openapi-explorer 2.2.772 → 2.2.774

package/dist/es/openapi-explorer.js

@@ -495,24 +495,6 @@ export default class OpenApiExplorer extends LitElement {
       }
     }, isExpandingNeeded ? 150 : 0);
   }
-  isValidTopId(id) {
-    return id.startsWith('overview') || id === 'servers' || id === 'auth';
-  }
-  isValidPathId(id) {
-    if (id === 'overview' && !this.hideInfo) {
-      return true;
-    }
-    if (id === 'servers' && !this.hideServerSelection) {
-      return true;
-    }
-    if (id === 'auth' && !this.hideAuthentication) {
-      return true;
-    }
-    if (id.startsWith('tag--')) {
-      return this.resolvedSpec.tags && this.resolvedSpec.tags.find(tag => tag.elementId === id);
-    }
-    return this.resolvedSpec.tags && this.resolvedSpec.tags.find(tag => tag.paths.find(path => path.elementId === id));
-  }
   onIntersect(entries) {
     if (this.isIntersectionObserverActive === false) {
       return;
@@ -630,15 +612,21 @@ export default class OpenApiExplorer extends LitElement {
 
     // explorerLocation will get validated in the focused-endpoint-template
     this.explorerLocation = elementId;
-    const tag = this.resolvedSpec.tags.find(t => t.paths.some(p => p.elementId === elementId));
-    if (tag) {
-      tag.expanded = true;
+    const tagFoundByPath = this.resolvedSpec.tags.find(t => t.paths.some(p => p.elementId === elementId));
+    if (tagFoundByPath) {
+      tagFoundByPath.expanded = true;
     }
+
     // Convert to Async and to the background, so that we can be sure that the operation has been expanded and put into view before trying to directly scroll to it (or it won't be found in the next line and even if it is, it might not be able to be scrolled into view)
     await sleep(0);
 
     // In the case of section scrolling, these are hard swaps, so just load "section". In the case of `tags` the headers have the element html Id in the last `--id`, so split that off and check for it
-    const contentEl = this.shadowRoot.getElementById(elementId !== null && elementId !== void 0 && elementId.startsWith('section') ? 'section' : elementId) || this.shadowRoot.getElementById(elementId.split('--').slice(-1)[0]);
+    // NOTE: Really this whole nonsense is because Marked, inserts -- between the prefix and the type and we cannot control it at all. When upgrading to Node 20, marked 16+, we will have to change this and we might even be able to make it work correctly. The biggest problem is that both the separator `--` and invalid character replacement `-`, can stack up.
+    const contentEl = this.shadowRoot.getElementById(elementId !== null && elementId !== void 0 && elementId.startsWith('section') ? 'section' : elementId)
+    // Remove the prefix of the section as headers in sub sections are not prefixed with the type.
+    || elementId.split('--').length > 1 && this.shadowRoot.getElementById(elementId.split('--').slice(1).join('--'))
+    // Remove the prefix of the operation (tag--) and the tag name (tag--NAME--) from header, as headers in sub sections are not prefixed with the type.
+    || elementId.split('--').length > 2 && this.shadowRoot.getElementById(elementId.split('--').slice(2).join('--')) || this.shadowRoot.getElementById(elementId.split('--').slice(-1)[0]);
     if (!contentEl) {
       return;
     }
@@ -684,8 +672,8 @@ export default class OpenApiExplorer extends LitElement {
       // Update Location Hash
       replaceState(elementId);
       newNavEl = this.shadowRoot.getElementById(`link-${elementId}`);
-    } else if (!elementId.match('cmp--') && !elementId.match('tag--')) {
-      this.shadowRoot.getElementById('operations-root').scrollIntoView({
+    } else if (elementId.match('cmp--') || elementId.match('tag--') || elementId.match('overview--') || elementId.match('auth--') || elementId.match('servers--')) {
+      contentEl.scrollIntoView({
         behavior: 'auto',
         block: 'start'
       });
@@ -694,7 +682,7 @@ export default class OpenApiExplorer extends LitElement {
       replaceState(elementId);
       newNavEl = this.shadowRoot.getElementById(`link-${elementId}`);
     } else {
-      contentEl.scrollIntoView({
+      this.shadowRoot.getElementById('operations-root').scrollIntoView({
         behavior: 'auto',
         block: 'start'
       });

package/dist/es/utils/common-utils.js

@@ -12,7 +12,7 @@ export function debounce(fn, delay) {
     }, delay);
   };
 }
-export const invalidCharsRegEx = new RegExp(/[\s#:?&={}]/, 'g'); // used for generating valid html element ids by replacing the invalid chars with hyphen (-)
+export const invalidCharsRegEx = new RegExp(/[\s#:?&={}-]+/, 'g'); // used for generating valid html element ids by replacing the invalid chars with hyphen (-)
 
 export function sleep(ms) {
   return new Promise(resolve => setTimeout(resolve, ms));

package/dist/lib/openapi-explorer.js

@@ -501,24 +501,6 @@ class OpenApiExplorer extends _lit.LitElement {
       }
     }, isExpandingNeeded ? 150 : 0);
   }
-  isValidTopId(id) {
-    return id.startsWith('overview') || id === 'servers' || id === 'auth';
-  }
-  isValidPathId(id) {
-    if (id === 'overview' && !this.hideInfo) {
-      return true;
-    }
-    if (id === 'servers' && !this.hideServerSelection) {
-      return true;
-    }
-    if (id === 'auth' && !this.hideAuthentication) {
-      return true;
-    }
-    if (id.startsWith('tag--')) {
-      return this.resolvedSpec.tags && this.resolvedSpec.tags.find(tag => tag.elementId === id);
-    }
-    return this.resolvedSpec.tags && this.resolvedSpec.tags.find(tag => tag.paths.find(path => path.elementId === id));
-  }
   onIntersect(entries) {
     if (this.isIntersectionObserverActive === false) {
       return;
@@ -636,15 +618,21 @@ class OpenApiExplorer extends _lit.LitElement {
 
     // explorerLocation will get validated in the focused-endpoint-template
     this.explorerLocation = elementId;
-    const tag = this.resolvedSpec.tags.find(t => t.paths.some(p => p.elementId === elementId));
-    if (tag) {
-      tag.expanded = true;
+    const tagFoundByPath = this.resolvedSpec.tags.find(t => t.paths.some(p => p.elementId === elementId));
+    if (tagFoundByPath) {
+      tagFoundByPath.expanded = true;
     }
+
     // Convert to Async and to the background, so that we can be sure that the operation has been expanded and put into view before trying to directly scroll to it (or it won't be found in the next line and even if it is, it might not be able to be scrolled into view)
     await (0, _commonUtils.sleep)(0);
 
     // In the case of section scrolling, these are hard swaps, so just load "section". In the case of `tags` the headers have the element html Id in the last `--id`, so split that off and check for it
-    const contentEl = this.shadowRoot.getElementById(elementId !== null && elementId !== void 0 && elementId.startsWith('section') ? 'section' : elementId) || this.shadowRoot.getElementById(elementId.split('--').slice(-1)[0]);
+    // NOTE: Really this whole nonsense is because Marked, inserts -- between the prefix and the type and we cannot control it at all. When upgrading to Node 20, marked 16+, we will have to change this and we might even be able to make it work correctly. The biggest problem is that both the separator `--` and invalid character replacement `-`, can stack up.
+    const contentEl = this.shadowRoot.getElementById(elementId !== null && elementId !== void 0 && elementId.startsWith('section') ? 'section' : elementId)
+    // Remove the prefix of the section as headers in sub sections are not prefixed with the type.
+    || elementId.split('--').length > 1 && this.shadowRoot.getElementById(elementId.split('--').slice(1).join('--'))
+    // Remove the prefix of the operation (tag--) and the tag name (tag--NAME--) from header, as headers in sub sections are not prefixed with the type.
+    || elementId.split('--').length > 2 && this.shadowRoot.getElementById(elementId.split('--').slice(2).join('--')) || this.shadowRoot.getElementById(elementId.split('--').slice(-1)[0]);
     if (!contentEl) {
       return;
     }
@@ -690,8 +678,8 @@ class OpenApiExplorer extends _lit.LitElement {
       // Update Location Hash
       (0, _commonUtils.replaceState)(elementId);
       newNavEl = this.shadowRoot.getElementById(`link-${elementId}`);
-    } else if (!elementId.match('cmp--') && !elementId.match('tag--')) {
-      this.shadowRoot.getElementById('operations-root').scrollIntoView({
+    } else if (elementId.match('cmp--') || elementId.match('tag--') || elementId.match('overview--') || elementId.match('auth--') || elementId.match('servers--')) {
+      contentEl.scrollIntoView({
         behavior: 'auto',
         block: 'start'
       });
@@ -700,7 +688,7 @@ class OpenApiExplorer extends _lit.LitElement {
       (0, _commonUtils.replaceState)(elementId);
       newNavEl = this.shadowRoot.getElementById(`link-${elementId}`);
     } else {
-      contentEl.scrollIntoView({
+      this.shadowRoot.getElementById('operations-root').scrollIntoView({
         behavior: 'auto',
         block: 'start'
       });

package/dist/lib/utils/common-utils.js

@@ -27,7 +27,7 @@ function debounce(fn, delay) {
     }, delay);
   };
 }
-const invalidCharsRegEx = exports.invalidCharsRegEx = new RegExp(/[\s#:?&={}]/, 'g'); // used for generating valid html element ids by replacing the invalid chars with hyphen (-)
+const invalidCharsRegEx = exports.invalidCharsRegEx = new RegExp(/[\s#:?&={}-]+/, 'g'); // used for generating valid html element ids by replacing the invalid chars with hyphen (-)
 
 function sleep(ms) {
   return new Promise(resolve => setTimeout(resolve, ms));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-explorer",
-  "version": "2.2.772",
+  "version": "2.2.774",
   "description": "OpenAPI Explorer - API viewer with dynamically generated components, documentation, and interaction console",
   "author": "Authress Developers <developers@authress.io>",
   "type": "module",