@pilotiq/pilotiq 0.8.2 → 0.10.0

package/dist/react/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAA;AAC5D,OAAO,EACL,yBAAyB,EACzB,oBAAoB,EACpB,UAAU,GAEX,MAAM,mBAAmB,CAAA;AAE1B,OAAO,EACL,cAAc,EAEd,UAAU,GAEX,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAA2B,MAAM,eAAe,CAAA;AAChG,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAA4B,MAAM,6BAA6B,CAAA;AACjH,OAAO,EACL,gCAAgC,EAChC,2BAA2B,GAE5B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACrB,6BAA6B,GAI9B,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,gCAAgC,EAChC,2BAA2B,GAE5B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EACL,iBAAiB,EACjB,aAAa,GAEd,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GAGpB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,yBAAyB,EACzB,oBAAoB,GAIrB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,GAE1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,GAGtB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,GAEjB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,iBAAiB,GAElB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,kBAAkB,EAA2B,MAAM,yBAAyB,CAAA;AACrF,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAElB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,YAAY,GAIb,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAE7D,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAA;AAE9E,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAExD,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,GAId,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,GAEvB,MAAM,2BAA2B,CAAA;AAElC,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,uBAAuB,GAGxB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,YAAY,GAEb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAY,oBAAoB,CAAA;AACxD,OAAO,EACL,iBAAiB,EACjB,eAAe,GAGhB,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAW,gBAAgB,CAAA;AAE/C,OAAO,EACL,eAAe,GAKhB,MAAM,sBAAsB,CAAA;AAG7B,iHAAiH;AACjH,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAElD,mBAAmB;AACnB,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAyC,MAAM,eAAe,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAsB,MAAM,eAAe,CAAA;AAC5D,OAAO,EACL,yBAAyB,EACzB,oBAAoB,EACpB,UAAU,GAEX,MAAM,mBAAmB,CAAA;AAE1B,OAAO,EACL,cAAc,EAEd,UAAU,GAEX,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAA2B,MAAM,eAAe,CAAA;AAChG,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAA4B,MAAM,6BAA6B,CAAA;AACjH,OAAO,EACL,gCAAgC,EAChC,2BAA2B,GAE5B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACrB,6BAA6B,GAI9B,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,gCAAgC,EAChC,2BAA2B,GAE5B,MAAM,uCAAuC,CAAA;AAC9C,OAAO,EACL,iBAAiB,EACjB,aAAa,GAEd,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,wBAAwB,EACxB,mBAAmB,GAGpB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EACL,yBAAyB,EACzB,oBAAoB,GAMrB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,8BAA8B,EAC9B,yBAAyB,GAE1B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,GAGtB,MAAM,iCAAiC,CAAA;AACxC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,GAEjB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,iBAAiB,GAElB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,kBAAkB,EAClB,kBAAkB,GAInB,MAAM,yBAAyB,CAAA;AAChC,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAElB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EACL,iBAAiB,EACjB,aAAa,EACb,YAAY,GAIb,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAE7D,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAA;AAE9E,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAExD,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,GAId,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,GAEvB,MAAM,2BAA2B,CAAA;AAElC,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,uBAAuB,GAGxB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,YAAY,GAEb,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAY,oBAAoB,CAAA;AACxD,OAAO,EACL,iBAAiB,EACjB,eAAe,GAGhB,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAW,gBAAgB,CAAA;AAE/C,OAAO,EACL,eAAe,GAKhB,MAAM,sBAAsB,CAAA;AAG7B,iHAAiH;AACjH,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAElD,mBAAmB;AACnB,OAAO,EAAE,QAAQ,IAAI,UAAU,EAAyC,MAAM,eAAe,CAAA"}

package/dist/react/parseRecordEditUrl.d.ts

