@reviseio/engine 0.0.0-stage → 3.0.1

package/chunks/signatures-DTNDS2PH.js

@@ -0,0 +1,21 @@
+import{r as d,ad as A,a7 as k,bh as x,bi as S}from"./engine-LMUnxdm2.js";const c=2;function s(e){return e===null||typeof e!="object"?JSON.stringify(e)??"null":Array.isArray(e)?`[${e.map(s).join(",")}]`:
+`{${Object.entries(e).filter(([,r])=>r!==void 0).sort(([r],[t])=>r<t?-1:r>t?1:0).map(([r,t])=>`${JSON.stringify(r)}:${s(t)}`).join(",")}}`}function i(e,r=c){if(e===null||typeof e!="object")return e;if(Array.
+isArray(e))return e.map(o=>i(o,r));const t=e;if(t.type==="text")return{...t,marks:(r===1?x:S)(t.marks)};const n={};for(const[o,a]of Object.entries(t))o==="indentLevel"&&t.type==="list-item"&&!a||o==="\
+hasHeader"&&t.type==="table"&&!a||o==="footnoteNumber"&&t.type==="footnote"||(n[o]=i(a,r));if(Array.isArray(n.children)){const o=[];for(const a of n.children){const f=o[o.length-1];if(f&&f.type==="tex\
+t"&&a.type==="text"&&s(f.marks)===s(a.marks)){f.text=`${f.text}${a.text}`;continue}o.push(a)}n.children=o}return n}function u(e){return`${b(e,0).toString(36)}-${b(e,2654435769).toString(36)}`}function b(e,r){
+let t=3735928559^r,n=1103547991^r;for(let o=0;o<e.length;o++){const a=e.charCodeAt(o);t=Math.imul(t^a,2654435761),n=Math.imul(n^a,1597334677)}return t=Math.imul(t^t>>>16,2246822507),t^=Math.imul(n^n>>>
+13,3266489909),n=Math.imul(n^n>>>16,2246822507),n^=Math.imul(t^t>>>13,3266489909),4294967296*(2097151&n)+(t>>>0)}function j(e,r=c){return s(i(e,r))}function $(e,r=c){return u(j(e,r))}function O(e){const{
+showPageNumbers:r,...t}=d(e.pageLayout);return u(s(t))}function v(e){const r=d(e.pageLayout);return[!0,!1].map(t=>u(s({...r,showPageNumbers:t})))}function p(e){if(e===null||typeof e!="object")return e;
+if(Array.isArray(e))return e.map(p);const r=e;if(r.type==="text"&&r.marks&&typeof r.marks=="object"&&"fontFamily"in r.marks){const n={...r.marks};return delete n.fontFamily,{...r,marks:n}}const t={};for(const[
+n,o]of Object.entries(r))t[n]=p(o);return t}function M(e,r=c){const t=[...e.children.filter(n=>n.type==="footnote"),...e.notes??[]];return u(s(t.map(n=>i(p(n),r))))}function m(e){if(e===null||typeof e!=
+"object")return e;if(Array.isArray(e))return e.map(m);const r={};for(const[t,n]of Object.entries(e))t!=="id"&&(r[t]=m(n));return r}function L(e,r=c){let t=[...e.children.filter(n=>n.type==="header-foo\
+ter"),...e.chrome??[]];return t.length===0&&(e.headers||e.footers)&&(t=k(e.headers,e.footers)),u(s(i({blocks:t.map(n=>m(n)),watermark:e.watermark??null,chromeImages:e.chromeImages??[]},r)))}function N(e,r=c){
+const t=n=>[...n].sort((o,a)=>{const f=s(i(o,r)),g=s(i(a,r));return f<g?-1:f>g?1:0});return u(s(i({sdtWrappers:t(e.sdtWrappers??[]),oxmlRanges:t(e.oxmlRanges??[])},r)))}function I(e,r=c){return u(s(i(
+{stylesXml:e.stylesXml??null,stylesheet:e.stylesheet??null},r)))}function y(e){if(e===null||typeof e!="object")return!1;if(Array.isArray(e))return e.some(y);const r=e;if(r.type==="toc")return!0;const t=r.
+marks;return t&&typeof t=="object"&&typeof t.fieldInstr=="string"?!0:Object.values(r).some(y)}function R(e){const r=[...e.children.filter(n=>n.type==="header-footer"),...e.chrome??[]],t=!!(e.headers?.
+even||e.footers?.even)||r.some(n=>n.slot==="even"&&A(n));return u(s({autoHyphenation:d(e.pageLayout).hyphenationEnabled,evenAndOddHeaders:t,updateFields:y(e.children)}))}function w(e,r=c){return u(s([
+...e.comments??[]].sort((t,n)=>t.id<n.id?-1:t.id>n.id?1:0).map(t=>i(t,r))))}function F(e){return u(s(e.coreProperties??{}))}const H=["structuralSuggestionRecords","structuralSuggestionRecord","structu\
+ralSuggestionLabel","diffState","suggestionId"];function l(e,r=c){const t={...e,children:[]};for(const n of H)delete t[n];return u(s(i(t,r)))}function h(e,r=c){return u(s(i(e,r)))}function P(e,r=c){const t={};
+for(const n of e.children)if(n.id){if(n.type==="paragraph"){t[n.id]={head:l(n,r),parts:[]};continue}n.type!=="table"&&n.type!=="list"||(t[n.id]={head:l(n,r),parts:n.children.map(o=>({id:o.id??"",signature:h(
+o,r),...n.type==="list"?{head:l(o,r)}:{},...n.type==="table"?{head:l(o,r),cells:(o.children??[]).map(a=>({id:a.id??"",signature:h(a,r)}))}:{}}))})}return t}export{c as C,j as a,$ as b,N as c,R as d,I as e,
+L as f,w as g,F as h,i,s as j,h as k,l,v as m,M as n,P as o,O as p,u as s};

