@nocobase/server 2.1.0-beta.15 → 2.1.0-beta.17

package/lib/swagger/app.js

@@ -0,0 +1,124 @@
+/**
+ * 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 app_exports = {};
+__export(app_exports, {
+  default: () => app_default
+});
+module.exports = __toCommonJS(app_exports);
+var app_default = {
+  "/app:getLang": {
+    get: {
+      tags: ["app"],
+      summary: "Get the current application language",
+      description: "Return the current locale used by the server.",
+      parameters: [],
+      responses: {
+        200: {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                type: "string"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/app:getInfo": {
+    get: {
+      tags: ["app"],
+      summary: "Get application metadata",
+      description: "Return basic application information, including version and environment-related metadata.",
+      parameters: [],
+      responses: {
+        200: {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                additionalProperties: true
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/app:getPlugins": {
+    get: {
+      tags: ["app"],
+      summary: "List loaded plugins",
+      description: "Return plugin metadata for the current application runtime.",
+      parameters: [],
+      responses: {
+        200: {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                type: "array",
+                items: {
+                  type: "object",
+                  additionalProperties: true
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "/app:restart": {
+    post: {
+      tags: ["app"],
+      summary: "Restart the application",
+      description: "Trigger an application restart asynchronously.",
+      parameters: [],
+      responses: {
+        200: {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/app:clearCache": {
+    post: {
+      tags: ["app"],
+      summary: "Clear application cache",
+      description: "Clear server-side caches used by the current application instance.",
+      parameters: [],
+      responses: {
+        200: {
+          description: "OK"
+        }
+      }
+    }
+  }
+};

package/lib/swagger/base.d.ts

@@ -0,0 +1,244 @@
+/**
+ * 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.
+ */
+declare const _default: {
+    readonly openapi: "3.0.2";
+    readonly info: {
+        readonly title: "NocoBase API - Core";
+    };
+    readonly tags: readonly [{
+        readonly name: "$collection";
+        readonly description: "Data table";
+    }, {
+        readonly name: "$collection.$oneToOneAssociation";
+        readonly description: "One to one relationship";
+    }, {
+        readonly name: "$collection.$manyToOneAssociation";
+        readonly description: "Many to one relationship";
+    }, {
+        readonly name: "$collection.$oneToManyAssociation";
+        readonly description: "One to many relationship";
+    }, {
+        readonly name: "$collection.$manyToManyAssociation";
+        readonly description: "Many to many relationship";
+    }, {
+        readonly name: "app";
+        readonly description: "app";
+    }, {
+        readonly name: "pm";
+        readonly description: "pm";
+    }];
+    readonly components: {
+        readonly parameters: {
+            readonly collectionName: {
+                readonly required: true;
+                readonly name: "collectionName";
+                readonly in: "path";
+                readonly description: "Collection name";
+                readonly schema: {
+                    readonly type: "string";
+                };
+            };
+            readonly collectionIndex: {
+                readonly required: true;
+                readonly name: "collectionIndex";
+                readonly in: "path";
+                readonly description: "Collection index";
+                readonly schema: {
+                    readonly type: "integer";
+                    readonly format: "int64";
+                };
+            };
+            readonly oneToOneAssociation: {
+                readonly required: true;
+                readonly name: "oneToOneAssociation";
+                readonly in: "path";
+                readonly description: "Association name";
+                readonly schema: {
+                    readonly type: "string";
+                };
+            };
+            readonly manyToOneAssociation: {
+                readonly required: true;
+                readonly name: "manyToOneAssociation";
+                readonly in: "path";
+                readonly description: "Association name";
+                readonly schema: {
+                    readonly type: "string";
+                };
+            };
+            readonly oneToManyAssociation: {
+                readonly required: true;
+                readonly name: "oneToManyAssociation";
+                readonly in: "path";
+                readonly description: "Association name";
+                readonly schema: {
+                    readonly type: "string";
+                };
+            };
+            readonly manyToManyAssociation: {
+                readonly required: true;
+                readonly name: "manyToManyAssociation";
+                readonly in: "path";
+                readonly description: "Association name";
+                readonly schema: {
+                    readonly type: "string";
+                };
+            };
+            readonly page: {
+                readonly name: "page";
+                readonly in: "query";
+                readonly description: "page number";
+                readonly required: false;
+                readonly schema: {
+                    readonly type: "integer";
+                };
+            };
+            readonly pageSize: {
+                readonly name: "pageSize";
+                readonly in: "query";
+                readonly description: "page size";
+                readonly required: false;
+                readonly schema: {
+                    readonly type: "integer";
+                };
+            };
+            readonly filterByTk: {
+                readonly name: "filterByTk";
+                readonly in: "query";
+                readonly description: "filter by TK(default by ID)";
+                readonly schema: {
+                    readonly type: "string";
+                };
+            };
+            readonly filterByTks: {
+                readonly name: "filterByTks";
+                readonly in: "query";
+                readonly description: "filter by TKs(default by ID), example: `1,2,3`";
+                readonly schema: {
+                    readonly type: "string";
+                };
+            };
+            readonly filter: {
+                readonly name: "filter";
+                readonly in: "query";
+                readonly description: "filter items";
+                readonly content: {
+                    readonly 'application/json': {
+                        readonly schema: {
+                            readonly type: "object";
+                        };
+                    };
+                };
+            };
+            readonly sort: {
+                readonly name: "sort";
+                readonly in: "query";
+                readonly description: "sort items by fields, example: `-field1,-field2,field3`";
+                readonly schema: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly example: readonly ["-id", "createdAt"];
+                    }, {
+                        readonly type: "string";
+                        readonly example: "-id,createdAt";
+                    }];
+                };
+            };
+            readonly fields: {
+                readonly name: "fields";
+                readonly in: "query";
+                readonly description: "select fields, example: `field1,field2`";
+                readonly schema: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly example: readonly ["id", "createdAt"];
+                    }, {
+                        readonly type: "string";
+                        readonly example: "id,createdAt";
+                    }];
+                };
+            };
+            readonly except: {
+                readonly name: "except";
+                readonly in: "query";
+                readonly description: "except fields in results, example: `field1,field2`";
+                readonly schema: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly example: readonly ["id", "createdAt"];
+                    }, {
+                        readonly type: "string";
+                        readonly example: "id,createdAt";
+                    }];
+                };
+            };
+            readonly appends: {
+                readonly name: "appends";
+                readonly in: "query";
+                readonly description: "append associations in results, example: `assoc1,assoc2`";
+                readonly schema: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly example: readonly ["id", "createdAt"];
+                    }, {
+                        readonly type: "string";
+                        readonly example: "id,createdAt";
+                    }];
+                };
+            };
+            readonly whitelist: {
+                readonly name: "whitelist";
+                readonly in: "query";
+                readonly description: "whitelist for fields changes, example: `field1,field2`";
+                readonly schema: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly example: readonly ["id", "createdAt"];
+                    }, {
+                        readonly type: "string";
+                        readonly example: "id,createdAt";
+                    }];
+                };
+            };
+            readonly blacklist: {
+                readonly name: "blacklist";
+                readonly in: "query";
+                readonly description: "blacklist for fields changes, example: `field1,field2`";
+                readonly schema: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly example: readonly ["id", "createdAt"];
+                    }, {
+                        readonly type: "string";
+                        readonly example: "id,createdAt";
+                    }];
+                };
+            };
+        };
+    };
+};
+export default _default;

