@superdoc/sdk 2.24.0 → 2.25.0-next.2

package/dist/runtime/document-rpc.cjs

@@ -133,6 +133,7 @@ function supportsTrackedMode(operation) {
     return operation.supportsTrackedMode === true || operation.supportsConditionalTrackedMode === true;
 }
 function documentInvokePayload(operation, params, invokeOptions) {
+    params = transportCommon.captureMutationPlanAuthor(operation.operationId, params, invokeOptions);
     const normalizedParams = transportCommon.applyOperationParamAliases(operation, params);
     if (invokeOptions.stdinBytes !== undefined) {
         throw unsupported('Structured document RPC does not support stdinBytes.', operation.operationId);

package/dist/runtime/document-rpc.js

@@ -1,7 +1,7 @@
 import { randomUUID } from 'node:crypto';
 import { SuperDocCliError } from './errors.js';
 import { SDK_POLICY } from './sdk-policy.js';
-import { applyOperationParamAliases, } from './transport-common.js';
+import { applyOperationParamAliases, captureMutationPlanAuthor, } from './transport-common.js';
 export const DOCUMENT_RPC_FEATURES = SDK_POLICY.documentRpcFeatures;
 export const DOCUMENT_RPC_REPLACE_FILE_FEATURE = SDK_POLICY.features.replaceFile;
 export const DOCUMENT_RPC_DEFAULT_CHANGE_MODE_FEATURE = SDK_POLICY.features.defaultChangeMode;
@@ -130,6 +130,7 @@ function supportsTrackedMode(operation) {
     return operation.supportsTrackedMode === true || operation.supportsConditionalTrackedMode === true;
 }
 function documentInvokePayload(operation, params, invokeOptions) {
+    params = captureMutationPlanAuthor(operation.operationId, params, invokeOptions);
     const normalizedParams = applyOperationParamAliases(operation, params);
     if (invokeOptions.stdinBytes !== undefined) {
         throw unsupported('Structured document RPC does not support stdinBytes.', operation.operationId);

package/dist/runtime/host.cjs

@@ -233,6 +233,7 @@ class HostTransport {
         await this.stateDirectory.dispose();
     }
     async invoke(operation, params = {}, options = {}) {
+        params = transportCommon.captureMutationPlanAuthor(operation.operationId, params, options);
         return this.runWhileActive(() => this.invokeWhileActive(operation, params, options));
     }
     async replaceFile(sessionId, path, options = {}) {

package/dist/runtime/host.js

@@ -1,5 +1,5 @@
 import { spawn } from 'node:child_process';
-import { buildOperationArgv, buildStructuredReadInput, normalizeCollaborationAuth, resolveInvocation, } from './transport-common.js';
+import { buildOperationArgv, captureMutationPlanAuthor, buildStructuredReadInput, normalizeCollaborationAuth, resolveInvocation, } from './transport-common.js';
 import { SuperDocCliError } from './errors.js';
 import { SdkStateDirectory } from './state-directory.js';
 import { registerMutationRevision } from './document-evidence.js';
@@ -230,6 +230,7 @@ export class HostTransport {
         await this.stateDirectory.dispose();
     }
     async invoke(operation, params = {}, options = {}) {
+        params = captureMutationPlanAuthor(operation.operationId, params, options);
         return this.runWhileActive(() => this.invokeWhileActive(operation, params, options));
     }
     async replaceFile(sessionId, path, options = {}) {

package/dist/runtime/sdk-version.generated.cjs

@@ -3,6 +3,6 @@
 // AUTO-GENERATED by scripts/embed-version.mjs — DO NOT EDIT.
 // Source of truth: package.json. Regenerated on every SDK build so the
 // SDK retains its own version identity when bundled into another package.
-const SDK_VERSION = '2.24.0';
+const SDK_VERSION = '2.25.0-next.2';
 
 exports.SDK_VERSION = SDK_VERSION;

package/dist/runtime/sdk-version.generated.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.24.0";
+export declare const SDK_VERSION = "2.25.0-next.2";

package/dist/runtime/sdk-version.generated.js

@@ -1,4 +1,4 @@
 // AUTO-GENERATED by scripts/embed-version.mjs — DO NOT EDIT.
 // Source of truth: package.json. Regenerated on every SDK build so the
 // SDK retains its own version identity when bundled into another package.
-export const SDK_VERSION = '2.24.0';
+export const SDK_VERSION = '2.25.0-next.2';

package/dist/runtime/transport-common.cjs

@@ -196,6 +196,7 @@ function applyOperationParamAliases(operation, params) {
  * - Booleans encoded as `--flag true`/`--flag false` explicitly, matching current CLI.
  */
 function buildOperationArgv(operation, params, options, runtimeTimeoutMs, defaultChangeMode, user) {
+    params = captureMutationPlanAuthor(operation.operationId, params, options);
     if (operation.operationId === 'doc.mutations.apply' && (params.dryRun !== undefined || options.dryRun === true)) {
         throw new errors.SuperDocCliError('mutations.apply does not accept dryRun; use mutations.preview.', {
             code: 'INVALID_INPUT',
@@ -272,9 +273,32 @@ function buildOperationArgv(operation, params, options, runtimeTimeoutMs, defaul
     argv.push('--output', 'json');
     return argv;
 }
+function captureMutationPlanAuthor(operationId, params, options) {
+    if (operationId !== 'doc.mutations.apply' && operationId !== 'doc.mutations.preview')
+        return params;
+    if (options && typeof options === 'object' && 'author' in options) {
+        throw new errors.SuperDocCliError('Put the mutation plan author in the tracked plan input.', { code: 'INVALID_INPUT' });
+    }
+    const author = params.author;
+    if (author === undefined)
+        return { ...params };
+    if (params.changeMode !== 'tracked' ||
+        !author ||
+        typeof author !== 'object' ||
+        Array.isArray(author) ||
+        Object.keys(author).some((key) => key !== 'name') ||
+        typeof author.name !== 'string' ||
+        author.name.trim().length === 0) {
+        throw new errors.SuperDocCliError('A plan author requires tracked mode and only a non-empty name.', {
+            code: 'INVALID_INPUT',
+        });
+    }
+    return { ...params, author: { name: author.name } };
+}
 
 exports.applyOperationParamAliases = applyOperationParamAliases;
 exports.buildOperationArgv = buildOperationArgv;
 exports.buildStructuredReadInput = buildStructuredReadInput;
+exports.captureMutationPlanAuthor = captureMutationPlanAuthor;
 exports.normalizeCollaborationAuth = normalizeCollaborationAuth;
 exports.resolveInvocation = resolveInvocation;

package/dist/runtime/transport-common.d.ts

@@ -113,3 +113,4 @@ export declare function applyOperationParamAliases(operation: OperationSpec, par
  * - Booleans encoded as `--flag true`/`--flag false` explicitly, matching current CLI.
  */
 export declare function buildOperationArgv(operation: OperationSpec, params: Record<string, unknown>, options: InvokeOptions, runtimeTimeoutMs: number | undefined, defaultChangeMode?: ChangeMode, user?: UserIdentity): string[];
+export declare function captureMutationPlanAuthor(operationId: string, params: Record<string, unknown>, options: InvokeOptions): Record<string, unknown>;

package/dist/runtime/transport-common.js

@@ -193,6 +193,7 @@ export function applyOperationParamAliases(operation, params) {
  * - Booleans encoded as `--flag true`/`--flag false` explicitly, matching current CLI.
  */
 export function buildOperationArgv(operation, params, options, runtimeTimeoutMs, defaultChangeMode, user) {
+    params = captureMutationPlanAuthor(operation.operationId, params, options);
     if (operation.operationId === 'doc.mutations.apply' && (params.dryRun !== undefined || options.dryRun === true)) {
         throw new SuperDocCliError('mutations.apply does not accept dryRun; use mutations.preview.', {
             code: 'INVALID_INPUT',
@@ -269,3 +270,25 @@ export function buildOperationArgv(operation, params, options, runtimeTimeoutMs,
     argv.push('--output', 'json');
     return argv;
 }
+export function captureMutationPlanAuthor(operationId, params, options) {
+    if (operationId !== 'doc.mutations.apply' && operationId !== 'doc.mutations.preview')
+        return params;
+    if (options && typeof options === 'object' && 'author' in options) {
+        throw new SuperDocCliError('Put the mutation plan author in the tracked plan input.', { code: 'INVALID_INPUT' });
+    }
+    const author = params.author;
+    if (author === undefined)
+        return { ...params };
+    if (params.changeMode !== 'tracked' ||
+        !author ||
+        typeof author !== 'object' ||
+        Array.isArray(author) ||
+        Object.keys(author).some((key) => key !== 'name') ||
+        typeof author.name !== 'string' ||
+        author.name.trim().length === 0) {
+        throw new SuperDocCliError('A plan author requires tracked mode and only a non-empty name.', {
+            code: 'INVALID_INPUT',
+        });
+    }
+    return { ...params, author: { name: author.name } };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superdoc/sdk",
-  "version": "2.24.0",
+  "version": "2.25.0-next.2",
   "description": "Node SDK for SuperDoc, wrapping the SuperDoc CLI to read and edit .docx files from JavaScript and TypeScript.",
   "private": false,
   "license": "AGPL-3.0",
@@ -38,11 +38,11 @@
     "typescript": "^5.9.2"
   },
   "optionalDependencies": {
-    "@superdoc/sdk-darwin-arm64": "2.24.0",
-    "@superdoc/sdk-darwin-x64": "2.24.0",
-    "@superdoc/sdk-linux-x64": "2.24.0",
-    "@superdoc/sdk-linux-arm64": "2.24.0",
-    "@superdoc/sdk-windows-x64": "2.24.0"
+    "@superdoc/sdk-darwin-arm64": "2.25.0-next.2",
+    "@superdoc/sdk-darwin-x64": "2.25.0-next.2",
+    "@superdoc/sdk-linux-x64": "2.25.0-next.2",
+    "@superdoc/sdk-linux-arm64": "2.25.0-next.2",
+    "@superdoc/sdk-windows-x64": "2.25.0-next.2"
   },
   "publishConfig": {
     "access": "public"

package/tools/catalog.json

@@ -7009,6 +7009,20 @@
             "$ref": "#/$defs/StoryLocator",
             "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes."
           },
+          "author": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "name"
+            ],
+            "description": "Display author for one tracked body text plan. Accepts only name; does not change the session user or inherit its email. Unsupported step combinations are rejected before mutation."
+          },
           "expectedRevision": {
             "type": "string",
             "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision. Only for action 'preview'. Omit for other actions."

package/tools/generation-receipt.json

@@ -1,8 +1,8 @@
 {
   "formatVersion": 1,
-  "contractHash": "2a7bb14d9c6e87863b3e5849c70df433fd8e94874b4245ecb96005c9b58facef",
-  "documentApiSourceHash": "2ac0e7bc6f10262dd67bb6761f904bdcc5925569a9bd90d86714ce2a05cf4899",
-  "generatorHash": "519bb56fb86fd88a4ed8e101b1158837b82681af7349c20c4aca431ffcde53ba",
+  "contractHash": "571c15fc12f574bfea752e1f34d5d26943b857086f82aa803386b16ff6cb748b",
+  "documentApiSourceHash": "be4011c4eaa7e9ab162283b4b61ae458c938f68f8f56098ba851d1fe777a280e",
+  "generatorHash": "ee2e346ab9e32bff632e3a47a8a56568d0f711d7a48a063ac63a05f4d5c6b2e4",
   "inputs": {
     "apps/cli/src/host/sdk-policy.ts": "8820bc2cb4694bd665cbfacbb55c262a5df5cde4ed2a1a8d0735c09c6a5e6dd8",
     "packages/sdk/codegen/src/artifacts.mjs": "aecab7eca4694cbcf2366ddd9cabc033abddad2ff8fb0960d505580dbaf4d8b7",
@@ -15,7 +15,7 @@
     "packages/sdk/codegen/src/model/schema.mjs": "29cb1167413280907ad324d8a1fcb54dc70cce829df00c1a755f43040d01cf3b",
     "packages/sdk/codegen/src/shared.mjs": "a411e7ea4fab43b5b08b00294c746ff7063ceddbae66ece8d8c5990f131e0f7c",
     "packages/sdk/codegen/src/targets.mjs": "62c5ae3e3813e07b37e62487d973bac60ef6bea558a01f3ace2e0c6e8374e147",
-    "packages/sdk/langs/node/package.json": "d3c2ebf0639ccbc271903be1c65c44ce007a3d1b0abf922fd406334006f76b4e",
+    "packages/sdk/langs/node/package.json": "fde7b6d108e78c8c314931145abf5636e23203d6d288cfe7974bb36317d7b184",
     "packages/sdk/langs/node/scripts/embed-prompts.mjs": "1b1641bf89cad962a4ff11d93f301fe5a4e32fe856cd3c9586106d8aaab4ad80",
     "packages/sdk/langs/node/scripts/embed-tools.mjs": "4cd8b0605b088421ea1fdf8e4e19c70f571f4e3352309a1480491600122e7bb3",
     "packages/sdk/langs/node/scripts/embed-version.mjs": "95e2ff3a7c15cb38130e12f04c8a96c901a5e55d9960610ebefa37178fd19cde",
@@ -32,14 +32,14 @@
   "outputs": {
     "packages/sdk/langs/node/src/generated/contract.ts": {
       "id": "node-contract",
-      "sha256": "a0347fe91441c680470f91341119586a361c6eea45ab56c4da777f0499b20e39",
+      "sha256": "3a731906dd26de618b324ea4fd035211dac464d3cb7e923d56ad58ae581b601e",
       "consumers": [
         "node"
       ]
     },
     "packages/sdk/langs/node/src/generated/client.ts": {
       "id": "node-client",
-      "sha256": "048a8477d168a143a1c628b5ba8143c13d2091239b7220e159a0cfdfd14cea63",
+      "sha256": "3ad801a85830aa6b29983a199557ae3a2172b03870b9faeadecf838c53c3dea6",
       "consumers": [
         "node"
       ]
@@ -53,14 +53,14 @@
     },
     "packages/sdk/langs/python/superdoc/generated/contract.py": {
       "id": "python-contract",
-      "sha256": "4814bc8a0cf60e078b77a0973518c2234ffb460ccabc82b6fd3e5d13aea78c38",
+      "sha256": "55af1018df757766c0f9a699a472e5319902b6506af55e47ede87f185fd6a4ba",
       "consumers": [
         "python"
       ]
     },
     "packages/sdk/langs/python/superdoc/generated/client.py": {
       "id": "python-client",
-      "sha256": "298b1d76bb5a1a4e273db885d21c4f8b9cc7e9847aa0a65aa443ebd7e7fcd7cc",
+      "sha256": "8f45241f01762c57e4c8e8d6fd6e4cae669f11f9095d712d7a3f19af605b4788",
       "consumers": [
         "python"
       ]
@@ -95,7 +95,7 @@
     },
     "packages/sdk/tools/catalog.json": {
       "id": "tool-catalog",
-      "sha256": "ba5c70bc8b8fe72a82f73bf4713536b2d202a2baffb36cfd4b08ecf0d14c7a1c",
+      "sha256": "606606282b03c08d15c437e064f9a96783ddf02662ac3634b0e750528b1f5a4e",
       "consumers": [
         "node",
         "python",
@@ -104,7 +104,7 @@
     },
     "packages/sdk/tools/tools-policy.json": {
       "id": "tool-policy",
-      "sha256": "8a2abf87a86a95cbe7c24631f4e1f89cad44c480a6770b2a15d5a9bea941ff44",
+      "sha256": "8d3fd959cb3b3fd22bb8f5da31a33fb6de801376cb8e54e22fa5d9e8ececab10",
       "consumers": [
         "node",
         "python"
@@ -112,7 +112,7 @@
     },
     "packages/sdk/tools/tools.openai.json": {
       "id": "tools-openai",
-      "sha256": "95e07d8fb8e0173c1372d896be8ad5386bb8fecb7abc05605eb722086ca1c786",
+      "sha256": "fdf1f16a1555ff4262e6889417ba712c3f4f139e930c272ee2ede2032c2aced1",
       "consumers": [
         "node",
         "python",
@@ -121,7 +121,7 @@
     },
     "packages/sdk/tools/tools.anthropic.json": {
       "id": "tools-anthropic",
-      "sha256": "c3844d298975a858794b9ca64976a072af93e1fd0bd931743bcda2e5858f20e8",
+      "sha256": "790291ea69a13c8d1cbc73443dac73cc39c7a488b1a835a5fd40274b1ebe64bc",
       "consumers": [
         "node",
         "python",
@@ -130,7 +130,7 @@
     },
     "packages/sdk/tools/tools.vercel.json": {
       "id": "tools-vercel",
-      "sha256": "95e07d8fb8e0173c1372d896be8ad5386bb8fecb7abc05605eb722086ca1c786",
+      "sha256": "fdf1f16a1555ff4262e6889417ba712c3f4f139e930c272ee2ede2032c2aced1",
       "consumers": [
         "node",
         "python",
@@ -139,7 +139,7 @@
     },
     "packages/sdk/tools/tools.generic.json": {
       "id": "tools-generic",
-      "sha256": "dcae9520ad1946900265724a95bb7080d26fe1b133818f45951fc1cdb1ed6e29",
+      "sha256": "ea4d922bed6f2f42cc42ce4e618f91614cf0a265874ff80b15ec510b4ef5e312",
       "consumers": [
         "node",
         "python",
@@ -179,14 +179,14 @@
     },
     "packages/sdk/langs/node/src/embedded-tools.generated.ts": {
       "id": "node-embedded-tools",
-      "sha256": "f85a6a0803219006781dc0c83cc8fd362ecb27a5df3eaa9d0ade60276dc19ef0",
+      "sha256": "93669a5667db7f68372e3a8695b207ce064ec87599c99afbc372e08f122ef841",
       "consumers": [
         "node"
       ]
     },
     "packages/sdk/langs/node/src/runtime/sdk-version.generated.ts": {
       "id": "node-sdk-version",
-      "sha256": "aff3b5c5f6dd9ed08606dce36e87903ed37f59c523f6f0b6aa4e62a84ce9f88a",
+      "sha256": "002c4ef2efbcb9dae1be92bcbf4336a6b8634d0e33fc0ad053cb1688dc39f1cb",
       "consumers": [
         "node"
       ]

package/tools/tools-policy.json

@@ -43,5 +43,5 @@
       "mutates": true
     }
   ],
-  "contractHash": "2a7bb14d9c6e87863b3e5849c70df433fd8e94874b4245ecb96005c9b58facef"
+  "contractHash": "571c15fc12f574bfea752e1f34d5d26943b857086f82aa803386b16ff6cb748b"
 }

package/tools/tools.anthropic.json

@@ -6561,6 +6561,20 @@
             "$ref": "#/$defs/StoryLocator",
             "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes."
           },
+          "author": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "name"
+            ],
+            "description": "Display author for one tracked body text plan. Accepts only name; does not change the session user or inherit its email. Unsupported step combinations are rejected before mutation."
+          },
           "expectedRevision": {
             "type": "string",
             "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision. Only for action 'preview'. Omit for other actions."

package/tools/tools.generic.json

@@ -6729,6 +6729,20 @@
             "$ref": "#/$defs/StoryLocator",
             "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes."
           },
+          "author": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "name"
+            ],
+            "description": "Display author for one tracked body text plan. Accepts only name; does not change the session user or inherit its email. Unsupported step combinations are rejected before mutation."
+          },
           "expectedRevision": {
             "type": "string",
             "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision. Only for action 'preview'. Omit for other actions."

package/tools/tools.openai.json

@@ -6587,6 +6587,20 @@
               "$ref": "#/$defs/StoryLocator",
               "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes."
             },
+            "author": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "name"
+              ],
+              "description": "Display author for one tracked body text plan. Accepts only name; does not change the session user or inherit its email. Unsupported step combinations are rejected before mutation."
+            },
             "expectedRevision": {
               "type": "string",
               "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision. Only for action 'preview'. Omit for other actions."

package/tools/tools.vercel.json

@@ -6587,6 +6587,20 @@
               "$ref": "#/$defs/StoryLocator",
               "description": "Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes."
             },
+            "author": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "name"
+              ],
+              "description": "Display author for one tracked body text plan. Accepts only name; does not change the session user or inherit its email. Unsupported step combinations are rejected before mutation."
+            },
             "expectedRevision": {
               "type": "string",
               "description": "Document revision for optimistic concurrency. Mutation fails if document was modified since this revision. Only for action 'preview'. Omit for other actions."