httpsnippet-client-api 6.0.1 → 6.1.1

package/dist/index.d.ts

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

package/dist/index.js

@@ -10,6 +10,29 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 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)
@@ -27,8 +50,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 exports.__esModule = true;
 var code_builder_1 = require("@readme/httpsnippet/dist/helpers/code-builder");
 var content_type_1 = __importDefault(require("content-type"));
-var oas_1 = __importDefault(require("oas"));
+var oas_1 = __importStar(require("oas"));
 var stringify_object_1 = __importDefault(require("stringify-object"));
+var matchesMimeType = oas_1.utils.matchesMimeType;
 function stringify(obj, opts) {
     if (opts === void 0) { opts = {}; }
     return (0, stringify_object_1["default"])(obj, __assign({ indent: '  ' }, opts));
@@ -214,10 +238,9 @@ var client = {
                     }
                 }
                 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()) {
+                    // If the `Accept` header here is JSON-like header then we can remove it from the code
+                    // snippet because `api` natively supports and prioritizes JSON over any other mime type.
+                    if (matchesMimeType.json(headers_1[header])) {
                         delete headers_1[header];
                         return;
                     }

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "httpsnippet-client-api",
-  "version": "6.0.1",
+  "version": "6.1.1",
   "description": "An HTTPSnippet client for generating snippets for the `api` module.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "tsc",
+    "lint:types": "tsc --noEmit",
     "prebuild": "rm -rf dist/",
     "prepack": "npm run build",
-    "test": "nyc mocha \"test/**/*.test.ts\""
+    "test": "vitest --coverage"
   },
   "repository": {
     "type": "git",
@@ -36,22 +37,13 @@
     "@readme/openapi-parser": "^2.4.0",
     "@types/content-type": "^1.1.5",
     "@types/stringify-object": "^4.0.2",
-    "api": "^6.0.0",
-    "chai": "^4.3.7",
+    "@vitest/coverage-v8": "^0.34.1",
+    "api": "^6.1.1",
     "fetch-mock": "^9.11.0",
     "isomorphic-fetch": "^3.0.0",
-    "mocha": "^10.2.0",
-    "nyc": "^15.1.0",
-    "sinon": "^15.0.1",
-    "sinon-chai": "^3.7.0",
-    "typescript": "^4.9.5"
+    "typescript": "^4.9.5",
+    "vitest": "^0.34.1"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "nyc": {
-    "exclude": [
-      "dist/",
-      "test/"
-    ]
-  },
-  "gitHead": "5fe262d794d82935f08863341b0d95b9eb8ac39b"
+  "gitHead": "e440a28841e753895bfb5315b4d31f679824fa39"
 }

package/src/index.ts

@@ -5,9 +5,11 @@ 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 Oas, { utils } from 'oas';
 import stringifyObject from 'stringify-object';
 
+const { matchesMimeType } = utils;
+
 // This should really be an exported type in `oas`.
 type SecurityType = 'Basic' | 'Bearer' | 'Query' | 'Header' | 'Cookie' | 'OAuth2' | 'http' | 'apiKey';
 
@@ -35,7 +37,7 @@ function buildAuthSnippet(authKey: string | string[]) {
 }
 
 function getAuthSources(operation: Operation) {
-  const matchers: { header: Record<string, string>; query: string[]; cookie: string[] } = {
+  const matchers: { cookie: string[]; header: Record<string, string>; query: string[] } = {
     header: {},
     query: [],
     cookie: [],
@@ -79,8 +81,8 @@ function getAuthSources(operation: Operation) {
 export interface APIOptions {
   apiDefinition: OASDocument;
   apiDefinitionUri: string;
-  indent?: string | false;
   escapeBrackets?: boolean;
+  indent?: string | false;
 }
 
 const client: Client<APIOptions> = {
@@ -107,7 +109,7 @@ const client: Client<APIOptions> = {
     const foundOperation = oas.findOperation(url, method);
     if (!foundOperation) {
       throw new Error(
-        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${url}`
+        `Unable to locate a matching operation in the supplied \`apiDefinition\` for: ${source.method} ${url}`,
       );
     }
 
@@ -224,10 +226,9 @@ const client: Client<APIOptions> = {
             return;
           }
         } else if (headerLower === 'accept') {
-          // If the `Accept` header here is not the default or first `Accept` header for the
-          // operations' request body then we should add it otherwise we can let the SDK handle it
-          // itself.
-          if (headers[header] === operation.getContentType()) {
+          // If the `Accept` header here is JSON-like header then we can remove it from the code
+          // snippet because `api` natively supports and prioritizes JSON over any other mime type.
+          if (matchesMimeType.json(headers[header] as string)) {
             delete headers[header];
             return;
           }