@univerjs/rpc 0.1.0-alpha.1

package/lib/types/controllers/data-sync/data-sync-primary.controller.d.ts

@@ -0,0 +1,15 @@
+import { ICommandService, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { IRemoteInstanceService } from '../../services/remote-instance/remote-instance.service';
+/**
+ * This controller is responsible for syncing data from the primary thread to
+ * the worker thread.
+ */
+export declare class DataSyncPrimaryController extends RxDisposable {
+    private readonly _unsyncMutations;
+    private readonly _univerInstanceService;
+    private readonly _remoteInstanceService;
+    private readonly _commandService;
+    constructor(_unsyncMutations: Set<string>, _univerInstanceService: IUniverInstanceService, _remoteInstanceService: IRemoteInstanceService, _commandService: ICommandService);
+    private _init;
+}
+//# sourceMappingURL=data-sync-primary.controller.d.ts.map

package/lib/types/controllers/data-sync/data-sync-primary.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-sync-primary.controller.d.ts","sourceRoot":"","sources":["../../../../src/controllers/data-sync/data-sync-primary.controller.ts"],"names":[],"mappings":"AACA,OAAO,EAGH,eAAe,EACf,sBAAsB,EAGtB,YAAY,EACf,MAAM,gBAAgB,CAAC;AAIxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,wDAAwD,CAAC;AAEhG;;;GAGG;AACH,qBACa,yBAA0B,SAAQ,YAAY;IAEnD,OAAO,CAAC,QAAQ,CAAC,gBAAgB;IACT,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACvC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe;gBAHhC,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,EACL,sBAAsB,EAAE,sBAAsB,EAC9C,sBAAsB,EAAE,sBAAsB,EACrD,eAAe,EAAE,eAAe;IAOtE,OAAO,CAAC,KAAK;CAgChB"}

package/lib/types/controllers/data-sync/data-sync-replica.controller.d.ts

@@ -0,0 +1,14 @@
+import { Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
+import { IRemoteSyncService } from '../../services/remote-instance/remote-instance.service';
+/**
+ * This controller is responsible for syncing data from the worker thread to
+ * the primary thread.
+ */
+export declare class DataSyncReplicaController extends Disposable {
+    private readonly _commandService;
+    private readonly _remoteInstanceService;
+    private readonly _univerInstanceService;
+    constructor(_commandService: ICommandService, _remoteInstanceService: IRemoteSyncService, _univerInstanceService: IUniverInstanceService);
+    private _init;
+}
+//# sourceMappingURL=data-sync-replica.controller.d.ts.map

package/lib/types/controllers/data-sync/data-sync-replica.controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-sync-replica.controller.d.ts","sourceRoot":"","sources":["../../../../src/controllers/data-sync/data-sync-replica.controller.ts"],"names":[],"mappings":"AACA,OAAO,EAEH,UAAU,EACV,eAAe,EACf,sBAAsB,EAGzB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,wDAAwD,CAAC;AAE5F;;;GAGG;AACH,qBACa,yBAA0B,SAAQ,UAAU;IAEhC,OAAO,CAAC,QAAQ,CAAC,eAAe;IAC7B,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IACnC,OAAO,CAAC,QAAQ,CAAC,sBAAsB;gBAF7B,eAAe,EAAE,eAAe,EAC7B,sBAAsB,EAAE,kBAAkB,EACtC,sBAAsB,EAAE,sBAAsB;IAO3F,OAAO,CAAC,KAAK;CAYhB"}

package/lib/types/index.d.ts

@@ -0,0 +1,2 @@
+export { type IUniverRPCMainThreadPluginConfig, type IUniverRPCWorkerThreadPluginConfig, UniverRPCMainThreadPlugin, UniverRPCWorkerThreadPlugin, } from './plugin';
+//# sourceMappingURL=index.d.ts.map

package/lib/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,KAAK,gCAAgC,EACrC,KAAK,kCAAkC,EACvC,yBAAyB,EACzB,2BAA2B,GAC9B,MAAM,UAAU,CAAC"}

package/lib/types/plugin.d.ts

@@ -0,0 +1,30 @@
+import { Plugin, PluginType } from '@univerjs/core';
+import { Injector } from '@wendellhu/redi';
+export interface IUniverRPCMainThreadPluginConfig {
+    workerURL: string | URL;
+    unsyncMutations?: Set<string>;
+}
+/**
+ * This plugin is used to register the RPC services on the main thread. It
+ * is also responsible for booting up the Web Worker instance of Univer.
+ */
+export declare class UniverRPCMainThreadPlugin extends Plugin {
+    private readonly _config;
+    protected readonly _injector: Injector;
+    static type: PluginType;
+    constructor(_config: IUniverRPCMainThreadPluginConfig, _injector: Injector);
+    onStarting(injector: Injector): Promise<void>;
+}
+export interface IUniverRPCWorkerThreadPluginConfig {
+}
+/**
+ * This plugin is used to register the RPC services on the worker thread.
+ */
+export declare class UniverRPCWorkerThreadPlugin extends Plugin {
+    private readonly _config;
+    protected readonly _injector: Injector;
+    static type: PluginType;
+    constructor(_config: UniverRPCWorkerThreadPlugin, _injector: Injector);
+    onStarting(injector: Injector): void;
+}
+//# sourceMappingURL=plugin.d.ts.map

package/lib/types/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,EAA4B,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAkBrE,MAAM,WAAW,gCAAgC;IAC7C,SAAS,EAAE,MAAM,GAAG,GAAG,CAAC;IACxB,eAAe,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CACjC;AAOD;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,MAAM;IAI7C,OAAO,CAAC,QAAQ,CAAC,OAAO;IACN,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ;IAJ5D,OAAgB,IAAI,aAAqB;gBAGpB,OAAO,EAAE,gCAAgC,EACrB,SAAS,EAAE,QAAQ;IAK7C,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;CAwB/D;AAED,MAAM,WAAW,kCAAkC;CAAG;AAEtD;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,MAAM;IAI/C,OAAO,CAAC,QAAQ,CAAC,OAAO;IACN,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ;IAJ5D,OAAgB,IAAI,aAAqB;gBAGpB,OAAO,EAAE,2BAA2B,EAChB,SAAS,EAAE,QAAQ;IAKnD,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CAiBhD"}

package/lib/types/services/implementations/web-worker-rpc.service.d.ts

@@ -0,0 +1,12 @@
+import type { IMessageProtocol } from '../rpc/rpc.service';
+/**
+ * Generate an `IMessageProtocol` on the web worker.
+ */
+export declare function createWebWorkerMessagePortOnWorker(): IMessageProtocol;
+/**
+ * Generate an `IMessageProtocol` on the main thread side.
+ * @param worker The Web Worker object
+ * @returns
+ */
+export declare function createWebWorkerMessagePortOnMain(worker: Worker): IMessageProtocol;
+//# sourceMappingURL=web-worker-rpc.service.d.ts.map

package/lib/types/services/implementations/web-worker-rpc.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-worker-rpc.service.d.ts","sourceRoot":"","sources":["../../../../src/services/implementations/web-worker-rpc.service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;GAEG;AACH,wBAAgB,kCAAkC,IAAI,gBAAgB,CAarE;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAajF"}

package/lib/types/services/remote-instance/remote-instance.service.d.ts

@@ -0,0 +1,63 @@
+import type { IExecutionOptions, IMutationInfo, IWorkbookData } from '@univerjs/core';
+import { DocumentType, ICommandService, IUniverInstanceService } from '@univerjs/core';
+export interface IRemoteSyncMutationOptions extends IExecutionOptions {
+    /** If this mutation is executed after it was sent from the peer univer instance. */
+    fromSync?: boolean;
+}
+export declare const RemoteSyncServiceName = "univer.remote-sync-service";
+/**
+ * This service is provided by the primary Univer.
+ *
+ * Replica Univer could call this service to update mutations back to the primary Univer.
+ */
+export declare const IRemoteSyncService: import("@wendellhu/redi").IdentifierDecorator<IRemoteSyncService>;
+export interface IRemoteSyncService {
+    syncMutation(params: {
+        mutationInfo: IMutationInfo;
+    }): Promise<boolean>;
+}
+export declare class RemoteSyncPrimaryService implements IRemoteSyncService {
+    private readonly _commandService;
+    constructor(_commandService: ICommandService);
+    syncMutation(params: {
+        mutationInfo: IMutationInfo;
+    }): Promise<boolean>;
+}
+export declare const RemoteInstanceServiceName = "univer.remote-instance-service";
+/**
+ * This service is provided by the replica Univer.
+ *
+ * Primary univer could call this service to init and dispose univer business instances
+ * and sync mutations to replica univer.
+ */
+export declare const IRemoteInstanceService: import("@wendellhu/redi").IdentifierDecorator<IRemoteInstanceService>;
+export interface IRemoteInstanceService {
+    createInstance(params: {
+        unitID: string;
+        type: DocumentType;
+        snapshot: IWorkbookData;
+    }): Promise<boolean>;
+    disposeInstance(params: {
+        unitID: string;
+    }): Promise<boolean>;
+    syncMutation(params: {
+        mutationInfo: IMutationInfo;
+    }): Promise<boolean>;
+}
+export declare class RemoteInstanceReplicaService implements IRemoteInstanceService {
+    private readonly _univerInstanceService;
+    private readonly _commandService;
+    constructor(_univerInstanceService: IUniverInstanceService, _commandService: ICommandService);
+    syncMutation(params: {
+        mutationInfo: IMutationInfo;
+    }): Promise<boolean>;
+    createInstance(params: {
+        unitID: string;
+        type: DocumentType;
+        snapshot: IWorkbookData;
+    }): Promise<boolean>;
+    disposeInstance(params: {
+        unitID: string;
+    }): Promise<boolean>;
+}
+//# sourceMappingURL=remote-instance.service.d.ts.map

package/lib/types/services/remote-instance/remote-instance.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-instance.service.d.ts","sourceRoot":"","sources":["../../../../src/services/remote-instance/remote-instance.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAGvF,MAAM,WAAW,0BAA2B,SAAQ,iBAAiB;IACjE,oFAAoF;IACpF,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,eAAO,MAAM,qBAAqB,+BAA+B,CAAC;AAClE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,mEAA8D,CAAC;AAC9F,MAAM,WAAW,kBAAkB;IAC/B,YAAY,CAAC,MAAM,EAAE;QAAE,YAAY,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3E;AACD,qBAAa,wBAAyB,YAAW,kBAAkB;IAClC,OAAO,CAAC,QAAQ,CAAC,eAAe;gBAAf,eAAe,EAAE,eAAe;IAExE,YAAY,CAAC,MAAM,EAAE;QAAE,YAAY,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAMhF;AAED,eAAO,MAAM,yBAAyB,mCAAmC,CAAC;AAC1E;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,uEAAsE,CAAC;AAC1G,MAAM,WAAW,sBAAsB;IACnC,cAAc,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,YAAY,CAAC;QAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1G,eAAe,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9D,YAAY,CAAC,MAAM,EAAE;QAAE,YAAY,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3E;AACD,qBAAa,4BAA6B,YAAW,sBAAsB;IAE3C,OAAO,CAAC,QAAQ,CAAC,sBAAsB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe;gBADR,sBAAsB,EAAE,sBAAsB,EACrD,eAAe,EAAE,eAAe;IAGhE,YAAY,CAAC,MAAM,EAAE;QAAE,YAAY,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAOvE,cAAc,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,YAAY,CAAC;QAAC,QAAQ,EAAE,aAAa,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAoBzG,eAAe,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAGtE"}

package/lib/types/services/rpc/__tests__/rpc.service.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rpc.service.spec.d.ts.map

package/lib/types/services/rpc/__tests__/rpc.service.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.service.spec.d.ts","sourceRoot":"","sources":["../../../../../src/services/rpc/__tests__/rpc.service.spec.ts"],"names":[],"mappings":""}

package/lib/types/services/rpc/rpc.service.d.ts

@@ -0,0 +1,79 @@
+import { RxDisposable } from '@univerjs/core';
+import { Observable } from 'rxjs';
+/** This protocol is for transferring data from the two peer univer instance running in different locations. */
+export interface IMessageProtocol {
+    send(message: any): void;
+    onMessage: Observable<any>;
+}
+/**
+ * Channel is a combination of methods and event sources. These methods and
+ * event sources are usually provided by the same service or controller.
+ */
+export interface IChannel {
+    call<T>(method: string, args?: any): Promise<T>;
+    subscribe<T>(event: string, args?: any): Observable<T>;
+}
+/**
+ * Wrapper a service or a controller into a channel so it could be invoked by
+ * a remote client. When the protocol is called, it would forward to the
+ * underlying service or controller.
+ *
+ * @param module the wrapper service or controller
+ * @returns the channel instance
+ */
+export declare function fromModule(module: unknown): IChannel;
+/**
+ * Wrap a channel into a service or a controller so it could be invoked by
+ * the upper layer modules. When the service or controller is called, it would
+ * request the remote server by calling the channel.
+ *
+ * @param channel
+ * @returns
+ */
+export declare function toModule<T extends object>(channel: IChannel): T;
+export interface IChannelClient {
+    getChannel<T extends IChannel>(channelName: string): T;
+}
+/**
+ *
+ */
+export interface IChannelServer {
+    registerChannel<T extends IChannel>(channelName: string, channel: T): void;
+}
+/**
+ * This method provides implementation for `IChannel` and is responsible for
+ * transforming a local calling to a RPC calling.
+ */
+export declare class ChannelClient extends RxDisposable implements IChannelClient {
+    private readonly _protocol;
+    private _initialized;
+    private _lastRequestCounter;
+    private _pendingRequests;
+    private _pendingSubscriptions;
+    constructor(_protocol: IMessageProtocol);
+    getChannel<T extends IChannel>(channelName: string): T;
+    private _whenReady;
+    private _remoteCall;
+    private _remoteSubscribe;
+    private _sendRequest;
+    private _onResponse;
+}
+export declare class ChannelServer extends RxDisposable implements IChannelServer {
+    private readonly _protocol;
+    private _channels;
+    private _subscriptions;
+    constructor(_protocol: IMessageProtocol);
+    registerChannel(channelName: string, channel: IChannel): void;
+    private _onRequest;
+    private _onMethodCall;
+    private _onSubscribe;
+    private _onUnsubscribe;
+    private _sendResponse;
+}
+/**
+ * This service is for other service to register channels to the RPC framework.
+ */
+export interface IRPCService {
+}
+export declare const IRPCService: import("@wendellhu/redi").IdentifierDecorator<IRPCService>;
+//# sourceMappingURL=rpc.service.d.ts.map

package/lib/types/services/rpc/rpc.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.service.d.ts","sourceRoot":"","sources":["../../../../src/services/rpc/rpc.service.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,OAAO,EAAiD,UAAU,EAAM,MAAM,MAAM,CAAC;AAGrF,+GAA+G;AAC/G,MAAM,WAAW,gBAAgB;IAC7B,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAChD,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;CAC1D;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,CAiCpD;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,CAAC,CAe/D;AAMD,MAAM,WAAW,cAAc;IAC3B,UAAU,CAAC,CAAC,SAAS,QAAQ,EAAE,WAAW,EAAE,MAAM,GAAG,CAAC,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,eAAe,CAAC,CAAC,SAAS,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;CAC9E;AAkDD;;;GAGG;AACH,qBAAa,aAAc,SAAQ,YAAa,YAAW,cAAc;IAMzD,OAAO,CAAC,QAAQ,CAAC,SAAS;IALtC,OAAO,CAAC,YAAY,CAAuC;IAC3D,OAAO,CAAC,mBAAmB,CAAK;IAChC,OAAO,CAAC,gBAAgB,CAAuC;IAC/D,OAAO,CAAC,qBAAqB,CAAsC;gBAEtC,SAAS,EAAE,gBAAgB;IAQxD,UAAU,CAAC,CAAC,SAAS,QAAQ,EAAE,WAAW,EAAE,MAAM,GAAG,CAAC;IAqBtD,OAAO,CAAC,UAAU;YASJ,WAAW;IAiCzB,OAAO,CAAC,gBAAgB;IA8CxB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,WAAW;CActB;AAED,qBAAa,aAAc,SAAQ,YAAa,YAAW,cAAc;IAKzD,OAAO,CAAC,QAAQ,CAAC,SAAS;IAJtC,OAAO,CAAC,SAAS,CAA+B;IAEhD,OAAO,CAAC,cAAc,CAAmC;gBAE5B,SAAS,EAAE,gBAAgB;IAOxD,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI;IAI7D,OAAO,CAAC,UAAU;IAgBlB,OAAO,CAAC,aAAa;IA0BrB,OAAO,CAAC,YAAY;IAgCpB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,aAAa;CAGxB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;CAAG;AAC/B,eAAO,MAAM,WAAW,4DAA+C,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@univerjs/rpc",
+  "version": "0.1.0-alpha.1",
+  "keywords": [],
+  "author": "DreamNum <developer@univer.ai>",
+  "license": "MIT",
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./*": {
+      "import": "./lib/esm/*",
+      "require": "./lib/cjs/*",
+      "types": "./lib/types/index.d.ts"
+    }
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib"
+  ],
+  "private": false,
+  "dependencies": {
+    "@wendellhu/redi": "^0.12.11",
+    "rxjs": "^7.8.1",
+    "@univerjs/core": "0.1.0-alpha.1"
+  },
+  "devDependencies": {
+    "@types/numeral": "^2.0.5",
+    "@vitest/coverage-istanbul": "^0.34.6",
+    "esbuild": "^0.19.8",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.3.2",
+    "vitest": "^0.34.6"
+  },
+  "scripts": {
+    "esbuild": "node ./esbuild.config.mjs && tsc -p tsconfig.esbuild.json"
+  }
+}