@strapi/plugin-documentation 5.0.0-beta.0 → 5.0.0-beta.10

package/server/middlewares/documentation.js

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

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

package/server/middlewares/restrict-access.js

@@ -1,24 +0,0 @@
-'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();
-};

package/server/register.js

@@ -1,11 +0,0 @@
-'use strict';
-
-const registerDocumentationMiddleWare = require('./middlewares/documentation');
-
-/**
- * Register upload plugin
- * @param {{ strapi: import('@strapi/strapi').Strapi }}
- */
-module.exports = async ({ strapi }) => {
-  await registerDocumentationMiddleWare({ strapi });
-};

package/server/routes/index.js

@@ -1,84 +0,0 @@
-'use strict';
-
-const restrictAccess = require('../middlewares/restrict-access');
-
-module.exports = [
-  {
-    method: 'GET',
-    path: '/',
-    handler: 'documentation.index',
-    config: {
-      auth: false,
-      middlewares: [restrictAccess],
-    },
-  },
-  {
-    method: 'GET',
-    path: '/v:major(\\d+).:minor(\\d+).:patch(\\d+)',
-    handler: 'documentation.index',
-    config: {
-      auth: false,
-      middlewares: [restrictAccess],
-    },
-  },
-  {
-    method: 'GET',
-    path: '/login',
-    handler: 'documentation.loginView',
-    config: {
-      auth: false,
-    },
-  },
-  {
-    method: 'POST',
-    path: '/login',
-    handler: 'documentation.login',
-    config: {
-      auth: false,
-    },
-  },
-  {
-    method: 'GET',
-    path: '/getInfos',
-    handler: 'documentation.getInfos',
-    config: {
-      policies: [
-        { name: 'admin::hasPermissions', config: { actions: ['plugin::documentation.read'] } },
-      ],
-    },
-  },
-  {
-    method: 'POST',
-    path: '/regenerateDoc',
-    handler: 'documentation.regenerateDoc',
-    config: {
-      policies: [
-        {
-          name: 'admin::hasPermissions',
-          config: { actions: ['plugin::documentation.settings.regenerate'] },
-        },
-      ],
-    },
-  },
-  {
-    method: 'PUT',
-    path: '/updateSettings',
-    handler: 'documentation.updateSettings',
-    config: {
-      policies: [
-        {
-          name: 'admin::hasPermissions',
-          config: { actions: ['plugin::documentation.settings.update'] },
-        },
-      ],
-    },
-  },
-  {
-    method: 'DELETE',
-    path: '/deleteDoc/:version',
-    handler: 'documentation.deleteDoc',
-    config: {
-      policies: [],
-    },
-  },
-];

package/server/services/__mocks__/mock-content-types.js

