@scayle/storefront-nuxt 7.88.1 → 7.90.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @scayle/storefront-nuxt
 
+## 7.90.0
+
+### Minor Changes
+
+- Fix RPC context test factory `Log` import
+
+## 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.90.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.90.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

package/dist/runtime/api/rpcHandler.d.ts

@@ -1,4 +1,4 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | true | string[] | import("@scayle/storefront-core").ShopUser | import("@scayle/storefront-api").Product | import("@scayle/storefront-api").Product[] | {
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string | true | string[] | import("@scayle/storefront-core").ShopUser | Response | import("@scayle/storefront-api").Product | import("@scayle/storefront-api").Product[] | {
     count: number;
 } | {
     filters: import("@scayle/storefront-api").FiltersEndpointResponseData;
@@ -34,7 +34,7 @@ declare const _default: import("h3").EventHandler<import("h3").EventHandlerReque
     activeNode: import("@scayle/storefront-api").Category;
 } | import("@scayle/storefront-core").Order | import("@scayle/storefront-api").TypeaheadSuggestionsEndpointResponseData | import("@scayle/storefront-api").SearchV2SuggestionsEndpointResponseData | import("@scayle/storefront-api").SearchEntity | import("@scayle/storefront-api").ShopConfiguration | {
     user: import("@scayle/storefront-core").ShopUser | undefined;
-} | import("@scayle/storefront-api").Wishlist | Response | import("@scayle/storefront-core").ShopUserAddress[] | {
+} | import("@scayle/storefront-api").Wishlist | import("@scayle/storefront-core").ShopUserAddress[] | {
     accessToken: string;
     checkoutJwt: string;
 } | import("@scayle/storefront-api").VariantDetail[] | import("@scayle/storefront-api").NavigationAllEndpointResponseData | import("@scayle/storefront-api").NavigationTree | {

package/dist/runtime/plugin/shop.d.ts

@@ -1,8 +1,8 @@
 declare const _default: import("nuxt/app").Plugin<{
-    currentShop: import("../../module").PublicShopConfig;
-    availableShops: import("../../module").PublicShopConfig[];
+    currentShop: import("../..").PublicShopConfig;
+    availableShops: import("../..").PublicShopConfig[];
 }> & import("nuxt/app").ObjectPlugin<{
-    currentShop: import("../../module").PublicShopConfig;
-    availableShops: import("../../module").PublicShopConfig[];
+    currentShop: import("../..").PublicShopConfig;
+    availableShops: import("../..").PublicShopConfig[];
 }>;
 export default _default;

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
+  }))
+});