feat(order, types): Add Credit Line to order module (#10636)

* feat(order, types): Add Credit Line to order module

* chore: add action to inject credit lines

packages/modules/order/src/models/credit-line.ts

@@ -0,0 +1,107 @@
+import { BigNumberRawValue, DAL } from "@medusajs/framework/types"
+import {
+  BigNumber,
+  createPsqlIndexStatementHelper,
+  generateEntityId,
+  MikroOrmBigNumberProperty,
+} from "@medusajs/framework/utils"
+import {
+  BeforeCreate,
+  Entity,
+  ManyToOne,
+  OnInit,
+  OptionalProps,
+  PrimaryKey,
+  Property,
+  Rel,
+} from "@mikro-orm/core"
+import Order from "./order"
+
+type OptionalLineItemProps = DAL.ModelDateColumns
+
+const tableName = "order_credit_line"
+const OrderIdIndex = createPsqlIndexStatementHelper({
+  tableName,
+  columns: ["order_id"],
+  where: "deleted_at IS NOT NULL",
+})
+
+const DeletedAtIndex = createPsqlIndexStatementHelper({
+  tableName,
+  columns: "deleted_at",
+  where: "deleted_at IS NOT NULL",
+})
+
+@Entity({ tableName })
+export default class OrderCreditLine {
+  [OptionalProps]?: OptionalLineItemProps
+
+  @PrimaryKey({ columnType: "text" })
+  id: string
+
+  @ManyToOne({
+    entity: () => Order,
+    mapToPk: true,
+    fieldName: "order_id",
+    columnType: "text",
+  })
+  @OrderIdIndex.MikroORMIndex()
+  order_id: string
+
+  @ManyToOne(() => Order, {
+    persist: false,
+  })
+  order: Rel<Order>
+
+  @Property({
+    columnType: "text",
+    nullable: true,
+  })
+  reference: string | null = null
+
+  @Property({
+    columnType: "text",
+    nullable: true,
+  })
+  reference_id: string | null = null
+
+  @MikroOrmBigNumberProperty()
+  amount: BigNumber | number
+
+  @Property({ columnType: "jsonb" })
+  raw_amount: BigNumberRawValue
+
+  @Property({ columnType: "jsonb", nullable: true })
+  metadata: Record<string, unknown> | null = null
+
+  @Property({
+    onCreate: () => new Date(),
+    columnType: "timestamptz",
+    defaultRaw: "now()",
+  })
+  created_at: Date
+
+  @Property({
+    onCreate: () => new Date(),
+    onUpdate: () => new Date(),
+    columnType: "timestamptz",
+    defaultRaw: "now()",
+  })
+  updated_at: Date
+
+  @Property({ columnType: "timestamptz", nullable: true })
+  @DeletedAtIndex.MikroORMIndex()
+  deleted_at: Date | null = null
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "ordcl")
+    this.order_id ??= this.order?.id
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "ordcl")
+    this.order_id ??= this.order?.id
+  }
+}

packages/modules/order/src/models/index.ts

@@ -2,6 +2,7 @@ export { default as OrderAddress } from "./address"
 export { default as OrderClaim } from "./claim"
 export { default as OrderClaimItem } from "./claim-item"
 export { default as OrderClaimItemImage } from "./claim-item-image"
+export { default as OrderCreditLine } from "./credit-line"
 export { default as OrderExchange } from "./exchange"
 export { default as OrderExchangeItem } from "./exchange-item"
 export { default as OrderLineItem } from "./line-item"

packages/modules/order/src/models/order.ts

@@ -20,6 +20,7 @@ import {
   Rel,
 } from "@mikro-orm/core"
 import OrderAddress from "./address"
+import OrderCreditLine from "./credit-line"
 import OrderItem from "./order-item"
 import OrderShipping from "./order-shipping-method"
 import OrderSummary from "./order-summary"
@@ -180,6 +181,11 @@ export default class Order {
   })
   items = new Collection<Rel<OrderItem>>(this)
 
+  @OneToMany(() => OrderCreditLine, (creditLine) => creditLine.order, {
+    cascade: [Cascade.PERSIST],
+  })
+  credit_lines = new Collection<Rel<OrderCreditLine>>(this)
+
   @OneToMany(() => OrderShipping, (shippingMethod) => shippingMethod.order, {
     cascade: [Cascade.PERSIST],
   })