@@ -1,264 +0,0 @@
-'use strict';
-
-module.exports = {
-  'plugin::upload.file': {
-    collectionName: 'files',
-    info: { singularName: 'file', pluralName: 'files', displayName: 'File', description: '' },
-    options: {},
-    pluginOptions: {
-      'content-manager': { visible: false },
-      'content-type-builder': { visible: false },
-    },
-    attributes: {
-      name: { type: 'string', configurable: false, required: true },
-      alternativeText: { type: 'string', configurable: false },
-      caption: { type: 'string', configurable: false },
-      width: { type: 'integer', configurable: false },
-      height: { type: 'integer', configurable: false },
-      formats: { type: 'json', configurable: false },
-      hash: { type: 'string', configurable: false, required: true },
-      ext: { type: 'string', configurable: false },
-      mime: { type: 'string', configurable: false, required: true },
-      size: { type: 'decimal', configurable: false, required: true },
-      url: { type: 'string', configurable: false, required: true },
-      previewUrl: { type: 'string', configurable: false },
-      provider: { type: 'string', configurable: false, required: true },
-      provider_metadata: { type: 'json', configurable: false },
-      related: { type: 'relation', relation: 'morphToMany', configurable: false },
-      folder: {
-        type: 'relation',
-        relation: 'manyToOne',
-        target: 'plugin::upload.folder',
-        inversedBy: 'files',
-        private: true,
-      },
-      folderPath: { type: 'string', min: 1, required: true, private: true },
-      createdAt: { type: 'datetime' },
-      updatedAt: { type: 'datetime' },
-      createdBy: {
-        type: 'relation',
-        relation: 'oneToOne',
-        target: 'admin::user',
-        configurable: false,
-        writable: false,
-        visible: false,
-        useJoinTable: false,
-        private: true,
-      },
-      updatedBy: {
-        type: 'relation',
-        relation: 'oneToOne',
-        target: 'admin::user',
-        configurable: false,
-        writable: false,
-        visible: false,
-        useJoinTable: false,
-        private: true,
-      },
-    },
-    indexes: [
-      { name: 'upload_files_folder_path_index', columns: ['folder_path'], type: null },
-      { name: 'upload_files_created_at_index', columns: ['created_at'], type: null },
-      { name: 'upload_files_updated_at_index', columns: ['updated_at'], type: null },
-      { name: 'upload_files_name_index', columns: ['name'], type: null },
-      { name: 'upload_files_size_index', columns: ['size'], type: null },
-      { name: 'upload_files_ext_index', columns: ['ext'], type: null },
-    ],
-    kind: 'collectionType',
-    modelType: 'contentType',
-    modelName: 'file',
-    uid: 'plugin::upload.file',
-    plugin: 'upload',
-    globalId: 'UploadFile',
-  },
-  'plugin::upload.folder': {
-    collectionName: 'upload_folders',
-    info: { singularName: 'folder', pluralName: 'folders', displayName: 'Folder' },
-    options: {},
-    pluginOptions: {
-      'content-manager': { visible: false },
-      'content-type-builder': { visible: false },
-    },
-    attributes: {
-      name: { type: 'string', min: 1, required: true },
-      pathId: { type: 'integer', unique: true, required: true },
-      parent: {
-        type: 'relation',
-        relation: 'manyToOne',
-        target: 'plugin::upload.folder',
-        inversedBy: 'children',
-      },
-      children: {
-        type: 'relation',
-        relation: 'oneToMany',
-        target: 'plugin::upload.folder',
-        mappedBy: 'parent',
-      },
-      files: {
-        type: 'relation',
-        relation: 'oneToMany',
-        target: 'plugin::upload.file',
-        mappedBy: 'folder',
-      },
-      path: { type: 'string', min: 1, required: true },
-      createdAt: { type: 'datetime' },
-      updatedAt: { type: 'datetime' },
-      createdBy: {
-        type: 'relation',
-        relation: 'oneToOne',
-        target: 'admin::user',
-        configurable: false,
-        writable: false,
-        visible: false,
-        useJoinTable: false,
-        private: true,
-      },
-      updatedBy: {
-        type: 'relation',
-        relation: 'oneToOne',
-        target: 'admin::user',
-        configurable: false,
-        writable: false,
-        visible: false,
-        useJoinTable: false,
-        private: true,
-      },
-    },
-    indexes: [
-      { name: 'upload_folders_path_id_index', columns: ['path_id'], type: 'unique' },
-      { name: 'upload_folders_path_index', columns: ['path'], type: 'unique' },
-    ],
-    kind: 'collectionType',
-    modelType: 'contentType',
-    modelName: 'folder',
-    uid: 'plugin::upload.folder',
-    plugin: 'upload',
-    globalId: 'UploadFolder',
-  },
-  'api::kitchensink.kitchensink': {
-    kind: 'collectionType',
-    collectionName: 'kitchensinks',
-    info: {
-      displayName: 'Kitchen Sink',
-      singularName: 'kitchensink',
-      pluralName: 'kitchensinks',
-      description: '',
-      name: 'Kitchen Sink',
-    },
-    pluginOptions: {},
-    attributes: {
-      short_text: { type: 'string' },
-      long_text: { type: 'text' },
-      rich_text: { type: 'richtext' },
-      integer: { type: 'integer' },
-      biginteger: { type: 'biginteger' },
-      decimal: { type: 'decimal' },
-      float: { type: 'float' },
-      date: { type: 'date' },
-      datetime: { type: 'datetime' },
-      time: { type: 'time' },
-      timestamp: { type: 'timestamp' },
-      boolean: { type: 'boolean' },
-      email: { type: 'email' },
-      password: { type: 'password' },
-      enumeration: { type: 'enumeration', enum: ['A', 'B', 'C', 'D', 'E'] },
-      single_media: {
-        type: 'media',
-        multiple: false,
-        required: false,
-        allowedTypes: ['images', 'files', 'videos'],
-      },
-      multiple_media: {
-        type: 'media',
-        multiple: true,
-        required: false,
-        allowedTypes: ['images', 'files', 'videos'],
-      },
-      json: { type: 'json' },
-      single_compo: { type: 'component', repeatable: false, component: 'basic.simple' },
-      repeatable_compo: { type: 'component', repeatable: true, component: 'basic.simple' },
-      dynamiczone: { type: 'dynamiczone', components: ['basic.simple', 'blog.test-como'] },
-      one_way_tag: { type: 'relation', relation: 'oneToOne', target: 'api::tag.tag' },
-      one_to_one_tag: {
-        type: 'relation',
-        relation: 'oneToOne',
-        target: 'api::tag.tag',
-        private: true,
-        inversedBy: 'one_to_one_kitchensink',
-      },
-      one_to_many_tags: {
-        type: 'relation',
-        relation: 'oneToMany',
-        target: 'api::tag.tag',
-        mappedBy: 'many_to_one_kitchensink',
-      },
-      many_to_one_tag: {
-        type: 'relation',
-        relation: 'manyToOne',
-        target: 'api::tag.tag',
-        inversedBy: 'one_to_many_kitchensinks',
-      },
-      many_to_many_tags: {
-        type: 'relation',
-        relation: 'manyToMany',
-        target: 'api::tag.tag',
-        inversedBy: 'many_to_many_kitchensinks',
-      },
-      many_way_tags: { type: 'relation', relation: 'oneToMany', target: 'api::tag.tag' },
-      morph_to_one: { type: 'relation', relation: 'morphToOne' },
-      morph_to_many: { type: 'relation', relation: 'morphToMany' },
-      custom_field: { type: 'string', customField: 'plugin::color-picker.color' },
-      custom_field_with_default_options: {
-        type: 'string',
-        regex: '^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$',
-        customField: 'plugin::color-picker.color',
-      },
-      cats: { type: 'dynamiczone', components: ['basic.relation', 'basic.simple'] },
-      createdAt: { type: 'datetime' },
-      updatedAt: { type: 'datetime' },
-      publishedAt: { type: 'datetime', configurable: false, writable: true, visible: false },
-      createdBy: {
-        type: 'relation',
-        relation: 'oneToOne',
-        target: 'admin::user',
-        configurable: false,
-        writable: false,
-        visible: false,
-        useJoinTable: false,
-        private: true,
-      },
-      updatedBy: {
-        type: 'relation',
-        relation: 'oneToOne',
-        target: 'admin::user',
-        configurable: false,
-        writable: false,
-        visible: false,
-        useJoinTable: false,
-        private: true,
-      },
-    },
-    modelType: 'contentType',
-    modelName: 'kitchensink',
-    uid: 'api::kitchensink.kitchensink',
-    apiName: 'kitchensink',
-    globalId: 'Kitchensink',
-    actions: {},
-    lifecycles: {},
-  },
-  'api::homepage.homepage': {
-    kind: 'singleType',
-    collectionName: 'homepages',
-    info: { displayName: 'Homepage', singularName: 'homepage', pluralName: 'homepages' },
-    pluginOptions: { i18n: { localized: true } },
-    attributes: {
-      title: { type: 'string', required: true, pluginOptions: { i18n: { localized: true } } },
-      slug: {
-        type: 'uid',
-        targetField: 'title',
-        required: true,
-        pluginOptions: { i18n: { localized: true } },
-      },
-    },
-  },
-};

