Refactoring and doc improvements

Signed-off-by: Alan Cha <Alan.cha1@ibm.com>

Author: Alan-Cha

packages/openapi-to-graphql/README.md

@@ -133,7 +133,7 @@ Notice that the slashes in the path `/favoriteBooks/{name}` must be escaped with
 
 ### File Uploads
 
-Support for file uploads through GraphQL is implemented based on the spec defined [here](https://github.com/jaydenseric/graphql-multipart-request-spec), through the module [`graphql-upload`](https://github.com/jaydenseric/graphql-upload). This requires that to opt-in for file uploads, it is required that a GraphQL client that provides support for the spec is used, additionally, on the Graphql Server the util method `processRequest` provided by the module `graphql-upload` is integrated to format the received request body to match the expectations for the spec.
+Support for file uploads through GraphQL is implemented based on the spec defined [here](https://github.com/jaydenseric/graphql-multipart-request-spec), through the module [`graphql-upload`](https://github.com/jaydenseric/graphql-upload). To opt in for file uploads, a GraphQL client that provides support for the spec must be used. Additionally, on the GraphQL server, the util method `processRequest` provided by the module `graphql-upload` must be integrated to format the received request body to match the expectations for the spec.
 
 ### Options
 
@@ -187,7 +187,7 @@ Resolver options:
 
 - `customSubscriptionResolvers` (type: `object`, default: `{}`): If the `createSubscriptionsFromCallbacks` is enabled, OpenAPI-to-GraphQL will generate Subscription fields. This option allows users to provide custom resolver and subscribe functions to be used in place of said ones created by OpenAPI-to-GraphQL. The field that the custom resolver and subscribe functions will affect is identifed first by the [title](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject) of the OAS, then the [path](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#paths-object) of the operation, and lastly the [method](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-item-object) of the operation. The resolver is provided via the `resolver` field and the publish function is provided via the `publish` field. The `customSubscriptionResolvers` object is thus a quadruply nested object where the outer key is the title, followed by the path, then the method, and lastly either `resolver` or `publish` which points to the [resolver function](https://graphql.org/learn/execution/#root-fields-resolvers) itself or publish function. See the [Subscriptions tutorial](./docs/subscriptions.md) for more information. _Note: Because the arguments are provided by the GraphQL interface, they may look different from the [parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject) defined by the OAS. For example, they will have [sanitized](https://github.com/IBM/openapi-to-graphql#characteristics) names. The [request body](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject) will also be contained in the arguments as an [input object type](https://graphql.org/graphql-js/mutations-and-input-types/)._
 
-- `fileUploadOptions` (type: `object`, default: `{}`): This options allows users to provide custom options for the form data object that will be used to process requests to endpoints that require a multipart request body, provided through the [`form-data` module](https://github.com/form-data/form-data)
+- `fileUploadOptions` (type: `object`, default: `{}`): This options allows users to provide custom options for the form data object that will be used to process requests to endpoints that require a multipart request body, provided through the [`form-data` module](https://github.com/form-data/form-data). See [file uploads](#file-uploads).
 
 ***
 

packages/openapi-to-graphql/src/resolver_builder.ts

@@ -328,14 +328,14 @@ export function getPublishResolver<TSource, TContext, TArgs>({
  * If the operation type is Query or Mutation, create and return a resolver
  * function that performs API requests for the given GraphQL query
  */
-export function getResolver<TSource, TContext, TArgs> ({
+export function getResolver<TSource, TContext, TArgs>({
   operation,
   argsFromLink = {},
   payloadName,
   data,
   baseUrl,
   requestOptions,
-    fileUploadOptions,
+  fileUploadOptions,
   fetch
 }: GetResolverParams<TSource, TContext, TArgs>): GraphQLFieldResolver<
   TSource & OpenAPIToGraphQLSource<TSource, TContext, TArgs>,
@@ -560,7 +560,7 @@ export function getResolver<TSource, TContext, TArgs> ({
      * GraphQL produces sanitized payload names, so we have to sanitize before
      * lookup here
      */
-    let form
+    let form: FormData
     resolveData.usedPayload = undefined
     if (typeof payloadName === 'string') {
       // The option genericPayloadArgName will change the payload name to "requestBody"
@@ -595,7 +595,7 @@ export function getResolver<TSource, TContext, TArgs> ({
 
                 originalFileStream.on('readable', function () {
                   let data
-                  // tslint:disable-next-line:no-conditional-assignment
+
                   while (data = this.read()) {
                     const canReadNext = filePassThrough.write(data)
                     if (!canReadNext) {
@@ -621,7 +621,7 @@ export function getResolver<TSource, TContext, TArgs> ({
                   contentType: uploadingFile.mimetype
                 })
               } else if (typeof fieldValue !== 'string') {
-                // handle all other primitives that aren't strings as strings the way the web server would expect it
+                // Handle all other primitives that aren't strings as strings the way the web server would expect it
                 form.append(fieldName, JSON.stringify(fieldValue))
               } else {
                 form.append(fieldName, fieldValue)
@@ -657,9 +657,13 @@ export function getResolver<TSource, TContext, TArgs> ({
         }
 
         if (form) {
+          /**
+           * When there is a form, remove default content type and leave 
+           * computation of content-type header to fetch
+           * 
+           * See https://github.com/github/fetch/issues/505#issuecomment-293064470
+           */
           Object.assign(options.headers, form.getHeaders())
-          // when is form, remove default content type and leave computation of content-type header to fetch
-          // see https://github.com/github/fetch/issues/505#issuecomment-293064470
           delete options.headers['content-type']
         }
       }

packages/openapi-to-graphql/src/types/options.ts

@@ -291,7 +291,7 @@ export type InternalOptions<TSource, TContext, TArgs> = {
    * Allows one to define config for the form data that will be used in streaming
    * the uploaded file from the client to the intending endpoint
    *
-   * Based on https://github.com/form-data/form-data#custom-options
+   * Based on: https://github.com/form-data/form-data#custom-options
    */
   fileUploadOptions?: FileUploadOptions
 

packages/openapi-to-graphql/test/README.md

@@ -25,11 +25,12 @@ The following table summarizes the purposes of these tests.
 | Test file | API(s) | Testing purpose |
 |---|---|---|
 | `example_api.test.ts` | `Example API` | An assortment of basic functionality and options on a company-themed API |
-| `authentication.test.ts` | `Example API` | Basic authentication tests including using the [viewer functionality](https://github.com/IBM/openapi-to-graphql/blob/master/packages/openapi-to-graphql/README.md#authentication) |
-| `example_api2.test.ts` | `Example API 2` | The [`operationIdFieldNames` option](https://github.com/IBM/openapi-to-graphql/blob/master/packages/openapi-to-graphql/README.md#options) |
-| `example_api3.test.ts` | `Example API` and `Example API 3` | Creating GraphQL wrappers from multiple APIs and [interOAS links](https://github.com/IBM/openapi-to-graphql/blob/master/packages/openapi-to-graphql/README.md#nested-objects) |
+| `authentication.test.ts` | `Example API` | Basic authentication tests including using the [viewer functionality](../README.md#authentication) |
+| `example_api2.test.ts` | `Example API 2` | The [`operationIdFieldNames` option](../README.md#options) |
+| `example_api3.test.ts` | `Example API` and `Example API 3` | Creating GraphQL wrappers from multiple APIs and [interOAS links](../README.md#nested-objects) |
 | `example_api4.test.ts` | `Example API 4` | JSON schema [combining schema](https://json-schema.org/understanding-json-schema/reference/combining.html) keywords |
-| `example_api5.test.ts` | `Example API 5` | The [`simpleNames` option](https://github.com/IBM/openapi-to-graphql/blob/master/packages/openapi-to-graphql/README.md#options) |
+| `example_api5.test.ts` | `Example API 5` | The [`simpleNames` option](../README.md#options) |
 | `example_api6.test.ts` | `Example API 6` | An assortment of other functionality and options |
 | `example_api7.test.ts` | `Example API 7` | [Subscription support](../docs/subscriptions.md) |
+| `file_upload.test.ts` | `File Upload API` | [File uploads](../README.md#file-uploads) and [file upload options](../README.md#options) |
 | `extensions.test.ts`   | `Extensions`, `Extensions Error 1`, `Extensions Error 2`, `Extensions Error 3`, `Extensions Error 4`, `Extensions Error 5`, `Extensions Error 6`, `Extensions Error 7` | The [`x-graphql-field-name`, `x-graphql-type-name`, and `x-graphql-enum-mapping` extensions](https://github.com/IBM/openapi-to-graphql/tree/master/packages/openapi-to-graphql#custom-type-and-field-names-and-enum-values)

packages/openapi-to-graphql/test/authentication.test.ts

@@ -5,7 +5,7 @@
 
 'use strict'
 
-import { graphql } from 'graphql'
+import { graphql, GraphQLSchema } from 'graphql'
 import { afterAll, beforeAll, expect, test } from '@jest/globals'
 
 import * as openAPIToGraphQL from '../src/index'
@@ -16,11 +16,9 @@ const PORT = 3003
 // update PORT for this test case:
 oas.servers[0].variables.port.default = String(PORT)
 
-let createdSchema
+let createdSchema: GraphQLSchema
 
-/**
- * Set up the schema first and run example API server
- */
+// Set up the schema first and run example API server
 beforeAll(() => {
   return Promise.all([
     openAPIToGraphQL.createGraphQLSchema(oas).then(({ schema }) => {
@@ -30,9 +28,7 @@ beforeAll(() => {
   ])
 })
 
-/**
- * Shut down API server
- */
+// Shut down API server
 afterAll(() => {
   return stopServer()
 })

packages/openapi-to-graphql/test/cloudfunction.test.ts

@@ -5,14 +5,14 @@
 
 'use strict'
 
-import { graphql, parse, validate } from 'graphql'
+import { graphql, GraphQLSchema, parse, validate } from 'graphql'
 import { afterAll, beforeAll, expect, test } from '@jest/globals'
 
 import * as openAPIToGraphQL from '../src/index'
 
 const oas = require('./fixtures/cloudfunction.json')
 
-let createdSchema
+let createdSchema: GraphQLSchema
 
 beforeAll(async () => {
   const { schema } = await openAPIToGraphQL.createGraphQLSchema(oas)

packages/openapi-to-graphql/test/example_api.test.ts

@@ -5,7 +5,7 @@
 
 'use strict'
 
-import { graphql, parse, validate } from 'graphql'
+import { graphql, GraphQLInputObjectType, GraphQLInputObjectTypeConfig, GraphQLObjectTypeConfig, GraphQLSchema, parse, validate } from 'graphql'
 import { afterAll, beforeAll, expect, test } from '@jest/globals'
 
 import * as openAPIToGraphQL from '../src/index'
@@ -18,11 +18,9 @@ const PORT = 3002
 // Update PORT for this test case:
 oas.servers[0].variables.port.default = String(PORT)
 
-let createdSchema
+let createdSchema: GraphQLSchema
 
-/**
- * Set up the schema first and run example API server
- */
+// Set up the schema first and run example API server
 beforeAll(() => {
   return Promise.all([
     openAPIToGraphQL
@@ -36,9 +34,7 @@ beforeAll(() => {
   ])
 })
 
-/**
- * Shut down API server
- */
+// Shut down API server
 afterAll(() => {
   return stopServer()
 })
@@ -1959,10 +1955,10 @@ test('Required properties for input object types', () => {
   const userInputType = createdSchema.getType('UserInput')
 
   // The exclamation mark shows that it is a required (non-nullable) property
-  expect(userInputType.toConfig().fields.address.type.toString()).toEqual(
+  expect((userInputType.toConfig() as GraphQLInputObjectTypeConfig).fields['address'].type.toString()).toEqual(
     'AddressInput!'
   )
-  expect(userInputType.toConfig().fields.address2.type.toString()).toEqual(
+  expect((userInputType.toConfig() as GraphQLInputObjectTypeConfig).fields['address2'].type.toString()).toEqual(
     'AddressInput'
   )
 })
@@ -2312,8 +2308,8 @@ test('Non-nullable properties for object types', () => {
   const coordinates = createdSchema.getType('Coordinates')
 
   // The exclamation mark shows that it is a required (non-nullable) property
-  expect(coordinates.toConfig().fields.lat.type.toString()).toEqual('Float!')
-  expect(coordinates.toConfig().fields.long.type.toString()).toEqual('Float!')
+  expect((coordinates.toConfig() as GraphQLObjectTypeConfig<any, any>).fields['lat'].type.toString()).toEqual('Float!')
+  expect((coordinates.toConfig() as GraphQLObjectTypeConfig<any, any>).fields['long'].type.toString()).toEqual('Float!')
 })
 
 test('Option genericPayloadArgName', () => {

packages/openapi-to-graphql/test/example_api2.test.ts

@@ -5,7 +5,7 @@
 
 'use strict'
 
-import { graphql } from 'graphql'
+import { graphql, GraphQLObjectType, GraphQLSchema } from 'graphql'
 import { afterAll, beforeAll, expect, test } from '@jest/globals'
 
 import * as openAPIToGraphQL from '../src/index'
@@ -16,7 +16,7 @@ const PORT = 3004
 // Update PORT for this test case:
 oas.servers[0].variables.port.default = String(PORT)
 
-let createdSchema
+let createdSchema: GraphQLSchema
 
 /**
  * This test suite is used to verify the behavior of the operationIdFieldNames
@@ -26,9 +26,7 @@ let createdSchema
  * have operationIDs.
  */
 
-/**
- * Set up the schema first and run example API server
- */
+// Set up the schema first and run example API server
 beforeAll(() => {
   return Promise.all([
     openAPIToGraphQL
@@ -40,9 +38,7 @@ beforeAll(() => {
   ])
 })
 
-/**
- * Shut down API server
- */
+// Shut down API server
 afterAll(() => {
   return stopServer()
 })
@@ -62,7 +58,7 @@ test('The option operationIdFieldNames should allow both operations to be presen
     }
   }
 
-  const gqlTypes = Object.keys(createdSchema._typeMap.Query.getFields()).length
+  const gqlTypes = Object.keys((createdSchema.getTypeMap().Query as GraphQLObjectType).getFields()).length
   expect(gqlTypes).toEqual(oasGetCount)
 })
 

packages/openapi-to-graphql/test/example_api3.test.ts

@@ -5,7 +5,7 @@
 
 'use strict'
 
-import { graphql, parse, validate } from 'graphql'
+import { graphql, GraphQLSchema, parse, validate } from 'graphql'
 import { afterAll, beforeAll, expect, test } from '@jest/globals'
 
 import * as openAPIToGraphQL from '../src/index'
@@ -22,16 +22,14 @@ const PORT2 = 3006
 oas.servers[0].variables.port.default = String(PORT)
 oas3.servers[0].variables.port.default = String(PORT2)
 
+let createdSchema: GraphQLSchema
+
 /**
  * This test suite is used to verify the behavior of interOAS links, i.e.
  * links across different OASs
  */
 
-let createdSchema
-
-/**
- * Set up the schema first and run example API server
- */
+// Set up the schema first and run example API server
 beforeAll(() => {
   return Promise.all([
     openAPIToGraphQL
@@ -44,9 +42,7 @@ beforeAll(() => {
   ])
 })
 
-/**
- * Shut down API server
- */
+// Shut down API server
 afterAll(() => {
   return Promise.all([api.stopServer(), api2.stopServer()])
 })

packages/openapi-to-graphql/test/example_api4.test.ts

@@ -5,20 +5,18 @@
 
 'use strict'
 
-import { graphql } from 'graphql'
+import { graphql, GraphQLSchema } from 'graphql'
 import { afterAll, beforeAll, expect, test } from '@jest/globals'
 
 import * as openAPIToGraphQL from '../src/index'
 
 const oas = require('./fixtures/example_oas4.json')
 
-// This test suite is used to verify the behavior of anyOf and oneOf handling
+let createdSchema: GraphQLSchema
 
-let createdSchema
+// This test suite is used to verify the behavior of anyOf and oneOf handling
 
-/**
- * Set up the schema
- */
+// Set up the schema
 beforeAll(() => {
   return openAPIToGraphQL
     .createGraphQLSchema(oas)