@strapi/plugin-documentation 4.0.0-next.6 → 4.0.0

package/config/functions/bootstrap.js

@@ -1,142 +0,0 @@
-/* eslint-disable no-unreachable */
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const _ = require('lodash');
-
-// Add permissions
-const RBAC_ACTIONS = [
-  {
-    section: 'plugins',
-    displayName: 'Access the Documentation',
-    uid: 'read',
-    pluginName: 'documentation',
-  },
-  {
-    section: 'plugins',
-    displayName: 'Update and delete',
-    uid: 'settings.update',
-    subCategory: 'settings',
-    pluginName: 'documentation',
-  },
-  {
-    section: 'plugins',
-    displayName: 'Regenerate',
-    uid: 'settings.regenerate',
-    subCategory: 'settings',
-    pluginName: 'documentation',
-  },
-];
-
-module.exports = async () => {
-  await strapi.admin.services.permission.actionProvider.registerMany(RBAC_ACTIONS);
-
-  return;
-
-  // Check if the plugin users-permissions is installed because the documentation needs it
-  if (Object.keys(strapi.plugins).indexOf('users-permissions') === -1) {
-    throw new Error(
-      'In order to make the documentation plugin works the users-permissions one is required'
-    );
-  }
-
-  const pluginStore = strapi.store({
-    environment: '',
-    type: 'plugin',
-    name: 'documentation',
-  });
-  const restrictedAccess = await pluginStore.get({ key: 'config' });
-
-  if (!restrictedAccess) {
-    pluginStore.set({ key: 'config', value: { restrictedAccess: false } });
-  }
-
-  let shouldUpdateFullDoc = false;
-  const services = strapi.plugins['documentation'].services.documentation;
-  // Generate plugins' documentation
-  const pluginsWithDocumentationNeeded = services.getPluginsWithDocumentationNeeded();
-
-  pluginsWithDocumentationNeeded.forEach(plugin => {
-    const isDocExisting = services.checkIfPluginDocumentationFolderExists(plugin);
-
-    if (!isDocExisting) {
-      services.createDocumentationDirectory(services.getPluginDocumentationPath(plugin));
-      // create the overrides directory
-      services.createDocumentationDirectory(services.getPluginOverrideDocumentationPath(plugin));
-      services.createPluginDocumentationFile(plugin);
-      shouldUpdateFullDoc = true;
-    } else {
-      const needToUpdatePluginDoc = services.checkIfPluginDocNeedsUpdate(plugin);
-
-      if (needToUpdatePluginDoc) {
-        services.createPluginDocumentationFile(plugin);
-        shouldUpdateFullDoc = true;
-      }
-    }
-  });
-
-  // Retrieve all the apis from the apis directory
-  const apis = services.getApis();
-  // Generate APIS' documentation
-  apis.forEach(api => {
-    const isDocExisting = services.checkIfDocumentationFolderExists(api);
-
-    if (!isDocExisting) {
-      // If the documentation directory doesn't exist create it
-      services.createDocumentationDirectory(services.getDocumentationPath(api));
-      // Create the overrides directory
-      services.createDocumentationDirectory(services.getDocumentationOverridesPath(api));
-      // Create the documentation files per version
-      services.createDocumentationFile(api); // Then create the {api}.json documentation file
-      shouldUpdateFullDoc = true;
-    } else {
-      const needToUpdateAPIDoc = services.checkIfAPIDocNeedsUpdate(api);
-
-      if (needToUpdateAPIDoc) {
-        services.createDocumentationFile(api);
-        shouldUpdateFullDoc = true;
-      }
-    }
-  });
-
-  const fullDoc = services.generateFullDoc();
-  // Verify that the correct documentation folder exists in the documentation plugin
-  const isMergedDocumentationExists = services.checkIfMergedDocumentationFolderExists();
-  const documentationPath = services.getMergedDocumentationPath();
-
-  if (isMergedDocumentationExists) {
-    /**
-     * Retrieve all tags from the documentation and join them
-     * @param {Object} documentation
-     * @returns {String}
-     */
-    const getDocTagsToString = documentation => {
-      return _.get(documentation, 'tags', [])
-        .map(tag => {
-          return tag.name.toLowerCase();
-        })
-        .sort((a, b) => a - b)
-        .join('.');
-    };
-    const oldDoc = require(path.resolve(documentationPath, 'full_documentation.json'));
-    const oldDocTags = getDocTagsToString(oldDoc);
-    const currentDocTags = getDocTagsToString(fullDoc);
-
-    // If the tags are different (an api has been deleted) we need to rebuild the documentation
-    if (oldDocTags !== currentDocTags) {
-      shouldUpdateFullDoc = true;
-    }
-  }
-
-  if (!isMergedDocumentationExists || shouldUpdateFullDoc) {
-    // Create the folder
-    services.createDocumentationDirectory(documentationPath);
-    // Write the file
-    fs.writeFileSync(
-      path.resolve(documentationPath, 'full_documentation.json'),
-      JSON.stringify(fullDoc, null, 2),
-      'utf8'
-    );
-  }
-};

