@doctocar/tooling 0.3.1-32 → 0.3.1-33

package/dist/pricing/__tests__/computeOrderPaymentBreakdownWithPlatformBalance.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/pricing/__tests__/computeOrderPaymentBreakdownWithPlatformBalance.test.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const stubs_1 = require("../utils/stubs");
+const computeOrderPaymentBreakdownWithPlatformBalance_1 = require("../computeOrderPaymentBreakdownWithPlatformBalance");
+describe("computeOrderPaymentBreakdownWithPlatformBalance", () => {
+    const invoiceTotals = (0, stubs_1.calculateInvoiceTotalWithTaxStub)({
+        totalPostTaxInCents: 1_800,
+        totalMarketplaceFeePostTaxInCents: 600,
+    });
+    it("should not apply balance when available balance is zero", () => {
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 0,
+            invoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_800,
+            remainingAmountToPayInCents: 1_800,
+            remainingMarketplaceFeeAmountInCents: 600,
+            platformBalanceAppliedInCents: 0,
+        });
+    });
+    it("should apply partial balance when available balance is below marketplace fee", () => {
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 200,
+            invoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_800,
+            remainingAmountToPayInCents: 1_600,
+            remainingMarketplaceFeeAmountInCents: 400,
+            platformBalanceAppliedInCents: 200,
+        });
+    });
+    it("should cap applied balance at marketplace fee post tax", () => {
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 5_000,
+            invoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_800,
+            remainingAmountToPayInCents: 1_200,
+            remainingMarketplaceFeeAmountInCents: 0,
+            platformBalanceAppliedInCents: 600,
+        });
+    });
+    it("should not apply balance when marketplace fee post tax is zero", () => {
+        const zeroFeeInvoiceTotals = (0, stubs_1.calculateInvoiceTotalWithTaxStub)({
+            totalPostTaxInCents: 1_200,
+            totalMarketplaceFeePostTaxInCents: 0,
+        });
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 500,
+            invoiceTotals: zeroFeeInvoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_200,
+            remainingAmountToPayInCents: 1_200,
+            remainingMarketplaceFeeAmountInCents: 0,
+            platformBalanceAppliedInCents: 0,
+        });
+    });
+});

package/dist/pricing/__tests__/computeOrderPaymentBreakdownWithPlatformBalance.util.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/pricing/__tests__/computeOrderPaymentBreakdownWithPlatformBalance.util.test.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const stubs_1 = require("../utils/stubs");
+const computeOrderPaymentBreakdownWithPlatformBalance_1 = require("../computeOrderPaymentBreakdownWithPlatformBalance");
+describe("computeOrderPaymentBreakdownWithPlatformBalance", () => {
+    const invoiceTotals = (0, stubs_1.calculateInvoiceTotalWithTaxStub)({
+        totalPostTaxInCents: 1_800,
+        totalMarketplaceFeePostTaxInCents: 600,
+    });
+    it("should not apply balance when available balance is zero", () => {
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 0,
+            invoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_800,
+            remainingAmountToPayInCents: 1_800,
+            remainingMarketplaceFeeAmountInCents: 600,
+            platformBalanceAppliedInCents: 0,
+        });
+    });
+    it("should apply partial balance when available balance is below marketplace fee", () => {
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 200,
+            invoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_800,
+            remainingAmountToPayInCents: 1_600,
+            remainingMarketplaceFeeAmountInCents: 400,
+            platformBalanceAppliedInCents: 200,
+        });
+    });
+    it("should cap applied balance at marketplace fee post tax", () => {
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 5_000,
+            invoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_800,
+            remainingAmountToPayInCents: 1_200,
+            remainingMarketplaceFeeAmountInCents: 0,
+            platformBalanceAppliedInCents: 600,
+        });
+    });
+    it("should not apply balance when marketplace fee post tax is zero", () => {
+        const zeroFeeInvoiceTotals = (0, stubs_1.calculateInvoiceTotalWithTaxStub)({
+            totalPostTaxInCents: 1_200,
+            totalMarketplaceFeePostTaxInCents: 0,
+        });
+        expect((0, computeOrderPaymentBreakdownWithPlatformBalance_1.computeOrderPaymentBreakdownWithPlatformBalance)({
+            availablePlatformBalanceInCents: 500,
+            invoiceTotals: zeroFeeInvoiceTotals,
+        })).toEqual({
+            totalAmountToPayInCents: 1_200,
+            remainingAmountToPayInCents: 1_200,
+            remainingMarketplaceFeeAmountInCents: 0,
+            platformBalanceAppliedInCents: 0,
+        });
+    });
+});

