@nocobase/client-v2 2.1.0-alpha.10 → 2.1.0-alpha.11

package/es/utils/globalDeps.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { RequireJS } from './requirejs';
+/**
+ * @internal
+ */
+export declare function defineGlobalDeps(requirejs: RequireJS): void;

package/lib/Application.js

@@ -62,6 +62,7 @@ var import_RouterManager = require("./RouterManager");
 var import_WebSocketClient = require("./WebSocketClient");
 var import_components = require("./components");
 var import_utils = require("./utils");
+var import_globalDeps = require("./utils/globalDeps");
 var import_requirejs = require("./utils/requirejs");
 var _providers, _router;
 const _Application = class _Application {
@@ -218,6 +219,7 @@ const _Application = class _Application {
       return;
     }
     window["requirejs"] = this.requirejs = (0, import_requirejs.getRequireJs)();
+    (0, import_globalDeps.defineGlobalDeps)(this.requirejs);
     window.define = this.requirejs.define;
   }
   addDefaultProviders() {

package/lib/PluginManager.js

@@ -60,7 +60,7 @@ const _PluginManager = class _PluginManager {
   }
   async initRemotePlugins() {
     var _a;
-    const res = await this.app.apiClient.request({ url: "pm:listEnabled" });
+    const res = await this.app.apiClient.request({ url: "pm:listEnabledV2" });
     const pluginList = ((_a = res == null ? void 0 : res.data) == null ? void 0 : _a.data) || [];
     const plugins = await (0, import_remotePlugins.getPlugins)({
       requirejs: this.app.requirejs,

package/lib/utils/globalDeps.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { RequireJS } from './requirejs';
+/**
+ * @internal
+ */
+export declare function defineGlobalDeps(requirejs: RequireJS): void;

package/lib/utils/globalDeps.js

@@ -0,0 +1,82 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var globalDeps_exports = {};
+__export(globalDeps_exports, {
+  defineGlobalDeps: () => defineGlobalDeps
+});
+module.exports = __toCommonJS(globalDeps_exports);
+var antdCssinjs = __toESM(require("@ant-design/cssinjs"));
+var antdIcons = __toESM(require("@ant-design/icons"));
+var formilyCore = __toESM(require("@formily/core"));
+var formilyReact = __toESM(require("@formily/react"));
+var formilyReactive = __toESM(require("@formily/reactive"));
+var formilyShared = __toESM(require("@formily/shared"));
+var nocobaseFlowEngine = __toESM(require("@nocobase/flow-engine"));
+var antd = __toESM(require("antd"));
+var i18next = __toESM(require("i18next"));
+var import_react = __toESM(require("react"));
+var import_react_dom = __toESM(require("react-dom"));
+var reactI18next = __toESM(require("react-i18next"));
+var ReactRouter = __toESM(require("react-router"));
+var ReactRouterDom = __toESM(require("react-router-dom"));
+var import_jsx_runtime = __toESM(require("react/jsx-runtime"));
+var nocobaseClientV2 = __toESM(require("../index"));
+function defineGlobalDeps(requirejs) {
+  requirejs.define("react", () => import_react.default);
+  requirejs.define("react-dom", () => import_react_dom.default);
+  requirejs.define("react/jsx-runtime", () => import_jsx_runtime.default);
+  requirejs.define("react-router", () => ReactRouter);
+  requirejs.define("react-router-dom", () => ReactRouterDom);
+  requirejs.define("antd", () => antd);
+  requirejs.define("@ant-design/icons", () => antdIcons);
+  requirejs.define("@ant-design/cssinjs", () => antdCssinjs);
+  requirejs.define("i18next", () => i18next);
+  requirejs.define("react-i18next", () => reactI18next);
+  requirejs.define("@formily/core", () => formilyCore);
+  requirejs.define("@formily/react", () => formilyReact);
+  requirejs.define("@formily/reactive", () => formilyReactive);
+  requirejs.define("@formily/shared", () => formilyShared);
+  requirejs.define("@nocobase/client-v2", () => nocobaseClientV2);
+  requirejs.define("@nocobase/client-v2/client-v2", () => nocobaseClientV2);
+  requirejs.define("@nocobase/flow-engine", () => nocobaseFlowEngine);
+}
+__name(defineGlobalDeps, "defineGlobalDeps");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  defineGlobalDeps
+});

package/lib/utils/remotePlugins.js

@@ -37,12 +37,12 @@ __export(remotePlugins_exports, {
 module.exports = __toCommonJS(remotePlugins_exports);
 function defineDevPlugins(plugins) {
   Object.entries(plugins).forEach(([packageName, plugin]) => {
-    window.define(`${packageName}/client`, () => plugin);
+    window.define(`${packageName}/client-v2`, () => plugin);
   });
 }
 __name(defineDevPlugins, "defineDevPlugins");
 function definePluginClient(packageName) {
-  window.define(`${packageName}/client`, ["exports", packageName], function(_exports, _pluginExports) {
+  window.define(`${packageName}/client-v2`, ["exports", packageName], function(_exports, _pluginExports) {
     Object.defineProperty(_exports, "__esModule", {
       value: true
     });

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@nocobase/client-v2",
-  "version": "2.1.0-alpha.10",
+  "version": "2.1.0-alpha.11",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.mjs",
   "types": "es/index.d.ts",
   "dependencies": {
-    "@nocobase/flow-engine": "2.1.0-alpha.10",
-    "@nocobase/sdk": "2.1.0-alpha.10",
-    "@nocobase/shared": "2.1.0-alpha.10",
+    "@nocobase/flow-engine": "2.1.0-alpha.11",
+    "@nocobase/sdk": "2.1.0-alpha.11",
+    "@nocobase/shared": "2.1.0-alpha.11",
     "i18next": "^22.4.9",
     "react-router-dom": "^6.30.1"
   },
-  "gitHead": "ce790d46c0a5768ca9618c7d0d77ab8300de75c8"
+  "gitHead": "bb96d633a6371afb586072ff516bd0613c757db0"
 }

package/src/Application.tsx

@@ -30,6 +30,7 @@ import { type ComponentTypeAndString, RouterManager, type RouterOptions } from '
 import { WebSocketClient, type WebSocketClientOptions } from './WebSocketClient';
 import { BlankComponent } from './components';
 import { compose, normalizeContainer } from './utils';
+import { defineGlobalDeps } from './utils/globalDeps';
 import type { RequireJS } from './utils/requirejs';
 import { getRequireJs } from './utils/requirejs';
 
@@ -232,6 +233,7 @@ export class Application {
       return;
     }
     window['requirejs'] = this.requirejs = getRequireJs();
+    defineGlobalDeps(this.requirejs);
     window.define = this.requirejs.define;
   }
 

package/src/PluginManager.ts

@@ -54,7 +54,7 @@ export class PluginManager {
   }
 
   private async initRemotePlugins() {
-    const res = await this.app.apiClient.request({ url: 'pm:listEnabled' });
+    const res = await this.app.apiClient.request({ url: 'pm:listEnabledV2' });
     const pluginList: PluginData[] = res?.data?.data || [];
     const plugins = await getPlugins({
       requirejs: this.app.requirejs,

package/src/__tests__/globalDeps.test.ts

@@ -0,0 +1,26 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineGlobalDeps } from '../utils/globalDeps';
+
+describe('client-v2 defineGlobalDeps', () => {
+  it('should register shared AMD dependencies for remote plugins', () => {
+    const define = vi.fn();
+
+    defineGlobalDeps({
+      define,
+    } as any);
+
+    expect(define).toHaveBeenCalledWith('react', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('react-router-dom', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@formily/react', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@nocobase/client-v2', expect.any(Function));
+    expect(define).toHaveBeenCalledWith('@nocobase/flow-engine', expect.any(Function));
+  });
+});

package/src/__tests__/plugin.test.ts

@@ -0,0 +1,61 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { createMockClient, Plugin } from '@nocobase/client-v2';
+
+describe('PluginManager', () => {
+  it('should request remote plugins from pm:listEnabledV2', async () => {
+    const app = createMockClient({
+      loadRemotePlugins: true,
+    });
+    app.apiMock.onGet('pm:listEnabledV2').reply(200, { data: [] });
+
+    await app.load();
+
+    expect(app.apiMock.history.get).toHaveLength(1);
+    expect(app.apiMock.history.get[0]?.url).toBe('pm:listEnabledV2');
+  });
+
+  it('should not request remote plugins from pm:listEnabled', async () => {
+    const app = createMockClient({
+      loadRemotePlugins: true,
+    });
+    app.apiMock.onGet('pm:listEnabledV2').reply(200, { data: [] });
+
+    await app.load();
+
+    expect(app.apiMock.history.get.some((request) => request.url === 'pm:listEnabled')).toBe(false);
+  });
+
+  it('should define client-v2 module ids for dev plugins', async () => {
+    class DemoPlugin extends Plugin {}
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    const app = createMockClient({
+      loadRemotePlugins: true,
+      devDynamicImport: vi.fn().mockResolvedValue({ default: DemoPlugin }) as any,
+    });
+    app.apiMock.onGet('pm:listEnabledV2').reply(200, {
+      data: [
+        {
+          name: '@nocobase/demo',
+          packageName: '@nocobase/demo',
+          url: 'https://demo.com/dist/client-v2/index.js',
+        },
+      ],
+    });
+
+    await app.load();
+
+    expect(mockDefine).toHaveBeenCalledWith('@nocobase/demo/client-v2', expect.any(Function));
+    expect(mockDefine).not.toHaveBeenCalledWith('@nocobase/demo/client', expect.any(Function));
+  });
+});

package/src/__tests__/remotePlugins.test.ts

@@ -0,0 +1,72 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { Plugin } from '../Plugin';
+import { defineDevPlugins, definePluginClient, getPlugins } from '../utils/remotePlugins';
+
+describe('client-v2 remotePlugins', () => {
+  afterEach(() => {
+    window.define = undefined;
+  });
+
+  it('should define dev plugins with /client-v2 module ids', () => {
+    class DemoPlugin extends Plugin {}
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    defineDevPlugins({
+      '@nocobase/demo': DemoPlugin,
+    });
+
+    expect(mockDefine).toHaveBeenCalledWith('@nocobase/demo/client-v2', expect.any(Function));
+  });
+
+  it('should define remote plugin proxies with /client-v2 module ids', () => {
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    definePluginClient('@nocobase/demo');
+
+    expect(mockDefine).toHaveBeenCalledWith(
+      '@nocobase/demo/client-v2',
+      ['exports', '@nocobase/demo'],
+      expect.any(Function),
+    );
+  });
+
+  it('should not define /client aliases when loading v2 plugins', async () => {
+    class DemoPlugin extends Plugin {}
+
+    const requirejs: any = {
+      requirejs: vi.fn(),
+    };
+    requirejs.requirejs.config = vi.fn();
+    requirejs.requirejs.requirejs = vi.fn();
+
+    const mockDefine: any = vi.fn();
+    window.define = mockDefine;
+
+    const plugins = await getPlugins({
+      requirejs,
+      pluginData: [
+        {
+          name: '@nocobase/demo',
+          packageName: '@nocobase/demo',
+          url: 'https://demo.com/dist/client-v2/index.js',
+        },
+      ] as any,
+      devDynamicImport: vi.fn().mockResolvedValue({ default: DemoPlugin }) as any,
+    });
+
+    expect(plugins).toEqual([['@nocobase/demo', DemoPlugin]]);
+    expect(mockDefine).toHaveBeenCalledWith('@nocobase/demo/client-v2', expect.any(Function));
+    expect(mockDefine).not.toHaveBeenCalledWith('@nocobase/demo/client', expect.any(Function));
+  });
+});

package/src/utils/globalDeps.ts

@@ -0,0 +1,61 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import * as antdCssinjs from '@ant-design/cssinjs';
+import * as antdIcons from '@ant-design/icons';
+import * as formilyCore from '@formily/core';
+import * as formilyReact from '@formily/react';
+import * as formilyReactive from '@formily/reactive';
+import * as formilyShared from '@formily/shared';
+import * as nocobaseFlowEngine from '@nocobase/flow-engine';
+import * as antd from 'antd';
+import * as i18next from 'i18next';
+import React from 'react';
+import ReactDOM from 'react-dom';
+import * as reactI18next from 'react-i18next';
+import * as ReactRouter from 'react-router';
+import * as ReactRouterDom from 'react-router-dom';
+import jsxRuntime from 'react/jsx-runtime';
+import * as nocobaseClientV2 from '../index';
+
+import type { RequireJS } from './requirejs';
+
+/**
+ * @internal
+ */
+export function defineGlobalDeps(requirejs: RequireJS) {
+  // react
+  requirejs.define('react', () => React);
+  requirejs.define('react-dom', () => ReactDOM);
+  requirejs.define('react/jsx-runtime', () => jsxRuntime);
+
+  // react-router
+  requirejs.define('react-router', () => ReactRouter);
+  requirejs.define('react-router-dom', () => ReactRouterDom);
+
+  // antd
+  requirejs.define('antd', () => antd);
+  requirejs.define('@ant-design/icons', () => antdIcons);
+  requirejs.define('@ant-design/cssinjs', () => antdCssinjs);
+
+  // i18next
+  requirejs.define('i18next', () => i18next);
+  requirejs.define('react-i18next', () => reactI18next);
+
+  // formily
+  requirejs.define('@formily/core', () => formilyCore);
+  requirejs.define('@formily/react', () => formilyReact);
+  requirejs.define('@formily/reactive', () => formilyReactive);
+  requirejs.define('@formily/shared', () => formilyShared);
+
+  // nocobase
+  requirejs.define('@nocobase/client-v2', () => nocobaseClientV2);
+  requirejs.define('@nocobase/client-v2/client-v2', () => nocobaseClientV2);
+  requirejs.define('@nocobase/flow-engine', () => nocobaseFlowEngine);
+}

package/src/utils/remotePlugins.ts

@@ -17,7 +17,7 @@ import type { RequireJS } from './requirejs';
  */
 export function defineDevPlugins(plugins: Record<string, typeof Plugin>) {
   Object.entries(plugins).forEach(([packageName, plugin]) => {
-    window.define(`${packageName}/client`, () => plugin);
+    window.define(`${packageName}/client-v2`, () => plugin);
   });
 }
 
@@ -25,7 +25,7 @@ export function defineDevPlugins(plugins: Record<string, typeof Plugin>) {
  * @internal
  */
 export function definePluginClient(packageName: string) {
-  window.define(`${packageName}/client`, ['exports', packageName], function (_exports: any, _pluginExports: any) {
+  window.define(`${packageName}/client-v2`, ['exports', packageName], function (_exports: any, _pluginExports: any) {
     Object.defineProperty(_exports, '__esModule', {
       value: true,
     });