@scalar/workspace-store 0.49.3 → 0.51.1

package/dist/mutators/operation/operation.js

@@ -7,6 +7,7 @@ import { syncParametersForPathChange } from '../../mutators/operation/helpers/sy
 import { getOperationEntries } from '../../navigation/index.js';
 import { getNavigationOptions } from '../../navigation/get-navigation-options.js';
 import { updateOrderIds } from '../../navigation/helpers/update-order-ids.js';
+import { isOpenApiDocument } from '../../schemas/type-guards.js';
 /**
  * Creates a new operation at a specific path and method in the document.
  * Automatically normalizes the path to ensure it starts with a slash.
@@ -25,7 +26,7 @@ import { updateOrderIds } from '../../navigation/helpers/update-order-ids.js';
  */
 export const createOperation = (workspaceStore, payload) => {
     const document = workspaceStore?.workspace.documents[payload.documentName];
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         payload.callback?.(false);
         return undefined;
     }
@@ -83,7 +84,7 @@ export const createOperation = (workspaceStore, payload) => {
  * ```
  */
 export const updateOperationMeta = (store, document, { meta, payload }) => {
-    if (!document || !store) {
+    if (!store || !isOpenApiDocument(document)) {
         return;
     }
     const documentName = document['x-scalar-navigation']?.name;
@@ -130,14 +131,18 @@ export const updateOperationPathMethod = (document, store, { meta, payload: { me
     // Determine the final method and path
     const finalMethod = methodChanged ? method : meta.method;
     const finalPath = pathChanged ? path : meta.path;
+    if (!store || !isOpenApiDocument(document)) {
+        console.error('Document or workspace not found', { document });
+        return;
+    }
     // Check for conflicts at the target location
-    if (document?.paths?.[finalPath]?.[finalMethod]) {
+    if (document.paths?.[finalPath]?.[finalMethod]) {
         callback('conflict', blurTargetSelector);
         return;
     }
-    const documentNavigation = document?.['x-scalar-navigation'];
-    if (!documentNavigation || !store) {
-        console.error('Document or workspace not found', { document });
+    const documentNavigation = document['x-scalar-navigation'];
+    if (!documentNavigation) {
+        console.error('Document navigation missing', { document });
         return;
     }
     const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
@@ -207,7 +212,7 @@ export const updateOperationPathMethod = (document, store, { meta, payload: { me
  */
 export const deleteOperation = (workspace, { meta, documentName }) => {
     const document = workspace?.workspace.documents[documentName];
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         return;
     }
     preventPollution(meta.path);
@@ -227,7 +232,7 @@ export const deleteOperation = (workspace, { meta, documentName }) => {
  */
 export const createOperationDraftExample = (workspace, { meta: { path, method }, documentName, exampleName }) => {
     const document = workspace?.workspace.documents[documentName];
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         console.error('Document not found', { documentName });
         return;
     }
@@ -255,7 +260,7 @@ export const createOperationDraftExample = (workspace, { meta: { path, method },
 export const deleteOperationExample = (workspace, { meta: { path, method, exampleKey }, documentName }) => {
     // Find the document in workspace based on documentName
     const document = workspace?.workspace.documents[documentName];
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         return;
     }
     // Get the operation object for the given path and method
@@ -306,7 +311,7 @@ export const deleteOperationExample = (workspace, { meta: { path, method, exampl
  */
 export const renameOperationExample = (workspace, { meta: { path, method, exampleKey }, documentName, payload }) => {
     const document = workspace?.workspace.documents[documentName];
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         return;
     }
     const operation = getResolvedRef(document.paths?.[path]?.[method]);

package/dist/mutators/operation/parameters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAGrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAKlD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,4CAA4C,eAAe,CAAC,4BAA4B,CAAC,SA+C1F,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,8BAA8B,GACzC,UAAU,iBAAiB,GAAG,IAAI,EAClC,uCAAuC,eAAe,CAAC,mCAAmC,CAAC,SA8C5F,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,6BAA6B,eAAe,CAAC,4BAA4B,CAAC,SA0B3E,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,4BAA4B,GACvC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gBAAgB,eAAe,CAAC,iCAAiC,CAAC,SAanE,CAAA"}
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../src/mutators/operation/parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAGrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAMlD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,4CAA4C,eAAe,CAAC,4BAA4B,CAAC,SAkD1F,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,8BAA8B,GACzC,UAAU,iBAAiB,GAAG,IAAI,EAClC,uCAAuC,eAAe,CAAC,mCAAmC,CAAC,SA8C5F,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,6BAA6B,eAAe,CAAC,4BAA4B,CAAC,SA6B3E,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,4BAA4B,GACvC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gBAAgB,eAAe,CAAC,iCAAiC,CAAC,SAanE,CAAA"}

package/dist/mutators/operation/parameters.js

@@ -1,5 +1,6 @@
 import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
 import { unpackProxyObject } from '../../helpers/unpack-proxy.js';
+import { isOpenApiDocument } from '../../schemas/type-guards.js';
 /**
  * Updates an existing parameter of a given `type` by its index within that
  * type subset (e.g. the N-th query parameter). Supports updating name, value,
@@ -38,7 +39,10 @@ export const upsertOperationParameter = (document, { meta, type, payload, origin
         return;
     }
     // We are adding a new parameter
-    const operation = getResolvedRef(document?.paths?.[meta.path]?.[meta.method]);
+    if (!isOpenApiDocument(document)) {
+        return;
+    }
+    const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
     if (!operation) {
         console.error('Operation not found', { meta, document });
         return;
@@ -76,7 +80,7 @@ export const upsertOperationParameter = (document, { meta, type, payload, origin
  */
 export const updateOperationExtraParameters = (document, { type, meta, payload, in: location }) => {
     // Ensure there's a valid document
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         return;
     }
     // Resolve the referenced operation from the document using the path and method
@@ -123,7 +127,10 @@ export const updateOperationExtraParameters = (document, { type, meta, payload,
  * ```
  */
 export const deleteOperationParameter = (document, { meta, originalParameter }) => {
-    const operation = getResolvedRef(document?.paths?.[meta.path]?.[meta.method]);
+    if (!isOpenApiDocument(document)) {
+        return;
+    }
+    const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
     // Lets check if its on the operation first as its more likely
     const operationIndex = operation?.parameters?.findIndex((it) => getResolvedRef(it) === originalParameter) ?? -1;
     // We cannot call splice on a proxy object, so we unwrap the array and filter it
@@ -132,7 +139,7 @@ export const deleteOperationParameter = (document, { meta, originalParameter })
         return;
     }
     // If it wasn't on the operation it might be on the path
-    const path = getResolvedRef(document?.paths?.[meta.path]);
+    const path = getResolvedRef(document.paths?.[meta.path]);
     const pathIndex = path?.parameters?.findIndex((it) => getResolvedRef(it) === originalParameter) ?? -1;
     if (path && pathIndex >= 0) {
         path.parameters = unpackProxyObject(path.parameters?.filter((_, i) => i !== pathIndex), { depth: 1 });
@@ -152,7 +159,7 @@ export const deleteOperationParameter = (document, { meta, originalParameter })
  * ```
  */
 export const deleteAllOperationParameters = (document, { meta, type }) => {
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         return;
     }
     const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);

package/dist/mutators/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/mutators/server.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAc,MAAM,6BAA6B,CAAA;AAI3E,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,wCAAwC,CAAA;AAC9F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAyB5D;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,iBAAiB,GAAG,IAAI,EAClC,UAAU,YAAY,CAAC,2BAA2B,CAAC,+BAUpD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GACpB,UAAU,iBAAiB,GAAG,IAAI,EAClC,uBAAuB,YAAY,CAAC,mBAAmB,CAAC,KACvD,YAAY,GAAG,SAmBjB,CAAA;AAgFD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GACvB,UAAU,iBAAiB,GAAG,IAAI,EAClC,yBAAyB,YAAY,CAAC,sBAAsB,CAAC,KAC5D,YAAY,GAAG,SAgCjB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GACvB,UAAU,iBAAiB,GAAG,IAAI,EAClC,iBAAiB,YAAY,CAAC,sBAAsB,CAAC,SAatD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,iBAAiB,GAAG,IAAI,EAAE,UAAU,YAAY,CAAC,sBAAsB,CAAC,SAS9G,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,GAChC,UAAU,iBAAiB,GAAG,IAAI,EAClC,6BAA6B,YAAY,CAAC,yBAAyB,CAAC,sFAWrE,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,iBAAiB,GAAG,IAAI,EAClC,eAAe,YAAY,CAAC,wBAAwB,CAAC,KACpD,MAAM,GAAG,SAaX,CAAA;AAED,eAAO,MAAM,qBAAqB,GAAI,cAAc;IAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE;iCAEzD,YAAY,CAAC,2BAA2B,CAAC;yBACjD,YAAY,CAAC,mBAAmB,CAAC;4BAC9B,YAAY,CAAC,sBAAsB,CAAC;4BACpC,YAAY,CAAC,sBAAsB,CAAC;4BACpC,YAAY,CAAC,sBAAsB,CAAC;qCAC3B,YAAY,CAAC,yBAAyB,CAAC;oCAExC,YAAY,CAAC,wBAAwB,CAAC;CAEzE,CAAA"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/mutators/server.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAc,MAAM,6BAA6B,CAAA;AAK3E,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,wCAAwC,CAAA;AAC9F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAyB5D;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,iBAAiB,GAAG,IAAI,EAClC,UAAU,YAAY,CAAC,2BAA2B,CAAC,+BAUpD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,GACpB,UAAU,iBAAiB,GAAG,IAAI,EAClC,uBAAuB,YAAY,CAAC,mBAAmB,CAAC,KACvD,YAAY,GAAG,SAmBjB,CAAA;AAgFD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GACvB,UAAU,iBAAiB,GAAG,IAAI,EAClC,yBAAyB,YAAY,CAAC,sBAAsB,CAAC,KAC5D,YAAY,GAAG,SAgCjB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GACvB,UAAU,iBAAiB,GAAG,IAAI,EAClC,iBAAiB,YAAY,CAAC,sBAAsB,CAAC,SAatD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,UAAU,iBAAiB,GAAG,IAAI,EAAE,UAAU,YAAY,CAAC,sBAAsB,CAAC,SAS9G,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,GAChC,UAAU,iBAAiB,GAAG,IAAI,EAClC,6BAA6B,YAAY,CAAC,yBAAyB,CAAC,sFAWrE,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAC/B,UAAU,iBAAiB,GAAG,IAAI,EAClC,eAAe,YAAY,CAAC,wBAAwB,CAAC,KACpD,MAAM,GAAG,SAaX,CAAA;AAED,eAAO,MAAM,qBAAqB,GAAI,cAAc;IAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;CAAE;iCAEzD,YAAY,CAAC,2BAA2B,CAAC;yBACjD,YAAY,CAAC,mBAAmB,CAAC;4BAC9B,YAAY,CAAC,sBAAsB,CAAC;4BACpC,YAAY,CAAC,sBAAsB,CAAC;4BACpC,YAAY,CAAC,sBAAsB,CAAC;qCAC3B,YAAY,CAAC,yBAAyB,CAAC;oCAExC,YAAY,CAAC,wBAAwB,CAAC;CAEzE,CAAA"}

package/dist/mutators/server.js

@@ -1,6 +1,7 @@
 import { findVariables } from '@scalar/helpers/regex/find-variables';
 import { getResolvedRef } from '../helpers/get-resolved-ref.js';
 import { unpackProxyObject } from '../helpers/unpack-proxy.js';
+import { isOpenApiDocument } from '../schemas/type-guards.js';
 import { coerceValue } from '../schemas/typebox-coerce.js';
 import { ServerObjectSchema } from '../schemas/v3.1/strict/openapi-document.js';
 /**
@@ -8,7 +9,7 @@ import { ServerObjectSchema } from '../schemas/v3.1/strict/openapi-document.js';
  * Document-level servers live on the document; operation-level servers on the operation object.
  */
 const getServerTarget = (document, meta) => {
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         return null;
     }
     if (meta.type === 'document') {

package/dist/mutators/tag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../src/mutators/tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAOzD;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,cAAc,GAAG,IAAI,EAAE,SAAS,SAAS,CAAC,gBAAgB,CAAC,SAe3F,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,cAAc,GAAG,IAAI,EAAE,SAAS,SAAS,CAAC,cAAc,CAAC,SAiEvF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,cAAc,GAAG,IAAI,EAAE,SAAS,SAAS,CAAC,gBAAgB,CAAC,SAwC/F,CAAA;AAED,eAAO,MAAM,kBAAkB,GAAI,WAAW;IAAE,KAAK,EAAE,cAAc,GAAG,IAAI,CAAA;CAAE;yBAErD,SAAS,CAAC,gBAAgB,CAAC;uBAC7B,SAAS,CAAC,cAAc,CAAC;yBACvB,SAAS,CAAC,gBAAgB,CAAC;CAEnD,CAAA"}
+{"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../src/mutators/tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAQzD;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,GAAI,OAAO,cAAc,GAAG,IAAI,EAAE,SAAS,SAAS,CAAC,gBAAgB,CAAC,SAe3F,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,OAAO,GAAI,OAAO,cAAc,GAAG,IAAI,EAAE,SAAS,SAAS,CAAC,cAAc,CAAC,SAqEvF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,GAAI,WAAW,cAAc,GAAG,IAAI,EAAE,SAAS,SAAS,CAAC,gBAAgB,CAAC,SAwC/F,CAAA;AAED,eAAO,MAAM,kBAAkB,GAAI,WAAW;IAAE,KAAK,EAAE,cAAc,GAAG,IAAI,CAAA;CAAE;yBAErD,SAAS,CAAC,gBAAgB,CAAC;uBAC7B,SAAS,CAAC,cAAc,CAAC;yBACvB,SAAS,CAAC,gBAAgB,CAAC;CAEnD,CAAA"}

package/dist/mutators/tag.js

@@ -3,6 +3,7 @@ import { unpackProxyObject } from '../helpers/unpack-proxy.js';
 import { getNavigationOptions } from '../navigation/get-navigation-options.js';
 import { getTagEntries } from '../navigation/helpers/get-tag-entries.js';
 import { updateOrderIds } from '../navigation/helpers/update-order-ids.js';
+import { isOpenApiDocument } from '../schemas/type-guards.js';
 /**
  * Adds a new tag to the WorkspaceDocument's `tags` array.
  *
@@ -13,7 +14,7 @@ import { updateOrderIds } from '../navigation/helpers/update-order-ids.js';
  */
 export const createTag = (store, payload) => {
     const document = store?.workspace.documents[payload.documentName];
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         console.error('Document not found', { payload, store });
         return;
     }
@@ -32,11 +33,15 @@ export const createTag = (store, payload) => {
  */
 export const editTag = (store, payload) => {
     const document = store?.workspace.documents[payload.documentName];
-    const documentNavigation = document?.['x-scalar-navigation'];
-    if (!document || !documentNavigation) {
+    if (!store || !isOpenApiDocument(document)) {
         console.error('Document not found', { payload, store });
         return;
     }
+    const documentNavigation = document['x-scalar-navigation'];
+    if (!documentNavigation) {
+        console.error('Document navigation missing', { payload, store });
+        return;
+    }
     const oldName = payload.tag.name;
     const newName = payload.newName;
     if (document.tags?.length) {
@@ -99,7 +104,7 @@ export const editTag = (store, payload) => {
  */
 export const deleteTag = (workspace, payload) => {
     const document = workspace?.workspace.documents[payload.documentName];
-    if (!document) {
+    if (!isOpenApiDocument(document)) {
         return;
     }
     // Clear tags from all operations that have this tag

package/dist/navigation/get-navigation-options.d.ts

@@ -1,6 +1,6 @@
 import type { ApiReferenceConfigurationRaw } from '@scalar/types/api-reference';
 import type { TraverseSpecOptions } from '../navigation/types.js';
-export type NavigationOptions = Partial<Pick<ApiReferenceConfigurationRaw, 'generateHeadingSlug' | 'generateTagSlug' | 'generateOperationSlug' | 'generateWebhookSlug' | 'generateModelSlug' | 'operationsSorter' | 'tagsSorter' | 'hideModels'>> | undefined;
+export type NavigationOptions = Partial<Pick<ApiReferenceConfigurationRaw, 'generateHeadingSlug' | 'generateTagSlug' | 'generateOperationSlug' | 'generateWebhookSlug' | 'generateModelSlug' | 'operationsSorter' | 'tagsSorter' | 'hideModels' | 'operationTitleSource'>> | undefined;
 /**
  * Returns options for traversing an OpenAPI document, allowing customization of
  * how IDs and slugs are generated for tags, headings, models, operations, and webhooks.

package/dist/navigation/get-navigation-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-navigation-options.d.ts","sourceRoot":"","sources":["../../src/navigation/get-navigation-options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAE/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,MAAM,MAAM,iBAAiB,GACzB,OAAO,CACL,IAAI,CACF,4BAA4B,EAC1B,qBAAqB,GACrB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,mBAAmB,GACnB,kBAAkB,GAClB,YAAY,GACZ,YAAY,CACf,CACF,GACD,SAAS,CAAA;AAEb;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,cAAc,MAAM,EAAE,UAAU,iBAAiB,KAAG,mBAiHxF,CAAA"}
+{"version":3,"file":"get-navigation-options.d.ts","sourceRoot":"","sources":["../../src/navigation/get-navigation-options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAE/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,MAAM,MAAM,iBAAiB,GACzB,OAAO,CACL,IAAI,CACF,4BAA4B,EAC1B,qBAAqB,GACrB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,mBAAmB,GACnB,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,sBAAsB,CACzB,CACF,GACD,SAAS,CAAA;AAEb;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,cAAc,MAAM,EAAE,UAAU,iBAAiB,KAAG,mBAkHxF,CAAA"}

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

@@ -96,6 +96,7 @@ export const getNavigationOptions = (documentName, options) => {
         hideModels: options?.hideModels ?? false,
         operationsSorter: options?.operationsSorter,
         tagsSorter: options?.tagsSorter,
+        operationTitleSource: options?.operationTitleSource,
         generateId,
     };
 };

package/dist/navigation/helpers/get-openapi-object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-openapi-object.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/get-openapi-object.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAE9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC/G,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AAIxF,KAAK,kBAAkB,GAAG,iBAAiB,GAAG,YAAY,GAAG,kBAAkB,CAAA;AAE/E,KAAK,gBAAgB,CAAC,KAAK,SAAS,kBAAkB,IAAI,KAAK,SAAS,iBAAiB,GACrF,iBAAiB,GACjB,KAAK,SAAS,YAAY,GACxB,SAAS,GACT,KAAK,SAAS,kBAAkB,GAC9B,eAAe,GACf,KAAK,CAAA;AAEb,0EAA0E;AAC1E,eAAO,MAAM,YAAY,GAAI,OAAO,cAAc,KAAG,KAAK,IAAI,kBACmB,CAAA;AAEjF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,SAAS,kBAAkB,EAAE,mBAGhE;IACD,KAAK,EAAE,cAAc,CAAA;IACrB,KAAK,EAAE,KAAK,CAAA;CACb,KAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,IA2B7B,CAAA"}
+{"version":3,"file":"get-openapi-object.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/get-openapi-object.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAE9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAE/G,OAAO,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AAIxF,KAAK,kBAAkB,GAAG,iBAAiB,GAAG,YAAY,GAAG,kBAAkB,CAAA;AAE/E,KAAK,gBAAgB,CAAC,KAAK,SAAS,kBAAkB,IAAI,KAAK,SAAS,iBAAiB,GACrF,iBAAiB,GACjB,KAAK,SAAS,YAAY,GACxB,SAAS,GACT,KAAK,SAAS,kBAAkB,GAC9B,eAAe,GACf,KAAK,CAAA;AAEb,0EAA0E;AAC1E,eAAO,MAAM,YAAY,GAAI,OAAO,cAAc,KAAG,KAAK,IAAI,kBACmB,CAAA;AAEjF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,SAAS,kBAAkB,EAAE,mBAGhE;IACD,KAAK,EAAE,cAAc,CAAA;IACrB,KAAK,EAAE,KAAK,CAAA;CACb,KAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,IAgC7B,CAAA"}

package/dist/navigation/helpers/get-openapi-object.js

@@ -1,4 +1,5 @@
 import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { isOpenApiDocument } from '../../schemas/type-guards.js';
 import { getParentEntry } from './get-parent-entry.js';
 /** Type guard which checks if the entry has an x-scalar-order property */
 export const canHaveOrder = (entry) => entry.type === 'document' || entry.type === 'tag' || entry.type === 'operation';
@@ -35,6 +36,10 @@ export const getOpenapiObject = ({ store, entry, }) => {
     if (entry.type === 'document') {
         return document;
     }
+    // Tag and operation lookups only make sense on OpenAPI documents.
+    if (!isOpenApiDocument(document)) {
+        return null;
+    }
     if (entry.type === 'tag') {
         // Find the tag by name in the document's tags array
         return document.tags?.find((tag) => tag.name === entry.name) ?? null;

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;;;;;;;CAoH5G,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;;;;;;;CA6H5G,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 } = getNavigationOptions(documentName, options);
+    const { hideModels, tagsSorter, operationsSorter, generateId, operationTitleSource } = getNavigationOptions(documentName, options);
     const documentId = generateId({
         type: 'document',
         info: document.info,
@@ -33,7 +33,13 @@ export const traverseDocument = (documentName, document, options) => {
         info: document.info,
     });
     /** Traverse all the document path  */
-    const { untaggedOperations } = traversePaths({ document, tagsMap, generateId, documentId });
+    const { untaggedOperations } = traversePaths({
+        document,
+        tagsMap,
+        generateId,
+        documentId,
+        operationTitleSource,
+    });
     const untaggedWebhooksParentId = generateId({
         type: 'webhook',
         name: '',

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

@@ -1,4 +1,4 @@
-import type { TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
+import type { OperationTitleSource, TagsMap, TraverseSpecOptions } from '../../navigation/types.js';
 import type { TraversedOperation } from '../../schemas/navigation.js';
 import type { OpenApiDocument, OperationObject } from '../../schemas/v3.1/strict/openapi-document.js';
 export declare const isDeprecatedOperation: (operation: OperationObject) => boolean;
@@ -19,7 +19,7 @@ export declare const isDeprecatedOperation: (operation: OperationObject) => bool
  * @param getOperationId - Function to generate unique IDs for operations
  * @returns Object containing the tagsMap and an array of untagged operations
  */
-export declare const traversePaths: ({ document, tagsMap, generateId, documentId, }: {
+export declare const traversePaths: ({ document, tagsMap, generateId, documentId, operationTitleSource, }: {
     document: OpenApiDocument;
     /** Map of tags and their entries */
     tagsMap: TagsMap;
@@ -27,6 +27,8 @@ export declare const traversePaths: ({ document, tagsMap, generateId, documentId
     generateId: TraverseSpecOptions["generateId"];
     /** Document ID */
     documentId: string;
+    /** Whether to use the operation summary or the operation path for sidebar titles */
+    operationTitleSource?: OperationTitleSource;
 }) => {
     untaggedOperations: TraversedOperation[];
 };

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

@@ -1 +1 @@
-{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-paths.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAEtE,OAAO,KAAK,EAA+B,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC3F,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAI9F,eAAO,MAAM,qBAAqB,GAAI,WAAW,eAAe,YAE/D,CAAA;AAoED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GAAI,gDAK3B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,0DAA0D;IAC1D,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB,KAAG;IAAE,kBAAkB,EAAE,kBAAkB,EAAE,CAAA;CA2D7C,CAAA"}
+{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-paths.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAE5F,OAAO,KAAK,EAA+B,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC3F,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAA;AAI9F,eAAO,MAAM,qBAAqB,GAAI,WAAW,eAAe,YAE/D,CAAA;AAsED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,GAAI,sEAM3B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,0DAA0D;IAC1D,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,oFAAoF;IACpF,oBAAoB,CAAC,EAAE,oBAAoB,CAAA;CAC5C,KAAG;IAAE,kBAAkB,EAAE,kBAAkB,EAAE,CAAA;CA6D7C,CAAA"}

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

@@ -1,7 +1,8 @@
 import { isHttpMethod } from '@scalar/helpers/http/is-http-method';
 import { objectKeys } from '@scalar/helpers/object/object-keys';
 import { escapeJsonPointer } from '@scalar/json-magic/helpers/escape-json-pointer';
-import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { getResolvedRef, mergeSiblingReferences } from '../../helpers/get-resolved-ref.js';
+import { isHidden } from '../../helpers/is-hidden.js';
 import { traverseOperationExamples } from '../../navigation/helpers/traverse-examples.js';
 import { XScalarStabilityValues } from '../../schemas/extensions/operation/index.js';
 import { getTag } from './get-tag.js';
@@ -20,7 +21,7 @@ export const isDeprecatedOperation = (operation) => {
  * @param getOperationId - Function to generate unique IDs for operations
  * @returns A traversed operation entry with ID, title, path, method and reference
  */
-const createOperationEntry = ({ ref, operation, method, path, generateId, parentId, parentTag, }) => {
+const createOperationEntry = ({ ref, operation, method, path, generateId, parentId, parentTag, operationTitleSource, }) => {
     const id = generateId({
         type: 'operation',
         operation,
@@ -29,7 +30,7 @@ const createOperationEntry = ({ ref, operation, method, path, generateId, parent
         path: path,
         parentId: parentId,
     });
-    const title = operation.summary?.trim() ? operation.summary : path;
+    const title = operationTitleSource === 'path' ? path : operation.summary?.trim() ? operation.summary : path;
     const isDeprecated = isDeprecatedOperation(operation);
     const examples = traverseOperationExamples(operation).map((example) => ({
         type: 'example',
@@ -70,19 +71,19 @@ const createOperationEntry = ({ ref, operation, method, path, generateId, parent
  * @param getOperationId - Function to generate unique IDs for operations
  * @returns Object containing the tagsMap and an array of untagged operations
  */
-export const traversePaths = ({ document, tagsMap, generateId, documentId, }) => {
+export const traversePaths = ({ document, tagsMap, generateId, documentId, operationTitleSource, }) => {
     const untaggedOperations = [];
     // Traverse paths
     Object.entries(document.paths ?? {}).forEach(([path, pathItemObject]) => {
         const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key));
         pathKeys.forEach((method) => {
             const _operation = pathItemObject?.[method];
-            const operation = getResolvedRef(_operation);
+            const operation = getResolvedRef(_operation, mergeSiblingReferences);
             if (!operation) {
                 return;
             }
             // Skip if the operation is internal or scalar-ignore
-            if (operation['x-internal'] || operation['x-scalar-ignore'] || !isHttpMethod(method)) {
+            if (isHidden(operation) || !isHttpMethod(method)) {
                 return;
             }
             const ref = `#/paths/${escapeJsonPointer(path)}/${method}`;
@@ -103,6 +104,7 @@ export const traversePaths = ({ document, tagsMap, generateId, documentId, }) =>
                         parentTag: { tag, id: tagId },
                         generateId,
                         parentId: tagId,
+                        operationTitleSource,
                     }));
                 });
             }
