@components-kit/open-workbook-office-js-engine 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Open Workbook contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# @components-kit/open-workbook-office-js-engine
+
+Office.js engine interface and defaults for Open Workbook.
+
+The live Office.js execution currently lives in the Excel add-in runtime. This package defines engine contracts and default options that future host bindings can share.
+
+## Usage
+
+```ts
+import { DefaultOfficeJsEngineOptions, OfficeJsEngine } from "@components-kit/open-workbook-office-js-engine";
+```
+
+Most users should install `@components-kit/open-workbook`. This package is published for engine integration work and tests.

package/dist/engine.d.ts

@@ -0,0 +1,24 @@
+import type { BatchRequest, CompiledBatch, OperationResult, RuntimeCapabilities, WorkbookRef } from "@components-kit/open-workbook-protocol";
+export interface ExcelEngine {
+    readonly name: string;
+    readonly version: string;
+    getCapabilities(): Promise<RuntimeCapabilities>;
+    getActiveWorkbook(): Promise<WorkbookRef | undefined>;
+    executeBatch(request: BatchRequest, compiled: CompiledBatch): Promise<OperationResult>;
+}
+export interface OfficeJsEngineOptions {
+    chunkCellLimit: number;
+    suspendCalculationCellThreshold: number;
+    suspendScreenUpdatingCellThreshold: number;
+}
+export declare const DefaultOfficeJsEngineOptions: OfficeJsEngineOptions;
+export declare class OfficeJsEngine implements ExcelEngine {
+    private readonly options;
+    readonly name = "office-js";
+    readonly version = "0.1.0";
+    constructor(options?: OfficeJsEngineOptions);
+    getCapabilities(): Promise<RuntimeCapabilities>;
+    getActiveWorkbook(): Promise<WorkbookRef | undefined>;
+    executeBatch(request: BatchRequest, compiled: CompiledBatch): Promise<OperationResult>;
+}
+//# sourceMappingURL=engine.d.ts.map

package/dist/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,WAAW,EACZ,MAAM,wCAAwC,CAAC;AAEhD,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChD,iBAAiB,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IACtD,YAAY,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CACxF;AAED,MAAM,WAAW,qBAAqB;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,+BAA+B,EAAE,MAAM,CAAC;IACxC,kCAAkC,EAAE,MAAM,CAAC;CAC5C;AAED,eAAO,MAAM,4BAA4B,EAAE,qBAI1C,CAAC;AAEF,qBAAa,cAAe,YAAW,WAAW;IAIpC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,QAAQ,CAAC,IAAI,eAAe;IAC5B,QAAQ,CAAC,OAAO,WAAW;gBAEE,OAAO,GAAE,qBAAoD;IAEpF,eAAe,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAuB/C,iBAAiB,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAIrD,YAAY,CAAC,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC;CA0B7F"}

package/dist/engine.js

@@ -0,0 +1,64 @@
+export const DefaultOfficeJsEngineOptions = {
+    chunkCellLimit: 50_000,
+    suspendCalculationCellThreshold: 10_000,
+    suspendScreenUpdatingCellThreshold: 10_000
+};
+export class OfficeJsEngine {
+    options;
+    name = "office-js";
+    version = "0.1.0";
+    constructor(options = DefaultOfficeJsEngineOptions) {
+        this.options = options;
+    }
+    async getCapabilities() {
+        return {
+            engine: {
+                name: this.name,
+                version: this.version,
+                platform: "unknown"
+            },
+            capabilities: [
+                { name: "workbook.context", supported: true, platforms: ["mac", "windows"] },
+                { name: "worksheet.copy", supported: true, platforms: ["mac", "windows"] },
+                { name: "range.write.values", supported: true, platforms: ["mac", "windows"] },
+                { name: "range.write.formulas", supported: true, platforms: ["mac", "windows"] },
+                { name: "template.fingerprint", supported: true, platforms: ["mac", "windows"] },
+                {
+                    name: "workbook.restore.full_file",
+                    supported: false,
+                    platforms: ["mac", "windows"],
+                    notes: "Full file restore is coordinated by the backend and may require user or OS-level file replacement."
+                }
+            ]
+        };
+    }
+    async getActiveWorkbook() {
+        return undefined;
+    }
+    async executeBatch(request, compiled) {
+        const started = Date.now();
+        return {
+            ok: false,
+            rollbackAvailable: compiled.requiredBackups.length > 0,
+            backups: [],
+            warnings: [
+                {
+                    code: "ENGINE_NOT_BOUND",
+                    message: "OfficeJsEngine is scaffolded but not yet bound to Excel.run in the add-in runtime."
+                }
+            ],
+            telemetry: {
+                durationMs: Date.now() - started,
+                syncCount: 0,
+                payloadBytes: JSON.stringify(request).length,
+                cellsWritten: compiled.estimatedCellsTouched,
+                rangeCount: compiled.targetFingerprints.length,
+                chunkCount: Math.max(1, Math.ceil(compiled.estimatedCellsTouched / this.options.chunkCellLimit)),
+                engineName: this.name,
+                engineVersion: this.version,
+                warningCount: 1
+            }
+        };
+    }
+}
+//# sourceMappingURL=engine.js.map