package/config/policies/index.js

@@ -1,33 +0,0 @@
-'use strict';
-
-module.exports = async (ctx, next) => {
-  const pluginStore = strapi.store({
-    environment: '',
-    type: 'plugin',
-    name: 'documentation',
-  });
-  const config = await pluginStore.get({ key: 'config' });
-
-  if (!config.restrictedAccess) {
-    return await next();
-  }
-
-  if (!ctx.session.documentation) {
-    const querystring = ctx.querystring ? `?${ctx.querystring}` : '';
-
-    return ctx.redirect(
-      `${strapi.config.server.url}${strapi.plugins.documentation.config['x-strapi-config'].path}/login${querystring}`
-    );
-  }
-  const isValid = await strapi.plugins['users-permissions'].services.user.validatePassword(
-    ctx.session.documentation,
-    config.password
-  );
-
-  if (!isValid) {
-    ctx.session.documentation = null;
-  }
-
-  // Execute the action.
-  await next();
-};

package/config/routes.json

@@ -1,74 +0,0 @@
-{
-  "routes": [
-    {
-      "method": "GET",
-      "path": "/",
-      "handler": "Documentation.index",
-      "config": {
-        "policies": [
-          "plugins::documentation.index",
-          ["admin::hasPermissions", ["plugins::documentation.read"]]
-        ]
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/v:major(\\d+).:minor(\\d+).:patch(\\d+)",
-      "handler": "Documentation.index",
-      "config": {
-        "policies": [
-          "plugins::documentation.index",
-          ["admin::hasPermissions", ["plugins::documentation.read"]]
-        ]
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/login",
-      "handler": "Documentation.loginView",
-      "config": {
-        "policies": [["admin::hasPermissions", ["plugins::documentation.read"]]]
-      }
-    },
-    {
-      "method": "POST",
-      "path": "/login",
-      "handler": "Documentation.login",
-      "config": {
-        "policies": [["admin::hasPermissions", ["plugins::documentation.read"]]]
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/getInfos",
-      "handler": "Documentation.getInfos",
-      "config": {
-        "policies": [["admin::hasPermissions", ["plugins::documentation.read"]]]
-      }
-    },
-    {
-      "method": "POST",
-      "path": "/regenerateDoc",
-      "handler": "Documentation.regenerateDoc",
-      "config": {
-        "policies": [["admin::hasPermissions", ["plugins::documentation.settings.regenerate"]]]
-      }
-    },
-    {
-      "method": "PUT",
-      "path": "/updateSettings",
-      "handler": "Documentation.updateSettings",
-      "config": {
-        "policies": [["admin::hasPermissions", ["plugins::documentation.settings.update"]]]
-      }
-    },
-    {
-      "method": "DELETE",
-      "path": "/deleteDoc/:version",
-      "handler": "Documentation.deleteDoc",
-      "config": {
-        "policies": []
-      }
-    }
-  ]
-}

package/config/settings.json

@@ -1,46 +0,0 @@
-{
-  "openapi": "3.0.0",
-  "info": {
-    "version": "1.0.0",
-    "title": "DOCUMENTATION",
-    "description": "",
-    "termsOfService": "YOUR_TERMS_OF_SERVICE_URL",
-    "contact": {
-      "name": "TEAM",
-      "email": "contact-email@something.io",
-      "url": "mywebsite.io"
-    },
-    "license": {
-      "name": "Apache 2.0",
-      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
-    }
-  },
-  "x-strapi-config": {
-    "path": "/documentation",
-    "showGeneratedFiles": true,
-    "generateDefaultResponse": true
-  },
-  "servers": [
-    {
-      "url": "http://localhost:1337",
-      "description": "Development server"
-    },
-    {
-      "url": "YOUR_STAGING_SERVER",
-      "description": "Staging server"
-    },
-    {
-      "url": "YOUR_PRODUCTION_SERVER",
-      "description": "Production server"
-    }
-  ],
-  "externalDocs": {
-    "description": "Find out more",
-    "url": "https://strapi.io/documentation/developer-docs/latest/getting-started/introduction.html"
-  },
-  "security": [
-    {
-      "bearerAuth": []
-    }
-  ]
-}

package/controllers/Documentation.js

@@ -1,302 +0,0 @@
-'use strict';
-
-/**
- * Documentation.js controller
- *
- * @description: A set of functions called "actions" of the `documentation` plugin.
- */
-
-// Core dependencies.
-const path = require('path');
-
-// Public dependencies.
-const fs = require('fs-extra');
-const cheerio = require('cheerio');
-const _ = require('lodash');
-const koaStatic = require('koa-static');
-
-module.exports = {
-  getInfos: async ctx => {
-    try {
-      const service = strapi.plugins.documentation.services.documentation;
-      const docVersions = service.retrieveDocumentationVersions();
-      const form = await service.retrieveFrontForm();
-
-      ctx.send({
-        docVersions,
-        currentVersion: service.getDocumentationVersion(),
-        prefix: strapi.plugins.documentation.config['x-strapi-config'].path,
-        form,
-      });
-    } catch (err) {
-      ctx.badRequest(null, err.message);
-    }
-  },
-
-  async index(ctx, next) {
-    try {
-      /**
-       * We don't expose the specs using koa-static or something else due to security reasons.
-       * That's why, we need to read the file localy and send the specs through it when we serve the Swagger UI.
-       */
-      const { major, minor, patch } = ctx.params;
-      const version =
-        major && minor && patch
-          ? `${major}.${minor}.${patch}`
-          : strapi.plugins.documentation.config.info.version;
-      const openAPISpecsPath = path.join(
-        strapi.config.appPath,
-        'extensions',
-        'documentation',
-        'documentation',
-        version,
-        'full_documentation.json'
-      );
-
-      try {
-        const documentation = fs.readFileSync(openAPISpecsPath, 'utf8');
-        const layout = fs.readFileSync(
-          path.resolve(__dirname, '..', 'public', 'index.html'),
-          'utf8'
-        );
-        const filledLayout = _.template(layout)({
-          backendUrl: strapi.config.server.url,
-          spec: JSON.stringify(JSON.parse(documentation)),
-        });
-
-        try {
-          const layoutPath = path.resolve(
-            strapi.config.appPath,
-            'extensions',
-            'documentation',
-            'public',
-            'index.html'
-          );
-          await fs.ensureFile(layoutPath);
-          await fs.writeFile(layoutPath, filledLayout);
-
-          // Serve the file.
-          ctx.url = path.basename(`${ctx.url}/index.html`);
-
-          try {
-            const staticFolder = path.resolve(
-              strapi.config.appPath,
-              'extensions',
-              'documentation',
-              'public'
-            );
-            return await koaStatic(staticFolder)(ctx, next);
-          } catch (e) {
-            strapi.log.error(e);
-          }
-        } catch (e) {
-          strapi.log.error(e);
-        }
-      } catch (e) {
-        strapi.log.error(e);
-      }
-    } catch (e) {
-      strapi.log.error(e);
-    }
-  },
-
-  async loginView(ctx, next) {
-    const { error } = ctx.query;
-
-    try {
-      const layout = fs.readFileSync(path.join(__dirname, '..', 'public', 'login.html'));
-      const filledLayout = _.template(layout)({
-        actionUrl: `${strapi.config.server.url}${strapi.plugins.documentation.config['x-strapi-config'].path}/login`,
-      });
-      const $ = cheerio.load(filledLayout);
-
-      $('.error').text(_.isEmpty(error) ? '' : 'Wrong password...');
-
-      try {
-        const layoutPath = path.resolve(
-          strapi.config.appPath,
-          'extensions',
-          'documentation',
-          'public',
-          'login.html'
-        );
-        await fs.ensureFile(layoutPath);
-        await fs.writeFile(layoutPath, $.html());
-
-        ctx.url = path.basename(`${ctx.url}/login.html`);
-
-        try {
-          const staticFolder = path.resolve(
-            strapi.config.appPath,
-            'extensions',
-            'documentation',
-            'public'
-          );
-          return await koaStatic(staticFolder)(ctx, next);
-        } catch (e) {
-          strapi.log.error(e);
-        }
-      } catch (e) {
-        strapi.log.error(e);
-      }
-    } catch (e) {
-      strapi.log.error(e);
-    }
-  },
-
-  async login(ctx) {
-    const {
-      body: { password },
-    } = ctx.request;
-
-    const { password: storedPassword } = await strapi
-      .store({
-        environment: '',
-        type: 'plugin',
-        name: 'documentation',
-        key: 'config',
-      })
-      .get();
-
-    const isValid = await strapi.plugins['users-permissions'].services.user.validatePassword(
-      password,
-      storedPassword
-    );
-    let querystring = '?error=password';
-
-    if (isValid) {
-      ctx.session.documentation = password;
-      querystring = '';
-    }
-
-    ctx.redirect(
-      `${strapi.config.server.url}${strapi.plugins.documentation.config['x-strapi-config'].path}${querystring}`
-    );
-  },
-
-  regenerateDoc: async ctx => {
-    const service = strapi.plugins.documentation.services.documentation;
-    const documentationVersions = service.retrieveDocumentationVersions().map(el => el.version);
-    const {
-      request: {
-        body: { version },
-        admin,
-      },
-    } = ctx;
-
-    if (_.isEmpty(version)) {
-      return ctx.badRequest(
-        null,
-        admin ? 'documentation.error.noVersion' : 'Please provide a version.'
-      );
-    }
-
-    if (!documentationVersions.includes(version)) {
-      return ctx.badRequest(
-        null,
-        admin
-          ? 'documentation.error.regenerateDoc.versionMissing'
-          : 'The version you are trying to generate does not exist.'
-      );
-    }
-
-    try {
-      strapi.reload.isWatching = false;
-      const fullDoc = service.generateFullDoc(version);
-      const documentationPath = service.getMergedDocumentationPath(version);
-      // Write the file
-      fs.writeFileSync(
-        path.resolve(documentationPath, 'full_documentation.json'),
-        JSON.stringify(fullDoc, null, 2),
-        'utf8'
-      );
-      ctx.send({ ok: true });
-    } catch (err) {
-      ctx.badRequest(null, admin ? 'documentation.error.regenerateDoc' : 'An error occured');
-    } finally {
-      strapi.reload.isWatching = true;
-    }
-  },
-
-  deleteDoc: async ctx => {
-    strapi.reload.isWatching = false;
-    const service = strapi.plugins.documentation.services.documentation;
-    const documentationVersions = service.retrieveDocumentationVersions().map(el => el.version);
-
-    const {
-      params: { version },
-      request: { admin },
-    } = ctx;
-
-    if (_.isEmpty(version)) {
-      return ctx.badRequest(
-        null,
-        admin ? 'documentation.error.noVersion' : 'Please provide a version.'
-      );
-    }
-
-    if (!documentationVersions.includes(version)) {
-      return ctx.badRequest(
-        null,
-        admin
-          ? 'documentation.error.deleteDoc.versionMissing'
-          : 'The version you are trying to delete does not exist.'
-      );
-    }
-
-    try {
-      await service.deleteDocumentation(version);
-      ctx.send({ ok: true });
-    } catch (err) {
-      ctx.badRequest(null, admin ? 'notification.error' : err.message);
-    } finally {
-      strapi.reload.isWatching = true;
-    }
-  },
-
-  updateSettings: async ctx => {
-    const {
-      admin,
-      body: { restrictedAccess, password },
-    } = ctx.request;
-    const usersPermService = strapi.plugins['users-permissions'].services;
-    const pluginStore = strapi.store({
-      environment: '',
-      type: 'plugin',
-      name: 'documentation',
-    });
-    const prevConfig = await pluginStore.get({ key: 'config' });
-
-    if (restrictedAccess && _.isEmpty(password)) {
-      return ctx.badRequest(
-        null,
-        admin ? 'users-permissions.Auth.form.error.password.provide' : 'Please provide a password'
-      );
-    }
-
-    const isNewPassword = !_.isEmpty(password) && password !== prevConfig.password;
-
-    if (isNewPassword && usersPermService.user.isHashed(password)) {
-      // Throw an error if the password selected by the user
-      // contains more than two times the symbol '$'.
-      return ctx.badRequest(
-        null,
-        admin
-          ? 'users-permissions.Auth.form.error.password.format'
-          : 'our password cannot contain more than three times the symbol `$`.'
-      );
-    }
-
-    if (isNewPassword) {
-      prevConfig.password = await usersPermService.user.hashPassword({
-        password,
-      });
-    }
-
-    _.set(prevConfig, 'restrictedAccess', restrictedAccess);
-
-    await pluginStore.set({ key: 'config', value: prevConfig });
-
-    return ctx.send({ ok: true });
-  },
-};

package/middlewares/documentation/defaults.json

@@ -1,5 +0,0 @@
-{
-  "documentation": {
-    "enabled": true
-  }
-}

package/middlewares/documentation/index.js

@@ -1,59 +0,0 @@
-'use strict';
-
-/**
- * Module dependencies
- */
-
-// Public node modules.
-const path = require('path');
-const _ = require('lodash');
-const swaggerUi = require('swagger-ui-dist');
-const koaStatic = require('koa-static');
-
-// Variables.
-const initialRoutes = [];
-
-module.exports = strapi => {
-  return {
-    beforeInitialize() {
-      strapi.config.middleware.load.before.push('documentation');
-
-      initialRoutes.push(..._.cloneDeep(strapi.plugins.documentation.config.routes));
-    },
-
-    initialize() {
-      // Find the plugins routes.
-      strapi.plugins.documentation.config.routes = strapi.plugins.documentation.config.routes.map(
-        (route, index) => {
-          if (route.handler === 'Documentation.getInfos') {
-            return route;
-          }
-
-          if (route.handler === 'Documentation.index' || route.path === '/login') {
-            route.config.policies = initialRoutes[index].config.policies;
-          }
-
-          // Set prefix to empty to be able to customise it.
-          if (_.get(strapi.plugins, ['documentation', 'config', 'x-strapi-config', 'path'])) {
-            route.config.prefix = '';
-            route.path = `/${strapi.plugins.documentation.config['x-strapi-config'].path}${route.path}`.replace(
-              '//',
-              '/'
-            );
-          }
-
-          return route;
-        }
-      );
-
-      strapi.router.get('/plugins/documentation/*', async (ctx, next) => {
-        ctx.url = path.basename(ctx.url);
-
-        return await koaStatic(swaggerUi.getAbsoluteFSPath(), {
-          maxage: strapi.config.middleware.settings.public.maxAge,
-          defer: true,
-        })(ctx, next);
-      });
-    },
-  };
-};