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

package/dist/swagger/index.js

@@ -127,6 +127,7 @@ var swagger_default = {
       get: {
         tags: ["desktopRoutes"],
         summary: "List desktop routes accessible to the current user",
+        description: "List desktop routes that the current user can access. Creating or destroying routes may also create or remove flowModels anchors through desktopRoutes hooks.",
         parameters: [
           { $ref: "#/components/parameters/TreeQuery" },
           { $ref: "#/components/parameters/SortScalarQuery" },
@@ -137,22 +138,234 @@ var swagger_default = {
             description: "OK",
             content: {
               "application/json": {
-                schema: {
-                  type: "object",
-                  properties: {
-                    data: {
-                      type: "array",
-                      items: { $ref: "#/components/schemas/DesktopRoute" }
-                    },
-                    meta: {
-                      type: "object",
-                      additionalProperties: true
-                    }
+                schema: { $ref: "#/components/schemas/DataWrappedDesktopRouteListResponse" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/desktopRoutes:getAccessible": {
+      get: {
+        tags: ["desktopRoutes"],
+        summary: "Get one accessible desktop route",
+        description: "Get one accessible desktop route by filter.",
+        parameters: [
+          { $ref: "#/components/parameters/FilterQuery" },
+          { $ref: "#/components/parameters/FilterByTkQuery" }
+        ],
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/DataWrappedNullableDesktopRouteResponse" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/desktopRoutes:create": {
+      post: {
+        tags: ["desktopRoutes"],
+        summary: "Create a desktop route",
+        description: "Create a desktop route. Side effect: the desktopRoutes.afterCreate hook may create a flowModels anchor using schemaUid for the created route.",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/DesktopRouteCreateValues" }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/DataWrappedDesktopRouteResponse" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/desktopRoutes:update": {
+      post: {
+        tags: ["desktopRoutes"],
+        summary: "Update a desktop route",
+        description: "Update a desktop route by filterByTk or filter.",
+        parameters: [
+          { $ref: "#/components/parameters/FilterByTkQuery" },
+          { $ref: "#/components/parameters/FilterQuery" }
+        ],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/DesktopRouteUpdateValues" }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/DataWrappedDesktopRouteResponse" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/desktopRoutes:updateOrCreate": {
+      post: {
+        tags: ["desktopRoutes"],
+        summary: "Update or create a desktop route",
+        description: "Update or create a desktop route by filterKeys.",
+        parameters: [{ $ref: "#/components/parameters/FilterKeysQuery" }],
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/DesktopRouteCreateValues" }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/DataWrappedDesktopRouteOrListResponse" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/desktopRoutes:move": {
+      post: {
+        tags: ["desktopRoutes"],
+        summary: "Move a desktop route",
+        description: "Move a route in the menu tree.",
+        parameters: [
+          { $ref: "#/components/parameters/SourceIdQuery" },
+          { $ref: "#/components/parameters/TargetIdQuery" },
+          { $ref: "#/components/parameters/MethodQuery" },
+          { $ref: "#/components/parameters/SortFieldQuery" },
+          { $ref: "#/components/parameters/TargetScopeQuery" },
+          { $ref: "#/components/parameters/StickyQuery" }
+        ],
+        responses: {
+          200: { description: "OK" }
+        }
+      }
+    },
+    "/desktopRoutes:destroy": {
+      post: {
+        tags: ["desktopRoutes"],
+        summary: "Destroy a desktop route",
+        description: "Destroy a desktop route. Side effect: the desktopRoutes.afterDestroy hook may remove flowModels anchors related to the destroyed route.",
+        parameters: [
+          { $ref: "#/components/parameters/FilterByTkQuery" },
+          { $ref: "#/components/parameters/FilterQuery" }
+        ],
+        responses: {
+          200: { description: "OK" }
+        }
+      }
+    },
+    "/desktopRoutes:createV2": {
+      post: {
+        tags: ["desktopRoutes"],
+        summary: "Create a Modern page (v2)",
+        description: "Create a Modern page (v2) in one transaction: creates the page route and default hidden tab route, inserts the FlowRoute uiSchema shell, and precreates key flowModels subtrees. The operation is idempotent on schemaUid.",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/DesktopRouteCreateV2Request" },
+              examples: {
+                createV2: {
+                  summary: "Create v2 page",
+                  value: {
+                    schemaUid: "page-uid-001",
+                    parentId: null,
+                    title: "My Page",
+                    icon: "Icon"
                   }
                 }
               }
             }
           }
+        },
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/DataWrappedDesktopRouteCreateV2Response" }
+              }
+            }
+          },
+          400: {
+            description: "Bad Request",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/ErrorResponse" }
+              }
+            }
+          },
+          409: {
+            description: "Conflict",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/ErrorResponse" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/desktopRoutes:destroyV2": {
+      post: {
+        tags: ["desktopRoutes"],
+        summary: "Destroy a Modern page (v2)",
+        description: "Destroy a Modern page (v2) by schemaUid in one transaction: removes the page route and its children, removes the FlowRoute uiSchema shell, and relies on desktopRoutes.afterDestroy to clean up flowModels anchors.",
+        requestBody: {
+          required: true,
+          content: {
+            "application/json": {
+              schema: { $ref: "#/components/schemas/DesktopRouteDestroyV2Request" },
+              examples: {
+                destroyV2: {
+                  summary: "Destroy v2 page",
+                  value: { schemaUid: "page-uid-001" }
+                }
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            description: "OK",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/DataWrappedOkResponse" }
+              }
+            }
+          },
+          400: {
+            description: "Bad Request",
+            content: {
+              "application/json": {
+                schema: { $ref: "#/components/schemas/ErrorResponse" }
+              }
+            }
+          }
         }
       }
     }
@@ -192,7 +405,80 @@ var swagger_default = {
         in: "query",
         description: "JSON filter object.",
         required: false,
-        schema: { type: "object", additionalProperties: true }
+        content: {
+          "application/json": {
+            schema: {
+              type: "object",
+              additionalProperties: true
+            }
+          }
+        }
+      },
+      FilterByTkQuery: {
+        name: "filterByTk",
+        in: "query",
+        description: "Filter by target key, usually route id.",
+        required: false,
+        schema: { type: "string" }
+      },
+      FilterKeysQuery: {
+        name: "filterKeys",
+        in: "query",
+        description: "Field list used to find an existing route before updateOrCreate.",
+        required: true,
+        schema: {
+          type: "array",
+          items: { type: "string" }
+        }
+      },
+      SourceIdQuery: {
+        name: "sourceId",
+        in: "query",
+        description: "Source route id.",
+        required: true,
+        schema: { type: "string" }
+      },
+      TargetIdQuery: {
+        name: "targetId",
+        in: "query",
+        description: "Target route id.",
+        required: false,
+        schema: { type: "string" }
+      },
+      MethodQuery: {
+        name: "method",
+        in: "query",
+        description: "Move method, for example `insertAfter` or `prepend`.",
+        required: false,
+        schema: { type: "string" }
+      },
+      SortFieldQuery: {
+        name: "sortField",
+        in: "query",
+        description: "Sort field name, default is `sort`.",
+        required: false,
+        schema: { type: "string" }
+      },
+      TargetScopeQuery: {
+        name: "targetScope",
+        in: "query",
+        description: "JSON scope object used to constrain move target.",
+        required: false,
+        content: {
+          "application/json": {
+            schema: {
+              type: "object",
+              additionalProperties: true
+            }
+          }
+        }
+      },
+      StickyQuery: {
+        name: "sticky",
+        in: "query",
+        description: "Whether to move the route to the sticky position.",
+        required: false,
+        schema: { type: "boolean" }
       }
     },
     schemas: {
@@ -201,21 +487,222 @@ var swagger_default = {
         description: "Desktop route id list.",
         items: { type: "integer" }
       },
+      ErrorItem: {
+        type: "object",
+        required: ["message"],
+        properties: {
+          code: { type: "string" },
+          message: { type: "string" },
+          details: {
+            type: "object",
+            additionalProperties: true
+          },
+          opId: { type: "string" },
+          opIndex: { type: "number" }
+        },
+        additionalProperties: true
+      },
+      ErrorResponse: {
+        type: "object",
+        required: ["errors"],
+        properties: {
+          errors: {
+            type: "array",
+            items: { $ref: "#/components/schemas/ErrorItem" }
+          }
+        },
+        additionalProperties: true
+      },
+      DataWrappedDesktopRouteListResponse: {
+        type: "object",
+        properties: {
+          data: {
+            type: "array",
+            items: { $ref: "#/components/schemas/DesktopRoute" }
+          }
+        },
+        additionalProperties: true
+      },
+      DataWrappedNullableDesktopRouteResponse: {
+        type: "object",
+        properties: {
+          data: {
+            anyOf: [{ $ref: "#/components/schemas/DesktopRoute" }, { type: "null" }]
+          }
+        },
+        additionalProperties: true
+      },
+      DataWrappedDesktopRouteResponse: {
+        type: "object",
+        properties: {
+          data: { $ref: "#/components/schemas/DesktopRoute" }
+        },
+        additionalProperties: true
+      },
+      DataWrappedDesktopRouteOrListResponse: {
+        type: "object",
+        properties: {
+          data: {
+            anyOf: [
+              { $ref: "#/components/schemas/DesktopRoute" },
+              {
+                type: "array",
+                items: { $ref: "#/components/schemas/DesktopRoute" }
+              }
+            ]
+          }
+        },
+        additionalProperties: true
+      },
+      DataWrappedDesktopRouteCreateV2Response: {
+        type: "object",
+        properties: {
+          data: { $ref: "#/components/schemas/DesktopRouteCreateV2Response" }
+        },
+        additionalProperties: true
+      },
+      DataWrappedOkResponse: {
+        type: "object",
+        properties: {
+          data: { $ref: "#/components/schemas/OkResponse" }
+        },
+        additionalProperties: true
+      },
       DesktopRoute: {
         type: "object",
         properties: {
-          id: { type: "integer" },
+          id: {
+            oneOf: [{ type: "integer" }, { type: "string" }]
+          },
           title: { type: "string" },
+          tooltip: { type: "string", nullable: true },
           type: { type: "string" },
+          icon: { type: "string", nullable: true },
           path: { type: "string", nullable: true },
-          parentId: { type: "integer", nullable: true },
+          parentId: {
+            anyOf: [{ type: "integer" }, { type: "string" }, { type: "null" }]
+          },
+          schemaUid: { type: "string", nullable: true },
+          menuSchemaUid: { type: "string", nullable: true },
+          tabSchemaName: { type: "string", nullable: true },
+          hideInMenu: { type: "boolean", nullable: true },
+          enableTabs: { type: "boolean", nullable: true },
+          enableHeader: { type: "boolean", nullable: true },
+          displayTitle: { type: "boolean", nullable: true },
           hidden: { type: "boolean", nullable: true },
+          sort: { type: "integer", nullable: true },
+          options: {
+            type: "object",
+            additionalProperties: true,
+            nullable: true
+          },
           children: {
             type: "array",
             items: { $ref: "#/components/schemas/DesktopRoute" }
           }
         },
         additionalProperties: true
+      },
+      DesktopRouteCreateValues: {
+        type: "object",
+        properties: {
+          type: { type: "string" },
+          title: { type: "string" },
+          tooltip: { type: "string" },
+          icon: { type: "string" },
+          parentId: {
+            anyOf: [{ type: "integer" }, { type: "string" }, { type: "null" }]
+          },
+          schemaUid: { type: "string" },
+          menuSchemaUid: { type: "string" },
+          tabSchemaName: { type: "string" },
+          hideInMenu: { type: "boolean" },
+          enableTabs: { type: "boolean" },
+          enableHeader: { type: "boolean" },
+          displayTitle: { type: "boolean" },
+          hidden: { type: "boolean" },
+          sort: { type: "integer" },
+          options: {
+            type: "object",
+            additionalProperties: true
+          },
+          children: {
+            type: "array",
+            items: {
+              type: "object",
+              additionalProperties: true
+            }
+          }
+        },
+        additionalProperties: true
+      },
+      DesktopRouteUpdateValues: {
+        type: "object",
+        additionalProperties: true
+      },
+      DesktopRouteCreateV2Request: {
+        type: "object",
+        required: ["schemaUid", "title"],
+        properties: {
+          schemaUid: { type: "string" },
+          parentId: {
+            anyOf: [{ type: "integer" }, { type: "string" }, { type: "null" }]
+          },
+          title: { type: "string" },
+          icon: { type: "string" }
+        },
+        additionalProperties: false
+      },
+      DesktopRouteCreateV2Response: {
+        type: "object",
+        required: ["page", "defaultTab"],
+        properties: {
+          page: {
+            type: "object",
+            properties: {
+              id: {
+                oneOf: [{ type: "integer" }, { type: "string" }]
+              },
+              schemaUid: { type: "string" },
+              title: { type: "string" },
+              icon: { type: "string", nullable: true },
+              parentId: {
+                anyOf: [{ type: "integer" }, { type: "string" }, { type: "null" }]
+              },
+              menuSchemaUid: { type: "string", nullable: true }
+            },
+            additionalProperties: true
+          },
+          defaultTab: {
+            type: "object",
+            nullable: true,
+            properties: {
+              id: {
+                oneOf: [{ type: "integer" }, { type: "string" }]
+              },
+              schemaUid: { type: "string" },
+              tabSchemaName: { type: "string", nullable: true }
+            },
+            additionalProperties: true
+          }
+        },
+        additionalProperties: true
+      },
+      DesktopRouteDestroyV2Request: {
+        type: "object",
+        required: ["schemaUid"],
+        properties: {
+          schemaUid: { type: "string" }
+        },
+        additionalProperties: false
+      },
+      OkResponse: {
+        type: "object",
+        required: ["ok"],
+        properties: {
+          ok: { type: "boolean" }
+        },
+        additionalProperties: true
       }
     }
   }

package/package.json

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