@sixtyninecommerce/client 0.23.1 → 0.25.0

package/dist/content/asset-urls.js

@@ -1,6 +1,45 @@
+/**
+ * Resolve asset references inside CMS content values.
+ *
+ * CMS field values used to be written as ABSOLUTE CDN URLs — both bare picker
+ * values and `<img src>` inside rich text. That baked the CDN origin and the
+ * channel's code into the content itself, so a channel rename or a change of
+ * CDN domain silently broke every image (1,915 such references existed in
+ * production across two tenants). Values are now stored as storage KEYS and
+ * resolved here, at render time.
+ *
+ * Both forms are handled on purpose: an absolute URL passes through the
+ * resolver unchanged, so old and new content coexist and no backfill has to
+ * land before this ships.
+ */
+/**
+ * A storage key: `{channelCode}/{source|preview|content}/…`. Deliberately
+ * narrow — content values are arbitrary merchant text, and anything looser
+ * would rewrite prose that merely contains a slash.
+ *
+ * `_global` is explicit: both asset writers map the DEFAULT channel to that
+ * prefix (`storage.service.ts`, `channel-aware-asset-naming-strategy.ts`), and
+ * a leading-underscore segment fails a plain `[a-z0-9]` opener — so
+ * platform-wide assets would silently never resolve.
+ */
 const STORAGE_KEY_PATTERN = /^(_global|[a-z0-9][a-z0-9-]*)\/(source|preview|content)\//;
+/**
+ * Single-URL asset attributes inside stored rich-text HTML.
+ *
+ * BOTH quote styles: the WordPress importer preserves whatever the source
+ * markup used, so a single-quoted `src` holding a storage key would otherwise
+ * never be resolved and render as a broken image.
+ */
 const HTML_ATTR_PATTERN = /(\s(?:src|poster|href)=["'])([^"']+)(["'])/g;
+/**
+ * `srcset` holds a COMMA-SEPARATED candidate list (`url 300w, url 500w`), so it
+ * needs its own parse — a whole-attribute replace would mangle the descriptors.
+ * It cannot be skipped either: browsers PREFER a matching srcset candidate over
+ * `src`, so leaving these unresolved would keep serving the old path even after
+ * everything else moved. Production rich text carries ~200 of these.
+ */
 const HTML_SRCSET_PATTERN = /(\ssrcset=["'])([^"']+)(["'])/g;
