@strapi/plugin-documentation 4.2.0-beta.3 → 4.2.1-alpha.0

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

@@ -33,6 +33,7 @@ describe('Build Component Schema', () => {
     const [pluginResponseValue, apiResponseValue] = Object.values(schemas);
 
     const expectedShape = {
+      type: 'object',
       properties: {
         data: {
           type: 'object',
@@ -82,6 +83,7 @@ describe('Build Component Schema', () => {
     const apiListResponseValue = schemas['RestaurantListResponse'];
 
     const expectedShape = {
+      type: 'object',
       properties: {
         data: {
           type: 'array',

package/package.json

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

package/server/controllers/documentation.js

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

package/server/services/documentation.js

@@ -17,12 +17,11 @@ module.exports = ({ strapi }) => {
     },
 
     getFullDocumentationPath() {
-      return path.join(strapi.dirs.app.extensions, 'documentation', 'documentation');
+      return path.join(strapi.dirs.extensions, 'documentation', 'documentation');
     },
 
     getCustomDocumentationPath() {
-      // ??
-      return path.join(strapi.dirs.app.extensions, 'documentation', 'config', 'settings.json');
+      return path.join(strapi.dirs.extensions, 'documentation', 'config', 'settings.json');
     },
 
     getDocumentationVersions() {
@@ -72,10 +71,10 @@ module.exports = ({ strapi }) => {
      */
     getApiDocumentationPath(api) {
       if (api.getter === 'plugin') {
-        return path.join(strapi.dirs.app.extensions, api.name, 'documentation');
+        return path.join(strapi.dirs.extensions, api.name, 'documentation');
       }
 
-      return path.join(strapi.dirs.app.api, api.name, 'documentation');
+      return path.join(strapi.dirs.api, api.name, 'documentation');
     },
 
     async deleteDocumentation(version) {

package/server/services/helpers/build-component-schema.js

@@ -95,6 +95,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
     schemas = {
       ...schemas,
       [`${pascalCase(uniqueName)}ListResponse`]: {
+        type: 'object',
         properties: {
           data: {
             type: 'array',
@@ -128,6 +129,7 @@ const getAllSchemasForContentType = ({ routeInfo, attributes, uniqueName }) => {
   schemas = {
     ...schemas,
     [`${pascalCase(uniqueName)}Response`]: {
+      type: 'object',
       properties: {
         data: {
           type: 'object',

package/yarn-error.log

@@ -0,0 +1,95 @@
+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