@nocobase/server 0.20.0-alpha.8 → 0.21.0-alpha.1

package/lib/acl/available-action.js

@@ -47,11 +47,12 @@ const availableActions = {
   update: {
     displayName: '{{t("Edit")}}',
     type: "old-data",
-    aliases: ["update", "move"],
+    aliases: ["update", "move", "add", "set", "remove", "toggle"],
     allowConfigureFields: true
   },
   destroy: {
     displayName: '{{t("Delete")}}',
+    aliases: ["destroy"],
     type: "old-data"
   }
 };

package/lib/application.d.ts

@@ -83,19 +83,41 @@ export type MaintainingCommandStatus = {
 };
 export declare class Application<StateT = DefaultState, ContextT = DefaultContext> extends Koa implements AsyncEmitter {
     options: ApplicationOptions;
+    /**
+     * @internal
+     */
     middleware: any;
+    /**
+     * @internal
+     */
     stopped: boolean;
+    /**
+     * @internal
+     */
     ready: boolean;
     emitAsync: (event: string | symbol, ...args: any[]) => Promise<boolean>;
+    /**
+     * @internal
+     */
     rawOptions: ApplicationOptions;
+    /**
+     * @internal
+     */
     activatedCommand: {
         name: string;
     };
+    /**
+     * @internal
+     */
     running: boolean;
+    /**
+     * @internal
+     */
     perfHistograms: Map<string, RecordableHistogram>;
     protected plugins: Map<string, Plugin<any>>;
     protected _appSupervisor: AppSupervisor;
     protected _started: boolean;
+    protected _logger: SystemLogger;
     private _authenticated;
     private _maintaining;
     private _maintainingCommandStatus;
@@ -103,20 +125,28 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     private _actionCommand;
     constructor(options: ApplicationOptions);
     protected _loaded: boolean;
+    /**
+     * @internal
+     */
     get loaded(): boolean;
     private _maintainingMessage;
+    /**
+     * @internal
+     */
     get maintainingMessage(): string;
     protected _cronJobManager: CronJobManager;
     get cronJobManager(): CronJobManager;
     get mainDataSource(): SequelizeDataSource;
     get db(): Database;
-    protected _logger: SystemLogger;
     get logger(): SystemLogger;
     get resourcer(): import("@nocobase/data-source-manager").ResourceManager;
     protected _cacheManager: CacheManager;
     get cacheManager(): CacheManager;
     protected _cache: Cache;
     get cache(): Cache;
+    /**
+     * @internal
+     */
     set cache(cache: Cache);
     protected _cli: AppCommand;
     get cli(): AppCommand;
@@ -128,6 +158,11 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     protected _authManager: AuthManager;
     get authManager(): AuthManager;
     protected _locales: Locale;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link #localeManager} instead.
+     * @deprecated
+     */
     get locales(): Locale;
     get localeManager(): Locale;
     protected _telemetry: Telemetry;
@@ -138,39 +173,88 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     get name(): string;
     protected _dataSourceManager: DataSourceManager;
     get dataSourceManager(): DataSourceManager;
+    /**
+     * @internal
+     */
     getMaintaining(): MaintainingCommandStatus;
+    /**
+     * @internal
+     */
     setMaintaining(_maintainingCommandStatus: MaintainingCommandStatus): void;
+    /**
+     * @internal
+     */
     setMaintainingMessage(message: string): void;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link #this.version.get()} instead.
+     * @deprecated
+     */
     getVersion(): string;
     /**
+     * This method is deprecated and should not be used.
+     * Use {@link #this.pm.addPreset()} instead.
      * @deprecated
      */
     plugin<O = any>(pluginClass: any, options?: O): void;
     use<NewStateT = {}, NewContextT = {}>(middleware: Koa.Middleware<StateT & NewStateT, ContextT & NewContextT>, options?: ToposortOptions): this;
+    /**
+     * @internal
+     */
     callback(): (req: IncomingMessage, res: ServerResponse) => any;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link #this.db.collection()} instead.
+     * @deprecated
+     */
     collection(options: CollectionOptions): import("@nocobase/database").Collection<any, any>;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link #this.resourcer.define()} instead.
+     * @deprecated
+     */
     resource(options: ResourceOptions): import("@nocobase/resourcer").Resource;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link #this.resourcer.registerActions()} instead.
+     * @deprecated
+     */
     actions(handlers: any, options?: ActionsOptions): void;
     command(name: string, desc?: string, opts?: CommandOptions): AppCommand;
     findCommand(name: string): Command;
-    preload(): Promise<void>;
+    /**
+     * @internal
+     */
     reInit(): Promise<void>;
     load(options?: any): Promise<void>;
     reload(options?: any): Promise<void>;
     /**
+     * This method is deprecated and should not be used.
+     * Use {@link this.pm.get()} instead.
      * @deprecated
      */
     getPlugin<P extends Plugin>(name: string | typeof Plugin): P;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link this.runAsCLI()} instead.
