@nocobase/plugin-api-doc 1.2.12-alpha → 1.3.0-alpha.20240710084543

package/dist/server/swagger/collections/paths/index.js

@@ -1,74 +0,0 @@
-/**
- * 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 __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var paths_exports = {};
-__export(paths_exports, {
-  default: () => paths_default,
-  hasSortField: () => hasSortField,
-  isViewCollection: () => isViewCollection,
-  readOnlyCollection: () => readOnlyCollection
-});
-module.exports = __toCommonJS(paths_exports);
-var import_collection = __toESM(require("./collection"));
-var import_associations = __toESM(require("./associations"));
-var paths_default = (collection, options) => {
-  const paths = (0, import_collection.default)(collection);
-  if (options.withAssociation && !isViewCollection(collection)) {
-    Object.assign(paths, (0, import_associations.default)(collection));
-  }
-  return paths;
-};
-function hasSortField(collection) {
-  for (const field of collection.fields.values()) {
-    if (field.type === "sort") {
-      return true;
-    }
-  }
-  return false;
-}
-function readOnlyCollection(collection) {
-  var _a;
-  return isViewCollection(collection) && ((_a = collection.options) == null ? void 0 : _a.writableView) == false;
-}
-function isViewCollection(collection) {
-  return collection.isView();
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  hasSortField,
-  isViewCollection,
-  readOnlyCollection
-});

package/dist/server/swagger/collections/tags/index.d.ts

@@ -1,14 +0,0 @@
-/**
- * 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.
- */
-import { Collection } from '@nocobase/database';
-declare const _default: (collection: Collection, options: any) => {
-    name: string;
-    description: string;
-}[];
-export default _default;

package/dist/server/swagger/collections/tags/index.js

@@ -1,52 +0,0 @@
-/**
- * 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 tags_exports = {};
-__export(tags_exports, {
-  default: () => tags_default
-});
-module.exports = __toCommonJS(tags_exports);
-var import_associations = require("../paths/associations");
-var import_collection = require("../paths/collection");
-var tags_default = (collection, options) => {
-  var _a, _b, _c, _d;
-  const associations = (0, import_associations.associationFields)(collection);
-  const tags = [
-    {
-      name: collection.name,
-      description: ((_a = collection.options) == null ? void 0 : _a.title) || collection.name
-    }
-  ];
-  if (options.withAssociation) {
-    for (const field of associations) {
-      tags.push({
-        name: `${collection.name}.${field.name}`,
-        description: `${(0, import_collection.relationTypeToString)(field)} relationship, ${((_b = collection.options) == null ? void 0 : _b.title) || collection.name}/${((_d = (_c = field.options) == null ? void 0 : _c.uiSchema) == null ? void 0 : _d.title) || field.name}`
-      });
-    }
-  }
-  return tags;
-};

package/dist/server/swagger/constants.d.ts

@@ -1,18 +0,0 @@
-/**
- * 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.
- */
-export declare const SchemaTypeMapping: {
-    uid: string;
-    json: string;
-    jsonb: string;
-    text: string;
-    bigInt: string;
-    sort: string;
-    context: string;
-    set: string;
-};

package/dist/server/swagger/constants.js

