@graphql-mesh/openapi 1.0.0-alpha-3fc47d119.0 → 1.0.0-alpha-20220804093904-8e2e41f7f

package/index.js

@@ -10,6 +10,7 @@ const Swagger2OpenAPI = require('swagger2openapi');
 const JsonPointer = _interopDefault(require('json-pointer'));
 const pluralize = _interopDefault(require('pluralize'));
 const JSONPath = require('jsonpath-plus');
+const qs = _interopDefault(require('qs'));
 const formurlencoded = _interopDefault(require('form-urlencoded'));
 const urlJoin = _interopDefault(require('url-join'));
 const fetch = require('@whatwg-node/fetch');
@@ -171,6 +172,7 @@ var HTTP_METHODS;
     HTTP_METHODS["head"] = "head";
 })(HTTP_METHODS || (HTTP_METHODS = {}));
 const SUCCESS_STATUS_RX = /2[0-9]{2}|2XX/;
+const CONTENT_TYPE_JSON_RX = /^application\/(.*)json$/;
 /**
  * Given an HTTP method, convert it to the HTTP_METHODS enum
  */
@@ -492,7 +494,7 @@ function getRequestBodyObject(operation, oas) {
             const content = requestBodyObject.content;
             const contentTypes = Object.keys(content);
             const jsonContentType = (_a = contentTypes
-                .find(contentType => contentType.toString().includes('application/json'))) === null || _a === void 0 ? void 0 : _a.toString();
+                .find(contentType => CONTENT_TYPE_JSON_RX.test(contentType.toString()))) === null || _a === void 0 ? void 0 : _a.toString();
             const formDataContentType = (_b = contentTypes
                 .find(contentType => contentType.toString().includes('application/x-www-form-urlencoded'))) === null || _b === void 0 ? void 0 : _b.toString();
             // Prioritize content-type JSON
