@nocobase/plugin-client 2.1.0-alpha.1 → 2.1.0-alpha.10

package/dist/swagger/index.js

@@ -0,0 +1,222 @@
+/**
+ * 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 swagger_exports = {};
+__export(swagger_exports, {
+  default: () => swagger_default
+});
+module.exports = __toCommonJS(swagger_exports);
+var swagger_default = {
+  openapi: "3.0.2",
+  info: {
+    title: "NocoBase API - Client plugin",
+    version: "1.0.0"
+  },
+  paths: {
+    "/roles/{roleName}/desktopRoutes:add": {
+      post: {
+        tags: ["roles.desktopRoutes"],
+        summary: "Add desktop route permissions to a role",
+        parameters: [{ $ref: "#/components/parameters/RoleNamePath" }],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/RouteIdList" }
+            }
+          }
+        },
+        responses: {
+          200: { description: "OK" }
+        }
+      }
+    },
+    "/roles/{roleName}/desktopRoutes:remove": {
+      post: {
+        tags: ["roles.desktopRoutes"],
+        summary: "Remove desktop route permissions from a role",
+        parameters: [{ $ref: "#/components/parameters/RoleNamePath" }],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/RouteIdList" }
+            }
+          }
+        },
+        responses: {
+          200: { description: "OK" }
+        }
+      }
+    },
+    "/roles/{roleName}/desktopRoutes:set": {
+      post: {
+        tags: ["roles.desktopRoutes"],
+        summary: "Set desktop route permissions for a role",
+        parameters: [{ $ref: "#/components/parameters/RoleNamePath" }],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/RouteIdList" }
+            }
+          }
+        },
+        responses: {
+          200: { description: "OK" }
+        }
+      }
+    },
+    "/roles/{roleName}/desktopRoutes:list": {
+      get: {
+        tags: ["roles.desktopRoutes"],
+        summary: "List desktop routes granted to a role",
+        parameters: [
+          { $ref: "#/components/parameters/RoleNamePath" },
+          { $ref: "#/components/parameters/PaginateQuery" },
+          { $ref: "#/components/parameters/FilterQuery" }
+        ],
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    data: {
+                      type: "array",
+                      items: { $ref: "#/components/schemas/DesktopRoute" }
+                    },
+                    meta: {
+                      type: "object",
+                      additionalProperties: true
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/desktopRoutes:listAccessible": {
+      get: {
+        tags: ["desktopRoutes"],
+        summary: "List desktop routes accessible to the current user",
+        parameters: [
+          { $ref: "#/components/parameters/TreeQuery" },
+          { $ref: "#/components/parameters/SortScalarQuery" },
+          { $ref: "#/components/parameters/FilterQuery" }
+        ],
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    data: {
+                      type: "array",
+                      items: { $ref: "#/components/schemas/DesktopRoute" }
+                    },
+                    meta: {
+                      type: "object",
+                      additionalProperties: true
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  components: {
+    parameters: {
+      RoleNamePath: {
+        name: "roleName",
+        in: "path",
+        description: "Role name.",
+        required: true,
+        schema: { type: "string" }
+      },
+      PaginateQuery: {
+        name: "paginate",
+        in: "query",
+        description: "Whether to return paginated result format.",
+        required: false,
+        schema: { type: "boolean" }
+      },
+      TreeQuery: {
+        name: "tree",
+        in: "query",
+        description: "Whether to return routes as a tree.",
+        required: false,
+        schema: { type: "boolean" }
+      },
+      SortScalarQuery: {
+        name: "sort",
+        in: "query",
+        description: "Sort field, for example `sort`.",
+        required: false,
+        schema: { type: "string" }
+      },
+      FilterQuery: {
+        name: "filter",
+        in: "query",
+        description: "JSON filter object.",
+        required: false,
+        schema: { type: "object", additionalProperties: true }
+      }
+    },
+    schemas: {
+      RouteIdList: {
+        type: "array",
+        description: "Desktop route id list.",
+        items: { type: "integer" }
+      },
+      DesktopRoute: {
+        type: "object",
+        properties: {
+          id: { type: "integer" },
+          title: { type: "string" },
+          type: { type: "string" },
+          path: { type: "string", nullable: true },
+          parentId: { type: "integer", nullable: true },
+          hidden: { type: "boolean", nullable: true },
+          children: {
+            type: "array",
+            items: { $ref: "#/components/schemas/DesktopRoute" }
+          }
+        },
+        additionalProperties: true
+      }
+    }
+  }
+};

package/package.json

@@ -6,9 +6,9 @@
   "description": "Provides a client interface for the NocoBase server",
   "description.ru-RU": "Предоставляет клиентский интерфейс для сервера NocoBase",
   "description.zh-CN": "为 NocoBase 服务端提供客户端界面",
-  "version": "2.1.0-alpha.1",
+  "version": "2.1.0-alpha.10",
   "main": "./dist/server/index.js",
-  "license": "AGPL-3.0",
+  "license": "Apache-2.0",
   "devDependencies": {
     "antd": "5.x",
     "cronstrue": "^2.11.0",
@@ -23,5 +23,5 @@
     "@nocobase/test": "2.x",
     "@nocobase/utils": "2.x"
   },
-  "gitHead": "d27baf21569643d6fa83f882233f4e90eb5b89f1"
+  "gitHead": "ce790d46c0a5768ca9618c7d0d77ab8300de75c8"
 }

package/dist/swagger/index.json

@@ -1,7 +0,0 @@
-{
-  "openapi": "3.0.2",
-  "info": {
-    "title": "NocoBase API - Client plugin"
-  },
-  "paths": {}
-}