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

package/es/WebSocketClient.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { Application } from './Application';
+export type WebSocketClientOptions = {
+    reconnectInterval?: number;
+    reconnectAttempts?: number;
+    pingInterval?: number;
+    url?: string;
+    basename?: string;
+    protocols?: string | string[];
+    onServerDown?: any;
+};
+export declare class WebSocketClient {
+    protected _ws: WebSocket;
+    protected _reconnectTimes: number;
+    protected events: any[];
+    protected options: WebSocketClientOptions;
+    app: Application;
+    enabled: boolean;
+    connected: boolean;
+    serverDown: boolean;
+    lastMessage: {};
+    constructor(options: WebSocketClientOptions | boolean);
+    getSubAppName: (app: Application) => string;
+    getURL(): string;
+    get reconnectAttempts(): number;
+    get reconnectInterval(): number;
+    get pingInterval(): number;
+    get readyState(): number;
+    createWebSocket(): WebSocket;
+    connect(): void;
+    reconnect(): void;
+    close(): void;
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+    on(type: string, listener: any, options?: boolean | AddEventListenerOptions): void;
+    emit(type: string, args: any): void;
+    off(type: string, listener: any, options?: boolean | EventListenerOptions): void;
+    removeAllListeners(): void;
+}

package/es/components/BlankComponent.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { FC, ReactNode } from 'react';
+export declare const BlankComponent: FC<{
+    children?: ReactNode;
+}>;

package/es/components/MainComponent.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 React from 'react';
+export declare const MainComponent: React.NamedExoticComponent<object>;

package/es/components/RouterBridge.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 { Application } from '../Application';
+export declare function useRouterSync(app: Application): void;
+export declare function RouterBridge({ app }: {
+    app: any;
+}): any;

package/es/components/RouterContextCleaner.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 { FC, ReactNode } from 'react';
+export declare const RouterContextCleaner: FC<{
+    children?: ReactNode;
+}>;

package/es/components/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+export * from './BlankComponent';
+export * from './RouterContextCleaner';

package/es/context.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Application } from './Application';
+export declare const ApplicationContext: import("react").Context<Application>;

package/es/hooks/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+export * from './useApp';
+export * from './usePlugin';
+export * from './useRouter';

package/es/hooks/useApp.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { Application } from '../Application';
+export declare const useApp: () => Application;

package/es/hooks/usePlugin.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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';
+export declare function usePlugin<T extends typeof Plugin = any>(plugin: T): InstanceType<T>;
+export declare function usePlugin<T extends {}>(name: string): T;

package/es/hooks/useRouter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+export declare const useRouter: () => import("../RouterManager").RouterManager;

package/es/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+export * from './Application';
+export * from './components';
+export * from './context';
+export * from './MockApplication';
+export * from './Plugin';
+export * from './WebSocketClient';

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/es/utils/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 React, { ComponentType } from 'react';
+export declare function normalizeContainer(container: Element | ShadowRoot | string): Element | null;
+export declare const compose: (...components: [ComponentType, any][]) => (LastChild?: ComponentType) => React.FC;

package/es/utils/remotePlugins.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { DevDynamicImport } from '../Application';
+import type { Plugin } from '../Plugin';
+import type { PluginData } from '../PluginManager';
+import type { RequireJS } from './requirejs';
+/**
+ * @internal
+ */
+export declare function defineDevPlugins(plugins: Record<string, typeof Plugin>): void;
+/**
+ * @internal
+ */
+export declare function definePluginClient(packageName: string): void;
+/**
+ * @internal
+ */
+export declare function configRequirejs(requirejs: any, pluginData: PluginData[]): void;
+/**
+ * @internal
+ */
+export declare function processRemotePlugins(pluginData: PluginData[], resolve: (plugins: [string, typeof Plugin][]) => void): (...pluginModules: (typeof Plugin & {
+    default?: typeof Plugin;
+})[]) => void;
+/**
+ * @internal
+ */
+export declare function getRemotePlugins(requirejs: any, pluginData?: PluginData[]): Promise<Array<[string, typeof Plugin]>>;
+interface GetPluginsOption {
+    requirejs: RequireJS;
+    pluginData: PluginData[];
+    devDynamicImport?: DevDynamicImport;
+}
+/**
+ * @internal
+ */
+export declare function getPlugins(options: GetPluginsOption): Promise<Array<[string, typeof Plugin]>>;
+export {};

