@strapi/plugin-documentation 4.0.5 → 4.1.0

package/admin/src/translations/dk.json

@@ -1,42 +1,42 @@
 {
-    "coming-soon": "Indholdet er på nuværende tidspunkt under konstruktion og kommer tilbage om et par uger!",
-    "components.Row.open": "Åben",
-    "components.Row.regenerate": "Regenerér",
-    "containers.HomePage.Block.title": "Versioner",
-    "containers.HomePage.Button.update": "Opdatér",
-    "containers.HomePage.PluginHeader.title": "Dokumentation - Indstillinger",
-    "containers.HomePage.PopUpWarning.confirm": "Jeg forstår",
-    "containers.HomePage.PopUpWarning.message": "Er du sikker på at du vil slette denne version?",
-    "containers.HomePage.copied": "Token kopieret til klippebord",
-    "containers.HomePage.form.jwtToken": "Hent dit jwt token",
-    "containers.HomePage.form.jwtToken.description": "Kopier dette token og brug det i swagger når du laver requests",
-    "containers.HomePage.form.password": "Kodeord",
-    "containers.HomePage.form.password.inputDescription": "Indstil kodeordet for at tilgå dokumentationen",
-    "containers.HomePage.form.restrictedAccess": "Begrænset adgang",
-    "containers.HomePage.form.restrictedAccess.inputDescription": "Gør dokumentationens endpoint private. Som standard er det offentligt",
-    "containers.HomePage.form.showGeneratedFiles": "Vis genererede filer",
-    "containers.HomePage.form.showGeneratedFiles.inputDescription": "Nyttig når du vil overskrive den genererede dokumentation. \nPluginnet vil generere filter splittet af model og plugin. \nVed at aktivere denne option bliver det nemmere at tilpasse din dokumentation",
-    "error.deleteDoc.versionMissing": "Versionen du prøver at slette, findes ikke.",
-    "error.noVersion": "En version er påkrævet",
-    "error.regenerateDoc": "Der opstod en fejl ved generering af dokumentation",
-    "error.regenerateDoc.versionMissing": "Versionen du forsøger at generere findes ikke",
-    "notification.delete.success": "Dokumentation slettet",
-    "notification.generate.success": "Dokumentation genereret",
-    "notification.update.success": "Indstillingerne er opdateret",
-    "pages.PluginPage.Button.open": "Åben dokumentation",
-    "pages.PluginPage.header.description": "Konfigurér dokumentations pluginnet",
-    "pages.PluginPage.table.generated": "Sidst genereret",
-    "pages.PluginPage.table.icon.delete": "Slet {target}",
-    "pages.PluginPage.table.icon.regenerate": "Regenerér {target}",
-    "pages.PluginPage.table.icon.show": "Åben {target}",
-    "pages.PluginPage.table.version": "Version",
-    "pages.SettingsPage.title": "Indstillinger",
-    "pages.SettingsPage.Button.description": "Konfigurér dokumentations pluginnet",
-    "pages.SettingsPage.header.save": "Gem",
-    "pages.SettingsPage.password.label": "Kodeord",
-    "pages.SettingsPage.toggle.hint": "Gør dokumentationens endpoint privat",
-    "pages.SettingsPage.toggle.label": "Begrænset adgang",
-    "plugin.description.long": "Opret et OpenAPI dokument og visualisér dit API med SWAGGER UI.",
-    "plugin.description.short": "Opret et OpenAPI dokument og visualisér dit API med SWAGGER UI.",
-    "plugin.name": "Dokumentation"
+  "coming-soon": "Indholdet er på nuværende tidspunkt under konstruktion og kommer tilbage om et par uger!",
+  "components.Row.open": "Åben",
+  "components.Row.regenerate": "Regenerér",
+  "containers.HomePage.Block.title": "Versioner",
+  "containers.HomePage.Button.update": "Opdatér",
+  "containers.HomePage.PluginHeader.title": "Dokumentation - Indstillinger",
+  "containers.HomePage.PopUpWarning.confirm": "Jeg forstår",
+  "containers.HomePage.PopUpWarning.message": "Er du sikker på at du vil slette denne version?",
+  "containers.HomePage.copied": "Token kopieret til klippebord",
+  "containers.HomePage.form.jwtToken": "Hent dit jwt token",
+  "containers.HomePage.form.jwtToken.description": "Kopier dette token og brug det i swagger når du laver requests",
+  "containers.HomePage.form.password": "Kodeord",
+  "containers.HomePage.form.password.inputDescription": "Indstil kodeordet for at tilgå dokumentationen",
+  "containers.HomePage.form.restrictedAccess": "Begrænset adgang",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "Gør dokumentationens endpoint private. Som standard er det offentligt",
+  "containers.HomePage.form.showGeneratedFiles": "Vis genererede filer",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Nyttig når du vil overskrive den genererede dokumentation. \nPluginnet vil generere filter splittet af model og plugin. \nVed at aktivere denne option bliver det nemmere at tilpasse din dokumentation",
+  "error.deleteDoc.versionMissing": "Versionen du prøver at slette, findes ikke.",
+  "error.noVersion": "En version er påkrævet",
+  "error.regenerateDoc": "Der opstod en fejl ved generering af dokumentation",
+  "error.regenerateDoc.versionMissing": "Versionen du forsøger at generere findes ikke",
+  "notification.delete.success": "Dokumentation slettet",
+  "notification.generate.success": "Dokumentation genereret",
+  "notification.update.success": "Indstillingerne er opdateret",
+  "pages.PluginPage.Button.open": "Åben dokumentation",
+  "pages.PluginPage.header.description": "Konfigurér dokumentations pluginnet",
+  "pages.PluginPage.table.generated": "Sidst genereret",
+  "pages.PluginPage.table.icon.delete": "Slet {target}",
+  "pages.PluginPage.table.icon.regenerate": "Regenerér {target}",
+  "pages.PluginPage.table.icon.show": "Åben {target}",
+  "pages.PluginPage.table.version": "Version",
+  "pages.SettingsPage.Button.description": "Konfigurér dokumentations pluginnet",
+  "pages.SettingsPage.header.save": "Gem",
+  "pages.SettingsPage.password.label": "Kodeord",
+  "pages.SettingsPage.title": "Indstillinger",
+  "pages.SettingsPage.toggle.hint": "Gør dokumentationens endpoint privat",
+  "pages.SettingsPage.toggle.label": "Begrænset adgang",
+  "plugin.description.long": "Opret et OpenAPI dokument og visualisér dit API med SWAGGER UI.",
+  "plugin.description.short": "Opret et OpenAPI dokument og visualisér dit API med SWAGGER UI.",
+  "plugin.name": "Dokumentation"
 }

