@01.software/sdk 0.42.0 → 0.43.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @01.software/sdk
 
+## 0.43.0
+
+### Minor Changes
+
+- 81ef105: Expose cart item `requiresShipping` snapshots through the public cart item
+  types, and update the ecommerce starter so non-shipping-only carts skip shipping
+  address collection while legacy or mixed carts remain shippable by default.
+- 5d7b26f: Expose the new `markets` collection slug through the browser-safe `COLLECTIONS`
+  constant so storefront and integration code can address tenant-scoped market
+  records without local collection-name mirrors.
+
+### Patch Changes
+
+- 9789528: Add checkout shipping context fields to the SDK contract and update the
+  ecommerce starter to pass checkout context through the order API instead of
+  mutating carts through the customer-scoped SDK client.
+- 9b7afab: Expose membership plan and customer membership collection slugs in the public collection surface.
+- db8bd4b: Add optional `seo` (title/description) to product upsert `ProductFieldsInput` for CSV import parity.
+- b95f6ac: Expose stable storefront discount validation reason codes in the SDK.
+  `ValidateDiscountResult.reasonCode` now carries the machine-readable discount
+  reason union returned by `/api/discounts/validate`, so storefronts can branch and
+  localize without parsing human-readable `reason` text.
+- c60ec7f: fix(sdk): remove stale event calendar order field
+
+  `EventCalendar` and its select type no longer expose the stale `_order` field
+  because tenant-global event calendars are not operator-orderable.
+
+- 6c71a71: chore(sdk): sync event occurrence timezone generated type docs
+
+  The generated Payload types now include the Event Occurrence timezone field
+  description used by Console's read-only occurrence identity timezone contract.
+  Type-only change; no SDK runtime or request shape changed.
+
+- 3aa6239: Allow `events.getRange()` to omit `start` and `end` so the public events range endpoint can use the tenant calendar's public listing defaults.
+- 294b7d1: Keep membership contract-parity type tests within the SDK export guard's explicit test-only private-contract allowlist.
+- f87fe09: Add return approval and rejection commerce notification webhook events.
+- 4362b14: Expose tenant commerce `fulfillmentMode` in tenant feature progress responses.
+
 ## 0.42.0
 
 ### Minor Changes

package/README.md

@@ -118,7 +118,10 @@ typo detection) and pass it as the generic. Mistyped names and out-of-enum
 values then fail to compile:
 
 ```typescript
-import { createAnalytics, defineAnalyticsEvents } from '@01.software/sdk/analytics'
+import {
+  createAnalytics,
+  defineAnalyticsEvents,
+} from '@01.software/sdk/analytics'
 
 type ShopEvents = {
   signup: { plan: 'free' | 'pro'; trial: boolean }
@@ -128,7 +131,7 @@ type ShopEvents = {
 
 const analytics = createAnalytics<ShopEvents>({ publishableKey: 'pk_xxx' })
 analytics.track('signup', { plan: 'pro', trial: false }) // ✅
-analytics.track('checkout_start')                         // ✅ no props
+analytics.track('checkout_start') // ✅ no props
 // analytics.track('signpu', { plan: 'pro', trial: false }) // ❌ unknown event
 // analytics.track('signup', { plan: 'team', trial: false }) // ❌ enum violation
 
@@ -144,7 +147,10 @@ instance for its subtree:
 Reusing the `ShopEvents` type from above:
 
 ```tsx
