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

package/dist/externalVersion.js

@@ -1,22 +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.
- */
-
-module.exports = {
-  "@nocobase/client": "1.2.12-alpha",
-  "@nocobase/sdk": "1.2.12-alpha",
-  "antd": "5.12.8",
-  "react": "18.2.0",
-  "@ant-design/icons": "5.2.6",
-  "antd-style": "3.4.5",
-  "react-i18next": "11.18.6",
-  "@nocobase/actions": "1.2.12-alpha",
-  "@nocobase/server": "1.2.12-alpha",
-  "@nocobase/utils": "1.2.12-alpha",
-  "@nocobase/database": "1.2.12-alpha"
-};

package/dist/index.d.ts

@@ -1,9 +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 { default } from './server';

package/dist/index.js

@@ -1,42 +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 src_exports = {};
-__export(src_exports, {
-  default: () => import_server.default
-});
-module.exports = __toCommonJS(src_exports);
-var import_server = __toESM(require("./server"));

package/dist/locale/en-US.json

@@ -1,5 +0,0 @@
-{
-  "API documentation": "API documentation",
-  "Documentation": "Documentation",
-  "Select a definition": "Select a definition"
-}

package/dist/locale/index.d.ts

@@ -1,12 +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 NAMESPACE = "api-doc";
-export declare function lang(key: string): string;
-export declare function generateNTemplate(key: string): string;
-export declare function useTranslation(): import("react-i18next").UseTranslationResponse<"api-doc", undefined>;

package/dist/locale/index.js

@@ -1,53 +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 locale_exports = {};
-__export(locale_exports, {
-  NAMESPACE: () => NAMESPACE,
-  generateNTemplate: () => generateNTemplate,
-  lang: () => lang,
-  useTranslation: () => useTranslation
-});
-module.exports = __toCommonJS(locale_exports);
-var import_client = require("@nocobase/client");
-var import_react_i18next = require("react-i18next");
-const NAMESPACE = "api-doc";
-function lang(key) {
-  return import_client.i18n.t(key, { ns: NAMESPACE });
-}
-function generateNTemplate(key) {
-  return `{{t('${key}', { ns: '${NAMESPACE}' })}}`;
-}
-function useTranslation() {
-  return (0, import_react_i18next.useTranslation)(NAMESPACE);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  NAMESPACE,
-  generateNTemplate,
-  lang,
-  useTranslation
-});

package/dist/locale/ko_KR.json

@@ -1,5 +0,0 @@
-{
-  "API documentation": "API 문서",
-  "Documentation": "문서",
-  "Select a definition": "정의 선택"  
-}

package/dist/locale/zh-CN.json

@@ -1,5 +0,0 @@
-{
-  "API documentation": "API 文档",
-  "Documentation": "文档",
-  "Select a definition": "选择端点"
-}

package/dist/server/index.d.ts

@@ -1,9 +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 { default } from './server';

package/dist/server/index.js

@@ -1,42 +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 server_exports = {};
-__export(server_exports, {
-  default: () => import_server.default
-});
-module.exports = __toCommonJS(server_exports);
-var import_server = __toESM(require("./server"));

package/dist/server/server.d.ts

@@ -1,17 +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 { Plugin } from '@nocobase/server';
-import { SwaggerManager } from './swagger';
-export declare class PluginAPIDocServer extends Plugin {
-    swagger: SwaggerManager;
-    constructor(app: any, options: any);
-    beforeLoad(): Promise<void>;
-    load(): Promise<void>;
-}
-export default PluginAPIDocServer;

package/dist/server/server.js

@@ -1,83 +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 server_exports = {};
-__export(server_exports, {
-  PluginAPIDocServer: () => PluginAPIDocServer,
-  default: () => server_default
-});
-module.exports = __toCommonJS(server_exports);
-var import_server = require("@nocobase/server");
-var import_swagger = require("./swagger");
-class PluginAPIDocServer extends import_server.Plugin {
-  swagger;
-  constructor(app, options) {
-    super(app, options);
-    this.swagger = new import_swagger.SwaggerManager(this);
-  }
-  async beforeLoad() {
-  }
-  async load() {
-    this.app.resourcer.define({
-      name: "swagger",
-      type: "single",
-      actions: {
-        getUrls: async (ctx, next) => {
-          ctx.body = await this.swagger.getUrls();
-          await next();
-        },
-        get: async (ctx, next) => {
-          ctx.withoutDataWrapping = true;
-          const { ns } = ctx.action.params;
-          if (!ns) {
-            ctx.body = await this.swagger.getSwagger();
-            return;
-          }
-          const [type, index] = ns.split("/");
-          if (type === "core") {
-            ctx.body = await this.swagger.getCoreSwagger();
-          } else if (type === "plugins") {
-            ctx.body = await this.swagger.getPluginsSwagger(index);
-          } else if (type === "collections") {
-            ctx.body = await this.swagger.getCollectionsSwagger(index);
-          }
-          await next();
-        }
-      },
-      only: ["get", "getUrls"]
-    });
-    this.app.acl.allow("swagger", ["get", "getUrls"], "loggedIn");
-    this.app.acl.registerSnippet({
-      name: ["pm", this.name, "documentation"].join("."),
-      actions: ["swagger:*"]
-    });
-  }
-}
-var server_default = PluginAPIDocServer;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  PluginAPIDocServer
-});

