@embedpdf/plugin-metadata 3.0.0-next.0

package/LICENSE

@@ -0,0 +1,192 @@
+Copyright 2026 CloudPDF LTD
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use files in this distribution except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-----------------------------------------------------------------------
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/dist/index.cjs

@@ -0,0 +1,104 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _embedpdf_core = require("@embedpdf/core");
+//#region src/capability.ts
+/**
+* Authorization for Info-dict writes. Maps to PDF bit 4 (MODIFY). The engine
+* ALSO enforces this — `metadata.update` throws `PermissionDenied` without it,
+* identically on local and cloud — so `canEdit()` is the UI mirror of a real
+* guard, not the guard itself. Typed as `DocCapability` so a typo is a compile
+* error.
+*/
+const METADATA_MODIFY_CAPABILITY = "doc.metadata.modify";
+/**
+* Reads/writes the document's Info dict through the engine handle and keeps the
+* plugin's state in sync. The live-update wiring (own + remote events) lives in
+* the effect; this is the read/write surface.
+*/
+function createMetadataCapability(ctx) {
+	const requireDoc = () => {
+		const doc = ctx.doc;
+		if (!doc) throw new Error("[metadata] no document bound");
+		return doc;
+	};
+	return {
+		canEdit() {
+			return ctx.doc?.security.allows(METADATA_MODIFY_CAPABILITY) ?? false;
+		},
+		current: () => ctx.getState().metadata,
+		update: async (patch) => {
+			const result = await requireDoc().metadata.update(patch);
+			ctx.dispatch({
+				type: "SET",
+				metadata: result.metadata
+			});
+		},
+		reload: async () => {
+			const metadata = await requireDoc().metadata.read();
+			ctx.dispatch({
+				type: "SET",
+				metadata
+			});
+		}
+	};
+}
+//#endregion
+//#region src/effects.ts
+/**
+* Makes metadata REACTIVE — the reason this is a plugin, not a kernel IO call.
+*
+*  1. Seed: read the Info dict once when the document opens.
+*  2. Live: subscribe to the document event stream. A `metadata.updated` event
+*     carries the full re-read metadata and fires for OWN edits AND for remote
+*     edits delivered over SSE (another session) — both just become `setState`.
+*
+* The handle's stream is synchronous fan-out, so this coexists with the kernel's
+* own subscription (page registry) on the same handle.
+*/
+function registerMetadataEffects(ctx) {
+	const doc = ctx.doc;
+	if (!doc) return;
+	doc.metadata.read().then((metadata) => ctx.dispatch({
+		type: "SET",
+		metadata
+	}), () => {});
+	const unsubscribe = doc.events.subscribe((event) => {
+		if (event.type === "metadata.updated") ctx.dispatch({
+			type: "SET",
+			metadata: event.metadata
+		});
+	});
+	ctx.cleanup(unsubscribe);
+}
+//#endregion
+//#region src/reducer.ts
+const initialMetadataState = () => ({ metadata: null });
+/** Pure. The only transition: replace the metadata snapshot (from a read or an
+*  event). */
+const metadataReducer = (state, a) => a.type === "SET" ? {
+	...state,
+	metadata: a.metadata
+} : state;
+//#endregion
+//#region src/types.ts
+const MetadataToken = (0, _embedpdf_core.createCapabilityToken)("metadata");
+//#endregion
+//#region src/metadata.plugin.ts
+/**
+* Document-scoped metadata plugin: reactive Info-dict state. The effect seeds it
+* from the engine and keeps it live off the document event stream (own + remote
+* SSE edits); the capability is the read/write surface.
+*/
+const metadataPlugin = () => (0, _embedpdf_core.definePlugin)({
+	id: "metadata",
+	token: MetadataToken,
+	scope: "document",
+	initialState: initialMetadataState,
+	reduce: metadataReducer,
+	capability: createMetadataCapability,
+	effects: registerMetadataEffects
+});
+//#endregion
+exports.MetadataToken = MetadataToken;
+exports.metadataPlugin = metadataPlugin;
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/capability.ts","../src/effects.ts","../src/reducer.ts","../src/types.ts","../src/metadata.plugin.ts"],"sourcesContent":["import type { PluginContext, DocCapability } from '@embedpdf/core';\nimport type { MetadataAction, MetadataCapability, MetadataState } from './types';\n\n/**\n * Authorization for Info-dict writes. Maps to PDF bit 4 (MODIFY). The engine\n * ALSO enforces this — `metadata.update` throws `PermissionDenied` without it,\n * identically on local and cloud — so `canEdit()` is the UI mirror of a real\n * guard, not the guard itself. Typed as `DocCapability` so a typo is a compile\n * error.\n */\nconst METADATA_MODIFY_CAPABILITY: DocCapability = 'doc.metadata.modify';\n\n/**\n * Reads/writes the document's Info dict through the engine handle and keeps the\n * plugin's state in sync. The live-update wiring (own + remote events) lives in\n * the effect; this is the read/write surface.\n */\nexport function createMetadataCapability(\n  ctx: PluginContext<MetadataState, MetadataAction>,\n): MetadataCapability {\n  const requireDoc = () => {\n    const doc = ctx.doc;\n    if (!doc) throw new Error('[metadata] no document bound');\n    return doc;\n  };\n\n  return {\n    canEdit() {\n      // Wildcard-aware predicate (mirrors the engine's own enforcement),\n      // identical on both engines. NOT `effectiveScope.includes(...)` — that\n      // enumeration drops the `*` admin grant, so it would hide the UI on a\n      // default admin open even though the engine allows the edit.\n      return ctx.doc?.security.allows(METADATA_MODIFY_CAPABILITY) ?? false;\n    },\n\n    current: () => ctx.getState().metadata,\n\n    update: async (patch) => {\n      // The write also emits a `metadata.updated` event the effect catches, so\n      // this dispatch is just for an immediate, in-sync update (idempotent).\n      const result = await requireDoc().metadata.update(patch);\n      ctx.dispatch({ type: 'SET', metadata: result.metadata });\n    },\n\n    reload: async () => {\n      const metadata = await requireDoc().metadata.read();\n      ctx.dispatch({ type: 'SET', metadata });\n    },\n  };\n}\n","import type { DocumentEvent, EffectContext } from '@embedpdf/core';\nimport type { MetadataAction, MetadataState } from './types';\n\n/**\n * Makes metadata REACTIVE — the reason this is a plugin, not a kernel IO call.\n *\n *  1. Seed: read the Info dict once when the document opens.\n *  2. Live: subscribe to the document event stream. A `metadata.updated` event\n *     carries the full re-read metadata and fires for OWN edits AND for remote\n *     edits delivered over SSE (another session) — both just become `setState`.\n *\n * The handle's stream is synchronous fan-out, so this coexists with the kernel's\n * own subscription (page registry) on the same handle.\n */\nexport function registerMetadataEffects(ctx: EffectContext<MetadataState, MetadataAction>): void {\n  const doc = ctx.doc;\n  if (!doc) return;\n\n  // 1. seed\n  void doc.metadata.read().then(\n    (metadata) => ctx.dispatch({ type: 'SET', metadata }),\n    () => {}, // doc closed / read aborted — ignore\n  );\n\n  // 2. live updates (own edits + remote SSE edits)\n  const unsubscribe = doc.events.subscribe((event: DocumentEvent) => {\n    if (event.type === 'metadata.updated') {\n      ctx.dispatch({ type: 'SET', metadata: event.metadata });\n    }\n  });\n  ctx.cleanup(unsubscribe);\n}\n","import type { MetadataAction, MetadataState } from './types';\n\nexport const initialMetadataState = (): MetadataState => ({ metadata: null });\n\n/** Pure. The only transition: replace the metadata snapshot (from a read or an\n *  event). */\nexport const metadataReducer = (state: MetadataState, a: MetadataAction): MetadataState =>\n  a.type === 'SET' ? { ...state, metadata: a.metadata } : state;\n","import { createCapabilityToken, type DocumentMetadata, type MetadataPatch } from '@embedpdf/core';\n\n/**\n * The document's Info-dict metadata, held as REACTIVE state — not a one-shot\n * read. It changes from local edits AND from other sessions (a remote edit\n * arrives over SSE as a `metadata.updated` event), so the plugin subscribes to\n * the document event stream and keeps `current()` live. `update` writes a\n * three-state patch into the LAYER (like a page mutation), so a metadata edit\n * saves with the layer.\n */\nexport interface MetadataState {\n  /** Current metadata, or null until the first read resolves. */\n  metadata: DocumentMetadata | null;\n}\n\nexport type MetadataAction = { type: 'SET'; metadata: DocumentMetadata | null };\n\nexport interface MetadataCapability {\n  /**\n   * Whether this caller is authorized to edit the Info dict —\n   * `effectiveScope` includes `doc.metadata.modify` (PDF bit 4). UIs gate their\n   * edit affordances on this; the engine independently enforces the same\n   * capability and throws `PermissionDenied` if a write slips through.\n   */\n  canEdit(): boolean;\n  /** Current metadata; null until the initial read lands. Reactive — reflects\n   *  own edits and remote (SSE) edits via the event stream. */\n  current(): DocumentMetadata | null;\n  /** Patch the Info dict (undefined=leave, null=clear, value=set). Writes to the\n   *  layer; state refreshes from the resulting `metadata.updated` event. */\n  update(patch: MetadataPatch): Promise<void>;\n  /** Force a re-read from the engine (rarely needed — the event stream keeps\n   *  state fresh). */\n  reload(): Promise<void>;\n}\n\nexport const MetadataToken = createCapabilityToken<MetadataCapability>('metadata');\n","import { definePlugin } from '@embedpdf/core';\nimport { createMetadataCapability } from './capability';\nimport { registerMetadataEffects } from './effects';\nimport { initialMetadataState, metadataReducer } from './reducer';\nimport { MetadataToken } from './types';\nimport type { MetadataAction, MetadataCapability, MetadataState } from './types';\n\n/**\n * Document-scoped metadata plugin: reactive Info-dict state. The effect seeds it\n * from the engine and keeps it live off the document event stream (own + remote\n * SSE edits); the capability is the read/write surface.\n */\nexport const metadataPlugin = () =>\n  definePlugin<MetadataState, MetadataAction, MetadataCapability>({\n    id: 'metadata',\n    token: MetadataToken,\n    scope: 'document',\n    initialState: initialMetadataState,\n    reduce: metadataReducer,\n    capability: createMetadataCapability,\n    effects: registerMetadataEffects,\n  });\n"],"mappings":";;;;;;;;;;AAUA,MAAM,6BAA4C;;;;;;AAOlD,SAAgB,yBACd,KACoB;CACpB,MAAM,mBAAmB;EACvB,MAAM,MAAM,IAAI;EAChB,IAAI,CAAC,KAAK,MAAM,IAAI,MAAM,8BAA8B;EACxD,OAAO;CACT;CAEA,OAAO;EACL,UAAU;GAKR,OAAO,IAAI,KAAK,SAAS,OAAO,0BAA0B,KAAK;EACjE;EAEA,eAAe,IAAI,SAAS,CAAC,CAAC;EAE9B,QAAQ,OAAO,UAAU;GAGvB,MAAM,SAAS,MAAM,WAAW,CAAC,CAAC,SAAS,OAAO,KAAK;GACvD,IAAI,SAAS;IAAE,MAAM;IAAO,UAAU,OAAO;GAAS,CAAC;EACzD;EAEA,QAAQ,YAAY;GAClB,MAAM,WAAW,MAAM,WAAW,CAAC,CAAC,SAAS,KAAK;GAClD,IAAI,SAAS;IAAE,MAAM;IAAO;GAAS,CAAC;EACxC;CACF;AACF;;;;;;;;;;;;;;ACnCA,SAAgB,wBAAwB,KAAyD;CAC/F,MAAM,MAAM,IAAI;CAChB,IAAI,CAAC,KAAK;CAGV,IAAS,SAAS,KAAK,CAAC,CAAC,MACtB,aAAa,IAAI,SAAS;EAAE,MAAM;EAAO;CAAS,CAAC,SAC9C,CAAC,CACT;CAGA,MAAM,cAAc,IAAI,OAAO,WAAW,UAAyB;EACjE,IAAI,MAAM,SAAS,oBACjB,IAAI,SAAS;GAAE,MAAM;GAAO,UAAU,MAAM;EAAS,CAAC;CAE1D,CAAC;CACD,IAAI,QAAQ,WAAW;AACzB;;;AC7BA,MAAa,8BAA6C,EAAE,UAAU,KAAK;;;AAI3E,MAAa,mBAAmB,OAAsB,MACpD,EAAE,SAAS,QAAQ;CAAE,GAAG;CAAO,UAAU,EAAE;AAAS,IAAI;;;AC6B1D,MAAa,iBAAA,GAAA,eAAA,sBAAA,CAA0D,UAAU;;;;;;;;ACxBjF,MAAa,wBAAA,GAAA,eAAA,aAAA,CACqD;CAC9D,IAAI;CACJ,OAAO;CACP,OAAO;CACP,cAAc;CACd,QAAQ;CACR,YAAY;CACZ,SAAS;AACX,CAAC"}

package/dist/index.d.cts

@@ -0,0 +1,48 @@
+import { DocumentMetadata, MetadataPatch } from "@embedpdf/core";
+//#region src/types.d.ts
+/**
+ * The document's Info-dict metadata, held as REACTIVE state — not a one-shot
+ * read. It changes from local edits AND from other sessions (a remote edit
+ * arrives over SSE as a `metadata.updated` event), so the plugin subscribes to
+ * the document event stream and keeps `current()` live. `update` writes a
+ * three-state patch into the LAYER (like a page mutation), so a metadata edit
+ * saves with the layer.
+ */
+interface MetadataState {
+  /** Current metadata, or null until the first read resolves. */
+  metadata: DocumentMetadata | null;
+}
+type MetadataAction = {
+  type: 'SET';
+  metadata: DocumentMetadata | null;
+};
+interface MetadataCapability {
+  /**
+   * Whether this caller is authorized to edit the Info dict —
+   * `effectiveScope` includes `doc.metadata.modify` (PDF bit 4). UIs gate their
+   * edit affordances on this; the engine independently enforces the same
+   * capability and throws `PermissionDenied` if a write slips through.
+   */
+  canEdit(): boolean;
+  /** Current metadata; null until the initial read lands. Reactive — reflects
+   *  own edits and remote (SSE) edits via the event stream. */
+  current(): DocumentMetadata | null;
+  /** Patch the Info dict (undefined=leave, null=clear, value=set). Writes to the
+   *  layer; state refreshes from the resulting `metadata.updated` event. */
+  update(patch: MetadataPatch): Promise<void>;
+  /** Force a re-read from the engine (rarely needed — the event stream keeps
+   *  state fresh). */
+  reload(): Promise<void>;
+}
+declare const MetadataToken: import("@embedpdf/core").CapabilityToken<MetadataCapability>;
+//#endregion
+//#region src/metadata.plugin.d.ts
+/**
+ * Document-scoped metadata plugin: reactive Info-dict state. The effect seeds it
+ * from the engine and keeps it live off the document event stream (own + remote
+ * SSE edits); the capability is the read/write surface.
+ */
+declare const metadataPlugin: () => import("@embedpdf/core").PluginDef<MetadataState, MetadataAction, MetadataCapability>;
+//#endregion
+export { type MetadataCapability, type MetadataState, MetadataToken, metadataPlugin };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { DocumentMetadata, MetadataPatch } from "@embedpdf/core";
+//#region src/types.d.ts
+/**
+ * The document's Info-dict metadata, held as REACTIVE state — not a one-shot
+ * read. It changes from local edits AND from other sessions (a remote edit
+ * arrives over SSE as a `metadata.updated` event), so the plugin subscribes to
+ * the document event stream and keeps `current()` live. `update` writes a
+ * three-state patch into the LAYER (like a page mutation), so a metadata edit
+ * saves with the layer.
+ */
+interface MetadataState {
+  /** Current metadata, or null until the first read resolves. */
+  metadata: DocumentMetadata | null;
+}
+type MetadataAction = {
+  type: 'SET';
+  metadata: DocumentMetadata | null;
+};
+interface MetadataCapability {
+  /**
+   * Whether this caller is authorized to edit the Info dict —
+   * `effectiveScope` includes `doc.metadata.modify` (PDF bit 4). UIs gate their
+   * edit affordances on this; the engine independently enforces the same
+   * capability and throws `PermissionDenied` if a write slips through.
+   */
+  canEdit(): boolean;
+  /** Current metadata; null until the initial read lands. Reactive — reflects
+   *  own edits and remote (SSE) edits via the event stream. */
+  current(): DocumentMetadata | null;
+  /** Patch the Info dict (undefined=leave, null=clear, value=set). Writes to the
+   *  layer; state refreshes from the resulting `metadata.updated` event. */
+  update(patch: MetadataPatch): Promise<void>;
+  /** Force a re-read from the engine (rarely needed — the event stream keeps
+   *  state fresh). */
+  reload(): Promise<void>;
+}
+declare const MetadataToken: import("@embedpdf/core").CapabilityToken<MetadataCapability>;
+//#endregion
+//#region src/metadata.plugin.d.ts
+/**
+ * Document-scoped metadata plugin: reactive Info-dict state. The effect seeds it
+ * from the engine and keeps it live off the document event stream (own + remote
+ * SSE edits); the capability is the read/write surface.
+ */
+declare const metadataPlugin: () => import("@embedpdf/core").PluginDef<MetadataState, MetadataAction, MetadataCapability>;
+//#endregion
+export { type MetadataCapability, type MetadataState, MetadataToken, metadataPlugin };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,102 @@
+import { createCapabilityToken, definePlugin } from "@embedpdf/core";
+//#region src/capability.ts
+/**
+* Authorization for Info-dict writes. Maps to PDF bit 4 (MODIFY). The engine
+* ALSO enforces this — `metadata.update` throws `PermissionDenied` without it,
+* identically on local and cloud — so `canEdit()` is the UI mirror of a real
+* guard, not the guard itself. Typed as `DocCapability` so a typo is a compile
+* error.
+*/
+const METADATA_MODIFY_CAPABILITY = "doc.metadata.modify";
+/**
+* Reads/writes the document's Info dict through the engine handle and keeps the
+* plugin's state in sync. The live-update wiring (own + remote events) lives in
+* the effect; this is the read/write surface.
+*/
+function createMetadataCapability(ctx) {
+	const requireDoc = () => {
+		const doc = ctx.doc;
+		if (!doc) throw new Error("[metadata] no document bound");
+		return doc;
+	};
+	return {
+		canEdit() {
+			return ctx.doc?.security.allows(METADATA_MODIFY_CAPABILITY) ?? false;
+		},
+		current: () => ctx.getState().metadata,
+		update: async (patch) => {
+			const result = await requireDoc().metadata.update(patch);
+			ctx.dispatch({
+				type: "SET",
+				metadata: result.metadata
+			});
+		},
+		reload: async () => {
+			const metadata = await requireDoc().metadata.read();
+			ctx.dispatch({
+				type: "SET",
+				metadata
+			});
+		}
+	};
+}
+//#endregion
+//#region src/effects.ts
+/**
+* Makes metadata REACTIVE — the reason this is a plugin, not a kernel IO call.
+*
+*  1. Seed: read the Info dict once when the document opens.
+*  2. Live: subscribe to the document event stream. A `metadata.updated` event
+*     carries the full re-read metadata and fires for OWN edits AND for remote
+*     edits delivered over SSE (another session) — both just become `setState`.
+*
+* The handle's stream is synchronous fan-out, so this coexists with the kernel's
+* own subscription (page registry) on the same handle.
+*/
+function registerMetadataEffects(ctx) {
+	const doc = ctx.doc;
+	if (!doc) return;
+	doc.metadata.read().then((metadata) => ctx.dispatch({
+		type: "SET",
+		metadata
+	}), () => {});
+	const unsubscribe = doc.events.subscribe((event) => {
+		if (event.type === "metadata.updated") ctx.dispatch({
+			type: "SET",
+			metadata: event.metadata
+		});
+	});
+	ctx.cleanup(unsubscribe);
+}
+//#endregion
+//#region src/reducer.ts
+const initialMetadataState = () => ({ metadata: null });
+/** Pure. The only transition: replace the metadata snapshot (from a read or an
+*  event). */
+const metadataReducer = (state, a) => a.type === "SET" ? {
+	...state,
+	metadata: a.metadata
+} : state;
+//#endregion
+//#region src/types.ts
+const MetadataToken = createCapabilityToken("metadata");
+//#endregion
+//#region src/metadata.plugin.ts
+/**
+* Document-scoped metadata plugin: reactive Info-dict state. The effect seeds it
+* from the engine and keeps it live off the document event stream (own + remote
+* SSE edits); the capability is the read/write surface.
+*/
+const metadataPlugin = () => definePlugin({
+	id: "metadata",
+	token: MetadataToken,
+	scope: "document",
+	initialState: initialMetadataState,
+	reduce: metadataReducer,
+	capability: createMetadataCapability,
+	effects: registerMetadataEffects
+});
+//#endregion
+export { MetadataToken, metadataPlugin };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/capability.ts","../src/effects.ts","../src/reducer.ts","../src/types.ts","../src/metadata.plugin.ts"],"sourcesContent":["import type { PluginContext, DocCapability } from '@embedpdf/core';\nimport type { MetadataAction, MetadataCapability, MetadataState } from './types';\n\n/**\n * Authorization for Info-dict writes. Maps to PDF bit 4 (MODIFY). The engine\n * ALSO enforces this — `metadata.update` throws `PermissionDenied` without it,\n * identically on local and cloud — so `canEdit()` is the UI mirror of a real\n * guard, not the guard itself. Typed as `DocCapability` so a typo is a compile\n * error.\n */\nconst METADATA_MODIFY_CAPABILITY: DocCapability = 'doc.metadata.modify';\n\n/**\n * Reads/writes the document's Info dict through the engine handle and keeps the\n * plugin's state in sync. The live-update wiring (own + remote events) lives in\n * the effect; this is the read/write surface.\n */\nexport function createMetadataCapability(\n  ctx: PluginContext<MetadataState, MetadataAction>,\n): MetadataCapability {\n  const requireDoc = () => {\n    const doc = ctx.doc;\n    if (!doc) throw new Error('[metadata] no document bound');\n    return doc;\n  };\n\n  return {\n    canEdit() {\n      // Wildcard-aware predicate (mirrors the engine's own enforcement),\n      // identical on both engines. NOT `effectiveScope.includes(...)` — that\n      // enumeration drops the `*` admin grant, so it would hide the UI on a\n      // default admin open even though the engine allows the edit.\n      return ctx.doc?.security.allows(METADATA_MODIFY_CAPABILITY) ?? false;\n    },\n\n    current: () => ctx.getState().metadata,\n\n    update: async (patch) => {\n      // The write also emits a `metadata.updated` event the effect catches, so\n      // this dispatch is just for an immediate, in-sync update (idempotent).\n      const result = await requireDoc().metadata.update(patch);\n      ctx.dispatch({ type: 'SET', metadata: result.metadata });\n    },\n\n    reload: async () => {\n      const metadata = await requireDoc().metadata.read();\n      ctx.dispatch({ type: 'SET', metadata });\n    },\n  };\n}\n","import type { DocumentEvent, EffectContext } from '@embedpdf/core';\nimport type { MetadataAction, MetadataState } from './types';\n\n/**\n * Makes metadata REACTIVE — the reason this is a plugin, not a kernel IO call.\n *\n *  1. Seed: read the Info dict once when the document opens.\n *  2. Live: subscribe to the document event stream. A `metadata.updated` event\n *     carries the full re-read metadata and fires for OWN edits AND for remote\n *     edits delivered over SSE (another session) — both just become `setState`.\n *\n * The handle's stream is synchronous fan-out, so this coexists with the kernel's\n * own subscription (page registry) on the same handle.\n */\nexport function registerMetadataEffects(ctx: EffectContext<MetadataState, MetadataAction>): void {\n  const doc = ctx.doc;\n  if (!doc) return;\n\n  // 1. seed\n  void doc.metadata.read().then(\n    (metadata) => ctx.dispatch({ type: 'SET', metadata }),\n    () => {}, // doc closed / read aborted — ignore\n  );\n\n  // 2. live updates (own edits + remote SSE edits)\n  const unsubscribe = doc.events.subscribe((event: DocumentEvent) => {\n    if (event.type === 'metadata.updated') {\n      ctx.dispatch({ type: 'SET', metadata: event.metadata });\n    }\n  });\n  ctx.cleanup(unsubscribe);\n}\n","import type { MetadataAction, MetadataState } from './types';\n\nexport const initialMetadataState = (): MetadataState => ({ metadata: null });\n\n/** Pure. The only transition: replace the metadata snapshot (from a read or an\n *  event). */\nexport const metadataReducer = (state: MetadataState, a: MetadataAction): MetadataState =>\n  a.type === 'SET' ? { ...state, metadata: a.metadata } : state;\n","import { createCapabilityToken, type DocumentMetadata, type MetadataPatch } from '@embedpdf/core';\n\n/**\n * The document's Info-dict metadata, held as REACTIVE state — not a one-shot\n * read. It changes from local edits AND from other sessions (a remote edit\n * arrives over SSE as a `metadata.updated` event), so the plugin subscribes to\n * the document event stream and keeps `current()` live. `update` writes a\n * three-state patch into the LAYER (like a page mutation), so a metadata edit\n * saves with the layer.\n */\nexport interface MetadataState {\n  /** Current metadata, or null until the first read resolves. */\n  metadata: DocumentMetadata | null;\n}\n\nexport type MetadataAction = { type: 'SET'; metadata: DocumentMetadata | null };\n\nexport interface MetadataCapability {\n  /**\n   * Whether this caller is authorized to edit the Info dict —\n   * `effectiveScope` includes `doc.metadata.modify` (PDF bit 4). UIs gate their\n   * edit affordances on this; the engine independently enforces the same\n   * capability and throws `PermissionDenied` if a write slips through.\n   */\n  canEdit(): boolean;\n  /** Current metadata; null until the initial read lands. Reactive — reflects\n   *  own edits and remote (SSE) edits via the event stream. */\n  current(): DocumentMetadata | null;\n  /** Patch the Info dict (undefined=leave, null=clear, value=set). Writes to the\n   *  layer; state refreshes from the resulting `metadata.updated` event. */\n  update(patch: MetadataPatch): Promise<void>;\n  /** Force a re-read from the engine (rarely needed — the event stream keeps\n   *  state fresh). */\n  reload(): Promise<void>;\n}\n\nexport const MetadataToken = createCapabilityToken<MetadataCapability>('metadata');\n","import { definePlugin } from '@embedpdf/core';\nimport { createMetadataCapability } from './capability';\nimport { registerMetadataEffects } from './effects';\nimport { initialMetadataState, metadataReducer } from './reducer';\nimport { MetadataToken } from './types';\nimport type { MetadataAction, MetadataCapability, MetadataState } from './types';\n\n/**\n * Document-scoped metadata plugin: reactive Info-dict state. The effect seeds it\n * from the engine and keeps it live off the document event stream (own + remote\n * SSE edits); the capability is the read/write surface.\n */\nexport const metadataPlugin = () =>\n  definePlugin<MetadataState, MetadataAction, MetadataCapability>({\n    id: 'metadata',\n    token: MetadataToken,\n    scope: 'document',\n    initialState: initialMetadataState,\n    reduce: metadataReducer,\n    capability: createMetadataCapability,\n    effects: registerMetadataEffects,\n  });\n"],"mappings":";;;;;;;;;AAUA,MAAM,6BAA4C;;;;;;AAOlD,SAAgB,yBACd,KACoB;CACpB,MAAM,mBAAmB;EACvB,MAAM,MAAM,IAAI;EAChB,IAAI,CAAC,KAAK,MAAM,IAAI,MAAM,8BAA8B;EACxD,OAAO;CACT;CAEA,OAAO;EACL,UAAU;GAKR,OAAO,IAAI,KAAK,SAAS,OAAO,0BAA0B,KAAK;EACjE;EAEA,eAAe,IAAI,SAAS,CAAC,CAAC;EAE9B,QAAQ,OAAO,UAAU;GAGvB,MAAM,SAAS,MAAM,WAAW,CAAC,CAAC,SAAS,OAAO,KAAK;GACvD,IAAI,SAAS;IAAE,MAAM;IAAO,UAAU,OAAO;GAAS,CAAC;EACzD;EAEA,QAAQ,YAAY;GAClB,MAAM,WAAW,MAAM,WAAW,CAAC,CAAC,SAAS,KAAK;GAClD,IAAI,SAAS;IAAE,MAAM;IAAO;GAAS,CAAC;EACxC;CACF;AACF;;;;;;;;;;;;;;ACnCA,SAAgB,wBAAwB,KAAyD;CAC/F,MAAM,MAAM,IAAI;CAChB,IAAI,CAAC,KAAK;CAGV,IAAS,SAAS,KAAK,CAAC,CAAC,MACtB,aAAa,IAAI,SAAS;EAAE,MAAM;EAAO;CAAS,CAAC,SAC9C,CAAC,CACT;CAGA,MAAM,cAAc,IAAI,OAAO,WAAW,UAAyB;EACjE,IAAI,MAAM,SAAS,oBACjB,IAAI,SAAS;GAAE,MAAM;GAAO,UAAU,MAAM;EAAS,CAAC;CAE1D,CAAC;CACD,IAAI,QAAQ,WAAW;AACzB;;;AC7BA,MAAa,8BAA6C,EAAE,UAAU,KAAK;;;AAI3E,MAAa,mBAAmB,OAAsB,MACpD,EAAE,SAAS,QAAQ;CAAE,GAAG;CAAO,UAAU,EAAE;AAAS,IAAI;;;AC6B1D,MAAa,gBAAgB,sBAA0C,UAAU;;;;;;;;ACxBjF,MAAa,uBACX,aAAgE;CAC9D,IAAI;CACJ,OAAO;CACP,OAAO;CACP,cAAc;CACd,QAAQ;CACR,YAAY;CACZ,SAAS;AACX,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@embedpdf/plugin-metadata",
+  "version": "3.0.0-next.0",
+  "private": false,
+  "description": "Document-scoped metadata: reactive Info-dict state fed by the document event stream (own edits + remote SSE), with a three-state update that writes to the layer.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@embedpdf/core": "3.0.0-next.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "vitest": "^2.1.9",
+    "@embedpdf/tooling-build": "0.0.0"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/embedpdf/embed-pdf-viewer.git",
+    "directory": "packages/plugin/metadata"
+  },
+  "scripts": {
+    "build": "epdf-build",
+    "clean": "rimraf dist",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  }
+}