@strapi/plugin-documentation 0.0.0-experimental.62ce06180fe9a772eaeb3d43d238b26644f39f7c → 0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282

package/dist/server/services/helpers/build-api-endpoint-path.js

@@ -0,0 +1,166 @@
+'use strict';
+
+var _ = require('lodash');
+var pathToRegexp = require('path-to-regexp');
+var pascalCase = require('./utils/pascal-case.js');
+var queryParams = require('./utils/query-params.js');
+var loopContentTypeNames = require('./utils/loop-content-type-names.js');
+var getApiResponses = require('./utils/get-api-responses.js');
+var routes = require('./utils/routes.js');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var ___default = /*#__PURE__*/_interopDefault(_);
+var pathToRegexp__namespace = /*#__PURE__*/_interopNamespace(pathToRegexp);
+
+/**
+ * @description Parses a route with ':variable'
+ *
+ * @param {string} routePath - The route's path property
+ * @returns {string}
+ */ const parsePathWithVariables = (routePath)=>{
+    const { tokens } = pathToRegexp__namespace.parse(routePath);
+    return tokens.map((token)=>{
+        switch(token.type){
+            case 'text':
+                return token.value;
+            case 'param':
+                return `{${token.name}}`;
+            case 'wildcard':
+                return `{${token.name}}`;
+            case 'group':
+                // Handle group tokens by mapping them within the same function context
+                return `(${parsePathWithVariables(token.tokens.map((t)=>t).join(''))})`;
+            default:
+                throw new Error(`Unknown token type: ${token.type}`);
+        }
+    }).join('');
+};
+/**
+ * @description Builds the required object for a path parameter
+ *
+ * @param {string} routePath - The route's path property
+ *
+ * @returns {object } Swagger path params object
+ */ const getPathParams = (routePath)=>{
+    const { tokens } = pathToRegexp__namespace.parse(routePath);
+    return tokens.reduce((acc, param)=>{
+        // Skip non-parameter tokens
+        if (param.type !== 'param') {
+            return acc;
+        }
+        acc.push({
+            name: `${param.name}`,
+            in: 'path',
+            description: '',
+            deprecated: false,
+            required: true,
+            schema: {
+                type: param.name === 'id' ? 'string' : 'number'
+            }
+        });
+        return acc;
+    }, []);
+};
+const getPathWithPrefix = (prefix, route)=>{
+    // When the prefix is set on the routes and
+    // the current route is not trying to remove it
+    if (prefix && !___default.default.has(route.config, 'prefix')) {
+        // Add the prefix to the path
+        return prefix.concat(route.path);
+    }
+    // Otherwise just return path
+    return route.path;
+};
+/**
+ * @description Gets all paths based on routes
+ *
+ * @param {object} apiInfo
+ * @property {object} apiInfo.routeInfo - The api routes object
+ * @property {string} apiInfo.uniqueName - Content type name | Api name + Content type name
+ * @property {object} apiInfo.contentTypeInfo - The info object found on content type schemas
+ *
+ * @returns {object}
+ */ const getPaths = ({ routeInfo, uniqueName, contentTypeInfo, kind })=>{
+    // Get the routes for the current content type
+    const contentTypeRoutes = routeInfo.routes.filter((route)=>{
+        return route.path.includes(contentTypeInfo.pluralName) || route.path.includes(contentTypeInfo.singularName);
+    });
+    const paths = contentTypeRoutes.reduce((acc, route)=>{
+        // TODO: Find a more reliable way to determine list of entities vs a single entity
+        const isListOfEntities = routes.hasFindMethod(route.handler);
+        const methodVerb = route.method.toLowerCase();
+        const hasPathParams = route.path.includes('/:');
+        const pathWithPrefix = getPathWithPrefix(routeInfo.prefix, route);
+        const routePath = hasPathParams ? parsePathWithVariables(pathWithPrefix) : pathWithPrefix;
+        const responses = getApiResponses({
+            uniqueName,
+            route,
+            isListOfEntities: kind !== 'singleType' && isListOfEntities
+        });
+        const swaggerConfig = {
+            responses,
+            tags: [
+                ___default.default.upperFirst(uniqueName)
+            ],
+            parameters: [],
+            operationId: `${methodVerb}${routePath}`
+        };
+        if (isListOfEntities) {
+            swaggerConfig.parameters?.push(...queryParams);
+        }
+        if (hasPathParams) {
+            const pathParams = getPathParams(route.path);
+            swaggerConfig.parameters?.push(...pathParams);
+        }
+        if ([
+            'post',
+            'put'
+        ].includes(methodVerb)) {
+            const refName = 'Request';
+            const requestBody = {
+                required: true,
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: `#/components/schemas/${pascalCase(uniqueName)}${refName}`
+                        }
+                    }
+                }
+            };
+            swaggerConfig.requestBody = requestBody;
+        }
+        ___default.default.set(acc, `${routePath}.${methodVerb}`, swaggerConfig);
+        return acc;
+    }, {});
+    return paths;
+};
+/**
+ * @description - Builds the Swagger paths object for each api
+ */ const buildApiEndpointPath = (api)=>{
+    // A reusable loop for building paths and component schemas
+    // Uses the api param to build a new set of params for each content type
+    // Passes these new params to the function provided
+    return loopContentTypeNames(api, getPaths);
+};
+
+module.exports = buildApiEndpointPath;
+//# sourceMappingURL=build-api-endpoint-path.js.map