package/lib/swagger/base.js

@@ -0,0 +1,292 @@
+/**
+ * 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 base_exports = {};
+__export(base_exports, {
+  default: () => base_default
+});
+module.exports = __toCommonJS(base_exports);
+var base_default = {
+  openapi: "3.0.2",
+  info: {
+    title: "NocoBase API - Core"
+  },
+  tags: [
+    {
+      name: "$collection",
+      description: "Data table"
+    },
+    {
+      name: "$collection.$oneToOneAssociation",
+      description: "One to one relationship"
+    },
+    {
+      name: "$collection.$manyToOneAssociation",
+      description: "Many to one relationship"
+    },
+    {
+      name: "$collection.$oneToManyAssociation",
+      description: "One to many relationship"
+    },
+    {
+      name: "$collection.$manyToManyAssociation",
+      description: "Many to many relationship"
+    },
+    {
+      name: "app",
+      description: "app"
+    },
+    {
+      name: "pm",
+      description: "pm"
+    }
+  ],
+  components: {
+    parameters: {
+      collectionName: {
+        required: true,
+        name: "collectionName",
+        in: "path",
+        description: "Collection name",
+        schema: {
+          type: "string"
+        }
+      },
+      collectionIndex: {
+        required: true,
+        name: "collectionIndex",
+        in: "path",
+        description: "Collection index",
+        schema: {
+          type: "integer",
+          format: "int64"
+        }
+      },
+      oneToOneAssociation: {
+        required: true,
+        name: "oneToOneAssociation",
+        in: "path",
+        description: "Association name",
+        schema: {
+          type: "string"
+        }
+      },
+      manyToOneAssociation: {
+        required: true,
+        name: "manyToOneAssociation",
+        in: "path",
+        description: "Association name",
+        schema: {
+          type: "string"
+        }
+      },
+      oneToManyAssociation: {
+        required: true,
+        name: "oneToManyAssociation",
+        in: "path",
+        description: "Association name",
+        schema: {
+          type: "string"
+        }
+      },
+      manyToManyAssociation: {
+        required: true,
+        name: "manyToManyAssociation",
+        in: "path",
+        description: "Association name",
+        schema: {
+          type: "string"
+        }
+      },
+      page: {
+        name: "page",
+        in: "query",
+        description: "page number",
+        required: false,
+        schema: {
+          type: "integer"
+        }
+      },
+      pageSize: {
+        name: "pageSize",
+        in: "query",
+        description: "page size",
+        required: false,
+        schema: {
+          type: "integer"
+        }
+      },
+      filterByTk: {
+        name: "filterByTk",
+        in: "query",
+        description: "filter by TK(default by ID)",
+        schema: {
+          type: "string"
+        }
+      },
+      filterByTks: {
+        name: "filterByTks",
+        in: "query",
+        description: "filter by TKs(default by ID), example: `1,2,3`",
+        schema: {
+          type: "string"
+        }
+      },
+      filter: {
+        name: "filter",
+        in: "query",
+        description: "filter items",
+        content: {
+          "application/json": {
+            schema: {
+              type: "object"
+            }
+          }
+        }
+      },
+      sort: {
+        name: "sort",
+        in: "query",
+        description: "sort items by fields, example: `-field1,-field2,field3`",
+        schema: {
+          oneOf: [
+            {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              example: ["-id", "createdAt"]
+            },
+            {
+              type: "string",
+              example: "-id,createdAt"
+            }
+          ]
+        }
+      },
+      fields: {
+        name: "fields",
+        in: "query",
+        description: "select fields, example: `field1,field2`",
+        schema: {
+          oneOf: [
+            {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              example: ["id", "createdAt"]
+            },
+            {
+              type: "string",
+              example: "id,createdAt"
+            }
+          ]
+        }
+      },
+      except: {
+        name: "except",
+        in: "query",
+        description: "except fields in results, example: `field1,field2`",
+        schema: {
+          oneOf: [
+            {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              example: ["id", "createdAt"]
+            },
+            {
+              type: "string",
+              example: "id,createdAt"
+            }
+          ]
+        }
+      },
+      appends: {
+        name: "appends",
+        in: "query",
+        description: "append associations in results, example: `assoc1,assoc2`",
+        schema: {
+          oneOf: [
+            {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              example: ["id", "createdAt"]
+            },
+            {
+              type: "string",
+              example: "id,createdAt"
+            }
+          ]
+        }
+      },
+      whitelist: {
+        name: "whitelist",
+        in: "query",
+        description: "whitelist for fields changes, example: `field1,field2`",
+        schema: {
+          oneOf: [
+            {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              example: ["id", "createdAt"]
+            },
+            {
+              type: "string",
+              example: "id,createdAt"
+            }
+          ]
+        }
+      },
+      blacklist: {
+        name: "blacklist",
+        in: "query",
+        description: "blacklist for fields changes, example: `field1,field2`",
+        schema: {
+          oneOf: [
+            {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              example: ["id", "createdAt"]
+            },
+            {
+              type: "string",
+              example: "id,createdAt"
+            }
+          ]
+        }
+      }
+    }
+  }
+};