package/admin/src/translations/en.json

@@ -30,10 +30,10 @@
   "pages.PluginPage.table.icon.regenerate": "Regenerate {target}",
   "pages.PluginPage.table.icon.show": "Open {target}",
   "pages.PluginPage.table.version": "Version",
-  "pages.SettingsPage.title": "Settings",
   "pages.SettingsPage.Button.description": "Configure the documentation plugin",
   "pages.SettingsPage.header.save": "Save",
   "pages.SettingsPage.password.label": "Password",
+  "pages.SettingsPage.title": "Settings",
   "pages.SettingsPage.toggle.hint": "Make the documentation endpoint private",
   "pages.SettingsPage.toggle.label": "Restricted Access",
   "plugin.description.long": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",

package/admin/src/translations/es.json

@@ -30,10 +30,10 @@
   "pages.PluginPage.table.icon.regenerate": "Regenerar {target}",
   "pages.PluginPage.table.icon.show": "Abrir {target}",
   "pages.PluginPage.table.version": "Versión",
-  "pages.SettingsPage.title": "Ajustes",
   "pages.SettingsPage.Button.description": "Configura el plugin de documentación",
   "pages.SettingsPage.header.save": "Guardar",
   "pages.SettingsPage.password.label": "Contraseña",
+  "pages.SettingsPage.title": "Ajustes",
   "pages.SettingsPage.toggle.hint": "Hacer que la documentación sea privada",
   "pages.SettingsPage.toggle.label": "Acceso restringido",
   "plugin.description.long": "Cree un documento OpenAPI y visualice su API con SWAGGER UI.",

package/admin/src/translations/ko.json

@@ -30,11 +30,10 @@
   "pages.PluginPage.table.icon.regenerate": "{target} 재생성",
   "pages.PluginPage.table.icon.show": "{target} 열기",
   "pages.PluginPage.table.version": "버전",
-  "pages.SettingsPage.title": "설정",
-  "pages.SettingsPage.header.description": "도큐멘테이션 플러그인 설정",
   "pages.SettingsPage.Button.description": "도큐멘테이션 플러그인 설정",
   "pages.SettingsPage.header.save": "저장",
   "pages.SettingsPage.password.label": "비밀번호",