package/chunks/suggestionAuthorship-B-IuLQlE.js

@@ -0,0 +1 @@
+const s="Revise Agent",e="Anonymous";function o(t){const n=t?.trim();return!n||n===s}export{e as A,s as R,o as i};

package/chunks/web-tree-sitter-BXGZGnNj.js

@@ -0,0 +1,2 @@
+class e{constructor(t){this.endIndex=t,this.childCount=0,this.startIndex=0,this.parent=null,this.type="text"}child(){return this}}class s{static async load(){return new s}}class n{static async init(){}setLanguage(){}parse(t){
+return{rootNode:new e(t.length)}}}export{s as Language,n as Parser};

package/chunks/xmlScan-DXjt2cTS.js

@@ -0,0 +1,8 @@
+function g(t,r,i=0){const n=h(t,r,i);if(n<0)throw new Error(`graft: <${r}> not found`);const e=d(t,n);if(t[e-2]==="/")return{open:{tag:r,start:n,end:e},contentStart:e,contentEnd:e,children:[]};const f=[];
+let s=e;for(;;){const o=t.indexOf("<",s);if(o<0)throw new Error(`graft: unterminated <${r}>`);if(t.startsWith("<!--",o)){const c=t.indexOf("-->",o);if(c<0)throw new Error("graft: unterminated comment");
+s=c+3;continue}if(t[o+1]==="/"){const c=t.indexOf(">",o),u=t.slice(o+2,c).trim();if(u!==r)throw new Error(`graft: unexpected </${u}> inside <${r}>`);return{open:{tag:r,start:n,end:e},contentStart:e,contentEnd:o,
+children:f}}const a=l(t,o);f.push(a),s=a.end}}function l(t,r){const i=d(t,r),n=t.slice(r+1,i).search(/[\s/>]/),e=t.slice(r+1,r+1+n);if(t[i-2]==="/")return{tag:e,start:r,end:i};let f=1,s=i;for(;f>0;){const o=t.
+indexOf("<",s);if(o<0)throw new Error(`graft: unterminated <${e}>`);if(t.startsWith("<!--",o)){const c=t.indexOf("-->",o);if(c<0)throw new Error("graft: unterminated comment");s=c+3;continue}const a=d(
+t,o);t[o+1]==="/"?(f--,s=a):(t[a-2]==="/"||f++,s=a)}return{tag:e,start:r,end:s}}function d(t,r){let i=r+1,n=null;for(;i<t.length;){const e=t[i];if(n)e===n&&(n=null);else if(e==='"'||e==="'")n=e;else if(e===
+">")return i+1;i++}throw new Error("graft: unterminated tag")}function h(t,r,i){const n=`<${r}`;let e=t.indexOf(n,i);for(;e>=0;){const f=t[e+n.length];if(f===" "||f===">"||f==="/"||f==="	"||f===`
+`||f==="\r")return e;e=t.indexOf(n,e+1)}return-1}export{d as endOfTag,h as findOpenTag,l as scanElement,g as scanElementChildren};

package/engine.d.ts

