Modify requestOptions

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

Author: Alan-Cha

packages/openapi-to-graphql/README.md

@@ -173,10 +173,13 @@ Schema options:
 Resolver options:
 
 - `headers` (type: `object` | `function`, default: `{}`): Headers to be sent in every request to the API. Parameters defined in the OpenAPI Specification and set by these headers will be ignored by OpenAPI-to-GraphQL. If used as a function, the following parameters will be exposed per-request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). The function should return the desired headers.
+_Note: If used as a function, this will be used to modify resolvers AND the schema. For example, if a `foo` header is set, then the resolver call will append the `foo` header, and the `foo` parameter will be removed from the GraphQL schema. In `resolver_builder.ts`, the function will be called with all arguments, but in `schema_builder.ts`, only the `method`, `path`, and `title` will be provided (because `resolverParams` and `generatedRequestOptions` are only available during execution). Therefore, for query, path, header, and cookie parameters, a value must be provided without `resolverParam` and `generatedRequestOptions` or else the schema will not have the right parameters._
 
 - `qs` (type: `object`, default: `{}`): Query parameters to be sent in every request to the API. Parameters defined in the OpenAPI Specification and set by these query parameters will be ignored by OpenAPI-to-GraphQL.
 
-- `requestOptions` (type: `object` | `function`, default: `{}`): Additional [options](https://github.com/request/request#requestoptions-callback), provided by the [`Request` module](https://github.com/request/request), that can be used to configure the HTTP calls that powers the generated GraphQL resolvers. A common use case for this option is to set up a web proxy with the `proxy` field. Parameters defined in the OpenAPI Specification and  set by this option will be ignored by OpenAPI-to-GraphQL. Additionally, the `headers` field has the feature of being used as a function. If used as a function, the following parameters will be exposed per-request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). The function should return the desired headers. If `requestOptions` is used as a function, the following parameters will be exposed per-request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). It should return object of type [options](https://github.com/request/request#requestoptions-callback). If `requestOptions` is used as a function `url` and `method` can also be set.
+- `requestOptions` (type: `object` | `function`, default: `{}`): Additional [options](https://github.com/request/request#requestoptions-callback), provided by the [`Request` module](https://github.com/request/request), that can be used to configure the HTTP calls that powers the generated GraphQL resolvers. A common use case for this option is to add headers or query string parameters to every request or to set up a web proxy with the `proxy` field. Parameters defined in the OpenAPI Specification and  set by this option will be ignored by OpenAPI-to-GraphQL. If `requestOptions` is used as a function, the following parameters will be exposed per request: the operation's `method`, the operation's `path`, the API `title`, and `resolverParams` (the [GraphQL resolver's parameters](https://graphql.org/learn/execution/#root-fields-resolvers)). The function should return an [options](https://github.com/request/request#requestoptions-callback) object. _Note: If used as a function, this will be used to modify resolvers AND the schema. For example, if a `foo` header is set, then the resolver call will append the `foo` header, and the `foo` parameter will be removed from the GraphQL schema. In `resolver_builder.ts`, the function will be called with all arguments, but in `schema_builder.ts`, only the `method`, `path`, and `title` will be provided (because `resolverParams` and `generatedRequestOptions` are only available during execution). Therefore, for query, path, header, and cookie parameters, a value must be provided without `resolverParam` and `generatedRequestOptions` or else the schema will not have the right parameters._
+
+- `connectOptions` (type: `object`, default: `{}`): Allows to override or add options to the PubSub connect object used to make publish/subscribe to the API backend, e.g. setup the web proxy to use.
 
 - `baseUrl` (type: `string`): Used to manually specify the base URL which all paths will be built on. Normally, OpenAPI-to-GraphQL will select a base URL from the [server object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject) defined in the OAS. However, if the server object contains multiple URLs, OpenAPI-to-GraphQL will randomly select one. The purpose of this option is to provide greater control over the base URL in these situations, especially when the OAS cannot be modified. This option may also prove to be useful in testing and development.
 

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

@@ -7,30 +7,35 @@ import { ConnectOptions } from './types/options';
 import { Operation } from './types/operation';
 import { SubscriptionContext } from './types/graphql';
 import { PreprocessingData } from './types/preprocessing_data';
-import { RequestOptions, RequestOptionsFunction } from './types/options';
+import { RequestOptions } from './types/options';
 import { GraphQLFieldResolver } from 'graphql';
 import { IncomingHttpHeaders } from 'http';
 export declare const OPENAPI_TO_GRAPHQL = "_openAPIToGraphQL";
-declare type GetResolverParams<TSource, TContext, TArgs> = {
+declare type GetSubscribeParams<TSource, TContext, TArgs> = {
     operation: Operation;
     argsFromLink?: {
         [key: string]: string;
     };
     payloadName?: string;
-    responseName?: string;
     data: PreprocessingData<TSource, TContext, TArgs>;
     baseUrl?: string;
-    requestOptions?: Partial<RequestOptions<TSource, TContext, TArgs>> | RequestOptionsFunction<TSource, TContext, TArgs>;
+    connectOptions: ConnectOptions;
 };
-declare type GetSubscribeParams<TSource, TContext, TArgs> = {
+declare type GetPublishResolverParams<TSource, TContext, TArgs> = {
+    operation: Operation;
+    responseName?: string;
+    data: PreprocessingData<TSource, TContext, TArgs>;
+};
+declare type GetResolverParams<TSource, TContext, TArgs> = {
     operation: Operation;
     argsFromLink?: {
         [key: string]: string;
     };
     payloadName?: string;
+    responseName?: string;
     data: PreprocessingData<TSource, TContext, TArgs>;
     baseUrl?: string;
-    connectOptions?: ConnectOptions;
+    requestOptions: RequestOptions<TSource, TContext, TArgs>;
 };
 declare type ResolveData<TSource, TContext, TArgs> = {
     /**
@@ -61,7 +66,7 @@ declare type OpenAPIToGraphQLSource<TSource, TContext, TArgs> = {
     _openAPIToGraphQL: OpenAPIToGraphQLRoot<TSource, TContext, TArgs>;
 };
 export declare function getSubscribe<TSource, TContext, TArgs>({ operation, payloadName, data, baseUrl, connectOptions }: GetSubscribeParams<TSource, TContext, TArgs>): GraphQLFieldResolver<TSource, SubscriptionContext, TArgs>;
-export declare function getPublishResolver<TSource, TContext, TArgs>({ operation, responseName, data }: GetResolverParams<TSource, TContext, TArgs>): GraphQLFieldResolver<TSource, TContext, TArgs>;
+export declare function getPublishResolver<TSource, TContext, TArgs>({ operation, responseName, data }: GetPublishResolverParams<TSource, TContext, TArgs>): GraphQLFieldResolver<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