@gogitcms/editor 0.38.0 → 0.40.0

package/app/src/App.tsx

@@ -2346,7 +2346,7 @@ function CmsView({
               const doc = loaded[draft.id];
               if (!tab || !doc) return;
               const col = collections.find((c) => c.name === tab.collection);
-              draftBus.publish({
+              const published = {
                 id: draft.id,
                 collection: tab.collection,
                 path: doc.path,
@@ -2356,6 +2356,16 @@ function CmsView({
                 fields: { ...(doc.fields ?? {}), ...draft.fields },
                 body: draft.body ?? undefined,
                 bodyField: col?.fields.find((f) => f.source === "body")?.name,
+              };
+              // Two audiences: the plugin tabs open on this document, and the
+              // plugins themselves — which is how a preview popped out into its
+              // own window keeps receiving edits after its tab is closed.
+              draftBus.publish(published);
+              pluginRegistry.notifyDraft(published, {
+                workspaceId: params.workspaceId,
+                repositoryId: repo.id,
+                branchId: branch.id,
+                ref: branch.name,
               });
             }
       }

package/app/vendor/plugin-sdk/src/__tests__/registry.test.ts

@@ -146,3 +146,40 @@ describe("host capabilities", () => {
     await expect(registry.api("@acme/preview").getPreviewToken("")).rejects.toThrow(/repositoryId is required/);
   });
 });
+
+describe("onDocumentDraft", () => {
+  it("hands every in-flight edit to the plugins that asked, for the life of the plugin", () => {
+    const registry = new PluginRegistry();
+    const seen: string[] = [];
+    registry.api("@acme/preview").onDocumentDraft((doc, ctx) => seen.push(`${ctx.repositoryId}:${doc.id}:${doc.fields.title}`));
+    registry.api("@acme/other").onDocumentDraft(() => {
+      throw new Error("boom");
+    });
+    const errors: string[] = [];
+    jest.spyOn(console, "error").mockImplementation((m: unknown) => void errors.push(String(m)));
+
+    registry.notifyDraft(
+      { id: "d1", collection: "posts", path: "content/a.md", fields: { title: "Hello" } },
+      { workspaceId: "ws", repositoryId: "repo-1", ref: "main" },
+    );
+    registry.notifyDraft(
+      { id: "d1", collection: "posts", path: "content/a.md", fields: { title: "Hello again" } },
+      { workspaceId: "ws", repositoryId: "repo-1", ref: "main" },
+    );
+
+    expect(seen).toEqual(["repo-1:d1:Hello", "repo-1:d1:Hello again"]);
+    // A listener that throws is reported and does not stop the others, nor
+    // the editor's typing path that called in.
+    expect(errors.some((e) => e.includes("@acme/other") && e.includes("boom"))).toBe(true);
+    jest.restoreAllMocks();
+  });
+
+  it("refuses a listener that is not a function", () => {
+    const registry = new PluginRegistry();
+    const errors: string[] = [];
+    jest.spyOn(console, "error").mockImplementation((m: unknown) => void errors.push(String(m)));
+    (registry.api("@acme/preview") as any).onDocumentDraft("nope");
+    expect(errors.some((e) => e.includes("must be a function"))).toBe(true);
+    jest.restoreAllMocks();
+  });
+});

package/app/vendor/plugin-sdk/src/registry.ts

@@ -15,6 +15,8 @@ import type {
   PluginSidebarLink,
   PluginStatus,
   PluginUserMenuLink,
+  PluginDraftContext,
+  PluginDraftListener,
 } from "./types";
 
 // The schema prefix under which plugin field components are addressed
@@ -85,6 +87,7 @@ export class PluginRegistry {
   private userMenuLinks: PluginUserMenuLinkRecord[] = [];
   private fieldComponents = new Map<string, PluginFieldComponentRecord>();
   private documentActions: PluginDocumentActionRecord[] = [];
+  private draftListeners: { pluginId: string; listener: PluginDraftListener }[] = [];
   private statuses = new Map<string, { status: PluginStatus; error?: string }>();
   private listeners = new Set<() => void>();
   private version = 0;
@@ -255,9 +258,31 @@ export class PluginRegistry {
         });
         registry.bump();
       },
+      onDocumentDraft(listener: PluginDraftListener) {
+        if (typeof listener !== "function") {
+          console.error(`[plugin ${pluginId}] onDocumentDraft: listener must be a function`);
+          return;
+        }
+        registry.draftListeners.push({ pluginId, listener });
+      },
     };
   }
 
