@scalar/workspace-store 0.52.0 → 0.54.0

package/dist/navigation/helpers/traverse-asyncapi-document.js

@@ -0,0 +1,479 @@
+import { sortByOrder } from '@scalar/helpers/array/sort-by-order';
+import { objectKeys } from '@scalar/helpers/object/object-keys';
+import { getResolvedRef, mergeSiblingReferences } from '../../helpers/get-resolved-ref.js';
+import { isHidden } from '../../helpers/is-hidden.js';
+import { unpackProxyObject } from '../../helpers/unpack-proxy.js';
+import { getNavigationOptions } from '../../navigation/get-navigation-options.js';
+import { getTag } from '../../navigation/helpers/get-tag.js';
+import { traverseDescription } from '../../navigation/helpers/traverse-description.js';
+import { traverseSchemas } from '../../navigation/helpers/traverse-schemas.js';
+/**
+ * Picks the first display candidate that is non-empty after trimming.
+ * Used by title helpers so we prefer `title`, then `summary`, then a fallback.
+ */
+const pickNonEmpty = (...candidates) => {
+    for (const candidate of candidates) {
+        const trimmed = candidate?.trim();
+        if (trimmed) {
+            return trimmed;
+        }
+    }
+    return undefined;
+};
+/**
+ * Returns the channel address shown in the sidebar and routing.
+ * Falls back to the channel map key when `channel.address` is missing or empty.
+ */
+const getChannelAddress = (channelName, channel) => typeof channel.address === 'string' && channel.address.length > 0 ? channel.address : channelName;
+/**
+ * Sidebar label for a channel: `title`, then `summary`, then the resolved address.
+ */
+const getChannelTitle = (channel, channelName) => pickNonEmpty(channel.title, channel.summary) ?? getChannelAddress(channelName, channel);
+/**
+ * Sidebar label for an operation: `title`, then `summary`, then the operation map key.
+ */
+const getOperationTitle = (operation, operationName) => pickNonEmpty(operation.title, operation.summary) ?? operationName;
+/**
+ * Sidebar label for a message: `title`, then `summary`, then `name`, then the message map key.
+ */
+const getMessageTitle = (message, messageName) => pickNonEmpty(message.title, message.summary, message.name) ?? messageName;
+/**
+ * Parses a channel JSON pointer (`#/channels/<name>`) into the key used in `document.channels`.
+ */
+const getChannelNameFromRef = (ref) => ref.match(/^#\/channels\/([^/]+)$/)?.[1];
+/**
+ * Resolves the channel referenced by an operation.
+ *
+ * The AsyncAPI 3 spec requires `operation.channel` to be a Reference Object,
+ * so we read the channel key straight from the JSON pointer rather than trying
+ * to match against the resolved channel by identity.
+ */
+const resolveOperationChannel = (document, operation) => {
+    const channelRef = operation.channel;
+    if (!channelRef || !('$ref' in channelRef)) {
+        return undefined;
+    }
+    const channelName = getChannelNameFromRef(channelRef.$ref);
+    if (!channelName) {
+        return undefined;
+    }
+    const channelEntry = document.channels?.[channelName];
+    if (!channelEntry) {
+        return undefined;
+    }
+    return {
+        channelName,
+        channel: getResolvedRef(channelEntry, mergeSiblingReferences),
+    };
+};
+/**
+ * Resolves which channel message names an operation references.
+ *
+ * - `operation.messages === undefined` → every channel message is included.
+ * - `operation.messages === []` → no channel messages are included.
+ * - Otherwise → the channel messages that the operation explicitly references.
+ */
+const resolveOperationMessageNames = (operation, channel, channelName) => {
+    const channelMessages = channel.messages ?? {};
+    if (operation.messages === undefined) {
+        return objectKeys(channelMessages);
+    }
+    if (operation.messages.length === 0) {
+        return [];
+    }
+    const channelScopePrefix = `#/channels/${channelName}/messages/`;
+    const names = new Set();
+    for (const messageRef of operation.messages) {
+        if (!('$ref' in messageRef)) {
+            continue;
+        }
+        // Common case: a channel-scoped reference like `#/channels/<name>/messages/<id>`.
+        if (messageRef.$ref.startsWith(channelScopePrefix)) {
+            const candidate = messageRef.$ref.slice(channelScopePrefix.length);
+            if (channelMessages[candidate]) {
+                names.add(candidate);
+                continue;
+            }
+        }
+        // Fallback: a channel-level message that points to the same target.
+        for (const [name, entry] of Object.entries(channelMessages)) {
+            if (entry && '$ref' in entry && entry.$ref === messageRef.$ref) {
+                names.add(name);
+            }
+        }
+    }
+    return [...names];
+};
+/**
+ * Normalizes an AsyncAPI tag (inline object or `$ref`) into the OpenAPI-style `TagObject`
+ * used by the shared tag navigation helpers.
+ */
+const toTagObject = (tag) => {
+    const resolved = getResolvedRef(tag, mergeSiblingReferences);
+    return {
+        name: resolved.name,
+        description: resolved.description,
+    };
+};
+/**
+ * Sorts operation navigation entries in place using the workspace `operationsSorter` option.
+ * Maps AsyncAPI `action` to the HTTP-style sorter fields so OpenAPI and AsyncAPI share the same API.
+ */
+const sortOperations = (entries, operationsSorter) => {
+    if (operationsSorter === 'alpha') {
+        entries.sort((a, b) => a.title.localeCompare(b.title));
+        return;
+    }
+    if (operationsSorter === 'method') {
+        entries.sort((a, b) => a.action.localeCompare(b.action));
+        return;
+    }
+    if (typeof operationsSorter === 'function') {
+        entries.sort((a, b) => operationsSorter({ method: a.action, path: a.operationName, ref: a.operationName, httpVerb: a.action }, { method: b.action, path: b.operationName, ref: b.operationName, httpVerb: b.action }));
+    }
+};
+/** Sorts message navigation entries alphabetically by display title. */
+const sortMessages = (entries) => {
+    entries.sort((a, b) => a.title.localeCompare(b.title));
+};
+/**
+ * Builds nested message entries for one operation.
+ * Resolves each message ref, skips hidden messages, and sorts the result by title.
+ */
+const createMessageEntries = ({ channelName, channel, operationId, messageNames, generateId, }) => {
+    const messages = messageNames.flatMap((messageName) => {
+        const messageNode = channel.messages?.[messageName];
+        if (!messageNode) {
+            return [];
+        }
+        const message = getResolvedRef(messageNode, mergeSiblingReferences);
+        if (isHidden(message)) {
+            return [];
+        }
+        return [
+            {
+                type: 'asyncapi-message',
+                id: generateId({
+                    type: 'asyncapi-message',
+                    messageName,
+                    channelName,
+                    parentId: operationId,
+                }),
+                title: getMessageTitle(message, messageName),
+                messageName,
+                channelName,
+            },
+        ];
+    });
+    sortMessages(messages);
+    return messages;
+};
+/**
+ * Builds a single operation navigation entry under a channel.
+ * Includes nested messages when the operation references channel messages (or all of them by default).
+ * Returns `undefined` when the operation is hidden via `x-internal` or `x-scalar-ignore`.
+ */
+const createOperationEntry = ({ operationName, operation, channel, channelName, channelAddress, generateId, parentId, }) => {
+    if (isHidden(operation)) {
+        return undefined;
+    }
+    const operationId = generateId({
+        type: 'asyncapi-operation',
+        operationName,
+        parentId,
+    });
+    const messageEntries = createMessageEntries({
+        channelName,
+        channel,
+        operationId,
+        messageNames: resolveOperationMessageNames(operation, channel, channelName),
+        generateId,
+    });
+    return {
+        type: 'asyncapi-operation',
+        id: operationId,
+        title: getOperationTitle(operation, operationName),
+        operationName,
+        action: operation.action,
+        channelName,
+        channelAddress,
+        children: messageEntries.length > 0 ? messageEntries : undefined,
+    };
+};
+/**
+ * Builds a channel navigation entry from a bucket and the operations to render under it.
+ * The same channel may appear at the document root and under each of its channel-level tags.
+ * Writes `x-scalar-order` on the source channel (when it is not a bare `$ref`) so other code can reuse the order.
+ * Returns `undefined` when the channel is hidden or every requested operation was filtered out.
+ */
+const createChannelEntry = ({ bucket, operationEntries, generateId, parentId, parentTag, operationsSorter, document, }) => {
+    if (isHidden(bucket.channel)) {
+        return undefined;
+    }
+    const channelId = generateId({
+        type: 'asyncapi-channel',
+        channelName: bucket.channelName,
+        parentId,
+        parentTag,
+    });
+    const operations = operationEntries.flatMap(({ operationName, operation }) => {
+        const entry = createOperationEntry({
+            operationName,
+            operation,
+            channel: bucket.channel,
+            channelName: bucket.channelName,
+            channelAddress: bucket.channelAddress,
+            generateId,
+            parentId: channelId,
+        });
+        return entry ? [entry] : [];
+    });
+    sortOperations(operations, operationsSorter);
+    if (operations.length === 0) {
+        return undefined;
+    }
+    // Persist the rendered order back onto the source channel for downstream consumers.
+    // We skip channels that are stored as references, since the order should live on the target.
+    const channelNode = document.channels?.[bucket.channelName];
+    if (channelNode && !('$ref' in channelNode)) {
+        ;
+        channelNode['x-scalar-order'] = operations.map((child) => child.id);
+    }
+    return {
+        type: 'asyncapi-channel',
+        id: channelId,
+        title: getChannelTitle(bucket.channel, bucket.channelName),
+        channelName: bucket.channelName,
+        channelAddress: bucket.channelAddress,
+        children: operations,
+    };
+};
+/**
+ * Wraps collected channel entries in a tag navigation node.
+ * Persists child order on the tag via `x-scalar-order` for later reordering in the UI.
+ */
+const createTagEntry = ({ tag, generateId, children, parentId, }) => {
+    const id = generateId({
+        type: 'tag',
+        tag,
+        parentId,
+        isGroup: false,
+    });
+    const title = tag['x-displayName'] ?? tag.name ?? 'Untitled Tag';
+    tag['x-scalar-order'] = children.map((child) => child.id);
+    return {
+        type: 'tag',
+        id,
+        title,
+        name: tag.name || title,
+        description: tag.description,
+        children,
+        isGroup: false,
+        isWebhooks: false,
+    };
+};
+/**
+ * Turns the in-memory `tagsMap` into top-level tag navigation entries.
+ * Respects per-tag `x-scalar-order`, document-level `x-scalar-order`, and `tagsSorter` (alpha or custom).
+ * Skips tags marked hidden.
+ */
+const getSortedTagEntries = ({ tagKeys, tagsMap, documentId, options: { tagsSorter, generateId }, sortOrder, }) => {
+    const entries = tagKeys.flatMap((key) => {
+        const { tag, entries: tagEntries } = getTag({ tagsMap, name: key, documentId, generateId });
+        if (isHidden(tag)) {
+            return [];
+        }
+        const tagOrder = tag['x-scalar-order'];
+        return createTagEntry({
+            tag,
+            generateId,
+            children: tagOrder ? sortByOrder(tagEntries, tagOrder, (item) => item.id) : tagEntries,
+            parentId: documentId,
+        });
+    });
+    if (sortOrder) {
+        return sortByOrder(entries, sortOrder, (item) => item.id);
+    }
+    if (tagsSorter === 'alpha') {
+        entries.sort((a, b) => a.title.localeCompare(b.title));
+    }
+    else if (typeof tagsSorter === 'function') {
+        entries.sort((a, b) => tagsSorter(getTag({ tagsMap, name: a.name, documentId, generateId }).tag, getTag({ tagsMap, name: b.name, documentId, generateId }).tag));
+    }
+    return entries;
+};
+/**
+ * Returns the existing bucket for a channel name or creates one with address and channel-level tags.
+ * Buckets are shared across the traversal so operations on the same channel accumulate together.
+ */
+const getOrCreateChannelBucket = (channelBuckets, channelName, channel) => {
+    const existing = channelBuckets.get(channelName);
+    if (existing) {
+        return existing;
+    }
+    const bucket = {
+        channelName,
+        channel,
+        channelAddress: getChannelAddress(channelName, channel),
+        channelTags: channel.tags?.map(toTagObject) ?? [],
+        operations: [],
+    };
+    channelBuckets.set(channelName, bucket);
+    return bucket;
+};
+/**
+ * Builds the channel/operation registry used to drive the rest of the traversal.
+ *
+ * Channels are seeded first so that they can appear in the sidebar even when no
+ * operations reference them. Operations are then assigned to the bucket of the
+ * channel they reference; operations with no resolvable channel are skipped.
+ */
+const collectChannelBuckets = (document) => {
+    const channelBuckets = new Map();
+    for (const [channelName, channelNode] of Object.entries(document.channels ?? {})) {
+        if (!channelNode) {
+            continue;
+        }
+        const channel = getResolvedRef(channelNode, mergeSiblingReferences);
+        if (isHidden(channel)) {
+            continue;
+        }
+        getOrCreateChannelBucket(channelBuckets, channelName, channel);
+    }
+    for (const [operationName, operationNode] of Object.entries(document.operations ?? {})) {
+        if (!operationNode) {
+            continue;
+        }
+        const operation = getResolvedRef(operationNode, mergeSiblingReferences);
+        if (isHidden(operation)) {
+            continue;
+        }
+        const resolved = resolveOperationChannel(document, operation);
+        if (!resolved) {
+            continue;
+        }
+        const bucket = getOrCreateChannelBucket(channelBuckets, resolved.channelName, resolved.channel);
+        // Operation-level tags are deliberately ignored here. Tag grouping is driven by
+        // channel-level tags only until operation-tag grouping is reintroduced.
+        bucket.operations.push({
+            operationName,
+            operation,
+        });
+    }
+    return channelBuckets;
+};
+/**
+ * Entry point: walks an AsyncAPI document and produces the sidebar tree.
+ *
+ * High-level flow:
+ * 1. `collectChannelBuckets` — resolve refs, group operations by channel, collect channel tags.
+ * 2. For each bucket — build the channel entry at the document root with all of its operations.
+ * 3. Apply channel-level tags so a channel can also appear under each of its tags.
+ * 4. Sort tags and top-level entries, then persist `x-scalar-order` on the document for stable ordering.
+ *
+ * Operation-level tags are intentionally not used to group channels yet; only channel-level
+ * tags drive tag grouping.
+ */
+export const traverseAsyncApiDocument = (documentName, document, options) => {
+    const { generateId, operationsSorter, tagsSorter, hideModels, modelsSectionLabel } = getNavigationOptions(documentName, options);
+    const documentId = generateId({
+        type: 'document',
+        info: document.info,
+        name: documentName,
+    });
+    const channelBuckets = collectChannelBuckets(document);
+    const tagsMap = new Map();
+    const untaggedChannels = [];
+    for (const bucket of channelBuckets.values()) {
+        // Operation-level tags are intentionally skipped for now: every operation is rendered
+        // under its channel, and only the channel's own tags drive tag grouping below.
+        if (bucket.channelTags.length === 0) {
+            const untaggedChannel = createChannelEntry({
+                bucket,
+                operationEntries: bucket.operations,
+                generateId,
+                parentId: documentId,
+                operationsSorter,
+                document,
+            });
+            if (untaggedChannel) {
+                untaggedChannels.push(untaggedChannel);
+            }
+        }
+        // Channels can declare their own tags independently of any operation tags.
+        for (const tag of bucket.channelTags) {
+            const tagName = tag.name ?? 'Untitled Tag';
+            const { id: tagId, entries } = getTag({ tagsMap, name: tagName, documentId, generateId });
+            const alreadyRegistered = entries.some((entry) => entry.type === 'asyncapi-channel' && entry.channelName === bucket.channelName);
+            if (alreadyRegistered) {
+                continue;
+            }
+            const taggedChannel = createChannelEntry({
+                bucket,
+                operationEntries: bucket.operations,
+                generateId,
+                parentId: tagId,
+                parentTag: { tag, id: tagId },
+                operationsSorter,
+                document,
+            });
+            if (taggedChannel) {
+                entries.push(taggedChannel);
+            }
+        }
+    }
+    // AsyncAPI documents carry reusable schemas under `components.schemas`, just like OpenAPI.
+    // Reuse the OpenAPI schema traversal so they render as "Models" in the same way. Schemas
+    // tagged via `x-tags` are pushed into `tagsMap` here, so this must run before the tag
+    // entries below are built from that map.
+    //
+    // `traverseSchemas` only reads `components.schemas`, which both document shapes share, but it is
+    // typed against the OpenAPI document. We hand it the resolved `components` (so a `$ref`-only
+    // wrapper still exposes its schemas) wrapped in a minimal document; the cast bridges the single
+    // overlapping field, since AsyncAPI and OpenAPI documents are otherwise distinct types.
+    const components = document.components ? getResolvedRef(document.components, mergeSiblingReferences) : undefined;
+    const untaggedModels = !hideModels && components?.schemas
+        ? traverseSchemas({ documentId, document: { components }, generateId, tagsMap })
+        : [];
+    // Surface the Introduction entry plus any headings extracted from `info.description`
+    // before the channel/tag entries, mirroring how OpenAPI documents are traversed.
+    const entries = traverseDescription({
+        generateId,
+        parentId: documentId,
+        info: document.info,
+    });
+    if (tagsMap.size > 0) {
+        entries.push(...getSortedTagEntries({
+            tagKeys: [...tagsMap.keys()],
+            tagsMap,
+            documentId,
+            options: { tagsSorter, generateId },
+            sortOrder: document['x-scalar-order'],
+        }));
+    }
+    if (operationsSorter === 'alpha') {
+        untaggedChannels.sort((a, b) => a.title.localeCompare(b.title));
+    }
+    entries.push(...untaggedChannels);
+    // Mirror OpenAPI: untagged schemas are grouped under a single top-level "Models" section.
+    if (untaggedModels.length) {
+        entries.push({
+            type: 'models',
+            id: generateId({ type: 'model', parentId: documentId }),
+            title: modelsSectionLabel,
+            name: modelsSectionLabel,
+            children: untaggedModels,
+        });
+    }
+    const sortOrder = document['x-scalar-order'];
+    const orderedEntries = sortOrder ? sortByOrder(entries, sortOrder, (entry) => entry.id) : entries;
+    document['x-scalar-order'] = unpackProxyObject(orderedEntries.map((entry) => entry.id));
+    return {
+        id: documentId,
+        type: 'document',
+        title: document.info?.title?.trim() || 'Untitled Document',
+        name: documentName,
+        children: orderedEntries,
+        icon: document['x-scalar-icon'],
+    };
+};

package/dist/navigation/helpers/traverse-description.d.ts

@@ -1,8 +1,9 @@
+import type { AsyncApiInfoObject } from '@scalar/types/asyncapi/3.1';
 import type { TraverseSpecOptions } from '../../navigation/types.js';
 import type { TraversedDescription } from '../../schemas/navigation.js';
 import type { InfoObject } from '../../schemas/v3.1/strict/info.js';
 /**
- * Creates a hierarchical navigation structure from markdown headings in an OpenAPI description.
+ * Creates a hierarchical navigation structure from markdown headings in an OpenAPI or AsyncAPI description.
  *
  * The function processes markdown headings to create a two-level navigation tree:
  * - Level 1: Main sections (based on the lowest heading level found)
@@ -14,13 +15,13 @@ import type { InfoObject } from '../../schemas/v3.1/strict/info.js';
  * @param description - The markdown description text to process
  * @param generateId - Function to generate unique IDs for headings
  * @param parentId - The ID of the parent entry
- * @param info - OpenAPI Info Object
+ * @param info - OpenAPI or AsyncAPI Info Object
  *
  * @returns Array of TraversedDescription entries with their hierarchy
  */
 export declare const traverseDescription: ({ generateId, parentId, info, }: {
     generateId: TraverseSpecOptions["generateId"];
     parentId: string;
-    info: InfoObject;
+    info: InfoObject | AsyncApiInfoObject;
 }) => TraversedDescription[];
 //# sourceMappingURL=traverse-description.d.ts.map

package/dist/navigation/helpers/traverse-description.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-description.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-description.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AA8B5D;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,GAAI,iCAIjC;IACD,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,UAAU,CAAA;CACjB,KAAG,oBAAoB,EAiEvB,CAAA"}
+{"version":3,"file":"traverse-description.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-description.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAGpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AA8B5D;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,GAAI,iCAIjC;IACD,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,UAAU,GAAG,kBAAkB,CAAA;CACtC,KAAG,oBAAoB,EAiEvB,CAAA"}

package/dist/navigation/helpers/traverse-description.js

@@ -20,7 +20,7 @@ const getDefaultDescriptionEntry = (generateId, parentId, info) => {
     return entry;
 };
 /**
- * Creates a hierarchical navigation structure from markdown headings in an OpenAPI description.
+ * Creates a hierarchical navigation structure from markdown headings in an OpenAPI or AsyncAPI description.
  *
  * The function processes markdown headings to create a two-level navigation tree:
  * - Level 1: Main sections (based on the lowest heading level found)
@@ -32,7 +32,7 @@ const getDefaultDescriptionEntry = (generateId, parentId, info) => {
  * @param description - The markdown description text to process
  * @param generateId - Function to generate unique IDs for headings
  * @param parentId - The ID of the parent entry
- * @param info - OpenAPI Info Object
+ * @param info - OpenAPI or AsyncAPI Info Object
  *
  * @returns Array of TraversedDescription entries with their hierarchy
  */

package/dist/navigation/helpers/traverse-document.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,iBAAiB,EAAwB,MAAM,qCAAqC,CAAA;AAElG,OAAO,KAAK,EAAqB,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAQ7E;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,cAAc,MAAM,EAAE,UAAU,eAAe,EAAE,UAAU,iBAAiB;;;;;;;CA6H5G,CAAA"}
+{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-document.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,iBAAiB,EAAwB,MAAM,qCAAqC,CAAA;AAElG,OAAO,KAAK,EAAqB,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAQ7E;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAAI,cAAc,MAAM,EAAE,UAAU,eAAe,EAAE,UAAU,iBAAiB;;;;;;;CA2H5G,CAAA"}

package/dist/navigation/helpers/traverse-document.js

@@ -15,7 +15,7 @@ import { traverseWebhooks } from './traverse-webhooks.js';
  * - Optional schema/model documentation
  */
 export const traverseDocument = (documentName, document, options) => {
-    const { hideModels, tagsSorter, operationsSorter, generateId, operationTitleSource } = getNavigationOptions(documentName, options);
+    const { hideModels, modelsSectionLabel, tagsSorter, operationsSorter, generateId, operationTitleSource } = getNavigationOptions(documentName, options);
     const documentId = generateId({
         type: 'document',
         info: document.info,
@@ -89,8 +89,8 @@ export const traverseDocument = (documentName, document, options) => {
                     type: 'model',
                     parentId: documentId,
                 }),
-                title: 'Models',
-                name: 'Models',
+                title: modelsSectionLabel,
+                name: modelsSectionLabel,
                 children: untaggedModels,
             });
         }

package/dist/navigation/index.d.ts

@@ -2,6 +2,7 @@ export { getOpenapiObject } from './helpers/get-openapi-object.js';
 export { type OperationEntriesMap, getOperationEntries } from './helpers/get-operation-entries.js';
 export { getParentEntry } from './helpers/get-parent-entry.js';
 export { type TagEntriesMap, getTagEntries } from './helpers/get-tag-entries.js';
+export { traverseAsyncApiDocument } from './helpers/traverse-asyncapi-document.js';
 export { traverseDocument as createNavigation } from './helpers/traverse-document.js';
 export type { TraverseSpecOptions as createNavigationOptions } from './types.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/navigation/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/navigation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAC/D,OAAO,EAAE,KAAK,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AAC/F,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,KAAK,aAAa,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,gBAAgB,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAClF,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/navigation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAC/D,OAAO,EAAE,KAAK,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAA;AAC/F,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,KAAK,aAAa,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAA;AAC/E,OAAO,EAAE,gBAAgB,IAAI,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAClF,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,SAAS,CAAA"}

package/dist/navigation/index.js

@@ -2,4 +2,5 @@ export { getOpenapiObject } from './helpers/get-openapi-object.js';
 export { getOperationEntries } from './helpers/get-operation-entries.js';
 export { getParentEntry } from './helpers/get-parent-entry.js';
 export { getTagEntries } from './helpers/get-tag-entries.js';
+export { traverseAsyncApiDocument } from './helpers/traverse-asyncapi-document.js';
 export { traverseDocument as createNavigation } from './helpers/traverse-document.js';

package/dist/navigation/types.d.ts

@@ -1,3 +1,4 @@
+import type { ModelsSectionLabel } from '@scalar/types/api-reference';
 import type { IdGenerator, TraversedEntry } from '../schemas/navigation.js';
 import type { TagObject } from '../schemas/v3.1/strict/openapi-document.js';
 /** Map of tagNames and their entries */
@@ -30,6 +31,8 @@ export type TraverseSpecOptions = {
     operationsSorter?: 'alpha' | 'method' | ((a: OperationSortValue, b: OperationSortValue) => number);
     /** Whether to hide model schemas from the navigation */
     hideModels: boolean;
+    /** User-facing label for the components.schemas section */
+    modelsSectionLabel: ModelsSectionLabel;
     /** Whether to derive operation titles from the operation summary or the path */
     operationTitleSource?: OperationTitleSource;
     generateId: IdGenerator;

package/dist/navigation/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AAEvE,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAE9G,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,MAAM,CAAA;AAErD;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE/D,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAElG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,gFAAgF;IAChF,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAE3C,UAAU,EAAE,WAAW,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/navigation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAErE,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AAEvE,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAE9G,KAAK,kBAAkB,GAAG;IACxB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,+FAA+F;AAC/F,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,MAAM,CAAA;AAErD;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,2FAA2F;IAC3F,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,KAAK,MAAM,CAAC,CAAA;IAE/D,sGAAsG;IACtG,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,CAAC,EAAE,kBAAkB,KAAK,MAAM,CAAC,CAAA;IAElG,wDAAwD;IACxD,UAAU,EAAE,OAAO,CAAA;IAEnB,2DAA2D;IAC3D,kBAAkB,EAAE,kBAAkB,CAAA;IAEtC,gFAAgF;IAChF,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;IAE3C,UAAU,EAAE,WAAW,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA"}

package/dist/request-example/builder/body/build-request-body.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build-request-body.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/build-request-body.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0DAA0D,CAAA;AAMjG,KAAK,QAAQ,GAAG;IACd,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,CACH;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CACJ,EAAE,CAAA;CACJ,CAAA;AAED,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,EAAE,CAAA;CACJ,CAAA;AAED,KAAK,GAAG,GAAG;IACT,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,GAAG,CAAA;AAiCrD;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAC3B,aAAa,iBAAiB,GAAG,SAAS;AAC1C,qCAAqC;AACrC,oBAAuB;AACvB,sEAAsE;AACtE,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,WAAW,GAAG,IA+OhB,CAAA"}
+{"version":3,"file":"build-request-body.d.ts","sourceRoot":"","sources":["../../../../src/request-example/builder/body/build-request-body.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0DAA0D,CAAA;AAOjG,KAAK,QAAQ,GAAG;IACd,IAAI,EAAE,UAAU,CAAA;IAChB,KAAK,EAAE,CACH;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,IAAI,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CACJ,EAAE,CAAA;CACJ,CAAA;AAED,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE,YAAY,CAAA;IAClB,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,EAAE,MAAM,CAAA;KACd,EAAE,CAAA;CACJ,CAAA;AAED,KAAK,GAAG,GAAG;IACT,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,UAAU,GAAG,GAAG,CAAA;AAiCrD;;GAEG;AACH,eAAO,MAAM,gBAAgB,GAC3B,aAAa,iBAAiB,GAAG,SAAS;AAC1C,qCAAqC;AACrC,oBAAuB;AACvB,sEAAsE;AACtE,kCAAkC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACvD,WAAW,GAAG,IAkRhB,CAAA"}