oas 17.8.1 → 17.8.2

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## <small>17.8.2 (2022-03-21)</small>
+
+* fix: issue where hostname server variables wouldn't match subdomains or ports (#623) ([0630600](https://github.com/readmeio/oas/commit/0630600)), closes [#623](https://github.com/readmeio/oas/issues/623)
+
+
+
 ## <small>17.8.1 (2022-03-04)</small>
 
 * fix: typo in the `--pattern` option ([42db80a](https://github.com/readmeio/oas/commit/42db80a))

package/dist/index.js

@@ -84,6 +84,7 @@ exports.Callback = operation_1.Callback;
 exports.Webhook = operation_1.Webhook;
 var utils_1 = __importStar(require("./utils"));
 exports.utils = utils_1["default"];
+var SERVER_VARIABLE_REGEX = /{([-_a-zA-Z0-9:.[\]]+)}/g;
 function ensureProtocol(url) {
     // Add protocol to urls starting with // e.g. //example.com
     // This is because httpsnippet throws a HARError when it doesnt have a protocol
@@ -137,12 +138,12 @@ function normalizedUrl(api, selected) {
  *
  * For example, when given `https://{region}.node.example.com/v14` this will return back:
  *
- *    https://([-_a-zA-Z0-9[\\]]+).node.example.com/v14
+ *    https://([-_a-zA-Z0-9:.[\\]]+).node.example.com/v14
  *
  * @param url URL to transform
  */
 function transformUrlIntoRegex(url) {
-    return stripTrailingSlash(url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, '([-_a-zA-Z0-9[\\]]+)'));
+    return stripTrailingSlash(url.replace(SERVER_VARIABLE_REGEX, '([-_a-zA-Z0-9:.[\\]]+)'));
 }
 /**
  * Normalize a path so that we can use it with `path-to-regexp` to do operation lookups.
@@ -362,7 +363,7 @@ var Oas = /** @class */ (function () {
             // way we'll be able to extract the parameter names and match them up with the matched server that we obtained
             // above.
             var variables = {};
-            Array.from(server.url.matchAll(/{([-_a-zA-Z0-9[\]]+)}/g)).forEach(function (variable, y) {
+            Array.from(server.url.matchAll(SERVER_VARIABLE_REGEX)).forEach(function (variable, y) {
                 variables[variable[1]] = found[y + 1];
             });
             return {
@@ -396,7 +397,7 @@ var Oas = /** @class */ (function () {
         if (variables === void 0) { variables = {}; }
         // When we're constructing URLs, server URLs with trailing slashes cause problems with doing lookups, so if we have
         // one here on, slice it off.
-        return stripTrailingSlash(url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, function (original, key) {
+        return stripTrailingSlash(url.replace(SERVER_VARIABLE_REGEX, function (original, key) {
             var userVariable = (0, get_user_variable_1["default"])(_this.user, key);
             if (userVariable) {
                 return userVariable;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "17.8.1",
+  "version": "17.8.2",
   "description": "Working with OpenAPI definitions is hard. This makes it easier.",
   "license": "MIT",
   "author": "ReadMe <support@readme.io> (https://readme.com)",

package/src/index.ts

@@ -24,6 +24,8 @@ type PathMatches = PathMatch[];
 
 type Variables = Record<string, string | number | { default?: string | number }[] | { default?: string | number }>;
 
+const SERVER_VARIABLE_REGEX = /{([-_a-zA-Z0-9:.[\]]+)}/g;
+
 function ensureProtocol(url: string) {
   // Add protocol to urls starting with // e.g. //example.com
   // This is because httpsnippet throws a HARError when it doesnt have a protocol
@@ -84,12 +86,12 @@ function normalizedUrl(api: RMOAS.OASDocument, selected: number) {
  *
  * For example, when given `https://{region}.node.example.com/v14` this will return back:
  *
- *    https://([-_a-zA-Z0-9[\\]]+).node.example.com/v14
+ *    https://([-_a-zA-Z0-9:.[\\]]+).node.example.com/v14
  *
  * @param url URL to transform
  */
 function transformUrlIntoRegex(url: string) {
-  return stripTrailingSlash(url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, '([-_a-zA-Z0-9[\\]]+)'));
+  return stripTrailingSlash(url.replace(SERVER_VARIABLE_REGEX, '([-_a-zA-Z0-9:.[\\]]+)'));
 }
 
 /**
@@ -365,7 +367,7 @@ export default class Oas {
         // way we'll be able to extract the parameter names and match them up with the matched server that we obtained
         // above.
         const variables: Record<string, string | number> = {};
-        Array.from(server.url.matchAll(/{([-_a-zA-Z0-9[\]]+)}/g)).forEach((variable, y) => {
+        Array.from(server.url.matchAll(SERVER_VARIABLE_REGEX)).forEach((variable, y) => {
           variables[variable[1]] = found[y + 1];
         });
 
@@ -401,7 +403,7 @@ export default class Oas {
     // When we're constructing URLs, server URLs with trailing slashes cause problems with doing lookups, so if we have
     // one here on, slice it off.
     return stripTrailingSlash(
-      url.replace(/{([-_a-zA-Z0-9[\]]+)}/g, (original: string, key: string) => {
+      url.replace(SERVER_VARIABLE_REGEX, (original: string, key: string) => {
         const userVariable = getUserVariable(this.user, key);
         if (userVariable) {
           return userVariable as string;