@@ -0,0 +1,179 @@
+/**
+ * @reviseio/engine: Revise's headless document engine. Node only.
+ *
+ * Most programs want `revise` (the MIT CLI and library built on it):
+ * https://revise.io/developer/docs
+ *
+ * Peer dependencies: `yjs` (one copy, shared with anything else that touches
+ * the document) and `jsdom` (the converters parse XML and HTML with DOM
+ * APIs).
+ */
+import type { Doc } from "yjs";
+import type {
+  ServerDocumentSession,
+  ServerDocumentSessionOptions,
+} from "./serverToolContract.js";
+
+/** Revise's document model. Opaque here — convert rather than inspect. */
+export interface ReviseDocument {
+  type: "doc";
+  children: unknown[];
+  [key: string]: unknown;
+}
+
+/** Formats readable on the server. PDF and images are browser-only. */
+export type ReviseServerFormat =
+  | "docx"
+  | "odt"
+  | "rtf"
+  | "markdown"
+  | "txt"
+  | "html";
+
+/** Top-level keys the editor owns inside a shared document. */
+export declare const RESERVED_DOCUMENT_KEYS: readonly string[];
+
+/** A document built with the settings the editor requires. */
+export declare function createReviseYDoc(): Doc;
+
+/** Throws if a document already uses the editor's reserved keys for
+ * something else. */
+export declare function assertUsableSharedDocument(ydoc: Doc): void;
+
+/** Install the DOM globals the converters need. Called for you by everything
+ * here; exported for hosts importing converters directly. */
+export declare function installDomShims(): Promise<void>;
+
+/** Parse .docx, .odt, .rtf, .md, .txt, or .html into the document model. */
+export declare function parseDocument(
+  bytes: Uint8Array,
+  filename: string,
+): Promise<ReviseDocument>;
+
+/** Serialize the document model back to .docx bytes. With `originalDocx`
+ * (the file this document was imported from), untouched content exports
+ * byte-for-byte via graft mode; any graft-proof failure falls back to full
+ * regeneration. */
+export declare function documentToDocx(
+  doc: ReviseDocument,
+  options?: { originalDocx?: Uint8Array },
+): Promise<Uint8Array>;
+
+/** Build a room's Yjs document from a file — server-side document creation,
+ * so every client simply joins. */
+export declare function fileToYDoc(
+  bytes: Uint8Array,
+  filename: string,
+): Promise<Doc>;
+
+/** Seed an empty room from a file. Returns false when it already had
+ * content, so it is safe to call on every connection — including under a
+ * connect race: every seed records a claim, and a room two peers both
+ * seeded before syncing is repaired deterministically (on the next call
+ * here, or by any live editor session the moment the claims merge). */
+export declare function seedYDocFromFile(
+  ydoc: Doc,
+  bytes: Uint8Array,
+  filename: string,
+): Promise<boolean>;
+
+export interface SeedRaceRepairResult {
+  /** Losing seed claims removed. */
+  losingClaims: number;
+  /** Top-level body blocks removed. */
+  removedBlocks: number;
+}
+
+/** Detect and repair a double-seed connect race: keep the deterministic
+ * winner and delete everything the losing seeds created. Idempotent and
+ * convergent — safe on any peer, at any time; null when there is nothing
+ * to repair. Editor sessions run this automatically. */
+export declare function repairSeedRace(
+  ydoc: Doc,
+): SeedRaceRepairResult | null;
+
+/** Read a room back as the document model. */
+export declare function ydocToDocument(ydoc: Doc): ReviseDocument;
+
+/** Export a room straight to .docx. A DOCX-imported room carries its
+ * original file inside the document; untouched content exports
+ * byte-for-byte. */
+export declare function ydocToDocx(ydoc: Doc): Promise<Uint8Array>;
+
+/** Formats `exportDocument` produces on the server. PDF needs a browser;
+ * use `tools.export` in the editor. */
+export type ReviseServerExportFormat = "docx" | "html" | "markdown" | "txt";
+
+export interface ReviseServerExportOptions {
+  format?: ReviseServerExportFormat;
+  /** "review" (default) keeps pending tracked changes and comments in a
+   * .docx; other formats show the text with changes accepted. "final"
+   * accepts every pending change and drops comments first. */
+  mode?: "review" | "final";
+  /** Document title, used by the HTML export's <title>. */
+  title?: string;
+}
+
+/** Export a room or a parsed document as a file. A room in review mode
+ * keeps DOCX mode (untouched content leaves as the original bytes); a final
+ * copy is always regenerated. */
+export declare function exportDocument(
+  source: Doc | ReviseDocument,
+  options?: ReviseServerExportOptions,
+): Promise<Uint8Array>;
+
+/** DOCX-mode fidelity for a room: "exact" (export reproduces the original
+ * file byte-for-byte), "grafted" (original + this document's edits), or
+ * "converted" (no usable original; export regenerates). */
+export declare function ydocSourceFidelity(ydoc: Doc): Promise<{
+  fidelity: "exact" | "grafted" | "converted";
+  regeneratedBlockIds: string[];
+  changedDomains: string[];
+  convertedReason?:
+    | "no-capture"
+    | "no-carrier"
+    | "carrier-hash-mismatch"
+    | "unpaired-capture";
+}>;
+
+/** Whether a room already holds a Revise document. */
+export declare function hasDocument(ydoc: Doc): boolean;
+
+/** The whole room as one update, for storage. */
+export declare function encodeYDoc(ydoc: Doc): Uint8Array;
+
+/** Restore a room from stored bytes. */
+export declare function decodeYDoc(update: Uint8Array): Doc;
+
+export type * from "./serverToolContract.js";
+
+export declare class ReviseToolError<Name extends string = string> extends Error {
+  readonly failure: import("./serverToolContract.js").ReviseToolFailure<Name>;
+  readonly callId: string;
+  readonly tool: Name;
+  readonly code: string;
+  constructor(failure: import("./serverToolContract.js").ReviseToolFailure<Name>);
+}
+
+/** Bind the canonical deterministic semantic tools to a host-owned Y.Doc.
+ * Async: the tool session's mutation engine is loaded on first use, so
+ * conversion-only hosts never pay for it. */
+export declare function createServerDocumentSession(
+  ydoc: Doc,
+  options: ServerDocumentSessionOptions,
+): Promise<ServerDocumentSession>;
+
+export type { ReviseToolName } from "./serverToolInputs.generated.js";
+/** The document model, as `parseDocument` returns it. */
+export type DocRoot = ReviseDocument;
+/** One block of the document model. */
+export interface BlockNode {
+  type: string;
+  id?: string;
+  [key: string]: unknown;
+}
+/** Seed an empty Y.Doc with a document, recording the claim that lets
+ * concurrent seeds be repaired. */
+export declare function seedDocRootWithClaim(ydoc: Doc, doc: ReviseDocument): void;
+/** @internal Lazy loaders the `revise` library uses. Not a stable API. */
+export declare const engineModules: Record<string, () => Promise<any>>;

