httpsnippet-client-api 7.0.0-beta.0 → 7.0.0-beta.3

package/dist/index.cjs

@@ -1,8 +1,10 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/index.ts
 var _codebuilder = require('@readme/httpsnippet/helpers/code-builder');
+var _camelcase = require('camelcase'); var _camelcase2 = _interopRequireDefault(_camelcase);
 var _contenttype = require('content-type'); var _contenttype2 = _interopRequireDefault(_contenttype);
 var _oas = require('oas'); var _oas2 = _interopRequireDefault(_oas);
 var _utils = require('oas/utils');
+var _reserved2 = require('reserved2');
 var _stringifyobject = require('stringify-object'); var _stringifyobject2 = _interopRequireDefault(_stringifyobject);
 var registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;
 function getProjectPrefixFromRegistryUUID(uri) {
@@ -15,7 +17,7 @@ function getProjectPrefixFromRegistryUUID(uri) {
 function stringify(obj, opts = {}) {
   return _stringifyobject2.default.call(void 0, obj, { indent: "  ", ...opts });
 }
-function buildAuthSnippet(authKey) {
+function buildAuthSnippet(sdkVariable, authKey) {
   if (Array.isArray(authKey)) {
     const auth = [];
     authKey.forEach((token, i) => {
@@ -24,9 +26,9 @@ function buildAuthSnippet(authKey) {
       }
       auth.push(`'${token.replace(/'/g, "\\'")}'`);
     });
-    return `sdk.auth(${auth.join(", ")});`;
+    return `${sdkVariable}.auth(${auth.join(", ")});`;
   }
-  return `sdk.auth('${authKey.replace(/'/g, "\\'")}');`;
+  return `${sdkVariable}.auth('${authKey.replace(/'/g, "\\'")}');`;
 }
 function getAuthSources(operation) {
   const matchers = {
@@ -90,7 +92,10 @@ var client = {
     let sdkVariable;
     if (opts.identifier) {
       sdkPackageName = opts.identifier;
-      sdkVariable = opts.identifier;
+      sdkVariable = _camelcase2.default.call(void 0, opts.identifier);
+      if (_reserved2.isReservedOrBuiltinsLC.call(void 0, sdkVariable)) {
+        sdkVariable = `_${sdkVariable}`;
+      }
     } else {
       sdkPackageName = getProjectPrefixFromRegistryUUID(opts.apiDefinitionUri);
       sdkVariable = "sdk";
@@ -117,14 +122,14 @@ var client = {
     let metadata = {};
     Object.keys(queryObj).forEach((param) => {
       if (authSources.query.includes(param)) {
-        authData.push(buildAuthSnippet(queryObj[param]));
+        authData.push(buildAuthSnippet(sdkVariable, queryObj[param]));
         return;
       }
       metadata[param] = queryObj[param];
     });
     Object.keys(cookiesObj).forEach((cookie) => {
       if (authSources.cookie.includes(cookie)) {
-        authData.push(buildAuthSnippet(cookiesObj[cookie]));
+        authData.push(buildAuthSnippet(sdkVariable, cookiesObj[cookie]));
         return;
       }
       metadata[cookie] = cookiesObj[cookie];
@@ -148,14 +153,14 @@ var client = {
         if (headerLower in authSources.header) {
           const authScheme = authSources.header[headerLower];
           if (authScheme === "*") {
-            authData.push(buildAuthSnippet(headers[header]));
+            authData.push(buildAuthSnippet(sdkVariable, 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));
+            authData.push(buildAuthSnippet(sdkVariable, authKey));
           }
           delete headers[header];
           return;

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAKA,SAAS,mBAAmB;AAC5B,OAAO,iBAAiB;AACxB,OAAO,SAAS;AAChB,SAAS,uBAAuB;AAChC,OAAO,qBAAqB;AAQ5B,IAAM,oBAAoB;AAK1B,SAAS,iCAAiC,KAAa;AACrD,QAAM,UAAU,IAAI,MAAM,iBAAiB;AAC3C,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,QAAQ;AACzB;AAGA,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;AAqBA,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,QAAI;AACJ,QAAI;AACJ,QAAI,KAAK,YAAY;AACnB,uBAAiB,KAAK;AACtB,oBAAc,KAAK;AAAA,IACrB,OAAO;AACL,uBAAiB,iCAAiC,KAAK,gBAAgB;AACvE,oBAAc;AAAA,IAChB;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,UAAU,WAAW,eAAe,cAAc,IAAI;AAC3D,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;AAIA,YAAI,CAAC,UAAU,cAAc,EAAE,SAAS,WAAW,GAAG;AACpD,yBAAe,WAAW,IAAI,QAAQ,MAAM;AAAA,QAC9C,OAAO;AAGL,yBAAe,MAAM,IAAI,QAAQ,MAAM;AAAA,QACzC;AAAA,MACF,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,GAAG,WAAW,IAAI,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG;AACrD,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/**\n * @note This regex also exists in `api/fetcher`.\n *\n * @example @petstore/v1.0#n6kvf10vakpemvplx\n * @example @petstore#n6kvf10vakpemvplx\n */\nconst registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;\n\n/**\n * @note This function also exists in `api/fetcher`.\n */\nfunction getProjectPrefixFromRegistryUUID(uri: string) {\n  const matches = uri.match(registryUUIDRegex);\n  if (!matches) {\n    return undefined;\n  }\n\n  return matches.groups?.project;\n}\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  /**\n   * The URI that is used to download this API definition from `npx api install`.\n   *\n   * @example @developers/v2.0#17273l2glm9fq4l5\n   */\n  apiDefinitionUri: string;\n  escapeBrackets?: boolean;\n  /**\n   * The string to identify this SDK as. This is used in the `import sdk from '@api/<identifier>'`\n   * sample as well as the the variable name we attach the SDK to.\n   *\n   * @example developers\n   */\n  identifier?: string;\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    let sdkPackageName;\n    let sdkVariable;\n    if (opts.identifier) {\n      sdkPackageName = opts.identifier;\n      sdkVariable = opts.identifier;\n    } else {\n      sdkPackageName = getProjectPrefixFromRegistryUUID(opts.apiDefinitionUri);\n      sdkVariable = 'sdk';\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(`import ${sdkVariable} from '@api/${sdkPackageName}';`);\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 it into our code snippet.\n        if (['accept', 'content-type'].includes(headerLower)) {\n          requestHeaders[headerLower] = headers[header];\n        } else {\n          // Non-reserved headers retain their casing because we want to generate a snippet that\n          // matches the TS types that are created during codegeneration.\n          requestHeaders[header] = headers[header];\n        }\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(`${sdkVariable}.${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"]}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAKA,SAAS,mBAAmB;AAC5B,OAAO,eAAe;AACtB,OAAO,iBAAiB;AACxB,OAAO,SAAS;AAChB,SAAS,uBAAuB;AAChC,SAAS,8BAA8B;AACvC,OAAO,qBAAqB;AAQ5B,IAAM,oBAAoB;AAK1B,SAAS,iCAAiC,KAAa;AACrD,QAAM,UAAU,IAAI,MAAM,iBAAiB;AAC3C,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,QAAQ;AACzB;AAGA,SAAS,UAAU,KAAU,OAAO,CAAC,GAAG;AACtC,SAAO,gBAAgB,KAAK,EAAE,QAAQ,MAAM,GAAG,KAAK,CAAC;AACvD;AAEA,SAAS,iBAAiB,aAAqB,SAA4B;AAEzE,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,GAAG,WAAW,SAAS,KAAK,KAAK,IAAI,CAAC;AAAA,EAC/C;AAEA,SAAO,GAAG,WAAW,UAAU,QAAQ,QAAQ,MAAM,KAAK,CAAC;AAC7D;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;AAqBA,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,QAAI;AACJ,QAAI;AACJ,QAAI,KAAK,YAAY;AACnB,uBAAiB,KAAK;AAEtB,oBAAc,UAAU,KAAK,UAAU;AACvC,UAAI,uBAAuB,WAAW,GAAG;AAGvC,sBAAc,IAAI,WAAW;AAAA,MAC/B;AAAA,IACF,OAAO;AACL,uBAAiB,iCAAiC,KAAK,gBAAgB;AACvE,oBAAc;AAAA,IAChB;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,UAAU,WAAW,eAAe,cAAc,IAAI;AAC3D,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,aAAa,SAAS,KAAK,CAAC,CAAC;AAI5D;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,aAAa,WAAW,MAAM,CAAC,CAAC;AAG/D;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,aAAa,QAAQ,MAAM,CAAC,CAAC;AAAA,UAC9D,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,aAAa,OAAO,CAAC;AAAA,UACtD;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;AAIA,YAAI,CAAC,UAAU,cAAc,EAAE,SAAS,WAAW,GAAG;AACpD,yBAAe,WAAW,IAAI,QAAQ,MAAM;AAAA,QAC9C,OAAO;AAGL,yBAAe,MAAM,IAAI,QAAQ,MAAM;AAAA,QACzC;AAAA,MACF,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,GAAG,WAAW,IAAI,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG;AACrD,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 camelCase from 'camelcase';\nimport contentType from 'content-type';\nimport Oas from 'oas';\nimport { matchesMimeType } from 'oas/utils';\nimport { isReservedOrBuiltinsLC } from 'reserved2';\nimport stringifyObject from 'stringify-object';\n\n/**\n * @note This regex also exists in `api/fetcher`.\n *\n * @example @petstore/v1.0#n6kvf10vakpemvplx\n * @example @petstore#n6kvf10vakpemvplx\n */\nconst registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;\n\n/**\n * @note This function also exists in `api/fetcher`.\n */\nfunction getProjectPrefixFromRegistryUUID(uri: string) {\n  const matches = uri.match(registryUUIDRegex);\n  if (!matches) {\n    return undefined;\n  }\n\n  return matches.groups?.project;\n}\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(sdkVariable: string, 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 `${sdkVariable}.auth(${auth.join(', ')});`;\n  }\n\n  return `${sdkVariable}.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  /**\n   * The URI that is used to download this API definition from `npx api install`.\n   *\n   * @example @developers/v2.0#17273l2glm9fq4l5\n   */\n  apiDefinitionUri: string;\n  escapeBrackets?: boolean;\n  /**\n   * The string to identify this SDK as. This is used in the `import sdk from '@api/<identifier>'`\n   * sample as well as the the variable name we attach the SDK to.\n   *\n   * @example developers\n   */\n  identifier?: string;\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    let sdkPackageName;\n    let sdkVariable: string;\n    if (opts.identifier) {\n      sdkPackageName = opts.identifier;\n\n      sdkVariable = camelCase(opts.identifier);\n      if (isReservedOrBuiltinsLC(sdkVariable)) {\n        // If this identifier is a reserved JS word then we should prefix it with an underscore so\n        // this snippet can be valid code.\n        sdkVariable = `_${sdkVariable}`;\n      }\n    } else {\n      sdkPackageName = getProjectPrefixFromRegistryUUID(opts.apiDefinitionUri);\n      sdkVariable = 'sdk';\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(`import ${sdkVariable} from '@api/${sdkPackageName}';`);\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(sdkVariable, 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(sdkVariable, 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(sdkVariable, 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(sdkVariable, 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 it into our code snippet.\n        if (['accept', 'content-type'].includes(headerLower)) {\n          requestHeaders[headerLower] = headers[header];\n        } else {\n          // Non-reserved headers retain their casing because we want to generate a snippet that\n          // matches the TS types that are created during codegeneration.\n          requestHeaders[header] = headers[header];\n        }\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(`${sdkVariable}.${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.js

@@ -1,8 +1,10 @@
 // src/index.ts
 import { CodeBuilder } from "@readme/httpsnippet/helpers/code-builder";
+import camelCase from "camelcase";
 import contentType from "content-type";
 import Oas from "oas";
 import { matchesMimeType } from "oas/utils";
+import { isReservedOrBuiltinsLC } from "reserved2";
 import stringifyObject from "stringify-object";
 var registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;
 function getProjectPrefixFromRegistryUUID(uri) {
@@ -15,7 +17,7 @@ function getProjectPrefixFromRegistryUUID(uri) {
 function stringify(obj, opts = {}) {
   return stringifyObject(obj, { indent: "  ", ...opts });
 }
-function buildAuthSnippet(authKey) {
+function buildAuthSnippet(sdkVariable, authKey) {
   if (Array.isArray(authKey)) {
     const auth = [];
     authKey.forEach((token, i) => {
@@ -24,9 +26,9 @@ function buildAuthSnippet(authKey) {
       }
       auth.push(`'${token.replace(/'/g, "\\'")}'`);
     });
-    return `sdk.auth(${auth.join(", ")});`;
+    return `${sdkVariable}.auth(${auth.join(", ")});`;
   }
-  return `sdk.auth('${authKey.replace(/'/g, "\\'")}');`;
+  return `${sdkVariable}.auth('${authKey.replace(/'/g, "\\'")}');`;
 }
 function getAuthSources(operation) {
   const matchers = {
@@ -90,7 +92,10 @@ var client = {
     let sdkVariable;
     if (opts.identifier) {
       sdkPackageName = opts.identifier;
-      sdkVariable = opts.identifier;
+      sdkVariable = camelCase(opts.identifier);
+      if (isReservedOrBuiltinsLC(sdkVariable)) {
+        sdkVariable = `_${sdkVariable}`;
+      }
     } else {
       sdkPackageName = getProjectPrefixFromRegistryUUID(opts.apiDefinitionUri);
       sdkVariable = "sdk";
@@ -117,14 +122,14 @@ var client = {
     let metadata = {};
     Object.keys(queryObj).forEach((param) => {
       if (authSources.query.includes(param)) {
-        authData.push(buildAuthSnippet(queryObj[param]));
+        authData.push(buildAuthSnippet(sdkVariable, queryObj[param]));
         return;
       }
       metadata[param] = queryObj[param];
     });
     Object.keys(cookiesObj).forEach((cookie) => {
       if (authSources.cookie.includes(cookie)) {
-        authData.push(buildAuthSnippet(cookiesObj[cookie]));
+        authData.push(buildAuthSnippet(sdkVariable, cookiesObj[cookie]));
         return;
       }
       metadata[cookie] = cookiesObj[cookie];
@@ -148,14 +153,14 @@ var client = {
         if (headerLower in authSources.header) {
           const authScheme = authSources.header[headerLower];
           if (authScheme === "*") {
-            authData.push(buildAuthSnippet(headers[header]));
+            authData.push(buildAuthSnippet(sdkVariable, 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));
+            authData.push(buildAuthSnippet(sdkVariable, authKey));
           }
           delete headers[header];
           return;

package/dist/index.js.map

@@ -1 +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/**\n * @note This regex also exists in `api/fetcher`.\n *\n * @example @petstore/v1.0#n6kvf10vakpemvplx\n * @example @petstore#n6kvf10vakpemvplx\n */\nconst registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;\n\n/**\n * @note This function also exists in `api/fetcher`.\n */\nfunction getProjectPrefixFromRegistryUUID(uri: string) {\n  const matches = uri.match(registryUUIDRegex);\n  if (!matches) {\n    return undefined;\n  }\n\n  return matches.groups?.project;\n}\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  /**\n   * The URI that is used to download this API definition from `npx api install`.\n   *\n   * @example @developers/v2.0#17273l2glm9fq4l5\n   */\n  apiDefinitionUri: string;\n  escapeBrackets?: boolean;\n  /**\n   * The string to identify this SDK as. This is used in the `import sdk from '@api/<identifier>'`\n   * sample as well as the the variable name we attach the SDK to.\n   *\n   * @example developers\n   */\n  identifier?: string;\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    let sdkPackageName;\n    let sdkVariable;\n    if (opts.identifier) {\n      sdkPackageName = opts.identifier;\n      sdkVariable = opts.identifier;\n    } else {\n      sdkPackageName = getProjectPrefixFromRegistryUUID(opts.apiDefinitionUri);\n      sdkVariable = 'sdk';\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(`import ${sdkVariable} from '@api/${sdkPackageName}';`);\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 it into our code snippet.\n        if (['accept', 'content-type'].includes(headerLower)) {\n          requestHeaders[headerLower] = headers[header];\n        } else {\n          // Non-reserved headers retain their casing because we want to generate a snippet that\n          // matches the TS types that are created during codegeneration.\n          requestHeaders[header] = headers[header];\n        }\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(`${sdkVariable}.${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;AAQ5B,IAAM,oBAAoB;AAK1B,SAAS,iCAAiC,KAAa;AACrD,QAAM,UAAU,IAAI,MAAM,iBAAiB;AAC3C,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,QAAQ;AACzB;AAGA,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;AAqBA,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,QAAI;AACJ,QAAI;AACJ,QAAI,KAAK,YAAY;AACnB,uBAAiB,KAAK;AACtB,oBAAc,KAAK;AAAA,IACrB,OAAO;AACL,uBAAiB,iCAAiC,KAAK,gBAAgB;AACvE,oBAAc;AAAA,IAChB;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,UAAU,WAAW,eAAe,cAAc,IAAI;AAC3D,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;AAIA,YAAI,CAAC,UAAU,cAAc,EAAE,SAAS,WAAW,GAAG;AACpD,yBAAe,WAAW,IAAI,QAAQ,MAAM;AAAA,QAC9C,OAAO;AAGL,yBAAe,MAAM,IAAI,QAAQ,MAAM;AAAA,QACzC;AAAA,MACF,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,GAAG,WAAW,IAAI,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG;AACrD,SAAK,0CAA0C,CAAC;AAChD,SAAK,sCAAsC,CAAC;AAE5C,WAAO,KAAK;AAAA,EACd;AACF;AAEA,IAAO,cAAQ;","names":[]}
+{"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 camelCase from 'camelcase';\nimport contentType from 'content-type';\nimport Oas from 'oas';\nimport { matchesMimeType } from 'oas/utils';\nimport { isReservedOrBuiltinsLC } from 'reserved2';\nimport stringifyObject from 'stringify-object';\n\n/**\n * @note This regex also exists in `api/fetcher`.\n *\n * @example @petstore/v1.0#n6kvf10vakpemvplx\n * @example @petstore#n6kvf10vakpemvplx\n */\nconst registryUUIDRegex = /^@(?<project>[a-zA-Z0-9-_]+)(\\/?(?<version>.+))?#(?<uuid>[a-z0-9]+)$/;\n\n/**\n * @note This function also exists in `api/fetcher`.\n */\nfunction getProjectPrefixFromRegistryUUID(uri: string) {\n  const matches = uri.match(registryUUIDRegex);\n  if (!matches) {\n    return undefined;\n  }\n\n  return matches.groups?.project;\n}\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(sdkVariable: string, 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 `${sdkVariable}.auth(${auth.join(', ')});`;\n  }\n\n  return `${sdkVariable}.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  /**\n   * The URI that is used to download this API definition from `npx api install`.\n   *\n   * @example @developers/v2.0#17273l2glm9fq4l5\n   */\n  apiDefinitionUri: string;\n  escapeBrackets?: boolean;\n  /**\n   * The string to identify this SDK as. This is used in the `import sdk from '@api/<identifier>'`\n   * sample as well as the the variable name we attach the SDK to.\n   *\n   * @example developers\n   */\n  identifier?: string;\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    let sdkPackageName;\n    let sdkVariable: string;\n    if (opts.identifier) {\n      sdkPackageName = opts.identifier;\n\n      sdkVariable = camelCase(opts.identifier);\n      if (isReservedOrBuiltinsLC(sdkVariable)) {\n        // If this identifier is a reserved JS word then we should prefix it with an underscore so\n        // this snippet can be valid code.\n        sdkVariable = `_${sdkVariable}`;\n      }\n    } else {\n      sdkPackageName = getProjectPrefixFromRegistryUUID(opts.apiDefinitionUri);\n      sdkVariable = 'sdk';\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(`import ${sdkVariable} from '@api/${sdkPackageName}';`);\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(sdkVariable, 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(sdkVariable, 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(sdkVariable, 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(sdkVariable, 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 it into our code snippet.\n        if (['accept', 'content-type'].includes(headerLower)) {\n          requestHeaders[headerLower] = headers[header];\n        } else {\n          // Non-reserved headers retain their casing because we want to generate a snippet that\n          // matches the TS types that are created during codegeneration.\n          requestHeaders[header] = headers[header];\n        }\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(`${sdkVariable}.${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,eAAe;AACtB,OAAO,iBAAiB;AACxB,OAAO,SAAS;AAChB,SAAS,uBAAuB;AAChC,SAAS,8BAA8B;AACvC,OAAO,qBAAqB;AAQ5B,IAAM,oBAAoB;AAK1B,SAAS,iCAAiC,KAAa;AACrD,QAAM,UAAU,IAAI,MAAM,iBAAiB;AAC3C,MAAI,CAAC,SAAS;AACZ,WAAO;AAAA,EACT;AAEA,SAAO,QAAQ,QAAQ;AACzB;AAGA,SAAS,UAAU,KAAU,OAAO,CAAC,GAAG;AACtC,SAAO,gBAAgB,KAAK,EAAE,QAAQ,MAAM,GAAG,KAAK,CAAC;AACvD;AAEA,SAAS,iBAAiB,aAAqB,SAA4B;AAEzE,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,GAAG,WAAW,SAAS,KAAK,KAAK,IAAI,CAAC;AAAA,EAC/C;AAEA,SAAO,GAAG,WAAW,UAAU,QAAQ,QAAQ,MAAM,KAAK,CAAC;AAC7D;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;AAqBA,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,QAAI;AACJ,QAAI;AACJ,QAAI,KAAK,YAAY;AACnB,uBAAiB,KAAK;AAEtB,oBAAc,UAAU,KAAK,UAAU;AACvC,UAAI,uBAAuB,WAAW,GAAG;AAGvC,sBAAc,IAAI,WAAW;AAAA,MAC/B;AAAA,IACF,OAAO;AACL,uBAAiB,iCAAiC,KAAK,gBAAgB;AACvE,oBAAc;AAAA,IAChB;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,UAAU,WAAW,eAAe,cAAc,IAAI;AAC3D,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,aAAa,SAAS,KAAK,CAAC,CAAC;AAI5D;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,aAAa,WAAW,MAAM,CAAC,CAAC;AAG/D;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,aAAa,QAAQ,MAAM,CAAC,CAAC;AAAA,UAC9D,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,aAAa,OAAO,CAAC;AAAA,UACtD;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;AAIA,YAAI,CAAC,UAAU,cAAc,EAAE,SAAS,WAAW,GAAG;AACpD,yBAAe,WAAW,IAAI,QAAQ,MAAM;AAAA,QAC9C,OAAO;AAGL,yBAAe,MAAM,IAAI,QAAQ,MAAM;AAAA,QACzC;AAAA,MACF,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,GAAG,WAAW,IAAI,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,GAAG;AACrD,SAAK,0CAA0C,CAAC;AAChD,SAAK,sCAAsC,CAAC;AAE5C,WAAO,KAAK;AAAA,EACd;AACF;AAEA,IAAO,cAAQ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "httpsnippet-client-api",
-  "version": "7.0.0-beta.0",
+  "version": "7.0.0-beta.3",
   "description": "An HTTPSnippet client for generating snippets for the `api` module.",
   "sideEffects": false,
   "type": "module",
@@ -36,7 +36,9 @@
     "node": ">=18"
   },
   "dependencies": {
+    "camelcase": "^8.0.0",
     "content-type": "^1.0.5",
+    "reserved2": "^0.1.5",
     "stringify-object": "^5.0.0"
   },
   "peerDependencies": {
@@ -53,5 +55,5 @@
     "vitest": "^0.34.5"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "gitHead": "6ea3f3468343cea16536dda9460d8f0c65fa35c8"
+  "gitHead": "9dbc86caab9ae4b49e7d0dac52ab6c25f5f46170"
 }

package/src/index.ts

@@ -4,9 +4,11 @@ import type Operation from 'oas/operation';
 import type { HttpMethods, OASDocument } from 'oas/rmoas.types';
 
 import { CodeBuilder } from '@readme/httpsnippet/helpers/code-builder';
+import camelCase from 'camelcase';
 import contentType from 'content-type';
 import Oas from 'oas';
 import { matchesMimeType } from 'oas/utils';
+import { isReservedOrBuiltinsLC } from 'reserved2';
 import stringifyObject from 'stringify-object';
 
 /**
@@ -34,7 +36,7 @@ function stringify(obj: any, opts = {}) {
   return stringifyObject(obj, { indent: '  ', ...opts });
 }
 
-function buildAuthSnippet(authKey: string | string[]) {
+function buildAuthSnippet(sdkVariable: string, authKey: string | string[]) {
   // Auth key will be an array for Basic auth cases.
   if (Array.isArray(authKey)) {
     const auth: string[] = [];
@@ -47,10 +49,10 @@ function buildAuthSnippet(authKey: string | string[]) {
       auth.push(`'${token.replace(/'/g, "\\'")}'`);
     });
 
-    return `sdk.auth(${auth.join(', ')});`;
+    return `${sdkVariable}.auth(${auth.join(', ')});`;
   }
 
-  return `sdk.auth('${authKey.replace(/'/g, "\\'")}');`;
+  return `${sdkVariable}.auth('${authKey.replace(/'/g, "\\'")}');`;
 }
 
 function getAuthSources(operation: Operation) {
@@ -143,10 +145,16 @@ const client: Client<APIOptions> = {
     }
 
     let sdkPackageName;
-    let sdkVariable;
+    let sdkVariable: string;
     if (opts.identifier) {
       sdkPackageName = opts.identifier;
-      sdkVariable = opts.identifier;
+
+      sdkVariable = camelCase(opts.identifier);
+      if (isReservedOrBuiltinsLC(sdkVariable)) {
+        // If this identifier is a reserved JS word then we should prefix it with an underscore so
+        // this snippet can be valid code.
+        sdkVariable = `_${sdkVariable}`;
+      }
     } else {
       sdkPackageName = getProjectPrefixFromRegistryUUID(opts.apiDefinitionUri);
       sdkVariable = 'sdk';
@@ -183,7 +191,7 @@ const client: Client<APIOptions> = {
     let metadata: Record<string, string | string[]> = {};
     Object.keys(queryObj).forEach(param => {
       if (authSources.query.includes(param)) {
-        authData.push(buildAuthSnippet(queryObj[param]));
+        authData.push(buildAuthSnippet(sdkVariable, queryObj[param]));
 
         // If this query param is part of an auth source then we don't want it doubled up in the
         // snippet.
@@ -195,7 +203,7 @@ const client: Client<APIOptions> = {
 
     Object.keys(cookiesObj).forEach(cookie => {
       if (authSources.cookie.includes(cookie)) {
-        authData.push(buildAuthSnippet(cookiesObj[cookie]));
+        authData.push(buildAuthSnippet(sdkVariable, cookiesObj[cookie]));
 
         // If this cookie is part of an auth source then we don't want it doubled up.
         return;
@@ -241,7 +249,7 @@ const client: Client<APIOptions> = {
           // into our auth data so we can build up an `.auth()` snippet for the SDK.
           const authScheme = authSources.header[headerLower];
           if (authScheme === '*') {
-            authData.push(buildAuthSnippet(headers[header]));
+            authData.push(buildAuthSnippet(sdkVariable, headers[header]));
           } else {
             // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.
             let authKey = headers[header].replace(`${authSources.header[headerLower]} `, '');
@@ -250,7 +258,7 @@ const client: Client<APIOptions> = {
               authKey = authKey.split(':');
             }
 
-            authData.push(buildAuthSnippet(authKey));
+            authData.push(buildAuthSnippet(sdkVariable, authKey));
           }
 
           delete headers[header];