@obelism/content 0.28.4 → 0.29.0

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { TokenSource } from './oidc.mjs';
-import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, S as ShopifyItem, L as LinkTarget, d as Link, e as EntryStub, f as RichTextNode } from './types-b6jbj3g6.js';
-export { g as AssetProduct, C as ContentTypeAccent, h as ContentTypeDefinition, i as ContentTypeKind, j as Environment, F as FieldCondition, k as FieldDefinition, l as FieldGroup, m as FieldType, n as RichTextDocument, o as RichTextMark } from './types-b6jbj3g6.js';
+import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, S as ShopifyItem, L as LinkTarget, d as Link, e as EntryStub, f as RichTextNode } from './types-mqo1osjh.js';
+export { g as AssetProduct, C as ContentTypeAccent, h as ContentTypeDefinition, i as ContentTypeKind, j as Environment, F as FieldCondition, k as FieldDefinition, l as FieldGroup, m as FieldType, n as RichTextDocument, o as RichTextMark } from './types-mqo1osjh.js';
 
 type ContentClientOptions = {
     token: TokenSource;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { TokenSource } from './oidc.js';
-import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, S as ShopifyItem, L as LinkTarget, d as Link, e as EntryStub, f as RichTextNode } from './types-b6jbj3g6.js';
-export { g as AssetProduct, C as ContentTypeAccent, h as ContentTypeDefinition, i as ContentTypeKind, j as Environment, F as FieldCondition, k as FieldDefinition, l as FieldGroup, m as FieldType, n as RichTextDocument, o as RichTextMark } from './types-b6jbj3g6.js';
+import { R as RichTextFormat, E as Entry, a as RedirectList, b as Redirect, c as EntryList, M as ModelFile, A as Asset, B as Block, I as ImproveBlock, S as ShopifyItem, L as LinkTarget, d as Link, e as EntryStub, f as RichTextNode } from './types-mqo1osjh.js';
+export { g as AssetProduct, C as ContentTypeAccent, h as ContentTypeDefinition, i as ContentTypeKind, j as Environment, F as FieldCondition, k as FieldDefinition, l as FieldGroup, m as FieldType, n as RichTextDocument, o as RichTextMark } from './types-mqo1osjh.js';
 
 type ContentClientOptions = {
     token: TokenSource;

package/dist/index.js

@@ -33,6 +33,9 @@ const fieldParams = (fields)=>Object.fromEntries(Object.entries(fields ?? {}).ma
         ];
     }));
 const trimSlashes = (path)=>path.replace(/^\/+|\/+$/g, '');
+// `/space_…/<environment>`: the part of a scoped delivery path between
+// DELIVERY_PATH and the operation.
+const SCOPE = /^\/space_[^/]+\/[^/]+$/;
 // Reads one space environment's content through the delivery API. The token
 // decides the space, the environment and whether drafts are visible (for a
 // host token, with `drafts`).
@@ -42,11 +45,17 @@ const trimSlashes = (path)=>path.replace(/^\/+|\/+$/g, '');
 class ContentClient {
     #token;
     #place;
+    // Where the API answers this client's token: it sends a token that reads
+    // published content to `/api/delivery/v1/{space}/{environment}/…` with a
+    // 308, so the client asks there directly after the first one. Never used
+    // for a request that reads drafts, which the scoped path refuses.
+    #scope;
     #defaults;
     #timeout;
     #init;
     #fetch;
     constructor({ token, drafts, space, environment, url, locale, depth, richText, timeout, init, fetch: fetchImpl }){
+        this.#scope = null;
         // The page at a path (`blog/hello`), or null when there is none. A site's
         // catch-all route asks for this. The path is looked up in `locale`'s
         // paths (the default locale's when left out or `*`): pages can have a
@@ -171,7 +180,7 @@ class ContentClient {
     }
     // For a 404, null when `notFound` is set, or the body as is for 'body';
     // throws ContentApiError otherwise.
-    async #request(path, query, { init, ...options }, { notFound = false, defaults = true } = {}) {
+    async #request(path, query, { init, ...options }, { notFound = false, defaults = true, scoped = true } = {}) {
         // Checked here rather than in the constructor, so a module creating a
         // client still loads (and a build still runs) without the variable.
         if (!this.#token) throw new Error('ContentClient needs a token');
@@ -190,7 +199,8 @@ class ContentClient {
             if (value !== undefined) params.set(key, String(value));
         }
         const search = params.size > 0 ? `?${params}` : '';
-        const url = `${this.url}${config.DELIVERY_PATH}${path}${search}`;
+        const scope = drafts || !scoped ? null : this.#scope;
+        const url = `${this.url}${config.DELIVERY_PATH}${scope ?? ''}${path}${search}`;
         const merged = {
             ...this.#init,
             ...init
@@ -215,6 +225,21 @@ class ContentClient {
                 timeout
             ]) : timeout
         });
+        // A token that changed, or now reads drafts, is refused on the path
+        // learned for the one before it: ask unscoped once, and learn again.
+        if (scope && (response.status === 401 || response.status === 403)) {
+            if (this.#scope === scope) this.#scope = null;
+            await response.body?.cancel();
+            return this.#request(path, query, {
+                init,
+                ...options
+            }, {
+                notFound,
+                defaults,
+                scoped: false
+            });
+        }
+        if (!scope && !drafts && response.redirected) this.#learnScope(response, path);
         if (notFound === true && response.status === 404) return null;
         const text = await response.text();
         let body = text;
