swagger-client 3.37.8 → 3.38.1

package/es/execute/index.js

@@ -15,6 +15,8 @@ import { getOperationRaw, idFromPathMethodLegacy } from '../helpers/index.js';
 import { isOpenAPI3 } from '../helpers/openapi-predicates.js';
 import { serialize as serializeCookie } from '../helpers/cookie.js';
 const arrayOrEmpty = ar => Array.isArray(ar) ? ar : [];
+const HTTP_METHOD_TOKEN = /^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/;
+const isValidHttpMethod = method => typeof method === 'string' && HTTP_METHOD_TOKEN.test(method);
 const findObjectOrArraySchema = (schema, {
   recurse = true,
   depth = 1
@@ -215,6 +217,9 @@ export function buildRequest(options) {
     method,
     pathName
   } = operationRaw;
+  if (!isValidHttpMethod(method)) {
+    throw new Error('Invalid HTTP method');
+  }
   baseURL = baseURL ?? baseUrl({
     spec,
     scheme,
@@ -223,6 +228,7 @@ export function buildRequest(options) {
     serverVariables,
     pathName,
     method,
+    operation,
     serverVariableEncoder
   });
   req.url += baseURL;
@@ -237,7 +243,9 @@ export function buildRequest(options) {
     return req;
   }
   req.url += pathName; // Have not yet replaced the path parameters
-  req.method = `${method}`.toUpperCase();
+  // Standard operations are normalized by eachOperation; additionalOperations
+  // must retain the exact HTTP method token defined by the OAS 3.2 document.
+  req.method = method;
   parameters = parameters || {};
   const path = spec.paths[pathName] || {};
   if (responseContentType) {
@@ -356,6 +364,7 @@ function oas3BaseUrl({
   spec,
   pathName,
   method,
+  operation,
   server,
   contextUrl,
   serverVariables = {},
@@ -366,7 +375,7 @@ function oas3BaseUrl({
   let selectedServerObj;
 
   // compute the servers (this will be taken care of by ApiDOM refrator plugins in future
-  const operationLevelServers = spec?.paths?.[pathName]?.[(method || '').toLowerCase()]?.servers;
+  const operationLevelServers = operation?.servers ?? spec?.paths?.[pathName]?.[(method || '').toLowerCase()]?.servers;
   const pathItemLevelServers = spec?.paths?.[pathName]?.servers;
   const rootLevelServers = spec?.servers;
   servers = isNonEmptyServerList(operationLevelServers) // eslint-disable-line no-nested-ternary

package/es/helpers/each-operation.js

@@ -1,3 +1,5 @@
+import { isOpenAPI32 } from './openapi-predicates.js';
+
 // iterate over each operation, and fire a callback with details
 // `find=true` will stop iterating, when the cb returns truthy
 export default function eachOperation(spec, cb, find) {
@@ -7,13 +9,14 @@ export default function eachOperation(spec, cb, find) {
   const {
     paths
   } = spec;
+  const supportsAdditionalOperations = isOpenAPI32(spec);
 
   // Iterate over the spec, collecting operations
   // eslint-disable-next-line no-restricted-syntax, guard-for-in
   for (const pathName in paths) {
     // eslint-disable-next-line no-restricted-syntax, guard-for-in
     for (const method in paths[pathName]) {
-      if (method.toUpperCase() === 'PARAMETERS') {
+      if (method.toUpperCase() === 'PARAMETERS' || method === 'additionalOperations') {
         continue; // eslint-disable-line no-continue
       }
       const operation = paths[pathName][method];
@@ -31,6 +34,28 @@ export default function eachOperation(spec, cb, find) {
         return operationObj;
       }
     }
+    const {
+      additionalOperations
+    } = paths[pathName];
+    if (supportsAdditionalOperations && additionalOperations && typeof additionalOperations === 'object') {
+      // eslint-disable-next-line no-restricted-syntax
+      for (const method of Object.keys(additionalOperations)) {
+        const operation = additionalOperations[method];
+        if (!operation || typeof operation !== 'object') {
+          continue; // eslint-disable-line no-continue
+        }
+        const operationObj = {
+          spec,
+          pathName,
+          method,
+          operation
+        };
+        const cbValue = cb(operationObj);
+        if (find && cbValue) {
+          return operationObj;
+        }
+      }
+    }
   }
   return undefined;
 }

package/es/helpers/id-from-path-method/index.js

@@ -1,4 +1,5 @@
 import replaceSpecialCharsWithUnderscore from '../replace-special-chars-with-underscore.js';
+const STANDARD_HTTP_METHODS = new Set(['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'query', 'trace']);
 export default function idFromPathMethod(pathName, method, {
   v2OperationIdCompatibilityMode
 } = {}) {
@@ -7,5 +8,6 @@ export default function idFromPathMethod(pathName, method, {
     res = res || `${pathName.substring(1)}_${method}`;
     return res.replace(/((_){2,})/g, '_').replace(/^(_)*/g, '').replace(/([_])*$/g, '');
   }
-  return `${method.toLowerCase()}${replaceSpecialCharsWithUnderscore(pathName)}`;
+  const normalizedMethod = STANDARD_HTTP_METHODS.has(method.toLowerCase()) ? method.toLowerCase() : method;
+  return `${normalizedMethod}${replaceSpecialCharsWithUnderscore(pathName)}`;
 }

package/es/interfaces.js

@@ -9,7 +9,7 @@ export const self = {
 };
 
 // Make an execute, bound to arguments defined in mapTagOperation's callback (cb)
-export function makeExecute(swaggerJs = {}) {
+export function makeExecute(swaggerClient = {}) {
   return ({
     pathName,
     method,
@@ -19,9 +19,9 @@ export function makeExecute(swaggerJs = {}) {
       requestInterceptor,
       responseInterceptor,
       userFetch
-    } = swaggerJs;
-    return swaggerJs.execute({
-      spec: swaggerJs.spec,
+    } = swaggerClient;
+    return swaggerClient.execute({
+      spec: swaggerClient.spec,
       requestInterceptor,
       responseInterceptor,
       userFetch,
@@ -38,12 +38,12 @@ export function makeExecute(swaggerJs = {}) {
 // The shape
 // { apis: { [tag]: { operations: [operation]: { execute }}}}
 // NOTE: this is mostly for compatibility
-export function makeApisTagOperationsOperationExecute(swaggerJs = {}) {
+export function makeApisTagOperationsOperationExecute(swaggerClient = {}) {
   // { apis: tag: operations: execute }
-  const cb = self.makeExecute(swaggerJs);
+  const cb = self.makeExecute(swaggerClient);
   const tagOperations = self.mapTagOperations({
-    v2OperationIdCompatibilityMode: swaggerJs.v2OperationIdCompatibilityMode,
-    spec: swaggerJs.spec,
+    v2OperationIdCompatibilityMode: swaggerClient.v2OperationIdCompatibilityMode,
+    spec: swaggerClient.spec,
     cb
   });
   const apis = {};
@@ -65,12 +65,12 @@ export function makeApisTagOperationsOperationExecute(swaggerJs = {}) {
 }
 
 // .apis[tag][operationId]:ExecuteFunction interface
-export function makeApisTagOperation(swaggerJs = {}) {
-  const cb = self.makeExecute(swaggerJs);
+export function makeApisTagOperation(swaggerClient = {}) {
+  const cb = self.makeExecute(swaggerClient);
   return {
     apis: self.mapTagOperations({
-      v2OperationIdCompatibilityMode: swaggerJs.v2OperationIdCompatibilityMode,
-      spec: swaggerJs.spec,
+      v2OperationIdCompatibilityMode: swaggerClient.v2OperationIdCompatibilityMode,
+      spec: swaggerClient.spec,
       cb
     })
   };

package/lib/execute/index.js

@@ -24,6 +24,8 @@ var _index3 = require("../helpers/index.js");
 var _openapiPredicates = require("../helpers/openapi-predicates.js");
 var _cookie = require("../helpers/cookie.js");
 const arrayOrEmpty = ar => Array.isArray(ar) ? ar : [];
+const HTTP_METHOD_TOKEN = /^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$/;
+const isValidHttpMethod = method => typeof method === 'string' && HTTP_METHOD_TOKEN.test(method);
 const findObjectOrArraySchema = (schema, {
   recurse = true,
   depth = 1
@@ -224,6 +226,9 @@ function buildRequest(options) {
     method,
     pathName
   } = operationRaw;
+  if (!isValidHttpMethod(method)) {
+    throw new Error('Invalid HTTP method');
+  }
   baseURL = baseURL ?? baseUrl({
     spec,
     scheme,
@@ -232,6 +237,7 @@ function buildRequest(options) {
     serverVariables,
     pathName,
     method,
+    operation,
     serverVariableEncoder
   });
   req.url += baseURL;
@@ -246,7 +252,9 @@ function buildRequest(options) {
     return req;
   }
   req.url += pathName; // Have not yet replaced the path parameters
-  req.method = `${method}`.toUpperCase();
+  // Standard operations are normalized by eachOperation; additionalOperations
+  // must retain the exact HTTP method token defined by the OAS 3.2 document.
+  req.method = method;
   parameters = parameters || {};
   const path = spec.paths[pathName] || {};
   if (responseContentType) {
@@ -365,6 +373,7 @@ function oas3BaseUrl({
   spec,
   pathName,
   method,
+  operation,
   server,
   contextUrl,
   serverVariables = {},
@@ -375,7 +384,7 @@ function oas3BaseUrl({
   let selectedServerObj;
 
   // compute the servers (this will be taken care of by ApiDOM refrator plugins in future
-  const operationLevelServers = spec?.paths?.[pathName]?.[(method || '').toLowerCase()]?.servers;
+  const operationLevelServers = operation?.servers ?? spec?.paths?.[pathName]?.[(method || '').toLowerCase()]?.servers;
   const pathItemLevelServers = spec?.paths?.[pathName]?.servers;
   const rootLevelServers = spec?.servers;
   servers = isNonEmptyServerList(operationLevelServers) // eslint-disable-line no-nested-ternary

package/lib/helpers/each-operation.js

@@ -2,6 +2,7 @@
 
 exports.__esModule = true;
 exports.default = eachOperation;
+var _openapiPredicates = require("./openapi-predicates.js");
 // iterate over each operation, and fire a callback with details
 // `find=true` will stop iterating, when the cb returns truthy
 function eachOperation(spec, cb, find) {
@@ -11,13 +12,14 @@ function eachOperation(spec, cb, find) {
   const {
     paths
   } = spec;
+  const supportsAdditionalOperations = (0, _openapiPredicates.isOpenAPI32)(spec);
 
   // Iterate over the spec, collecting operations
   // eslint-disable-next-line no-restricted-syntax, guard-for-in
   for (const pathName in paths) {
     // eslint-disable-next-line no-restricted-syntax, guard-for-in
     for (const method in paths[pathName]) {
-      if (method.toUpperCase() === 'PARAMETERS') {
+      if (method.toUpperCase() === 'PARAMETERS' || method === 'additionalOperations') {
         continue; // eslint-disable-line no-continue
       }
       const operation = paths[pathName][method];
@@ -35,6 +37,28 @@ function eachOperation(spec, cb, find) {
         return operationObj;
       }
     }
+    const {
+      additionalOperations
+    } = paths[pathName];
+    if (supportsAdditionalOperations && additionalOperations && typeof additionalOperations === 'object') {
+      // eslint-disable-next-line no-restricted-syntax
+      for (const method of Object.keys(additionalOperations)) {
+        const operation = additionalOperations[method];
+        if (!operation || typeof operation !== 'object') {
+          continue; // eslint-disable-line no-continue
+        }
+        const operationObj = {
+          spec,
+          pathName,
+          method,
+          operation
+        };
+        const cbValue = cb(operationObj);
+        if (find && cbValue) {
+          return operationObj;
+        }
+      }
+    }
   }
   return undefined;
 }

package/lib/helpers/id-from-path-method/index.js

@@ -4,6 +4,7 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 exports.__esModule = true;
 exports.default = idFromPathMethod;
 var _replaceSpecialCharsWithUnderscore = _interopRequireDefault(require("../replace-special-chars-with-underscore.js"));
+const STANDARD_HTTP_METHODS = new Set(['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'query', 'trace']);
 function idFromPathMethod(pathName, method, {
   v2OperationIdCompatibilityMode
 } = {}) {
@@ -12,5 +13,6 @@ function idFromPathMethod(pathName, method, {
     res = res || `${pathName.substring(1)}_${method}`;
     return res.replace(/((_){2,})/g, '_').replace(/^(_)*/g, '').replace(/([_])*$/g, '');
   }
-  return `${method.toLowerCase()}${(0, _replaceSpecialCharsWithUnderscore.default)(pathName)}`;
+  const normalizedMethod = STANDARD_HTTP_METHODS.has(method.toLowerCase()) ? method.toLowerCase() : method;
+  return `${normalizedMethod}${(0, _replaceSpecialCharsWithUnderscore.default)(pathName)}`;
 }

package/lib/interfaces.js

@@ -17,7 +17,7 @@ const self = exports.self = {
 };
 
 // Make an execute, bound to arguments defined in mapTagOperation's callback (cb)
-function makeExecute(swaggerJs = {}) {
+function makeExecute(swaggerClient = {}) {
   return ({
     pathName,
     method,
@@ -27,9 +27,9 @@ function makeExecute(swaggerJs = {}) {
       requestInterceptor,
       responseInterceptor,
       userFetch
-    } = swaggerJs;
-    return swaggerJs.execute({
-      spec: swaggerJs.spec,
+    } = swaggerClient;
+    return swaggerClient.execute({
+      spec: swaggerClient.spec,
       requestInterceptor,
       responseInterceptor,
       userFetch,
@@ -46,12 +46,12 @@ function makeExecute(swaggerJs = {}) {
 // The shape
 // { apis: { [tag]: { operations: [operation]: { execute }}}}
 // NOTE: this is mostly for compatibility
-function makeApisTagOperationsOperationExecute(swaggerJs = {}) {
+function makeApisTagOperationsOperationExecute(swaggerClient = {}) {
   // { apis: tag: operations: execute }
-  const cb = self.makeExecute(swaggerJs);
+  const cb = self.makeExecute(swaggerClient);
   const tagOperations = self.mapTagOperations({
-    v2OperationIdCompatibilityMode: swaggerJs.v2OperationIdCompatibilityMode,
-    spec: swaggerJs.spec,
+    v2OperationIdCompatibilityMode: swaggerClient.v2OperationIdCompatibilityMode,
+    spec: swaggerClient.spec,
     cb
   });
   const apis = {};
@@ -73,12 +73,12 @@ function makeApisTagOperationsOperationExecute(swaggerJs = {}) {
 }
 
 // .apis[tag][operationId]:ExecuteFunction interface
-function makeApisTagOperation(swaggerJs = {}) {
-  const cb = self.makeExecute(swaggerJs);
+function makeApisTagOperation(swaggerClient = {}) {
+  const cb = self.makeExecute(swaggerClient);
   return {
     apis: self.mapTagOperations({
-      v2OperationIdCompatibilityMode: swaggerJs.v2OperationIdCompatibilityMode,
-      spec: swaggerJs.spec,
+      v2OperationIdCompatibilityMode: swaggerClient.v2OperationIdCompatibilityMode,
+      spec: swaggerClient.spec,
       cb
     })
   };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "swagger-client",
-  "version": "3.37.8",
-  "description": "SwaggerJS - a collection of interfaces for OAI specs",
+  "version": "3.38.1",
+  "description": "Swagger Client - a collection of interfaces for OAI specs",
   "browser": {
     "./src/helpers/btoa.node.js": "./src/helpers/btoa.browser.js",
     "./lib/helpers/btoa.node.js": "./lib/helpers/btoa.browser.js",
@@ -14,7 +14,7 @@
   "module": "es/index.js",
   "jsnext:main": "es/index.js",
   "unpkg": "dist/swagger-client.browser.min.js",
-  "repository": "git@github.com:swagger-api/swagger-js.git",
+  "repository": "git@github.com:swagger-api/swagger-client.git",
   "contributors": [
     "(in alphabetical order)",
     "Anna Bodnia <anna.bodnia@gmail.com>",
@@ -74,17 +74,17 @@
   "dependencies": {
     "@babel/runtime-corejs3": "^7.22.15",
     "@scarf/scarf": "=1.4.0",
-    "@swagger-api/apidom-core": "^1.12.0",
-    "@swagger-api/apidom-error": "^1.12.0",
-    "@swagger-api/apidom-json-pointer": "^1.12.0",
-    "@swagger-api/apidom-ns-openapi-3-1": "^1.12.0",
-    "@swagger-api/apidom-ns-openapi-3-2": "^1.12.0",
-    "@swagger-api/apidom-reference": "^1.12.0",
+    "@swagger-api/apidom-core": "~1.11.3",
+    "@swagger-api/apidom-error": "~1.11.3",
+    "@swagger-api/apidom-json-pointer": "~1.11.3",
+    "@swagger-api/apidom-ns-openapi-3-1": "~1.11.3",
+    "@swagger-api/apidom-ns-openapi-3-2": "~1.11.3",
+    "@swagger-api/apidom-reference": "~1.11.3",
     "@swaggerexpert/cookie": "^2.0.2",
     "deepmerge": "~4.3.0",
     "fast-json-patch": "^3.0.0-1",
-    "js-yaml": "^4.2.0",
-    "neotraverse": "=0.6.18",
+    "js-yaml": "^4.3.2",
+    "neotraverse": "=1.0.1",
     "node-abort-controller": "^3.1.1",
     "openapi-path-templating": "^2.2.1",
     "openapi-server-url-templating": "^1.3.0",
@@ -101,12 +101,12 @@
     "@commitlint/cli": "^20.4.1",
     "@commitlint/config-conventional": "^20.4.1",
     "babel-loader": "=10.1.1",
-    "cross-env": "=7.0.3",
+    "cross-env": "=10.1.0",
     "eslint": "^8.42.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "=10.1.8",
     "eslint-plugin-import": "=2.32.0",
-    "eslint-plugin-prettier": "=5.5.4",
+    "eslint-plugin-prettier": "=5.5.6",
     "expect": "^30.3.0",
     "glob": "=13.0.6",
     "husky": "^9.0.11",
@@ -116,40 +116,50 @@
     "jest-environment-jsdom": "^30.4.1",
     "json-loader": "=0.5.7",
     "license-checker": "=25.0.1",
-    "lint-staged": "=16.2.7",
+    "lint-staged": "=17.3.0",
     "lodash": "^4.17.21",
     "npm-run-all": "=4.1.5",
-    "prettier": "^3.1.1",
-    "rimraf": "=6.1.2",
+    "prettier": "^3.9.6",
+    "rimraf": "=6.1.3",
     "source-map-explorer": "^2.5.3",
     "terser-webpack-plugin": "^5.0.3",
     "undici": "^6.27.0",
     "webpack": "=5.106.2",
     "webpack-bundle-size-analyzer": "=3.1.0",
-    "webpack-cli": "=7.0.2",
+    "webpack-cli": "=7.2.2",
     "webpack-stats-plugin": "=1.1.3"
   },
   "optionalDependencies": {
-    "@swagger-api/apidom-ns-asyncapi-2": "^1.12.0",
-    "@swagger-api/apidom-ns-asyncapi-3": "^1.12.0",
-    "@swagger-api/apidom-ns-openapi-2": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-api-design-systems-json": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-api-design-systems-yaml": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-asyncapi-json-2": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-asyncapi-json-3": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-asyncapi-yaml-2": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-asyncapi-yaml-3": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-json": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-json-2": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-yaml-2": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-json-3-0": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-json-3-1": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-json-3-2": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-0": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-1": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-2": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-arazzo-json-1": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-arazzo-yaml-1": "^1.12.0",
-    "@swagger-api/apidom-parser-adapter-yaml-1-2": "^1.12.0"
+    "@swagger-api/apidom-ns-asyncapi-2": "~1.11.3",
+    "@swagger-api/apidom-ns-asyncapi-3": "~1.11.3",
+    "@swagger-api/apidom-ns-openapi-2": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-api-design-systems-json": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-api-design-systems-yaml": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-asyncapi-json-2": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-asyncapi-json-3": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-asyncapi-yaml-2": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-asyncapi-yaml-3": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-json": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-json-2": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-yaml-2": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-json-3-0": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-json-3-1": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-json-3-2": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-0": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-1": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-openapi-yaml-3-2": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-arazzo-json-1": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-arazzo-yaml-1": "~1.11.3",
+    "@swagger-api/apidom-parser-adapter-yaml-1-2": "~1.11.3"
+  },
+  "allowScripts": {
+    "tree-sitter@0.22.4": true,
+    "tree-sitter@0.21.1": true,
+    "@tree-sitter-grammars/tree-sitter-yaml@0.7.1": true,
+    "tree-sitter-json@0.24.8": true,
+    "fsevents@2.3.3": true,
+    "unrs-resolver@1.12.2": true,
+    "@scarf/scarf": false,
+    "core-js-pure": false
   }
 }