httpsnippet-client-api 6.1.0 → 7.0.0-alpha.4

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2022 ReadMe
+Copyright © 2023 ReadMe
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the “Software”), to deal in

package/dist/index.cjs

@@ -0,0 +1,219 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }// src/index.ts
+var _codebuilder = require('@readme/httpsnippet/helpers/code-builder');
+var _contenttype = require('content-type'); var _contenttype2 = _interopRequireDefault(_contenttype);
+var _oas = require('oas'); var _oas2 = _interopRequireDefault(_oas);
+var _utils = require('oas/utils');
+var _stringifyobject = require('stringify-object'); var _stringifyobject2 = _interopRequireDefault(_stringifyobject);
+function stringify(obj, opts = {}) {
+  return _stringifyobject2.default.call(void 0, obj, { indent: "  ", ...opts });
+}
+function buildAuthSnippet(authKey) {
+  if (Array.isArray(authKey)) {
+    const auth = [];
+    authKey.forEach((token, i) => {
+      if (token.length === 0 && authKey.length > 1 && i === authKey.length - 1) {
+        return;
+      }
+      auth.push(`'${token.replace(/'/g, "\\'")}'`);
+    });
+    return `sdk.auth(${auth.join(", ")});`;
+  }
+  return `sdk.auth('${authKey.replace(/'/g, "\\'")}');`;
+}
+function getAuthSources(operation) {
+  const matchers = {
+    header: {},
+    query: [],
+    cookie: []
+  };
+  if (operation.getSecurity().length === 0) {
+    return matchers;
+  }
+  Object.entries(operation.prepareSecurity()).forEach(([, schemes]) => {
+    schemes.forEach((scheme) => {
+      if (scheme.type === "http") {
+        if (scheme.scheme === "basic") {
+          matchers.header.authorization = "Basic";
+        } else if (scheme.scheme === "bearer") {
+          matchers.header.authorization = "Bearer";
+        }
+      } else if (scheme.type === "oauth2") {
+        matchers.header.authorization = "Bearer";
+      } else if (scheme.type === "apiKey") {
+        if (scheme.in === "query") {
+          matchers.query.push(scheme.name);
+        } else if (scheme.in === "header") {
+          matchers.header[scheme.name.toLowerCase()] = "*";
+        } else if (scheme.in === "cookie") {
+          matchers.cookie.push(scheme.name);
+        }
+      }
+    });
+  });
+  return matchers;
+}
+var client = {
+  info: {
+    key: "api",
+    title: "API",
+    link: "https://npm.im/api",
+    description: "Automatic SDK generation from an OpenAPI definition.",
+    extname: ".js"
+  },
+  convert: ({ cookiesObj, headersObj, postData, queryObj, url, ...source }, options) => {
+    const opts = {
+      ...options
+    };
+    if (!("apiDefinitionUri" in opts)) {
+      throw new Error("This HTTP Snippet client must have an `apiDefinitionUri` option supplied to it.");
+    } else if (!("apiDefinition" in opts)) {
+      throw new Error("This HTTP Snippet client must have an `apiDefinition` option supplied to it.");
+    }
+    const method = source.method.toLowerCase();
+    const oas = new (0, _oas2.default)(opts.apiDefinition);
+    const apiDefinition = oas.getDefinition();
+    const foundOperation = oas.findOperation(url, method);
+    if (!foundOperation) {
+      throw new Error(
+        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${url}`
+      );
+    }
+    const operationSlugs = foundOperation.url.slugs;
+    const operation = oas.operation(foundOperation.url.nonNormalizedPath, method);
+    const operationPathParameters = operation.getParameters().filter((param) => param.in === "path");
+    const path = operation.path;
+    const authData = [];
+    const authSources = getAuthSources(operation);
+    const { blank, push, join } = new (0, _codebuilder.CodeBuilder)({ indent: opts.indent || "  " });
+    push(`const sdk = require('api')('${opts.apiDefinitionUri}');`);
+    blank();
+    const configData = [];
+    if ((apiDefinition.servers || []).length > 1) {
+      const stockUrl = oas.url();
+      const baseUrl = url.replace(path, "");
+      if (baseUrl !== stockUrl) {
+        const serverVars = oas.splitVariables(baseUrl);
+        const serverUrl = serverVars ? oas.url(serverVars.selected, serverVars.variables) : baseUrl;
+        configData.push(`sdk.server('${serverUrl}');`);
+      }
+    }
+    let metadata = {};
+    Object.keys(queryObj).forEach((param) => {
+      if (authSources.query.includes(param)) {
+        authData.push(buildAuthSnippet(queryObj[param]));
+        return;
+      }
+      metadata[param] = queryObj[param];
+    });
+    Object.keys(cookiesObj).forEach((cookie) => {
+      if (authSources.cookie.includes(cookie)) {
+        authData.push(buildAuthSnippet(cookiesObj[cookie]));
+        return;
+      }
+      metadata[cookie] = cookiesObj[cookie];
+    });
+    Array.from(Object.entries(operationSlugs)).forEach(([param, value]) => {
+      const cleanedParam = param.substring(1);
+      const unsanitizedParam = operationPathParameters.find((p) => {
+        return p.name.includes("-") && p.name.replace(/-/g, "") === cleanedParam ? p.name : false;
+      });
+      if (unsanitizedParam) {
+        metadata[unsanitizedParam.name] = value;
+      } else {
+        metadata[cleanedParam] = value;
+      }
+    });
+    if (Object.keys(headersObj).length) {
+      const headers = headersObj;
+      const requestHeaders = {};
+      Object.keys(headers).forEach((header) => {
+        const headerLower = header.toLowerCase();
+        if (headerLower in authSources.header) {
+          const authScheme = authSources.header[headerLower];
+          if (authScheme === "*") {
+            authData.push(buildAuthSnippet(headers[header]));
+          } else {
+            let authKey = headers[header].replace(`${authSources.header[headerLower]} `, "");
+            if (authScheme.toLowerCase() === "basic") {
+              authKey = Buffer.from(authKey, "base64").toString("ascii");
+              authKey = authKey.split(":");
+            }
+            authData.push(buildAuthSnippet(authKey));
+          }
+          delete headers[header];
+          return;
+        } else if (headerLower === "content-type") {
+          const parsedContentType = _contenttype2.default.parse(headers[header]);
+          if (!Object.keys(parsedContentType.parameters).length) {
+            delete headers[header];
+            return;
+          }
+        } else if (headerLower === "accept") {
+          if (_utils.matchesMimeType.json(headers[header])) {
+            delete headers[header];
+            return;
+          }
+        }
+        requestHeaders[headerLower] = headers[header];
+      });
+      if (Object.keys(requestHeaders).length > 0) {
+        metadata = Object.assign(metadata, requestHeaders);
+      }
+    }
+    let body;
+    switch (postData.mimeType) {
+      case "application/x-www-form-urlencoded":
+        body = postData.paramsObj;
+        break;
+      case "application/json":
+        if (postData.jsonObj) {
+          body = postData.jsonObj;
+        }
+        break;
+      case "multipart/form-data":
+        if (postData.params) {
+          body = {};
+          if ("content-type" in metadata && metadata["content-type"].indexOf("multipart/form-data") === 0) {
+            delete metadata["content-type"];
+          }
+          postData.params.forEach((param) => {
+            if (param.fileName) {
+              body[param.name] = param.fileName;
+            } else {
+              body[param.name] = param.value;
+            }
+          });
+        }
+        break;
+      default:
+        if (postData.text) {
+          body = postData.text;
+        }
+    }
+    const args = [];
+    const accessor = operation.getOperationId({ camelCase: true });
+    const inlineCharacterLimit = typeof body !== "undefined" && Object.keys(metadata).length > 0 ? 40 : 80;
+    if (typeof body !== "undefined") {
+      args.push(stringify(body, { inlineCharacterLimit }));
+    }
+    if (Object.keys(metadata).length > 0) {
+      args.push(stringify(metadata, { inlineCharacterLimit }));
+    }
+    if (authData.length) {
+      push(authData.join("\n"));
+    }
+    if (configData.length) {
+      push(configData.join("\n"));
+    }
+    push(`sdk.${accessor}(${args.join(", ")})`);
+    push(".then(({ data }) => console.log(data))", 1);
+    push(".catch(err => console.error(err));", 1);
+    return join();
+  }
+};
+var src_default = client;
+
+
+exports.default = src_default;
+
+module.exports = exports.default//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAKA,SAAS,mBAAmB;AAC5B,OAAO,iBAAiB;AACxB,OAAO,SAAS;AAChB,SAAS,uBAAuB;AAChC,OAAO,qBAAqB;AAG5B,SAAS,UAAU,KAAU,OAAO,CAAC,GAAG;AACtC,SAAO,gBAAgB,KAAK,EAAE,QAAQ,MAAM,GAAG,KAAK,CAAC;AACvD;AAEA,SAAS,iBAAiB,SAA4B;AAEpD,MAAI,MAAM,QAAQ,OAAO,GAAG;AAC1B,UAAM,OAAiB,CAAC;AACxB,YAAQ,QAAQ,CAAC,OAAO,MAAM;AAE5B,UAAI,MAAM,WAAW,KAAK,QAAQ,SAAS,KAAK,MAAM,QAAQ,SAAS,GAAG;AACxE;AAAA,MACF;AAEA,WAAK,KAAK,IAAI,MAAM,QAAQ,MAAM,KAAK,CAAC,GAAG;AAAA,IAC7C,CAAC;AAED,WAAO,YAAY,KAAK,KAAK,IAAI,CAAC;AAAA,EACpC;AAEA,SAAO,aAAa,QAAQ,QAAQ,MAAM,KAAK,CAAC;AAClD;AAEA,SAAS,eAAe,WAAsB;AAC5C,QAAM,WAAkF;AAAA,IACtF,QAAQ,CAAC;AAAA,IACT,OAAO,CAAC;AAAA,IACR,QAAQ,CAAC;AAAA,EACX;AAEA,MAAI,UAAU,YAAY,EAAE,WAAW,GAAG;AACxC,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,UAAU,gBAAgB,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM;AACnE,YAAQ,QAAQ,YAAU;AACxB,UAAI,OAAO,SAAS,QAAQ;AAC1B,YAAI,OAAO,WAAW,SAAS;AAC7B,mBAAS,OAAO,gBAAgB;AAAA,QAClC,WAAW,OAAO,WAAW,UAAU;AACrC,mBAAS,OAAO,gBAAgB;AAAA,QAClC;AAAA,MACF,WAAW,OAAO,SAAS,UAAU;AACnC,iBAAS,OAAO,gBAAgB;AAAA,MAClC,WAAW,OAAO,SAAS,UAAU;AACnC,YAAI,OAAO,OAAO,SAAS;AACzB,mBAAS,MAAM,KAAK,OAAO,IAAI;AAAA,QACjC,WAAW,OAAO,OAAO,UAAU;AAMjC,mBAAS,OAAO,OAAO,KAAK,YAAY,CAAC,IAAI;AAAA,QAC/C,WAAW,OAAO,OAAO,UAAU;AACjC,mBAAS,OAAO,KAAK,OAAO,IAAI;AAAA,QAClC;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;AASA,IAAM,SAA6B;AAAA,EACjC,MAAM;AAAA,IACJ,KAAK;AAAA,IACL,OAAO;AAAA,IACP,MAAM;AAAA,IACN,aAAa;AAAA,IACb,SAAS;AAAA,EACX;AAAA,EACA,SAAS,CAAC,EAAE,YAAY,YAAY,UAAU,UAAU,KAAK,GAAG,OAAO,GAAG,YAAY;AACpF,UAAM,OAAO;AAAA,MACX,GAAG;AAAA,IACL;AAEA,QAAI,EAAE,sBAAsB,OAAO;AACjC,YAAM,IAAI,MAAM,iFAAiF;AAAA,IACnG,WAAW,EAAE,mBAAmB,OAAO;AACrC,YAAM,IAAI,MAAM,8EAA8E;AAAA,IAChG;AAEA,UAAM,SAAS,OAAO,OAAO,YAAY;AACzC,UAAM,MAAM,IAAI,IAAI,KAAK,aAAa;AACtC,UAAM,gBAAgB,IAAI,cAAc;AACxC,UAAM,iBAAiB,IAAI,cAAc,KAAK,MAAM;AACpD,QAAI,CAAC,gBAAgB;AACnB,YAAM,IAAI;AAAA,QACR,gFAAgF,OAAO,MAAM,IAAI,GAAG;AAAA,MACtG;AAAA,IACF;AAEA,UAAM,iBAAiB,eAAe,IAAI;AAC1C,UAAM,YAAY,IAAI,UAAU,eAAe,IAAI,mBAAmB,MAAM;AAC5E,UAAM,0BAA0B,UAAU,cAAc,EAAE,OAAO,WAAS,MAAM,OAAO,MAAM;AAC7F,UAAM,OAAO,UAAU;AACvB,UAAM,WAAqB,CAAC;AAC5B,UAAM,cAAc,eAAe,SAAS;AAE5C,UAAM,EAAE,OAAO,MAAM,KAAK,IAAI,IAAI,YAAY,EAAE,QAAQ,KAAK,UAAU,KAAK,CAAC;AAE7E,SAAK,+BAA+B,KAAK,gBAAgB,KAAK;AAC9D,UAAM;AAMN,UAAM,aAAa,CAAC;AACpB,SAAK,cAAc,WAAW,CAAC,GAAG,SAAS,GAAG;AAC5C,YAAM,WAAW,IAAI,IAAI;AACzB,YAAM,UAAU,IAAI,QAAQ,MAAM,EAAE;AACpC,UAAI,YAAY,UAAU;AACxB,cAAM,aAAa,IAAI,eAAe,OAAO;AAC7C,cAAM,YAAY,aAAa,IAAI,IAAI,WAAW,UAAU,WAAW,SAAS,IAAI;AAEpF,mBAAW,KAAK,eAAe,SAAS,KAAK;AAAA,MAC/C;AAAA,IACF;AAEA,QAAI,WAA8C,CAAC;AACnD,WAAO,KAAK,QAAQ,EAAE,QAAQ,WAAS;AACrC,UAAI,YAAY,MAAM,SAAS,KAAK,GAAG;AACrC,iBAAS,KAAK,iBAAiB,SAAS,KAAK,CAAC,CAAC;AAI/C;AAAA,MACF;AAEA,eAAS,KAAK,IAAI,SAAS,KAAK;AAAA,IAClC,CAAC;AAED,WAAO,KAAK,UAAU,EAAE,QAAQ,YAAU;AACxC,UAAI,YAAY,OAAO,SAAS,MAAM,GAAG;AACvC,iBAAS,KAAK,iBAAiB,WAAW,MAAM,CAAC,CAAC;AAGlD;AAAA,MACF;AAKA,eAAS,MAAM,IAAI,WAAW,MAAM;AAAA,IACtC,CAAC;AAGD,UAAM,KAAK,OAAO,QAAQ,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAC,OAAO,KAAK,MAAM;AAGrE,YAAM,eAAe,MAAM,UAAU,CAAC;AAKtC,YAAM,mBAAmB,wBAAwB,KAAK,OAAK;AACzD,eAAO,EAAE,KAAK,SAAS,GAAG,KAAK,EAAE,KAAK,QAAQ,MAAM,EAAE,MAAM,eAAe,EAAE,OAAO;AAAA,MACtF,CAAC;AAED,UAAI,kBAAkB;AACpB,iBAAS,iBAAiB,IAAI,IAAI;AAAA,MACpC,OAAO;AACL,iBAAS,YAAY,IAAI;AAAA,MAC3B;AAAA,IACF,CAAC;AAED,QAAI,OAAO,KAAK,UAAU,EAAE,QAAQ;AAClC,YAAM,UAAU;AAChB,YAAM,iBAAsC,CAAC;AAE7C,aAAO,KAAK,OAAO,EAAE,QAAQ,YAAU;AAGrC,cAAM,cAAc,OAAO,YAAY;AAEvC,YAAI,eAAe,YAAY,QAAQ;AAGrC,gBAAM,aAAa,YAAY,OAAO,WAAW;AACjD,cAAI,eAAe,KAAK;AACtB,qBAAS,KAAK,iBAAiB,QAAQ,MAAM,CAAC,CAAC;AAAA,UACjD,OAAO;AAEL,gBAAI,UAAU,QAAQ,MAAM,EAAE,QAAQ,GAAG,YAAY,OAAO,WAAW,CAAC,KAAK,EAAE;AAC/E,gBAAI,WAAW,YAAY,MAAM,SAAS;AACxC,wBAAU,OAAO,KAAK,SAAS,QAAQ,EAAE,SAAS,OAAO;AACzD,wBAAU,QAAQ,MAAM,GAAG;AAAA,YAC7B;AAEA,qBAAS,KAAK,iBAAiB,OAAO,CAAC;AAAA,UACzC;AAEA,iBAAO,QAAQ,MAAM;AACrB;AAAA,QACF,WAAW,gBAAgB,gBAAgB;AAIzC,gBAAM,oBAAoB,YAAY,MAAM,QAAQ,MAAM,CAAC;AAC3D,cAAI,CAAC,OAAO,KAAK,kBAAkB,UAAU,EAAE,QAAQ;AACrD,mBAAO,QAAQ,MAAM;AACrB;AAAA,UACF;AAAA,QACF,WAAW,gBAAgB,UAAU;AAGnC,cAAI,gBAAgB,KAAK,QAAQ,MAAM,CAAW,GAAG;AACnD,mBAAO,QAAQ,MAAM;AACrB;AAAA,UACF;AAAA,QACF;AAKA,uBAAe,WAAW,IAAI,QAAQ,MAAM;AAAA,MAC9C,CAAC;AAED,UAAI,OAAO,KAAK,cAAc,EAAE,SAAS,GAAG;AAC1C,mBAAW,OAAO,OAAO,UAAU,cAAc;AAAA,MACnD;AAAA,IACF;AAGA,QAAI;AACJ,YAAQ,SAAS,UAAU;AAAA,MACzB,KAAK;AACH,eAAO,SAAS;AAChB;AAAA,MAEF,KAAK;AACH,YAAI,SAAS,SAAS;AACpB,iBAAO,SAAS;AAAA,QAClB;AACA;AAAA,MAEF,KAAK;AACH,YAAI,SAAS,QAAQ;AACnB,iBAAO,CAAC;AAMR,cAAI,kBAAkB,YAAY,SAAS,cAAc,EAAE,QAAQ,qBAAqB,MAAM,GAAG;AAC/F,mBAAO,SAAS,cAAc;AAAA,UAChC;AAEA,mBAAS,OAAO,QAAQ,WAAS;AAC/B,gBAAI,MAAM,UAAU;AAClB,mBAAK,MAAM,IAAI,IAAI,MAAM;AAAA,YAC3B,OAAO;AACL,mBAAK,MAAM,IAAI,IAAI,MAAM;AAAA,YAC3B;AAAA,UACF,CAAC;AAAA,QACH;AACA;AAAA,MAEF;AACE,YAAI,SAAS,MAAM;AACjB,iBAAO,SAAS;AAAA,QAClB;AAAA,IACJ;AAEA,UAAM,OAAO,CAAC;AAEd,UAAM,WAAW,UAAU,eAAe,EAAE,WAAW,KAAK,CAAC;AAI7D,UAAM,uBAAuB,OAAO,SAAS,eAAe,OAAO,KAAK,QAAQ,EAAE,SAAS,IAAI,KAAK;AACpG,QAAI,OAAO,SAAS,aAAa;AAC/B,WAAK,KAAK,UAAU,MAAM,EAAE,qBAAqB,CAAC,CAAC;AAAA,IACrD;AAEA,QAAI,OAAO,KAAK,QAAQ,EAAE,SAAS,GAAG;AACpC,WAAK,KAAK,UAAU,UAAU,EAAE,qBAAqB,CAAC,CAAC;AAAA,IACzD;AAEA,QAAI,SAAS,QAAQ;AACnB,WAAK,SAAS,KAAK,IAAI,CAAC;AAAA,IAC1B;AAEA,QAAI,WAAW,QAAQ;AACrB,WAAK,WAAW,KAAK,IAAI,CAAC;AAAA,IAC5B;AAEA,SAAK,OAAO,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG;AAC1C,SAAK,0CAA0C,CAAC;AAChD,SAAK,sCAAsC,CAAC;AAE5C,WAAO,KAAK;AAAA,EACd;AACF;AAEA,IAAO,cAAQ","sourcesContent":["import type { ReducedHelperObject } from '@readme/httpsnippet/helpers/reducer';\nimport type { Client } from '@readme/httpsnippet/targets';\nimport type Operation from 'oas/operation';\nimport type { HttpMethods, OASDocument } from 'oas/rmoas.types';\n\nimport { CodeBuilder } from '@readme/httpsnippet/helpers/code-builder';\nimport contentType from 'content-type';\nimport Oas from 'oas';\nimport { matchesMimeType } from 'oas/utils';\nimport stringifyObject from 'stringify-object';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nfunction stringify(obj: any, opts = {}) {\n  return stringifyObject(obj, { indent: '  ', ...opts });\n}\n\nfunction buildAuthSnippet(authKey: string | string[]) {\n  // Auth key will be an array for Basic auth cases.\n  if (Array.isArray(authKey)) {\n    const auth: string[] = [];\n    authKey.forEach((token, i) => {\n      // If the token part is the last part of the key and it's empty, don't add it to the snippet.\n      if (token.length === 0 && authKey.length > 1 && i === authKey.length - 1) {\n        return;\n      }\n\n      auth.push(`'${token.replace(/'/g, \"\\\\'\")}'`);\n    });\n\n    return `sdk.auth(${auth.join(', ')});`;\n  }\n\n  return `sdk.auth('${authKey.replace(/'/g, \"\\\\'\")}');`;\n}\n\nfunction getAuthSources(operation: Operation) {\n  const matchers: { cookie: string[]; header: Record<string, string>; query: string[] } = {\n    header: {},\n    query: [],\n    cookie: [],\n  };\n\n  if (operation.getSecurity().length === 0) {\n    return matchers;\n  }\n\n  Object.entries(operation.prepareSecurity()).forEach(([, schemes]) => {\n    schemes.forEach(scheme => {\n      if (scheme.type === 'http') {\n        if (scheme.scheme === 'basic') {\n          matchers.header.authorization = 'Basic';\n        } else if (scheme.scheme === 'bearer') {\n          matchers.header.authorization = 'Bearer';\n        }\n      } else if (scheme.type === 'oauth2') {\n        matchers.header.authorization = 'Bearer';\n      } else if (scheme.type === 'apiKey') {\n        if (scheme.in === 'query') {\n          matchers.query.push(scheme.name);\n        } else if (scheme.in === 'header') {\n          // The way that this asterisk header matcher works is that since this `apiKey` goes in a\n          // named header (`scheme.name`) because the header is the key, we're matching against the\n          // entire header -- counter to the way that the HTTP basic matcher above works where we\n          // match and extract the API key from everything after `Basic ` in the `Authorization`\n          // header.\n          matchers.header[scheme.name.toLowerCase()] = '*';\n        } else if (scheme.in === 'cookie') {\n          matchers.cookie.push(scheme.name);\n        }\n      }\n    });\n  });\n\n  return matchers;\n}\n\ninterface APIOptions {\n  apiDefinition: OASDocument;\n  apiDefinitionUri: string;\n  escapeBrackets?: boolean;\n  indent?: string | false;\n}\n\nconst client: Client<APIOptions> = {\n  info: {\n    key: 'api',\n    title: 'API',\n    link: 'https://npm.im/api',\n    description: 'Automatic SDK generation from an OpenAPI definition.',\n    extname: '.js',\n  },\n  convert: ({ cookiesObj, headersObj, postData, queryObj, url, ...source }, options) => {\n    const opts = {\n      ...options,\n    } as APIOptions;\n\n    if (!('apiDefinitionUri' in opts)) {\n      throw new Error('This HTTP Snippet client must have an `apiDefinitionUri` option supplied to it.');\n    } else if (!('apiDefinition' in opts)) {\n      throw new Error('This HTTP Snippet client must have an `apiDefinition` option supplied to it.');\n    }\n\n    const method = source.method.toLowerCase() as HttpMethods;\n    const oas = new Oas(opts.apiDefinition);\n    const apiDefinition = oas.getDefinition();\n    const foundOperation = oas.findOperation(url, method);\n    if (!foundOperation) {\n      throw new Error(\n        `Unable to locate a matching operation in the supplied \\`apiDefinition\\` for: ${source.method} ${url}`,\n      );\n    }\n\n    const operationSlugs = foundOperation.url.slugs;\n    const operation = oas.operation(foundOperation.url.nonNormalizedPath, method);\n    const operationPathParameters = operation.getParameters().filter(param => param.in === 'path');\n    const path = operation.path;\n    const authData: string[] = [];\n    const authSources = getAuthSources(operation);\n\n    const { blank, push, join } = new CodeBuilder({ indent: opts.indent || '  ' });\n\n    push(`const sdk = require('api')('${opts.apiDefinitionUri}');`);\n    blank();\n\n    // If we have multiple servers configured and our source URL differs from the stock URL that we\n    // receive from our `oas` library then the URL either has server variables contained in it (that\n    // don't match the defaults), or the OAS offers alternate server URLs and we should expose that\n    // in the generated snippet.\n    const configData = [];\n    if ((apiDefinition.servers || []).length > 1) {\n      const stockUrl = oas.url();\n      const baseUrl = url.replace(path, '');\n      if (baseUrl !== stockUrl) {\n        const serverVars = oas.splitVariables(baseUrl);\n        const serverUrl = serverVars ? oas.url(serverVars.selected, serverVars.variables) : baseUrl;\n\n        configData.push(`sdk.server('${serverUrl}');`);\n      }\n    }\n\n    let metadata: Record<string, string | string[]> = {};\n    Object.keys(queryObj).forEach(param => {\n      if (authSources.query.includes(param)) {\n        authData.push(buildAuthSnippet(queryObj[param]));\n\n        // If this query param is part of an auth source then we don't want it doubled up in the\n        // snippet.\n        return;\n      }\n\n      metadata[param] = queryObj[param];\n    });\n\n    Object.keys(cookiesObj).forEach(cookie => {\n      if (authSources.cookie.includes(cookie)) {\n        authData.push(buildAuthSnippet(cookiesObj[cookie]));\n\n        // If this cookie is part of an auth source then we don't want it doubled up.\n        return;\n      }\n\n      // Note that we may have the potential to overlap any cookie that also shares the name as\n      // another metadata parameter. This problem is currently inherent to `api` and not this\n      // snippet generator.\n      metadata[cookie] = cookiesObj[cookie];\n    });\n\n    // If we have path parameters present we should add them into the metadata object.\n    Array.from(Object.entries(operationSlugs)).forEach(([param, value]) => {\n      // The keys in `operationSlugs` will always be prefixed with a `:` in the `oas` library so\n      // we can safely do this substring here without asserting this context.\n      const cleanedParam = param.substring(1);\n\n      // If our incoming path slug out of `oas.findOperation()` has been sanitized and is missing\n      // a hyphen, but there is a parameter in the OpenAPI definition that matches what our\n      // hyphen-less slug is then we should use that for the snippet.\n      const unsanitizedParam = operationPathParameters.find(p => {\n        return p.name.includes('-') && p.name.replace(/-/g, '') === cleanedParam ? p.name : false;\n      });\n\n      if (unsanitizedParam) {\n        metadata[unsanitizedParam.name] = value;\n      } else {\n        metadata[cleanedParam] = value;\n      }\n    });\n\n    if (Object.keys(headersObj).length) {\n      const headers = headersObj;\n      const requestHeaders: ReducedHelperObject = {};\n\n      Object.keys(headers).forEach(header => {\n        // Headers in HTTPSnippet are case-insensitive so we need to add in some special handling to\n        // make sure we're able to match them properly.\n        const headerLower = header.toLowerCase();\n\n        if (headerLower in authSources.header) {\n          // If this header has been set up as an authentication header, let's remove it and add it\n          // into our auth data so we can build up an `.auth()` snippet for the SDK.\n          const authScheme = authSources.header[headerLower];\n          if (authScheme === '*') {\n            authData.push(buildAuthSnippet(headers[header]));\n          } else {\n            // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.\n            let authKey = headers[header].replace(`${authSources.header[headerLower]} `, '');\n            if (authScheme.toLowerCase() === 'basic') {\n              authKey = Buffer.from(authKey, 'base64').toString('ascii');\n              authKey = authKey.split(':');\n            }\n\n            authData.push(buildAuthSnippet(authKey));\n          }\n\n          delete headers[header];\n          return;\n        } else if (headerLower === 'content-type') {\n          // `Content-Type` headers are automatically added within the SDK so we can filter them out\n          // if they don't have parameters attached to them.\n          // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.\n          const parsedContentType = contentType.parse(headers[header]);\n          if (!Object.keys(parsedContentType.parameters).length) {\n            delete headers[header];\n            return;\n          }\n        } else if (headerLower === 'accept') {\n          // If the `Accept` header here is JSON-like header then we can remove it from the code\n          // snippet because `api` natively supports and prioritizes JSON over any other mime type.\n          if (matchesMimeType.json(headers[header] as string)) {\n            delete headers[header];\n            return;\n          }\n        }\n\n        // If we haven't used our header anywhere else, or we've deleted it from the payload\n        // because it'll be handled internally by `api` then we should add the lowercased version\n        // of our header into the generated code snippet.\n        requestHeaders[headerLower] = headers[header];\n      });\n\n      if (Object.keys(requestHeaders).length > 0) {\n        metadata = Object.assign(metadata, requestHeaders);\n      }\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    let body: any;\n    switch (postData.mimeType) {\n      case 'application/x-www-form-urlencoded':\n        body = postData.paramsObj;\n        break;\n\n      case 'application/json':\n        if (postData.jsonObj) {\n          body = postData.jsonObj;\n        }\n        break;\n\n      case 'multipart/form-data':\n        if (postData.params) {\n          body = {};\n\n          // If there's a `Content-Type` header present in the metadata, but it's for the\n          // `multipart/form-data` request then dump it off the snippet. We shouldn't offload that\n          // unnecessary bloat of multipart boundaries to the user, instead letting the SDK handle it\n          // automatically.\n          if ('content-type' in metadata && metadata['content-type'].indexOf('multipart/form-data') === 0) {\n            delete metadata['content-type'];\n          }\n\n          postData.params.forEach(param => {\n            if (param.fileName) {\n              body[param.name] = param.fileName;\n            } else {\n              body[param.name] = param.value;\n            }\n          });\n        }\n        break;\n\n      default:\n        if (postData.text) {\n          body = postData.text;\n        }\n    }\n\n    const args = [];\n\n    const accessor = operation.getOperationId({ camelCase: true });\n\n    // If we're going to be rendering out body params and metadata we should cut their character\n    // limit in half because we'll be rendering them in their own lines.\n    const inlineCharacterLimit = typeof body !== 'undefined' && Object.keys(metadata).length > 0 ? 40 : 80;\n    if (typeof body !== 'undefined') {\n      args.push(stringify(body, { inlineCharacterLimit }));\n    }\n\n    if (Object.keys(metadata).length > 0) {\n      args.push(stringify(metadata, { inlineCharacterLimit }));\n    }\n\n    if (authData.length) {\n      push(authData.join('\\n'));\n    }\n\n    if (configData.length) {\n      push(configData.join('\\n'));\n    }\n\n    push(`sdk.${accessor}(${args.join(', ')})`);\n    push('.then(({ data }) => console.log(data))', 1);\n    push('.catch(err => console.error(err));', 1);\n\n    return join();\n  },\n};\n\nexport default client;\n"]}

package/dist/index.d.cts

@@ -0,0 +1,12 @@
+import { Client } from '@readme/httpsnippet/targets';
+import { OASDocument } from 'oas/rmoas.types';
+
+interface APIOptions {
+    apiDefinition: OASDocument;
+    apiDefinitionUri: string;
+    escapeBrackets?: boolean;
+    indent?: string | false;
+}
+declare const client: Client<APIOptions>;
+
+export = client;

package/dist/index.d.ts

@@ -1,10 +1,12 @@
-import type { Client } from '@readme/httpsnippet/dist/targets/targets';
-import type { OASDocument } from 'oas/dist/rmoas.types';
-export interface APIOptions {
+import { Client } from '@readme/httpsnippet/targets';
+import { OASDocument } from 'oas/rmoas.types';
+
+interface APIOptions {
     apiDefinition: OASDocument;
     apiDefinitionUri: string;
     escapeBrackets?: boolean;
     indent?: string | false;
 }
 declare const client: Client<APIOptions>;
-export default client;
+
+export { client as default };

package/dist/index.js

@@ -1,292 +1,218 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-exports.__esModule = true;
-var code_builder_1 = require("@readme/httpsnippet/dist/helpers/code-builder");
-var content_type_1 = __importDefault(require("content-type"));
-var oas_1 = __importDefault(require("oas"));
-var stringify_object_1 = __importDefault(require("stringify-object"));
-function stringify(obj, opts) {
-    if (opts === void 0) { opts = {}; }
-    return (0, stringify_object_1["default"])(obj, __assign({ indent: '  ' }, opts));
+// src/index.ts
+import { CodeBuilder } from "@readme/httpsnippet/helpers/code-builder";
+import contentType from "content-type";
+import Oas from "oas";
+import { matchesMimeType } from "oas/utils";
+import stringifyObject from "stringify-object";
+function stringify(obj, opts = {}) {
+  return stringifyObject(obj, { indent: "  ", ...opts });
 }
 function buildAuthSnippet(authKey) {
-    // Auth key will be an array for Basic auth cases.
-    if (Array.isArray(authKey)) {
-        var auth_1 = [];
-        authKey.forEach(function (token, i) {
-            // If the token part is the last part of the key and it's empty, don't add it to the snippet.
-            if (token.length === 0 && authKey.length > 1 && i === authKey.length - 1) {
-                return;
-            }
-            auth_1.push("'".concat(token.replace(/'/g, "\\'"), "'"));
-        });
-        return "sdk.auth(".concat(auth_1.join(', '), ");");
-    }
-    return "sdk.auth('".concat(authKey.replace(/'/g, "\\'"), "');");
+  if (Array.isArray(authKey)) {
+    const auth = [];
+    authKey.forEach((token, i) => {
+      if (token.length === 0 && authKey.length > 1 && i === authKey.length - 1) {
+        return;
+      }
+      auth.push(`'${token.replace(/'/g, "\\'")}'`);
+    });
+    return `sdk.auth(${auth.join(", ")});`;
+  }
+  return `sdk.auth('${authKey.replace(/'/g, "\\'")}');`;
 }
 function getAuthSources(operation) {
-    var matchers = {
-        header: {},
-        query: [],
-        cookie: []
-    };
-    if (operation.getSecurity().length === 0) {
-        return matchers;
-    }
-    var security = operation.prepareSecurity();
-    Object.keys(security).forEach(function (id) {
-        security[id].forEach(function (scheme) {
-            if (scheme.type === 'http') {
-                if (scheme.scheme === 'basic') {
-                    matchers.header.authorization = 'Basic';
-                }
-                else if (scheme.scheme === 'bearer') {
-                    matchers.header.authorization = 'Bearer';
-                }
-            }
-            else if (scheme.type === 'oauth2') {
-                matchers.header.authorization = 'Bearer';
-            }
-            else if (scheme.type === 'apiKey') {
-                if (scheme["in"] === 'query') {
-                    matchers.query.push(scheme.name);
-                }
-                else if (scheme["in"] === 'header') {
-                    // The way that this asterisk header matcher works is that since this `apiKey` goes in a
-                    // named header (`scheme.name`) because the header is the key, we're matching against the
-                    // entire header -- counter to the way that the HTTP basic matcher above works where we
-                    // match and extract the API key from everything after `Basic ` in the `Authorization`
-                    // header.
-                    matchers.header[scheme.name.toLowerCase()] = '*';
-                }
-                else if (scheme["in"] === 'cookie') {
-                    matchers.cookie.push(scheme.name);
-                }
-            }
-        });
-    });
+  const matchers = {
+    header: {},
+    query: [],
+    cookie: []
+  };
+  if (operation.getSecurity().length === 0) {
     return matchers;
-}
-var client = {
-    info: {
-        key: 'api',
-        title: 'API',
-        link: 'https://npm.im/api',
-        description: 'Automatic SDK generation from an OpenAPI definition.'
-    },
-    convert: function (_a, options) {
-        var cookiesObj = _a.cookiesObj, headersObj = _a.headersObj, postData = _a.postData, queryObj = _a.queryObj, url = _a.url, source = __rest(_a, ["cookiesObj", "headersObj", "postData", "queryObj", "url"]);
-        var opts = __assign({}, options);
-        if (!('apiDefinitionUri' in opts)) {
-            throw new Error('This HTTP Snippet client must have an `apiDefinitionUri` option supplied to it.');
+  }
+  Object.entries(operation.prepareSecurity()).forEach(([, schemes]) => {
+    schemes.forEach((scheme) => {
+      if (scheme.type === "http") {
+        if (scheme.scheme === "basic") {
+          matchers.header.authorization = "Basic";
+        } else if (scheme.scheme === "bearer") {
+          matchers.header.authorization = "Bearer";
         }
-        else if (!('apiDefinition' in opts)) {
-            throw new Error('This HTTP Snippet client must have an `apiDefinition` option supplied to it.');
+      } else if (scheme.type === "oauth2") {
+        matchers.header.authorization = "Bearer";
+      } else if (scheme.type === "apiKey") {
+        if (scheme.in === "query") {
+          matchers.query.push(scheme.name);
+        } else if (scheme.in === "header") {
+          matchers.header[scheme.name.toLowerCase()] = "*";
+        } else if (scheme.in === "cookie") {
+          matchers.cookie.push(scheme.name);
         }
-        var method = source.method.toLowerCase();
-        var oas = new oas_1["default"](opts.apiDefinition);
-        var apiDefinition = oas.getDefinition();
-        var foundOperation = oas.findOperation(url, method);
-        if (!foundOperation) {
-            throw new Error("Unable to locate a matching operation in the supplied `apiDefinition` for: ".concat(source.method, " ").concat(url));
-        }
-        var operationSlugs = foundOperation.url.slugs;
-        var operation = oas.operation(foundOperation.url.nonNormalizedPath, method);
-        var operationPathParameters = operation.getParameters().filter(function (param) { return param["in"] === 'path'; });
-        var path = operation.path;
-        var authData = [];
-        var authSources = getAuthSources(operation);
-        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent || '  ' }), blank = _b.blank, push = _b.push, join = _b.join;
-        push("const sdk = require('api')('".concat(opts.apiDefinitionUri, "');"));
-        blank();
-        // If we have multiple servers configured and our source URL differs from the stock URL that we
-        // receive from our `oas` library then the URL either has server variables contained in it (that
-        // don't match the defaults), or the OAS offers alternate server URLs and we should expose that
-        // in the generated snippet.
-        var configData = [];
-        if ((apiDefinition.servers || []).length > 1) {
-            var stockUrl = oas.url();
-            var baseUrl = url.replace(path, '');
-            if (baseUrl !== stockUrl) {
-                var serverVars = oas.splitVariables(baseUrl);
-                var serverUrl = serverVars ? oas.url(serverVars.selected, serverVars.variables) : baseUrl;
-                configData.push("sdk.server('".concat(serverUrl, "');"));
-            }
-        }
-        var metadata = {};
-        Object.keys(queryObj).forEach(function (param) {
-            if (authSources.query.includes(param)) {
-                authData.push(buildAuthSnippet(queryObj[param]));
-                // If this query param is part of an auth source then we don't want it doubled up in the
-                // snippet.
-                return;
-            }
-            metadata[param] = queryObj[param];
-        });
-        Object.keys(cookiesObj).forEach(function (cookie) {
-            if (authSources.cookie.includes(cookie)) {
-                authData.push(buildAuthSnippet(cookiesObj[cookie]));
-                // If this cookie is part of an auth source then we don't want it doubled up.
-                return;
-            }
-            // Note that we may have the potential to overlap any cookie that also shares the name as
-            // another metadata parameter. This problem is currently inherent to `api` and not this
-            // snippet generator.
-            metadata[cookie] = cookiesObj[cookie];
-        });
-        // If we have path parameters present we should add them into the metadata object.
-        Array.from(Object.entries(operationSlugs)).forEach(function (_a) {
-            var param = _a[0], value = _a[1];
-            // The keys in `operationSlugs` will always be prefixed with a `:` in the `oas` library so
-            // we can safely do this substring here without asserting this context.
-            var cleanedParam = param.substring(1);
-            // If our incoming path slug out of `oas.findOperation()` has been sanitized and is missing
-            // a hyphen, but there is a parameter in the OpenAPI definition that matches what our
-            // hyphen-less slug is then we should use that for the snippet.
-            var unsanitizedParam = operationPathParameters.find(function (p) {
-                return p.name.includes('-') && p.name.replace(/-/g, '') === cleanedParam ? p.name : false;
-            });
-            if (unsanitizedParam) {
-                metadata[unsanitizedParam.name] = value;
-            }
-            else {
-                metadata[cleanedParam] = value;
-            }
-        });
-        if (Object.keys(headersObj).length) {
-            var headers_1 = headersObj;
-            var requestHeaders_1 = {};
-            Object.keys(headers_1).forEach(function (header) {
-                // Headers in HTTPSnippet are case-insensitive so we need to add in some special handling to
-                // make sure we're able to match them properly.
-                var headerLower = header.toLowerCase();
-                if (headerLower in authSources.header) {
-                    // If this header has been set up as an authentication header, let's remove it and add it
-                    // into our auth data so we can build up an `.auth()` snippet for the SDK.
-                    var authScheme = authSources.header[headerLower];
-                    if (authScheme === '*') {
-                        authData.push(buildAuthSnippet(headers_1[header]));
-                    }
-                    else {
-                        // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.
-                        var authKey = headers_1[header].replace("".concat(authSources.header[headerLower], " "), '');
-                        if (authScheme.toLowerCase() === 'basic') {
-                            authKey = Buffer.from(authKey, 'base64').toString('ascii');
-                            authKey = authKey.split(':');
-                        }
-                        authData.push(buildAuthSnippet(authKey));
-                    }
-                    delete headers_1[header];
-                    return;
-                }
-                else if (headerLower === 'content-type') {
-                    // `Content-Type` headers are automatically added within the SDK so we can filter them out
-                    // if they don't have parameters attached to them.
-                    // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.
-                    var parsedContentType = content_type_1["default"].parse(headers_1[header]);
-                    if (!Object.keys(parsedContentType.parameters).length) {
-                        delete headers_1[header];
-                        return;
-                    }
-                }
-                else if (headerLower === 'accept') {
-                    // If the `Accept` header here is not the default or first `Accept` header for the
-                    // operations' request body then we should add it otherwise we can let the SDK handle it
-                    // itself.
-                    if (headers_1[header] === operation.getContentType()) {
-                        delete headers_1[header];
-                        return;
-                    }
-                }
-                // If we haven't used our header anywhere else, or we've deleted it from the payload
-                // because it'll be handled internally by `api` then we should add the lowercased version
-                // of our header into the generated code snippet.
-                requestHeaders_1[headerLower] = headers_1[header];
-            });
-            if (Object.keys(requestHeaders_1).length > 0) {
-                metadata = Object.assign(metadata, requestHeaders_1);
+      }
+    });
+  });
+  return matchers;
+}
+var client = {
+  info: {
+    key: "api",
+    title: "API",
+    link: "https://npm.im/api",
+    description: "Automatic SDK generation from an OpenAPI definition.",
+    extname: ".js"
+  },
+  convert: ({ cookiesObj, headersObj, postData, queryObj, url, ...source }, options) => {
+    const opts = {
+      ...options
+    };
+    if (!("apiDefinitionUri" in opts)) {
+      throw new Error("This HTTP Snippet client must have an `apiDefinitionUri` option supplied to it.");
+    } else if (!("apiDefinition" in opts)) {
+      throw new Error("This HTTP Snippet client must have an `apiDefinition` option supplied to it.");
+    }
+    const method = source.method.toLowerCase();
+    const oas = new Oas(opts.apiDefinition);
+    const apiDefinition = oas.getDefinition();
+    const foundOperation = oas.findOperation(url, method);
+    if (!foundOperation) {
+      throw new Error(
+        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${url}`
+      );
+    }
+    const operationSlugs = foundOperation.url.slugs;
+    const operation = oas.operation(foundOperation.url.nonNormalizedPath, method);
+    const operationPathParameters = operation.getParameters().filter((param) => param.in === "path");
+    const path = operation.path;
+    const authData = [];
+    const authSources = getAuthSources(operation);
+    const { blank, push, join } = new CodeBuilder({ indent: opts.indent || "  " });
+    push(`const sdk = require('api')('${opts.apiDefinitionUri}');`);
+    blank();
+    const configData = [];
+    if ((apiDefinition.servers || []).length > 1) {
+      const stockUrl = oas.url();
+      const baseUrl = url.replace(path, "");
+      if (baseUrl !== stockUrl) {
+        const serverVars = oas.splitVariables(baseUrl);
+        const serverUrl = serverVars ? oas.url(serverVars.selected, serverVars.variables) : baseUrl;
+        configData.push(`sdk.server('${serverUrl}');`);
+      }
+    }
+    let metadata = {};
+    Object.keys(queryObj).forEach((param) => {
+      if (authSources.query.includes(param)) {
+        authData.push(buildAuthSnippet(queryObj[param]));
+        return;
+      }
+      metadata[param] = queryObj[param];
+    });
+    Object.keys(cookiesObj).forEach((cookie) => {
+      if (authSources.cookie.includes(cookie)) {
+        authData.push(buildAuthSnippet(cookiesObj[cookie]));
+        return;
+      }
+      metadata[cookie] = cookiesObj[cookie];
+    });
+    Array.from(Object.entries(operationSlugs)).forEach(([param, value]) => {
+      const cleanedParam = param.substring(1);
+      const unsanitizedParam = operationPathParameters.find((p) => {
+        return p.name.includes("-") && p.name.replace(/-/g, "") === cleanedParam ? p.name : false;
+      });
+      if (unsanitizedParam) {
+        metadata[unsanitizedParam.name] = value;
+      } else {
+        metadata[cleanedParam] = value;
+      }
+    });
+    if (Object.keys(headersObj).length) {
+      const headers = headersObj;
+      const requestHeaders = {};
+      Object.keys(headers).forEach((header) => {
+        const headerLower = header.toLowerCase();
+        if (headerLower in authSources.header) {
+          const authScheme = authSources.header[headerLower];
+          if (authScheme === "*") {
+            authData.push(buildAuthSnippet(headers[header]));
+          } else {
+            let authKey = headers[header].replace(`${authSources.header[headerLower]} `, "");
+            if (authScheme.toLowerCase() === "basic") {
+              authKey = Buffer.from(authKey, "base64").toString("ascii");
+              authKey = authKey.split(":");
             }
+            authData.push(buildAuthSnippet(authKey));
+          }
+          delete headers[header];
+          return;
+        } else if (headerLower === "content-type") {
+          const parsedContentType = contentType.parse(headers[header]);
+          if (!Object.keys(parsedContentType.parameters).length) {
+            delete headers[header];
+            return;
+          }
+        } else if (headerLower === "accept") {
+          if (matchesMimeType.json(headers[header])) {
+            delete headers[header];
+            return;
+          }
         }
-        var body;
-        switch (postData.mimeType) {
-            case 'application/x-www-form-urlencoded':
-                body = postData.paramsObj;
-                break;
-            case 'application/json':
-                if (postData.jsonObj) {
-                    body = postData.jsonObj;
-                }
-                break;
-            case 'multipart/form-data':
-                if (postData.params) {
-                    body = {};
-                    // If there's a `Content-Type` header present in the metadata, but it's for the
-                    // `multipart/form-data` request then dump it off the snippet. We shouldn't offload that
-                    // unnecessary bloat of multipart boundaries to the user, instead letting the SDK handle it
-                    // automatically.
-                    if ('content-type' in metadata && metadata['content-type'].indexOf('multipart/form-data') === 0) {
-                        delete metadata['content-type'];
-                    }
-                    postData.params.forEach(function (param) {
-                        if (param.fileName) {
-                            body[param.name] = param.fileName;
-                        }
-                        else {
-                            body[param.name] = param.value;
-                        }
-                    });
-                }
-                break;
-            default:
-                if (postData.text) {
-                    body = postData.text;
-                }
-        }
-        var args = [];
-        var accessor = operation.getOperationId({ camelCase: true });
-        // If we're going to be rendering out body params and metadata we should cut their character
-        // limit in half because we'll be rendering them in their own lines.
-        var inlineCharacterLimit = typeof body !== 'undefined' && Object.keys(metadata).length > 0 ? 40 : 80;
-        if (typeof body !== 'undefined') {
-            args.push(stringify(body, { inlineCharacterLimit: inlineCharacterLimit }));
-        }
-        if (Object.keys(metadata).length > 0) {
-            args.push(stringify(metadata, { inlineCharacterLimit: inlineCharacterLimit }));
+        requestHeaders[headerLower] = headers[header];
+      });
+      if (Object.keys(requestHeaders).length > 0) {
+        metadata = Object.assign(metadata, requestHeaders);
+      }
+    }
+    let body;
+    switch (postData.mimeType) {
+      case "application/x-www-form-urlencoded":
+        body = postData.paramsObj;
+        break;
+      case "application/json":
+        if (postData.jsonObj) {
+          body = postData.jsonObj;
         }
-        if (authData.length) {
-            push(authData.join('\n'));
+        break;
+      case "multipart/form-data":
+        if (postData.params) {
+          body = {};
+          if ("content-type" in metadata && metadata["content-type"].indexOf("multipart/form-data") === 0) {
+            delete metadata["content-type"];
+          }
+          postData.params.forEach((param) => {
+            if (param.fileName) {
+              body[param.name] = param.fileName;
+            } else {
+              body[param.name] = param.value;
+            }
+          });
         }
-        if (configData.length) {
-            push(configData.join('\n'));
+        break;
+      default:
+        if (postData.text) {
+          body = postData.text;
         }
-        push("sdk.".concat(accessor, "(").concat(args.join(', '), ")"));
-        push('.then(({ data }) => console.log(data))', 1);
-        push('.catch(err => console.error(err));', 1);
-        return join();
     }
+    const args = [];
+    const accessor = operation.getOperationId({ camelCase: true });
+    const inlineCharacterLimit = typeof body !== "undefined" && Object.keys(metadata).length > 0 ? 40 : 80;
+    if (typeof body !== "undefined") {
+      args.push(stringify(body, { inlineCharacterLimit }));
+    }
+    if (Object.keys(metadata).length > 0) {
+      args.push(stringify(metadata, { inlineCharacterLimit }));
+    }
+    if (authData.length) {
+      push(authData.join("\n"));
+    }
+    if (configData.length) {
+      push(configData.join("\n"));
+    }
+    push(`sdk.${accessor}(${args.join(", ")})`);
+    push(".then(({ data }) => console.log(data))", 1);
+    push(".catch(err => console.error(err));", 1);
+    return join();
+  }
+};
+var src_default = client;
+export {
+  src_default as default
 };
-exports["default"] = client;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { ReducedHelperObject } from '@readme/httpsnippet/helpers/reducer';\nimport type { Client } from '@readme/httpsnippet/targets';\nimport type Operation from 'oas/operation';\nimport type { HttpMethods, OASDocument } from 'oas/rmoas.types';\n\nimport { CodeBuilder } from '@readme/httpsnippet/helpers/code-builder';\nimport contentType from 'content-type';\nimport Oas from 'oas';\nimport { matchesMimeType } from 'oas/utils';\nimport stringifyObject from 'stringify-object';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nfunction stringify(obj: any, opts = {}) {\n  return stringifyObject(obj, { indent: '  ', ...opts });\n}\n\nfunction buildAuthSnippet(authKey: string | string[]) {\n  // Auth key will be an array for Basic auth cases.\n  if (Array.isArray(authKey)) {\n    const auth: string[] = [];\n    authKey.forEach((token, i) => {\n      // If the token part is the last part of the key and it's empty, don't add it to the snippet.\n      if (token.length === 0 && authKey.length > 1 && i === authKey.length - 1) {\n        return;\n      }\n\n      auth.push(`'${token.replace(/'/g, \"\\\\'\")}'`);\n    });\n\n    return `sdk.auth(${auth.join(', ')});`;\n  }\n\n  return `sdk.auth('${authKey.replace(/'/g, \"\\\\'\")}');`;\n}\n\nfunction getAuthSources(operation: Operation) {\n  const matchers: { cookie: string[]; header: Record<string, string>; query: string[] } = {\n    header: {},\n    query: [],\n    cookie: [],\n  };\n\n  if (operation.getSecurity().length === 0) {\n    return matchers;\n  }\n\n  Object.entries(operation.prepareSecurity()).forEach(([, schemes]) => {\n    schemes.forEach(scheme => {\n      if (scheme.type === 'http') {\n        if (scheme.scheme === 'basic') {\n          matchers.header.authorization = 'Basic';\n        } else if (scheme.scheme === 'bearer') {\n          matchers.header.authorization = 'Bearer';\n        }\n      } else if (scheme.type === 'oauth2') {\n        matchers.header.authorization = 'Bearer';\n      } else if (scheme.type === 'apiKey') {\n        if (scheme.in === 'query') {\n          matchers.query.push(scheme.name);\n        } else if (scheme.in === 'header') {\n          // The way that this asterisk header matcher works is that since this `apiKey` goes in a\n          // named header (`scheme.name`) because the header is the key, we're matching against the\n          // entire header -- counter to the way that the HTTP basic matcher above works where we\n          // match and extract the API key from everything after `Basic ` in the `Authorization`\n          // header.\n          matchers.header[scheme.name.toLowerCase()] = '*';\n        } else if (scheme.in === 'cookie') {\n          matchers.cookie.push(scheme.name);\n        }\n      }\n    });\n  });\n\n  return matchers;\n}\n\ninterface APIOptions {\n  apiDefinition: OASDocument;\n  apiDefinitionUri: string;\n  escapeBrackets?: boolean;\n  indent?: string | false;\n}\n\nconst client: Client<APIOptions> = {\n  info: {\n    key: 'api',\n    title: 'API',\n    link: 'https://npm.im/api',\n    description: 'Automatic SDK generation from an OpenAPI definition.',\n    extname: '.js',\n  },\n  convert: ({ cookiesObj, headersObj, postData, queryObj, url, ...source }, options) => {\n    const opts = {\n      ...options,\n    } as APIOptions;\n\n    if (!('apiDefinitionUri' in opts)) {\n      throw new Error('This HTTP Snippet client must have an `apiDefinitionUri` option supplied to it.');\n    } else if (!('apiDefinition' in opts)) {\n      throw new Error('This HTTP Snippet client must have an `apiDefinition` option supplied to it.');\n    }\n\n    const method = source.method.toLowerCase() as HttpMethods;\n    const oas = new Oas(opts.apiDefinition);\n    const apiDefinition = oas.getDefinition();\n    const foundOperation = oas.findOperation(url, method);\n    if (!foundOperation) {\n      throw new Error(\n        `Unable to locate a matching operation in the supplied \\`apiDefinition\\` for: ${source.method} ${url}`,\n      );\n    }\n\n    const operationSlugs = foundOperation.url.slugs;\n    const operation = oas.operation(foundOperation.url.nonNormalizedPath, method);\n    const operationPathParameters = operation.getParameters().filter(param => param.in === 'path');\n    const path = operation.path;\n    const authData: string[] = [];\n    const authSources = getAuthSources(operation);\n\n    const { blank, push, join } = new CodeBuilder({ indent: opts.indent || '  ' });\n\n    push(`const sdk = require('api')('${opts.apiDefinitionUri}');`);\n    blank();\n\n    // If we have multiple servers configured and our source URL differs from the stock URL that we\n    // receive from our `oas` library then the URL either has server variables contained in it (that\n    // don't match the defaults), or the OAS offers alternate server URLs and we should expose that\n    // in the generated snippet.\n    const configData = [];\n    if ((apiDefinition.servers || []).length > 1) {\n      const stockUrl = oas.url();\n      const baseUrl = url.replace(path, '');\n      if (baseUrl !== stockUrl) {\n        const serverVars = oas.splitVariables(baseUrl);\n        const serverUrl = serverVars ? oas.url(serverVars.selected, serverVars.variables) : baseUrl;\n\n        configData.push(`sdk.server('${serverUrl}');`);\n      }\n    }\n\n    let metadata: Record<string, string | string[]> = {};\n    Object.keys(queryObj).forEach(param => {\n      if (authSources.query.includes(param)) {\n        authData.push(buildAuthSnippet(queryObj[param]));\n\n        // If this query param is part of an auth source then we don't want it doubled up in the\n        // snippet.\n        return;\n      }\n\n      metadata[param] = queryObj[param];\n    });\n\n    Object.keys(cookiesObj).forEach(cookie => {\n      if (authSources.cookie.includes(cookie)) {\n        authData.push(buildAuthSnippet(cookiesObj[cookie]));\n\n        // If this cookie is part of an auth source then we don't want it doubled up.\n        return;\n      }\n\n      // Note that we may have the potential to overlap any cookie that also shares the name as\n      // another metadata parameter. This problem is currently inherent to `api` and not this\n      // snippet generator.\n      metadata[cookie] = cookiesObj[cookie];\n    });\n\n    // If we have path parameters present we should add them into the metadata object.\n    Array.from(Object.entries(operationSlugs)).forEach(([param, value]) => {\n      // The keys in `operationSlugs` will always be prefixed with a `:` in the `oas` library so\n      // we can safely do this substring here without asserting this context.\n      const cleanedParam = param.substring(1);\n\n      // If our incoming path slug out of `oas.findOperation()` has been sanitized and is missing\n      // a hyphen, but there is a parameter in the OpenAPI definition that matches what our\n      // hyphen-less slug is then we should use that for the snippet.\n      const unsanitizedParam = operationPathParameters.find(p => {\n        return p.name.includes('-') && p.name.replace(/-/g, '') === cleanedParam ? p.name : false;\n      });\n\n      if (unsanitizedParam) {\n        metadata[unsanitizedParam.name] = value;\n      } else {\n        metadata[cleanedParam] = value;\n      }\n    });\n\n    if (Object.keys(headersObj).length) {\n      const headers = headersObj;\n      const requestHeaders: ReducedHelperObject = {};\n\n      Object.keys(headers).forEach(header => {\n        // Headers in HTTPSnippet are case-insensitive so we need to add in some special handling to\n        // make sure we're able to match them properly.\n        const headerLower = header.toLowerCase();\n\n        if (headerLower in authSources.header) {\n          // If this header has been set up as an authentication header, let's remove it and add it\n          // into our auth data so we can build up an `.auth()` snippet for the SDK.\n          const authScheme = authSources.header[headerLower];\n          if (authScheme === '*') {\n            authData.push(buildAuthSnippet(headers[header]));\n          } else {\n            // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.\n            let authKey = headers[header].replace(`${authSources.header[headerLower]} `, '');\n            if (authScheme.toLowerCase() === 'basic') {\n              authKey = Buffer.from(authKey, 'base64').toString('ascii');\n              authKey = authKey.split(':');\n            }\n\n            authData.push(buildAuthSnippet(authKey));\n          }\n\n          delete headers[header];\n          return;\n        } else if (headerLower === 'content-type') {\n          // `Content-Type` headers are automatically added within the SDK so we can filter them out\n          // if they don't have parameters attached to them.\n          // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.\n          const parsedContentType = contentType.parse(headers[header]);\n          if (!Object.keys(parsedContentType.parameters).length) {\n            delete headers[header];\n            return;\n          }\n        } else if (headerLower === 'accept') {\n          // If the `Accept` header here is JSON-like header then we can remove it from the code\n          // snippet because `api` natively supports and prioritizes JSON over any other mime type.\n          if (matchesMimeType.json(headers[header] as string)) {\n            delete headers[header];\n            return;\n          }\n        }\n\n        // If we haven't used our header anywhere else, or we've deleted it from the payload\n        // because it'll be handled internally by `api` then we should add the lowercased version\n        // of our header into the generated code snippet.\n        requestHeaders[headerLower] = headers[header];\n      });\n\n      if (Object.keys(requestHeaders).length > 0) {\n        metadata = Object.assign(metadata, requestHeaders);\n      }\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    let body: any;\n    switch (postData.mimeType) {\n      case 'application/x-www-form-urlencoded':\n        body = postData.paramsObj;\n        break;\n\n      case 'application/json':\n        if (postData.jsonObj) {\n          body = postData.jsonObj;\n        }\n        break;\n\n      case 'multipart/form-data':\n        if (postData.params) {\n          body = {};\n\n          // If there's a `Content-Type` header present in the metadata, but it's for the\n          // `multipart/form-data` request then dump it off the snippet. We shouldn't offload that\n          // unnecessary bloat of multipart boundaries to the user, instead letting the SDK handle it\n          // automatically.\n          if ('content-type' in metadata && metadata['content-type'].indexOf('multipart/form-data') === 0) {\n            delete metadata['content-type'];\n          }\n\n          postData.params.forEach(param => {\n            if (param.fileName) {\n              body[param.name] = param.fileName;\n            } else {\n              body[param.name] = param.value;\n            }\n          });\n        }\n        break;\n\n      default:\n        if (postData.text) {\n          body = postData.text;\n        }\n    }\n\n    const args = [];\n\n    const accessor = operation.getOperationId({ camelCase: true });\n\n    // If we're going to be rendering out body params and metadata we should cut their character\n    // limit in half because we'll be rendering them in their own lines.\n    const inlineCharacterLimit = typeof body !== 'undefined' && Object.keys(metadata).length > 0 ? 40 : 80;\n    if (typeof body !== 'undefined') {\n      args.push(stringify(body, { inlineCharacterLimit }));\n    }\n\n    if (Object.keys(metadata).length > 0) {\n      args.push(stringify(metadata, { inlineCharacterLimit }));\n    }\n\n    if (authData.length) {\n      push(authData.join('\\n'));\n    }\n\n    if (configData.length) {\n      push(configData.join('\\n'));\n    }\n\n    push(`sdk.${accessor}(${args.join(', ')})`);\n    push('.then(({ data }) => console.log(data))', 1);\n    push('.catch(err => console.error(err));', 1);\n\n    return join();\n  },\n};\n\nexport default client;\n"],"mappings":";AAKA,SAAS,mBAAmB;AAC5B,OAAO,iBAAiB;AACxB,OAAO,SAAS;AAChB,SAAS,uBAAuB;AAChC,OAAO,qBAAqB;AAG5B,SAAS,UAAU,KAAU,OAAO,CAAC,GAAG;AACtC,SAAO,gBAAgB,KAAK,EAAE,QAAQ,MAAM,GAAG,KAAK,CAAC;AACvD;AAEA,SAAS,iBAAiB,SAA4B;AAEpD,MAAI,MAAM,QAAQ,OAAO,GAAG;AAC1B,UAAM,OAAiB,CAAC;AACxB,YAAQ,QAAQ,CAAC,OAAO,MAAM;AAE5B,UAAI,MAAM,WAAW,KAAK,QAAQ,SAAS,KAAK,MAAM,QAAQ,SAAS,GAAG;AACxE;AAAA,MACF;AAEA,WAAK,KAAK,IAAI,MAAM,QAAQ,MAAM,KAAK,CAAC,GAAG;AAAA,IAC7C,CAAC;AAED,WAAO,YAAY,KAAK,KAAK,IAAI,CAAC;AAAA,EACpC;AAEA,SAAO,aAAa,QAAQ,QAAQ,MAAM,KAAK,CAAC;AAClD;AAEA,SAAS,eAAe,WAAsB;AAC5C,QAAM,WAAkF;AAAA,IACtF,QAAQ,CAAC;AAAA,IACT,OAAO,CAAC;AAAA,IACR,QAAQ,CAAC;AAAA,EACX;AAEA,MAAI,UAAU,YAAY,EAAE,WAAW,GAAG;AACxC,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,UAAU,gBAAgB,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,MAAM;AACnE,YAAQ,QAAQ,YAAU;AACxB,UAAI,OAAO,SAAS,QAAQ;AAC1B,YAAI,OAAO,WAAW,SAAS;AAC7B,mBAAS,OAAO,gBAAgB;AAAA,QAClC,WAAW,OAAO,WAAW,UAAU;AACrC,mBAAS,OAAO,gBAAgB;AAAA,QAClC;AAAA,MACF,WAAW,OAAO,SAAS,UAAU;AACnC,iBAAS,OAAO,gBAAgB;AAAA,MAClC,WAAW,OAAO,SAAS,UAAU;AACnC,YAAI,OAAO,OAAO,SAAS;AACzB,mBAAS,MAAM,KAAK,OAAO,IAAI;AAAA,QACjC,WAAW,OAAO,OAAO,UAAU;AAMjC,mBAAS,OAAO,OAAO,KAAK,YAAY,CAAC,IAAI;AAAA,QAC/C,WAAW,OAAO,OAAO,UAAU;AACjC,mBAAS,OAAO,KAAK,OAAO,IAAI;AAAA,QAClC;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,SAAO;AACT;AASA,IAAM,SAA6B;AAAA,EACjC,MAAM;AAAA,IACJ,KAAK;AAAA,IACL,OAAO;AAAA,IACP,MAAM;AAAA,IACN,aAAa;AAAA,IACb,SAAS;AAAA,EACX;AAAA,EACA,SAAS,CAAC,EAAE,YAAY,YAAY,UAAU,UAAU,KAAK,GAAG,OAAO,GAAG,YAAY;AACpF,UAAM,OAAO;AAAA,MACX,GAAG;AAAA,IACL;AAEA,QAAI,EAAE,sBAAsB,OAAO;AACjC,YAAM,IAAI,MAAM,iFAAiF;AAAA,IACnG,WAAW,EAAE,mBAAmB,OAAO;AACrC,YAAM,IAAI,MAAM,8EAA8E;AAAA,IAChG;AAEA,UAAM,SAAS,OAAO,OAAO,YAAY;AACzC,UAAM,MAAM,IAAI,IAAI,KAAK,aAAa;AACtC,UAAM,gBAAgB,IAAI,cAAc;AACxC,UAAM,iBAAiB,IAAI,cAAc,KAAK,MAAM;AACpD,QAAI,CAAC,gBAAgB;AACnB,YAAM,IAAI;AAAA,QACR,gFAAgF,OAAO,MAAM,IAAI,GAAG;AAAA,MACtG;AAAA,IACF;AAEA,UAAM,iBAAiB,eAAe,IAAI;AAC1C,UAAM,YAAY,IAAI,UAAU,eAAe,IAAI,mBAAmB,MAAM;AAC5E,UAAM,0BAA0B,UAAU,cAAc,EAAE,OAAO,WAAS,MAAM,OAAO,MAAM;AAC7F,UAAM,OAAO,UAAU;AACvB,UAAM,WAAqB,CAAC;AAC5B,UAAM,cAAc,eAAe,SAAS;AAE5C,UAAM,EAAE,OAAO,MAAM,KAAK,IAAI,IAAI,YAAY,EAAE,QAAQ,KAAK,UAAU,KAAK,CAAC;AAE7E,SAAK,+BAA+B,KAAK,gBAAgB,KAAK;AAC9D,UAAM;AAMN,UAAM,aAAa,CAAC;AACpB,SAAK,cAAc,WAAW,CAAC,GAAG,SAAS,GAAG;AAC5C,YAAM,WAAW,IAAI,IAAI;AACzB,YAAM,UAAU,IAAI,QAAQ,MAAM,EAAE;AACpC,UAAI,YAAY,UAAU;AACxB,cAAM,aAAa,IAAI,eAAe,OAAO;AAC7C,cAAM,YAAY,aAAa,IAAI,IAAI,WAAW,UAAU,WAAW,SAAS,IAAI;AAEpF,mBAAW,KAAK,eAAe,SAAS,KAAK;AAAA,MAC/C;AAAA,IACF;AAEA,QAAI,WAA8C,CAAC;AACnD,WAAO,KAAK,QAAQ,EAAE,QAAQ,WAAS;AACrC,UAAI,YAAY,MAAM,SAAS,KAAK,GAAG;AACrC,iBAAS,KAAK,iBAAiB,SAAS,KAAK,CAAC,CAAC;AAI/C;AAAA,MACF;AAEA,eAAS,KAAK,IAAI,SAAS,KAAK;AAAA,IAClC,CAAC;AAED,WAAO,KAAK,UAAU,EAAE,QAAQ,YAAU;AACxC,UAAI,YAAY,OAAO,SAAS,MAAM,GAAG;AACvC,iBAAS,KAAK,iBAAiB,WAAW,MAAM,CAAC,CAAC;AAGlD;AAAA,MACF;AAKA,eAAS,MAAM,IAAI,WAAW,MAAM;AAAA,IACtC,CAAC;AAGD,UAAM,KAAK,OAAO,QAAQ,cAAc,CAAC,EAAE,QAAQ,CAAC,CAAC,OAAO,KAAK,MAAM;AAGrE,YAAM,eAAe,MAAM,UAAU,CAAC;AAKtC,YAAM,mBAAmB,wBAAwB,KAAK,OAAK;AACzD,eAAO,EAAE,KAAK,SAAS,GAAG,KAAK,EAAE,KAAK,QAAQ,MAAM,EAAE,MAAM,eAAe,EAAE,OAAO;AAAA,MACtF,CAAC;AAED,UAAI,kBAAkB;AACpB,iBAAS,iBAAiB,IAAI,IAAI;AAAA,MACpC,OAAO;AACL,iBAAS,YAAY,IAAI;AAAA,MAC3B;AAAA,IACF,CAAC;AAED,QAAI,OAAO,KAAK,UAAU,EAAE,QAAQ;AAClC,YAAM,UAAU;AAChB,YAAM,iBAAsC,CAAC;AAE7C,aAAO,KAAK,OAAO,EAAE,QAAQ,YAAU;AAGrC,cAAM,cAAc,OAAO,YAAY;AAEvC,YAAI,eAAe,YAAY,QAAQ;AAGrC,gBAAM,aAAa,YAAY,OAAO,WAAW;AACjD,cAAI,eAAe,KAAK;AACtB,qBAAS,KAAK,iBAAiB,QAAQ,MAAM,CAAC,CAAC;AAAA,UACjD,OAAO;AAEL,gBAAI,UAAU,QAAQ,MAAM,EAAE,QAAQ,GAAG,YAAY,OAAO,WAAW,CAAC,KAAK,EAAE;AAC/E,gBAAI,WAAW,YAAY,MAAM,SAAS;AACxC,wBAAU,OAAO,KAAK,SAAS,QAAQ,EAAE,SAAS,OAAO;AACzD,wBAAU,QAAQ,MAAM,GAAG;AAAA,YAC7B;AAEA,qBAAS,KAAK,iBAAiB,OAAO,CAAC;AAAA,UACzC;AAEA,iBAAO,QAAQ,MAAM;AACrB;AAAA,QACF,WAAW,gBAAgB,gBAAgB;AAIzC,gBAAM,oBAAoB,YAAY,MAAM,QAAQ,MAAM,CAAC;AAC3D,cAAI,CAAC,OAAO,KAAK,kBAAkB,UAAU,EAAE,QAAQ;AACrD,mBAAO,QAAQ,MAAM;AACrB;AAAA,UACF;AAAA,QACF,WAAW,gBAAgB,UAAU;AAGnC,cAAI,gBAAgB,KAAK,QAAQ,MAAM,CAAW,GAAG;AACnD,mBAAO,QAAQ,MAAM;AACrB;AAAA,UACF;AAAA,QACF;AAKA,uBAAe,WAAW,IAAI,QAAQ,MAAM;AAAA,MAC9C,CAAC;AAED,UAAI,OAAO,KAAK,cAAc,EAAE,SAAS,GAAG;AAC1C,mBAAW,OAAO,OAAO,UAAU,cAAc;AAAA,MACnD;AAAA,IACF;AAGA,QAAI;AACJ,YAAQ,SAAS,UAAU;AAAA,MACzB,KAAK;AACH,eAAO,SAAS;AAChB;AAAA,MAEF,KAAK;AACH,YAAI,SAAS,SAAS;AACpB,iBAAO,SAAS;AAAA,QAClB;AACA;AAAA,MAEF,KAAK;AACH,YAAI,SAAS,QAAQ;AACnB,iBAAO,CAAC;AAMR,cAAI,kBAAkB,YAAY,SAAS,cAAc,EAAE,QAAQ,qBAAqB,MAAM,GAAG;AAC/F,mBAAO,SAAS,cAAc;AAAA,UAChC;AAEA,mBAAS,OAAO,QAAQ,WAAS;AAC/B,gBAAI,MAAM,UAAU;AAClB,mBAAK,MAAM,IAAI,IAAI,MAAM;AAAA,YAC3B,OAAO;AACL,mBAAK,MAAM,IAAI,IAAI,MAAM;AAAA,YAC3B;AAAA,UACF,CAAC;AAAA,QACH;AACA;AAAA,MAEF;AACE,YAAI,SAAS,MAAM;AACjB,iBAAO,SAAS;AAAA,QAClB;AAAA,IACJ;AAEA,UAAM,OAAO,CAAC;AAEd,UAAM,WAAW,UAAU,eAAe,EAAE,WAAW,KAAK,CAAC;AAI7D,UAAM,uBAAuB,OAAO,SAAS,eAAe,OAAO,KAAK,QAAQ,EAAE,SAAS,IAAI,KAAK;AACpG,QAAI,OAAO,SAAS,aAAa;AAC/B,WAAK,KAAK,UAAU,MAAM,EAAE,qBAAqB,CAAC,CAAC;AAAA,IACrD;AAEA,QAAI,OAAO,KAAK,QAAQ,EAAE,SAAS,GAAG;AACpC,WAAK,KAAK,UAAU,UAAU,EAAE,qBAAqB,CAAC,CAAC;AAAA,IACzD;AAEA,QAAI,SAAS,QAAQ;AACnB,WAAK,SAAS,KAAK,IAAI,CAAC;AAAA,IAC1B;AAEA,QAAI,WAAW,QAAQ;AACrB,WAAK,WAAW,KAAK,IAAI,CAAC;AAAA,IAC5B;AAEA,SAAK,OAAO,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG;AAC1C,SAAK,0CAA0C,CAAC;AAChD,SAAK,sCAAsC,CAAC;AAE5C,WAAO,KAAK;AAAA,EACd;AACF;AAEA,IAAO,cAAQ;","names":[]}

package/package.json

@@ -1,14 +1,26 @@
 {
   "name": "httpsnippet-client-api",
-  "version": "6.1.0",
+  "version": "7.0.0-alpha.4",
   "description": "An HTTPSnippet client for generating snippets for the `api` module.",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.cts",
   "scripts": {
-    "build": "tsc",
+    "attw": "attw --pack --format table-flipped",
+    "build": "tsup",
+    "lint:types": "tsc --noEmit",
     "prebuild": "rm -rf dist/",
     "prepack": "npm run build",
-    "test": "jest --coverage"
+    "test": "vitest run --coverage"
   },
   "repository": {
     "type": "git",
@@ -21,29 +33,25 @@
   "author": "Jon Ursenbach <jon@readme.io>",
   "license": "MIT",
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "dependencies": {
     "content-type": "^1.0.5",
     "stringify-object": "^3.3.0"
   },
   "peerDependencies": {
-    "@readme/httpsnippet": ">=4",
-    "oas": "^20.0.0"
+    "@readme/httpsnippet": ">=8",
+    "oas": "^23.0.0"
   },
   "devDependencies": {
-    "@readme/oas-examples": "^5.9.0",
-    "@readme/openapi-parser": "^2.4.0",
-    "@types/content-type": "^1.1.5",
-    "@types/jest": "^29.5.2",
-    "@types/stringify-object": "^4.0.2",
-    "api": "^6.1.0",
-    "fetch-mock": "^9.11.0",
-    "isomorphic-fetch": "^3.0.0",
-    "jest": "^29.6.1",
-    "ts-jest": "^29.1.1",
-    "typescript": "^4.9.5"
+    "@readme/oas-examples": "^5.12.0",
+    "@readme/openapi-parser": "^2.5.0",
+    "@types/content-type": "^1.1.6",
+    "@types/stringify-object": "^3.3.1",
+    "@vitest/coverage-v8": "^0.34.4",
+    "typescript": "^5.2.2",
+    "vitest": "^0.34.5"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "gitHead": "244093f2ad00e5ea527420f49bdb541bc2095806"
+  "gitHead": "9f45fd21218af94f457250ac67aad71ad06942bf"
 }

package/src/index.ts

@@ -1,16 +1,15 @@
-import type { ReducedHelperObject } from '@readme/httpsnippet/dist/helpers/reducer';
-import type { Client } from '@readme/httpsnippet/dist/targets/targets';
-import type { Operation } from 'oas';
-import type { HttpMethods, OASDocument } from 'oas/dist/rmoas.types';
+import type { ReducedHelperObject } from '@readme/httpsnippet/helpers/reducer';
+import type { Client } from '@readme/httpsnippet/targets';
+import type Operation from 'oas/operation';
+import type { HttpMethods, OASDocument } from 'oas/rmoas.types';
 
-import { CodeBuilder } from '@readme/httpsnippet/dist/helpers/code-builder';
+import { CodeBuilder } from '@readme/httpsnippet/helpers/code-builder';
 import contentType from 'content-type';
 import Oas from 'oas';
+import { matchesMimeType } from 'oas/utils';
 import stringifyObject from 'stringify-object';
 
-// This should really be an exported type in `oas`.
-type SecurityType = 'Basic' | 'Bearer' | 'Query' | 'Header' | 'Cookie' | 'OAuth2' | 'http' | 'apiKey';
-
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function stringify(obj: any, opts = {}) {
   return stringifyObject(obj, { indent: '  ', ...opts });
 }
@@ -45,9 +44,8 @@ function getAuthSources(operation: Operation) {
     return matchers;
   }
 
-  const security = operation.prepareSecurity();
-  Object.keys(security).forEach((id: SecurityType) => {
-    security[id].forEach(scheme => {
+  Object.entries(operation.prepareSecurity()).forEach(([, schemes]) => {
+    schemes.forEach(scheme => {
       if (scheme.type === 'http') {
         if (scheme.scheme === 'basic') {
           matchers.header.authorization = 'Basic';
@@ -76,7 +74,7 @@ function getAuthSources(operation: Operation) {
   return matchers;
 }
 
-export interface APIOptions {
+interface APIOptions {
   apiDefinition: OASDocument;
   apiDefinitionUri: string;
   escapeBrackets?: boolean;
@@ -89,11 +87,12 @@ const client: Client<APIOptions> = {
     title: 'API',
     link: 'https://npm.im/api',
     description: 'Automatic SDK generation from an OpenAPI definition.',
+    extname: '.js',
   },
   convert: ({ cookiesObj, headersObj, postData, queryObj, url, ...source }, options) => {
     const opts = {
       ...options,
-    };
+    } as APIOptions;
 
     if (!('apiDefinitionUri' in opts)) {
       throw new Error('This HTTP Snippet client must have an `apiDefinitionUri` option supplied to it.');
@@ -107,7 +106,7 @@ const client: Client<APIOptions> = {
     const foundOperation = oas.findOperation(url, method);
     if (!foundOperation) {
       throw new Error(
-        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${url}`
+        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${url}`,
       );
     }
 
@@ -224,10 +223,9 @@ const client: Client<APIOptions> = {
             return;
           }
         } else if (headerLower === 'accept') {
-          // If the `Accept` header here is not the default or first `Accept` header for the
-          // operations' request body then we should add it otherwise we can let the SDK handle it
-          // itself.
-          if (headers[header] === operation.getContentType()) {
+          // If the `Accept` header here is JSON-like header then we can remove it from the code
+          // snippet because `api` natively supports and prioritizes JSON over any other mime type.
+          if (matchesMimeType.json(headers[header] as string)) {
             delete headers[header];
             return;
           }
@@ -244,6 +242,7 @@ const client: Client<APIOptions> = {
       }
     }
 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     let body: any;
     switch (postData.mimeType) {
       case 'application/x-www-form-urlencoded':

package/tsconfig.json

@@ -1,11 +1,7 @@
 {
+  "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "allowJs": true,
-    "baseUrl": "./src",
-    "declaration": true,
-    "esModuleInterop": true,
-    "lib": ["dom", "es2020"],
-    "noImplicitAny": true,
+    "lib": ["DOM", "ES2023"],
     "outDir": "dist/"
   },
   "include": ["./src/**/*"]

package/tsup.config.ts

@@ -0,0 +1,15 @@
+import type { Options } from 'tsup';
+
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { defineConfig } from 'tsup';
+
+// eslint-disable-next-line import/no-relative-packages
+import config from '../../tsup.config.js';
+
+export default defineConfig((options: Options) => ({
+  ...options,
+  ...config,
+
+  entry: ['src/index.ts'],
+  silent: !options.watch,
+}));