@nocobase/server 2.1.0-alpha.2 → 2.1.0-alpha.21

package/README.md

@@ -1,17 +1,24 @@
 # NocoBase
 
 <video width="100%" controls>
-      <source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
+  <source src="https://github.com/user-attachments/assets/4d11a87b-00e2-48f3-9bf7-389d21072d13" type="video/mp4">
 </video>
 
+<p align="center">
+<a href="https://trendshift.io/repositories/4112" target="_blank"><img src="https://trendshift.io/api/badge/repositories/4112" alt="nocobase%2Fnocobase | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+<a href="https://www.producthunt.com/posts/nocobase?embed=true&utm_source=badge-top-post-topic-badge&utm_medium=badge&utm_souce=badge-nocobase" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-topic-badge.svg?post_id=456520&theme=light&period=weekly&topic_id=267" alt="NocoBase - Scalability&#0045;first&#0044;&#0032;open&#0045;source&#0032;no&#0045;code&#0032;platform | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
+</p>
 
 ## What is NocoBase
 
-NocoBase is a scalability-first, open-source no-code development platform.  
-Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
+NocoBase is the most extensible AI-powered no-code platform.   
+Total control. Infinite extensibility. AI collaboration.  
+Enable your team to adapt quickly and cut costs dramatically.  
+No years of development. No millions wasted.  
+Deploy NocoBase in minutes — and take control of everything.
 
 Homepage:  
-https://www.nocobase.com/
+https://www.nocobase.com/  
 
 Online Demo:  
 https://demo.nocobase.com/new
@@ -19,12 +26,74 @@ https://demo.nocobase.com/new
 Documents:  
 https://docs.nocobase.com/
 
-Commericial license & plugins:  
-https://www.nocobase.com/en/commercial
+Forum:  
+https://forum.nocobase.com/
 
-License agreement:   
-https://www.nocobase.com/en/agreement
+Use Cases:  
+https://www.nocobase.com/en/blog/tags/customer-stories
 
+## Release Notes
 
