@shoppexio/storefront 1.0.106 → 1.0.107

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.107
+
+- Pause policy (Design Batch 4, feature 6). `dashboard()` (`@shoppexio/storefront/customer`) keeps a subscription's `pause` (`state` `scheduled` or `paused`, `starts_at`, `resume_at` or null, `reason`), `pause_options` (`starts_at`, `lengths` of 7, 14, 30, 60 or 90 `days` with their `resume_at`, `reason_enabled`, `pauses_left_after`) `pause_limit` (`pauses_per_year`, `available_again_at`) and `pause_access_roles` (the names of the Discord roles a pause takes, `[]` when it takes none, `null` when not known) instead of stripping them. `pauseSubscription(uniqid, { length_days, reason })` and `HeadlessCustomerClient.pauseSubscription(id, { lengthDays, reason })` send one of the offered lengths and an optional reason (`taking_a_break`, `too_expensive`, `not_using`, `not_working`, `other`); without a length the API pauses for the shop's longest pause. `resumeSubscription` also calls off a scheduled pause. The four fields are optional: absent until the API that sends them is deployed.
+
 ## 1.0.106
 
 - `dashboard()` (`@shoppexio/storefront/customer`) keeps a subscription's `open_renewal` (the renewal invoice to pay now: `uniqid`, `amount`, `currency`, `pay_by`, `pay_url`) and `hold_ends_at` (when an unpaid renewal's hold ends the subscription) instead of stripping them (PR #4099). Show "Pay now" from `open_renewal.pay_url`. It also keeps `ends_at`: when a subscription set to end without renewing ends (cancelled at the period end, or a voided renewal); show "Ends" from it instead of reading `cancel_at_period_end`. The three fields are optional: absent until the API that sends them is deployed.

package/dist/{chunk-INBEHRZN.js → chunk-P7MN6RXP.js}

@@ -20070,8 +20070,27 @@ var customerPortalSubscriptionSummarySchema = external_exports.object({
     amount: external_exports.string(),
     currency: external_exports.string(),
     pay_by: external_exports.string(),
-    pay_url: external_exports.string()
-  }).nullable().optional()
+    pay_url: external_exports.string(),
+    interval: external_exports.string(),
+    interval_count: external_exports.number()
+  }).nullable().optional(),
+  // The pause policy (me.routes.ts, buyerPauseView): the open pause, the lengths a new pause
+  // can take, or the yearly limit. Optional for the same deploy order.
+  pause: external_exports.object({
+    state: external_exports.enum(["scheduled", "paused"]),
+    starts_at: external_exports.string(),
+    resume_at: nullableStringSchema,
+    reason: external_exports.enum(["taking_a_break", "too_expensive", "not_using", "not_working", "other"]).nullable()
+  }).nullable().optional(),
+  pause_options: external_exports.object({
+    starts_at: external_exports.string(),
+    lengths: external_exports.array(external_exports.object({ days: external_exports.union([external_exports.literal(7), external_exports.literal(14), external_exports.literal(30), external_exports.literal(60), external_exports.literal(90)]), resume_at: external_exports.string() })),
+    reason_enabled: external_exports.boolean(),
+    pauses_left_after: external_exports.number()
+  }).nullable().optional(),
+  pause_limit: external_exports.object({ pauses_per_year: external_exports.number(), available_again_at: external_exports.string() }).nullable().optional(),
+  // The Discord roles a pause takes ([] none); null when not known. Optional for deploy order.
+  pause_access_roles: external_exports.array(external_exports.string()).nullable().optional()
 });
 var customerLoyaltySchema = external_exports.object({
   enabled: external_exports.boolean(),
@@ -20252,4 +20271,4 @@ export {
   customerPortalNotificationPreferencesSchema,
   customerPortalAffiliateCreateLinkSchema
 };
-//# sourceMappingURL=chunk-INBEHRZN.js.map
+//# sourceMappingURL=chunk-P7MN6RXP.js.map