api 6.1.0 → 6.1.1

package/README.md

@@ -40,7 +40,7 @@ Or you can use it dynamically (though you won't have fancy TypeScript types to h
 
 ```js
 const petstore = require('api')(
-  'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json'
+  'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json',
 );
 
 petstore.listPets().then(({ data }) => {

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

@@ -1,4 +1,3 @@
-export declare function formatter(content: string): string;
 /**
  * @see {@link https://www.30secondsofcode.org/js/s/word-wrap}
  */

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

@@ -3,11 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-exports.generateTypeName = exports.toSafeString = exports.docblockEscape = exports.wordWrap = exports.formatter = void 0;
+exports.generateTypeName = exports.toSafeString = exports.docblockEscape = exports.wordWrap = void 0;
 var lodash_camelcase_1 = __importDefault(require("lodash.camelcase"));
 var lodash_deburr_1 = __importDefault(require("lodash.deburr"));
 var lodash_startcase_1 = __importDefault(require("lodash.startcase"));
-var prettier_1 = require("prettier");
 /**
  * This is a mix of reserved JS words and keywords in TypeScript that might be reserved or
  * allowable but functionally confusing (like `let any = 'buster';`)
@@ -103,14 +102,6 @@ var RESERVED_WORDS = [
     'self',
     'window',
 ];
-function formatter(content) {
-    return (0, prettier_1.format)(content, {
-        parser: 'typescript',
-        printWidth: 100,
-        singleQuote: true
-    });
-}
-exports.formatter = formatter;
 /**
  * @see {@link https://www.30secondsofcode.org/js/s/word-wrap}
  */

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

@@ -243,7 +243,7 @@ var TSGenerator = /** @class */ (function (_super) {
                                 // user will have `.d.ts` files for them instead.
                                 return {};
                             }
-                            var code = (0, util_1.formatter)(sourceFile.text);
+                            var code = sourceFile.text;
                             if (file === 'index.js' && _this.compilerTarget === 'cjs') {
                                 /**
                                  * There's an annoying quirk with `ts-morph` where if we're exporting a default export
@@ -268,7 +268,7 @@ var TSGenerator = /** @class */ (function (_super) {
                 return [2 /*return*/, __spreadArray(__spreadArray([], this.project.getSourceFiles().map(function (sourceFile) {
                         var _a;
                         return (_a = {},
-                            _a[sourceFile.getBaseName()] = (0, util_1.formatter)(sourceFile.getFullText()),
+                            _a[sourceFile.getBaseName()] = sourceFile.getFullText(),
                             _a);
                     }), true), this.project
                         .emitToMemory({ emitOnlyDtsFiles: true })
@@ -276,7 +276,7 @@ var TSGenerator = /** @class */ (function (_super) {
                         .map(function (sourceFile) {
                         var _a;
                         return (_a = {},
-                            _a[path_1["default"].basename(sourceFile.filePath)] = (0, util_1.formatter)(sourceFile.text),
+                            _a[path_1["default"].basename(sourceFile.filePath)] = sourceFile.text,
                             _a);
                     }), true).reduce(function (prev, next) { return Object.assign(prev, next); })];
             });
@@ -602,7 +602,7 @@ var TSGenerator = /** @class */ (function (_super) {
                             fetchStmt.write(', ');
                         }
                         fetchStmt.write(arg.name);
-                        if (totalParams > 1 && i !== totalParams) {
+                        if (i !== totalParams - 1) {
                             fetchStmt.write(', ');
                         }
                     });

package/dist/core/prepareParams.js

@@ -82,7 +82,7 @@ function isObject(thing) {
     return typeof thing === 'object' && thing !== null && !Array.isArray(thing);
 }
 function isPrimitive(obj) {
-    return typeof obj === null || typeof obj === 'number' || typeof obj === 'string';
+    return obj === null || typeof obj === 'number' || typeof obj === 'string';
 }
 function merge(src, target) {
     if (Array.isArray(target)) {
@@ -343,6 +343,7 @@ function prepareParams(operation, body, metadata) {
                             if (typeof metadata === 'object' && !isEmpty(metadata)) {
                                 if (paramName in metadata) {
                                     value = metadata[paramName];
+                                    metadataHeaderParam = paramName;
                                 }
                                 else if (param["in"] === 'header') {
                                     // Headers are sent case-insensitive so we need to make sure that we're properly
@@ -387,10 +388,7 @@ function prepareParams(operation, body, metadata) {
                         // If there's any leftover metadata that hasn't been moved into form data for this request we
                         // need to move it or else it'll get tossed.
                         if (!isEmpty(metadata)) {
-                            if (operation.isFormUrlEncoded()) {
-                                params.formData = merge(params.formData, metadata);
-                            }
-                            else if (typeof metadata === 'object') {
+                            if (typeof metadata === 'object') {
                                 // If the user supplied an `accept` or `authorization` header themselves we should allow it
                                 // through. Normally these headers are automatically handled by `@readme/oas-to-har` but in
                                 // the event that maybe the user wants to return XML for an API that normally returns JSON
@@ -400,9 +398,14 @@ function prepareParams(operation, body, metadata) {
                                     var headerParam = Object.keys(metadata).find(function (m) { return m.toLowerCase() === headerName; });
                                     if (headerParam) {
                                         params.header[headerName] = metadata[headerParam];
+                                        // eslint-disable-next-line no-param-reassign
+                                        delete metadata[headerParam];
                                     }
                                 });
                             }
+                            if (operation.isFormUrlEncoded()) {
+                                params.formData = merge(params.formData, metadata);
+                            }
                             else {
                                 // Any other remaining unused metadata will be unused because we don't know where to place
                                 // it in the request.

package/dist/fetcher.js

@@ -158,7 +158,6 @@ var Fetcher = /** @class */ (function () {
      * @example @petstore/v1.0#n6kvf10vakpemvplx
      * @example @petstore#n6kvf10vakpemvplx
      */
-    // eslint-disable-next-line unicorn/no-unsafe-regex
     Fetcher.registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;
     return Fetcher;
 }());

package/dist/packageInfo.d.ts

@@ -1,2 +1,2 @@
 export declare const PACKAGE_NAME = "api";
-export declare const PACKAGE_VERSION = "6.1.0";
+export declare const PACKAGE_VERSION = "6.1.1";

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 = '6.1.0';
+exports.PACKAGE_VERSION = '6.1.1';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "description": "Magical SDK generation from an OpenAPI definition 🪄",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -10,10 +10,11 @@
   "scripts": {
     "build": "tsc",
     "debug:bin": "node -r ts-node/register src/bin.ts",
+    "lint:types": "tsc --noEmit",
     "prebuild": "rm -rf dist/; npm run version",
     "prepack": "npm run build",
-    "test": "jest --coverage $(find test -name '*.test.ts' -not -path '*/smoketest.test.ts')",
-    "test:smoke": "npx jest test/cli/codegen/languages/typescript/smoketest.test.ts",
+    "test": "vitest --coverage",
+    "test:smoke": "vitest --config=vitest-smoketest.config.ts ",
     "version": "node -p \"'// This file is automatically updated by the build script.\\nexport const PACKAGE_NAME = \\'' + require('./package.json').name + '\\';\\nexport const PACKAGE_VERSION = \\'' + require('./package.json').version + '\\';'\" > src/packageInfo.ts; git add src/packageInfo.ts"
   },
   "repository": {
@@ -63,7 +64,6 @@
     "node-abort-controller": "^3.1.1",
     "oas": "^20.4.0",
     "ora": "^5.4.1",
-    "prettier": "^2.8.3",
     "prompts": "^2.4.2",
     "remove-undefined-objects": "^2.0.2",
     "semver": "^7.3.8",
@@ -75,7 +75,6 @@
     "@readme/oas-examples": "^5.9.0",
     "@types/caseless": "^0.12.2",
     "@types/find-cache-dir": "^3.2.1",
-    "@types/jest": "^29.5.2",
     "@types/js-yaml": "^4.0.5",
     "@types/lodash.camelcase": "^4.3.7",
     "@types/lodash.deburr": "^4.1.7",
@@ -87,15 +86,14 @@
     "@types/semver": "^7.3.13",
     "@types/ssri": "^7.1.1",
     "@types/validate-npm-package-name": "^4.0.0",
+    "@vitest/coverage-v8": "^0.34.1",
     "fetch-mock": "^9.11.0",
-    "jest": "^29.6.1",
-    "jest-extended": "^4.0.0",
     "oas-normalize": "^8.3.2",
-    "ts-jest": "^29.1.1",
-    "type-fest": "^3.5.4",
+    "type-fest": "^4.2.0",
     "typescript": "^4.9.5",
-    "unique-temp-dir": "^1.0.0"
+    "unique-temp-dir": "^1.0.0",
+    "vitest": "^0.34.1"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "gitHead": "244093f2ad00e5ea527420f49bdb541bc2095806"
+  "gitHead": "e440a28841e753895bfb5315b4d31f679824fa39"
 }

package/src/cli/codegen/index.ts

@@ -9,7 +9,7 @@ export default function codegen(
   language: SupportedLanguages,
   spec: Oas,
   specPath: string,
-  identifier: string
+  identifier: string,
 ): CodeGeneratorLanguage {
   switch (language) {
     case 'js':

package/src/cli/codegen/language.ts

@@ -49,7 +49,7 @@ export default abstract class CodeGeneratorLanguage {
      */
     if (JSON.stringify(spec.api).includes('"$ref":"#/')) {
       throw new Error(
-        'Sorry, this library does not yet support generating an SDK for an OpenAPI definition that contains circular references.'
+        'Sorry, this library does not yet support generating an SDK for an OpenAPI definition that contains circular references.',
       );
     }
   }

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

@@ -1,7 +1,6 @@
 import camelCase from 'lodash.camelcase';
 import deburr from 'lodash.deburr';
 import startCase from 'lodash.startcase';
-import { format as prettier } from 'prettier';
 
 /**
  * This is a mix of reserved JS words and keywords in TypeScript that might be reserved or
@@ -100,14 +99,6 @@ const RESERVED_WORDS = [
   'window',
 ];
 
-export function formatter(content: string) {
-  return prettier(content, {
-    parser: 'typescript',
-    printWidth: 100,
-    singleQuote: true,
-  });
-}
-
 /**
  * @see {@link https://www.30secondsofcode.org/js/s/word-wrap}
  */

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

@@ -23,7 +23,7 @@ import { IndentationText, Project, QuoteKind, ScriptTarget, VariableDeclarationK
 import logger from '../../logger';
 import CodeGeneratorLanguage from '../language';
 
-import { docblockEscape, formatter, generateTypeName, wordWrap } from './typescript/util';
+import { docblockEscape, generateTypeName, wordWrap } from './typescript/util';
 
 export interface TSGeneratorOptions {
   compilerTarget?: 'cjs' | 'esm';
@@ -245,7 +245,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
             return {};
           }
 
-          let code = formatter(sourceFile.text);
+          let code = sourceFile.text;
           if (file === 'index.js' && this.compilerTarget === 'cjs') {
             /**
              * There's an annoying quirk with `ts-morph` where if we're exporting a default export
@@ -271,7 +271,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
 
     return [
       ...this.project.getSourceFiles().map(sourceFile => ({
-        [sourceFile.getBaseName()]: formatter(sourceFile.getFullText()),
+        [sourceFile.getBaseName()]: sourceFile.getFullText(),
       })),
 
       // Because we're returning the raw source files for TS generation we also need to separately
@@ -281,7 +281,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
         .emitToMemory({ emitOnlyDtsFiles: true })
         .getFiles()
         .map(sourceFile => ({
-          [path.basename(sourceFile.filePath)]: formatter(sourceFile.text),
+          [path.basename(sourceFile.filePath)]: sourceFile.text,
         })),
     ].reduce((prev, next) => Object.assign(prev, next));
   }
@@ -340,7 +340,7 @@ export default class TSGenerator extends CodeGeneratorLanguage {
               {
                 tagName: 'param',
                 text: wordWrap(
-                  'config.timeout Override the default `fetch` request timeout of 30 seconds. This number should be represented in milliseconds.'
+                  'config.timeout Override the default `fetch` request timeout of 30 seconds. This number should be represented in milliseconds.',
                 ),
               },
             ],
@@ -370,7 +370,7 @@ sdk.auth('username', 'password');
 sdk.auth('myBearerToken');
 
 @example <caption>API Keys</caption>
-sdk.auth('myApiKey');`)
+sdk.auth('myApiKey');`),
               ),
             tags: [
               { tagName: 'see', text: '{@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}' },
@@ -403,7 +403,7 @@ sdk.server('https://{region}.api.example.com/{basePath}', {
 });
 
 @example <caption>Fully qualified server URL</caption>
-sdk.server('https://eu.api.example.com/v14');`)
+sdk.server('https://eu.api.example.com/v14');`),
               ),
             tags: [
               { tagName: 'param', text: 'url Server URL' },
@@ -536,7 +536,7 @@ sdk.server('https://eu.api.example.com/v14');`)
     operation: Operation,
     operationId: string,
     paramTypes?: OperationTypeHousing['types']['params'],
