@strapi/plugin-documentation 0.0.0-113ff29005

package/admin/src/translations/uk.json

@@ -0,0 +1,23 @@
+{
+  "components.Row.open": "Відкрити",
+  "components.Row.regenerate": "Згенерувати",
+  "containers.HomePage.Block.title": "Версії",
+  "containers.HomePage.Button.update": "Оновити",
+  "containers.HomePage.PluginHeader.title": "Документація - Налаштування",
+  "containers.HomePage.PopUpWarning.confirm": "Я усвідомлюю",
+  "containers.HomePage.PopUpWarning.message": "Ви впевнені, що хочете видалити цю версію?",
+  "containers.HomePage.copied": "Токен скопійовано у буфер обміну",
+  "containers.HomePage.form.jwtToken": "Отримайте ваш JWT токен",
+  "containers.HomePage.form.jwtToken.description": "Скопіюйте цей токен та застосуйте його в swagger, щоб відправляти запити",
+  "containers.HomePage.form.password": "Пароль",
+  "containers.HomePage.form.password.inputDescription": "Встановіть пароль доступу до документації",
+  "containers.HomePage.form.restrictedAccess": "Обмежений доступ",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "Зробіть документацію приватною. За замовченням, документація загальнодоступна",
+  "containers.HomePage.form.showGeneratedFiles": "Показати згенеровані файли",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Корисно, якщо ви хочете переписати згенеровані документи \nПлаґін згенерує файли окремо для моделі та плаґіну. \nУвімкнувши цю опцію, буде легше налаштувати вашу документацію",
+  "error.deleteDoc.versionMissing": "Версія, яку ви намагаєтесь видалити не існує.",
+  "error.noVersion": "Необхідна версія",
+  "error.regenerateDoc": "Під час генерування документації сталася помилка",
+  "error.regenerateDoc.versionMissing": "Версія, яку ви намагаєтесь згенерувати не існує.",
+  "notification.update.success": "Налаштування оновлено"
+}

package/admin/src/translations/vi.json

@@ -0,0 +1,24 @@
+{
+  "components.Row.open": "Mở",
+  "components.Row.regenerate": "Sinh lại",
+  "containers.HomePage.Block.title": "Các Phiên Bản",
+  "containers.HomePage.Button.update": "Cập nhật",
+  "containers.HomePage.PluginHeader.title": "Tài liệu - Cài đặt",
+  "containers.HomePage.PopUpWarning.confirm": "Tôi hiểu",
+  "containers.HomePage.PopUpWarning.message": "Bạn có chắc là muốn xóa phiên bản này không?",
+  "containers.HomePage.copied": "Chuỗi khoá đã được sao chép vào bộ nhớ tạm",
+  "containers.HomePage.form.jwtToken": "Lấy lại chuỗi khóa jwt của bạn",
+  "containers.HomePage.form.jwtToken.description": "Sao chép chuỗi khóa và sử dụng nó trong swagger để truy vấn",
+  "containers.HomePage.form.password": "Mật khẩu",
+  "containers.HomePage.form.password.inputDescription": "Cài đặt mật khẩu để truy cập tài liệu",
+  "containers.HomePage.form.restrictedAccess": "Truy cập bị giới hạn",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "Làm cho điểm truy cập tài liệu thành riêng tư. Mặc định, truy cập là công khai.",
+  "containers.HomePage.form.showGeneratedFiles": "Hiển thị tập tin đã sinh ra",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "Hữu ích khi bạn muốn ghi đè lên tài liệu đã sinh ra. \nPlugin này sẽ tạo ra các tập tin phân chia bởi cấu hình và plugin. \nBằng việc kích hoạt tuỳ chọn này, sẽ dễ dàng hơn cho bạn tùy chỉnh tài liệu của bạn.",
+  "error.deleteDoc.versionMissing": "Phiên bản bạn đang cố xóa không tồn tại.",
+  "error.noVersion": "Bắt buộc phải có một phiên bản",
+  "error.regenerateDoc": "Một lỗi đã xảy ra trong khi sinh ra tài liệu",
+  "error.regenerateDoc.versionMissing": "Phiên bản bạn đang cố sinh ra không tồn tại",
+  "notification.update.success": "Các cài đặt đã được cập nhật thành công",
+  "plugin.name": "Tài liệu"
+}

