@scalar/api-reference 1.31.3 → 1.31.6

package/dist/features/traverse-schema/helpers/get-tag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-tag.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/get-tag.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,qEAAqE;AACrE,eAAO,MAAM,MAAM,aAAc,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,QAAQ,MAAM,wDAWhF,CAAA"}

package/dist/features/traverse-schema/helpers/operation-id-params.d.ts

@@ -0,0 +1,8 @@
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { TransformedOperation } from '@scalar/types/legacy';
+/** Temp helper for converting transformed operation to operationId payload */
+export declare const operationIdParams: (transformedOperation: TransformedOperation) => {
+    path: string;
+    method: OpenAPIV3_1.HttpMethods;
+} & OpenAPIV3_1.OperationObject;
+//# sourceMappingURL=operation-id-params.d.ts.map

package/dist/features/traverse-schema/helpers/operation-id-params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-id-params.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/operation-id-params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAEhE,8EAA8E;AAC9E,eAAO,MAAM,iBAAiB,yBACN,oBAAoB,KACzC;IACD,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;CAChC,GAAG,WAAW,CAAC,eAId,CAAA"}

package/dist/features/traverse-schema/helpers/operation-id-params.js

@@ -0,0 +1,8 @@
+const o = (t) => ({
+  ...t.information,
+  path: t.path,
+  method: t.httpVerb.toLowerCase()
+});
+export {
+  o as operationIdParams
+};

package/dist/features/traverse-schema/helpers/traverse-description.d.ts

@@ -0,0 +1,9 @@
+import type { TraversedDescription } from '../../../features/traverse-schema/types';
+import type { Heading } from '@scalar/types/legacy';
+export declare const DEFAULT_INTRODUCTION_SLUG = "introduction";
+/**
+ * Creates sidebar entries from markdown headings in the OpenAPI description.
+ * Only includes the top two levels of headings for a clean hierarchy.
+ */
+export declare const traverseDescription: (description: string | undefined, titlesMap: Map<string, string>, getHeadingId: (heading: Heading) => string) => TraversedDescription[];
+//# sourceMappingURL=traverse-description.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-description.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse-description.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-description.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AAE5E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEnD,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAEvD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,gBACjB,MAAM,GAAG,SAAS,aAEpB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,gBAChB,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,KACzC,oBAAoB,EAmDtB,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-document.d.ts

@@ -0,0 +1,16 @@
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { TraverseSpecOptions, TraversedEntry } from '../../../features/traverse-schema/types';
+/**
+ * Travers the OpenAPI Document and ensure we only do it once
+ *
+ * We are generating the following:
+ * - the sidebar
+ * - the search index (todo)
+ *
+ * Currently its called by createSidebar, but we can move this into the de-reference process as a plugin for even more gains
+ */
+export declare const traverseDocument: (document: OpenAPIV3_1.Document, { config, getHeadingId, getOperationId, getWebhookId, getModelId, getTagId }: TraverseSpecOptions) => {
+    entries: TraversedEntry[];
+    titles: Map<string, string>;
+};
+//# sourceMappingURL=traverse-document.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse-document.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAOxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAA;AAE3F;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,aACjB,WAAW,CAAC,QAAQ,gFACgD,mBAAmB;;;CA6ClG,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-paths.d.ts

@@ -0,0 +1,11 @@
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { TraversedOperation } from '../../../features/traverse-schema/types';
+import type { UseNavState } from '../../../hooks/useNavState.js';
+/**
+ * Traverse the paths of the spec and build a map of tags and operations
+ *
+ * Default tag is to match what we have now we can improve later
+ * TODO: filter out internal and scalar-ignore tags
+ */
+export declare const traversePaths: (content: OpenAPIV3_1.Document, tagsDict: Map<string, OpenAPIV3_1.TagObject>, titlesMap: Map<string, string>, getOperationId: UseNavState["getOperationId"]) => Map<string, TraversedOperation[]>;
+//# sourceMappingURL=traverse-paths.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse-paths.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-paths.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAA;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAuBtD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,YACf,WAAW,CAAC,QAAQ,YAEnB,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,aAEjC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,kBACd,WAAW,CAAC,gBAAgB,CAAC,KAC5C,GAAG,CAAC,MAAM,EAAE,kBAAkB,EAAE,CAiClC,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-schemas.d.ts

