@scalar/workspace-store 0.58.1 → 0.59.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @scalar/workspace-store
 
+## 0.59.0
+
+### Minor Changes
+
+- feat: test OpenAPI webhooks from the API reference and API client
+
+### Patch Changes
+
+- [#9950](https://github.com/scalar/scalar/pull/9950): Shorten AsyncAPI navigation id segments: `asyncapi-channel` → `channel`, `asyncapi-message` → `message`, and `asyncapi-operation` → `operation`. This makes the generated navigation ids (and the URLs, anchors, and DOM ids derived from them) shorter and consistent, e.g. `.../channel/planetevents/operation/subscribe/message/planetcreated`.
+
 ## 0.58.1
 
 ### Patch Changes

package/dist/navigation/get-navigation-options.js

@@ -42,15 +42,15 @@ export const getNavigationOptions = (documentName, options) => {
                     parentId: props.parentTag.id,
                 })}/`
                 : `${documentId}/`;
-            return `${prefixTag}asyncapi-channel/${slugify(props.channelName)}`;
+            return `${prefixTag}channel/${slugify(props.channelName)}`;
         }
         // -------- Default AsyncAPI message id generation logic --------
         if (props.type === 'asyncapi-message') {
-            return `${props.parentId}/asyncapi-message/${slugify(props.messageName)}`;
+            return `${props.parentId}/message/${slugify(props.messageName)}`;
         }
         // -------- Default AsyncAPI operation id generation logic --------
         if (props.type === 'asyncapi-operation') {
-            return `${props.parentId}/asyncapi-operation/${slugify(props.operationName)}`;
+            return `${props.parentId}/operation/${slugify(props.operationName)}`;
         }
         // -------- Default operation id generation logic --------
         if (props.type === 'operation') {

package/dist/request-example/context/get-request-example-context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-request-example-context.d.ts","sourceRoot":"","sources":["../../../src/request-example/context/get-request-example-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAE9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAGpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAIjG,OAAO,EAAE,KAAK,MAAM,EAAqB,MAAM,iCAAiC,CAAA;AAIhF,OAAO,EAAE,KAAK,qBAAqB,EAAiB,MAAM,mDAAmD,CAAA;AAE7G,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qDAAqD,CAAA;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+CAA+C,CAAA;AAElF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAA;AAC3F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAE5D,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,eAAe,CAAA;IAC1B,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,WAAW,EAAE,kBAAkB,CAAA;KAChC,CAAA;IACD,OAAO,EAAE;QACP,SAAS,EAAE,aAAa,EAAE,CAAA;QAC1B,QAAQ,EAAE,aAAa,EAAE,CAAA;KAC1B,CAAA;IACD,OAAO,EAAE;QACP,IAAI,EAAE,YAAY,EAAE,CAAA;QACpB,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAA;QAC7B,IAAI,EAAE,UAAU,CAAA;KACjB,CAAA;IACD,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KACnB,CAAA;IACD,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAChC,CAAA;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,qBAAqB,CAAA;QAC9B,YAAY,EAAE,yBAAyB,EAAE,CAAA;QACzC,QAAQ,EAAE,gBAAgB,CAAA;QAC1B,eAAe,EAAE,0BAA0B,EAAE,CAAA;QAC7C,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;CACF,CAAA;AAED,eAAO,MAAM,wBAAwB,GACnC,gBAAgB,cAAc,EAC9B,cAAc,MAAM,EACpB,oBAAoB,kBAAkB,EACtC,UAAS,OAAO,CAAC;IACf,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;IACnB,+CAA+C;IAC/C,cAAc,EAAE,2BAA2B,CAAA;IAC3C;;;;OAIG;IACH,gBAAgB,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC3C,CAAM,KACN,MAAM,CAAC,0BAA0B,CA6InC,CAAA"}
+{"version":3,"file":"get-request-example-context.d.ts","sourceRoot":"","sources":["../../../src/request-example/context/get-request-example-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAE9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAGpD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iDAAiD,CAAA;AAIjG,OAAO,EAAE,KAAK,MAAM,EAAqB,MAAM,iCAAiC,CAAA;AAIhF,OAAO,EAAE,KAAK,qBAAqB,EAAiB,MAAM,mDAAmD,CAAA;AAE7G,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qDAAqD,CAAA;AAC7F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+CAA+C,CAAA;AAElF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACtE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAA;AAC3F,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAE5D,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,eAAe,CAAA;IAC1B,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,WAAW,EAAE,kBAAkB,CAAA;KAChC,CAAA;IACD,OAAO,EAAE;QACP,SAAS,EAAE,aAAa,EAAE,CAAA;QAC1B,QAAQ,EAAE,aAAa,EAAE,CAAA;KAC1B,CAAA;IACD,OAAO,EAAE;QACP,IAAI,EAAE,YAAY,EAAE,CAAA;QACpB,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAA;QAC7B,IAAI,EAAE,UAAU,CAAA;KACjB,CAAA;IACD,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;KACnB,CAAA;IACD,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAChC,CAAA;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,qBAAqB,CAAA;QAC9B,YAAY,EAAE,yBAAyB,EAAE,CAAA;QACzC,QAAQ,EAAE,gBAAgB,CAAA;QAC1B,eAAe,EAAE,0BAA0B,EAAE,CAAA;QAC7C,IAAI,EAAE,QAAQ,CAAA;KACf,CAAA;CACF,CAAA;AAED,eAAO,MAAM,wBAAwB,GACnC,gBAAgB,cAAc,EAC9B,cAAc,MAAM,EACpB,oBAAoB,kBAAkB,EACtC,UAAS,OAAO,CAAC;IACf,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,OAAO,CAAA;IACnB,+CAA+C;IAC/C,cAAc,EAAE,2BAA2B,CAAA;IAC3C;;;;OAIG;IACH,gBAAgB,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAC3C,CAAM,KACN,MAAM,CAAC,0BAA0B,CAkJnC,CAAA"}

package/dist/request-example/context/get-request-example-context.js

@@ -11,7 +11,7 @@ import { mergeSecurity } from '../../request-example/context/security/merge-secu
 import { getSelectedServer, getServers } from '../../request-example/context/servers.js';
 import { isOpenApiDocument } from '../../schemas/type-guards.js';
 export const getRequestExampleContext = (workspaceStore, documentName, requestExampleMeta, options = {}) => {
-    const { path, method, exampleName } = requestExampleMeta;
+    const { path, method, exampleName, isWebhook = false } = requestExampleMeta;
     const document = workspaceStore.workspace.documents[documentName] ?? options.fallbackDocument ?? undefined;
     if (!document) {
         return {
@@ -25,18 +25,18 @@ export const getRequestExampleContext = (workspaceStore, documentName, requestEx
             error: `Document ${documentName} is not an OpenAPI document`,
         };
     }
-    const pathItem = getResolvedPathItem(document.paths?.[path]);
+    const pathItem = getResolvedPathItem(isWebhook ? document.webhooks?.[path] : document.paths?.[path]);
     if (!pathItem) {
         return {
             ok: false,
-            error: `Path ${path} not found`,
+            error: isWebhook ? `Webhook ${path} not found` : `Path ${path} not found`,
         };
     }
-    const resolvedOperation = getResolvedRef(getPathItemOperation(document.paths?.[path], method));
+    const resolvedOperation = getResolvedRef(getPathItemOperation(pathItem, method));
     if (!resolvedOperation) {
         return {
             ok: false,
-            error: `Method ${method} not found on path ${path}`,
+            error: isWebhook ? `Method ${method} not found on webhook ${path}` : `Method ${method} not found on path ${path}`,
         };
     }
     // Combine the path item and operation parameters
@@ -53,7 +53,10 @@ export const getRequestExampleContext = (workspaceStore, documentName, requestEx
     //                                 SERVER CONTEXT
     //------------------------------------------------------------------------------------------------
     // Get server context for the request example
-    const serverList = getServers(options.servers ?? operation.servers ?? document.servers, {
+    const configuredServers = isWebhook
+        ? (options.servers ?? operation.servers)
+        : (options.servers ?? operation.servers ?? document.servers);
+    const serverList = getServers(configuredServers, {
         baseServerUrl: options.baseServerUrl,
         documentUrl: document['x-scalar-original-source-url'],
     });
@@ -76,7 +79,9 @@ export const getRequestExampleContext = (workspaceStore, documentName, requestEx
     const selectedSecurity = getSelectedSecurity(documentSelectedSecurity, operationSelectedSecurity, securityRequirements, securitySchemes, options.authentication?.preferredSecurityScheme);
     /** The above selected requirements in scheme form */
     const selectedSecuritySchemes = getSecuritySchemes(securitySchemes, selectedSecurity.selectedSchemes[selectedSecurity.selectedIndex] ?? {});
-    const serverMeta = operation.servers != null ? { type: 'operation', path: path ?? '', method: method ?? 'get' } : { type: 'document' };
+    const serverMeta = !isWebhook && operation.servers != null
+        ? { type: 'operation', path: path ?? '', method: method ?? 'get' }
+        : { type: 'document' };
     const authMeta = operationSelectedSecurity !== undefined
         ? { type: 'operation', path: path ?? '', method: method ?? 'get' }
         : { type: 'document' };

package/dist/request-example/types.d.ts

@@ -6,8 +6,11 @@ import type { HttpMethod } from '@scalar/helpers/http/http-methods';
  */
 export type { Result } from '@scalar/helpers/types/result';
 export type RequestExampleMeta = {
+    /** API path, or webhook name when `isWebhook` is true. */
     path: string;
     method: HttpMethod;
     exampleName: string;
+    /** Resolve the operation from `document.webhooks` instead of `document.paths`. */
+    isWebhook?: boolean;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/request-example/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/request-example/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE;;;;GAIG;AACH,YAAY,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AAE1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/request-example/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE;;;;GAIG;AACH,YAAY,EAAE,MAAM,EAAE,MAAM,8BAA8B,CAAA;AAE1D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,kFAAkF;IAClF,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA"}

package/package.json

@@ -16,7 +16,7 @@
     "openapi",
     "scalar"
   ],
-  "version": "0.58.1",
+  "version": "0.59.0",
   "engines": {
     "node": ">=22"
   },
@@ -148,13 +148,13 @@
     "type-fest": "^5.8.0",
     "vue": "^3.5.40",
     "yaml": "^2.9.0",
-    "@scalar/asyncapi-upgrader": "0.1.7",
-    "@scalar/helpers": "0.11.1",
-    "@scalar/json-magic": "0.13.2",
+    "@scalar/asyncapi-upgrader": "0.1.8",
+    "@scalar/json-magic": "0.13.3",
     "@scalar/openapi-upgrader": "0.2.15",
-    "@scalar/schemas": "0.8.3",
-    "@scalar/snippetz": "0.9.28",
-    "@scalar/types": "0.18.2",
+    "@scalar/schemas": "0.8.4",
+    "@scalar/helpers": "0.11.2",
+    "@scalar/snippetz": "0.9.29",
+    "@scalar/types": "0.18.3",
     "@scalar/validation": "0.6.3"
   },
   "devDependencies": {