package/dist/engine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.js","sourceRoot":"","sources":["../src/engine.ts"],"names":[],"mappings":"AAsBA,MAAM,CAAC,MAAM,4BAA4B,GAA0B;IACjE,cAAc,EAAE,MAAM;IACtB,+BAA+B,EAAE,MAAM;IACvC,kCAAkC,EAAE,MAAM;CAC3C,CAAC;AAEF,MAAM,OAAO,cAAc;IAII;IAHpB,IAAI,GAAG,WAAW,CAAC;IACnB,OAAO,GAAG,OAAO,CAAC;IAE3B,YAA6B,UAAiC,4BAA4B;QAA7D,YAAO,GAAP,OAAO,CAAsD;IAAG,CAAC;IAE9F,KAAK,CAAC,eAAe;QACnB,OAAO;YACL,MAAM,EAAE;gBACN,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,QAAQ,EAAE,SAAS;aACpB;YACD,YAAY,EAAE;gBACZ,EAAE,IAAI,EAAE,kBAAkB,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE;gBAC5E,EAAE,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE;gBAC1E,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE;gBAC9E,EAAE,IAAI,EAAE,sBAAsB,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE;gBAChF,EAAE,IAAI,EAAE,sBAAsB,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE;gBAChF;oBACE,IAAI,EAAE,4BAA4B;oBAClC,SAAS,EAAE,KAAK;oBAChB,SAAS,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC;oBAC7B,KAAK,EAAE,oGAAoG;iBAC5G;aACF;SACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,OAAqB,EAAE,QAAuB;QAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE3B,OAAO;YACL,EAAE,EAAE,KAAK;YACT,iBAAiB,EAAE,QAAQ,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC;YACtD,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE;gBACR;oBACE,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EAAE,oFAAoF;iBAC9F;aACF;YACD,SAAS,EAAE;gBACT,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,OAAO;gBAChC,SAAS,EAAE,CAAC;gBACZ,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM;gBAC5C,YAAY,EAAE,QAAQ,CAAC,qBAAqB;gBAC5C,UAAU,EAAE,QAAQ,CAAC,kBAAkB,CAAC,MAAM;gBAC9C,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBAChG,UAAU,EAAE,IAAI,CAAC,IAAI;gBACrB,aAAa,EAAE,IAAI,CAAC,OAAO;gBAC3B,YAAY,EAAE,CAAC;aAChB;SACF,CAAC;IACJ,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./engine.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./engine.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@components-kit/open-workbook-office-js-engine",
+  "version": "0.1.0",
+  "description": "Office.js engine interfaces and defaults for Open Workbook Excel execution.",
+  "license": "MIT",
+  "type": "module",
+  "homepage": "https://github.com/components-kit/open-workbook#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/components-kit/open-workbook.git",
+    "directory": "packages/office-js-engine"
+  },
+  "bugs": {
+    "url": "https://github.com/components-kit/open-workbook/issues"
+  },
+  "keywords": [
+    "excel",
+    "office-js",
+    "spreadsheet",
+    "engine"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@components-kit/open-workbook-protocol": "0.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.3",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run --passWithNoTests"
+  }
+}