+  /**
+   * Hand an in-flight edit to every plugin that asked for them. Called by the
+   * host from its typing path, so a listener that throws is reported and
+   * skipped rather than allowed to break the editor.
+   */
+  notifyDraft(doc: PluginDocument, ctx: PluginDraftContext): void {
+    for (const { pluginId, listener } of this.draftListeners) {
+      try {
+        listener(doc, ctx);
+      } catch (err) {
+        console.error(`[plugin ${pluginId}] draft listener threw: ${String(err)}`);
+      }
+    }
+  }
+
   // --- queries the hosts render from ----------------------------------------
 
   /** Field component for a schema `display.component` key ("plugin:<name>"). */

package/app/vendor/plugin-sdk/src/types.ts

@@ -212,8 +212,30 @@ export interface CmsPluginApi {
    * pane is built without the CMS knowing anything about previews.
    */
   addDocumentAction(action: PluginDocumentAction): void;
+  /**
+   * Subscribe to every open document's in-flight edits, for the life of the
+   * plugin rather than of a tab.
+   *
+   * A tab's `onDraft` (PluginTabContext) ends with the tab. This one does not,
+   * which is what lets a preview keep receiving edits after its pane has been
+   * popped out into a window and the tab closed. The host debounces before
+   * calling (~150 ms), same as the tab form. Listeners are called for every
+   * document being edited; the plugin decides which ones it cares about.
+   */
+  onDocumentDraft(listener: PluginDraftListener): void;
 }
 
+/** Where a draft came from: the repository and branch being edited. */
+export type PluginDraftContext = {
+  workspaceId: string;
+  repositoryId: string;
+  branchId?: string;
+  /** Git ref name of the branch, when the host knows it. */
+  ref?: string;
+};
+
+export type PluginDraftListener = (doc: PluginDocument, ctx: PluginDraftContext) => void;
+
 /** A plugin's setup function — the package entrypoint's default export. */
 export type PluginSetup = (cms: CmsPluginApi, options?: unknown) => void | Promise<void>;
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@gogitcms/editor",
-  "version": "0.38.0",
+  "version": "0.40.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@gogitcms/editor",
-      "version": "0.38.0",
+      "version": "0.40.0",
       "dependencies": {
         "@apollo/client": "^3.11.8",
         "@handlewithcare/react-prosemirror": "^3.2.7",
@@ -47,11 +47,11 @@
         "node": ">=20"
       },
       "optionalDependencies": {
-        "@gogitcms/gitcms-local-darwin-arm64": "0.38.0",
-        "@gogitcms/gitcms-local-darwin-x64": "0.38.0",
-        "@gogitcms/gitcms-local-linux-arm64": "0.38.0",
-        "@gogitcms/gitcms-local-linux-x64": "0.38.0",
-        "@gogitcms/gitcms-local-win32-x64": "0.38.0"
+        "@gogitcms/gitcms-local-darwin-arm64": "0.40.0",
+        "@gogitcms/gitcms-local-darwin-x64": "0.40.0",
+        "@gogitcms/gitcms-local-linux-arm64": "0.40.0",
+        "@gogitcms/gitcms-local-linux-x64": "0.40.0",
+        "@gogitcms/gitcms-local-win32-x64": "0.40.0"
       }
     },
     "node_modules/@apollo/client": {
@@ -751,9 +751,9 @@
       }
     },
     "node_modules/@gogitcms/gitcms-local-darwin-arm64": {
-      "version": "0.38.0",
-      "resolved": "https://registry.npmjs.org/@gogitcms/gitcms-local-darwin-arm64/-/gitcms-local-darwin-arm64-0.38.0.tgz",
-      "integrity": "sha512-H8SJS8frXpgA3tmWN8ex+Biho0qiM8CZbwwLC07GJ+Vzx8d3q1QNnmu+8R4D3HuecoOhD9UzMnzQXBSJ+Qb4TA==",
+      "version": "0.40.0",
+      "resolved": "https://registry.npmjs.org/@gogitcms/gitcms-local-darwin-arm64/-/gitcms-local-darwin-arm64-0.40.0.tgz",
+      "integrity": "sha512-YSXToG2tsBQgjcvnQUrukaejCPUfkEHTeaOephZd4cOXQ2ZqG9/ZlHUrL7f7EByfqL3Haq0+kFIf8n6gr8UQgQ==",
       "cpu": [
         "arm64"
       ],
@@ -764,9 +764,9 @@
       ]
     },
     "node_modules/@gogitcms/gitcms-local-darwin-x64": {
-      "version": "0.38.0",
-      "resolved": "https://registry.npmjs.org/@gogitcms/gitcms-local-darwin-x64/-/gitcms-local-darwin-x64-0.38.0.tgz",
-      "integrity": "sha512-KokjE3yBXCXZr2y3cXm9c0tWWXI1PbR5BMhNU8Fi23ShWLh7BKepGoexTW+YTz+1Nc9zcmT8nSSU1kxTzOQXlw==",
+      "version": "0.40.0",
+      "resolved": "https://registry.npmjs.org/@gogitcms/gitcms-local-darwin-x64/-/gitcms-local-darwin-x64-0.40.0.tgz",
+      "integrity": "sha512-TgOawXMxI9VbFIsqV6fewAn/TK0I6B/nZp+2kfchV/uTTdvdwRhis5AP3xgg9Pm3oGeQRiS3U7CzYsmVbsSxkw==",
       "cpu": [
         "x64"
       ],
@@ -777,9 +777,9 @@
       ]
     },
     "node_modules/@gogitcms/gitcms-local-linux-x64": {
-      "version": "0.38.0",
-      "resolved": "https://registry.npmjs.org/@gogitcms/gitcms-local-linux-x64/-/gitcms-local-linux-x64-0.38.0.tgz",
-      "integrity": "sha512-YvD7qc+Va0OvcEXVmtSoyAY5VvS4D54O4HwR+Yel9EhuSvAiihmgkbCuWQQpDNPOAp/6t8dHLYJwe4Jr+7a6/Q==",
+      "version": "0.40.0",
+      "resolved": "https://registry.npmjs.org/@gogitcms/gitcms-local-linux-x64/-/gitcms-local-linux-x64-0.40.0.tgz",
+      "integrity": "sha512-w7HITMMDfoYTkY7d3wUyHt5rcdF6Ku8f0Ej8GTYXa4TO72QtVDxh9TcKOdICxih7lvQNBUhj7sZ88ZtabYsOtg==",
       "cpu": [
         "x64"
       ],
@@ -789,6 +789,19 @@
         "linux"
       ]
     },
