@scayle/storefront-product-listing 1.3.2 → 1.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scayle/storefront-product-listing
 
+## 1.5.0
+
+### Minor Changes
+
+- **\[Utilities\]** Added `getCategoryAncestors`, `isSaleCategory`, and `flattenCategoryTree` utilities to enhance functionality.
+
+## 1.4.0
+
+### Minor Changes
+
+- Update to `@nuxt/module-builder@1`. This version of Nuxt Module Builder is ESM-only, so CommonJS (`.cjs`) files will no longer be built or distributed with the package. However as of Nuxt 3, only esm is used so this should not have any impact as this module does not support Nuxt 2.
+
 ## 1.3.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -4,9 +4,9 @@ import { FilterItemWithValues } from '@scayle/storefront-api';
 
 type RangeTuple = [start: number, end: number];
 
-declare const breadcrumbsFactory: Factory<BreadcrumbItem[], any, BreadcrumbItem[]>;
+declare const breadcrumbsFactory: Factory<BreadcrumbItem[], any, BreadcrumbItem[], BreadcrumbItem[]>;
 
-declare const filtersFactory: Factory<FilterItemWithValues[], any, FilterItemWithValues[]>;
+declare const filtersFactory: Factory<FilterItemWithValues[], any, FilterItemWithValues[], FilterItemWithValues[]>;
 
 export { breadcrumbsFactory, filtersFactory };
 export type { RangeTuple };

package/dist/module.json

@@ -1,13 +1,13 @@
 {
   "name": "@scayle/storefront-product-listing",
   "configKey": "product-listing",
-  "version": "1.3.2",
+  "version": "1.5.0",
   "compatibility": {
     "bridge": false,
     "nuxt": ">=3.13"
   },
   "builder": {
-    "@nuxt/module-builder": "0.8.4",
-    "unbuild": "2.0.0"
+    "@nuxt/module-builder": "1.0.1",
+    "unbuild": "3.5.0"
   }
 }

package/dist/module.mjs

@@ -1,7 +1,7 @@
 import { defineNuxtModule, createResolver, addImportsDir } from '@nuxt/kit';
 
 const PACKAGE_NAME = "@scayle/storefront-product-listing";
