snapshot of https://github.com/dream-num/univer.git (dev, 2026-09-16; blobs > 131072B omitted)

packages/rpc-node/README.md

@@ -0,0 +1,46 @@
+# @univerjs/rpc-node
+
+[![npm version](https://img.shields.io/npm/v/@univerjs/rpc-node?style=flat-square)](https://npmjs.com/package/@univerjs/rpc-node)
+[![license](https://img.shields.io/npm/l/@univerjs/rpc-node?style=flat-square)](https://npmjs.com/package/@univerjs/rpc-node)
+[![downloads](https://img.shields.io/npm/dm/@univerjs/rpc-node?style=flat-square)](https://npmjs.com/package/@univerjs/rpc-node)
+
+`@univerjs/rpc-node` provides the Node.js counterpart for Univer RPC scenarios, allowing main-thread and worker-side plugins to communicate outside the browser.
+
+## Package Overview
+
+| Package | UMD global | CSS | Locales | Facade entry |
+| --- | --- | :---: | :---: | :---: |
+| `@univerjs/rpc-node` | `UniverRpcNode` | No | No | No |
+
+## Installation
+
+```sh
+pnpm add @univerjs/rpc-node
+# or
+npm install @univerjs/rpc-node
+```
+
+Keep all `@univerjs/*` packages on the same version.
+
+## Usage
+
+```ts
+import { fileURLToPath } from 'node:url';
+import { UniverRPCNodeMainPlugin } from '@univerjs/rpc-node';
+
+const workerSrc = fileURLToPath(new URL('./worker.js', import.meta.url));
+univer.registerPlugin(UniverRPCNodeMainPlugin, { workerSrc });
+```
+
+The referenced worker module must create its own Univer instance and register `UniverRPCNodeWorkerPlugin`; see the [Node.js worker example](../../examples/src/node/sdk/worker.ts).
+
+Exported plugin classes:
+
+- `UniverRPCNodeMainPlugin`
+- `UniverRPCNodeWorkerPlugin`
+
+## Resources
+
+- [Documentation](https://docs.univer.ai)
+- [NPM package](https://npmjs.com/package/@univerjs/rpc-node)
+- [GitHub repository](https://github.com/dream-num/univer)

packages/rpc-node/package.json

@@ -0,0 +1,79 @@
+{
+    "name": "@univerjs/rpc-node",
+    "version": "1.0.0-rc.0",
+    "private": false,
+    "description": "Node.js RPC plugins for Univer main-thread and worker communication.",
+    "author": "DreamNum Co., Ltd. <developer@univer.ai>",
+    "license": "Apache-2.0",
+    "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/univer"
+    },
+    "homepage": "https://univer.ai",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/dream-num/univer"
+    },
+    "bugs": {
+        "url": "https://github.com/dream-num/univer/issues"
+    },
+    "keywords": [
+        "univer",
+        "rpc",
+        "nodejs",
+        "worker",
+        "plugin"
+    ],
+    "exports": {
+        ".": "./src/index.ts",
+        "./*": "./src/*"
+    },
+    "main": "./src/index.ts",
+    "types": "./lib/types/index.d.ts",
+    "publishConfig": {
+        "access": "public",
+        "main": "./lib/es/index.js",
+        "module": "./lib/es/index.js",
+        "exports": {
+            ".": {
+                "import": "./lib/es/index.js",
+                "require": "./lib/cjs/index.js",
+                "types": "./lib/types/index.d.ts"
+            },
+            "./*": {
+                "import": "./lib/es/*",
+                "require": "./lib/cjs/*",
+                "types": "./lib/types/index.d.ts"
+            },
+            "./lib/*": "./lib/*"
+        }
+    },
+    "directories": {
+        "lib": "lib"
+    },
+    "files": [
+        "lib"
+    ],
+    "scripts": {
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "coverage": "vitest run --coverage",
+        "typecheck": "tsc --noEmit",
+        "build:bundle": "univer-cli build",
+        "build:types": "tsc -p tsconfig.node.json",
+        "build": "pnpm run build:bundle && pnpm run build:types"
+    },
+    "peerDependencies": {
+        "rxjs": ">=7.0.0"
+    },
+    "dependencies": {
+        "@univerjs/core": "workspace:*",
+        "@univerjs/rpc": "workspace:*"
+    },
+    "devDependencies": {
+        "@univerjs-infra/shared": "workspace:*",
+        "rxjs": "^7.8.2",
+        "typescript": "^6.0.3",
+        "vitest": "^5.0.0"
+    }
+}

packages/rpc-node/src/config/config.ts

@@ -0,0 +1,34 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export const PLUGIN_CONFIG_KEY_MAIN_THREAD = 'rpc-node.main-thread.config';
+
+export const configSymbolMainThread = Symbol(PLUGIN_CONFIG_KEY_MAIN_THREAD);
+
+export interface IUniverRPCNodeMainConfig {
+    workerSrc?: string;
+}
+
+export const defaultPluginMainThreadConfig: IUniverRPCNodeMainConfig = {};
+
+export const PLUGIN_CONFIG_KEY_WORKER_THREAD = 'rpc-node.worker-thread.config';
+
+export const configSymbolWorkerThread = Symbol(PLUGIN_CONFIG_KEY_WORKER_THREAD);
+
+export interface IUniverRPCNodeWorkerThreadConfig {
+}
+
+export const defaultPluginWorkerThreadConfig: IUniverRPCNodeWorkerThreadConfig = {};

packages/rpc-node/src/index.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { UniverRPCNodeMainPlugin, UniverRPCNodeWorkerPlugin } from './plugin';

packages/rpc-node/src/plugin.ts

@@ -0,0 +1,171 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Dependency } from '@univerjs/core';
+import type { IMessageProtocol } from '@univerjs/rpc';
+import type { ChildProcess, Serializable } from 'node:child_process';
+import type { IUniverRPCNodeMainConfig, IUniverRPCNodeWorkerThreadConfig } from './config/config';
+import { fork } from 'node:child_process';
+import process from 'node:process';
+import { IConfigService, ILogService, Inject, Injector, merge, Plugin } from '@univerjs/core';
+import {
+    ChannelService,
+    DataSyncPrimaryController,
+    DataSyncReplicaController,
+    IRemoteInstanceService,
+    IRemoteSyncService,
+    IRPCChannelService,
+    RemoteSyncPrimaryService,
+    WebWorkerRemoteInstanceService,
+} from '@univerjs/rpc';
+import { Observable, shareReplay } from 'rxjs';
+import pkg from '../package.json';
+import { defaultPluginMainThreadConfig, defaultPluginWorkerThreadConfig, PLUGIN_CONFIG_KEY_MAIN_THREAD, PLUGIN_CONFIG_KEY_WORKER_THREAD } from './config/config';
+
+export class UniverRPCNodeMainPlugin extends Plugin {
+    static override pluginName = 'UNIVER_RPC_NODE_MAIN_PLUGIN';
+    static override packageName = pkg.name;
+    static override version = pkg.version;
+
+    private _child: ChildProcess | null = null;
+
+    constructor(
+        private readonly _config: Partial<IUniverRPCNodeMainConfig> = defaultPluginMainThreadConfig,
+        @Inject(Injector) protected readonly _injector: Injector,
+        @IConfigService private readonly _configService: IConfigService
+    ) {
+        super();
+
+        // Manage the plugin configuration.
+        const { ...rest } = merge(
+            {},
+            defaultPluginMainThreadConfig,
+            this._config
+        );
+        this._configService.setConfig(PLUGIN_CONFIG_KEY_MAIN_THREAD, rest);
+    }
+
+    override onStarting(): void {
+        const { workerSrc } = this._config;
+        if (!workerSrc) {
+            throw new Error('[UniverRPCNodeMainPlugin] workerSrc is required for UniverRPCNodeMainPlugin');
+        }
+
+        const [messageProtocol, child] = createNodeMessagePortOnMain(this._injector, workerSrc);
+
+        const dependencies: Dependency[] = [
+            [IRPCChannelService, {
+                // eslint-disable-next-line react/no-unnecessary-use-prefix
+                useFactory: () => new ChannelService(messageProtocol),
+            }],
+            [DataSyncPrimaryController],
+            [IRemoteSyncService, { useClass: RemoteSyncPrimaryService }],
+        ];
+
+        dependencies.forEach((dependency) => this._injector.add(dependency));
+
+        this._injector.get(DataSyncPrimaryController);
+        this._child = child;
+    }
+
+    override dispose(): void {
+        super.dispose();
+
+        if (this._child) {
+            try {
+                this._child.kill();
+            } catch (e) {
+                console.error('Failed to kill child process:', e);
+            }
+            this._child = null;
+        }
+    }
+}
+
+export class UniverRPCNodeWorkerPlugin extends Plugin {
+    static override pluginName = 'UNIVER_RPC_NODE_WORKER_PLUGIN';
+    static override packageName = pkg.name;
+    static override version = pkg.version;
+
+    constructor(
+        private readonly _config: Partial<IUniverRPCNodeWorkerThreadConfig> = defaultPluginWorkerThreadConfig,
+        @Inject(Injector) protected readonly _injector: Injector,
+        @IConfigService private readonly _configService: IConfigService
+    ) {
+        super();
+
+        // Manage the plugin configuration.
+        const { ...rest } = merge(
+            {},
+            defaultPluginWorkerThreadConfig,
+            this._config
+        );
+        this._configService.setConfig(PLUGIN_CONFIG_KEY_WORKER_THREAD, rest);
+    }
+
+    override onStarting(): void {
+        ([
+            [DataSyncReplicaController],
+            [IRPCChannelService, {
+                // eslint-disable-next-line react/no-unnecessary-use-prefix
+                useFactory: () => new ChannelService(createNodeWorkerMessageProtocol()),
+            }],
+            [IRemoteInstanceService, { useClass: WebWorkerRemoteInstanceService }],
+        ] as Dependency[]).forEach((d) => this._injector.add(d));
+
+        this._injector.get(DataSyncReplicaController);
+    }
+}
+
+function createNodeMessagePortOnMain(injector: Injector, path: string): [IMessageProtocol, ChildProcess] {
+    const logService = injector.get(ILogService);
+
+    const child = fork(path);
+    child.on('spawn', () => logService.log('Child computing process spawned!'));
+    child.on('error', (error) => logService.error(error));
+
+    const messageProtocol: IMessageProtocol = {
+        send(message: unknown): void {
+            child.send(message as Serializable);
+        },
+        onMessage: new Observable<unknown>((subscriber) => {
+            const handler = (message: unknown) => {
+                subscriber.next(message);
+            };
+
+            child.on('message', handler);
+            return () => child.off('message', handler);
+        }).pipe(shareReplay({ bufferSize: 1, refCount: true })),
+    };
+
+    return [messageProtocol, child];
+}
+
+function createNodeWorkerMessageProtocol(): IMessageProtocol {
+    return {
+        send(message) {
+            process.send!(message as Serializable);
+        },
+        onMessage: new Observable<unknown>((subscriber) => {
+            const handler = (event: unknown) => {
+                subscriber.next(event);
+            };
+
+            process.on('message', handler);
+            return () => process.off('message', handler);
+        }).pipe(shareReplay({ bufferSize: 1, refCount: true })),
+    };
+}

packages/rpc-node/tsconfig.json

@@ -0,0 +1,8 @@
+{
+    "extends": "@univerjs-infra/shared/tsconfigs/base",
+    "compilerOptions": {
+        "rootDir": "src",
+        "outDir": "lib/types"
+    },
+    "include": ["src"]
+}

packages/rpc-node/tsconfig.node.json

@@ -0,0 +1,18 @@
+{
+    "extends": "@univerjs-infra/shared/tsconfigs/node",
+    "compilerOptions": {
+        "rootDir": "src",
+        "declaration": true,
+        "emitDeclarationOnly": true,
+        "noEmit": false,
+        "outDir": "lib/types"
+    },
+    "include": [
+        "src"
+    ],
+    "exclude": [
+        "src/**/__tests__/**",
+        "src/**/*.spec.ts",
+        "src/**/*.test.ts"
+    ]
+}

packages/rpc-node/vitest.config.ts

@@ -0,0 +1,3 @@
+import createConfig from '@univerjs-infra/shared/vitest';
+
+export default createConfig();