@scayle/storefront-nuxt 7.88.1 → 7.89.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @scayle/storefront-nuxt
 
+## 7.89.0
+
+### Minor Changes
+
+- Add `category` test factory and expose all test factories. Moreover, `fishery` has
+  been added to the `peerDependencies` as it is main dependency for the test factories.
+  They can be used as follows:
+
+  ```ts
+  import { categoryFactory } from '@scayle/storefront-nuxt/test-factories'
+
+  categoryFactory.build()
+  ```
+
+- Introduce `seo` and `category` utilities within the module and expose them as externals.
+  The category utilities consist of various functions that manage category tree-structured data.
+  The SEO utilities focus primarily on generating schemas and manipulating URLs for SEO purposes.
+
+  They are exposed externally and can be used as follows:
+
+  ```ts
+  import { sanitizeCanonicalURL } from '@scayle/storefront-nuxt'
+
+  sanitizeCanonicalURL('/en/women-2045')
+  ```
+
+### Patch Changes
+
+- Added dependency `schema-dts@1.1.2`
+- Updated dependency `ufo@^1.5.3` to `ufo@^1.5.4`
+  **Dependencies**
+
+- Updated dependency to @scayle/unstorage-compression-driver@0.1.5
+
 ## 7.88.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,8 @@
 export { e as AdditionalShopConfig, A as AppKeys, B as BapiConfig, i as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, j as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, d as SapiConfig, a as SessionConfig, f as ShopConfig, g as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, h as StorefrontConfig } from './shared/storefront-nuxt.80aa5060.mjs';
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';
+export * from '../dist/runtime/utils/category.js';
+export * from '../dist/runtime/utils/seo.js';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export { e as AdditionalShopConfig, A as AppKeys, B as BapiConfig, i as CheckoutEvent, C as CheckoutShopConfig, M as ModuleBaseOptions, j as ModulePublicRuntimeConfig, P as PublicShopConfig, R as RedisConfig, d as SapiConfig, a as SessionConfig, f as ShopConfig, g as ShopConfigIndexed, c as StorageConfig, b as StorageEntity, S as StorageProvider, h as StorefrontConfig } from './shared/storefront-nuxt.80aa5060.js';
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';
+export * from '../dist/runtime/utils/category.js';
+export * from '../dist/runtime/utils/seo.js';
 export * from '@scayle/storefront-core';
 export { LogLevel } from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';

package/dist/index.mjs

@@ -1,4 +1,6 @@
 export { rpcCall } from '../dist/runtime/rpc/rpcCall.js';
 export { extendPromise } from '../dist/runtime/utils/promise.js';
+export * from '../dist/runtime/utils/category.js';
+export * from '../dist/runtime/utils/seo.js';
 export * from '@scayle/storefront-core';
 export { unwrap } from '@scayle/storefront-core/dist/utils/response';

package/dist/module.json

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

package/dist/module.mjs

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

package/dist/runtime/utils/category.d.ts

@@ -0,0 +1,4 @@
+import type { Category } from '@scayle/storefront-core';
+export declare const getCategoryAncestors: (category: Category, categories?: Category[]) => Category[];
+export declare const isSaleCategory: (category: Category) => boolean;
+export declare const flattenCategoryTree: (categoryTree: Category[]) => Category[];

package/dist/runtime/utils/category.js

@@ -0,0 +1,20 @@
+export const getCategoryAncestors = (category, categories = []) => {
+  if (!category?.parent) {
+    return categories;
+  }
+  return getCategoryAncestors(category.parent, [category.parent, ...categories]);
+};
+export const isSaleCategory = (category) => {
+  return category.properties.some(({ name }) => name === "sale");
+};
+export const flattenCategoryTree = (categoryTree) => {
+  const flattenedCategoryTreeList = categoryTree.flatMap((categoryNode) => [
+    categoryNode,
+    ...categoryNode.children ? flattenCategoryTree(categoryNode.children) : []
+  ]);
+  return [
+    ...new Map(
+      flattenedCategoryTreeList.map((item) => [item.id, item])
+    ).values()
+  ];
+};

package/dist/runtime/utils/seo.d.ts

@@ -0,0 +1,4 @@
+import type { WithContext, BreadcrumbList } from 'schema-dts';
+import type { BreadcrumbItem } from '@scayle/storefront-core';
+export declare const sanitizeCanonicalURL: (url: string, whitelistParams?: string[]) => string;
+export declare const generateCategoryBreadcrumbSchema: (breadcrumbs: BreadcrumbItem[]) => WithContext<BreadcrumbList>;

package/dist/runtime/utils/seo.js

