httpsnippet-client-api 4.3.0 → 5.0.0-beta.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2020 ReadMe
+Copyright © 2022 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/README.md

@@ -1,6 +1,6 @@
 # httpsnippet-client-api
 
-An HTTP Snippet client for generating snippets for the [api](https://npm.im/api) module.
+An [HTTPSnippet](https://npm.im/httpsnippet) client for generating snippets for the [api](https://npm.im/api) module.
 
 [![npm](https://img.shields.io/npm/v/httpsnippet-client-api)](https://npm.im/api) [![Build](https://github.com/readmeio/api/workflows/CI/badge.svg)](https://github.com/readmeio/api)
 
@@ -21,23 +21,45 @@ const client = require('httpsnippet-client-api');
 
 HTTPSnippet.addTargetClient('node', client);
 
-const snippet = new HTTPSnippet(harObject);
-console.log(
-  snippet.convert('node', 'api', {
-    apiDefinitionUri: 'https://example.com/openapi.json'
-    apiDefinition: {
-      /* an OpenAPI definition object */
-    }
-  })
-);
+const har = {
+  "log": {
+    "entries": [
+      {
+        "request": {
+          "cookies": [],
+          "httpVersion": "HTTP/1.1",
+          "method": "PUT",
+          "headers": [
+            {
+              "name": "X-API-KEY",
+              "value": "a5a220e"
+            }
+          ],
+          "url": "https://httpbin.org/apiKey"
+        }
+      }
+    ]
+  }
+}
+
+const snippet = new HTTPSnippet(har);
+const code = snippet.convert('node', 'api', {
+  apiDefinitionUri: 'https://api.example.com/openapi.json'
+  apiDefinition: {
+    /* an OpenAPI definition object */
+  }
+});
+
+console.log(code);
 ```
 
 Results in the following:
 
 ```js
-const sdk = require('api')('https://example.com/openapi.json');
+const sdk = require('api')('https://api.example.com/openapi.json');
 
-sdk.get('/har')
+sdk.auth('a5a220e');
+sdk.put('/apiKey')
   .then(res => console.log(res))
   .catch(err => console.error(err));
 ```

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "httpsnippet-client-api",
-  "version": "4.3.0",
-  "description": "An HTTP Snippet client for generating snippets for the api module.",
+  "version": "5.0.0-beta.0",
+  "description": "An HTTPSnippet client for generating snippets for the `api` module.",
   "main": "src/index.js",
   "scripts": {
     "lint": "eslint .",
     "pretest": "npm run lint",
     "prettier": "prettier --list-different --write \"./**/**.js\"",
-    "test": "jest --coverage"
+    "test": "nyc mocha \"test/**/*.test.js\"",
+    "test:watch": "nyc mocha \"test/**/*.test.js\" --watch"
   },
   "repository": {
     "type": "git",
@@ -20,29 +21,31 @@
   "author": "Jon Ursenbach <jon@readme.io>",
   "license": "MIT",
   "engines": {
-    "node": "^12 || ^14 || ^16"
+    "node": ">=14"
   },
   "dependencies": {
     "content-type": "^1.0.4",
-    "path-to-regexp": "^6.1.0",
     "stringify-object": "^3.3.0"
   },
   "peerDependencies": {
     "@readme/httpsnippet": "^3.0.0",
-    "oas": "^18.1.0"
+    "oas": "^18.0.1"
   },
   "devDependencies": {
-    "@readme/eslint-config": "^8.0.2",
-    "@readme/oas-examples": "^4.3.3",
-    "eslint": "^8.3.0",
-    "jest": "^27.3.1",
-    "prettier": "^2.4.1"
+    "@readme/eslint-config": "^8.7.3",
+    "@readme/oas-examples": "^5.4.1",
+    "@readme/openapi-parser": "^2.2.0",
+    "api": "^5.0.0-beta.0",
+    "chai": "^4.3.6",
+    "eslint": "^8.14.0",
+    "fetch-mock": "^9.11.0",
+    "isomorphic-fetch": "^3.0.0",
+    "mocha": "^10.0.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.6.2",
+    "sinon": "^14.0.0",
+    "sinon-chai": "^3.7.0"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "jest": {
-    "testPathIgnorePatterns": [
-      "__tests__/__fixtures__/"
-    ]
-  },
-  "gitHead": "d69e58465d8eff63aec29693f70d085247afb7ef"
+  "gitHead": "d18f7e3a1c20edaf84d0c5c2e1a64714549a4ee6"
 }

package/src/index.js

@@ -1,4 +1,3 @@
-const { match } = require('path-to-regexp');
 const stringifyObject = require('stringify-object');
 const CodeBuilder = require('@readme/httpsnippet/src/helpers/code-builder');
 const contentType = require('content-type');
@@ -21,7 +20,7 @@ function buildAuthSnippet(authKey) {
       auth.push(`'${token.replace(/'/g, "\\'")}'`);
     });
 