package/dist/pricing/computeOrderPaymentBreakdownWithPlatformBalance.d.ts

@@ -0,0 +1,6 @@
+import type { ComputeOrderPaymentBreakdownWithPlatformBalanceParams, ComputeOrderPaymentBreakdownWithPlatformBalanceResult } from "./types";
+/**
+ * Allocates customer platform balance against the marketplace fee portion of an order.
+ * Credits never reduce the service provider payout slice; unused balance stays on the entity.
+ */
+export declare function computeOrderPaymentBreakdownWithPlatformBalance({ availablePlatformBalanceInCents, invoiceTotals, }: ComputeOrderPaymentBreakdownWithPlatformBalanceParams): ComputeOrderPaymentBreakdownWithPlatformBalanceResult;

package/dist/pricing/computeOrderPaymentBreakdownWithPlatformBalance.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeOrderPaymentBreakdownWithPlatformBalance = computeOrderPaymentBreakdownWithPlatformBalance;
+/**
+ * Allocates customer platform balance against the marketplace fee portion of an order.
+ * Credits never reduce the service provider payout slice; unused balance stays on the entity.
+ */
+function computeOrderPaymentBreakdownWithPlatformBalance({ availablePlatformBalanceInCents, invoiceTotals, }) {
+    const totalAmountToPayInCents = invoiceTotals.totalPostTaxInCents;
+    const platformBalanceAppliedInCents = availablePlatformBalanceInCents > 0
+        ? Math.min(availablePlatformBalanceInCents, invoiceTotals.totalMarketplaceFeePostTaxInCents)
+        : 0;
+    const remainingAmountToPayInCents = totalAmountToPayInCents - platformBalanceAppliedInCents;
+    const remainingMarketplaceFeeAmountInCents = invoiceTotals.totalMarketplaceFeePostTaxInCents -
+        platformBalanceAppliedInCents;
+    return {
+        totalAmountToPayInCents,
+        remainingAmountToPayInCents,
+        remainingMarketplaceFeeAmountInCents,
+        platformBalanceAppliedInCents,
+    };
+}

package/dist/pricing/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./types";
 export * from "./utils";
 export * from "./calculateInvoiceTotalWithTax";
+export * from "./computeOrderPaymentBreakdownWithPlatformBalance";
 export * from "./constants";
 export * from "./enums";

package/dist/pricing/index.js

@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./calculateInvoiceTotalWithTax"), exports);
+__exportStar(require("./computeOrderPaymentBreakdownWithPlatformBalance"), exports);
 __exportStar(require("./constants"), exports);
 __exportStar(require("./enums"), exports);

package/dist/pricing/types/ComputeOrderPaymentBreakdownWithPlatformBalanceParams.type.d.ts

@@ -0,0 +1,5 @@
+import type { CalculateInvoiceTotalsWithTaxResult } from "./CalculateInvoiceTotalsWithTaxResult.type";
+export type ComputeOrderPaymentBreakdownWithPlatformBalanceParams = {
+    availablePlatformBalanceInCents: number;
+    invoiceTotals: Pick<CalculateInvoiceTotalsWithTaxResult, "totalPostTaxInCents" | "totalMarketplaceFeePostTaxInCents">;
+};

package/dist/pricing/types/ComputeOrderPaymentBreakdownWithPlatformBalanceParams.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/pricing/types/ComputeOrderPaymentBreakdownWithPlatformBalanceResult.type.d.ts

@@ -0,0 +1,6 @@
+export type ComputeOrderPaymentBreakdownWithPlatformBalanceResult = {
+    totalAmountToPayInCents: number;
+    remainingAmountToPayInCents: number;
+    remainingMarketplaceFeeAmountInCents: number;
+    platformBalanceAppliedInCents: number;
+};

package/dist/pricing/types/ComputeOrderPaymentBreakdownWithPlatformBalanceResult.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/pricing/types/index.d.ts

@@ -1,4 +1,6 @@
 export * from "./CalculateInvoiceTotalsWithTaxParams.type";
 export * from "./CalculateInvoiceTotalsWithTaxResult.type";
