@asteby/storefront 0.17.0 → 0.18.1

package/README.md

@@ -408,6 +408,30 @@ a rule that produces a `discard_fields` field. `qr_canonical` (top level) is a t
 (`fiscal_regime`, `invoice_use`). A text that does not match yields `missing` (required fields); only a spec that cannot
 run throws `IdentityRulesError`.
 
+## Buyer items: «My items» / «My garage» (Storefront API 1.9)
+
+A **subject** is something the buyer shops for: a vehicle, a printer, a phone, a pet, a size. WHICH kinds a store has is data the organization publishes (`content.subjectKinds()`); the SDK names none. A store that declares none (`customer.capabilities().subjects` absent, `subjectKinds()` empty) has no such section: show nothing.
+
+```ts
+const kinds = await sf.content.subjectKinds()                         // [] when the store declares none (or the server is older)
+const me = sf.withCustomerToken(token)
+const item = await me.customer.subjects.create({ kind: 'vehicle', attributes: { make: 'nissan', model: 'np300', year: 2012, engine: '2.5', plate: 'ABC-123' } })
+item.label    // 'Nissan NP300 Frontier 2012 2.5 L'  (built by the server from the catalog and the PUBLIC values)
+item.fit_key  // 'nissan/np300/2012/2.5'             (the `fit:<key>` tag of the products; '' if it does not resolve completely)
+item.attributes.plate // '••23'                       (a `private` field is returned masked, always)
+
+// Only the parts that fit: its own tag plus the universal one.
+await sf.products.list({ tags_any: fitTagsAny(item.fit_key) })        // ?tags_any=fit:nissan/np300/2012/2.5,fit:universal
+```
+
+- `customer.subjects.list({ kind? })`, `create`, `update(id, patch)` (attributes merge; `null` clears a field; a private value sent back as its mask is kept), `delete(id)`. Errors: `422` with `field: 'attributes.<field>'` (never the value), `409` repeated or past the limit, `429` too many saves, `404` for an item that is not the buyer's.
+- **Privacy**: a `private` field (a licence plate) is stored for the buyer and never enters the label, the key, a filter, a cache key, a cookie or an order. Never prefill it from the server (it only comes masked, `isMasked`), never log it, never put it in a URL.
+- Pure helpers (`@asteby/storefront`), no UI: `subjectOptions(kind, field, values)` (the cascade), `reconcileSubjectValues`, `resolveSubject(kind, values)` (the same validation as the server, so the form answers without a round trip; the server stays the authority), `fitTagsAny`, `fitTag`, `isMasked`.
+- `splitSubjectTree(tree, maxBytes?)`: a catalog larger than one page (a page is one 64 KiB write with the draft and the published copy, ~28 KB of tree) is published as several `subject_catalog` pages, split by its first level; the kind names them all (`catalog_ref: ["page:x-1", "page:x-2"]`) and the server joins them.
+- Catalog: the levels of the tree follow the kind's `catalog` fields that are not years; an option may declare `from`/`to`/`ranges` (model years) and a `year` field must satisfy every option on the chosen path. A year chosen before an engine narrows the engines; an engine never narrows the year.
+- `products.list({ tags_any })`: at most 5 tags of 120 characters, comma-separated on the wire (a tag with a comma is refused by the client); a hard filter, so facets count inside it.
+- Mock: `createMockStorefront({ subjectKinds: MOCK_SUBJECT_KINDS })` serves the kinds and the whole CRUD with the same rules (default: none, like a store that declares nothing).
+
 ## Buyer account: orders, shipments, invoices (Storefront API 1.8)
 
 `customer.order(id)` carries `progress` (unified timeline), `next_action`, `shipments[]` (events, carrier, `https`

package/dist/{account-settings-DNcJKOQl.d.ts → account-settings-C3OFjz-H.d.ts}

@@ -375,6 +375,10 @@ type DeliveryOptions = {
     /** `true` when some provider failed: `rates` holds only what arrived. */
     partial?: boolean;
     unavailable?: UnavailableRateProvider[];
+    /** The shop's own fixed price: no carrier was asked (addon setting `shipping_quote_mode`). */
+    fixed?: boolean;
+    /** Every shipping rate costs 0 (free-shipping minimum reached): nothing to choose, show "Free shipping" and go on. */
+    free?: boolean;
 };
 /** One way to pay (`GET /storefront/carts/:id/payment-methods`). `key` is sent as `payment_method` at checkout. */
 type PaymentMethod = {
@@ -463,6 +467,17 @@ type CheckoutPayment = {
     client?: PaymentClient;
     /** Pending action of the last attempt (voucher, 3DS challenge). */
     action?: PaymentAction | null;
+    /**
+     * Only on `GET checkouts/:id` when the LATEST attempt was rejected (e.g. the bank failed the 3DS challenge): the checkout
+     * stays `pending` (a new attempt is allowed) but `outcome` is `rejected`, with the typed reason and next step.
+     */
+    outcome?: string | null;
+    decline_code?: DeclineCode | null;
+    next_step?: PaymentNextStep | null;
+    retryable?: boolean | null;
+    message?: string | null;
+    message_en?: string | null;
+    attempts_left?: number | null;
 };
 type CheckoutInfo = {
     /** Checkout session id; use it with `payment.instructions`. */
@@ -535,6 +550,14 @@ type CustomerCapabilities = {
     fiscal_profiles?: {
         max: number;
     };
+    /**
+     * The kinds of saved item the store declares («My items»; contract 1.9). Absent when the store declares none (or on
+     * older servers): there is no such section, show nothing.
+     */
+    subjects?: {
+        kinds: string[];
+        share_with_workshop?: boolean;
+    };
     /** Channels the notification preferences can use (connector installed). Absent on older servers: no preferences section. */
     notifications?: {
         channels: string[];
@@ -1391,6 +1414,91 @@ type FiscalProfileInput = Partial<FiscalIdentityInput> & {
     label?: string;
     is_default?: boolean;
 };
+/**
+ * A subject is something the buyer shops for: a vehicle, a printer, a phone, a pet, a size. WHICH kinds exist is
+ * data the organization publishes (`content.subjectKinds()`); nothing in the SDK or the contract names one. A store
+ * with no kinds has no such section.
+ */
+type SubjectFieldType = 'text' | 'year' | 'select';
+type SubjectField = {
+    key: string;
+    label: string;
+    type: SubjectFieldType;
+    /** `catalog`: the value is an option of the kind's catalog (a `year` is checked against the options' years). Default `free`. */
+    source?: 'catalog' | 'free';
+    /** The field whose choice narrows this one (the cascade order). */
+    depends_on?: string | null;
+    required?: boolean;
+    /**
+     * Stored for the buyer and NEVER part of the label, the compatibility key, a filter, a cache key, a cookie or an
+     * order (a licence plate). The server returns it only masked (`••34`): never prefill it, never log it.
+     */
+    private?: boolean;
+    max?: number;
+};
+/**
+ * One option of a catalog level (make, model, engine…). `from`/`to`/`ranges` bound the model years it covers: a
+ * `year` field must satisfy every option on the chosen path that declares them.
+ */
+type SubjectCatalogNode = {
+    label: string;
+    from?: number;
+    to?: number;
+    ranges?: [number, number][];
+    children?: Record<string, SubjectCatalogNode>;
+};
+/** The cascade of options of a kind: levels follow the kind's `catalog` fields that are not years. */
+type SubjectCatalog = {
+    version?: string | null;
+    tree: Record<string, SubjectCatalogNode>;
+};
+type SubjectKind = {
+    key: string;
+    /** Singular («Vehicle»). */
+    label: string;
+    /** The section's name («My garage»). */
+    label_plural: string;
+    max_per_account: number;
+    fields: SubjectField[];
+    /** Template of the compatibility key with the fields in braces (public ones only). */
+    fit_key_template: string;
+    /** The checkout may ask «which one is this order for?». */
+    attach_to_order?: boolean;
+    /** `null` for kinds with free fields only. */
+    catalog?: SubjectCatalog | null;
+};
+/** A saved item. `attributes` holds the public values; private ones come masked (`••34`). */
+type Subject = {
+    id: string;
+    kind: string;
+    /** Public label built by the server from the catalog and the public values. */
+    label: string;
+    nickname?: string | null;
+    /** Compatibility key (the `fit:<key>` tag of the products); `''` when the item does not resolve completely. */
+    fit_key: string;
+    attributes: Record<string, unknown>;
+    /** The active item of its kind. */
+    is_default: boolean;
+    last_used_at?: string | null;
+    created_at: string;
+};
+type SubjectInput = {
+    kind: string;
+    attributes: Record<string, unknown>;
+    nickname?: string | null;
+    is_default?: boolean;
+};
+/** Merged over the stored item: `null` clears a field; a private value sent back as its mask is kept. */
+type SubjectPatch = {
+    attributes?: Record<string, unknown>;
+    nickname?: string | null;
+    is_default?: boolean;
+};
+/** The item an order is for (kinds with `attach_to_order`). */
+type SubjectRef = {
+    kind: string;
+    id: string;
+};
 /** `PATCH /customer`. `fiscal: null` deletes the saved fiscal data (ARCO). */
 type CustomerUpdateInput = {
     first_name?: string | null;
@@ -1591,4 +1699,4 @@ declare function dataExportBytes(file: Pick<DataExportFile, 'content_base64'>):
 /** A download filename that is safe in a `Content-Disposition` header: no path, quotes, control characters or spaces. */
 declare function safeExportFilename(name: unknown, fallback?: string): string;
 
-export { type FiscalProfile as $, type AccountDeleteInput as A, type Customer as B, type Cart as C, type CustomerCapabilities as D, type CustomerIdentifier as E, type CustomerPasswordLoginInput as F, type CustomerPreferences as G, type CustomerRegisterInput as H, type CustomerRegisterResult as I, type CustomerResetPasswordInput as J, type CustomerSession as K, type CustomerSessionInfo as L, type CustomerSessionInput as M, type CustomerSetPasswordInput as N, type CustomerUpdateInput as O, type CustomerVerifyRegistrationInput as P, type DataExportFile as Q, type DeclineCode as R, type DeliveryInput as S, type DeliveryMethod as T, type DeliveryOptions as U, type Facet as V, type FacetValue as W, type FiscalDocumentEvidence as X, type FiscalDocumentSource as Y, type FiscalIdentity as Z, type FiscalIdentityInput as _, type Address as a, type Product as a$, type FiscalProfileInput as a0, type FiscalVerification as a1, type GeoHint as a2, type IdentityCapture as a3, type IdentityDocumentSpec as a4, type IdentityFieldRule as a5, type IdentityRulesV1 as a6, type IdentityStrategy as a7, type Image as a8, type InsufficientStockDetails as a9, type OrderProgress as aA, type OrderProgressStep as aB, type OrderSection as aC, type OrderStage as aD, type OrderStepKey as aE, type OrderStepState as aF, type Page as aG, type PageInfo as aH, type PaymentAction as aI, type PaymentAttemptResult as aJ, type PaymentAttemptStatus as aK, type PaymentClient as aL, type PaymentClientCsp as aM, type PaymentConfig as aN, type PaymentFlow as aO, type PaymentInfo as aP, type PaymentMethod as aQ, type PaymentMethods as aR, type PaymentNextStep as aS, type PaymentOption as aT, type PaymentOptionKey as aU, type PaymentPoint as aV, type PaymentSubmitInput as aW, type PaymentVoucher as aX, type PendingPayment as aY, type PendingPaymentVoucher as aZ, type PickupOption as a_, type InsufficientStockLine as aa, type InvoiceAction as ab, type InvoiceDoc as ac, type InvoiceFile as ad, type InvoiceFileKind as ae, type InvoiceRequest as af, type InvoiceResult as ag, type InvoiceStage as ah, type InvoiceSummary as ai, type InvoicingCapabilities as aj, type Location as ak, type LocationContacts as al, type LocationKind as am, type LocationListParams as an, type LocationPickup as ao, type Menu as ap, type MenuItem as aq, type Money as ar, type MoneyRange as as, type NearestLocation as at, type NextAction as au, type NextActionKind as av, type Order as aw, type OrderLine as ax, type OrderPickup as ay, type OrderProblem as az, type AddressInput as b, type ProductAttributeValue as b0, type ProductCategory as b1, type ProductConnection as b2, type ProductOption as b3, type ProductSort as b4, type ProductVariant as b5, type PromotionAnnouncement as b6, type PromotionReward as b7, type PromotionTier as b8, type PromotionsList as b9, type ShopPolicies as bA, type StockLevel as bB, StorefrontError as bC, type StorefrontErrorBody as bD, type StorefrontErrorCode as bE, type StorefrontErrorInit as bF, type Theme as bG, type TokenIntrospection as bH, type UnavailableRateProvider as bI, dataExportBytes as bJ, isAccountDeleteBlocked as bK, isReauthRequired as bL, isStorefrontError as bM, safeExportFilename as bN, type ReauthInput as ba, type ReauthResult as bb, type RecommendationPlacement as bc, type Refund as bd, type Region as be, type RegionFiscalEntry as bf, type RegionFiscalId as bg, type RegionPaymentMethod as bh, type RegionPostalCode as bi, type RestockSubscriptionInput as bj, type RestockSubscriptionResult as bk, type ReturnRequest as bl, type ReturnRequestInput as bm, type SEO as bn, type Section as bo, type SelectedOption as bp, type Shipment as bq, type ShipmentEvent as br, type ShipmentKind as bs, type ShipmentMap as bt, type ShipmentStatus as bu, type ShipmentsSummary as bv, type ShippingRate as bw, type Shop as bx, type ShopBranch as by, type ShopContact as bz, type Article as c, type Availability as d, type AvailabilityStatus as e, type CartBuyer as f, type CartBuyerInput as g, type CartCost as h, type CartDelivery as i, type CartDiscountCode as j, type CartDiscountLine as k, type CartInvoice as l, type CartLine as m, type CartLineInput as n, type CartLineMerchandise as o, type CartLineProblem as p, type CartLineUpdateInput as q, type CartPromotions as r, type CartRecommendation as s, type CartRecommendations as t, type CheckoutInfo as u, type CheckoutInput as v, type CheckoutPayment as w, type CheckoutResult as x, type Collection as y, type Connection as z };
+export { type FiscalProfile as $, type AccountDeleteInput as A, type Customer as B, type Cart as C, type CustomerCapabilities as D, type CustomerIdentifier as E, type CustomerPasswordLoginInput as F, type CustomerPreferences as G, type CustomerRegisterInput as H, type CustomerRegisterResult as I, type CustomerResetPasswordInput as J, type CustomerSession as K, type CustomerSessionInfo as L, type CustomerSessionInput as M, type CustomerSetPasswordInput as N, type CustomerUpdateInput as O, type CustomerVerifyRegistrationInput as P, type DataExportFile as Q, type DeclineCode as R, type DeliveryInput as S, type DeliveryMethod as T, type DeliveryOptions as U, type Facet as V, type FacetValue as W, type FiscalDocumentEvidence as X, type FiscalDocumentSource as Y, type FiscalIdentity as Z, type FiscalIdentityInput as _, type Address as a, type Product as a$, type FiscalProfileInput as a0, type FiscalVerification as a1, type GeoHint as a2, type IdentityCapture as a3, type IdentityDocumentSpec as a4, type IdentityFieldRule as a5, type IdentityRulesV1 as a6, type IdentityStrategy as a7, type Image as a8, type InsufficientStockDetails as a9, type OrderProgress as aA, type OrderProgressStep as aB, type OrderSection as aC, type OrderStage as aD, type OrderStepKey as aE, type OrderStepState as aF, type Page as aG, type PageInfo as aH, type PaymentAction as aI, type PaymentAttemptResult as aJ, type PaymentAttemptStatus as aK, type PaymentClient as aL, type PaymentClientCsp as aM, type PaymentConfig as aN, type PaymentFlow as aO, type PaymentInfo as aP, type PaymentMethod as aQ, type PaymentMethods as aR, type PaymentNextStep as aS, type PaymentOption as aT, type PaymentOptionKey as aU, type PaymentPoint as aV, type PaymentSubmitInput as aW, type PaymentVoucher as aX, type PendingPayment as aY, type PendingPaymentVoucher as aZ, type PickupOption as a_, type InsufficientStockLine as aa, type InvoiceAction as ab, type InvoiceDoc as ac, type InvoiceFile as ad, type InvoiceFileKind as ae, type InvoiceRequest as af, type InvoiceResult as ag, type InvoiceStage as ah, type InvoiceSummary as ai, type InvoicingCapabilities as aj, type Location as ak, type LocationContacts as al, type LocationKind as am, type LocationListParams as an, type LocationPickup as ao, type Menu as ap, type MenuItem as aq, type Money as ar, type MoneyRange as as, type NearestLocation as at, type NextAction as au, type NextActionKind as av, type Order as aw, type OrderLine as ax, type OrderPickup as ay, type OrderProblem as az, type AddressInput as b, type ProductAttributeValue as b0, type ProductCategory as b1, type ProductConnection as b2, type ProductOption as b3, type ProductSort as b4, type ProductVariant as b5, type PromotionAnnouncement as b6, type PromotionReward as b7, type PromotionTier as b8, type PromotionsList as b9, type ShopPolicies as bA, type StockLevel as bB, StorefrontError as bC, type StorefrontErrorBody as bD, type StorefrontErrorCode as bE, type StorefrontErrorInit as bF, type Subject as bG, type SubjectCatalog as bH, type SubjectCatalogNode as bI, type SubjectField as bJ, type SubjectFieldType as bK, type SubjectInput as bL, type SubjectKind as bM, type SubjectPatch as bN, type SubjectRef as bO, type Theme as bP, type TokenIntrospection as bQ, type UnavailableRateProvider as bR, dataExportBytes as bS, isAccountDeleteBlocked as bT, isReauthRequired as bU, isStorefrontError as bV, safeExportFilename as bW, type ReauthInput as ba, type ReauthResult as bb, type RecommendationPlacement as bc, type Refund as bd, type Region as be, type RegionFiscalEntry as bf, type RegionFiscalId as bg, type RegionPaymentMethod as bh, type RegionPostalCode as bi, type RestockSubscriptionInput as bj, type RestockSubscriptionResult as bk, type ReturnRequest as bl, type ReturnRequestInput as bm, type SEO as bn, type Section as bo, type SelectedOption as bp, type Shipment as bq, type ShipmentEvent as br, type ShipmentKind as bs, type ShipmentMap as bt, type ShipmentStatus as bu, type ShipmentsSummary as bv, type ShippingRate as bw, type Shop as bx, type ShopBranch as by, type ShopContact as bz, type Article as c, type Availability as d, type AvailabilityStatus as e, type CartBuyer as f, type CartBuyerInput as g, type CartCost as h, type CartDelivery as i, type CartDiscountCode as j, type CartDiscountLine as k, type CartInvoice as l, type CartLine as m, type CartLineInput as n, type CartLineMerchandise as o, type CartLineProblem as p, type CartLineUpdateInput as q, type CartPromotions as r, type CartRecommendation as s, type CartRecommendations as t, type CheckoutInfo as u, type CheckoutInput as v, type CheckoutPayment as w, type CheckoutResult as x, type Collection as y, type Connection as z };

package/dist/{account-settings-H6zuI7iG.d.cts → account-settings-x0TZ7BTv.d.cts}

@@ -375,6 +375,10 @@ type DeliveryOptions = {
     /** `true` when some provider failed: `rates` holds only what arrived. */
     partial?: boolean;
     unavailable?: UnavailableRateProvider[];
+    /** The shop's own fixed price: no carrier was asked (addon setting `shipping_quote_mode`). */
+    fixed?: boolean;
+    /** Every shipping rate costs 0 (free-shipping minimum reached): nothing to choose, show "Free shipping" and go on. */
+    free?: boolean;
 };
 /** One way to pay (`GET /storefront/carts/:id/payment-methods`). `key` is sent as `payment_method` at checkout. */
 type PaymentMethod = {
@@ -463,6 +467,17 @@ type CheckoutPayment = {
     client?: PaymentClient;
     /** Pending action of the last attempt (voucher, 3DS challenge). */
     action?: PaymentAction | null;
+    /**
+     * Only on `GET checkouts/:id` when the LATEST attempt was rejected (e.g. the bank failed the 3DS challenge): the checkout
+     * stays `pending` (a new attempt is allowed) but `outcome` is `rejected`, with the typed reason and next step.
+     */
+    outcome?: string | null;
+    decline_code?: DeclineCode | null;
+    next_step?: PaymentNextStep | null;
+    retryable?: boolean | null;
+    message?: string | null;
+    message_en?: string | null;
+    attempts_left?: number | null;
 };
 type CheckoutInfo = {
     /** Checkout session id; use it with `payment.instructions`. */
@@ -535,6 +550,14 @@ type CustomerCapabilities = {
     fiscal_profiles?: {
         max: number;
     };
+    /**
+     * The kinds of saved item the store declares («My items»; contract 1.9). Absent when the store declares none (or on
+     * older servers): there is no such section, show nothing.
+     */
+    subjects?: {
+        kinds: string[];
+        share_with_workshop?: boolean;
+    };
     /** Channels the notification preferences can use (connector installed). Absent on older servers: no preferences section. */
     notifications?: {
         channels: string[];
@@ -1391,6 +1414,91 @@ type FiscalProfileInput = Partial<FiscalIdentityInput> & {
     label?: string;
     is_default?: boolean;
 };
+/**
+ * A subject is something the buyer shops for: a vehicle, a printer, a phone, a pet, a size. WHICH kinds exist is
+ * data the organization publishes (`content.subjectKinds()`); nothing in the SDK or the contract names one. A store
+ * with no kinds has no such section.
+ */
+type SubjectFieldType = 'text' | 'year' | 'select';
+type SubjectField = {
+    key: string;
+    label: string;
+    type: SubjectFieldType;
+    /** `catalog`: the value is an option of the kind's catalog (a `year` is checked against the options' years). Default `free`. */
+    source?: 'catalog' | 'free';
+    /** The field whose choice narrows this one (the cascade order). */
+    depends_on?: string | null;
+    required?: boolean;
+    /**
+     * Stored for the buyer and NEVER part of the label, the compatibility key, a filter, a cache key, a cookie or an
+     * order (a licence plate). The server returns it only masked (`••34`): never prefill it, never log it.
+     */
+    private?: boolean;
+    max?: number;
+};
+/**
+ * One option of a catalog level (make, model, engine…). `from`/`to`/`ranges` bound the model years it covers: a
+ * `year` field must satisfy every option on the chosen path that declares them.
+ */
+type SubjectCatalogNode = {
+    label: string;
+    from?: number;
+    to?: number;
+    ranges?: [number, number][];
+    children?: Record<string, SubjectCatalogNode>;
+};
+/** The cascade of options of a kind: levels follow the kind's `catalog` fields that are not years. */
+type SubjectCatalog = {
+    version?: string | null;
+    tree: Record<string, SubjectCatalogNode>;
+};
+type SubjectKind = {
+    key: string;
+    /** Singular («Vehicle»). */
+    label: string;
+    /** The section's name («My garage»). */
+    label_plural: string;
+    max_per_account: number;
+    fields: SubjectField[];
+    /** Template of the compatibility key with the fields in braces (public ones only). */
+    fit_key_template: string;
+    /** The checkout may ask «which one is this order for?». */
+    attach_to_order?: boolean;
+    /** `null` for kinds with free fields only. */
+    catalog?: SubjectCatalog | null;
+};
+/** A saved item. `attributes` holds the public values; private ones come masked (`••34`). */
+type Subject = {
+    id: string;
+    kind: string;
+    /** Public label built by the server from the catalog and the public values. */
+    label: string;
+    nickname?: string | null;
+    /** Compatibility key (the `fit:<key>` tag of the products); `''` when the item does not resolve completely. */
+    fit_key: string;
+    attributes: Record<string, unknown>;
+    /** The active item of its kind. */
+    is_default: boolean;
+    last_used_at?: string | null;
+    created_at: string;
+};
+type SubjectInput = {
+    kind: string;
+    attributes: Record<string, unknown>;
+    nickname?: string | null;
+    is_default?: boolean;
+};
+/** Merged over the stored item: `null` clears a field; a private value sent back as its mask is kept. */
+type SubjectPatch = {
+    attributes?: Record<string, unknown>;
+    nickname?: string | null;
+    is_default?: boolean;
+};
+/** The item an order is for (kinds with `attach_to_order`). */
+type SubjectRef = {
+    kind: string;
+    id: string;
+};
 /** `PATCH /customer`. `fiscal: null` deletes the saved fiscal data (ARCO). */
 type CustomerUpdateInput = {
     first_name?: string | null;
@@ -1591,4 +1699,4 @@ declare function dataExportBytes(file: Pick<DataExportFile, 'content_base64'>):
 /** A download filename that is safe in a `Content-Disposition` header: no path, quotes, control characters or spaces. */
 declare function safeExportFilename(name: unknown, fallback?: string): string;
 
-export { type FiscalProfile as $, type AccountDeleteInput as A, type Customer as B, type Cart as C, type CustomerCapabilities as D, type CustomerIdentifier as E, type CustomerPasswordLoginInput as F, type CustomerPreferences as G, type CustomerRegisterInput as H, type CustomerRegisterResult as I, type CustomerResetPasswordInput as J, type CustomerSession as K, type CustomerSessionInfo as L, type CustomerSessionInput as M, type CustomerSetPasswordInput as N, type CustomerUpdateInput as O, type CustomerVerifyRegistrationInput as P, type DataExportFile as Q, type DeclineCode as R, type DeliveryInput as S, type DeliveryMethod as T, type DeliveryOptions as U, type Facet as V, type FacetValue as W, type FiscalDocumentEvidence as X, type FiscalDocumentSource as Y, type FiscalIdentity as Z, type FiscalIdentityInput as _, type Address as a, type Product as a$, type FiscalProfileInput as a0, type FiscalVerification as a1, type GeoHint as a2, type IdentityCapture as a3, type IdentityDocumentSpec as a4, type IdentityFieldRule as a5, type IdentityRulesV1 as a6, type IdentityStrategy as a7, type Image as a8, type InsufficientStockDetails as a9, type OrderProgress as aA, type OrderProgressStep as aB, type OrderSection as aC, type OrderStage as aD, type OrderStepKey as aE, type OrderStepState as aF, type Page as aG, type PageInfo as aH, type PaymentAction as aI, type PaymentAttemptResult as aJ, type PaymentAttemptStatus as aK, type PaymentClient as aL, type PaymentClientCsp as aM, type PaymentConfig as aN, type PaymentFlow as aO, type PaymentInfo as aP, type PaymentMethod as aQ, type PaymentMethods as aR, type PaymentNextStep as aS, type PaymentOption as aT, type PaymentOptionKey as aU, type PaymentPoint as aV, type PaymentSubmitInput as aW, type PaymentVoucher as aX, type PendingPayment as aY, type PendingPaymentVoucher as aZ, type PickupOption as a_, type InsufficientStockLine as aa, type InvoiceAction as ab, type InvoiceDoc as ac, type InvoiceFile as ad, type InvoiceFileKind as ae, type InvoiceRequest as af, type InvoiceResult as ag, type InvoiceStage as ah, type InvoiceSummary as ai, type InvoicingCapabilities as aj, type Location as ak, type LocationContacts as al, type LocationKind as am, type LocationListParams as an, type LocationPickup as ao, type Menu as ap, type MenuItem as aq, type Money as ar, type MoneyRange as as, type NearestLocation as at, type NextAction as au, type NextActionKind as av, type Order as aw, type OrderLine as ax, type OrderPickup as ay, type OrderProblem as az, type AddressInput as b, type ProductAttributeValue as b0, type ProductCategory as b1, type ProductConnection as b2, type ProductOption as b3, type ProductSort as b4, type ProductVariant as b5, type PromotionAnnouncement as b6, type PromotionReward as b7, type PromotionTier as b8, type PromotionsList as b9, type ShopPolicies as bA, type StockLevel as bB, StorefrontError as bC, type StorefrontErrorBody as bD, type StorefrontErrorCode as bE, type StorefrontErrorInit as bF, type Theme as bG, type TokenIntrospection as bH, type UnavailableRateProvider as bI, dataExportBytes as bJ, isAccountDeleteBlocked as bK, isReauthRequired as bL, isStorefrontError as bM, safeExportFilename as bN, type ReauthInput as ba, type ReauthResult as bb, type RecommendationPlacement as bc, type Refund as bd, type Region as be, type RegionFiscalEntry as bf, type RegionFiscalId as bg, type RegionPaymentMethod as bh, type RegionPostalCode as bi, type RestockSubscriptionInput as bj, type RestockSubscriptionResult as bk, type ReturnRequest as bl, type ReturnRequestInput as bm, type SEO as bn, type Section as bo, type SelectedOption as bp, type Shipment as bq, type ShipmentEvent as br, type ShipmentKind as bs, type ShipmentMap as bt, type ShipmentStatus as bu, type ShipmentsSummary as bv, type ShippingRate as bw, type Shop as bx, type ShopBranch as by, type ShopContact as bz, type Article as c, type Availability as d, type AvailabilityStatus as e, type CartBuyer as f, type CartBuyerInput as g, type CartCost as h, type CartDelivery as i, type CartDiscountCode as j, type CartDiscountLine as k, type CartInvoice as l, type CartLine as m, type CartLineInput as n, type CartLineMerchandise as o, type CartLineProblem as p, type CartLineUpdateInput as q, type CartPromotions as r, type CartRecommendation as s, type CartRecommendations as t, type CheckoutInfo as u, type CheckoutInput as v, type CheckoutPayment as w, type CheckoutResult as x, type Collection as y, type Connection as z };
+export { type FiscalProfile as $, type AccountDeleteInput as A, type Customer as B, type Cart as C, type CustomerCapabilities as D, type CustomerIdentifier as E, type CustomerPasswordLoginInput as F, type CustomerPreferences as G, type CustomerRegisterInput as H, type CustomerRegisterResult as I, type CustomerResetPasswordInput as J, type CustomerSession as K, type CustomerSessionInfo as L, type CustomerSessionInput as M, type CustomerSetPasswordInput as N, type CustomerUpdateInput as O, type CustomerVerifyRegistrationInput as P, type DataExportFile as Q, type DeclineCode as R, type DeliveryInput as S, type DeliveryMethod as T, type DeliveryOptions as U, type Facet as V, type FacetValue as W, type FiscalDocumentEvidence as X, type FiscalDocumentSource as Y, type FiscalIdentity as Z, type FiscalIdentityInput as _, type Address as a, type Product as a$, type FiscalProfileInput as a0, type FiscalVerification as a1, type GeoHint as a2, type IdentityCapture as a3, type IdentityDocumentSpec as a4, type IdentityFieldRule as a5, type IdentityRulesV1 as a6, type IdentityStrategy as a7, type Image as a8, type InsufficientStockDetails as a9, type OrderProgress as aA, type OrderProgressStep as aB, type OrderSection as aC, type OrderStage as aD, type OrderStepKey as aE, type OrderStepState as aF, type Page as aG, type PageInfo as aH, type PaymentAction as aI, type PaymentAttemptResult as aJ, type PaymentAttemptStatus as aK, type PaymentClient as aL, type PaymentClientCsp as aM, type PaymentConfig as aN, type PaymentFlow as aO, type PaymentInfo as aP, type PaymentMethod as aQ, type PaymentMethods as aR, type PaymentNextStep as aS, type PaymentOption as aT, type PaymentOptionKey as aU, type PaymentPoint as aV, type PaymentSubmitInput as aW, type PaymentVoucher as aX, type PendingPayment as aY, type PendingPaymentVoucher as aZ, type PickupOption as a_, type InsufficientStockLine as aa, type InvoiceAction as ab, type InvoiceDoc as ac, type InvoiceFile as ad, type InvoiceFileKind as ae, type InvoiceRequest as af, type InvoiceResult as ag, type InvoiceStage as ah, type InvoiceSummary as ai, type InvoicingCapabilities as aj, type Location as ak, type LocationContacts as al, type LocationKind as am, type LocationListParams as an, type LocationPickup as ao, type Menu as ap, type MenuItem as aq, type Money as ar, type MoneyRange as as, type NearestLocation as at, type NextAction as au, type NextActionKind as av, type Order as aw, type OrderLine as ax, type OrderPickup as ay, type OrderProblem as az, type AddressInput as b, type ProductAttributeValue as b0, type ProductCategory as b1, type ProductConnection as b2, type ProductOption as b3, type ProductSort as b4, type ProductVariant as b5, type PromotionAnnouncement as b6, type PromotionReward as b7, type PromotionTier as b8, type PromotionsList as b9, type ShopPolicies as bA, type StockLevel as bB, StorefrontError as bC, type StorefrontErrorBody as bD, type StorefrontErrorCode as bE, type StorefrontErrorInit as bF, type Subject as bG, type SubjectCatalog as bH, type SubjectCatalogNode as bI, type SubjectField as bJ, type SubjectFieldType as bK, type SubjectInput as bL, type SubjectKind as bM, type SubjectPatch as bN, type SubjectRef as bO, type Theme as bP, type TokenIntrospection as bQ, type UnavailableRateProvider as bR, dataExportBytes as bS, isAccountDeleteBlocked as bT, isReauthRequired as bU, isStorefrontError as bV, safeExportFilename as bW, type ReauthInput as ba, type ReauthResult as bb, type RecommendationPlacement as bc, type Refund as bd, type Region as be, type RegionFiscalEntry as bf, type RegionFiscalId as bg, type RegionPaymentMethod as bh, type RegionPostalCode as bi, type RestockSubscriptionInput as bj, type RestockSubscriptionResult as bk, type ReturnRequest as bl, type ReturnRequestInput as bm, type SEO as bn, type Section as bo, type SelectedOption as bp, type Shipment as bq, type ShipmentEvent as br, type ShipmentKind as bs, type ShipmentMap as bt, type ShipmentStatus as bu, type ShipmentsSummary as bv, type ShippingRate as bw, type Shop as bx, type ShopBranch as by, type ShopContact as bz, type Article as c, type Availability as d, type AvailabilityStatus as e, type CartBuyer as f, type CartBuyerInput as g, type CartCost as h, type CartDelivery as i, type CartDiscountCode as j, type CartDiscountLine as k, type CartInvoice as l, type CartLine as m, type CartLineInput as n, type CartLineMerchandise as o, type CartLineProblem as p, type CartLineUpdateInput as q, type CartPromotions as r, type CartRecommendation as s, type CartRecommendations as t, type CheckoutInfo as u, type CheckoutInput as v, type CheckoutPayment as w, type CheckoutResult as x, type Collection as y, type Connection as z };

package/dist/{chunk-IPUAZ3LQ.js → chunk-5BJRZIS3.js}

@@ -641,6 +641,199 @@ function shipmentsStatus(order) {
   return live.length ? live[0].status : null;
 }
 
-export { PICKUP_STEPS, SHIPPING_STEPS, StorefrontError, availabilityLocale, availabilityMessages, availabilityView, cartLineProblemView, declineMessage, declineMessageKey, defaultCodeForStatus, formatAvailabilityMessage, formatVoucherExpiry, isStorefrontError, isTestInvoice, isTestShipment, nextAction, orderProgress, orderShipments, paymentErrorView, paymentIdempotencyKey, paymentMessages, paymentOutcome, productAvailability, resolveAvailability, safeHttpsUrl, safeTrackingUrl, schemaAvailability, shipmentsStatus, sortTrackingEvents };
-//# sourceMappingURL=chunk-IPUAZ3LQ.js.map
-//# sourceMappingURL=chunk-IPUAZ3LQ.js.map
+// src/subjects.ts
+var MIN_SUBJECT_YEAR = 1900;
+var MAX_SUBJECT_YEAR = 2100;
+var MAX_VALUE_LENGTH = 80;
+var MAX_LABEL_LENGTH = 120;
+var MAX_FIT_KEY_LENGTH = 100;
+var isPresent = (v) => v !== null && v !== void 0 && v !== "";
+var asYear = (v) => {
+  const n = typeof v === "number" ? v : typeof v === "string" && /^\s*\d+\s*$/.test(v) ? Number(v) : NaN;
+  return Number.isInteger(n) && n >= MIN_SUBJECT_YEAR && n <= MAX_SUBJECT_YEAR ? n : null;
+};
+var cleanText = (v, max) => {
+  if (typeof v !== "string") return null;
+  const s = v.split(/\s+/).filter(Boolean).join(" ");
+  return [...s].length > max || /[\u0000-\u001f\u007f-\u009f]/.test(s) ? null : s;
+};
+var slug = (s) => s.toLowerCase().replace(/[^a-z0-9._+-]+/g, "-").replace(/^-+|-+$/g, "");
+function coversYear(node, year) {
+  if (node.ranges && node.ranges.length > 0) return node.ranges.some(([a, b]) => year >= a && year <= b);
+  if (node.from !== void 0 && year < node.from) return false;
+  if (node.to !== void 0 && year > node.to) return false;
+  return true;
+}
+var declaresYears = (n) => n.from !== void 0 || n.to !== void 0 || (n.ranges?.length ?? 0) > 0;
+function subjectLevels(kind) {
+  return kind.fields.filter((f) => f.source === "catalog" && f.type !== "year");
+}
+function subjectFields(kind) {
+  return kind.fields;
+}
+function walk(kind, values) {
+  const path = [];
+  const ids = {};
+  let tree = kind.catalog?.tree;
+  for (const f of subjectLevels(kind)) {
+    const raw = values[f.key];
+    const s = isPresent(raw) ? cleanText(raw, MAX_VALUE_LENGTH) : null;
+    const node = s && tree ? tree[s] ?? tree[s.toLowerCase()] : void 0;
+    if (!s || !node) return { path, ids, next: tree };
+    ids[f.key] = tree && tree[s] ? s : s.toLowerCase();
+    path.push(node);
+    tree = node.children;
+    if (!tree) return { path, ids, next: void 0 };
+  }
+  return { path, ids, next: tree };
+}
+var byLabel = (a, b) => a.label.localeCompare(b.label, void 0, { sensitivity: "base", numeric: true });
+function subjectOptions(kind, fieldKey, values) {
+  const field = kind.fields.find((f) => f.key === fieldKey);
+  if (!field || field.source !== "catalog" || !kind.catalog) return [];
+  if (field.type === "year") {
+    const upto = kind.fields.slice(0, kind.fields.indexOf(field));
+    const { path: path2 } = walk({ ...kind, fields: upto }, values);
+    const declared = path2.filter(declaresYears);
+    if (declared.length === 0) return [];
+    let lo = Infinity;
+    let hi = -Infinity;
+    for (const n of declared) {
+      for (const [a, b] of n.ranges?.length ? n.ranges : [[n.from ?? MIN_SUBJECT_YEAR, n.to ?? MAX_SUBJECT_YEAR]]) {
+        lo = Math.min(lo, a);
+        hi = Math.max(hi, b);
+      }
+    }
+    const out = [];
+    for (let y = Math.min(hi, MAX_SUBJECT_YEAR); y >= Math.max(lo, MIN_SUBJECT_YEAR); y--) if (declared.every((n) => coversYear(n, y))) out.push({ value: String(y), label: String(y) });
+    return out;
+  }
+  const levels = subjectLevels(kind);
+  const at = levels.findIndex((f) => f.key === fieldKey);
+  if (at < 0) return [];
+  const before = Object.fromEntries(levels.slice(0, at).map((f) => [f.key, values[f.key]]));
+  const { path, next } = walk({ ...kind, fields: kind.fields.filter((f) => levels.slice(0, at).includes(f) || f.type === "year") }, before);
+  if (path.length < at || !next) return [];
+  const year = asYear(values[kind.fields.find((f) => f.type === "year" && f.source === "catalog")?.key ?? ""]);
+  return Object.entries(next).filter(([, n]) => year === null || coversYear(n, year)).map(([value, n]) => ({ value, label: n.label })).sort(byLabel);
+}
+function reconcileSubjectValues(kind, values) {
+  const out = { ...values };
+  for (const f of kind.fields) {
+    if (f.source !== "catalog" || !isPresent(out[f.key])) continue;
+    const options = subjectOptions(kind, f.key, out);
+    const v = String(out[f.key]);
+    const ok = f.type === "year" ? options.length === 0 || options.some((o) => o.value === v) : options.some((o) => o.value === v || o.value === v.toLowerCase());
+    if (!ok) out[f.key] = "";
+  }
+  return out;
+}
+function resolveSubject(kind, values) {
+  const problems = {};
+  const known = new Set(kind.fields.map((f) => f.key));
+  for (const key2 of Object.keys(values)) if (isPresent(values[key2]) && !known.has(key2)) problems[key2] = "unknown";
+  const attributes = {};
+  const priv = {};
+  const display = {};
+  const ids = {};
+  const path = [];
+  let tree = kind.catalog?.tree;
+  const years = [];
+  const put = (f, v) => {
+    if (f.private) priv[f.key] = String(v);
+    else attributes[f.key] = v;
+  };
+  for (const f of kind.fields) {
+    const raw = values[f.key];
+    if (!isPresent(raw)) {
+      if (f.required) problems[f.key] = "required";
+      if (f.source === "catalog" && f.type !== "year") tree = void 0;
+      continue;
+    }
+    const max = f.max ?? MAX_VALUE_LENGTH;
+    if (f.type === "year") {
+      const y = asYear(raw);
+      if (y === null) {
+        problems[f.key] = "invalid";
+        continue;
+      }
+      put(f, y);
+      display[f.key] = ids[f.key] = String(y);
+      if (f.source === "catalog") years.push(f.key);
+    } else if (f.source === "catalog") {
+      if (!kind.catalog) {
+        problems[f.key] = "catalog_unavailable";
+        continue;
+      }
+      const s = cleanText(raw, max);
+      if (s === null) {
+        problems[f.key] = "invalid";
+        continue;
+      }
+      const node = tree?.[s] ?? tree?.[s.toLowerCase()];
+      if (!node) {
+        problems[f.key] = "not_in_catalog";
+        continue;
+      }
+      const id = tree?.[s] ? s : s.toLowerCase();
+      path.push(node);
+      tree = node.children;
+      put(f, id);
+      display[f.key] = node.label;
+      ids[f.key] = id;
+    } else {
+      const s = cleanText(raw, max);
+      if (s === null) {
+        problems[f.key] = "invalid";
+        continue;
+      }
+      put(f, s);
+      display[f.key] = s;
+      ids[f.key] = slug(s);
+    }
+  }
+  for (const key2 of years) {
+    const y = attributes[key2];
+    if (y !== void 0 && !problems[key2] && !path.every((n) => coversYear(n, y))) problems[key2] = "year_range";
+  }
+  if (Object.keys(problems).length > 0) return { ok: false, problems };
+  const label = [...kind.fields.filter((f) => !f.private).map((f) => display[f.key]).filter(Boolean).join(" ")].slice(0, MAX_LABEL_LENGTH).join("").trim();
+  if (!label) return { ok: false, problems: { _: "required" } };
+  let complete = true;
+  const key = kind.fit_key_template.replace(/\{([a-z][a-z0-9_]*)\}/g, (_m, name) => {
+    const id = ids[name];
+    if (!id) complete = false;
+    return id ?? "";
+  });
+  return { ok: true, subject: { label, fit_key: complete && key.length <= MAX_FIT_KEY_LENGTH ? key.toLowerCase() : "", attributes, private: priv } };
+}
+var PRIVATE_MASK = "\u2022\u2022";
+var isMasked = (v) => typeof v === "string" && v.startsWith(PRIVATE_MASK);
+var DEFAULT_FIT_TAG_PREFIX = "fit:";
+var fitTag = (fitKey, prefix = DEFAULT_FIT_TAG_PREFIX) => `${prefix}${fitKey}`;
+function fitTagsAny(fitKey, opts = {}) {
+  if (!fitKey) return [];
+  const prefix = opts.prefix ?? DEFAULT_FIT_TAG_PREFIX;
+  return opts.universal === false ? [fitTag(fitKey, prefix)] : [fitTag(fitKey, prefix), `${prefix}universal`];
+}
+var SUBJECT_CATALOG_PAGE_BYTES = 28 * 1024;
+var utf8Bytes = (s) => new TextEncoder().encode(s).length;
+function splitSubjectTree(tree, maxBytes = SUBJECT_CATALOG_PAGE_BYTES) {
+  const size = (part) => utf8Bytes(JSON.stringify(JSON.stringify(part)));
+  const parts = [];
+  let current = {};
+  for (const [id, node] of Object.entries(tree)) {
+    if (size({ [id]: node }) > maxBytes) throw new RangeError(`splitSubjectTree: option ${id} alone exceeds ${maxBytes} bytes`);
+    const next = { ...current, [id]: node };
+    if (Object.keys(current).length > 0 && size(next) > maxBytes) {
+      parts.push(current);
+      current = { [id]: node };
+    } else current = next;
+  }
+  if (Object.keys(current).length > 0) parts.push(current);
+  return parts;
+}
+
+export { DEFAULT_FIT_TAG_PREFIX, MAX_SUBJECT_YEAR, MIN_SUBJECT_YEAR, PICKUP_STEPS, PRIVATE_MASK, SHIPPING_STEPS, SUBJECT_CATALOG_PAGE_BYTES, StorefrontError, availabilityLocale, availabilityMessages, availabilityView, cartLineProblemView, coversYear, declineMessage, declineMessageKey, defaultCodeForStatus, fitTag, fitTagsAny, formatAvailabilityMessage, formatVoucherExpiry, isMasked, isStorefrontError, isTestInvoice, isTestShipment, nextAction, orderProgress, orderShipments, paymentErrorView, paymentIdempotencyKey, paymentMessages, paymentOutcome, productAvailability, reconcileSubjectValues, resolveAvailability, resolveSubject, safeHttpsUrl, safeTrackingUrl, schemaAvailability, shipmentsStatus, sortTrackingEvents, splitSubjectTree, subjectFields, subjectLevels, subjectOptions };
+//# sourceMappingURL=chunk-5BJRZIS3.js.map
+//# sourceMappingURL=chunk-5BJRZIS3.js.map