@strapi/plugin-documentation 4.2.0-beta.1 → 4.2.0-beta.4

package/__mocks__/strapi.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const strapi = {
+  plugins: {
+    'users-permissions': {
+      contentTypes: {
+        role: {
+          attributes: {
+            name: {
+              type: 'string',
+            },
+          },
+        },
+      },
+      routes: {
+        'content-api': {
+          routes: [],
+        },
+      },
+    },
+  },
+  api: {
+    restaurant: {
+      contentTypes: {
+        restaurant: {
+          attributes: {
+            name: {
+              type: 'string',
+            },
+          },
+        },
+      },
+      routes: {
+        restaurant: { routes: [] },
+      },
+    },
+  },
+  contentType: () => ({ info: {}, attributes: { test: { type: 'string' } } }),
+};
+
+module.exports = strapi;

package/__tests__/build-component-schema.test.js

@@ -0,0 +1,271 @@
+'use strict';
+
+const _ = require('lodash');
+const buildComponentSchema = require('../server/services/helpers/build-component-schema');
+const strapi = require('../__mocks__/strapi');
+
+describe('Build Component Schema', () => {
+  beforeEach(() => {
+    // Reset the mocked strapi instance
+    global.strapi = _.cloneDeep(strapi);
+  });
+
+  it('builds the Response schema', () => {
+    const apiMocks = [
+      {
+        name: 'users-permissions',
+        getter: 'plugin',
+        ctNames: ['role'],
+      },
+      { name: 'restaurant', getter: 'api', ctNames: ['restaurant'] },
+    ];
+
+    let schemas = {};
+    for (const mock of apiMocks) {
+      schemas = {
+        ...schemas,
+        ...buildComponentSchema(mock),
+      };
+    }
+
+    const schemaNames = Object.keys(schemas);
+    const [pluginResponseName, apiResponseName] = Object.keys(schemas);
+    const [pluginResponseValue, apiResponseValue] = Object.values(schemas);
+
+    const expectedShape = {
+      type: 'object',
+      properties: {
+        data: {
+          type: 'object',
+          properties: {
+            id: { type: 'string' },
+            attributes: { type: 'object', properties: { test: { type: 'string' } } },
+          },
+        },
+        meta: { type: 'object' },
+      },
+    };
+
+    expect(schemaNames.length).toBe(2);
+    expect(pluginResponseName).toBe('UsersPermissionsRoleResponse');
+    expect(apiResponseName).toBe('RestaurantResponse');
+    expect(pluginResponseValue).toStrictEqual(expectedShape);
+    expect(apiResponseValue).toStrictEqual(expectedShape);
+  });
+
+  it('builds the ResponseList schema', () => {
+    global.strapi.plugins['users-permissions'].routes['content-api'].routes = [
+      { method: 'GET', path: '/test', handler: 'test.find' },
+    ];
+    global.strapi.api.restaurant.routes.restaurant.routes = [
+      { method: 'GET', path: '/test', handler: 'test.find' },
+    ];
+
+    const apiMocks = [
+      {
+        name: 'users-permissions',
+        getter: 'plugin',
+        ctNames: ['role'],
+      },
+      { name: 'restaurant', getter: 'api', ctNames: ['restaurant'] },
+    ];
+
+    let schemas = {};
+    for (const mock of apiMocks) {
+      schemas = {
+        ...schemas,
+        ...buildComponentSchema(mock),
+      };
+    }
+
+    const schemaNames = Object.keys(schemas);
+    const pluginListResponseValue = schemas['UsersPermissionsRoleListResponse'];
+    const apiListResponseValue = schemas['RestaurantListResponse'];
+
+    const expectedShape = {
+      type: 'object',
+      properties: {
+        data: {
+          type: 'array',
+          items: {
+            type: 'object',
+            properties: {
+              id: { type: 'string' },
+              attributes: { type: 'object', properties: { test: { type: 'string' } } },
+            },
+          },
+        },
+        meta: {
+          type: 'object',
+          properties: {
+            pagination: {
+              properties: {
+                page: { type: 'integer' },
+                pageSize: { type: 'integer', minimum: 25 },
+                pageCount: { type: 'integer', maximum: 1 },
+                total: { type: 'integer' },
+              },
+            },
+          },
+        },
+      },
+    };
+
+    expect(schemaNames.length).toBe(4);
+    expect(schemaNames.includes('UsersPermissionsRoleListResponse')).toBe(true);
+    expect(schemaNames.includes('RestaurantListResponse')).toBe(true);
+    expect(pluginListResponseValue).toStrictEqual(expectedShape);
+    expect(apiListResponseValue).toStrictEqual(expectedShape);
+  });
+
+  it('builds the Request schema', () => {
+    global.strapi.plugins['users-permissions'].routes['content-api'].routes = [
+      { method: 'POST', path: '/test', handler: 'test.create' },
+    ];
+    global.strapi.api.restaurant.routes.restaurant.routes = [
+      { method: 'POST', path: '/test', handler: 'test.create' },
+    ];
+
+    const apiMocks = [
+      {
+        name: 'users-permissions',
+        getter: 'plugin',
+        ctNames: ['role'],
+      },
+      { name: 'restaurant', getter: 'api', ctNames: ['restaurant'] },
+    ];
+
+    let schemas = {};
+    for (const mock of apiMocks) {
+      schemas = {
+        ...schemas,
+        ...buildComponentSchema(mock),
+      };
+    }
+
+    const schemaNames = Object.keys(schemas);
+    const pluginListResponseValue = schemas['UsersPermissionsRoleRequest'];
+    const apiListResponseValue = schemas['RestaurantRequest'];
+
+    const expectedShape = {
+      type: 'object',
+      required: ['data'],
+      properties: {
+        data: {
+          required: [],
+          type: 'object',
+          properties: { test: { type: 'string' } },
+        },
+      },
+    };
+
+    expect(schemaNames.length).toBe(4);
+    expect(schemaNames.includes('UsersPermissionsRoleRequest')).toBe(true);
+    expect(schemaNames.includes('RestaurantRequest')).toBe(true);
+    expect(pluginListResponseValue).toStrictEqual(expectedShape);
+    expect(apiListResponseValue).toStrictEqual(expectedShape);
+  });
+
+  it('builds the LocalizationResponse schema', () => {
+    global.strapi.plugins['users-permissions'].routes['content-api'].routes = [
+      { method: 'GET', path: '/localizations', handler: 'test' },
+    ];
+    global.strapi.api.restaurant.routes.restaurant.routes = [
+      { method: 'GET', path: '/localizations', handler: 'test' },
+    ];
+
+    const apiMocks = [
+      {
+        name: 'users-permissions',
+        getter: 'plugin',
+        ctNames: ['role'],
+      },
+      { name: 'restaurant', getter: 'api', ctNames: ['restaurant'] },
+    ];
+
+    let schemas = {};
+    for (const mock of apiMocks) {
+      schemas = {
+        ...schemas,
+        ...buildComponentSchema(mock),
+      };
+    }
+
+    const schemaNames = Object.keys(schemas);
+    const pluginListResponseValue = schemas['UsersPermissionsRoleLocalizationResponse'];
+    const apiListResponseValue = schemas['RestaurantLocalizationResponse'];
+
+    const expectedShape = {
+      type: 'object',
+      properties: {
+        id: { type: 'string' },
+        test: { type: 'string' },
+      },
+    };
+
+    expect(schemaNames.length).toBe(4);
+    expect(schemaNames.includes('UsersPermissionsRoleLocalizationResponse')).toBe(true);
+    expect(schemaNames.includes('RestaurantLocalizationResponse')).toBe(true);
+    expect(pluginListResponseValue).toStrictEqual(expectedShape);
+    expect(apiListResponseValue).toStrictEqual(expectedShape);
+  });
+
+  it('builds the LocalizationRequest schema', () => {
+    global.strapi.plugins['users-permissions'].routes['content-api'].routes = [
+      { method: 'POST', path: '/localizations', handler: 'test' },
+    ];
+    global.strapi.api.restaurant.routes.restaurant.routes = [
+      { method: 'POST', path: '/localizations', handler: 'test' },
+    ];
+
+    const apiMocks = [
+      {
+        name: 'users-permissions',
+        getter: 'plugin',
+        ctNames: ['role'],
+      },
+      { name: 'restaurant', getter: 'api', ctNames: ['restaurant'] },
+    ];
+
+    let schemas = {};
+    for (const mock of apiMocks) {
+      schemas = {
+        ...schemas,
+        ...buildComponentSchema(mock),
+      };
+    }
+
+    const schemaNames = Object.keys(schemas);
+    const pluginListResponseValue = schemas['UsersPermissionsRoleLocalizationRequest'];
+    const apiListResponseValue = schemas['RestaurantLocalizationRequest'];
+
+    const expectedShape = {
+      type: 'object',
+      required: ['locale'],
+      properties: { test: { type: 'string' } },
+    };
+
+    expect(schemaNames.length).toBe(8);
+    expect(schemaNames.includes('UsersPermissionsRoleLocalizationRequest')).toBe(true);
+    expect(schemaNames.includes('RestaurantLocalizationRequest')).toBe(true);
+    expect(pluginListResponseValue).toStrictEqual(expectedShape);
+    expect(apiListResponseValue).toStrictEqual(expectedShape);
+  });
+
+  it('creates the correct name given multiple content types', () => {
+    const apiMock = {
+      name: 'users-permissions',
+      getter: 'plugin',
+      ctNames: ['permission', 'role', 'user'],
+    };
+
+    const schemas = buildComponentSchema(apiMock);
+    const schemaNames = Object.keys(schemas);
+    const [permission, role, user] = schemaNames;
+
+    expect(schemaNames.length).toBe(3);
+    expect(permission).toBe('UsersPermissionsPermissionResponse');
+    expect(role).toBe('UsersPermissionsRoleResponse');
+    expect(user).toBe('UsersPermissionsUserResponse');
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.2.0-beta.1",
+  "version": "4.2.0-beta.4",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "repository": {
     "type": "git",
@@ -24,8 +24,8 @@
     "test": "echo \"no tests yet\""
   },
   "dependencies": {
-    "@strapi/helper-plugin": "4.2.0-beta.1",
-    "@strapi/utils": "4.2.0-beta.1",
+    "@strapi/helper-plugin": "4.2.0-beta.4",
+    "@strapi/utils": "4.2.0-beta.4",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.5",
     "fs-extra": "10.0.0",
@@ -42,13 +42,13 @@
     "react-router-dom": "5.2.0",
     "redux": "^4.0.1",
     "reselect": "^4.0.0",
-    "swagger-ui-dist": "3.47.1"
+    "swagger-ui-dist": "4.11.1"
   },
   "peerDependencies": {
     "@strapi/strapi": "^4.0.0"
   },
   "engines": {
-    "node": ">=12.22.0 <=16.x.x",
+    "node": ">=14.19.1 <=16.x.x",
     "npm": ">=6.0.0"
   },
   "strapi": {
@@ -57,5 +57,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "4fa2804f35e15ed72dfd309fb5bb1c4dba18932f"
+  "gitHead": "5caff35a30e33b7a660eb946299f9e3d2d35b2b8"
 }

package/server/config/{default-config.js → default-plugin-config.js}

@@ -21,7 +21,7 @@ module.exports = {
     path: '/documentation',
     showGeneratedFiles: true,
     generateDefaultResponse: true,
-    plugins: ['email', 'upload'],
+    plugins: ['email', 'upload', 'users-permissions'],
   },
   servers: [],
   externalDocs: {
@@ -41,5 +41,34 @@ module.exports = {
         bearerFormat: 'JWT',
       },
     },
+    schemas: {
+      Error: {
+        type: 'object',
+        required: ['error'],
+        properties: {
+          data: {
+            nullable: true,
+            oneOf: [{ type: 'object' }, { type: 'array', items: [] }],
+          },
+          error: {
+            type: 'object',
+            properties: {
+              status: {
+                type: 'integer',
+              },
+              name: {
+                type: 'string',
+              },
+              message: {
+                type: 'string',
+              },
+              details: {
+                type: 'object',
+              },
+            },
+          },
+        },
+      },
+    },
   },
 };

package/server/config/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-const defaultDocumentationConfig = require('./default-config');
+const defaultPluginConfig = require('./default-plugin-config');
 
 module.exports = {
-  default: defaultDocumentationConfig,
+  default: defaultPluginConfig,
 };

package/server/services/documentation.js

@@ -5,8 +5,8 @@ const fs = require('fs-extra');
 const _ = require('lodash');
 const { getAbsoluteServerUrl } = require('@strapi/utils');
 
-const { builApiEndpointPath } = require('../utils/builders');
-const defaultConfig = require('../config/default-config');
+const defaultPluginConfig = require('../config/default-plugin-config');
+const { builApiEndpointPath, buildComponentSchema } = require('./helpers');
 
 module.exports = ({ strapi }) => {
   const config = strapi.config.get('plugin.documentation');
@@ -108,7 +108,7 @@ module.exports = ({ strapi }) => {
       return [...apisToDocument, ...pluginsToDocument];
     },
 
-    async getCustomSettings() {
+    async getCustomConfig() {
       const customConfigPath = this.getCustomDocumentationPath();
       const pathExists = await fs.pathExists(customConfigPath);
       if (pathExists) {
@@ -123,23 +123,31 @@ module.exports = ({ strapi }) => {
      */
     async generateFullDoc(version = this.getDocumentationVersion()) {
       let paths = {};
-
+      let schemas = {};
       const apis = this.getPluginAndApiInfo();
       for (const api of apis) {
         const apiName = api.name;
         const apiDirPath = path.join(this.getApiDocumentationPath(api), version);
 
         const apiDocPath = path.join(apiDirPath, `${apiName}.json`);
-        const apiPathsObject = builApiEndpointPath(api);
 
-        if (!apiPathsObject) {
+        const apiPath = builApiEndpointPath(api);
+
+        if (!apiPath) {
           continue;
         }
 
         await fs.ensureFile(apiDocPath);
-        await fs.writeJson(apiDocPath, apiPathsObject, { spaces: 2 });
+        await fs.writeJson(apiDocPath, apiPath, { spaces: 2 });
 
-        paths = { ...paths, ...apiPathsObject.paths };
+        const componentSchema = buildComponentSchema(api);
+
+        schemas = {
+          ...schemas,
+          ...componentSchema,
+        };
+
+        paths = { ...paths, ...apiPath };
       }
 
       const fullDocJsonPath = path.join(
@@ -148,27 +156,26 @@ module.exports = ({ strapi }) => {
         'full_documentation.json'
       );
 
-      const defaultSettings = _.cloneDeep(defaultConfig);
+      const defaultConfig = _.cloneDeep(defaultPluginConfig);
 
       const serverUrl = getAbsoluteServerUrl(strapi.config);
       const apiPath = strapi.config.get('api.rest.prefix');
 
-      _.set(defaultSettings, 'servers', [
+      _.set(defaultConfig, 'servers', [
         {
           url: `${serverUrl}${apiPath}`,
           description: 'Development server',
         },
       ]);
+      _.set(defaultConfig, ['info', 'x-generation-date'], new Date().toISOString());
+      _.set(defaultConfig, ['info', 'version'], version);
+      _.merge(defaultConfig.components, { schemas });
 
-      _.set(defaultSettings, ['info', 'x-generation-date'], new Date().toISOString());
-      _.set(defaultSettings, ['info', 'version'], version);
-
-      const customSettings = await this.getCustomSettings();
-
-      const settings = _.merge(defaultSettings, customSettings);
+      const customConfig = await this.getCustomConfig();
+      const config = _.merge(defaultConfig, customConfig);
 
       await fs.ensureFile(fullDocJsonPath);
-      await fs.writeJson(fullDocJsonPath, { ...settings, paths }, { spaces: 2 });
+      await fs.writeJson(fullDocJsonPath, { ...config, paths }, { spaces: 2 });
     },
   };
 };

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

@@ -0,0 +1,185 @@
+'use strict';
+
+const _ = require('lodash');
+const pathToRegexp = require('path-to-regexp');
+
+const pascalCase = require('./utils/pascal-case');
+const queryParams = require('./utils/query-params');
+const loopContentTypeNames = require('./utils/loop-content-type-names');
+const getApiResponses = require('./utils/get-api-responses');
+const { hasFindMethod, isLocalizedPath } = require('./utils/routes');
+
+/**
+ * @description Parses a route with ':variable'
+ *
+ * @param {string} routePath - The route's path property
+ * @returns {string}
+ */
+const parsePathWithVariables = routePath => {
+  return pathToRegexp
+    .parse(routePath)
+    .map(token => {
+      if (_.isObject(token)) {
+        return token.prefix + '{' + token.name + '}';
+      }
+
+      return token;
+    })
+    .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 => {
+  return pathToRegexp
+    .parse(routePath)
+    .filter(token => _.isObject(token))
+    .map(param => {
+      return {
+        name: param.name,
+        in: 'path',
+        description: '',
+        deprecated: false,
+        required: true,
+        schema: { type: 'string' },
+      };
+    });
+};
+
+/**
+ *
+ * @param {string} prefix - The prefix found on the routes object
+ * @param {string} route - The current route
+ * @property {string} route.path - The current route's path
+ * @property {object} route.config - The current route's config object
+ *
+ * @returns {string}
+ */
+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 }) => {
+  // 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 isLocalizationPath = isLocalizedPath(route.path);
+    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,
+      isLocalizationPath,
+    });
+
+    const swaggerConfig = {
+      responses,
+      tags: [_.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 = isLocalizationPath ? 'LocalizationRequest' : '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;
+};
+
+/**
+ * @decription Gets all open api paths object for a given content type
+ *
+ * @param {object} apiInfo
+ *
+ * @returns {object} Open API paths
+ */
+const getAllPathsForContentType = apiInfo => {
+  let paths = {};
+
+  const pathsObject = getPaths(apiInfo);
+
+  paths = {
+    ...paths,
+    ...pathsObject,
+  };
+
+  return paths;
+};
+
+/**
+ * @description - Builds the Swagger paths object for each api
+ *
+ * @param {object} api - Information about the current api
+ * @property {string} api.name - The name of the api
+ * @property {string} api.getter - The getter for the api (api | plugin)
+ * @property {array} api.ctNames - The name of all contentTypes found on the api
+ *
+ * @returns {object}
+ */
+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, getAllPathsForContentType);
+};
+
+module.exports = buildApiEndpointPath;