package/engine.js

@@ -0,0 +1,3 @@
+import{bT as s,bU as a,bV as e,bW as o,bX as c,bS as t,bY as i,bZ as D,j as m,b_ as r,c2 as b,b$ as d,c0 as n,c1 as l}from"./chunks/engine-LMUnxdm2.js";export{s as createReviseYDoc,a as createServerDocumentSession,
+e as decodeYDoc,o as documentToDocx,c as encodeYDoc,t as engineModules,i as exportDocument,D as fileToYDoc,m as installDomShims,r as parseDocument,b as seedDocRootWithClaim,d as seedYDocFromFile,n as ydocSourceFidelity,
+l as ydocToDocument};

package/package.json

@@ -1,6 +1,66 @@
 {
   "name": "@reviseio/engine",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "3.0.1",
+  "reviseBuild": "7ef88f310",
+  "description": "Revise's headless document engine: Word-faithful import and export, tracked changes, comments, layout, and agent tools. Free to use; the `revise` package is the API.",
+  "keywords": [
+    "docx",
+    "word",
+    "document",
+    "tracked-changes",
+    "redlines"
+  ],
+  "type": "module",
+  "main": "./engine.js",
+  "module": "./engine.js",
+  "types": "./engine.d.ts",
+  "exports": {
+    ".": {
+      "types": "./engine.d.ts",
+      "import": "./engine.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "engine.js",
+    "engine.d.ts",
+    "serverToolContract.d.ts",
+    "serverToolInputs.generated.d.ts",
+    "chunks",
+    "assets",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "THIRD-PARTY-NOTICES.md",
+    "FONT-LICENSE-HAN-EXT-B.txt",
+    "FONT-LICENSE-KATEX.txt",
+    "FONT-LICENSE-LIBERATION.txt",
+    "FONT-LICENSE-NOTO-MULTILINGUAL.txt",
+    "FONT-LICENSE-NOTO-SANS-SC.txt",
+    "FONT-LICENSE-NOTO.txt",
+    "FONT-LICENSE-SOURCE-CODE-PRO.txt",
+    "FONT-LICENSE-SOURCE-SERIF-4.txt"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "jsdom": "^26.1.0",
+    "y-protocols": "^1.0.6"
+  },
+  "peerDependencies": {
+    "yjs": "^13.6.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://revise.io/developer/docs",
+  "bugs": {
+    "email": "sdk@revise.io"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepublishOnly": "node -e \"if(process.env.REVISE_SDK_VERIFIED_PUBLISH!=='1'){console.error('Refusing to publish: use the audited publish in frontend/ (verify-sdk-tarball.mjs --publish).');process.exit(1)}\""
+  }
+}