@@ -0,0 +1,28 @@
+import { parseURL, stringifyParsedURL, parseQuery, stringifyQuery } from "ufo";
+const CANONICAL_PARAMS_WHITELIST = ["page"];
+export const sanitizeCanonicalURL = (url, whitelistParams = CANONICAL_PARAMS_WHITELIST) => {
+  const parsedURL = parseURL(url);
+  if (!parsedURL.search) {
+    return url;
+  }
+  const parsedQuery = parseQuery(parsedURL.search);
+  const purifiedQuery = Object.fromEntries(
+    Object.entries(parsedQuery).filter(
+      ([key]) => whitelistParams.includes(key)
+    )
+  );
+  return stringifyParsedURL({
+    ...parsedURL,
+    search: stringifyQuery(purifiedQuery)
+  });
+};
+export const generateCategoryBreadcrumbSchema = (breadcrumbs) => ({
+  "@context": "https://schema.org",
+  "@type": "BreadcrumbList",
+  itemListElement: breadcrumbs.map((item, index) => ({
+    "@type": "ListItem",
+    position: index + 1,
+    name: item.value,
+    item: item.to
+  }))
+});

package/dist/test-factories/category.d.ts

@@ -0,0 +1,3 @@
+import type { Category } from '@scayle/storefront-core';
+import { Factory } from 'fishery';
+export declare const categoryFactory: Factory<Category, any, Category>;

package/dist/test-factories/category.mjs

@@ -0,0 +1,18 @@
+import { Factory } from "fishery";
+export const categoryFactory = Factory.define(() => {
+  return {
+    id: 1,
+    path: "/women",
+    name: "women",
+    slug: "test",
+    parentId: 2048,
+    rootlineIds: [2045, 2048, 2058],
+    childrenIds: [],
+    properties: [],
+    isHidden: false,
+    depth: 3,
+    supportedFilter: ["color", "brand", "size"],
+    shopLevelCustomData: {},
+    countryLevelCustomData: {}
+  };
+});

package/dist/test-factories/index.d.ts

@@ -0,0 +1,4 @@
+export * from './category';
+export * from './moduleOptions';
+export * from './shopConfig';
+export * from './rpcContext';

package/dist/test-factories/index.mjs

@@ -0,0 +1,4 @@
+export * from "./category.mjs";
+export * from "./moduleOptions.mjs";
+export * from "./shopConfig.mjs";
+export * from "./rpcContext.mjs";

package/dist/test-factories/moduleOptions.d.ts

@@ -0,0 +1,7 @@
+import { Factory } from 'fishery';
+import type { ModuleBaseOptions, ShopConfig } from '../../src/module';
+interface ModuleOptionsFactoryParams {
+    shops: ShopConfig[];
+}
+export declare const moduleOptionsFactory: Factory<ModuleBaseOptions, ModuleOptionsFactoryParams, ModuleBaseOptions>;
+export {};

package/dist/test-factories/moduleOptions.mjs

@@ -0,0 +1,27 @@
+import { Factory } from "fishery";
+import { HashAlgorithm } from "@scayle/storefront-core";
+export const moduleOptionsFactory = Factory.define(({ transientParams }) => {
+  return {
+    sapi: {
+      host: "sapiHost",
+      token: "sapiToken"
+    },
+    oauth: {
+      apiHost: "oauthHost",
+      clientId: "clientId",
+      clientSecret: "clientSecret"
+    },
+    appKeys: {
+      basketKey: "basketKey",
+      wishlistKey: "wishlistKey",
+      hashAlgorithm: HashAlgorithm.MD5
+    },
+    shopSelector: "path",
+    shops: (transientParams?.shops || []).reduce((acc, curr) => {
+      return {
+        [curr.shopId]: curr,
+        ...acc
+      };
+    }, {})
+  };
+});

package/dist/test-factories/rpcContext.d.ts

@@ -0,0 +1,7 @@
+import { Factory } from 'fishery';
+import { type RpcContext } from '@scayle/storefront-core';
+interface RpcContextFactoryParams {
+    isLoggedIn: boolean;
+}
+export declare const rpcContextFactory: Factory<RpcContext, RpcContextFactoryParams, RpcContext>;
+export {};

package/dist/test-factories/rpcContext.mjs