+    "node_modules/@gogitcms/gitcms-local-win32-x64": {
+      "version": "0.40.0",
+      "resolved": "https://registry.npmjs.org/@gogitcms/gitcms-local-win32-x64/-/gitcms-local-win32-x64-0.40.0.tgz",
+      "integrity": "sha512-qszCKrAqqddACYF+ZrtAep2wIGSLW/SWAAS2+M5MS6WiZT6bJVlYTQiw64U+/hMk4XfscFP4hUwOSeV37c9ocA==",
+      "cpu": [
+        "x64"
+      ],
+      "license": "UNLICENSED",
+      "optional": true,
+      "os": [
+        "win32"
+      ]
+    },
     "node_modules/@graphql-typed-document-node/core": {
       "version": "3.2.0",
       "resolved": "https://registry.npmjs.org/@graphql-typed-document-node/core/-/core-3.2.0.tgz",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gogitcms/editor",
-  "version": "0.38.0",
+  "version": "0.40.0",
   "description": "Terminal UI for setting up and running the Go·Git CMS content editor",
   "type": "module",
   "bin": {
@@ -65,10 +65,10 @@
     "@gogitcms/frontend": "workspace:*"
   },
   "optionalDependencies": {
-    "@gogitcms/gitcms-local-darwin-arm64": "0.38.0",
-    "@gogitcms/gitcms-local-darwin-x64": "0.38.0",
-    "@gogitcms/gitcms-local-linux-arm64": "0.38.0",
-    "@gogitcms/gitcms-local-linux-x64": "0.38.0",
-    "@gogitcms/gitcms-local-win32-x64": "0.38.0"
+    "@gogitcms/gitcms-local-darwin-arm64": "0.40.0",
+    "@gogitcms/gitcms-local-darwin-x64": "0.40.0",
+    "@gogitcms/gitcms-local-linux-arm64": "0.40.0",
+    "@gogitcms/gitcms-local-linux-x64": "0.40.0",
+    "@gogitcms/gitcms-local-win32-x64": "0.40.0"
   }
 }