-    responseTypes?: OperationTypeHousing['types']['responses']
+    responseTypes?: OperationTypeHousing['types']['responses'],
   ) {
     let docblock: OptionalKind<JSDocStructure> = {};
     const summary = operation.getSummary();
@@ -676,7 +676,7 @@ sdk.server('https://eu.api.example.com/v14');`)
             }
 
             fetchStmt.write(arg.name);
-            if (totalParams > 1 && i !== totalParams) {
+            if (i !== totalParams - 1) {
               fetchStmt.write(', ');
             }
           });

package/src/cli/commands/install.ts

@@ -24,7 +24,7 @@ cmd
       'js-cjs',
       'js-esm',
       'ts',
-    ])
+    ]),
   )
   .addOption(new Option('-y, --yes', 'Automatically answer "yes" to any prompts printed'))
   .action(async (uri: string, options: { identifier?: string; lang: string; yes?: boolean }) => {
@@ -188,7 +188,7 @@ cmd
 Examples:
   $ api install @developers/v2.0#nysezql0wwo236
   $ api install https://raw.githubusercontent.com/readmeio/oas-examples/main/3.0/json/petstore-simple.json
-  $ api install ./petstore.json`
+  $ api install ./petstore.json`,
   );
 
 export default cmd;

package/src/cli/lib/prompt.ts

@@ -9,7 +9,7 @@ import prompts from 'prompts';
  */
 export default async function promptTerminal<T extends string = string>(
   question: prompts.PromptObject<T>,
-  options?: prompts.Options
+  options?: prompts.Options,
 ) {
   const enableTerminalCursor = () => {
     process.stdout.write('\x1B[?25h');

package/src/core/getJSONSchemaDefaults.ts

@@ -26,7 +26,7 @@ export default function getJSONSchemaDefaults(jsonSchemas: SchemaWrapper[]) {
           parentPointer: string,
           parentKeyword: string,
           parentSchema: SchemaObject,
-          indexProperty: string
+          indexProperty: string,
         ) => {
           if (!pointer.startsWith('/properties/')) {
             return;
@@ -58,7 +58,7 @@ export default function getJSONSchemaDefaults(jsonSchemas: SchemaWrapper[]) {
               }
             }
           }
-        }
+        },
       );
 
       if (!Object.keys(defaults).length) {

package/src/core/index.ts

@@ -132,7 +132,7 @@ export default class APICore {
               parsed.status,
               parsed.data,
               parsed.headers,
-              parsed.res
+              parsed.res,
             );
           }
 

package/src/core/prepareAuth.ts

@@ -26,7 +26,7 @@ export default function prepareAuth(authKey: (number | string)[], operation: Ope
   // Does this operation require multiple forms of auth?
   if (security.every(s => Object.keys(s).length > 1)) {
     throw new Error(
-      "Sorry, this operation currently requires multiple forms of authentication which this library doesn't yet support."
+      "Sorry, this operation currently requires multiple forms of authentication which this library doesn't yet support.",
     );
   }
 
@@ -54,7 +54,7 @@ export default function prepareAuth(authKey: (number | string)[], operation: Ope
     const schemes = preparedSecurity.Basic.filter(s => usableSecuritySchemes.includes(s._key));
     if (!schemes.length) {
       throw new Error(
-        'Credentials for Basic Authentication were supplied but this operation requires another form of auth in that case, which this library does not yet support. This operation does, however, allow supplying a single auth token.'
+        'Credentials for Basic Authentication were supplied but this operation requires another form of auth in that case, which this library does not yet support. This operation does, however, allow supplying a single auth token.',
       );
     }
 
@@ -101,7 +101,7 @@ export default function prepareAuth(authKey: (number | string)[], operation: Ope
 
     default:
       throw new Error(
-        `Sorry, this API currently uses a security scheme, ${scheme.type}, which this library doesn't yet support.`
+        `Sorry, this API currently uses a security scheme, ${scheme.type}, which this library doesn't yet support.`,
       );
   }
 