+/** Rewrite each candidate's URL, preserving its width/density descriptor. */
 function resolveSrcset(value, resolve) {
     return value
         .split(',')
@@ -18,9 +57,17 @@ function resolveSrcset(value, resolve) {
 function looksLikeHtml(value) {
     return value.includes('<');
 }
+/** True when a bare string is an asset reference rather than merchant prose. */
 export function isAssetReference(value) {
     return (STORAGE_KEY_PATTERN.test(value) || value.startsWith('http://') || value.startsWith('https://'));
 }
+/**
+ * Resolve every asset reference in one stored value.
+ *
+ * - Rich text: rewrites each `src` attribute.
+ * - A bare storage key: resolves the whole value.
+ * - Anything else (prose, numbers, JSON): returned untouched.
+ */
 export function resolveContentAssetUrls(value, resolve) {
     if (!value)
         return value;
@@ -30,7 +77,14 @@ export function resolveContentAssetUrls(value, resolve) {
     }
     return isAssetReference(value) ? resolve(value) : value;
 }
+/**
+ * How deep to walk a stored value. Field values are merchant JSON, so a
+ * pathological or cyclic-looking shape must not turn a page render into a stack
+ * overflow. Real content nests two or three levels (`group` → repeater entry →
+ * asset).
+ */
 const MAX_VALUE_DEPTH = 8;
+/** Resolve every asset reference inside one stored value, at any depth. */
 function resolveValue(value, resolve, depth) {
     if (typeof value === 'string')
         return resolveContentAssetUrls(value, resolve);
@@ -44,7 +98,23 @@ function resolveValue(value, resolve, depth) {
     }
     return out;
 }
+/**
+ * Apply {@link resolveContentAssetUrls} across a field-value bag.
+ *
+ * Walks NESTED values, not just top-level strings. A `video` field is stored as
+ * `{ source, url }` and a `group` field as an object (or an array of them) with
+ * asset, multi-asset and rich-text members — the dashboard writes storage keys
+ * inside all of those, so stopping at the first level would hand the storefront
+ * a raw key and render a broken video or image.
+ *
+ * Non-string leaves (numbers, booleans, null) are returned untouched, and the
+ * walk is depth-capped: field values are merchant JSON, and a render must not
+ * be able to blow the stack.
+ */
 export function resolveContentFieldValues(fields, resolve) {
+    // This runs on whatever the CMS returned. A field bag that is absent or not
+    // an object is a response shape, not a crash — the SDK must hand the caller
+    // something renderable either way.
     if (!fields || typeof fields !== 'object')
         return {};
     const out = {};
@@ -53,6 +123,13 @@ export function resolveContentFieldValues(fields, resolve) {
     }
     return out;
 }
+/**
+ * Keys a search hit carries as ITEM METADATA rather than as a field value.
+ *
+ * They must be passed through untouched: `path` in particular is merchant
+ * routing like `products/content/winter`, which matches the storage-key shape
+ * exactly and would be rewritten into a CDN URL.
+ */
 const SEARCH_HIT_METADATA_KEYS = new Set([
     'id',
     'channel_id',
@@ -67,6 +144,15 @@ const SEARCH_HIT_METADATA_KEYS = new Set([
     'updated_at',
     'published_at',
 ]);
+/**
+ * Resolve the field values flattened onto one search hit.
+ *
+ * Search results come from Meilisearch, which stores `value_json` verbatim —
+ * so a hit carries exactly the same stored form as a direct read and needs
+ * exactly the same resolution. Missing it means a storefront search bar renders
+ * raw storage keys while the pages themselves are fine, and only for items
+ * re-saved since the migration, which makes it look intermittent.
+ */
 export function resolveSearchHitValues(hit, resolve) {
     const out = {};
     for (const [key, value] of Object.entries(hit)) {
@@ -76,6 +162,12 @@ export function resolveSearchHitValues(hit, resolve) {
     }
     return out;
 }
+/**
+ * Resolve the hits inside a raw search envelope (`{ data: { hits: [...] } }`).
+ *
+ * Used by the untyped `getContent` passthrough, which hands the caller whatever
+ * the endpoint returned — including, before this, unresolved storage keys.
+ */
 export function resolveSearchEnvelope(envelope, resolve) {
     const data = envelope.data;
     if (!data || typeof data !== 'object')

package/dist/content/asset-urls.js.map

@@ -1 +1 @@
-{"version":3,"file":"asset-urls.js","sourceRoot":"","sources":["../../src/content/asset-urls.ts"],"names":[],"mappings":"AA2BA,MAAM,mBAAmB,GAAG,2DAA2D,CAAC;AASxF,MAAM,iBAAiB,GAAG,6CAA6C,CAAC;AASxE,MAAM,mBAAmB,GAAG,gCAAgC,CAAC;AAG7D,SAAS,aAAa,CAAC,KAAa,EAAE,OAAyB;IAC7D,OAAO,KAAK;SACT,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QACjB,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAC/B,MAAM,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAAE,OAAO,SAAS,CAAC;QACrD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAGD,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,OAAO,CACL,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAC/F,CAAC;AACJ,CAAC;AASD,MAAM,UAAU,uBAAuB,CAAC,KAAa,EAAE,OAAyB;IAC9E,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IAEzB,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAC7B,iBAAiB,EACjB,CAAC,KAAK,EAAE,MAAc,EAAE,GAAW,EAAE,MAAc,EAAE,EAAE,CACrD,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CACtE,CAAC;QACF,OAAO,SAAS,CAAC,OAAO,CACtB,mBAAmB,EACnB,CAAC,MAAM,EAAE,MAAc,EAAE,GAAW,EAAE,MAAc,EAAE,EAAE,CACtD,GAAG,MAAM,GAAG,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CACrD,CAAC;IACJ,CAAC;IAED,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1D,CAAC;AAQD,MAAM,eAAe,GAAG,CAAC,CAAC;AAG1B,SAAS,YAAY,CAAC,KAAc,EAAE,OAAyB,EAAE,KAAa;IAC5E,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9E,IAAI,KAAK,IAAI,eAAe,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC1F,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/F,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAeD,MAAM,UAAU,yBAAyB,CACvC,MAAkD,EAClD,OAAyB;IAKzB,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACrD,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AASD,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC;IACvC,IAAI;IACJ,YAAY;IACZ,eAAe;IACf,iBAAiB;IACjB,MAAM;IACN,MAAM;IACN,WAAW;IACX,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,YAAY;IACZ,cAAc;CACf,CAAC,CAAC;AAWH,MAAM,UAAU,sBAAsB,CACpC,GAAM,EACN,OAAyB;IAEzB,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,GAAG,CAAC,GAAG,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC;YAC1C,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,yBAAyB,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,GAAQ,CAAC;AAClB,CAAC;AAQD,MAAM,UAAU,qBAAqB,CACnC,QAAiC,EACjC,OAAyB;IAEzB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC3B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IACvD,MAAM,IAAI,GAAI,IAA2B,CAAC,IAAI,CAAC;IAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC1C,OAAO;QACL,GAAG,QAAQ;QACX,IAAI,EAAE;YACJ,GAAI,IAAgC;YACpC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACrB,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAC5B,CAAC,CAAC,sBAAsB,CAAC,GAA8B,EAAE,OAAO,CAAC;gBACjE,CAAC,CAAC,GAAG,CACR;SACF;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"asset-urls.js","sourceRoot":"","sources":["../../src/content/asset-urls.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAIH;;;;;;;;;GASG;AACH,MAAM,mBAAmB,GAAG,2DAA2D,CAAC;AAExF;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,6CAA6C,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,mBAAmB,GAAG,gCAAgC,CAAC;AAE7D,6EAA6E;AAC7E,SAAS,aAAa,CAAC,KAAa,EAAE,OAAyB;IAC7D,OAAO,KAAK;SACT,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;QACjB,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC;QAC/B,MAAM,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,IAAI,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC;YAAE,OAAO,SAAS,CAAC;QACrD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,OAAO,CACL,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAC/F,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAa,EAAE,OAAyB;IAC9E,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IAEzB,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAC7B,iBAAiB,EACjB,CAAC,KAAK,EAAE,MAAc,EAAE,GAAW,EAAE,MAAc,EAAE,EAAE,CACrD,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC,KAAK,CACtE,CAAC;QACF,OAAO,SAAS,CAAC,OAAO,CACtB,mBAAmB,EACnB,CAAC,MAAM,EAAE,MAAc,EAAE,GAAW,EAAE,MAAc,EAAE,EAAE,CACtD,GAAG,MAAM,GAAG,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,MAAM,EAAE,CACrD,CAAC;IACJ,CAAC;IAED,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,MAAM,eAAe,GAAG,CAAC,CAAC;AAE1B,2EAA2E;AAC3E,SAAS,YAAY,CAAC,KAAc,EAAE,OAAyB,EAAE,KAAa;IAC5E,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9E,IAAI,KAAK,IAAI,eAAe,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC1F,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAC/F,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;QAC5E,GAAG,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,yBAAyB,CACvC,MAAkD,EAClD,OAAyB;IAEzB,4EAA4E;IAC5E,4EAA4E;IAC5E,mCAAmC;IACnC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACrD,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC;IACvC,IAAI;IACJ,YAAY;IACZ,eAAe;IACf,iBAAiB;IACjB,MAAM;IACN,MAAM;IACN,WAAW;IACX,UAAU;IACV,QAAQ;IACR,YAAY;IACZ,YAAY;IACZ,cAAc;CACf,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,GAAM,EACN,OAAyB;IAEzB,MAAM,GAAG,GAA4B,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,GAAG,CAAC,GAAG,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC;YAC1C,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,yBAAyB,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,GAAQ,CAAC;AAClB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAiC,EACjC,OAAyB;IAEzB,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC3B,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IACvD,MAAM,IAAI,GAAI,IAA2B,CAAC,IAAI,CAAC;IAC/C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC1C,OAAO;QACL,GAAG,QAAQ;QACX,IAAI,EAAE;YACJ,GAAI,IAAgC;YACpC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACrB,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAC5B,CAAC,CAAC,sBAAsB,CAAC,GAA8B,EAAE,OAAO,CAAC;gBACjE,CAAC,CAAC,GAAG,CACR;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/content/assets.d.ts

@@ -1,8 +1,23 @@
 import type { HttpClient } from '../core/http.js';
 import type { CmsAsset, RequestOptions, VendureAssetDescriptionTranslation } from '../types.js';
 export declare function createAssetMethods(http: HttpClient): {
+    /**
+     * Fetch a single CMS asset by ID. Public endpoint, scoped by channel header.
+     * Returns the public-safe asset shape with image presets and alt-text translations.
+     */
     getAsset(id: string, options?: RequestOptions): Promise<CmsAsset>;
+    /**
+     * Bulk-fetch CMS assets by ID. Used to resolve image references stored in
+     * CMS field values (the `image`/`images` field types store asset ID arrays).
+     * Public endpoint; max 50 IDs per call. Foreign or missing IDs are silently
+     * dropped — the result may have fewer entries than requested.
+     */
     lookupAssets(ids: string[], options?: RequestOptions): Promise<CmsAsset[]>;
+    /**
+     * Bulk-fetch alt-text translations for Vendure product image assets, keyed
+     * by Vendure asset ID. Vendure stores assets globally; per-channel alt-text
+     * translations live in the CMS service. Public endpoint; max 50 IDs per call.
+     */
     lookupVendureAssetDescriptions(vendureAssetIds: string[], options?: RequestOptions): Promise<Record<string, VendureAssetDescriptionTranslation[]>>;
 };
 //# sourceMappingURL=assets.d.ts.map

package/dist/content/assets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/content/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAC;AAchG,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,UAAU;iBAM5B,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;sBAe/C,MAAM,EAAE,YAAY,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;oDAgB7D,MAAM,EAAE,YACf,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kCAAkC,EAAE,CAAC,CAAC;EAUnE"}
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../src/content/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAC;AAchG,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,UAAU;IAE/C;;;OAGG;iBACgB,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IASvE;;;;;OAKG;sBACqB,MAAM,EAAE,YAAY,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUhF;;;;OAIG;oDAEgB,MAAM,EAAE,YACf,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,kCAAkC,EAAE,CAAC,CAAC;EAUnE"}

package/dist/content/assets.js

@@ -1,15 +1,30 @@
 export function createAssetMethods(http) {
     return {
+        /**
+         * Fetch a single CMS asset by ID. Public endpoint, scoped by channel header.
+         * Returns the public-safe asset shape with image presets and alt-text translations.
+         */
         async getAsset(id, options) {
             const response = await http.cmsGet(`/public-assets/${id}`, undefined, options);
             return response.data;
         },
+        /**
+         * Bulk-fetch CMS assets by ID. Used to resolve image references stored in
+         * CMS field values (the `image`/`images` field types store asset ID arrays).
+         * Public endpoint; max 50 IDs per call. Foreign or missing IDs are silently
+         * dropped — the result may have fewer entries than requested.
+         */
         async lookupAssets(ids, options) {
             if (ids.length === 0)
                 return [];
             const response = await http.cmsGet('/assets/lookup', { ids: ids.join(',') }, options);
             return response.data;
         },
+        /**
+         * Bulk-fetch alt-text translations for Vendure product image assets, keyed
+         * by Vendure asset ID. Vendure stores assets globally; per-channel alt-text
+         * translations live in the CMS service. Public endpoint; max 50 IDs per call.
+         */
         async lookupVendureAssetDescriptions(vendureAssetIds, options) {
             if (vendureAssetIds.length === 0)
                 return {};

package/dist/content/assets.js.map

@@ -1 +1 @@
-{"version":3,"file":"assets.js","sourceRoot":"","sources":["../../src/content/assets.ts"],"names":[],"mappings":"AAeA,MAAM,UAAU,kBAAkB,CAAC,IAAgB;IACjD,OAAO;QAKL,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;YACjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,kBAAkB,EAAE,EAAE,EACtB,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAQD,KAAK,CAAC,YAAY,CAAC,GAAa,EAAE,OAAwB;YACxD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,EAChB,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EACtB,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAOD,KAAK,CAAC,8BAA8B,CAClC,eAAyB,EACzB,OAAwB;YAExB,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,wBAAwB,EACxB,EAAE,GAAG,EAAE,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAClC,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"assets.js","sourceRoot":"","sources":["../../src/content/assets.ts"],"names":[],"mappings":"AAeA,MAAM,UAAU,kBAAkB,CAAC,IAAgB;IACjD,OAAO;QACL;;;WAGG;QACH,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;YACjD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,kBAAkB,EAAE,EAAE,EACtB,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED;;;;;WAKG;QACH,KAAK,CAAC,YAAY,CAAC,GAAa,EAAE,OAAwB;YACxD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,EAChB,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EACtB,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED;;;;WAIG;QACH,KAAK,CAAC,8BAA8B,CAClC,eAAyB,EACzB,OAAwB;YAExB,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,wBAAwB,EACxB,EAAE,GAAG,EAAE,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAClC,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/content/collection-pages.d.ts

@@ -1,6 +1,11 @@
 import type { HttpClient } from '../core/http.js';
 import type { CollectionPageValues, RequestOptions, StoreContext } from '../types.js';
 export declare function createCollectionPageMethods(http: HttpClient, ctx: StoreContext): {
+    /**
+     * Fetch the page-scoped field values for a collection's landing page.
+     * Use this to render collection index pages (e.g. `/blog`, `/shop/sale`)
+     * with their associated CMS-managed hero image, intro copy, etc.
+     */
     getCollectionPageValues(collectionId: string, languageCode?: string, options?: RequestOptions): Promise<CollectionPageValues>;
 };
 //# sourceMappingURL=collection-pages.d.ts.map

package/dist/content/collection-pages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collection-pages.d.ts","sourceRoot":"","sources":["../../src/content/collection-pages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAOtF,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY;0CAQ3D,MAAM,iBACL,MAAM,YACX,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;EAkBnC"}
+{"version":3,"file":"collection-pages.d.ts","sourceRoot":"","sources":["../../src/content/collection-pages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,oBAAoB,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAOtF,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY;IAE3E;;;;OAIG;0CAEa,MAAM,iBACL,MAAM,YACX,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;EAkBnC"}

package/dist/content/collection-pages.js

@@ -2,11 +2,19 @@ import { createContextAssetUrlResolver } from '../media/urls.js';
 import { resolveContentFieldValues } from './asset-urls.js';
 export function createCollectionPageMethods(http, ctx) {
     return {
+        /**
+         * Fetch the page-scoped field values for a collection's landing page.
+         * Use this to render collection index pages (e.g. `/blog`, `/shop/sale`)
+         * with their associated CMS-managed hero image, intro copy, etc.
+         */
         async getCollectionPageValues(collectionId, languageCode, options) {
             const params = {};
             if (languageCode)
                 params.language_code = languageCode;
             const response = await http.cmsGet(`/collections/${collectionId}/page-values`, params, options);
+            // Values reference assets by storage key; the CDN origin (and the
+            // channel prefix, on a custom domain) belongs to render time, not to
+            // stored content. Legacy absolute URLs pass through untouched.
             const resolve = createContextAssetUrlResolver(ctx);
             return {
                 ...response.data,

package/dist/content/collection-pages.js.map

@@ -1 +1 @@
-{"version":3,"file":"collection-pages.js","sourceRoot":"","sources":["../../src/content/collection-pages.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAM5D,MAAM,UAAU,2BAA2B,CAAC,IAAgB,EAAE,GAAiB;IAC7E,OAAO;QAML,KAAK,CAAC,uBAAuB,CAC3B,YAAoB,EACpB,YAAqB,EACrB,OAAwB;YAExB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,YAAY;gBAAE,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,cAAc,EAC1C,MAAM,EACN,OAAO,CACR,CAAC;YAIF,MAAM,OAAO,GAAG,6BAA6B,CAAC,GAAG,CAAC,CAAC;YACnD,OAAO;gBACL,GAAG,QAAQ,CAAC,IAAI;gBAChB,MAAM,EAAE,yBAAyB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;aACjE,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"collection-pages.js","sourceRoot":"","sources":["../../src/content/collection-pages.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AAEjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAM5D,MAAM,UAAU,2BAA2B,CAAC,IAAgB,EAAE,GAAiB;IAC7E,OAAO;QACL;;;;WAIG;QACH,KAAK,CAAC,uBAAuB,CAC3B,YAAoB,EACpB,YAAqB,EACrB,OAAwB;YAExB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,YAAY;gBAAE,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,cAAc,EAC1C,MAAM,EACN,OAAO,CACR,CAAC;YACF,kEAAkE;YAClE,qEAAqE;YACrE,+DAA+D;YAC/D,MAAM,OAAO,GAAG,6BAA6B,CAAC,GAAG,CAAC,CAAC;YACnD,OAAO;gBACL,GAAG,QAAQ,CAAC,IAAI;gBAChB,MAAM,EAAE,yBAAyB,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;aACjE,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/content/collections.d.ts

@@ -1,9 +1,23 @@
 import type { HttpClient } from '../core/http.js';
 import type { CmsCollection, CmsCollectionDetail, CmsCollectionItem, CmsCollectionItemList, CollectionItemsQuery, RequestOptions, StoreContext } from '../types.js';
+/**
+ * Direct (database-backed) CMS collection reads. Unlike `getContent` /
+ * `searchContent`, which go through the Meilisearch index, these read the
+ * CMS database directly — use them for canonical content fetches (detail
+ * pages, build-time rendering) where index freshness must not matter.
+ * Public callers only ever receive published items.
+ */
 export declare function createCmsCollectionMethods(http: HttpClient, ctx: StoreContext): {
+    /** List the channel's CMS collections (content types). */
     getCollections(options?: RequestOptions): Promise<CmsCollection[]>;
+    /** A single CMS collection including its field definitions. */
     getCollection(collectionId: string, options?: RequestOptions): Promise<CmsCollectionDetail>;
+    /**
+     * List a collection's items with locale-aware field values. Pass
+     * `parentId: 'root'` for top-level items of a hierarchical collection.
+     */
     getCollectionItems(collectionId: string, query?: CollectionItemsQuery, options?: RequestOptions): Promise<CmsCollectionItemList>;
+    /** A single collection item with field values and slug translations. */
     getCollectionItem(collectionId: string, itemId: string, languageCode?: string, options?: RequestOptions): Promise<CmsCollectionItem>;
 };
 //# sourceMappingURL=collections.d.ts.map

package/dist/content/collections.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../../src/content/collections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,YAAY,EACb,MAAM,aAAa,CAAC;AA2BrB,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY;6BAW3C,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;gCAOxD,MAAM,YACV,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;qCAcf,MAAM,UACZ,oBAAoB,YAClB,cAAc,GACvB,OAAO,CAAC,qBAAqB,CAAC;oCAoBjB,MAAM,UACZ,MAAM,iBACC,MAAM,YACX,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC;EAWhC"}
+{"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../../src/content/collections.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EACV,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,YAAY,EACb,MAAM,aAAa,CAAC;AAoBrB;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY;IAU1E,0DAA0D;6BAC3B,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAKxE,+DAA+D;gCAE/C,MAAM,YACV,cAAc,GACvB,OAAO,CAAC,mBAAmB,CAAC;IAS/B;;;OAGG;qCAEa,MAAM,UACZ,oBAAoB,YAClB,cAAc,GACvB,OAAO,CAAC,qBAAqB,CAAC;IAkBjC,wEAAwE;oCAExD,MAAM,UACZ,MAAM,iBACC,MAAM,YACX,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC;EAWhC"}

package/dist/content/collections.js

@@ -1,20 +1,35 @@
 import { createContextAssetUrlResolver } from '../media/urls.js';
 import { resolveContentFieldValues } from './asset-urls.js';
+/**
+ * Direct (database-backed) CMS collection reads. Unlike `getContent` /
+ * `searchContent`, which go through the Meilisearch index, these read the
+ * CMS database directly — use them for canonical content fetches (detail
+ * pages, build-time rendering) where index freshness must not matter.
+ * Public callers only ever receive published items.
+ */
 export function createCmsCollectionMethods(http, ctx) {
+    // Built once: ctx is fixed for the client's lifetime.
     const resolve = createContextAssetUrlResolver(ctx);
+    /** Content values carry asset references as storage keys; resolve on read. */
     const withResolvedValues = (item) => ({
         ...item,
         values: resolveContentFieldValues(item.values, resolve),
     });
     return {
+        /** List the channel's CMS collections (content types). */
         async getCollections(options) {
             const envelope = await http.cmsGet('/collections', {}, options);
             return envelope.data;
         },
+        /** A single CMS collection including its field definitions. */
         async getCollection(collectionId, options) {
             const envelope = await http.cmsGet(`/collections/${collectionId}`, {}, options);
             return envelope.data;
         },
+        /**
+         * List a collection's items with locale-aware field values. Pass
+         * `parentId: 'root'` for top-level items of a hierarchical collection.
+         */
         async getCollectionItems(collectionId, query, options) {
             const params = {};
             if (query?.parentId)
@@ -34,6 +49,7 @@ export function createCmsCollectionMethods(http, ctx) {
             const envelope = await http.cmsGet(`/collections/${collectionId}/items`, params, options);
             return { items: envelope.data.map(withResolvedValues), total: envelope.pagination.total };
         },
+        /** A single collection item with field values and slug translations. */
         async getCollectionItem(collectionId, itemId, languageCode, options) {
             const params = {};
             if (languageCode)

package/dist/content/collections.js.map

@@ -1 +1 @@
-{"version":3,"file":"collections.js","sourceRoot":"","sources":["../../src/content/collections.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AAUjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AA0B5D,MAAM,UAAU,0BAA0B,CAAC,IAAgB,EAAE,GAAiB;IAE5E,MAAM,OAAO,GAAG,6BAA6B,CAAC,GAAG,CAAC,CAAC;IAEnD,MAAM,kBAAkB,GAAG,CAAgD,IAAO,EAAK,EAAE,CAAC,CAAC;QACzF,GAAG,IAAI;QACP,MAAM,EAAE,yBAAyB,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;KACxD,CAAC,CAAC;IAEH,OAAO;QAEL,KAAK,CAAC,cAAc,CAAC,OAAwB;YAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAyB,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YACxF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAGD,KAAK,CAAC,aAAa,CACjB,YAAoB,EACpB,OAAwB;YAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,EAAE,EAC9B,EAAE,EACF,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAMD,KAAK,CAAC,kBAAkB,CACtB,YAAoB,EACpB,KAA4B,EAC5B,OAAwB;YAExB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,KAAK,EAAE,QAAQ;gBAAE,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;YACvD,IAAI,KAAK,EAAE,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAC1C,IAAI,KAAK,EAAE,MAAM;gBAAE,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YAChD,IAAI,KAAK,EAAE,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAC1C,IAAI,KAAK,EAAE,YAAY;gBAAE,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;YACnE,IAAI,KAAK,EAAE,KAAK,IAAI,IAAI;gBAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI;gBAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEhE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,QAAQ,EACpC,MAAM,EACN,OAAO,CACR,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QAC5F,CAAC;QAGD,KAAK,CAAC,iBAAiB,CACrB,YAAoB,EACpB,MAAc,EACd,YAAqB,EACrB,OAAwB;YAExB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,YAAY;gBAAE,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,UAAU,MAAM,EAAE,EAC9C,MAAM,EACN,OAAO,CACR,CAAC;YACF,OAAO,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"collections.js","sourceRoot":"","sources":["../../src/content/collections.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAC;AAUjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAmB5D;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CAAC,IAAgB,EAAE,GAAiB;IAC5E,sDAAsD;IACtD,MAAM,OAAO,GAAG,6BAA6B,CAAC,GAAG,CAAC,CAAC;IACnD,8EAA8E;IAC9E,MAAM,kBAAkB,GAAG,CAAgD,IAAO,EAAK,EAAE,CAAC,CAAC;QACzF,GAAG,IAAI;QACP,MAAM,EAAE,yBAAyB,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;KACxD,CAAC,CAAC;IAEH,OAAO;QACL,0DAA0D;QAC1D,KAAK,CAAC,cAAc,CAAC,OAAwB;YAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAyB,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YACxF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,+DAA+D;QAC/D,KAAK,CAAC,aAAa,CACjB,YAAoB,EACpB,OAAwB;YAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,EAAE,EAC9B,EAAE,EACF,OAAO,CACR,CAAC;YACF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAED;;;WAGG;QACH,KAAK,CAAC,kBAAkB,CACtB,YAAoB,EACpB,KAA4B,EAC5B,OAAwB;YAExB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,KAAK,EAAE,QAAQ;gBAAE,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;YACvD,IAAI,KAAK,EAAE,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAC1C,IAAI,KAAK,EAAE,MAAM;gBAAE,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YAChD,IAAI,KAAK,EAAE,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAC1C,IAAI,KAAK,EAAE,YAAY;gBAAE,MAAM,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;YACnE,IAAI,KAAK,EAAE,KAAK,IAAI,IAAI;gBAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC7D,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI;gBAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEhE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,QAAQ,EACpC,MAAM,EACN,OAAO,CACR,CAAC;YACF,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QAC5F,CAAC;QAED,wEAAwE;QACxE,KAAK,CAAC,iBAAiB,CACrB,YAAoB,EACpB,MAAc,EACd,YAAqB,EACrB,OAAwB;YAExB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,YAAY;gBAAE,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAChC,gBAAgB,YAAY,UAAU,MAAM,EAAE,EAC9C,MAAM,EACN,OAAO,CACR,CAAC;YACF,OAAO,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3C,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/content/filtered-products.d.ts

@@ -1,4 +1,5 @@
 import type { SearchInput } from '../types.js';
+/** Value stored by the `filtered_products` CMS field type. */
 export interface FilteredProductsValue {
     filters: Array<{
         property_slug: string;
@@ -6,11 +7,28 @@ export interface FilteredProductsValue {
     }>;
     collection_id?: string | null;
 }
+/** Field-level config for the `filtered_products` CMS field type. */
 export interface FilteredProductsConfig {
     filtered_sort_field?: string;
     filtered_sort_direction?: string;
     filtered_limit?: number;
 }
+/**
+ * Convert a `filtered_products` CMS field value + config into SearchInput params
+ * for use with `searchProducts()`.
+ *
+ * Sort and limit come from the field config (set in the content type builder),
+ * filters and collection scope come from the per-item value.
+ *
+ * @example
+ * ```ts
+ * const field = collection.fields.find(f => f.slug === 'featured');
+ * const value = item.values.featured as FilteredProductsValue;
+ * const results = await client.commerce.searchProducts(
+ *   buildFilteredProductsSearch(value, field?.config),
+ * );
+ * ```
+ */
 export declare function buildFilteredProductsSearch(value: FilteredProductsValue, config?: FilteredProductsConfig, overrides?: {
     term?: string;
     take?: number;

package/dist/content/filtered-products.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filtered-products.d.ts","sourceRoot":"","sources":["../../src/content/filtered-products.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/C,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,KAAK,CAAC;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IACrE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAGD,MAAM,WAAW,sBAAsB;IACrC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAkBD,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,qBAAqB,EAC5B,MAAM,CAAC,EAAE,sBAAsB,EAC/B,SAAS,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAC1D,WAAW,CAiBb"}
+{"version":3,"file":"filtered-products.d.ts","sourceRoot":"","sources":["../../src/content/filtered-products.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,8DAA8D;AAC9D,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,KAAK,CAAC;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IACrE,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,qEAAqE;AACrE,MAAM,WAAW,sBAAsB;IACrC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,qBAAqB,EAC5B,MAAM,CAAC,EAAE,sBAAsB,EAC/B,SAAS,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAC1D,WAAW,CAiBb"}

package/dist/content/filtered-products.js

@@ -1,3 +1,19 @@
+/**
+ * Convert a `filtered_products` CMS field value + config into SearchInput params
+ * for use with `searchProducts()`.
+ *
+ * Sort and limit come from the field config (set in the content type builder),
+ * filters and collection scope come from the per-item value.
+ *
+ * @example
+ * ```ts
+ * const field = collection.fields.find(f => f.slug === 'featured');
+ * const value = item.values.featured as FilteredProductsValue;
+ * const results = await client.commerce.searchProducts(
+ *   buildFilteredProductsSearch(value, field?.config),
+ * );
+ * ```
+ */
 export function buildFilteredProductsSearch(value, config, overrides) {
     const sort = config?.filtered_sort_field
         ? {

package/dist/content/filtered-products.js.map

@@ -1 +1 @@
-{"version":3,"file":"filtered-products.js","sourceRoot":"","sources":["../../src/content/filtered-products.ts"],"names":[],"mappings":"AA+BA,MAAM,UAAU,2BAA2B,CACzC,KAA4B,EAC5B,MAA+B,EAC/B,SAA2D;IAE3D,MAAM,IAAI,GAAoC,MAAM,EAAE,mBAAmB;QACvE,CAAC,CAAE;YACC,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC,uBAAuB,IAAI,KAAK;SAC9C;QAC3B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO;QACL,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE;QAC3B,iBAAiB,EAAE,KAAK,CAAC,OAAO;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;aAC3C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;QAC1C,YAAY,EAAE,KAAK,CAAC,aAAa,IAAI,SAAS;QAC9C,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,MAAM,EAAE,cAAc;QAC/C,IAAI,EAAE,SAAS,EAAE,IAAI;QACrB,IAAI;KACL,CAAC;AACJ,CAAC"}
+{"version":3,"file":"filtered-products.js","sourceRoot":"","sources":["../../src/content/filtered-products.ts"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,2BAA2B,CACzC,KAA4B,EAC5B,MAA+B,EAC/B,SAA2D;IAE3D,MAAM,IAAI,GAAoC,MAAM,EAAE,mBAAmB;QACvE,CAAC,CAAE;YACC,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC,uBAAuB,IAAI,KAAK;SAC9C;QAC3B,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO;QACL,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE;QAC3B,iBAAiB,EAAE,KAAK,CAAC,OAAO;aAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;aAC3C,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC;QAC1C,YAAY,EAAE,KAAK,CAAC,aAAa,IAAI,SAAS;QAC9C,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,MAAM,EAAE,cAAc;QAC/C,IAAI,EAAE,SAAS,EAAE,IAAI;QACrB,IAAI;KACL,CAAC;AACJ,CAAC"}

package/dist/content/form-field-types.d.ts

@@ -1,4 +1,10 @@
 import type { FormFieldTypeDescriptor, FormSlugRules } from '../types.js';
+/**
+ * Static mirror of the CMS slug rules (services/cms field-type-registry.ts),
+ * served live in the `meta.slugRules` of GET /forms/field-types. Form slugs are
+ * HYPHEN-separated and field slugs are UNDERSCORE-separated — the mix-up the
+ * CMS rejects with a 400.
+ */
 export declare const FORM_SLUG_RULES: FormSlugRules;
 export declare const FORM_FIELD_TYPES: FormFieldTypeDescriptor[];
 //# sourceMappingURL=form-field-types.d.ts.map

package/dist/content/form-field-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"form-field-types.d.ts","sourceRoot":"","sources":["../../src/content/form-field-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA2B,uBAAuB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAQnG,eAAO,MAAM,eAAe,EAAE,aAiB7B,CAAC;AA4BF,eAAO,MAAM,gBAAgB,EAAE,uBAAuB,EAoFrD,CAAC"}
+{"version":3,"file":"form-field-types.d.ts","sourceRoot":"","sources":["../../src/content/form-field-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA2B,uBAAuB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEnG;;;;;GAKG;AACH,eAAO,MAAM,eAAe,EAAE,aAiB7B,CAAC;AA4BF,eAAO,MAAM,gBAAgB,EAAE,uBAAuB,EAoFrD,CAAC"}

package/dist/content/form-field-types.js

@@ -1,3 +1,9 @@
+/**
+ * Static mirror of the CMS slug rules (services/cms field-type-registry.ts),
+ * served live in the `meta.slugRules` of GET /forms/field-types. Form slugs are
+ * HYPHEN-separated and field slugs are UNDERSCORE-separated — the mix-up the
+ * CMS rejects with a 400.
+ */
 export const FORM_SLUG_RULES = {
     form: {
         pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$',
@@ -14,6 +20,12 @@ export const FORM_SLUG_RULES = {
         invalidExamples: ['Email', 'first-name', '_email', 'first__name'],
     },
 };
+/**
+ * Static mirror of the CMS field-type registry (services/cms field-type-registry.ts),
+ * so a storefront can author forms without a round-trip. Keep this data
+ * IDENTICAL to what `GET /forms/field-types` (content.getFormFieldTypes())
+ * returns — the endpoint is authoritative; this is the offline copy.
+ */
 const STRING_CONSTRAINTS = [
     { key: 'min_length', valueType: 'integer', description: 'Minimum number of characters.' },
     { key: 'max_length', valueType: 'integer', description: 'Maximum number of characters.' },

package/dist/content/form-field-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"form-field-types.js","sourceRoot":"","sources":["../../src/content/form-field-types.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,MAAM,eAAe,GAAkB;IAC5C,IAAI,EAAE;QACJ,OAAO,EAAE,4BAA4B;QACrC,SAAS,EAAE,GAAG;QACd,WAAW,EACT,yIAAyI;QAC3I,aAAa,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,wBAAwB,CAAC;QAClE,eAAe,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,CAAC;KACtE;IACD,KAAK,EAAE;QACL,OAAO,EAAE,4BAA4B;QACrC,SAAS,EAAE,GAAG;QACd,WAAW,EACT,0NAA0N;QAC5N,aAAa,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,CAAC;QACrD,eAAe,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,CAAC;KAClE;CACF,CAAC;AASF,MAAM,kBAAkB,GAA8B;IACpD,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,+BAA+B,EAAE;IACzF,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,+BAA+B,EAAE;IACzF;QACE,GAAG,EAAE,SAAS;QACd,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,sEAAsE;KACpF;CACF,CAAC;AAEF,MAAM,kBAAkB,GAA8B;IACpD;QACE,GAAG,EAAE,SAAS;QACd,SAAS,EAAE,UAAU;QACrB,WAAW,EACT,iIAAiI;KACpI;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAA8B;IACzD;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,kBAAkB;QACzB,WAAW,EAAE,2BAA2B;QACxC,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,yBAAyB;QACtC,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,yEAAyE;KACjF;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,8CAA8C;QAC3D,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,EAAE;KAChB;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,kCAAkC;QAC/C,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,mEAAmE;QAChF,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE;YACX,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,oCAAoC,EAAE;YACtF,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,oCAAoC,EAAE;SACvF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,0BAA0B;QACjC,WAAW,EAAE,gDAAgD;QAC7D,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,2BAA2B;QAClC,WAAW,EACT,uFAAuF;QACzF,SAAS,EAAE,oBAAoB;QAC/B,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,+EAA+E;KACvF;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EAAE,gDAAgD;QAC7D,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,+CAA+C;QAC5D,SAAS,EAAE,mBAAmB;QAC9B,WAAW,EAAE,EAAE;KAChB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,gBAAgB;QACvB,WAAW,EAAE,wDAAwD;QACrE,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,iEAAiE;QAC9E,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;CACF,CAAC"}
+{"version":3,"file":"form-field-types.js","sourceRoot":"","sources":["../../src/content/form-field-types.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAkB;IAC5C,IAAI,EAAE;QACJ,OAAO,EAAE,4BAA4B;QACrC,SAAS,EAAE,GAAG;QACd,WAAW,EACT,yIAAyI;QAC3I,aAAa,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,wBAAwB,CAAC;QAClE,eAAe,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,aAAa,CAAC;KACtE;IACD,KAAK,EAAE;QACL,OAAO,EAAE,4BAA4B;QACrC,SAAS,EAAE,GAAG;QACd,WAAW,EACT,0NAA0N;QAC5N,aAAa,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,CAAC;QACrD,eAAe,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,CAAC;KAClE;CACF,CAAC;AAEF;;;;;GAKG;AAEH,MAAM,kBAAkB,GAA8B;IACpD,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,+BAA+B,EAAE;IACzF,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,+BAA+B,EAAE;IACzF;QACE,GAAG,EAAE,SAAS;QACd,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,sEAAsE;KACpF;CACF,CAAC;AAEF,MAAM,kBAAkB,GAA8B;IACpD;QACE,GAAG,EAAE,SAAS;QACd,SAAS,EAAE,UAAU;QACrB,WAAW,EACT,iIAAiI;KACpI;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAA8B;IACzD;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,kBAAkB;QACzB,WAAW,EAAE,2BAA2B;QACxC,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,yBAAyB;QACtC,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,yEAAyE;KACjF;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,8CAA8C;QAC3D,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,EAAE;KAChB;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,kCAAkC;QAC/C,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,mEAAmE;QAChF,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE;YACX,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,oCAAoC,EAAE;YACtF,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,oCAAoC,EAAE;SACvF;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,0BAA0B;QACjC,WAAW,EAAE,gDAAgD;QAC7D,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,KAAK,EAAE,2BAA2B;QAClC,WAAW,EACT,uFAAuF;QACzF,SAAS,EAAE,oBAAoB;QAC/B,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,+EAA+E;KACvF;IACD;QACE,IAAI,EAAE,OAAO;QACb,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EAAE,gDAAgD;QAC7D,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,+CAA+C;QAC5D,SAAS,EAAE,mBAAmB;QAC9B,WAAW,EAAE,EAAE;KAChB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,KAAK,EAAE,gBAAgB;QACvB,WAAW,EAAE,wDAAwD;QACrE,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;IACD;QACE,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,iEAAiE;QAC9E,SAAS,EAAE,QAAQ;QACnB,WAAW,EAAE,kBAAkB;KAChC;CACF,CAAC"}

package/dist/content/forms.d.ts

@@ -1,10 +1,26 @@
 import type { HttpClient } from '../core/http.js';
 import type { FormDefinition, FormFieldTypeDescriptor, FormFieldTypeRegistry, FormListOptions, FormListResult, FormSubmissionResult, RequestOptions, StoreContext } from '../types.js';
 export declare function createFormMethods(http: HttpClient, ctx: StoreContext): {
+    /**
+     * Discover the channel's forms (public projection). Returns summaries —
+     * `fields`/`translations` are empty here; call getForm/getFormBySlug for a
+     * single form's fields.
+     */
     listForms(options?: FormListOptions & RequestOptions): Promise<FormListResult>;
     getForm(id: string, options?: RequestOptions): Promise<FormDefinition>;
+    /** Look up a form by its stable slug instead of its UUID. */
     getFormBySlug(slug: string, options?: RequestOptions): Promise<FormDefinition>;
+    /**
+     * The field-type registry served by GET /forms/field-types. For an offline
+     * copy that needs no round-trip, import the static `FORM_FIELD_TYPES`.
+     */
     getFormFieldTypes(options?: RequestOptions): Promise<FormFieldTypeDescriptor[]>;
+    /**
+     * Field types AND slug rules from the same request. `meta.slugRules` was
+     * added to the endpoint after the SDK shipped, so a CMS that predates it
+     * falls back to the static mirror rather than handing back an undefined
+     * rule an author would then have to guess at.
+     */
     getFormFieldTypeRegistry(options?: RequestOptions): Promise<FormFieldTypeRegistry>;
     submitForm(id: string, values: Record<string, unknown>, options?: RequestOptions): Promise<FormSubmissionResult>;
 };

package/dist/content/forms.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forms.d.ts","sourceRoot":"","sources":["../../src/content/forms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,cAAc,EAEd,oBAAoB,EACpB,cAAc,EACd,YAAY,EACb,MAAM,aAAa,CAAC;AAGrB,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY;wBAmBvC,eAAe,GAAG,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;gBAUlE,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;wBAMlD,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;gCAalD,cAAc,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC;uCAe5C,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;mBASlF,MAAM,UACF,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACrB,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;EAgCnC"}
+{"version":3,"file":"forms.d.ts","sourceRoot":"","sources":["../../src/content/forms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EACV,cAAc,EACd,uBAAuB,EACvB,qBAAqB,EACrB,eAAe,EACf,cAAc,EAEd,oBAAoB,EACpB,cAAc,EACd,YAAY,EACb,MAAM,aAAa,CAAC;AAGrB,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,YAAY;IAcjE;;;;OAIG;wBACuB,eAAe,GAAG,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;gBAUlE,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAK5E,6DAA6D;wBACnC,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IASpF;;;OAGG;gCAC+B,cAAc,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC;IASrF;;;;;OAKG;uCACsC,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;mBASlF,MAAM,UACF,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACrB,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;EAgCnC"}

package/dist/content/forms.js

@@ -13,6 +13,11 @@ export function createFormMethods(http, ctx) {
         };
     }
     return {
+        /**
+         * Discover the channel's forms (public projection). Returns summaries —
+         * `fields`/`translations` are empty here; call getForm/getFormBySlug for a
+         * single form's fields.
+         */
         async listForms(options) {
             const params = {};
             if (options?.limit !== undefined)
@@ -31,19 +36,37 @@ export function createFormMethods(http, ctx) {
             const data = await http.cmsGet(`/forms/${id}`, undefined, options);
             return withSubmitTarget(data.data);
         },
+        /** Look up a form by its stable slug instead of its UUID. */
         async getFormBySlug(slug, options) {
             const data = await http.cmsGet(`/forms/by-slug/${encodeURIComponent(slug)}`, undefined, options);
             return withSubmitTarget(data.data);
         },
+        /**
+         * The field-type registry served by GET /forms/field-types. For an offline
+         * copy that needs no round-trip, import the static `FORM_FIELD_TYPES`.
+         */
         async getFormFieldTypes(options) {
             const data = await http.cmsGet('/forms/field-types', undefined, options);
             return data.data;
         },
+        /**
+         * Field types AND slug rules from the same request. `meta.slugRules` was
+         * added to the endpoint after the SDK shipped, so a CMS that predates it
+         * falls back to the static mirror rather than handing back an undefined
+         * rule an author would then have to guess at.
+         */
         async getFormFieldTypeRegistry(options) {
             const data = await http.cmsGet('/forms/field-types', undefined, options);
             return { fieldTypes: data.data, slugRules: data.meta?.slugRules ?? FORM_SLUG_RULES };
         },
         async submitForm(id, values, options) {
+            // The CMS expects the field values wrapped in `data`, with an optional
+            // locale taken from the store context. On success it returns
+            // { data: { id, created_at } }. A 400 carrying field-level details is a
+            // VALIDATION failure — resolved as { success: false, errors } so
+            // storefronts can render inline field messages without try/catch.
+            // Everything else (429 rate limit with retryAfterSeconds, non-field
+            // 400s, 5xx, transport) still throws.
             const body = { data: values };
             if (ctx.languageCode) {
                 body.locale_code = ctx.languageCode;

package/dist/content/forms.js.map

@@ -1 +1 @@
-{"version":3,"file":"forms.js","sourceRoot":"","sources":["../../src/content/forms.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAY/C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,UAAU,iBAAiB,CAAC,IAAgB,EAAE,GAAiB;IACnE,SAAS,gBAAgB,CAAC,IAAoB;QAC5C,OAAO;YACL,GAAG,IAAI;YACP,SAAS,EAAE,GAAG,GAAG,CAAC,MAAM,UAAU,IAAI,CAAC,EAAE,SAAS;YAClD,YAAY,EAAE,MAAM;YACpB,aAAa,EAAE;gBACb,cAAc,EAAE,kBAAkB;gBAClC,cAAc,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE;aAC/B;SACF,CAAC;IACJ,CAAC;IAED,OAAO;QAML,KAAK,CAAC,SAAS,CAAC,OAA0C;YACxD,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS;gBAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACvE,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS;gBAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC1E,IAAI,OAAO,EAAE,MAAM;gBAAE,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YACpD,IAAI,OAAO,EAAE,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YAC9C,IAAI,OAAO,EAAE,MAAM;gBAAE,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YACpD,OAAO,IAAI,CAAC,MAAM,CAAiB,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,OAAwB;YAChD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAA2B,UAAU,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7F,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QAGD,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,OAAwB;YACxD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAC5B,kBAAkB,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAC5C,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QAMD,KAAK,CAAC,iBAAiB,CAAC,OAAwB;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAC5B,oBAAoB,EACpB,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;QAQD,KAAK,CAAC,wBAAwB,CAAC,OAAwB;YACrD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAG3B,oBAAoB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7C,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,IAAI,eAAe,EAAE,CAAC;QACvF,CAAC;QAED,KAAK,CAAC,UAAU,CACd,EAAU,EACV,MAA+B,EAC/B,OAAwB;YASxB,MAAM,IAAI,GAA4D,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACvF,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;gBACrB,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,YAAY,CAAC;YACtC,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,UAAU,EAAE,SAAS,EACrB,IAAI,EACJ,OAAO,CACR,CAAC;gBACF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAClF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IACE,KAAK,YAAY,eAAe;oBAChC,KAAK,CAAC,UAAU,KAAK,GAAG;oBACxB,KAAK,CAAC,OAAO,KAAK,SAAS;oBAC3B,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EACxB,CAAC;oBACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;gBACnD,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"forms.js","sourceRoot":"","sources":["../../src/content/forms.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAY/C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,UAAU,iBAAiB,CAAC,IAAgB,EAAE,GAAiB;IACnE,SAAS,gBAAgB,CAAC,IAAoB;QAC5C,OAAO;YACL,GAAG,IAAI;YACP,SAAS,EAAE,GAAG,GAAG,CAAC,MAAM,UAAU,IAAI,CAAC,EAAE,SAAS;YAClD,YAAY,EAAE,MAAM;YACpB,aAAa,EAAE;gBACb,cAAc,EAAE,kBAAkB;gBAClC,cAAc,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE;aAC/B;SACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL;;;;WAIG;QACH,KAAK,CAAC,SAAS,CAAC,OAA0C;YACxD,MAAM,MAAM,GAA2B,EAAE,CAAC;YAC1C,IAAI,OAAO,EAAE,KAAK,KAAK,SAAS;gBAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACvE,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS;gBAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAC1E,IAAI,OAAO,EAAE,MAAM;gBAAE,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YACpD,IAAI,OAAO,EAAE,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YAC9C,IAAI,OAAO,EAAE,MAAM;gBAAE,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YACpD,OAAO,IAAI,CAAC,MAAM,CAAiB,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC;QAED,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,OAAwB;YAChD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAA2B,UAAU,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7F,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,6DAA6D;QAC7D,KAAK,CAAC,aAAa,CAAC,IAAY,EAAE,OAAwB;YACxD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAC5B,kBAAkB,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAC5C,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QAED;;;WAGG;QACH,KAAK,CAAC,iBAAiB,CAAC,OAAwB;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAC5B,oBAAoB,EACpB,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;QAED;;;;;WAKG;QACH,KAAK,CAAC,wBAAwB,CAAC,OAAwB;YACrD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAG3B,oBAAoB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7C,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,IAAI,eAAe,EAAE,CAAC;QACvF,CAAC;QAED,KAAK,CAAC,UAAU,CACd,EAAU,EACV,MAA+B,EAC/B,OAAwB;YAExB,uEAAuE;YACvE,6DAA6D;YAC7D,wEAAwE;YACxE,iEAAiE;YACjE,kEAAkE;YAClE,oEAAoE;YACpE,sCAAsC;YACtC,MAAM,IAAI,GAA4D,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YACvF,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;gBACrB,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,YAAY,CAAC;YACtC,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAC/B,UAAU,EAAE,SAAS,EACrB,IAAI,EACJ,OAAO,CACR,CAAC;gBACF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAClF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IACE,KAAK,YAAY,eAAe;oBAChC,KAAK,CAAC,UAAU,KAAK,GAAG;oBACxB,KAAK,CAAC,OAAO,KAAK,SAAS;oBAC3B,KAAK,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EACxB,CAAC;oBACD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;gBACnD,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}