@@ -0,0 +1,6 @@
+import type { TraversedSchema } from '../../../features/traverse-schema/types';
+import type { UseNavState } from '../../../hooks/useNavState.js';
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+/** Traverse components.schemas to create entries for models */
+export declare const traverseSchemas: (content: OpenAPIV3_1.Document, titlesMap: Map<string, string>, getModelId: UseNavState["getModelId"]) => TraversedSchema[];
+//# sourceMappingURL=traverse-schemas.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse-schemas.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-schemas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AACvE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAoBxD,+DAA+D;AAC/D,eAAO,MAAM,eAAe,YACjB,WAAW,CAAC,QAAQ,aAElB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,cAClB,WAAW,CAAC,YAAY,CAAC,KACpC,eAAe,EAcjB,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-tags.d.ts

@@ -0,0 +1,9 @@
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
+import type { TraversedEntry } from '../../../features/traverse-schema/types';
+import type { UseNavState } from '../../../hooks/useNavState.js';
+type Options = Pick<UseNavState, 'getTagId'> & Pick<ApiReferenceConfiguration, 'tagsSorter' | 'operationsSorter'>;
+/** Traverses our tags map creates entries, also handles sorting and tagGroups */
+export declare const traverseTags: (content: OpenAPIV3_1.Document, tagsMap: Map<string, TraversedEntry[]>, tagsDict: Map<string, OpenAPIV3_1.TagObject>, titlesMap: Map<string, string>, { getTagId, tagsSorter, operationsSorter }: Options) => TraversedEntry[];
+export {};
+//# sourceMappingURL=traverse-tags.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-tags.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse-tags.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-tags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,kCAAkC,CAAA;AACpF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAGtD,KAAK,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,GAAG,kBAAkB,CAAC,CAAA;AAuGjH,iFAAiF;AACjF,eAAO,MAAM,YAAY,YACd,WAAW,CAAC,QAAQ,WAEpB,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,YAE5B,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,aAEjC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,8CACc,OAAO,KAClD,cAAc,EAyBhB,CAAA"}

package/dist/features/traverse-schema/helpers/traverse-webhooks.d.ts

@@ -0,0 +1,6 @@
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { TraversedEntry, TraversedWebhook } from '../../../features/traverse-schema/types';
+import type { UseNavState } from '../../../hooks/useNavState.js';
+/** When traversing webhooks, we pass in the tags in from operations to save on memory */
+export declare const traverseWebhooks: (content: OpenAPIV3_1.Document, tagsMap: Map<string, TraversedEntry[]>, tagsDict: Map<string, OpenAPIV3_1.TagObject>, titlesMap: Map<string, string>, getWebhookId: UseNavState["getWebhookId"]) => TraversedWebhook[];
+//# sourceMappingURL=traverse-webhooks.d.ts.map

package/dist/features/traverse-schema/helpers/traverse-webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse-webhooks.d.ts","sourceRoot":"","sources":["../../../../src/features/traverse-schema/helpers/traverse-webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AACxF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAyBtD,yFAAyF;AACzF,eAAO,MAAM,gBAAgB,YAClB,WAAW,CAAC,QAAQ,WAEpB,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,CAAC,YAE5B,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,SAAS,CAAC,aAEjC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,gBAChB,WAAW,CAAC,cAAc,CAAC,KACxC,gBAAgB,EA+BlB,CAAA"}

package/dist/features/traverse-schema/index.d.ts

@@ -0,0 +1,4 @@
+export type { TraverseSpecOptions } from './types';
+export { traverseDocument } from './helpers/traverse-document';
+export { operationIdParams } from './helpers/operation-id-params.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/features/traverse-schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/traverse-schema/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAA"}

package/dist/features/traverse-schema/types.d.ts