-## Contact Us:  
-hello@nocobase.com
+Our [blog](https://www.nocobase.com/en/blog/timeline) is regularly updated with release notes and provides a weekly summary.
+
+## Distinctive features
+
+### 1. Data model-driven, not form/table–driven
+
+Instead of being constrained by forms or tables, NocoBase adopts a data model–driven approach, separating data structure from user interface to unlock unlimited possibilities.
+
+- UI and data structure are fully decoupled
+- Multiple blocks and actions can be created for the same table or record in any quantity or form
+- Supports the main database, external databases, and third-party APIs as data sources
+
+![model](https://static-docs.nocobase.com/model.png)
+
+### 2. AI employees, integrated into your business systems
+Unlike standalone AI demos, NocoBase allows you to embed AI capabilities seamlessly into your interfaces, workflows, and data context, making AI truly useful in real business scenarios.
+
+- Define AI employees for roles such as translator, analyst, researcher, or assistant
+- Seamless AI–human collaboration in interfaces and workflows
+- Ensure AI usage is secure, transparent, and customizable for your business needs
+
+![AI-employee](https://static-docs.nocobase.com/ai-employee-home.png)
+
+### 3. What you see is what you get, incredibly easy to use
+
+While enabling the development of complex business systems, NocoBase keeps the experience simple and intuitive.
+
+- One-click switch between usage mode and configuration mode
+- Pages serve as a canvas to arrange blocks and actions, similar to Notion
+- Configuration mode is designed for ordinary users, not just programmers
+
+![wysiwyg](https://static-docs.nocobase.com/wysiwyg.gif)
+
+### 4. Everything is a plugin, designed for extension
+Adding more no-code features will never cover every business case. NocoBase is built for extension through its plugin-based microkernel architecture.
+
+- All functionalities are plugins, similar to WordPress
+- Plugins are ready to use upon installation
+- Pages, blocks, actions, APIs, and data sources can all be extended through custom plugins
+
+![plugins](https://static-docs.nocobase.com/plugins.png)
+
+## Installation
+
+NocoBase supports three installation methods:
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/docker-compose">Installing With Docker (👍Recommended)</a>
+
+  Suitable for no-code scenarios, no code to write. When upgrading, just download the latest image and reboot.
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/create-nocobase-app">Installing from create-nocobase-app CLI</a>
+
+  The business code of the project is completely independent and supports low-code development.
+
+- <a target="_blank" href="https://docs.nocobase.com/welcome/getting-started/installation/git-clone">Installing from Git source code</a>
+
+  If you want to experience the latest unreleased version, or want to participate in the contribution, you need to make changes and debug on the source code, it is recommended to choose this installation method, which requires a high level of development skills, and if the code has been updated, you can git pull the latest code.
+
+## How NocoBase works
+
+<video width="100%" controls>
+  <source src="https://github.com/user-attachments/assets/8d183b44-9bb5-4792-b08f-bc08fe8dfaaf" type="video/mp4">
+</video>

package/lib/acl/available-action.js

@@ -50,7 +50,7 @@ const availableActions = {
   view: {
     displayName: '{{t("View")}}',
     type: "old-data",
-    aliases: ["get", "list"],
+    aliases: ["get", "list", "query"],
     allowConfigureFields: true
   },
   update: {

package/lib/aes-encryptor.js

@@ -44,6 +44,7 @@ module.exports = __toCommonJS(aes_encryptor_exports);
 var import_crypto = __toESM(require("crypto"));
 var import_fs_extra = __toESM(require("fs-extra"));
 var import_path = __toESM(require("path"));
+var import_utils = require("@nocobase/utils");
 const _AesEncryptor = class _AesEncryptor {
   key;
   constructor(key) {
@@ -99,12 +100,12 @@ const _AesEncryptor = class _AesEncryptor {
     }
   }
   static async getKeyPath(appName) {
-    const appKeyPath = import_path.default.resolve(process.cwd(), "storage", "apps", appName, "aes_key.dat");
+    const appKeyPath = (0, import_utils.storagePathJoin)("apps", appName, "aes_key.dat");
     const appKeyExists = await import_fs_extra.default.exists(appKeyPath);
     if (appKeyExists) {
       return appKeyPath;
     }
-    const envKeyPath = import_path.default.resolve(process.cwd(), "storage", "environment-variables", appName, "aes_key.dat");
+    const envKeyPath = (0, import_utils.storagePathJoin)("environment-variables", appName, "aes_key.dat");
     const envKeyExists = await import_fs_extra.default.exists(envKeyPath);
     if (envKeyExists) {
       return envKeyPath;

package/lib/ai/create-docs-index.js

@@ -43,10 +43,11 @@ module.exports = __toCommonJS(create_docs_index_exports);
 var import_fast_glob = __toESM(require("fast-glob"));
 var import_fs_extra = __toESM(require("fs-extra"));
 var import_path = __toESM(require("path"));
+var import_utils = require("@nocobase/utils");
 var import_ai = require("@nocobase/ai");
 var import_findPackageNames = require("../plugin-manager/findPackageNames");
 var import_plugin_manager = require("../plugin-manager");
-const DOCS_STORAGE_DIR = import_path.default.resolve(process.cwd(), "storage/ai/docs");
+const DOCS_STORAGE_DIR = (0, import_utils.storagePathJoin)("ai", "docs");
 const REFERENCE_START = "<!-- docs:references:start -->";
 const REFERENCE_END = "<!-- docs:references:end -->";
 const SPLIT_REFERENCE_START = "<!-- docs:splits:start -->";

package/lib/app-supervisor/app-options-factory.d.ts

@@ -16,6 +16,7 @@ export declare const appOptionsFactory: (appName: string, mainApp: Application,
         migrator?: any;
         usingBigIntForId?: boolean;
         underscored?: boolean;
+        rawTimezone?: string;
         logger?: import("@nocobase/logger/lib/logger").Logger | import("@nocobase/logger/lib/logger").LoggerOptions;
         customHooks?: any;
         instanceId?: string;

package/lib/app-supervisor/index.js

@@ -47,6 +47,7 @@ var import_lodash = __toESM(require("lodash"));
 var import_utils = require("@nocobase/utils");
 var import_events = require("events");
 var import_application = __toESM(require("../application"));
+var import_worker_mode = require("../worker-mode");
 var import_main_only_adapter = require("./main-only-adapter");
 var import_handler = require("../errors/handler");
 var import_condition_registry = require("./condition-registry");
@@ -288,6 +289,10 @@ const _AppSupervisor = class _AppSupervisor extends import_events.EventEmitter {
     return this.discoveryAdapter.getAppStatus(appName, defaultStatus);
   }
   async setAppStatus(appName, status, options = {}) {
+    if ((0, import_worker_mode.isTransient)()) {
+      this.logger.debug("App running as worker, status will not be set", { appName, status });
+      return;
+    }
     this.logger.debug("Setting app status", { appName, status });
     return this.discoveryAdapter.setAppStatus(appName, status, options);
   }
@@ -329,7 +334,7 @@ const _AppSupervisor = class _AppSupervisor extends import_events.EventEmitter {
       };
     }
     const app = new import_application.default(options);
-    if (hook !== false) {
+    if (hook ?? !(0, import_worker_mode.isTransient)()) {
       app.on("afterStart", async () => {
         await this.sendSyncMessage(mainApp, {
           type: "app:started",
@@ -356,6 +361,9 @@ const _AppSupervisor = class _AppSupervisor extends import_events.EventEmitter {
     this.registerCommandHandler(app);
     app.on("afterStart", async (app2) => {
       var _a, _b;
+      if ((0, import_worker_mode.isTransient)()) {
+        return;
+      }
       await app2.syncMessageManager.subscribe(
         "app_supervisor:sync",
         async (message) => {
@@ -390,6 +398,9 @@ const _AppSupervisor = class _AppSupervisor extends import_events.EventEmitter {
       }
     });
     app.on("afterDestroy", async (app2) => {
+      if ((0, import_worker_mode.isTransient)()) {
+        return;
+      }
       await this.unregisterEnvironment();
     });
     return app;
@@ -586,6 +597,9 @@ const _AppSupervisor = class _AppSupervisor extends import_events.EventEmitter {
     return super.on(eventName, listener);
   }
   bindAppEvents(app) {
+    if ((0, import_worker_mode.isTransient)()) {
+      return;
+    }
     app.on("afterDestroy", async () => {
       delete this.apps[app.name];
       delete this.appStatus[app.name];

package/lib/app-supervisor/main-only-adapter.d.ts

@@ -13,7 +13,7 @@ import type { AppSupervisor } from './index';
 export declare class MainOnlyAdapter implements AppDiscoveryAdapter, AppProcessAdapter {
     protected readonly supervisor: AppSupervisor;
     readonly name: string;
-    app: Application;
+    apps: Record<string, Application>;
     status: AppStatus;
     appErrors: Record<string, Error>;
     constructor(supervisor: AppSupervisor);

package/lib/app-supervisor/main-only-adapter.js

@@ -36,7 +36,7 @@ const _MainOnlyAdapter = class _MainOnlyAdapter {
     this.name = "main-only";
   }
   name;
-  app;
+  apps = {};
   status;
   appErrors = {};
   async getApp(appName, options = {}) {
@@ -47,10 +47,10 @@ const _MainOnlyAdapter = class _MainOnlyAdapter {
     if (!options.withOutBootStrap) {
       await this.bootstrapApp(appName);
     }
-    return this.app;
+    return this.apps[appName];
   }
   async bootstrapApp(appName) {
-    if (appName !== "main" || !this.app) {
+    if (appName !== "main" || !this.apps[appName]) {
       this.setAppStatus(appName, "not_found");
       return;
     }
@@ -66,23 +66,23 @@ const _MainOnlyAdapter = class _MainOnlyAdapter {
       this.supervisor.logger.warn(`only main app is supported`, { method: "addApp" });
       return;
     }
-    if (this.app) {
+    if (this.apps[app.name]) {
       throw new Error(`app ${app.name} already exists`);
     }
-    this.app = app;
+    this.apps[app.name] = app;
     if (!this.status || this.status === "not_found") {
       this.setAppStatus(app.name, "preparing");
     }
     return app;
   }
   getApps() {
-    return [this.app];
+    return Object.values(this.apps);
   }
   hasApp(appName) {
     if (appName !== "main") {
       return false;
     }
-    return !!this.app;
+    return !!this.apps[appName];
   }
   async startApp(appName) {
     if (appName !== "main") {
@@ -93,31 +93,36 @@ const _MainOnlyAdapter = class _MainOnlyAdapter {
     await (app == null ? void 0 : app.runCommand("start", "--quickstart"));
   }
   async stopApp(appName) {
+    var _a;
     if (appName !== "main") {
       this.supervisor.logger.warn(`only main app is supported`, { method: "stopApp" });
       return;
     }
-    await this.app.runCommand("stop");
+    if (!this.apps[appName]) {
+      return;
+    }
+    await ((_a = this.apps[appName]) == null ? void 0 : _a.runCommand("stop"));
   }
   async removeApp(appName) {
     if (appName !== "main") {
       this.supervisor.logger.warn(`only main app is supported`, { method: "removeApp" });
       return;
     }
-    if (!this.app) {
+    if (!this.apps[appName]) {
       return;
     }
-    await this.app.runCommand("destroy");
+    await this.apps[appName].runCommand("destroy");
+    this.apps[appName] = null;
   }
   async upgradeApp(appName) {
     if (appName !== "main") {
       this.supervisor.logger.warn(`only main app is supported`, { method: "upgrade" });
       return;
     }
-    if (!this.app) {
+    if (!this.apps[appName]) {
       return;
     }
-    await this.app.runCommand("upgrade");
+    await this.apps[appName].runCommand("upgrade");
   }
   async removeAllApps() {
     return this.removeApp("main");

package/lib/application.d.ts

@@ -270,8 +270,7 @@ export declare class Application<StateT = DefaultState, ContextT = DefaultContex
     protected _aesEncryptor: AesEncryptor;
     get aesEncryptor(): AesEncryptor;
     /**
-     * Check if the application is serving as a specific worker.
-     * @experimental
+     * @deprecated use {@link serving} from './worker-mode' instead.
      */
     serving(key?: string): boolean;
     /**

package/lib/application.js

@@ -87,6 +87,7 @@ var import_redis_connection_manager = require("./redis-connection-manager");
 var import_service_container = require("./service-container");
 var import_snowflake_id_field = require("./snowflake-id-field");
 var import_worker_id_allocator = require("./worker-id-allocator");
+var import_worker_mode = require("./worker-mode");
 const _Application = class _Application extends import_koa.default {
   constructor(options) {
     super();
@@ -282,32 +283,10 @@ const _Application = class _Application extends import_koa.default {
     return this._aesEncryptor;
   }
   /**
-   * Check if the application is serving as a specific worker.
-   * @experimental
+   * @deprecated use {@link serving} from './worker-mode' instead.
    */
   serving(key) {
-    const { WORKER_MODE = "" } = process.env;
-    if (!WORKER_MODE) {
-      return true;
-    }
-    if (WORKER_MODE === "-") {
-      return false;
-    }
-    const topics = WORKER_MODE.trim().split(",");
-    if (key) {
-      if (WORKER_MODE === "*") {
-        return true;
-      }
-      if (topics.includes(key)) {
-        return true;
-      }
-      return false;
-    } else {
-      if (topics.includes("!")) {
-        return true;
-      }
-      return false;
-    }
+    return (0, import_worker_mode.serving)(key);
   }
   /**
    * @internal

package/lib/commands/create-migration.js

@@ -76,6 +76,6 @@ export default class extends Migration {
 `;
     await import_fs.default.promises.mkdir((0, import_path.dirname)(filename), { recursive: true });
     await import_fs.default.promises.writeFile(filename, data, "utf8");
-    app.log.info(`migration file in ${filename}`);
+    console.log(`migration file in ${filename}`);
   });
 }, "default");

package/lib/commands/install.js

@@ -37,7 +37,9 @@ var install_default = /* @__PURE__ */ __name((app) => {
     if (options.lang) {
       process.env.INIT_APP_LANG = options.lang;
     }
-    await (0, import_create_docs_index.createDocsIndex)(app);
+    if (!process.env.VITEST) {
+      await (0, import_create_docs_index.createDocsIndex)(app);
+    }
     await app.install(options);
     const reinstall = options.clean || options.force;
     app.log.info(`app ${reinstall ? "reinstalled" : "installed"} successfully [v${app.getVersion()}]`);

package/lib/commands/pm.js

@@ -32,9 +32,16 @@ __export(pm_exports, {
 module.exports = __toCommonJS(pm_exports);
 var import_app_supervisor = require("../app-supervisor");
 var import_plugin_command_error = require("../errors/plugin-command-error");
+var import_utils = require("../plugin-manager/utils");
 /* istanbul ignore file -- @preserve */
 var pm_default = /* @__PURE__ */ __name((app) => {
   const pm = app.command("pm");
+  pm.command("list").action(async () => {
+    const items = await (0, import_utils.pmListSummary)(app);
+    console.log("--- BEGIN_PLUGIN_LIST_JSON ---");
+    console.log(JSON.stringify(items));
+    console.log("--- END_PLUGIN_LIST_JSON ---");
+  });
   pm.command("create").argument("plugin").option("--force-recreate").action(async (plugin, options) => {
     await app.pm.create(plugin, options);
   });

package/lib/commands/start.js

@@ -41,14 +41,14 @@ __export(start_exports, {
 });
 module.exports = __toCommonJS(start_exports);
 var import_fs_extra = __toESM(require("fs-extra"));
-var import_path = require("path");
+var import_utils = require("@nocobase/utils");
 var import_create_docs_index = require("../ai/create-docs-index");
 var import_application_not_install = require("../errors/application-not-install");
 /* istanbul ignore file -- @preserve */
 var start_default = /* @__PURE__ */ __name((app) => {
   app.command("start").auth().option("--db-sync").option("--quickstart").action(async (...cliArgs) => {
     const [options] = cliArgs;
-    const file = (0, import_path.resolve)(process.cwd(), "storage/.upgrading");
+    const file = (0, import_utils.storagePathJoin)(".upgrading");
     const upgrading = await import_fs_extra.default.exists(file);
     if (upgrading) {
       if (!process.env.VITEST) {

package/lib/commands/upgrade.js

@@ -34,7 +34,9 @@ var import_create_docs_index = require("../ai/create-docs-index");
 /* istanbul ignore file -- @preserve */
 var upgrade_default = /* @__PURE__ */ __name((app) => {
   app.command("upgrade").ipc().auth().action(async (options) => {
-    await (0, import_create_docs_index.createDocsIndex)(app);
+    if (!process.env.VITEST) {
+      await (0, import_create_docs_index.createDocsIndex)(app);
+    }
     await app.upgrade(options);
     app.log.info(`\u2728  NocoBase has been upgraded to v${app.getVersion()}`);
   });

package/lib/event-queue.js

@@ -71,7 +71,7 @@ const _MemoryEventQueueAdapter = class _MemoryEventQueueAdapter {
     return null;
   }
   get storagePath() {
-    return import_path.default.resolve(process.cwd(), "storage", "apps", this.options.appName, "event-queue.json");
+    return (0, import_utils.storagePathJoin)("apps", this.options.appName, "event-queue.json");
   }
   listen = /* @__PURE__ */ __name((channel) => {
     if (!this.connected) {

package/lib/gateway/index.d.ts

@@ -19,6 +19,7 @@ import { IPCSocketClient } from './ipc-socket-client';
 import { IPCSocketServer } from './ipc-socket-server';
 import { WSServer } from './ws-server';
 import { Duplex } from 'node:stream';
+export { getHost, getHostname } from './utils';
 export interface IncomingRequest {
     url: string;
     headers: any;
@@ -40,7 +41,7 @@ interface RunOptions {
     mainAppOptions: ApplicationOptions;
 }
 export interface AppSelectorMiddlewareContext {
-    req: IncomingRequest;
+    req: IncomingMessage | IncomingRequest;
     resolvedAppName: string | null;
 }
 export declare class Gateway extends EventEmitter {
@@ -57,6 +58,7 @@ export declare class Gateway extends EventEmitter {
     private port;
     private host;
     private socketPath;
+    private v2IndexTemplateCache;
     private terminating;
     private onTerminate;
     private constructor();
@@ -74,9 +76,18 @@ export declare class Gateway extends EventEmitter {
         code: string;
     }): void;
     responseErrorWithCode(code: any, res: any, options: any): void;
+    private getV2PublicPath;
+    private getAppPublicPath;
+    private isV2Request;
+    private isV2IndexRequest;
+    private getV2RuntimeConfig;
+    private getV2RuntimeConfigScript;
+    private getV2AssetPublicPath;
+    private getV2IndexTemplate;
+    private renderV2IndexHtml;
     requestHandler(req: IncomingMessage, res: ServerResponse): Promise<void>;
     getAppSelectorMiddlewares(): Toposort<AppSelectorMiddleware>;
-    getRequestHandleAppName(req: IncomingRequest): Promise<string>;
+    getRequestHandleAppName(req: IncomingMessage | IncomingRequest): Promise<string>;
     getCallback(): any;
     watch(): Promise<void>;
     run(options: RunOptions): Promise<void>;
@@ -96,4 +107,3 @@ export declare class Gateway extends EventEmitter {
     static registerWsHandler(wsServer: (req: IncomingMessage, socket: Duplex, head: Buffer, app: Application) => boolean | void): void;
     static unregisterWsHandler(wsServer: (req: IncomingMessage, socket: Duplex, head: Buffer, app: Application) => boolean | void): void;
 }
-export {};