@strapi/plugin-documentation 4.2.1-alpha.0 → 4.3.0-beta.2

package/README.md

@@ -1,7 +1,6 @@
 # Plugin documentation
 
 This plugin automates your API documentation creation. It basically generates a swagger file. It follows the [Open API specification version 3.0.1](https://swagger.io/specification/).
-The documentation plugin is not release on npm yet, Here's how to install it.
 
 ## Usage
 

package/admin/src/translations/pl.json

@@ -1,9 +1,10 @@
 {
+  "coming-soon": "Zawartość w trakcie budowy, wróci w ciągu kilku tygodni!",
   "components.Row.open": "Otwórz",
   "components.Row.regenerate": "Wygeneruj ponownie",
   "containers.HomePage.Block.title": "Wersje",
   "containers.HomePage.Button.update": "Zaktualizuj",
-  "containers.HomePage.PluginHeader.title": "Dokuemntacja - Ustawienia",
+  "containers.HomePage.PluginHeader.title": "Dokumentacja - Ustawienia",
   "containers.HomePage.PopUpWarning.confirm": "Rozumiem",
   "containers.HomePage.PopUpWarning.message": "Czy jesteś pewien, że chcesz usunąć tę wersję?",
   "containers.HomePage.copied": "Token skopiowany do schowka",
@@ -11,14 +12,28 @@
   "containers.HomePage.form.jwtToken.description": "Skopiuj token i użyj go w swaggerze aby wykonać request",
   "containers.HomePage.form.password": "Hasło",
   "containers.HomePage.form.password.inputDescription": "Ustaw hasło aby uzyskać dostęp do dokumentacji",
-  "containers.HomePage.form.restrictedAccess": "Dostęp Ograniczony",
+  "containers.HomePage.form.restrictedAccess": "Dostęp ograniczony",
   "containers.HomePage.form.restrictedAccess.inputDescription": "Ustaw endpoint dokumentacji jako prywatny. Domyślnie dostęp jest publiczny.",
   "containers.HomePage.form.showGeneratedFiles": "Pokaż wygenerowane pliki",
-  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Przydatne, gdy chcesz nadpisać wygenerowaną dokumentację. \nWtyczka wygeneruje pliki i podzieli je według modelu i wtyczki. \nWłączenie tej opcji ułatwi dostosowywanie dokumentacji",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Przydatne, gdy chcesz nadpisać wygenerowaną dokumentację. \nPlugin wygeneruje pliki i podzieli je według modelu i pluginu. \nWłączenie tej opcji ułatwi dostosowywanie dokumentacji",
   "error.deleteDoc.versionMissing": "Wersja, którą próbujesz usunąć nie istnieje.",
   "error.noVersion": "Wersja jest wymagana",
   "error.regenerateDoc": "Wystąpił błąd podczas ponownego generowania dokumentacji",
-  "error.regenerateDoc.versionMissing": "Wersja, którą prubujesz wygenerować nie istnieje.",
+  "error.regenerateDoc.versionMissing": "Wersja, którą próbujesz wygenerować nie istnieje.",
+  "notification.delete.success": "Dokumentacja usunięta",
+  "notification.generate.success": "Dokumentacja wygenerowana",
   "notification.update.success": "Ustawienia zaktualizowane pomyślnie",
+  "pages.PluginPage.Button.open": "Otwórz dokumentację",
+  "pages.PluginPage.header.description": "Skonfiguruj plugin dokumentacji",
+  "pages.PluginPage.table.generated": "Ostatnio wygenerowane",
+  "pages.PluginPage.table.icon.regenerate": "Wygeneruj ponownie {target}",
+  "pages.PluginPage.table.icon.show": "Otwórz {target}",
+  "pages.PluginPage.table.version": "Wersja",
+  "pages.SettingsPage.Button.description": "Skonfiguruj plugin dokumentacji",
+  "pages.SettingsPage.header.save": "Zapisz",
+  "pages.SettingsPage.toggle.hint": "Ustaw endpoint dokumentacji na prywatny",
+  "pages.SettingsPage.toggle.label": "Dostęp ograniczony",
+  "plugin.description.long": "Stwórz dokument OpenAPI i zwizualizuj swoje API z SWAGGER UI.",
+  "plugin.description.short": "Stwórz dokument OpenAPI i zwizualizuj swoje API z SWAGGER UI.",
   "plugin.name": "Dokumentacja"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-documentation",
-  "version": "4.2.1-alpha.0",
+  "version": "4.3.0-beta.2",
   "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
   "repository": {
     "type": "git",
@@ -24,25 +24,26 @@
     "test": "echo \"no tests yet\""
   },
   "dependencies": {
-    "@strapi/helper-plugin": "4.2.1-alpha.0",
-    "@strapi/utils": "4.2.1-alpha.0",
+    "@strapi/helper-plugin": "4.3.0-beta.2",
+    "@strapi/utils": "4.3.0-beta.2",
     "bcryptjs": "2.4.3",
     "cheerio": "^1.0.0-rc.5",
     "fs-extra": "10.0.0",
     "koa-static": "^5.0.0",
     "lodash": "4.17.21",
-    "path-to-regexp": "6.2.0",
+    "path-to-regexp": "6.2.1",
     "pluralize": "8.0.0",
     "react": "^17.0.2",
-    "react-copy-to-clipboard": "^5.0.3",
+    "react-copy-to-clipboard": "^5.1.0",
     "react-dom": "^17.0.2",
     "react-intl": "5.20.2",
-    "react-redux": "7.2.3",
+    "react-redux": "7.2.8",
     "react-router": "^5.2.0",
     "react-router-dom": "5.2.0",
     "redux": "^4.0.1",
     "reselect": "^4.0.0",
-    "swagger-ui-dist": "4.11.1"
+    "swagger-ui-dist": "4.11.1",
+    "yaml": "1.10.2"
   },
   "peerDependencies": {
     "@strapi/strapi": "^4.0.0"
@@ -57,5 +58,5 @@
     "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
     "kind": "plugin"
   },
-  "gitHead": "90bd3b9e294a69cd9538bde4e2e853e6de60f238"
+  "gitHead": "42aba356ad1b0751584d3b375e83baa4a2c18f65"
 }

package/server/controllers/documentation.js

@@ -49,7 +49,7 @@ module.exports = {
               .getDocumentationVersion();
 
       const openAPISpecsPath = path.join(
-        strapi.dirs.extensions,
+        strapi.dirs.app.extensions,
         'documentation',
         'documentation',
         version,
@@ -69,7 +69,7 @@ module.exports = {
 
         try {
           const layoutPath = path.resolve(
-            strapi.dirs.extensions,
+            strapi.dirs.app.extensions,
             'documentation',
             'public',
             'index.html'
@@ -81,7 +81,11 @@ module.exports = {
           ctx.url = path.basename(`${ctx.url}/index.html`);
 
           try {
-            const staticFolder = path.resolve(strapi.dirs.extensions, 'documentation', 'public');
+            const staticFolder = path.resolve(
+              strapi.dirs.app.extensions,
+              'documentation',
+              'public'
+            );
             return koaStatic(staticFolder)(ctx, next);
           } catch (e) {
             strapi.log.error(e);
@@ -116,7 +120,7 @@ module.exports = {
 
       try {
         const layoutPath = path.resolve(
-          strapi.dirs.extensions,
+          strapi.dirs.app.extensions,
           'documentation',
           'public',
           'login.html'
@@ -127,7 +131,7 @@ module.exports = {
         ctx.url = path.basename(`${ctx.url}/login.html`);
 
         try {
-          const staticFolder = path.resolve(strapi.dirs.extensions, 'documentation', 'public');
+          const staticFolder = path.resolve(strapi.dirs.app.extensions, 'documentation', 'public');
           return koaStatic(staticFolder)(ctx, next);
         } catch (e) {
           strapi.log.error(e);

package/server/services/documentation.js

@@ -11,17 +11,28 @@ const { builApiEndpointPath, buildComponentSchema } = require('./helpers');
 module.exports = ({ strapi }) => {
   const config = strapi.config.get('plugin.documentation');
 
+  const registeredDocs = [];
+
   return {
+    registerDoc(doc) {
+      // parseYaml
+      if (typeof doc === 'string') {
+        doc = require('yaml').parse(doc);
+      }
+      // receive an object we can register it directly
+      registeredDocs.push(doc);
+    },
     getDocumentationVersion() {
       return _.get(config, 'info.version');
     },
 
     getFullDocumentationPath() {
-      return path.join(strapi.dirs.extensions, 'documentation', 'documentation');
+      return path.join(strapi.dirs.app.extensions, 'documentation', 'documentation');
     },
 
     getCustomDocumentationPath() {
-      return path.join(strapi.dirs.extensions, 'documentation', 'config', 'settings.json');
+      // ??
+      return path.join(strapi.dirs.app.extensions, 'documentation', 'config', 'settings.json');
     },
 
     getDocumentationVersions() {
@@ -71,10 +82,10 @@ module.exports = ({ strapi }) => {
      */
     getApiDocumentationPath(api) {
       if (api.getter === 'plugin') {
-        return path.join(strapi.dirs.extensions, api.name, 'documentation');
+        return path.join(strapi.dirs.app.extensions, api.name, 'documentation');
       }
 
-      return path.join(strapi.dirs.api, api.name, 'documentation');
+      return path.join(strapi.dirs.app.api, api.name, 'documentation');
     },
 
     async deleteDocumentation(version) {
@@ -173,8 +184,26 @@ module.exports = ({ strapi }) => {
       const customConfig = await this.getCustomConfig();
       const config = _.merge(defaultConfig, customConfig);
 
+      const finalDoc = { ...config, paths };
+
+      registeredDocs.forEach(doc => {
+        // Add tags
+        finalDoc.tags = finalDoc.tags || [];
+        finalDoc.tags.push(...(doc.tags || []));
+
+        // Add Paths
+        _.assign(finalDoc.paths, doc.paths);
+
+        // Add components
+        _.forEach(doc.components || {}, (val, key) => {
+          finalDoc.components[key] = finalDoc.components[key] || {};
+
+          _.assign(finalDoc.components[key], val);
+        });
+      });
+
       await fs.ensureFile(fullDocJsonPath);
-      await fs.writeJson(fullDocJsonPath, { ...config, paths }, { spaces: 2 });
+      await fs.writeJson(fullDocJsonPath, finalDoc, { spaces: 2 });
     },
   };
 };

package/yarn-error.log

@@ -1,95 +0,0 @@
-Arguments: 
-  /Users/alex/.nvm/versions/node/v16.13.2/bin/node /Users/alex/.nvm/versions/node/v16.13.2/bin/yarn
-
-PATH: 
-  /Users/alex/.nvm/versions/node/v16.13.2/bin:/Users/alex/.nvm/versions/node/v18.1.0/bin:/Users/alex/.nvm/versions/node/v16.13.2/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/go/bin:/Users/alex/.nvm/versions/node/v16.13.2/bin:/opt/homebrew/bin:/opt/homebrew/sbin:/Users/alex/.yarn/bin:/Users/alex/.yarn/bin
-
-Yarn version: 
-  1.22.17
-
-Node version: 
-  16.13.2
-
-Platform: 
-  darwin arm64
-
-Trace: 
-  SyntaxError: /Users/alex/dev/strapi/strapi/packages/plugins/documentation/package.json: Unexpected token < in JSON at position 1187
-      at JSON.parse (<anonymous>)
-      at /Users/alex/.nvm/versions/node/v16.13.2/lib/node_modules/yarn/lib/cli.js:1625:59
-      at Generator.next (<anonymous>)
-      at step (/Users/alex/.nvm/versions/node/v16.13.2/lib/node_modules/yarn/lib/cli.js:310:30)
-      at /Users/alex/.nvm/versions/node/v16.13.2/lib/node_modules/yarn/lib/cli.js:321:13
-
-npm manifest: 
-  {
-    "name": "@strapi/plugin-documentation",
-    "version": "4.1.12",
-    "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
-    "repository": {
-      "type": "git",
-      "url": "https://github.com/strapi/strapi.git",
-      "directory": "packages/plugins/documentation"
-    },
-    "license": "SEE LICENSE IN LICENSE",
-    "author": {
-      "name": "Strapi Solutions SAS",
-      "email": "hi@strapi.io",
-      "url": "https://strapi.io"
-    },
-    "maintainers": [
-      {
-        "name": "Strapi Solutions SAS",
-        "email": "hi@strapi.io",
-        "url": "https://strapi.io"
-      }
-    ],
-    "scripts": {
-      "test": "echo \"no tests yet\""
-    },
-    "dependencies": {
-      "@strapi/helper-plugin": "4.1.12",
-      "@strapi/utils": "4.1.12",
-      "bcryptjs": "2.4.3",
-      "cheerio": "^1.0.0-rc.5",
-      "fs-extra": "10.0.0",
-      "koa-static": "^5.0.0",
-      "lodash": "4.17.21",
-      "path-to-regexp": "6.2.0",
-      "pluralize": "8.0.0",
-      "react": "^17.0.2",
-      "react-copy-to-clipboard": "^5.0.3",
-      "react-dom": "^17.0.2",
-      "react-intl": "5.20.2",
-      "react-redux": "7.2.3",
-      "react-router": "^5.2.0",
-      "react-router-dom": "5.2.0",
-      "redux": "^4.0.1",
-      "reselect": "^4.0.0",
-  <<<<<<< HEAD
-      "swagger-ui-dist": "3.47.1",
-      "yaml": "1.10.2"
-  =======
-      "swagger-ui-dist": "4.11.1"
-  >>>>>>> master
-    },
-    "peerDependencies": {
-      "@strapi/strapi": "^4.0.0"
-    },
-    "engines": {
-      "node": ">=12.22.0 <=16.x.x",
-      "npm": ">=6.0.0"
-    },
-    "strapi": {
-      "displayName": "Documentation",
-      "name": "documentation",
-      "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
-      "kind": "plugin"
-    }
-  }
-
-yarn manifest: 
-  No manifest
-
-Lockfile: 
-  No lockfile