api-console 6.6.66 → 6.6.69

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "api-console",
   "description": "The API Console to automatically generate API documentation from RAML and OAS files.",
-  "version": "6.6.66",
+  "version": "6.6.69",
   "license": "CPAL-1.0",
   "main": "index.js",
   "module": "index.js",
@@ -40,7 +40,7 @@
     "@api-components/amf-helper-mixin": "^4.5.36",
     "@api-components/api-console-ext-comm": "^3.0.0",
     "@api-components/api-documentation": "^6.1.8",
-    "@api-components/api-navigation": "^4.3.20",
+    "@api-components/api-navigation": "^4.3.22",
     "@api-components/api-request": "^0.3.8",
     "@api-components/api-summary": "^4.6.16",
     "@polymer/app-layout": "^3.1.0",
@@ -55,7 +55,7 @@
     "@anypoint-web-components/anypoint-listbox": "^1.0.4",
     "@anypoint-web-components/anypoint-menu-mixin": "^1.0.2",
     "@anypoint-web-components/anypoint-styles": "^1.0.1",
-    "@api-components/api-model-generator": "^0.2.14",
+    "@api-components/api-model-generator": "^0.4.0",
     "@commitlint/cli": "^13.2.1",
     "@commitlint/config-conventional": "^13.2.0",
     "@open-wc/building-rollup": "^1.2.6",
@@ -66,7 +66,7 @@
     "@web/test-runner": "^0.13.15",
     "@web/test-runner-playwright": "^0.11.0",
     "@web/test-runner-visual-regression": "^0.6.4",
-    "amf-client-js": "^5.4.4",
+    "amf-client-js": "^5.12.0",
     "body-parser": "^1.19.0",
     "deepmerge": "^4.2.1",
     "eslint": "^8.0.0",
@@ -120,7 +120,7 @@
     ]
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=18.0.0"
   },
   "remarkConfig": {
     "settings": {
@@ -155,7 +155,8 @@
     "semver": "7.5.4",
     "decode-uri-component": "0.4.1",
     "set-value": "4.1.0",
-    "dompurify": "3.4.5"
+    "dompurify": "3.4.5",
+    "amf-client-js": "$amf-client-js"
   },
   "resolutions": {
     "dompurify": "3.4.5"

package/src/ApiConsole.js

@@ -523,9 +523,36 @@ export class ApiConsole extends AmfHelperMixin(LitElement) {
    * `request`.
    */
   _tryitHandler() {
+    if (this._isWebhookOperation(this.selectedShape, this.webApi)) {
+      return;
+    }
     this.page = 'request';
   }
 
+  /**
+   * Whether `selected` is an OAS 3.1/3.2 top-level webhook operation.
+   * Webhooks have no invokable URL — the API calls the consumer, not the
+   * other way around — so the request/response "try it" panel doesn't
+   * apply to them.
+   * @param {String} selected Currently selected AMF shape (@id).
+   * @param {Object} webApi Computed AMF WebAPI model.
+   * @return {Boolean}
+   */
+  _isWebhookOperation(selected, webApi) {
+    if (!selected || !webApi || typeof this._computeWebhooks !== 'function') {
+      return false;
+    }
+    const webhooks = this._computeWebhooks(webApi);
+    if (!webhooks || !webhooks.length) {
+      return false;
+    }
+    const opKey = this._getAmfKey(this.ns.aml.vocabularies.apiContract.supportedOperation);
+    return webhooks.some((webhook) => {
+      const operations = this._ensureArray(webhook[opKey]);
+      return operations && operations.some((op) => op['@id'] === selected);
+    });
+  }
+
   /**
    * Resets current selection to "summary" page
    */
@@ -793,7 +820,6 @@ export class ApiConsole extends AmfHelperMixin(LitElement) {
       inlineMethods,
       compatibility,
       outlined,
-      _noTryItValue,
       amf,
       selectedShape,
       selectedShapeType,
@@ -806,6 +832,7 @@ export class ApiConsole extends AmfHelperMixin(LitElement) {
       _noServerSelector,
       allowCustomBaseUri,
     } = this;
+    const noTryIt = this._noTryItValue || this._isWebhookOperation(selectedShape, this.webApi);
 
     return html`<api-documentation
       .amf="${amf}"
@@ -817,7 +844,7 @@ export class ApiConsole extends AmfHelperMixin(LitElement) {
       ?noServerSelector="${_noServerSelector}"
       ?allowCustomBaseUri="${allowCustomBaseUri}"
       .inlineMethods="${inlineMethods}"
-      .noTryIt="${_noTryItValue}"
+      .noTryIt="${noTryIt}"
       .baseUri="${baseUri}"
       .redirectUri="${redirectUri}"
       .scrollTarget="${scrollTarget}"

package/src/ApiConsoleApp.js

@@ -374,9 +374,13 @@ export class ApiConsoleApp extends ApiConsole {
    * @return {TemplateResult} Template for the api documentation section
    */
   _apiDocumentationTemplate() {
+    // Webhooks have no invokable URL: the inline panel would render broken
+    // (no server/URL to send a request to) even though there's no "Try it"
+    // button to gate it, so the webhook check has to happen here too.
+    const webhookSelected = this._isWebhookOperation(this.selectedShape, this.webApi);
     return html`<section class="api-docs">
     ${super._apiDocumentationTemplate()}
-    ${this._renderInlineTryit ? html`<div class="inline-request">
+    ${this._renderInlineTryit && !webhookSelected ? html`<div class="inline-request">
       ${this._bannerMessage()}
       ${this._requestPanelTemplate()}
     </div>` : ''}