@scayle/storefront-nuxt 8.32.1 → 8.33.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @scayle/storefront-nuxt
 
+## 8.33.0
+
+### Patch Changes
+
+- Updated dependency `@scayle/storefront-core@8.32.0` to `@scayle/storefront-core@workspace:*`
+- Updated dependency `@scayle/unstorage-compression-driver@^1.0.0` to `@scayle/unstorage-compression-driver@workspace:*`
+- Updated dependency `@vueuse/core@13.4.0` to `@vueuse/core@13.5.0`
+
+**Dependencies**
+
+**@scayle/storefront-core v8.33.0**
+
+- Minor
+
+  - Added test factories for order and all related types.
+
+  It is now possible to build orders with factory functions for testing purposes.
+  This will reduce the amount of boilerplate code needed to create test data.
+
+- Patch
+  - Updated dependency `@scayle/storefront-api@18.9.0` to `@scayle/storefront-api@workspace:*`
+  - Updated dependency `@scayle/unstorage-scayle-kv-driver@1.0.2` to `@scayle/unstorage-scayle-kv-driver@workspace:*`
+
 ## 8.32.1
 
 ### Patch Changes
@@ -38,23 +61,23 @@
   - Added `minReduction` and `maxReduction` filter parameters to `FetchProductsByCategoryParams.where` and `FetchFiltersParams.where` types, and updated the `getProductsByCategory` and `getFilters` RPC methods to accept and handle these new reduction-based filtering conditions.
 
   ```ts
-  const { data } = useRpc("getFilters", "getFiltersKey", () => ({
+  const { data } = useRpc('getFilters', 'getFiltersKey', () => ({
     where: {
       minReduction: 10,
       maxReduction: 20,
     },
-  }));
+  }))
 
   const { data } = useRpc(
-    "getProductsByCategory",
-    "getProductsByCategoryKey",
+    'getProductsByCategory',
+    'getProductsByCategoryKey',
     () => ({
       where: {
         minReduction: 10,
         maxReduction: 20,
       },
     }),
-  );
+  )
   ```
 
 ## 8.30.3
@@ -106,28 +129,28 @@
 
   ```ts
   export const existingHandlerWithoutParams = async (_context: RpcContext) => {
-    return "existing handler";
-  };
+    return 'existing handler'
+  }
 
   export const existingHandlerWithParams = async (
     { name }: { name: string },
     _context: RpcContext,
   ) => {
-    return name;
-  };
+    return name
+  }
 
   // will become
 
   export const existingHandlerWithoutParams = defineRpcHandler(
     async (_context: RpcContext) => {
-      return "existing handler";
+      return 'existing handler'
     },
-  );
+  )
   export const existingHandlerWithParams = defineRpcHandler(
     async ({ name }: { name: string }, _context: RpcContext) => {
-      return name;
+      return name
     },
-  );
+  )
   ```
 
 - Patch
@@ -149,15 +172,15 @@
   - Added an optional `hideEmptyCategories` parameter to `getCategoryTree`. When enabled, the product count for each category is retrieved, and categories (including their children) without any products are removed. Enabling this option may increase response times, especially for large category trees.
 
   ```ts
-  import { rpcMethods } from "@scayle/storefront-core";
+  import { rpcMethods } from '@scayle/storefront-core'
 
-  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext);
+  rpcMethods.getCategoryTree({ hideEmptyCategories: true }, rpcContext)
   ```
 
   or
 
   ```ts
-  import { useCategoryTree } from "#storefront/composables";
+  import { useCategoryTree } from '#storefront/composables'
 
   const { data: rootCategories, status } = useCategoryTree(
     {
@@ -165,8 +188,8 @@
         hideEmptyCategories: true,
       },
     },
-    "category-navigation-tree",
-  );
+    'category-navigation-tree',
+  )
   ```
 
 ## 8.28.7
@@ -263,9 +286,9 @@
     params: {
       children: 10,
       includeHidden: true,
-      properties: { withName: ["sale"] },
+      properties: { withName: ['sale'] },
     },