@@ -0,0 +1,51 @@
+import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
+import type { UseNavState } from '../../hooks/useNavState.js';
+import type { Ref } from 'vue';
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+/** Description entry returned form traversing the document */
+export type TraversedDescription = {
+    id: string;
+    title: string;
+    children?: TraversedDescription[];
+};
+/** Operation entry returned form traversing the document */
+export type TraversedOperation = {
+    id: string;
+    title: string;
+    method: OpenAPIV3_1.HttpMethods;
+    path: string;
+    operation: OpenAPIV3_1.OperationObject;
+};
+/** Model entry returned form traversing the document */
+export type TraversedSchema = {
+    id: string;
+    title: string;
+    name: string;
+    schema: OpenAPIV3_1.SchemaObject;
+};
+/** Tag entry returned form traversing the document, includes tagGroups */
+export type TraversedTag = {
+    id: string;
+    title: string;
+    name: string;
+    children?: TraversedEntry[];
+    tag: OpenAPIV3_1.TagObject;
+    isGroup: boolean;
+};
+/** Webhook entry returned form traversing the document, basically the same as an operaation but with name instead of path */
+export type TraversedWebhook = {
+    id: string;
+    title: string;
+    method: OpenAPIV3_1.HttpMethods;
+    name: string;
+    webhook: OpenAPIV3_1.OperationObject;
+};
+/** Entries returned form traversing the document */
+export type TraversedEntry = TraversedDescription | TraversedOperation | TraversedSchema | TraversedTag | TraversedWebhook;
+/** Create sidebar options */
+export type TraverseSpecOptions = {
+    config: Ref<ApiReferenceConfiguration>;
+    /** You can optionally pass in these refs in case you need them before the hook is instantiated */
+    isSidebarOpen?: Ref<boolean>;
+} & Pick<UseNavState, 'getHeadingId' | 'getModelId' | 'getOperationId' | 'getSectionId' | 'getTagId' | 'getWebhookId'>;
+//# sourceMappingURL=types.d.ts.map

package/dist/features/traverse-schema/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/features/traverse-schema/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAE5E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAC9B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,8DAA8D;AAC9D,MAAM,MAAM,oBAAoB,GAAG;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,oBAAoB,EAAE,CAAA;CAClC,CAAA;AAED,4DAA4D;AAC5D,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,WAAW,CAAC,eAAe,CAAA;CACvC,CAAA;AAED,wDAAwD;AACxD,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,WAAW,CAAC,YAAY,CAAA;CACjC,CAAA;AAED,0EAA0E;AAC1E,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,GAAG,EAAE,WAAW,CAAC,SAAS,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,6HAA6H;AAC7H,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,WAAW,CAAC,eAAe,CAAA;CACrC,CAAA;AAED,oDAAoD;AACpD,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,kBAAkB,GAClB,eAAe,GACf,YAAY,GACZ,gBAAgB,CAAA;AAEpB,6BAA6B;AAC7B,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,GAAG,CAAC,yBAAyB,CAAC,CAAA;IACtC,kGAAkG;IAClG,aAAa,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CAC7B,GAAG,IAAI,CAAC,WAAW,EAAE,cAAc,GAAG,YAAY,GAAG,gBAAgB,GAAG,cAAc,GAAG,UAAU,GAAG,cAAc,CAAC,CAAA"}

package/dist/helpers/parse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAOhD;;;;GAIG;AACH,eAAO,MAAM,KAAK,yBAA0B,WAAW,CAAC,QAAQ,KAAG,OAAO,CAAC,IAAI,CAmB9E,CAAA"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAQhD;;;;GAIG;AACH,eAAO,MAAM,KAAK,yBAA0B,WAAW,CAAC,QAAQ,KAAG,OAAO,CAAC,IAAI,CAmB9E,CAAA"}

package/dist/helpers/parse.js

@@ -1,7 +1,7 @@
-import { shouldIgnoreEntity as u } from "@scalar/oas-utils/helpers";
+import { shouldIgnoreEntity as m } from "@scalar/oas-utils/helpers";
 import { createEmptySpecification as w } from "../libs/openapi.js";
