@moonbase.sh/storefront-api 3.3.1 → 3.4.0

package/dist/index.cjs

@@ -46,6 +46,7 @@ __export(index_exports, {
   OfferUtils: () => OfferUtils,
   OrderStatus: () => OrderStatus,
   Platform: () => Platform,
+  SubscriptionCancellationReason: () => SubscriptionCancellationReason,
   SubscriptionStatus: () => SubscriptionStatus,
   TokenStore: () => TokenStore,
   imageWidths: () => imageWidths,
@@ -1382,6 +1383,15 @@ var SubscriptionStatus = /* @__PURE__ */ ((SubscriptionStatus2) => {
   SubscriptionStatus2["Completed"] = "Completed";
   return SubscriptionStatus2;
 })(SubscriptionStatus || {});
+var SubscriptionCancellationReason = /* @__PURE__ */ ((SubscriptionCancellationReason2) => {
+  SubscriptionCancellationReason2["TooExpensive"] = "TooExpensive";
+  SubscriptionCancellationReason2["Unused"] = "Unused";
+  SubscriptionCancellationReason2["MissingFeatures"] = "MissingFeatures";
+  SubscriptionCancellationReason2["TechnicalIssues"] = "TechnicalIssues";
+  SubscriptionCancellationReason2["SwitchedService"] = "SwitchedService";
+  SubscriptionCancellationReason2["Other"] = "Other";
+  return SubscriptionCancellationReason2;
+})(SubscriptionCancellationReason || {});
 
 // src/inventory/subscriptions/schemas.ts
 var baseMilestoneProgressEventSchema = import_zod13.z.object({
@@ -1455,8 +1465,19 @@ var SubscriptionEndpoints = class {
     const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}?${objectToQuery(options)}`, subscriptionSchema);
     return response.data;
   }
-  async cancel(subscriptionId) {
-    const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/cancel`, subscriptionSchema, { method: "POST" });
+  /**
+   * Turns off auto-renew. The customer keeps access until the subscription's current
+   * period ends. Pass `feedback` to record why they are cancelling.
+   */
+  async cancel(subscriptionId, feedback) {
+    var _a, _b;
+    const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/cancel`, subscriptionSchema, {
+      method: "POST",
+      body: {
+        reason: (_a = feedback == null ? void 0 : feedback.reason) != null ? _a : void 0,
+        comment: ((_b = feedback == null ? void 0 : feedback.comment) == null ? void 0 : _b.trim()) || void 0
+      }
+    });
     return response.data;
   }
   async renew(subscriptionId, returnUrl, embedded) {
@@ -2586,6 +2607,7 @@ var MoonbaseClient = class {
   OfferUtils,
   OrderStatus,
   Platform,
+  SubscriptionCancellationReason,
   SubscriptionStatus,
   TokenStore,
   imageWidths,

package/dist/index.d.cts

@@ -6539,6 +6539,27 @@ declare enum SubscriptionStatus {
     Cancelled = "Cancelled",
     Completed = "Completed"
 }
+/**
+ * Why a customer is cancelling a subscription, as they would pick it from a list. The
+ * merchant has two further reasons of its own that a customer cannot give.
+ */
+declare enum SubscriptionCancellationReason {
+    TooExpensive = "TooExpensive",
+    Unused = "Unused",
+    MissingFeatures = "MissingFeatures",
+    TechnicalIssues = "TechnicalIssues",
+    SwitchedService = "SwitchedService",
+    Other = "Other"
+}
+/**
+ * What a customer said about why they are cancelling. Both parts are optional, and
+ * the merchant sees them alongside the cancellation.
+ */
+interface SubscriptionCancellationFeedback {
+    reason?: SubscriptionCancellationReason | null;
+    /** Free text, at most 1000 characters. */
+    comment?: string | null;
+}
 type Subscription = z.infer<typeof subscriptionSchema>;
 type MilestoneProgress = z.infer<typeof milestoneProgressSchema>;
 
@@ -6551,7 +6572,11 @@ declare class SubscriptionEndpoints {
         toUpdatePaymentMethod?: boolean;
         returnUrl?: string;
     }): Promise<Subscription>;
-    cancel(subscriptionId: string): Promise<Subscription>;
+    /**
+     * Turns off auto-renew. The customer keeps access until the subscription's current
+     * period ends. Pass `feedback` to record why they are cancelling.
+     */
+    cancel(subscriptionId: string, feedback?: SubscriptionCancellationFeedback): Promise<Subscription>;
     renew(subscriptionId: string, returnUrl: string, embedded: boolean): Promise<{
         location: string;
     }>;
@@ -47157,4 +47182,4 @@ declare class MoonbaseClient {
     orders: OrderEndpoints;
 }
 
-export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, Architecture, type BundleLineItem, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, type SignUpOptions, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject };
+export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, Architecture, type BundleLineItem, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, type SignUpOptions, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, type SubscriptionCancellationFeedback, SubscriptionCancellationReason, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject };

package/dist/index.d.ts

@@ -6539,6 +6539,27 @@ declare enum SubscriptionStatus {
     Cancelled = "Cancelled",
     Completed = "Completed"
 }
+/**
+ * Why a customer is cancelling a subscription, as they would pick it from a list. The
+ * merchant has two further reasons of its own that a customer cannot give.
+ */
+declare enum SubscriptionCancellationReason {
+    TooExpensive = "TooExpensive",
+    Unused = "Unused",
+    MissingFeatures = "MissingFeatures",
+    TechnicalIssues = "TechnicalIssues",
+    SwitchedService = "SwitchedService",
+    Other = "Other"
+}
+/**
+ * What a customer said about why they are cancelling. Both parts are optional, and
+ * the merchant sees them alongside the cancellation.
+ */
+interface SubscriptionCancellationFeedback {
+    reason?: SubscriptionCancellationReason | null;
+    /** Free text, at most 1000 characters. */
+    comment?: string | null;
+}
 type Subscription = z.infer<typeof subscriptionSchema>;
 type MilestoneProgress = z.infer<typeof milestoneProgressSchema>;
 
@@ -6551,7 +6572,11 @@ declare class SubscriptionEndpoints {
         toUpdatePaymentMethod?: boolean;
         returnUrl?: string;
     }): Promise<Subscription>;
-    cancel(subscriptionId: string): Promise<Subscription>;
+    /**
+     * Turns off auto-renew. The customer keeps access until the subscription's current
+     * period ends. Pass `feedback` to record why they are cancelling.
+     */
+    cancel(subscriptionId: string, feedback?: SubscriptionCancellationFeedback): Promise<Subscription>;
     renew(subscriptionId: string, returnUrl: string, embedded: boolean): Promise<{
         location: string;
     }>;
@@ -47157,4 +47182,4 @@ declare class MoonbaseClient {
     orders: OrderEndpoints;
 }
 
-export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, Architecture, type BundleLineItem, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, type SignUpOptions, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject };
+export { type Activation, ActivationMethod, type ActivationRequest, ActivationRequestFulfillmentType, ActivationRequestStatus, ActivationStatus, type Address, Architecture, type BundleLineItem, type CartCatalog, type CartOrder, type CartTotal, type CartTotalCondition, CartUtils, type CommunicationPreferences, type CommunicationPreferencesInput, type CommunicationPreferencesView, type CompletedOrder, ConnectableAccountProvider, type ConnectedAccount, ConsoleLogger, CycleLength, type Discount, DiscountUtils, type Download, type DownloadManifest, type ILogger, type IRecurrence, type IStore, type ITokenStore, type Identity, type ImageFit, type ImageFormat, type ImageTransform, ImageUtils, InMemoryStore, type License, LicenseStatus, type LineItem, type LineItemTotal, LocalStorageStore, LogLevel, MarketingConsentType, type MilestoneProgress, type Money, type MoneyCollection, MoneyCollectionUtils, MoonbaseApi, MoonbaseClient, type MoonbaseConfiguration, MoonbaseError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, type OfferCondition, type OfferConditionContext, type OfferProgress, type OfferScope, OfferUtils, type OpenOrder, type Order, OrderStatus, type OrderTotal, type OwnedProduct, type Page, Platform, type PricingTier, type PricingVariation, type ProblemDetails, type ProductLineItem, type PromotionDisplay, type Quantifiable, type RawPropertyArray, type RawPropertyObject, type RawPropertyValue, type SignUpOptions, type SignUpResult, type SingleOrMultiple, type Storefront, type StorefrontBundle, type StorefrontOffer, type StorefrontOfferTarget, type StorefrontProduct, type StorefrontPromotion, type StorefrontPromotionCta, type StorefrontPromotionTarget, type SubscribeInput, type SubscribeResponse, type Subscription, type SubscriptionCancellationFeedback, SubscriptionCancellationReason, SubscriptionStatus, type TaxEstimate, TokenStore, type UrchinTrackingModule, type User, type UserAccountConfirmed, type UserAccountConfirmedStatus, type Vendor, type Voucher, imageWidths, isLocalStorageAvailable, isPromotionDisplay, isTransformableImageUrl, maxImageDimension, normalizeGroupIds, objectToQuery, parseOffSiteReferrer, problemDetailsSchema, promotionDisplays, resolveUtm, schemas, utmToObject };

package/dist/index.js

@@ -1322,6 +1322,15 @@ var SubscriptionStatus = /* @__PURE__ */ ((SubscriptionStatus2) => {
   SubscriptionStatus2["Completed"] = "Completed";
   return SubscriptionStatus2;
 })(SubscriptionStatus || {});
+var SubscriptionCancellationReason = /* @__PURE__ */ ((SubscriptionCancellationReason2) => {
+  SubscriptionCancellationReason2["TooExpensive"] = "TooExpensive";
+  SubscriptionCancellationReason2["Unused"] = "Unused";
+  SubscriptionCancellationReason2["MissingFeatures"] = "MissingFeatures";
+  SubscriptionCancellationReason2["TechnicalIssues"] = "TechnicalIssues";
+  SubscriptionCancellationReason2["SwitchedService"] = "SwitchedService";
+  SubscriptionCancellationReason2["Other"] = "Other";
+  return SubscriptionCancellationReason2;
+})(SubscriptionCancellationReason || {});
 
 // src/inventory/subscriptions/schemas.ts
 var baseMilestoneProgressEventSchema = z13.object({
@@ -1395,8 +1404,19 @@ var SubscriptionEndpoints = class {
     const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}?${objectToQuery(options)}`, subscriptionSchema);
     return response.data;
   }
-  async cancel(subscriptionId) {
-    const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/cancel`, subscriptionSchema, { method: "POST" });
+  /**
+   * Turns off auto-renew. The customer keeps access until the subscription's current
+   * period ends. Pass `feedback` to record why they are cancelling.
+   */
+  async cancel(subscriptionId, feedback) {
+    var _a, _b;
+    const response = await this.api.authenticatedFetch(`/api/customer/inventory/subscriptions/${subscriptionId}/cancel`, subscriptionSchema, {
+      method: "POST",
+      body: {
+        reason: (_a = feedback == null ? void 0 : feedback.reason) != null ? _a : void 0,
+        comment: ((_b = feedback == null ? void 0 : feedback.comment) == null ? void 0 : _b.trim()) || void 0
+      }
+    });
     return response.data;
   }
   async renew(subscriptionId, returnUrl, embedded) {
@@ -2525,6 +2545,7 @@ export {
   OfferUtils,
   OrderStatus,
   Platform,
+  SubscriptionCancellationReason,
   SubscriptionStatus,
   TokenStore,
   imageWidths,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@moonbase.sh/storefront-api",
   "type": "module",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "description": "Package to let you build storefronts with Moonbase.sh as payment and delivery provider",
   "author": "Tobias Lønnerød Madsen <m@dsen.tv>",
   "license": "MIT",
@@ -27,6 +27,8 @@
     "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
     "version": "npm version",
     "type-check": "tsc --noEmit -p tsconfig.typecheck.json",
+    "lint": "eslint . --cache --cache-location node_modules/.cache/eslint/ --cache-strategy content",
+    "lint:fix": "eslint . --cache --cache-location node_modules/.cache/eslint/ --cache-strategy content --fix",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:integration": "TEST_INTEGRATION=true vitest run"