@spree/sdk 0.6.6 → 0.6.8

package/README.md

@@ -27,7 +27,7 @@ const client = createSpreeClient({
 // Browse products (Store API)
 const products = await client.store.products.list({
   limit: 10,
-  expand: 'variants,images',
+  expand: ['variants', 'images'],
 });
 
 // Get a single product
@@ -150,12 +150,12 @@ const products = await client.store.products.list({
   limit: 25,
   name_cont: 'shirt',
   sort: 'price asc',
-  expand: 'variants,images,taxons',
+  expand: ['variants', 'images', 'taxons'],
 });
 
 // Get single product by ID or slug
 const product = await client.store.products.get('spree-tote', {
-  expand: 'variants,images',
+  expand: ['variants', 'images'],
 });
 
 // Get available filters (price range, availability, options, taxons)
@@ -169,12 +169,12 @@ const filters = await client.store.products.filters({
 ```typescript
 // List taxonomies
 const taxonomies = await client.store.taxonomies.list({
-  expand: 'taxons',
+  expand: ['taxons'],
 });
 
 // Get taxonomy with taxons
 const categories = await client.store.taxonomies.get('tax_123', {
-  expand: 'root,taxons',
+  expand: ['root', 'taxons'],
 });
 
 // List taxons with filtering
@@ -185,14 +185,14 @@ const taxons = await client.store.taxons.list({
 
 // Get single taxon by ID or permalink
 const taxon = await client.store.taxons.get('categories/clothing', {
-  expand: 'ancestors,children', // For breadcrumbs and subcategories
+  expand: ['ancestors', 'children'], // For breadcrumbs and subcategories
 });
 
 // List products in a category
 const categoryProducts = await client.store.taxons.products.list('categories/clothing', {
   page: 1,
   limit: 12,
-  expand: 'images,default_variant',
+  expand: ['images', 'default_variant'],
 });
 ```
 
@@ -225,7 +225,7 @@ const options = { orderToken: cart.order_token };
 
 // Get order by ID or number
 const order = await client.store.orders.get('R123456789', {
-  expand: 'line_items,shipments',
+  expand: ['line_items', 'shipments'],
 }, options);
 
 // Update order (email, addresses)
@@ -364,14 +364,37 @@ const completed = await client.store.orders.paymentSessions.complete(
 console.log(completed.status); // 'completed'
 ```
 
+### Markets
+
+```typescript
+// List all markets
+const { data: markets } = await client.store.markets.list();
+// [{ id: "mkt_xxx", name: "North America", currency: "USD", default_locale: "en", ... }]
+
+// Get a single market
+const market = await client.store.markets.get('mkt_xxx');
+
+// Resolve which market applies for a country
+const market = await client.store.markets.resolve('DE');
+// => { id: "mkt_xxx", name: "Europe", currency: "EUR", default_locale: "de", ... }
+
+// List countries in a market
+const { data: countries } = await client.store.markets.countries.list('mkt_xxx');
+
+// Get a country in a market (with states for address forms)
+const country = await client.store.markets.countries.get('mkt_xxx', 'DE', {
+  expand: ['states'],
+});
+```
+
 ### Geography
 
 ```typescript
 // List countries available for checkout
 const { data: countries } = await client.store.countries.list();
 
-// Get country by ISO code (includes states)
-const usa = await client.store.countries.get('US');
+// Get country by ISO code (with states)
+const usa = await client.store.countries.get('US', { expand: ['states'] });
 console.log(usa.states); // Array of states
 ```
 
@@ -448,7 +471,7 @@ const { data: wishlists } = await client.store.wishlists.list({}, options);
 
 // Get wishlist by ID
 const wishlist = await client.store.wishlists.get('wl_xxx', {
-  expand: 'wished_items',
+  expand: ['wished_items'],
 }, options);
 
 // Create wishlist
@@ -501,6 +524,7 @@ The SDK uses a resource builder pattern for nested resources:
 | `store.customer` | `addresses` | `list`, `get`, `create`, `update`, `delete`, `markAsDefault` |
 | `store.customer` | `creditCards` | `list`, `get`, `delete` |
 | `store.customer` | `giftCards` | `list`, `get` |
+| `store.markets` | `countries` | `list`, `get` |
 | `store.taxons` | `products` | `list` |
 | `store.wishlists` | `items` | `create`, `update`, `delete` |
 
@@ -511,6 +535,7 @@ await client.store.orders.lineItems.create(orderId, params, options);
 await client.store.orders.payments.list(orderId, options);
 await client.store.orders.shipments.update(orderId, shipmentId, params, options);
 await client.store.customer.addresses.list({}, options);
+await client.store.markets.countries.list(marketId);
 await client.store.taxons.products.list(taxonId, params, options);
 await client.store.wishlists.items.create(wishlistId, params, options);
 ```
@@ -608,6 +633,7 @@ The SDK exports all Store API types:
 - `StoreState` - State/province
 - `StoreAddress` - Customer address
 - `StoreCustomer` - Customer profile
+- `StoreMarket` - Market configuration (currency, locales, countries)
 - `StoreStore` - Store configuration
 
 ### Commerce Types

package/dist/index.cjs

@@ -21,20 +21,23 @@ function calculateDelay(attempt, config) {
 function sleep(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
-function shouldRetryOnStatus(method, status, config) {
-  const isIdempotent = method === "GET" || method === "HEAD";
+function generateIdempotencyKey() {
+  return `spree-sdk-retry-${crypto.randomUUID()}`;
+}
+function shouldRetryOnStatus(method, status, config, hasIdempotencyKey) {
+  const isIdempotent = method === "GET" || method === "HEAD" || hasIdempotencyKey;
   if (isIdempotent) {
     return config.retryOnStatus.includes(status);
   }
   return status === 429;
 }
-function shouldRetryOnNetworkError(method, config) {
+function shouldRetryOnNetworkError(method, config, hasIdempotencyKey) {
   if (!config.retryOnNetworkError) return false;
-  return method === "GET" || method === "HEAD";
+  return method === "GET" || method === "HEAD" || hasIdempotencyKey;
 }
 function createRequestFn(config, basePath, auth, defaults) {
   return async function request(method, path, options = {}) {
-    const { token, orderToken, headers = {}, body, params } = options;
+    const { token, orderToken, idempotencyKey, headers = {}, body, params } = options;
     const locale = options.locale ?? defaults?.locale;
     const currency = options.currency ?? defaults?.currency;
     const country = options.country ?? defaults?.country;
@@ -50,14 +53,13 @@ function createRequestFn(config, basePath, auth, defaults) {
         }
       });
     }
-    if (orderToken) {
-      url.searchParams.set("order_token", orderToken);
-    }
     const requestHeaders = {
       "Content-Type": "application/json",
-      [auth.headerName]: auth.headerValue,
       ...headers
     };
+    if (auth.headerName && auth.headerValue) {
+      requestHeaders[auth.headerName] = auth.headerValue;
+    }
     if (token) {
       requestHeaders["Authorization"] = `Bearer ${token}`;
     }
@@ -73,6 +75,12 @@ function createRequestFn(config, basePath, auth, defaults) {
     if (country) {
       requestHeaders["x-spree-country"] = country;
     }
+    const isMutating = method !== "GET" && method !== "HEAD";
+    const effectiveIdempotencyKey = idempotencyKey ?? (isMutating && config.retryConfig ? generateIdempotencyKey() : void 0);
+    if (effectiveIdempotencyKey) {
+      requestHeaders["Idempotency-Key"] = effectiveIdempotencyKey;
+    }
+    const hasIdempotencyKey = !!effectiveIdempotencyKey;
     const maxAttempts = config.retryConfig ? config.retryConfig.maxRetries + 1 : 1;
     for (let attempt = 0; attempt < maxAttempts; attempt++) {
       try {
@@ -83,7 +91,7 @@ function createRequestFn(config, basePath, auth, defaults) {
         });
         if (!response.ok) {
           const isLastAttempt = attempt >= maxAttempts - 1;
-          if (!isLastAttempt && config.retryConfig && shouldRetryOnStatus(method, response.status, config.retryConfig)) {
+          if (!isLastAttempt && config.retryConfig && shouldRetryOnStatus(method, response.status, config.retryConfig, hasIdempotencyKey)) {
             const retryAfter = response.headers.get("Retry-After");
             const delay = retryAfter ? Math.min(parseInt(retryAfter, 10) * 1e3, config.retryConfig.maxDelay) : calculateDelay(attempt, config.retryConfig);
             await sleep(delay);
@@ -101,7 +109,7 @@ function createRequestFn(config, basePath, auth, defaults) {
           throw error;
         }
         const isLastAttempt = attempt >= maxAttempts - 1;
-        if (!isLastAttempt && config.retryConfig && shouldRetryOnNetworkError(method, config.retryConfig)) {
+        if (!isLastAttempt && config.retryConfig && shouldRetryOnNetworkError(method, config.retryConfig, hasIdempotencyKey)) {
           const delay = calculateDelay(attempt, config.retryConfig);
           await sleep(delay);
           continue;
@@ -138,6 +146,10 @@ function transformListParams(params) {
 }
 
 // src/store-client.ts
+function expandParams(params) {
+  if (!params?.expand?.length) return void 0;
+  return { expand: params.expand.join(",") };
+}
 var StoreClient = class {
   request;
   constructor(request) {
@@ -161,15 +173,6 @@ var StoreClient = class {
     refresh: (options) => this.request("POST", "/auth/refresh", options)
   };
   // ============================================
-  // Store
-  // ============================================
-  store = {
-    /**
-     * Get current store information
-     */
-    get: (options) => this.request("GET", "/store", options)
-  };
-  // ============================================
   // Products
   // ============================================
   products = {
@@ -178,14 +181,14 @@ var StoreClient = class {
      */
     list: (params, options) => this.request("GET", "/products", {
       ...options,
-      params: params ? transformListParams(params) : void 0
+      params: transformListParams({ ...params })
     }),
     /**
      * Get a product by ID or slug
      */
     get: (idOrSlug, params, options) => this.request("GET", `/products/${idOrSlug}`, {
       ...options,
-      params
+      params: expandParams(params)
     }),
     /**
      * Get available filters for products
@@ -205,14 +208,14 @@ var StoreClient = class {
      */
     list: (params, options) => this.request("GET", "/taxonomies", {
       ...options,
-      params
+      params: transformListParams({ ...params })
     }),
     /**
      * Get a taxonomy by ID
      */
     get: (id, params, options) => this.request("GET", `/taxonomies/${id}`, {
       ...options,
-      params
+      params: expandParams(params)
     })
   };
   taxons = {
@@ -221,14 +224,14 @@ var StoreClient = class {
      */
     list: (params, options) => this.request("GET", "/taxons", {
       ...options,
-      params: params ? transformListParams(params) : void 0
+      params: transformListParams({ ...params })
     }),
     /**
      * Get a taxon by ID or permalink
      */
     get: (idOrPermalink, params, options) => this.request("GET", `/taxons/${idOrPermalink}`, {
       ...options,
-      params
+      params: expandParams(params)
     }),
     /**
      * Nested resource: Products in a taxon
@@ -243,7 +246,7 @@ var StoreClient = class {
         `/taxons/${taxonId}/products`,
         {
           ...options,
-          params: params ? transformListParams(params) : void 0
+          params: transformListParams({ ...params })
         }
       )
     }
@@ -264,7 +267,7 @@ var StoreClient = class {
      */
     get: (iso, params, options) => this.request("GET", `/countries/${iso}`, {
       ...options,
-      params
+      params: expandParams(params)
     })
   };
   currencies = {
@@ -321,7 +324,7 @@ var StoreClient = class {
       get: (marketId, iso, params, options) => this.request(
         "GET",
         `/markets/${marketId}/countries/${iso}`,
-        { ...options, params }
+        { ...options, params: expandParams(params) }
       )
     }
   };
@@ -358,7 +361,7 @@ var StoreClient = class {
      */
     get: (idOrNumber, params, options) => this.request("GET", `/orders/${idOrNumber}`, {
       ...options,
-      params
+      params: expandParams(params)
     }),
     /**
      * Update an order
@@ -576,7 +579,7 @@ var StoreClient = class {
       list: (params, options) => this.request(
         "GET",
         "/customer/addresses",
-        { ...options, params }
+        { ...options, params: transformListParams({ ...params }) }
       ),
       /**
        * Get an address by ID
@@ -618,7 +621,7 @@ var StoreClient = class {
       list: (params, options) => this.request(
         "GET",
         "/customer/credit_cards",
-        { ...options, params }
+        { ...options, params: transformListParams({ ...params }) }
       ),
       /**
        * Get a credit card by ID
@@ -640,7 +643,7 @@ var StoreClient = class {
       list: (params, options) => this.request(
         "GET",
         "/customer/gift_cards",
-        { ...options, params }
+        { ...options, params: transformListParams({ ...params }) }
       ),
       /**
        * Get a gift card by ID
@@ -656,7 +659,7 @@ var StoreClient = class {
        */
       list: (params, options) => this.request("GET", "/customer/orders", {
         ...options,
-        params: params ? transformListParams(params) : void 0
+        params: transformListParams({ ...params })
       })
     },
     /**
@@ -696,14 +699,14 @@ var StoreClient = class {
      */
     list: (params, options) => this.request("GET", "/wishlists", {
       ...options,
-      params
+      params: transformListParams({ ...params })
     }),
     /**
      * Get a wishlist by ID
      */
     get: (id, params, options) => this.request("GET", `/wishlists/${id}`, {
       ...options,
-      params
+      params: expandParams(params)
     }),
     /**
      * Create a wishlist
@@ -772,6 +775,9 @@ var SpreeClient = class {
   admin;
   _defaults;
   constructor(config) {
+    if (!config.publishableKey && !config.secretKey) {
+      throw new Error("SpreeClient requires at least one of publishableKey or secretKey");
+    }
     const baseUrl = config.baseUrl.replace(/\/$/, "");
     const fetchFn = config.fetch || fetch.bind(globalThis);
     this._defaults = {
@@ -795,7 +801,7 @@ var SpreeClient = class {
     const storeRequestFn = createRequestFn(
       requestConfig,
       "/api/v3/store",
-      { headerName: "x-spree-api-key", headerValue: config.publishableKey },
+      config.publishableKey ? { headerName: "x-spree-api-key", headerValue: config.publishableKey } : { headerName: "", headerValue: "" },
       this._defaults
     );
     const adminRequestFn = createRequestFn(