+     * @deprecated
+     */
     parse(argv?: string[]): Promise<AppCommand>;
     authenticate(): Promise<void>;
     runCommand(command: string, ...args: any[]): Promise<AppCommand>;
     runCommandThrowError(command: string, ...args: any[]): Promise<AppCommand>;
-    createCli(): AppCommand;
+    protected createCLI(): AppCommand;
+    /**
+     * @internal
+     */
     loadMigrations(options: any): Promise<{
         beforeLoad: any[];
         afterSync: any[];
         afterLoad: any[];
     }>;
+    /**
+     * @internal
+     */
     loadCoreMigrations(): Promise<{
         beforeLoad: {
             up: () => Promise<void>;
@@ -182,14 +266,26 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
             up: () => Promise<void>;
         };
     }>;
+    /**
+     * @internal
+     */
     loadPluginCommands(): Promise<void>;
+    /**
+     * @internal
+     */
     runAsCLI(argv?: string[], options?: ParseOptions & {
         throwError?: boolean;
         reqId?: string;
     }): Promise<AppCommand>;
     start(options?: StartOptions): Promise<void>;
+    /**
+     * @internal
+     */
     emitStartedEvent(options?: StartOptions): Promise<void>;
     isStarted(): Promise<boolean>;
+    /**
+     * @internal
+     */
     tryReloadOrRestart(options?: StartOptions): Promise<void>;
     restart(options?: StartOptions): Promise<void>;
     stop(options?: any): Promise<void>;
@@ -201,6 +297,9 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
         appName: string;
         name: string;
     };
+    /**
+     * @internal
+     */
     reInitEvents(): void;
     createLogger(options: LoggerOptions): import("winston").Logger;
     protected init(): void;

package/lib/application.js

@@ -68,25 +68,50 @@ const _Application = class _Application extends import_koa.default {
     this.init();
     this._appSupervisor.addApp(this);
   }
+  /**
+   * @internal
+   */
   stopped = false;
+  /**
+   * @internal
+   */
   ready = false;
+  /**
+   * @internal
+   */
   rawOptions;
+  /**
+   * @internal
+   */
   activatedCommand = null;
+  /**
+   * @internal
+   */
   running = false;
+  /**
+   * @internal
+   */
   perfHistograms = /* @__PURE__ */ new Map();
   plugins = /* @__PURE__ */ new Map();
   _appSupervisor = import_app_supervisor.AppSupervisor.getInstance();
   _started;
+  _logger;
   _authenticated = false;
   _maintaining = false;
   _maintainingCommandStatus;
   _maintainingStatusBeforeCommand;
   _actionCommand;
   _loaded;
+  /**
+   * @internal
+   */
   get loaded() {
     return this._loaded;
   }
   _maintainingMessage;
+  /**
+   * @internal
+   */
   get maintainingMessage() {
     return this._maintainingMessage;
   }