package/src/core/prepareParams.ts

@@ -32,7 +32,7 @@ function digestParameters(parameters: ParameterObject[]): Record<string, Paramet
       throw new Error("The OpenAPI document for this operation wasn't dereferenced before processing.");
     } else if (param.name in prev) {
       throw new Error(
-        `The operation you are using has the same parameter, ${param.name}, spread across multiple entry points. We unfortunately can't handle this right now.`
+        `The operation you are using has the same parameter, ${param.name}, spread across multiple entry points. We unfortunately can't handle this right now.`,
       );
     }
 
@@ -54,7 +54,7 @@ function isObject(thing: any) {
 }
 
 function isPrimitive(obj: any) {
-  return typeof obj === null || typeof obj === 'number' || typeof obj === 'string';
+  return obj === null || typeof obj === 'number' || typeof obj === 'string';
 }
 
 function merge(src: any, target: any) {
@@ -75,7 +75,7 @@ function merge(src: any, target: any) {
  */
 function processFile(
   paramName: string,
-  file: string | ReadStream
+  file: string | ReadStream,
 ): Promise<{ base64: string; buffer: Buffer; filename: string; paramName: string }> {
   if (typeof file === 'string') {
     // In order to support relative pathed files, we need to attempt to resolve them.
@@ -129,8 +129,8 @@ function processFile(
     new TypeError(
       paramName
         ? `The data supplied for the \`${paramName}\` request body parameter is not a file handler that we support.`
-        : 'The data supplied for the request body payload is not a file handler that we support.'
-    )
+        : 'The data supplied for the request body payload is not a file handler that we support.',
+    ),
   );
 }
 
@@ -179,7 +179,7 @@ export default async function prepareParams(operation: Operation, body?: unknown
 
     if (throwNoParamsError) {
       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."
+        "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.",
       );
     }
   }
@@ -332,6 +332,7 @@ export default async function prepareParams(operation: Operation, body?: unknown
       if (typeof metadata === 'object' && !isEmpty(metadata)) {
         if (paramName in metadata) {
           value = metadata[paramName];
+          metadataHeaderParam = 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.
@@ -379,9 +380,7 @@ export default async function prepareParams(operation: Operation, body?: unknown
     // If there's any leftover metadata that hasn't been moved into form data for this request we
     // need to move it or else it'll get tossed.
     if (!isEmpty(metadata)) {
-      if (operation.isFormUrlEncoded()) {
-        params.formData = merge(params.formData, metadata);
-      } else if (typeof metadata === 'object') {
+      if (typeof metadata === 'object') {
         // If the user supplied an `accept` or `authorization` header themselves we should allow it
         // through. Normally these headers are automatically handled by `@readme/oas-to-har` but in
         // the event that maybe the user wants to return XML for an API that normally returns JSON
@@ -391,8 +390,14 @@ export default async function prepareParams(operation: Operation, body?: unknown
           const headerParam = Object.keys(metadata).find(m => m.toLowerCase() === headerName);
           if (headerParam) {
             params.header[headerName] = metadata[headerParam] as string;
+            // eslint-disable-next-line no-param-reassign
+            delete metadata[headerParam];
           }
         });
+      }
+
+      if (operation.isFormUrlEncoded()) {
+        params.formData = merge(params.formData, metadata);
       } else {
         // Any other remaining unused metadata will be unused because we don't know where to place
         // it in the request.

package/src/fetcher.ts

@@ -14,7 +14,6 @@ export default class Fetcher {
    * @example @petstore/v1.0#n6kvf10vakpemvplx
    * @example @petstore#n6kvf10vakpemvplx
    */
-  // eslint-disable-next-line unicorn/no-unsafe-regex
   static registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;
 
   constructor(uri: string | OASDocument) {
@@ -59,7 +58,7 @@ export default class Fetcher {
   async load() {
     if (typeof this.uri !== 'string') {
       throw new TypeError(
-        "Something disastrous occurred and a non-string URI was supplied to the Fetcher library. This shouldn't have happened!"
+        "Something disastrous occurred and a non-string URI was supplied to the Fetcher library. This shouldn't have happened!",
       );
     }
 
@@ -103,7 +102,7 @@ export default class Fetcher {
 
     if (!fs.existsSync(file)) {
       throw new Error(
-        `Sorry, we were unable to load an API definition from ${file}. Please either supply a URL or a path on your filesystem.`
+        `Sorry, we were unable to load an API definition from ${file}. Please either supply a URL or a path on your filesystem.`,
       );
     }
 

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 = '6.1.0';
+export const PACKAGE_VERSION = '6.1.1';

package/tsconfig.json

@@ -8,7 +8,7 @@
     "noImplicitAny": true,
     "outDir": "dist/",
     "paths": {
-      // Because this library uses ES2015+ `#private` syntax that would require us to maket his
+      // Because this library uses ES2015+ `#private` syntax that would require us to make this
       // library ESM-only we're overloading its types with a `paths` config with this empty file.
       // This isn't a great solution as we're losing type checks where this library is used, but
       // it's far too early in the ESM lifecycle for us to make API an ESM-only library.