@docx-editor.dev/pro 2.0.0 → 2.1.0

package/dist/chunk-TNSHSAA4.cjs

@@ -1 +0,0 @@
-'use strict';var store=require('@docx-editor.dev/core/store'),layout=require('@docx-editor.dev/core/layout');function f(e){}var z=64,I=new Set(["__proto__","constructor","prototype"]);function p(e,i,r){let s=new URLSearchParams;for(let[o,d]of Object.entries(r))s.set(o,d);let a=s.toString(),t=a.length>0?`${e}:${i}?${a}`:`${e}:${i}`;return t.length>64?{ok:false,reason:"tag-overflow",length:t.length}:{ok:true,tag:t}}function g(e){if(e.length>64)return null;let i=e.indexOf(":");if(i<=0)return null;let r=e.slice(0,i),s=e.slice(i+1),a=s.indexOf("?"),t=a===-1?s:s.slice(0,a);if(t.length===0)return null;let o=Object.create(null);if(a!==-1)for(let[d,n]of new URLSearchParams(s.slice(a+1))){if(I.has(d))return null;o[d]=n;}return {prefix:r,name:t,attrs:o}}function x(e){return typeof e=="object"&&e!==null&&typeof e.name=="string"&&typeof e.tagPrefix=="string"}var y=/^[A-Za-z0-9_.-]+$/;function U(e){if(!y.test(e.name??""))throw new Error(`defineCustomNode: invalid name ${JSON.stringify(e.name)}`);if(!y.test(e.tagPrefix??""))throw new Error(`defineCustomNode: invalid tagPrefix ${JSON.stringify(e.tagPrefix)}`);return Object.freeze({...e})}function F(e){return f(e.licenseKey),{id:"custom-nodes",customNodes:e.nodes}}function k(e){for(let i of e.children)if(!(i.kind==="textValue"||i.localName!=="sdtPr")){for(let r of i.children)if(!(r.kind==="textValue"||r.localName!=="tag")){for(let s of r.attributes)if(s.localName==="val")return s.value}}}function v(e){if(e.kind==="textValue")return e.value;let i="";for(let r of e.children)i+=v(r);return i}function N(e,i){if(i.length===0)return [];let r=new Map;for(let t of i){let o=`${t.tagPrefix}:${t.name}`;if(r.has(o))throw new Error(`recognizeCustomNodes: duplicate definition for ${JSON.stringify(o)}`);r.set(o,t);}let s=[],a=(t,o)=>{if(!(t.kind==="textValue"||o>64)){if(t.kind==="contentControl"){let d=k(t),n=d!==void 0?g(d):null,l=n?r.get(`${n.prefix}:${n.name}`):void 0;if(n&&l&&d!==void 0){let c=v(t),u=l.fromDocx?l.fromDocx({attrs:n.attrs,text:c}):n.attrs;if(u!==null){s.push({name:l.name,attrs:u,text:c,nodeId:t.id,tag:d});return}}}for(let d of t.children)a(d,o+1);}};return a(e.root,0),s}function R(e,i){let r=store.findNode(e,i);return !r||r.kind!=="paragraph"?[]:store.revisionItemsOf({id:e.id,name:e.name,contentType:e.contentType,root:r})}function b(e,i){let r=i.filter(o=>o.reviewCard);if(r.length===0)return [];let s=N(e,r);if(s.length===0)return [];let a=store.locateSites(e),t=[];for(let o of s){let d=r.find(c=>c.name===o.name&&o.tag.startsWith(`${c.tagPrefix}:`));if(!d)continue;let n=d.reviewCard({attrs:o.attrs,text:o.text});if(n===null)continue;let l=a.get(o.nodeId);t.push({kind:"custom",id:o.nodeId,name:o.name,tag:o.tag,attrs:o.attrs,text:o.text,title:n.title,...n.detail!==void 0?{detail:n.detail}:{},range:l?{partName:e.name,start:{paragraphId:l.paragraphId,offset:l.start},end:{paragraphId:l.paragraphId,offset:l.end}}:null});}return t}function O(e){let i=store.collectReviewItems(e),r=(e.customNodes??[]).filter(x);if(r.length===0)return i;let s=[e.storyPart],a=new Set([e.storyPart.name]);for(let n of e.furnitureParts??[])a.has(n.name)||(a.add(n.name),s.push(n));let t=[],o=new Map;for(let n of s){t.push(...b(n,r));let l=o.size;for(let[c,u]of store.paragraphOrderOfPart(n))o.has(c)||o.set(c,l+u);}return t.length===0?i:[...i,...t].sort((n,l)=>layout.reviewItemPositionRank(n,o)-layout.reviewItemPositionRank(l,o))}function se(e={}){return f(e.licenseKey),{id:"review",review:{displayModes:["all-markup","proposed","original"],collectReviewItems:O,revisionItemsOfParagraph:R}}}function w(e){return e.surface??null}function _(e,i){let r=null,s=t=>t.id===i?true:t.kind==="textValue"?false:t.children.some(s),a=(t,o)=>{if(!(r||t.kind==="textValue"||o>64)){if(t.kind==="paragraph"){s(t)&&(r=t);return}for(let d of t.children)a(d,o+1);}};return a(e.root,0),r}function A(e,i){let r=new Set,s=n=>{if(r.add(n.id),n.kind!=="textValue")for(let l of n.children)s(l);},a=n=>{if(n.id===i)return n;if(n.kind==="textValue")return null;for(let l of n.children){let c=a(l);if(c)return c}return null},t=a(e);if(!t)return null;s(t);let o=Number.MAX_SAFE_INTEGER,d=-1;for(let n of store.segmentsOf(e))r.has(n.runId)&&(n.start<o&&(o=n.start),n.end>d&&(d=n.end));return d<0?null:{start:o,end:d}}function ce(e,i){let r=w(e);if(!r)return {ok:false,code:"notFound",reason:"no document is mounted"};let s=r.session.applyTreeOps([{op:"removeContentControl",controlId:i,keepContent:false}]);return s.committed?{ok:true,changed:true}:{ok:false,code:"unsupported",reason:typeof s.reason=="string"?s.reason:"the removal was refused"}}function ue(e,i,r,s,a,t={}){let o=w(e);if(!o)return {ok:false,code:"notFound",reason:"no document is mounted"};let d=p(i.tagPrefix,i.name,s);if(!d.ok)return {ok:false,code:"invalidArgs",reason:`the encoded tag is ${d.length} characters; Word caps w:tag at 64 \u2014 shorten the attrs`};let n=o.session.part(),l=_(n,r),c=l?A(l,r):null;if(!l||!c)return {ok:false,code:"notFound",reason:"no custom node with that id"};let u=t.lock===void 0?"contentLocked":t.lock,m=o.session.applyTreeOps([{op:"removeContentControl",controlId:r,keepContent:false},{op:"insertInlineContentControl",paragraphId:l.id,offset:c.start,tag:d.tag,text:a,...t.alias===void 0?{}:{alias:t.alias},...u===false?{}:{lock:u}}]);return m.committed?{ok:true,changed:true}:{ok:false,code:"unsupported",reason:typeof m.reason=="string"?m.reason:"the update was refused"}}exports.a=z;exports.b=p;exports.c=g;exports.d=x;exports.e=y;exports.f=U;exports.g=F;exports.h=N;exports.i=se;exports.j=ce;exports.k=ue;

