@obelism/content 0.3.0 → 0.5.0

package/README.md

@@ -26,6 +26,15 @@ await content.getEntry('entry_…') //         Entry | null
 await content.getEntries({ contentType: 'post', limit: 20, skip: 0 }) // { items, total, limit, skip }
 for await (const post of content.getAllEntries({ contentType: 'post' })) {
 }
+await content.getFirstEntry({
+	contentType: 'navigation',
+	fields: { key: 'main' },
+}) // Entry | null
+await content.getEntries({
+	contentType: 'post',
+	fields: { category: 'news', 'date[gte]': '2026-01-01', tags: ['a', 'b'] }, // a list: one of them
+	order: '-fields.date',
+})
 await content.getContentModel() //          the model file
 ```
 
@@ -36,12 +45,31 @@ with generics: `content.getPage<Entry<{ title: string }>>('home')`.
 
 ## Preview
 
-The visual editor loads your site with `?cms_preview=1&cms_entry=…&cms_environment=…`.
+The visual editor loads your site with
+`?cms_preview=1&cms_entry=…&cms_environment=…&cms_token=…`. `cms_token` is
+made for the person editing and reads drafts for 8 hours; read the page with
+it, server-side. Never show drafts because `cms_preview` is there: anyone can
+add it to a URL.
 
 ```ts
