@nocobase/plugin-api-doc 0.13.0-alpha.1

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

@@ -0,0 +1,333 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var index = require('./index');
+
+function relationTypeToString(field) {
+  return {
+    belongsTo: "Many to one",
+    hasOne: "One to one",
+    hasMany: "One to many",
+    belongsToMany: "Many to many"
+  }[field.type];
+}
+function ListActionTemplate({ collection, relationField }) {
+  return {
+    get: {
+      tags: [relationField ? `${collection.name}.${relationField.name}` : collection.name],
+      summary: relationField ? `Return a list of ${relationTypeToString(relationField)} relationship` : `Returns a list of the collection`,
+      parameters: [
+        {
+          name: "page",
+          in: "query",
+          description: "page number",
+          required: false,
+          schema: {
+            type: "integer"
+          }
+        },
+        {
+          name: "pageSize",
+          in: "query",
+          description: "page size",
+          required: false,
+          schema: {
+            type: "integer"
+          }
+        },
+        {
+          $ref: "#/components/parameters/filter"
+        },
+        {
+          $ref: "#/components/parameters/sort"
+        },
+        {
+          $ref: "#/components/parameters/fields"
+        },
+        {
+          $ref: "#/components/parameters/appends"
+        },
+        {
+          $ref: "#/components/parameters/except"
+        }
+      ],
+      responses: {
+        "200": {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  data: {
+                    type: "array",
+                    items: {
+                      $ref: `#/components/schemas/${collection.name}`
+                    }
+                  },
+                  meta: {
+                    type: "object",
+                    properties: {
+                      count: {
+                        type: "integer",
+                        description: "total count"
+                      },
+                      page: {
+                        type: "integer",
+                        description: "current page"
+                      },
+                      pageSize: {
+                        type: "integer",
+                        description: "items count per page"
+                      },
+                      totalPage: {
+                        type: "integer",
+                        description: "total page"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  };
+}
+function GetActionTemplate(options) {
+  const { collection, relationField } = options;
+  return {
+    get: {
+      tags: [relationField ? `${collection.name}.${relationField.name}` : collection.name],
+      summary: `Return a record${relationField ? ` of ${relationTypeToString(relationField)}` : ""}`,
+      parameters: [
+        {
+          $ref: "#/components/parameters/filterByTk"
+        },
+        {
+          $ref: "#/components/parameters/filter"
+        },
+        {
+          $ref: "#/components/parameters/sort"
+        },
+        {
+          $ref: "#/components/parameters/fields"
+        },
+        {
+          $ref: "#/components/parameters/appends"
+        },
+        {
+          $ref: "#/components/parameters/except"
+        }
+      ],
+      responses: {
+        "200": {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  data: {
+                    $ref: `#/components/schemas/${collection.name}`
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  };
+}
+function CreateActionTemplate(options) {
+  const { collection, relationField } = options;
+  return {
+    post: {
+      tags: [relationField ? `${collection.name}.${relationField.name}` : collection.name],
+      summary: relationField ? `Create and associate a record` : `Create record`,
+      parameters: [
+        {
+          $ref: "#/components/parameters/whitelist"
+        },
+        {
+          $ref: "#/components/parameters/blacklist"
+        }
+      ],
+      requestBody: {
+        content: {
+          "application/json": {
+            schema: {
+              $ref: `#/components/schemas/${collection.name}.form`
+            }
+          }
+        }
+      },
+      responses: {
+        "200": {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  data: {
+                    $ref: `#/components/schemas/${collection.name}`
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  };
+}
+function UpdateActionTemplate(options) {
+  const { collection, relationField } = options;
+  return {
+    post: {
+      tags: [relationField ? `${collection.name}.${relationField.name}` : collection.name],
+      summary: relationField ? `Update the relationship record` : `Update record`,
+      parameters: [
+        {
+          $ref: "#/components/parameters/filterByTk"
+        },
+        {
+          $ref: "#/components/parameters/filter"
+        },
+        {
+          $ref: "#/components/parameters/whitelist"
+        },
+        {
+          $ref: "#/components/parameters/blacklist"
+        }
+      ],
+      requestBody: {
+        content: {
+          "application/json": {
+            schema: {
+              $ref: `#/components/schemas/${collection.name}.form`
+            }
+          }
+        }
+      },
+      responses: {
+        "200": {
+          description: "OK",
+          content: {
+            "application/json": {
+              schema: {
+                type: "object",
+                properties: {
+                  data: {
+                    $ref: `#/components/schemas/${collection.name}`
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  };
+}
+function DestroyActionTemplate(options) {
+  const { collection, relationField } = options;
+  return {
+    post: {
+      tags: [relationField ? `${collection.name}.${relationField.name}` : collection.name],
+      summary: relationField ? `Destroy and disassociate the relationship record` : `Delete record`,
+      parameters: [
+        {
+          $ref: "#/components/parameters/filterByTk"
+        },
+        {
+          $ref: "#/components/parameters/filter"
+        }
+      ],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  };
+}
+function MoveActionTemplate(options) {
+  const { collection, relationField } = options;
+  return {
+    post: {
+      tags: [relationField ? `${collection.name}.${relationField.name}` : collection.name],
+      summary: relationField ? `Move the relationship record` : `Move record`,
+      parameters: [
+        {
+          name: "sourceId",
+          in: "query",
+          description: "source id",
+          schema: { type: "string" }
+        },
+        {
+          name: "targetId",
+          in: "query",
+          description: "move target id",
+          schema: { type: "string" }
+        },
+        {
+          name: "method",
+          in: "query",
+          description: "move method, insertAfter or insertBefore",
+          schema: { type: "string" }
+        },
+        {
+          name: "sortField",
+          in: "query",
+          description: "sort field name, default is sort",
+          schema: { type: "string" }
+        },
+        {
+          name: "targetScope",
+          in: "query",
+          description: "move target scope",
+          schema: { type: "string" }
+        },
+        {
+          name: "sticky",
+          in: "query",
+          description: "sticky to top",
+          schema: { type: "boolean" }
+        }
+      ],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  };
+}
+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)
+  };
+  if (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;

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

@@ -0,0 +1,4 @@
+import { Collection } from '@nocobase/database';
+declare const _default: (collection: Collection, options: any) => any;
+export default _default;
+export declare function hasSortField(collection: Collection): boolean;

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

@@ -0,0 +1,30 @@
+'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 paths_default = (collection, options) => {
+  const paths = list__default.default(collection);
+  if (options.withAssociation) {
+    Object.assign(paths, associations__default.default(collection));
+  }
+  return paths;
+};
+function hasSortField(collection) {
+  for (const field of collection.fields.values()) {
+    if (field.type === "sort") {
+      return true;
+    }
+  }
+  return false;
+}
+
+exports.default = paths_default;
+exports.hasSortField = hasSortField;

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

@@ -0,0 +1,6 @@
+import { Collection } from '@nocobase/database';
+declare const _default: (collection: Collection, options: any) => {
+    name: string;
+    description: any;
+}[];
+export default _default;

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

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

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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,14 @@
+'use strict';
+
+const SchemaTypeMapping = {
+  uid: "string",
+  json: "object",
+  jsonb: "object",
+  text: "string",
+  bigInt: "integer",
+  sort: "integer",
+  context: "string",
+  set: "array"
+};
+
+exports.SchemaTypeMapping = SchemaTypeMapping;

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

@@ -0,0 +1,171 @@
+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

@@ -0,0 +1,111 @@
+'use strict';
+
+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;
+};
+
+exports.createDefaultActionSwagger = createDefaultActionSwagger;
+exports.getInterfaceCollection = getInterfaceCollection;