oas 18.0.3 → 18.0.6

package/@types/operation.d.ts

@@ -79,7 +79,8 @@ export default class Operation {
     prepareSecurity(): Record<SecurityType, RMOAS.KeyedSecuritySchemeObject[]>;
     getHeaders(): Operation['headers'];
     /**
-     * Determine if the operation has an operation present in its schema.
+     * Determine if the operation has an operation present in its schema. Note that if one is present
+     * in the schema but is an empty string then this will return false.
      *
      */
     hasOperationId(): boolean;

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+## <small>18.0.6 (2022-03-21)</small>
+
+* feat: `camelCase` opt on `getOperationId()` should clean IDs if present (#625) ([6ab85df](https://github.com/readmeio/oas/commit/6ab85df)), closes [#625](https://github.com/readmeio/oas/issues/625)
+
+
+
+## <small>18.0.5 (2022-03-21)</small>
+
+* fix: `operation.hasOperationId` should return false for an empty string (#624) ([bc23a43](https://github.com/readmeio/oas/commit/bc23a43)), closes [#624](https://github.com/readmeio/oas/issues/624)
+
+
+
+## <small>18.0.4 (2022-03-21)</small>
+
+* docs: updating the changelog for 17.8.2 ([18c853c](https://github.com/readmeio/oas/commit/18c853c))
+* chore: removing some docs from this repo as they're now in our .github/ repo ([776dbe5](https://github.com/readmeio/oas/commit/776dbe5))
+* fix: issue where hostname server variables wouldn't match subdomains or ports (#623) ([9e84ded](https://github.com/readmeio/oas/commit/9e84ded)), closes [#623](https://github.com/readmeio/oas/issues/623)
+
+
+
+## <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>18.0.3 (2022-03-18)</small>
 
 * fix: bumping oas-normalize to fix a nested babel dep issue ([3f45c98](https://github.com/readmeio/oas/commit/3f45c98))

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.
@@ -383,7 +384,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 {
@@ -417,7 +418,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/dist/operation.js

@@ -279,11 +279,12 @@ var Operation = /** @class */ (function () {
         return this.headers;
     };
     /**
-     * Determine if the operation has an operation present in its schema.
+     * Determine if the operation has an operation present in its schema. Note that if one is present
+     * in the schema but is an empty string then this will return false.
      *
      */
     Operation.prototype.hasOperationId = function () {
-        return 'operationId' in this.schema;
+        return Boolean('operationId' in this.schema && this.schema.operationId.length);
     };
     /**
      * Get an `operationId` for this operation. If one is not present (it's not required by the spec!)
@@ -293,25 +294,36 @@ var Operation = /** @class */ (function () {
      * @param opts.camelCase Generate a JS method-friendly operation ID when one isn't present.
      */
     Operation.prototype.getOperationId = function (opts) {
-        if ('operationId' in this.schema) {
-            return this.schema.operationId;
+        var operationId;
+        if (this.hasOperationId()) {
+            operationId = this.schema.operationId;
+        }
+        else {
+            operationId = this.path
+                .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
+                .replace(/^-|-$/g, '') // Don't start or end with -
+                .replace(/--+/g, '-') // Remove double --'s
+                .toLowerCase();
         }
         var method = this.method.toLowerCase();
-        var operationId = this.path
-            .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
-            .replace(/^-|-$/g, '') // Don't start or end with -
-            .replace(/--+/g, '-') // Remove double --'s
-            .toLowerCase();
         if (opts === null || opts === void 0 ? void 0 : opts.camelCase) {
             operationId = operationId.replace(/[^a-zA-Z0-9]+(.)/g, function (_, chr) { return chr.toUpperCase(); });
-            // If the generated operationId already starts with the method (eg. `getPets`) we don't want
+            // If the generated `operationId` already starts with the method (eg. `getPets`) we don't want
             // to double it up into `getGetPets`.
             if (operationId.startsWith(method)) {
                 return operationId;
             }
+            // If this operation already has an operationId and we just cleaned it up then we shouldn't
+            // prefix it with an HTTP method.
+            if (this.hasOperationId()) {
+                return operationId;
+            }
             operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
             return "".concat(method).concat(operationId);
         }
+        else if (this.hasOperationId()) {
+            return operationId;
+        }
         return "".concat(method, "_").concat(operationId);
     };
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas",
-  "version": "18.0.3",
+  "version": "18.0.6",
   "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:.[\\]]+)'));
 }
 
 /**
@@ -384,7 +386,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];
         });
 
@@ -420,7 +422,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;

package/src/operation.ts

@@ -315,11 +315,12 @@ export default class Operation {
   }
 
   /**
-   * Determine if the operation has an operation present in its schema.
+   * Determine if the operation has an operation present in its schema. Note that if one is present
+   * in the schema but is an empty string then this will return false.
    *
    */
   hasOperationId(): boolean {
-    return 'operationId' in this.schema;
+    return Boolean('operationId' in this.schema && this.schema.operationId.length);
   }
 
   /**
@@ -330,28 +331,37 @@ export default class Operation {
    * @param opts.camelCase Generate a JS method-friendly operation ID when one isn't present.
    */
   getOperationId(opts?: { camelCase: boolean }): string {
-    if ('operationId' in this.schema) {
-      return this.schema.operationId;
+    let operationId;
+    if (this.hasOperationId()) {
+      operationId = this.schema.operationId;
+    } else {
+      operationId = this.path
+        .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
+        .replace(/^-|-$/g, '') // Don't start or end with -
+        .replace(/--+/g, '-') // Remove double --'s
+        .toLowerCase();
     }
 
     const method = this.method.toLowerCase();
-    let operationId = this.path
-      .replace(/[^a-zA-Z0-9]/g, '-') // Remove weird characters
-      .replace(/^-|-$/g, '') // Don't start or end with -
-      .replace(/--+/g, '-') // Remove double --'s
-      .toLowerCase();
-
     if (opts?.camelCase) {
       operationId = operationId.replace(/[^a-zA-Z0-9]+(.)/g, (_, chr) => chr.toUpperCase());
 
-      // If the generated operationId already starts with the method (eg. `getPets`) we don't want
+      // If the generated `operationId` already starts with the method (eg. `getPets`) we don't want
       // to double it up into `getGetPets`.
       if (operationId.startsWith(method)) {
         return operationId;
       }
 
+      // If this operation already has an operationId and we just cleaned it up then we shouldn't
+      // prefix it with an HTTP method.
+      if (this.hasOperationId()) {
+        return operationId;
+      }
+
       operationId = operationId.charAt(0).toUpperCase() + operationId.slice(1);
       return `${method}${operationId}`;
+    } else if (this.hasOperationId()) {
+      return operationId;
     }
 
     return `${method}_${operationId}`;