@strapi/plugin-documentation 5.12.1 → 5.12.2

package/dist/server/config/default-plugin-config.mjs

@@ -0,0 +1,86 @@
+const defaultConfig = {
+    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': {
+        plugins: null,
+        mutateDocumentation: null
+    },
+    servers: [],
+    externalDocs: {
+        description: 'Find out more',
+        url: 'https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html'
+    },
+    security: [
+        {
+            bearerAuth: []
+        }
+    ],
+    paths: {},
+    components: {
+        securitySchemes: {
+            bearerAuth: {
+                type: 'http',
+                scheme: 'bearer',
+                bearerFormat: 'JWT'
+            }
+        },
+        schemas: {
+            Error: {
+                type: 'object',
+                required: [
+                    'error'
+                ],
+                properties: {
+                    data: {
+                        nullable: true,
+                        oneOf: [
+                            {
+                                type: 'object'
+                            },
+                            {
+                                type: 'array',
+                                items: {
+                                    type: 'object'
+                                }
+                            }
+                        ]
+                    },
+                    error: {
+                        type: 'object',
+                        properties: {
+                            status: {
+                                type: 'integer'
+                            },
+                            name: {
+                                type: 'string'
+                            },
+                            message: {
+                                type: 'string'
+                            },
+                            details: {
+                                type: 'object'
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+};
+
+export { defaultConfig };
+//# sourceMappingURL=default-plugin-config.mjs.map

package/dist/server/config/default-plugin-config.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-plugin-config.mjs","sources":["../../../server/src/config/default-plugin-config.ts"],"sourcesContent":["import type { PluginConfig } from '../types';\n\nexport const defaultConfig: PluginConfig = {\n  openapi: '3.0.0',\n  info: {\n    version: '1.0.0',\n    title: 'DOCUMENTATION',\n    description: '',\n    termsOfService: 'YOUR_TERMS_OF_SERVICE_URL',\n    contact: {\n      name: 'TEAM',\n      email: 'contact-email@something.io',\n      url: 'mywebsite.io',\n    },\n    license: {\n      name: 'Apache 2.0',\n      url: 'https://www.apache.org/licenses/LICENSE-2.0.html',\n    },\n  },\n  'x-strapi-config': {\n    plugins: null,\n    mutateDocumentation: null,\n  },\n  servers: [],\n  externalDocs: {\n    description: 'Find out more',\n    url: 'https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html',\n  },\n  security: [\n    {\n      bearerAuth: [],\n    },\n  ],\n  paths: {},\n  components: {\n    securitySchemes: {\n      bearerAuth: {\n        type: 'http',\n        scheme: 'bearer',\n        bearerFormat: 'JWT',\n      },\n    },\n    schemas: {\n      Error: {\n        type: 'object',\n        required: ['error'],\n        properties: {\n          data: {\n            nullable: true,\n            oneOf: [{ type: 'object' }, { type: 'array', items: { type: 'object' } }],\n          },\n          error: {\n            type: 'object',\n            properties: {\n              status: {\n                type: 'integer',\n              },\n              name: {\n                type: 'string',\n              },\n              message: {\n                type: 'string',\n              },\n              details: {\n                type: 'object',\n              },\n            },\n          },\n        },\n      },\n    },\n  },\n};\n"],"names":["defaultConfig","openapi","info","version","title","description","termsOfService","contact","name","email","url","license","plugins","mutateDocumentation","servers","externalDocs","security","bearerAuth","paths","components","securitySchemes","type","scheme","bearerFormat","schemas","Error","required","properties","data","nullable","oneOf","items","error","status","message","details"],"mappings":"MAEaA,aAA8B,GAAA;IACzCC,OAAS,EAAA,OAAA;IACTC,IAAM,EAAA;QACJC,OAAS,EAAA,OAAA;QACTC,KAAO,EAAA,eAAA;QACPC,WAAa,EAAA,EAAA;QACbC,cAAgB,EAAA,2BAAA;QAChBC,OAAS,EAAA;YACPC,IAAM,EAAA,MAAA;YACNC,KAAO,EAAA,4BAAA;YACPC,GAAK,EAAA;AACP,SAAA;QACAC,OAAS,EAAA;YACPH,IAAM,EAAA,YAAA;YACNE,GAAK,EAAA;AACP;AACF,KAAA;IACA,iBAAmB,EAAA;QACjBE,OAAS,EAAA,IAAA;QACTC,mBAAqB,EAAA;AACvB,KAAA;AACAC,IAAAA,OAAAA,EAAS,EAAE;IACXC,YAAc,EAAA;QACZV,WAAa,EAAA,eAAA;QACbK,GAAK,EAAA;AACP,KAAA;IACAM,QAAU,EAAA;AACR,QAAA;AACEC,YAAAA,UAAAA,EAAY;AACd;AACD,KAAA;AACDC,IAAAA,KAAAA,EAAO,EAAC;IACRC,UAAY,EAAA;QACVC,eAAiB,EAAA;YACfH,UAAY,EAAA;gBACVI,IAAM,EAAA,MAAA;gBACNC,MAAQ,EAAA,QAAA;gBACRC,YAAc,EAAA;AAChB;AACF,SAAA;QACAC,OAAS,EAAA;YACPC,KAAO,EAAA;gBACLJ,IAAM,EAAA,QAAA;gBACNK,QAAU,EAAA;AAAC,oBAAA;AAAQ,iBAAA;gBACnBC,UAAY,EAAA;oBACVC,IAAM,EAAA;wBACJC,QAAU,EAAA,IAAA;wBACVC,KAAO,EAAA;AAAC,4BAAA;gCAAET,IAAM,EAAA;AAAS,6BAAA;AAAG,4BAAA;gCAAEA,IAAM,EAAA,OAAA;gCAASU,KAAO,EAAA;oCAAEV,IAAM,EAAA;AAAS;AAAE;AAAE;AAC3E,qBAAA;oBACAW,KAAO,EAAA;wBACLX,IAAM,EAAA,QAAA;wBACNM,UAAY,EAAA;4BACVM,MAAQ,EAAA;gCACNZ,IAAM,EAAA;AACR,6BAAA;4BACAb,IAAM,EAAA;gCACJa,IAAM,EAAA;AACR,6BAAA;4BACAa,OAAS,EAAA;gCACPb,IAAM,EAAA;AACR,6BAAA;4BACAc,OAAS,EAAA;gCACPd,IAAM,EAAA;AACR;AACF;AACF;AACF;AACF;AACF;AACF;AACF;;;;"}

package/dist/server/config/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var defaultPluginConfig = require('./default-plugin-config.js');
+
+const config = {
+    default: defaultPluginConfig.defaultConfig
+};
+
+exports.config = config;
+//# sourceMappingURL=index.js.map

package/dist/server/config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../server/src/config/index.ts"],"sourcesContent":["import { defaultConfig } from './default-plugin-config';\n\nexport const config = {\n  default: defaultConfig,\n};\n"],"names":["config","default","defaultConfig"],"mappings":";;;;MAEaA,MAAS,GAAA;IACpBC,OAASC,EAAAA;AACX;;;;"}

package/dist/server/config/index.mjs

@@ -0,0 +1,8 @@
+import { defaultConfig } from './default-plugin-config.mjs';
+
+const config = {
+    default: defaultConfig
+};
+
+export { config };
+//# sourceMappingURL=index.mjs.map

package/dist/server/config/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../../server/src/config/index.ts"],"sourcesContent":["import { defaultConfig } from './default-plugin-config';\n\nexport const config = {\n  default: defaultConfig,\n};\n"],"names":["config","default","defaultConfig"],"mappings":";;MAEaA,MAAS,GAAA;IACpBC,OAASC,EAAAA;AACX;;;;"}

package/dist/server/controllers/documentation.js

@@ -0,0 +1,185 @@
+'use strict';
+
+var path = require('path');
+var bcrypt = require('bcryptjs');
+var fs = require('fs-extra');
+var _ = require('lodash');
+var koaStatic = require('koa-static');
+var utils = require('@strapi/utils');
+var utils$1 = require('../utils.js');
+
+function _interopNamespaceDefaultOnly (e) { return Object.freeze({ __proto__: null, default: e }); }
+
+const validation = {
+    validateSettings: utils.validateYupSchema(utils.yup.object().shape({
+        restrictedAccess: utils.yup.boolean(),
+        password: utils.yup.string().min(8).matches(/[a-z]/, '${path} must contain at least one lowercase character').matches(/[A-Z]/, '${path} must contain at least one uppercase character').matches(/\d/, '${path} must contain at least one number').when('restrictedAccess', (value, initSchema)=>{
+            return value ? initSchema.required('password is required') : initSchema;
+        })
+    }))
+};
+var documentation = {
+    async getInfos (ctx) {
+        try {
+            const docService = utils$1.getService('documentation');
+            const docVersions = docService.getDocumentationVersions();
+            const documentationAccess = await docService.getDocumentationAccess();
+            ctx.send({
+                docVersions,
+                currentVersion: docService.getDocumentationVersion(),
+                prefix: '/documentation',
+                documentationAccess
+            });
+        } catch (err) {
+            strapi.log.error(err);
+            ctx.badRequest();
+        }
+    },
+    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}` : utils$1.getService('documentation').getDocumentationVersion();
+            const openAPISpecsPath = path.join(strapi.dirs.app.extensions, 'documentation', 'documentation', version, 'full_documentation.json');
+            try {
+                const documentation = fs.readFileSync(openAPISpecsPath, 'utf8');
+                const layout = (await Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespaceDefaultOnly(require('../public/index.html.js')); })).default;
+                const filledLayout = _.template(layout)({
+                    backendUrl: strapi.config.server.url,
+                    spec: JSON.stringify(JSON.parse(documentation))
+                });
+                try {
+                    const layoutPath = path.resolve(strapi.dirs.app.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.dirs.app.extensions, 'documentation', 'public');
+                        return 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) {
+        // lazy require cheerio
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const cheerio = require('cheerio');
+        const { error } = ctx.query;
+        try {
+            const layout = (await Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespaceDefaultOnly(require('../public/login.html.js')); })).default;
+            const filledLayout = _.template(layout.toString())({
+                actionUrl: `${strapi.config.server.url}/documentation/login`
+            });
+            const $ = cheerio.load(filledLayout);
+            $('.error').text(_.isEmpty(error) ? '' : 'Wrong password...');
+            try {
+                const layoutPath = path.resolve(strapi.dirs.app.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.dirs.app.extensions, 'documentation', 'public');
+                    return 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: hash } = await strapi.store({
+            type: 'plugin',
+            name: 'documentation',
+            key: 'config'
+        }).get();
+        const isValid = await bcrypt.compare(password, hash);
+        let querystring = '?error=password';
+        if (isValid && ctx.session) {
+            ctx.session.documentation = {
+                logged: true
+            };
+            querystring = '';
+        }
+        ctx.redirect(`${strapi.config.server.url}/documentation${querystring}`);
+    },
+    async regenerateDoc (ctx) {
+        const { version } = ctx.request.body;
+        const service = utils$1.getService('documentation');
+        const documentationVersions = service.getDocumentationVersions().map((el)=>el.version);
+        if (_.isEmpty(version)) {
+            return ctx.badRequest('Please provide a version.');
+        }
+        if (!documentationVersions.includes(version)) {
+            return ctx.badRequest('The version you are trying to generate does not exist.');
+        }
+        try {
+            strapi.reload.isWatching = false;
+            await service.generateFullDoc(version);
+            ctx.send({
+                ok: true
+            });
+        } finally{
+            strapi.reload.isWatching = true;
+        }
+    },
+    async deleteDoc (ctx) {
+        const { version } = ctx.params;
+        const service = utils$1.getService('documentation');
+        const documentationVersions = service.getDocumentationVersions().map((el)=>el.version);
+        if (_.isEmpty(version)) {
+            return ctx.badRequest('Please provide a version.');
+        }
+        if (!documentationVersions.includes(version)) {
+            return ctx.badRequest('The version you are trying to delete does not exist.');
+        }
+        try {
+            strapi.reload.isWatching = false;
+            await service.deleteDocumentation(version);
+            ctx.send({
+                ok: true
+            });
+        } finally{
+            strapi.reload.isWatching = true;
+        }
+    },
+    async updateSettings (ctx) {
+        const pluginStore = strapi.store({
+            type: 'plugin',
+            name: 'documentation'
+        });
+        const data = await validation.validateSettings(ctx.request.body);
+        const config = {
+            restrictedAccess: Boolean(data.restrictedAccess)
+        };
+        if (data.password) {
+            config.password = await bcrypt.hash(data.password, 10);
+        }
+        await pluginStore.set({
+            key: 'config',
+            value: config
+        });
+        return ctx.send({
+            ok: true
+        });
+    }
+};
+
+module.exports = documentation;
+//# sourceMappingURL=documentation.js.map

package/dist/server/controllers/documentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentation.js","sources":["../../../server/src/controllers/documentation.ts"],"sourcesContent":["import path from 'path';\nimport bcrypt from 'bcryptjs';\nimport fs from 'fs-extra';\nimport _ from 'lodash';\nimport koaStatic from 'koa-static';\nimport { yup, validateYupSchema } from '@strapi/utils';\n\nimport type Koa from 'koa';\nimport type {} from 'koa-body';\n\nimport { getService } from '../utils';\nimport type { Config } from '../types';\n\nconst validation = {\n  validateSettings: validateYupSchema(\n    yup.object().shape({\n      restrictedAccess: yup.boolean(),\n      password: yup\n        .string()\n        .min(8)\n        .matches(/[a-z]/, '${path} must contain at least one lowercase character')\n        .matches(/[A-Z]/, '${path} must contain at least one uppercase character')\n        .matches(/\\d/, '${path} must contain at least one number')\n        .when('restrictedAccess', (value, initSchema) => {\n          return value ? initSchema.required('password is required') : initSchema;\n        }),\n    })\n  ),\n};\n\nexport default {\n  async getInfos(ctx: Koa.Context) {\n    try {\n      const docService = getService('documentation');\n      const docVersions = docService.getDocumentationVersions();\n      const documentationAccess = await docService.getDocumentationAccess();\n\n      ctx.send({\n        docVersions,\n        currentVersion: docService.getDocumentationVersion(),\n        prefix: '/documentation',\n        documentationAccess,\n      });\n    } catch (err) {\n      strapi.log.error(err);\n      ctx.badRequest();\n    }\n  },\n\n  async index(ctx: Koa.Context, next: Koa.Next) {\n    try {\n      /**\n       * We don't expose the specs using koa-static or something else due to security reasons.\n       * That's why, we need to read the file localy and send the specs through it when we serve the Swagger UI.\n       */\n      const { major, minor, patch } = ctx.params;\n      const version =\n        major && minor && patch\n          ? `${major}.${minor}.${patch}`\n          : getService('documentation').getDocumentationVersion();\n\n      const openAPISpecsPath = path.join(\n        strapi.dirs.app.extensions,\n        'documentation',\n        'documentation',\n        version,\n        'full_documentation.json'\n      );\n\n      try {\n        const documentation = fs.readFileSync(openAPISpecsPath, 'utf8');\n\n        const layout = (await import('../public/index.html')).default;\n\n        const filledLayout = _.template(layout)({\n          backendUrl: strapi.config.server.url,\n          spec: JSON.stringify(JSON.parse(documentation)),\n        });\n\n        try {\n          const layoutPath = path.resolve(\n            strapi.dirs.app.extensions,\n            'documentation',\n            'public',\n            'index.html'\n          );\n          await fs.ensureFile(layoutPath);\n          await fs.writeFile(layoutPath, filledLayout);\n\n          // Serve the file.\n          ctx.url = path.basename(`${ctx.url}/index.html`);\n\n          try {\n            const staticFolder = path.resolve(\n              strapi.dirs.app.extensions,\n              'documentation',\n              'public'\n            );\n            return koaStatic(staticFolder)(ctx, next);\n          } catch (e) {\n            strapi.log.error(e);\n          }\n        } catch (e) {\n          strapi.log.error(e);\n        }\n      } catch (e) {\n        strapi.log.error(e);\n      }\n    } catch (e) {\n      strapi.log.error(e);\n    }\n  },\n\n  async loginView(ctx: Koa.Context, next: Koa.Next) {\n    // lazy require cheerio\n    // eslint-disable-next-line @typescript-eslint/no-var-requires\n    const cheerio = require('cheerio');\n\n    const { error } = ctx.query;\n\n    try {\n      const layout = (await import('../public/login.html')).default;\n\n      const filledLayout = _.template(layout.toString())({\n        actionUrl: `${strapi.config.server.url}/documentation/login`,\n      });\n\n      const $ = cheerio.load(filledLayout);\n\n      $('.error').text(_.isEmpty(error) ? '' : 'Wrong password...');\n\n      try {\n        const layoutPath = path.resolve(\n          strapi.dirs.app.extensions,\n          'documentation',\n          'public',\n          'login.html'\n        );\n        await fs.ensureFile(layoutPath);\n        await fs.writeFile(layoutPath, $.html());\n\n        ctx.url = path.basename(`${ctx.url}/login.html`);\n\n        try {\n          const staticFolder = path.resolve(strapi.dirs.app.extensions, 'documentation', 'public');\n          return koaStatic(staticFolder)(ctx, next);\n        } catch (e) {\n          strapi.log.error(e);\n        }\n      } catch (e) {\n        strapi.log.error(e);\n      }\n    } catch (e) {\n      strapi.log.error(e);\n    }\n  },\n\n  async login(ctx: Koa.Context) {\n    const {\n      body: { password },\n    } = ctx.request;\n\n    const { password: hash } = (await strapi\n      .store({ type: 'plugin', name: 'documentation', key: 'config' })\n      .get()) as { password: string };\n\n    const isValid = await bcrypt.compare(password, hash);\n\n    let querystring = '?error=password';\n\n    if (isValid && ctx.session) {\n      ctx.session.documentation = {\n        logged: true,\n      };\n\n      querystring = '';\n    }\n\n    ctx.redirect(`${strapi.config.server.url}/documentation${querystring}`);\n  },\n\n  async regenerateDoc(ctx: Koa.Context) {\n    const { version } = ctx.request.body;\n\n    const service = getService('documentation');\n\n    const documentationVersions = service.getDocumentationVersions().map((el) => el.version);\n\n    if (_.isEmpty(version)) {\n      return ctx.badRequest('Please provide a version.');\n    }\n\n    if (!documentationVersions.includes(version)) {\n      return ctx.badRequest('The version you are trying to generate does not exist.');\n    }\n\n    try {\n      strapi.reload.isWatching = false;\n      await service.generateFullDoc(version);\n      ctx.send({ ok: true });\n    } finally {\n      strapi.reload.isWatching = true;\n    }\n  },\n\n  async deleteDoc(ctx: Koa.Context) {\n    const { version } = ctx.params;\n\n    const service = getService('documentation');\n\n    const documentationVersions = service.getDocumentationVersions().map((el) => el.version);\n\n    if (_.isEmpty(version)) {\n      return ctx.badRequest('Please provide a version.');\n    }\n\n    if (!documentationVersions.includes(version)) {\n      return ctx.badRequest('The version you are trying to delete does not exist.');\n    }\n\n    try {\n      strapi.reload.isWatching = false;\n      await service.deleteDocumentation(version);\n      ctx.send({ ok: true });\n    } finally {\n      strapi.reload.isWatching = true;\n    }\n  },\n\n  async updateSettings(ctx: Koa.Context) {\n    const pluginStore = strapi.store({ type: 'plugin', name: 'documentation' });\n\n    const data = await validation.validateSettings(ctx.request.body);\n\n    const config: Config = {\n      restrictedAccess: Boolean(data.restrictedAccess),\n    };\n\n    if (data.password) {\n      config.password = await bcrypt.hash(data.password, 10);\n    }\n\n    await pluginStore.set({ key: 'config', value: config });\n\n    return ctx.send({ ok: true });\n  },\n};\n"],"names":["validation","validateSettings","validateYupSchema","yup","object","shape","restrictedAccess","boolean","password","string","min","matches","when","value","initSchema","required","getInfos","ctx","docService","getService","docVersions","getDocumentationVersions","documentationAccess","getDocumentationAccess","send","currentVersion","getDocumentationVersion","prefix","err","strapi","log","error","badRequest","index","next","major","minor","patch","params","version","openAPISpecsPath","path","join","dirs","app","extensions","documentation","fs","readFileSync","layout","default","filledLayout","_","template","backendUrl","config","server","url","spec","JSON","stringify","parse","layoutPath","resolve","ensureFile","writeFile","basename","staticFolder","koaStatic","e","loginView","cheerio","require","query","toString","actionUrl","$","load","text","isEmpty","html","login","body","request","hash","store","type","name","key","get","isValid","bcrypt","compare","querystring","session","logged","redirect","regenerateDoc","service","documentationVersions","map","el","includes","reload","isWatching","generateFullDoc","ok","deleteDoc","deleteDocumentation","updateSettings","pluginStore","data","Boolean","set"],"mappings":";;;;;;;;;;;;AAaA,MAAMA,UAAa,GAAA;AACjBC,IAAAA,gBAAAA,EAAkBC,uBAChBC,CAAAA,SAAAA,CAAIC,MAAM,EAAA,CAAGC,KAAK,CAAC;AACjBC,QAAAA,gBAAAA,EAAkBH,UAAII,OAAO,EAAA;QAC7BC,QAAUL,EAAAA,SAAAA,CACPM,MAAM,EACNC,CAAAA,GAAG,CAAC,CACJC,CAAAA,CAAAA,OAAO,CAAC,OAAA,EAAS,uDACjBA,CAAAA,CAAAA,OAAO,CAAC,OAAS,EAAA,uDAAA,CAAA,CACjBA,OAAO,CAAC,IAAA,EAAM,4CACdC,IAAI,CAAC,kBAAoB,EAAA,CAACC,KAAOC,EAAAA,UAAAA,GAAAA;AAChC,YAAA,OAAOD,KAAQC,GAAAA,UAAAA,CAAWC,QAAQ,CAAC,sBAA0BD,CAAAA,GAAAA,UAAAA;AAC/D,SAAA;AACJ,KAAA,CAAA;AAEJ,CAAA;AAEA,oBAAe;AACb,IAAA,MAAME,UAASC,GAAgB,EAAA;QAC7B,IAAI;AACF,YAAA,MAAMC,aAAaC,kBAAW,CAAA,eAAA,CAAA;YAC9B,MAAMC,WAAAA,GAAcF,WAAWG,wBAAwB,EAAA;YACvD,MAAMC,mBAAAA,GAAsB,MAAMJ,UAAAA,CAAWK,sBAAsB,EAAA;AAEnEN,YAAAA,GAAAA,CAAIO,IAAI,CAAC;AACPJ,gBAAAA,WAAAA;AACAK,gBAAAA,cAAAA,EAAgBP,WAAWQ,uBAAuB,EAAA;gBAClDC,MAAQ,EAAA,gBAAA;AACRL,gBAAAA;AACF,aAAA,CAAA;AACF,SAAA,CAAE,OAAOM,GAAK,EAAA;YACZC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACH,GAAAA,CAAAA;AACjBX,YAAAA,GAAAA,CAAIe,UAAU,EAAA;AAChB;AACF,KAAA;IAEA,MAAMC,KAAAA,CAAAA,CAAMhB,GAAgB,EAAEiB,IAAc,EAAA;QAC1C,IAAI;AACF;;;UAIA,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAEC,KAAK,EAAE,GAAGpB,GAAAA,CAAIqB,MAAM;AAC1C,YAAA,MAAMC,UACJJ,KAASC,IAAAA,KAAAA,IAASC,KACd,GAAA,CAAC,EAAEF,KAAM,CAAA,CAAC,EAAEC,KAAAA,CAAM,CAAC,EAAEC,KAAAA,CAAM,CAAC,GAC5BlB,kBAAAA,CAAW,iBAAiBO,uBAAuB,EAAA;AAEzD,YAAA,MAAMc,gBAAmBC,GAAAA,IAAAA,CAAKC,IAAI,CAChCb,MAAOc,CAAAA,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eAAA,EACA,iBACAN,OACA,EAAA,yBAAA,CAAA;YAGF,IAAI;AACF,gBAAA,MAAMO,aAAgBC,GAAAA,EAAAA,CAAGC,YAAY,CAACR,gBAAkB,EAAA,MAAA,CAAA;gBAExD,MAAMS,MAAAA,GAAS,CAAC,MAAM,8FAAO,yBAAA,MAAsB,EAAGC,OAAO;AAE7D,gBAAA,MAAMC,YAAeC,GAAAA,CAAAA,CAAEC,QAAQ,CAACJ,MAAQ,CAAA,CAAA;AACtCK,oBAAAA,UAAAA,EAAYzB,MAAO0B,CAAAA,MAAM,CAACC,MAAM,CAACC,GAAG;AACpCC,oBAAAA,IAAAA,EAAMC,IAAKC,CAAAA,SAAS,CAACD,IAAAA,CAAKE,KAAK,CAACf,aAAAA,CAAAA;AAClC,iBAAA,CAAA;gBAEA,IAAI;AACF,oBAAA,MAAMgB,UAAarB,GAAAA,IAAAA,CAAKsB,OAAO,CAC7BlC,MAAOc,CAAAA,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eAAA,EACA,QACA,EAAA,YAAA,CAAA;oBAEF,MAAME,EAAAA,CAAGiB,UAAU,CAACF,UAAAA,CAAAA;oBACpB,MAAMf,EAAAA,CAAGkB,SAAS,CAACH,UAAYX,EAAAA,YAAAA,CAAAA;;oBAG/BlC,GAAIwC,CAAAA,GAAG,GAAGhB,IAAAA,CAAKyB,QAAQ,CAAC,CAAC,EAAEjD,GAAIwC,CAAAA,GAAG,CAAC,WAAW,CAAC,CAAA;oBAE/C,IAAI;wBACF,MAAMU,YAAAA,GAAe1B,IAAKsB,CAAAA,OAAO,CAC/BlC,MAAAA,CAAOc,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eACA,EAAA,QAAA,CAAA;wBAEF,OAAOuB,SAAAA,CAAUD,cAAclD,GAAKiB,EAAAA,IAAAA,CAAAA;AACtC,qBAAA,CAAE,OAAOmC,CAAG,EAAA;wBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,iBAAA,CAAE,OAAOA,CAAG,EAAA;oBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,aAAA,CAAE,OAAOA,CAAG,EAAA;gBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,SAAA,CAAE,OAAOA,CAAG,EAAA;YACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,KAAA;IAEA,MAAMC,SAAAA,CAAAA,CAAUrD,GAAgB,EAAEiB,IAAc,EAAA;;;AAG9C,QAAA,MAAMqC,UAAUC,OAAQ,CAAA,SAAA,CAAA;AAExB,QAAA,MAAM,EAAEzC,KAAK,EAAE,GAAGd,IAAIwD,KAAK;QAE3B,IAAI;YACF,MAAMxB,MAAAA,GAAS,CAAC,MAAM,8FAAO,yBAAA,MAAsB,EAAGC,OAAO;AAE7D,YAAA,MAAMC,eAAeC,CAAEC,CAAAA,QAAQ,CAACJ,MAAAA,CAAOyB,QAAQ,EAAI,CAAA,CAAA;gBACjDC,SAAW,EAAA,CAAC,EAAE9C,MAAAA,CAAO0B,MAAM,CAACC,MAAM,CAACC,GAAG,CAAC,oBAAoB;AAC7D,aAAA,CAAA;YAEA,MAAMmB,CAAAA,GAAIL,OAAQM,CAAAA,IAAI,CAAC1B,YAAAA,CAAAA;AAEvByB,YAAAA,CAAAA,CAAE,UAAUE,IAAI,CAAC1B,EAAE2B,OAAO,CAAChD,SAAS,EAAK,GAAA,mBAAA,CAAA;YAEzC,IAAI;AACF,gBAAA,MAAM+B,UAAarB,GAAAA,IAAAA,CAAKsB,OAAO,CAC7BlC,MAAOc,CAAAA,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eAAA,EACA,QACA,EAAA,YAAA,CAAA;gBAEF,MAAME,EAAAA,CAAGiB,UAAU,CAACF,UAAAA,CAAAA;AACpB,gBAAA,MAAMf,EAAGkB,CAAAA,SAAS,CAACH,UAAAA,EAAYc,EAAEI,IAAI,EAAA,CAAA;gBAErC/D,GAAIwC,CAAAA,GAAG,GAAGhB,IAAAA,CAAKyB,QAAQ,CAAC,CAAC,EAAEjD,GAAIwC,CAAAA,GAAG,CAAC,WAAW,CAAC,CAAA;gBAE/C,IAAI;oBACF,MAAMU,YAAAA,GAAe1B,IAAKsB,CAAAA,OAAO,CAAClC,MAAAA,CAAOc,IAAI,CAACC,GAAG,CAACC,UAAU,EAAE,eAAiB,EAAA,QAAA,CAAA;oBAC/E,OAAOuB,SAAAA,CAAUD,cAAclD,GAAKiB,EAAAA,IAAAA,CAAAA;AACtC,iBAAA,CAAE,OAAOmC,CAAG,EAAA;oBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,aAAA,CAAE,OAAOA,CAAG,EAAA;gBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,SAAA,CAAE,OAAOA,CAAG,EAAA;YACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,KAAA;AAEA,IAAA,MAAMY,OAAMhE,GAAgB,EAAA;QAC1B,MAAM,EACJiE,MAAM,EAAE1E,QAAQ,EAAE,EACnB,GAAGS,IAAIkE,OAAO;QAEf,MAAM,EAAE3E,UAAU4E,IAAI,EAAE,GAAI,MAAMvD,MAAAA,CAC/BwD,KAAK,CAAC;YAAEC,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA,eAAA;YAAiBC,GAAK,EAAA;AAAS,SAAA,CAAA,CAC7DC,GAAG,EAAA;AAEN,QAAA,MAAMC,OAAU,GAAA,MAAMC,MAAOC,CAAAA,OAAO,CAACpF,QAAU4E,EAAAA,IAAAA,CAAAA;AAE/C,QAAA,IAAIS,WAAc,GAAA,iBAAA;QAElB,IAAIH,OAAAA,IAAWzE,GAAI6E,CAAAA,OAAO,EAAE;YAC1B7E,GAAI6E,CAAAA,OAAO,CAAChD,aAAa,GAAG;gBAC1BiD,MAAQ,EAAA;AACV,aAAA;YAEAF,WAAc,GAAA,EAAA;AAChB;AAEA5E,QAAAA,GAAAA,CAAI+E,QAAQ,CAAC,CAAC,EAAEnE,OAAO0B,MAAM,CAACC,MAAM,CAACC,GAAG,CAAC,cAAc,EAAEoC,YAAY,CAAC,CAAA;AACxE,KAAA;AAEA,IAAA,MAAMI,eAAchF,GAAgB,EAAA;AAClC,QAAA,MAAM,EAAEsB,OAAO,EAAE,GAAGtB,GAAIkE,CAAAA,OAAO,CAACD,IAAI;AAEpC,QAAA,MAAMgB,UAAU/E,kBAAW,CAAA,eAAA,CAAA;QAE3B,MAAMgF,qBAAAA,GAAwBD,QAAQ7E,wBAAwB,EAAA,CAAG+E,GAAG,CAAC,CAACC,EAAOA,GAAAA,EAAAA,CAAG9D,OAAO,CAAA;QAEvF,IAAIa,CAAAA,CAAE2B,OAAO,CAACxC,OAAU,CAAA,EAAA;YACtB,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,2BAAA,CAAA;AACxB;AAEA,QAAA,IAAI,CAACmE,qBAAAA,CAAsBG,QAAQ,CAAC/D,OAAU,CAAA,EAAA;YAC5C,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,wDAAA,CAAA;AACxB;QAEA,IAAI;YACFH,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,KAAA;YAC3B,MAAMN,OAAAA,CAAQO,eAAe,CAAClE,OAAAA,CAAAA;AAC9BtB,YAAAA,GAAAA,CAAIO,IAAI,CAAC;gBAAEkF,EAAI,EAAA;AAAK,aAAA,CAAA;SACZ,QAAA;YACR7E,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,IAAA;AAC7B;AACF,KAAA;AAEA,IAAA,MAAMG,WAAU1F,GAAgB,EAAA;AAC9B,QAAA,MAAM,EAAEsB,OAAO,EAAE,GAAGtB,IAAIqB,MAAM;AAE9B,QAAA,MAAM4D,UAAU/E,kBAAW,CAAA,eAAA,CAAA;QAE3B,MAAMgF,qBAAAA,GAAwBD,QAAQ7E,wBAAwB,EAAA,CAAG+E,GAAG,CAAC,CAACC,EAAOA,GAAAA,EAAAA,CAAG9D,OAAO,CAAA;QAEvF,IAAIa,CAAAA,CAAE2B,OAAO,CAACxC,OAAU,CAAA,EAAA;YACtB,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,2BAAA,CAAA;AACxB;AAEA,QAAA,IAAI,CAACmE,qBAAAA,CAAsBG,QAAQ,CAAC/D,OAAU,CAAA,EAAA;YAC5C,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,sDAAA,CAAA;AACxB;QAEA,IAAI;YACFH,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,KAAA;YAC3B,MAAMN,OAAAA,CAAQU,mBAAmB,CAACrE,OAAAA,CAAAA;AAClCtB,YAAAA,GAAAA,CAAIO,IAAI,CAAC;gBAAEkF,EAAI,EAAA;AAAK,aAAA,CAAA;SACZ,QAAA;YACR7E,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,IAAA;AAC7B;AACF,KAAA;AAEA,IAAA,MAAMK,gBAAe5F,GAAgB,EAAA;QACnC,MAAM6F,WAAAA,GAAcjF,MAAOwD,CAAAA,KAAK,CAAC;YAAEC,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA;AAAgB,SAAA,CAAA;QAEzE,MAAMwB,IAAAA,GAAO,MAAM/G,UAAWC,CAAAA,gBAAgB,CAACgB,GAAIkE,CAAAA,OAAO,CAACD,IAAI,CAAA;AAE/D,QAAA,MAAM3B,MAAiB,GAAA;YACrBjD,gBAAkB0G,EAAAA,OAAAA,CAAQD,KAAKzG,gBAAgB;AACjD,SAAA;QAEA,IAAIyG,IAAAA,CAAKvG,QAAQ,EAAE;YACjB+C,MAAO/C,CAAAA,QAAQ,GAAG,MAAMmF,MAAAA,CAAOP,IAAI,CAAC2B,IAAAA,CAAKvG,QAAQ,EAAE,EAAA,CAAA;AACrD;QAEA,MAAMsG,WAAAA,CAAYG,GAAG,CAAC;YAAEzB,GAAK,EAAA,QAAA;YAAU3E,KAAO0C,EAAAA;AAAO,SAAA,CAAA;QAErD,OAAOtC,GAAAA,CAAIO,IAAI,CAAC;YAAEkF,EAAI,EAAA;AAAK,SAAA,CAAA;AAC7B;AACF,CAAE;;;;"}

package/dist/server/controllers/documentation.mjs

@@ -0,0 +1,181 @@
+import path from 'path';
+import bcrypt from 'bcryptjs';
+import fs from 'fs-extra';
+import _ from 'lodash';
+import koaStatic from 'koa-static';
+import { validateYupSchema, yup } from '@strapi/utils';
+import { getService } from '../utils.mjs';
+
+const validation = {
+    validateSettings: validateYupSchema(yup.object().shape({
+        restrictedAccess: yup.boolean(),
+        password: yup.string().min(8).matches(/[a-z]/, '${path} must contain at least one lowercase character').matches(/[A-Z]/, '${path} must contain at least one uppercase character').matches(/\d/, '${path} must contain at least one number').when('restrictedAccess', (value, initSchema)=>{
+            return value ? initSchema.required('password is required') : initSchema;
+        })
+    }))
+};
+var documentation = {
+    async getInfos (ctx) {
+        try {
+            const docService = getService('documentation');
+            const docVersions = docService.getDocumentationVersions();
+            const documentationAccess = await docService.getDocumentationAccess();
+            ctx.send({
+                docVersions,
+                currentVersion: docService.getDocumentationVersion(),
+                prefix: '/documentation',
+                documentationAccess
+            });
+        } catch (err) {
+            strapi.log.error(err);
+            ctx.badRequest();
+        }
+    },
+    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}` : getService('documentation').getDocumentationVersion();
+            const openAPISpecsPath = path.join(strapi.dirs.app.extensions, 'documentation', 'documentation', version, 'full_documentation.json');
+            try {
+                const documentation = fs.readFileSync(openAPISpecsPath, 'utf8');
+                const layout = (await import('../public/index.html.mjs')).default;
+                const filledLayout = _.template(layout)({
+                    backendUrl: strapi.config.server.url,
+                    spec: JSON.stringify(JSON.parse(documentation))
+                });
+                try {
+                    const layoutPath = path.resolve(strapi.dirs.app.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.dirs.app.extensions, 'documentation', 'public');
+                        return 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) {
+        // lazy require cheerio
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const cheerio = require('cheerio');
+        const { error } = ctx.query;
+        try {
+            const layout = (await import('../public/login.html.mjs')).default;
+            const filledLayout = _.template(layout.toString())({
+                actionUrl: `${strapi.config.server.url}/documentation/login`
+            });
+            const $ = cheerio.load(filledLayout);
+            $('.error').text(_.isEmpty(error) ? '' : 'Wrong password...');
+            try {
+                const layoutPath = path.resolve(strapi.dirs.app.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.dirs.app.extensions, 'documentation', 'public');
+                    return 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: hash } = await strapi.store({
+            type: 'plugin',
+            name: 'documentation',
+            key: 'config'
+        }).get();
+        const isValid = await bcrypt.compare(password, hash);
+        let querystring = '?error=password';
+        if (isValid && ctx.session) {
+            ctx.session.documentation = {
+                logged: true
+            };
+            querystring = '';
+        }
+        ctx.redirect(`${strapi.config.server.url}/documentation${querystring}`);
+    },
+    async regenerateDoc (ctx) {
+        const { version } = ctx.request.body;
+        const service = getService('documentation');
+        const documentationVersions = service.getDocumentationVersions().map((el)=>el.version);
+        if (_.isEmpty(version)) {
+            return ctx.badRequest('Please provide a version.');
+        }
+        if (!documentationVersions.includes(version)) {
+            return ctx.badRequest('The version you are trying to generate does not exist.');
+        }
+        try {
+            strapi.reload.isWatching = false;
+            await service.generateFullDoc(version);
+            ctx.send({
+                ok: true
+            });
+        } finally{
+            strapi.reload.isWatching = true;
+        }
+    },
+    async deleteDoc (ctx) {
+        const { version } = ctx.params;
+        const service = getService('documentation');
+        const documentationVersions = service.getDocumentationVersions().map((el)=>el.version);
+        if (_.isEmpty(version)) {
+            return ctx.badRequest('Please provide a version.');
+        }
+        if (!documentationVersions.includes(version)) {
+            return ctx.badRequest('The version you are trying to delete does not exist.');
+        }
+        try {
+            strapi.reload.isWatching = false;
+            await service.deleteDocumentation(version);
+            ctx.send({
+                ok: true
+            });
+        } finally{
+            strapi.reload.isWatching = true;
+        }
+    },
+    async updateSettings (ctx) {
+        const pluginStore = strapi.store({
+            type: 'plugin',
+            name: 'documentation'
+        });
+        const data = await validation.validateSettings(ctx.request.body);
+        const config = {
+            restrictedAccess: Boolean(data.restrictedAccess)
+        };
+        if (data.password) {
+            config.password = await bcrypt.hash(data.password, 10);
+        }
+        await pluginStore.set({
+            key: 'config',
+            value: config
+        });
+        return ctx.send({
+            ok: true
+        });
+    }
+};
+
+export { documentation as default };
+//# sourceMappingURL=documentation.mjs.map

package/dist/server/controllers/documentation.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentation.mjs","sources":["../../../server/src/controllers/documentation.ts"],"sourcesContent":["import path from 'path';\nimport bcrypt from 'bcryptjs';\nimport fs from 'fs-extra';\nimport _ from 'lodash';\nimport koaStatic from 'koa-static';\nimport { yup, validateYupSchema } from '@strapi/utils';\n\nimport type Koa from 'koa';\nimport type {} from 'koa-body';\n\nimport { getService } from '../utils';\nimport type { Config } from '../types';\n\nconst validation = {\n  validateSettings: validateYupSchema(\n    yup.object().shape({\n      restrictedAccess: yup.boolean(),\n      password: yup\n        .string()\n        .min(8)\n        .matches(/[a-z]/, '${path} must contain at least one lowercase character')\n        .matches(/[A-Z]/, '${path} must contain at least one uppercase character')\n        .matches(/\\d/, '${path} must contain at least one number')\n        .when('restrictedAccess', (value, initSchema) => {\n          return value ? initSchema.required('password is required') : initSchema;\n        }),\n    })\n  ),\n};\n\nexport default {\n  async getInfos(ctx: Koa.Context) {\n    try {\n      const docService = getService('documentation');\n      const docVersions = docService.getDocumentationVersions();\n      const documentationAccess = await docService.getDocumentationAccess();\n\n      ctx.send({\n        docVersions,\n        currentVersion: docService.getDocumentationVersion(),\n        prefix: '/documentation',\n        documentationAccess,\n      });\n    } catch (err) {\n      strapi.log.error(err);\n      ctx.badRequest();\n    }\n  },\n\n  async index(ctx: Koa.Context, next: Koa.Next) {\n    try {\n      /**\n       * We don't expose the specs using koa-static or something else due to security reasons.\n       * That's why, we need to read the file localy and send the specs through it when we serve the Swagger UI.\n       */\n      const { major, minor, patch } = ctx.params;\n      const version =\n        major && minor && patch\n          ? `${major}.${minor}.${patch}`\n          : getService('documentation').getDocumentationVersion();\n\n      const openAPISpecsPath = path.join(\n        strapi.dirs.app.extensions,\n        'documentation',\n        'documentation',\n        version,\n        'full_documentation.json'\n      );\n\n      try {\n        const documentation = fs.readFileSync(openAPISpecsPath, 'utf8');\n\n        const layout = (await import('../public/index.html')).default;\n\n        const filledLayout = _.template(layout)({\n          backendUrl: strapi.config.server.url,\n          spec: JSON.stringify(JSON.parse(documentation)),\n        });\n\n        try {\n          const layoutPath = path.resolve(\n            strapi.dirs.app.extensions,\n            'documentation',\n            'public',\n            'index.html'\n          );\n          await fs.ensureFile(layoutPath);\n          await fs.writeFile(layoutPath, filledLayout);\n\n          // Serve the file.\n          ctx.url = path.basename(`${ctx.url}/index.html`);\n\n          try {\n            const staticFolder = path.resolve(\n              strapi.dirs.app.extensions,\n              'documentation',\n              'public'\n            );\n            return koaStatic(staticFolder)(ctx, next);\n          } catch (e) {\n            strapi.log.error(e);\n          }\n        } catch (e) {\n          strapi.log.error(e);\n        }\n      } catch (e) {\n        strapi.log.error(e);\n      }\n    } catch (e) {\n      strapi.log.error(e);\n    }\n  },\n\n  async loginView(ctx: Koa.Context, next: Koa.Next) {\n    // lazy require cheerio\n    // eslint-disable-next-line @typescript-eslint/no-var-requires\n    const cheerio = require('cheerio');\n\n    const { error } = ctx.query;\n\n    try {\n      const layout = (await import('../public/login.html')).default;\n\n      const filledLayout = _.template(layout.toString())({\n        actionUrl: `${strapi.config.server.url}/documentation/login`,\n      });\n\n      const $ = cheerio.load(filledLayout);\n\n      $('.error').text(_.isEmpty(error) ? '' : 'Wrong password...');\n\n      try {\n        const layoutPath = path.resolve(\n          strapi.dirs.app.extensions,\n          'documentation',\n          'public',\n          'login.html'\n        );\n        await fs.ensureFile(layoutPath);\n        await fs.writeFile(layoutPath, $.html());\n\n        ctx.url = path.basename(`${ctx.url}/login.html`);\n\n        try {\n          const staticFolder = path.resolve(strapi.dirs.app.extensions, 'documentation', 'public');\n          return koaStatic(staticFolder)(ctx, next);\n        } catch (e) {\n          strapi.log.error(e);\n        }\n      } catch (e) {\n        strapi.log.error(e);\n      }\n    } catch (e) {\n      strapi.log.error(e);\n    }\n  },\n\n  async login(ctx: Koa.Context) {\n    const {\n      body: { password },\n    } = ctx.request;\n\n    const { password: hash } = (await strapi\n      .store({ type: 'plugin', name: 'documentation', key: 'config' })\n      .get()) as { password: string };\n\n    const isValid = await bcrypt.compare(password, hash);\n\n    let querystring = '?error=password';\n\n    if (isValid && ctx.session) {\n      ctx.session.documentation = {\n        logged: true,\n      };\n\n      querystring = '';\n    }\n\n    ctx.redirect(`${strapi.config.server.url}/documentation${querystring}`);\n  },\n\n  async regenerateDoc(ctx: Koa.Context) {\n    const { version } = ctx.request.body;\n\n    const service = getService('documentation');\n\n    const documentationVersions = service.getDocumentationVersions().map((el) => el.version);\n\n    if (_.isEmpty(version)) {\n      return ctx.badRequest('Please provide a version.');\n    }\n\n    if (!documentationVersions.includes(version)) {\n      return ctx.badRequest('The version you are trying to generate does not exist.');\n    }\n\n    try {\n      strapi.reload.isWatching = false;\n      await service.generateFullDoc(version);\n      ctx.send({ ok: true });\n    } finally {\n      strapi.reload.isWatching = true;\n    }\n  },\n\n  async deleteDoc(ctx: Koa.Context) {\n    const { version } = ctx.params;\n\n    const service = getService('documentation');\n\n    const documentationVersions = service.getDocumentationVersions().map((el) => el.version);\n\n    if (_.isEmpty(version)) {\n      return ctx.badRequest('Please provide a version.');\n    }\n\n    if (!documentationVersions.includes(version)) {\n      return ctx.badRequest('The version you are trying to delete does not exist.');\n    }\n\n    try {\n      strapi.reload.isWatching = false;\n      await service.deleteDocumentation(version);\n      ctx.send({ ok: true });\n    } finally {\n      strapi.reload.isWatching = true;\n    }\n  },\n\n  async updateSettings(ctx: Koa.Context) {\n    const pluginStore = strapi.store({ type: 'plugin', name: 'documentation' });\n\n    const data = await validation.validateSettings(ctx.request.body);\n\n    const config: Config = {\n      restrictedAccess: Boolean(data.restrictedAccess),\n    };\n\n    if (data.password) {\n      config.password = await bcrypt.hash(data.password, 10);\n    }\n\n    await pluginStore.set({ key: 'config', value: config });\n\n    return ctx.send({ ok: true });\n  },\n};\n"],"names":["validation","validateSettings","validateYupSchema","yup","object","shape","restrictedAccess","boolean","password","string","min","matches","when","value","initSchema","required","getInfos","ctx","docService","getService","docVersions","getDocumentationVersions","documentationAccess","getDocumentationAccess","send","currentVersion","getDocumentationVersion","prefix","err","strapi","log","error","badRequest","index","next","major","minor","patch","params","version","openAPISpecsPath","path","join","dirs","app","extensions","documentation","fs","readFileSync","layout","default","filledLayout","_","template","backendUrl","config","server","url","spec","JSON","stringify","parse","layoutPath","resolve","ensureFile","writeFile","basename","staticFolder","koaStatic","e","loginView","cheerio","require","query","toString","actionUrl","$","load","text","isEmpty","html","login","body","request","hash","store","type","name","key","get","isValid","bcrypt","compare","querystring","session","logged","redirect","regenerateDoc","service","documentationVersions","map","el","includes","reload","isWatching","generateFullDoc","ok","deleteDoc","deleteDocumentation","updateSettings","pluginStore","data","Boolean","set"],"mappings":";;;;;;;;AAaA,MAAMA,UAAa,GAAA;AACjBC,IAAAA,gBAAAA,EAAkBC,iBAChBC,CAAAA,GAAAA,CAAIC,MAAM,EAAA,CAAGC,KAAK,CAAC;AACjBC,QAAAA,gBAAAA,EAAkBH,IAAII,OAAO,EAAA;QAC7BC,QAAUL,EAAAA,GAAAA,CACPM,MAAM,EACNC,CAAAA,GAAG,CAAC,CACJC,CAAAA,CAAAA,OAAO,CAAC,OAAA,EAAS,uDACjBA,CAAAA,CAAAA,OAAO,CAAC,OAAS,EAAA,uDAAA,CAAA,CACjBA,OAAO,CAAC,IAAA,EAAM,4CACdC,IAAI,CAAC,kBAAoB,EAAA,CAACC,KAAOC,EAAAA,UAAAA,GAAAA;AAChC,YAAA,OAAOD,KAAQC,GAAAA,UAAAA,CAAWC,QAAQ,CAAC,sBAA0BD,CAAAA,GAAAA,UAAAA;AAC/D,SAAA;AACJ,KAAA,CAAA;AAEJ,CAAA;AAEA,oBAAe;AACb,IAAA,MAAME,UAASC,GAAgB,EAAA;QAC7B,IAAI;AACF,YAAA,MAAMC,aAAaC,UAAW,CAAA,eAAA,CAAA;YAC9B,MAAMC,WAAAA,GAAcF,WAAWG,wBAAwB,EAAA;YACvD,MAAMC,mBAAAA,GAAsB,MAAMJ,UAAAA,CAAWK,sBAAsB,EAAA;AAEnEN,YAAAA,GAAAA,CAAIO,IAAI,CAAC;AACPJ,gBAAAA,WAAAA;AACAK,gBAAAA,cAAAA,EAAgBP,WAAWQ,uBAAuB,EAAA;gBAClDC,MAAQ,EAAA,gBAAA;AACRL,gBAAAA;AACF,aAAA,CAAA;AACF,SAAA,CAAE,OAAOM,GAAK,EAAA;YACZC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACH,GAAAA,CAAAA;AACjBX,YAAAA,GAAAA,CAAIe,UAAU,EAAA;AAChB;AACF,KAAA;IAEA,MAAMC,KAAAA,CAAAA,CAAMhB,GAAgB,EAAEiB,IAAc,EAAA;QAC1C,IAAI;AACF;;;UAIA,MAAM,EAAEC,KAAK,EAAEC,KAAK,EAAEC,KAAK,EAAE,GAAGpB,GAAAA,CAAIqB,MAAM;AAC1C,YAAA,MAAMC,UACJJ,KAASC,IAAAA,KAAAA,IAASC,KACd,GAAA,CAAC,EAAEF,KAAM,CAAA,CAAC,EAAEC,KAAAA,CAAM,CAAC,EAAEC,KAAAA,CAAM,CAAC,GAC5BlB,UAAAA,CAAW,iBAAiBO,uBAAuB,EAAA;AAEzD,YAAA,MAAMc,gBAAmBC,GAAAA,IAAAA,CAAKC,IAAI,CAChCb,MAAOc,CAAAA,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eAAA,EACA,iBACAN,OACA,EAAA,yBAAA,CAAA;YAGF,IAAI;AACF,gBAAA,MAAMO,aAAgBC,GAAAA,EAAAA,CAAGC,YAAY,CAACR,gBAAkB,EAAA,MAAA,CAAA;gBAExD,MAAMS,MAAAA,GAAS,CAAC,MAAM,OAAO,0BAAA,CAAsB,EAAGC,OAAO;AAE7D,gBAAA,MAAMC,YAAeC,GAAAA,CAAAA,CAAEC,QAAQ,CAACJ,MAAQ,CAAA,CAAA;AACtCK,oBAAAA,UAAAA,EAAYzB,MAAO0B,CAAAA,MAAM,CAACC,MAAM,CAACC,GAAG;AACpCC,oBAAAA,IAAAA,EAAMC,IAAKC,CAAAA,SAAS,CAACD,IAAAA,CAAKE,KAAK,CAACf,aAAAA,CAAAA;AAClC,iBAAA,CAAA;gBAEA,IAAI;AACF,oBAAA,MAAMgB,UAAarB,GAAAA,IAAAA,CAAKsB,OAAO,CAC7BlC,MAAOc,CAAAA,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eAAA,EACA,QACA,EAAA,YAAA,CAAA;oBAEF,MAAME,EAAAA,CAAGiB,UAAU,CAACF,UAAAA,CAAAA;oBACpB,MAAMf,EAAAA,CAAGkB,SAAS,CAACH,UAAYX,EAAAA,YAAAA,CAAAA;;oBAG/BlC,GAAIwC,CAAAA,GAAG,GAAGhB,IAAAA,CAAKyB,QAAQ,CAAC,CAAC,EAAEjD,GAAIwC,CAAAA,GAAG,CAAC,WAAW,CAAC,CAAA;oBAE/C,IAAI;wBACF,MAAMU,YAAAA,GAAe1B,IAAKsB,CAAAA,OAAO,CAC/BlC,MAAAA,CAAOc,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eACA,EAAA,QAAA,CAAA;wBAEF,OAAOuB,SAAAA,CAAUD,cAAclD,GAAKiB,EAAAA,IAAAA,CAAAA;AACtC,qBAAA,CAAE,OAAOmC,CAAG,EAAA;wBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,iBAAA,CAAE,OAAOA,CAAG,EAAA;oBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,aAAA,CAAE,OAAOA,CAAG,EAAA;gBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,SAAA,CAAE,OAAOA,CAAG,EAAA;YACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,KAAA;IAEA,MAAMC,SAAAA,CAAAA,CAAUrD,GAAgB,EAAEiB,IAAc,EAAA;;;AAG9C,QAAA,MAAMqC,UAAUC,OAAQ,CAAA,SAAA,CAAA;AAExB,QAAA,MAAM,EAAEzC,KAAK,EAAE,GAAGd,IAAIwD,KAAK;QAE3B,IAAI;YACF,MAAMxB,MAAAA,GAAS,CAAC,MAAM,OAAO,0BAAA,CAAsB,EAAGC,OAAO;AAE7D,YAAA,MAAMC,eAAeC,CAAEC,CAAAA,QAAQ,CAACJ,MAAAA,CAAOyB,QAAQ,EAAI,CAAA,CAAA;gBACjDC,SAAW,EAAA,CAAC,EAAE9C,MAAAA,CAAO0B,MAAM,CAACC,MAAM,CAACC,GAAG,CAAC,oBAAoB;AAC7D,aAAA,CAAA;YAEA,MAAMmB,CAAAA,GAAIL,OAAQM,CAAAA,IAAI,CAAC1B,YAAAA,CAAAA;AAEvByB,YAAAA,CAAAA,CAAE,UAAUE,IAAI,CAAC1B,EAAE2B,OAAO,CAAChD,SAAS,EAAK,GAAA,mBAAA,CAAA;YAEzC,IAAI;AACF,gBAAA,MAAM+B,UAAarB,GAAAA,IAAAA,CAAKsB,OAAO,CAC7BlC,MAAOc,CAAAA,IAAI,CAACC,GAAG,CAACC,UAAU,EAC1B,eAAA,EACA,QACA,EAAA,YAAA,CAAA;gBAEF,MAAME,EAAAA,CAAGiB,UAAU,CAACF,UAAAA,CAAAA;AACpB,gBAAA,MAAMf,EAAGkB,CAAAA,SAAS,CAACH,UAAAA,EAAYc,EAAEI,IAAI,EAAA,CAAA;gBAErC/D,GAAIwC,CAAAA,GAAG,GAAGhB,IAAAA,CAAKyB,QAAQ,CAAC,CAAC,EAAEjD,GAAIwC,CAAAA,GAAG,CAAC,WAAW,CAAC,CAAA;gBAE/C,IAAI;oBACF,MAAMU,YAAAA,GAAe1B,IAAKsB,CAAAA,OAAO,CAAClC,MAAAA,CAAOc,IAAI,CAACC,GAAG,CAACC,UAAU,EAAE,eAAiB,EAAA,QAAA,CAAA;oBAC/E,OAAOuB,SAAAA,CAAUD,cAAclD,GAAKiB,EAAAA,IAAAA,CAAAA;AACtC,iBAAA,CAAE,OAAOmC,CAAG,EAAA;oBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,aAAA,CAAE,OAAOA,CAAG,EAAA;gBACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,SAAA,CAAE,OAAOA,CAAG,EAAA;YACVxC,MAAOC,CAAAA,GAAG,CAACC,KAAK,CAACsC,CAAAA,CAAAA;AACnB;AACF,KAAA;AAEA,IAAA,MAAMY,OAAMhE,GAAgB,EAAA;QAC1B,MAAM,EACJiE,MAAM,EAAE1E,QAAQ,EAAE,EACnB,GAAGS,IAAIkE,OAAO;QAEf,MAAM,EAAE3E,UAAU4E,IAAI,EAAE,GAAI,MAAMvD,MAAAA,CAC/BwD,KAAK,CAAC;YAAEC,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA,eAAA;YAAiBC,GAAK,EAAA;AAAS,SAAA,CAAA,CAC7DC,GAAG,EAAA;AAEN,QAAA,MAAMC,OAAU,GAAA,MAAMC,MAAOC,CAAAA,OAAO,CAACpF,QAAU4E,EAAAA,IAAAA,CAAAA;AAE/C,QAAA,IAAIS,WAAc,GAAA,iBAAA;QAElB,IAAIH,OAAAA,IAAWzE,GAAI6E,CAAAA,OAAO,EAAE;YAC1B7E,GAAI6E,CAAAA,OAAO,CAAChD,aAAa,GAAG;gBAC1BiD,MAAQ,EAAA;AACV,aAAA;YAEAF,WAAc,GAAA,EAAA;AAChB;AAEA5E,QAAAA,GAAAA,CAAI+E,QAAQ,CAAC,CAAC,EAAEnE,OAAO0B,MAAM,CAACC,MAAM,CAACC,GAAG,CAAC,cAAc,EAAEoC,YAAY,CAAC,CAAA;AACxE,KAAA;AAEA,IAAA,MAAMI,eAAchF,GAAgB,EAAA;AAClC,QAAA,MAAM,EAAEsB,OAAO,EAAE,GAAGtB,GAAIkE,CAAAA,OAAO,CAACD,IAAI;AAEpC,QAAA,MAAMgB,UAAU/E,UAAW,CAAA,eAAA,CAAA;QAE3B,MAAMgF,qBAAAA,GAAwBD,QAAQ7E,wBAAwB,EAAA,CAAG+E,GAAG,CAAC,CAACC,EAAOA,GAAAA,EAAAA,CAAG9D,OAAO,CAAA;QAEvF,IAAIa,CAAAA,CAAE2B,OAAO,CAACxC,OAAU,CAAA,EAAA;YACtB,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,2BAAA,CAAA;AACxB;AAEA,QAAA,IAAI,CAACmE,qBAAAA,CAAsBG,QAAQ,CAAC/D,OAAU,CAAA,EAAA;YAC5C,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,wDAAA,CAAA;AACxB;QAEA,IAAI;YACFH,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,KAAA;YAC3B,MAAMN,OAAAA,CAAQO,eAAe,CAAClE,OAAAA,CAAAA;AAC9BtB,YAAAA,GAAAA,CAAIO,IAAI,CAAC;gBAAEkF,EAAI,EAAA;AAAK,aAAA,CAAA;SACZ,QAAA;YACR7E,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,IAAA;AAC7B;AACF,KAAA;AAEA,IAAA,MAAMG,WAAU1F,GAAgB,EAAA;AAC9B,QAAA,MAAM,EAAEsB,OAAO,EAAE,GAAGtB,IAAIqB,MAAM;AAE9B,QAAA,MAAM4D,UAAU/E,UAAW,CAAA,eAAA,CAAA;QAE3B,MAAMgF,qBAAAA,GAAwBD,QAAQ7E,wBAAwB,EAAA,CAAG+E,GAAG,CAAC,CAACC,EAAOA,GAAAA,EAAAA,CAAG9D,OAAO,CAAA;QAEvF,IAAIa,CAAAA,CAAE2B,OAAO,CAACxC,OAAU,CAAA,EAAA;YACtB,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,2BAAA,CAAA;AACxB;AAEA,QAAA,IAAI,CAACmE,qBAAAA,CAAsBG,QAAQ,CAAC/D,OAAU,CAAA,EAAA;YAC5C,OAAOtB,GAAAA,CAAIe,UAAU,CAAC,sDAAA,CAAA;AACxB;QAEA,IAAI;YACFH,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,KAAA;YAC3B,MAAMN,OAAAA,CAAQU,mBAAmB,CAACrE,OAAAA,CAAAA;AAClCtB,YAAAA,GAAAA,CAAIO,IAAI,CAAC;gBAAEkF,EAAI,EAAA;AAAK,aAAA,CAAA;SACZ,QAAA;YACR7E,MAAO0E,CAAAA,MAAM,CAACC,UAAU,GAAG,IAAA;AAC7B;AACF,KAAA;AAEA,IAAA,MAAMK,gBAAe5F,GAAgB,EAAA;QACnC,MAAM6F,WAAAA,GAAcjF,MAAOwD,CAAAA,KAAK,CAAC;YAAEC,IAAM,EAAA,QAAA;YAAUC,IAAM,EAAA;AAAgB,SAAA,CAAA;QAEzE,MAAMwB,IAAAA,GAAO,MAAM/G,UAAWC,CAAAA,gBAAgB,CAACgB,GAAIkE,CAAAA,OAAO,CAACD,IAAI,CAAA;AAE/D,QAAA,MAAM3B,MAAiB,GAAA;YACrBjD,gBAAkB0G,EAAAA,OAAAA,CAAQD,KAAKzG,gBAAgB;AACjD,SAAA;QAEA,IAAIyG,IAAAA,CAAKvG,QAAQ,EAAE;YACjB+C,MAAO/C,CAAAA,QAAQ,GAAG,MAAMmF,MAAAA,CAAOP,IAAI,CAAC2B,IAAAA,CAAKvG,QAAQ,EAAE,EAAA,CAAA;AACrD;QAEA,MAAMsG,WAAAA,CAAYG,GAAG,CAAC;YAAEzB,GAAK,EAAA,QAAA;YAAU3E,KAAO0C,EAAAA;AAAO,SAAA,CAAA;QAErD,OAAOtC,GAAAA,CAAIO,IAAI,CAAC;YAAEkF,EAAI,EAAA;AAAK,SAAA,CAAA;AAC7B;AACF,CAAE;;;;"}

package/dist/server/controllers/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var documentation = require('./documentation.js');
+
+var controllers = {
+    documentation
+};
+
+module.exports = controllers;
+//# sourceMappingURL=index.js.map

package/dist/server/controllers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../../server/src/controllers/index.ts"],"sourcesContent":["import documentation from './documentation';\n\nexport default {\n  documentation,\n};\n"],"names":["documentation"],"mappings":";;;;AAEA,kBAAe;AACbA,IAAAA;AACF,CAAE;;;;"}

package/dist/server/controllers/index.mjs

@@ -0,0 +1,8 @@
+import documentation from './documentation.mjs';
+
+var controllers = {
+    documentation
+};
+
+export { controllers as default };
+//# sourceMappingURL=index.mjs.map

package/dist/server/controllers/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../../server/src/controllers/index.ts"],"sourcesContent":["import documentation from './documentation';\n\nexport default {\n  documentation,\n};\n"],"names":["documentation"],"mappings":";;AAEA,kBAAe;AACbA,IAAAA;AACF,CAAE;;;;"}