@scayle/storefront-product-listing 1.5.0 → 1.6.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scayle/storefront-product-listing
 
+## 1.6.1
+
+### Patch Changes
+
+- Added missing exports for `useAllShopCategoriesForId` composable and SEO utils.
+
+## 1.6.0
+
+### Minor Changes
+
+- **\[PLP\]** Added `generateCategoryHreflangLinks` utils to generate hreflang links for a category for all shops.
+- **\[PLP\]** Added RPC method `getAllShopCategoriesForId` and the composable `useAllShopCategoriesForId` for product listing page to fetch category for all shops. This is used to generate hreflang links for the category for all shops.
+
 ## 1.5.0
 
 ### Minor Changes

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-product-listing",
   "configKey": "product-listing",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "compatibility": {
     "bridge": false,
     "nuxt": ">=3.13"

package/dist/module.mjs

@@ -1,7 +1,7 @@
-import { defineNuxtModule, createResolver, addImportsDir } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, resolvePath, addImportsDir } from '@nuxt/kit';
 
 const PACKAGE_NAME = "@scayle/storefront-product-listing";
-const PACKAGE_VERSION = "1.5.0";
+const PACKAGE_VERSION = "1.6.1";
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,
@@ -17,6 +17,12 @@ const module = defineNuxtModule({
     const { resolve } = createResolver(import.meta.url);
     nuxt.options.alias["#storefront-product-listing"] = resolve("./runtime");
     nuxt.options.build.transpile.push("#storefront-product-listing/runtime");
+    nuxt.hook("storefront:custom-rpc:extend", async (customRpcs) => {
+      customRpcs.push({
+        source: await resolvePath("./runtime/rpc/methods/categories"),
+        names: ["getAllShopCategoriesForId"]
+      });
+    });
     if (options.autoImports) {
       addImportsDir(resolve("./runtime/composables"));
       addImportsDir(resolve("./runtime/utils"));

package/dist/runtime/composables/index.d.ts

@@ -1,3 +1,4 @@
+export * from './useAllShopCategoriesForId.js';
 export * from './useAppliedFilters.js';
 export * from './useFiltersForListing.js';
 export * from './useProductListSort.js';

package/dist/runtime/composables/index.js

@@ -1,3 +1,4 @@
+export * from "./useAllShopCategoriesForId.js";
 export * from "./useAppliedFilters.js";
 export * from "./useFiltersForListing.js";
 export * from "./useProductListSort.js";

package/dist/runtime/composables/useAllShopCategoriesForId.d.ts

@@ -0,0 +1,4 @@
+import type { KeysOf, NormalizedRpcResponse, UseRpcReturn } from '@scayle/storefront-nuxt/composables';
+import type { MaybeRefOrGetter } from 'vue';
+import type { RpcMethodParameters } from '@scayle/storefront-core';
+export declare function useAllShopCategoriesForId<DataT = NormalizedRpcResponse<'getAllShopCategoriesForId'>, PickKeys extends KeysOf<DataT> = KeysOf<DataT>, DefaultT = null>(params: MaybeRefOrGetter<RpcMethodParameters<'getAllShopCategoriesForId'>>, key?: string): UseRpcReturn<'getAllShopCategoriesForId', DataT, PickKeys, DefaultT>;

package/dist/runtime/composables/useAllShopCategoriesForId.js

@@ -0,0 +1,8 @@
+import { useRpc } from "@scayle/storefront-nuxt/composables";
+export function useAllShopCategoriesForId(params, key = "useAllShopCategoriesForId") {
+  return useRpc(
+    "getAllShopCategoriesForId",
+    key,
+    params
+  );
+}

package/dist/runtime/index.d.ts

@@ -1,3 +1,4 @@
+export * from './composables/useAllShopCategoriesForId.js';
 export * from './composables/useProductListSort.js';
 export * from './composables/useAppliedFilters.js';
 export * from './composables/useFiltersForListing.js';
@@ -5,3 +6,4 @@ export * from './composables/useProductListingSeoData.js';
 export * from './composables/useProductsForListing.js';
 export * from './utils/filters.js';
 export * from './utils/category.js';
+export * from './utils/seo.js';

package/dist/runtime/index.js

@@ -1,3 +1,4 @@
+export * from "./composables/useAllShopCategoriesForId.js";
 export * from "./composables/useProductListSort.js";
 export * from "./composables/useAppliedFilters.js";
 export * from "./composables/useFiltersForListing.js";
@@ -5,3 +6,4 @@ export * from "./composables/useProductListingSeoData.js";
 export * from "./composables/useProductsForListing.js";
 export * from "./utils/filters.js";
 export * from "./utils/category.js";
+export * from "./utils/seo.js";

package/dist/runtime/rpc/methods/categories.d.ts

@@ -0,0 +1,25 @@
+import type { ProductCategoryPropertyWith, RpcHandler, ShopConfig, Category } from '@scayle/storefront-nuxt';
+type ShopCategory = Pick<ShopConfig, 'locale' | 'path'> & {
+    category: Category;
+};
+/**
+ * Fetches all shop categories for a given category ID.
+ *
+ * This function retrieves all categories from all shops in the runtime configuration.
+ * It uses the SAPI client to fetch the category details for each shop.
+ *
+ * @param options - The parameters for fetching the category.
+ * @param options.id - The ID of the category to fetch.
+ * @param options.children - The number of children to fetch.
+ * @param options.includeHidden - Whether to include hidden categories.
+ * @param options.properties - The properties to fetch.
+ *
+ * @param context - The context object containing runtime configuration, SAPI client, and logging.
+ *
+ * @returns An array of objects containing the category for each shop.
+ */
+export declare const getAllShopCategoriesForId: RpcHandler<{
+    id: number;
+    properties?: ProductCategoryPropertyWith;
+}, ShopCategory[]>;
+export {};

package/dist/runtime/rpc/methods/categories.js

@@ -0,0 +1,34 @@
+export const getAllShopCategoriesForId = async function getAllShopCategoriesForId2({ id, properties }, context) {
+  const { runtimeConfiguration, sapiClient, log, cached } = context;
+  const fetchAllCategories = async () => {
+    const categories = [];
+    const shops = Object.values(
+      runtimeConfiguration.storefront.shops
+    );
+    await Promise.all(
+      shops.map(async (shop) => {
+        try {
+          const category = await sapiClient.clone({ shopId: shop.shopId }).categories.getById(id, {
+            with: {
+              properties
+            }
+          });
+          categories.push({
+            locale: shop.locale,
+            path: Array.isArray(shop.path) ? shop.path[0] : shop.path,
+            category
+          });
+        } catch (error) {
+          log.error(error instanceof Error ? error : String(error));
+        }
+      })
+    );
+    return categories;
+  };
+  const result = await cached(fetchAllCategories, {
+    cacheKeyPrefix: `getAllShopCategoriesForId-${id}`,
+    ttl: 12 * 60 * 60
+    // 12 hours
+  })();
+  return result;
+};

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

@@ -1,6 +1,6 @@
 import type { LocationQuery, RouteLocationNormalizedLoadedGeneric } from 'vue-router';
 import type { CategoryFilter, ProductSearchQuery } from '@scayle/storefront-nuxt';
-import type { RangeTuple } from '~/src';
+import type { RangeTuple } from '../..//index.js';
 /**
  * Parses filter data from a Vue Router route object.
  *

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

@@ -0,0 +1,19 @@
+import type { ShopConfig } from '@scayle/storefront-nuxt';
+import type { MaybeRefOrGetter } from 'vue';
+type ShopCategoryHref = Pick<ShopConfig, 'locale' | 'path'> & {
+    categoryHref: string;
+};
+/**
+ * Generates hreflang links for a product listing.
+ *
+ * @param _categoriesForAllShops - A list of category links for all shops.
+ * @param defaultLocale - The default locale of the store.
+ *
+ * @returns An array of hreflang links.
+ */
+export declare const generateProductListingHreflangLinks: (_categoriesForAllShops: MaybeRefOrGetter<ShopCategoryHref[]>, defaultLocale: string) => {
+    rel: string;
+    hreflang: string;
+    href: string;
+}[];
+export {};

package/dist/runtime/utils/seo.js

@@ -0,0 +1,24 @@
+import { toValue } from "vue";
+export const generateProductListingHreflangLinks = (_categoriesForAllShops, defaultLocale) => {
+  const categoriesForAllShops = toValue(_categoriesForAllShops);
+  if (!categoriesForAllShops) {
+    return [];
+  }
+  return categoriesForAllShops.flatMap(({ categoryHref, path, locale }) => {
+    const links = [
+      {
+        rel: "alternate",
+        hreflang: locale,
+        href: categoryHref
+      }
+    ];
+    if (path === defaultLocale) {
+      links.push({
+        rel: "alternate",
+        hreflang: "x-default",
+        href: categoryHref
+      });
+    }
+    return links;
+  });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-product-listing",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "Collection of essential composables and utilities to work with product listing",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -41,9 +41,9 @@
     "lint:fix": "eslint . --fix",
     "format": "dprint check",
     "format:fix": "dprint fmt",
-    "test": "vitest --run --passWithNoTests",
-    "test:watch": "vitest --passWithNoTests",
-    "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml",
+    "test": "vitest --run",
+    "test:watch": "vitest",
+    "test:ci": "vitest --run --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml",
     "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
     "package:lint": "publint",
     "verify-packaging": "attw --pack . --profile esm-only"
@@ -65,14 +65,14 @@
     "@nuxt/schema": "3.16.2",
     "@nuxt/test-utils": "3.18.0",
     "@scayle/eslint-config-storefront": "4.5.2",
-    "@scayle/storefront-api": "18.3.1",
-    "@scayle/storefront-nuxt": "8.25.4",
-    "@types/node": "22.15.17",
+    "@scayle/storefront-api": "18.7.0",
+    "@scayle/storefront-nuxt": "8.27.0",
+    "@types/node": "22.15.21",
     "@vue/test-utils": "2.4.6",
-    "@vueuse/core": "13.1.0",
-    "dprint": "0.49.1",
+    "@vueuse/core": "13.2.0",
+    "dprint": "0.50.0",
     "eslint-formatter-gitlab": "6.0.0",
-    "eslint": "9.26.0",
+    "eslint": "9.27.0",
     "fishery": "2.3.1",
     "happy-dom": "17.4.7",
     "nuxt": "3.16.2",
@@ -80,9 +80,9 @@
     "schema-dts": "1.1.5",
     "typescript": "5.8.3",
     "unbuild": "3.5.0",
-    "vitest": "3.1.3",
+    "vitest": "3.1.4",
     "vue-router": "4.5.1",
     "vue-tsc": "2.2.10",
-    "vue": "3.5.13"
+    "vue": "3.5.14"
   }
 }