@medusajs/types 3.0.0-snapshot-20250410105645 → 3.0.0-snapshot-20251104004624

package/dist/promotion/common/index.d.ts

@@ -2,6 +2,7 @@ export * from "./application-method";
 export * from "./campaign";
 export * from "./campaign-budget";
 export * from "./compute-actions";
+export * from "./campaing-budget-usage";
 export * from "./promotion";
 export * from "./promotion-rule";
 export * from "./promotion-rule-value";

package/dist/promotion/common/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,wBAAwB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,wBAAwB,CAAA"}

package/dist/promotion/common/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./application-method"), exports);
 __exportStar(require("./campaign"), exports);
 __exportStar(require("./campaign-budget"), exports);
 __exportStar(require("./compute-actions"), exports);
+__exportStar(require("./campaing-budget-usage"), exports);
 __exportStar(require("./promotion"), exports);
 __exportStar(require("./promotion-rule"), exports);
 __exportStar(require("./promotion-rule-value"), exports);

package/dist/promotion/common/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/promotion/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,6CAA0B;AAC1B,oDAAiC;AACjC,oDAAiC;AACjC,8CAA2B;AAC3B,mDAAgC;AAChC,yDAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/promotion/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAoC;AACpC,6CAA0B;AAC1B,oDAAiC;AACjC,oDAAiC;AACjC,0DAAuC;AACvC,8CAA2B;AAC3B,mDAAgC;AAChC,yDAAsC"}

package/dist/promotion/common/promotion.d.ts