-  });
+  })
   ```
 
 ### Patch Changes
@@ -436,16 +459,16 @@
     nitro: {
       storage: {
         redis: {
-          driver: "redis",
-          host: "localhost",
+          driver: 'redis',
+          host: 'localhost',
         },
         db: {
-          driver: "fs",
-          base: "./.data/db",
+          driver: 'fs',
+          base: './.data/db',
         },
       },
     },
-  });
+  })
   ```
 
   With the introduction of the new approach for configuring storefront storage mounts, the global and shop-specific `storage` option within the `@scayle/storefront-nuxt` runtime configuration has been deprecated.
@@ -518,9 +541,9 @@
   ```typescript
   const idp = useIDP({
     authUrlParameters: {
-      theme: "dark",
+      theme: 'dark',
     },
-  });
+  })
   ```
 
 ### Patch Changes
@@ -662,11 +685,11 @@
       storefront: {
         redirects: {
           enabled: true,
-          strategy: "on-missing",
+          strategy: 'on-missing',
         },
       },
     },
-  });
+  })
   ```
 
   Also, keep in mind that when this option is enabled, the redirect logic will only be executed when the request would otherwise result in a 404. There are three ways in which a 404 can occur.
@@ -680,7 +703,7 @@
   If the request handler returns a `Response` object with a `status` of 404, a 404 response will be returned to the client.
 
   ```typescript
-  return new Response(null, { status: 404 });
+  return new Response(null, { status: 404 })
   ```
 
   3. Thrown H3Error with 404 status
@@ -688,8 +711,8 @@
   If the request handler throws an H3Error with a `statusCode` 404, a 404 response will be returned to the client.
 
   ```typescript
-  import { createError } from "h3";
-  throw createError({ statusCode: 404 });
+  import { createError } from 'h3'
+  throw createError({ statusCode: 404 })
   ```
 
 ### Patch Changes
@@ -1131,28 +1154,28 @@
   **rpc-methods.ts**
 
   ```typescript
-  import type { RpcContext, RpcHandler } from "@scayle/storefront-nuxt";
+  import type { RpcContext, RpcHandler } from '@scayle/storefront-nuxt'
 
   export const foo: RpcHandler<string, number> = function testing(
     param: string,
     _: RpcContext,
   ) {
-    return param.length;
-  };
+    return param.length
+  }
   ```
 
   **module.ts**
 
   ```typescript
   function setup() {
-    const resolver = createResolver(import.meta.url);
+    const resolver = createResolver(import.meta.url)
 
-    nuxt.hook("storefront:custom-rpc:extend", (customRpcImports) => {
+    nuxt.hook('storefront:custom-rpc:extend', (customRpcImports) => {
       customRpcImports.push({
-        source: resolver.resolve("./rpc-methods.ts"),
-        names: ["foo"],
-      });
-    });
+        source: resolver.resolve('./rpc-methods.ts'),
+        names: ['foo'],
+      })
+    })
   }
   ```
 
@@ -1374,23 +1397,23 @@
         storefront: {
           // ...
           redis: {
-            host: "localhost",
+            host: 'localhost',
             port: 6379,
-            prefix: "",
-            user: "",
-            password: "",
+            prefix: '',
+            user: '',
+            password: '',
             sslTransit: false,
           },
           // ...
           session: {
             // ...
-            provider: "redis",
+            provider: 'redis',
           },
         },
         // ...
       },
       // ...
-    });
+    })
     ```
 
   - _Current Unified Storage Approach (`nuxt.config.ts`):_
@@ -1404,13 +1427,13 @@
           // ...
           storage: {
             cache: {
-              driver: "redis",
-              host: "localhost",
+              driver: 'redis',
+              host: 'localhost',
               port: 6379,
             },
             session: {
-              driver: "redis",
-              host: "localhost",
+              driver: 'redis',
+              host: 'localhost',
               port: 6379,
             },
             // ...
@@ -1420,7 +1443,7 @@
         // ...
       },
       // ...
-    });
+    })
     ```
 
 - **\[💥 BREAKING\]** The composable `useSearch` has been replaced by `useStorefrontSearch`, consolidating and transitioning to SCAYLE Search v2.
@@ -1487,9 +1510,9 @@
 
     ```ts
     const { activeFilters, applyFilters, resetFilterUrl, productConditions } =