+export * from "./ComputeOrderPaymentBreakdownWithPlatformBalanceParams.type";
+export * from "./ComputeOrderPaymentBreakdownWithPlatformBalanceResult.type";
 export * from "./PricingPostTaxLine.type";
 export * from "./PricingPreTaxLine.type";

package/dist/pricing/types/index.js

@@ -16,5 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CalculateInvoiceTotalsWithTaxParams.type"), exports);
 __exportStar(require("./CalculateInvoiceTotalsWithTaxResult.type"), exports);
+__exportStar(require("./ComputeOrderPaymentBreakdownWithPlatformBalanceParams.type"), exports);
+__exportStar(require("./ComputeOrderPaymentBreakdownWithPlatformBalanceResult.type"), exports);
 __exportStar(require("./PricingPostTaxLine.type"), exports);
 __exportStar(require("./PricingPreTaxLine.type"), exports);

package/dist/pricing/utils/applyBasisPointsRateHalfUp.util.js

@@ -8,5 +8,5 @@ function applyBasisPointsRateHalfUp({ amountInCents, rateBasisPoints, }) {
     if (rateBasisPoints < 0 || rateBasisPoints > 10_000) {
         throw new Error("rateBasisPoints must be between 0 and 10000");
     }
-    return Math.floor((amountInCents * rateBasisPoints + 5_000) / 10_000);
+    return Math.round((amountInCents * rateBasisPoints) / 10_000);
 }

package/dist/pricing/utils/stubs/computeOrderPaymentBreakdownWithPlatformBalanceStub.d.ts

@@ -0,0 +1,2 @@
+import type { ComputeOrderPaymentBreakdownWithPlatformBalanceResult } from "../../types";
+export declare function computeOrderPaymentBreakdownWithPlatformBalanceStub(overwrite?: Partial<ComputeOrderPaymentBreakdownWithPlatformBalanceResult>): ComputeOrderPaymentBreakdownWithPlatformBalanceResult;

package/dist/pricing/utils/stubs/computeOrderPaymentBreakdownWithPlatformBalanceStub.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeOrderPaymentBreakdownWithPlatformBalanceStub = computeOrderPaymentBreakdownWithPlatformBalanceStub;
+function computeOrderPaymentBreakdownWithPlatformBalanceStub(overwrite = {}) {
+    return {
+        totalAmountToPayInCents: 0,
+        remainingAmountToPayInCents: 0,
+        remainingMarketplaceFeeAmountInCents: 0,
+        platformBalanceAppliedInCents: 0,
+        ...overwrite,
+    };
+}

package/dist/pricing/utils/stubs/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./calculateInvoiceTotalWithTaxStub";
+export * from "./computeOrderPaymentBreakdownWithPlatformBalanceStub";
 export * from "./pricingPostTaxLineStub";
 export * from "./pricingPreTaxLineStub";

package/dist/pricing/utils/stubs/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./calculateInvoiceTotalWithTaxStub"), exports);
+__exportStar(require("./computeOrderPaymentBreakdownWithPlatformBalanceStub"), exports);
 __exportStar(require("./pricingPostTaxLineStub"), exports);
 __exportStar(require("./pricingPreTaxLineStub"), exports);

package/dist/stripe/types/StripeCustomRefundMetadata.type.d.ts

@@ -0,0 +1,8 @@
+export type StripeCustomRefundMetadata = {
+    orderDocumentId: string;
+    orderRefundIntentDocumentId: string;
+    firestoreCustomerUserDocumentId: string;
+    firestoreCustomerEntityDocumentId: string;
+    firestoreServiceProviderUserDocumentId: string;
+    firestoreServiceProviderEntityDocumentId: string;
+};

package/dist/stripe/types/StripeCustomRefundMetadata.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/stripe/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./StripeCustomPaymentIntentMetadata.type";
+export * from "./StripeCustomRefundMetadata.type";
 export * from "./StripeCustomServiceProviderPayoutMetadata.type";

package/dist/stripe/types/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./StripeCustomPaymentIntentMetadata.type"), exports);
+__exportStar(require("./StripeCustomRefundMetadata.type"), exports);
 __exportStar(require("./StripeCustomServiceProviderPayoutMetadata.type"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doctocar/tooling",
-  "version": "0.3.1-32",
+  "version": "0.3.1-33",
   "description": "A set of tools for DoctoCar projects",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",