@obelism/content 0.17.0 → 0.18.0

package/dist/index.js

@@ -1,7 +1,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var config = require('./config-ci2hxmas.js');
-var preview = require('./preview-mpwfmnla.js');
+var preview = require('./preview-ijk3ixwb.js');
 
 // A response from the API that wasn't a success. `message` is the API's own
 // `error` text when it sent one.
@@ -266,10 +266,10 @@ const pickImproveVariant = (block, option, fallback)=>{
     return Object.values(variants)[0] ?? [];
 };
 
-const linkHref = (link, { url = (path)=>`/${path}` } = {})=>{
+const linkHref = (link, { url = (path)=>`/${path}`, product = ({ handle })=>`/products/${handle}` } = {})=>{
     if (!link) return null;
     if (link.type === 'entry' && link.entry.path === null) return null;
-    const base = link.type === 'url' ? link.url : url(link.entry.path);
+    const base = link.type === 'url' ? link.url : link.type === 'product' ? product(link.product, link.entry) : url(link.entry.path);
     const hashAt = base.indexOf('#');
     const address = hashAt === -1 ? base : base.slice(0, hashAt);
     const ownHash = hashAt === -1 ? null : base.slice(hashAt + 1);
@@ -509,8 +509,11 @@ const sitemapXml = (entries, { exclude = hidden, ...options })=>{
 exports.DEFAULT_URL = config.DEFAULT_URL;
 exports.ENTRY_ATTRIBUTE = preview.ENTRY_ATTRIBUTE;
 exports.PREVIEW_PARAMS = preview.PREVIEW_PARAMS;
+exports.PRODUCT_ATTRIBUTE = preview.PRODUCT_ATTRIBUTE;
+exports.PRODUCT_HANDLE_ATTRIBUTE = preview.PRODUCT_HANDLE_ATTRIBUTE;
 exports.UID_ATTRIBUTE = preview.UID_ATTRIBUTE;
 exports.editable = preview.editable;
+exports.editableProduct = preview.editableProduct;
 exports.readPreviewParams = preview.readPreviewParams;
 exports.ContentApiError = ContentApiError;
 exports.ContentClient = ContentClient;

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { n as normalizeUrl, a as DEFAULT_TIMEOUT, b as DELIVERY_PATH, D as DEFAULT_URL } from './config-c6qktlz6.mjs';
-export { E as ENTRY_ATTRIBUTE, P as PREVIEW_PARAMS, U as UID_ATTRIBUTE, e as editable, r as readPreviewParams } from './preview-h7rwp06v.mjs';
+export { E as ENTRY_ATTRIBUTE, P as PREVIEW_PARAMS, a as PRODUCT_ATTRIBUTE, b as PRODUCT_HANDLE_ATTRIBUTE, U as UID_ATTRIBUTE, e as editable, c as editableProduct, r as readPreviewParams } from './preview-jcmxxj92.mjs';
 
 // A response from the API that wasn't a success. `message` is the API's own
 // `error` text when it sent one.
@@ -264,10 +264,10 @@ const pickImproveVariant = (block, option, fallback)=>{
     return Object.values(variants)[0] ?? [];
 };
 
-const linkHref = (link, { url = (path)=>`/${path}` } = {})=>{
+const linkHref = (link, { url = (path)=>`/${path}`, product = ({ handle })=>`/products/${handle}` } = {})=>{
     if (!link) return null;
     if (link.type === 'entry' && link.entry.path === null) return null;
-    const base = link.type === 'url' ? link.url : url(link.entry.path);
+    const base = link.type === 'url' ? link.url : link.type === 'product' ? product(link.product, link.entry) : url(link.entry.path);
     const hashAt = base.indexOf('#');
     const address = hashAt === -1 ? base : base.slice(0, hashAt);
     const ownHash = hashAt === -1 ? null : base.slice(hashAt + 1);

package/dist/{preview-mpwfmnla.js → preview-ijk3ixwb.js}

@@ -1,5 +1,7 @@
 const UID_ATTRIBUTE = 'data-cms-uid';
 const ENTRY_ATTRIBUTE = 'data-cms-entry';
+const PRODUCT_ATTRIBUTE = 'data-cms-product';
+const PRODUCT_HANDLE_ATTRIBUTE = 'data-cms-product-handle';
 // The attribute that lets editors select a block on the page, in the visual
 // editor and on the site. Spread it on the block's outermost element:
 //
@@ -22,6 +24,18 @@ const editable = (target)=>{
     }
     return {};
 };
+// The Shopify product a page shows, on a product route: editing on the site
+// then offers "Add a product page" when the page has no product page yet
+// (no `editable(entry)`), and makes one for this product.
+//
+//   <main {...editableProduct(product)} {...editable(page)}>…</main>
+//
+// `product` is the store's (its GID and handle), from the Storefront API or
+// a Shopify field.
+const editableProduct = (product)=>product?.id ? {
+        'data-cms-product': product.id,
+        'data-cms-product-handle': product.handle
+    } : {};
 
 // The visual editor loads the site in an iframe at the environment's preview
 // URL plus the entry's path, with these parameters added. `cms_token` is a
@@ -72,6 +86,9 @@ const readPreviewParams = (input)=>{
 
 exports.ENTRY_ATTRIBUTE = ENTRY_ATTRIBUTE;
 exports.PREVIEW_PARAMS = PREVIEW_PARAMS;
+exports.PRODUCT_ATTRIBUTE = PRODUCT_ATTRIBUTE;
+exports.PRODUCT_HANDLE_ATTRIBUTE = PRODUCT_HANDLE_ATTRIBUTE;
 exports.UID_ATTRIBUTE = UID_ATTRIBUTE;
 exports.editable = editable;
+exports.editableProduct = editableProduct;
 exports.readPreviewParams = readPreviewParams;

package/dist/{preview-h7rwp06v.mjs → preview-jcmxxj92.mjs}

@@ -1,5 +1,7 @@
 const UID_ATTRIBUTE = 'data-cms-uid';
 const ENTRY_ATTRIBUTE = 'data-cms-entry';
+const PRODUCT_ATTRIBUTE = 'data-cms-product';
+const PRODUCT_HANDLE_ATTRIBUTE = 'data-cms-product-handle';
 // The attribute that lets editors select a block on the page, in the visual
 // editor and on the site. Spread it on the block's outermost element:
 //
@@ -22,6 +24,18 @@ const editable = (target)=>{
     }
     return {};
 };
+// The Shopify product a page shows, on a product route: editing on the site
+// then offers "Add a product page" when the page has no product page yet
+// (no `editable(entry)`), and makes one for this product.
+//
+//   <main {...editableProduct(product)} {...editable(page)}>…</main>
+//
+// `product` is the store's (its GID and handle), from the Storefront API or
+// a Shopify field.
+const editableProduct = (product)=>product?.id ? {
+        'data-cms-product': product.id,
+        'data-cms-product-handle': product.handle
+    } : {};
 
 // The visual editor loads the site in an iframe at the environment's preview
 // URL plus the entry's path, with these parameters added. `cms_token` is a
@@ -70,4 +84,4 @@ const readPreviewParams = (input)=>{
     };
 };
 
-export { ENTRY_ATTRIBUTE as E, PREVIEW_PARAMS as P, UID_ATTRIBUTE as U, editable as e, readPreviewParams as r };
+export { ENTRY_ATTRIBUTE as E, PREVIEW_PARAMS as P, UID_ATTRIBUTE as U, PRODUCT_ATTRIBUTE as a, PRODUCT_HANDLE_ATTRIBUTE as b, editableProduct as c, editable as e, readPreviewParams as r };

package/dist/site.js

@@ -94,6 +94,11 @@ const PROXY_ROUTES = [
         method: 'POST',
         pattern: /^entries$/
     },
+    // "Add a product page" on a product the site marks (editableProduct).
+    {
+        method: 'POST',
+        pattern: /^product-pages$/
+    },
     // The one-time address of the CMS's entry form (the prompt box's Form).
     {
         method: 'POST',

package/dist/site.mjs

@@ -92,6 +92,11 @@ const PROXY_ROUTES = [
         method: 'POST',
         pattern: /^entries$/
     },
+    // "Add a product page" on a product the site marks (editableProduct).
+    {
+        method: 'POST',
+        pattern: /^product-pages$/
+    },
     // The one-time address of the CMS's entry form (the prompt box's Form).
     {
         method: 'POST',

package/dist/{types-e5nvgudo.d.ts → types-mtjco3a5.d.ts}

@@ -47,6 +47,12 @@ type Link = {
     url: string;
     query: string | null;
     hash: string | null;
+} | {
+    type: 'product';
+    product: ShopifyItem;
+    entry: LinkTarget | null;
+    query: string | null;
+    hash: string | null;
 };
 type Block<TFields extends Record<string, unknown> = Record<string, unknown>, TType extends string = string> = {
     _uid: string;
@@ -152,6 +158,7 @@ type FieldDefinition = BaseField & ({
 } | {
     type: 'link';
     contentTypes?: string[];
+    products?: boolean;
 } | {
     type: 'blocks';
     allowedBlocks?: string[];
@@ -161,6 +168,7 @@ type FieldDefinition = BaseField & ({
     type: 'shopify';
     resource: 'collection' | 'product';
     multiple?: boolean;
+    unique?: boolean;
     min?: number;
     max?: number;
 } | {
@@ -180,5 +188,5 @@ type ModelFile = {
     contentTypes: ContentTypeDefinition[];
 };
 
-export type { Asset as A, Block as B, ContentTypeDefinition as C, Entry as E, FieldDefinition as F, ImproveBlock as I, Link as L, ModelFile as M, RichTextFormat as R, ShopifyItem as S, RedirectList as a, Redirect as b, EntryList as c, EntryStub as d, RichTextNode as e, ContentTypeKind as f, Environment as g, FieldType as h, LinkTarget as i, RichTextDocument as j, RichTextMark as k };
-//# sourceMappingURL=types-e5nvgudo.d.ts.map
+export type { Asset as A, Block as B, ContentTypeDefinition as C, Entry as E, FieldDefinition as F, ImproveBlock as I, LinkTarget as L, ModelFile as M, RichTextFormat as R, ShopifyItem as S, RedirectList as a, Redirect as b, EntryList as c, Link as d, EntryStub as e, RichTextNode as f, ContentTypeKind as g, Environment as h, FieldType as i, RichTextDocument as j, RichTextMark as k };
+//# sourceMappingURL=types-mtjco3a5.d.ts.map

package/dist/types-mtjco3a5.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-mtjco3a5.d.ts","sources":["../src/types.ts"],"mappings":"AAAA,KAAK,WAAW;AAChB,KAAK,cAAc;AACnB,KAAK,KAAK;AACV;AACA;AACA;AACA;AACA;AACA;AACA;AACA,oBAAoB,MAAM;AAC1B,kBAAkB,MAAM;AACxB;AACA;AACA;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA;AACA;AACA,WAAW,MAAM;AACjB;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS;AACd;AACA;AACA;AACA,KAAK,UAAU;AACf;AACA,oBAAoB,MAAM;AAC1B;AACA;AACA;AACA,KAAK,IAAI;AACT;AACA,WAAW,UAAU;AACrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,aAAa,WAAW;AACxB,WAAW,UAAU;AACrB;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA,KAAK,YAAY,gBAAgB,KAAK,GAAG,KAAK,IAAI,KAAK;AACvD;AACA;AACA,cAAc,MAAM;AACpB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB,cAAc,YAAY;AAC1B;AACA,YAAY,YAAY;AACxB;AACA,KAAK,gBAAgB,GAAG,YAAY;AACpC;AACA;AACA,KAAK,SAAS,gBAAgB,KAAK,GAAG,KAAK;AAC3C;AACA;AACA;AACA;AACA;AACA,KAAK,QAAQ;AACb;AACA;AACA;AACA;AACA,KAAK,YAAY;AACjB,WAAW,QAAQ;AACnB;AACA;AACA;AACA;AACA,KAAK,WAAW;AAChB;AACA;AACA;AACA,KAAK,eAAe;AACpB,KAAK,SAAS;AACd;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,eAAe,GAAG,SAAS;AAChC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS,GAAG,eAAe;AAChC,KAAK,qBAAqB;AAC1B;AACA;AACA,UAAU,eAAe;AACzB;AACA,YAAY,eAAe;AAC3B;AACA,KAAK,SAAS;AACd;AACA;AACA,kBAAkB,qBAAqB;AACvC;;","names":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@obelism/content",
 	"description": "Obelism Content SDK: the delivery API client, the visual editor bridge with prompt editing, editing on your own site, webhook verification, and the content model CLI",
-	"version": "0.17.0",
+	"version": "0.18.0",
 	"keywords": [
 		"cms",
 		"headless-cms",

package/dist/types-e5nvgudo.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types-e5nvgudo.d.ts","sources":["../src/types.ts"],"mappings":"AAAA,KAAK,WAAW;AAChB,KAAK,cAAc;AACnB,KAAK,KAAK;AACV;AACA;AACA;AACA;AACA;AACA;AACA;AACA,oBAAoB,MAAM;AAC1B,kBAAkB,MAAM;AACxB;AACA;AACA;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA;AACA;AACA,WAAW,MAAM;AACjB;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS;AACd;AACA;AACA;AACA,KAAK,UAAU;AACf;AACA,oBAAoB,MAAM;AAC1B;AACA;AACA;AACA,KAAK,IAAI;AACT;AACA,WAAW,UAAU;AACrB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,KAAK,iBAAiB,MAAM,oBAAoB,MAAM;AAC3D;AACA;AACA;AACA,KAAK,YAAY,gBAAgB,KAAK,GAAG,KAAK,IAAI,KAAK;AACvD;AACA;AACA,cAAc,MAAM;AACpB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB;AACA,KAAK,YAAY;AACjB;AACA,YAAY,MAAM;AAClB,cAAc,YAAY;AAC1B;AACA,YAAY,YAAY;AACxB;AACA,KAAK,gBAAgB,GAAG,YAAY;AACpC;AACA;AACA,KAAK,SAAS,gBAAgB,KAAK,GAAG,KAAK;AAC3C;AACA;AACA;AACA;AACA;AACA,KAAK,QAAQ;AACb;AACA;AACA;AACA;AACA,KAAK,YAAY;AACjB,WAAW,QAAQ;AACnB;AACA;AACA;AACA;AACA,KAAK,WAAW;AAChB;AACA;AACA;AACA,KAAK,eAAe;AACpB,KAAK,SAAS;AACd;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,eAAe,GAAG,SAAS;AAChC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,KAAK,SAAS,GAAG,eAAe;AAChC,KAAK,qBAAqB;AAC1B;AACA;AACA,UAAU,eAAe;AACzB;AACA,YAAY,eAAe;AAC3B;AACA,KAAK,SAAS;AACd;AACA;AACA,kBAAkB,qBAAqB;AACvC;;","names":[]}