-import { normalizeRequestMethod as R } from "../legacy/helpers/normalizeRequestMethod.js";
-import { validRequestMethods as q } from "../legacy/fixtures/httpRequestMethods.js";
+import { normalizeHttpMethod as P } from "@scalar/helpers/http/normalize-http-method";
+import { validRequestMethods as A } from "../legacy/fixtures/httpRequestMethods.js";
 const C = (c) => new Promise(async (t, p) => {
   try {
     return t(b(c || w()));
@@ -17,22 +17,22 @@ const C = (c) => new Promise(async (t, p) => {
   return Object.keys(t.webhooks ?? {}).forEach((s) => {
     var d;
     Object.keys(((d = t.webhooks) == null ? void 0 : d[s]) ?? {}).forEach((r) => {
-      var n, m, h, g;
+      var n, u, h, g;
       const e = (n = t.webhooks) == null ? void 0 : n[s][r];
-      if (!(!e || u(e))) {
+      if (!(!e || m(e))) {
         if (Array.isArray(e.tags)) {
-          const o = (m = e.tags) == null ? void 0 : m.map(
+          const o = (u = e.tags) == null ? void 0 : u.map(
             (a) => {
               var y;
               return (y = t.tags) == null ? void 0 : y.find((i) => i.name === a);
             }
           );
-          if (e.tags = o == null ? void 0 : o.filter((a) => !u(a)), o != null && o.some((a) => u(a)))
+          if (e.tags = o == null ? void 0 : o.filter((a) => !m(a)), o != null && o.some((a) => m(a)))
             return;
         }
         p[s] === void 0 && (p[s] = {}), p[s][r] = {
           // Transformed data
-          httpVerb: R(r),
+          httpVerb: P(r),
           path: s,
           operationId: (e == null ? void 0 : e.operationId) || s,
           name: (e == null ? void 0 : e.summary) || s || "",
@@ -47,17 +47,17 @@ const C = (c) => new Promise(async (t, p) => {
     });
   }), Object.keys(((E = t.components) == null ? void 0 : E.schemas) ?? {}).forEach((s) => {
     var d, r, e, n;
-    u((r = (d = t.components) == null ? void 0 : d.schemas) == null ? void 0 : r[s]) && ((n = (e = t.components) == null ? void 0 : e.schemas) == null || delete n[s]);
+    m((r = (d = t.components) == null ? void 0 : d.schemas) == null ? void 0 : r[s]) && ((n = (e = t.components) == null ? void 0 : e.schemas) == null || delete n[s]);
   }), Object.keys(t.paths).forEach((s) => {
     Object.keys(t.paths[s]).filter(
-      (r) => q.includes(r.toUpperCase())
+      (r) => A.includes(r.toUpperCase())
     ).forEach((r) => {
-      var m, h, g, o, a, y;
+      var u, h, g, o, a, y;
       const e = t.paths[s][r];
-      if (e === void 0 || u(e))
+      if (e === void 0 || m(e))
         return;
       const n = {
-        httpVerb: R(r),
+        httpVerb: P(r),
         path: s,
         operationId: e.operationId || s,
         name: e.summary || s || "",
@@ -65,7 +65,7 @@ const C = (c) => new Promise(async (t, p) => {
         information: {
           ...e
         },
-        pathParameters: (h = (m = t.paths) == null ? void 0 : m[s]) == null ? void 0 : h.parameters
+        pathParameters: (h = (u = t.paths) == null ? void 0 : u[s]) == null ? void 0 : h.parameters
       };
       if (!e.tags || e.tags.length === 0) {
         (g = t.tags) != null && g.find((f) => f.name === "default") || (o = t.tags) == null || o.push({
@@ -78,7 +78,7 @@ const C = (c) => new Promise(async (t, p) => {
       } else
         e.tags.forEach((i) => {
           var k, x, j;
-          const f = (k = t.tags) == null ? void 0 : k.findIndex((P) => P.name === i);
+          const f = (k = t.tags) == null ? void 0 : k.findIndex((R) => R.name === i);
           f === -1 && ((x = t.tags) == null || x.push({
             name: i,
             description: ""
@@ -87,7 +87,7 @@ const C = (c) => new Promise(async (t, p) => {
           typeof ((j = t.tags[I]) == null ? void 0 : j.operations) > "u" && (t.tags[I].operations = []), t.tags[I].operations.push(n);
         });
     });
-  }), t.tags = (O = t.tags) == null ? void 0 : O.filter((s) => !u(s)), {
+  }), t.tags = (O = t.tags) == null ? void 0 : O.filter((s) => !m(s)), {
     ...t,
     webhooks: p
   };

package/dist/hooks/useNavState.d.ts

@@ -1,5 +1,5 @@
 import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
-import type { Heading, Tag, TransformedOperation } from '@scalar/types/legacy';
+import type { Heading, OpenAPIV3_1 } from '@scalar/types/legacy';
 import { type InjectionKey, type Ref } from 'vue';
 export type NavState = {
     /** The URL hash without the #, also the "hash" pulled from pathRouting */
@@ -45,16 +45,21 @@ export declare const useNavState: (_config?: Ref<ApiReferenceConfiguration>) =>
     getWebhookId: (webhook?: {
         name: string;
         method?: string;
-    }) => string;
+    }, parentTag?: OpenAPIV3_1.TagObject) => string;
     getModelId: (model?: {
         name: string;
     }) => string;
     getHeadingId: (heading: Heading) => string;
-    getOperationId: (operation: TransformedOperation, parentTag: Tag) => string;
+    getOperationId: (operation: {
+        path: string;
+        method: OpenAPIV3_1.HttpMethods;
+    } & OpenAPIV3_1.OperationObject, parentTag: OpenAPIV3_1.TagObject) => string;
     getPathRoutingId: (pathName: string) => string;
     getSectionId: (hashStr?: string) => string;
-    getTagId: (tag: Tag) => string;
+    getTagId: (tag: OpenAPIV3_1.TagObject) => string;
     isIntersectionEnabled: Ref<boolean, boolean>;
     updateHash: () => string;
 };
+/** Whats returned from the hook */
+export type UseNavState = ReturnType<typeof useNavState>;
 //# sourceMappingURL=useNavState.d.ts.map

package/dist/hooks/useNavState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAE9E,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAE9D,MAAM,MAAM,QAAQ,GAAG;IACrB,0EAA0E;IAC1E,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,2CAA2C;IAC3C,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACvB,sFAAsF;IACtF,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACpC,CAAA;AACD,eAAO,MAAM,gBAAgB,EAAe,YAAY,CAAC,QAAQ,CAAC,CAAA;AAOlE;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,aAAc,GAAG,CAAC,yBAAyB,CAAC;;IAuIhE,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BArE4B,MAAM;IAuErC;;;;;OAKG;oCA3FkC,MAAM;IA6F3C;;;OAGG;uCAlHqC,MAAM;;6BAiFhB;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;yBA9BrC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;4BAXb,OAAO;gCA6BH,oBAAoB,aAAa,GAAG;iCArGnC,MAAM;;oBA8FnB,GAAG;;;CAiE3B,CAAA"}
+{"version":3,"file":"useNavState.d.ts","sourceRoot":"","sources":["../../src/hooks/useNavState.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEhE,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,GAAG,EAAe,MAAM,KAAK,CAAA;AAE9D,MAAM,MAAM,QAAQ,GAAG;IACrB,0EAA0E;IAC1E,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,2CAA2C;IAC3C,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACvB,sFAAsF;IACtF,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACpC,CAAA;AACD,eAAO,MAAM,gBAAgB,EAAe,YAAY,CAAC,QAAQ,CAAC,CAAA;AAOlE;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,aAAc,GAAG,CAAC,yBAAyB,CAAC;;IAiJhE,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BA/E4B,MAAM;IAiFrC;;;;;OAKG;oCArGkC,MAAM;IAuG3C;;;OAGG;uCA5HqC,MAAM;;6BAwFhB;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,cAAc,WAAW,CAAC,SAAS;yBArCxE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;4BAXb,OAAO;gCA8BzB;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;KAChC,GAAG,WAAW,CAAC,eAAe,aACpB,WAAW,CAAC,SAAS;iCA1GE,MAAM;;oBA8FnB,WAAW,CAAC,SAAS;;;CA2E7C,CAAA;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA"}

package/dist/hooks/useNavState.js

@@ -1,32 +1,32 @@
 import { useConfig as b } from "./useConfig.js";
-import { combineUrlAndPath as d } from "@scalar/oas-utils/helpers";
+import { combineUrlAndPath as d } from "@scalar/helpers/url/merge-urls";
 import { slug as i } from "github-slugger";
 import { inject as y, ref as l } from "vue";
-const P = Symbol(), U = l(!1), k = l(""), x = l(""), T = (f) => {
+const P = Symbol(), U = l(!1), x = l(""), k = l(""), T = (f) => {
   const { isIntersectionEnabled: p, hash: r, hashPrefix: u } = y(P, {
     isIntersectionEnabled: U,
-    hash: k,
-    hashPrefix: x
+    hash: x,
+    hashPrefix: k
   }), t = f ?? b(), g = (e) => {
-    var n;
+    var a;
     if (!t.value.pathRouting)
       return "";
-    const a = new RegExp("^" + ((n = t.value.pathRouting) == null ? void 0 : n.basePath) + "/?");
-    return decodeURIComponent(e.replace(a, ""));
+    const n = new RegExp("^" + ((a = t.value.pathRouting) == null ? void 0 : a.basePath) + "/?");
+    return decodeURIComponent(e.replace(n, ""));
   }, v = (e = r.value) => {
     var h;
-    const a = (h = e.match(/(tag\/[^/]+)/)) == null ? void 0 : h[0], n = e.startsWith("model") ? "models" : "", o = e.startsWith("webhook") ? "webhooks" : "";
-    return a || n || o;
+    const n = (h = e.match(/(tag\/[^/]+)/)) == null ? void 0 : h[0], a = e.startsWith("model") ? "models" : "", o = e.startsWith("webhook") ? "webhooks" : "";
+    return n || a || o;
   }, c = () => t.value.pathRouting ? g(window.location.pathname) : (
     // Must remove the prefix from the hash as the internal hash value should be pure
     decodeURIComponent(window.location.hash.replace(/^#/, "")).slice(u.value.length)
-  ), m = () => r.value = c(), I = (e, a = window.location.href) => {
-    const n = new URL(a);
-    t.value.pathRouting ? n.pathname = d(t.value.pathRouting.basePath, e) : n.hash = u.value + e, r.value = e, window.history.replaceState({}, "", n);
-  }, w = (e, a = window.location.href, n = window.location.search) => {
-    const o = new URL(a);
-    return t.value.pathRouting ? o.pathname = d(t.value.pathRouting.basePath, e) : o.hash = u.value + e, o.search = n, o.toString();
-  }, S = (e = r.value) => `${u.value}${e}`, $ = (e) => typeof t.value.generateHeadingSlug == "function" ? `${t.value.generateHeadingSlug(e)}` : e.slug ? `description/${e.slug}` : "", R = (e) => e != null && e.name ? typeof t.value.generateModelSlug == "function" ? `model/${t.value.generateModelSlug(e)}` : `model/${i(e.name)}` : "models", s = (e) => typeof t.value.generateTagSlug == "function" ? `tag/${t.value.generateTagSlug(e)}` : `tag/${i(e.name)}`;
+  ), m = () => r.value = c(), I = (e, n = window.location.href) => {
+    const a = new URL(n);
+    t.value.pathRouting ? a.pathname = d(t.value.pathRouting.basePath, e) : a.hash = u.value + e, r.value = e, window.history.replaceState({}, "", a);
+  }, $ = (e, n = window.location.href, a = window.location.search) => {
+    const o = new URL(n);
+    return t.value.pathRouting ? o.pathname = d(t.value.pathRouting.basePath, e) : o.hash = u.value + e, o.search = a, o.toString();
+  }, w = (e = r.value) => `${u.value}${e}`, S = (e) => typeof t.value.generateHeadingSlug == "function" ? `${t.value.generateHeadingSlug(e)}` : e.slug ? `description/${e.slug}` : "", R = (e) => e != null && e.name ? typeof t.value.generateModelSlug == "function" ? `model/${t.value.generateModelSlug(e)}` : `model/${i(e.name)}` : "models", s = (e) => typeof t.value.generateTagSlug == "function" ? `tag/${t.value.generateTagSlug(e)}` : `tag/${i(e.name ?? "")}`;
   return {
     hash: r,
     /** Sets the prefix for the hash */
@@ -38,32 +38,34 @@ const P = Symbol(), U = l(!1), k = l(""), x = l(""), T = (f) => {
      * @param hashTarget The hash to target with the return
      * @returns The full hash
      */
-    getFullHash: S,
+    getFullHash: w,
     /**
      * Gets the hashed url with the prefix
      * @param replacementHash The hash to replace the current hash with
      * @param url The url to get the hashed url from
      * @returns The hashed url
      */
-    getHashedUrl: w,
+    getHashedUrl: $,
     /**
      * Replaces the URL state with the new url and hash
      * Replacement is used so that hash changes don't trigger the url hash watcher and cause a scroll
      */
     replaceUrlState: I,
     getReferenceId: c,
-    getWebhookId: (e) => e != null && e.name ? typeof t.value.generateWebhookSlug == "function" ? `webhook/${t.value.generateWebhookSlug(e)}` : `webhook/${e.method}/${i(e.name)}` : "webhooks",
-    getModelId: R,
-    getHeadingId: $,
-    getOperationId: (e, a) => {
-      var n;
-      return typeof t.value.generateOperationSlug == "function" ? `${s(a)}/${t.value.generateOperationSlug({
-        path: e.path,
-        operationId: e.operationId,
-        method: e.httpVerb,
-        summary: (n = e.information) == null ? void 0 : n.summary
-      })}` : `${s(a)}/${e.httpVerb}${e.path}`;
+    getWebhookId: (e, n) => {
+      if (!(e != null && e.name))
+        return "webhooks";
+      const a = n ? `${s(n)}/` : "";
+      return typeof t.value.generateWebhookSlug == "function" ? `${a}webhook/${t.value.generateWebhookSlug(e)}` : `${a}webhook/${e.method}/${i(e.name)}`;
     },
+    getModelId: R,
+    getHeadingId: S,
+    getOperationId: (e, n) => typeof t.value.generateOperationSlug == "function" ? `${s(n)}/${t.value.generateOperationSlug({
+      path: e.path,
+      operationId: e.operationId,
+      method: e.method,
+      summary: e.summary
+    })}` : `${s(n)}/${e.method}${e.path}`,
     getPathRoutingId: g,
     getSectionId: v,
     getTagId: s,

package/dist/hooks/useSidebar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../src/hooks/useSidebar.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAG3E,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAcvD,uDAAuD;AACvD,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,QA0ChC;AAMD,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAIpD,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AAkOD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,IAAI,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,CAAA;IACnD,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,EAAE,oBAAoB,KAAK,MAAM,CAAC,CAAA;CACvG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,gBAAiB,MAAM,UAAU,OAAO,SAiBrE,CAAA;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,YAAY;;;;;;;;;;;;;qCAtBrB,MAAM,UAAU,OAAO;EA8FrE"}
+{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../src/hooks/useSidebar.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAI3E,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,OAAO,CAAA;IACb,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,yBAAyB,iBAAiB,CAAA;AAcvD,uDAAuD;AACvD,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,QA0ChC;AAMD,KAAK,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAIpD,iBAAS,0BAA0B,CAAC,GAAG,EAAE,MAAM,QAE9C;AAED,iBAAS,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,QAE3D;AAkOD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,IAAI,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,CAAA;IACnD,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,CAAC,EAAE,oBAAoB,KAAK,MAAM,CAAC,CAAA;CACvG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,gBAAiB,MAAM,UAAU,OAAO,SAiBrE,CAAA;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,YAAY;;;;;;;;;;;;;qCAtBrB,MAAM,UAAU,OAAO;EA8FrE"}