@@ -104,7 +129,6 @@ const _Application = class _Application extends import_koa.default {
     }
     return this.mainDataSource.collectionManager.db;
   }
-  _logger;
   get logger() {
     return this._logger;
   }
@@ -119,6 +143,9 @@ const _Application = class _Application extends import_koa.default {
   get cache() {
     return this._cache;
   }
+  /**
+   * @internal
+   */
   set cache(cache) {
     this._cache = cache;
   }
@@ -142,6 +169,11 @@ const _Application = class _Application extends import_koa.default {
     return this._authManager;
   }
   _locales;
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link #localeManager} instead.
+   * @deprecated
+   */
   get locales() {
     return this._locales;
   }
@@ -166,9 +198,15 @@ const _Application = class _Application extends import_koa.default {
   get dataSourceManager() {
     return this._dataSourceManager;
   }
+  /**
+   * @internal
+   */
   getMaintaining() {
     return this._maintainingCommandStatus;
   }
+  /**
+   * @internal
+   */
   setMaintaining(_maintainingCommandStatus) {
     this._maintainingCommandStatus = _maintainingCommandStatus;
     this.emit("maintaining", _maintainingCommandStatus);
@@ -178,6 +216,9 @@ const _Application = class _Application extends import_koa.default {
     }
     this._maintaining = true;
   }
+  /**
+   * @internal
+   */
   setMaintainingMessage(message) {
     this._maintainingMessage = message;
     this.emit("maintainingMessageChanged", {
@@ -185,10 +226,17 @@ const _Application = class _Application extends import_koa.default {
       maintainingStatus: this._maintainingCommandStatus
     });
   }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link #this.version.get()} instead.
+   * @deprecated
+   */
   getVersion() {
     return import_package.default.version;
   }
   /**
+   * This method is deprecated and should not be used.
+   * Use {@link #this.pm.addPreset()} instead.
    * @deprecated
    */
   plugin(pluginClass, options) {
@@ -200,6 +248,9 @@ const _Application = class _Application extends import_koa.default {
     this.middleware.add(middleware, options);
     return this;
   }
+  /**
+   * @internal
+   */
   callback() {
     const fn = (0, import_koa_compose.default)(this.middleware.nodes);
     if (!this.listenerCount("error"))
@@ -209,12 +260,27 @@ const _Application = class _Application extends import_koa.default {
       return this.handleRequest(ctx, fn);
     };
   }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link #this.db.collection()} instead.
+   * @deprecated
+   */
   collection(options) {
     return this.db.collection(options);
   }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link #this.resourcer.define()} instead.
+   * @deprecated
+   */
   resource(options) {
     return this.resourcer.define(options);
   }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link #this.resourcer.registerActions()} instead.
+   * @deprecated
+   */
   actions(handlers, options) {
     return this.resourcer.registerActions(handlers);
   }
@@ -224,8 +290,9 @@ const _Application = class _Application extends import_koa.default {
   findCommand(name) {
     return this.cli._findCommand(name);
   }
-  async preload() {
-  }
+  /**
+   * @internal
+   */
   async reInit() {
     if (!this._loaded) {
       return;
@@ -300,11 +367,18 @@ const _Application = class _Application extends import_koa.default {
     this.log.debug(`finish reload`, { method: "reload" });
   }
   /**
+   * This method is deprecated and should not be used.
+   * Use {@link this.pm.get()} instead.
    * @deprecated
    */
   getPlugin(name) {
     return this.pm.get(name);
   }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link this.runAsCLI()} instead.
+   * @deprecated
+   */
   async parse(argv = process.argv) {
     return this.runAsCLI(argv);
   }
@@ -323,7 +397,7 @@ const _Application = class _Application extends import_koa.default {
   async runCommandThrowError(command, ...args) {
     return await this.runAsCLI([command, ...args], { from: "user", throwError: true });
   }
-  createCli() {
+  createCLI() {
     const command = new import_app_command.AppCommand("nocobase").usage("[command] [options]").hook("preAction", async (_, actionCommand) => {
       this._actionCommand = actionCommand;
       this.activatedCommand = {
@@ -354,6 +428,9 @@ const _Application = class _Application extends import_koa.default {
     });
     return command;
   }
+  /**
+   * @internal
+   */
   async loadMigrations(options) {
     const { directory, context, namespace } = options;
     const migrations = {
@@ -379,6 +456,9 @@ const _Application = class _Application extends import_koa.default {
     }
     return migrations;
   }
+  /**
+   * @internal
+   */
   async loadCoreMigrations() {
     const migrations = await this.loadMigrations({
       directory: (0, import_path.resolve)(__dirname, "migrations"),
@@ -408,10 +488,16 @@ const _Application = class _Application extends import_koa.default {
       }
     };
   }
+  /**
+   * @internal
+   */
   async loadPluginCommands() {
     this.log.debug("load plugin commands");
     await this.pm.loadCommands();
   }
+  /**
+   * @internal
+   */
   async runAsCLI(argv = process.argv, options) {
     if (this.activatedCommand) {
       return;
@@ -482,6 +568,9 @@ const _Application = class _Application extends import_koa.default {
     await this.emitStartedEvent(options);
     this.stopped = false;
   }
+  /**
+   * @internal
+   */
   async emitStartedEvent(options = {}) {
     await this.emitAsync("__started", this, {
       maintainingStatus: import_lodash.default.cloneDeep(this._maintainingCommandStatus),
@@ -491,6 +580,9 @@ const _Application = class _Application extends import_koa.default {
   async isStarted() {
     return this._started;
   }
+  /**
+   * @internal
+   */
   async tryReloadOrRestart(options = {}) {
     if (this._started) {
       await this.restart(options);
@@ -620,6 +712,9 @@ const _Application = class _Application extends import_koa.default {
       name: this.name
     };
   }
+  /**
+   * @internal
+   */
   reInitEvents() {
     for (const eventName of this.eventNames()) {
       for (const listener of this.listeners(eventName)) {
@@ -657,7 +752,7 @@ const _Application = class _Application extends import_koa.default {
     }
     this.createMainDataSource(options);
     this._cronJobManager = new import_cron_job_manager.CronJobManager(this);
-    this._cli = this.createCli();
+    this._cli = this.createCLI();
     this._i18n = (0, import_helper.createI18n)(options);
     this.context.db = this.db;
     this.context.resourcer = this.resourcer;

package/lib/commands/console.js

@@ -23,7 +23,7 @@ __export(console_exports, {
 module.exports = __toCommonJS(console_exports);
 const REPL = require("repl");
 var console_default = /* @__PURE__ */ __name((app) => {
-  app.command("console").action(async () => {
+  app.command("console").preload().action(async () => {
     await app.start();
     const repl = REPL.start("nocobase > ").context.app = app;
     repl.on("exit", async function(err) {

package/lib/commands/index.js

@@ -43,7 +43,9 @@ var import_restart = __toESM(require("./restart"));
 var import_start = __toESM(require("./start"));
 var import_stop = __toESM(require("./stop"));
 var import_upgrade = __toESM(require("./upgrade"));
+var import_console = __toESM(require("./console"));
 function registerCli(app) {
+  (0, import_console.default)(app);
   (0, import_db_auth.default)(app);
   (0, import_create_migration.default)(app);
   (0, import_db_clean.default)(app);

package/lib/commands/pm.js

@@ -42,7 +42,7 @@ var pm_default = /* @__PURE__ */ __name((app) => {
     try {
       await app.pm.addViaCLI(name, import_lodash.default.cloneDeep(options));
     } catch (error) {
-      throw new import_plugin_command_error.PluginCommandError(`Failed to add plugin: ${error.message}`);
+      throw new import_plugin_command_error.PluginCommandError(`Failed to add plugin`, { cause: error });
     }
   });
   pm.command("update").ipc().argument("<packageName>").option("--path [path]").option("--url [url]").option("--registry [registry]").option("--auth-token [authToken]").option("--version [version]").action(async (packageName, options) => {
@@ -52,21 +52,21 @@ var pm_default = /* @__PURE__ */ __name((app) => {
         packageName
       });
     } catch (error) {
-      throw new import_plugin_command_error.PluginCommandError(`Failed to update plugin: ${error.message}`);
+      throw new import_plugin_command_error.PluginCommandError(`Failed to update plugin`, { cause: error });
     }
   });
   pm.command("enable").ipc().preload().arguments("<plugins...>").action(async (plugins) => {
     try {
       await app.pm.enable(plugins);
     } catch (error) {
-      throw new import_plugin_command_error.PluginCommandError(`Failed to enable plugin: ${error.message}`);
+      throw new import_plugin_command_error.PluginCommandError(`Failed to enable plugin`, { cause: error });
     }
   });
   pm.command("disable").ipc().preload().arguments("<plugins...>").action(async (plugins) => {
     try {
       await app.pm.disable(plugins);
     } catch (error) {
-      throw new import_plugin_command_error.PluginCommandError(`Failed to disable plugin: ${error.message}`);
+      throw new import_plugin_command_error.PluginCommandError(`Failed to disable plugin`, { cause: error });
     }
   });
   pm.command("remove").auth().arguments("<plugins...>").option("--force").option("--remove-dir").action(async (plugins, options) => {

package/lib/gateway/index.js

@@ -153,23 +153,25 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
   }
   async requestHandler(req, res) {
     const { pathname } = (0, import_url.parse)(req.url);
-    if (pathname === "/__umi/api/bundle-status") {
+    const { PLUGIN_STATICS_PATH, APP_PUBLIC_PATH } = process.env;
+    if (pathname.endsWith("/__umi/api/bundle-status")) {
       res.statusCode = 200;
       res.end("ok");
       return;
     }
-    if (pathname.startsWith("/storage/uploads/")) {
+    if (pathname.startsWith(APP_PUBLIC_PATH + "storage/uploads/")) {
+      req.url = req.url.substring(APP_PUBLIC_PATH.length - 1);
       await compress(req, res);
       return (0, import_serve_handler.default)(req, res, {
         public: (0, import_path.resolve)(process.cwd()),
         directoryListing: false
       });
     }
-    if (pathname.startsWith(import_plugin_manager.PLUGIN_STATICS_PATH) && !pathname.includes("/server/")) {
+    if (pathname.startsWith(PLUGIN_STATICS_PATH) && !pathname.includes("/server/")) {
       await compress(req, res);
       const packageName = (0, import_plugin_manager.getPackageNameByExposeUrl)(pathname);
       const publicDir = (0, import_plugin_manager.getPackageDirByExposeUrl)(pathname);
-      const destination = pathname.replace(import_plugin_manager.PLUGIN_STATICS_PATH, "").replace(packageName, "");
+      const destination = pathname.replace(PLUGIN_STATICS_PATH, "").replace(packageName, "");
       return (0, import_serve_handler.default)(req, res, {
         public: publicDir,
         rewrites: [
@@ -180,7 +182,8 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
         ]
       });
     }
-    if (!pathname.startsWith("/api")) {
+    if (!pathname.startsWith(process.env.API_BASE_PATH)) {
+      req.url = req.url.substring(APP_PUBLIC_PATH.length - 1);
       await compress(req, res);
       return (0, import_serve_handler.default)(req, res, {
         public: `${process.env.APP_PACKAGE_ROOT}/dist/client`,
@@ -279,14 +282,14 @@ const _Gateway = class _Gateway extends import_events.EventEmitter {
       throwError: true,
       from: "node"
     }).then(async () => {
-      if (!await mainApp.isStarted()) {
+      if (!isStart && !await mainApp.isStarted()) {
         await mainApp.stop({ logging: false });
       }
     }).catch(async (e) => {
       if (e.code !== "commander.helpDisplayed") {
         mainApp.log.error(e);
       }
-      if (!await mainApp.isStarted()) {
+      if (!isStart && !await mainApp.isStarted()) {
         await mainApp.stop({ logging: false });
       }
     });

package/lib/locale/locale.js

@@ -78,6 +78,9 @@ const _Locale = class _Locale {
   }
   async getCacheResources(lang) {
     this.resourceCached.set(lang, true);
+    if (process.env.APP_ENV !== "production") {
+      await this.cache.reset();
+    }
     return await this.wrapCache(`resources:${lang}`, () => this.getResources(lang));
   }
   getResources(lang) {

package/lib/locale/resource.js

@@ -55,7 +55,10 @@ const getResource = /* @__PURE__ */ __name((packageName, lang, isPlugin = true)
   for (const prefix of prefixes) {
     try {
       const file = `${packageName}/${prefix}/locale/${lang}`;
-      require.resolve(file);
+      const f = require.resolve(file);
+      if (process.env.APP_ENV !== "production") {
+        delete require.cache[f];
+      }
       const resource = (0, import_utils.requireModule)(file);
       resources.push(resource);
     } catch (error) {

package/lib/plugin-manager/clientStaticUtils.js

@@ -73,7 +73,7 @@ function getPackageFilePathWithExistCheck(packageName, filePath) {
 }
 __name(getPackageFilePathWithExistCheck, "getPackageFilePathWithExistCheck");
 function getExposeUrl(packageName, filePath) {
-  return `${PLUGIN_STATICS_PATH}${packageName}/${filePath}`;
+  return `${process.env.PLUGIN_STATICS_PATH}${packageName}/${filePath}`;
 }
 __name(getExposeUrl, "getExposeUrl");
 function getExposeReadmeUrl(packageName, lang) {
@@ -92,7 +92,7 @@ function getExposeChangelogUrl(packageName) {
 }
 __name(getExposeChangelogUrl, "getExposeChangelogUrl");
 function getPackageNameByExposeUrl(pathname) {
-  pathname = pathname.replace(PLUGIN_STATICS_PATH, "");
+  pathname = pathname.replace(process.env.PLUGIN_STATICS_PATH, "");
   const pathArr = pathname.split("/");
   if (pathname.startsWith("@")) {
     return pathArr.slice(0, 2).join("/");

package/lib/plugin-manager/options/resource.js

@@ -155,7 +155,10 @@ var resource_default = {
         try {
           return {
             ...item.toJSON(),
-            url: `${(0, import_clientStaticUtils.getExposeUrl)(item.packageName, PLUGIN_CLIENT_ENTRY_FILE)}?version=${item.version}`
+            url: `${process.env.APP_SERVER_BASE_URL}${(0, import_clientStaticUtils.getExposeUrl)(
+              item.packageName,
+              PLUGIN_CLIENT_ENTRY_FILE
+            )}?version=${item.version}`
           };
         } catch {
           return false;

package/lib/plugin-manager/plugin-manager-repository.d.ts

@@ -1,11 +1,26 @@
 import { Repository } from '@nocobase/database';
 import { PluginManager } from './plugin-manager';
 export declare class PluginManagerRepository extends Repository {
+    /**
+     * @internal
+     */
     pm: PluginManager;
+    /**
+     * @internal
+     */
     setPluginManager(pm: PluginManager): void;
+    /**
+     * @deprecated
+     */
     remove(name: string | string[]): Promise<void>;
+    /**
+     * @deprecated
+     */
     enable(name: string | string[]): Promise<string[]>;
     updateVersions(): Promise<void>;
+    /**
+     * @deprecated
+     */
     disable(name: string | string[]): Promise<string[]>;
     getItems(): Promise<any>;
     init(): Promise<void>;