Add simpleEnumValues option

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

.gitignore

@@ -1,37 +1,11 @@
-# visual code settings
-.vscode/
+# OpenAPI-to-GraphQL specific
+packages/openapi-to-graphql/APIs
 
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
+# Visual Code settings
+.vscode
 
 # Dependency directories
 node_modules
-jspm_packages
 
 # Optional npm cache directory
 .npm

packages/openapi-to-graphql/lib/index.js

@@ -113,6 +113,16 @@ export declare type InternalOptions<TSource, TContext, TArgs> = {
      * to the provided names in the OAS as possible.
      */
     simpleNames: boolean;
+    /**
+     * By default, field names are sanitized to conform with GraphQL conventions,
+     * i.e. types should be in PascalCase, fields should be in camelCase, and
+     * enum values should be in ALL_CAPS.
+     *
+     * This option will prevent OpenAPI-to-GraphQL from enforcing ALL_CAPS enum
+     * values, only removing illegal characters and staying as true to the
+     * provided enum values in the OAS as possible.
+     */
+    simpleEnumValues: boolean;
     /**
      * Experimental feature that will try to create more meaningful names from
      * the operation path than the response object by leveraging common

packages/openapi-to-graphql/lib/index.js.map

@@ -112,6 +112,10 @@ export function createGraphQLSchema<TSource, TContext, TArgs>(
         : false
     options.simpleNames =
       typeof options.simpleNames === 'boolean' ? options.simpleNames : false
+    options.simpleEnumValues =
+      typeof options.simpleEnumValues === 'boolean'
+        ? options.simpleEnumValues
+        : false
     options.singularNames =
       typeof options.singularNames === 'boolean' ? options.singularNames : false
     options.createSubscriptionsFromCallbacks =
@@ -153,36 +157,33 @@ export function createGraphQLSchema<TSource, TContext, TArgs>(
         spec.map((ele) => {
           return Oas3Tools.getValidOAS3(ele)
         })
-      )
-        .then((oass) => {
-          resolve(
-            translateOpenAPIToGraphQL(
-              oass,
-              options as InternalOptions<TSource, TContext, TArgs>
-            )
+      ).then((oass) => {
+        resolve(
+          translateOpenAPIToGraphQL(
+            oass,
+            options as InternalOptions<TSource, TContext, TArgs>
           )
-        })
-        .catch((error) => {
-          reject(error)
-        })
+        )
+      }).catch((error) => {
+        reject(error)
+      })
     } else {
       /**
        * Check if the spec is a valid OAS 3
        * If the spec is OAS 2.0, attempt to translate it into 3, then try to
        * translate the spec into a GraphQL schema
        */
-      Oas3Tools.getValidOAS3(spec)
-        .then((oas) => {
-          resolve(
-            translateOpenAPIToGraphQL(
-              [oas],
-              options as InternalOptions<TSource, TContext, TArgs>
-            )
+      Oas3Tools.getValidOAS3(spec).then((oas) => {
+        resolve(
+          translateOpenAPIToGraphQL(
+            [oas],
+            options as InternalOptions<TSource, TContext, TArgs>
           )
-        })
-        .catch((error) => {
-          reject(error)
-        })
+        )
+      })
+      .catch((error) => {
+        reject(error)
+      })
     }
   })
 }
@@ -204,6 +205,7 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     selectQueryOrMutationField,
     genericPayloadArgName,
     simpleNames,
+    simpleEnumValues,
     singularNames,
     createSubscriptionsFromCallbacks,
 
@@ -238,6 +240,7 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     selectQueryOrMutationField,
     genericPayloadArgName,
     simpleNames,
+    simpleEnumValues,
     singularNames,
     createSubscriptionsFromCallbacks,
 

packages/openapi-to-graphql/lib/resolver_builder.js