@@ -229,6 +254,18 @@ class ContentClient {
         if (!response.ok) throw new ContentApiError(response.status, url, body);
         return body;
     }
+    #learnScope(response, path) {
+        let redirected;
+        try {
+            redirected = new URL(response.url);
+        } catch  {
+            return;
+        }
+        const { origin, pathname } = redirected;
+        if (origin !== new URL(this.url).origin || !pathname.startsWith(`${config.DELIVERY_PATH}/`) || !pathname.endsWith(path)) return;
+        const scope = pathname.slice(config.DELIVERY_PATH.length, pathname.length - path.length);
+        if (SCOPE.test(scope)) this.#scope = scope;
+    }
 }
 const withoutUndefined = (value)=>Object.fromEntries(Object.entries(value).filter(([, entry])=>entry !== undefined));
 const headersToObject = (headers)=>headers ? Object.fromEntries(new Headers(headers)) : {};
@@ -277,11 +314,14 @@ const isImproveBlock = (block)=>block._type === IMPROVE_BLOCK;
 // improve's SDK returned for the visitor (getTestValue / getFlagValue). It
 // is null when the test or flag isn't active or the visitor isn't in it;
 // then, or for an option the block has no variant for, the `fallback`
-// option's variant, else the first one (usually the control).
+// option's variant, else the first one.
 const pickImproveVariant = (block, option, fallback)=>{
     const variants = block.variants ?? {};
     if (option && variants[option]) return variants[option];
-    if (fallback && variants[fallback]) return variants[fallback];
+    // The arm Improve gives a visitor outside the test, when the caller names
+    // none: it is not always the first variant.
+    const behind = fallback ?? block.fallback;
+    if (behind && variants[behind]) return variants[behind];
     return Object.values(variants)[0] ?? [];
 };
 

package/dist/index.mjs

@@ -31,6 +31,9 @@ const fieldParams = (fields)=>Object.fromEntries(Object.entries(fields ?? {}).ma
         ];
     }));
 const trimSlashes = (path)=>path.replace(/^\/+|\/+$/g, '');
+// `/space_…/<environment>`: the part of a scoped delivery path between
+// DELIVERY_PATH and the operation.
+const SCOPE = /^\/space_[^/]+\/[^/]+$/;
 // Reads one space environment's content through the delivery API. The token
 // decides the space, the environment and whether drafts are visible (for a
 // host token, with `drafts`).
@@ -40,11 +43,17 @@ const trimSlashes = (path)=>path.replace(/^\/+|\/+$/g, '');
 class ContentClient {
     #token;
     #place;
+    // Where the API answers this client's token: it sends a token that reads
+    // published content to `/api/delivery/v1/{space}/{environment}/…` with a
+    // 308, so the client asks there directly after the first one. Never used
+    // for a request that reads drafts, which the scoped path refuses.
+    #scope;
     #defaults;
     #timeout;
     #init;
     #fetch;
     constructor({ token, drafts, space, environment, url, locale, depth, richText, timeout, init, fetch: fetchImpl }){
+        this.#scope = null;
         // The page at a path (`blog/hello`), or null when there is none. A site's
         // catch-all route asks for this. The path is looked up in `locale`'s
         // paths (the default locale's when left out or `*`): pages can have a
@@ -169,7 +178,7 @@ class ContentClient {
     }
     // For a 404, null when `notFound` is set, or the body as is for 'body';
     // throws ContentApiError otherwise.
-    async #request(path, query, { init, ...options }, { notFound = false, defaults = true } = {}) {
+    async #request(path, query, { init, ...options }, { notFound = false, defaults = true, scoped = true } = {}) {
         // Checked here rather than in the constructor, so a module creating a
         // client still loads (and a build still runs) without the variable.
         if (!this.#token) throw new Error('ContentClient needs a token');
@@ -188,7 +197,8 @@ class ContentClient {
             if (value !== undefined) params.set(key, String(value));
         }
         const search = params.size > 0 ? `?${params}` : '';
-        const url = `${this.url}${DELIVERY_PATH}${path}${search}`;
+        const scope = drafts || !scoped ? null : this.#scope;
+        const url = `${this.url}${DELIVERY_PATH}${scope ?? ''}${path}${search}`;
         const merged = {
             ...this.#init,
             ...init
@@ -213,6 +223,21 @@ class ContentClient {
                 timeout
             ]) : timeout
         });
+        // A token that changed, or now reads drafts, is refused on the path
+        // learned for the one before it: ask unscoped once, and learn again.
+        if (scope && (response.status === 401 || response.status === 403)) {
+            if (this.#scope === scope) this.#scope = null;
+            await response.body?.cancel();
+            return this.#request(path, query, {
+                init,
+                ...options
+            }, {
+                notFound,
+                defaults,
+                scoped: false
+            });
+        }
+        if (!scope && !drafts && response.redirected) this.#learnScope(response, path);
         if (notFound === true && response.status === 404) return null;
         const text = await response.text();
         let body = text;