package/es/utils/requirejs.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { Require, RequireDefine } from './types';
+export interface RequireJS {
+    require: Require;
+    requirejs: Require;
+    define: RequireDefine;
+}
+/**
+ * @internal
+ */
+export declare function getRequireJs(): RequireJS;

package/es/utils/types.d.ts

@@ -0,0 +1,330 @@
+/**
+ * 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.
+ */
+/** vim: et:ts=4:sw=4:sts=4
+ * @license RequireJS 2.3.6 Copyright jQuery Foundation and other contributors.
+ * Released under MIT license, https://github.com/requirejs/requirejs/blob/master/LICENSE
+ */
+interface RequireModule {
+    /** */
+    config(): {};
+}
+interface RequireMap {
+    /** */
+    prefix: string;
+    /** */
+    name: string;
+    /** */
+    parentMap: RequireMap;
+    /** */
+    url: string;
+    /** */
+    originalName: string;
+    /** */
+    fullName: string;
+}
+interface RequireError extends Error {
+    /**
+     * The error ID that maps to an ID on a web page.
+     */
+    requireType: string;
+    /**
+     * Required modules.
+     */
+    requireModules: string[] | null;
+    /**
+     * The original error, if there is one (might be null).
+     */
+    originalError: Error;
+}
+interface RequireShim {
+    /**
+     * List of dependencies.
+     */
+    deps?: string[] | undefined;
+    /**
+     * Name the module will be exported as.
+     */
+    exports?: string | undefined;
+    /**
+     * Initialize function with all dependcies passed in,
+     * if the function returns a value then that value is used
+     * as the module export value instead of the object
+     * found via the 'exports' string.
+     * @param dependencies
+     * @return
+     */
+    init?: ((...dependencies: any[]) => any) | undefined;
+}
+interface RequireConfig {
+    /**
+     * The root path to use for all module lookups.
+     */
+    baseUrl?: string | undefined;
+    /**
+     * Path mappings for module names not found directly under
+     * baseUrl.
+     */
+    paths?: {
+        [key: string]: any;
+    } | undefined;
+    /**
+     * Dictionary of Shim's.
+     * Can be of type RequireShim or string[] of dependencies
+     */
+    shim?: {
+        [key: string]: RequireShim | string[];
+    } | undefined;
+    /**
+     * For the given module prefix, instead of loading the
+     * module with the given ID, substitude a different
+     * module ID.
+     *
+     * @example
+     * requirejs.config({
+     *    map: {
+     *        'some/newmodule': {
+     *            'foo': 'foo1.2'
+     *        },
+     *        'some/oldmodule': {
+     *            'foo': 'foo1.0'
+     *        }
+     *    }
+     * });
+     */
+    map?: {
+        [id: string]: {
+            [id: string]: string;
+        };
+    } | undefined;
+    /**
+     * Allows pointing multiple module IDs to a module ID that contains a bundle of modules.
+     *
+     * @example
+     * requirejs.config({
+     *    bundles: {
+     *        'primary': ['main', 'util', 'text', 'text!template.html'],
+     *        'secondary': ['text!secondary.html']
+     *    }
+     * });
+     */
+    bundles?: {
+        [key: string]: string[];
+    } | undefined;
+    /**
+     * AMD configurations, use module.config() to access in
+     * define() functions
+     */
+    config?: {
+        [id: string]: {};
+    } | undefined;
+    /**
+     * Configures loading modules from CommonJS packages.
+     */
+    packages?: {} | undefined;
+    /**
+     * The number of seconds to wait before giving up on loading
+     * a script.  The default is 7 seconds.
+     */
+    waitSeconds?: number | undefined;
+    /**
+     * A name to give to a loading context.  This allows require.js
+     * to load multiple versions of modules in a page, as long as
+     * each top-level require call specifies a unique context string.
+     */
+    context?: string | undefined;
+    /**
+     * An array of dependencies to load.
+     */
+    deps?: string[] | undefined;
+    /**
+     * A function to pass to require that should be require after
+     * deps have been loaded.
+     * @param modules
+     */
+    callback?: ((...modules: any[]) => void) | undefined;
+    /**
+     * If set to true, an error will be thrown if a script loads
+     * that does not call define() or have shim exports string
+     * value that can be checked.
+     */
+    enforceDefine?: boolean | undefined;
+    /**
+     * If set to true, document.createElementNS() will be used
+     * to create script elements.
+     */
+    xhtml?: boolean | undefined;
+    /**
+     * Extra query string arguments appended to URLs that RequireJS
+     * uses to fetch resources.  Most useful to cache bust when
+     * the browser or server is not configured correctly.
+     *
+     * As of RequireJS 2.2.0, urlArgs can be a function. If a
+     * function, it will receive the module ID and the URL as
+     * parameters, and it should return a string that will be added
+     * to the end of the URL. Return an empty string if no args.
+     * Be sure to take care of adding the '?' or '&' depending on
+     * the existing state of the URL.
+     *
+     * @example
+     *
+     * urlArgs: "bust=" + (new Date()).getTime()
+     *
+     * @example
+     *
+     * requirejs.config({
+     *     urlArgs: function(id, url) {
+     *         var args = 'v=1';
+     *        if (url.indexOf('view.html') !== -1) {
+     *             args = 'v=2'
+     *         }
+     *
+     *        return (url.indexOf('?') === -1 ? '?' : '&') + args;
+     *     }
+     * });
+     */
+    urlArgs?: string | ((id: string, url: string) => string) | undefined;
+    /**
+     * Specify the value for the type="" attribute used for script
+     * tags inserted into the document by RequireJS.  Default is
+     * "text/javascript".  To use Firefox's JavasScript 1.8
+     * features, use "text/javascript;version=1.8".
+     */
+    scriptType?: string | undefined;
+    /**
+     * If set to true, skips the data-main attribute scanning done
+     * to start module loading. Useful if RequireJS is embedded in
+     * a utility library that may interact with other RequireJS
+     * library on the page, and the embedded version should not do
+     * data-main loading.
+     */
+    skipDataMain?: boolean | undefined;
+    /**
+     * Allow extending requirejs to support Subresource Integrity
+     * (SRI).
+     */
+    onNodeCreated?: ((node: HTMLScriptElement, config: RequireConfig, moduleName: string, url: string) => void) | undefined;
+}
+export interface Require {
+    /**
+     * Configure require.js
+     */
+    config(config: RequireConfig): Require;
+    /**
+     * CommonJS require call
+     * @param module Module to load
+     * @return The loaded module
+     */
+    (module: string): any;
+    /**
+     * Start the main app logic.
+     * Callback is optional.
+     * Can alternatively use deps and callback.
+     * @param modules Required modules to load.
+     */
+    (modules: string[]): void;
+    /**
+     * @see Require()
+     * @param ready Called when required modules are ready.
+     */
+    (modules: string[], ready: Function): void;
+    /**
+     * @see http://requirejs.org/docs/api.html#errbacks
+     * @param ready Called when required modules are ready.
+     */
+    (modules: string[], ready: Function, errback: Function): void;
+    /**
+     * Generate URLs from require module
+     * @param module Module to URL
+     * @return URL string
+     */
+    toUrl(module: string): string;
+    /**
+     * Returns true if the module has already been loaded and defined.
+     * @param module Module to check
+     */
+    defined(module: string): boolean;
+    /**
+     * Returns true if the module has already been requested or is in the process of loading and should be available at some point.
+     * @param module Module to check
+     */
+    specified(module: string): boolean;
+    /**
+     * On Error override
+     * @param err
+     */
+    onError(err: RequireError, errback?: (err: RequireError) => void): void;
+    /**
+     * Undefine a module
+     * @param module Module to undefine.
+     */
+    undef(module: string): void;
+    /**
+     * Semi-private function, overload in special instance of undef()
+     */
+    onResourceLoad(context: Object, map: RequireMap, depArray: RequireMap[]): void;
+}
+export interface RequireDefine {
+    /**
+     * Define Simple Name/Value Pairs
+     * @param config Dictionary of Named/Value pairs for the config.
+     */
+    (config: {
+        [key: string]: any;
+    }): void;
+    /**
+     * Define function.
+     * @param func: The function module.
+     */
+    (func: () => any): void;
+    /**
+     * Define function with dependencies.
+     * @param deps List of dependencies module IDs.
+     * @param ready Callback function when the dependencies are loaded.
+     *    callback param deps module dependencies
+     *    callback return module definition
+     */
+    (deps: string[], ready: Function): void;
+    /**
+     *  Define module with simplified CommonJS wrapper.
+     * @param ready
+     *    callback require requirejs instance
+     *    callback exports exports object
+     *    callback module module
+     *    callback return module definition
+     */
+    (ready: (require: Require, exports: {
+        [key: string]: any;
+    }, module: RequireModule) => any): void;
+    /**
+     * Define a module with a name and dependencies.
+     * @param name The name of the module.
+     * @param deps List of dependencies module IDs.
+     * @param ready Callback function when the dependencies are loaded.
+     *    callback deps module dependencies
+     *    callback return module definition
+     */
+    (name: string, deps: string[], ready: Function): void;
+    /**
+     * Define a module with a name.
+     * @param name The name of the module.
+     * @param ready Callback function when the dependencies are loaded.
+     *    callback return module definition
+     */
+    (name: string, ready: Function): void;
+    /**
+     * Used to allow a clear indicator that a global define function (as needed for script src browser loading) conforms
+     * to the AMD API, any global define function SHOULD have a property called "amd" whose value is an object.
+     * This helps avoid conflict with any other existing JavaScript code that could have defined a define() function
+     * that does not conform to the AMD API.
+     * define.amd.jQuery is specific to jQuery and indicates that the loader is able to account for multiple version
+     * of jQuery being loaded simultaneously.
+     */
+    amd: Object;
+}
+export {};

