@nocobase/server 0.20.0-alpha.9 → 0.21.0-alpha.10

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

@@ -22,9 +22,16 @@ import { InstallOptions, PluginManager } from './plugin-manager';
 import { DataSourceManager, SequelizeDataSource } from '@nocobase/data-source-manager';
 export type PluginType = string | typeof Plugin;
 export type PluginConfiguration = PluginType | [PluginType, any];
-export interface ResourcerOptions {
+export interface ResourceManagerOptions {
     prefix?: string;
 }
+/**
+ * this interface is deprecated and should not be used.
+ * @deprecated
+ * use {@link ResourceManagerOptions} instead
+ */
+export interface ResourcerOptions extends ResourceManagerOptions {
+}
 export interface AppLoggerOptions {
     request: RequestLoggerOptions;
     system: SystemLoggerOptions;
@@ -35,7 +42,13 @@ export interface AppTelemetryOptions extends TelemetryOptions {
 export interface ApplicationOptions {
     database?: IDatabaseOptions | Database;
     cacheManager?: CacheManagerOptions;
-    resourcer?: ResourcerOptions;
+    /**
+     * this property is deprecated and should not be used.
+     * @deprecated
+     * use {@link ApplicationOptions.resourceManager} instead
+     */
+    resourcer?: ResourceManagerOptions;
+    resourceManager?: ResourceManagerOptions;
     bodyParser?: any;
     cors?: any;
     dataWrapping?: boolean;
@@ -44,9 +57,15 @@ export interface ApplicationOptions {
     plugins?: PluginConfiguration[];
     acl?: boolean;
     logger?: AppLoggerOptions;
+    /**
+     * @internal
+     */
     pmSock?: string;
     name?: string;
     authManager?: AuthManagerOptions;
+    /**
+     * @internal
+     */
     perfHooks?: boolean;
     telemetry?: AppTelemetryOptions;
 }
@@ -65,6 +84,12 @@ interface ActionsOptions {
     resourceName?: string;
     resourceNames?: string[];
 }
+interface LoadOptions {
+    reload?: boolean;
+    hooks?: boolean;
+    sync?: boolean;
+    [key: string]: any;
+}
 interface StartOptions {
     cliArgs?: any[];
     dbSync?: boolean;
@@ -83,19 +108,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 +150,34 @@ 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;
+    get resourceManager(): import("@nocobase/resourcer").ResourceManager;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link #resourceManager} instead.
+     * @deprecated
+     */
+    get resourcer(): import("@nocobase/resourcer").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 +189,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 +204,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.resourceManager.define()} instead.
+     * @deprecated
+     */
     resource(options: ResourceOptions): import("@nocobase/resourcer").Resource;
+    /**
+     * This method is deprecated and should not be used.
+     * Use {@link #this.resourceManager.registerActionHandlers()} 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>;
+    load(options?: LoadOptions): Promise<void>;
+    reload(options?: LoadOptions): 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 +297,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 +328,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

@@ -59,6 +59,7 @@ var import_plugin_manager = require("./plugin-manager");
 var import_data_source_manager = require("@nocobase/data-source-manager");
 var import_package = __toESM(require("../package.json"));
 var import_main_data_source = require("./main-data-source");
+var import_validate_filter_params = __toESM(require("./middlewares/validate-filter-params"));
 const _Application = class _Application extends import_koa.default {
   constructor(options) {
     super();
@@ -68,25 +69,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,10 +130,17 @@ const _Application = class _Application extends import_koa.default {
     }
     return this.mainDataSource.collectionManager.db;
   }
-  _logger;
   get logger() {
     return this._logger;
   }
+  get resourceManager() {
+    return this.mainDataSource.resourceManager;
+  }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link #resourceManager} instead.
+   * @deprecated
+   */
   get resourcer() {
     return this.mainDataSource.resourceManager;
   }
@@ -119,6 +152,9 @@ const _Application = class _Application extends import_koa.default {
   get cache() {
     return this._cache;
   }
+  /**
+   * @internal
+   */
   set cache(cache) {
     this._cache = cache;
   }
@@ -142,6 +178,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 +207,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 +225,9 @@ const _Application = class _Application extends import_koa.default {
     }
     this._maintaining = true;
   }
+  /**
+   * @internal
+   */
   setMaintainingMessage(message) {
     this._maintainingMessage = message;
     this.emit("maintainingMessageChanged", {
@@ -185,10 +235,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 +257,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,14 +269,29 @@ 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.resourceManager.define()} instead.
+   * @deprecated
+   */
   resource(options) {
-    return this.resourcer.define(options);
+    return this.resourceManager.define(options);
   }
+  /**
+   * This method is deprecated and should not be used.
+   * Use {@link #this.resourceManager.registerActionHandlers()} instead.
+   * @deprecated
+   */
   actions(handlers, options) {
-    return this.resourcer.registerActions(handlers);
+    return this.resourceManager.registerActionHandlers(handlers);
   }
   command(name, desc, opts) {
     return this.cli.command(name, desc, opts).allowUnknownOption();
@@ -224,8 +299,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 +376,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 +406,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 +437,9 @@ const _Application = class _Application extends import_koa.default {
     });
     return command;
   }
+  /**
+   * @internal
+   */
   async loadMigrations(options) {
     const { directory, context, namespace } = options;
     const migrations = {
@@ -379,6 +465,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,15 +497,21 @@ 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;
     }
-    if (options.reqId) {
+    if (options == null ? void 0 : options.reqId) {
       this.context.reqId = options.reqId;
       this._logger = this._logger.child({ reqId: this.context.reqId });
     }
@@ -445,6 +540,8 @@ const _Application = class _Application extends import_koa.default {
       });
       if (options == null ? void 0 : options.throwError) {
         throw error;
+      } else {
+        this.log.error(error);
       }
     } finally {
       const _actionCommand = this._actionCommand;
@@ -482,6 +579,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 +591,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 +723,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,10 +763,11 @@ 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;
+    this.context.resourcer = this.resourceManager;
+    this.context.resourceManager = this.resourceManager;
     this.context.cacheManager = this._cacheManager;
     this.context.cache = this._cache;
     const plugins = this._pm ? this._pm.options.plugins : options.plugins;
@@ -678,15 +785,12 @@ const _Application = class _Application extends import_koa.default {
       default: "basic",
       ...this.options.authManager || {}
     });
-    this.resource({
+    this.resourceManager.define({
       name: "auth",
       actions: import_auth.actions
     });
     this._dataSourceManager.use(this._authManager.middleware(), { tag: "auth" });
-    this.resourcer.use(this._authManager.middleware(), { tag: "auth" });
-    if (this.options.acl !== false) {
-      this.resourcer.use(this.acl.middleware(), { tag: "acl", after: ["auth"] });
-    }
+    this._dataSourceManager.use(import_validate_filter_params.default, { tag: "validate-filter-params", before: ["auth"] });
     this._locales = new import_locale.Locale((0, import_helper.createAppProxy)(this));
     if (options.perfHooks) {
       (0, import_helper.enablePerfHooks)(this);
@@ -703,7 +807,8 @@ const _Application = class _Application extends import_koa.default {
       name: "main",
       database: this.createDatabase(options),
       acl: (0, import_acl.createACL)(),
-      resourceManager: (0, import_helper.createResourcer)(options)
+      resourceManager: (0, import_helper.createResourcer)(options),
+      useACL: options.acl
     });
     this._dataSourceManager = new import_data_source_manager.DataSourceManager();
     this.dataSourceManager.dataSources.set("main", mainDataSourceInstance);

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,28 @@ 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-all").ipc().preload().action(async () => {
+    try {
+      await app.pm.enable("*");
+    } catch (error) {
+      throw new import_plugin_command_error.PluginCommandError(`Failed to enable 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) => {