@@ -1,12 +1,13 @@
 /**
- * Parses a pilotiq URL into a record-edit identity, or returns `null`
- * for any URL that isn't a record-bound edit page.
+ * URL → record-page identity parser. Used by `RecordWrapperGate` (and any
+ * plugin that wants to reason about record-bound URLs) to decide whether
+ * the current page is a record-edit or record-view route.
  *
  * A URL matches when:
  *   1. it starts with the panel's `basePath`
- *   2. after stripping the prefix it ends with `/edit`
+ *   2. after stripping the prefix it ends with `/edit` or `/view`
  *   3. there are at least three remaining segments (resource slug,
- *      record id, `edit`)
+ *      record id, terminal token)
  *
  * The `resourceSlug` is the slash-joined chain of every segment up to
  * the record id — this gives clustered resources (`${base}/blog/articles/123/edit`)
@@ -14,13 +15,36 @@
  * distinct slugs so two URLs that target different records always
  * produce different room names downstream.
  *
- *   `/admin/articles/123/edit`                      → { resourceSlug: 'articles',                 recordId: '123' }
- *   `/admin/blog/articles/123/edit`                 → { resourceSlug: 'blog/articles',            recordId: '123' }
- *   `/admin/articles/123/comments/456/edit`         → { resourceSlug: 'articles/123/comments',    recordId: '456' }
- *   `/admin/articles/123/comments`                  → null  (no trailing /edit)
- *   `/admin/articles/123/comments/create`           → null  (no record id)
+ *   `/admin/articles/123/edit`                      → { slug: 'articles',              id: '123', role: 'edit' }
+ *   `/admin/articles/123/view`                      → { slug: 'articles',              id: '123', role: 'view' }
+ *   `/admin/blog/articles/123/edit`                 → { slug: 'blog/articles',         id: '123', role: 'edit' }
+ *   `/admin/articles/123/comments/456/edit`         → { slug: 'articles/123/comments', id: '456', role: 'edit' }
+ *   `/admin/articles/123/comments`                  → null  (no trailing /edit or /view)
+ *   `/admin/articles/123/comments/create`           → null  (terminal token isn't edit|view)
  *   `/site/articles/123/edit`                       → null  (basePath mismatch when basePath='/admin')
  */