package/dist/server/swagger/base-swagger.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.
- */
-declare const _default: {
-    openapi: string;
-    info: {
-        title: string;
-        description: string;
-        contact: {
-            url: string;
-        };
-        license: {
-            name: string;
-            url: string;
-        };
-    };
-    externalDocs: {
-        description: string;
-        url: string;
-    };
-    components: {
-        securitySchemes: {
-            'api-key': {
-                type: string;
-                scheme: string;
-            };
-        };
-        schemas: {
-            error: {
-                type: string;
-                properties: {
-                    errors: {
-                        type: string;
-                        items: {
-                            type: string;
-                            properties: {
-                                message: {
-                                    description: string;
-                                    type: string;
-                                };
-                            };
-                        };
-                    };
-                };
-            };
-        };
-    };
-    security: {
-        'api-key': any[];
-    }[];
-};
-export default _default;

package/dist/server/swagger/base-swagger.js

@@ -1,81 +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 base_swagger_exports = {};
-__export(base_swagger_exports, {
-  default: () => base_swagger_default
-});
-module.exports = __toCommonJS(base_swagger_exports);
-var base_swagger_default = {
-  openapi: "3.0.3",
-  info: {
-    title: "NocoBase API documentation",
-    description: "",
-    contact: {
-      url: "https://github.com/nocobase/nocobase/issues"
-    },
-    license: {
-      name: "Core packages are Apache 2.0 & Plugins packages are AGPL 3.0 licensed.",
-      url: "https://github.com/nocobase/nocobase#license"
-    }
-  },
-  externalDocs: {
-    description: "Find out more about NocoBase",
-    url: "https://docs.nocobase.com/api/http"
-  },
-  components: {
-    securitySchemes: {
-      "api-key": {
-        type: "http",
-        scheme: "bearer"
-      }
-    },
-    schemas: {
-      error: {
-        type: "object",
-        properties: {
-          errors: {
-            type: "array",
-            items: {
-              type: "object",
-              properties: {
-                message: {
-                  description: "\u9519\u8BEF\u4FE1\u606F",
-                  type: "string"
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  security: [
-    {
-      "api-key": []
-    }
-  ]
-};

package/dist/server/swagger/collections/components/field-type-map.d.ts

@@ -1,30 +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 { Field } from '@nocobase/database';
-declare const fieldTypeMap: {
-    bigint: {
-        type: string;
-        format: string;
-    };
-    datetime: {
-        type: string;
-        format: string;
-    };
-    string: {
-        type: string;
-    };
-    text: {
-        type: string;
-    };
-    jsontype: {
-        type: string;
-    };
-};
-declare function getTypeByField(field: Field): any;
-export { fieldTypeMap, getTypeByField };

package/dist/server/swagger/collections/components/field-type-map.js

@@ -1,66 +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 field_type_map_exports = {};
-__export(field_type_map_exports, {
-  fieldTypeMap: () => fieldTypeMap,
-  getTypeByField: () => getTypeByField
-});
-module.exports = __toCommonJS(field_type_map_exports);
-const fieldTypeMap = {
-  bigint: {
-    type: "integer",
-    format: "int64"
-  },
-  datetime: {
-    type: "string",
-    format: "date-time"
-  },
-  string: {
-    type: "string"
-  },
-  text: {
-    type: "string"
-  },
-  jsontype: {
-    type: "string"
-  }
-};
-function getTypeByField(field) {
-  const fieldType = field.dataType.toString().toLowerCase();
-  const fieldAttributes = fieldTypeMap[fieldType];
-  if (!fieldAttributes) {
-    return {
-      type: "string"
-    };
-  }
-  return fieldAttributes;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  fieldTypeMap,
-  getTypeByField
-});

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

@@ -1,32 +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) => {
-    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;
-        };
-    };
-};
-export default _default;

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

@@ -1,49 +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 components_exports = {};
-__export(components_exports, {
-  default: () => components_default
-});
-module.exports = __toCommonJS(components_exports);
-var import_schemas = __toESM(require("./schemas"));
-var import_parameters = __toESM(require("./parameters"));
-var components_default = (collection, options) => {
-  return {
-    ...(0, import_schemas.default)(collection, options),
-    ...(0, import_parameters.default)(collection)
-  };
-};

package/dist/server/swagger/collections/components/parameters.d.ts

@@ -1,13 +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) => {
-    parameters: {};
-};
-export default _default;