@@ -547,7 +549,7 @@ function getRequestSchemaAndNames(path, operation, oas) {
          * Instead, treat the request body as a black box and send it as a string
          * with the proper content-type header
          */
-        if (!payloadContentType.includes('application/json') &&
+        if (!CONTENT_TYPE_JSON_RX.test(payloadContentType.toString()) &&
             !payloadContentType.includes('application/x-www-form-urlencoded') &&
             !payloadContentType.includes('*/*')) {
             const saneContentTypeName = uncapitalize(payloadContentType.split('/').reduce((name, term) => {
@@ -594,7 +596,7 @@ function getResponseObject(operation, statusCode, oas) {
             if (responseObject.content && typeof responseObject.content !== 'undefined') {
                 const content = responseObject.content;
                 const contentTypes = Object.keys(content);
-                const isJsonContent = contentTypes.some(contentType => contentType.toString().includes('application/json'));
+                const isJsonContent = contentTypes.some(contentType => CONTENT_TYPE_JSON_RX.test(contentType.toString()));
                 // Prioritize content-type JSON
                 if (isJsonContent) {
                     return {
@@ -631,9 +633,22 @@ function getResponseSchemaAndNames(path, method, operation, oas, data, options)
         const availableSimilarContentType = contentTypes.find(contentType => contentType.toString().includes(responseContentType));
         let responseSchema = responseObject.content[availableSimilarContentType || contentTypes[0]].schema;
         let fromRef;
-        if ('$ref' in responseSchema) {
-            fromRef = responseSchema.$ref.split('/').pop();
-            responseSchema = resolveRef(responseSchema.$ref, oas);
+        if (responseSchema) {
+            if ('$ref' in responseSchema) {
+                fromRef = responseSchema.$ref.split('/').pop();
+                responseSchema = resolveRef(responseSchema.$ref, oas);
+            }
+        }
+        else if (options.allowUndefinedSchemaRefTags) {
+            options.logger.info(`${path}:${method.toUpperCase()}:${statusCode}`);
+            fromRef = 'Unknown';
+            responseSchema = {
+                description: `Placeholder for missing ${path}:${method.toUpperCase()}:${statusCode} schema ref`,
+                type: options.defaultUndefinedSchemaType || 'object',
+            };
+        }
+        else {
+            throw new Error(`${path}:${method.toUpperCase()}:${statusCode} has an undefined schema ref`);
         }
         const responseSchemaNames = {
             fromRef,
@@ -644,7 +659,7 @@ function getResponseSchemaAndNames(path, method, operation, oas, data, options)
          * Edge case: if response body content-type is not application/json, do not
          * parse.
          */
-        if (!responseContentType.includes('application/json') && !responseContentType.includes('*/*')) {
+        if (!CONTENT_TYPE_JSON_RX.test(responseContentType.toString()) && !responseContentType.includes('*/*')) {
             let description = 'Placeholder to access non-application/json response bodies';
             if ('description' in responseSchema && typeof responseSchema.description === 'string') {
                 description += `\n\nOriginal top level description: '${responseSchema.description}'`;
@@ -1298,17 +1313,8 @@ function getResolver(getResolverParams, logger) {
                 headers,
             };
         }
-        for (const paramName in query) {
-            const val = query[paramName];
-            if (Array.isArray(val)) {
-                for (let index = 0; index < val.length; index++) {
-                    urlObject.searchParams.append(paramName, val[index]);
-                }
-            }
-            else if (val !== undefined) {
-                urlObject.searchParams.set(paramName, val);
-            }
-        }
+        const allQueryParams = {};
+        Object.assign(allQueryParams, query);
         /**
          * Determine possible payload
          *
@@ -1350,21 +1356,11 @@ function getResolver(getResolverParams, logger) {
             }
             // Query string:
             if (typeof data.options.qs === 'object') {
-                for (const query in data.options.qs) {
-                    const val = data.options.qs[query];
-                    if (val) {
-                        urlObject.searchParams.set(query, val);
-                    }
-                }
+                Object.assign(allQueryParams, data.options.qs);
             }
         }
         if (typeof customQs === 'object') {
-            for (const query in customQs) {
-                const val = customQs[query];
-                if (val) {
-                    urlObject.searchParams.set(query, val);
-                }
-            }
+            Object.assign(allQueryParams, customQs);
         }
         // Get authentication headers and query parameters
         if (root && typeof root === 'object' && typeof root._openAPIToGraphQL === 'object') {
@@ -1376,12 +1372,7 @@ function getResolver(getResolverParams, logger) {
                     options.headers[headerName] = headerValue;
                 }
             }
-            for (const query in authQs) {
-                const val = authQs[query];
-                if (val) {
-                    urlObject.searchParams.set(query, val);
-                }
-            }
+            Object.assign(allQueryParams, authQs);
             // Add authentication cookie if created
             if (authCookie !== null) {
                 const cookieHeaderName = 'cookie';
@@ -1391,12 +1382,7 @@ function getResolver(getResolverParams, logger) {
         // Extract OAuth token from context (if available)
         if (data.options.sendOAuthTokenInQuery) {
             const oauthQueryObj = createOAuthQS(data, ctx, logger);
-            for (const query in oauthQueryObj) {
-                const val = oauthQueryObj[query];
-                if (val) {
-                    urlObject.searchParams.set(query, val);
-                }
-            }
+            Object.assign(allQueryParams, oauthQueryObj);
         }
         else {
             const oauthHeader = createOAuthHeader(data, ctx, logger);
@@ -1407,6 +1393,7 @@ function getResolver(getResolverParams, logger) {
                 }
             }
         }
+        urlObject.search = qs.stringify(allQueryParams);
         const urlWithoutQuery = urlObject.href.replace(urlObject.search, '');
         resolveData.url = urlWithoutQuery;
         resolveData.usedRequestOptions = Object.assign({}, options);
@@ -3961,7 +3948,7 @@ function getArgs({ requestPayloadDef, parameters, operation, data, includeHttpDe
         }
         else if (typeof parameter.content === 'object') {
             const contentTypes = Object.keys(parameter.content);
-            const jsonContentType = contentTypes.find(contentType => contentType.toString().includes('application/json') || contentType.toString().includes('*/*'));
+            const jsonContentType = contentTypes.find(contentType => CONTENT_TYPE_JSON_RX.test(contentType.toString()) || contentType.toString().includes('*/*'));
             if (jsonContentType &&
                 typeof parameter.content[jsonContentType] === 'object' &&
                 typeof parameter.content[jsonContentType].schema === 'object') {
@@ -5004,6 +4991,8 @@ class OpenAPIHandler {
                 }
                 return originalFactory(() => resolverParams, this.logger)(root, args, context, info);
             },
+            allowUndefinedSchemaRefTags: this.config.allowUndefinedSchemaRefTags,
+            defaultUndefinedSchemaType: this.config.defaultUndefinedSchemaType,
         });
         const { args, contextVariables } = stringInterpolation.parseInterpolationStrings(Object.values(operationHeaders || {}));
         const rootFields = [

package/index.mjs

@@ -6,6 +6,7 @@ import { convertObj } from 'swagger2openapi';
 import JsonPointer from 'json-pointer';
 import pluralize from 'pluralize';
 import { JSONPath } from 'jsonpath-plus';
+import qs from 'qs';
 import formurlencoded from 'form-urlencoded';
 import urlJoin from 'url-join';
 import { Headers } from '@whatwg-node/fetch';
@@ -167,6 +168,7 @@ var HTTP_METHODS;
     HTTP_METHODS["head"] = "head";
 })(HTTP_METHODS || (HTTP_METHODS = {}));
 const SUCCESS_STATUS_RX = /2[0-9]{2}|2XX/;
+const CONTENT_TYPE_JSON_RX = /^application\/(.*)json$/;
 /**
  * Given an HTTP method, convert it to the HTTP_METHODS enum
  */
@@ -488,7 +490,7 @@ function getRequestBodyObject(operation, oas) {
             const content = requestBodyObject.content;
             const contentTypes = Object.keys(content);
             const jsonContentType = (_a = contentTypes
-                .find(contentType => contentType.toString().includes('application/json'))) === null || _a === void 0 ? void 0 : _a.toString();
+                .find(contentType => CONTENT_TYPE_JSON_RX.test(contentType.toString()))) === null || _a === void 0 ? void 0 : _a.toString();
             const formDataContentType = (_b = contentTypes
                 .find(contentType => contentType.toString().includes('application/x-www-form-urlencoded'))) === null || _b === void 0 ? void 0 : _b.toString();
             // Prioritize content-type JSON
@@ -543,7 +545,7 @@ function getRequestSchemaAndNames(path, operation, oas) {
          * Instead, treat the request body as a black box and send it as a string
          * with the proper content-type header
          */
-        if (!payloadContentType.includes('application/json') &&
+        if (!CONTENT_TYPE_JSON_RX.test(payloadContentType.toString()) &&
             !payloadContentType.includes('application/x-www-form-urlencoded') &&
             !payloadContentType.includes('*/*')) {
             const saneContentTypeName = uncapitalize(payloadContentType.split('/').reduce((name, term) => {
@@ -590,7 +592,7 @@ function getResponseObject(operation, statusCode, oas) {
             if (responseObject.content && typeof responseObject.content !== 'undefined') {
                 const content = responseObject.content;
                 const contentTypes = Object.keys(content);
-                const isJsonContent = contentTypes.some(contentType => contentType.toString().includes('application/json'));
+                const isJsonContent = contentTypes.some(contentType => CONTENT_TYPE_JSON_RX.test(contentType.toString()));
                 // Prioritize content-type JSON
                 if (isJsonContent) {
                     return {
@@ -627,9 +629,22 @@ function getResponseSchemaAndNames(path, method, operation, oas, data, options)
         const availableSimilarContentType = contentTypes.find(contentType => contentType.toString().includes(responseContentType));
         let responseSchema = responseObject.content[availableSimilarContentType || contentTypes[0]].schema;
         let fromRef;
-        if ('$ref' in responseSchema) {
-            fromRef = responseSchema.$ref.split('/').pop();
-            responseSchema = resolveRef(responseSchema.$ref, oas);
+        if (responseSchema) {
+            if ('$ref' in responseSchema) {
+                fromRef = responseSchema.$ref.split('/').pop();
+                responseSchema = resolveRef(responseSchema.$ref, oas);
+            }
+        }
+        else if (options.allowUndefinedSchemaRefTags) {
+            options.logger.info(`${path}:${method.toUpperCase()}:${statusCode}`);
+            fromRef = 'Unknown';
+            responseSchema = {
+                description: `Placeholder for missing ${path}:${method.toUpperCase()}:${statusCode} schema ref`,
+                type: options.defaultUndefinedSchemaType || 'object',
+            };
+        }
+        else {
+            throw new Error(`${path}:${method.toUpperCase()}:${statusCode} has an undefined schema ref`);
         }
         const responseSchemaNames = {
             fromRef,
@@ -640,7 +655,7 @@ function getResponseSchemaAndNames(path, method, operation, oas, data, options)
          * Edge case: if response body content-type is not application/json, do not
          * parse.
          */
-        if (!responseContentType.includes('application/json') && !responseContentType.includes('*/*')) {
+        if (!CONTENT_TYPE_JSON_RX.test(responseContentType.toString()) && !responseContentType.includes('*/*')) {
             let description = 'Placeholder to access non-application/json response bodies';
             if ('description' in responseSchema && typeof responseSchema.description === 'string') {
                 description += `\n\nOriginal top level description: '${responseSchema.description}'`;
@@ -1294,17 +1309,8 @@ function getResolver(getResolverParams, logger) {
                 headers,
             };
         }
-        for (const paramName in query) {
-            const val = query[paramName];
-            if (Array.isArray(val)) {
-                for (let index = 0; index < val.length; index++) {
-                    urlObject.searchParams.append(paramName, val[index]);
-                }
-            }
-            else if (val !== undefined) {
-                urlObject.searchParams.set(paramName, val);
-            }
-        }
+        const allQueryParams = {};
+        Object.assign(allQueryParams, query);
         /**
          * Determine possible payload
          *
@@ -1346,21 +1352,11 @@ function getResolver(getResolverParams, logger) {
             }
             // Query string:
             if (typeof data.options.qs === 'object') {
-                for (const query in data.options.qs) {
-                    const val = data.options.qs[query];
-                    if (val) {
-                        urlObject.searchParams.set(query, val);
-                    }
-                }
+                Object.assign(allQueryParams, data.options.qs);
             }
         }
         if (typeof customQs === 'object') {
-            for (const query in customQs) {
-                const val = customQs[query];
-                if (val) {
-                    urlObject.searchParams.set(query, val);
-                }
-            }
+            Object.assign(allQueryParams, customQs);
         }
         // Get authentication headers and query parameters
         if (root && typeof root === 'object' && typeof root._openAPIToGraphQL === 'object') {
@@ -1372,12 +1368,7 @@ function getResolver(getResolverParams, logger) {
                     options.headers[headerName] = headerValue;
                 }
             }
-            for (const query in authQs) {
-                const val = authQs[query];
-                if (val) {
-                    urlObject.searchParams.set(query, val);
-                }
-            }
+            Object.assign(allQueryParams, authQs);
             // Add authentication cookie if created
             if (authCookie !== null) {
                 const cookieHeaderName = 'cookie';
@@ -1387,12 +1378,7 @@ function getResolver(getResolverParams, logger) {
         // Extract OAuth token from context (if available)
         if (data.options.sendOAuthTokenInQuery) {
             const oauthQueryObj = createOAuthQS(data, ctx, logger);
-            for (const query in oauthQueryObj) {
-                const val = oauthQueryObj[query];
-                if (val) {
-                    urlObject.searchParams.set(query, val);
-                }
-            }
+            Object.assign(allQueryParams, oauthQueryObj);
         }
         else {
             const oauthHeader = createOAuthHeader(data, ctx, logger);
@@ -1403,6 +1389,7 @@ function getResolver(getResolverParams, logger) {
                 }
             }
         }
+        urlObject.search = qs.stringify(allQueryParams);
         const urlWithoutQuery = urlObject.href.replace(urlObject.search, '');
         resolveData.url = urlWithoutQuery;
         resolveData.usedRequestOptions = Object.assign({}, options);
@@ -3957,7 +3944,7 @@ function getArgs({ requestPayloadDef, parameters, operation, data, includeHttpDe
         }
         else if (typeof parameter.content === 'object') {
             const contentTypes = Object.keys(parameter.content);
-            const jsonContentType = contentTypes.find(contentType => contentType.toString().includes('application/json') || contentType.toString().includes('*/*'));
+            const jsonContentType = contentTypes.find(contentType => CONTENT_TYPE_JSON_RX.test(contentType.toString()) || contentType.toString().includes('*/*'));
             if (jsonContentType &&
                 typeof parameter.content[jsonContentType] === 'object' &&
                 typeof parameter.content[jsonContentType].schema === 'object') {
@@ -5000,6 +4987,8 @@ class OpenAPIHandler {
                 }
                 return originalFactory(() => resolverParams, this.logger)(root, args, context, info);
             },
+            allowUndefinedSchemaRefTags: this.config.allowUndefinedSchemaRefTags,
+            defaultUndefinedSchemaType: this.config.defaultUndefinedSchemaType,
         });
         const { args, contextVariables } = parseInterpolationStrings(Object.values(operationHeaders || {}));
         const rootFields = [

package/openapi-to-graphql/oas_3_tools.d.ts

@@ -39,6 +39,7 @@ export declare enum HTTP_METHODS {
     'head' = "head"
 }
 export declare const SUCCESS_STATUS_RX: RegExp;
+export declare const CONTENT_TYPE_JSON_RX: RegExp;
 /**
  * Given an HTTP method, convert it to the HTTP_METHODS enum
  */

package/openapi-to-graphql/types/options.d.ts

@@ -240,4 +240,12 @@ export declare type InternalOptions<TSource, TContext, TArgs> = {
     includeHttpDetails?: boolean;
     pubsub: MeshPubSub;
     logger: Logger;
+    /**
+     * Allow processing to continue if the swagger schema is missing a schema $ref.
+     */
+    allowUndefinedSchemaRefTags?: boolean;
+    /**
+     * Object type to use for missing swagger schemas refs default is object.
+     */
+    defaultUndefinedSchemaType?: 'string' | 'number' | 'object' | 'array' | 'boolean' | 'integer';
 };

package/package.json

@@ -1,26 +1,27 @@
 {
   "name": "@graphql-mesh/openapi",
-  "version": "1.0.0-alpha-3fc47d119.0",
+  "version": "1.0.0-alpha-20220804093904-8e2e41f7f",
   "sideEffects": false,
   "peerDependencies": {
-    "@graphql-mesh/types": "0.79.0-alpha-3fc47d119.0",
-    "@graphql-mesh/utils": "1.0.0-alpha-3fc47d119.0",
+    "@graphql-mesh/types": "0.79.0-alpha-20220804093904-8e2e41f7f",
+    "@graphql-mesh/utils": "1.0.0-alpha-20220804093904-8e2e41f7f",
     "graphql": "*"
   },
   "dependencies": {
     "@graphql-mesh/cross-helpers": "0.2.0",
-    "@graphql-mesh/store": "1.0.0-alpha-3fc47d119.0",
+    "@graphql-mesh/store": "1.0.0-alpha-20220804093904-8e2e41f7f",
     "@graphql-mesh/string-interpolation": "0.3.0",
-    "@graphql-tools/utils": "8.8.0",
-    "@whatwg-node/fetch": "^0.0.2",
+    "@graphql-tools/utils": "8.9.0",
+    "@whatwg-node/fetch": "^0.2.7",
     "deep-equal": "2.0.5",
-    "form-urlencoded": "6.0.7",
+    "form-urlencoded": "6.1.0",
     "graphql-scalars": "1.17.0",
     "json-pointer": "0.6.2",
     "jsonpath-plus": "7.0.0",
     "openapi-diff": "0.23.5",
     "openapi-types": "12.0.0",
     "pluralize": "8.0.0",
+    "qs": "6.11.0",
     "swagger2openapi": "7.0.8",
     "tslib": "^2.4.0",
     "url-join": "4.0.1"