chore(index): index dml (medusajs#10482)

What:
- DML - `autoincrement` property
- Index `type` option (GIN)
- Index module - DML

.changeset/yellow-penguins-pay.md

@@ -0,0 +1,7 @@
+---
+"@medusajs/index": patch
+"@medusajs/types": patch
+"@medusajs/utils": patch
+---
+
+chore: index module to DML

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

@@ -41,6 +41,7 @@ export type KnownDataTypes =
   | "enum"
   | "number"
   | "bigNumber"
+  | "serial"
   | "dateTime"
   | "array"
   | "json"
@@ -310,6 +311,11 @@ export type EntityIndex<
    * Conditions to restrict which records are indexed.
    */
   where?: Where
+
+  /**
+   * The type of the index. (e.g: GIN)
+   */
+  type?: string
 }
 
 export type SimpleQueryValue = string | number | boolean | null

packages/core/utils/src/dml/__tests__/autoincrement-property.spec.ts

@@ -0,0 +1,20 @@
+import { expectTypeOf } from "expect-type"
+import { AutoIncrementProperty } from "../properties/autoincrement"
+
+describe("Autoincrement property", () => {
+  test("create autoincrement property type", () => {
+    const property = new AutoIncrementProperty()
+
+    expectTypeOf(property["$dataType"]).toEqualTypeOf<number>()
+    expect(property.parse("display_id")).toEqual({
+      fieldName: "display_id",
+      dataType: {
+        name: "serial",
+        options: {},
+      },
+      nullable: false,
+      indexes: [],
+      relationships: [],
+    })
+  })
+})

packages/core/utils/src/dml/__tests__/entity-builder.spec.ts

