api 6.0.0 → 6.1.1

package/src/core/prepareAuth.ts

@@ -11,8 +11,8 @@ export default function prepareAuth(authKey: (number | string)[], operation: Ope
     | string
     | number
     | {
-        user: string | number;
         pass: string | number;
+        user: string | number;
       }
   > = {};
 
@@ -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,8 +75,8 @@ function merge(src: any, target: any) {
  */
 function processFile(
   paramName: string,
-  file: string | ReadStream
-): Promise<{ paramName: string; base64: string; filename: string; buffer: Buffer }> {
+  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.
     const resolvedFile = path.resolve(file);
@@ -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/core/prepareServer.ts

@@ -12,9 +12,6 @@ function stripTrailingSlash(url: string) {
  * With an SDK server config and an instance of OAS we should extract and prepare the server and
  * any server variables to be supplied to `@readme/oas-to-har`.
  *
- * @param spec
- * @param url
- * @param variables
  */
 export default function prepareServer(spec: Oas, url: string, variables: Record<string, string | number> = {}) {
   let serverIdx;

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/index.ts

@@ -41,7 +41,6 @@ class Sdk {
      * Create dynamic accessors for every operation with a defined operation ID. If an operation
      * does not have an operation ID it can be accessed by its `.method('/path')` accessor instead.
      *
-     * @param spec
      */
     function loadOperations(spec: Oas) {
       return Object.entries(spec.getPaths())

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.0.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.