@strapi/plugin-graphql 4.0.0-next.9 → 4.0.0

package/server/services/utils/naming.js

@@ -0,0 +1,287 @@
+'use strict';
+
+const { camelCase, upperFirst, lowerFirst, pipe, get } = require('lodash/fp');
+const { singular } = require('pluralize');
+const { ApplicationError } = require('@strapi/utils').errors;
+
+module.exports = ({ strapi }) => {
+  /**
+   * Build a type name for a enum based on a content type & an attribute name
+   * @param {object} contentType
+   * @param {string} attributeName
+   * @return {string}
+   */
+  const getEnumName = (contentType, attributeName) => {
+    const { attributes } = contentType;
+    const { enumName } = attributes[attributeName];
+    const { modelType } = contentType;
+
+    const typeName =
+      modelType === 'component' ? getComponentName(contentType) : getTypeName(contentType);
+
+    const defaultEnumName = `ENUM_${typeName.toUpperCase()}_${attributeName.toUpperCase()}`;
+
+    return enumName || defaultEnumName;
+  };
+
+  /**
+   * Build the base type name for a given content type
+   * @param {object} contentType
+   * @param {object} options
+   * @param {'singular' | 'plural'} options.plurality
+   * @return {string}
+   */
+  const getTypeName = (contentType, { plurality = 'singular' } = {}) => {
+    const plugin = get('plugin', contentType);
+    const modelName = get('modelName', contentType);
+    const name =
+      plurality === 'singular'
+        ? get('info.singularName', contentType)
+        : get('info.pluralName', contentType);
+
+    const transformedPlugin = upperFirst(camelCase(plugin));
+    const transformedModelName = upperFirst(camelCase(name || singular(modelName)));
+
+    return `${transformedPlugin}${transformedModelName}`;
+  };
+
+  /**
+   * Build the entity's type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getEntityName = contentType => {
+    return `${getTypeName(contentType)}Entity`;
+  };
+
+  /**
+   * Build the entity meta type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getEntityMetaName = contentType => {
+    return `${getEntityName(contentType)}Meta`;
+  };
+
+  /**
+   * Build the entity response's type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getEntityResponseName = contentType => {
+    return `${getEntityName(contentType)}Response`;
+  };
+
+  /**
+   * Build the entity response collection's type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getEntityResponseCollectionName = contentType => {
+    return `${getEntityName(contentType)}ResponseCollection`;
+  };
+
+  /**
+   * Build the relation response collection's type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getRelationResponseCollectionName = contentType => {
+    return `${getTypeName(contentType)}RelationResponseCollection`;
+  };
+
+  /**
+   * Build a component type name based on its definition
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getComponentName = contentType => {
+    return contentType.globalId;
+  };
+
+  /**
+   * Build a component type name based on a content type's attribute
+   * @param {object} attribute
+   * @return {string}
+   */
+  const getComponentNameFromAttribute = attribute => {
+    return strapi.components[attribute.component].globalId;
+  };
+
+  /**
+   * Build a dynamic zone type name based on a content type and an attribute name
+   * @param {object} contentType
+   * @param {string} attributeName
+   * @return {string}
+   */
+  const getDynamicZoneName = (contentType, attributeName) => {
+    const typeName = getTypeName(contentType);
+    const dzName = upperFirst(camelCase(attributeName));
+    const suffix = 'DynamicZone';
+
+    return `${typeName}${dzName}${suffix}`;
+  };
+
+  /**
+   * Build a dynamic zone input type name based on a content type and an attribute name
+   * @param {object} contentType
+   * @param {string} attributeName
+   * @return {string}
+   */
+  const getDynamicZoneInputName = (contentType, attributeName) => {
+    const dzName = getDynamicZoneName(contentType, attributeName);
+
+    return `${dzName}Input`;
+  };
+
+  /**
+   * Build a component input type name based on a content type and an attribute name
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getComponentInputName = contentType => {
+    const componentName = getComponentName(contentType);
+
+    return `${componentName}Input`;
+  };
+
+  /**
+   * Build a content type input name based on a content type and an attribute name
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getContentTypeInputName = contentType => {
+    const typeName = getTypeName(contentType);
+
+    return `${typeName}Input`;
+  };
+
+  /**
+   * Build the queries type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getEntityQueriesTypeName = contentType => {
+    return `${getEntityName(contentType)}Queries`;
+  };
+
+  /**
+   * Build the mutations type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getEntityMutationsTypeName = contentType => {
+    return `${getEntityName(contentType)}Mutations`;
+  };
+
+  /**
+   * Build the filters type name for a given content type
+   * @param {object} contentType
+   * @return {string}
+   */
+  const getFiltersInputTypeName = contentType => {
+    const isComponent = contentType.modelType === 'component';
+
+    const baseName = isComponent ? getComponentName(contentType) : getTypeName(contentType);
+
+    return `${baseName}FiltersInput`;
+  };
+
+  /**
+   * Build a filters type name for a given GraphQL scalar type
+   * @param {NexusGenScalars} scalarType
+   * @return {string}
+   */
+  const getScalarFilterInputTypeName = scalarType => {
+    return `${scalarType}FilterInput`;
+  };
+
+  /**
+   * Build a type name for a given content type & polymorphic attribute
+   * @param {object} contentType
+   * @param {string} attributeName
+   * @return {string}
+   */
+  const getMorphRelationTypeName = (contentType, attributeName) => {
+    const typeName = getTypeName(contentType);
+    const formattedAttr = upperFirst(camelCase(attributeName));
+
+    return `${typeName}${formattedAttr}Morph`;
+  };
+
+  /**
+   * Build a custom type name generator with different customization options
+   * @param {object} options
+   * @param {string} [options.prefix]
+   * @param {string} [options.suffix]
+   * @param {'upper' | 'lower'} [options.firstLetterCase]
+   * @param {'plural' | 'singular'} [options.plurality]
+   * @return {function(*=): string}
+   */
+  const buildCustomTypeNameGenerator = (options = {}) => {
+    // todo[v4]: use singularName & pluralName is available
+    const { prefix = '', suffix = '', plurality = 'singular', firstLetterCase = 'upper' } = options;
+
+    if (!['plural', 'singular'].includes(plurality)) {
+      throw new ApplicationError(
+        `"plurality" param must be either "plural" or "singular", but got: "${plurality}"`
+      );
+    }
+
+    const getCustomTypeName = pipe(
+      ct => getTypeName(ct, { plurality }),
+      firstLetterCase === 'upper' ? upperFirst : lowerFirst
+    );
+
+    return contentType => `${prefix}${getCustomTypeName(contentType)}${suffix}`;
+  };
+
+  const getFindQueryName = buildCustomTypeNameGenerator({
+    plurality: 'plural',
+    firstLetterCase: 'lower',
+  });
+
+  const getFindOneQueryName = buildCustomTypeNameGenerator({ firstLetterCase: 'lower' });
+
+  const getCreateMutationTypeName = buildCustomTypeNameGenerator({
+    prefix: 'create',
+    firstLetterCase: 'upper',
+  });
+
+  const getUpdateMutationTypeName = buildCustomTypeNameGenerator({
+    prefix: 'update',
+    firstLetterCase: 'upper',
+  });
+
+  const getDeleteMutationTypeName = buildCustomTypeNameGenerator({
+    prefix: 'delete',
+    firstLetterCase: 'upper',
+  });
+
+  return {
+    getEnumName,
+    getTypeName,
+    getEntityName,
+    getEntityMetaName,
+    getEntityResponseName,
+    getEntityResponseCollectionName,
+    getRelationResponseCollectionName,
+    getComponentName,
+    getComponentNameFromAttribute,
+    getDynamicZoneName,
+    getDynamicZoneInputName,
+    getComponentInputName,
+    getContentTypeInputName,
+    getEntityQueriesTypeName,
+    getEntityMutationsTypeName,
+    getFiltersInputTypeName,
+    getScalarFilterInputTypeName,
+    getMorphRelationTypeName,
+    buildCustomTypeNameGenerator,
+    getFindQueryName,
+    getFindOneQueryName,
+    getCreateMutationTypeName,
+    getUpdateMutationTypeName,
+    getDeleteMutationTypeName,
+  };
+};