package/lib/Application.js

@@ -51,7 +51,7 @@ var import_reactive = require("@formily/reactive");
 var import_flow_engine = require("@nocobase/flow-engine");
 var import_sdk = require("@nocobase/sdk");
 var import_i18next = require("i18next");
-var import_lodash = __toESM(require("lodash"));
+var import_lodash_es = require("lodash-es");
 var import_react = __toESM(require("react"));
 var import_client = require("react-dom/client");
 var import_react_i18next = require("react-i18next");
@@ -62,11 +62,13 @@ 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 {
   constructor(options = {}) {
     this.options = options;
+    var _a;
     this.initRequireJs();
     (0, import_reactive.define)(this, {
       maintained: import_reactive.observable.ref,
@@ -74,10 +76,17 @@ const _Application = class _Application {
       error: import_reactive.observable.ref
     });
     this.devDynamicImport = options.devDynamicImport;
-    this.components = import_lodash.default.merge(this.components, options.components);
+    this.components = (0, import_lodash_es.merge)(this.components, options.components);
     this.apiClient = new import_sdk.APIClient(options.apiClient);
     this.i18n = options.i18n || (0, import_i18next.createInstance)();
     this.router = new import_RouterManager.RouterManager(options.router, this);
+    if (typeof ((_a = options.router) == null ? void 0 : _a.basename) === "undefined") {
+      const publicPath = this.getPublicPath();
+      const basename = publicPath === "/" ? void 0 : publicPath.replace(/\/$/, "");
+      if (basename) {
+        this.router.setBasename(basename);
+      }
+    }
     this.pluginManager = new import_PluginManager.PluginManager(options.plugins, options.loadRemotePlugins, this);
     this.flowEngine = new import_flow_engine.FlowEngine();
     this.flowEngine.registerModels({ ApplicationModel });
@@ -210,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() {
@@ -377,7 +387,7 @@ const _Application = class _Application {
     }
     if (typeof Component === "function") return Component;
     if (typeof Component === "string") {
-      const res = import_lodash.default.get(this.components, Component);
+      const res = (0, import_lodash_es.get)(this.components, Component);
       if (!res) {
         showError(`Component ${Component} not found`);
         return;
@@ -396,7 +406,7 @@ const _Application = class _Application {
       console.error("Component must have a displayName or pass name as second argument");
       return;
     }
-    import_lodash.default.set(this.components, componentName, component);
+    (0, import_lodash_es.set)(this.components, componentName, component);
   }
   addComponents(components) {
     Object.keys(components).forEach((name) => {

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,