@asstio-dev/storefront 0.11.0 → 0.12.0

package/dist/gtin.d.ts

@@ -0,0 +1,3 @@
+/** Schema.org's GTIN property for a `gtin` value from the API (GTIN spec §13.3): gtin8, gtin12, gtin13 or gtin14 by
+ *  length. The API sends the canonical form, so the length is the format. Spread it into a Product or Offer object. */
+export declare function gtinJsonLd(gtin: string | null | undefined): Record<string, string>;

package/dist/gtin.js

@@ -0,0 +1,13 @@
+/** Schema.org's GTIN property for a `gtin` value from the API (GTIN spec §13.3): gtin8, gtin12, gtin13 or gtin14 by
+ *  length. The API sends the canonical form, so the length is the format. Spread it into a Product or Offer object. */
+export function gtinJsonLd(gtin) {
+    if (!gtin || !/^\d+$/.test(gtin))
+        return {};
+    switch (gtin.length) {
+        case 8: return { gtin8: gtin };
+        case 12: return { gtin12: gtin };
+        case 13: return { gtin13: gtin };
+        case 14: return { gtin14: gtin };
+        default: return {};
+    }
+}

package/dist/index.d.ts

@@ -53,6 +53,7 @@ export { mountCheckout, type CheckoutHandle, type MountOptions, type MinimalDocu
 export { controllers, type CheckoutController, type ProviderWindow } from "./checkout/controllers.js";
 export { breadcrumbJsonLd } from "./seo/breadcrumb.js";
 export { brandHead, collectionHead, productHead, toNextMetadata } from "./seo/head.js";
+export { gtinJsonLd } from "./gtin.js";
 export { productJsonLd } from "./seo/product.js";
 export { jsonLdScript } from "./seo/serialize.js";
 export { SeoError, type BreadcrumbLink, type CollectionHeadOptions, type HeadOptions, type JsonLd, type NextMetadataLike, type ProductJsonLdOptions, type SchemaProperty, type SeoContext, type SeoHead, type SeoMeta, } from "./seo/types.js";

package/dist/index.js

@@ -42,6 +42,7 @@ export { mountCheckout } from "./checkout/browser.js";
 export { controllers } from "./checkout/controllers.js";
 export { breadcrumbJsonLd } from "./seo/breadcrumb.js";
 export { brandHead, collectionHead, productHead, toNextMetadata } from "./seo/head.js";
+export { gtinJsonLd } from "./gtin.js";
 export { productJsonLd } from "./seo/product.js";
 export { jsonLdScript } from "./seo/serialize.js";
 export { SeoError, } from "./seo/types.js";

package/dist/schema.d.ts

@@ -852,6 +852,8 @@ export interface components {
             collections: components["schemas"]["CollectionRefDto"][];
             description: null | components["schemas"]["DescriptionDto"];
             files: components["schemas"]["MediaDescriptorDto"][];
+            gtin: null | string;
+            gtins: string[];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
             images: components["schemas"]["MediaDescriptorDto"][];
@@ -1003,6 +1005,8 @@ export interface components {
         };
         VariantDto: {
             brand: null | components["schemas"]["BrandDto"];
+            gtin: null | string;
+            gtins: string[];
             hasOwnImages: boolean;
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];

package/dist/seo/product.js

@@ -1,3 +1,4 @@
+import { gtinJsonLd } from "../gtin.js";
 import { jsonLdDescription, pickImages, productDescription, rejectRedirect, requireMarket } from "./shared.js";
 import { SeoError } from "./types.js";
 const PROPERTIES = ["size", "color", "material", "pattern"];
@@ -81,8 +82,13 @@ export function productJsonLd(p, ctx) {
         ...offerExtras(ctx),
     });
     const gtin = (v) => {
-        const g = ctx.gtin?.(v);
-        return g ? { gtin: g } : {};
+        // GTIN spec §13.3 (plan P14): the hook wins when given, and may omit; otherwise the variant's own gtin. A value of
+        // 8, 12, 13 or 14 digits becomes gtin8/12/13/14; any other hook value keeps the generic property.
+        const g = ctx.gtin ? ctx.gtin(v) : (v.gtin ?? undefined);
+        if (!g)
+            return {};
+        const keyed = gtinJsonLd(g);
+        return Object.keys(keyed).length > 0 ? keyed : { gtin: g };
     };
     if (list === null || sellable.length === 0)
         return { ...common("Product"), sku: p.sku, ...(p.brand ? { brand: brandNode(p.brand.label) } : {}) };

package/dist/seo/types.d.ts

@@ -41,6 +41,7 @@ export type ProductJsonLdOptions = SeoContext & {
     variesBy?: Record<string, SchemaProperty>;
     /** Used only when `p.variants` is `null` (more than 100 variants), e.g. the first page of `/variants`. */
     variants?: VariantDto[];
+    /** Overrides the GTIN per variant; return `undefined` to omit. Defaults to the variant's `gtin`. */
     gtin?: (v: VariantDto) => string | undefined;
     seller?: {
         name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asstio-dev/storefront",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Typed client for the Asstio Storefront API (generated from OpenAPI).",
   "repository": {
     "type": "git",
@@ -21,7 +21,7 @@
     "test": "vitest run",
     "test:browser": "playwright test -c browser/playwright.config.ts",
     "check": "npm run generate && npm run typecheck-examples && npm test && git diff --exit-code -- src/schema.d.ts && test -z \"$(git status --porcelain -- src/schema.d.ts)\"",
-    "smoke": "node --input-type=module -e \"import(\\\"./dist/index.js\\\").then(m => { for (const f of [\\\"createStorefrontClient\\\", \\\"filterQuery\\\", \\\"encodeFilterValues\\\", \\\"decodeFilterValues\\\", \\\"pictureSources\\\", \\\"mediaUrl\\\", \\\"formatImage\\\", \\\"styleToCss\\\", \\\"startCheckout\\\", \\\"syncCheckout\\\", \\\"completeCheckout\\\", \\\"getCheckoutStatus\\\", \\\"getOrder\\\", \\\"awaitCompletion\\\", \\\"mountCheckout\\\", \\\"productJsonLd\\\", \\\"breadcrumbJsonLd\\\", \\\"productHead\\\", \\\"collectionHead\\\", \\\"brandHead\\\", \\\"toNextMetadata\\\", \\\"jsonLdScript\\\", \\\"SeoError\\\"]) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f) })\""
+    "smoke": "node --input-type=module -e \"import(\\\"./dist/index.js\\\").then(m => { for (const f of [\\\"createStorefrontClient\\\", \\\"filterQuery\\\", \\\"encodeFilterValues\\\", \\\"decodeFilterValues\\\", \\\"pictureSources\\\", \\\"mediaUrl\\\", \\\"formatImage\\\", \\\"styleToCss\\\", \\\"startCheckout\\\", \\\"syncCheckout\\\", \\\"completeCheckout\\\", \\\"getCheckoutStatus\\\", \\\"getOrder\\\", \\\"awaitCompletion\\\", \\\"mountCheckout\\\", \\\"productJsonLd\\\", \\\"gtinJsonLd\\\", \\\"breadcrumbJsonLd\\\", \\\"productHead\\\", \\\"collectionHead\\\", \\\"brandHead\\\", \\\"toNextMetadata\\\", \\\"jsonLdScript\\\", \\\"SeoError\\\"]) if (typeof m[f] !== \\\"function\\\") throw new Error(\\\"missing export \\\" + f) })\""
   },
   "dependencies": {
     "openapi-fetch": "0.17.0"

package/src/schema.d.ts

@@ -852,6 +852,8 @@ export interface components {
             collections: components["schemas"]["CollectionRefDto"][];
             description: null | components["schemas"]["DescriptionDto"];
             files: components["schemas"]["MediaDescriptorDto"][];
+            gtin: null | string;
+            gtins: string[];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
             images: components["schemas"]["MediaDescriptorDto"][];
@@ -1003,6 +1005,8 @@ export interface components {
         };
         VariantDto: {
             brand: null | components["schemas"]["BrandDto"];
+            gtin: null | string;
+            gtins: string[];
             hasOwnImages: boolean;
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];