package/strapi-admin.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('./admin/src').default;

package/strapi-server.js

@@ -1,15 +1,13 @@
 'use strict';
 
+const bootstrap = require('./server/bootstrap');
+const services = require('./server/services');
+const config = require('./server/config');
+
 module.exports = (/* strapi, config */) => {
   return {
-    bootstrap: () => {},
-    destroy: () => {},
-    config: {},
-    routes: [],
-    controllers: {},
-    services: () => {},
-    policies: {},
-    middlewares: {},
-    contentTypes: {},
+    config,
+    bootstrap,
+    services,
   };
 };

package/admin/src/assets/images/logo.svg

@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="25px" height="28px" viewBox="0 0 25 28" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-    <!-- Generator: Sketch 46.1 (44463) - http://www.bohemiancoding.com/sketch -->
-    <title>GraphQL_Logo</title>
-    <desc>Created with Sketch.</desc>
-    <defs></defs>
-    <g id="Pages" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
-        <g id="List-plugins" transform="translate(-302.000000, -668.000000)" fill-rule="nonzero" fill="#E535AB">
-            <g id="Container" transform="translate(263.000000, 83.000000)">
-                <g id="Content">
-                    <g id="Forms" transform="translate(1.000000, 78.000000)">
-                        <g id="List" transform="translate(15.000000, 19.000000)">
-                            <g id="9" transform="translate(0.000000, 484.000000)">
-                                <g id="GraphQL_Logo" transform="translate(23.000000, 4.000000)">
-                                    <rect id="Rectangle-path" transform="translate(7.525343, 11.130007) rotate(-149.999272) translate(-7.525343, -11.130007) " x="6.93249876" y="-0.309026904" width="1.1856882" height="22.8780681"></rect>
-                                    <rect id="Rectangle-path" x="1.05714286" y="19.1571429" width="22.8785714" height="1.18571429"></rect>
-                                    <rect id="Rectangle-path" transform="translate(7.528064, 22.613421) rotate(-149.999272) translate(-7.528064, -22.613421) " x="0.921066787" y="22.0205773" width="13.213995" height="1.1856882"></rect>
-                                    <rect id="Rectangle-path" transform="translate(17.469093, 5.393493) rotate(-149.999272) translate(-17.469093, -5.393493) " x="10.8620954" y="4.80064876" width="13.213995" height="1.1856882"></rect>
-                                    <rect id="Rectangle-path" transform="translate(7.531236, 5.388979) rotate(-120.000728) translate(-7.531236, -5.388979) " x="6.93839161" y="-1.21801893" width="1.1856882" height="13.213995"></rect>
-                                    <rect id="Rectangle-path" transform="translate(17.477229, 11.130221) rotate(-120.000728) translate(-17.477229, -11.130221) " x="6.03819452" y="10.5373773" width="22.8780681" height="1.1856882"></rect>
-                                    <rect id="Rectangle-path" x="1.96428571" y="7.39285714" width="1.18571429" height="13.2142857"></rect>
-                                    <rect id="Rectangle-path" x="21.85" y="7.39285714" width="1.18571429" height="13.2142857"></rect>
-                                    <rect id="Rectangle-path" transform="translate(17.469043, 22.606829) rotate(-120.000728) translate(-17.469043, -22.606829) " x="16.9511971" y="16.8605264" width="1.0356915" height="11.4926043"></rect>
-                                    <path d="M24.6071429,20.9928571 C23.9214286,22.1857143 22.3928571,22.5928571 21.2,21.9071429 C20.0071429,21.2214286 19.6,19.6928571 20.2857143,18.5 C20.9714286,17.3071429 22.5,16.9 23.6928571,17.5857143 C24.8928571,18.2785714 25.3,19.8 24.6071429,20.9928571" id="Shape"></path>
-                                    <path d="M4.70714286,9.5 C4.02142857,10.6928571 2.49285714,11.1 1.3,10.4142857 C0.107142857,9.72857143 -0.3,8.2 0.385714286,7.00714286 C1.07142857,5.81428571 2.6,5.40714286 3.79285714,6.09285714 C4.98571429,6.78571429 5.39285714,8.30714286 4.70714286,9.5" id="Shape"></path>
-                                    <path d="M0.392857143,20.9928571 C-0.292857143,19.8 0.114285714,18.2785714 1.30714286,17.5857143 C2.5,16.9 4.02142857,17.3071429 4.71428571,18.5 C5.4,19.6928571 4.99285714,21.2142857 3.8,21.9071429 C2.6,22.5928571 1.07857143,22.1857143 0.392857143,20.9928571" id="Shape"></path>
-                                    <path d="M20.2928571,9.5 C19.6071429,8.30714286 20.0142857,6.78571429 21.2071429,6.09285714 C22.4,5.40714286 23.9214286,5.81428571 24.6142857,7.00714286 C25.3,8.2 24.8928571,9.72142857 23.7,10.4142857 C22.5071429,11.1 20.9785714,10.6928571 20.2928571,9.5" id="Shape"></path>
-                                    <path d="M12.5,27.9857143 C11.1214286,27.9857143 10.0071429,26.8714286 10.0071429,25.4928571 C10.0071429,24.1142857 11.1214286,23 12.5,23 C13.8785714,23 14.9928571,24.1142857 14.9928571,25.4928571 C14.9928571,26.8642857 13.8785714,27.9857143 12.5,27.9857143" id="Shape"></path>
-                                    <path d="M12.5,5 C11.1214286,5 10.0071429,3.88571429 10.0071429,2.50714286 C10.0071429,1.12857143 11.1214286,0.0142857143 12.5,0.0142857143 C13.8785714,0.0142857143 14.9928571,1.12857143 14.9928571,2.50714286 C14.9928571,3.88571429 13.8785714,5 12.5,5" id="Shape"></path>
-                                </g>
-                            </g>
-                        </g>
-                    </g>
-                </g>
-            </g>
-        </g>
-    </g>
-</svg>