package/server/services/__mocks__/mock-strapi-data.js

@@ -1,183 +0,0 @@
-'use strict';
-
-const contentTypes = require('./mock-content-types');
-
-module.exports = {
-  contentTypes,
-  components: {
-    'basic.simple': {
-      collectionName: 'components_basic_simples',
-      info: { displayName: 'simple', icon: 'ambulance', description: '' },
-      options: {},
-      attributes: { name: { type: 'string', required: true }, test: { type: 'string' } },
-      uid: 'basic.simple',
-      category: 'basic',
-      modelType: 'component',
-      modelName: 'simple',
-      globalId: 'ComponentBasicSimple',
-    },
-    'blog.test-como': {
-      collectionName: 'components_blog_test_comos',
-      info: { displayName: 'test comp', icon: 'air-freshener', description: '' },
-      options: {},
-      attributes: { name: { type: 'string', default: 'toto' } },
-      uid: 'blog.test-como',
-      category: 'blog',
-      modelType: 'component',
-      modelName: 'test-como',
-      globalId: 'ComponentBlogTestComo',
-    },
-    'basic.relation': {
-      collectionName: 'components_basic_relations',
-      info: { displayName: 'Relation' },
-      options: {},
-      attributes: {
-        categories: { type: 'relation', relation: 'oneToMany', target: 'api::category.category' },
-      },
-      uid: 'basic.relation',
-      category: 'basic',
-      modelType: 'component',
-      modelName: 'relation',
-      globalId: 'ComponentBasicRelation',
-    },
-  },
-  plugins: {
-    upload: {
-      contentTypes: {
-        file: contentTypes['plugin::upload.file'],
-        folder: contentTypes['plugin::upload.folder'],
-      },
-      routes: {
-        'content-api': {
-          type: 'content-api',
-          routes: [
-            {
-              method: 'POST',
-              path: '/',
-              handler: 'content-api.upload',
-              config: { auth: { scope: ['plugin::upload.content-api.upload'] } },
-              info: { pluginName: 'upload', type: 'content-api' },
-            },
-            {
-              method: 'GET',
-              path: '/files',
-              handler: 'content-api.find',
-              config: { auth: { scope: ['plugin::upload.content-api.find'] } },
-              info: { pluginName: 'upload', type: 'content-api' },
-            },
-            {
-              method: 'GET',
-              path: '/files/:id',
-              handler: 'content-api.findOne',
-              config: { auth: { scope: ['plugin::upload.content-api.findOne'] } },
-              info: { pluginName: 'upload', type: 'content-api' },
-            },
-            {
-              method: 'DELETE',
-              path: '/files/:id',
-              handler: 'content-api.destroy',
-              config: { auth: { scope: ['plugin::upload.content-api.destroy'] } },
-              info: { pluginName: 'upload', type: 'content-api' },
-            },
-          ],
-          prefix: '/upload',
-        },
-      },
-    },
-    email: {
-      contentTypes: {},
-    },
-    'users-permissions': {
-      contentTypes: {},
-    },
-  },
-  api: {
-    homepage: {
-      contentTypes: {
-        homepage: contentTypes['api::homepage.homepage'],
-      },
-      routes: {
-        homepage: {
-          type: 'content-api',
-          routes: [
-            {
-              method: 'GET',
-              path: '/homepage',
-              handler: 'api::homepage.homepage.find',
-              config: { auth: { scope: ['api::homepage.homepage.find'] } },
-              info: { apiName: 'homepage', type: 'content-api' },
-            },
-            {
-              method: 'PUT',
-              path: '/homepage',
-              handler: 'api::homepage.homepage.update',
-              config: { auth: { scope: ['api::homepage.homepage.update'] } },
-              info: { apiName: 'homepage', type: 'content-api' },
-            },
-            {
-              method: 'DELETE',
-              path: '/homepage',
-              handler: 'api::homepage.homepage.delete',
-              config: { auth: { scope: ['api::homepage.homepage.delete'] } },
-              info: { apiName: 'homepage', type: 'content-api' },
-            },
-            {
-              method: 'POST',
-              path: '/homepage',
-              handler: 'api::homepage.homepage.create',
-              config: { auth: { scope: ['api::homepage.homepage.create'] } },
-              info: { apiName: 'homepage', type: 'content-api' },
-            },
-          ],
-        },
-      },
-    },
-    kitchensink: {
-      contentTypes: {
-        kitchensink: contentTypes['api::kitchensink.kitchensink'],
-      },
-      routes: {
-        kitchensink: {
-          routes: [
-            {
-              method: 'GET',
-              path: '/kitchensinks',
-              handler: 'api::kitchensink.kitchensink.find',
-              config: { auth: { scope: ['api::kitchensink.kitchensink.find'] } },
-              info: { apiName: 'kitchensink', type: 'content-api' },
-            },
-            {
-              method: 'GET',
-              path: '/kitchensinks/:id',
-              handler: 'api::kitchensink.kitchensink.findOne',
-              config: { auth: { scope: ['api::kitchensink.kitchensink.findOne'] } },
-              info: { apiName: 'kitchensink', type: 'content-api' },
-            },
-            {
-              method: 'POST',
-              path: '/kitchensinks',
-              handler: 'api::kitchensink.kitchensink.create',
-              config: { auth: { scope: ['api::kitchensink.kitchensink.create'] } },
-              info: { apiName: 'kitchensink', type: 'content-api' },
-            },
-            {
-              method: 'PUT',
-              path: '/kitchensinks/:id',
-              handler: 'api::kitchensink.kitchensink.update',
-              config: { auth: { scope: ['api::kitchensink.kitchensink.update'] } },
-              info: { apiName: 'kitchensink', type: 'content-api' },
-            },
-            {
-              method: 'DELETE',
-              path: '/kitchensinks/:id',
-              handler: 'api::kitchensink.kitchensink.delete',
-              config: { auth: { scope: ['api::kitchensink.kitchensink.delete'] } },
-              info: { apiName: 'kitchensink', type: 'content-api' },
-            },
-          ],
-          type: 'content-api',
-        },
-      },
-    },
-  },
-};