-      useQueryFilterState();
+      useQueryFilterState()
 
-    applyFilters({ brand: 23, sale: true, maxPrice: 100, minPrice: 0 });
+    applyFilters({ brand: 23, sale: true, maxPrice: 100, minPrice: 0 })
     ```
 
   - _Current Usage of `useFilter` and `useAppliedFilters`:_
@@ -1502,20 +1525,20 @@
       resetFilters,
       resetPriceFilter,
       resetFilter,
-    } = useFilter();
+    } = useFilter()
 
-    applyPriceFilter([0, 100]);
-    applyBooleanFilter("sale", true);
-    applyAttributeFilter("brand", 23);
+    applyPriceFilter([0, 100])
+    applyBooleanFilter('sale', true)
+    applyAttributeFilter('brand', 23)
 
-    const route = useRoute();
+    const route = useRoute()
     const {
       appliedFilter,
       appliedFiltersCount,
       appliedAttributeValues,
       appliedBooleanValues,
       areFiltersApplied,
-    } = useAppliedFilters(route);
+    } = useAppliedFilters(route)
     ```
 
 - **\[💥 BREAKING\]** The `getBadgeLabel` helper function has been removed, giving you more control over badge label display.
@@ -1525,43 +1548,43 @@
 
     ```ts
     const BadgeLabel = {
-      NEW: "new",
-      SOLD_OUT: "sold_out",
-      ONLINE_EXCLUSIVE: "online_exclusive",
-      SUSTAINABLE: "sustainable",
-      PREMIUM: "premium",
-      DEFAULT: "",
-    } as const;
+      NEW: 'new',
+      SOLD_OUT: 'sold_out',
+      ONLINE_EXCLUSIVE: 'online_exclusive',
+      SUSTAINABLE: 'sustainable',
+      PREMIUM: 'premium',
+      DEFAULT: '',
+    } as const
 
     type BadgeLabelParamsKeys =
-      | "isNew"
-      | "isSoldOut"
-      | "isOnlineOnly"
-      | "isSustainable"
-      | "isPremium";
-    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>;
+      | 'isNew'
+      | 'isSoldOut'
+      | 'isOnlineOnly'
+      | 'isSustainable'
+      | 'isPremium'
+    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>
 
     const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
       if (!params) {
-        return BadgeLabel.DEFAULT;
+        return BadgeLabel.DEFAULT
       }
       const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
-        params;
+        params
 
       if (isNew) {
-        return BadgeLabel.NEW;
+        return BadgeLabel.NEW
       } else if (isSoldOut) {
-        return BadgeLabel.SOLD_OUT;
+        return BadgeLabel.SOLD_OUT
       } else if (isOnlineOnly) {
-        return BadgeLabel.ONLINE_EXCLUSIVE;
+        return BadgeLabel.ONLINE_EXCLUSIVE
       } else if (isSustainable) {
-        return BadgeLabel.SUSTAINABLE;
+        return BadgeLabel.SUSTAINABLE
       } else if (isPremium) {
-        return BadgeLabel.PREMIUM;
+        return BadgeLabel.PREMIUM
       } else {
-        return BadgeLabel.DEFAULT;
+        return BadgeLabel.DEFAULT
       }
-    };
+    }
     ```
 
 - **\[💥 BREAKING\]** The `store` option in the module configuration has been removed. `œscayle/storefront-nuxt@7.84.0` introduced the `shops` option as a replacement, but maintained backward compatibility with the `store` option. Going forward, configuring shops must be done using the `shops` keyword.
@@ -1585,7 +1608,7 @@
         // ...
       },
       // ...
-    });
+    })
     ```
 
   - _Previous Environment Variables for Store Configuration:_
@@ -1614,7 +1637,7 @@
         // ...
       },
       // ...
-    });
+    })
     ```
 
   - _Current Environment Variables for Shops Configuration:_
@@ -1634,8 +1657,8 @@
     ```ts
     useProduct({
       // ...
-      key: "productKey",
-    });
+      key: 'productKey',
+    })
     ```
 
   - _Current `key` as dedicated composables argument:_