@@ -1,45 +0,0 @@
-/**
- * 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 constants_exports = {};
-__export(constants_exports, {
-  SchemaTypeMapping: () => SchemaTypeMapping
-});
-module.exports = __toCommonJS(constants_exports);
-const SchemaTypeMapping = {
-  uid: "string",
-  json: "object",
-  jsonb: "object",
-  text: "string",
-  bigInt: "integer",
-  sort: "integer",
-  context: "string",
-  set: "array"
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  SchemaTypeMapping
-});

package/dist/server/swagger/helpers.d.ts

@@ -1,179 +0,0 @@
-/**
- * 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.
- */
-export declare const createDefaultActionSwagger: ({ collection }: {
-    collection: any;
-}) => {
-    list: {
-        method: string;
-        responses: {
-            default: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-    create: {
-        method: string;
-        requestBody: {
-            content: {
-                'application/json': {
-                    schema: {
-                        $ref: string;
-                    };
-                };
-            };
-        };
-    };
-    get: {
-        method: string;
-        responses: {
-            default: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-    update: {
-        method: string;
-        requestBody: {
-            content: {
-                'application/json': {
-                    schema: {
-                        $ref: string;
-                    };
-                };
-            };
-        };
-        responses: {
-            default: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-    destroy: {
-        method: string;
-        responses: {
-            default: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-    add: {
-        method: string;
-        requestBody: {
-            content: {
-                'application/json': {
-                    schema: {
-                        $ref: string;
-                    };
-                };
-            };
-        };
-        responses: {
-            default: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-    set: {
-        method: string;
-        requestBody: {
-            content: {
-                'application/json': {
-                    schema: {
-                        $ref: string;
-                    };
-                };
-            };
-        };
-    };
-    remove: {
-        method: string;
-        responses: {
-            default: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-    toggle: {
-        method: string;
-        requestBody: {
-            content: {
-                'application/json': {
-                    schema: {
-                        $ref: string;
-                    };
-                };
-            };
-        };
-        responses: {
-            default: {
-                content: {
-                    'application/json': {
-                        schema: {
-                            $ref: string;
-                        };
-                    };
-                };
-            };
-        };
-    };
-    move: {
-        method: string;
-        requestBody: {
-            content: {
-                'application/json': {
-                    schema: {
-                        $ref: string;
-                    };
-                };
-            };
-        };
-    };
-};
-export declare const getInterfaceCollection: (options: Record<string, any>) => {
-    '/{resourceName}': any[];
-    '/{resourceName}/{resourceIndex}': any[];
-    '/{associatedName}/{associatedIndex}/{resourceName}': any[];
-    '/{associatedName}/{associatedIndex}/{resourceName}/{resourceIndex}': any[];
-};

package/dist/server/swagger/helpers.js

@@ -1,143 +0,0 @@
-/**
- * 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 helpers_exports = {};
-__export(helpers_exports, {
-  createDefaultActionSwagger: () => createDefaultActionSwagger,
-  getInterfaceCollection: () => getInterfaceCollection
-});
-module.exports = __toCommonJS(helpers_exports);
-const createDefaultActionSwagger = ({ collection }) => {
-  const responses = {
-    default: {
-      content: {
-        "application/json": {
-          schema: {
-            $ref: `#/components/schemas/${collection.name}`
-          }
-        }
-      }
-    }
-  };
-  const requestBody = {
-    content: {
-      "application/json": {
-        schema: {
-          $ref: `#/components/schemas/${collection.name}`
-        }
-      }
-    }
-  };
-  return {
-    list: {
-      method: "get",
-      responses
-    },
-    create: {
-      method: "post",
-      requestBody
-    },
-    get: {
-      method: "get",
-      responses
-    },
-    update: {
-      method: "put",
-      requestBody,
-      responses
-    },
-    destroy: {
-      method: "delete",
-      responses
-    },
-    add: {
-      method: "post",
-      requestBody,
-      responses
-    },
-    set: {
-      method: "post",
-      requestBody
-    },
-    remove: {
-      method: "delete",
-      responses
-    },
-    toggle: {
-      method: "post",
-      requestBody,
-      responses
-    },
-    move: {
-      method: "post",
-      requestBody
-    }
-  };
-};
-const getInterfaceCollection = (options) => {
-  const accessors = {
-    // 常规 actions
-    list: "list",
-    create: "create",
-    get: "get",
-    update: "update",
-    delete: "destroy",
-    // associate 操作
-    add: "add",
-    set: "set",
-    remove: "remove",
-    toggle: "toggle",
-    move: "move",
-    ...options.accessors || {}
-  };
-  const single = {
-    "/{resourceName}": [accessors.list, accessors.create, accessors.delete],
-    "/{resourceName}/{resourceIndex}": [accessors.get, accessors.update, accessors.delete],
-    "/{associatedName}/{associatedIndex}/{resourceName}": [
-      accessors.list,
-      accessors.create,
-      accessors.delete,
-      accessors.toggle,
-      accessors.add,
-      accessors.remove
-    ],
-    "/{associatedName}/{associatedIndex}/{resourceName}/{resourceIndex}": [
-      accessors.get,
-      accessors.update,
-      accessors.delete,
-      accessors.remove,
-      accessors.toggle,
-      accessors.set,
-      accessors.move
-    ]
-  };
-  return single;
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  createDefaultActionSwagger,
-  getInterfaceCollection
-});

package/dist/server/swagger/index.d.ts

@@ -1,57 +0,0 @@
-/**
- * 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.
- */
-import APIDocPlugin from '../server';
-export declare class SwaggerManager {
-    private plugin;
-    constructor(plugin: APIDocPlugin);
-    private get app();
-    private get db();
-    generateSwagger(options?: {
-        plugins?: string[];
-    }): Promise<unknown>;
-    getSwagger(): Promise<unknown>;
-    collection2Swagger(collectionName: string, withAssociation?: boolean): Promise<{
-        paths: any;
-        components: {
-            parameters: {};
-            schemas: {
-                [x: string]: {
-                    type: string;
-                    properties: {};
-                    allOf?: undefined;
-                } | {
-                    allOf: ({
-                        $ref: string;
-                        type?: undefined;
-                        properties?: undefined;
-                    } | {
-                        type: string;
-                        properties: any;
-                        $ref?: undefined;
-                    })[];
-                    type?: undefined;
-                    properties?: undefined;
-                };
-            };
-        };
-        tags: {
-            name: string;
-            description: string;
-        }[];
-    }>;
-    getCollectionsSwagger(name?: string): Promise<unknown>;
-    getPluginsSwagger(pluginName?: string): Promise<unknown>;
-    getCoreSwagger(): Promise<unknown>;
-    getURL(pathname: string): string;
-    getUrls(): Promise<any[]>;
-    private getBaseSwagger;
-    private generateSchemas;
-    private generateCollectionBuiltInInterface;
-    private loadSwaggers;
-}