package/admin/src/translations/zh-Hans.json

@@ -0,0 +1,28 @@
+{
+  "components.Row.open": "打开",
+  "components.Row.regenerate": "重新生成",
+  "containers.HomePage.Block.title": "版本号",
+  "containers.HomePage.Button.update": "更新",
+  "containers.HomePage.PluginHeader.title": "文档 - 设置",
+  "containers.HomePage.PopUpWarning.confirm": "我确定",
+  "containers.HomePage.PopUpWarning.message": "您确定要删除此版本吗？",
+  "containers.HomePage.copied": "令牌已被复制到粘贴板",
+  "containers.HomePage.form.jwtToken": "检索您的 jwt 令牌",
+  "containers.HomePage.form.jwtToken.description": "复制此令牌，并用它在 Swagger 中发出请求",
+  "containers.HomePage.form.password": "密码",
+  "containers.HomePage.form.password.inputDescription": "设置密码以供访问文档",
+  "containers.HomePage.form.restrictedAccess": "禁止访问",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "将文档端点设为私有。默认情况下，访问权限是公共的",
+  "containers.HomePage.form.showGeneratedFiles": "显示生成的文件",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "当您想要覆盖生成的文档的时候很有用。 \n该插件将生成按型号和插件拆分的文件。 \n通过启用此选项，可以更轻松地自定义文档",
+  "error.deleteDoc.versionMissing": "您尝试删除的版本不存在。",
+  "error.noVersion": "需要一个版本",
+  "error.regenerateDoc": "重新生成文件时发生错误",
+  "error.regenerateDoc.versionMissing": "您尝试重新生成的版本不存在",
+  "notification.delete.success": "文档删除成功",
+  "notification.generate.success": "文档生成成功",
+  "notification.update.success": "设置更新成功",
+  "plugin.description.long": "创建OpenAPI文档并使用SwaggerUI可视化你的API",
+  "plugin.description.short": "创建OpenAPI文档并使用SwaggerUI可视化你的API",
+  "plugin.name": "文档"
+}

package/admin/src/translations/zh.json

@@ -0,0 +1,24 @@
+{
+  "components.Row.open": "開啟",
+  "components.Row.regenerate": "重新產生",
+  "containers.HomePage.Block.title": "版本",
+  "containers.HomePage.Button.update": "更新",
+  "containers.HomePage.PluginHeader.title": "文件資料 - 設定",
+  "containers.HomePage.PopUpWarning.confirm": "我了解了",
+  "containers.HomePage.PopUpWarning.message": "你確定要刪除這個版本嗎？",
+  "containers.HomePage.copied": "Token 已經複製到剪貼簿",
+  "containers.HomePage.form.jwtToken": "存取你的 jwt token",
+  "containers.HomePage.form.jwtToken.description": "複製這個token並於swagger中使用於發出請求",
+  "containers.HomePage.form.password": "密碼",
+  "containers.HomePage.form.password.inputDescription": "設定密碼存取權限",
+  "containers.HomePage.form.restrictedAccess": "存取受到限制",
+  "containers.HomePage.form.restrictedAccess.inputDescription": "將endpoints設定為私密的. 預設是對外公開的",
+  "containers.HomePage.form.showGeneratedFiles": "顯示產生的檔案",
+  "containers.HomePage.form.showGeneratedFiles.inputDescription": "用於覆寫產生的文件檔案時. \n擴充套件會依照model及plugin分別產生檔案. \n啟用這個選項將會方便你客製化文件資料",
+  "error.deleteDoc.versionMissing": "你想刪除的版本不存在",
+  "error.noVersion": "版本是必填欄位",
+  "error.regenerateDoc": "重新產生文件資料時發生了錯誤",
+  "error.regenerateDoc.versionMissing": "你想產生的版本不存在",
+  "notification.update.success": "更新設定成功",
+  "plugin.name": "文件資料"
+}

package/admin/src/utils/getTrad.js

@@ -0,0 +1,5 @@
+import pluginId from '../pluginId';
+
+const getTrad = (id) => `${pluginId}.${id}`;
+
+export default getTrad;

