feat: Add BigNumber implementation

packages/cart/integration-tests/__tests__/services/cart-module/index.spec.ts

@@ -481,14 +481,14 @@ describe("Cart Module Service", () => {
       const error = await service
         .addLineItems(createdCart.id, [
           {
-            quantity: 1,
+            unit_price: 10,
             title: "test",
           },
         ] as any)
         .catch((e) => e)
 
       expect(error.message).toContain(
-        "Value for LineItem.unit_price is required, 'undefined' found"
+        "Value for LineItem.quantity is required, 'undefined' found"
       )
     })
 
@@ -503,14 +503,14 @@ describe("Cart Module Service", () => {
         .addLineItems([
           {
             cart_id: createdCart.id,
-            quantity: 1,
+            unit_price: 10,
             title: "test",
           },
         ] as any)
         .catch((e) => e)
 
       expect(error.message).toContain(
-        "Value for LineItem.unit_price is required, 'undefined' found"
+        "Value for LineItem.quantity is required, 'undefined' found"
       )
     })
   })

packages/cart/src/migrations/CartModuleSetup20240122122952.ts

@@ -80,7 +80,9 @@ export class CartModuleSetup20240122122952 extends Migration {
       "is_discountable" BOOLEAN NOT NULL DEFAULT TRUE,
       "is_tax_inclusive" BOOLEAN NOT NULL DEFAULT FALSE,
       "compare_at_unit_price" NUMERIC NULL,
+      "raw_compare_at_unit_price" JSONB NULL,
       "unit_price" NUMERIC NOT NULL,
+      "raw_unit_price" JSONB NOT NULL,
       "created_at" TIMESTAMPTZ NOT NULL DEFAULT NOW(),
       "updated_at" TIMESTAMPTZ NOT NULL DEFAULT NOW(),
       CONSTRAINT "cart_line_item_pkey" PRIMARY KEY ("id"),
@@ -134,6 +136,7 @@ export class CartModuleSetup20240122122952 extends Migration {
       "name" TEXT NOT NULL,
       "description" JSONB NULL,
       "amount" NUMERIC NOT NULL,
+      "raw_amount" JSONB NOT NULL,
       "is_tax_inclusive" BOOLEAN NOT NULL DEFAULT FALSE,
       "shipping_option_id" TEXT NULL,
       "data" JSONB NULL,

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

@@ -1,9 +1,9 @@
-import { DAL } from "@medusajs/types"
-import { generateEntityId } from "@medusajs/utils"
+import { BigNumberRawValue, DAL } from "@medusajs/types"
+import { BigNumber, generateEntityId } from "@medusajs/utils"
 import {
   BeforeCreate,
+  BeforeUpdate,
   Cascade,
-  Check,
   Collection,
   Entity,
   ManyToOne,
@@ -109,12 +109,16 @@ export default class LineItem {
   is_tax_inclusive = false
 
   @Property({ columnType: "numeric", nullable: true })
-  compare_at_unit_price: number | null = null
+  compare_at_unit_price?: BigNumber | number | null = null
 
-  // TODO: Rework when BigNumber has been introduced
-  @Property({ columnType: "numeric", serializer: Number })
-  @Check({ expression: "unit_price >= 0" }) // TODO: Validate that numeric types work with the expression
-  unit_price: number
+  @Property({ columnType: "jsonb", nullable: true })
+  raw_compare_at_unit_price: BigNumberRawValue | null = null
+
+  @Property({ columnType: "numeric" })
+  unit_price: BigNumber | number
+
+  @Property({ columnType: "jsonb" })
+  raw_unit_price: BigNumberRawValue
 
   @OneToMany(() => LineItemTaxLine, (taxLine) => taxLine.item, {
     cascade: [Cascade.REMOVE],
@@ -144,10 +148,28 @@ export default class LineItem {
   @BeforeCreate()
   onCreate() {
     this.id = generateEntityId(this.id, "cali")
+
+    const val = new BigNumber(this.raw_unit_price ?? this.unit_price)
+
+    this.unit_price = val.numeric
+    this.raw_unit_price = val.raw!
+  }
+
+  @BeforeUpdate()
+  onUpdate() {
+    const val = new BigNumber(this.raw_unit_price ?? this.unit_price)
+
+    this.unit_price = val.numeric
+    this.raw_unit_price = val.raw as BigNumberRawValue
   }
 
   @OnInit()
   onInit() {
     this.id = generateEntityId(this.id, "cali")
+
+    const val = new BigNumber(this.raw_unit_price ?? this.unit_price)
+
+    this.unit_price = val.numeric
+    this.raw_unit_price = val.raw!
   }
 }

packages/cart/src/models/shipping-method.ts

@@ -1,4 +1,5 @@
-import { generateEntityId } from "@medusajs/utils"
+import { BigNumberRawValue } from "@medusajs/types"
+import { BigNumber, generateEntityId } from "@medusajs/utils"
 import {
   BeforeCreate,
   Cascade,
@@ -11,6 +12,7 @@ import {
   PrimaryKey,
   Property,
 } from "@mikro-orm/core"
+import { BeforeUpdate } from "typeorm"
 import Cart from "./cart"
 import ShippingMethodAdjustment from "./shipping-method-adjustment"
 import ShippingMethodTaxLine from "./shipping-method-tax-line"
@@ -37,8 +39,11 @@ export default class ShippingMethod {
   @Property({ columnType: "jsonb", nullable: true })
   description: string | null = null
 
-  @Property({ columnType: "numeric", serializer: Number })
-  amount: number
+  @Property({ columnType: "numeric" })
+  amount: BigNumber | number
+
+  @Property({ columnType: "jsonb" })
+  raw_amount: BigNumberRawValue
 
   @Property({ columnType: "boolean" })
   is_tax_inclusive = false
@@ -92,10 +97,28 @@ export default class ShippingMethod {
   @BeforeCreate()
   onCreate() {
     this.id = generateEntityId(this.id, "casm")
+
+    const val = new BigNumber(this.raw_amount ?? this.amount)
+
+    this.amount = val.numeric
+    this.raw_amount = val.raw!
+  }
+
+  @BeforeUpdate()
+  onUpdate() {
+    const val = new BigNumber(this.raw_amount ?? this.amount)
+
+    this.amount = val.numeric
+    this.raw_amount = val.raw as BigNumberRawValue
   }
 
   @OnInit()
   onInit() {
     this.id = generateEntityId(this.id, "casm")
+
+    const val = new BigNumber(this.raw_amount ?? this.amount)
+
+    this.amount = val.numeric
+    this.raw_amount = val.raw!
   }
 }

packages/cart/src/services/cart-module.ts

@@ -11,11 +11,11 @@ import {
 import {
   InjectManager,
   InjectTransactionManager,
-  isObject,
-  isString,
   MedusaContext,
   MedusaError,
   ModulesSdkUtils,
+  isObject,
+  isString,
 } from "@medusajs/utils"
 import {
   Address,

packages/cart/src/services/index.ts

@@ -1 +1 @@
-export { default as CartModuleService } from "./cart-module"
+export { default as CartModuleService } from "./cart-module";

packages/cart/src/types/line-item.ts

@@ -26,7 +26,7 @@ interface PartialUpsertLineItemDTO {
 export interface CreateLineItemDTO extends PartialUpsertLineItemDTO {
   title: string
   quantity: number
-  unit_price: number
+  unit_price: number | string
   cart_id: string
 }
 

packages/medusa/src/services/new-totals.ts

@@ -79,8 +79,8 @@ export default class NewTotalsService extends TransactionBaseService {
 
   /**
    * Calculate and return the items totals for either the legacy calculation or the new calculation
-   * @param items 
-   * @param param1 
+   * @param items
+   * @param param1
    */
   async getLineItemTotals(
     items: LineItem | LineItem[],
@@ -136,9 +136,9 @@ export default class NewTotalsService extends TransactionBaseService {
 
   /**
    * Calculate and return the totals for an item
-   * @param item 
-   * @param param1 
-   * @returns 
+   * @param item
+   * @param param1
+   * @returns
    */
   protected async getLineItemTotals_(
     item: LineItem,

packages/payment/src/models/capture.ts

@@ -1,3 +1,4 @@
+import { generateEntityId } from "@medusajs/utils"
 import {
   BeforeCreate,
   Entity,
@@ -7,8 +8,6 @@ import {
   PrimaryKey,
   Property,
 } from "@mikro-orm/core"
-
-import { generateEntityId } from "@medusajs/utils"
 import Payment from "./payment"
 
 type OptionalCaptureProps = "created_at"

packages/types/package.json

@@ -22,6 +22,7 @@
   "license": "MIT",
   "devDependencies": {
     "awilix": "^8.0.0",
+    "bignumber.js": "^9.1.2",
     "cross-env": "^5.2.1",
     "ioredis": "^5.2.5",
     "rimraf": "^5.0.1",

packages/types/src/cart/common.ts

@@ -261,7 +261,23 @@ export interface CartShippingMethodDTO {
   discount_tax_total: number
 }
 
-export interface CartLineItemDTO {
+export interface CartLineItemTotalsDTO {
+  original_total: number
+  original_subtotal: number
+  original_tax_total: number
+
+  item_total: number
+  item_subtotal: number
+  item_tax_total: number
+
+  total: number
+  subtotal: number
+  tax_total: number
+  discount_total: number
+  discount_tax_total: number
+}
+
+export interface CartLineItemDTO extends CartLineItemTotalsDTO {
   /**
    * The ID of the line item.
    */
@@ -384,20 +400,6 @@ export interface CartLineItemDTO {
    * When the line item was updated.
    */
   updated_at?: Date
-
-  original_total: number
-  original_subtotal: number
-  original_tax_total: number
-
-  item_total: number
-  item_subtotal: number
-  item_tax_total: number
-
-  total: number
-  subtotal: number
-  tax_total: number
-  discount_total: number
-  discount_tax_total: number
 }
 
 export interface CartDTO {
@@ -478,8 +480,12 @@ export interface CartDTO {
   subtotal: number
   tax_total: number
   discount_total: number
+  raw_discount_total: any
   discount_tax_total: number
 
+  gift_card_total: number
+  gift_card_tax_total: number
+
   shipping_total: number
   shipping_subtotal: number
   shipping_tax_total: number

packages/types/src/cart/mutations.ts

@@ -156,7 +156,7 @@ export interface CreateLineItemDTO {
   is_tax_inclusive?: boolean
 
   compare_at_unit_price?: number
-  unit_price: number
+  unit_price: number | string
 
   tax_lines?: CreateTaxLineDTO[]
   adjustments?: CreateAdjustmentDTO[]

packages/types/src/index.ts

@@ -26,6 +26,7 @@ export * from "./sales-channel"
 export * from "./search"
 export * from "./shared-context"
 export * from "./stock-location"
+export * from "./totals"
 export * from "./transaction-base"
 export * from "./user"
 export * from "./workflow"

packages/types/src/totals/big-number.ts

@@ -0,0 +1,12 @@
+import BigNumber from "bignumber.js"
+
+export type BigNumberRawValue = {
+  value: string | number
+  [key: string]: unknown
+}
+
+export type BigNumberRawPriceInput =
+  | BigNumberRawValue
+  | number
+  | string
+  | BigNumber

packages/types/src/totals/index.ts

@@ -0,0 +1,2 @@
+export * from "./big-number";
+

packages/utils/package.json

@@ -35,6 +35,7 @@
     "@mikro-orm/migrations": "5.9.7",
     "@mikro-orm/postgresql": "5.9.7",
     "awilix": "^8.0.1",
+    "bignumber.js": "^9.1.2",
     "knex": "2.4.2",
     "ulid": "^2.3.0"
   },

packages/utils/src/common/index.ts

@@ -14,6 +14,7 @@ export * from "./get-iso-string-from-date"
 export * from "./get-selects-and-relations-from-object-array"
 export * from "./group-by"
 export * from "./handle-postgres-database-error"
+export * from "./is-big-number"
 export * from "./is-date"
 export * from "./is-defined"
 export * from "./is-email"

packages/utils/src/common/is-big-number.ts

@@ -0,0 +1,6 @@
+import { BigNumberRawValue } from "@medusajs/types"
+import { isObject } from "./is-object"
+
+export function isBigNumber(obj: any): obj is BigNumberRawValue {
+  return isObject(obj) && "value" in obj
+}

packages/utils/src/index.ts

@@ -16,5 +16,7 @@ export * from "./product"
 export * from "./promotion"
 export * from "./search"
 export * from "./shipping"
+export * from "./totals"
+export * from "./totals/big-number"
 
 export const MedusaModuleType = Symbol.for("MedusaModule")