-const PACKAGE_VERSION = "1.3.2";
+const PACKAGE_VERSION = "1.5.0";
 const module = defineNuxtModule({
   meta: {
     name: PACKAGE_NAME,

package/dist/runtime/index.d.ts

@@ -4,3 +4,4 @@ export * from './composables/useFiltersForListing.js';
 export * from './composables/useProductListingSeoData.js';
 export * from './composables/useProductsForListing.js';
 export * from './utils/filters.js';
+export * from './utils/category.js';

package/dist/runtime/index.js

@@ -4,3 +4,4 @@ export * from "./composables/useFiltersForListing.js";
 export * from "./composables/useProductListingSeoData.js";
 export * from "./composables/useProductsForListing.js";
 export * from "./utils/filters.js";
+export * from "./utils/category.js";

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

@@ -0,0 +1,19 @@
+import type { Category } from '@scayle/storefront-nuxt';
+/**
+ * Get all ancestors of a category.
+ * @param category - The category to get the ancestors of.
+ * @returns An array of all ancestors of the category.
+ */
+export declare const getCategoryAncestors: (category: Category) => Category[];
+/**
+ * Check if a category is a sale category.
+ * @param category - The category to check.
+ * @returns True if the category is the sale category, false otherwise.
+ */
+export declare const isSaleCategory: (category: Category) => boolean;
+/**
+ * Flatten a category tree.
+ * @param categoryTree - The category tree to flatten.
+ * @returns A flattened array of all categories in the tree.
+ */
+export declare const flattenCategoryTree: (categoryTree: Category[]) => Category[];

package/dist/runtime/utils/category.js

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

package/dist/types.d.mts

@@ -1,7 +1,7 @@
 import type { NuxtModule } from '@nuxt/schema'
 
-import type { default as Module } from './module.js'
+import type { default as Module } from './module.mjs'
 
 export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
 
-export { default } from './module.js'
+export { default } from './module.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-product-listing",
-  "version": "1.3.2",
+  "version": "1.5.0",
   "description": "Collection of essential composables and utilities to work with product listing",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -11,12 +11,11 @@
   },
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/index.d.mts",
       "default": "./dist/index.mjs"
     },
     "./module": {
-      "types": "./dist/module.d.ts",
-      "require": "./dist/module.cjs",
+      "types": "./dist/module.d.mts",
       "import": "./dist/module.mjs"
     },
     "./composables": {
@@ -25,7 +24,6 @@
     }
   },
   "main": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
   "files": [
     "CHANGELOG.md",
     "dist"
@@ -37,8 +35,9 @@
     "build": "nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",
-    "prep": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
-    "lint": "eslint . --format gitlab",
+    "prep": "nuxt-module-build prepare && nuxi prepare playground",
+    "lint": "eslint .",
+    "lint:ci": "eslint . --format gitlab",
     "lint:fix": "eslint . --fix",
     "format": "dprint check",
     "format:fix": "dprint fmt",
@@ -46,7 +45,8 @@
     "test:watch": "vitest --passWithNoTests",
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml",
     "typecheck": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
-    "package:lint": "publint"
+    "package:lint": "publint",
+    "verify-packaging": "attw --pack . --profile esm-only"
   },
   "peerDependencies": {
     "@nuxt/kit": ">=3.13.0",
@@ -59,29 +59,30 @@
     "vue": "^3.5.13"
   },
   "devDependencies": {
-    "@nuxt/kit": "3.15.4",
-    "@nuxt/module-builder": "0.8.4",
-    "@nuxt/schema": "3.15.4",
-    "@nuxt/test-utils": "3.17.2",
-    "@scayle/eslint-config-storefront": "4.5.0",
-    "@scayle/storefront-api": "18.2.1",
-    "@scayle/storefront-nuxt": "8.16.0",
-    "@types/node": "22.14.0",
+    "@arethetypeswrong/cli": "0.18.1",
+    "@nuxt/kit": "3.16.2",
+    "@nuxt/module-builder": "1.0.1",
+    "@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",
     "@vue/test-utils": "2.4.6",
-    "@vueuse/core": "13.0.0",
+    "@vueuse/core": "13.1.0",
     "dprint": "0.49.1",
-    "eslint-formatter-gitlab": "5.1.0",
-    "eslint": "9.23.0",
-    "fishery": "2.2.3",
-    "happy-dom": "17.4.4",
-    "nuxt": "3.15.4",
+    "eslint-formatter-gitlab": "6.0.0",
+    "eslint": "9.26.0",
+    "fishery": "2.3.1",
+    "happy-dom": "17.4.7",
+    "nuxt": "3.16.2",
     "publint": "0.2.12",
     "schema-dts": "1.1.5",
-    "typescript": "5.8.2",
-    "unbuild": "2.0.0",
-    "vitest": "2.1.9",
-    "vue-router": "4.5.0",
-    "vue-tsc": "2.2.8",
+    "typescript": "5.8.3",
+    "unbuild": "3.5.0",
+    "vitest": "3.1.3",
+    "vue-router": "4.5.1",
+    "vue-tsc": "2.2.10",
     "vue": "3.5.13"
   }
 }

package/dist/index.d.ts

@@ -1,12 +0,0 @@
-import { BreadcrumbItem } from '@scayle/storefront-nuxt';
-import { Factory } from 'fishery';
-import { FilterItemWithValues } from '@scayle/storefront-api';
-
-type RangeTuple = [start: number, end: number];
-
-declare const breadcrumbsFactory: Factory<BreadcrumbItem[], any, BreadcrumbItem[]>;
-
-declare const filtersFactory: Factory<FilterItemWithValues[], any, FilterItemWithValues[]>;
-
-export { breadcrumbsFactory, filtersFactory };
-export type { RangeTuple };

package/dist/module.cjs

@@ -1,5 +0,0 @@
-module.exports = function(...args) {
-  return import('./module.mjs').then(m => m.default.call(this, ...args))
-}
-const _meta = module.exports.meta = require('./module.json')
-module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -1,8 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-
-interface ModuleOptions {
-    autoImports?: boolean;
-}
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
-
-export { _default as default };

package/dist/types.d.ts

@@ -1,7 +0,0 @@
-import type { NuxtModule } from '@nuxt/schema'
-
-import type { default as Module } from './module'
-
-export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
-
-export { default } from './module'