Expose preprocessing data

Signed-off-by: Dotan Simha <[email protected]>
IBM · Mar 3, 2021 · 2b98853 · 2b98853
1 parent 15ed7f2
commit 2b98853
Show file tree

Hide file tree

Showing 12 changed files with 125 additions and 1,430 deletions.
diff --git a/packages/openapi-to-graphql-cli/package-lock.json b/packages/openapi-to-graphql-cli/package-lock.json
diff --git a/packages/openapi-to-graphql/lib/index.d.ts b/packages/openapi-to-graphql/lib/index.d.ts
@@ -27,14 +27,16 @@
 import { Options, Report } from './types/options';
 import { Oas3 } from './types/oas3';
 import { Oas2 } from './types/oas2';
+import { PreprocessingData } from './types/preprocessing_data';
 import { GraphQLSchema } from 'graphql';
-declare type Result = {
+declare type Result<TSource, TContext, TArgs> = {
     schema: GraphQLSchema;
     report: Report;
+    data: PreprocessingData<TSource, TContext, TArgs>;
 };
 /**
  * Creates a GraphQL interface from the given OpenAPI Specification (2 or 3).
  */
-export declare function createGraphQLSchema<TSource, TContext, TArgs>(spec: Oas3 | Oas2 | (Oas3 | Oas2)[], options?: Options<TSource, TContext, TArgs>): Promise<Result>;
+export declare function createGraphQLSchema<TSource, TContext, TArgs>(spec: Oas3 | Oas2 | (Oas3 | Oas2)[], options?: Options<TSource, TContext, TArgs>): Promise<Result<TSource, TContext, TArgs>>;
 export { sanitize, CaseStyle } from './oas_3_tools';
 export { GraphQLOperationType } from './types/graphql';
diff --git a/packages/openapi-to-graphql/lib/index.js b/packages/openapi-to-graphql/lib/index.js
diff --git a/packages/openapi-to-graphql/lib/index.js.map b/packages/openapi-to-graphql/lib/index.js.map
diff --git a/packages/openapi-to-graphql/lib/preprocessor.js b/packages/openapi-to-graphql/lib/preprocessor.js
diff --git a/packages/openapi-to-graphql/lib/preprocessor.js.map b/packages/openapi-to-graphql/lib/preprocessor.js.map
diff --git a/packages/openapi-to-graphql/lib/types/operation.d.ts b/packages/openapi-to-graphql/lib/types/operation.d.ts
@@ -1,3 +1,4 @@
+import { OperationObject } from './oas3';
 /**
  * Type definitions for the objects created during preprocessing for every
  * operation in the OAS.
@@ -40,6 +41,10 @@ export declare type DataDefinition = {
     graphQLInputObjectType?: GraphQLInputObjectType | GraphQLList<any>;
 };
 export declare type Operation = {
+    /**
+     * The raw operation object from the OAS spec
+     */
+    operation: OperationObject;
     /**
      * Identifier of the operation - may be created by concatenating method & path
      */
@@ -58,6 +63,10 @@ export declare type Operation = {
      * Human-readable description of the operation
      */
     description: string;
+    /**
+     * Tags from the original OAS
+     */
+    tags: string[];
     /**
      * URL path of this operation
      */

diff --git a/packages/openapi-to-graphql/lib/types/operation.js b/packages/openapi-to-graphql/lib/types/operation.js
diff --git a/packages/openapi-to-graphql/lib/types/operation.js.map b/packages/openapi-to-graphql/lib/types/operation.js.map
diff --git a/packages/openapi-to-graphql/src/index.ts b/packages/openapi-to-graphql/src/index.ts
@@ -69,9 +69,10 @@ import debug from 'debug'
 import { GraphQLSchemaConfig } from 'graphql/type/schema'
 import { sortObject, handleWarning, MitigationTypes } from './utils'
 
-type Result = {
+type Result<TSource, TContext, TArgs> = {
   schema: GraphQLSchema
   report: Report
+  data: PreprocessingData<TSource, TContext, TArgs>
 }
 
 const translationLog = debug('translation')
@@ -82,7 +83,7 @@ const translationLog = debug('translation')
 export function createGraphQLSchema<TSource, TContext, TArgs>(
   spec: Oas3 | Oas2 | (Oas3 | Oas2)[],
   options?: Options<TSource, TContext, TArgs>
-): Promise<Result> {
+): Promise<Result<TSource, TContext, TArgs>> {
   return new Promise((resolve, reject) => {
     if (typeof options === 'undefined') {
       options = {}
@@ -224,7 +225,7 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
     provideErrorExtensions,
     equivalentToMessages
   }: InternalOptions<TSource, TContext, TArgs>
-): { schema: GraphQLSchema; report: Report } {
+): Result<TSource, TContext, TArgs> {
   const options = {
     strict,
     report,
@@ -630,7 +631,7 @@ function translateOpenAPIToGraphQL<TSource, TContext, TArgs>(
 
   const schema = new GraphQLSchema(schemaConfig)
 
-  return { schema, report: options.report }
+  return { schema, report: options.report, data }
 }
 
 /**

diff --git a/packages/openapi-to-graphql/src/preprocessor.ts b/packages/openapi-to-graphql/src/preprocessor.ts
@@ -73,6 +73,9 @@ function processOperation<TSource, TContext, TArgs>(
     description += `\n\nEquivalent to ${operationString}`
   }
 
+  // Determine tags
+  const tags = operation.tags || []
+
   // Hold on to the operationId
   const operationId =
     typeof operation.operationId !== 'undefined'
@@ -161,10 +164,12 @@ function processOperation<TSource, TContext, TArgs>(
     securityRequirements.length > 0 && data.options.viewer !== false
 
   return {
+    operation,
     operationId,
     operationString,
     operationType,
     description,
+    tags,
     path,
     method,
     payloadContentType,

diff --git a/packages/openapi-to-graphql/src/types/operation.ts b/packages/openapi-to-graphql/src/types/operation.ts
@@ -1,3 +1,4 @@
+import { OperationObject } from './oas3'
 // Copyright IBM Corp. 2018. All Rights Reserved.
 // Node module: openapi-to-graphql
 // This file is licensed under the MIT License.
@@ -89,6 +90,11 @@ export type DataDefinition = {
 }
 
 export type Operation = {
+  /**
+   * The raw operation object from the OAS spec
+   */
+  operation: OperationObject
+
   /**
    * Identifier of the operation - may be created by concatenating method & path
    */
@@ -110,6 +116,11 @@ export type Operation = {
    */
   description: string
 
+  /**
+   * Tags from the original OAS
+   */
+  tags: string[]
+
   /**
    * URL path of this operation
    */