@@ -1645,8 +1668,8 @@
       {
         // ...
       },
-      "productKey",
-    );
+      'productKey',
+    )
     ```
 
 - **\[💥 BREAKING\]** Introducing a new feature flag `storefront.legacy.enableSessionMigration` to control the automatic migration of legacy session data, set to `false` by default. Starting with `@scayle/storefront-nuxt@7.68.0` Storefront uses unique session cookie names for each shop, simplifying implementation and enhancing stability.
@@ -1663,27 +1686,27 @@
   - _Previous Usage of `handleIDPLoginCallback`:_
 
     ```ts
-    const { handleIDPLoginCallback } = await useIDP();
+    const { handleIDPLoginCallback } = await useIDP()
 
     watch(
       () => route.query,
       async (query) => {
         if (query.code && isString(query.code)) {
-          await handleIDPLoginCallback(query.code);
+          await handleIDPLoginCallback(query.code)
         }
       },
       { immediate: true },
-    );
+    )
     ```
 
   - _Current Usage of `loginIDP`:_
 
     ```ts
-    const { loginIDP } = useAuthentication("login");
+    const { loginIDP } = useAuthentication('login')
 
     onMounted(async () => {
-      await loginIDP(props.code);
-    });
+      await loginIDP(props.code)
+    })
     ```
 
 - **\[🧹 NON-BREAKING\]** Addressed various type resolution errors that were present when using the `@scayle/storefront-nuxt` package with different Node.js versions and module systems. These errors manifested as internal resolution errors or ESM dynamic import only warnings. With this fix, the package now more consistently resolves types correctly across Node.js 16 (CJS and ESM), and bundlers, ensuring a smoother developer experience.
@@ -1693,17 +1716,17 @@
   - _Previous `useRpc` with `autoFetch`:_
 
     ```ts
-    useRpc("rpcMethod", key, params, { autoFetch: true });
+    useRpc('rpcMethod', key, params, { autoFetch: true })
 
-    useUser({ autoFetch: true });
+    useUser({ autoFetch: true })
     ```
 
   - _Current `useRpc` with `immediate`:_
 
     ```ts
-    useRpc("rpcMethod", key, params, { immediate: true });
+    useRpc('rpcMethod', key, params, { immediate: true })
 
-    useUser({ immediate: true });
+    useUser({ immediate: true })
     ```
 
 - **\[💥 BREAKING\]** The attribute `isCmsPreview` has been removed from `RpcContext`.
@@ -1723,18 +1746,18 @@
       getSearchSuggestions,
       fetching,
       ...searchData
-    } = useStorefrontSearch(searchQuery, { key });
+    } = useStorefrontSearch(searchQuery, { key })
 
-    fetching.value; // true or false
+    fetching.value // true or false
     ```
 
   - _Current `useStorefrontSearch` returning `status`:_
 
     ```ts
     const { data, resolveSearch, getSearchSuggestions, status, ...searchData } =
-      useStorefrontSearch(searchQuery, {}, key);
+      useStorefrontSearch(searchQuery, {}, key)
 
-    status.value; // 'idle', 'pending', 'error' or 'success'
+    status.value // 'idle', 'pending', 'error' or 'success'
     ```
 
 - **\[💥 BREAKING\]** We've simplified composable caching and clarified the control you have over shared state behavior. The configuration option `disableDefaultGetCachedDataOverride` has been replaced with `legacy.enableDefaultGetCachedDataOverride`, and its logic has been reversed. Now, when `legacy.enableDefaultGetCachedDataOverride` is not set or set to `false`, the default behavior maintains the shared state functionality of `useRpc`, where multiple calls with the same key use the same cached data. Setting the option to `true` bypasses this shared caching, providing data isolation between calls. To maintain your existing caching behavior, simply change the value of `disableDefaultGetCachedDataOverride` to its opposite in your `nuxt.config.ts` file.
@@ -1759,7 +1782,7 @@
         // ...
       },
       // ...