package/admin/src/utils/index.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/prefer-default-export
+export { default as getTrad } from './getTrad';

package/admin/src/utils/openWithNewTab.js

@@ -0,0 +1,20 @@
+import { startsWith } from 'lodash';
+
+const openWithNewTab = (path) => {
+  const url = (() => {
+    if (startsWith(path, '/')) {
+      return `${strapi.backendURL}${path}`;
+    }
+    if (startsWith(path, 'https') || startsWith(path, 'http')) {
+      return path;
+    }
+
+    return `${strapi.backendURL}/${path}`;
+  })();
+
+  window.open(url, '_blank');
+
+  return window.focus();
+};
+
+export default openWithNewTab;

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@strapi/plugin-documentation",
+  "version": "0.0.0-113ff29005",
+  "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": "0.0.0-113ff29005",
+    "@strapi/utils": "0.0.0-113ff29005",
+    "bcryptjs": "2.4.3",
+    "cheerio": "^1.0.0-rc.12",
+    "fs-extra": "10.0.0",
+    "koa-static": "^5.0.0",
+    "lodash": "4.17.21",
+    "path-to-regexp": "6.2.1",
+    "pluralize": "8.0.0",
+    "react": "^17.0.2",
+    "react-copy-to-clipboard": "^5.1.0",
+    "react-dom": "^17.0.2",
+    "react-intl": "5.20.2",
+    "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.12.0",
+    "yaml": "1.10.2"
+  },
+  "peerDependencies": {
+    "@strapi/strapi": "^4.0.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "11.2.7",
+    "msw": "0.42.3"
+  },
+  "engines": {
+    "node": ">=14.19.1 <=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"
+  },
+  "gitHead": "113ff2900569e2f7b1d25a382451031bea239ed2"
+}

package/server/bootstrap.js

@@ -0,0 +1,54 @@
+/* eslint-disable no-unreachable */
+
+'use strict';
+
+// Add permissions
+const RBAC_ACTIONS = [
+  {
+    section: 'plugins',
+    displayName: 'Access the Documentation',
+    uid: 'read',
+    pluginName: 'documentation',
+  },
+  {
+    section: 'plugins',
+    displayName: 'Update and delete',
+    uid: 'settings.update',
+    pluginName: 'documentation',
+  },
+  {
+    section: 'plugins',
+    displayName: 'Regenerate',
+    uid: 'settings.regenerate',
+    pluginName: 'documentation',
+  },
+  {
+    section: 'settings',
+    displayName: 'Access the documentation settings page',
+    uid: 'settings.read',
+    pluginName: 'documentation',
+    category: 'documentation',
+  },
+];
+
+/**
+ *
+ * @param {{strapi: import("@strapi/strapi").Strapi}} args
+ */
+module.exports = async ({ strapi }) => {
+  await strapi.admin.services.permission.actionProvider.registerMany(RBAC_ACTIONS);
+
+  const pluginStore = strapi.store({
+    environment: '',
+    type: 'plugin',
+    name: 'documentation',
+  });
+
+  const config = await pluginStore.get({ key: 'config' });
+
+  if (!config) {
+    pluginStore.set({ key: 'config', value: { restrictedAccess: false } });
+  }
+
+  await strapi.plugin('documentation').service('documentation').generateFullDoc();
+};

package/server/config/default-plugin-config.js

