@nocobase/server 2.1.0-beta.14 → 2.1.0-beta.16

package/lib/swagger/pm.js

@@ -0,0 +1,422 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var pm_exports = {};
+__export(pm_exports, {
+  default: () => pm_default,
+  pmComponents: () => pmComponents
+});
+module.exports = __toCommonJS(pm_exports);
+const pluginNameParameter = {
+  name: "filterByTk",
+  in: "query",
+  description: "Plugin name.",
+  required: true,
+  schema: {
+    type: "string"
+  }
+};
+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/PMEnabledPlugin"
+        }
+      }
+    }
+  }
+};
+const pluginListResponseOneOf = {
+  description: "OK. Shape depends on `mode`: full `PMPlugin` list by default, or `PMPluginListSummaryItem` when `mode=summary`.",
+  content: {
+    "application/json": {
+      schema: {
+        oneOf: [
+          {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/PMPlugin"
+            }
+          },
+          {
+            type: "array",
+            items: {
+              $ref: "#/components/schemas/PMPluginListSummaryItem"
+            }
+          }
+        ]
+      }
+    }
+  }
+};
+const pluginOperationResponse = {
+  description: "OK",
+  content: {
+    "application/json": {
+      schema: {
+        oneOf: [
+          {
+            type: "string",
+            example: "ok"
+          },
+          {
+            $ref: "#/components/schemas/PMPluginActionResult"
+          }
+        ]
+      }
+    }
+  }
+};
+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: {
+        id: {
+          type: "integer"
+        },
+        name: {
+          type: "string",
+          description: "Plugin short name."
+        },
+        packageName: {
+          type: "string",
+          description: "Plugin package name."
+        },
+        version: {
+          type: "string"
+        },
+        enabled: {
+          type: "boolean"
+        },
+        installed: {
+          type: "boolean"
+        },
+        builtIn: {
+          type: "boolean"
+        },
+        options: {
+          type: "object",
+          additionalProperties: true
+        }
+      },
+      additionalProperties: true
+    },
+    PMEnabledPlugin: {
+      type: "object",
+      properties: {
+        name: {
+          type: "string"
+        },
+        packageName: {
+          type: "string"
+        },
+        options: {
+          type: "object",
+          additionalProperties: true
+        },
+        url: {
+          type: "string",
+          description: "Resolved client bundle URL."
+        }
+      },
+      additionalProperties: true
+    },
+    PMPluginActionResult: {
+      type: "string",
+      description: "Queued successfully.",
+      example: "ok"
+    },
+    PMInstallOrUpdatePayload: {
+      type: "object",
+      description: "JSON payload for installing or updating a plugin from npm or a compressed package URL.",
+      properties: {
+        packageName: {
+          type: "string",
+          description: "Plugin package name."
+        },
+        version: {
+          type: "string",
+          description: "Target plugin version."
+        },
+        registry: {
+          type: "string",
+          description: "Custom npm registry URL."
+        },
+        authToken: {
+          type: "string",
+          description: "Authentication token used when accessing a private registry."
+        },
+        compressedFileUrl: {
+          type: "string",
+          description: "Remote compressed package URL."
+        }
+      },
+      additionalProperties: true
+    },
+    PMUploadPayload: {
+      type: "object",
+      description: "Multipart payload for uploading a plugin package file.",
+      properties: {
+        packageName: {
+          type: "string",
+          description: "Plugin package name. Required when updating from an uploaded file."
+        },
+        version: {
+          type: "string"
+        },
+        registry: {
+          type: "string"
+        },
+        authToken: {
+          type: "string"
+        },
+        file: {
+          type: "string",
+          format: "binary",
+          description: "Compressed plugin package file."
+        }
+      },
+      additionalProperties: true
+    }
+  }
+};
+var pm_default = {
+  "/pm:list": {
+    get: {
+      tags: ["pm"],
+      summary: "List available plugins",
+      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: pluginListResponseOneOf
+      }
+    }
+  },
+  "/pm:get": {
+    get: {
+      tags: ["pm"],
+      summary: "Get plugin details",
+      description: "Return metadata for a single plugin.",
+      parameters: [pluginNameParameter],
+      responses: {
+        200: {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                $ref: "#/components/schemas/PMPlugin"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/pm:listEnabled": {
+    get: {
+      tags: ["pm"],
+      summary: "List enabled client plugins",
+      description: "Return enabled plugins that expose a `dist/client/index.js` entry.",
+      parameters: [],
+      responses: {
+        200: enabledPluginListResponse
+      }
+    }
+  },
+  "/pm:listEnabledV2": {
+    get: {
+      tags: ["pm"],
+      summary: "List enabled client-v2 plugins",
+      description: "Return enabled plugins that expose a `dist/client-v2/index.js` entry.",
+      parameters: [],
+      responses: {
+        200: enabledPluginListResponse
+      }
+    }
+  },
+  // '/pm:npmVersionList': {
+  //   get: {
+  //     tags: ['pm'],
+  //     summary: 'List published plugin versions',
+  //     description: 'Return all available npm versions for a specific installed plugin.',
+  //     parameters: [pluginNameParameter],
+  //     responses: {
+  //       200: {
+  //         description: 'OK',
+  //         content: {
+  //           'application/json': {
+  //             schema: {
+  //               type: 'array',
+  //               items: {
+  //                 type: 'string',
+  //               },
+  //             },
+  //           },
+  //         },
+  //       },
+  //     },
+  //   },
+  // },
+  "/pm:add": {
+    post: {
+      tags: ["pm"],
+      summary: "Install a plugin",
+      description: "Queue a plugin installation from npm, a remote compressed package URL, or an uploaded package file.",
+      requestBody: {
+        required: true,
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/PMInstallOrUpdatePayload"
+            }
+          },
+          "multipart/form-data": {
+            schema: {
+              $ref: "#/components/schemas/PMUploadPayload"
+            }
+          }
+        }
+      },
+      responses: {
+        200: pluginOperationResponse
+      }
+    }
+  },
+  "/pm:update": {
+    post: {
+      tags: ["pm"],
+      summary: "Update a plugin",
+      description: "Queue a plugin update from npm, a remote compressed package URL, or an uploaded package file.",
+      requestBody: {
+        required: true,
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/PMInstallOrUpdatePayload"
+            }
+          },
+          "multipart/form-data": {
+            schema: {
+              $ref: "#/components/schemas/PMUploadPayload"
+            }
+          }
+        }
+      },
+      responses: {
+        200: pluginOperationResponse
+      }
+    }
+  },
+  "/pm:enable": {
+    post: {
+      tags: ["pm"],
+      summary: "Enable a plugin",
+      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
+      }
+    }
+  },
+  "/pm:disable": {
+    post: {
+      tags: ["pm"],
+      summary: "Disable a plugin",
+      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
+      }
+    }
+  },
+  "/pm:remove": {
+    post: {
+      tags: ["pm"],
+      summary: "Remove a plugin",
+      description: "Queue a removal operation for a plugin.",
+      parameters: [pluginNameParameter],
+      responses: {
+        200: pluginOperationResponse
+      }
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pmComponents
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/server",
-  "version": "2.1.0-beta.14",
+  "version": "2.1.0-beta.16",
   "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-beta.14",
-    "@nocobase/actions": "2.1.0-beta.14",
-    "@nocobase/ai": "2.1.0-beta.14",
-    "@nocobase/auth": "2.1.0-beta.14",
-    "@nocobase/cache": "2.1.0-beta.14",
-    "@nocobase/data-source-manager": "2.1.0-beta.14",
-    "@nocobase/database": "2.1.0-beta.14",
-    "@nocobase/evaluators": "2.1.0-beta.14",
-    "@nocobase/lock-manager": "2.1.0-beta.14",
-    "@nocobase/logger": "2.1.0-beta.14",
-    "@nocobase/resourcer": "2.1.0-beta.14",
-    "@nocobase/sdk": "2.1.0-beta.14",
-    "@nocobase/snowflake-id": "2.1.0-beta.14",
-    "@nocobase/telemetry": "2.1.0-beta.14",
-    "@nocobase/utils": "2.1.0-beta.14",
+    "@nocobase/acl": "2.1.0-beta.16",
+    "@nocobase/actions": "2.1.0-beta.16",
+    "@nocobase/ai": "2.1.0-beta.16",
+    "@nocobase/auth": "2.1.0-beta.16",
+    "@nocobase/cache": "2.1.0-beta.16",
+    "@nocobase/data-source-manager": "2.1.0-beta.16",
+    "@nocobase/database": "2.1.0-beta.16",
+    "@nocobase/evaluators": "2.1.0-beta.16",
+    "@nocobase/lock-manager": "2.1.0-beta.16",
+    "@nocobase/logger": "2.1.0-beta.16",
+    "@nocobase/resourcer": "2.1.0-beta.16",
+    "@nocobase/sdk": "2.1.0-beta.16",
+    "@nocobase/snowflake-id": "2.1.0-beta.16",
+    "@nocobase/telemetry": "2.1.0-beta.16",
+    "@nocobase/utils": "2.1.0-beta.16",
     "@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": "cd55c9a14596d834c30c83a82c38f1f719f7aac4"
+  "gitHead": "b9a191705a440a336c85d82fd877fdf152bec70f"
 }