-    });
+    })
     ```
 
   - _Current `enableDefaultGetCachedDataOverride`in `nuxt.config.ts`:_
@@ -1784,7 +1807,7 @@
         // ...
       },
       // ...
-    });
+    })
     ```
 
 - **\[💥 BREAKING\]** The `useRpc` composable has been updated to provide a more modern and robust data fetching experience, aligning its interface with the current and underlying [Nuxt 3 `useAsyncData`.](https://nuxt.com/docs/api/composables/use-async-data#return-values).
@@ -1806,7 +1829,7 @@
     function myCustomRpc() {
       // ...
 
-      throw new BaseError(404);
+      throw new BaseError(404)
     }
     ```
 
@@ -1816,7 +1839,7 @@
     function myCustomRpc() {
       // ...
 
-      return new Response(null, { status: 404 });
+      return new Response(null, { status: 404 })
     }
     ```
 

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.32.1",
+  "version": "8.33.0",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -54,7 +54,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.32.1";
+const PACKAGE_VERSION = "8.33.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.32.1",
+  "version": "8.33.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -61,13 +61,21 @@
   "engines": {
     "node": ">= 20.7.0"
   },
+  "peerDependencies": {
+    "@nuxt/kit": ">=3.12.2",
+    "@scayle/storefront-api": "^18.1.0",
+    "fishery": "^2.2.2",
+    "h3": "^1.10.0",
+    "nitropack": "^2.9.7",
+    "nuxt": ">=3.10.0",
+    "unstorage": "^1.10.1",
+    "vue": "^3.4.0"
+  },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "0.6.1",
-    "@scayle/storefront-core": "8.32.1",
-    "@scayle/unstorage-compression-driver": "^1.0.0",
     "@vercel/nft": "0.29.4",
-    "@vueuse/core": "13.4.0",
+    "@vueuse/core": "13.5.0",
     "consola": "^3.2.3",
     "core-js": "^3.37.1",
     "defu": "^6.1.4",
@@ -81,24 +89,23 @@
     "unstorage": "^1.10.2",
     "utility-types": "^3.11.0",
     "vue-router": "^4.4.0",
-    "zod": "^3.23.8"
+    "zod": "^3.23.8",
+    "@scayle/storefront-core": "8.33.0",
+    "@scayle/unstorage-compression-driver": "1.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "0.18.2",
     "@eslint/eslintrc": "3.3.1",
-    "@nuxt/eslint": "1.5.0",
+    "@nuxt/eslint": "1.5.2",
     "@nuxt/kit": "3.16.2",
     "@nuxt/module-builder": "1.0.1",
     "@nuxt/schema": "3.16.2",
     "@nuxt/test-utils": "3.19.2",
-    "@scayle/eslint-config-storefront": "4.5.12",
-    "@scayle/eslint-plugin-vue-composable": "0.2.1",
-    "@scayle/unstorage-scayle-kv-driver": "1.0.2",
-    "@types/node": "22.15.34",
+    "@types/node": "22.16.0",
     "@vitest/coverage-v8": "3.2.4",
     "dprint": "0.50.1",
     "eslint-formatter-gitlab": "6.0.1",
-    "eslint": "9.30.0",
+    "eslint": "9.30.1",
     "fishery": "2.3.1",
     "h3": "1.15.3",
     "nitro-test-utils": "0.9.2",
@@ -109,17 +116,10 @@
     "typescript": "5.8.3",
     "unbuild": "3.5.0",
     "vitest": "3.2.4",
-    "vue-tsc": "2.2.10"
-  },
-  "peerDependencies": {
-    "@nuxt/kit": ">=3.12.2",
-    "@scayle/storefront-api": "^18.1.0",
-    "fishery": "^2.2.2",
-    "h3": "^1.10.0",
-    "nitropack": "^2.9.7",
-    "nuxt": ">=3.10.0",
-    "unstorage": "^1.10.1",
-    "vue": "^3.4.0"
+    "vue-tsc": "3.0.1",
+    "@scayle/eslint-config-storefront": "4.5.12",
+    "@scayle/eslint-plugin-vue-composable": "0.2.1",
+    "@scayle/unstorage-scayle-kv-driver": "1.0.2"
   },
   "volta": {
     "node": "22.17.0"