@asstio-dev/storefront 0.13.0 → 0.14.0

package/dist/index.d.ts

@@ -56,4 +56,4 @@ export { brandHead, collectionHead, productHead, toNextMetadata } from "./seo/he
 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";
+export { SeoError, type BreadcrumbLink, type CollectionHeadOptions, type HeadOptions, type JsonLd, type NextMetadataLike, type ProductJsonLdOptions, type SchemaProperty, type SeoContext, type SeoHead, type SeoMeta, type VariantAvailability, } from "./seo/types.js";

package/dist/schema.d.ts

@@ -456,6 +456,7 @@ export interface components {
         };
         CartDto: {
             currency: string;
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             grandTotalInc: string;
             lines: components["schemas"]["CartLineDto"][];
             market: string;
@@ -467,6 +468,8 @@ export interface components {
             warnings: components["schemas"]["WarningDto"][];
         };
         CartLineDto: {
+            availability: components["schemas"]["LineAvailability"];
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
             price: components["schemas"]["PriceDto"];
@@ -501,6 +504,7 @@ export interface components {
         };
         CheckoutCartDto: {
             currency: string;
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             grandTotalInc: string;
             lines: components["schemas"]["CheckoutCartLineDto"][];
             subtotalInc: string;
@@ -508,6 +512,8 @@ export interface components {
             version: number | string;
         };
         CheckoutCartLineDto: {
+            availability: null | components["schemas"]["LineAvailability"];
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             image: null | components["schemas"]["MediaDescriptorDto"];
             lineTotalInc: string;
             name: string;
@@ -568,6 +574,7 @@ export interface components {
             attemptId: string;
             order: null | components["schemas"]["CheckoutOrderRefDto"];
             paymentStatus: null | string;
+            promisedDelivery: null | components["schemas"]["DeliveryRangeDto"];
             status: string;
             widget: null | components["schemas"]["CheckoutWidgetDto"];
         };
@@ -611,6 +618,12 @@ export interface components {
             slug: string;
             url: string;
         };
+        DeliveryRangeDto: {
+            /** Format: int32 */
+            max: number;
+            /** Format: int32 */
+            min: number;
+        };
         DescriptionDto: {
             html: string;
             text: string;
@@ -649,6 +662,8 @@ export interface components {
             facet: string;
             values: components["schemas"]["FacetValueDto"][];
         };
+        /** @enum {unknown} */
+        LineAvailability: "backorder" | "inStock";
         ListingResponse: {
             appliedFilters: components["schemas"]["AppliedFilterDto"][];
             facets: components["schemas"]["FacetDto"][];
@@ -774,6 +789,7 @@ export interface components {
             orderNumber: null | string;
             /** Format: date-time */
             placedAt: string;
+            promisedDelivery: null | components["schemas"]["DeliveryRangeDto"];
             reference: string;
             status: components["schemas"]["OrderStatusDto"];
             test: boolean;
@@ -827,6 +843,7 @@ export interface components {
         };
         ProductCardDto: {
             brand: null | components["schemas"]["BrandDto"];
+            buyable: boolean;
             collections: string[];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -897,6 +914,9 @@ export interface components {
             importer: null | components["schemas"]["PartyDto"];
             manufacturer: null | components["schemas"]["PartyDto"];
         };
+        SellabilityDto: {
+            mode: components["schemas"]["SiteSellabilityMode"];
+        };
         SeoDto: {
             description: null | string;
             title: string;
@@ -912,8 +932,11 @@ export interface components {
             media: components["schemas"]["MediaDto"];
             name: string;
             preview: boolean;
+            sellability: components["schemas"]["SellabilityDto"];
             urlPatterns: components["schemas"]["UrlPatternsDto"];
         };
+        /** @enum {unknown} */
+        SiteSellabilityMode: "backorder" | "onHand";
         SitemapEntryDto: {
             alternateUrls: {
                 [key: string]: string;
@@ -1003,8 +1026,15 @@ export interface components {
             collection: string;
             product: string;
         };
+        /** @enum {unknown} */
+        VariantAvailability: "backorder" | "inStock" | "unavailable";
         VariantDto: {
+            availability: components["schemas"]["VariantAvailability"];
+            /** Format: int32 */
+            availableUnits: number;
+            backorderDelivery: null | components["schemas"]["DeliveryRangeDto"];
             brand: null | components["schemas"]["BrandDto"];
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             gtin: null | string;
             gtins: string[];
             hasOwnImages: boolean;

package/dist/seo/product.js

@@ -3,7 +3,15 @@ import { jsonLdDescription, pickImages, productDescription, rejectRedirect, requ
 import { SeoError } from "./types.js";
 const PROPERTIES = ["size", "color", "material", "pattern"];
 const IN_STOCK = "https://schema.org/InStock";
+const BACK_ORDER = "https://schema.org/BackOrder";
 const OUT_OF_STOCK = "https://schema.org/OutOfStock";
+const SCHEMA_AVAILABILITY = { inStock: IN_STOCK, backorder: BACK_ORDER, unavailable: OUT_OF_STOCK };
+/** Sellability C1 §6: the caller's answer, else the variant's own; a response from an API older than 0.14 has no
+ * `availability` and falls back to `inStock`. */
+function availabilityOf(v, ctx) {
+    const state = ctx.availability?.(v) ?? v.availability ?? (v.inStock ? "inStock" : "unavailable");
+    return SCHEMA_AVAILABILITY[state] ?? OUT_OF_STOCK;
+}
 const brandNode = (label) => ({ "@type": "Brand", name: label });
 /** Spec §4.12: absolute http(s), distinct per variant; checked for every emitted variant, single path included. */
 function checkVariantUrls(variants, variantUrl) {
@@ -77,7 +85,7 @@ export function productJsonLd(p, ctx) {
         "@type": "Offer",
         price: v.price.amount,
         priceCurrency: v.price.currency,
-        availability: v.inStock ? IN_STOCK : OUT_OF_STOCK,
+        availability: availabilityOf(v, ctx),
         url,
         ...offerExtras(ctx),
     });

package/dist/seo/types.d.ts

@@ -4,6 +4,7 @@ export type SiteDto = Schemas["SiteDto"];
 export type MarketDto = Schemas["MarketDto"];
 export type ProductDto = Schemas["ProductDto"];
 export type VariantDto = Schemas["VariantDto"];
+export type VariantAvailability = Schemas["VariantAvailability"];
 export type CollectionListingResponse = Schemas["CollectionListingResponse"];
 export type CollectionCrumbDto = Schemas["CollectionCrumbDto"];
 export type BrandDetailDto = Schemas["BrandDetailDto"];
@@ -43,6 +44,9 @@ export type ProductJsonLdOptions = SeoContext & {
     variants?: VariantDto[];
     /** Overrides the GTIN per variant; return `undefined` to omit. Defaults to the variant's `gtin`. */
     gtin?: (v: VariantDto) => string | undefined;
+    /** Sellability C1 §6: the availability for the quantity this page sells (e.g. a pair of the same lens needs two units).
+     * Return `undefined` to use the variant's own `availability` (its state for quantity 1). */
+    availability?: (v: VariantDto) => VariantAvailability | undefined;
     seller?: {
         name: string;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asstio-dev/storefront",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "Typed client for the Asstio Storefront API (generated from OpenAPI).",
   "repository": {
     "type": "git",

package/src/schema.d.ts

@@ -456,6 +456,7 @@ export interface components {
         };
         CartDto: {
             currency: string;
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             grandTotalInc: string;
             lines: components["schemas"]["CartLineDto"][];
             market: string;
@@ -467,6 +468,8 @@ export interface components {
             warnings: components["schemas"]["WarningDto"][];
         };
         CartLineDto: {
+            availability: components["schemas"]["LineAvailability"];
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
             price: components["schemas"]["PriceDto"];
@@ -501,6 +504,7 @@ export interface components {
         };
         CheckoutCartDto: {
             currency: string;
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             grandTotalInc: string;
             lines: components["schemas"]["CheckoutCartLineDto"][];
             subtotalInc: string;
@@ -508,6 +512,8 @@ export interface components {
             version: number | string;
         };
         CheckoutCartLineDto: {
+            availability: null | components["schemas"]["LineAvailability"];
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             image: null | components["schemas"]["MediaDescriptorDto"];
             lineTotalInc: string;
             name: string;
@@ -568,6 +574,7 @@ export interface components {
             attemptId: string;
             order: null | components["schemas"]["CheckoutOrderRefDto"];
             paymentStatus: null | string;
+            promisedDelivery: null | components["schemas"]["DeliveryRangeDto"];
             status: string;
             widget: null | components["schemas"]["CheckoutWidgetDto"];
         };
@@ -611,6 +618,12 @@ export interface components {
             slug: string;
             url: string;
         };
+        DeliveryRangeDto: {
+            /** Format: int32 */
+            max: number;
+            /** Format: int32 */
+            min: number;
+        };
         DescriptionDto: {
             html: string;
             text: string;
@@ -649,6 +662,8 @@ export interface components {
             facet: string;
             values: components["schemas"]["FacetValueDto"][];
         };
+        /** @enum {unknown} */
+        LineAvailability: "backorder" | "inStock";
         ListingResponse: {
             appliedFilters: components["schemas"]["AppliedFilterDto"][];
             facets: components["schemas"]["FacetDto"][];
@@ -774,6 +789,7 @@ export interface components {
             orderNumber: null | string;
             /** Format: date-time */
             placedAt: string;
+            promisedDelivery: null | components["schemas"]["DeliveryRangeDto"];
             reference: string;
             status: components["schemas"]["OrderStatusDto"];
             test: boolean;
@@ -827,6 +843,7 @@ export interface components {
         };
         ProductCardDto: {
             brand: null | components["schemas"]["BrandDto"];
+            buyable: boolean;
             collections: string[];
             id: string;
             image: null | components["schemas"]["MediaDescriptorDto"];
@@ -897,6 +914,9 @@ export interface components {
             importer: null | components["schemas"]["PartyDto"];
             manufacturer: null | components["schemas"]["PartyDto"];
         };
+        SellabilityDto: {
+            mode: components["schemas"]["SiteSellabilityMode"];
+        };
         SeoDto: {
             description: null | string;
             title: string;
@@ -912,8 +932,11 @@ export interface components {
             media: components["schemas"]["MediaDto"];
             name: string;
             preview: boolean;
+            sellability: components["schemas"]["SellabilityDto"];
             urlPatterns: components["schemas"]["UrlPatternsDto"];
         };
+        /** @enum {unknown} */
+        SiteSellabilityMode: "backorder" | "onHand";
         SitemapEntryDto: {
             alternateUrls: {
                 [key: string]: string;
@@ -1003,8 +1026,15 @@ export interface components {
             collection: string;
             product: string;
         };
+        /** @enum {unknown} */
+        VariantAvailability: "backorder" | "inStock" | "unavailable";
         VariantDto: {
+            availability: components["schemas"]["VariantAvailability"];
+            /** Format: int32 */
+            availableUnits: number;
+            backorderDelivery: null | components["schemas"]["DeliveryRangeDto"];
             brand: null | components["schemas"]["BrandDto"];
+            delivery: null | components["schemas"]["DeliveryRangeDto"];
             gtin: null | string;
             gtins: string[];
             hasOwnImages: boolean;