package/dist/define-custom-node-CkkDPdB0.d.cts

@@ -1,191 +0,0 @@
-import { EditorModule } from '@docx-editor.dev/core/editor';
-import { OoxmlPart } from '@docx-editor.dev/core/store';
-
-/**
- * Licensing, v1: honor system.
- *
- * The key is accepted and remembered so that adding offline (Ed25519)
- * verification later is not a breaking change — but nothing validates it,
- * nothing warns, nothing renders differently, and NOTHING EVER LEAVES THE
- * PROCESS: no network request is made for licensing, ever. That last property
- * is a spec requirement (`pro-licensing`), not an implementation detail.
- */
-/** Accepted by every pro entry point. */
-interface ProLicenseOptions {
-    /**
-     * Your license key from docx-editor.dev. Optional in v1: unlicensed use in
-     * development and evaluation is permitted, production use requires a
-     * license (see LICENSE.md) — the package trusts you either way.
-     */
-    readonly licenseKey?: string;
-}
-
-/**
- * The review module: comments, tracked changes, and markup rendering as an
- * `EditorModule` for `createDocxEditor({ modules })`.
- *
- * Registering it is the whole enablement story: the review chrome slots light
- * up through the same `toolbarCommandState` they were disabled by, suggesting
- * mode becomes reachable, and the editor renders revisions in markup rather
- * than the free tier's final-state projection.
- */
-
-/**
- * How {@link reviewModule} is configured. Carries only the licence key today, so
- * `reviewModule()` with no argument is the ordinary call.
- *
- * @public
- */
-interface ReviewModuleOptions extends ProLicenseOptions {
-}
-/** Build the review module. Construction never validates the key and never touches the network. */
-declare function reviewModule(options?: ReviewModuleOptions): EditorModule;
-
-/** A recognized custom node: one inline SDT whose tag matched a definition. */
-interface RecognizedCustomNode {
-    /** The definition's `name`. */
-    readonly name: string;
-    /** Attrs after the definition's `fromDocx` had its say. Untrusted input. */
-    readonly attrs: Readonly<Record<string, string>>;
-    /** The SDT's literal content text — what Word users see and may have edited. */
-    readonly text: string;
-    /** The SDT node's stable id in the canonical tree. */
-    readonly nodeId: string;
-    /** The raw `w:tag` the node was recognized from. */
-    readonly tag: string;
-}
-/**
- * One integrator-defined inline node, anchored on a run-level SDT whose `w:tag` carries its
- * identity.
- *
- * A definition claims a tag PREFIX, so `acme` recognizes every `acme:*` tag. An SDT whose prefix
- * no definition claims stays literal — which is also what the free tier and Word itself render,
- * so an unrecognized node never loses content or locks editing.
- *
- * Build one with {@link defineCustomNode}, which validates the shape, then register it through
- * {@link customNodesModule}.
- *
- * @example
- * ```ts
- * const citation = defineCustomNode({
- *   name: 'citation',
- *   tagPrefix: 'acme',
- *   chrome: { color: '#2563eb' },
- *   onClick: (node) => openCitation(node.attrs.key),
- * });
- * ```
- *
- * @public
- */
-interface CustomNodeDefinition {
-    /** Node type name — the second segment of the tag (`<prefix>:<name>?…`). */
-    readonly name: string;
-    /** Tag prefix this definition claims (`acme` claims `acme:*`). No colons. */
-    readonly tagPrefix: string;
-    /**
-     * Recognition hook. Receives the decoded attrs and the SDT's literal text
-     * (so label drift from Word edits is visible) and returns the attrs the node
-     * should carry — or null to leave this SDT unrecognized and literal.
-     *
-     * Every input value originates in a file an attacker controls; treat it as
-     * untrusted and never build DOM or URLs from it without sanitizing.
-     */
-    readonly fromDocx?: (input: {
-        readonly attrs: Readonly<Record<string, string>>;
-        readonly text: string;
-    }) => Readonly<Record<string, string>> | null;
-    /**
-     * Chip appearance, HOST-authored (never file data). `color` tints the chip
-     * and its border; applied by `CustomNodeChrome` from `@docx-editor.dev/pro/react`.
-     */
-    readonly chrome?: {
-        readonly color?: string;
-    };
-    /** Click on the painted chip. UI state belongs in `CustomNodeChrome`'s `onNodeClick`. */
-    readonly onClick?: (node: ActivatedCustomNode) => void;
-    /** Pointer enters the painted chip. */
-    readonly onHover?: (node: ActivatedCustomNode) => void;
-    /**
-     * Contribute a card to the review sidebar for every recognized node of this
-     * definition, anchored at the node's range. Return null to skip one node.
-     *
-     * `attrs` and `text` originate in the file — untrusted; the returned strings
-     * are rendered as TEXT by the pane, never markup. The context-menu section
-     * reuses this hook for its info block and may invoke it with `text: ''` when
-     * no review module is registered (the DOM decode alone cannot see the text).
-     */
-    readonly reviewCard?: (node: {
-        readonly attrs: Readonly<Record<string, string>>;
-        readonly text: string;
-    }) => {
-        readonly title: string;
-        readonly detail?: string;
-    } | null;
-    /**
-     * The "Edit {label}" row the context menu shows at the top when the
-     * right-click lands on the node's chip. The HOST owns the dialog.
-     *
-     * HONEST LIMIT: there is no in-place update call yet — re-authoring is
-     * `removeContentControl` + `insertCustomNode` at the node's range (the
-     * activation carries `nodeId` and, when a review module is registered, the
-     * current `text` to prefill a form). Schema-driven edit forms are the planned
-     * follow-up.
-     */
-    readonly onEdit?: (node: ActivatedCustomNode) => void;
-    /**
-     * Display name for chrome — the "Edit {label}" context-menu row. Defaults to
-     * `name`. Host-authored, never file data; provide a localized string.
-     */
-    readonly label?: string;
-}
-/**
- * A chip activation: identity + attrs, plus where it sits.
- *
- * `attrs` are the definition's OWN shape — the raw tag decode has already been
- * through `fromDocx`, exactly as the review derivation runs it, so every
- * surface (click, hover, edit, cards) sees one attrs vocabulary. `text` and
- * `nodeId` are present when the surface could resolve them (a registered
- * review module resolves both).
- */
-interface ActivatedCustomNode {
-    readonly name: string;
-    readonly attrs: Readonly<Record<string, string>>;
-    readonly tag: string;
-    /** Viewport-relative rect of the chip's boundary, for anchoring host UI. */
-    readonly rect: DOMRect;
-    /** The SDT node's canonical id — the address `removeContentControl` takes. */
-    readonly nodeId?: string;
-    /** The node's literal content text, when resolvable. */
-    readonly text?: string;
-}
-/**
- * Whether an opaque registry value is a custom-node definition.
- *
- * The engine carries registered definitions as unknowns (`getCustomNodeDefinitions`), so
- * every pro surface that reads them back narrows through this ONE guard.
- */
-declare function isCustomNodeDefinition(candidate: unknown): candidate is CustomNodeDefinition;
-/** Validate and freeze a definition. Throws on a shape mistake — author error, not file input. */
-declare function defineCustomNode(definition: CustomNodeDefinition): CustomNodeDefinition;
-/**
- * How {@link customNodesModule} is configured.
- *
- * @public
- */
-interface CustomNodesModuleOptions extends ProLicenseOptions {
-    /** The definitions this editor recognizes. A tag prefix no definition claims stays literal. */
-    readonly nodes: readonly CustomNodeDefinition[];
-}
-/** Register custom node definitions with `createDocxEditor({ modules })`. */
-declare function customNodesModule(options: CustomNodesModuleOptions): EditorModule;
-/**
- * Every recognized custom node in one story, in document order.
- *
- * Tag-prefix keyed, exactly as the change specifies: an inline SDT whose tag
- * decodes to a registered `<prefix>:<name>` pair is offered to that
- * definition's `fromDocx`; everything else — foreign tags, unregistered
- * prefixes, a `fromDocx` veto — stays a literal SDT.
- */
-declare function recognizeCustomNodes(part: OoxmlPart, definitions: readonly CustomNodeDefinition[]): RecognizedCustomNode[];
-
-export { type ActivatedCustomNode as A, type CustomNodeDefinition as C, type ProLicenseOptions as P, type RecognizedCustomNode as R, type CustomNodesModuleOptions as a, type ReviewModuleOptions as b, customNodesModule as c, defineCustomNode as d, reviewModule as e, isCustomNodeDefinition as i, recognizeCustomNodes as r };

