httpsnippet-client-api 5.0.0-beta.3 → 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/dist/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

@@ -25,10 +25,10 @@ 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));
@@ -157,16 +157,13 @@ var client = {
             // snippet generator.
             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 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 = {};
@@ -257,16 +254,7 @@ var client = {
                 }
         }
         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;
@@ -283,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.3",
+  "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.3.4"
+    "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.3",
+    "api": "^5.0.0",
     "chai": "^4.3.6",
     "fetch-mock": "^9.11.0",
     "isomorphic-fetch": "^3.0.0",
@@ -53,5 +53,5 @@
       "test/"
     ]
   },
-  "gitHead": "24d5b83545735176786d212a69121a029cf6dea1"
+  "gitHead": "bb044ecdb3296c24838056764553fa7f18e6d228"
 }

package/src/index.ts

@@ -1,12 +1,12 @@
+import type { ReducedHelperObject } from '@readme/httpsnippet/dist/helpers/reducer';
+import type { Client } from '@readme/httpsnippet/dist/targets/targets';
 import type { Operation } from 'oas';
 import type { HttpMethods, OASDocument } from 'oas/dist/rmoas.types';
-import type { Client } from '@readme/httpsnippet/dist/targets/targets';
-import type { ReducedHelperObject } from '@readme/httpsnippet/dist/helpers/reducer';
 
-import stringifyObject from 'stringify-object';
 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';
@@ -165,15 +165,12 @@ const client: Client<APIOptions> = {
       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(headersObj).length) {
       const headers = headersObj;
@@ -275,18 +272,7 @@ const client: Client<APIOptions> = {
 
     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.
@@ -308,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();