feat(utils,types): infer keys in query builder from schema (#7861)

packages/core/types/src/dml/index.ts

@@ -196,6 +196,8 @@ export type SimpleQueryValue = string | number | boolean | null
 export type NeQueryValue = { $ne: SimpleQueryValue }
 export type QueryValue = SimpleQueryValue | NeQueryValue
 
-export interface QueryCondition {
-  [key: string]: QueryValue | QueryCondition | QueryCondition[]
+export type QueryCondition<T extends DMLSchema = DMLSchema> = {
+  [K in keyof IDmlEntity<T>["schema"]]?: T[K] extends object
+    ? QueryValue
+    : QueryCondition<T>
 }

packages/core/utils/src/dml/entity.ts

@@ -125,9 +125,9 @@ export class DmlEntity<Schema extends DMLSchema> implements IDmlEntity<Schema> {
   /**
    * Adds indexes to be created at during model creation on the DML entity.
    */
-  indexes(indexes: EntityIndex<Schema, string | QueryCondition>[]) {
+  indexes(indexes: EntityIndex<Schema, string | QueryCondition<Schema>>[]) {
     for (const index of indexes) {
-      index.where = transformIndexWhere(index)
+      index.where = transformIndexWhere<Schema>(index)
       index.unique ??= false
     }
 

packages/core/utils/src/dml/helpers/entity-builder/build-indexes.ts

@@ -1,5 +1,6 @@
 import { DMLSchema, EntityIndex, QueryCondition } from "@medusajs/types"
 import { isObject, isPresent } from "../../../common"
+import { DateTimeProperty } from "../../properties/date-time"
 import { buildWhereQuery } from "./query-builder"
 
 /*
@@ -9,14 +10,16 @@ import { buildWhereQuery } from "./query-builder"
   this will need to be updated to include that case.
 */
 export function transformIndexWhere<TSchema extends DMLSchema>(
-  index: EntityIndex<TSchema, string | QueryCondition>
+  index: EntityIndex<TSchema, string | QueryCondition<TSchema>>
 ): string {
   return isObject(index.where)
-    ? transformWhereQb(index.where)
+    ? transformWhereQb<TSchema>(index.where)
     : transformWhere(index.where)
 }
 
-function transformWhereQb(where: QueryCondition): string {
+function transformWhereQb<TSchema extends DMLSchema>(
+  where: QueryCondition<TSchema & { deleted_at: DateTimeProperty }>
+): string {
   if (!isPresent(where.deleted_at)) {
     where.deleted_at = null
   }

packages/core/utils/src/dml/helpers/entity-builder/query-builder.ts

@@ -17,10 +17,16 @@ export function buildWhereQuery(query: QueryCondition): string {
   const conditions: string[] = []
 
   for (const [key, value] of Object.entries(query)) {
+    if (!isDefined(value)) {
+      throw new Error(
+        `value cannot be undefined when building where query for an index`
+      )
+    }
+
     if (isQueryCondition(value)) {
       conditions.push(buildWhereQuery(value))
     } else {
-      conditions.push(buildCondition(key, value as QueryValue))
+      conditions.push(buildCondition(key, value))
     }
   }