api 5.0.0-beta.2 → 5.0.0-beta.3

package/README.md

@@ -31,7 +31,6 @@ $ npx api install https://raw.githubusercontent.com/OAI/OpenAPI-Specification/ma
 ```js
 const SDK = require('@api/petstore');
 
-const petstore = new SDK();
 petstore.listPets().then(res => {
   console.log(`My pets name is ${res[0].name}!`);
 });

package/dist/cache.d.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 import 'isomorphic-fetch';
 import Fetcher from './fetcher';
 declare type CacheStore = Record<string, {

package/dist/cli/codegen/languages/typescript.d.ts

@@ -1,11 +1,15 @@
 import type Oas from 'oas';
 import type { Operation } from 'oas';
-import type { JSONSchema, SchemaObject } from 'oas/@types/rmoas.types';
-import type { ClassDeclaration, MethodDeclaration } from 'ts-morph';
+import type { JSONSchema, SchemaObject } from 'oas/dist/rmoas.types';
+import type { ClassDeclaration, MethodDeclaration, VariableStatement } from 'ts-morph';
 import type Storage from '../../storage';
 import type { InstallerOptions } from '../language';
 import CodeGeneratorLanguage from '../language';
 import { Project } from 'ts-morph';
+export declare type TSGeneratorOptions = {
+    outputJS?: boolean;
+    compilerTarget?: 'cjs' | 'esm';
+};
 declare type OperationTypeHousing = {
     types: {
         params?: false | Record<'body' | 'formData' | 'metadata', string>;
@@ -21,15 +25,13 @@ export default class TSGenerator extends CodeGeneratorLanguage {
     files: Record<string, string>;
     methodGenerics: Map<string, MethodDeclaration>;
     sdk: ClassDeclaration;
+    sdkExport: VariableStatement;
     schemas: Map<string, {
         schema: SchemaObject;
         name: string;
         tsType?: string;
     }>;
-    constructor(spec: Oas, specPath: string, identifier: string, opts?: {
-        outputJS?: boolean;
-        compilerTarget?: 'cjs' | 'esm';
-    });
+    constructor(spec: Oas, specPath: string, identifier: string, opts?: TSGeneratorOptions);
     static formatter(content: string): string;
     installer(storage: Storage, opts?: InstallerOptions): Promise<void>;
     /**

package/dist/cli/codegen/languages/typescript.js

@@ -114,7 +114,7 @@ var TSGenerator = /** @class */ (function (_super) {
                 indentationText: ts_morph_1.IndentationText.TwoSpaces,
                 quoteKind: ts_morph_1.QuoteKind.Single
             },
-            compilerOptions: __assign({ declaration: true, resolveJsonModule: true, target: options.compilerTarget === 'cjs' ? ts_morph_1.ScriptTarget.ES5 : ts_morph_1.ScriptTarget.ES2020, outDir: 'dist' }, (options.compilerTarget === 'cjs' ? { esModuleInterop: true } : {}))
+            compilerOptions: __assign({ declaration: true, outDir: 'dist', resolveJsonModule: true, target: options.compilerTarget === 'cjs' ? ts_morph_1.ScriptTarget.ES5 : ts_morph_1.ScriptTarget.ES2020 }, (options.compilerTarget === 'cjs' ? { esModuleInterop: true } : {}))
         });
         _this.compilerTarget = options.compilerTarget;
         _this.outputJS = options.outputJS;
@@ -195,24 +195,57 @@ var TSGenerator = /** @class */ (function (_super) {
                         this.sdk = sdkSource.addClass({
                             name: 'SDK'
                         });
-                        // There's an annoying quirk with `ts-morph` where if we set the SDK class to be the default
-                        // export with `isDefaultExport` then when we compile it to an ES5 target for CJS environments
-                        // it'll be exported as `export.default = SDK`, which when you try to load it you'll need to
-                        // run `require('@api/sdk').default`.
-                        //
-                        // Instead here by plainly creating the SDK class in the source file and then setting this
-                        // export assignment it'll export the SDK class as `module.exports = SDK` so people can cleanly
-                        // load the SDK with `require('@api/sdk)`.
-                        //
-                        // A whole lot of debugging went into here to let people not have to worry about `.default`
-                        // messes. I hope it's worth it!
+                        this.sdkExport = sdkSource.addVariableStatement({
+                            declarationKind: ts_morph_1.VariableDeclarationKind.Const,
+                            declarations: [
+                                {
+                                    name: 'createSDK',
+                                    initializer: function (writer) {
+                                        // `ts-morph` doesn't have any way to cleanly create an IFEE.
+                                        writer.writeLine('(() => { return new SDK(); })()');
+                                        return writer;
+                                    }
+                                },
+                            ]
+                        });
+                        /**
+                         * There's an annoying quirk with `ts-morph` where if we set the `createSDK` function to be the
+                         * default export with `isDefaultExport` then when we compile it to an ES5 target for CJS
+                         * environments it'll be exported as `export.default = createSDK`, which when you try to load it
+                         * you'll need to run `require('@api/sdk').default`.
+                         *
+                         * Instead here by plainly creating `createSDK` in the source file and then setting this export
+                         * assignment it'll export the SDK IFEE initializer as `module.exports = createSDK` so people
+                         * can cleanly load their SDK with `require('@api/sdk)`.
+                         *
+                         * A whole lot of debugging went into here to let people not have to worry about `.default`
+                         * messes. I hope it's worth it!
+                         */
                         if (this.compilerTarget === 'cjs') {
                             sdkSource.addExportAssignment({
-                                expression: 'SDK'
+                                expression: 'createSDK'
                             });
                         }
                         else {
-                            this.sdk.setIsDefaultExport(true);
+                            /**
+                             * Because `createSDK` above is an IFEE constant we can't use `setIsDefaultExport` on it due
+                             * to `ts-morph` not having great handling for IFEE's.
+                             *
+                             * If we were to call `setIsDefaultExport` on our IFEE to attempt to compile it as
+                             * `export default createSDK` then `ts-morph` hard crashes with a "Error replacing tree: The
+                             * children of the old and new trees were expected to have the same count" exception due to
+                             * it not being able properly handle IFEE's. It's for that reason that we need to manually
+                             * write a statement expression to set `createSDK` as the default export.
+                             *
+                             * Another quirk that this work avoids is there being an empty `export {};` at the very end
+                             * of our compiled `d.ts` declaration file. I'm not sure why it was being added, and it
+                             * didn't appear to be harming anything, but us manually creating this export statement
+                             * causes it to go away.
+                             *
+                             * Thankfully, fortunately, and curiously, these are all only problems in non-CJS compiled
+                             * targets. ¯\_(ツ)_/¯
+                             */
+                            sdkSource.addStatements('export default createSDK');
                         }
                         this.sdk.addProperties([
                             { name: 'spec', type: 'Oas' },
@@ -313,7 +346,42 @@ var TSGenerator = /** @class */ (function (_super) {
                         // @todo should all of these isolated into their own file outside of the main sdk class file?
                         // Add all known types that we're using into the SDK.
                         Array.from(this.types.values()).forEach(function (exp) {
-                            sdkSource.addStatements(exp);
+                            /**
+                             * When `ts-morph` compiles declaration files when we're targeting CJS environments it creates
+                             * the default export as `export = _default` instead of `export default const _default`. This
+                             * causes TS to throw a TS2309 error for "An export assignment cannot be used in a module
+                             * with other exported elements" because our types and interfaces are also being exported and
+                             * the `export =` overrides those.
+                             *
+                             * Fixing this is, to be frank, a fucking HARD problem for a couple reasons:
+                             *
+                             *  1. Our JSON Schema types and interfaces are coming from `json-schema-to-typescript` and
+                             *    that library exports its data a raw string containing multiple types and interfaces.
+                             *    The only way we're able to capture and use them in our codegenerated SDK is because
+                             *    we're ingesting that string into `ts-morph` and then using its APIs to extract exported
+                             *    declarations (which are still strings) and then they're re-inserted into our main
+                             *    source file here.
+                             *  2. Though `ts-morph` has APIs for adding type aliases and interfaces to a source file what
+                             *    it doesn't have is the ability to pass in a string, or a `Writer` class that exposes,
+                             *    to write raw strings to a type or an interface. If it did we'd be able to replace this
+                             *    `addStatements` call with an `addTypeAlias` and `addInterface` call for each of our
+                             *    JSON Schema schemas that we've got along with an `isExported` flag for `ts-morph` to
+                             *    export it.
+                             *
+                             * Because neither of these are solvable problems right now we're instead opting to **not**
+                             * export types and interfaces from these SDKs. This isn't a great solution because it
+                             * /slightly/ reduces the usability of the TS codegen functionality but in order for the TS
+                             * declaration files that we generate to be valid this is the only option that we've got.
+                             *
+                             * However, that said, if somebody needs an interface or type exported they can export it
+                             * themselves in the SDK code that we compile for them.
+                             *
+                             * @fixme
+                             */
+                            sdkSource.addStatements(
+                            // All expressions coming out of `json-schema-to-typescript` are exported so by popping this
+                            // off we'll just be inserting plain interfaces and types into the SDK source.
+                            exp.substring('export '.length));
                         });
                         if (this.outputJS) {
                             return [2 /*return*/, this.project

package/dist/cli/storage.d.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 import Fetcher from '../fetcher';
 export default class Storage {
     static dir: string;

package/dist/core/getJSONSchemaDefaults.d.ts

@@ -1,4 +1,4 @@
-import type { SchemaWrapper } from 'oas/@types/operation/get-parameters-as-json-schema';
+import type { SchemaWrapper } from 'oas/dist/operation/get-parameters-as-json-schema';
 /**
  * Run through a JSON Schema object and compose up an object containing default data for any schema
  * property that is required and also has a defined default.

package/dist/core/index.d.ts

@@ -1,6 +1,6 @@
 import type Oas from 'oas';
 import type { Operation } from 'oas';
-import type { HttpMethods } from 'oas/@types/rmoas.types';
+import type { HttpMethods } from 'oas/dist/rmoas.types';
 import 'isomorphic-fetch';
 import getJSONSchemaDefaults from './getJSONSchemaDefaults';
 import parseResponse from './parseResponse';

package/dist/core/prepareParams.js

@@ -46,6 +46,8 @@ var stream_1 = __importDefault(require("stream"));
 var get_stream_1 = __importDefault(require("get-stream"));
 var sync_1 = __importDefault(require("datauri/sync"));
 var parser_1 = __importDefault(require("datauri/parser"));
+var remove_undefined_objects_1 = __importDefault(require("remove-undefined-objects"));
+var caseless_1 = __importDefault(require("caseless"));
 var getJSONSchemaDefaults_1 = __importDefault(require("./getJSONSchemaDefaults"));
 /**
  * Extract all available parameters from an operations Parameter Object into a digestable array
@@ -156,7 +158,7 @@ function processFile(paramName, file) {
 function prepareParams(operation, body, metadata) {
     var _a, _b, _c, _d;
     return __awaiter(this, void 0, void 0, function () {
-        var metadataIntersected, digestedParameters, hasDigestedParams, jsonSchema, jsonSchemaDefaults, params, intersection, payloadJsonSchema, conversions_1;
+        var metadataIntersected, digestedParameters, hasDigestedParams, jsonSchema, jsonSchemaDefaults, params, headerParams_1, intersection, payloadJsonSchema, conversions_1;
         return __generator(this, function (_e) {
             switch (_e.label) {
                 case 0:
@@ -164,6 +166,17 @@ function prepareParams(operation, body, metadata) {
                     digestedParameters = digestParameters(operation.getParameters());
                     hasDigestedParams = !!Object.keys(digestedParameters).length;
                     jsonSchema = operation.getParametersAsJsonSchema();
+                    /**
+                     * It might be common for somebody to run `sdk.findPetsByStatus({ status: 'available' }, {})`, in
+                     * which case we want to filter out the second (metadata) parameter and treat the first parameter
+                     * as the metadata instead. If we don't do this, their supplied `status` metadata will be treated
+                     * as a body parameter, and because there's no `status` body parameter, and no supplied metadata
+                     * (because it's an empty object), the request won't send a payload.
+                     *
+                     * @see {@link https://github.com/readmeio/api/issues/449}
+                     */
+                    // eslint-disable-next-line no-param-reassign
+                    metadata = (0, remove_undefined_objects_1["default"])(metadata);
                     if (!jsonSchema && (body !== undefined || metadata !== undefined)) {
                         throw new Error("You supplied metadata and/or body data for this operation but it doesn't have any documented parameters or request payloads. If you think this is an error please contact support for the API you're using.");
                     }
@@ -190,7 +203,24 @@ function prepareParams(operation, body, metadata) {
                                 params.body = merge(params.body, body);
                             }
                             else {
-                                intersection = Object.keys(body).filter(function (value) { return Object.keys(digestedParameters).includes(value); }).length;
+                                headerParams_1 = (0, caseless_1["default"])({});
+                                Object.entries(digestedParameters).forEach(function (_a) {
+                                    var paramName = _a[0], param = _a[1];
+                                    // Headers are sent case-insensitive so we need to make sure that we're properly
+                                    // matching them when detecting what our incoming payload looks like.
+                                    if (param["in"] === 'header') {
+                                        headerParams_1.set(paramName, '');
+                                    }
+                                });
+                                intersection = Object.keys(body).filter(function (value) {
+                                    if (Object.keys(digestedParameters).includes(value)) {
+                                        return true;
+                                    }
+                                    else if (headerParams_1.has(value)) {
+                                        return true;
+                                    }
+                                    return false;
+                                }).length;
                                 if (intersection && intersection / Object.keys(body).length > 0.25) {
                                     /* eslint-disable no-param-reassign */
                                     // If more than 25% of the body intersects with the parameters that we've got on hand,
@@ -290,8 +320,15 @@ function prepareParams(operation, body, metadata) {
                         Object.entries(digestedParameters).forEach(function (_a) {
                             var paramName = _a[0], param = _a[1];
                             var value;
-                            if (typeof metadata === 'object' && !isEmpty(metadata) && paramName in metadata) {
-                                value = metadata[paramName];
+                            if (typeof metadata === 'object' && !isEmpty(metadata)) {
+                                if (paramName in metadata) {
+                                    value = metadata[paramName];
+                                }
+                                else if (param["in"] === 'header') {
+                                    // Headers are sent case-insensitive so we need to make sure that we're properly
+                                    // matching them when detecting what our incoming payload looks like.
+                                    value = metadata[Object.keys(metadata).find(function (k) { return k.toLowerCase() === paramName.toLowerCase(); })];
+                                }
                             }
                             if (value === undefined) {
                                 return;
@@ -307,7 +344,7 @@ function prepareParams(operation, body, metadata) {
                                     delete metadata[paramName];
                                     break;
                                 case 'header':
-                                    params.header[paramName] = value;
+                                    params.header[paramName.toLowerCase()] = value;
                                     delete metadata[paramName];
                                     break;
                                 case 'cookie':

package/dist/fetcher.d.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 import 'isomorphic-fetch';
 export default class Fetcher {
     uri: string | OASDocument;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 interface SDKOptions {
     cacheDir?: string;
 }

package/dist/packageInfo.d.ts

@@ -1,2 +1,2 @@
 export declare const PACKAGE_NAME = "api";
-export declare const PACKAGE_VERSION = "5.0.0-beta.2";
+export declare const PACKAGE_VERSION = "5.0.0-beta.3";

package/dist/packageInfo.js

@@ -3,4 +3,4 @@ exports.__esModule = true;
 exports.PACKAGE_VERSION = exports.PACKAGE_NAME = void 0;
 // This file is automatically updated by the build script.
 exports.PACKAGE_NAME = 'api';
-exports.PACKAGE_VERSION = '5.0.0-beta.2';
+exports.PACKAGE_VERSION = '5.0.0-beta.3';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "5.0.0-beta.2",
+  "version": "5.0.0-beta.3",
   "description": "Magical SDK generation from an OpenAPI definition 🪄",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -38,6 +38,7 @@
   "dependencies": {
     "@readme/oas-to-har": "^17.0.8",
     "@readme/openapi-parser": "^2.2.0",
+    "caseless": "^0.12.0",
     "chalk": "^4.1.2",
     "commander": "^9.2.0",
     "datauri": "^4.1.0",
@@ -54,16 +55,18 @@
     "json-schema-traverse": "^1.0.0",
     "lodash.merge": "^4.6.2",
     "make-dir": "^3.1.0",
-    "oas": "^18.3.3",
+    "oas": "^18.3.4",
     "object-hash": "^3.0.0",
     "ora": "^5.4.1",
     "prompts": "^2.4.2",
+    "remove-undefined-objects": "^2.0.1",
     "ssri": "^9.0.0",
     "ts-morph": "^15.1.0",
     "validate-npm-package-name": "^4.0.0"
   },
   "devDependencies": {
     "@readme/oas-examples": "^5.4.1",
+    "@types/caseless": "^0.12.2",
     "@types/chai": "^4.3.1",
     "@types/find-cache-dir": "^3.2.1",
     "@types/js-yaml": "^4.0.5",
@@ -91,5 +94,5 @@
       "test/"
     ]
   },
-  "gitHead": "aa738b1bf46b447afed38507d3fc49acbbad6309"
+  "gitHead": "24d5b83545735176786d212a69121a029cf6dea1"
 }

package/src/cache.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 
 import 'isomorphic-fetch';
 import OpenAPIParser from '@readme/openapi-parser';

package/src/cli/codegen/languages/typescript.ts

@@ -1,6 +1,6 @@
 import type Oas from 'oas';
 import type { Operation } from 'oas';
-import type { HttpMethods, JSONSchema, SchemaObject } from 'oas/@types/rmoas.types';
+import type { HttpMethods, JSONSchema, SchemaObject } from 'oas/dist/rmoas.types';
 import type {
   ClassDeclaration,
   JSDocStructure,
@@ -8,6 +8,7 @@ import type {
   OptionalKind,
   ParameterDeclarationStructure,
   TypeParameterDeclarationStructure,
+  VariableStatement,
 } from 'ts-morph';
 import type { Options as JSONSchemaToTypescriptOptions } from 'json-schema-to-typescript';
 import type Storage from '../../storage';
@@ -18,11 +19,16 @@ import path from 'path';
 import CodeGeneratorLanguage from '../language';
 import logger from '../../logger';
 import objectHash from 'object-hash';
-import { IndentationText, Project, QuoteKind, ScriptTarget } from 'ts-morph';
+import { IndentationText, Project, QuoteKind, ScriptTarget, VariableDeclarationKind } from 'ts-morph';
 import { compile } from 'json-schema-to-typescript';
 import { format as prettier } from 'json-schema-to-typescript/dist/src/formatter';
 import execa from 'execa';
 
+export type TSGeneratorOptions = {
+  outputJS?: boolean;
+  compilerTarget?: 'cjs' | 'esm';
+};
+
 type OperationTypeHousing = {
   types: {
     params?: false | Record<'body' | 'formData' | 'metadata', string>;
@@ -51,6 +57,8 @@ export default class TSGenerator extends CodeGeneratorLanguage {
 
   sdk: ClassDeclaration;
 
+  sdkExport: VariableStatement;
+
   schemas: Map<
     string,
     {
@@ -60,15 +68,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
     }
   >;
 
-  constructor(
-    spec: Oas,
-    specPath: string,
-    identifier: string,
-    opts: {
-      outputJS?: boolean;
-      compilerTarget?: 'cjs' | 'esm';
-    } = {}
-  ) {
+  constructor(spec: Oas, specPath: string, identifier: string, opts: TSGeneratorOptions = {}) {
     const options: { outputJS: boolean; compilerTarget: 'cjs' | 'esm' } = {
       outputJS: false,
       compilerTarget: 'cjs',
@@ -100,9 +100,9 @@ export default class TSGenerator extends CodeGeneratorLanguage {
       },
       compilerOptions: {
         declaration: true,
+        outDir: 'dist',
         resolveJsonModule: true,
         target: options.compilerTarget === 'cjs' ? ScriptTarget.ES5 : ScriptTarget.ES2020,
-        outDir: 'dist',
 
         // If we're compiling to a CJS target then we need to include this compiler option
         // otherwise TS will attempt to load our `openapi.json` import with a `.default` property
@@ -186,23 +186,57 @@ export default class TSGenerator extends CodeGeneratorLanguage {
       name: 'SDK',
     });
 
-    // There's an annoying quirk with `ts-morph` where if we set the SDK class to be the default
-    // export with `isDefaultExport` then when we compile it to an ES5 target for CJS environments
-    // it'll be exported as `export.default = SDK`, which when you try to load it you'll need to
-    // run `require('@api/sdk').default`.
-    //
-    // Instead here by plainly creating the SDK class in the source file and then setting this
-    // export assignment it'll export the SDK class as `module.exports = SDK` so people can cleanly
-    // load the SDK with `require('@api/sdk)`.
-    //
-    // A whole lot of debugging went into here to let people not have to worry about `.default`
-    // messes. I hope it's worth it!
+    this.sdkExport = sdkSource.addVariableStatement({
+      declarationKind: VariableDeclarationKind.Const,
+      declarations: [
+        {
+          name: 'createSDK',
+          initializer: writer => {
+            // `ts-morph` doesn't have any way to cleanly create an IFEE.
+            writer.writeLine('(() => { return new SDK(); })()');
+            return writer;
+          },
+        },
+      ],
+    });
+
+    /**
+     * There's an annoying quirk with `ts-morph` where if we set the `createSDK` function to be the
+     * default export with `isDefaultExport` then when we compile it to an ES5 target for CJS
+     * environments it'll be exported as `export.default = createSDK`, which when you try to load it
+     * you'll need to run `require('@api/sdk').default`.
+     *
+     * Instead here by plainly creating `createSDK` in the source file and then setting this export
+     * assignment it'll export the SDK IFEE initializer as `module.exports = createSDK` so people
+     * can cleanly load their SDK with `require('@api/sdk)`.
+     *
+     * A whole lot of debugging went into here to let people not have to worry about `.default`
+     * messes. I hope it's worth it!
+     */
     if (this.compilerTarget === 'cjs') {
       sdkSource.addExportAssignment({
-        expression: 'SDK',
+        expression: 'createSDK',
       });
     } else {
-      this.sdk.setIsDefaultExport(true);
+      /**
+       * Because `createSDK` above is an IFEE constant we can't use `setIsDefaultExport` on it due
+       * to `ts-morph` not having great handling for IFEE's.
+       *
+       * If we were to call `setIsDefaultExport` on our IFEE to attempt to compile it as
+       * `export default createSDK` then `ts-morph` hard crashes with a "Error replacing tree: The
+       * children of the old and new trees were expected to have the same count" exception due to
+       * it not being able properly handle IFEE's. It's for that reason that we need to manually
+       * write a statement expression to set `createSDK` as the default export.
+       *
+       * Another quirk that this work avoids is there being an empty `export {};` at the very end
+       * of our compiled `d.ts` declaration file. I'm not sure why it was being added, and it
+       * didn't appear to be harming anything, but us manually creating this export statement
+       * causes it to go away.
+       *
+       * Thankfully, fortunately, and curiously, these are all only problems in non-CJS compiled
+       * targets. ¯\_(ツ)_/¯
+       */
+      sdkSource.addStatements('export default createSDK');
     }
 
     this.sdk.addProperties([
@@ -334,7 +368,43 @@ sdk.server('https://eu.api.example.com/v14');`)
     // @todo should all of these isolated into their own file outside of the main sdk class file?
     // Add all known types that we're using into the SDK.
     Array.from(this.types.values()).forEach(exp => {
-      sdkSource.addStatements(exp);
+      /**
+       * When `ts-morph` compiles declaration files when we're targeting CJS environments it creates
+       * the default export as `export = _default` instead of `export default const _default`. This
+       * causes TS to throw a TS2309 error for "An export assignment cannot be used in a module
+       * with other exported elements" because our types and interfaces are also being exported and
+       * the `export =` overrides those.
+       *
+       * Fixing this is, to be frank, a fucking HARD problem for a couple reasons:
+       *
+       *  1. Our JSON Schema types and interfaces are coming from `json-schema-to-typescript` and
+       *    that library exports its data a raw string containing multiple types and interfaces.
+       *    The only way we're able to capture and use them in our codegenerated SDK is because
+       *    we're ingesting that string into `ts-morph` and then using its APIs to extract exported
+       *    declarations (which are still strings) and then they're re-inserted into our main
+       *    source file here.
+       *  2. Though `ts-morph` has APIs for adding type aliases and interfaces to a source file what
+       *    it doesn't have is the ability to pass in a string, or a `Writer` class that exposes,
+       *    to write raw strings to a type or an interface. If it did we'd be able to replace this
+       *    `addStatements` call with an `addTypeAlias` and `addInterface` call for each of our
+       *    JSON Schema schemas that we've got along with an `isExported` flag for `ts-morph` to
+       *    export it.
+       *
+       * Because neither of these are solvable problems right now we're instead opting to **not**
+       * export types and interfaces from these SDKs. This isn't a great solution because it
+       * /slightly/ reduces the usability of the TS codegen functionality but in order for the TS
+       * declaration files that we generate to be valid this is the only option that we've got.
+       *
+       * However, that said, if somebody needs an interface or type exported they can export it
+       * themselves in the SDK code that we compile for them.
+       *
+       * @fixme
+       */
+      sdkSource.addStatements(
+        // All expressions coming out of `json-schema-to-typescript` are exported so by popping this
+        // off we'll just be inserting plain interfaces and types into the SDK source.
+        exp.substring('export '.length)
+      );
     });
 
     if (this.outputJS) {

package/src/cli/storage.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 
 import ssri from 'ssri';
 import fs from 'fs';

package/src/core/getJSONSchemaDefaults.ts

@@ -1,5 +1,5 @@
-import type { SchemaObject } from 'oas/@types/rmoas.types';
-import type { SchemaWrapper } from 'oas/@types/operation/get-parameters-as-json-schema';
+import type { SchemaObject } from 'oas/dist/rmoas.types';
+import type { SchemaWrapper } from 'oas/dist/operation/get-parameters-as-json-schema';
 import traverse from 'json-schema-traverse';
 
 /**

package/src/core/index.ts

@@ -1,6 +1,6 @@
 import type Oas from 'oas';
 import type { Operation } from 'oas';
-import type { HttpMethods } from 'oas/@types/rmoas.types';
+import type { HttpMethods } from 'oas/dist/rmoas.types';
 
 import 'isomorphic-fetch';
 import fetchHar from 'fetch-har';

package/src/core/prepareParams.ts

@@ -1,5 +1,5 @@
 import type { Operation } from 'oas';
-import type { ParameterObject, SchemaObject } from 'oas/@types/rmoas.types';
+import type { ParameterObject, SchemaObject } from 'oas/dist/rmoas.types';
 import type { ReadStream } from 'fs';
 
 import lodashMerge from 'lodash.merge';
@@ -9,6 +9,8 @@ import stream from 'stream';
 import getStream from 'get-stream';
 import datauri from 'datauri/sync';
 import DatauriParser from 'datauri/parser';
+import removeUndefinedObjects from 'remove-undefined-objects';
+import caseless from 'caseless';
 import getJSONSchemaDefaults from './getJSONSchemaDefaults';
 
 /**
@@ -143,6 +145,18 @@ export default async function prepareParams(operation: Operation, body?: unknown
   const hasDigestedParams = !!Object.keys(digestedParameters).length;
   const jsonSchema = operation.getParametersAsJsonSchema();
 
+  /**
+   * It might be common for somebody to run `sdk.findPetsByStatus({ status: 'available' }, {})`, in
+   * which case we want to filter out the second (metadata) parameter and treat the first parameter
+   * as the metadata instead. If we don't do this, their supplied `status` metadata will be treated
+   * as a body parameter, and because there's no `status` body parameter, and no supplied metadata
+   * (because it's an empty object), the request won't send a payload.
+   *
+   * @see {@link https://github.com/readmeio/api/issues/449}
+   */
+  // eslint-disable-next-line no-param-reassign
+  metadata = removeUndefinedObjects(metadata);
+
   if (!jsonSchema && (body !== undefined || metadata !== undefined)) {
     throw new Error(
       "You supplied metadata and/or body data for this operation but it doesn't have any documented parameters or request payloads. If you think this is an error please contact support for the API you're using."
@@ -184,7 +198,25 @@ export default async function prepareParams(operation: Operation, body?: unknown
         // isn't anything we can do about it.
         params.body = merge(params.body, body);
       } else {
-        const intersection = Object.keys(body).filter(value => Object.keys(digestedParameters).includes(value)).length;
+        const headerParams = caseless({});
+        Object.entries(digestedParameters).forEach(([paramName, param]) => {
+          // Headers are sent case-insensitive so we need to make sure that we're properly
+          // matching them when detecting what our incoming payload looks like.
+          if (param.in === 'header') {
+            headerParams.set(paramName, '');
+          }
+        });
+
+        const intersection = Object.keys(body).filter(value => {
+          if (Object.keys(digestedParameters).includes(value)) {
+            return true;
+          } else if (headerParams.has(value)) {
+            return true;
+          }
+
+          return false;
+        }).length;
+
         if (intersection && intersection / Object.keys(body).length > 0.25) {
           /* eslint-disable no-param-reassign */
           // If more than 25% of the body intersects with the parameters that we've got on hand,
@@ -276,8 +308,14 @@ export default async function prepareParams(operation: Operation, body?: unknown
 
     Object.entries(digestedParameters).forEach(([paramName, param]) => {
       let value: any;
-      if (typeof metadata === 'object' && !isEmpty(metadata) && paramName in metadata) {
-        value = metadata[paramName];
+      if (typeof metadata === 'object' && !isEmpty(metadata)) {
+        if (paramName in metadata) {
+          value = metadata[paramName];
+        } else if (param.in === 'header') {
+          // Headers are sent case-insensitive so we need to make sure that we're properly
+          // matching them when detecting what our incoming payload looks like.
+          value = metadata[Object.keys(metadata).find(k => k.toLowerCase() === paramName.toLowerCase())];
+        }
       }
 
       if (value === undefined) {
@@ -295,7 +333,7 @@ export default async function prepareParams(operation: Operation, body?: unknown
           delete metadata[paramName];
           break;
         case 'header':
-          params.header[paramName] = value;
+          params.header[paramName.toLowerCase()] = value;
           delete metadata[paramName];
           break;
         case 'cookie':

package/src/fetcher.ts

@@ -1,4 +1,4 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 
 import 'isomorphic-fetch';
 import OpenAPIParser from '@readme/openapi-parser';

package/src/index.ts

@@ -1,5 +1,5 @@
 import type { Operation } from 'oas';
-import type { HttpMethods, OASDocument } from 'oas/@types/rmoas.types';
+import type { HttpMethods, OASDocument } from 'oas/dist/rmoas.types';
 import type { ConfigOptions } from './core';
 
 import Oas from 'oas';

package/src/packageInfo.ts

@@ -1,3 +1,3 @@
 // This file is automatically updated by the build script.
 export const PACKAGE_NAME = 'api';
-export const PACKAGE_VERSION = '5.0.0-beta.2';
+export const PACKAGE_VERSION = '5.0.0-beta.3';