@nocobase/server 2.1.0-alpha.19 → 2.1.0-alpha.20

package/lib/main-data-source.js

@@ -122,7 +122,7 @@ const _MainDataSource = class _MainDataSource extends import_data_source_manager
     const loadedData = {};
     for (const collection of collections) {
       const c = db.getCollection(collection.name);
-      loadedData[c.tableName()] = {
+      loadedData[c.model.tableName] = {
         ...collection.toJSON(),
         fields: collection.fields.map((field) => {
           const f = c.getField(field.name);

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

@@ -44,10 +44,10 @@ __export(resource_exports, {
 });
 module.exports = __toCommonJS(resource_exports);
 var import_utils = require("@nocobase/utils");
+var import_crypto = __toESM(require("crypto"));
 var import_fs = __toESM(require("fs"));
 var import_fs_extra = __toESM(require("fs-extra"));
 var import_path = __toESM(require("path"));
-var import_crypto = __toESM(require("crypto"));
 var import_utils2 = require("../utils");
 var import_package = __toESM(require("../../../package.json"));
 const PLUGIN_CLIENT_ENTRY_FILES = {
@@ -139,6 +139,21 @@ async function listEnabledPlugins(ctx, lane = "client") {
   return arr;
 }
 __name(listEnabledPlugins, "listEnabledPlugins");
+function normalizePmPluginKeys(filterByTk) {
+  return filterByTk.split(",").map((k) => k.trim()).filter(Boolean);
+}
+__name(normalizePmPluginKeys, "normalizePmPluginKeys");
+function coerceAwaitResponse(value) {
+  if (value === true || value === 1) {
+    return true;
+  }
+  if (typeof value === "string") {
+    const v = value.trim().toLowerCase();
+    return v === "true" || v === "1" || v === "yes";
+  }
+  return false;
+}
+__name(coerceAwaitResponse, "coerceAwaitResponse");
 var resource_default = {
   name: "pm",
   actions: {
@@ -216,23 +231,46 @@ var resource_default = {
       await next();
     },
     async enable(ctx, next) {
-      const { filterByTk } = ctx.action.params;
+      const { filterByTk, awaitResponse: awaitResponseRaw } = ctx.action.params;
       const app = ctx.app;
-      if (!filterByTk) {
+      if (filterByTk == null || filterByTk === "" || typeof filterByTk !== "string") {
+        ctx.throw(400, "plugin name invalid");
+      }
+      const keys = normalizePmPluginKeys(filterByTk);
+      if (!keys.length) {
         ctx.throw(400, "plugin name invalid");
       }
-      const keys = Array.isArray(filterByTk) ? filterByTk : [filterByTk];
-      app.runAsCLI(["pm", "enable", ...keys], { from: "user" });
+      const awaitResponse = coerceAwaitResponse(awaitResponseRaw);
+      const argv = ["pm", "enable", ...keys];
+      if (awaitResponse) {
+        await app.runAsCLI(argv, { from: "user", throwError: true });
+      } else {
+        void app.runAsCLI(argv, { from: "user" }).catch((err) => {
+          app.log.error(err);
+        });
+      }
       ctx.body = filterByTk;
       await next();
     },
     async disable(ctx, next) {
-      const { filterByTk } = ctx.action.params;
-      if (!filterByTk) {
+      const { filterByTk, awaitResponse: awaitResponseRaw } = ctx.action.params;
+      const app = ctx.app;
+      if (filterByTk == null || filterByTk === "" || typeof filterByTk !== "string") {
         ctx.throw(400, "plugin name invalid");
       }
-      const app = ctx.app;
-      app.runAsCLI(["pm", "disable", filterByTk], { from: "user" });
+      const keys = normalizePmPluginKeys(filterByTk);
+      if (!keys.length) {
+        ctx.throw(400, "plugin name invalid");
+      }
+      const awaitResponse = coerceAwaitResponse(awaitResponseRaw);
+      const argv = ["pm", "disable", ...keys];
+      if (awaitResponse) {
+        await app.runAsCLI(argv, { from: "user", throwError: true });
+      } else {
+        void app.runAsCLI(argv, { from: "user" }).catch((err) => {
+          app.log.error(err);
+        });
+      }
       ctx.body = filterByTk;
       await next();
     },

package/lib/swagger/index.d.ts

@@ -34,6 +34,25 @@ declare const _default: {
     })[];
     components: {
         schemas: {
+            PMPluginListSummaryItem: {
+                readonly type: "object";
+                readonly description: "Compact plugin row returned when listing with `mode=summary`.";
+                readonly properties: {
+                    readonly displayName: {
+                        readonly type: "string";
+                    };
+                    readonly packageName: {
+                        readonly type: "string";
+                    };
+                    readonly enabled: {
+                        readonly type: "boolean";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                    };
+                };
+                readonly additionalProperties: true;
+            };
             PMPlugin: {
                 readonly type: "object";
                 readonly properties: {
@@ -356,18 +375,29 @@ declare const _default: {
             readonly get: {
                 readonly tags: readonly ["pm"];
                 readonly summary: "List available plugins";
-                readonly description: "Return plugin metadata from the plugin manager.";
-                readonly parameters: readonly [];
+                readonly description: "Return plugin metadata from the plugin manager. Pass `mode=summary` for a lightweight list built from discovered packages; omit `mode` for full records (locale-aware via the nocobase plugin).";
+                readonly parameters: readonly [{
+                    name: string;
+                    in: string;
+                    required: boolean;
+                    description: string;
+                    schema: {
+                        type: string;
+                        enum: string[];
+                    };
+                }];
                 readonly responses: {
                     readonly 200: {
                         description: string;
                         content: {
                             'application/json': {
                                 schema: {
-                                    type: string;
-                                    items: {
-                                        $ref: string;
-                                    };
+                                    oneOf: {
+                                        type: string;
+                                        items: {
+                                            $ref: string;
+                                        };
+                                    }[];
                                 };
                             };
                         };
@@ -537,14 +567,23 @@ declare const _default: {
             readonly post: {
                 readonly tags: readonly ["pm"];
                 readonly summary: "Enable a plugin";
-                readonly description: "Queue an enable operation for a plugin.";
+                readonly description: "Run plugin enable via the plugin manager. Use `awaitResponse=true` to wait for completion. Multiple plugins can be passed in `filterByTk` as a comma-separated list.";
                 readonly parameters: readonly [{
                     name: string;
                     in: string;
+                    required: boolean;
                     description: string;
+                    schema: {
+                        type: string;
+                    };
+                }, {
+                    name: string;
+                    in: string;
                     required: boolean;
+                    description: string;
                     schema: {
                         type: string;
+                        default: boolean;
                     };
                 }];
                 readonly responses: {
@@ -573,14 +612,23 @@ declare const _default: {
             readonly post: {
                 readonly tags: readonly ["pm"];
                 readonly summary: "Disable a plugin";
-                readonly description: "Queue a disable operation for a plugin.";
+                readonly description: "Run plugin disable via the plugin manager. Use `awaitResponse=true` to wait for completion. Multiple plugins can be passed in `filterByTk` as a comma-separated list.";
                 readonly parameters: readonly [{
                     name: string;
                     in: string;
+                    required: boolean;
                     description: string;
+                    schema: {
+                        type: string;
+                    };
+                }, {
+                    name: string;
+                    in: string;
                     required: boolean;
+                    description: string;
                     schema: {
                         type: string;
+                        default: boolean;
                     };
                 }];
                 readonly responses: {

package/lib/swagger/pm.d.ts

@@ -8,6 +8,25 @@
  */
 export declare const pmComponents: {
     readonly schemas: {
+        readonly PMPluginListSummaryItem: {
+            readonly type: "object";
+            readonly description: "Compact plugin row returned when listing with `mode=summary`.";
+            readonly properties: {
+                readonly displayName: {
+                    readonly type: "string";
+                };
+                readonly packageName: {
+                    readonly type: "string";
+                };
+                readonly enabled: {
+                    readonly type: "boolean";
+                };
+                readonly description: {
+                    readonly type: "string";
+                };
+            };
+            readonly additionalProperties: true;
+        };
         readonly PMPlugin: {
             readonly type: "object";
             readonly properties: {
@@ -125,18 +144,29 @@ declare const _default: {
         readonly get: {
             readonly tags: readonly ["pm"];
             readonly summary: "List available plugins";
-            readonly description: "Return plugin metadata from the plugin manager.";
-            readonly parameters: readonly [];
+            readonly description: "Return plugin metadata from the plugin manager. Pass `mode=summary` for a lightweight list built from discovered packages; omit `mode` for full records (locale-aware via the nocobase plugin).";
+            readonly parameters: readonly [{
+                name: string;
+                in: string;
+                required: boolean;
+                description: string;
+                schema: {
+                    type: string;
+                    enum: string[];
+                };
+            }];
             readonly responses: {
                 readonly 200: {
                     description: string;
                     content: {
                         'application/json': {
                             schema: {
-                                type: string;
-                                items: {
-                                    $ref: string;
-                                };
+                                oneOf: {
+                                    type: string;
+                                    items: {
+                                        $ref: string;
+                                    };
+                                }[];
                             };
                         };
                     };
@@ -306,14 +336,23 @@ declare const _default: {
         readonly post: {
             readonly tags: readonly ["pm"];
             readonly summary: "Enable a plugin";
-            readonly description: "Queue an enable operation for a plugin.";
+            readonly description: "Run plugin enable via the plugin manager. Use `awaitResponse=true` to wait for completion. Multiple plugins can be passed in `filterByTk` as a comma-separated list.";
             readonly parameters: readonly [{
                 name: string;
                 in: string;
+                required: boolean;
                 description: string;
+                schema: {
+                    type: string;
+                };
+            }, {
+                name: string;
+                in: string;
                 required: boolean;
+                description: string;
                 schema: {
                     type: string;
+                    default: boolean;
                 };
             }];
             readonly responses: {
@@ -342,14 +381,23 @@ declare const _default: {
         readonly post: {
             readonly tags: readonly ["pm"];
             readonly summary: "Disable a plugin";
-            readonly description: "Queue a disable operation for a plugin.";
+            readonly description: "Run plugin disable via the plugin manager. Use `awaitResponse=true` to wait for completion. Multiple plugins can be passed in `filterByTk` as a comma-separated list.";
             readonly parameters: readonly [{
                 name: string;
                 in: string;
+                required: boolean;
                 description: string;
+                schema: {
+                    type: string;
+                };
+            }, {
+                name: string;
+                in: string;
                 required: boolean;
+                description: string;
                 schema: {
                     type: string;
+                    default: boolean;
                 };
             }];
             readonly responses: {

package/lib/swagger/pm.js

@@ -39,28 +39,67 @@ const pluginNameParameter = {
     type: "string"
   }
 };
-const pluginListResponse = {
+const pluginPmEnableDisableFilterParameter = {
+  name: "filterByTk",
+  in: "query",
+  required: true,
+  description: "Plugin package name(s). Pass multiple plugins as a comma-separated list (e.g. `@nocobase/plugin-a,@nocobase/plugin-b`).",
+  schema: {
+    type: "string"
+  }
+};
+const pluginPmAwaitResponseParameter = {
+  name: "awaitResponse",
+  in: "query",
+  required: false,
+  description: "When `true`, await the CLI operation and return its result in the response body. When `false` or omitted, start the operation and return promptly (body is usually the plugin name or the `filterByTk` value for enable).",
+  schema: {
+    type: "boolean",
+    default: false
+  }
+};
+const pluginListModeParameter = {
+  name: "mode",
+  in: "query",
+  required: false,
+  description: "Use `summary` for a compact list (`displayName`, `packageName`, `enabled`, `description`). Omit for full plugin objects (`PMPlugin`), including locale-specific fields from the nocobase plugin.",
+  schema: {
+    type: "string",
+    enum: ["summary"]
+  }
+};
+const enabledPluginListResponse = {
   description: "OK",
   content: {
     "application/json": {
       schema: {
         type: "array",
         items: {
-          $ref: "#/components/schemas/PMPlugin"
+          $ref: "#/components/schemas/PMEnabledPlugin"
         }
       }
     }
   }
 };
-const enabledPluginListResponse = {
-  description: "OK",
+const pluginListResponseOneOf = {
+  description: "OK. Shape depends on `mode`: full `PMPlugin` list by default, or `PMPluginListSummaryItem` when `mode=summary`.",
   content: {
     "application/json": {
       schema: {
-        type: "array",
-        items: {
-          $ref: "#/components/schemas/PMEnabledPlugin"
-        }
+        oneOf: [
+          {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/PMPlugin"
+            }
+          },
+          {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/PMPluginListSummaryItem"
+            }
+          }
+        ]
       }
     }
   }
@@ -85,6 +124,25 @@ const pluginOperationResponse = {
 };
 const pmComponents = {
   schemas: {
+    PMPluginListSummaryItem: {
+      type: "object",
+      description: "Compact plugin row returned when listing with `mode=summary`.",
+      properties: {
+        displayName: {
+          type: "string"
+        },
+        packageName: {
+          type: "string"
+        },
+        enabled: {
+          type: "boolean"
+        },
+        description: {
+          type: "string"
+        }
+      },
+      additionalProperties: true
+    },
     PMPlugin: {
       type: "object",
       properties: {
@@ -202,10 +260,10 @@ var pm_default = {
     get: {
       tags: ["pm"],
       summary: "List available plugins",
-      description: "Return plugin metadata from the plugin manager.",
-      parameters: [],
+      description: "Return plugin metadata from the plugin manager. Pass `mode=summary` for a lightweight list built from discovered packages; omit `mode` for full records (locale-aware via the nocobase plugin).",
+      parameters: [pluginListModeParameter],
       responses: {
-        200: pluginListResponse
+        200: pluginListResponseOneOf
       }
     }
   },
@@ -328,8 +386,8 @@ var pm_default = {
     post: {
       tags: ["pm"],
       summary: "Enable a plugin",
-      description: "Queue an enable operation for a plugin.",
-      parameters: [pluginNameParameter],
+      description: "Run plugin enable via the plugin manager. Use `awaitResponse=true` to wait for completion. Multiple plugins can be passed in `filterByTk` as a comma-separated list.",
+      parameters: [pluginPmEnableDisableFilterParameter, pluginPmAwaitResponseParameter],
       responses: {
         200: pluginOperationResponse
       }
@@ -339,8 +397,8 @@ var pm_default = {
     post: {
       tags: ["pm"],
       summary: "Disable a plugin",
-      description: "Queue a disable operation for a plugin.",
-      parameters: [pluginNameParameter],
+      description: "Run plugin disable via the plugin manager. Use `awaitResponse=true` to wait for completion. Multiple plugins can be passed in `filterByTk` as a comma-separated list.",
+      parameters: [pluginPmEnableDisableFilterParameter, pluginPmAwaitResponseParameter],
       responses: {
         200: pluginOperationResponse
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/server",
-  "version": "2.1.0-alpha.19",
+  "version": "2.1.0-alpha.20",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
   "license": "Apache-2.0",
@@ -10,21 +10,21 @@
     "@koa/cors": "^5.0.0",
     "@koa/multer": "^3.1.0",
     "@koa/router": "^13.1.0",
-    "@nocobase/acl": "2.1.0-alpha.19",
-    "@nocobase/actions": "2.1.0-alpha.19",
-    "@nocobase/ai": "2.1.0-alpha.19",
-    "@nocobase/auth": "2.1.0-alpha.19",
-    "@nocobase/cache": "2.1.0-alpha.19",
-    "@nocobase/data-source-manager": "2.1.0-alpha.19",
-    "@nocobase/database": "2.1.0-alpha.19",
-    "@nocobase/evaluators": "2.1.0-alpha.19",
-    "@nocobase/lock-manager": "2.1.0-alpha.19",
-    "@nocobase/logger": "2.1.0-alpha.19",
-    "@nocobase/resourcer": "2.1.0-alpha.19",
-    "@nocobase/sdk": "2.1.0-alpha.19",
-    "@nocobase/snowflake-id": "2.1.0-alpha.19",
-    "@nocobase/telemetry": "2.1.0-alpha.19",
-    "@nocobase/utils": "2.1.0-alpha.19",
+    "@nocobase/acl": "2.1.0-alpha.20",
+    "@nocobase/actions": "2.1.0-alpha.20",
+    "@nocobase/ai": "2.1.0-alpha.20",
+    "@nocobase/auth": "2.1.0-alpha.20",
+    "@nocobase/cache": "2.1.0-alpha.20",
+    "@nocobase/data-source-manager": "2.1.0-alpha.20",
+    "@nocobase/database": "2.1.0-alpha.20",
+    "@nocobase/evaluators": "2.1.0-alpha.20",
+    "@nocobase/lock-manager": "2.1.0-alpha.20",
+    "@nocobase/logger": "2.1.0-alpha.20",
+    "@nocobase/resourcer": "2.1.0-alpha.20",
+    "@nocobase/sdk": "2.1.0-alpha.20",
+    "@nocobase/snowflake-id": "2.1.0-alpha.20",
+    "@nocobase/telemetry": "2.1.0-alpha.20",
+    "@nocobase/utils": "2.1.0-alpha.20",
     "@types/decompress": "4.2.7",
     "@types/ini": "^1.3.31",
     "@types/koa-send": "^4.1.3",
@@ -61,5 +61,5 @@
     "@types/serve-handler": "^6.1.1",
     "@types/ws": "^8.5.5"
   },
-  "gitHead": "3d13700360eac1c0f9dbf6a5f167ed396a294a3c"
+  "gitHead": "3d1535db6bf93ca23257faf474afee0d565f54c6"
 }