feat(cart): Data models

packages/cart/src/models/address.ts

@@ -0,0 +1,82 @@
+import { DAL } from "@medusajs/types"
+import { generateEntityId } from "@medusajs/utils"
+import {
+  BeforeCreate,
+  Entity,
+  OnInit,
+  OptionalProps,
+  PrimaryKey,
+  Property
+} from "@mikro-orm/core"
+
+
+type OptionalAddressProps = DAL.EntityDateColumns // TODO: To be revisited when more clear
+
+@Entity({ tableName: "cart_address" })
+export default class Address {
+  [OptionalProps]: OptionalAddressProps
+
+  @PrimaryKey({ columnType: "text" })
+  id!: string
+
+  @Property({ columnType: "text", nullable: true })
+  customer_id?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  company?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  first_name?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  last_name?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  address_1?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  address_2?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  city?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  country_code?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  province?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  postal_code?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  phone?: string | null
+
+  @Property({ columnType: "jsonb", nullable: true })
+  metadata?: Record<string, unknown> | 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
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "caaddr")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "caaddr")
+  }
+}

packages/cart/src/models/adjustment-line.ts

@@ -0,0 +1,41 @@
+import { DAL } from "@medusajs/types"
+import { OptionalProps, PrimaryKey, Property } from "@mikro-orm/core"
+
+type OptionalAdjustmentLineProps = DAL.EntityDateColumns // TODO: To be revisited when more clear
+
+export default class AdjustmentLine {
+  [OptionalProps]: OptionalAdjustmentLineProps
+
+  @PrimaryKey({ columnType: "text" })
+  id: string
+
+  @Property({ columnType: "text", nullable: true })
+  description?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  promotion_id?: string | null
+
+  @Property({ columnType: "text" })
+  code: string
+
+  @Property({ columnType: "numeric" })
+  amount: number
+
+  @Property({ columnType: "text", nullable: true })
+  provider_id?: string | 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
+}

packages/cart/src/models/cart.ts

@@ -1,10 +1,119 @@
+import { DAL } from "@medusajs/types"
 import { generateEntityId } from "@medusajs/utils"
-import { BeforeCreate, Entity, OnInit, PrimaryKey } from "@mikro-orm/core"
+import {
+  BeforeCreate,
+  Collection,
+  Entity,
+  OnInit,
+  OneToMany,
+  OneToOne,
+  PrimaryKey,
+  Property,
+} from "@mikro-orm/core"
+import Address from "./address"
+import LineItem from "./line-item"
+import ShippingMethod from "./shipping-method"
 
-@Entity()
+type OptionalCartProps =
+  | "shipping_address"
+  | "billing_address"
+  | DAL.EntityDateColumns // TODO: To be revisited when more clear
+
+@Entity({ tableName: "cart" })
 export default class Cart {
   @PrimaryKey({ columnType: "text" })
-  id!: string
+  id: string
+
+  @Property({ columnType: "text", nullable: true })
+  region_id?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  customer_id?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  sales_channel_id?: string | null
+
+  @Property({ columnType: "text", nullable: true })
+  email?: string | null
+
+  @Property({ columnType: "text" })
+  currency_code: string
+
+  @OneToOne({
+    entity: () => Address,
+    joinColumn: "shipping_address_id",
+    orphanRemoval: true,
+  })
+  shipping_address?: Address | null
+
+  @OneToOne({
+    entity: () => Address,
+    joinColumn: "billing_address_id",
+    orphanRemoval: true,
+  })
+  billing_address?: Address | null
+
+  @Property({ columnType: "jsonb", nullable: true })
+  metadata?: Record<string, unknown> | null
+
+  @OneToMany(() => LineItem, (lineItem) => lineItem.cart, {
+    orphanRemoval: true,
+  })
+  items = new Collection<LineItem>(this)
+
+  @OneToMany(() => ShippingMethod, (shippingMethod) => shippingMethod.cart, {
+    orphanRemoval: true,
+  })
+  shipping_methods = new Collection<ShippingMethod>(this)
+
+  /** COMPUTED PROPERTIES - START */
+
+  // compare_at_item_total?: number
+  // compare_at_item_subtotal?: number
+  // compare_at_item_tax_total?: number
+
+  // original_item_total: number
+  // original_item_subtotal: number
+  // original_item_tax_total: number
+
+  // item_total: number
+  // item_subtotal: number
+  // item_tax_total: number
+
+  // original_total: number
+  // original_subtotal: number
+  // original_tax_total: number
+
+  // total: number
+  // subtotal: number
+  // tax_total: number
+  // discount_total: number
+  // discount_tax_total: number
+
+  // shipping_total: number
+  // shipping_subtotal: number
+  // shipping_tax_total: number
+
+  // original_shipping_total: number
+  // original_shipping_subtotal: number
+  // original_shipping_tax_total: number
+
+  /** COMPUTED PROPERTIES - END */
+
+  @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
 
   @BeforeCreate()
   onCreate() {

packages/cart/src/models/index.ts

@@ -1,2 +1,11 @@
-export { default as Cart } from "./cart";
+export { default as Address } from "./address"
+export { default as AdjustmentLine } from "./adjustment-line"
+export { default as Cart } from "./cart"
+export { default as LineItem } from "./line-item"
+export { default as LineItemAdjustmentLine } from "./line-item-adjustment-line"
+export { default as LineItemTaxLine } from "./line-item-tax-line"
+export { default as ShippingMethod } from "./shipping-method"
+export { default as ShippingMethodAdjustmentLine } from "./shipping-method-adjustment-line"
+export { default as ShippingMethodTaxLine } from "./shipping-method-tax-line"
+export { default as TaxLine } from "./tax-line"
 

packages/cart/src/models/line-item-adjustment-line.ts

@@ -0,0 +1,28 @@
+import { generateEntityId } from "@medusajs/utils"
+import {
+  BeforeCreate,
+  Entity,
+  ManyToOne,
+  OnInit
+} from "@mikro-orm/core"
+import AdjustmentLine from "./adjustment-line"
+import LineItem from "./line-item"
+
+@Entity({ tableName: "cart_line_item_adjustment_line" })
+export default class LineItemAdjustmentLine extends AdjustmentLine {
+  @ManyToOne(() => LineItem, {
+    joinColumn: "line_item",
+    fieldName: "line_item_id",
+  })
+  line_item: LineItem
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "caliadj")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "caliadj")
+  }
+}

packages/cart/src/models/line-item-tax-line.ts

@@ -0,0 +1,23 @@
+import { generateEntityId } from "@medusajs/utils"
+import { BeforeCreate, Entity, ManyToOne, OnInit } from "@mikro-orm/core"
+import LineItem from "./line-item"
+import TaxLine from "./tax-line"
+
+@Entity({ tableName: "cart_line_item_tax_line" })
+export default class LineItemTaxLine extends TaxLine {
+  @ManyToOne(() => LineItem, {
+    joinColumn: "line_item",
+    fieldName: "line_item_id",
+  })
+  line_item: LineItem
+
+  @BeforeCreate()
+  onCreate() {
+    this.id = generateEntityId(this.id, "calitxl")
+  }
+
+  @OnInit()
+  onInit() {
+    this.id = generateEntityId(this.id, "calitxl")
+  }
+}