@nocobase/plugin-api-doc 0.13.0-alpha.4 → 0.13.0-alpha.5

package/dist/server/swagger/collections/paths/associations/multiple-association.js

@@ -1,10 +1,28 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var collection = require('../collection');
-var index = require('../index');
-
+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 multiple_association_exports = {};
+__export(multiple_association_exports, {
+  appendCollectionIndexParams: () => appendCollectionIndexParams,
+  default: () => multiple_association_default
+});
+module.exports = __toCommonJS(multiple_association_exports);
+var import_collection = require("../collection");
+var import__ = require("../index");
 function appendCollectionIndexParams(apiDef) {
   for (const action of Object.keys(apiDef)) {
     const parameters = apiDef[action]["parameters"];
@@ -17,31 +35,31 @@ function appendCollectionIndexParams(apiDef) {
   }
   return apiDef;
 }
-var multiple_association_default = (collection$1, relationField) => {
+var multiple_association_default = (collection, relationField) => {
   const options = {
-    collection: collection$1,
+    collection,
     relationField
   };
-  collection$1.db.getCollection(relationField.target);
+  const targetCollection = collection.db.getCollection(relationField.target);
   const paths = {
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:list`]: appendCollectionIndexParams(
-      collection.ListActionTemplate(options)
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:list`]: appendCollectionIndexParams(
+      (0, import_collection.ListActionTemplate)(options)
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:get`]: appendCollectionIndexParams(
-      collection.GetActionTemplate(options)
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:get`]: appendCollectionIndexParams(
+      (0, import_collection.GetActionTemplate)(options)
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:create`]: appendCollectionIndexParams(
-      collection.CreateActionTemplate(options)
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:create`]: appendCollectionIndexParams(
+      (0, import_collection.CreateActionTemplate)(options)
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:update`]: appendCollectionIndexParams(
-      collection.UpdateActionTemplate(options)
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:update`]: appendCollectionIndexParams(
+      (0, import_collection.UpdateActionTemplate)(options)
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:destroy`]: appendCollectionIndexParams(
-      collection.DestroyActionTemplate(options)
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:destroy`]: appendCollectionIndexParams(
+      (0, import_collection.DestroyActionTemplate)(options)
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:set`]: appendCollectionIndexParams({
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:set`]: appendCollectionIndexParams({
       post: {
-        tags: [`${collection$1.name}.${relationField.name}`],
+        tags: [`${collection.name}.${relationField.name}`],
         summary: "Set or reset associations",
         parameters: [
           {
@@ -58,9 +76,9 @@ var multiple_association_default = (collection$1, relationField) => {
         }
       }
     }),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:remove`]: appendCollectionIndexParams({
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:remove`]: appendCollectionIndexParams({
       post: {
-        tags: [`${collection$1.name}.${relationField.name}`],
+        tags: [`${collection.name}.${relationField.name}`],
         summary: "Detach record",
         parameters: [
           {
@@ -77,9 +95,9 @@ var multiple_association_default = (collection$1, relationField) => {
         }
       }
     }),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:toggle`]: appendCollectionIndexParams({
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:toggle`]: appendCollectionIndexParams({
       post: {
-        tags: [`${collection$1.name}.${relationField.name}`],
+        tags: [`${collection.name}.${relationField.name}`],
         summary: "Attach or detach record",
         parameters: [
           {
@@ -94,13 +112,14 @@ var multiple_association_default = (collection$1, relationField) => {
       }
     })
   };
-  if (index.hasSortField(collection$1)) {
-    paths[`/${collection$1.name}/{collectionIndex}/${relationField.name}:move`] = appendCollectionIndexParams(
-      collection.MoveActionTemplate(options)
+  if ((0, import__.hasSortField)(collection)) {
+    paths[`/${collection.name}/{collectionIndex}/${relationField.name}:move`] = appendCollectionIndexParams(
+      (0, import_collection.MoveActionTemplate)(options)
     );
   }
   return paths;
 };
-
-exports.appendCollectionIndexParams = appendCollectionIndexParams;
-exports.default = multiple_association_default;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  appendCollectionIndexParams
+});

package/dist/server/swagger/collections/paths/associations/single-association.js

@@ -1,8 +1,27 @@
-'use strict';
-
-var multipleAssociation = require('./multiple-association');
-var collection = require('../collection');
-
+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 single_association_exports = {};
+__export(single_association_exports, {
+  default: () => single_association_default
+});
+module.exports = __toCommonJS(single_association_exports);
+var import_multiple_association = require("./multiple-association");
+var import_collection = require("../collection");
 function removeFilterByTkParams(apiDoc) {
   for (const action of Object.values(apiDoc)) {
     if (action.parameters) {
@@ -32,18 +51,18 @@ function filterSingleAssociationParams(apiDoc) {
   }
   return apiDoc;
 }
-var single_association_default = (collection$1, relationField) => {
+var single_association_default = (collection, relationField) => {
   const options = {
-    collection: collection$1,
+    collection,
     relationField
   };
   return {
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:get`]: removeFilterByTkParams(
-      filterSingleAssociationParams(multipleAssociation.appendCollectionIndexParams(collection.GetActionTemplate(options)))
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:get`]: removeFilterByTkParams(
+      filterSingleAssociationParams((0, import_multiple_association.appendCollectionIndexParams)((0, import_collection.GetActionTemplate)(options)))
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:set`]: multipleAssociation.appendCollectionIndexParams({
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:set`]: (0, import_multiple_association.appendCollectionIndexParams)({
       post: {
-        tags: [`${collection$1.name}.${relationField.name}`],
+        tags: [`${collection.name}.${relationField.name}`],
         summary: "Associate a record",
         parameters: [
           {
@@ -62,9 +81,9 @@ var single_association_default = (collection$1, relationField) => {
         }
       }
     }),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:remove`]: multipleAssociation.appendCollectionIndexParams({
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:remove`]: (0, import_multiple_association.appendCollectionIndexParams)({
       post: {
-        tags: [`${collection$1.name}.${relationField.name}`],
+        tags: [`${collection.name}.${relationField.name}`],
         summary: "Disassociate the relationship record",
         responses: {
           "200": {
@@ -73,16 +92,14 @@ var single_association_default = (collection$1, relationField) => {
         }
       }
     }),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:update`]: removeFilterByTkParams(
-      filterSingleAssociationParams(multipleAssociation.appendCollectionIndexParams(collection.UpdateActionTemplate(options)))
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:update`]: removeFilterByTkParams(
+      filterSingleAssociationParams((0, import_multiple_association.appendCollectionIndexParams)((0, import_collection.UpdateActionTemplate)(options)))
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:create`]: removeFilterByTkParams(
-      filterSingleAssociationParams(multipleAssociation.appendCollectionIndexParams(collection.CreateActionTemplate(options)))
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:create`]: removeFilterByTkParams(
+      filterSingleAssociationParams((0, import_multiple_association.appendCollectionIndexParams)((0, import_collection.CreateActionTemplate)(options)))
     ),
-    [`/${collection$1.name}/{collectionIndex}/${relationField.name}:destroy`]: removeFilterByTkParams(
-      filterSingleAssociationParams(multipleAssociation.appendCollectionIndexParams(collection.DestroyActionTemplate(options)))
+    [`/${collection.name}/{collectionIndex}/${relationField.name}:destroy`]: removeFilterByTkParams(
+      filterSingleAssociationParams((0, import_multiple_association.appendCollectionIndexParams)((0, import_collection.DestroyActionTemplate)(options)))
     )
   };
 };
-
-module.exports = single_association_default;

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

@@ -1,9 +1,33 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var index = require('./index');
-
+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 collection_exports = {};
+__export(collection_exports, {
+  CreateActionTemplate: () => CreateActionTemplate,
+  DestroyActionTemplate: () => DestroyActionTemplate,
+  GetActionTemplate: () => GetActionTemplate,
+  ListActionTemplate: () => ListActionTemplate,
+  MoveActionTemplate: () => MoveActionTemplate,
+  UpdateActionTemplate: () => UpdateActionTemplate,
+  default: () => collection_default,
+  relationTypeToString: () => relationTypeToString
+});
+module.exports = __toCommonJS(collection_exports);
+var import_index = require("./index");
 function relationTypeToString(field) {
   return {
     belongsTo: "Many to one",
@@ -312,22 +336,27 @@ var collection_default = (collection) => {
   const options = { collection };
   const apiDoc = {
     [`/${collection.name}:list`]: ListActionTemplate(options),
-    [`/${collection.name}:get`]: GetActionTemplate(options),
-    [`/${collection.name}:create`]: CreateActionTemplate(options),
-    [`/${collection.name}:update`]: UpdateActionTemplate(options),
-    [`/${collection.name}:destroy`]: DestroyActionTemplate(options)
+    [`/${collection.name}:get`]: GetActionTemplate(options)
   };
-  if (index.hasSortField(collection)) {
+  if (!(0, import_index.readOnlyCollection)(collection)) {
+    Object.assign(apiDoc, {
+      [`/${collection.name}:create`]: CreateActionTemplate(options),
+      [`/${collection.name}:update`]: UpdateActionTemplate(options),
+      [`/${collection.name}:destroy`]: DestroyActionTemplate(options)
+    });
+  }
+  if ((0, import_index.hasSortField)(collection)) {
     apiDoc[`/${collection.name}:move`] = MoveActionTemplate(options);
   }
   return apiDoc;
 };
-
-exports.CreateActionTemplate = CreateActionTemplate;
-exports.DestroyActionTemplate = DestroyActionTemplate;
-exports.GetActionTemplate = GetActionTemplate;
-exports.ListActionTemplate = ListActionTemplate;
-exports.MoveActionTemplate = MoveActionTemplate;
-exports.UpdateActionTemplate = UpdateActionTemplate;
-exports.default = collection_default;
-exports.relationTypeToString = relationTypeToString;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CreateActionTemplate,
+  DestroyActionTemplate,
+  GetActionTemplate,
+  ListActionTemplate,
+  MoveActionTemplate,
+  UpdateActionTemplate,
+  relationTypeToString
+});

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

@@ -2,3 +2,5 @@ import { Collection } from '@nocobase/database';
 declare const _default: (collection: Collection, options: any) => any;
 export default _default;
 export declare function hasSortField(collection: Collection): boolean;
+export declare function readOnlyCollection(collection: Collection): boolean;
+export declare function isViewCollection(collection: Collection): boolean;

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

@@ -1,19 +1,44 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var list = require('./collection');
-var associations = require('./associations');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var list__default = /*#__PURE__*/_interopDefault(list);
-var associations__default = /*#__PURE__*/_interopDefault(associations);
-
+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 = list__default.default(collection);
-  if (options.withAssociation) {
-    Object.assign(paths, associations__default.default(collection));
+  const paths = (0, import_collection.default)(collection);
+  if (options.withAssociation && !isViewCollection(collection)) {
+    Object.assign(paths, (0, import_associations.default)(collection));
   }
   return paths;
 };
@@ -25,6 +50,16 @@ function hasSortField(collection) {
   }
   return false;
 }
-
-exports.default = paths_default;
-exports.hasSortField = hasSortField;
+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.js

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

package/dist/server/swagger/constants.js

@@ -1,5 +1,25 @@
-'use strict';
-
+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",
@@ -10,5 +30,7 @@ const SchemaTypeMapping = {
   context: "string",
   set: "array"
 };
-
-exports.SchemaTypeMapping = SchemaTypeMapping;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SchemaTypeMapping
+});

package/dist/server/swagger/helpers.js

@@ -1,5 +1,26 @@
-'use strict';
-
+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: {
@@ -106,6 +127,8 @@ const getInterfaceCollection = (options) => {
   };
   return single;
 };
-
-exports.createDefaultActionSwagger = createDefaultActionSwagger;
-exports.getInterfaceCollection = getInterfaceCollection;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createDefaultActionSwagger,
+  getInterfaceCollection
+});