@ansonlai/docx-redline-js 0.7.2 → 0.8.1

package/docs/SKILL_AUTHORING.md

@@ -78,8 +78,11 @@ node emit-operations.mjs | docx-redline apply input.docx --operations - --profil
 ```
 
 Use `JSON.stringify` or a structured tool API. Never demonstrate `echo`, a
-heredoc, or shell-interpolated document text. A Node byte-oriented wrapper should
-call `openDocx` and return the structured result instead of recreating CLI
+heredoc, or shell-interpolated document text. In JavaScript/TypeScript runtimes
+(Node.js, browsers, Cloudflare Workers, Deno, Bun, or sandboxed environments like
+n8n), an in-process wrapper should call `openDocx(uint8Array)` directly from
+`@ansonlai/docx-redline-js` (or `@ansonlai/docx-redline-js/bundle` for zero-dependency
+standalone sandboxes) and return the structured result instead of recreating CLI
 serialization, ZIP handling, targeting, validation, or rollback.
 
 ## Ordinary generated workflow

package/docs/TESTING.md

@@ -31,7 +31,8 @@ fixtures rarely contain.
 | Live-session accuracy and instrumentation | `node tests/performance_phase1_session_tests.mjs` | One full parse/serialization, sequential semantic equivalence, exact accepted/rejected text, valid revisions, list/table/comment/highlight preservation, savepoint no-ops, and zero-serialization rollback | Desktop Word rendering |
 | Target hot-path parity | `node tests/performance_phase3_target_hot_paths_tests.mjs` | Cached and uncached resolution metadata parity, duplicate safety, snapshots, session invalidation, and pointer-based revision-ID seeding | Machine-independent latency thresholds |
 | List and text-walker parity | `node tests/performance_phase4_list_and_text_parity_tests.mjs` | One shared marker vocabulary and canonical/specialized visible-text agreement across structural characters and revision views | That all specialized mappings are interchangeable |
-| Route compatibility | `node tests/performance_phase5_route_consolidation_tests.mjs` | Direct/legacy list accepted-rejected parity, numbering artifacts, route selection, capability records, and stable public exports | Permission to migrate the retained multi-paragraph compatibility route |
+| Universal document facade & ZIP | `node tests/universal_docx_document_tests.mjs`, `node tests/universal_zip_archive_tests.mjs`, `node tests/universal_facade_edge_cases_tests.mjs` | Universal `Uint8Array` binary handling, `fflate` compression/decompression, optimistic concurrency, and complete-DOCX operations without Node built-ins | Desktop Word rendering |
+| Sandbox bundle isolation | `node tests/sandbox_bundle_isolation_tests.mjs` | Zero-dependency standalone ESM/CJS bundles execute in restricted VM sandboxes without `process`, `Buffer`, or `require`, with zero Node built-in imports | Web Worker latency |
 | Cross-author revision slicing | `node tests/cross_author_slicing_fixtures_tests.mjs`, `node tests/cross_author_carrier_splitting_tests.mjs`, `node tests/cross_author_slicing_synthetic_tests.mjs`, `node tests/cross_author_slicing_real_tests.mjs`, `node tests/cross_author_slicing_hyperlink_roundtrip_tests.mjs`, `node tests/cross_author_slicing_insertion_stress_tests.mjs` | Word-native `<w:ins>` splitting, `<w:del>` nesting, multi-author stacking, straddle boundaries, synthetic matrix (SYN-01..12d), strict package differential replay (PKG-01..06), exact hyperlink/NBSP round trips, and 76 insertion stress scenarios | Non-Word consumers beyond OpenXML XSD validation |
 
 The package-facade regression opens a real ZIP buffer, adds a comment beside an

package/docs/schemas/document-operations.schema.json

@@ -71,6 +71,22 @@
         }
       ]
     },
+    "headerFooterPart": {
+      "description": "Targets a header or footer instead of the body. Use a part path from inspect().headersFooters, or a selector. Comments are not supported in headers or footers.",
+      "oneOf": [
+        { "type": "string", "minLength": 1, "examples": ["word/footer2.xml"] },
+        {
+          "type": "object",
+          "required": ["kind"],
+          "properties": {
+            "kind": { "enum": ["header", "footer"] },
+            "type": { "enum": ["default", "first", "even"], "description": "Defaults to default." },
+            "section": { "type": "integer", "minimum": 0, "description": "Zero-based section; required when several sections have their own part." }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
     "base": {
       "type": "object",
       "required": ["type", "target"],
@@ -78,6 +94,7 @@
         "operationId": { "type": "string", "minLength": 1, "maxLength": 256 },
         "captureKey": { "type": "string", "minLength": 1, "maxLength": 256 },
         "target": { "$ref": "#/$defs/target" }, "targetRef": { "type": ["integer", "string", "null"] },
+        "part": { "$ref": "#/$defs/headerFooterPart" },
         "author": { "type": "string", "minLength": 1 }, "generateRedlines": { "type": "boolean" },
         "existingRevisions": { "enum": ["merge-same-author", "slice-cross-author", "reject-input", "accept-all-first", "accept-all-first-keep-normalized"] },
         "pairReplacements": { "type": "boolean" },
@@ -109,6 +126,18 @@
           },
           "additionalProperties": false
         },
+        {
+          "type": "object",
+          "description": "Resolve or reopen the comment thread containing commentId. Resolved is thread-level in Word, so the root and every reply change together. Body-only; not allowed with part.",
+          "required": ["type", "commentId"],
+          "properties": {
+            "type": { "const": "comment_resolve" },
+            "operationId": { "type": "string", "minLength": 1, "maxLength": 256 },
+            "commentId": { "type": ["integer", "string"] },
+            "resolved": { "type": "boolean", "default": true }
+          },
+          "additionalProperties": false
+        },
         {
           "allOf": [ { "$ref": "#/$defs/base" }, { "type": "object", "required": ["replacements"], "properties": { "type": { "enum": ["redline", "replace"] }, "replacements": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/localizedReplacement" } } } } ]
         },

package/document/docx-document.d.ts

@@ -0,0 +1,39 @@
+import type { DocumentOperation, DocumentOperationBatchResult, OperationPreflightResult, StandaloneRunnerOptions } from '../services/standalone-operation-runner.js';
+import type { DocumentInspectionOptions, DocumentInspectionResult, RevisionToken } from '../index.js';
+
+export interface DocxApplyOptions extends StandaloneRunnerOptions {
+  author?: string;
+  validate?: boolean;
+}
+
+export interface DocxApplyResult extends DocumentOperationBatchResult {
+  written: boolean;
+  uint8Array: Uint8Array;
+  buffer: Uint8Array;
+  inspection?: DocumentInspectionResult;
+  artifactsChanged?: string[];
+  validation?: { originalIssues: unknown[]; generatedIssues: unknown[] };
+  issues?: unknown[];
+  toUint8Array(): Uint8Array;
+  toBuffer(): Uint8Array;
+}
+
+export class DocxDocument {
+  constructor(input: Uint8Array | ArrayBuffer | string);
+  readonly originalBytes: Uint8Array;
+  readonly originalBuffer: Uint8Array;
+  readonly entries: Map<string, Uint8Array>;
+  inspect(options?: DocumentInspectionOptions): DocumentInspectionResult;
+  getRevisionToken(): RevisionToken;
+  readonly revisionToken: RevisionToken;
+  preflight(operations: DocumentOperation[], author?: string, options?: StandaloneRunnerOptions): OperationPreflightResult;
+  applyOperations(operations: DocumentOperation[], options?: DocxApplyOptions): Promise<DocxApplyResult>;
+  resolveRevisions(action: 'accept' | 'reject', options?: { author?: string; allAuthors?: boolean; validate?: boolean }): Promise<DocxApplyResult>;
+  deleteComments(options?: { author?: string; allAuthors?: boolean; validate?: boolean }): Promise<DocxApplyResult>;
+  toUint8Array(): Uint8Array;
+  toBuffer(): Uint8Array;
+}
+
+export function computePackageRevisionToken(input: unknown): RevisionToken;
+
+export function openDocx(input: Uint8Array | ArrayBuffer | string): DocxDocument;