+/** Page roles `parseRecordPageUrl` recognizes. `'edit'` and `'view'`
+ * are the two record-scoped page roles where collab and other
+ * record-bound plugins want to mount their per-record wrapper. */
+export type RecordPageRole = 'edit' | 'view';
+export interface RecordPageIdentity {
+    resourceSlug: string;
+    recordId: string;
+    /** Which terminal URL segment matched — `'edit'` for the writable edit
+     * page, `'view'` for the read-only view page. Lets the gate decide per
+     * resource whether collab activates on this role (defaults to `'edit'`
+     * only; resources opt into `'view'` for presence-only experiences). */
+    role: RecordPageRole;
+}
+/**
+ * Parse a pilotiq URL into a `{ slug, id, role }` identity. Returns
+ * `null` for any URL that isn't a record-edit or record-view page.
+ */
+export declare function parseRecordPageUrl(currentPath: string, basePath: string): RecordPageIdentity | null;
+/** Legacy alias: parse a URL into an edit-only identity. Returns `null`
+ * for view URLs (and any non-edit URL). Kept for back-compat with the
+ * pre-`parseRecordPageUrl` public API; new code should call
+ * `parseRecordPageUrl` and branch on `role`. */
 export interface RecordEditIdentity {
     resourceSlug: string;
     recordId: string;

package/dist/react/parseRecordEditUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseRecordEditUrl.d.ts","sourceRoot":"","sources":["../../src/react/parseRecordEditUrl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAM,MAAM,CAAA;CACrB;AAED,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAK,MAAM,GAClB,kBAAkB,GAAG,IAAI,CAuB3B"}
+{"version":3,"file":"parseRecordEditUrl.d.ts","sourceRoot":"","sources":["../../src/react/parseRecordEditUrl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH;;kEAEkE;AAClE,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,MAAM,CAAA;AAE5C,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAM,MAAM,CAAA;IACpB;;;2EAGuE;IACvE,IAAI,EAAU,cAAc,CAAA;CAC7B;AAID;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAK,MAAM,GAClB,kBAAkB,GAAG,IAAI,CAyB3B;AAED;;;gDAGgD;AAChD,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAM,MAAM,CAAA;CACrB;AAED,wBAAgB,kBAAkB,CAChC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAK,MAAM,GAClB,kBAAkB,GAAG,IAAI,CAI3B"}

package/dist/react/parseRecordEditUrl.js

@@ -1,4 +1,34 @@
-export function parseRecordEditUrl(currentPath, basePath) {
+/**
+ * URL → record-page identity parser. Used by `RecordWrapperGate` (and any
+ * plugin that wants to reason about record-bound URLs) to decide whether
+ * the current page is a record-edit or record-view route.
+ *
+ * A URL matches when:
+ *   1. it starts with the panel's `basePath`
+ *   2. after stripping the prefix it ends with `/edit` or `/view`
+ *   3. there are at least three remaining segments (resource slug,
+ *      record id, terminal token)
+ *
+ * The `resourceSlug` is the slash-joined chain of every segment up to
+ * the record id — this gives clustered resources (`${base}/blog/articles/123/edit`)
+ * and nested-relation edits (`${base}/articles/123/comments/456/edit`)
+ * distinct slugs so two URLs that target different records always
+ * produce different room names downstream.
+ *
+ *   `/admin/articles/123/edit`                      → { slug: 'articles',              id: '123', role: 'edit' }
+ *   `/admin/articles/123/view`                      → { slug: 'articles',              id: '123', role: 'view' }
+ *   `/admin/blog/articles/123/edit`                 → { slug: 'blog/articles',         id: '123', role: 'edit' }
+ *   `/admin/articles/123/comments/456/edit`         → { slug: 'articles/123/comments', id: '456', role: 'edit' }
+ *   `/admin/articles/123/comments`                  → null  (no trailing /edit or /view)
+ *   `/admin/articles/123/comments/create`           → null  (terminal token isn't edit|view)
+ *   `/site/articles/123/edit`                       → null  (basePath mismatch when basePath='/admin')
+ */
+const RECOGNIZED_ROLES = ['edit', 'view'];
+/**
+ * Parse a pilotiq URL into a `{ slug, id, role }` identity. Returns
+ * `null` for any URL that isn't a record-edit or record-view page.
+ */
+export function parseRecordPageUrl(currentPath, basePath) {
     if (!currentPath)
         return null;
     // Normalise — trailing slashes on the URL or trailing slashes on
@@ -11,7 +41,8 @@ export function parseRecordEditUrl(currentPath, basePath) {
     const parts = tail.split('/').filter(Boolean);
     if (parts.length < 3)
         return null;
-    if (parts[parts.length - 1] !== 'edit')
+    const terminal = parts[parts.length - 1];
+    if (!RECOGNIZED_ROLES.includes(terminal))
         return null;
     const recordId = parts[parts.length - 2];
     const slugParts = parts.slice(0, parts.length - 2);
@@ -20,6 +51,13 @@ export function parseRecordEditUrl(currentPath, basePath) {
     return {
         resourceSlug: slugParts.join('/'),
         recordId,
+        role: terminal,
     };
 }
+export function parseRecordEditUrl(currentPath, basePath) {
+    const identity = parseRecordPageUrl(currentPath, basePath);
+    if (!identity || identity.role !== 'edit')
+        return null;
+    return { resourceSlug: identity.resourceSlug, recordId: identity.recordId };
+}
 //# sourceMappingURL=parseRecordEditUrl.js.map

package/dist/react/parseRecordEditUrl.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseRecordEditUrl.js","sourceRoot":"","sources":["../../src/react/parseRecordEditUrl.ts"],"names":[],"mappings":"AA4BA,MAAM,UAAU,kBAAkB,CAChC,WAAmB,EACnB,QAAmB;IAEnB,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAA;IAC7B,iEAAiE;IACjE,2DAA2D;IAC3D,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IACnD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAEhD,IAAI,WAAW,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC;QAAE,OAAO,IAAI,CAAA;IAE3E,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAE7C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAA;IACjC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,MAAM;QAAE,OAAO,IAAI,CAAA;IAEnD,MAAM,QAAQ,GAAM,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAE,CAAA;IAC5C,MAAM,SAAS,GAAK,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACpD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IAEvC,OAAO;QACL,YAAY,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;QACjC,QAAQ;KACT,CAAA;AACH,CAAC"}
+{"version":3,"file":"parseRecordEditUrl.js","sourceRoot":"","sources":["../../src/react/parseRecordEditUrl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAiBH,MAAM,gBAAgB,GAAkC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAExE;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAChC,WAAmB,EACnB,QAAmB;IAEnB,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAA;IAC7B,iEAAiE;IACjE,2DAA2D;IAC3D,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IACnD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAEhD,IAAI,WAAW,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC;QAAE,OAAO,IAAI,CAAA;IAE3E,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IACtE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAE7C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAA;IACjC,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAE,CAAA;IACzC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,QAA0B,CAAC;QAAE,OAAO,IAAI,CAAA;IAEvE,MAAM,QAAQ,GAAM,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAE,CAAA;IAC5C,MAAM,SAAS,GAAK,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACpD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IAEvC,OAAO;QACL,YAAY,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC;QACjC,QAAQ;QACR,IAAI,EAAU,QAA0B;KACzC,CAAA;AACH,CAAC;AAWD,MAAM,UAAU,kBAAkB,CAChC,WAAmB,EACnB,QAAmB;IAEnB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;IAC1D,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM;QAAE,OAAO,IAAI,CAAA;IACtD,OAAO,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAA;AAC7E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotiq/pilotiq",
-  "version": "0.8.2",
+  "version": "0.10.0",
   "description": "View-based admin panel for RudderJS",
   "license": "MIT",
   "repository": {

package/src/Pilotiq.ts

@@ -67,6 +67,44 @@ export interface PilotiqPlugin {
  */
 export type UserResolver = (req: unknown) => unknown | null | Promise<unknown | null>
 
+/**
+ * Server-side hook handed to `Pilotiq.editPageHydrator(fn)`. The
+ * resource-edit data builder calls every registered hydrator after the
+ * standard fill pipeline (`loadRecord` → `mutateFormDataBeforeFill` →
+ * `fillFromRecord` → `mutateFormDataAfterFill` →
+ * `applyRelationshipRepeaterFill` → `applyRelationshipBuilderFill`) and
+ * merges each non-null return onto the form's default values.
+ *
+ * Multiple hydrators are walked in registration order; later hydrators
+ * override keys produced by earlier ones. A hydrator returning `null`
+ * (or throwing) is a pass-through — the DB row values survive intact.
+ *
+ * Designed for the SSR-from-Y.Doc consumer in `@pilotiq-pro/collab`:
+ * read persisted Y.Text + Y.Map values for the record and override the
+ * matching field defaults, killing the DB → Y.Doc value flicker on
+ * hydration. Other consumers (per-tenant overrides, A/B experiments,
+ * draft-snapshot resume) compose the same way.
+ *
+ * Pilotiq core stays Yjs-free — the hook's `Record<string, unknown>`
+ * return is opaque, so the collab consumer's Yjs imports stay confined
+ * to its own `/server` subpath.
+ */
+export interface EditPageHydratorContext {
+  /** The Resource class being edited (server-side reference, not the
+   *  serialized meta — gives access to `model`, `getSlug()`, etc.). */
+  resource:      ResourceClass
+  /** Record id from the URL, stringified. */
+  recordId:      string
+  /** Values produced by the fill pipeline so far — DB row → hooks →
+   *  relationship fills. Hydrators read this to make merge decisions
+   *  (e.g. "only override fields that have content in Y.Doc"). */
+  currentValues: Record<string, unknown>
+}
+
+export type EditPageHydrator = (
+  ctx: EditPageHydratorContext,
+) => Record<string, unknown> | null | Promise<Record<string, unknown> | null>
+
 /**
  * Upload configuration. Apps register an adapter via `Pilotiq.uploads({
  * adapter })`; the `_uploads` route hands every incoming file to it.
@@ -203,6 +241,11 @@ export interface PilotiqConfig {
    *  separator + Sign-out entry. Without this, the menu shows custom
    *  items (if any) and the user identity, but no sign-out affordance. */
   signOut?:      SignOutConfig
+  /** Server-side hydrators applied after the fill pipeline on every
+   *  resource edit page. Empty / unset → behaviour unchanged. See
+   *  `EditPageHydrator` for the contract; plugins register via
+   *  `panel.editPageHydrator(fn)`. */
+  editPageHydrators?: EditPageHydrator[]
   /** Database notifications — opt-in. Mounts the bell + 4 endpoints
    *  (`_notifications` list / `:id/read` / `:id/unread` / `read-all`).
    *  Reads rows from `@rudderjs/notification`'s `notification` table via
@@ -521,6 +564,27 @@ export class Pilotiq {
     return this
   }
 
+  /**
+   * Register a server-side hydrator that runs after the fill pipeline
+   * on every resource edit page. Each registered hydrator's non-null
+   * return merges onto the form's default values; multiple registrations
+   * are walked in registration order (later wins on key conflicts).
+   *
+   *   panel.editPageHydrator(async ({ resource, recordId }) => {
+   *     // override defaults for this record from your alt source
+   *     return { title: await draftStore.read(resource.getSlug(), recordId) }
+   *   })
+   *
+   * Plugins typically register from inside their `register(panel)` hook.
+   * Throwing or returning `null` is a pass-through — the DB row values
+   * survive. See `EditPageHydrator` for the full contract.
+   */
+  editPageHydrator(fn: EditPageHydrator): this {
+    if (!this.config.editPageHydrators) this.config.editPageHydrators = []
+    this.config.editPageHydrators.push(fn)
+    return this
+  }
+
   /**
    * Enable persistent database-backed notifications. Mounts the bell in
    * the panel chrome + a small set of `_notifications` endpoints. The

package/src/Resource.test.ts

@@ -237,4 +237,48 @@ describe('Resource (static API)', () => {
       assert.equal(await R.canRestore(null, { ownedBy: 'other' }), false)
     })
   })
+
+  describe('collab opt-in', () => {
+    it('omitted static collab → getResolvedCollabConfig returns null', () => {
+      class R extends Resource {}
+      assert.equal(R.getResolvedCollabConfig(), null)
+    })
+
+    it('static collab = false → null (explicit opt-out)', () => {
+      class R extends Resource {
+        static override collab = false as const
+      }
+      assert.equal(R.getResolvedCollabConfig(), null)
+    })
+
+    it('static collab = true → defaults to { pages: [edit], presence: true }', () => {
+      class R extends Resource {
+        static override collab = true as const
+      }
+      assert.deepEqual(R.getResolvedCollabConfig(), {
+        pages:    ['edit'],
+        presence: true,
+      })
+    })
+
+    it('object form merges with defaults', () => {
+      class R extends Resource {
+        static override collab = { pages: ['edit', 'view'] as const }
+      }
+      assert.deepEqual(R.getResolvedCollabConfig(), {
+        pages:    ['edit', 'view'],
+        presence: true,   // default preserved
+      })
+    })
+
+    it('object form can suppress presence', () => {
+      class R extends Resource {
+        static override collab = { presence: false }
+      }
+      assert.deepEqual(R.getResolvedCollabConfig(), {
+        pages:    ['edit'],   // default preserved
+        presence: false,
+      })
+    })
+  })
 })

package/src/Resource.ts

@@ -50,6 +50,33 @@ export type NavigationBadgeColor =
 export type NavigationBadgeHandler =
   () => string | number | undefined | Promise<string | number | undefined>
 
+/**
+ * Per-resource collab configuration. Set via `static collab = true` (the
+ * 90% case — opts the edit page in with presence) or via the object form
+ * for finer control. Omitting `static collab` entirely keeps the resource
+ * collab-free even when the `@pilotiq-pro/collab` plugin is registered.
+ *
+ *   pages    — page roles where collab activates. `'edit'` syncs values +
+ *              presence; `'view'` is presence-only (the page is read-only,
+ *              value-sync would be moot). Defaults to `['edit']`.
+ *   presence — when false, suppress the awareness layer (focus chips,
+ *              cursor positions) while keeping value-sync. Defaults to true.
+ *
+ * Field-level `.collab(false)` always wins over this setting — opting the
+ * resource in then opting individual fields out is the supported shape.
+ */
+export interface ResourceCollabConfig {
+  pages:    ReadonlyArray<'edit' | 'view'>
+  presence: boolean
+}
+
+/** Raw shape accepted by `static collab` before normalization. `true` is a
+ * shorthand for `{ pages: ['edit'], presence: true }`. */
+export type ResourceCollabInput = boolean | {
+  pages?:    ReadonlyArray<'edit' | 'view'>
+  presence?: boolean
+}
+
 /**
  * Abstract Resource base class. **All methods are static** — resources are
  * registered by class, not by instance. Routes look up the class and call
@@ -297,6 +324,37 @@ export abstract class Resource {
     return undefined
   }
 
+  // ─── Realtime collab opt-in ────────────────────────────────
+  // Opt-in per resource. The `@pilotiq-pro/collab` plugin registers the
+  // global singletons (transport, Tiptap extension factory, RecordWrapper
+  // factory); resources with `static collab` unset stay collab-free even
+  // when the plugin is installed. Field-level `.collab(false)` overrides
+  // this setting per field.
+
+  /** Enable collab on this resource. `true` is the 90% case — shorthand
+   * for `{ pages: ['edit'], presence: true }`. Use the object form to
+   * narrow which page roles activate or to suppress presence. Default
+   * `false` (collab off — the WS room is never opened for this resource). */
+  static collab: ResourceCollabInput = false
+
+  /**
+   * Normalize `static collab` into the canonical wire shape, or return
+   * `null` when the resource has opted out. Centralizes the `true` →
+   * defaults expansion and the `{ pages?: … }` merge.
+   *
+   * Result lands on `panelInfo().recordCollab[slug]`; the gate reads it
+   * to decide whether to mount the record wrapper.
+   */
+  static getResolvedCollabConfig(): ResourceCollabConfig | null {
+    const raw = this.collab
+    if (raw === false || raw == null) return null
+    if (raw === true) return { pages: ['edit'], presence: true }
+    return {
+      pages:    raw.pages    ?? ['edit'],
+      presence: raw.presence ?? true,
+    }
+  }
+
   // ─── Plan #10: authorization predicates ────────────────────
   // All async, all default `true`. Routes call them with the resolved
   // user (from `Pilotiq.user(fn)`); the renderer threads the same user

package/src/index.ts

@@ -6,6 +6,8 @@ export {
   type UserResolver,
   type UploadConfig,
   type SignOutConfig,
+  type EditPageHydrator,
+  type EditPageHydratorContext,
 } from './Pilotiq.js'
 export {
   UserMenuItem,

package/src/pageData/helpers.ts

@@ -1,4 +1,9 @@
-import type { Pilotiq, PilotiqConfig } from '../Pilotiq.js'
+import type {
+  Pilotiq,
+  PilotiqConfig,
+  EditPageHydrator,
+  EditPageHydratorContext,
+} from '../Pilotiq.js'
 import type { Page } from '../Page.js'
 import { Element } from '../schema/Element.js'
 import { Field } from '../fields/Field.js'
@@ -386,6 +391,40 @@ export async function applyFillPipeline<R>(
   return values
 }
 
+/**
+ * Walk every hydrator registered via `Pilotiq.editPageHydrator(fn)` and
+ * merge non-null returns onto `currentValues`. Hydrators run sequentially
+ * in registration order; later returns override keys from earlier ones.
+ *
+ * Failure mode is permissive: a hydrator that throws or returns `null`
+ * contributes nothing; the page still renders against the fill-pipeline
+ * values it received. Errors emit a `console.warn` so the page isn't
+ * silently relying on missing data.
+ *
+ * Returns the merged overlay (NOT the final values). The caller composes
+ * the overlay onto the form via `form.withValues({ ...current, ...overlay })`
+ * — keeps the merge order explicit at the call site (overlay wins).
+ *
+ * Empty hydrators array / no overrides → returns `{}` so callers can
+ * skip the `withValues` call cheaply.
+ */
+export async function applyEditPageHydrators(
+  hydrators: ReadonlyArray<EditPageHydrator>,
+  ctx:       EditPageHydratorContext,
+): Promise<Record<string, unknown>> {
+  if (hydrators.length === 0) return {}
+  let overlay: Record<string, unknown> = {}
+  for (const fn of hydrators) {
+    try {
+      const result = await fn(ctx)
+      if (result && typeof result === 'object') overlay = { ...overlay, ...result }
+    } catch (err) {
+      console.warn('[pilotiq] editPageHydrator threw — falling back to fill-pipeline values', err)
+    }
+  }
+  return overlay
+}
+
 /**
  * Walk the form's top-level Repeaters and replace `values[fieldName]`
  * with rows fetched from `parent.related(name)` for any

package/src/pageData/navigation.ts

@@ -1,6 +1,6 @@
 import type { Pilotiq, PilotiqConfig } from '../Pilotiq.js'
 import type { Page } from '../Page.js'
-import type { ResourceClass, NavigationBadgeColor } from '../Resource.js'
+import type { ResourceClass, NavigationBadgeColor, ResourceCollabConfig } from '../Resource.js'
 import type { GlobalClass } from '../Global.js'
 import type { ClusterClass } from '../Cluster.js'
 import { resourceBasePath, globalBasePath, pageBasePath } from '../clusterPaths.js'
@@ -194,6 +194,35 @@ export interface PanelInfoRoute {
   url?:      string
 }
 
+/**
+ * Per-resource collab opt-in map, keyed by the URL slug
+ * `parseRecordPageUrl` produces. Non-clustered resource → `getSlug()`;
+ * clustered resource → `${cluster.getSlug()}/${R.getSlug()}`.
+ *
+ * `RecordWrapperGate` reads this map to decide whether the page tree
+ * needs the plugin-registered RecordWrapper (collab room, audit, …)
+ * mounted around the record view/edit content area.
+ *
+ * Nested-relation edit URLs (`/articles/123/comments/456/edit`) have a
+ * dynamic-id segment in the gate's URL slug and don't match here in v1.
+ * Collab on nested-relation edits is a follow-up — top-level resource
+ * edits are the common case and ship now.
+ */
+export type RecordCollabMap = Record<string, ResourceCollabConfig>
+
+function resourceSlugForGate(R: ResourceClass): string {
+  return R.cluster ? `${R.cluster.getSlug()}/${R.getSlug()}` : R.getSlug()
+}
+
+function buildRecordCollabMap(cfg: Readonly<PilotiqConfig>): RecordCollabMap | undefined {
+  const map: RecordCollabMap = {}
+  for (const R of cfg.resources) {
+    const collab = R.getResolvedCollabConfig()
+    if (collab) map[resourceSlugForGate(R)] = collab
+  }
+  return Object.keys(map).length > 0 ? map : undefined
+}
+
 export async function panelInfo(
   pilotiq: Pilotiq,
   req?:    unknown,
@@ -210,6 +239,7 @@ export async function panelInfo(
     buildRightSidebarMeta(cfg, user),
   ])
   const databaseNotifications = buildDatabaseNotificationsMeta(cfg, user)
+  const recordCollab = buildRecordCollabMap(cfg)
   // AI suggestion mode — sparse: omit when 'auto' (the default) so the
   // wire shape stays minimal for panels that don't opt into review mode.
   // Plugin clients (e.g. @pilotiq-pro/ai's `AiClientToolBindings`) read
@@ -225,6 +255,7 @@ export async function panelInfo(
     ...(userMenu ? { userMenu } : {}),
     ...(databaseNotifications ? { databaseNotifications } : {}),
     ...(rightSidebar ? { rightSidebar } : {}),
+    ...(recordCollab ? { recordCollab } : {}),
     ...(Object.keys(renderHooks).length > 0 ? { renderHooks } : {}),
     ...(aiSuggestionsMode !== 'auto' ? { aiSuggestionsMode } : {}),
   }

package/src/pageData/resourcePages.ts

@@ -25,6 +25,7 @@ import {
   resourceViewBreadcrumbs,
 } from './breadcrumbs.js'
 import {
+  applyEditPageHydrators,
   applyFillPipeline,
   applyRelationshipBuilderFill,
   applyRelationshipRepeaterFill,
@@ -400,7 +401,22 @@ export async function resourceEditData(
       const values = await applyFillPipeline(form, record)
       const withRelations  = await applyRelationshipRepeaterFill(form, values, record, R.model)
       const withBuilders   = await applyRelationshipBuilderFill(form, withRelations, record, R.model)
-      form.withValues(withBuilders)
+      // Hydrators run AFTER the standard fill pipeline so they overlay
+      // on top of DB-row + relationship-row values. Skipped on the
+      // prefill branch (validation-error round-trip) — overlaying there
+      // would clobber the user's just-submitted input that the page is
+      // re-displaying for them to fix.
+      const hydrators = cfg.editPageHydrators ?? []
+      const overlay = hydrators.length > 0
+        ? await applyEditPageHydrators(hydrators, {
+            resource:      R,
+            recordId,
+            currentValues: withBuilders,
+          })
+        : {}
+      form.withValues(Object.keys(overlay).length > 0
+        ? { ...withBuilders, ...overlay }
+        : withBuilders)
     } else if (prefill?.values) {
       form.withValues(prefill.values)
     }