package/dist/server/services/helpers/build-api-endpoint-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-api-endpoint-path.js","sources":["../../../../server/src/services/helpers/build-api-endpoint-path.ts"],"sourcesContent":["import _ from 'lodash';\nimport * as pathToRegexp from 'path-to-regexp';\n\nimport type { Core } from '@strapi/types';\nimport type { OpenAPIV3 } from 'openapi-types';\n\nimport pascalCase from './utils/pascal-case';\nimport queryParams from './utils/query-params';\nimport loopContentTypeNames from './utils/loop-content-type-names';\nimport getApiResponses from './utils/get-api-responses';\nimport { hasFindMethod } from './utils/routes';\n\nimport type { Api, ApiInfo } from '../../types';\n\n/**\n * @description Parses a route with ':variable'\n *\n * @param {string} routePath - The route's path property\n * @returns {string}\n */\nconst parsePathWithVariables = (routePath: string): string => {\n  const { tokens } = pathToRegexp.parse(routePath);\n\n  return tokens\n    .map((token) => {\n      switch (token.type) {\n        case 'text':\n          return token.value;\n        case 'param':\n          return `{${token.name}}`;\n        case 'wildcard':\n          return `{${token.name}}`;\n        case 'group':\n          // Handle group tokens by mapping them within the same function context\n          return `(${parsePathWithVariables(token.tokens.map((t) => t satisfies pathToRegexp.Token).join(''))})`;\n        default:\n          throw new Error(`Unknown token type: ${(token as any).type}`);\n      }\n    })\n    .join('');\n};\n\n/**\n * @description Builds the required object for a path parameter\n *\n * @param {string} routePath - The route's path property\n *\n * @returns {object } Swagger path params object\n */\nconst getPathParams = (routePath: string): OpenAPIV3.ParameterObject[] => {\n  const { tokens } = pathToRegexp.parse(routePath);\n\n  return tokens.reduce((acc, param) => {\n    // Skip non-parameter tokens\n    if (param.type !== 'param') {\n      return acc;\n    }\n\n    acc.push({\n      name: `${param.name}`,\n      in: 'path',\n      description: '',\n      deprecated: false,\n      required: true,\n      schema: { type: param.name === 'id' ? 'string' : 'number' },\n    });\n\n    return acc;\n  }, [] as OpenAPIV3.ParameterObject[]);\n};\n\nconst getPathWithPrefix = (prefix: string | undefined, route: Core.Route) => {\n  // When the prefix is set on the routes and\n  // the current route is not trying to remove it\n  if (prefix && !_.has(route.config, 'prefix')) {\n    // Add the prefix to the path\n    return prefix.concat(route.path);\n  }\n\n  // Otherwise just return path\n  return route.path;\n};\n\n/**\n * @description Gets all paths based on routes\n *\n * @param {object} apiInfo\n * @property {object} apiInfo.routeInfo - The api routes object\n * @property {string} apiInfo.uniqueName - Content type name | Api name + Content type name\n * @property {object} apiInfo.contentTypeInfo - The info object found on content type schemas\n *\n * @returns {object}\n */\nconst getPaths = ({ routeInfo, uniqueName, contentTypeInfo, kind }: ApiInfo) => {\n  // Get the routes for the current content type\n  const contentTypeRoutes = routeInfo.routes.filter((route) => {\n    return (\n      route.path.includes(contentTypeInfo.pluralName) ||\n      route.path.includes(contentTypeInfo.singularName)\n    );\n  });\n\n  const paths = contentTypeRoutes.reduce((acc: any, route: Core.Route) => {\n    // TODO: Find a more reliable way to determine list of entities vs a single entity\n    const isListOfEntities = hasFindMethod(route.handler);\n    const methodVerb = route.method.toLowerCase();\n    const hasPathParams = route.path.includes('/:');\n    const pathWithPrefix = getPathWithPrefix(routeInfo.prefix, route);\n    const routePath = hasPathParams ? parsePathWithVariables(pathWithPrefix) : pathWithPrefix;\n\n    const responses = getApiResponses({\n      uniqueName,\n      route,\n      isListOfEntities: kind !== 'singleType' && isListOfEntities,\n    });\n\n    const swaggerConfig: OpenAPIV3.OperationObject = {\n      responses,\n      tags: [_.upperFirst(uniqueName)],\n      parameters: [],\n      operationId: `${methodVerb}${routePath}`,\n    };\n\n    if (isListOfEntities) {\n      swaggerConfig.parameters?.push(...queryParams);\n    }\n\n    if (hasPathParams) {\n      const pathParams = getPathParams(route.path);\n      swaggerConfig.parameters?.push(...pathParams);\n    }\n\n    if (['post', 'put'].includes(methodVerb)) {\n      const refName = 'Request';\n      const requestBody = {\n        required: true,\n        content: {\n          'application/json': {\n            schema: {\n              $ref: `#/components/schemas/${pascalCase(uniqueName)}${refName}`,\n            },\n          },\n        },\n      };\n\n      swaggerConfig.requestBody = requestBody;\n    }\n\n    _.set(acc, `${routePath}.${methodVerb}`, swaggerConfig);\n\n    return acc;\n  }, {});\n\n  return paths;\n};\n\n/**\n * @description - Builds the Swagger paths object for each api\n */\nconst buildApiEndpointPath = (api: Api) => {\n  // A reusable loop for building paths and component schemas\n  // Uses the api param to build a new set of params for each content type\n  // Passes these new params to the function provided\n  return loopContentTypeNames(api, getPaths);\n};\n\nexport default buildApiEndpointPath;\n"],"names":["parsePathWithVariables","routePath","tokens","pathToRegexp","parse","map","token","type","value","name","t","join","Error","getPathParams","reduce","acc","param","push","in","description","deprecated","required","schema","getPathWithPrefix","prefix","route","_","has","config","concat","path","getPaths","routeInfo","uniqueName","contentTypeInfo","kind","contentTypeRoutes","routes","filter","includes","pluralName","singularName","paths","isListOfEntities","hasFindMethod","handler","methodVerb","method","toLowerCase","hasPathParams","pathWithPrefix","responses","getApiResponses","swaggerConfig","tags","upperFirst","parameters","operationId","queryParams","pathParams","refName","requestBody","content","$ref","pascalCase","set","buildApiEndpointPath","api","loopContentTypeNames"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA;;;;;IAMA,MAAMA,yBAAyB,CAACC,SAAAA,GAAAA;AAC9B,IAAA,MAAM,EAAEC,MAAM,EAAE,GAAGC,uBAAAA,CAAaC,KAAK,CAACH,SAAAA,CAAAA;IAEtC,OAAOC,MAAAA,CACJG,GAAG,CAAC,CAACC,KAAAA,GAAAA;AACJ,QAAA,OAAQA,MAAMC,IAAI;YAChB,KAAK,MAAA;AACH,gBAAA,OAAOD,MAAME,KAAK;YACpB,KAAK,OAAA;AACH,gBAAA,OAAO,CAAC,CAAC,EAAEF,MAAMG,IAAI,CAAC,CAAC,CAAC;YAC1B,KAAK,UAAA;AACH,gBAAA,OAAO,CAAC,CAAC,EAAEH,MAAMG,IAAI,CAAC,CAAC,CAAC;YAC1B,KAAK,OAAA;;AAEH,gBAAA,OAAO,CAAC,CAAC,EAAET,sBAAAA,CAAuBM,KAAAA,CAAMJ,MAAM,CAACG,GAAG,CAAC,CAACK,IAAMA,CAAAA,CAAAA,CAAgCC,IAAI,CAAC,EAAA,CAAA,CAAA,CAAK,CAAC,CAAC;AACxG,YAAA;gBACE,MAAM,IAAIC,MAAM,CAAC,oBAAoB,EAAE,KAACN,CAAcC,IAAI,CAAA,CAAE,CAAA;AAChE;AACF,IAAA,CAAA,CAAA,CACCI,IAAI,CAAC,EAAA,CAAA;AACV,CAAA;AAEA;;;;;;IAOA,MAAME,gBAAgB,CAACZ,SAAAA,GAAAA;AACrB,IAAA,MAAM,EAAEC,MAAM,EAAE,GAAGC,uBAAAA,CAAaC,KAAK,CAACH,SAAAA,CAAAA;AAEtC,IAAA,OAAOC,MAAAA,CAAOY,MAAM,CAAC,CAACC,GAAAA,EAAKC,KAAAA,GAAAA;;QAEzB,IAAIA,KAAAA,CAAMT,IAAI,KAAK,OAAA,EAAS;YAC1B,OAAOQ,GAAAA;AACT,QAAA;AAEAA,QAAAA,GAAAA,CAAIE,IAAI,CAAC;YACPR,IAAAA,EAAM,CAAA,EAAGO,KAAAA,CAAMP,IAAI,CAAA,CAAE;YACrBS,EAAAA,EAAI,MAAA;YACJC,WAAAA,EAAa,EAAA;YACbC,UAAAA,EAAY,KAAA;YACZC,QAAAA,EAAU,IAAA;YACVC,MAAAA,EAAQ;AAAEf,gBAAAA,IAAAA,EAAMS,KAAAA,CAAMP,IAAI,KAAK,IAAA,GAAO,QAAA,GAAW;AAAS;AAC5D,SAAA,CAAA;QAEA,OAAOM,GAAAA;AACT,IAAA,CAAA,EAAG,EAAE,CAAA;AACP,CAAA;AAEA,MAAMQ,iBAAAA,GAAoB,CAACC,MAAAA,EAA4BC,KAAAA,GAAAA;;;IAGrD,IAAID,MAAAA,IAAU,CAACE,kBAAAA,CAAEC,GAAG,CAACF,KAAAA,CAAMG,MAAM,EAAE,QAAA,CAAA,EAAW;;AAE5C,QAAA,OAAOJ,MAAAA,CAAOK,MAAM,CAACJ,KAAAA,CAAMK,IAAI,CAAA;AACjC,IAAA;;AAGA,IAAA,OAAOL,MAAMK,IAAI;AACnB,CAAA;AAEA;;;;;;;;;IAUA,MAAMC,QAAAA,GAAW,CAAC,EAAEC,SAAS,EAAEC,UAAU,EAAEC,eAAe,EAAEC,IAAI,EAAW,GAAA;;AAEzE,IAAA,MAAMC,oBAAoBJ,SAAAA,CAAUK,MAAM,CAACC,MAAM,CAAC,CAACb,KAAAA,GAAAA;AACjD,QAAA,OACEA,KAAAA,CAAMK,IAAI,CAACS,QAAQ,CAACL,eAAAA,CAAgBM,UAAU,CAAA,IAC9Cf,KAAAA,CAAMK,IAAI,CAACS,QAAQ,CAACL,gBAAgBO,YAAY,CAAA;AAEpD,IAAA,CAAA,CAAA;AAEA,IAAA,MAAMC,KAAAA,GAAQN,iBAAAA,CAAkBtB,MAAM,CAAC,CAACC,GAAAA,EAAUU,KAAAA,GAAAA;;QAEhD,MAAMkB,gBAAAA,GAAmBC,oBAAAA,CAAcnB,KAAAA,CAAMoB,OAAO,CAAA;AACpD,QAAA,MAAMC,UAAAA,GAAarB,KAAAA,CAAMsB,MAAM,CAACC,WAAW,EAAA;AAC3C,QAAA,MAAMC,aAAAA,GAAgBxB,KAAAA,CAAMK,IAAI,CAACS,QAAQ,CAAC,IAAA,CAAA;AAC1C,QAAA,MAAMW,cAAAA,GAAiB3B,iBAAAA,CAAkBS,SAAAA,CAAUR,MAAM,EAAEC,KAAAA,CAAAA;QAC3D,MAAMxB,SAAAA,GAAYgD,aAAAA,GAAgBjD,sBAAAA,CAAuBkD,cAAAA,CAAAA,GAAkBA,cAAAA;AAE3E,QAAA,MAAMC,YAAYC,eAAAA,CAAgB;AAChCnB,YAAAA,UAAAA;AACAR,YAAAA,KAAAA;AACAkB,YAAAA,gBAAAA,EAAkBR,SAAS,YAAA,IAAgBQ;AAC7C,SAAA,CAAA;AAEA,QAAA,MAAMU,aAAAA,GAA2C;AAC/CF,YAAAA,SAAAA;YACAG,IAAAA,EAAM;AAAC5B,gBAAAA,kBAAAA,CAAE6B,UAAU,CAACtB,UAAAA;AAAY,aAAA;AAChCuB,YAAAA,UAAAA,EAAY,EAAE;YACdC,WAAAA,EAAa,CAAA,EAAGX,aAAa7C,SAAAA,CAAAA;AAC/B,SAAA;AAEA,QAAA,IAAI0C,gBAAAA,EAAkB;YACpBU,aAAAA,CAAcG,UAAU,EAAEvC,IAAAA,CAAAA,GAAQyC,WAAAA,CAAAA;AACpC,QAAA;AAEA,QAAA,IAAIT,aAAAA,EAAe;YACjB,MAAMU,UAAAA,GAAa9C,aAAAA,CAAcY,KAAAA,CAAMK,IAAI,CAAA;YAC3CuB,aAAAA,CAAcG,UAAU,EAAEvC,IAAAA,CAAAA,GAAQ0C,UAAAA,CAAAA;AACpC,QAAA;QAEA,IAAI;AAAC,YAAA,MAAA;AAAQ,YAAA;SAAM,CAACpB,QAAQ,CAACO,UAAAA,CAAAA,EAAa;AACxC,YAAA,MAAMc,OAAAA,GAAU,SAAA;AAChB,YAAA,MAAMC,WAAAA,GAAc;gBAClBxC,QAAAA,EAAU,IAAA;gBACVyC,OAAAA,EAAS;oBACP,kBAAA,EAAoB;wBAClBxC,MAAAA,EAAQ;AACNyC,4BAAAA,IAAAA,EAAM,CAAC,qBAAqB,EAAEC,UAAAA,CAAW/B,cAAc2B,OAAAA,CAAAA;AACzD;AACF;AACF;AACF,aAAA;AAEAP,YAAAA,aAAAA,CAAcQ,WAAW,GAAGA,WAAAA;AAC9B,QAAA;QAEAnC,kBAAAA,CAAEuC,GAAG,CAAClD,GAAAA,EAAK,CAAA,EAAGd,UAAU,CAAC,EAAE6C,YAAY,EAAEO,aAAAA,CAAAA;QAEzC,OAAOtC,GAAAA;AACT,IAAA,CAAA,EAAG,EAAC,CAAA;IAEJ,OAAO2B,KAAAA;AACT,CAAA;AAEA;;IAGA,MAAMwB,uBAAuB,CAACC,GAAAA,GAAAA;;;;AAI5B,IAAA,OAAOC,qBAAqBD,GAAAA,EAAKpC,QAAAA,CAAAA;AACnC;;;;"}

package/dist/server/services/helpers/build-api-endpoint-path.mjs

@@ -0,0 +1,141 @@
+import _ from 'lodash';
+import * as pathToRegexp from 'path-to-regexp';
+import pascalCase from './utils/pascal-case.mjs';
+import params from './utils/query-params.mjs';
+import loopContentTypeNames from './utils/loop-content-type-names.mjs';
+import getApiResponse from './utils/get-api-responses.mjs';
+import { hasFindMethod } from './utils/routes.mjs';
+
+/**
+ * @description Parses a route with ':variable'
+ *
+ * @param {string} routePath - The route's path property
+ * @returns {string}
+ */ const parsePathWithVariables = (routePath)=>{
+    const { tokens } = pathToRegexp.parse(routePath);
+    return tokens.map((token)=>{
+        switch(token.type){
+            case 'text':
+                return token.value;
+            case 'param':
+                return `{${token.name}}`;
+            case 'wildcard':
+                return `{${token.name}}`;
+            case 'group':
+                // Handle group tokens by mapping them within the same function context
+                return `(${parsePathWithVariables(token.tokens.map((t)=>t).join(''))})`;
+            default:
+                throw new Error(`Unknown token type: ${token.type}`);
+        }
+    }).join('');
+};
+/**
+ * @description Builds the required object for a path parameter
+ *
+ * @param {string} routePath - The route's path property
+ *
+ * @returns {object } Swagger path params object
+ */ const getPathParams = (routePath)=>{
+    const { tokens } = pathToRegexp.parse(routePath);
+    return tokens.reduce((acc, param)=>{
+        // Skip non-parameter tokens
+        if (param.type !== 'param') {
+            return acc;
+        }
+        acc.push({
+            name: `${param.name}`,
+            in: 'path',
+            description: '',
+            deprecated: false,
+            required: true,
+            schema: {
+                type: param.name === 'id' ? 'string' : 'number'
+            }
+        });
+        return acc;
+    }, []);
+};
+const getPathWithPrefix = (prefix, route)=>{
+    // When the prefix is set on the routes and
+    // the current route is not trying to remove it
+    if (prefix && !_.has(route.config, 'prefix')) {
+        // Add the prefix to the path
+        return prefix.concat(route.path);
+    }
+    // Otherwise just return path
+    return route.path;
+};
+/**
+ * @description Gets all paths based on routes
+ *
+ * @param {object} apiInfo
+ * @property {object} apiInfo.routeInfo - The api routes object
+ * @property {string} apiInfo.uniqueName - Content type name | Api name + Content type name
+ * @property {object} apiInfo.contentTypeInfo - The info object found on content type schemas
+ *
+ * @returns {object}
+ */ const getPaths = ({ routeInfo, uniqueName, contentTypeInfo, kind })=>{
+    // Get the routes for the current content type
+    const contentTypeRoutes = routeInfo.routes.filter((route)=>{
+        return route.path.includes(contentTypeInfo.pluralName) || route.path.includes(contentTypeInfo.singularName);
+    });
+    const paths = contentTypeRoutes.reduce((acc, route)=>{
+        // TODO: Find a more reliable way to determine list of entities vs a single entity
+        const isListOfEntities = hasFindMethod(route.handler);
+        const methodVerb = route.method.toLowerCase();
+        const hasPathParams = route.path.includes('/:');
+        const pathWithPrefix = getPathWithPrefix(routeInfo.prefix, route);
+        const routePath = hasPathParams ? parsePathWithVariables(pathWithPrefix) : pathWithPrefix;
+        const responses = getApiResponse({
+            uniqueName,
+            route,
+            isListOfEntities: kind !== 'singleType' && isListOfEntities
+        });
+        const swaggerConfig = {
+            responses,
+            tags: [
+                _.upperFirst(uniqueName)
+            ],
+            parameters: [],
+            operationId: `${methodVerb}${routePath}`
+        };
+        if (isListOfEntities) {
+            swaggerConfig.parameters?.push(...params);
+        }
+        if (hasPathParams) {
+            const pathParams = getPathParams(route.path);
+            swaggerConfig.parameters?.push(...pathParams);
+        }
+        if ([
+            'post',
+            'put'
+        ].includes(methodVerb)) {
+            const refName = 'Request';
+            const requestBody = {
+                required: true,
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: `#/components/schemas/${pascalCase(uniqueName)}${refName}`
+                        }
+                    }
+                }
+            };
+            swaggerConfig.requestBody = requestBody;
+        }
+        _.set(acc, `${routePath}.${methodVerb}`, swaggerConfig);
+        return acc;
+    }, {});
+    return paths;
+};
+/**
+ * @description - Builds the Swagger paths object for each api
+ */ const buildApiEndpointPath = (api)=>{
+    // A reusable loop for building paths and component schemas
+    // Uses the api param to build a new set of params for each content type
+    // Passes these new params to the function provided
+    return loopContentTypeNames(api, getPaths);
+};
+
+export { buildApiEndpointPath as default };
+//# sourceMappingURL=build-api-endpoint-path.mjs.map

package/dist/server/services/helpers/build-api-endpoint-path.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-api-endpoint-path.mjs","sources":["../../../../server/src/services/helpers/build-api-endpoint-path.ts"],"sourcesContent":["import _ from 'lodash';\nimport * as pathToRegexp from 'path-to-regexp';\n\nimport type { Core } from '@strapi/types';\nimport type { OpenAPIV3 } from 'openapi-types';\n\nimport pascalCase from './utils/pascal-case';\nimport queryParams from './utils/query-params';\nimport loopContentTypeNames from './utils/loop-content-type-names';\nimport getApiResponses from './utils/get-api-responses';\nimport { hasFindMethod } from './utils/routes';\n\nimport type { Api, ApiInfo } from '../../types';\n\n/**\n * @description Parses a route with ':variable'\n *\n * @param {string} routePath - The route's path property\n * @returns {string}\n */\nconst parsePathWithVariables = (routePath: string): string => {\n  const { tokens } = pathToRegexp.parse(routePath);\n\n  return tokens\n    .map((token) => {\n      switch (token.type) {\n        case 'text':\n          return token.value;\n        case 'param':\n          return `{${token.name}}`;\n        case 'wildcard':\n          return `{${token.name}}`;\n        case 'group':\n          // Handle group tokens by mapping them within the same function context\n          return `(${parsePathWithVariables(token.tokens.map((t) => t satisfies pathToRegexp.Token).join(''))})`;\n        default:\n          throw new Error(`Unknown token type: ${(token as any).type}`);\n      }\n    })\n    .join('');\n};\n\n/**\n * @description Builds the required object for a path parameter\n *\n * @param {string} routePath - The route's path property\n *\n * @returns {object } Swagger path params object\n */\nconst getPathParams = (routePath: string): OpenAPIV3.ParameterObject[] => {\n  const { tokens } = pathToRegexp.parse(routePath);\n\n  return tokens.reduce((acc, param) => {\n    // Skip non-parameter tokens\n    if (param.type !== 'param') {\n      return acc;\n    }\n\n    acc.push({\n      name: `${param.name}`,\n      in: 'path',\n      description: '',\n      deprecated: false,\n      required: true,\n      schema: { type: param.name === 'id' ? 'string' : 'number' },\n    });\n\n    return acc;\n  }, [] as OpenAPIV3.ParameterObject[]);\n};\n\nconst getPathWithPrefix = (prefix: string | undefined, route: Core.Route) => {\n  // When the prefix is set on the routes and\n  // the current route is not trying to remove it\n  if (prefix && !_.has(route.config, 'prefix')) {\n    // Add the prefix to the path\n    return prefix.concat(route.path);\n  }\n\n  // Otherwise just return path\n  return route.path;\n};\n\n/**\n * @description Gets all paths based on routes\n *\n * @param {object} apiInfo\n * @property {object} apiInfo.routeInfo - The api routes object\n * @property {string} apiInfo.uniqueName - Content type name | Api name + Content type name\n * @property {object} apiInfo.contentTypeInfo - The info object found on content type schemas\n *\n * @returns {object}\n */\nconst getPaths = ({ routeInfo, uniqueName, contentTypeInfo, kind }: ApiInfo) => {\n  // Get the routes for the current content type\n  const contentTypeRoutes = routeInfo.routes.filter((route) => {\n    return (\n      route.path.includes(contentTypeInfo.pluralName) ||\n      route.path.includes(contentTypeInfo.singularName)\n    );\n  });\n\n  const paths = contentTypeRoutes.reduce((acc: any, route: Core.Route) => {\n    // TODO: Find a more reliable way to determine list of entities vs a single entity\n    const isListOfEntities = hasFindMethod(route.handler);\n    const methodVerb = route.method.toLowerCase();\n    const hasPathParams = route.path.includes('/:');\n    const pathWithPrefix = getPathWithPrefix(routeInfo.prefix, route);\n    const routePath = hasPathParams ? parsePathWithVariables(pathWithPrefix) : pathWithPrefix;\n\n    const responses = getApiResponses({\n      uniqueName,\n      route,\n      isListOfEntities: kind !== 'singleType' && isListOfEntities,\n    });\n\n    const swaggerConfig: OpenAPIV3.OperationObject = {\n      responses,\n      tags: [_.upperFirst(uniqueName)],\n      parameters: [],\n      operationId: `${methodVerb}${routePath}`,\n    };\n\n    if (isListOfEntities) {\n      swaggerConfig.parameters?.push(...queryParams);\n    }\n\n    if (hasPathParams) {\n      const pathParams = getPathParams(route.path);\n      swaggerConfig.parameters?.push(...pathParams);\n    }\n\n    if (['post', 'put'].includes(methodVerb)) {\n      const refName = 'Request';\n      const requestBody = {\n        required: true,\n        content: {\n          'application/json': {\n            schema: {\n              $ref: `#/components/schemas/${pascalCase(uniqueName)}${refName}`,\n            },\n          },\n        },\n      };\n\n      swaggerConfig.requestBody = requestBody;\n    }\n\n    _.set(acc, `${routePath}.${methodVerb}`, swaggerConfig);\n\n    return acc;\n  }, {});\n\n  return paths;\n};\n\n/**\n * @description - Builds the Swagger paths object for each api\n */\nconst buildApiEndpointPath = (api: Api) => {\n  // A reusable loop for building paths and component schemas\n  // Uses the api param to build a new set of params for each content type\n  // Passes these new params to the function provided\n  return loopContentTypeNames(api, getPaths);\n};\n\nexport default buildApiEndpointPath;\n"],"names":["parsePathWithVariables","routePath","tokens","pathToRegexp","parse","map","token","type","value","name","t","join","Error","getPathParams","reduce","acc","param","push","in","description","deprecated","required","schema","getPathWithPrefix","prefix","route","_","has","config","concat","path","getPaths","routeInfo","uniqueName","contentTypeInfo","kind","contentTypeRoutes","routes","filter","includes","pluralName","singularName","paths","isListOfEntities","hasFindMethod","handler","methodVerb","method","toLowerCase","hasPathParams","pathWithPrefix","responses","getApiResponses","swaggerConfig","tags","upperFirst","parameters","operationId","queryParams","pathParams","refName","requestBody","content","$ref","pascalCase","set","buildApiEndpointPath","api","loopContentTypeNames"],"mappings":";;;;;;;;AAcA;;;;;IAMA,MAAMA,yBAAyB,CAACC,SAAAA,GAAAA;AAC9B,IAAA,MAAM,EAAEC,MAAM,EAAE,GAAGC,YAAAA,CAAaC,KAAK,CAACH,SAAAA,CAAAA;IAEtC,OAAOC,MAAAA,CACJG,GAAG,CAAC,CAACC,KAAAA,GAAAA;AACJ,QAAA,OAAQA,MAAMC,IAAI;YAChB,KAAK,MAAA;AACH,gBAAA,OAAOD,MAAME,KAAK;YACpB,KAAK,OAAA;AACH,gBAAA,OAAO,CAAC,CAAC,EAAEF,MAAMG,IAAI,CAAC,CAAC,CAAC;YAC1B,KAAK,UAAA;AACH,gBAAA,OAAO,CAAC,CAAC,EAAEH,MAAMG,IAAI,CAAC,CAAC,CAAC;YAC1B,KAAK,OAAA;;AAEH,gBAAA,OAAO,CAAC,CAAC,EAAET,sBAAAA,CAAuBM,KAAAA,CAAMJ,MAAM,CAACG,GAAG,CAAC,CAACK,IAAMA,CAAAA,CAAAA,CAAgCC,IAAI,CAAC,EAAA,CAAA,CAAA,CAAK,CAAC,CAAC;AACxG,YAAA;gBACE,MAAM,IAAIC,MAAM,CAAC,oBAAoB,EAAE,KAACN,CAAcC,IAAI,CAAA,CAAE,CAAA;AAChE;AACF,IAAA,CAAA,CAAA,CACCI,IAAI,CAAC,EAAA,CAAA;AACV,CAAA;AAEA;;;;;;IAOA,MAAME,gBAAgB,CAACZ,SAAAA,GAAAA;AACrB,IAAA,MAAM,EAAEC,MAAM,EAAE,GAAGC,YAAAA,CAAaC,KAAK,CAACH,SAAAA,CAAAA;AAEtC,IAAA,OAAOC,MAAAA,CAAOY,MAAM,CAAC,CAACC,GAAAA,EAAKC,KAAAA,GAAAA;;QAEzB,IAAIA,KAAAA,CAAMT,IAAI,KAAK,OAAA,EAAS;YAC1B,OAAOQ,GAAAA;AACT,QAAA;AAEAA,QAAAA,GAAAA,CAAIE,IAAI,CAAC;YACPR,IAAAA,EAAM,CAAA,EAAGO,KAAAA,CAAMP,IAAI,CAAA,CAAE;YACrBS,EAAAA,EAAI,MAAA;YACJC,WAAAA,EAAa,EAAA;YACbC,UAAAA,EAAY,KAAA;YACZC,QAAAA,EAAU,IAAA;YACVC,MAAAA,EAAQ;AAAEf,gBAAAA,IAAAA,EAAMS,KAAAA,CAAMP,IAAI,KAAK,IAAA,GAAO,QAAA,GAAW;AAAS;AAC5D,SAAA,CAAA;QAEA,OAAOM,GAAAA;AACT,IAAA,CAAA,EAAG,EAAE,CAAA;AACP,CAAA;AAEA,MAAMQ,iBAAAA,GAAoB,CAACC,MAAAA,EAA4BC,KAAAA,GAAAA;;;IAGrD,IAAID,MAAAA,IAAU,CAACE,CAAAA,CAAEC,GAAG,CAACF,KAAAA,CAAMG,MAAM,EAAE,QAAA,CAAA,EAAW;;AAE5C,QAAA,OAAOJ,MAAAA,CAAOK,MAAM,CAACJ,KAAAA,CAAMK,IAAI,CAAA;AACjC,IAAA;;AAGA,IAAA,OAAOL,MAAMK,IAAI;AACnB,CAAA;AAEA;;;;;;;;;IAUA,MAAMC,QAAAA,GAAW,CAAC,EAAEC,SAAS,EAAEC,UAAU,EAAEC,eAAe,EAAEC,IAAI,EAAW,GAAA;;AAEzE,IAAA,MAAMC,oBAAoBJ,SAAAA,CAAUK,MAAM,CAACC,MAAM,CAAC,CAACb,KAAAA,GAAAA;AACjD,QAAA,OACEA,KAAAA,CAAMK,IAAI,CAACS,QAAQ,CAACL,eAAAA,CAAgBM,UAAU,CAAA,IAC9Cf,KAAAA,CAAMK,IAAI,CAACS,QAAQ,CAACL,gBAAgBO,YAAY,CAAA;AAEpD,IAAA,CAAA,CAAA;AAEA,IAAA,MAAMC,KAAAA,GAAQN,iBAAAA,CAAkBtB,MAAM,CAAC,CAACC,GAAAA,EAAUU,KAAAA,GAAAA;;QAEhD,MAAMkB,gBAAAA,GAAmBC,aAAAA,CAAcnB,KAAAA,CAAMoB,OAAO,CAAA;AACpD,QAAA,MAAMC,UAAAA,GAAarB,KAAAA,CAAMsB,MAAM,CAACC,WAAW,EAAA;AAC3C,QAAA,MAAMC,aAAAA,GAAgBxB,KAAAA,CAAMK,IAAI,CAACS,QAAQ,CAAC,IAAA,CAAA;AAC1C,QAAA,MAAMW,cAAAA,GAAiB3B,iBAAAA,CAAkBS,SAAAA,CAAUR,MAAM,EAAEC,KAAAA,CAAAA;QAC3D,MAAMxB,SAAAA,GAAYgD,aAAAA,GAAgBjD,sBAAAA,CAAuBkD,cAAAA,CAAAA,GAAkBA,cAAAA;AAE3E,QAAA,MAAMC,YAAYC,cAAAA,CAAgB;AAChCnB,YAAAA,UAAAA;AACAR,YAAAA,KAAAA;AACAkB,YAAAA,gBAAAA,EAAkBR,SAAS,YAAA,IAAgBQ;AAC7C,SAAA,CAAA;AAEA,QAAA,MAAMU,aAAAA,GAA2C;AAC/CF,YAAAA,SAAAA;YACAG,IAAAA,EAAM;AAAC5B,gBAAAA,CAAAA,CAAE6B,UAAU,CAACtB,UAAAA;AAAY,aAAA;AAChCuB,YAAAA,UAAAA,EAAY,EAAE;YACdC,WAAAA,EAAa,CAAA,EAAGX,aAAa7C,SAAAA,CAAAA;AAC/B,SAAA;AAEA,QAAA,IAAI0C,gBAAAA,EAAkB;YACpBU,aAAAA,CAAcG,UAAU,EAAEvC,IAAAA,CAAAA,GAAQyC,MAAAA,CAAAA;AACpC,QAAA;AAEA,QAAA,IAAIT,aAAAA,EAAe;YACjB,MAAMU,UAAAA,GAAa9C,aAAAA,CAAcY,KAAAA,CAAMK,IAAI,CAAA;YAC3CuB,aAAAA,CAAcG,UAAU,EAAEvC,IAAAA,CAAAA,GAAQ0C,UAAAA,CAAAA;AACpC,QAAA;QAEA,IAAI;AAAC,YAAA,MAAA;AAAQ,YAAA;SAAM,CAACpB,QAAQ,CAACO,UAAAA,CAAAA,EAAa;AACxC,YAAA,MAAMc,OAAAA,GAAU,SAAA;AAChB,YAAA,MAAMC,WAAAA,GAAc;gBAClBxC,QAAAA,EAAU,IAAA;gBACVyC,OAAAA,EAAS;oBACP,kBAAA,EAAoB;wBAClBxC,MAAAA,EAAQ;AACNyC,4BAAAA,IAAAA,EAAM,CAAC,qBAAqB,EAAEC,UAAAA,CAAW/B,cAAc2B,OAAAA,CAAAA;AACzD;AACF;AACF;AACF,aAAA;AAEAP,YAAAA,aAAAA,CAAcQ,WAAW,GAAGA,WAAAA;AAC9B,QAAA;QAEAnC,CAAAA,CAAEuC,GAAG,CAAClD,GAAAA,EAAK,CAAA,EAAGd,UAAU,CAAC,EAAE6C,YAAY,EAAEO,aAAAA,CAAAA;QAEzC,OAAOtC,GAAAA;AACT,IAAA,CAAA,EAAG,EAAC,CAAA;IAEJ,OAAO2B,KAAAA;AACT,CAAA;AAEA;;IAGA,MAAMwB,uBAAuB,CAACC,GAAAA,GAAAA;;;;AAI5B,IAAA,OAAOC,qBAAqBD,GAAAA,EAAKpC,QAAAA,CAAAA;AACnC;;;;"}

package/dist/server/services/helpers/build-component-schema.js

@@ -0,0 +1,178 @@
+'use strict';
+
+var _ = require('lodash');
+var cleanSchemaAttributes = require('./utils/clean-schema-attributes.js');
+var loopContentTypeNames = require('./utils/loop-content-type-names.js');
+var pascalCase = require('./utils/pascal-case.js');
+var routes = require('./utils/routes.js');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var ___default = /*#__PURE__*/_interopDefault(_);
+
+const getRequiredAttributes = (allAttributes)=>{
+    const requiredAttributes = [];
+    for(const key in allAttributes){
+        if (allAttributes[key].required) {
+            requiredAttributes.push(key);
+        }
+    }
+    return requiredAttributes;
+};
+/**
+ * @description Get all open api schema objects for a given content type
+ *
+ * @param {object} apiInfo
+ * @property {string} apiInfo.uniqueName - Api name | Api name + Content type name
+ * @property {object} apiInfo.attributes - Attributes on content type
+ * @property {object} apiInfo.routeInfo - The routes for the api
+ *
+ * @returns {object} Open API schemas
+ */ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName })=>{
+    // Store response and request schemas in an object
+    let strapiComponentSchemas = {};
+    const schemas = {};
+    const typeName = pascalCase(uniqueName);
+    // adds a ComponentSchema to the Schemas so it can be used as Ref
+    const didAddStrapiComponentsToSchemas = (schemaName, schema)=>{
+        if (!Object.keys(schema) || !Object.keys(schema.properties)) return false;
+        // Add the Strapi components to the schema
+        strapiComponentSchemas = {
+            ...strapiComponentSchemas,
+            [schemaName]: schema
+        };
+        return true;
+    };
+    // Get all the route methods
+    const routeMethods = routeInfo.routes.map((route)=>route.method);
+    const attributesToOmit = [
+        'createdAt',
+        'updatedAt',
+        'publishedAt',
+        'publishedBy',
+        'updatedBy',
+        'createdBy'
+    ];
+    const attributesForRequest = ___default.default.omit(attributes, attributesToOmit);
+    // Get a list of required attribute names
+    const requiredRequestAttributes = getRequiredAttributes(attributesForRequest);
+    // Build the request schemas when the route has POST or PUT methods
+    if (routeMethods.includes('POST') || routeMethods.includes('PUT')) {
+        // Build localization requests schemas
+        // Build the request schema
+        Object.assign(schemas, {
+            [`${typeName}Request`]: {
+                type: 'object',
+                required: [
+                    'data'
+                ],
+                properties: {
+                    data: {
+                        ...requiredRequestAttributes.length && {
+                            required: requiredRequestAttributes
+                        },
+                        type: 'object',
+                        properties: cleanSchemaAttributes(attributesForRequest, {
+                            isRequest: true,
+                            didAddStrapiComponentsToSchemas
+                        })
+                    }
+                }
+            }
+        });
+    }
+    // Check for routes that need to return a list
+    const hasListOfEntities = routeInfo.routes.filter((route)=>routes.hasFindMethod(route.handler)).length;
+    if (hasListOfEntities) {
+        // Build the list response schema
+        Object.assign(schemas, {
+            [`${typeName}ListResponse`]: {
+                type: 'object',
+                properties: {
+                    data: {
+                        type: 'array',
+                        items: {
+                            $ref: `#/components/schemas/${typeName}`
+                        }
+                    },
+                    meta: {
+                        type: 'object',
+                        properties: {
+                            pagination: {
+                                type: 'object',
+                                properties: {
+                                    page: {
+                                        type: 'integer'
+                                    },
+                                    pageSize: {
+                                        type: 'integer',
+                                        minimum: 25
+                                    },
+                                    pageCount: {
+                                        type: 'integer',
+                                        maximum: 1
+                                    },
+                                    total: {
+                                        type: 'integer'
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        });
+    }
+    const requiredAttributes = getRequiredAttributes(attributes);
+    // Build the response schema
+    Object.assign(schemas, {
+        [`${typeName}`]: {
+            type: 'object',
+            ...requiredAttributes.length && {
+                required: requiredAttributes
+            },
+            properties: {
+                id: {
+                    oneOf: [
+                        {
+                            type: 'string'
+                        },
+                        {
+                            type: 'number'
+                        }
+                    ]
+                },
+                documentId: {
+                    type: 'string'
+                },
+                ...cleanSchemaAttributes(attributes, {
+                    didAddStrapiComponentsToSchemas
+                })
+            }
+        },
+        [`${typeName}Response`]: {
+            type: 'object',
+            properties: {
+                data: {
+                    $ref: `#/components/schemas/${typeName}`
+                },
+                meta: {
+                    type: 'object'
+                }
+            }
+        }
+    });
+    return {
+        ...schemas,
+        ...strapiComponentSchemas
+    };
+};
+const buildComponentSchema = (api)=>{
+    // A reusable loop for building paths and component schemas
+    // Uses the api param to build a new set of params for each content type
+    // Passes these new params to the function provided
+    return loopContentTypeNames(api, getAllSchemasForContentType);
+};
+
+module.exports = buildComponentSchema;
+//# sourceMappingURL=build-component-schema.js.map

package/dist/server/services/helpers/build-component-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-component-schema.js","sources":["../../../../server/src/services/helpers/build-component-schema.ts"],"sourcesContent":["import _ from 'lodash';\n\nimport type { OpenAPIV3 } from 'openapi-types';\nimport type { Core, Struct } from '@strapi/types';\n\nimport cleanSchemaAttributes from './utils/clean-schema-attributes';\nimport loopContentTypeNames from './utils/loop-content-type-names';\nimport pascalCase from './utils/pascal-case';\nimport { hasFindMethod } from './utils/routes';\n\nimport type { Api, ApiInfo } from '../../types';\n\nconst getRequiredAttributes = (allAttributes: Struct.SchemaAttributes) => {\n  const requiredAttributes: string[] = [];\n\n  for (const key in allAttributes) {\n    if (allAttributes[key].required) {\n      requiredAttributes.push(key);\n    }\n  }\n\n  return requiredAttributes;\n};\n\n/**\n * @description Get all open api schema objects for a given content type\n *\n * @param {object} apiInfo\n * @property {string} apiInfo.uniqueName - Api name | Api name + Content type name\n * @property {object} apiInfo.attributes - Attributes on content type\n * @property {object} apiInfo.routeInfo - The routes for the api\n *\n * @returns {object} Open API schemas\n */\nconst getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }: ApiInfo) => {\n  // Store response and request schemas in an object\n  let strapiComponentSchemas = {};\n  const schemas: OpenAPIV3.ComponentsObject = {};\n  const typeName = pascalCase(uniqueName);\n\n  // adds a ComponentSchema to the Schemas so it can be used as Ref\n  const didAddStrapiComponentsToSchemas = (schemaName: string, schema: OpenAPIV3.SchemaObject) => {\n    if (!Object.keys(schema) || !Object.keys(schema.properties!)) return false;\n\n    // Add the Strapi components to the schema\n    strapiComponentSchemas = {\n      ...strapiComponentSchemas,\n      [schemaName]: schema,\n    };\n\n    return true;\n  };\n\n  // Get all the route methods\n  const routeMethods = routeInfo.routes.map((route: Core.Route) => route.method);\n\n  const attributesToOmit = [\n    'createdAt',\n    'updatedAt',\n    'publishedAt',\n    'publishedBy',\n    'updatedBy',\n    'createdBy',\n  ];\n\n  const attributesForRequest = _.omit(attributes, attributesToOmit);\n  // Get a list of required attribute names\n  const requiredRequestAttributes = getRequiredAttributes(attributesForRequest);\n  // Build the request schemas when the route has POST or PUT methods\n  if (routeMethods.includes('POST') || routeMethods.includes('PUT')) {\n    // Build localization requests schemas\n\n    // Build the request schema\n    Object.assign(schemas, {\n      [`${typeName}Request`]: {\n        type: 'object',\n        required: ['data'],\n        properties: {\n          data: {\n            ...(requiredRequestAttributes.length && { required: requiredRequestAttributes }),\n            type: 'object',\n            properties: cleanSchemaAttributes(attributesForRequest, {\n              isRequest: true,\n              didAddStrapiComponentsToSchemas,\n            }),\n          },\n        },\n      },\n    });\n  }\n\n  // Check for routes that need to return a list\n  const hasListOfEntities = routeInfo.routes.filter((route: Core.Route) =>\n    hasFindMethod(route.handler)\n  ).length;\n\n  if (hasListOfEntities) {\n    // Build the list response schema\n    Object.assign(schemas, {\n      [`${typeName}ListResponse`]: {\n        type: 'object',\n        properties: {\n          data: {\n            type: 'array',\n            items: {\n              $ref: `#/components/schemas/${typeName}`,\n            },\n          },\n          meta: {\n            type: 'object',\n            properties: {\n              pagination: {\n                type: 'object',\n                properties: {\n                  page: { type: 'integer' },\n                  pageSize: { type: 'integer', minimum: 25 },\n                  pageCount: { type: 'integer', maximum: 1 },\n                  total: { type: 'integer' },\n                },\n              },\n            },\n          },\n        },\n      },\n    });\n  }\n\n  const requiredAttributes = getRequiredAttributes(attributes);\n  // Build the response schema\n  Object.assign(schemas, {\n    [`${typeName}`]: {\n      type: 'object',\n      ...(requiredAttributes.length && { required: requiredAttributes }),\n      properties: {\n        id: { oneOf: [{ type: 'string' }, { type: 'number' }] },\n        documentId: { type: 'string' },\n        ...cleanSchemaAttributes(attributes, { didAddStrapiComponentsToSchemas }),\n      },\n    },\n\n    [`${typeName}Response`]: {\n      type: 'object',\n      properties: {\n        data: {\n          $ref: `#/components/schemas/${typeName}`,\n        },\n        meta: { type: 'object' },\n      },\n    },\n  });\n\n  return { ...schemas, ...strapiComponentSchemas };\n};\n\nconst buildComponentSchema = (api: Api) => {\n  // A reusable loop for building paths and component schemas\n  // Uses the api param to build a new set of params for each content type\n  // Passes these new params to the function provided\n  return loopContentTypeNames(api, getAllSchemasForContentType);\n};\n\nexport default buildComponentSchema;\n"],"names":["getRequiredAttributes","allAttributes","requiredAttributes","key","required","push","getAllSchemasForContentType","routeInfo","attributes","uniqueName","strapiComponentSchemas","schemas","typeName","pascalCase","didAddStrapiComponentsToSchemas","schemaName","schema","Object","keys","properties","routeMethods","routes","map","route","method","attributesToOmit","attributesForRequest","_","omit","requiredRequestAttributes","includes","assign","type","data","length","cleanSchemaAttributes","isRequest","hasListOfEntities","filter","hasFindMethod","handler","items","$ref","meta","pagination","page","pageSize","minimum","pageCount","maximum","total","id","oneOf","documentId","buildComponentSchema","api","loopContentTypeNames"],"mappings":";;;;;;;;;;;;AAYA,MAAMA,wBAAwB,CAACC,aAAAA,GAAAA;AAC7B,IAAA,MAAMC,qBAA+B,EAAE;IAEvC,IAAK,MAAMC,OAAOF,aAAAA,CAAe;AAC/B,QAAA,IAAIA,aAAa,CAACE,GAAAA,CAAI,CAACC,QAAQ,EAAE;AAC/BF,YAAAA,kBAAAA,CAAmBG,IAAI,CAACF,GAAAA,CAAAA;AAC1B,QAAA;AACF,IAAA;IAEA,OAAOD,kBAAAA;AACT,CAAA;AAEA;;;;;;;;;IAUA,MAAMI,8BAA8B,CAAC,EAAEC,SAAS,EAAEC,UAAU,EAAEC,UAAU,EAAW,GAAA;;AAEjF,IAAA,IAAIC,yBAAyB,EAAC;AAC9B,IAAA,MAAMC,UAAsC,EAAC;AAC7C,IAAA,MAAMC,WAAWC,UAAAA,CAAWJ,UAAAA,CAAAA;;IAG5B,MAAMK,+BAAAA,GAAkC,CAACC,UAAAA,EAAoBC,MAAAA,GAAAA;AAC3D,QAAA,IAAI,CAACC,MAAAA,CAAOC,IAAI,CAACF,MAAAA,CAAAA,IAAW,CAACC,MAAAA,CAAOC,IAAI,CAACF,MAAAA,CAAOG,UAAU,CAAA,EAAI,OAAO,KAAA;;QAGrET,sBAAAA,GAAyB;AACvB,YAAA,GAAGA,sBAAsB;AACzB,YAAA,CAACK,aAAaC;AAChB,SAAA;QAEA,OAAO,IAAA;AACT,IAAA,CAAA;;IAGA,MAAMI,YAAAA,GAAeb,UAAUc,MAAM,CAACC,GAAG,CAAC,CAACC,KAAAA,GAAsBA,KAAAA,CAAMC,MAAM,CAAA;AAE7E,IAAA,MAAMC,gBAAAA,GAAmB;AACvB,QAAA,WAAA;AACA,QAAA,WAAA;AACA,QAAA,aAAA;AACA,QAAA,aAAA;AACA,QAAA,WAAA;AACA,QAAA;AACD,KAAA;AAED,IAAA,MAAMC,oBAAAA,GAAuBC,kBAAAA,CAAEC,IAAI,CAACpB,UAAAA,EAAYiB,gBAAAA,CAAAA;;AAEhD,IAAA,MAAMI,4BAA4B7B,qBAAAA,CAAsB0B,oBAAAA,CAAAA;;AAExD,IAAA,IAAIN,aAAaU,QAAQ,CAAC,WAAWV,YAAAA,CAAaU,QAAQ,CAAC,KAAA,CAAA,EAAQ;;;QAIjEb,MAAAA,CAAOc,MAAM,CAACpB,OAAAA,EAAS;AACrB,YAAA,CAAC,CAAA,EAAGC,QAAAA,CAAS,OAAO,CAAC,GAAG;gBACtBoB,IAAAA,EAAM,QAAA;gBACN5B,QAAAA,EAAU;AAAC,oBAAA;AAAO,iBAAA;gBAClBe,UAAAA,EAAY;oBACVc,IAAAA,EAAM;wBACJ,GAAIJ,yBAAAA,CAA0BK,MAAM,IAAI;4BAAE9B,QAAAA,EAAUyB;yBAA2B;wBAC/EG,IAAAA,EAAM,QAAA;AACNb,wBAAAA,UAAAA,EAAYgB,sBAAsBT,oBAAAA,EAAsB;4BACtDU,SAAAA,EAAW,IAAA;AACXtB,4BAAAA;AACF,yBAAA;AACF;AACF;AACF;AACF,SAAA,CAAA;AACF,IAAA;;AAGA,IAAA,MAAMuB,iBAAAA,GAAoB9B,SAAAA,CAAUc,MAAM,CAACiB,MAAM,CAAC,CAACf,KAAAA,GACjDgB,oBAAAA,CAAchB,KAAAA,CAAMiB,OAAO,CAAA,CAAA,CAC3BN,MAAM;AAER,IAAA,IAAIG,iBAAAA,EAAmB;;QAErBpB,MAAAA,CAAOc,MAAM,CAACpB,OAAAA,EAAS;AACrB,YAAA,CAAC,CAAA,EAAGC,QAAAA,CAAS,YAAY,CAAC,GAAG;gBAC3BoB,IAAAA,EAAM,QAAA;gBACNb,UAAAA,EAAY;oBACVc,IAAAA,EAAM;wBACJD,IAAAA,EAAM,OAAA;wBACNS,KAAAA,EAAO;4BACLC,IAAAA,EAAM,CAAC,qBAAqB,EAAE9B,QAAAA,CAAAA;AAChC;AACF,qBAAA;oBACA+B,IAAAA,EAAM;wBACJX,IAAAA,EAAM,QAAA;wBACNb,UAAAA,EAAY;4BACVyB,UAAAA,EAAY;gCACVZ,IAAAA,EAAM,QAAA;gCACNb,UAAAA,EAAY;oCACV0B,IAAAA,EAAM;wCAAEb,IAAAA,EAAM;AAAU,qCAAA;oCACxBc,QAAAA,EAAU;wCAAEd,IAAAA,EAAM,SAAA;wCAAWe,OAAAA,EAAS;AAAG,qCAAA;oCACzCC,SAAAA,EAAW;wCAAEhB,IAAAA,EAAM,SAAA;wCAAWiB,OAAAA,EAAS;AAAE,qCAAA;oCACzCC,KAAAA,EAAO;wCAAElB,IAAAA,EAAM;AAAU;AAC3B;AACF;AACF;AACF;AACF;AACF;AACF,SAAA,CAAA;AACF,IAAA;AAEA,IAAA,MAAM9B,qBAAqBF,qBAAAA,CAAsBQ,UAAAA,CAAAA;;IAEjDS,MAAAA,CAAOc,MAAM,CAACpB,OAAAA,EAAS;QACrB,CAAC,CAAA,EAAGC,QAAAA,CAAAA,CAAU,GAAG;YACfoB,IAAAA,EAAM,QAAA;YACN,GAAI9B,kBAAAA,CAAmBgC,MAAM,IAAI;gBAAE9B,QAAAA,EAAUF;aAAoB;YACjEiB,UAAAA,EAAY;gBACVgC,EAAAA,EAAI;oBAAEC,KAAAA,EAAO;AAAC,wBAAA;4BAAEpB,IAAAA,EAAM;AAAS,yBAAA;AAAG,wBAAA;4BAAEA,IAAAA,EAAM;AAAS;AAAE;AAAC,iBAAA;gBACtDqB,UAAAA,EAAY;oBAAErB,IAAAA,EAAM;AAAS,iBAAA;AAC7B,gBAAA,GAAGG,sBAAsB3B,UAAAA,EAAY;AAAEM,oBAAAA;iBAAgC;AACzE;AACF,SAAA;AAEA,QAAA,CAAC,CAAA,EAAGF,QAAAA,CAAS,QAAQ,CAAC,GAAG;YACvBoB,IAAAA,EAAM,QAAA;YACNb,UAAAA,EAAY;gBACVc,IAAAA,EAAM;oBACJS,IAAAA,EAAM,CAAC,qBAAqB,EAAE9B,QAAAA,CAAAA;AAChC,iBAAA;gBACA+B,IAAAA,EAAM;oBAAEX,IAAAA,EAAM;AAAS;AACzB;AACF;AACF,KAAA,CAAA;IAEA,OAAO;AAAE,QAAA,GAAGrB,OAAO;AAAE,QAAA,GAAGD;AAAuB,KAAA;AACjD,CAAA;AAEA,MAAM4C,uBAAuB,CAACC,GAAAA,GAAAA;;;;AAI5B,IAAA,OAAOC,qBAAqBD,GAAAA,EAAKjD,2BAAAA,CAAAA;AACnC;;;;"}