feat(core): univer support override dependencies (#2050)

* feat(core): univer support override dependencies * fix: fix pushed dependency * chore: upgrade redi version
dream-num · Apr 23, 2024 · cfad0da · cfad0da
1 parent ce029a8
commit cfad0da
Show file tree

Hide file tree

Showing 32 changed files with 196 additions and 127 deletions.
diff --git a/common/shared/vite/auto-externalize-dependency-plugin.js b/common/shared/vite/auto-externalize-dependency-plugin.js
@@ -11,7 +11,7 @@ exports.autoExternalizeDependency = function autoExternalizeDependency() {
         '@wendellhu/redi': {
             global: '@wendellhu/redi',
             name: '@wendellhu/redi',
-            version: '0.13.0',
+            version: '^0.13.1',
         },
         '@wendellhu/redi/react-bindings': {
             global: '@wendellhu/redi/react-bindings',

diff --git a/common/storybook/package.json b/common/storybook/package.json
@@ -30,7 +30,7 @@
         "@univerjs/core": "workspace:*",
         "@univerjs/design": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "css-loader": "^6.10.0",
         "less-loader": "^12.2.0",
         "storybook": "8.0.9",

diff --git a/examples/package.json b/examples/package.json
@@ -37,7 +37,7 @@
         "@univerjs/slides-ui": "workspace:*",
         "@univerjs/ui": "workspace:*",
         "@univerjs/uniscript": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "clsx": "^2.1.1",
         "monaco-editor": "0.47.0",
         "react": "^18.2.0",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -64,7 +64,7 @@
         "build": "tsc && vite build"
     },
     "peerDependencies": {
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "dependencies": {
@@ -76,7 +76,7 @@
     "devDependencies": {
         "@types/numeral": "^2.0.5",
         "@univerjs/shared": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",
         "vite": "^5.2.10",

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -117,6 +117,7 @@ export type { IComposeInterceptors, IInterceptor, InterceptorHandler } from './c
 export { composeInterceptors, createInterceptorKey, InterceptorManager } from './common/interceptor';
 export { normalizeTextRuns } from './docs/data-model/apply-utils/common';
 export type { PluginCtor } from './services/plugin/plugin';
+export { type DependencyOverride, mergeOverrideWithDependencies } from './services/plugin/plugin-override';
 export { Range } from './sheets/range';
 export { Styles } from './sheets/styles';
 export {

diff --git a/packages/core/src/services/plugin/plugin-override.ts b/packages/core/src/services/plugin/plugin-override.ts
@@ -0,0 +1,51 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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.
+ */
+
+/* eslint-disable ts/no-explicit-any */
+
+import type { Dependency, DependencyItem, IdentifierDecorator } from '@wendellhu/redi';
+
+/**
+ * Overrides the dependencies definited in the plugin. Only dependencies that are identified by `IdentifierDecorator` can be overridden.
+ * If you override a dependency with `null`, the original dependency will be removed.
+ */
+export type DependencyOverride = [identifier: IdentifierDecorator<any>, DependencyItem<any> | null][];
+
+export function mergeOverrideWithDependencies(dependencies: Dependency[], override?: DependencyOverride): Dependency[] {
+    if (!override) {
+        return dependencies;
+    }
+
+    const result: Dependency[] = [];
+    for (const dependency of dependencies) {
+        if (dependency.length === 1) {
+            result.push(dependency);
+            continue;
+        }
+
+        const overrideItem = override.find(([identifier]) => identifier === dependency[0]);
+        if (overrideItem) {
+            if (overrideItem[1] === null) {
+                continue;
+            }
+            result.push([dependency[0], overrideItem[1]]);
+        } else {
+            result.push(dependency);
+        }
+    }
+
+    return result;
+}
diff --git a/packages/core/src/types/interfaces/i-univer-data.ts b/packages/core/src/types/interfaces/i-univer-data.ts
@@ -15,6 +15,7 @@
  */
 
 import type { LogLevel } from '../../services/log/log.service';
+import type { DependencyOverride } from '../../services/plugin/plugin-override';
 import type { IStyleSheet } from '../../services/theme/theme.service';
 import type { ILocales } from '../../shared/locale';
 import type { LocaleType } from '../enum';
@@ -25,19 +26,6 @@ export interface IUniverData {
     locales: ILocales;
     logLevel: LogLevel;
     id: string;
-}
-
-/**
- * Toolbar Observer generic interface, convenient for plug-ins to define their own types
- */
-export interface UIObserver<T = string> {
-    /**
-     * fontSize, fontFamily,color...
-     */
-    name: string;
 
-    /**
-     * fontSize:number, fontFamily:string ...
-     */
-    value?: T;
+    override?: DependencyOverride;
 }
diff --git a/packages/core/src/univer.ts b/packages/core/src/univer.ts
@@ -47,6 +47,8 @@ import type { UnitModel, UnitType } from './common/unit';
 import { UniverInstanceType } from './common/unit';
 import { PluginService } from './services/plugin/plugin.service';
 import type { Plugin, PluginCtor } from './services/plugin/plugin';
+import type { DependencyOverride } from './services/plugin/plugin-override';
+import { mergeOverrideWithDependencies } from './services/plugin/plugin-override';
 
 export class Univer {
     private _startedTypes = new Set<UnitType>();
@@ -66,7 +68,7 @@ export class Univer {
      * @param parentInjector An optional parent injector of the Univer injector. For more information, see https://redi.wendell.fun/docs/hierarchy.
      */
     constructor(config: Partial<IUniverData> = {}, parentInjector?: Injector) {
-        const injector = this._injector = createUniverInjector(parentInjector);
+        const injector = this._injector = createUniverInjector(parentInjector, config?.override);
 
         const { theme, locale, locales, logLevel } = config;
 
@@ -159,15 +161,17 @@ export class Univer {
     }
 }
 
-function createUniverInjector(parentInjector?: Injector) {
-    const dependencies: Dependency[] = ([
+function createUniverInjector(parentInjector?: Injector, override?: DependencyOverride) {
+    const dependencies: Dependency[] = mergeOverrideWithDependencies([
         [ErrorService],
         [LocaleService],
         [ThemeService],
         [LifecycleService],
         [LifecycleInitializerService],
         [UniverPermissionService],
         [PluginService],
+
+        // abstract services
         [IUniverInstanceService, { useClass: UniverInstanceService }],
         [IPermissionService, { useClass: PermissionService }],
         [ILogService, { useClass: DesktopLogService, lazy: true }],
@@ -178,7 +182,7 @@ function createUniverInjector(parentInjector?: Injector) {
         [IFloatingObjectManagerService, { useClass: FloatingObjectManagerService, lazy: true }],
         [IResourceManagerService, { useClass: ResourceManagerService, lazy: true }],
         [IResourceLoaderService, { useClass: ResourceLoaderService, lazy: true }],
-    ]);
+    ], override);
 
     return parentInjector ? parentInjector.createChild(dependencies) : new Injector(dependencies);
 }
diff --git a/packages/data-validation/package.json b/packages/data-validation/package.json
@@ -64,7 +64,7 @@
     "peerDependencies": {
         "@univerjs/core": "workspace:*",
         "@univerjs/sheets": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "dependencies": {
@@ -76,7 +76,7 @@
         "@univerjs/protocol": "^0.1.14",
         "@univerjs/shared": "workspace:*",
         "@univerjs/sheets": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",
         "vite": "^5.2.10",

diff --git a/packages/docs-ui/package.json b/packages/docs-ui/package.json
@@ -71,7 +71,7 @@
         "@univerjs/docs": "workspace:*",
         "@univerjs/engine-render": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "react": "^16.9.0 || ^17.0.0 || ^18.0.0",
         "rxjs": ">=7.0.0"
     },
@@ -83,7 +83,7 @@
         "@univerjs/engine-render": "workspace:*",
         "@univerjs/shared": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "less": "^4.2.0",
         "react": "^18.2.0",
         "rxjs": "^7.8.1",

diff --git a/packages/docs/package.json b/packages/docs/package.json
@@ -65,14 +65,14 @@
     "peerDependencies": {
         "@univerjs/core": "workspace:*",
         "@univerjs/engine-render": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "devDependencies": {
         "@univerjs/core": "workspace:*",
         "@univerjs/engine-render": "workspace:*",
         "@univerjs/shared": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",
         "vite": "^5.2.10",

diff --git a/packages/engine-formula/package.json b/packages/engine-formula/package.json
@@ -64,7 +64,7 @@
     },
     "peerDependencies": {
         "@univerjs/core": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "dependencies": {
@@ -75,7 +75,7 @@
         "@types/big.js": "^6.2.2",
         "@univerjs/core": "workspace:*",
         "@univerjs/shared": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",
         "vite": "^5.2.10",

diff --git a/packages/engine-render/package.json b/packages/engine-render/package.json
@@ -64,7 +64,7 @@
     },
     "peerDependencies": {
         "@univerjs/core": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "dependencies": {
@@ -75,7 +75,7 @@
         "@types/opentype.js": "^1.3.8",
         "@univerjs/core": "workspace:*",
         "@univerjs/shared": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",
         "vite": "^5.2.10",

diff --git a/packages/facade/package.json b/packages/facade/package.json
@@ -71,7 +71,7 @@
         "@univerjs/sheets-formula": "workspace:*",
         "@univerjs/sheets-numfmt": "workspace:*",
         "@univerjs/sheets-ui": "workspace:*",
-        "@wendellhu/redi": "0.13.0"
+        "@wendellhu/redi": "^0.13.1"
     },
     "devDependencies": {
         "@univerjs/core": "workspace:*",
@@ -86,7 +86,7 @@
         "@univerjs/sheets-numfmt": "workspace:*",
         "@univerjs/sheets-ui": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "jsdom": "^24.0.0",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",

diff --git a/packages/find-replace/package.json b/packages/find-replace/package.json
@@ -70,7 +70,7 @@
         "@univerjs/design": "workspace:*",
         "@univerjs/engine-render": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "react": "^16.9.0 || ^17.0.0 || ^18.0.0",
         "rxjs": ">=7.0.0"
     },
@@ -85,7 +85,7 @@
         "@univerjs/engine-render": "workspace:*",
         "@univerjs/shared": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "less": "^4.2.0",
         "react": "^18.2.0",
         "rxjs": "^7.8.1",

diff --git a/packages/image/package.json b/packages/image/package.json
@@ -63,7 +63,7 @@
     "peerDependencies": {
         "@univerjs/core": "workspace:*",
         "@univerjs/engine-render": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "dependencies": {
@@ -76,7 +76,7 @@
         "@univerjs/shared": "workspace:*",
         "@univerjs/sheets": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "less": "^4.2.0",
         "react": "^18.2.0",
         "rxjs": "^7.8.1",

diff --git a/packages/network/package.json b/packages/network/package.json
@@ -63,13 +63,13 @@
     },
     "peerDependencies": {
         "@univerjs/core": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "devDependencies": {
         "@univerjs/core": "workspace:*",
         "@univerjs/shared": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",
         "vite": "^5.2.10",

diff --git a/packages/rpc/package.json b/packages/rpc/package.json
@@ -60,13 +60,13 @@
     },
     "peerDependencies": {
         "@univerjs/core": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "devDependencies": {
         "@univerjs/core": "workspace:*",
         "@univerjs/shared": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "typescript": "^5.4.5",
         "vite": "^5.2.10",

diff --git a/packages/sheets-conditional-formatting-ui/package.json b/packages/sheets-conditional-formatting-ui/package.json
@@ -74,7 +74,7 @@
         "@univerjs/sheets-conditional-formatting": "workspace:*",
         "@univerjs/sheets-ui": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "clsx": ">=2.0.0",
         "react": "^16.9.0 || ^17.0.0 || ^18.0.0",
         "react-dom": "^16.9.0 || ^17.0.0 || ^18.0.0",
@@ -101,7 +101,7 @@
         "@univerjs/sheets": "workspace:*",
         "@univerjs/sheets-ui": "workspace:*",
         "@univerjs/ui": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "clsx": "^2.1.1",
         "less": "^4.2.0",
         "react": "^18.2.0",

diff --git a/packages/sheets-conditional-formatting/package.json b/packages/sheets-conditional-formatting/package.json
@@ -68,7 +68,7 @@
         "@univerjs/engine-formula": "workspace:*",
         "@univerjs/engine-render": "workspace:*",
         "@univerjs/sheets": "workspace:*",
-        "@wendellhu/redi": "0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": ">=7.0.0"
     },
     "dependencies": {
@@ -82,7 +82,7 @@
         "@univerjs/icons-svg": "^0.1.44",
         "@univerjs/shared": "workspace:*",
         "@univerjs/sheets": "workspace:*",
-        "@wendellhu/redi": "^0.13.0",
+        "@wendellhu/redi": "^0.13.1",
         "rxjs": "^7.8.1",
         "sharp": "^0.33.3",
         "typescript": "^5.4.5",