package/config/routes.json

@@ -1,3 +0,0 @@
-{
-  "routes": []
-}

package/config/schema.graphql

@@ -1 +0,0 @@
-module.exports = {};

package/config/settings.json

@@ -1,12 +0,0 @@
-{
-  "endpoint": "/graphql",
-  "shadowCRUD": true,
-  "playgroundAlways": false,
-  "depthLimit": 7,
-  "amountLimit": 100,
-  "shareEnabled": false,
-  "federation": false,
-  "apolloServer": {
-    "tracing": false
-  }
-}

package/controllers/GraphQL.js

@@ -1,9 +0,0 @@
-'use strict';
-
-/**
- * GraphQL.js controller
- *
- * @description: A set of functions called "actions" of the `GraphQL` plugin.
- */
-
-module.exports = {};

package/hooks/graphql/defaults.json

@@ -1,5 +0,0 @@
-{
-  "graphql": {
-    "enabled": true
-  }
-}

package/hooks/graphql/index.js

@@ -1,174 +0,0 @@
-'use strict';
-
-/**
- * Module dependencies
- */
-
-// Public node modules.
-const _ = require('lodash');
-const { ApolloServer } = require('apollo-server-koa');
-const depthLimit = require('graphql-depth-limit');
-const { graphqlUploadKoa } = require('graphql-upload');
-const loadConfigs = require('./load-config');
-
-const attachMetadataToResolvers = (schema, { api, plugin }) => {
-  const { resolver = {} } = schema;
-  if (_.isEmpty(resolver)) return schema;
-
-  Object.keys(resolver).forEach(type => {
-    if (!_.isPlainObject(resolver[type])) return;
-
-    Object.keys(resolver[type]).forEach(resolverName => {
-      if (!_.isPlainObject(resolver[type][resolverName])) return;
-
-      resolver[type][resolverName]['_metadatas'] = {
-        api,
-        plugin,
-      };
-    });
-  });
-
-  return schema;
-};
-
-module.exports = strapi => {
-  const { appPath, installedPlugins } = strapi.config;
-
-  return {
-    async beforeInitialize() {
-      // Try to inject this hook just after the others hooks to skip the router processing.
-      if (!strapi.config.get('hook.load.after')) {
-        _.set(strapi.config.hook.load, 'after', []);
-      }
-
-      strapi.config.hook.load.after.push('graphql');
-      // Load core utils.
-
-      const { api, plugins, extensions } = await loadConfigs({
-        appPath,
-        installedPlugins,
-      });
-      _.merge(strapi, { api, plugins });
-
-      // Create a merge of all the GraphQL configuration.
-      const apisSchemas = Object.keys(strapi.api || {}).map(key => {
-        const schema = _.get(strapi.api[key], 'config.schema.graphql', {});
-        return attachMetadataToResolvers(schema, { api: key });
-      });
-
-      const pluginsSchemas = Object.keys(strapi.plugins || {}).map(key => {
-        const schema = _.get(strapi.plugins[key], 'config.schema.graphql', {});
-        return attachMetadataToResolvers(schema, { plugin: key });
-      });
-
-      const extensionsSchemas = Object.keys(extensions || {}).map(key => {
-        const schema = _.get(extensions[key], 'config.schema.graphql', {});
-        return attachMetadataToResolvers(schema, { plugin: key });
-      });
-
-      const baseSchema = mergeSchemas([...pluginsSchemas, ...extensionsSchemas, ...apisSchemas]);
-
-      // save the final schema in the plugin's config
-      _.set(strapi.plugins.graphql, 'config._schema.graphql', baseSchema);
-    },
-
-    initialize() {
-      const schema = strapi.plugins.graphql.services['schema-generator'].generateSchema();
-
-      if (_.isEmpty(schema)) {
-        strapi.log.warn('The GraphQL schema has not been generated because it is empty');
-
-        return;
-      }
-
-      const config = _.get(strapi.plugins.graphql, 'config', {});
-
-      // TODO: Remove these deprecated options in favor of `apolloServer` in the next major version
-      const deprecatedApolloServerConfig = {
-        tracing: _.get(config, 'tracing', false),
-        introspection: _.get(config, 'introspection', true),
-        engine: _.get(config, 'engine', false),
-      };
-
-      if (['tracing', 'introspection', 'engine'].some(key => _.has(config, key))) {
-        strapi.log.warn(
-          'The `tracing`, `introspection` and `engine` options are deprecated in favor of the `apolloServer` object and they will be removed in the next major version.'
-        );
-      }
-
-      const apolloServerConfig = _.get(config, 'apolloServer', {});
-
-      const serverParams = {
-        schema,
-        uploads: false,
-        context: ({ ctx }) => {
-          // Initiliase loaders for this request.
-          // TODO: set loaders in the context not globally
-
-          strapi.plugins.graphql.services['data-loaders'].initializeLoader();
-
-          return {
-            context: ctx,
-          };
-        },
-        formatError: err => {
-          const formatError = _.get(config, 'formatError', null);
-
-          return typeof formatError === 'function' ? formatError(err) : err;
-        },
-        validationRules: [depthLimit(config.depthLimit)],
-        playground: false,
-        cors: false,
-        bodyParserConfig: true,
-        // TODO: Remove these deprecated options in favor of `apolloServerConfig` in the next major version
-        ...deprecatedApolloServerConfig,
-        ...apolloServerConfig,
-      };
-
-      // Disable GraphQL Playground in production environment.
-      if (strapi.config.environment !== 'production' || config.playgroundAlways) {
-        serverParams.playground = {
-          endpoint: `${strapi.config.server.url}${config.endpoint}`,
-          shareEnabled: config.shareEnabled,
-        };
-      }
-
-      const server = new ApolloServer(serverParams);
-
-      const uploadMiddleware = graphqlUploadKoa();
-      strapi.app.use((ctx, next) => {
-        if (ctx.path === config.endpoint) {
-          return uploadMiddleware(ctx, next);
-        }
-
-        return next();
-      });
-      server.applyMiddleware({
-        app: strapi.app,
-        path: config.endpoint,
-      });
-
-      strapi.plugins.graphql.destroy = async () => {
-        await server.stop();
-      };
-    },
-  };
-};
-
-/**
- * Merges a  list of schemas
- * @param {Array<Object>} schemas - The list of schemas to merge
- */
-const mergeSchemas = schemas => {
-  return schemas.reduce((acc, el) => {
-    const { definition, query, mutation, type, resolver } = el;
-
-    return _.merge(acc, {
-      definition: `${acc.definition || ''} ${definition || ''}`,
-      query: `${acc.query || ''} ${query || ''}`,
-      mutation: `${acc.mutation || ''} ${mutation || ''}`,
-      type,
-      resolver,
-    });
-  }, {});
-};

