@scayle/storefront-product-detail 0.4.0 → 1.0.0

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-product-detail",
   "configKey": "product-detail",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "compatibility": {
     "bridge": false,
     "nuxt": ">=3.13"

package/dist/module.mjs

@@ -4,7 +4,7 @@ const module = defineNuxtModule({
   meta: {
     name: "@scayle/storefront-product-detail",
     configKey: "product-detail",
-    version: "0.0.1",
+    version: "1.0.0",
     compatibility: {
       bridge: false,
       nuxt: ">=3.13"

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

@@ -4,37 +4,37 @@ import type { WithContext, Product, BreadcrumbList } from 'schema-dts';
 type CanonicalLink = Record<'rel' | 'key' | 'href', string>;
 type UrlParams = Record<'baseUrl' | 'fullPath', string>;
 interface ProductInfo {
+    /** The name of the product. */
     name: string;
+    /** The brand of the product. */
     brand: string;
+    /** A description of the product. */
     productDescription: string;
+    /** Array of product variants. */
     variants: Variant[];
+    /** Array of image URLs for the product. */
     images: string[];
 }
 export interface UseProductSeoDataReturn {
+    /** The title of the product. */
     title: ComputedRef<string>;
+    /** Robots meta tag value, typically "index, follow". */
     robots: string;
+    /** Computed ref for canonical link tag metadata. */
     canonicalLink: ComputedRef<CanonicalLink[]>;
+    /** Computed ref containing JSON-LD structured data for the product. */
     productJsonLd: ComputedRef<WithContext<Product>>;
+    /** Computed ref containing JSON-LD structured data for product breadcrumbs. */
     productBreadcrumbJsonLd: ComputedRef<WithContext<BreadcrumbList>>;
 }
 /**
  * Composable function to generate SEO-related data for a product page.
  *
- * @param {MaybeRefOrGetter<BreadcrumbItem[]>} breadcrumbs - Array of breadcrumb items representing the navigation path to the product.
- * @param {MaybeRefOrGetter<UrlParams>} urlParams - Object containing baseUrl and fullPath to build and sanitize canonicalUrl.
- * @param {MaybeRefOrGetter<ProductInfo>} productInfo - Object containing product information including name, brand, description, and variants.
- * @property {string} name - The name of the product.
- * @property {string} brand - The brand of the product.
- * @property {string} productDescription - A description of the product.
- * @property {Variant[]} variants - Array of product variants.
- * @property {string[]} images - Array of image URLs for the product.
+ * @param breadcrumbs Array of breadcrumb items representing the navigation path to the product.
+ * @param urlParams Object containing baseUrl and fullPath to build and sanitize canonicalUrl.
+ * @param productInfo Object containing product information including name, brand, description, and variants.
  *
- * @returns {UseProductSeoDataReturn} An object containing SEO data for the product page with following properties:
- * @property {string} robots - Robots meta tag value, typically "index, follow".
- * @property {ComputedRef<CanonicalLink[]>} canonicalLink - Computed ref for canonical link tag metadata.
- * @property {ComputedRef<string>} title - The title of the product.
- * @property {ComputedRef<WithContext<Product>>} productJsonLd - Computed ref containing JSON-LD structured data for the product.
- * @property {ComputedRef<WithContext<BreadcrumbList>>} productBreadcrumbJsonLd - Computed ref containing JSON-LD structured data for product breadcrumbs.
+ * @returns An object containing SEO data for the product page with following properties:
  */
 export declare function useProductSeoData(breadcrumbs: MaybeRefOrGetter<BreadcrumbItem[]>, urlParams: MaybeRefOrGetter<UrlParams>, productInfo: MaybeRefOrGetter<ProductInfo>): UseProductSeoDataReturn;
 export {};

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

@@ -2,21 +2,27 @@ import type { Attributes } from '@scayle/storefront-nuxt';
 /**
  * Filters and formats attribute groups based on specified types.
  *
- * @param {Attributes} attributes - The object containing attribute groups, where each key maps to an attribute group.
- * @param {string[]} filterTypes - An array of attribute types to include in the filtered results.
- * @param {string[]} [singleValueType] - An array of attribute types that should have simplified formatting for their values. Default includes 'extras'.
- * @returns {Map<string, string[]>} A map where the keys are attribute types and the values are arrays of formatted labels.
+ * @param attributes The object containing attribute groups, where each key maps to an attribute group.
+ * @param filterTypes An array of attribute types to include in the filtered results.
+ * @param singleValueType An array of attribute types that should have simplified formatting for their values. Default includes 'extras'.
+ *
+ * @returns A map where the keys are attribute types and the values are arrays of formatted labels.
  *
  * @example
+ * ```
  * const attributes = {
  *   color: { type: 'color', values: [{ label: 'Red' }, { label: 'Blue' }] },
  *   size: { type: 'size', values: [{ label: 'S' }, { label: 'M' }] },
- * };
- * const filterTypes = ['color', 'size'];
- * const result = getFilteredAttributeGroups(attributes, filterTypes);
+ * }
+ *
+ * const filterTypes = ['color', 'size']
+ *
+ * const result = getFilteredAttributeGroups(attributes, filterTypes)
+ *
  * // Result: Map {
  * //   'color' => ['Red', 'Blue'],
  * //   'size' => ['S', 'M']
  * // }
+ * ```
  */
 export declare const getFilteredAttributeGroups: (attributes: Attributes, filterTypes: string[], singleValueType?: string[]) => Map<string, string[]>;

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

@@ -6,10 +6,16 @@ import { type AdvancedAttribute } from '@scayle/storefront-nuxt';
  * parses them as integers, and filters out any invalid values. It is
  * commonly used to handle product recommendations.
  *
- * @param {AdvancedAttribute} [attribute] - The advanced attribute containing values to extract product IDs from. This attribute is sourced from a product's advanced attributes.
- * @returns {number[]} An array of valid product IDs extracted from the attribute values. Returns an empty array if the input is undefined or invalid.
+ * More information about recommended products and attributes groups please visit our SCAYLE Resource Center:
+ * @see https://scayle.dev/en/storefront-guide/developer-guide/features/product-recommendation
+ * @see https://scayle.dev/en/user-guide/settings/product-structure/attribute-groups
+ *
+ * @param attribute The advanced attribute containing values to extract product IDs from. This attribute is sourced from a product's advanced attributes.
+ *
+ * @returns An array of valid product IDs extracted from the attribute values. Returns an empty array if the input is undefined or invalid.
  *
  * @example
+ * ```
  * // Example usage within a Vue.js/Nuxt computed property
  * const recommendedProductIds = computed(() => {
  *   return getCombineWithProductIds(
@@ -58,9 +64,6 @@ import { type AdvancedAttribute } from '@scayle/storefront-nuxt';
  * }
  *
  * // Then: recommendedProductIds.value => [ 206131, 206017, 206012 ]
- *
- * More information about recommended products and attributes groups please visit our SCAYLE Resource Center:
- * https://scayle.dev/en/storefront-guide/developer-guide/features/product-recommendation
- * https://scayle.dev/en/user-guide/settings/product-structure/attribute-groups
+ * ```
  */
 export declare const getCombineWithProductIds: (attribute?: AdvancedAttribute) => number[];

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

@@ -1,5 +1,13 @@
 import type { Variant } from '@scayle/storefront-nuxt';
 import type { Product, WithContext } from 'schema-dts';
+/**
+ * Generates an object following the schema.org `Product` type with context.
+ *
+ * @see https://schema.org/Product Used to specify `@type` of the returned schema.
+ * @see https://schema.org/Brand Used to define schema of `brand`.
+ *
+ * @returns An object following the schema.org `Product` type with context.
+ */
 export declare const generateProductSchema: ({ productName, brandName, variants, url, images, description, }: {
     productName: string;
     brandName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-product-detail",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "description": "Collection of essential composables and utilities to work with product detail",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -41,7 +41,7 @@
   },
   "peerDependencies": {
     "@nuxt/kit": "^3.13.0",
-    "@scayle/storefront-nuxt": "^7.93.0 || ^8.0.0",
+    "@scayle/storefront-nuxt": "^8.0.0",
     "@vue/test-utils": "2.4.6",
     "@vueuse/core": "12.0.0",
     "vue-router": "4.5.0"
@@ -52,8 +52,8 @@
     "@nuxt/schema": "3.13.2",
     "@nuxt/test-utils": "3.15.1",
     "@scayle/eslint-config-storefront": "4.3.2",
-    "@scayle/storefront-nuxt": "8.1.1",
-    "@types/node": "22.10.1",
+    "@scayle/storefront-nuxt": "8.1.3",
+    "@types/node": "22.10.2",
     "@vue/test-utils": "2.4.6",
     "@vueuse/core": "12.0.0",
     "dprint": "0.47.6",