@paged-media/plugin-sdk 0.2.4-canary.0 → 0.2.6-canary.0

package/dist/index.js

@@ -92,6 +92,8 @@ var HOST_FEATURES = [
   "document.elementGeometry@1",
   "document.tree@1",
   "document.onDidChange@1",
+  "document.getMetadata@1",
+  "document.setMetadata@1",
   "selection@1",
   "viewport@1",
   "overlay.toolPreview@1",
@@ -136,6 +138,7 @@ function createBundleHost(getEditor, manifest, options) {
   const sink = options?.console ?? console;
   const ns = `${manifest.id}.`;
   const tag = `[${manifest.id}]`;
+  const metadataKey = (m) => `x-paged:${m.id}`;
   const assertNamespaced = (id, kind) => {
     if (!id.startsWith(ns)) {
       throw new Error(
@@ -182,8 +185,26 @@ function createBundleHost(getEditor, manifest, options) {
       );
     }
   };
+  const foreignMetadataKey = (m) => {
+    if (m.op === "setPluginMetadata") {
+      return m.args.key === metadataKey(manifest) ? null : m.args.key;
+    }
+    if (m.op === "batch") {
+      for (const child of m.args.ops) {
+        const bad = foreignMetadataKey(child);
+        if (bad !== null) return bad;
+      }
+    }
+    return null;
+  };
   const document = {
     async mutate(mutation) {
+      const foreign = foreignMetadataKey(mutation);
+      if (foreign !== null) {
+        const error = `setPluginMetadata key "${foreign}" is outside this plugin's namespace ("${metadataKey(manifest)}")`;
+        log.warn(error);
+        return { applied: false, error };
+      }
       try {
         const reply = await getEditor().client.mutate(mutation);
         if (reply.kind === "mutationApplied") {
@@ -236,6 +257,37 @@ function createBundleHost(getEditor, manifest, options) {
       });
       return reply.kind === "sceneTree" ? reply.payload.roots : [];
     },
+    async getMetadata(id) {
+      const key = metadataKey(manifest);
+      const reply = await getEditor().client.send({
+        kind: "requestElementProperties",
+        payload: { id }
+      });
+      if (reply.kind !== "elementProperties" || !reply.payload.result) {
+        return null;
+      }
+      for (const entry of reply.payload.result.entries) {
+        const v = entry.value;
+        if (v && typeof v === "object" && v.type === "pluginMetadata" && v.value.key === key && typeof v.value.value === "string") {
+          try {
+            return JSON.parse(v.value.value);
+          } catch {
+            return null;
+          }
+        }
+      }
+      return null;
+    },
+    async setMetadata(id, envelope) {
+      return this.mutate({
+        op: "setPluginMetadata",
+        args: {
+          elementId: id,
+          key: metadataKey(manifest),
+          value: envelope === null ? null : JSON.stringify(envelope)
+        }
+      });
+    },
     onDidChange(listener) {
       const off = getEditor().client.subscribe((msg) => {
         if (msg.kind === "mutationApplied" || msg.kind === "undoApplied" || msg.kind === "redoApplied") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paged-media/plugin-sdk",
-  "version": "0.2.4-canary.0",
+  "version": "0.2.6-canary.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,14 +11,14 @@
     }
   },
   "dependencies": {
-    "@paged-media/plugin-api": "0.2.4-canary.0"
+    "@paged-media/plugin-api": "0.2.6-canary.0"
   },
   "devDependencies": {
     "typescript": "^5.6.3",
     "vitest": "^2.1.8"
   },
   "description": "The Paged plugin runtime: loadBundle, the in-process BundleHost adapter, the gesture kit, and version negotiation.",
-  "license": "UNLICENSED",
+  "license": "MPL-2.0 OR LicenseRef-PMEL",
   "files": [
     "dist"
   ],