package/hooks/graphql/load-config.js

@@ -1,42 +0,0 @@
-'use strict';
-
-// eslint-disable-next-line node/no-extraneous-require
-const loadUtils = require('@strapi/strapi/lib/load');
-const _ = require('lodash');
-
-const loadApisGraphqlConfig = appPath =>
-  loadUtils.loadFiles(appPath, 'api/**/config/*.graphql?(.js)');
-
-const loadPluginsGraphqlConfig = async installedPlugins => {
-  const root = {};
-
-  for (let pluginName of installedPlugins) {
-    const pluginDir = loadUtils.findPackagePath(`@strapi/plugin-${pluginName}`);
-
-    const result = await loadUtils.loadFiles(pluginDir, 'config/*.graphql?(.js)');
-
-    _.set(root, ['plugins', pluginName], result);
-  }
-
-  return root;
-};
-
-const loadLocalPluginsGraphqlConfig = async appPath =>
-  loadUtils.loadFiles(appPath, 'plugins/**/config/*.graphql?(.js)');
-
-const loadExtensions = async appPath =>
-  loadUtils.loadFiles(appPath, 'extensions/**/config/*.graphql?(.js)');
-
-/**
- * Loads the graphql config files
- */
-module.exports = async ({ appPath, installedPlugins }) => {
-  const [apis, plugins, localPlugins, extensions] = await Promise.all([
-    loadApisGraphqlConfig(appPath),
-    loadPluginsGraphqlConfig(installedPlugins),
-    loadLocalPluginsGraphqlConfig(appPath),
-    loadExtensions(appPath),
-  ]);
-
-  return _.merge({}, apis, plugins, extensions, localPlugins);
-};