package/dist/define-custom-node-CkkDPdB0.d.ts

@@ -1,191 +0,0 @@
-import { EditorModule } from '@docx-editor.dev/core/editor';
-import { OoxmlPart } from '@docx-editor.dev/core/store';
-
-/**
- * Licensing, v1: honor system.
- *
- * The key is accepted and remembered so that adding offline (Ed25519)
- * verification later is not a breaking change — but nothing validates it,
- * nothing warns, nothing renders differently, and NOTHING EVER LEAVES THE
- * PROCESS: no network request is made for licensing, ever. That last property
- * is a spec requirement (`pro-licensing`), not an implementation detail.
- */
-/** Accepted by every pro entry point. */
-interface ProLicenseOptions {
-    /**
-     * Your license key from docx-editor.dev. Optional in v1: unlicensed use in
-     * development and evaluation is permitted, production use requires a
-     * license (see LICENSE.md) — the package trusts you either way.
-     */
-    readonly licenseKey?: string;
-}
-
-/**
- * The review module: comments, tracked changes, and markup rendering as an
- * `EditorModule` for `createDocxEditor({ modules })`.
- *
- * Registering it is the whole enablement story: the review chrome slots light
- * up through the same `toolbarCommandState` they were disabled by, suggesting
- * mode becomes reachable, and the editor renders revisions in markup rather
- * than the free tier's final-state projection.
- */
-
-/**
- * How {@link reviewModule} is configured. Carries only the licence key today, so
- * `reviewModule()` with no argument is the ordinary call.
- *
- * @public
- */
-interface ReviewModuleOptions extends ProLicenseOptions {
-}
-/** Build the review module. Construction never validates the key and never touches the network. */
-declare function reviewModule(options?: ReviewModuleOptions): EditorModule;
-
-/** A recognized custom node: one inline SDT whose tag matched a definition. */
-interface RecognizedCustomNode {
-    /** The definition's `name`. */
-    readonly name: string;
-    /** Attrs after the definition's `fromDocx` had its say. Untrusted input. */
-    readonly attrs: Readonly<Record<string, string>>;
-    /** The SDT's literal content text — what Word users see and may have edited. */
-    readonly text: string;
-    /** The SDT node's stable id in the canonical tree. */
-    readonly nodeId: string;
-    /** The raw `w:tag` the node was recognized from. */
-    readonly tag: string;
-}
-/**
- * One integrator-defined inline node, anchored on a run-level SDT whose `w:tag` carries its
- * identity.
- *
- * A definition claims a tag PREFIX, so `acme` recognizes every `acme:*` tag. An SDT whose prefix
- * no definition claims stays literal — which is also what the free tier and Word itself render,
- * so an unrecognized node never loses content or locks editing.
- *
- * Build one with {@link defineCustomNode}, which validates the shape, then register it through
- * {@link customNodesModule}.
- *
- * @example
- * ```ts
- * const citation = defineCustomNode({
- *   name: 'citation',
- *   tagPrefix: 'acme',
- *   chrome: { color: '#2563eb' },
- *   onClick: (node) => openCitation(node.attrs.key),
- * });
- * ```
- *
- * @public
- */
-interface CustomNodeDefinition {
-    /** Node type name — the second segment of the tag (`<prefix>:<name>?…`). */
-    readonly name: string;
-    /** Tag prefix this definition claims (`acme` claims `acme:*`). No colons. */
-    readonly tagPrefix: string;
-    /**
-     * Recognition hook. Receives the decoded attrs and the SDT's literal text
-     * (so label drift from Word edits is visible) and returns the attrs the node
-     * should carry — or null to leave this SDT unrecognized and literal.
-     *
-     * Every input value originates in a file an attacker controls; treat it as
-     * untrusted and never build DOM or URLs from it without sanitizing.
-     */
-    readonly fromDocx?: (input: {
-        readonly attrs: Readonly<Record<string, string>>;
-        readonly text: string;
-    }) => Readonly<Record<string, string>> | null;
-    /**
-     * Chip appearance, HOST-authored (never file data). `color` tints the chip
-     * and its border; applied by `CustomNodeChrome` from `@docx-editor.dev/pro/react`.
-     */
-    readonly chrome?: {
-        readonly color?: string;
-    };
-    /** Click on the painted chip. UI state belongs in `CustomNodeChrome`'s `onNodeClick`. */
-    readonly onClick?: (node: ActivatedCustomNode) => void;
-    /** Pointer enters the painted chip. */
-    readonly onHover?: (node: ActivatedCustomNode) => void;
-    /**
-     * Contribute a card to the review sidebar for every recognized node of this
-     * definition, anchored at the node's range. Return null to skip one node.
-     *
-     * `attrs` and `text` originate in the file — untrusted; the returned strings
-     * are rendered as TEXT by the pane, never markup. The context-menu section
-     * reuses this hook for its info block and may invoke it with `text: ''` when
-     * no review module is registered (the DOM decode alone cannot see the text).
-     */
-    readonly reviewCard?: (node: {
-        readonly attrs: Readonly<Record<string, string>>;
-        readonly text: string;
-    }) => {
-        readonly title: string;
-        readonly detail?: string;
-    } | null;
-    /**
-     * The "Edit {label}" row the context menu shows at the top when the
-     * right-click lands on the node's chip. The HOST owns the dialog.
-     *
-     * HONEST LIMIT: there is no in-place update call yet — re-authoring is
-     * `removeContentControl` + `insertCustomNode` at the node's range (the
-     * activation carries `nodeId` and, when a review module is registered, the
-     * current `text` to prefill a form). Schema-driven edit forms are the planned
-     * follow-up.
-     */
-    readonly onEdit?: (node: ActivatedCustomNode) => void;
-    /**
-     * Display name for chrome — the "Edit {label}" context-menu row. Defaults to
-     * `name`. Host-authored, never file data; provide a localized string.
-     */
-    readonly label?: string;
-}
-/**
- * A chip activation: identity + attrs, plus where it sits.
- *
- * `attrs` are the definition's OWN shape — the raw tag decode has already been
- * through `fromDocx`, exactly as the review derivation runs it, so every
- * surface (click, hover, edit, cards) sees one attrs vocabulary. `text` and
- * `nodeId` are present when the surface could resolve them (a registered
- * review module resolves both).
- */
-interface ActivatedCustomNode {
-    readonly name: string;
-    readonly attrs: Readonly<Record<string, string>>;
-    readonly tag: string;
-    /** Viewport-relative rect of the chip's boundary, for anchoring host UI. */
-    readonly rect: DOMRect;
-    /** The SDT node's canonical id — the address `removeContentControl` takes. */
-    readonly nodeId?: string;
-    /** The node's literal content text, when resolvable. */
-    readonly text?: string;
-}
-/**
- * Whether an opaque registry value is a custom-node definition.
- *
- * The engine carries registered definitions as unknowns (`getCustomNodeDefinitions`), so
- * every pro surface that reads them back narrows through this ONE guard.
- */
-declare function isCustomNodeDefinition(candidate: unknown): candidate is CustomNodeDefinition;
-/** Validate and freeze a definition. Throws on a shape mistake — author error, not file input. */
-declare function defineCustomNode(definition: CustomNodeDefinition): CustomNodeDefinition;
-/**
- * How {@link customNodesModule} is configured.
- *
- * @public
- */
-interface CustomNodesModuleOptions extends ProLicenseOptions {
-    /** The definitions this editor recognizes. A tag prefix no definition claims stays literal. */
-    readonly nodes: readonly CustomNodeDefinition[];
-}
-/** Register custom node definitions with `createDocxEditor({ modules })`. */
-declare function customNodesModule(options: CustomNodesModuleOptions): EditorModule;
-/**
- * Every recognized custom node in one story, in document order.
- *
- * Tag-prefix keyed, exactly as the change specifies: an inline SDT whose tag
- * decodes to a registered `<prefix>:<name>` pair is offered to that
- * definition's `fromDocx`; everything else — foreign tags, unregistered
- * prefixes, a `fromDocx` veto — stays a literal SDT.
- */
-declare function recognizeCustomNodes(part: OoxmlPart, definitions: readonly CustomNodeDefinition[]): RecognizedCustomNode[];
-
-export { type ActivatedCustomNode as A, type CustomNodeDefinition as C, type ProLicenseOptions as P, type RecognizedCustomNode as R, type CustomNodesModuleOptions as a, type ReviewModuleOptions as b, customNodesModule as c, defineCustomNode as d, reviewModule as e, isCustomNodeDefinition as i, recognizeCustomNodes as r };