@@ -0,0 +1,74 @@
+'use strict';
+
+module.exports = {
+  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,
+    plugins: ['email', 'upload', 'users-permissions'],
+  },
+  servers: [],
+  externalDocs: {
+    description: 'Find out more',
+    url: 'https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html',
+  },
+  security: [
+    {
+      bearerAuth: [],
+    },
+  ],
+  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: [] }],
+          },
+          error: {
+            type: 'object',
+            properties: {
+              status: {
+                type: 'integer',
+              },
+              name: {
+                type: 'string',
+              },
+              message: {
+                type: 'string',
+              },
+              details: {
+                type: 'object',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};

package/server/config/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const defaultPluginConfig = require('./default-plugin-config');
+
+module.exports = {
+  default: defaultPluginConfig,
+};

package/server/controllers/documentation.js

@@ -0,0 +1,241 @@
+'use strict';
+
+/**
+ * Documentation.js controller
+ *
+ * @description: A set of functions called "actions" of the `documentation` plugin.
+ */
+
+// Core dependencies.
+const path = require('path');
+const bcrypt = require('bcryptjs');
+
+// Public dependencies.
+const fs = require('fs-extra');
+const _ = require('lodash');
+const koaStatic = require('koa-static');
+
+module.exports = {
+  async getInfos(ctx) {
+    try {
+      const docService = strapi.plugin('documentation').service('documentation');
+      const docVersions = docService.getDocumentationVersions();
+      const documentationAccess = await docService.getDocumentationAccess();
+
+      ctx.send({
+        docVersions,
+        currentVersion: docService.getDocumentationVersion(),
+        prefix: strapi.plugin('documentation').config('x-strapi-config').path,
+        documentationAccess,
+      });
+    } 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.plugin('documentation').service('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 = 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.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
+    const cheerio = require('cheerio');
+
+    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.config.get('plugin.documentation.x-strapi-config').path
+        }/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.documentation = {
+        logged: true,
+      };
+
+      querystring = '';
+    }
+
+    ctx.redirect(
+      `${strapi.config.server.url}${
+        strapi.config.get('plugin.documentation.x-strapi-config').path
+      }${querystring}`
+    );
+  },
+
+  async regenerateDoc(ctx) {
+    const { version } = ctx.request.body;
+
+    const service = strapi.service('plugin::documentation.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 = strapi.service('plugin::documentation.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 { restrictedAccess, password } = ctx.request.body;
+
+    const pluginStore = strapi.store({ type: 'plugin', name: 'documentation' });
+
+    const config = {
+      restrictedAccess: Boolean(restrictedAccess),
+    };
+
+    if (restrictedAccess) {
+      if (_.isEmpty(password)) {
+        return ctx.badRequest('Please provide a password');
+      }
+
+      config.password = await bcrypt.hash(password, 10);
+    }
+
+    await pluginStore.set({ key: 'config', value: config });
+
+    return ctx.send({ ok: true });
+  },
+};

package/server/controllers/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const documentation = require('./documentation');
+
+module.exports = {
+  documentation,
+};

package/server/index.js

@@ -0,0 +1,17 @@
+'use strict';
+
+const bootstrap = require('./bootstrap');
+const services = require('./services');
+const routes = require('./routes');
+const controllers = require('./controllers');
+const register = require('./register');
+const config = require('./config');
+
+module.exports = () => ({
+  bootstrap,
+  config,
+  routes,
+  controllers,
+  register,
+  services,
+});

package/server/middlewares/documentation.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const path = require('path');
+const koaStatic = require('koa-static');
+const swaggerUi = require('swagger-ui-dist');
+
+module.exports = async ({ strapi }) => {
+  strapi.server.routes([
+    {
+      method: 'GET',
+      path: '/plugins/documentation/(.*)',
+      async handler(ctx, next) {
+        ctx.url = path.basename(ctx.url);
+
+        return koaStatic(swaggerUi.getAbsoluteFSPath(), {
+          maxage: 86400000,
+          defer: true,
+        })(ctx, next);
+      },
+      config: {
+        auth: false,
+      },
+    },
+  ]);
+};

package/server/middlewares/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const documentation = require('./documentation');
+
+module.exports = {
+  documentation,
+};

package/server/middlewares/restrict-access.js

@@ -0,0 +1,24 @@
+'use strict';
+
+module.exports = async (ctx, next) => {
+  const pluginStore = strapi.store({ type: 'plugin', name: 'documentation' });
+
+  const config = await pluginStore.get({ key: 'config' });
+
+  if (!config.restrictedAccess) {
+    return next();
+  }
+
+  if (!ctx.session.documentation || !ctx.session.documentation.logged) {
+    const querystring = ctx.querystring ? `?${ctx.querystring}` : '';
+
+    return ctx.redirect(
+      `${strapi.config.server.url}${
+        strapi.config.get('plugin.documentation.x-strapi-config').path
+      }/login${querystring}`
+    );
+  }
+
+  // Execute the action.
+  return next();
+};