@@ -115,6 +117,7 @@ export const traversePaths = ({ document, tagsMap, generateId, documentId, }) =>
                     path,
                     generateId,
                     parentId: documentId,
+                    operationTitleSource,
                 }));
             }
         });

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

@@ -1 +1 @@
-{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAa,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAgB,MAAM,wCAAwC,CAAA;AA2C3F;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,gDAK7B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,UAAU,EAAE,MAAM,CAAA;CACnB,KAAG,eAAe,EA4ClB,CAAA"}
+{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAa,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtE,OAAO,KAAK,EAAE,eAAe,EAAgB,MAAM,wCAAwC,CAAA;AA2C3F;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,GAAI,gDAK7B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,UAAU,EAAE,MAAM,CAAA;CACnB,KAAG,eAAe,EAiDlB,CAAA"}

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

@@ -1,4 +1,5 @@
-import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { getResolvedRef, mergeSiblingReferences } from '../../helpers/get-resolved-ref.js';
+import { isHidden } from '../../helpers/is-hidden.js';
 import { getTag } from '../../navigation/helpers/get-tag.js';
 /** Creates a traversed schema entry from an OpenAPI schema object.
  *
@@ -33,10 +34,14 @@ const createSchemaEntry = ({ ref, name, generateId, parentTag, _schema, parentId
 export const traverseSchemas = ({ document, tagsMap, generateId, documentId, }) => {
     const schemas = document.components?.schemas ?? {};
     const untagged = [];
-    // biome-ignore lint/suspicious/useGuardForIn: we do have an if statement after de-ref
     for (const name in schemas) {
-        const schema = getResolvedRef(schemas[name]);
-        if (schema?.['x-internal'] || schema?.['x-scalar-ignore'] || !Object.hasOwn(schemas, name)) {
+        if (!Object.hasOwn(schemas, name)) {
+            continue;
+        }
+        // Merge wrapper siblings onto the dereferenced schema so x-internal / x-scalar-ignore
+        // set alongside a $ref are honored (e.g. https://github.com/scalar/scalar/issues/9114).
+        const schema = getResolvedRef(schemas[name], mergeSiblingReferences);
+        if (isHidden(schema)) {
             continue;
         }
         const ref = `#/components/schemas/${name}`;

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

@@ -1 +1 @@
-{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-tags.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,sBAAsB,CAAA;AACxE,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAIxF,KAAK,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,YAAY,GAAG,kBAAkB,GAAG,YAAY,CAAC,CAAA;AA4K1F;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,2FAK1B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;CACjB,KAAG,cAAc,EAyCjB,CAAA"}
+{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-tags.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,sBAAsB,CAAA;AACxE,OAAO,KAAK,EAAE,eAAe,EAAa,MAAM,wCAAwC,CAAA;AAIxF,KAAK,OAAO,GAAG,IAAI,CAAC,mBAAmB,EAAE,YAAY,GAAG,kBAAkB,GAAG,YAAY,CAAC,CAAA;AA4K1F;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,2FAK1B;IACD,QAAQ,EAAE,eAAe,CAAA;IACzB,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;CACjB,KAAG,cAAc,EAyCjB,CAAA"}

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

@@ -1,4 +1,5 @@
 import { sortByOrder } from '@scalar/helpers/array/sort-by-order';
+import { isHidden } from '../../helpers/is-hidden.js';
 import { unpackProxyObject } from '../../helpers/unpack-proxy.js';
 import { getXKeysFromObject } from '../../navigation/helpers/get-x-keys.js';
 import { getTag } from './get-tag.js';
@@ -61,7 +62,7 @@ const getSortedTagEntries = ({ _keys, tagsMap, options: { tagsSorter, operations
     const entries = _keys.flatMap((key) => {
         const { tag, entries } = getTag({ tagsMap, name: key, documentId, generateId });
         // Skip if the tag is internal or scalar-ignore
-        if (tag['x-internal'] || tag['x-scalar-ignore']) {
+        if (isHidden(tag)) {
             return [];
         }
         const sortOrder = tag['x-scalar-order'];

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

@@ -1 +1 @@
-{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAa,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAA8B,MAAM,wCAAwC,CAAA;AA2DzG;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAAI,0EAM9B;IACD,uBAAuB;IACvB,QAAQ,EAAE,eAAe,CAAA;IACzB,6CAA6C;IAC7C,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,MAAM,CAAA;CACnB,KAAG,gBAAgB,EA0DnB,CAAA"}
+{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACtE,OAAO,KAAK,EAAa,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAA8B,MAAM,wCAAwC,CAAA;AA2DzG;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAAI,0EAM9B;IACD,uBAAuB;IACvB,QAAQ,EAAE,eAAe,CAAA;IACzB,6CAA6C;IAC7C,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAA;IAC7C,wBAAwB,EAAE,MAAM,CAAA;IAChC,UAAU,EAAE,MAAM,CAAA;CACnB,KAAG,gBAAgB,EA0DnB,CAAA"}

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

@@ -1,6 +1,7 @@
 import { isHttpMethod } from '@scalar/helpers/http/is-http-method';
 import { objectKeys } from '@scalar/helpers/object/object-keys';
-import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { getResolvedRef, mergeSiblingReferences } from '../../helpers/get-resolved-ref.js';
+import { isHidden } from '../../helpers/is-hidden.js';
 import { isDeprecatedOperation } from '../../navigation/helpers/traverse-paths.js';
 import { getTag } from './get-tag.js';
 /** Creates a traversed webhook entry from an OpenAPI webhook object.
@@ -56,12 +57,12 @@ export const traverseWebhooks = ({ document, tagsMap, generateId, untaggedWebhoo
         const pathKeys = objectKeys(pathItemObject ?? {}).filter((key) => isHttpMethod(key));
         pathKeys.forEach((method) => {
             const _operation = pathItemObject?.[method];
-            const operation = getResolvedRef(_operation);
+            const operation = getResolvedRef(_operation, mergeSiblingReferences);
             if (!operation) {
                 return;
             }
             // Skip if the operation is internal or scalar-ignore
-            if (operation['x-internal'] || operation['x-scalar-ignore']) {
+            if (isHidden(operation)) {
                 return;
             }
             const ref = `#/webhooks/${name}/${method}`;

package/dist/navigation/helpers/update-order-ids.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update-order-ids.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/update-order-ids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAG9C,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACvH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAEtE,KAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,cAAc,CAAA;IACrB,UAAU,EAAE,WAAW,CAAA;CACxB,GAAG,CACA;IACE,8DAA8D;IAC9D,OAAO,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAA;IAC1E,SAAS,EAAE,eAAe,CAAA;IAC1B,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,6CAA6C;IAC7C,OAAO,EAAE,UAAU,CAAC,YAAY,CAAC,EAAE,CAAA;IACnC,GAAG,EAAE,SAAS,CAAA;CACf,CACJ,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,gCAAgC,mBAAmB,SA+DjF,CAAA"}
+{"version":3,"file":"update-order-ids.d.ts","sourceRoot":"","sources":["../../../src/navigation/helpers/update-order-ids.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAG9C,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEvH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wCAAwC,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAEtE,KAAK,mBAAmB,GAAG;IACzB,KAAK,EAAE,cAAc,CAAA;IACrB,UAAU,EAAE,WAAW,CAAA;CACxB,GAAG,CACA;IACE,8DAA8D;IAC9D,OAAO,EAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAA;IAC1E,SAAS,EAAE,eAAe,CAAA;IAC1B,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,6CAA6C;IAC7C,OAAO,EAAE,UAAU,CAAC,YAAY,CAAC,EAAE,CAAA;IACnC,GAAG,EAAE,SAAS,CAAA;CACf,CACJ,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,gCAAgC,mBAAmB,SAiEjF,CAAA"}

package/dist/navigation/helpers/update-order-ids.js

@@ -1,5 +1,6 @@
 import { canHaveOrder, getOpenapiObject } from '../../navigation/helpers/get-openapi-object.js';
 import { getParentEntry } from '../../navigation/helpers/get-parent-entry.js';
+import { isOpenApiDocument } from '../../schemas/type-guards.js';
 /**
  * Updates the order ID of an entry (operation or tag) in the sidebar.
  * Used when changing path, method, or tag name so we do not lose the sidebar ordering.
@@ -36,7 +37,9 @@ export const updateOrderIds = ({ store, generateId, ...rest }) => {
             if (oldTagId !== newTagId) {
                 const documentEntry = getParentEntry('document', entry);
                 const document = documentEntry ? store.workspace.documents[documentEntry.name] : null;
-                const renamedTagObj = document?.tags?.find((t) => t.name === rest.tag.name);
+                const renamedTagObj = isOpenApiDocument(document)
+                    ? document.tags?.find((t) => t.name === rest.tag.name)
+                    : undefined;
                 const childOrder = renamedTagObj?.['x-scalar-order'];
                 if (renamedTagObj && Array.isArray(childOrder)) {
                     const oldPrefix = `${oldTagId}/`;

package/dist/navigation/types.d.ts

@@ -14,6 +14,8 @@ type OperationSortValue = {
     /** @deprecated use method instead */
     httpVerb: string;
 };
+/** Whether to use the operation summary or the operation path for sidebar and search titles */
+export type OperationTitleSource = 'summary' | 'path';
 /** Configuration options for traversing an OpenAPI specification document.
  *
  * These options control how the document is processed and organized, including:
@@ -28,6 +30,8 @@ export type TraverseSpecOptions = {
     operationsSorter?: 'alpha' | 'method' | ((a: OperationSortValue, b: OperationSortValue) => number);
     /** Whether to hide model schemas from the navigation */
     hideModels: boolean;
+    /** Whether to derive operation titles from the operation summary or the path */
+    operationTitleSource?: OperationTitleSource;
     generateId: IdGenerator;
 };
 export type Heading = {

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;;;;;;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,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,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"}