@payload-onpage/core 0.2.1 → 0.3.1

package/README.md

@@ -2,6 +2,8 @@
 
 Framework-free building blocks: document refs, paths and field operations, the editor session (multi-document, undo, serialized publish/discard), autosave with stale-write detection, invisible field markers, sealing, and the **port interfaces** adapters implement.
 
+![Editing a Payload CMS page in place: click the heading, type, and it autosaves as a draft](https://raw.githubusercontent.com/jellologic/payload-onpage/main/docs/media/edit-text.gif)
+
 ```ts
 import { EditorSession } from '@payload-onpage/core'
 import { payloadRest } from '@payload-onpage/core/payload'
@@ -17,3 +19,5 @@ Entries: `@payload-onpage/core` (logic, ports), `@payload-onpage/core/payload` (
 Part of [**payload-onpage**](https://github.com/jellologic/payload-onpage): on-page editing and draft previews for Payload CMS + Next.js. Start with the [getting started guide](https://github.com/jellologic/payload-onpage/blob/main/docs/getting-started.md).
 
 MIT licensed.
+
+See the **[tour](https://github.com/jellologic/payload-onpage/blob/main/docs/tour.md)** and **[getting started](https://github.com/jellologic/payload-onpage/blob/main/docs/getting-started.md)**.

package/dist/autosave.d.ts

@@ -9,8 +9,8 @@ import type { SaveResult } from './ports.ts';
 export type SaveStatus = 'idle' | 'pending' | 'saving' | 'saved' | 'error' | 'conflict';
 export interface SaveState {
     status: SaveStatus;
-    lastSavedAt?: number;
-    message?: string;
+    lastSavedAt?: number | undefined;
+    message?: string | undefined;
     /** Increments with every successful save. */
     seq: number;
 }

package/dist/autosave.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"autosave.d.ts","sourceRoot":"","sources":["../src/autosave.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAA;AAEvF,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAA;IACpC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAA;IAClD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;CACvC;AAID,qBAAa,aAAa;IAWZ,OAAO,CAAC,QAAQ,CAAC,IAAI;IAVjC,OAAO,CAAC,OAAO,CAAuC;IACtD,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,OAAO,CAAI;IACnB,OAAO,CAAC,KAAK,CAAwC;IACrD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyC;IAClE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA2B;gBAEzB,IAAI,EAAE,eAAe;IAOlD,IAAI,OAAO,IAAI,SAAS,CAEvB;IAED,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,OAAO,CAAC,QAAQ;IAKhB,gFAAgF;IAChF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAOvC,OAAO,CAAC,GAAG;IAQX,kEAAkE;IAC5D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAuD5B,gGAAgG;IAChG,KAAK;IAQL,wDAAwD;IACxD,KAAK;IAML,0FAA0F;IAC1F,OAAO;CAIR"}
+{"version":3,"file":"autosave.d.ts","sourceRoot":"","sources":["../src/autosave.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAG5C,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAA;AAEvF,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAA;IAC7D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAA;IACpC,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,EAAE,EAAE,EAAE,MAAM,KAAK,OAAO,CAAA;IAClD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;CACvC;AAID,qBAAa,aAAa;IAWZ,OAAO,CAAC,QAAQ,CAAC,IAAI;IAVjC,OAAO,CAAC,OAAO,CAAuC;IACtD,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,OAAO,CAAI;IACnB,OAAO,CAAC,KAAK,CAAwC;IACrD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAyC;IAClE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA2B;gBAEzB,IAAI,EAAE,eAAe;IAOlD,IAAI,OAAO,IAAI,SAAS,CAEvB;IAED,IAAI,UAAU,IAAI,OAAO,CAExB;IAED,OAAO,CAAC,QAAQ;IAKhB,gFAAgF;IAChF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAOvC,OAAO,CAAC,GAAG;IAQX,kEAAkE;IAC5D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAuD5B,gGAAgG;IAChG,KAAK;IAQL,wDAAwD;IACxD,KAAK;IAML,0FAA0F;IAC1F,OAAO;CAIR"}

package/dist/autosave.js

@@ -1,3 +1,4 @@
+import { errorText } from "./util.js";
 const isTransient = (status) => !status || status === 429 || status >= 500;
 export class AutosaveQueue {
     opts;
@@ -66,7 +67,7 @@ export class AutosaveQueue {
                 result = await this.opts.send(patch);
             }
             catch (err) {
-                result = { ok: false, status: 0, message: err instanceof Error ? err.message : String(err) };
+                result = { ok: false, status: 0, message: errorText(err) };
             }
             this.inFlight = null;
             if (result.ok) {

package/dist/autosave.js.map

@@ -1 +1 @@
-{"version":3,"file":"autosave.js","sourceRoot":"","sources":["../src/autosave.ts"],"names":[],"mappings":"AA6BA,MAAM,WAAW,GAAG,CAAC,MAA0B,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,IAAI,GAAG,CAAA;AAE9F,MAAM,OAAO,aAAa;IAWK;IAVrB,OAAO,GAAmC,IAAI,CAAA;IAC9C,KAAK,GAAY,IAAI,CAAA;IACrB,QAAQ,GAAyB,IAAI,CAAA;IACrC,OAAO,GAAG,CAAC,CAAA;IACX,KAAK,GAAc,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAA;IACpC,KAAK,CAAQ;IACb,OAAO,CAAQ;IACf,QAAQ,CAAyC;IACjD,UAAU,CAA2B;IAEtD,YAA6B,IAAqB;QAArB,SAAI,GAAJ,IAAI,CAAiB;QAChD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,GAAG,CAAA;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,CAAA;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAkC,CAAC,CAAC,CAAA;IAChG,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAA;IACxD,CAAC;IAEO,QAAQ,CAAC,IAAwB;QACvC,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE,CAAA;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjC,CAAC;IAED,gFAAgF;IAChF,QAAQ,CAAC,KAA8B;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU;YAAE,OAAM;QAC5C,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,CAAA;QACpD,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAA;QAC/D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAEO,GAAG,CAAC,EAAU;QACpB,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;YACjB,KAAK,IAAI,CAAC,KAAK,EAAE,CAAA;QACnB,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;IAED,kEAAkE;IAClE,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,QAAQ,CAAA;YACnB,IAAI,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;YACrC,OAAM;QACR,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU;YAAE,OAAM;QAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAA;QACnC,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,EAAE;YAC1B,IAAI,MAAkB,CAAA;YACtB,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACtC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAA;YAC9F,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;gBAChB,IAAI,CAAC,QAAQ,CAAC;oBACZ,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;oBAC1C,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;oBACvB,OAAO,EAAE,SAAS;oBAClB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;iBACxB,CAAC,CAAA;gBACF,IAAI,IAAI,CAAC,OAAO;oBAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBAC7B,OAAM;YACR,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;gBACnB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;gBAC9D,OAAM;YACR,CAAC;YACD,uDAAuD;YACvD,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAA;YACpD,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC9D,IAAI,CAAC,OAAO,IAAI,CAAC,CAAA;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;gBAC7D,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;gBAChB,IAAI,CAAC,QAAQ,CAAC;oBACZ,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,gBAAgB,MAAM,CAAC,MAAM,GAAG;iBAC5D,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,EAAE,CAAA;QACJ,MAAM,IAAI,CAAC,QAAQ,CAAA;IACrB,CAAC;IAED,gGAAgG;IAChG,KAAK;QACH,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;IACvD,CAAC;IAED,wDAAwD;IACxD,KAAK;QACH,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,OAAO;YAAE,OAAM;QACzC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,CAAC;IAED,0FAA0F;IAC1F,OAAO;QACL,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;CACF"}
+{"version":3,"file":"autosave.js","sourceRoot":"","sources":["../src/autosave.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAsBrC,MAAM,WAAW,GAAG,CAAC,MAA0B,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,IAAI,GAAG,CAAA;AAE9F,MAAM,OAAO,aAAa;IAWK;IAVrB,OAAO,GAAmC,IAAI,CAAA;IAC9C,KAAK,GAAY,IAAI,CAAA;IACrB,QAAQ,GAAyB,IAAI,CAAA;IACrC,OAAO,GAAG,CAAC,CAAA;IACX,KAAK,GAAc,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAA;IACpC,KAAK,CAAQ;IACb,OAAO,CAAQ;IACf,QAAQ,CAAyC;IACjD,UAAU,CAA2B;IAEtD,YAA6B,IAAqB;QAArB,SAAI,GAAJ,IAAI,CAAiB;QAChD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,GAAG,CAAA;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,CAAA;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAA;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,CAAkC,CAAC,CAAC,CAAA;IAChG,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,OAAO,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAA;IACxD,CAAC;IAEO,QAAQ,CAAC,IAAwB;QACvC,IAAI,CAAC,KAAK,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE,CAAA;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjC,CAAC;IAED,gFAAgF;IAChF,QAAQ,CAAC,KAA8B;QACrC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU;YAAE,OAAM;QAC5C,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,CAAA;QACpD,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAA;QAC/D,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC;IAEO,GAAG,CAAC,EAAU;QACpB,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;YACjB,KAAK,IAAI,CAAC,KAAK,EAAE,CAAA;QACnB,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC;IAED,kEAAkE;IAClE,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,QAAQ,CAAA;YACnB,IAAI,IAAI,CAAC,OAAO;gBAAE,OAAO,IAAI,CAAC,KAAK,EAAE,CAAA;YACrC,OAAM;QACR,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,UAAU;YAAE,OAAM;QAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAA;QAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAA;QACnC,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,EAAE;YAC1B,IAAI,MAAkB,CAAA;YACtB,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACtC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAA;YAC5D,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;YACpB,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;gBAChB,IAAI,CAAC,QAAQ,CAAC;oBACZ,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;oBAC1C,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE;oBACvB,OAAO,EAAE,SAAS;oBAClB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;iBACxB,CAAC,CAAA;gBACF,IAAI,IAAI,CAAC,OAAO;oBAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;gBAC7B,OAAM;YACR,CAAC;YACD,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;gBACnB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;gBAC9D,OAAM;YACR,CAAC;YACD,uDAAuD;YACvD,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAA;YACpD,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC9D,IAAI,CAAC,OAAO,IAAI,CAAC,CAAA;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;gBAC7D,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;YAC1C,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;gBAChB,IAAI,CAAC,QAAQ,CAAC;oBACZ,MAAM,EAAE,OAAO;oBACf,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,gBAAgB,MAAM,CAAC,MAAM,GAAG;iBAC5D,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,EAAE,CAAA;QACJ,MAAM,IAAI,CAAC,QAAQ,CAAA;IACrB,CAAC;IAED,gGAAgG;IAChG,KAAK;QACH,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;IACvD,CAAC;IAED,wDAAwD;IACxD,KAAK;QACH,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,OAAO;YAAE,OAAM;QACzC,IAAI,CAAC,OAAO,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IACb,CAAC;IAED,0FAA0F;IAC1F,OAAO;QACL,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACnB,CAAC;CACF"}

package/dist/constants.d.ts

@@ -4,6 +4,20 @@ export declare const DEFAULTS: {
     readonly routePrefix: "/onpage";
     readonly adminRoute: "/admin";
 };
+/** The plugin's endpoints, under `${apiRoute}${routePrefix}`. One list for the plugin and every client. */
+export declare const ROUTES: {
+    readonly schema: "/schema";
+    readonly enter: "/enter";
+    readonly mode: "/mode";
+    readonly exit: "/exit";
+    readonly previewLink: "/preview-link";
+    readonly preview: "/preview";
+};
+/**
+ * The Payload request-context key that asks a read for auto-mapping markers.
+ * `onpageContext()` sets it; the plugin's afterRead hook reads it.
+ */
+export declare const CONTEXT_KEY = "onpage";
 /** Cookies and headers used by the Next.js adapter and its proxy. */
 export declare const COOKIE: {
     /** Editor mode, bound to the signed-in session: `edit|view:<authCookie>:<hash>`. */

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,eAAO,MAAM,QAAQ;;;;CAIX,CAAA;AAEV,qEAAqE;AACrE,eAAO,MAAM,MAAM;IACjB,oFAAoF;;IAEpF,iGAAiG;;IAEjG,mCAAmC;;CAE3B,CAAA;AAEV,eAAO,MAAM,MAAM;IACjB,iFAAiF;;IAEjF,iEAAiE;;IAEjE,8DAA8D;;CAEtD,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,eAAO,MAAM,QAAQ;;;;CAIX,CAAA;AAEV,2GAA2G;AAC3G,eAAO,MAAM,MAAM;;;;;;;CAOT,CAAA;AAEV;;;GAGG;AACH,eAAO,MAAM,WAAW,WAAW,CAAA;AAEnC,qEAAqE;AACrE,eAAO,MAAM,MAAM;IACjB,oFAAoF;;IAEpF,iGAAiG;;IAEjG,mCAAmC;;CAE3B,CAAA;AAEV,eAAO,MAAM,MAAM;IACjB,iFAAiF;;IAEjF,iEAAiE;;IAEjE,8DAA8D;;CAEtD,CAAA"}

package/dist/constants.js

@@ -4,6 +4,20 @@ export const DEFAULTS = {
     routePrefix: '/onpage',
     adminRoute: '/admin',
 };
+/** The plugin's endpoints, under `${apiRoute}${routePrefix}`. One list for the plugin and every client. */
+export const ROUTES = {
+    schema: '/schema',
+    enter: '/enter',
+    mode: '/mode',
+    exit: '/exit',
+    previewLink: '/preview-link',
+    preview: '/preview',
+};
+/**
+ * The Payload request-context key that asks a read for auto-mapping markers.
+ * `onpageContext()` sets it; the plugin's afterRead hook reads it.
+ */
+export const CONTEXT_KEY = 'onpage';
 /** Cookies and headers used by the Next.js adapter and its proxy. */
 export const COOKIE = {
     /** Editor mode, bound to the signed-in session: `edit|view:<authCookie>:<hash>`. */

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,SAAS;IACtB,UAAU,EAAE,QAAQ;CACZ,CAAA;AAEV,qEAAqE;AACrE,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,oFAAoF;IACpF,IAAI,EAAE,QAAQ;IACd,iGAAiG;IACjG,OAAO,EAAE,gBAAgB;IACzB,mCAAmC;IACnC,SAAS,EAAE,oBAAoB;CACvB,CAAA;AAEV,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,iFAAiF;IACjF,IAAI,EAAE,eAAe;IACrB,iEAAiE;IACjE,MAAM,EAAE,iBAAiB;IACzB,8DAA8D;IAC9D,iBAAiB,EAAE,8BAA8B;CACzC,CAAA"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,8EAA8E;AAC9E,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,QAAQ,EAAE,MAAM;IAChB,WAAW,EAAE,SAAS;IACtB,UAAU,EAAE,QAAQ;CACZ,CAAA;AAEV,2GAA2G;AAC3G,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,MAAM,EAAE,SAAS;IACjB,KAAK,EAAE,QAAQ;IACf,IAAI,EAAE,OAAO;IACb,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,eAAe;IAC5B,OAAO,EAAE,UAAU;CACX,CAAA;AAEV;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAA;AAEnC,qEAAqE;AACrE,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,oFAAoF;IACpF,IAAI,EAAE,QAAQ;IACd,iGAAiG;IACjG,OAAO,EAAE,gBAAgB;IACzB,mCAAmC;IACnC,SAAS,EAAE,oBAAoB;CACvB,CAAA;AAEV,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,iFAAiF;IACjF,IAAI,EAAE,eAAe;IACrB,iEAAiE;IACjE,MAAM,EAAE,iBAAiB;IACzB,8DAA8D;IAC9D,iBAAiB,EAAE,8BAA8B;CACzC,CAAA"}

package/dist/docref.d.ts

@@ -11,9 +11,24 @@ export type DocRef = {
     kind: 'global';
     slug: string;
 };
-/** Stable string key: "c:<slug>:<id>" or "g:<slug>". */
-export declare function refKey(ref: DocRef): string;
+/**
+ * A document's stable key: "c:<slug>:<id>" or "g:<slug>". A template-literal
+ * type, so a field path or slug can't be passed where a document key belongs.
+ */
+export type RefKey = `c:${string}:${string}` | `g:${string}`;
+/** A field (or row/list) of one document: "<refKey>|<path>". */
+export type TargetKey = `${RefKey}|${string}`;
+export declare function refKey(ref: DocRef): RefKey;
+/** Is this string a well-formed document key? */
+export declare const isRefKey: (key: string) => key is RefKey;
 export declare function parseRefKey(key: string): DocRef | null;
+/**
+ * A collection ref from an id read as text (a key, a URL, an attribute). Only a
+ * canonical safe integer becomes a number: "007" and ids past 2^53 stay text,
+ * so the document they name is the one that's opened. Servers that know the
+ * collection's id type should decide instead (the plugin does).
+ */
+export declare function collectionRef(slug: string, id: string): DocRef;
 /** Key for one field (or row/list) of one document: "<refKey>|<path>". */
-export declare const targetKey: (ref: DocRef | string, path: string) => string;
+export declare const targetKey: (ref: DocRef | RefKey, path: string) => TargetKey;
 //# sourceMappingURL=docref.d.ts.map

package/dist/docref.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"docref.d.ts","sourceRoot":"","sources":["../src/docref.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAChB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAE9F,wDAAwD;AACxD,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CActD;AAED,0EAA0E;AAC1E,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,GAAG,MAAM,EAAE,MAAM,MAAM,KAAG,MACL,CAAA"}
+{"version":3,"file":"docref.d.ts","sourceRoot":"","sources":["../src/docref.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAChB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAE9F;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG,KAAK,MAAM,IAAI,MAAM,EAAE,GAAG,KAAK,MAAM,EAAE,CAAA;AAE5D,gEAAgE;AAChE,MAAM,MAAM,SAAS,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAA;AAE7C,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED,iDAAiD;AACjD,eAAO,MAAM,QAAQ,GAAI,KAAK,MAAM,KAAG,GAAG,IAAI,MAAmC,CAAA;AAEjF,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAYtD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAG9D;AAED,0EAA0E;AAC1E,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,GAAG,MAAM,EAAE,MAAM,MAAM,KAAG,SACL,CAAA"}

package/dist/docref.js

@@ -1,7 +1,8 @@
-/** Stable string key: "c:<slug>:<id>" or "g:<slug>". */
 export function refKey(ref) {
     return ref.kind === 'global' ? `g:${ref.slug}` : `c:${ref.slug}:${ref.id}`;
 }
+/** Is this string a well-formed document key? */
+export const isRefKey = (key) => parseRefKey(key) !== null;
 export function parseRefKey(key) {
     if (key.startsWith('g:')) {
         const slug = key.slice(2);
@@ -12,12 +13,20 @@ export function parseRefKey(key) {
         const i = rest.indexOf(':');
         if (i <= 0 || i === rest.length - 1)
             return null;
-        const slug = rest.slice(0, i);
-        const raw = rest.slice(i + 1);
-        return { kind: 'collection', slug, id: /^\d+$/.test(raw) ? Number(raw) : raw };
+        return collectionRef(rest.slice(0, i), rest.slice(i + 1));
     }
     return null;
 }
+/**
+ * A collection ref from an id read as text (a key, a URL, an attribute). Only a
+ * canonical safe integer becomes a number: "007" and ids past 2^53 stay text,
+ * so the document they name is the one that's opened. Servers that know the
+ * collection's id type should decide instead (the plugin does).
+ */
+export function collectionRef(slug, id) {
+    const n = Number(id);
+    return { kind: 'collection', slug, id: Number.isSafeInteger(n) && String(n) === id ? n : id };
+}
 /** Key for one field (or row/list) of one document: "<refKey>|<path>". */
 export const targetKey = (ref, path) => `${typeof ref === 'string' ? ref : refKey(ref)}|${path}`;
 //# sourceMappingURL=docref.js.map

package/dist/docref.js.map

@@ -1 +1 @@
-{"version":3,"file":"docref.js","sourceRoot":"","sources":["../src/docref.ts"],"names":[],"mappings":"AAQA,wDAAwD;AACxD,MAAM,UAAU,MAAM,CAAC,GAAW;IAChC,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,EAAE,CAAA;AAC5E,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACzB,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;IAC/C,CAAC;IACD,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,IAAI,CAAA;QAChD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;QAC7B,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IAChF,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,0EAA0E;AAC1E,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAoB,EAAE,IAAY,EAAU,EAAE,CACtE,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAA"}
+{"version":3,"file":"docref.js","sourceRoot":"","sources":["../src/docref.ts"],"names":[],"mappings":"AAiBA,MAAM,UAAU,MAAM,CAAC,GAAW;IAChC,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,EAAE,CAAA;AAC5E,CAAC;AAED,iDAAiD;AACjD,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAiB,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,CAAA;AAEjF,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACzB,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;IAC/C,CAAC;IACD,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACzB,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO,IAAI,CAAA;QAChD,OAAO,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;IAC3D,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAY,EAAE,EAAU;IACpD,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAA;IACpB,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;AAC/F,CAAC;AAED,0EAA0E;AAC1E,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAoB,EAAE,IAAY,EAAa,EAAE,CACzE,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAA"}

package/dist/encode.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Auto-mapping: tag a document's displayable strings with stega
+ * markers (see @payload-onpage/core stega) so the editor can find them on the
+ * page. The plugin runs it on reads that ask for it (`context.onpage`);
+ * client mode runs it on the editor state it renders.
+ *
+ * Tagged: text and textarea values, rich-text text nodes, and the `alt` of
+ * populated uploads (carrying the parent's upload-field path, so `<img alt>`
+ * maps an image). Never tagged: selects, numbers, dates, relationships, JSON,
+ * code, and any field whose name suggests machine use (url, slug, email…).
+ */
+import type { RefKey } from './docref.ts';
 import type { SchemaField } from './schema.ts';
 /**
  * Does this field name suggest a machine value? Matches whole camelCase/snake
@@ -7,11 +19,11 @@ export declare function isMachineFieldName(name: string): boolean;
 export type EncodeFilter = (args: {
     field: SchemaField;
     path: string;
-    ref: string;
+    ref: RefKey;
 }) => boolean;
 /** Return a copy of `doc` with markers on the given (editable) top-level fields. */
-export declare function encodeDocument<T extends Record<string, unknown>>(doc: T, fields: SchemaField[], ref: string, opts?: {
-    only?: string[];
-    filter?: EncodeFilter;
+export declare function encodeDocument<T extends Record<string, unknown>>(doc: T, fields: SchemaField[], ref: RefKey, opts?: {
+    only?: string[] | undefined;
+    filter?: EncodeFilter | undefined;
 }): T;
 //# sourceMappingURL=encode.d.ts.map

package/dist/encode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../src/encode.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AA0B9C;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAIxD;AAKD,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAA;AAwE/F,oFAAoF;AACpF,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,GAAG,EAAE,CAAC,EACN,MAAM,EAAE,WAAW,EAAE,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,YAAY,CAAA;CAAO,GACpD,CAAC,CAGH"}
+{"version":3,"file":"encode.d.ts","sourceRoot":"","sources":["../src/encode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AA2B9C;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAIxD;AAKD,MAAM,MAAM,YAAY,GAAG,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,KAAK,OAAO,CAAA;AA6D/F,oFAAoF;AACpF,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,GAAG,EAAE,CAAC,EACN,MAAM,EAAE,WAAW,EAAE,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAAC,MAAM,CAAC,EAAE,YAAY,GAAG,SAAS,CAAA;CAAO,GAC5E,CAAC,CAIH"}

package/dist/encode.js

@@ -1,17 +1,7 @@
-/**
- * Auto-mapping: tag a document's displayable strings with stega
- * markers (see @payload-onpage/core stega) so the editor can find them on the
- * page. The plugin runs it on reads that ask for it (`context.onpage`);
- * client mode runs it on the editor state it renders.
- *
- * Tagged: text and textarea values, rich-text text nodes, and the `alt` of
- * populated uploads (carrying the parent's upload-field path, so `<img alt>`
- * maps an image). Never tagged: selects, numbers, dates, relationships, JSON,
- * code, and any field whose name suggests machine use (url, slug, email…).
- */
 import { stegaEncode } from "./stega.js";
-import { blockFor } from "./fields.js";
+import { mapFields } from "./fields.js";
 import { mapLexical } from "./lexical.js";
+import { assertNever } from "./util.js";
 /** Name segments that mark a field as holding a machine value (never marked). */
 const MACHINE_WORDS = new Set([
     'url',
@@ -53,57 +43,47 @@ function encodeRichText(value, ctx, path) {
         ? { ...node, text: mark(node.text, ctx, path, 'richtext') }
         : node);
 }
-function encodeValue(value, field, path, ctx) {
-    if (value == null)
-        return value;
-    switch (field.type) {
-        case 'text':
-        case 'textarea':
-            if (typeof value === 'string' && value && allowed(field, path, ctx))
-                return mark(value, ctx, path, field.type === 'textarea' ? 'textarea' : 'text');
-            return value;
-        case 'richText':
-            return allowed(field, path, ctx) ? encodeRichText(value, ctx, path) : value;
-        case 'upload':
-            if (!field.hasMany && value && typeof value === 'object' && !Array.isArray(value)) {
-                const media = value;
-                return {
-                    ...media,
-                    alt: mark(typeof media.alt === 'string' ? media.alt : '', ctx, path, 'media'),
-                };
-            }
-            return value;
-        case 'group':
-            return encodeFields(value, field.fields ?? [], path, ctx);
-        case 'array':
-            return Array.isArray(value)
-                ? value.map((row, i) => encodeFields(row, field.fields ?? [], `${path}.${i}`, ctx))
-                : value;
-        case 'blocks':
-            return Array.isArray(value)
-                ? value.map((row, i) => {
-                    const block = blockFor(field, row);
-                    return block ? encodeFields(row, block.fields, `${path}.${i}`, ctx) : row;
-                })
-                : value;
-        default:
-            return value;
-    }
-}
-function encodeFields(data, fields, prefix, ctx) {
-    if (!data || typeof data !== 'object' || Array.isArray(data))
-        return data;
-    const out = { ...data };
-    for (const f of fields) {
-        if (!(f.name in out))
-            continue;
-        out[f.name] = encodeValue(out[f.name], f, prefix ? `${prefix}.${f.name}` : f.name, ctx);
-    }
-    return out;
-}
+/** What each leaf field kind gets: text and rich text are marked, a populated upload's `alt` carries its path. */
+const encoding = (ctx) => ({
+    leaf: (value, field, path) => {
+        switch (field.type) {
+            case 'text':
+            case 'textarea':
+                return typeof value === 'string' && value && allowed(field, path, ctx)
+                    ? mark(value, ctx, path, field.type)
+                    : value;
+            case 'richText':
+                return allowed(field, path, ctx) ? encodeRichText(value, ctx, path) : value;
+            case 'upload':
+                if (!field.hasMany && value && typeof value === 'object' && !Array.isArray(value)) {
+                    const media = value;
+                    return {
+                        ...media,
+                        alt: mark(typeof media.alt === 'string' ? media.alt : '', ctx, path, 'media'),
+                    };
+                }
+                return value;
+            // Machine values: never marked.
+            case 'email':
+            case 'code':
+            case 'json':
+            case 'checkbox':
+            case 'point':
+            case 'number':
+            case 'date':
+            case 'select':
+            case 'radio':
+            case 'relationship':
+                return value;
+            default:
+                return assertNever(field, 'field type');
+        }
+    },
+});
 /** Return a copy of `doc` with markers on the given (editable) top-level fields. */
 export function encodeDocument(doc, fields, ref, opts = {}) {
-    const scope = opts.only ? fields.filter((f) => opts.only.includes(f.name)) : fields;
-    return encodeFields(doc, scope, '', { ref, filter: opts.filter });
+    const { only } = opts;
+    const scope = only ? fields.filter((f) => only.includes(f.name)) : fields;
+    return mapFields(doc, scope, encoding({ ref, filter: opts.filter }));
 }
 //# sourceMappingURL=encode.js.map

package/dist/encode.js.map

@@ -1 +1 @@
-{"version":3,"file":"encode.js","sourceRoot":"","sources":["../src/encode.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,EAAE,WAAW,EAAe,MAAM,YAAY,CAAA;AAErD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,iFAAiF;AACjF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,KAAK;IACL,OAAO;IACP,QAAQ;IACR,IAAI;IACJ,OAAO;IACP,WAAW;IACX,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,KAAK;CACN,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,IAAI;SACR,KAAK,CAAC,iCAAiC,CAAC;SACxC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;AACpD,CAAC;AAED,yHAAyH;AACzH,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAA;AASvE,MAAM,OAAO,GAAG,CAAC,KAAkB,EAAE,IAAY,EAAE,GAAQ,EAAE,EAAE,CAC7D,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC;IAC/B,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;AAEjE,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,GAAQ,EAAE,IAAY,EAAE,IAAoB,EAAE,EAAE,CAC3E,WAAW,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;AAElD,SAAS,cAAc,CAAC,KAAc,EAAE,GAAQ,EAAE,IAAY;IAC5D,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAChC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI;QAChE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE;QAC3D,CAAC,CAAC,IAAI,CACT,CAAA;AACH,CAAC;AAED,SAAS,WAAW,CAAC,KAAc,EAAE,KAAkB,EAAE,IAAY,EAAE,GAAQ;IAC7E,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAC/B,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,MAAM,CAAC;QACZ,KAAK,UAAU;YACb,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC;gBACjE,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;YAChF,OAAO,KAAK,CAAA;QACd,KAAK,UAAU;YACb,OAAO,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAC7E,KAAK,QAAQ;YACX,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClF,MAAM,KAAK,GAAG,KAAgC,CAAA;gBAC9C,OAAO;oBACL,GAAG,KAAK;oBACR,GAAG,EAAE,IAAI,CAAC,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC;iBAC9E,CAAA;YACH,CAAC;YACD,OAAO,KAAK,CAAA;QACd,KAAK,OAAO;YACV,OAAO,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,CAAA;QAC3D,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACzB,CAAC,CAAE,KAAmB,CAAC,GAAG,CAAC,CAAC,GAAY,EAAE,CAAS,EAAE,EAAE,CACnD,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAC3D;gBACH,CAAC,CAAC,KAAK,CAAA;QACX,KAAK,QAAQ;YACX,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBACzB,CAAC,CAAE,KAAmB,CAAC,GAAG,CAAC,CAAC,GAAY,EAAE,CAAS,EAAE,EAAE;oBACnD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;oBAClC,OAAO,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,IAAI,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;gBAC3E,CAAC,CAAC;gBACJ,CAAC,CAAC,KAAK,CAAA;QACX;YACE,OAAO,KAAK,CAAA;IAChB,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAa,EAAE,MAAqB,EAAE,MAAc,EAAE,GAAQ;IAClF,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAA;IACzE,MAAM,GAAG,GAA4B,EAAE,GAAI,IAAgC,EAAE,CAAA;IAC7E,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC;YAAE,SAAQ;QAC9B,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IACzF,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,oFAAoF;AACpF,MAAM,UAAU,cAAc,CAC5B,GAAM,EACN,MAAqB,EACrB,GAAW,EACX,OAAmD,EAAE;IAErD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;IACpF,OAAO,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAM,CAAA;AACxE,CAAC"}
+{"version":3,"file":"encode.js","sourceRoot":"","sources":["../src/encode.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,WAAW,EAAe,MAAM,YAAY,CAAA;AAErD,OAAO,EAAE,SAAS,EAAqB,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC,iFAAiF;AACjF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,MAAM;IACN,KAAK;IACL,OAAO;IACP,QAAQ;IACR,IAAI;IACJ,OAAO;IACP,WAAW;IACX,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,KAAK;CACN,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,IAAI;SACR,KAAK,CAAC,iCAAiC,CAAC;SACxC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;AACpD,CAAC;AAED,yHAAyH;AACzH,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,CAAA;AASvE,MAAM,OAAO,GAAG,CAAC,KAAkB,EAAE,IAAY,EAAE,GAAQ,EAAE,EAAE,CAC7D,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC;IAC/B,CAAC,CAAC,KAAK,CAAC,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;AAEjE,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,GAAQ,EAAE,IAAY,EAAE,IAAoB,EAAE,EAAE,CAC3E,WAAW,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;AAElD,SAAS,cAAc,CAAC,KAAc,EAAE,GAAQ,EAAE,IAAY;IAC5D,OAAO,UAAU,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAChC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI;QAChE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,EAAE;QAC3D,CAAC,CAAC,IAAI,CACT,CAAA;AACH,CAAC;AAED,kHAAkH;AAClH,MAAM,QAAQ,GAAG,CAAC,GAAQ,EAAgB,EAAE,CAAC,CAAC;IAC5C,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3B,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,MAAM,CAAC;YACZ,KAAK,UAAU;gBACb,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC;oBACpE,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC;oBACpC,CAAC,CAAC,KAAK,CAAA;YACX,KAAK,UAAU;gBACb,OAAO,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;YAC7E,KAAK,QAAQ;gBACX,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAClF,MAAM,KAAK,GAAG,KAAgC,CAAA;oBAC9C,OAAO;wBACL,GAAG,KAAK;wBACR,GAAG,EAAE,IAAI,CAAC,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC;qBAC9E,CAAA;gBACH,CAAC;gBACD,OAAO,KAAK,CAAA;YACd,gCAAgC;YAChC,KAAK,OAAO,CAAC;YACb,KAAK,MAAM,CAAC;YACZ,KAAK,MAAM,CAAC;YACZ,KAAK,UAAU,CAAC;YAChB,KAAK,OAAO,CAAC;YACb,KAAK,QAAQ,CAAC;YACd,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,OAAO,CAAC;YACb,KAAK,cAAc;gBACjB,OAAO,KAAK,CAAA;YACd;gBACE,OAAO,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;CACF,CAAC,CAAA;AAEF,oFAAoF;AACpF,MAAM,UAAU,cAAc,CAC5B,GAAM,EACN,MAAqB,EACrB,GAAW,EACX,OAA2E,EAAE;IAE7E,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;IACrB,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;IACzE,OAAO,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAM,CAAA;AAC3E,CAAC"}

package/dist/fields.d.ts

@@ -4,16 +4,40 @@
  * for saving (populated relations back to ids).
  */
 import { type PathSegment } from './path.ts';
-import type { DocumentSchema, SchemaBlock, SchemaField } from './schema.ts';
+import type { ArrayField, BlocksField, DocumentSchema, GroupField, ListField, SchemaBlock, SchemaField } from './schema.ts';
 export interface FieldAtPath {
     field: SchemaField;
     /** The block whose fields contain this field, when inside a blocks row. */
-    block?: SchemaBlock;
+    block?: SchemaBlock | undefined;
     /** Path of the nearest blocks row ("sections.3"), when inside one. */
-    blockPath?: string;
+    blockPath?: string | undefined;
 }
+type Data = Record<string, unknown>;
 /** The block a blocks-field row uses (by its `blockType`). */
-export declare const blockFor: (field: SchemaField, row: unknown) => SchemaBlock | undefined;
+export declare const blockFor: (field: BlocksField, row: unknown) => SchemaBlock | undefined;
+/** The fields of one row of a list field: the block's fields, or the array's. */
+export declare const rowFieldsOf: (field: ListField, row: unknown) => SchemaField[] | undefined;
+/** A field that holds other fields' data. */
+type Container = GroupField | ArrayField | BlocksField;
+/** Any other field: its value is handled as one unit. */
+export type LeafField = Exclude<SchemaField, Container>;
+export interface FieldVisitor {
+    /** Every field that isn't a group, array or blocks field. Return the value unchanged to keep it. */
+    leaf: (value: unknown, field: LeafField, path: string) => unknown;
+    /** Each array/blocks row (a copy), before its fields are visited: e.g. give it a new id. */
+    row?: (row: Data, path: string) => Data;
+    /** A blocks row with an unknown `blockType`. Default: kept as is. */
+    unknownBlock?: (row: unknown) => unknown;
+}
+/**
+ * Rebuild document data field by field. Groups, array rows and block rows are
+ * walked here, once, for every schema-aware transform (cloning, normalizing for
+ * a save, encoding markers); `visit` only says what to do with leaf fields.
+ * Values of fields missing from `data` stay missing; untouched values are shared.
+ */
+export declare function mapFields(data: unknown, fields: SchemaField[], visit: FieldVisitor, prefix?: string): unknown;
+/** One field's value (see `mapFields`). */
+export declare function mapField(value: unknown, field: SchemaField, visit: FieldVisitor, path: string): unknown;
 /** May the editor change this path? (Its top-level field must be editable.) */
 export declare const isEditablePath: (schema: DocumentSchema, path: string) => boolean;
 export interface RowInfo {
@@ -23,7 +47,7 @@ export interface RowInfo {
     listPath: string;
     index: number;
     length: number;
-    listField: SchemaField;
+    listField: ListField;
     /** Fields of this row: the block's fields, or the array's. */
     rowFields: SchemaField[];
     /** Singular label of one row ("Hero", "Feature"). */
@@ -39,9 +63,9 @@ export declare function resolveRow(schema: DocumentSchema, doc: unknown, path: s
  */
 export declare function fieldAtPath(fields: SchemaField[], doc: unknown, path: string | PathSegment[]): FieldAtPath | null;
 /** Defaults for a set of fields: static `defaultValue`s, nested groups, `minRows` rows. */
-export declare function defaultsFor(fields: SchemaField[]): Record<string, unknown>;
-export declare function newArrayRow(arrayField: SchemaField): Record<string, unknown>;
-export declare function newBlockRow(block: SchemaBlock): Record<string, unknown>;
+export declare function defaultsFor(fields: SchemaField[]): Data;
+export declare function newArrayRow(arrayField: ArrayField): Data;
+export declare function newBlockRow(block: SchemaBlock): Data;
 /**
  * Deep-clone a row (array item or block) giving it, and every nested row, a new
  * id. Ids of related documents (uploads, relationships) are left alone, so a
@@ -50,6 +74,12 @@ export declare function newBlockRow(block: SchemaBlock): Record<string, unknown>
 export declare function cloneRow(row: unknown, rowFields: SchemaField[]): unknown;
 /** The id of a relationship value: a populated doc, `{ relationTo, value }`, or an id. */
 export declare function relationId(v: unknown): string | number | undefined;
+/**
+ * A field value as a list: a hasMany value as its items, a single value as a
+ * one-item list, nothing as []. `item` keeps or converts each entry (return
+ * undefined to drop it).
+ */
+export declare function asList<T = unknown>(value: unknown, many: boolean | undefined, item?: (v: unknown) => T | undefined): T[];
 /** A display title for a relationship value (`titleField` when known, else common title fields, else the id). */
 export declare function relationTitle(v: unknown, titleField?: string): string;
 /**
@@ -69,4 +99,5 @@ export declare function buildPatch(doc: Record<string, unknown>, keys: string[],
 export declare function changedKeys(prev: Record<string, unknown>, next: Record<string, unknown>, keys: string[]): string[];
 /** A scalar value as editable text: strings and numbers as-is; null, undefined and objects as ''. */
 export declare function toText(value: unknown): string;
+export {};
 //# sourceMappingURL=fields.d.ts.map

package/dist/fields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAA8B,KAAK,WAAW,EAAE,MAAM,WAAW,CAAA;AAExE,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAE3E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,WAAW,CAAA;IAClB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,WAAW,CAAA;IACnB,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,8DAA8D;AAC9D,eAAO,MAAM,QAAQ,GAAI,OAAO,WAAW,EAAE,KAAK,OAAO,KAAG,WAAW,GAAG,SACgB,CAAA;AAE1F,+EAA+E;AAC/E,eAAO,MAAM,cAAc,GAAI,QAAQ,cAAc,EAAE,MAAM,MAAM,KAAG,OAClB,CAAA;AAEpD,MAAM,WAAW,OAAO;IACtB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,WAAW,CAAA;IACtB,8DAA8D;IAC9D,SAAS,EAAE,WAAW,EAAE,CAAA;IACxB,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,sHAAsH;AACtH,wBAAgB,UAAU,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAwB7F;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,WAAW,EAAE,EACrB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GAAG,WAAW,EAAE,GAC3B,WAAW,GAAG,IAAI,CA4BpB;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAgB1E;AAED,wBAAgB,WAAW,CAAC,UAAU,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE5E;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEvE;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,CAKxE;AAoBD,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAOlE;AAED,iHAAiH;AACjH,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CASrE;AAiBD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CA4B1E;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAgBzD;AAYD,yEAAyE;AACzE,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5B,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,WAAW,EAAE,GACpB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAOzB;AAED,8EAA8E;AAC9E,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EAAE,GACb,MAAM,EAAE,CAIV;AAED,qGAAqG;AACrG,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAM7C"}
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAA6C,KAAK,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvF,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,cAAc,EACd,UAAU,EACV,SAAS,EAET,WAAW,EACX,WAAW,EACZ,MAAM,aAAa,CAAA;AAIpB,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,WAAW,CAAA;IAClB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;IAC/B,sEAAsE;IACtE,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC/B;AAED,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAKnC,8DAA8D;AAC9D,eAAO,MAAM,QAAQ,GAAI,OAAO,WAAW,EAAE,KAAK,OAAO,KAAG,WAAW,GAAG,SACI,CAAA;AAE9E,iFAAiF;AACjF,eAAO,MAAM,WAAW,GAAI,OAAO,SAAS,EAAE,KAAK,OAAO,KAAG,WAAW,EAAE,GAAG,SACN,CAAA;AAEvE,6CAA6C;AAC7C,KAAK,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,WAAW,CAAA;AACtD,yDAAyD;AACzD,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;AAEvD,MAAM,WAAW,YAAY;IAC3B,oGAAoG;IACpG,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAA;IACjE,4FAA4F;IAC5F,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACvC,qEAAqE;IACrE,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAA;CACzC;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,EACb,MAAM,EAAE,WAAW,EAAE,EACrB,KAAK,EAAE,YAAY,EACnB,MAAM,SAAK,GACV,OAAO,CAOT;AAED,2CAA2C;AAC3C,wBAAgB,QAAQ,CACtB,KAAK,EAAE,OAAO,EACd,KAAK,EAAE,WAAW,EAClB,KAAK,EAAE,YAAY,EACnB,IAAI,EAAE,MAAM,GACX,OAAO,CAmBT;AAED,+EAA+E;AAC/E,eAAO,MAAM,cAAc,GAAI,QAAQ,cAAc,EAAE,MAAM,MAAM,KAAG,OAClB,CAAA;AAEpD,MAAM,WAAW,OAAO;IACtB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,SAAS,CAAA;IACpB,8DAA8D;IAC9D,SAAS,EAAE,WAAW,EAAE,CAAA;IACxB,qDAAqD;IACrD,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,sHAAsH;AACtH,wBAAgB,UAAU,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAsB7F;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,WAAW,EAAE,EACrB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,GAAG,WAAW,EAAE,GAC3B,WAAW,GAAG,IAAI,CAyBpB;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAWvD;AAED,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAExD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI,CAEpD;AASD;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,CAExE;AAED,0FAA0F;AAC1F,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAOlE;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,CAAC,GAAG,OAAO,EAChC,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,OAAO,GAAG,SAAS,EACzB,IAAI,GAAE,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,GAAG,SAAyB,GAClD,CAAC,EAAE,CAML;AAED,iHAAiH;AACjH,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CASrE;AA4CD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO,CAE1E;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAgBzD;AAKD,yEAAyE;AACzE,wBAAgB,UAAU,CACxB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5B,IAAI,EAAE,MAAM,EAAE,EACd,MAAM,EAAE,WAAW,EAAE,GACpB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAOzB;AAED,8EAA8E;AAC9E,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EAAE,GACb,MAAM,EAAE,CAIV;AAED,qGAAqG;AACrG,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAM7C"}