httpsnippet-client-api 5.0.0-beta.2 → 5.0.0

package/README.md

@@ -60,6 +60,6 @@ const sdk = require('api')('https://api.example.com/openapi.json');
 sdk.auth('a5a220e');
 sdk
   .put('/apiKey')
-  .then(res => console.log(res))
+  .then(({ data }}) => console.log(data))
   .catch(err => console.error(err));
 ```

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import type { OASDocument } from 'oas/@types/rmoas.types';
 import type { Client } from '@readme/httpsnippet/dist/targets/targets';
+import type { OASDocument } from 'oas/dist/rmoas.types';
 export interface APIOptions {
     apiDefinition: OASDocument;
     apiDefinitionUri: string;

package/dist/index.js

@@ -10,14 +10,25 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-var stringify_object_1 = __importDefault(require("stringify-object"));
 var code_builder_1 = require("@readme/httpsnippet/dist/helpers/code-builder");
 var content_type_1 = __importDefault(require("content-type"));
 var oas_1 = __importDefault(require("oas"));
+var stringify_object_1 = __importDefault(require("stringify-object"));
 function stringify(obj, opts) {
     if (opts === void 0) { opts = {}; }
     return (0, stringify_object_1["default"])(obj, __assign({ indent: '  ' }, opts));
@@ -87,7 +98,8 @@ var client = {
         link: 'https://npm.im/api',
         description: 'Automatic SDK generation from an OpenAPI definition.'
     },
-    convert: function (source, options) {
+    convert: function (_a, options) {
+        var cookiesObj = _a.cookiesObj, headersObj = _a.headersObj, postData = _a.postData, queryObj = _a.queryObj, url = _a.url, source = __rest(_a, ["cookiesObj", "headersObj", "postData", "queryObj", "url"]);
         var opts = __assign({}, options);
         if (!('apiDefinitionUri' in opts)) {
             throw new Error('This HTTP Snippet client must have an `apiDefinitionUri` option supplied to it.');
@@ -98,17 +110,16 @@ var client = {
         var method = source.method.toLowerCase();
         var oas = new oas_1["default"](opts.apiDefinition);
         var apiDefinition = oas.getDefinition();
-        var foundOperation = oas.findOperation(source.url, method);
+        var foundOperation = oas.findOperation(url, method);
         if (!foundOperation) {
-            throw new Error("Unable to locate a matching operation in the supplied `apiDefinition` for: ".concat(source.method, " ").concat(source.url));
+            throw new Error("Unable to locate a matching operation in the supplied `apiDefinition` for: ".concat(source.method, " ").concat(url));
         }
         var operationSlugs = foundOperation.url.slugs;
         var operation = oas.operation(foundOperation.url.nonNormalizedPath, method);
         var path = operation.path;
         var authData = [];
         var authSources = getAuthSources(operation);
-        var _a = new code_builder_1.CodeBuilder({ indent: opts.indent || '  ' }), blank = _a.blank, push = _a.push, join = _a.join;
-        // const code = new CodeBuilder(opts.indent);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent || '  ' }), blank = _b.blank, push = _b.push, join = _b.join;
         push("const sdk = require('api')('".concat(opts.apiDefinitionUri, "');"));
         blank();
         // If we have multiple servers configured and our source URL differs from the stock URL that we
@@ -118,7 +129,7 @@ var client = {
         var configData = [];
         if ((apiDefinition.servers || []).length > 1) {
             var stockUrl = oas.url();
-            var baseUrl = source.url.replace(path, '');
+            var baseUrl = url.replace(path, '');
             if (baseUrl !== stockUrl) {
                 var serverVars = oas.splitVariables(baseUrl);
                 var serverUrl = serverVars ? oas.url(serverVars.selected, serverVars.variables) : baseUrl;
@@ -126,52 +137,50 @@ var client = {
             }
         }
         var metadata = {};
-        Object.keys(source.queryObj).forEach(function (param) {
+        Object.keys(queryObj).forEach(function (param) {
             if (authSources.query.includes(param)) {
-                authData.push(buildAuthSnippet(source.queryObj[param]));
+                authData.push(buildAuthSnippet(queryObj[param]));
                 // If this query param is part of an auth source then we don't want it doubled up in the
                 // snippet.
                 return;
             }
-            metadata[param] = source.queryObj[param];
+            metadata[param] = queryObj[param];
         });
-        Object.keys(source.cookiesObj).forEach(function (cookie) {
+        Object.keys(cookiesObj).forEach(function (cookie) {
             if (authSources.cookie.includes(cookie)) {
-                authData.push(buildAuthSnippet(source.cookiesObj[cookie]));
+                authData.push(buildAuthSnippet(cookiesObj[cookie]));
                 // If this cookie is part of an auth source then we don't want it doubled up.
                 return;
             }
             // Note that we may have the potential to overlap any cookie that also shares the name as
             // another metadata parameter. This problem is currently inherent to `api` and not this
             // snippet generator.
-            metadata[cookie] = source.cookiesObj[cookie];
+            metadata[cookie] = 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(function (_a) {
-                var param = _a[0], value = _a[1];
-                // The keys in `operationSlugs` will always be prefixed with a `:` in the `oas` library so
-                // we can safely do this substring here without asserting this context.
-                metadata[param.substring(1)] = value;
-            });
-        }
-        if (Object.keys(source.headersObj).length) {
-            var headers_1 = source.headersObj;
+        // If we have path parameters present we should add them into the metadata object.
+        Array.from(Object.entries(operationSlugs)).forEach(function (_a) {
+            var param = _a[0], value = _a[1];
+            // The keys in `operationSlugs` will always be prefixed with a `:` in the `oas` library so
+            // we can safely do this substring here without asserting this context.
+            metadata[param.substring(1)] = value;
+        });
+        if (Object.keys(headersObj).length) {
+            var headers_1 = headersObj;
+            var requestHeaders_1 = {};
             Object.keys(headers_1).forEach(function (header) {
                 // Headers in HTTPSnippet are case-insensitive so we need to add in some special handling to
                 // make sure we're able to match them properly.
-                var headerLc = header.toLowerCase();
-                if (headerLc in authSources.header) {
+                var headerLower = header.toLowerCase();
+                if (headerLower in authSources.header) {
                     // If this header has been set up as an authentication header, let's remove it and add it
                     // into our auth data so we can build up an `.auth()` snippet for the SDK.
-                    var authScheme = authSources.header[headerLc];
+                    var authScheme = authSources.header[headerLower];
                     if (authScheme === '*') {
                         authData.push(buildAuthSnippet(headers_1[header]));
                     }
                     else {
                         // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.
-                        var authKey = headers_1[header].replace("".concat(authSources.header[headerLc], " "), '');
+                        var authKey = headers_1[header].replace("".concat(authSources.header[headerLower], " "), '');
                         if (authScheme.toLowerCase() === 'basic') {
                             authKey = Buffer.from(authKey, 'base64').toString('ascii');
                             authKey = authKey.split(':');
@@ -179,41 +188,48 @@ var client = {
                         authData.push(buildAuthSnippet(authKey));
                     }
                     delete headers_1[header];
+                    return;
                 }
-                else if (headerLc === 'content-type') {
+                else if (headerLower === 'content-type') {
                     // `Content-Type` headers are automatically added within the SDK so we can filter them out
                     // if they don't have parameters attached to them.
                     // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.
                     var parsedContentType = content_type_1["default"].parse(headers_1[header]);
                     if (!Object.keys(parsedContentType.parameters).length) {
                         delete headers_1[header];
+                        return;
                     }
                 }
-                else if (headerLc === 'accept') {
+                else if (headerLower === 'accept') {
                     // If the `Accept` header here is not the default or first `Accept` header for the
                     // operations' request body then we should add it otherwise we can let the SDK handle it
                     // itself.
                     if (headers_1[header] === operation.getContentType()) {
                         delete headers_1[header];
+                        return;
                     }
                 }
+                // If we haven't used our header anywhere else, or we've deleted it from the payload
+                // because it'll be handled internally by `api` then we should add the lowercased version
+                // of our header into the generated code snippet.
+                requestHeaders_1[headerLower] = headers_1[header];
             });
-            if (Object.keys(headers_1).length > 0) {
-                metadata = Object.assign(metadata, headers_1);
+            if (Object.keys(requestHeaders_1).length > 0) {
+                metadata = Object.assign(metadata, requestHeaders_1);
             }
         }
         var body;
-        switch (source.postData.mimeType) {
+        switch (postData.mimeType) {
             case 'application/x-www-form-urlencoded':
-                body = source.postData.paramsObj;
+                body = postData.paramsObj;
                 break;
             case 'application/json':
-                if (source.postData.jsonObj) {
-                    body = source.postData.jsonObj;
+                if (postData.jsonObj) {
+                    body = postData.jsonObj;
                 }
                 break;
             case 'multipart/form-data':
-                if (source.postData.params) {
+                if (postData.params) {
                     body = {};
                     // If there's a `Content-Type` header present in the metadata, but it's for the
                     // `multipart/form-data` request then dump it off the snippet. We shouldn't offload that
@@ -222,7 +238,7 @@ var client = {
                     if ('content-type' in metadata && metadata['content-type'].indexOf('multipart/form-data') === 0) {
                         delete metadata['content-type'];
                     }
-                    source.postData.params.forEach(function (param) {
+                    postData.params.forEach(function (param) {
                         if (param.fileName) {
                             body[param.name] = param.fileName;
                         }
@@ -233,21 +249,12 @@ var client = {
                 }
                 break;
             default:
-                if (source.postData.text) {
-                    body = source.postData.text;
+                if (postData.text) {
+                    body = postData.text;
                 }
         }
         var args = [];
-        var accessor = method;
-        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.
-            var slugs = Object.fromEntries(Object.keys(operationSlugs).map(function (slug) { return [slug.replace(/:(.*)/, '$1'), operationSlugs[slug]]; }));
-            args.push("'".concat(decodeURIComponent(oas.replaceUrl(path, slugs)), "'"));
-        }
+        var accessor = operation.getOperationId({ camelCase: true });
         // If we're going to be rendering out body params and metadata we should cut their character
         // limit in half because we'll be rendering them in their own lines.
         var inlineCharacterLimit = typeof body !== 'undefined' && Object.keys(metadata).length > 0 ? 40 : 80;
@@ -264,7 +271,7 @@ var client = {
             push(configData.join('\n'));
         }
         push("sdk.".concat(accessor, "(").concat(args.join(', '), ")"));
-        push('.then(res => console.log(res))', 1);
+        push('.then(({ data }) => console.log(data))', 1);
         push('.catch(err => console.error(err));', 1);
         return join();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "httpsnippet-client-api",
-  "version": "5.0.0-beta.2",
+  "version": "5.0.0",
   "description": "An HTTPSnippet client for generating snippets for the `api` module.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -29,14 +29,14 @@
   },
   "peerDependencies": {
     "@readme/httpsnippet": "^4.0.3",
-    "oas": "^18.0.1"
+    "oas": "^20.0.0"
   },
   "devDependencies": {
-    "@readme/oas-examples": "^5.4.1",
+    "@readme/oas-examples": "^5.7.1",
     "@readme/openapi-parser": "^2.2.0",
     "@types/content-type": "^1.1.5",
     "@types/stringify-object": "^4.0.1",
-    "api": "^5.0.0-beta.2",
+    "api": "^5.0.0",
     "chai": "^4.3.6",
     "fetch-mock": "^9.11.0",
     "isomorphic-fetch": "^3.0.0",
@@ -53,5 +53,5 @@
       "test/"
     ]
   },
-  "gitHead": "aa738b1bf46b447afed38507d3fc49acbbad6309"
+  "gitHead": "bb044ecdb3296c24838056764553fa7f18e6d228"
 }

package/src/index.ts

@@ -1,10 +1,12 @@
-import type { Operation } from 'oas';
-import type { HttpMethods, OASDocument } from 'oas/@types/rmoas.types';
+import type { ReducedHelperObject } from '@readme/httpsnippet/dist/helpers/reducer';
 import type { Client } from '@readme/httpsnippet/dist/targets/targets';
-import stringifyObject from 'stringify-object';
+import type { Operation } from 'oas';
+import type { HttpMethods, OASDocument } from 'oas/dist/rmoas.types';
+
 import { CodeBuilder } from '@readme/httpsnippet/dist/helpers/code-builder';
 import contentType from 'content-type';
 import Oas from 'oas';
+import stringifyObject from 'stringify-object';
 
 // This should really be an exported type in `oas`.
 type SecurityType = 'Basic' | 'Bearer' | 'Query' | 'Header' | 'Cookie' | 'OAuth2' | 'http' | 'apiKey';
@@ -88,7 +90,7 @@ const client: Client<APIOptions> = {
     link: 'https://npm.im/api',
     description: 'Automatic SDK generation from an OpenAPI definition.',
   },
-  convert: (source, options) => {
+  convert: ({ cookiesObj, headersObj, postData, queryObj, url, ...source }, options) => {
     const opts = {
       ...options,
     };
@@ -102,10 +104,10 @@ const client: Client<APIOptions> = {
     const method = source.method.toLowerCase() as HttpMethods;
     const oas = new Oas(opts.apiDefinition);
     const apiDefinition = oas.getDefinition();
-    const foundOperation = oas.findOperation(source.url, method);
+    const foundOperation = oas.findOperation(url, method);
     if (!foundOperation) {
       throw new Error(
-        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${source.url}`
+        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${url}`
       );
     }
 
@@ -116,7 +118,6 @@ const client: Client<APIOptions> = {
     const authSources = getAuthSources(operation);
 
     const { blank, push, join } = new CodeBuilder({ indent: opts.indent || '  ' });
-    // const code = new CodeBuilder(opts.indent);
 
     push(`const sdk = require('api')('${opts.apiDefinitionUri}');`);
     blank();
@@ -128,7 +129,7 @@ const client: Client<APIOptions> = {
     const configData = [];
     if ((apiDefinition.servers || []).length > 1) {
       const stockUrl = oas.url();
-      const baseUrl = source.url.replace(path, '');
+      const baseUrl = url.replace(path, '');
       if (baseUrl !== stockUrl) {
         const serverVars = oas.splitVariables(baseUrl);
         const serverUrl = serverVars ? oas.url(serverVars.selected, serverVars.variables) : baseUrl;
@@ -138,21 +139,21 @@ const client: Client<APIOptions> = {
     }
 
     let metadata: Record<string, string | string[]> = {};
-    Object.keys(source.queryObj).forEach(param => {
+    Object.keys(queryObj).forEach(param => {
       if (authSources.query.includes(param)) {
-        authData.push(buildAuthSnippet(source.queryObj[param]));
+        authData.push(buildAuthSnippet(queryObj[param]));
 
         // If this query param is part of an auth source then we don't want it doubled up in the
         // snippet.
         return;
       }
 
-      metadata[param] = source.queryObj[param];
+      metadata[param] = queryObj[param];
     });
 
-    Object.keys(source.cookiesObj).forEach(cookie => {
+    Object.keys(cookiesObj).forEach(cookie => {
       if (authSources.cookie.includes(cookie)) {
-        authData.push(buildAuthSnippet(source.cookiesObj[cookie]));
+        authData.push(buildAuthSnippet(cookiesObj[cookie]));
 
         // If this cookie is part of an auth source then we don't want it doubled up.
         return;
@@ -161,36 +162,34 @@ const client: Client<APIOptions> = {
       // 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];
+      metadata[cookie] = 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 we have path parameters present we should add them into the metadata object.
+    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;
+    if (Object.keys(headersObj).length) {
+      const headers = headersObj;
+      const requestHeaders: ReducedHelperObject = {};
 
       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.
-        const headerLc = header.toLowerCase();
+        const headerLower = header.toLowerCase();
 
-        if (headerLc in authSources.header) {
+        if (headerLower in authSources.header) {
           // If this header has been set up as an authentication header, let's remove it and add it
           // into our auth data so we can build up an `.auth()` snippet for the SDK.
-          const authScheme = authSources.header[headerLc];
+          const authScheme = authSources.header[headerLower];
           if (authScheme === '*') {
             authData.push(buildAuthSnippet(headers[header]));
           } else {
             // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.
-            let authKey = headers[header].replace(`${authSources.header[headerLc]} `, '');
+            let authKey = headers[header].replace(`${authSources.header[headerLower]} `, '');
             if (authScheme.toLowerCase() === 'basic') {
               authKey = Buffer.from(authKey, 'base64').toString('ascii');
               authKey = authKey.split(':');
@@ -200,43 +199,51 @@ const client: Client<APIOptions> = {
           }
 
           delete headers[header];
-        } else if (headerLc === 'content-type') {
+          return;
+        } else if (headerLower === 'content-type') {
           // `Content-Type` headers are automatically added within the SDK so we can filter them out
           // if they don't have parameters attached to them.
           // @ts-expect-error `headers[header]` is typed improperly in HTTPSnippet.
           const parsedContentType = contentType.parse(headers[header]);
           if (!Object.keys(parsedContentType.parameters).length) {
             delete headers[header];
+            return;
           }
-        } else if (headerLc === 'accept') {
+        } else if (headerLower === 'accept') {
           // If the `Accept` header here is not the default or first `Accept` header for the
           // operations' request body then we should add it otherwise we can let the SDK handle it
           // itself.
           if (headers[header] === operation.getContentType()) {
             delete headers[header];
+            return;
           }
         }
+
+        // If we haven't used our header anywhere else, or we've deleted it from the payload
+        // because it'll be handled internally by `api` then we should add the lowercased version
+        // of our header into the generated code snippet.
+        requestHeaders[headerLower] = headers[header];
       });
 
-      if (Object.keys(headers).length > 0) {
-        metadata = Object.assign(metadata, headers);
+      if (Object.keys(requestHeaders).length > 0) {
+        metadata = Object.assign(metadata, requestHeaders);
       }
     }
 
     let body: any;
-    switch (source.postData.mimeType) {
+    switch (postData.mimeType) {
       case 'application/x-www-form-urlencoded':
-        body = source.postData.paramsObj;
+        body = postData.paramsObj;
         break;
 
       case 'application/json':
-        if (source.postData.jsonObj) {
-          body = source.postData.jsonObj;
+        if (postData.jsonObj) {
+          body = postData.jsonObj;
         }
         break;
 
       case 'multipart/form-data':
-        if (source.postData.params) {
+        if (postData.params) {
           body = {};
 
           // If there's a `Content-Type` header present in the metadata, but it's for the
@@ -247,7 +254,7 @@ const client: Client<APIOptions> = {
             delete metadata['content-type'];
           }
 
-          source.postData.params.forEach(function (param) {
+          postData.params.forEach(function (param) {
             if (param.fileName) {
               body[param.name] = param.fileName;
             } else {
@@ -258,25 +265,14 @@ const client: Client<APIOptions> = {
         break;
 
       default:
-        if (source.postData.text) {
-          body = source.postData.text;
+        if (postData.text) {
+          body = postData.text;
         }
     }
 
     const args = [];
 
-    let accessor: string = method;
-    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.
-      const slugs = Object.fromEntries(
-        Object.keys(operationSlugs).map(slug => [slug.replace(/:(.*)/, '$1'), operationSlugs[slug]])
-      );
-
-      args.push(`'${decodeURIComponent(oas.replaceUrl(path, slugs))}'`);
-    }
+    const accessor = operation.getOperationId({ camelCase: true });
 
     // If we're going to be rendering out body params and metadata we should cut their character
     // limit in half because we'll be rendering them in their own lines.
@@ -298,7 +294,7 @@ const client: Client<APIOptions> = {
     }
 
     push(`sdk.${accessor}(${args.join(', ')})`);
-    push('.then(res => console.log(res))', 1);
+    push('.then(({ data }) => console.log(data))', 1);
     push('.catch(err => console.error(err));', 1);
 
     return join();