@mercurjs/types 2.3.4-canary.6 → 2.3.4-canary.7

package/dist/commission/common.d.ts

@@ -26,10 +26,12 @@ export type CommissionLineDTO = {
     item_id: string | null;
     shipping_method_id: string | null;
     commission_rate_id: string | null;
+    provider_id: string;
     code: string;
     rate: number;
     amount: number;
     description: string | null;
+    data: Record<string, unknown> | null;
     created_at: Date;
     updated_at: Date;
     deleted_at: Date | null;
@@ -64,6 +66,10 @@ export interface CommissionCalculationItemLine {
      * The tax total of the line item (used when include_tax is true).
      */
     tax_total?: BigNumberInput;
+    /**
+     * Line total after discounts — the ceiling a provider must not exceed.
+     */
+    total?: BigNumberInput;
     /**
      * The product of the line item.
      */
@@ -80,6 +86,7 @@ export interface CommissionCalculationItemLine {
         seller?: {
             id: string;
         };
+        attribute_value_ids?: string[];
     };
 }
 export interface CommissionCalculationShippingLine {
@@ -101,6 +108,14 @@ export interface CommissionCalculationContext {
      * The cart's currency
      */
     currency_code: string;
+    /**
+     * The order the lines are computed for, when known.
+     */
+    order_id?: string;
+    /**
+     * The seller the order belongs to, when known.
+     */
+    seller_id?: string;
     /**
      * The cart's line items.
      */
@@ -109,15 +124,23 @@ export interface CommissionCalculationContext {
      * The cart's shipping methods.
      */
     shipping_methods?: CommissionCalculationShippingLine[];
+    /**
+     * Data for the active provider that the framework fields do not carry,
+     * populated by the `setCommissionContext` hook of
+     * `refreshOrderCommissionLinesWorkflow`.
+     */
+    additional_context?: Record<string, unknown>;
 }
 export interface CreateCommissionLineDTO {
     item_id?: string | null;
     shipping_method_id?: string | null;
-    commission_rate_id: string;
+    commission_rate_id?: string | null;
+    provider_id?: string;
     code: string;
     rate: number;
     amount: number;
     description?: string | null;
+    data?: Record<string, unknown> | null;
 }
 export interface UpdateCommissionLineDTO extends Partial<CreateCommissionLineDTO> {
     id: string;

package/dist/commission/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/commission/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,UAAU,eAAe;CAC1B;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,kBAAkB,CAAA;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,EAAE,OAAO,CAAA;IACpB,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACjC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAA;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAA;QACV,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,IAAI,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACvB,UAAU,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;KACxB,CAAA;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAA;CAC3B;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,6BAA6B,EAAE,CAAA;IAEvC;;OAEG;IACH,gBAAgB,CAAC,EAAE,iCAAiC,EAAE,CAAA;CACvD;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,uBAAuB,CAAC;IAC/E,EAAE,EAAE,MAAM,CAAA;CACX"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/commission/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,UAAU,eAAe;CAC1B;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,kBAAkB,CAAA;IACxB,KAAK,EAAE,MAAM,CAAA;IACb,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,WAAW,EAAE,OAAO,CAAA;IACpB,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,MAAM,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACjC,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,CAAA;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,EAAE,EAAE,MAAM,CAAA;QACV,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,IAAI,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACvB,UAAU,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAA;QACvB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,cAAc,CAAA;IAExB;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAA;CAC3B;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,6BAA6B,EAAE,CAAA;IAEvC;;OAEG;IACH,gBAAgB,CAAC,EAAE,iCAAiC,EAAE,CAAA;IAEtD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CACtC;AAED,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,uBAAuB,CAAC;IAC/E,EAAE,EAAE,MAAM,CAAA;CACX"}

package/dist/commission/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./common";
 export * from "./mutations";
+export * from "./provider";
 //# sourceMappingURL=index.d.ts.map

package/dist/commission/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/commission/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/commission/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/dist/commission/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./common"), exports);
 __exportStar(require("./mutations"), exports);
+__exportStar(require("./provider"), exports);

package/dist/commission/provider.d.ts

@@ -0,0 +1,43 @@
+import type { ModuleProviderExports } from "@medusajs/types";
+import type { CommissionCalculationContext, CreateCommissionLineDTO } from "./common";
+export interface ICommissionProvider {
+    /**
+     * Compute the commission lines for an order-shaped context. Returned lines
+     * without a `provider_id` are stamped with the provider's registration id.
+     */
+    getCommissionLines(context: CommissionCalculationContext): Promise<CreateCommissionLineDTO[]>;
+}
+export interface CommissionModuleOptions {
+    /**
+     * Providers to be registered next to the built-in `system` provider.
+     */
+    providers?: {
+        /**
+         * The module provider to be registered
+         */
+        resolve: string | ModuleProviderExports;
+        /**
+         * The id of the provider
+         */
+        id: string;
+        /**
+         * Key value pair of the configuration to be passed to the provider constructor
+         */
+        options?: Record<string, unknown>;
+        /**
+         * Use this provider for every calculation. A single configured provider
+         * is the default implicitly.
+         */
+        is_default?: boolean;
+    }[];
+    /**
+     * Provider id used when a calculation names none. Defaults to the built-in `system`.
+     */
+    default_provider?: string;
+}
+declare module "@medusajs/types" {
+    interface ModuleOptions {
+        "@mercurjs/core/modules/commission": CommissionModuleOptions;
+    }
+}
+//# sourceMappingURL=provider.d.ts.map

package/dist/commission/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/commission/provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAA;AAE5D,OAAO,KAAK,EACV,4BAA4B,EAC5B,uBAAuB,EACxB,MAAM,UAAU,CAAA;AAEjB,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,kBAAkB,CAChB,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,uBAAuB,EAAE,CAAC,CAAA;CACtC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,qBAAqB,CAAA;QACvC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,EAAE,CAAA;IAEH;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED,OAAO,QAAQ,iBAAiB,CAAC;IAC/B,UAAU,aAAa;QACrB,mCAAmC,EAAE,uBAAuB,CAAA;KAC7D;CACF"}

package/dist/commission/provider.js

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

package/dist/http/shipping-profile.d.ts

@@ -1,4 +1,4 @@
-import { DeleteResponse, PaginatedResponse, ShippingProfileDTO } from "@medusajs/types";
+import { PaginatedResponse, ShippingProfileDTO } from "@medusajs/types";
 export interface VendorShippingProfileResponse {
     /**
      * The shipping profile's details.
@@ -11,5 +11,4 @@ export type VendorShippingProfileListResponse = PaginatedResponse<{
      */
     shipping_profiles: ShippingProfileDTO[];
 }>;
-export type VendorShippingProfileDeleteResponse = DeleteResponse<"shipping_profile">;
 //# sourceMappingURL=shipping-profile.d.ts.map

package/dist/http/shipping-profile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../src/http/shipping-profile.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,iBAAiB,CAAA;AAExB,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAA;CACrC;AAED,MAAM,MAAM,iCAAiC,GAAG,iBAAiB,CAAC;IAChE;;OAEG;IACH,iBAAiB,EAAE,kBAAkB,EAAE,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,MAAM,mCAAmC,GAAG,cAAc,CAAC,kBAAkB,CAAC,CAAA"}
+{"version":3,"file":"shipping-profile.d.ts","sourceRoot":"","sources":["../../src/http/shipping-profile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEvE,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,gBAAgB,EAAE,kBAAkB,CAAA;CACrC;AAED,MAAM,MAAM,iCAAiC,GAAG,iBAAiB,CAAC;IAChE;;OAEG;IACH,iBAAiB,EAAE,kBAAkB,EAAE,CAAA;CACxC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mercurjs/types",
-  "version": "2.3.4-canary.6",
+  "version": "2.3.4-canary.7",
   "repository": {
     "type": "git",
     "url": "https://github.com/mercurjs/mercur",