@@ -0,0 +1,57 @@
+import { Factory } from "fishery";
+import { vi } from "vitest";
+import {
+  StorefrontAPIClient
+} from "@scayle/storefront-core";
+import { Log } from "../../src/runtime/log";
+export const rpcContextFactory = Factory.define(({ transientParams }) => {
+  return {
+    locale: "de",
+    checkout: {
+      url: "",
+      token: "",
+      secret: "",
+      user: ""
+    },
+    bapiClient: new StorefrontAPIClient({ host: "", shopId: 1001 }),
+    sapiClient: new StorefrontAPIClient({ host: "", shopId: 1001 }),
+    cached: (fn, _options) => {
+      return async (...args) => {
+        return await fn(...args);
+      };
+    },
+    isCmsPreview: false,
+    shopId: 1001,
+    domain: "localhost",
+    destroySessionsForUserId: vi.fn(),
+    generateBasketKeyForUserId: (userId) => Promise.resolve(`basket-${userId}`),
+    generateWishlistKeyForUserId: (userId) => Promise.resolve(`wishlist-${userId}`),
+    log: new Log(),
+    auth: {},
+    runtimeConfiguration: {},
+    headers: new Headers(),
+    ...transientParams.isLoggedIn ? {
+      wishlistKey: "wishlistKey",
+      basketKey: "basketKey",
+      sessionId: "sessionId",
+      user: void 0,
+      accessToken: void 0,
+      refreshToken: void 0,
+      destroySession: vi.fn(),
+      createUserBoundSession: vi.fn(),
+      updateUser: vi.fn(),
+      updateTokens: vi.fn()
+    } : {
+      wishlistKey: void 0,
+      basketKey: void 0,
+      sessionId: void 0,
+      user: void 0,
+      accessToken: void 0,
+      refreshToken: void 0,
+      destroySession: void 0,
+      createUserBoundSession: void 0,
+      updateUser: void 0,
+      updateTokens: void 0
+    }
+  };
+});

package/dist/test-factories/shopConfig.d.ts

@@ -0,0 +1,3 @@
+import { Factory } from 'fishery';
+import type { ShopConfig } from '../../src/module';
+export declare const shopConfigFactory: Factory<ShopConfig, any, ShopConfig>;

package/dist/test-factories/shopConfig.mjs

@@ -0,0 +1,19 @@
+import { Factory } from "fishery";
+export const shopConfigFactory = Factory.define(() => {
+  return {
+    shopId: 1,
+    domain: "localhost",
+    locale: "en-US",
+    currency: "USD",
+    checkout: {
+      host: "checkoutHost",
+      secret: "checkoutSecret",
+      token: "checkoutToken",
+      user: "checkoutUser"
+    },
+    auth: {
+      resetPasswordUrl: "resetPasswordUrl"
+    },
+    paymentProviders: []
+  };
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "7.88.1",
+  "version": "7.89.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -29,6 +29,10 @@
       "types": "./dist/runtime/composables/index.d.ts",
       "import": "./dist/runtime/composables/index.js"
     },
+    "./test-factories": {
+      "types": "./dist/test-factories/index.d.ts",
+      "default": "./dist/test-factories/index.mjs"
+    },
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.mjs"
@@ -66,7 +70,7 @@
     "@opentelemetry/api": "^1.9.0",
     "@scayle/h3-session": "^0.4.1",
     "@scayle/storefront-core": "7.66.1",
-    "@scayle/unstorage-compression-driver": "^0.1.4",
+    "@scayle/unstorage-compression-driver": "^0.1.5",
     "@vueuse/core": "11.2.0",
     "consola": "^3.2.3",
     "core-js": "^3.37.1",
@@ -76,11 +80,12 @@
     "knitwork": "^1.1.0",
     "nitropack": "^2.9.7",
     "ofetch": "^1.3.4",
-    "ufo": "^1.5.3",
+    "ufo": "^1.5.4",
     "uncrypto": "^0.1.3",
     "unstorage": "^1.10.2",
     "vue-router": "^4.4.0",
-    "zod": "^3.23.8"
+    "zod": "^3.23.8",
+    "schema-dts": "1.1.2"
   },
   "devDependencies": {
     "@nuxt/eslint": "0.6.1",
@@ -89,9 +94,9 @@
     "@nuxt/test-utils": "3.14.4",
     "@scayle/eslint-config-storefront": "4.3.2",
     "@scayle/eslint-plugin-vue-composable": "0.2.1",
-    "@types/node": "22.8.5",
+    "@types/node": "22.8.7",
     "dprint": "0.47.5",
-    "eslint": "9.13.0",
+    "eslint": "9.14.0",
     "eslint-formatter-gitlab": "5.1.0",
     "fishery": "2.2.2",
     "h3": "1.13.0",
@@ -106,7 +111,8 @@
     "h3": "^1.10.0",
     "nuxt": ">=3.10.0",
     "unstorage": ">= 1.10.1",
-    "vue": ">=3.4.0"
+    "vue": ">=3.4.0",
+    "fishery": "^2.2.2"
   },
   "resolutions": {
     "h3": "1.13.0",
@@ -115,6 +121,6 @@
     "@nuxt/schema": "3.13.2"
   },
   "volta": {
-    "node": "22.10.0"
+    "node": "22.11.0"
   }
 }