@@ -227,6 +252,18 @@ class ContentClient {
         if (!response.ok) throw new ContentApiError(response.status, url, body);
         return body;
     }
+    #learnScope(response, path) {
+        let redirected;
+        try {
+            redirected = new URL(response.url);
+        } catch  {
+            return;
+        }
+        const { origin, pathname } = redirected;
+        if (origin !== new URL(this.url).origin || !pathname.startsWith(`${DELIVERY_PATH}/`) || !pathname.endsWith(path)) return;
+        const scope = pathname.slice(DELIVERY_PATH.length, pathname.length - path.length);
+        if (SCOPE.test(scope)) this.#scope = scope;
+    }
 }
 const withoutUndefined = (value)=>Object.fromEntries(Object.entries(value).filter(([, entry])=>entry !== undefined));
 const headersToObject = (headers)=>headers ? Object.fromEntries(new Headers(headers)) : {};
@@ -275,11 +312,14 @@ const isImproveBlock = (block)=>block._type === IMPROVE_BLOCK;
 // improve's SDK returned for the visitor (getTestValue / getFlagValue). It
 // is null when the test or flag isn't active or the visitor isn't in it;
 // then, or for an option the block has no variant for, the `fallback`
-// option's variant, else the first one (usually the control).
+// option's variant, else the first one.
 const pickImproveVariant = (block, option, fallback)=>{
     const variants = block.variants ?? {};
     if (option && variants[option]) return variants[option];
-    if (fallback && variants[fallback]) return variants[fallback];
+    // The arm Improve gives a visitor outside the test, when the caller names
+    // none: it is not always the first variant.
+    const behind = fallback ?? block.fallback;
+    if (behind && variants[behind]) return variants[behind];
     return Object.values(variants)[0] ?? [];
 };
 

package/dist/{types-b6jbj3g6.d.ts → types-mqo1osjh.d.ts}

@@ -76,6 +76,7 @@ type Block<TFields extends Record<string, unknown> = Record<string, unknown>, TT
 type ImproveBlock<TBlock extends Block = Block> = Block<{
     kind: 'test' | 'flag';
     slug: string;
+    fallback?: string;
     variants: Record<string, TBlock[]>;
 }, '_improve'>;
 type RichTextMark = {
@@ -226,4 +227,4 @@ type ModelFile = {
 };
 
 export type { Asset as A, Block as B, ContentTypeAccent as C, Entry as E, FieldCondition 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, AssetProduct as g, ContentTypeDefinition as h, ContentTypeKind as i, Environment as j, FieldDefinition as k, FieldGroup as l, FieldType as m, RichTextDocument as n, RichTextMark as o };
-//# sourceMappingURL=types-b6jbj3g6.d.ts.map
+//# sourceMappingURL=types-mqo1osjh.d.ts.map

package/dist/{types-b6jbj3g6.d.ts.map → types-mqo1osjh.d.ts.map}

@@ -1 +1 @@
-{"version":3,"file":"types-b6jbj3g6.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,eAAe,YAAY;AAC3B;AACA,KAAK,YAAY;AACjB;AACA;AACA;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;AACA,gBAAgB,WAAW;AAC3B,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;AACA,iBAAiB,MAAM;AACvB;AACA,WAAW,cAAc;AACzB;AACA,KAAK,cAAc;AACnB;AACA;AACA;AACA;AACA;AACA,KAAK,UAAU;AACf;AACA;AACA;AACA;AACA,KAAK,iBAAiB;AACtB,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;AACA,KAAK,SAAS,GAAG,eAAe;AAChC,KAAK,qBAAqB;AAC1B;AACA;AACA,UAAU,eAAe;AACzB;AACA;AACA,aAAa,iBAAiB;AAC9B;AACA,aAAa,UAAU;AACvB,YAAY,eAAe;AAC3B;AACA,KAAK,SAAS;AACd;AACA;AACA,kBAAkB,qBAAqB;AACvC;;","names":[]}
+{"version":3,"file":"types-mqo1osjh.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,eAAe,YAAY;AAC3B;AACA,KAAK,YAAY;AACjB;AACA;AACA;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;AACA,gBAAgB,WAAW;AAC3B,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;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;AACA,iBAAiB,MAAM;AACvB;AACA,WAAW,cAAc;AACzB;AACA,KAAK,cAAc;AACnB;AACA;AACA;AACA;AACA;AACA,KAAK,UAAU;AACf;AACA;AACA;AACA;AACA,KAAK,iBAAiB;AACtB,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;AACA,KAAK,SAAS,GAAG,eAAe;AAChC,KAAK,qBAAqB;AAC1B;AACA;AACA,UAAU,eAAe;AACzB;AACA;AACA,aAAa,iBAAiB;AAC9B;AACA,aAAa,UAAU;AACvB,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.28.4",
+	"version": "0.29.0",
 	"keywords": [
 		"cms",
 		"headless-cms",