-    return `sdk.auth(${auth.join(', ')})`;
+    return `sdk.auth(${auth.join(', ')});`;
   }
 
   return `sdk.auth('${authKey.replace(/'/g, "\\'")}');`;
@@ -53,7 +52,12 @@ function getAuthSources(operation) {
         if (scheme.in === 'query') {
           matchers.query.push(scheme.name);
         } else if (scheme.in === 'header') {
-          matchers.header[scheme.name] = '*';
+          // 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);
         }
@@ -64,21 +68,6 @@ function getAuthSources(operation) {
   return matchers;
 }
 
-function getParamsInPath(operation, path) {
-  const cleanedPath = operation.path.replace(/{(.*?)}/g, ':$1');
-  const matchStatement = match(cleanedPath, { decode: decodeURIComponent });
-  const matchResult = matchStatement(path);
-  const slugs = {};
-
-  if (matchResult && Object.keys(matchResult.params).length) {
-    Object.keys(matchResult.params).forEach(param => {
-      slugs[`${param}`] = matchResult.params[param];
-    });
-  }
-
-  return slugs;
-}
-
 module.exports = function (source, options) {
   const opts = { indent: '  ', ...options };
 
@@ -109,9 +98,10 @@ module.exports = function (source, options) {
   code.push(`const sdk = require('api')('${opts.apiDefinitionUri}');`);
   code.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.
+  // 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.
   const configData = [];
   if ((apiDefinition.servers || []).length > 1) {
     const stockUrl = oas.url();
@@ -125,46 +115,53 @@ module.exports = function (source, options) {
   }
 
   let metadata = {};
-  if (Object.keys(source.queryObj).length) {
-    const queryParams = source.queryObj;
+  Object.keys(source.queryObj).forEach(param => {
+    if (authSources.query.includes(param)) {
+      authData.push(buildAuthSnippet(source.queryObj[param]));
 
-    Object.keys(queryParams).forEach(param => {
-      if (authSources.query.includes(param)) {
-        authData.push(buildAuthSnippet(queryParams[param]));
+      // If this query param is part of an auth source then we don't want it doubled up in the
+      // snippet.
+      return;
+    }
 
-        delete queryParams[param];
-      }
-    });
+    metadata[param] = source.queryObj[param];
+  });
 
-    metadata = Object.assign(metadata, queryParams);
-  }
+  Object.keys(source.cookiesObj).forEach(cookie => {
+    if (authSources.cookie.includes(cookie)) {
+      authData.push(buildAuthSnippet(source.cookiesObj[cookie]));
 
-  // If we have path parameters present, we should only add them in if we have an operationId as we don't want metadata
-  // to duplicate what we'll be setting the path in the snippet to.
-  if ('operationId' in operation.schema) {
-    const pathParams = getParamsInPath(operation, operation.path);
-    if (Object.keys(pathParams).length) {
-      Object.keys(pathParams).forEach(param => {
-        if (`:${param}` in operationSlugs) {
-          metadata[param] = operationSlugs[`:${param}`];
-        } else {
-          metadata[param] = pathParams[param];
-        }
-      });
+      // 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] = source.cookiesObj[cookie];
+  });
+
+  // If we have path parameters present, we should only add them in if we have an `operationId` as
+  // we don't want metadata to duplicate what we'll be setting the path in the snippet to.
+  if (operation.hasOperationId()) {
+    Array.from(Object.entries(operationSlugs)).forEach(([param, value]) => {
+      // 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.
+      metadata[param.substring(1)] = value;
+    });
   }
 
   if (Object.keys(source.headersObj).length) {
     const headers = source.headersObj;
 
     Object.keys(headers).forEach(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.
+      // 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.
       const headerLc = header.toLowerCase();
 
       if (headerLc 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.
+        // 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.
         const authScheme = authSources.header[headerLc];
         if (authScheme === '*') {
           authData.push(buildAuthSnippet(headers[header]));
@@ -180,15 +177,16 @@ module.exports = function (source, options) {
 
         delete headers[header];
       } else if (headerLc === '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.
+        // `Content-Type` headers are automatically added within the SDK so we can filter them out
+        // if they don't have parameters attached to them.
         const parsedContentType = contentType.parse(headers[header]);
         if (!Object.keys(parsedContentType.parameters).length) {
           delete headers[header];
         }
       } else if (headerLc === 'accept') {
-        // If the accept header here is not the default/first accept header for the operations request body, then we
-        // should add it, otherwise just let the SDK handle it itself.
+        // 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()) {
           delete headers[header];
         }
@@ -216,9 +214,10 @@ module.exports = function (source, options) {
       if (source.postData.params) {
         body = {};
 
-        // If there's a `Content-Type` header present in the metadata, but it's for the form-data
-        // request then dump it off the snippet. We shouldn't offload that unnecessary bloat to the
-        // user, instead letting the SDK handle it automatically.
+        // 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'];
         }
@@ -242,11 +241,11 @@ module.exports = function (source, options) {
   const args = [];
 
   let accessor = method;
-  if ('operationId' in operation.schema && operation.schema.operationId.length > 0) {
-    accessor = operation.schema.operationId;
+  if (operation.hasOperationId()) {
+    accessor = operation.getOperationId({ camelCase: true });
   } else {
-    // Since we're not using an operationId as our primary accessor we need to take the current operation that we're
-    // working with and transpile back our path parameters on top of it.
+    // Since we're not using an operationId as our primary accessor we need to take the current
+    // operation that we're working with and transpile back our path parameters on top of it.
     const slugs = Object.fromEntries(
       Object.keys(operationSlugs).map(slug => [slug.replace(/:(.*)/, '$1'), operationSlugs[slug]])
     );
@@ -254,16 +253,8 @@ module.exports = function (source, options) {
     args.push(`'${decodeURIComponent(oas.replaceUrl(path, slugs))}'`);
   }
 
-  // If the operation or method accessor is non-alphanumeric, we need to add it to the SDK object as an array key.
-  // https://github.com/readmeio/api/issues/119
-  if (accessor.match(/[^a-zA-Z\d\s:]/)) {
-    accessor = `['${accessor}']`;
-  } else {
-    accessor = `.${accessor}`;
-  }
-
-  // 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.
+  // 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.
   const inlineCharacterLimit = typeof body !== 'undefined' && Object.keys(metadata).length > 0 ? 40 : 80;
   if (typeof body !== 'undefined') {
     args.push(stringify(body, { inlineCharacterLimit }));
@@ -282,7 +273,7 @@ module.exports = function (source, options) {
   }
 
   code
-    .push(`sdk${accessor}(${args.join(', ')})`)
+    .push(`sdk.${accessor}(${args.join(', ')})`)
     .push(1, '.then(res => console.log(res))')
     .push(1, '.catch(err => console.error(err));');