+  "pages.SettingsPage.title": "설정",
   "pages.SettingsPage.toggle.hint": "도큐멘테이션 엔드포인트를 비공개로 설정합니다.",
   "pages.SettingsPage.toggle.label": "액세스 제한",
   "plugin.description.long": "SWAGER UI를 사용하여 오픈 API 문서를 만들고 API를 시각화합니다.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.0.5",
+  "version": "4.1.0",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "repository": {
     "type": "git",
@@ -24,12 +24,11 @@
     "test": "echo \"no tests yet\""
   },
   "dependencies": {
-    "@strapi/helper-plugin": "4.0.5",
-    "@strapi/utils": "4.0.5",
+    "@strapi/helper-plugin": "4.1.0",
+    "@strapi/utils": "4.1.0",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.5",
     "fs-extra": "^9.1.0",
-    "koa-session": "6.2.0",
     "koa-static": "^5.0.0",
     "lodash": "4.17.21",
     "path-to-regexp": "6.2.0",
@@ -45,6 +44,9 @@
     "reselect": "^4.0.0",
     "swagger-ui-dist": "3.47.1"
   },
+  "peerDependencies": {
+    "@strapi/strapi": "^4.0.0"
+  },
   "engines": {
     "node": ">=12.22.0 <=16.x.x",
     "npm": ">=6.0.0"
@@ -55,5 +57,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "45020eee065af8917011cc43398f95c4c624d6ad"
+  "gitHead": "d4273d81fbeec230b5734375e43a5f1f1f2a0231"
 }

package/server/config/index.js

@@ -2,15 +2,6 @@
 
 const defaultDocumentationConfig = require('./default-config');
 
-const defaultConfig = {
-  ...defaultDocumentationConfig,
-  session: {
-    key: 'plugin::documentation.sess',
-    maxAge: 'session',
-    secretKeys: ['mySecret'],
-  },
-};
-
 module.exports = {
-  default: defaultConfig,
+  default: defaultDocumentationConfig,
 };

package/server/middlewares/documentation.js

@@ -2,14 +2,9 @@
 
 const path = require('path');
 const koaStatic = require('koa-static');
-const session = require('koa-session');
 const swaggerUi = require('swagger-ui-dist');
 
 module.exports = async ({ strapi }) => {
-  const sessionConfig = strapi.config.get('plugin.documentation').session;
-  strapi.server.app.keys = sessionConfig.secretKeys;
-  strapi.server.app.use(session(sessionConfig, strapi.server.app));
-
   strapi.server.routes([
     {
       method: 'GET',

package/server/services/documentation.js

@@ -20,6 +20,10 @@ module.exports = ({ strapi }) => {
       return path.join(strapi.dirs.extensions, 'documentation', 'documentation');
     },
 
+    getCustomDocumentationPath() {
+      return path.join(strapi.dirs.extensions, 'documentation', 'config', 'settings.json');
+    },
+
     getDocumentationVersions() {
       return fs
         .readdirSync(this.getFullDocumentationPath())
@@ -103,6 +107,16 @@ module.exports = ({ strapi }) => {
       return [...apisToDocument, ...pluginsToDocument];
     },
 
+    async getCustomSettings() {
+      const customConfigPath = this.getCustomDocumentationPath();
+      const pathExists = await fs.pathExists(customConfigPath);
+      if (pathExists) {
+        return fs.readJson(customConfigPath);
+      }
+
+      return {};
+    },
+
     /**
      * @description - Creates the Swagger json files
      */
@@ -133,20 +147,24 @@ module.exports = ({ strapi }) => {
         'full_documentation.json'
       );
 
-      const settings = _.cloneDeep(defaultConfig);
+      const defaultSettings = _.cloneDeep(defaultConfig);
 
       const serverUrl = getAbsoluteServerUrl(strapi.config);
       const apiPath = strapi.config.get('api.rest.prefix');
 
-      _.set(settings, 'servers', [
+      _.set(defaultSettings, 'servers', [
         {
           url: `${serverUrl}${apiPath}`,
           description: 'Development server',
         },
       ]);
 
-      _.set(settings, ['info', 'x-generation-date'], new Date().toISOString());
-      _.set(settings, ['info', 'version'], version);
+      _.set(defaultSettings, ['info', 'x-generation-date'], new Date().toISOString());
+      _.set(defaultSettings, ['info', 'version'], version);
+
+      const customSettings = await this.getCustomSettings();
+
+      const settings = _.merge(defaultSettings, customSettings);
 
       await fs.ensureFile(fullDocJsonPath);
       await fs.writeJson(fullDocJsonPath, { ...settings, paths }, { spaces: 2 });