@@ -47,6 +47,10 @@ export interface PromotionDTO {
      * Whether the promotion is applied automatically.
      */
     is_automatic?: boolean;
+    /**
+     * Whether the promotion is tax inclusive.
+     */
+    is_tax_inclusive?: boolean;
     /**
      * The associated application method.
      */
@@ -92,6 +96,10 @@ export interface CreatePromotionDTO {
      * Whether the promotion is applied automatically.
      */
     is_automatic?: boolean;
+    /**
+     * Whether the promotion is tax inclusive.
+     */
+    is_tax_inclusive?: boolean;
     /**
      * The associated application method.
      */
@@ -129,6 +137,10 @@ export interface UpdatePromotionDTO {
      * The type of the promotion.
      */
     type?: PromotionTypeValues;
+    /**
+     * Whether the promotion is tax inclusive.
+     */
+    is_tax_inclusive?: boolean;
     /**
      * The status of the promotion:
      *

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

@@ -1 +1 @@
-{"version":3,"file":"promotion.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACjE,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAE3E;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEnE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,CAAA;AAEnE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAE1B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,oBAAoB,CAAA;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;OAMG;IACH,IAAI,EAAE,mBAAmB,CAAA;IAEzB;;;;;;OAMG;IACH,MAAM,EAAE,qBAAqB,CAAA;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,kBAAkB,EAAE,0BAA0B,CAAA;IAE9C;;OAEG;IACH,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAE1B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,IAAI,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAA;IAE3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE1C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,CAAA;CACnC"}
+{"version":3,"file":"promotion.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACjE,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAE3E;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEnE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,CAAA;AAEnE;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAE1B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,oBAAoB,CAAA;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;OAMG;IACH,IAAI,EAAE,mBAAmB,CAAA;IAEzB;;;;;;OAMG;IACH,MAAM,EAAE,qBAAqB,CAAA;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,kBAAkB,EAAE,0BAA0B,CAAA;IAE9C;;OAEG;IACH,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,IAAI,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAA;IAE3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE1C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,CAAA;CACnC"}

package/dist/promotion/mutations.d.ts

@@ -19,6 +19,16 @@ export interface CreateCampaignBudgetDTO {
      * The currency of the campaign.
      */
     currency_code?: string | null;
+    /**
+     * The attribute that the budget limit is applied to. By default,
+     * the budget is applied globally. If the type is `use_by_attribute`, this field indicates the
+     * attribute the budget is tracked by. For example, `customer_id` means the budget is tracked per customer.
+     *
+     * @example
+     * customer_id
+     * @since 2.11.0
+     */
+    attribute?: string | null;
 }
 /**
  * The attributes to update in the campaign budget.

package/dist/promotion/mutations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/promotion/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,CAAA;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,CAAA;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB"}
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/promotion/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,CAAA;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,CAAA;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB"}

package/dist/promotion/service.d.ts

@@ -2,7 +2,7 @@ import { FindConfig } from "../common";
 import { RestoreReturn, SoftDeleteReturn } from "../dal";
 import { IModuleService } from "../modules-sdk";
 import { Context } from "../shared-context";
-import { CampaignDTO, ComputeActionContext, ComputeActions, CreatePromotionDTO, CreatePromotionRuleDTO, FilterableCampaignProps, FilterablePromotionProps, FilterablePromotionRuleProps, PromotionDTO, PromotionRuleDTO, UpdatePromotionDTO, UpdatePromotionRuleDTO, UsageComputedActions } from "./common";
+import { CampaignDTO, CampaignBudgetUsageContext, ComputeActionContext, ComputeActions, CreatePromotionDTO, CreatePromotionRuleDTO, FilterableCampaignProps, FilterablePromotionProps, FilterablePromotionRuleProps, PromotionDTO, PromotionRuleDTO, UpdatePromotionDTO, UpdatePromotionRuleDTO, UsageComputedActions } from "./common";
 import { AddPromotionsToCampaignDTO, CreateCampaignDTO, RemovePromotionsFromCampaignDTO, UpdateCampaignDTO } from "./mutations";
 /**
  * The main service interface for the Promotion Module.
@@ -14,6 +14,7 @@ export interface IPromotionModuleService extends IModuleService {
      * computed actions.
      *
      * @param {UsageComputedActions[]} computedActions - The computed actions to adjust their promotion's campaign budget.
+     * @param {CampaignBudgetUsageContext} registrationContext - The context of the campaign budget usage.
      * @returns {Promise<void>} Resolves when the campaign budgets have been adjusted successfully.
      *
      * @example
@@ -28,12 +29,13 @@ export interface IPromotionModuleService extends IModuleService {
      *   },
      * ])
      */
-    registerUsage(computedActions: UsageComputedActions[]): Promise<void>;
+    registerUsage(computedActions: UsageComputedActions[], registrationContext: CampaignBudgetUsageContext): Promise<void>;
     /**
      * This method is used to revert the changes made by registerUsage action
      *
      * @param {UsageComputedActions[]} computedActions - The computed actions to adjust their promotion's campaign budget.
-     * @returns {Promise<void>} Resolves when the campaign budgets have been adjusted successfully.
+     * @param {CampaignBudgetUsageContext} registrationContext - The context of the campaign budget usage.
+     * @returns {Promise<void>} Resolves when the campaign budgets have been reverted successfully.
      *
      * @example
      * await promotionModuleService.revertUsage([
@@ -47,7 +49,7 @@ export interface IPromotionModuleService extends IModuleService {
      *   },
      * ])
      */
-    revertUsage(computedActions: UsageComputedActions[]): Promise<void>;
+    revertUsage(computedActions: UsageComputedActions[], registrationContext: CampaignBudgetUsageContext): Promise<void>;
     /**
      * This method provides the actions to perform on a cart based on the specified promotions
      * and context.
@@ -96,6 +98,7 @@ export interface IPromotionModuleService extends IModuleService {
      *   {
      *     code: "50OFF",
      *     type: "standard",
+     *     status: "active",
      *     application_method: {
      *       type: "percentage",
      *       target_type: "items",
@@ -105,6 +108,7 @@ export interface IPromotionModuleService extends IModuleService {
      *   {
      *     code: "FREESHIPPING",
      *     type: "standard",
+     *     status: "active",
      *     application_method: {
      *       type: "percentage",
      *       target_type: "shipping_methods",
@@ -114,6 +118,7 @@ export interface IPromotionModuleService extends IModuleService {
      *   {
      *     code: "BUY2GET1",
      *     type: "buyget",
+     *     status: "active",
      *     application_method: {
      *       type: "fixed",
      *       target_type: "items",
@@ -142,6 +147,7 @@ export interface IPromotionModuleService extends IModuleService {
      * const promotionA = await promotionModuleService.createPromotions({
      *   code: "50OFF",
      *   type: "standard",
+     *   status: "active",
      *   application_method: {
      *     type: "percentage",
      *     target_type: "items",
@@ -152,6 +158,7 @@ export interface IPromotionModuleService extends IModuleService {
      * const promotionB = await promotionModuleService.createPromotions({
      *   code: "FREESHIPPING",
      *   type: "standard",
+     *   status: "active",
      *   application_method: {
      *     type: "percentage",
      *     target_type: "shipping_methods",
@@ -162,6 +169,7 @@ export interface IPromotionModuleService extends IModuleService {
      * const promotionC = await promotionModuleService.createPromotions({
      *   code: "BUY2GET1",
      *   type: "buyget",
+     *   status: "active",
      *   application_method: {
      *     type: "fixed",
      *     target_type: "items",
@@ -228,6 +236,13 @@ export interface IPromotionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the promotions:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const promotions = await promotionModuleService.listPromotions(
      *   {
@@ -276,6 +291,13 @@ export interface IPromotionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the promotions:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const [promotions, count] =
      *   await promotionModuleService.listAndCountPromotions(
@@ -324,6 +346,13 @@ export interface IPromotionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const promotion = await promotionModuleService.retrievePromotion(
      *   "promo_123",
@@ -602,6 +631,13 @@ export interface IPromotionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the promotion rules:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const promotionRules =
      *   await promotionModuleService.listPromotionRules(
@@ -668,6 +704,13 @@ export interface IPromotionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the campaigns:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const campaigns = await promotionModuleService.listCampaigns(
      *   {
@@ -716,6 +759,13 @@ export interface IPromotionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the campaigns:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const [campaigns, count] =
      *   await promotionModuleService.listAndCountCampaigns(
@@ -764,6 +814,13 @@ export interface IPromotionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const campaign =
      *   await promotionModuleService.retrieveCampaign(

package/dist/promotion/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/promotion/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,WAAW,EACX,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,4BAA4B,EAC5B,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,0BAA0B,EAC1B,iBAAiB,EACjB,+BAA+B,EAC/B,iBAAiB,EAClB,MAAM,aAAa,CAAA;AAEpB;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CAAC,eAAe,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,eAAe,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,cAAc,CACZ,qBAAqB,EAAE,MAAM,EAAE,EAC/B,kBAAkB,EAAE,oBAAoB,EACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,cAAc,CACZ,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,sBAAsB,CACpB,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvE;;;;;;;;;OASG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAClE,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC/D,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,iBAAiB,CACf,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;OAaG;IACH,0BAA0B,CACxB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;OAaG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAClB,IAAI,EAAE,sBAAsB,EAAE,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtE;;;;;;;;;OASG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAAmB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACjE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,gBAAgB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC9D,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C,uBAAuB,CACrB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAA;IAE7B,4BAA4B,CAC1B,IAAI,EAAE,+BAA+B,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAA;CAC9B"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/promotion/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,WAAW,EACX,0BAA0B,EAC1B,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,4BAA4B,EAC5B,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,0BAA0B,EAC1B,iBAAiB,EACjB,+BAA+B,EAC/B,iBAAiB,EAClB,MAAM,aAAa,CAAA;AAEpB;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa,CACX,eAAe,EAAE,oBAAoB,EAAE,EACvC,mBAAmB,EAAE,0BAA0B,GAC9C,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CACT,eAAe,EAAE,oBAAoB,EAAE,EACvC,mBAAmB,EAAE,0BAA0B,GAC9C,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,cAAc,CACZ,qBAAqB,EAAE,MAAM,EAAE,EAC/B,kBAAkB,EAAE,oBAAoB,EACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC5B,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EAAE,EAC1B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,IAAI,EAAE,kBAAkB,EACxB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,cAAc,CACZ,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,sBAAsB,CACpB,OAAO,CAAC,EAAE,wBAAwB,EAClC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,YAAY,CAAC,CAAA;IAExB;;;;;;;;;;;;OAYG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvE;;;;;;;;;OASG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErE;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAClE,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC/D,YAAY,EAAE,MAAM,GAAG,MAAM,EAAE,EAC/B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,iBAAiB,CACf,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,sBAAsB,EAAE,EACnC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;OAaG;IACH,0BAA0B,CACxB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CACrB,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EAAE,EACjB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EAAE,EACzB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;OAaG;IACH,eAAe,CACb,IAAI,EAAE,iBAAiB,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAClB,IAAI,EAAE,sBAAsB,EAAE,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,uBAAuB,EACjC,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,WAAW,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEtE;;;;;;;;;OASG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAAmB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACjE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,gBAAgB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC9D,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,EAC9B,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C,uBAAuB,CACrB,IAAI,EAAE,0BAA0B,EAChC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAA;IAE7B,4BAA4B,CAC1B,IAAI,EAAE,+BAA+B,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAA;CAC9B"}

package/dist/region/service.d.ts

@@ -152,6 +152,13 @@ export interface IRegionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const region = await regionModuleService.retrieveRegion("reg_123", {
      *   relations: ["countries"],
@@ -179,6 +186,13 @@ export interface IRegionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the regions:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const regions = await regionModuleService.listRegions(
      *   {
@@ -227,6 +241,13 @@ export interface IRegionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the regions:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const [regions, count] =
      *   await regionModuleService.listAndCountRegions(
@@ -275,6 +296,13 @@ export interface IRegionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const country = await regionModuleService.retrieveCountry(
      *   "us",
@@ -305,6 +333,13 @@ export interface IRegionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the countries:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const countries = await regionModuleService.listCountries(
      *   {
@@ -353,6 +388,13 @@ export interface IRegionModuleService extends IModuleService {
      *
      * To specify relations that should be retrieved within the countries:
      *
+     * :::note
+     *
+     * You can only retrieve data models defined in the same module. To retrieve linked data models
+     * from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
+     *
+     * :::
+     *
      * ```ts
      * const [countries, count] =
      *   await regionModuleService.listAndCountCountries(

package/dist/region/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/region/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,gBAAgB,EAChB,SAAS,EACV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EAAE,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EAAE,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,WAAW,CACT,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,mBAAmB,CACjB,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC/D,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC5D,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/region/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,gBAAgB,EAChB,SAAS,EACV,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EAAE,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EAAE,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,WAAW,CACT,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,mBAAmB,CACjB,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,eAAe,CACb,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,aAAa,CACX,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,qBAAqB,CACnB,OAAO,CAAC,EAAE,4BAA4B,EACtC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,EACrC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,gBAAgB,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC/D,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAC5D,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}

package/dist/settings/common.d.ts

@@ -0,0 +1,151 @@
+import { BaseFilterable } from "../dal";
+/**
+ * The view configuration data model.
+ */
+export interface ViewConfigurationDTO {
+    /**
+     * The ID of the configuration.
+     */
+    id: string;
+    /**
+     * The entity this configuration is for.
+     */
+    entity: string;
+    /**
+     * The name of the configuration.
+     */
+    name: string;
+    /**
+     * The user ID this configuration belongs to.
+     */
+    user_id: string | null;
+    /**
+     * Whether this is a system default configuration.
+     */
+    is_system_default: boolean;
+    /**
+     * The configuration data.
+     */
+    configuration: {
+        /**
+         * The visible columns.
+         */
+        visible_columns: string[];
+        /**
+         * The column order.
+         */
+        column_order: string[];
+        /**
+         * The column widths.
+         */
+        column_widths?: Record<string, number>;
+        /**
+         * The filters to apply.
+         */
+        filters?: Record<string, any>;
+        /**
+         * The sorting configuration.
+         */
+        sorting?: {
+            id: string;
+            desc: boolean;
+        } | null;
+        /**
+         * The search string.
+         */
+        search?: string;
+    };
+    /**
+     * The date the configuration was created.
+     */
+    created_at: Date;
+    /**
+     * The date the configuration was last updated.
+     */
+    updated_at: Date;
+}
+/**
+ * The user preference data model.
+ */
+export interface UserPreferenceDTO {
+    /**
+     * The ID of the preference.
+     */
+    id: string;
+    /**
+     * The user ID.
+     */
+    user_id: string;
+    /**
+     * The preference key.
+     */
+    key: string;
+    /**
+     * The preference value.
+     */
+    value: any;
+    /**
+     * The date the preference was created.
+     */
+    created_at: Date;
+    /**
+     * The date the preference was last updated.
+     */
+    updated_at: Date;
+}
+/**
+ * Partial filters for view configuration fields.
+ */
+export interface ViewConfigurationFilterableFields {
+    /**
+     * The IDs to filter by.
+     */
+    id?: string | string[];
+    /**
+     * Filter by entity name.
+     */
+    entity?: string | string[];
+    /**
+     * Filter by user ID.
+     */
+    user_id?: string | string[] | null;
+    /**
+     * Filter by system default flag.
+     */
+    is_system_default?: boolean;
+    /**
+     * Filter by name.
+     */
+    name?: string | string[];
+}
+/**
+ * The filters to apply on the retrieved view configurations.
+ */
+export interface FilterableViewConfigurationProps extends ViewConfigurationFilterableFields {
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.
+     */
+    $and?: (ViewConfigurationFilterableFields | FilterableViewConfigurationProps)[];
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.
+     */
+    $or?: (ViewConfigurationFilterableFields | FilterableViewConfigurationProps)[];
+}
+/**
+ * The filters to apply on the retrieved user preferences.
+ */
+export interface FilterableUserPreferenceProps extends BaseFilterable<UserPreferenceDTO> {
+    /**
+     * The IDs to filter by.
+     */
+    id?: string | string[];
+    /**
+     * Filter by user ID.
+     */
+    user_id?: string | string[];
+    /**
+     * Filter by preference key.
+     */
+    key?: string | string[];
+}
+//# sourceMappingURL=common.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/settings/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AAEvC;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,aAAa,EAAE;QACb;;WAEG;QACH,eAAe,EAAE,MAAM,EAAE,CAAA;QAEzB;;WAEG;QACH,YAAY,EAAE,MAAM,EAAE,CAAA;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAEtC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;QAE7B;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,OAAO,CAAA;SAAE,GAAG,IAAI,CAAA;QAE9C;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;IAED;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,KAAK,EAAE,GAAG,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAElC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,iCAAiC;IACzF;;OAEG;IACH,IAAI,CAAC,EAAE,CAAC,iCAAiC,GAAG,gCAAgC,CAAC,EAAE,CAAA;IAE/E;;OAEG;IACH,GAAG,CAAC,EAAE,CAAC,iCAAiC,GAAG,gCAAgC,CAAC,EAAE,CAAA;CAC/E;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,cAAc,CAAC,iBAAiB,CAAC;IACtF;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAE3B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACxB"}

package/dist/settings/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/dist/settings/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/settings/common.ts"],"names":[],"mappings":""}

package/dist/settings/index.d.ts

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

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

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

package/dist/settings/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+__exportStar(require("./mutations"), exports);
+__exportStar(require("./service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/settings/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/settings/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,8CAA2B;AAC3B,4CAAyB"}