@@ -3736,6 +3736,7 @@ describe("Entity builder", () => {
         },
         group: {
           entity: "Group",
+          fieldName: "group_id",
           name: "group",
           nullable: false,
           persist: false,
@@ -4355,6 +4356,7 @@ describe("Entity builder", () => {
         },
         user: {
           entity: "User",
+          fieldName: "user_id",
           name: "user",
           nullable: false,
           persist: false,
@@ -4363,8 +4365,8 @@ describe("Entity builder", () => {
         user_id: {
           columnType: "text",
           entity: "User",
-          fieldName: "user_id",
           mapToPk: true,
+          fieldName: "user_id",
           name: "user_id",
           nullable: false,
           onDelete: "cascade",
@@ -4949,6 +4951,7 @@ describe("Entity builder", () => {
           name: "user",
           reference: "m:1",
           entity: "User",
+          fieldName: "user_id",
           persist: false,
           nullable: false,
         },
@@ -5136,6 +5139,7 @@ describe("Entity builder", () => {
         user: {
           name: "user",
           reference: "m:1",
+          fieldName: "user_id",
           entity: "User",
           persist: false,
           nullable: true,
@@ -5697,6 +5701,7 @@ describe("Entity builder", () => {
         },
         parent: {
           name: "parent",
+          fieldName: "parent_id",
           reference: "m:1",
           entity: "User",
           persist: false,
@@ -7447,39 +7452,37 @@ describe("Entity builder", () => {
         },
         user_id: {
           name: "user_id",
-          reference: "m:1",
-          entity: "User",
+          reference: "scalar",
           columnType: "text",
-          mapToPk: true,
           fieldName: "user_id",
+          getter: false,
+          setter: false,
           nullable: false,
+          type: "User",
         },
         user: {
-          reference: "scalar",
-          type: "User",
+          reference: "m:1",
+          entity: "User",
           persist: false,
           nullable: false,
           name: "user",
-          getter: false,
-          setter: false,
         },
         team_id: {
           name: "team_id",
-          reference: "m:1",
-          entity: "Team",
+          reference: "scalar",
           columnType: "text",
-          mapToPk: true,
           fieldName: "team_id",
           nullable: false,
+          getter: false,
+          setter: false,
+          type: "Team",
         },
         team: {
-          reference: "scalar",
-          type: "Team",
+          reference: "m:1",
+          entity: "Team",
           persist: false,
           nullable: false,
           name: "team",
-          getter: false,
-          setter: false,
         },
         created_at: {
           reference: "scalar",

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

@@ -13,6 +13,7 @@ import {
   DMLSchemaDefaults,
 } from "./helpers/entity-builder/create-default-properties"
 import { ArrayProperty } from "./properties/array"
+import { AutoIncrementProperty } from "./properties/autoincrement"
 import { BigNumberProperty } from "./properties/big-number"
 import { BooleanProperty } from "./properties/boolean"
 import { DateTimeProperty } from "./properties/date-time"
@@ -24,8 +25,8 @@ import { TextProperty } from "./properties/text"
 import { BelongsTo } from "./relations/belongs-to"
 import { HasMany } from "./relations/has-many"
 import { HasOne } from "./relations/has-one"
-import { ManyToMany } from "./relations/many-to-many"
 import { HasOneWithForeignKey } from "./relations/has-one-fk"
+import { ManyToMany } from "./relations/many-to-many"
 
 /**
  * The implicit properties added by EntityBuilder in every schema
@@ -60,11 +61,11 @@ export type ManyToManyOptions = RelationshipOptions &
         /**
          * The column name in the pivot table that for the current entity
          */
-        joinColumn?: string
+        joinColumn?: string | string[]
         /**
          * The column name in the pivot table for the opposite entity
          */
-        inverseJoinColumn?: string
+        inverseJoinColumn?: string | string[]
       }
     | {
         /**
@@ -77,6 +78,14 @@ export type ManyToManyOptions = RelationshipOptions &
          * database for this relationship.
          */
         pivotEntity?: () => DmlEntity<any, any>
+        /**
+         * The column name in the pivot table that for the current entity
+         */
+        joinColumn?: string | string[]
+        /**
+         * The column name in the pivot table for the opposite entity
+         */
+        inverseJoinColumn?: string | string[]
       }
   )
 
@@ -240,6 +249,26 @@ export class EntityBuilder {
     return new BigNumberProperty()
   }
 
+  /**
+   * This method defines an autoincrement property.
+   *
+   * @example
+   * import { model } from "@medusajs/framework/utils"
+   *
+   * const MyCustom = model.define("my_custom", {
+   *   serial_id: model.autoincrement(),
+   *   // ...
+   * })
+   *
+   * export default MyCustom
+   *
+   * @customNamespace Property
+   */
+
+  autoincrement() {
+    return new AutoIncrementProperty()
+  }
+
   /**
    * This method defines an array of strings property.
    *

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

@@ -4,8 +4,6 @@ import {
   PropertyMetadata,
   PropertyType,
 } from "@medusajs/types"
-import { MikroOrmBigNumberProperty } from "../../../dal"
-import { generateEntityId, isDefined } from "../../../common"
 import {
   ArrayType,
   BeforeCreate,
@@ -14,7 +12,10 @@ import {
   PrimaryKey,
   Property,
   Utils,
+  t as mikroOrmType,
 } from "@mikro-orm/core"
+import { generateEntityId, isDefined } from "../../../common"
+import { MikroOrmBigNumberProperty } from "../../../dal"
 import { PrimaryKeyModifier } from "../../properties/primary-key"
 import { applyEntityIndexes } from "../mikro-orm/apply-indexes"
 
@@ -32,6 +33,7 @@ const COLUMN_TYPES: {
   dateTime: "timestamptz",
   number: "integer",
   bigNumber: "numeric",
+  serial: "number",
   text: "text",
   json: "jsonb",
   array: "array",
@@ -51,6 +53,7 @@ const PROPERTY_TYPES: {
   dateTime: "date",
   number: "number",
   bigNumber: "number",
+  serial: "number",
   text: "string",
   json: "any",
   array: "string[]",
@@ -202,19 +205,16 @@ export function defineProperty(
    * Defining an id property
    */
   if (field.dataType.name === "id") {
-    const IdDecorator = PrimaryKeyModifier.isPrimaryKeyModifier(property)
-      ? PrimaryKey({
-          columnType: "text",
-          type: "string",
-          nullable: false,
-          fieldName: field.fieldName,
-        })
-      : Property({
-          columnType: "text",
-          type: "string",
-          nullable: false,
-          fieldName: field.fieldName,
-        })
+    const Prop = PrimaryKeyModifier.isPrimaryKeyModifier(property)
+      ? PrimaryKey
+      : Property
+
+    const IdDecorator = Prop({
+      columnType: "text",
+      type: "string",
+      nullable: false,
+      fieldName: field.fieldName,
+    })
 
     IdDecorator(MikroORMEntity.prototype, field.fieldName)
 
@@ -259,6 +259,24 @@ export function defineProperty(
     return
   }
 
+  /**
+   * Handling serial property separately to set the column type
+   */
+  if (field.dataType.name === "serial") {
+    const Prop = PrimaryKeyModifier.isPrimaryKeyModifier(property)
+      ? PrimaryKey
+      : Property
+
+    Prop({
+      columnType: "serial",
+      type: mikroOrmType.integer,
+      nullable: true,
+      fieldName: field.fieldName,
+      serializer: Number,
+    })(MikroORMEntity.prototype, field.fieldName)
+    return
+  }
+
   /**
    * Define rest of properties
    */