@@ -402,14 +402,14 @@ export function getResolver<TSource, TContext, TArgs>({
      * the user.
      */
     operation.parameters.forEach((param) => {
-      const paramName = Oas3Tools.sanitize(
+      const saneParamName = Oas3Tools.sanitize(
         param.name,
         !data.options.simpleNames
           ? Oas3Tools.CaseStyle.camelCase
           : Oas3Tools.CaseStyle.simple
       )
       if (
-        typeof args[paramName] === 'undefined' &&
+        typeof args[saneParamName] === 'undefined' &&
         param.schema &&
         typeof param.schema === 'object'
       ) {
@@ -422,7 +422,7 @@ export function getResolver<TSource, TContext, TArgs>({
           (schema as SchemaObject).default &&
           typeof (schema as SchemaObject).default !== 'undefined'
         ) {
-          args[paramName] = (schema as SchemaObject).default
+          args[saneParamName] = (schema as SchemaObject).default
         }
       }
     })
@@ -1282,28 +1282,28 @@ export function extractRequestDataFromArgs<TSource, TContext, TArgs>(
 
   // Iterate parameters:
   for (const param of parameters) {
-    const sanitizedParamName = Oas3Tools.sanitize(
+    const saneParamName = Oas3Tools.sanitize(
       param.name,
       !data.options.simpleNames
         ? Oas3Tools.CaseStyle.camelCase
         : Oas3Tools.CaseStyle.simple
     )
 
-    if (sanitizedParamName && sanitizedParamName in args) {
+    if (saneParamName && saneParamName in args) {
       switch (param.in) {
         // Path parameters
         case 'path':
-          path = path.replace(`{${param.name}}`, args[sanitizedParamName])
+          path = path.replace(`{${param.name}}`, args[saneParamName])
           break
 
         // Query parameters
         case 'query':
-          qs[param.name] = args[sanitizedParamName]
+          qs[param.name] = args[saneParamName]
           break
 
         // Header parameters
         case 'header':
-          headers[param.name] = args[sanitizedParamName]
+          headers[param.name] = args[saneParamName]
           break
 
         // Cookie parameters
@@ -1312,7 +1312,7 @@ export function extractRequestDataFromArgs<TSource, TContext, TArgs>(
             headers['cookie'] = ''
           }
 
-          headers['cookie'] += `${param.name}=${args[sanitizedParamName]}; `
+          headers['cookie'] += `${param.name}=${args[saneParamName]}; `
           break
 
         default:

packages/openapi-to-graphql/lib/resolver_builder.js.map

@@ -537,13 +537,12 @@ function createOrReuseEnum<TSource, TContext, TArgs>({
 
     const values = {}
     def.schema.enum.forEach((e) => {
-      // Force enum values to string and value should be in ALL_CAPS
       values[
         Oas3Tools.sanitize(
           e.toString(),
-          data.options.simpleNames
-            ? Oas3Tools.CaseStyle.simple
-            : Oas3Tools.CaseStyle.ALL_CAPS
+          !data.options.simpleEnumValues
+            ? Oas3Tools.CaseStyle.ALL_CAPS
+            : Oas3Tools.CaseStyle.simple
         )
       ] = {
         value: e

packages/openapi-to-graphql/lib/schema_builder.js

@@ -66,8 +66,10 @@ export type RequestOptions<TSource, TContext, TArgs> = Omit<
 > & {
   headers?: Headers | RequestHeadersFunction<TSource, TContext, TArgs>
 }
-      
-export type Options<TSource, TContext, TArgs> = Partial<InternalOptions<TSource, TContext, TArgs>>
+
+export type Options<TSource, TContext, TArgs> = Partial<
+  InternalOptions<TSource, TContext, TArgs>
+>
 
 export type InternalOptions<TSource, TContext, TArgs> = {
   /*
@@ -150,6 +152,17 @@ export type InternalOptions<TSource, TContext, TArgs> = {
    */
   simpleNames: boolean
 
+  /**
+   * By default, field names are sanitized to conform with GraphQL conventions,
+   * i.e. types should be in PascalCase, fields should be in camelCase, and
+   * enum values should be in ALL_CAPS.
+   *
+   * This option will prevent OpenAPI-to-GraphQL from enforcing ALL_CAPS enum
+   * values, only removing illegal characters and staying as true to the
+   * provided enum values in the OAS as possible.
+   */
+  simpleEnumValues: boolean
+
   /**
    * Experimental feature that will try to create more meaningful names from
    * the operation path than the response object by leveraging common
@@ -220,7 +233,9 @@ export type InternalOptions<TSource, TContext, TArgs> = {
    * implementing performance improvements like caching, or dealing with
    * non-standard authentication requirements.
    */
-  customResolvers?: OasTitlePathMethodObject<GraphQLFieldResolver<TSource, TContext, TArgs>>
+  customResolvers?: OasTitlePathMethodObject<
+    GraphQLFieldResolver<TSource, TContext, TArgs>
+  >
 
   /**
    * Allows to define custom resolvers and subscribe functions for fields on the