feat: Payment module interface

.changeset/forty-moons-wash.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/types": patch
+---
+
+feat: Payment Module service interface

packages/payment/src/models/capture.ts

@@ -0,0 +1,55 @@
+import {
+  BeforeCreate,
+  Entity,
+  ManyToOne,
+  OnInit,
+  OptionalProps,
+  PrimaryKey,
+  Property,
+} from "@mikro-orm/core"
+
+import { generateEntityId } from "@medusajs/utils"
+import Payment from "./payment"
+
+type OptionalCaptureProps = "created_at"
+
+@Entity({ tableName: "capture" })
+export default class Capture {
+  [OptionalProps]?: OptionalCaptureProps
+
+  @PrimaryKey({ columnType: "text" })
+  id: string
+
+  @Property({
+    columnType: "numeric",
+    serializer: Number,
+  })
+  amount: number
+
+  @ManyToOne(() => Payment, {
+    onDelete: "cascade",
+    index: "IDX_capture_payment_id",
+    fieldName: "payment_id",
+  })
+  payment: Payment
+
+  @Property({
+    onCreate: () => new Date(),
+    columnType: "timestamptz",
+    defaultRaw: "now()",
+  })
+  created_at: Date
+
+  @Property({ columnType: "text", nullable: true })
+  created_by?: string | null
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "capt")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "capt")
+  }
+}

packages/payment/src/models/index.ts

@@ -1 +1,7 @@
+export { default as Capture } from "./capture"
 export { default as Payment } from "./payment"
+export { default as PaymentCollection } from "./payment-collection"
+export { default as PaymentMethodToken } from "./payment-method-token"
+export { default as PaymentProvider } from "./payment-provider"
+export { default as PaymentSession } from "./payment-session"
+export { default as Refund } from "./refund"

packages/payment/src/models/payment-collection.ts

@@ -0,0 +1,119 @@
+import {
+  BeforeCreate,
+  Cascade,
+  Collection,
+  Entity,
+  Enum,
+  Filter,
+  ManyToMany,
+  OneToMany,
+  OnInit,
+  OptionalProps,
+  PrimaryKey,
+  Property,
+} from "@mikro-orm/core"
+import { DAL } from "@medusajs/types"
+
+import {
+  DALUtils,
+  generateEntityId,
+  optionalNumericSerializer,
+  PaymentCollectionStatus,
+} from "@medusajs/utils"
+import PaymentProvider from "./payment-provider"
+import PaymentSession from "./payment-session"
+import Payment from "./payment"
+
+type OptionalPaymentCollectionProps = "status" | DAL.EntityDateColumns
+
+@Entity({ tableName: "payment_collection" })
+@Filter(DALUtils.mikroOrmSoftDeletableFilterOptions)
+export default class PaymentCollection {
+  [OptionalProps]?: OptionalPaymentCollectionProps
+
+  @PrimaryKey({ columnType: "text" })
+  id: string
+
+  @Property({ columnType: "text" })
+  currency_code: string
+
+  @Property({
+    columnType: "numeric",
+    serializer: Number,
+  })
+  amount: number
+
+  @Property({
+    columnType: "numeric",
+    nullable: true,
+    serializer: optionalNumericSerializer,
+  })
+  authorized_amount?: number | null
+
+  @Property({
+    columnType: "numeric",
+    nullable: true,
+    serializer: optionalNumericSerializer,
+  })
+  refunded_amount?: number | null
+
+  @Property({ columnType: "text", index: "IDX_payment_collection_region_id" })
+  region_id: string
+
+  @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,
+    index: "IDX_payment_collection_deleted_at",
+  })
+  deleted_at?: Date | null
+
+  @Property({
+    columnType: "timestamptz",
+    nullable: true,
+  })
+  completed_at?: Date | null
+
+  @Enum({
+    items: () => PaymentCollectionStatus,
+    default: PaymentCollectionStatus.NOT_PAID,
+  })
+  status: PaymentCollectionStatus = PaymentCollectionStatus.NOT_PAID
+
+  @ManyToMany(() => PaymentProvider)
+  payment_providers = new Collection<PaymentProvider>(this)
+
+  @OneToMany(() => PaymentSession, (ps) => ps.payment_collection, {
+    cascade: [Cascade.REMOVE],
+  })
+  payment_sessions = new Collection<PaymentSession>(this)
+
+  @OneToMany(() => Payment, (payment) => payment.payment_collection, {
+    cascade: [Cascade.REMOVE],
+  })
+  payments = new Collection<Payment>(this)
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "pay_col")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "pay_col")
+  }
+}

packages/payment/src/models/payment-method-token.ts

@@ -0,0 +1,43 @@
+import {
+  BeforeCreate,
+  Entity,
+  OnInit,
+  PrimaryKey,
+  Property,
+} from "@mikro-orm/core"
+
+import { generateEntityId } from "@medusajs/utils"
+
+@Entity({ tableName: "payment_method_token" })
+export default class PaymentMethodToken {
+  @PrimaryKey({ columnType: "text" })
+  id: string
+
+  @Property({ columnType: "text" })
+  provider_id: string
+
+  @Property({ columnType: "jsonb", nullable: true })
+  data?: Record<string, unknown> | null
+
+  @Property({ columnType: "text" })
+  name: string
+
+  @Property({ columnType: "text", nullable: true })
+  type_detail?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  description_detail?: string | null
+
+  @Property({ columnType: "jsonb", nullable: true })
+  metadata?: Record<string, unknown> | null
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "paymttok")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "paymttok")
+  }
+}

packages/payment/src/models/payment-provider.ts

@@ -0,0 +1,14 @@
+import { Entity, OptionalProps, PrimaryKey, Property } from "@mikro-orm/core"
+
+@Entity({ tableName: "payment_provider" })
+export default class PaymentProvider {
+  [OptionalProps]?: "is_enabled"
+
+  @PrimaryKey({ columnType: "text" })
+  id: string
+
+  @Property({
+    default: true,
+  })
+  is_enabled: boolean = true
+}

packages/payment/src/models/payment-session.ts

@@ -0,0 +1,69 @@
+import {
+  BeforeCreate,
+  Entity,
+  Enum,
+  ManyToOne,
+  OneToOne,
+  OnInit,
+  PrimaryKey,
+  Property,
+} from "@mikro-orm/core"
+import { generateEntityId, PaymentSessionStatus } from "@medusajs/utils"
+
+import PaymentCollection from "./payment-collection"
+import Payment from "./payment"
+
+@Entity({ tableName: "payment_session" })
+export default class PaymentSession {
+  @PrimaryKey({ columnType: "text" })
+  id: string
+
+  @Property({ columnType: "text" })
+  currency_code: string
+
+  @Property({
+    columnType: "numeric",
+    serializer: Number,
+  })
+  amount: number
+
+  @Property({ columnType: "text" })
+  provider_id: string
+
+  @Property({ columnType: "jsonb", nullable: true })
+  data?: Record<string, unknown> | null
+
+  @Enum({
+    items: () => PaymentSessionStatus,
+  })
+  status: PaymentSessionStatus
+
+  @Property({
+    columnType: "timestamptz",
+    nullable: true,
+  })
+  authorized_at?: Date | null
+
+  @ManyToOne({
+    index: "IDX_payment_session_payment_collection_id",
+    fieldName: "payment_collection_id",
+  })
+  payment_collection!: PaymentCollection
+
+  @OneToOne({
+    entity: () => Payment,
+    mappedBy: (payment) => payment.session,
+    cascade: ["soft-remove"] as any,
+  })
+  payment!: Payment
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "payses")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "payses")
+  }
+}