-import { AnalyticsProvider, useAnalytics } from '@01.software/sdk/analytics/react'
+import {
+  AnalyticsProvider,
+  useAnalytics,
+} from '@01.software/sdk/analytics/react'
 
 function Root() {
   return (
@@ -1411,7 +1417,7 @@ Source of truth: `packages/sdk/src/core/collection/const.ts` (`COLLECTIONS`).
 | Category           | Browser-public generic collections                                                                                                                                 |
 | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | Tenant             | `tenants`, `tenant-metadata`                                                                                                                                       |
-| Products           | `products`, `product-variants`, `product-options`, `product-option-values`, `product-categories`, `product-tags`, `product-collections`, `brands`                  |
+| Products           | `products`, `product-variants`, `product-options`, `product-option-values`, `product-categories`, `product-tags`, `product-collections`, `markets`, `brands`       |
 | Customers          | `customer-profiles`                                                                                                                                                |
 | Commerce           | `discounts`, `shipping-policies`, `shipping-zones`                                                                                                                 |
 | Content            | `documents`, `document-categories`, `document-types`, `articles`, `article-authors`, `article-categories`, `article-tags`, `links`, `link-categories`, `link-tags` |

package/dist/client.cjs

@@ -668,6 +668,64 @@ async function httpFetch(url, options) {
   throw lastError ?? new NetworkError("Request failed after retries");
 }
 
+// src/core/api/endpoints.ts
+var COMMERCE_ENDPOINTS = {
+  orders: {
+    create: "/api/orders/create",
+    update: "/api/orders/update",
+    confirmPayment: "/api/orders/confirm-payment",
+    byPayment: "/api/orders/by-payment",
+    cancel: "/api/orders/cancel",
+    resolveCancelRefund: "/api/orders/resolve-cancel-refund",
+    checkout: "/api/orders/checkout",
+    createFulfillment: "/api/orders/create-fulfillment",
+    updateFulfillment: "/api/orders/update-fulfillment"
+  },
+  transactions: {
+    update: "/api/transactions/update"
+  },
+  returns: {
+    create: "/api/returns/create",
+    update: "/api/returns/update",
+    returnRefund: "/api/returns/return-refund"
+  },
+  fulfillmentOrders: {
+    prepare: "/api/fulfillment-orders/prepare-fulfillment-order"
+  },
+  fulfillments: {
+    bulkImport: "/api/fulfillments/bulk-import"
+  },
+  carts: {
+    mine: "/api/carts/mine",
+    merge: "/api/carts/merge",
+    addItem: "/api/carts/add-item",
+    updateItem: "/api/carts/update-item",
+    removeItem: "/api/carts/remove-item",
+    applyDiscount: "/api/carts/apply-discount",
+    removeDiscount: "/api/carts/remove-discount",
+    clear: "/api/carts/clear"
+  },
+  products: {
+    stockCheck: "/api/products/stock-check",
+    stockSnapshot: "/api/products/stock",
+    listingGroups: "/api/products/listing-groups",
+    listingGroupsCatalog: "/api/products/listing-groups/catalog",
+    listingGroupsQuery: "/api/products/listing-groups/query",
+    listingGroupsQueryCatalog: "/api/products/listing-groups/query/catalog",
+    detail: "/api/products/detail",
+    detailCatalog: "/api/products/detail/catalog",
+    upsert: "/api/products/upsert"
+  }
+};
+var COMMERCE_ENDPOINT_PATHS = Object.values(
+  COMMERCE_ENDPOINTS
+).flatMap((group) => Object.values(group));
+var MEMBERSHIP_ENDPOINTS = {
+  subscribe: "/api/memberships/subscribe",
+  cancel: (id) => `/api/memberships/${id}/cancel`,
+  me: "/api/memberships/me"
+};
+
 // src/core/internal/utils/query-string.ts
 function productDetailQuery(params) {
   const search = new URLSearchParams();
@@ -676,7 +734,7 @@ function productDetailQuery(params) {
   } else {
     search.set("id", params.id);
   }
-  return `/api/products/detail?${search}`;
+  return `${COMMERCE_ENDPOINTS.products.detail}?${search}`;
 }
 function productDetailCatalogQuery(params) {
   const search = new URLSearchParams();
@@ -685,20 +743,17 @@ function productDetailCatalogQuery(params) {
   } else {
     search.set("id", params.id);
   }
-  return `/api/products/detail/catalog?${search}`;
+  return `${COMMERCE_ENDPOINTS.products.detailCatalog}?${search}`;
 }
 function listingGroupsCatalogQuery(params) {
-  return `/api/products/listing-groups/catalog?ids=${params.productIds.map(encodeURIComponent).join(",")}`;
+  return `${COMMERCE_ENDPOINTS.products.listingGroupsCatalog}?ids=${params.productIds.map(encodeURIComponent).join(",")}`;
 }
 function appendListingGroupsQuerySearchParams(search, options) {
   if (options?.page != null) search.set("page", String(options.page));
   if (options?.limit != null) search.set("limit", String(options.limit));
   if (options?.sort != null) {
     const sort = options.sort;
-    search.set(
-      "sort",
-      Array.isArray(sort) ? sort.join(",") : sort
-    );
+    search.set("sort", Array.isArray(sort) ? sort.join(",") : sort);
   }
   if (options?.where != null) {
     search.set("whereJson", JSON.stringify(options.where));
@@ -708,16 +763,16 @@ function listingGroupsQueryUrl(options) {
   const search = new URLSearchParams();
   appendListingGroupsQuerySearchParams(search, options);
   const query = search.toString();
-  return `/api/products/listing-groups/query${query ? `?${query}` : ""}`;
+  return `${COMMERCE_ENDPOINTS.products.listingGroupsQuery}${query ? `?${query}` : ""}`;
 }
 function listingGroupsQueryCatalogUrl(options) {
   const search = new URLSearchParams();
   appendListingGroupsQuerySearchParams(search, options);
   const query = search.toString();
-  return `/api/products/listing-groups/query/catalog${query ? `?${query}` : ""}`;
+  return `${COMMERCE_ENDPOINTS.products.listingGroupsQueryCatalog}${query ? `?${query}` : ""}`;
 }
 function stockSnapshotQuery(params) {
-  return `/api/products/stock?variantIds=${params.variantIds.map(encodeURIComponent).join(",")}`;
+  return `${COMMERCE_ENDPOINTS.products.stockSnapshot}?variantIds=${params.variantIds.map(encodeURIComponent).join(",")}`;
 }
 
 // src/core/collection/http-client.ts
@@ -1606,48 +1661,6 @@ var CustomerNamespace = class {
   }
 };
 
-// src/core/api/endpoints.ts
-var COMMERCE_ENDPOINTS = {
-  orders: {
-    create: "/api/orders/create",
-    update: "/api/orders/update",
-    confirmPayment: "/api/orders/confirm-payment",
-    byPayment: "/api/orders/by-payment",
-    cancel: "/api/orders/cancel",
-    resolveCancelRefund: "/api/orders/resolve-cancel-refund",
-    checkout: "/api/orders/checkout",
-    createFulfillment: "/api/orders/create-fulfillment",
-    updateFulfillment: "/api/orders/update-fulfillment"
-  },
-  transactions: {
-    update: "/api/transactions/update"
-  },
-  returns: {
-    create: "/api/returns/create",
-    update: "/api/returns/update",
-    returnRefund: "/api/returns/return-refund"
-  },
-  fulfillmentOrders: {
-    prepare: "/api/fulfillment-orders/prepare-fulfillment-order"
-  },
-  fulfillments: {
-    bulkImport: "/api/fulfillments/bulk-import"
-  },
-  carts: {
-    mine: "/api/carts/mine",
-    merge: "/api/carts/merge",
-    addItem: "/api/carts/add-item",
-    updateItem: "/api/carts/update-item",
-    removeItem: "/api/carts/remove-item",
-    applyDiscount: "/api/carts/apply-discount",
-    removeDiscount: "/api/carts/remove-discount",
-    clear: "/api/carts/clear"
-  }
-};
-var COMMERCE_ENDPOINT_PATHS = Object.values(
-  COMMERCE_ENDPOINTS
-).flatMap((group) => Object.values(group));
-
 // src/core/api/cart-api.ts
 var CartApi = class extends CustomerScopedApi {
   constructor(options) {
@@ -2871,7 +2884,10 @@ var CommerceClient = class {
       onRequestId: options.onRequestId
     });
     this.product = {
-      stockCheck: (params) => api.post("/api/products/stock-check", params),
+      stockCheck: (params) => api.post(
+        COMMERCE_ENDPOINTS.products.stockCheck,
+        params
+      ),
       stockSnapshot: (params) => api.get(stockSnapshotQuery(params)),
       listingGroups: (params) => api.get(
         listingGroupsCatalogQuery(params)
@@ -2889,7 +2905,9 @@ var CommerceClient = class {
       },
       detail: async (params) => {
         try {
-          const product = await api.get(productDetailQuery(params));
+          const product = await api.get(
+            productDetailQuery(params)
+          );
           return { found: true, product };
         } catch (err) {
           const notFoundResult = productDetailResultFromError(err);
@@ -2937,7 +2955,10 @@ var CommerceClient = class {
       validate: (params) => api.post("/api/discounts/validate", params)
     };
     this.shipping = {
-      calculate: (params) => api.post("/api/shipping-policies/calculate", params)
+      calculate: (params) => api.post(
+        "/api/shipping-policies/calculate",
+        params
+      )
     };
   }
 };
@@ -3026,8 +3047,12 @@ function buildGuestCancelRequestBody(token, params) {
 }
 function buildRangeEndpoint(params) {
   const urlParams = new URLSearchParams();
-  urlParams.set("start", formatDateParam(params.start));
-  urlParams.set("end", formatDateParam(params.end));
+  if (params.start !== void 0) {
+    urlParams.set("start", formatDateParam(params.start));
+  }
+  if (params.end !== void 0) {
+    urlParams.set("end", formatDateParam(params.end));
+  }
   if (params.limit !== void 0) urlParams.set("limit", String(params.limit));
   if (params.page !== void 0) urlParams.set("page", String(params.page));
   appendValues(urlParams, "calendar", params.calendar);
@@ -3050,6 +3075,13 @@ function appendValues(params, key, value) {
 }
 
 // src/core/client/client.ts
+var BrowserMembershipApi = class extends CustomerScopedApi {
+  me() {
+    return this.request(MEMBERSHIP_ENDPOINTS.me, {
+      method: "GET"
+    });
+  }
+};
 var Client = class {
   constructor(options) {
     this.lastRequestId = null;
@@ -3114,6 +3146,16 @@ var Client = class {
       onRequestId,
       this.config.apiUrl
     );
+    const membershipApi = new BrowserMembershipApi("MembershipApi", {
+      publishableKey: this.config.publishableKey,
+      apiUrl: this.config.apiUrl,
+      customerToken: () => this.customer.auth.getToken(),
+      onUnauthorized,
+      onRequestId
+    });
+    this.memberships = {
+      me: membershipApi.me.bind(membershipApi)
+    };
   }
   getState() {
     return { ...this.state };