-import { readPreviewParams } from '@obelism/content'
-
-const client = readPreviewParams(request.url) ? previewClient : deliveryClient
+import {
+	ContentApiError,
+	ContentClient,
+	readPreviewParams,
+} from '@obelism/content'
+
+const preview = readPreviewParams(request.url)
+const content = preview?.token
+	? new ContentClient({ token: preview.token, init: { cache: 'no-store' } })
+	: deliveryClient
+
+const page = await content.getPage(path).catch((error) => {
+	// A made-up or expired token: show what's published.
+	if (error instanceof ContentApiError && error.status === 401) {
+		return deliveryClient.getPage(path)
+	}
+	throw error
+})
 ```
 
 ## Visual editor bridge

package/dist/bin/content.js

@@ -501,7 +501,7 @@ const runInitCommand = async ({ url, token, dir, install: shouldInstall, cwd = p
     log([
         '',
         'Next:',
-        '- Create a delivery token (and a preview token for drafts) in Space settings, and set CONTENT_DELIVERY_TOKEN and CONTENT_PREVIEW_TOKEN.',
+        '- Create a delivery token in Space settings and set CONTENT_DELIVERY_TOKEN (a preview token only if the site builds from drafts; the visual editor brings its own, as cms_token).',
         '- Fetch content with ContentClient from @obelism/content; the examples show what each type looks like.',
         ...improve.enabled ? [
             "- Render _improve blocks: ask improve's SDK for the visitor's option (getTestValue / getFlagValue with the block's slug) and render pickImproveVariant(block, option)."

package/dist/bridge.global.js

@@ -1,4 +1,4 @@
-!/*! Obelism Content bridge (@obelism/content), MIT. https://content.obelism.studio/docs/visual-editor */function(){"use strict";var e;let t="data-cms-uid",r="data-cms-entry",n="cms_environment",o="#d58a1f",a=(e="")=>`${e}[${t}]{cursor:pointer;transition:outline-color .15s}${e}[${t}]:hover{outline:2px dashed ${o};outline-offset:2px}${e}[${t}][data-cms-selected]{outline:2px solid ${o};outline-offset:2px}`,i={features:[],selectedUid:null,prompting:!1,canUndo:!1,unsaved:!1,saving:!1,publishing:!1,selecting:!1},s=()=>{let e={update:new Set,saved:new Set,published:new Set,change:new Set};return{listeners:e,on:(t,r)=>(e[t].add(r),()=>{e[t].delete(r)}),emit(t,r){for(let n of e[t])try{n(r)}catch(e){console.error("[@obelism/content bridge]",e)}}}},l=()=>Promise.reject(Error("Save and publish in the visual editor itself")),d={prompt:()=>Promise.reject(Error("Prompts only work inside the visual editor")),createPage:()=>Promise.reject(Error("New pages are made on the site itself")),undo:()=>{},save:l,publish:l,signOut:()=>{},select:()=>{},setSelecting:()=>{}},c=e=>`[${t}="${e.replace(/["\\]/g,"\\$&")}"]`,p=(e,t)=>{let r=s();e.on("saved",()=>r.emit("saved",{})),e.on("published",()=>r.emit("published",{}));let o=!1;return{isEditing:e.isEditing,mode:e.isEditing?"editor":null,entryId:e.entryId,environment:t.get(n),on:(t,n)=>("update"!==t||o||(o=!0,e.on("update",e=>{let t=e?.entry;t&&r.emit("update",{entry:t,selectedUid:null})})),r.on(t,n)),getState:()=>i,...d,destroy:()=>{}}},g={open:"Edit with a prompt",placeholder:"Describe a change, e.g. “make the heading shorter”",send:"Apply",undo:"Undo",close:"Close",scopeEntry:"Whole page",scopeBlock:"Selected block",clearBlock:"Edit the whole page instead",working:"Working on it…",save:"Save",publish:"Publish",saving:"Saving…",publishing:"Publishing…",saved:"Saved as a draft",published:"Published",unsaved:"Unsaved changes",signOut:"Exit editing",viewingDrafts:"Viewing drafts",selectHint:"Click a block to change only that block",newPage:"New page",newPageCancel:"Edit this page instead",newPagePlaceholder:"Describe the new page, e.g. “a pricing page for agencies”",path:"Path",pathPlaceholder:"/pricing",creating:"Writing the page…",created:"Opening the new page…"},u={page:'<path d="M15 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7Z"/><path d="M14 2v4a2 2 0 0 0 2 2h4"/>',newPage:'<path d="M15 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7Z"/><path d="M14 2v4a2 2 0 0 0 2 2h4"/><path d="M9 15h6"/><path d="M12 18v-6"/>',block:'<rect width="18" height="18" x="3" y="3" rx="2"/><path d="M7 8h10"/><path d="M7 12h6"/>',undo:'<path d="M9 14 4 9l5-5"/><path d="M4 9h10.5a5.5 5.5 0 0 1 0 11H11"/>',close:'<path d="M18 6 6 18"/><path d="m6 6 12 12"/>',send:'<path d="M3.714 3.048a.498.498 0 0 0-.683.627l2.843 7.627a2 2 0 0 1 0 1.396l-2.842 7.627a.498.498 0 0 0 .682.627l18-8.5a.5.5 0 0 0 0-.904z"/><path d="M6 12h16"/>'},h=`
+!/*! Obelism Content bridge (@obelism/content), MIT. https://content.obelism.studio/docs/guides/visual-editor */function(){"use strict";var e;let t="data-cms-uid",r="data-cms-entry",n="cms_environment",o="#d58a1f",a=(e="")=>`${e}[${t}]{cursor:pointer;transition:outline-color .15s}${e}[${t}]:hover{outline:2px dashed ${o};outline-offset:2px}${e}[${t}][data-cms-selected]{outline:2px solid ${o};outline-offset:2px}`,i={features:[],selectedUid:null,prompting:!1,canUndo:!1,unsaved:!1,saving:!1,publishing:!1,selecting:!1},s=()=>{let e={update:new Set,saved:new Set,published:new Set,change:new Set};return{listeners:e,on:(t,r)=>(e[t].add(r),()=>{e[t].delete(r)}),emit(t,r){for(let n of e[t])try{n(r)}catch(e){console.error("[@obelism/content bridge]",e)}}}},l=()=>Promise.reject(Error("Save and publish in the visual editor itself")),d={prompt:()=>Promise.reject(Error("Prompts only work inside the visual editor")),createPage:()=>Promise.reject(Error("New pages are made on the site itself")),undo:()=>{},save:l,publish:l,signOut:()=>{},select:()=>{},setSelecting:()=>{}},c=e=>`[${t}="${e.replace(/["\\]/g,"\\$&")}"]`,p=(e,t)=>{let r=s();e.on("saved",()=>r.emit("saved",{})),e.on("published",()=>r.emit("published",{}));let o=!1;return{isEditing:e.isEditing,mode:e.isEditing?"editor":null,entryId:e.entryId,environment:t.get(n),on:(t,n)=>("update"!==t||o||(o=!0,e.on("update",e=>{let t=e?.entry;t&&r.emit("update",{entry:t,selectedUid:null})})),r.on(t,n)),getState:()=>i,...d,destroy:()=>{}}},g={open:"Edit with a prompt",placeholder:"Describe a change, e.g. “make the heading shorter”",send:"Apply",undo:"Undo",close:"Close",scopeEntry:"Whole page",scopeBlock:"Selected block",clearBlock:"Edit the whole page instead",working:"Working on it…",save:"Save",publish:"Publish",saving:"Saving…",publishing:"Publishing…",saved:"Saved as a draft",published:"Published",unsaved:"Unsaved changes",signOut:"Exit editing",viewingDrafts:"Viewing drafts",selectHint:"Click a block to change only that block",newPage:"New page",newPageCancel:"Edit this page instead",newPagePlaceholder:"Describe the new page, e.g. “a pricing page for agencies”",path:"Path",pathPlaceholder:"/pricing",creating:"Writing the page…",created:"Opening the new page…"},u={page:'<path d="M15 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7Z"/><path d="M14 2v4a2 2 0 0 0 2 2h4"/>',newPage:'<path d="M15 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7Z"/><path d="M14 2v4a2 2 0 0 0 2 2h4"/><path d="M9 15h6"/><path d="M12 18v-6"/>',block:'<rect width="18" height="18" x="3" y="3" rx="2"/><path d="M7 8h10"/><path d="M7 12h6"/>',undo:'<path d="M9 14 4 9l5-5"/><path d="M4 9h10.5a5.5 5.5 0 0 1 0 11H11"/>',close:'<path d="M18 6 6 18"/><path d="m6 6 12 12"/>',send:'<path d="M3.714 3.048a.498.498 0 0 0-.683.627l2.843 7.627a2 2 0 0 1 0 1.396l-2.842 7.627a.498.498 0 0 0 .682.627l18-8.5a.5.5 0 0 0 0-.904z"/><path d="M6 12h16"/>'},h=`
 :host { all: initial; }
 * { box-sizing: border-box; font: inherit; color: inherit; margin: 0; }
 .root {

package/dist/bridge.js

@@ -1,6 +1,6 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var preview = require('./preview-by8d54dt.js');
+var preview = require('./preview-mpwfmnla.js');
 var site = require('./site.js');
 var config = require('./config-ci2hxmas.js');
 

package/dist/bridge.mjs

@@ -1,4 +1,4 @@
-import { P as PREVIEW_PARAMS, U as UID_ATTRIBUTE, E as ENTRY_ATTRIBUTE } from './preview-kvotryzw.mjs';
+import { P as PREVIEW_PARAMS, U as UID_ATTRIBUTE, E as ENTRY_ATTRIBUTE } from './preview-h7rwp06v.mjs';
 import { SITE_EDITING_COOKIE, SITE_REQUEST_HEADER } from './site.mjs';
 import { n as normalizeUrl, D as DEFAULT_URL } from './config-c6qktlz6.mjs';
 

package/dist/index.d.mts

@@ -17,9 +17,12 @@ type RequestOptions = {
     richText?: RichTextFormat | undefined;
     init?: RequestInit | undefined;
 };
+type FieldFilterValue = string | number | boolean;
 type EntriesQuery = RequestOptions & {
     contentType?: string | undefined;
     parentPath?: string | undefined;
+    fields?: Record<string, FieldFilterValue | readonly FieldFilterValue[]> | undefined;
+    order?: string | undefined;
     limit?: number | undefined;
     skip?: number | undefined;
 };
@@ -29,7 +32,8 @@ declare class ContentClient {
     constructor({ token, url, locale, depth, richText, timeout, init, fetch: fetchImpl, }: ContentClientOptions);
     getPage: <TEntry extends Entry = Entry>(path: string, options?: RequestOptions) => Promise<TEntry | null>;
     getEntry: <TEntry extends Entry = Entry>(id: string, options?: RequestOptions) => Promise<TEntry | null>;
-    getEntries: <TEntry extends Entry = Entry>({ contentType, parentPath, limit, skip, ...options }?: EntriesQuery) => Promise<EntryList<TEntry>>;
+    getEntries: <TEntry extends Entry = Entry>({ contentType, parentPath, fields, order, limit, skip, ...options }?: EntriesQuery) => Promise<EntryList<TEntry>>;
+    getFirstEntry: <TEntry extends Entry = Entry>(query?: Omit<EntriesQuery, "limit" | "skip">) => Promise<TEntry | null>;
     getAllEntries<TEntry extends Entry = Entry>(query?: Omit<EntriesQuery, 'skip'>): AsyncGenerator<TEntry, void, undefined>;
     getContentModel: (options?: Pick<RequestOptions, "init">) => Promise<ModelFile>;
 }
@@ -74,10 +78,12 @@ declare const PREVIEW_PARAMS: {
     readonly preview: "cms_preview";
     readonly entry: "cms_entry";
     readonly environment: "cms_environment";
+    readonly token: "cms_token";
 };
 type PreviewParams = {
     entryId: string | null;
     environment: string | null;
+    token: string | null;
 };
 type SearchParamsInput = URL | URLSearchParams | string | Record<string, string | string[] | undefined>;
 declare const readPreviewParams: (input: SearchParamsInput) => PreviewParams | null;

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sources":["../src/client.ts","../src/config.ts","../src/editable.ts","../src/errors.ts","../src/images.ts","../src/improve.ts","../src/preview.ts","../src/richText.ts"],"mappings":";;;AACA,KAAK,oBAAoB;AACzB;AACA;AACA;AACA;AACA,eAAe,cAAc;AAC7B;AACA,WAAW,WAAW;AACtB,mBAAmB,KAAK;AACxB;AACA,KAAK,cAAc;AACnB;AACA;AACA,eAAe,cAAc;AAC7B,WAAW,WAAW;AACtB;AACA,KAAK,YAAY,GAAG,cAAc;AAClC;AACA;AACA;AACA;AACA;AACA,cAAc,aAAa;AAC3B;AACA;AACA,2FAA2F,oBAAoB;AAC/G,6BAA6B,KAAK,GAAG,KAAK,0BAA0B,cAAc,KAAK,OAAO;AAC9F,8BAA8B,KAAK,GAAG,KAAK,wBAAwB,cAAc,KAAK,OAAO;AAC7F,gCAAgC,KAAK,GAAG,KAAK,yDAAyD,YAAY,KAAK,OAAO,CAAC,SAAS;AACxI,iCAAiC,KAAK,GAAG,KAAK,UAAU,IAAI,CAAC,YAAY,YAAY,cAAc;AACnG,gCAAgC,IAAI,CAAC,cAAc,cAAc,OAAO,CAAC,SAAS;AAClF;;AChCA,cAAc,WAAW;;ACAzB,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,KAAK,QAAQ;AACb;AACA;AACA;AACA,cAAc,QAAQ;AACtB;AACA;AACA;AACA;AACA,yBAAyB,QAAQ;;ACXjC,cAAc,eAAe,SAAS,KAAK;AAC3C;AACA;AACA;AACA;AACA;;ACJA,KAAK,cAAc;AACnB;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,QAAQ,UAAU,IAAI,CAAC,KAAK,+BAA+B,cAAc;AACvF,cAAc,WAAW,UAAU,IAAI,CAAC,KAAK,iDAAiD,IAAI,CAAC,cAAc;;ACRjH,cAAc,aAAa;AAC3B,cAAc,cAAc,UAAU,KAAK,cAAc,YAAY;AACrE,cAAc,kBAAkB,kBAAkB,KAAK,SAAS,YAAY;;ACH5E,cAAc,cAAc;AAC5B;AACA;AACA;AACA;AACA,KAAK,aAAa;AAClB;AACA;AACA;AACA,KAAK,iBAAiB,GAAG,GAAG,GAAG,eAAe,YAAY,MAAM;AAChE,cAAc,iBAAiB,UAAU,iBAAiB,KAAK,aAAa;;ACT5E,cAAc,SAAS,EAAE,MAAM;AAC/B,cAAc,UAAU;AACxB,KAAK,mBAAmB;AACxB,0BAA0B,KAAK,GAAG,SAAS,QAAQ,YAAY;AAC/D,0BAA0B,KAAK,QAAQ,YAAY;AACnD;AACA,cAAc,cAAc,QAAQ,YAAY,oDAAoD,mBAAmB;AACvH,cAAc,YAAY,SAAS,YAAY;AAC/C,cAAc,mBAAmB,QAAQ,YAAY;;","names":[]}
+{"version":3,"file":"index.d.mts","sources":["../src/client.ts","../src/config.ts","../src/editable.ts","../src/errors.ts","../src/images.ts","../src/improve.ts","../src/preview.ts","../src/richText.ts"],"mappings":";;;AACA,KAAK,oBAAoB;AACzB;AACA;AACA;AACA;AACA,eAAe,cAAc;AAC7B;AACA,WAAW,WAAW;AACtB,mBAAmB,KAAK;AACxB;AACA,KAAK,cAAc;AACnB;AACA;AACA,eAAe,cAAc;AAC7B,WAAW,WAAW;AACtB;AACA,KAAK,gBAAgB;AACrB,KAAK,YAAY,GAAG,cAAc;AAClC;AACA;AACA,aAAa,MAAM,SAAS,gBAAgB,YAAY,gBAAgB;AACxE;AACA;AACA;AACA;AACA,cAAc,aAAa;AAC3B;AACA;AACA,2FAA2F,oBAAoB;AAC/G,6BAA6B,KAAK,GAAG,KAAK,0BAA0B,cAAc,KAAK,OAAO;AAC9F,8BAA8B,KAAK,GAAG,KAAK,wBAAwB,cAAc,KAAK,OAAO;AAC7F,gCAAgC,KAAK,GAAG,KAAK,wEAAwE,YAAY,KAAK,OAAO,CAAC,SAAS;AACvJ,mCAAmC,KAAK,GAAG,KAAK,UAAU,IAAI,CAAC,YAAY,wBAAwB,OAAO;AAC1G,iCAAiC,KAAK,GAAG,KAAK,UAAU,IAAI,CAAC,YAAY,YAAY,cAAc;AACnG,gCAAgC,IAAI,CAAC,cAAc,cAAc,OAAO,CAAC,SAAS;AAClF;;ACpCA,cAAc,WAAW;;ACAzB,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,KAAK,QAAQ;AACb;AACA;AACA;AACA,cAAc,QAAQ;AACtB;AACA;AACA;AACA;AACA,yBAAyB,QAAQ;;ACXjC,cAAc,eAAe,SAAS,KAAK;AAC3C;AACA;AACA;AACA;AACA;;ACJA,KAAK,cAAc;AACnB;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,QAAQ,UAAU,IAAI,CAAC,KAAK,+BAA+B,cAAc;AACvF,cAAc,WAAW,UAAU,IAAI,CAAC,KAAK,iDAAiD,IAAI,CAAC,cAAc;;ACRjH,cAAc,aAAa;AAC3B,cAAc,cAAc,UAAU,KAAK,cAAc,YAAY;AACrE,cAAc,kBAAkB,kBAAkB,KAAK,SAAS,YAAY;;ACH5E,cAAc,cAAc;AAC5B;AACA;AACA;AACA;AACA;AACA,KAAK,aAAa;AAClB;AACA;AACA;AACA;AACA,KAAK,iBAAiB,GAAG,GAAG,GAAG,eAAe,YAAY,MAAM;AAChE,cAAc,iBAAiB,UAAU,iBAAiB,KAAK,aAAa;;ACX5E,cAAc,SAAS,EAAE,MAAM;AAC/B,cAAc,UAAU;AACxB,KAAK,mBAAmB;AACxB,0BAA0B,KAAK,GAAG,SAAS,QAAQ,YAAY;AAC/D,0BAA0B,KAAK,QAAQ,YAAY;AACnD;AACA,cAAc,cAAc,QAAQ,YAAY,oDAAoD,mBAAmB;AACvH,cAAc,YAAY,SAAS,YAAY;AAC/C,cAAc,mBAAmB,QAAQ,YAAY;;","names":[]}

package/dist/index.d.ts

@@ -17,9 +17,12 @@ type RequestOptions = {
     richText?: RichTextFormat | undefined;
     init?: RequestInit | undefined;
 };
+type FieldFilterValue = string | number | boolean;
 type EntriesQuery = RequestOptions & {
     contentType?: string | undefined;
     parentPath?: string | undefined;
+    fields?: Record<string, FieldFilterValue | readonly FieldFilterValue[]> | undefined;
+    order?: string | undefined;
     limit?: number | undefined;
     skip?: number | undefined;
 };
@@ -29,7 +32,8 @@ declare class ContentClient {
     constructor({ token, url, locale, depth, richText, timeout, init, fetch: fetchImpl, }: ContentClientOptions);
     getPage: <TEntry extends Entry = Entry>(path: string, options?: RequestOptions) => Promise<TEntry | null>;
     getEntry: <TEntry extends Entry = Entry>(id: string, options?: RequestOptions) => Promise<TEntry | null>;
-    getEntries: <TEntry extends Entry = Entry>({ contentType, parentPath, limit, skip, ...options }?: EntriesQuery) => Promise<EntryList<TEntry>>;
+    getEntries: <TEntry extends Entry = Entry>({ contentType, parentPath, fields, order, limit, skip, ...options }?: EntriesQuery) => Promise<EntryList<TEntry>>;
+    getFirstEntry: <TEntry extends Entry = Entry>(query?: Omit<EntriesQuery, "limit" | "skip">) => Promise<TEntry | null>;
     getAllEntries<TEntry extends Entry = Entry>(query?: Omit<EntriesQuery, 'skip'>): AsyncGenerator<TEntry, void, undefined>;
     getContentModel: (options?: Pick<RequestOptions, "init">) => Promise<ModelFile>;
 }
@@ -74,10 +78,12 @@ declare const PREVIEW_PARAMS: {
     readonly preview: "cms_preview";
     readonly entry: "cms_entry";
     readonly environment: "cms_environment";
+    readonly token: "cms_token";
 };
 type PreviewParams = {
     entryId: string | null;
     environment: string | null;
+    token: string | null;
 };
 type SearchParamsInput = URL | URLSearchParams | string | Record<string, string | string[] | undefined>;
 declare const readPreviewParams: (input: SearchParamsInput) => PreviewParams | null;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sources":["../src/client.ts","../src/config.ts","../src/editable.ts","../src/errors.ts","../src/images.ts","../src/improve.ts","../src/preview.ts","../src/richText.ts"],"mappings":";;;AACA,KAAK,oBAAoB;AACzB;AACA;AACA;AACA;AACA,eAAe,cAAc;AAC7B;AACA,WAAW,WAAW;AACtB,mBAAmB,KAAK;AACxB;AACA,KAAK,cAAc;AACnB;AACA;AACA,eAAe,cAAc;AAC7B,WAAW,WAAW;AACtB;AACA,KAAK,YAAY,GAAG,cAAc;AAClC;AACA;AACA;AACA;AACA;AACA,cAAc,aAAa;AAC3B;AACA;AACA,2FAA2F,oBAAoB;AAC/G,6BAA6B,KAAK,GAAG,KAAK,0BAA0B,cAAc,KAAK,OAAO;AAC9F,8BAA8B,KAAK,GAAG,KAAK,wBAAwB,cAAc,KAAK,OAAO;AAC7F,gCAAgC,KAAK,GAAG,KAAK,yDAAyD,YAAY,KAAK,OAAO,CAAC,SAAS;AACxI,iCAAiC,KAAK,GAAG,KAAK,UAAU,IAAI,CAAC,YAAY,YAAY,cAAc;AACnG,gCAAgC,IAAI,CAAC,cAAc,cAAc,OAAO,CAAC,SAAS;AAClF;;AChCA,cAAc,WAAW;;ACAzB,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,KAAK,QAAQ;AACb;AACA;AACA;AACA,cAAc,QAAQ;AACtB;AACA;AACA;AACA;AACA,yBAAyB,QAAQ;;ACXjC,cAAc,eAAe,SAAS,KAAK;AAC3C;AACA;AACA;AACA;AACA;;ACJA,KAAK,cAAc;AACnB;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,QAAQ,UAAU,IAAI,CAAC,KAAK,+BAA+B,cAAc;AACvF,cAAc,WAAW,UAAU,IAAI,CAAC,KAAK,iDAAiD,IAAI,CAAC,cAAc;;ACRjH,cAAc,aAAa;AAC3B,cAAc,cAAc,UAAU,KAAK,cAAc,YAAY;AACrE,cAAc,kBAAkB,kBAAkB,KAAK,SAAS,YAAY;;ACH5E,cAAc,cAAc;AAC5B;AACA;AACA;AACA;AACA,KAAK,aAAa;AAClB;AACA;AACA;AACA,KAAK,iBAAiB,GAAG,GAAG,GAAG,eAAe,YAAY,MAAM;AAChE,cAAc,iBAAiB,UAAU,iBAAiB,KAAK,aAAa;;ACT5E,cAAc,SAAS,EAAE,MAAM;AAC/B,cAAc,UAAU;AACxB,KAAK,mBAAmB;AACxB,0BAA0B,KAAK,GAAG,SAAS,QAAQ,YAAY;AAC/D,0BAA0B,KAAK,QAAQ,YAAY;AACnD;AACA,cAAc,cAAc,QAAQ,YAAY,oDAAoD,mBAAmB;AACvH,cAAc,YAAY,SAAS,YAAY;AAC/C,cAAc,mBAAmB,QAAQ,YAAY;;","names":[]}
+{"version":3,"file":"index.d.ts","sources":["../src/client.ts","../src/config.ts","../src/editable.ts","../src/errors.ts","../src/images.ts","../src/improve.ts","../src/preview.ts","../src/richText.ts"],"mappings":";;;AACA,KAAK,oBAAoB;AACzB;AACA;AACA;AACA;AACA,eAAe,cAAc;AAC7B;AACA,WAAW,WAAW;AACtB,mBAAmB,KAAK;AACxB;AACA,KAAK,cAAc;AACnB;AACA;AACA,eAAe,cAAc;AAC7B,WAAW,WAAW;AACtB;AACA,KAAK,gBAAgB;AACrB,KAAK,YAAY,GAAG,cAAc;AAClC;AACA;AACA,aAAa,MAAM,SAAS,gBAAgB,YAAY,gBAAgB;AACxE;AACA;AACA;AACA;AACA,cAAc,aAAa;AAC3B;AACA;AACA,2FAA2F,oBAAoB;AAC/G,6BAA6B,KAAK,GAAG,KAAK,0BAA0B,cAAc,KAAK,OAAO;AAC9F,8BAA8B,KAAK,GAAG,KAAK,wBAAwB,cAAc,KAAK,OAAO;AAC7F,gCAAgC,KAAK,GAAG,KAAK,wEAAwE,YAAY,KAAK,OAAO,CAAC,SAAS;AACvJ,mCAAmC,KAAK,GAAG,KAAK,UAAU,IAAI,CAAC,YAAY,wBAAwB,OAAO;AAC1G,iCAAiC,KAAK,GAAG,KAAK,UAAU,IAAI,CAAC,YAAY,YAAY,cAAc;AACnG,gCAAgC,IAAI,CAAC,cAAc,cAAc,OAAO,CAAC,SAAS;AAClF;;ACpCA,cAAc,WAAW;;ACAzB,cAAc,aAAa;AAC3B,cAAc,eAAe;AAC7B,KAAK,QAAQ;AACb;AACA;AACA;AACA,cAAc,QAAQ;AACtB;AACA;AACA;AACA;AACA,yBAAyB,QAAQ;;ACXjC,cAAc,eAAe,SAAS,KAAK;AAC3C;AACA;AACA;AACA;AACA;;ACJA,KAAK,cAAc;AACnB;AACA;AACA;AACA;AACA;AACA;AACA,cAAc,QAAQ,UAAU,IAAI,CAAC,KAAK,+BAA+B,cAAc;AACvF,cAAc,WAAW,UAAU,IAAI,CAAC,KAAK,iDAAiD,IAAI,CAAC,cAAc;;ACRjH,cAAc,aAAa;AAC3B,cAAc,cAAc,UAAU,KAAK,cAAc,YAAY;AACrE,cAAc,kBAAkB,kBAAkB,KAAK,SAAS,YAAY;;ACH5E,cAAc,cAAc;AAC5B;AACA;AACA;AACA;AACA;AACA,KAAK,aAAa;AAClB;AACA;AACA;AACA;AACA,KAAK,iBAAiB,GAAG,GAAG,GAAG,eAAe,YAAY,MAAM;AAChE,cAAc,iBAAiB,UAAU,iBAAiB,KAAK,aAAa;;ACX5E,cAAc,SAAS,EAAE,MAAM;AAC/B,cAAc,UAAU;AACxB,KAAK,mBAAmB;AACxB,0BAA0B,KAAK,GAAG,SAAS,QAAQ,YAAY;AAC/D,0BAA0B,KAAK,QAAQ,YAAY;AACnD;AACA,cAAc,cAAc,QAAQ,YAAY,oDAAoD,mBAAmB;AACvH,cAAc,YAAY,SAAS,YAAY;AAC/C,cAAc,mBAAmB,QAAQ,YAAY;;","names":[]}

package/dist/index.js

@@ -1,7 +1,7 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var config = require('./config-ci2hxmas.js');
-var preview = require('./preview-by8d54dt.js');
+var preview = require('./preview-mpwfmnla.js');
 
 // A response from the API that wasn't a success. `message` is the API's own
 // `error` text when it sent one.
@@ -16,6 +16,18 @@ class ContentApiError extends Error {
     }
 }
 
+// `fields` as the API's `fields.<apiId>[op]` parameters.
+const fieldParams = (fields)=>Object.fromEntries(Object.entries(fields ?? {}).map(([key, value])=>{
+        if (!Array.isArray(value)) return [
+            `fields.${key}`,
+            String(value)
+        ];
+        const name = key.includes('[') ? key : `${key}[in]`;
+        return [
+            `fields.${name}`,
+            value.join(',')
+        ];
+    }));
 const trimSlashes = (path)=>path.replace(/^\/+|\/+$/g, '');
 // Reads one space environment's content through the delivery API. The token
 // decides the space, the environment and whether drafts are visible.
@@ -50,12 +62,22 @@ class ContentClient {
             return result?.entry ?? null;
         };
         // One page of entries, ordered as in the space's tree.
-        this.getEntries = ({ contentType, parentPath, limit, skip, ...options } = {})=>this.#request('/entries', {
+        this.getEntries = ({ contentType, parentPath, fields, order, limit, skip, ...options } = {})=>this.#request('/entries', {
                 contentType,
                 parentPath: parentPath === undefined ? undefined : trimSlashes(parentPath),
+                ...fieldParams(fields),
+                order,
                 limit,
                 skip
             }, options);
+        // The first entry matching the query, or null: a settings entry, or a
+        // navigation by its key, without its id.
+        //
+        //   await content.getFirstEntry({ contentType: 'navigation', fields: { key: 'main' } })
+        this.getFirstEntry = async (query = {})=>(await this.getEntries({
+                ...query,
+                limit: 1
+            })).items[0] ?? null;
         // The environment's content model, e.g. to generate types in a build.
         this.getContentModel = (options = {})=>this.#request('/content-model', {}, options, {
                 defaults: false

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-kvotryzw.mjs';
+export { E as ENTRY_ATTRIBUTE, P as PREVIEW_PARAMS, U as UID_ATTRIBUTE, e as editable, r as readPreviewParams } from './preview-h7rwp06v.mjs';
 
 // A response from the API that wasn't a success. `message` is the API's own
 // `error` text when it sent one.
@@ -14,6 +14,18 @@ class ContentApiError extends Error {
     }
 }
 
+// `fields` as the API's `fields.<apiId>[op]` parameters.
+const fieldParams = (fields)=>Object.fromEntries(Object.entries(fields ?? {}).map(([key, value])=>{
+        if (!Array.isArray(value)) return [
+            `fields.${key}`,
+            String(value)
+        ];
+        const name = key.includes('[') ? key : `${key}[in]`;
+        return [
+            `fields.${name}`,
+            value.join(',')
+        ];
+    }));
 const trimSlashes = (path)=>path.replace(/^\/+|\/+$/g, '');
 // Reads one space environment's content through the delivery API. The token
 // decides the space, the environment and whether drafts are visible.
@@ -48,12 +60,22 @@ class ContentClient {
             return result?.entry ?? null;
         };
         // One page of entries, ordered as in the space's tree.
-        this.getEntries = ({ contentType, parentPath, limit, skip, ...options } = {})=>this.#request('/entries', {
+        this.getEntries = ({ contentType, parentPath, fields, order, limit, skip, ...options } = {})=>this.#request('/entries', {
                 contentType,
                 parentPath: parentPath === undefined ? undefined : trimSlashes(parentPath),
+                ...fieldParams(fields),
+                order,
                 limit,
                 skip
             }, options);
+        // The first entry matching the query, or null: a settings entry, or a
+        // navigation by its key, without its id.
+        //
+        //   await content.getFirstEntry({ contentType: 'navigation', fields: { key: 'main' } })
+        this.getFirstEntry = async (query = {})=>(await this.getEntries({
+                ...query,
+                limit: 1
+            })).items[0] ?? null;
         // The environment's content model, e.g. to generate types in a build.
         this.getContentModel = (options = {})=>this.#request('/content-model', {}, options, {
                 defaults: false

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

@@ -24,12 +24,15 @@ const editable = (target)=>{
 };
 
 // The visual editor loads the site in an iframe at the environment's preview
-// URL plus the entry's path, with these parameters added. A request carrying
-// `cms_preview` should be answered with drafts: fetch with a preview token.
+// URL plus the entry's path, with these parameters added. `cms_token` is a
+// token the CMS made for the person editing (`cms_v_…`): it reads drafts
+// through the delivery API for 8 hours. Read drafts with it, never because
+// `cms_preview` is there: anyone can add that to a URL.
 const PREVIEW_PARAMS = {
     preview: 'cms_preview',
     entry: 'cms_entry',
-    environment: 'cms_environment'
+    environment: 'cms_environment',
+    token: 'cms_token'
 };
 const toSearchParams = (input)=>{
     if (input instanceof URL) return input.searchParams;
@@ -51,13 +54,19 @@ const toSearchParams = (input)=>{
 // The editor's parameters when this is a preview request, else null.
 //
 //   const preview = readPreviewParams(request.url)
-//   const content = preview ? previewClient : deliveryClient
+//   const content = preview?.token
+//   	? new ContentClient({ token: preview.token, init: { cache: 'no-store' } })
+//   	: deliveryClient
+//
+// A made-up or expired token makes the client throw a ContentApiError with
+// status 401: answer with `deliveryClient` then.
 const readPreviewParams = (input)=>{
     const params = toSearchParams(input);
     if (!params.has(PREVIEW_PARAMS.preview)) return null;
     return {
         entryId: params.get(PREVIEW_PARAMS.entry),
-        environment: params.get(PREVIEW_PARAMS.environment)
+        environment: params.get(PREVIEW_PARAMS.environment),
+        token: params.get(PREVIEW_PARAMS.token)
     };
 };
 

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

@@ -24,12 +24,15 @@ const editable = (target)=>{
 };
 
 // The visual editor loads the site in an iframe at the environment's preview
-// URL plus the entry's path, with these parameters added. A request carrying
-// `cms_preview` should be answered with drafts: fetch with a preview token.
+// URL plus the entry's path, with these parameters added. `cms_token` is a
+// token the CMS made for the person editing (`cms_v_…`): it reads drafts
+// through the delivery API for 8 hours. Read drafts with it, never because
+// `cms_preview` is there: anyone can add that to a URL.
 const PREVIEW_PARAMS = {
     preview: 'cms_preview',
     entry: 'cms_entry',
-    environment: 'cms_environment'
+    environment: 'cms_environment',
+    token: 'cms_token'
 };
 const toSearchParams = (input)=>{
     if (input instanceof URL) return input.searchParams;
@@ -51,13 +54,19 @@ const toSearchParams = (input)=>{
 // The editor's parameters when this is a preview request, else null.
 //
 //   const preview = readPreviewParams(request.url)
-//   const content = preview ? previewClient : deliveryClient
+//   const content = preview?.token
+//   	? new ContentClient({ token: preview.token, init: { cache: 'no-store' } })
+//   	: deliveryClient
+//
+// A made-up or expired token makes the client throw a ContentApiError with
+// status 401: answer with `deliveryClient` then.
 const readPreviewParams = (input)=>{
     const params = toSearchParams(input);
     if (!params.has(PREVIEW_PARAMS.preview)) return null;
     return {
         entryId: params.get(PREVIEW_PARAMS.entry),
-        environment: params.get(PREVIEW_PARAMS.environment)
+        environment: params.get(PREVIEW_PARAMS.environment),
+        token: params.get(PREVIEW_PARAMS.token)
     };
 };
 

package/dist/site.js

@@ -2,9 +2,9 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var config = require('./config-ci2hxmas.js');
 
-// Editing on your own site, outside the visual editor (the CMS's
-// docs/site-editing.md). One handler serves everything under `/cms` (the
-// `basePath`) on your site:
+// Editing on your own site, outside the visual editor
+// (https://content.obelism.studio/docs/guides/site-editing). One handler
+// serves everything under `/cms` (the `basePath`) on your site:
 //
 // - `/cms/login?return_to=/pricing` — sends the browser to Obelism Content
 //   to sign in, with a PKCE challenge, and…

package/dist/site.mjs

@@ -1,8 +1,8 @@
 import { n as normalizeUrl, a as DEFAULT_TIMEOUT, D as DEFAULT_URL } from './config-c6qktlz6.mjs';
 
-// Editing on your own site, outside the visual editor (the CMS's
-// docs/site-editing.md). One handler serves everything under `/cms` (the
-// `basePath`) on your site:
+// Editing on your own site, outside the visual editor
+// (https://content.obelism.studio/docs/guides/site-editing). One handler
+// serves everything under `/cms` (the `basePath`) on your site:
 //
 // - `/cms/login?return_to=/pricing` — sends the browser to Obelism Content
 //   to sign in, with a PKCE challenge, and…

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, and the content model CLI",
-	"version": "0.3.0",
+	"version": "0.5.0",
 	"keywords": [
 		"cms",
 		"headless-cms",