feat(core-flows,dashboard,js-sdk,promotion,medusa,types,utils): limit promotion usage per customer (#13451)

**What**
- implement promotion usage limits per customer/email
- fix registering spend usage over the limit
- fix type errors in promotion module tests

**How**
- introduce a new type of campaign budget that can be defined by an attribute such as customer id or email
- add `CampaignBudgetUsage` entity to keep track of the number of uses per attribute value
- update `registerUsage` and `computeActions` in the promotion module to work with the new type
- update `core-flows` to pass context needed for usage calculation to the promotion module

**Breaking**
- registering promotion usage now throws (and cart complete fails) if the budget limit is exceeded or if the cart completion would result in a breached limit

---

CLOSES CORE-1172
CLOSES CORE-1173
CLOSES CORE-1174
CLOSES CORE-1175


Co-authored-by: Adrien de Peretti <25098370+adrien2p@users.noreply.github.com>

packages/modules/promotion/src/models/campaign-budget-usage.ts

@@ -0,0 +1,27 @@
+import { model } from "@medusajs/framework/utils"
+import CampaignBudget from "./campaign-budget"
+
+const CampaignBudgetUsage = model
+  .define(
+    {
+      name: "CampaignBudgetUsage",
+      tableName: "promotion_campaign_budget_usage",
+    },
+    {
+      id: model.id({ prefix: "probudgus" }).primaryKey(),
+      attribute_value: model.text(), // e.g. "cus_123" | "john.smith@gmail.com"
+      used: model.bigNumber().default(0),
+      budget: model.belongsTo(() => CampaignBudget, {
+        mappedBy: "usages",
+      }),
+    }
+  )
+  .indexes([
+    {
+      on: ["attribute_value", "budget_id"],
+      unique: true,
+      where: "deleted_at IS NULL",
+    },
+  ])
+
+export default CampaignBudgetUsage

packages/modules/promotion/src/models/campaign-budget.ts

@@ -1,20 +1,32 @@
 import { PromotionUtils, model } from "@medusajs/framework/utils"
 import Campaign from "./campaign"
+import CampaignBudgetUsage from "./campaign-budget-usage"
 
-const CampaignBudget = model.define(
-  { name: "CampaignBudget", tableName: "promotion_campaign_budget" },
-  {
-    id: model.id({ prefix: "probudg" }).primaryKey(),
-    type: model
-      .enum(PromotionUtils.CampaignBudgetType)
-      .index("IDX_campaign_budget_type"),
-    currency_code: model.text().nullable(),
-    limit: model.bigNumber().nullable(),
-    used: model.bigNumber().default(0),
-    campaign: model.belongsTo(() => Campaign, {
-      mappedBy: "budget",
-    }),
-  }
-)
+const CampaignBudget = model
+  .define(
+    { name: "CampaignBudget", tableName: "promotion_campaign_budget" },
+    {
+      id: model.id({ prefix: "probudg" }).primaryKey(),
+      type: model
+        .enum(PromotionUtils.CampaignBudgetType)
+        .index("IDX_campaign_budget_type"),
+      currency_code: model.text().nullable(),
+      limit: model.bigNumber().nullable(),
+      used: model.bigNumber().default(0),
+      campaign: model.belongsTo(() => Campaign, {
+        mappedBy: "budget",
+      }),
+
+      attribute: model.text().nullable(), // e.g. "customer_id", "customer_email"
+
+      // usages when budget type is "limit/use by attribute"
+      usages: model.hasMany(() => CampaignBudgetUsage, {
+        mappedBy: "budget",
+      }),
+    }
+  )
+  .cascades({
+    delete: ["usages"],
+  })
 
 export default CampaignBudget

packages/modules/promotion/src/models/index.ts

@@ -4,3 +4,4 @@ export { default as CampaignBudget } from "./campaign-budget"
 export { default as Promotion } from "./promotion"
 export { default as PromotionRule } from "./promotion-rule"
 export { default as PromotionRuleValue } from "./promotion-rule-value"
+export { default as CampaignBudgetUsage } from "./campaign-budget-usage"