@scalar/api-reference 1.31.8 → 1.31.9

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

@@ -2,6 +2,11 @@ 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';
+/** Map of tagNames and their entries */
+export type TagsMap = Map<string, {
+    tag: OpenAPIV3_1.TagObject;
+    entries: TraversedEntry[];
+}>;
 /** Description entry returned form traversing the document */
 export type TraversedDescription = {
     id: string;
@@ -27,10 +32,10 @@ export type TraversedSchema = {
 export type TraversedTag = {
     id: string;
     title: string;
-    name: string;
-    children?: TraversedEntry[];
+    children: TraversedEntry[];
     tag: OpenAPIV3_1.TagObject;
     isGroup: boolean;
+    isWebhooks?: boolean;
 };
 /** Webhook entry returned form traversing the document, basically the same as an operaation but with name instead of path */
 export type TraversedWebhook = {
@@ -42,10 +47,8 @@ export type TraversedWebhook = {
 };
 /** Entries returned form traversing the document */
 export type TraversedEntry = TraversedDescription | TraversedOperation | TraversedSchema | TraversedTag | TraversedWebhook;
-/** Create sidebar options */
+/** Options for traversing the spec */
 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

@@ -1 +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"}
+{"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,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,WAAW,CAAC,SAAS,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAE5F,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,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,GAAG,EAAE,WAAW,CAAC,SAAS,CAAA;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,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,sCAAsC;AACtC,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,GAAG,CAAC,yBAAyB,CAAC,CAAA;CACvC,GAAG,IAAI,CAAC,WAAW,EAAE,cAAc,GAAG,YAAY,GAAG,gBAAgB,GAAG,cAAc,GAAG,UAAU,GAAG,cAAc,CAAC,CAAA"}

package/dist/helpers/parse.d.ts

@@ -1,9 +1,10 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
 import type { Spec } from '@scalar/types/legacy';
+import type { TraversedEntry } from '../features/traverse-schema';
 /**
  * Parse the given dereferencedDocument and return a super custom transformed dereferencedDocument.
  *
  * @deprecated Try to use a store instead.
  */
-export declare const parse: (dereferencedDocument: OpenAPIV3_1.Document) => Promise<Spec>;
+export declare const parse: (dereferencedDocument: OpenAPIV3_1.Document, items?: TraversedEntry[]) => Promise<Spec>;
 //# sourceMappingURL=parse.d.ts.map

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,IAAI,EAAwB,MAAM,sBAAsB,CAAA;AAGtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAKhE;;;;GAIG;AACH,eAAO,MAAM,KAAK,yBAA0B,WAAW,CAAC,QAAQ,UAAU,cAAc,EAAE,KAAG,OAAO,CAAC,IAAI,CAiBrG,CAAA"}

package/dist/helpers/parse.js

@@ -1,97 +1,81 @@
-import { shouldIgnoreEntity as m } from "@scalar/oas-utils/helpers";
 import { createEmptySpecification as w } from "../libs/openapi.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) => {
+import { normalizeHttpMethod as m } from "@scalar/helpers/http/normalize-http-method";
+const I = (s, i) => new Promise((e, b) => {
   try {
-    return t(b(c || w()));
-  } catch (l) {
-    console.error("[@scalar/api-reference]", "Failed to parse the OpenAPI document. It might be invalid?"), console.error(l), p(l);
+    return e(s ? k(s, i) : k(w()));
+  } catch (p) {
+    console.error("[@scalar/api-reference]", "Failed to parse the OpenAPI document. It might be invalid?"), console.error(p), b(p);
   }
-  return t(b(w()));
-}), b = (c) => {
-  var E, O;
-  let t = {};
-  c && typeof c == "object" ? t = c : t = w(), t.tags || (t.tags = []), t.paths || (t.paths = {}), t.components || (t.components = {}), t.webhooks || (t.webhooks = {}), t.servers || (t.servers = []), t.security || (t.security = []);
-  const p = {};
-  return Object.keys(t.webhooks ?? {}).forEach((s) => {
-    var d;
-    Object.keys(((d = t.webhooks) == null ? void 0 : d[s]) ?? {}).forEach((r) => {
-      var n, u, h, g;
-      const e = (n = t.webhooks) == null ? void 0 : n[s][r];
-      if (!(!e || m(e))) {
-        if (Array.isArray(e.tags)) {
-          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) => !m(a)), o != null && o.some((a) => m(a)))
-            return;
-        }
-        p[s] === void 0 && (p[s] = {}), p[s][r] = {
-          // Transformed data
-          httpVerb: P(r),
-          path: s,
-          operationId: (e == null ? void 0 : e.operationId) || s,
-          name: (e == null ? void 0 : e.summary) || s || "",
-          description: (e == null ? void 0 : e.description) || "",
-          pathParameters: (g = (h = t.paths) == null ? void 0 : h[s]) == null ? void 0 : g.parameters,
-          // Original webhook
-          information: {
-            ...e
-          }
-        };
-      }
+  return e(k(w()));
+}), k = (s, i) => {
+  let e = {};
+  s && typeof s == "object" ? e = s : e = w(), e.tags || (e.tags = []), e.paths || (e.paths = {}), e.components || (e.components = {}), e.webhooks || (e.webhooks = {}), e.servers || (e.servers = []), e.security || (e.security = []);
+  const b = [], p = (o) => {
+    var h;
+    !("children" in o) || !((h = o.children) != null && h.length) || o.children.forEach((a) => {
+      var f, u, t, n, g;
+      let r = (f = e.tags) == null ? void 0 : f.findIndex((d) => "tag" in o && d.name === o.tag.name);
+      r === -1 && "tag" in o && (e.tags.push({
+        name: o.tag.name,
+        operations: []
+      }), r = e.tags.length - 1), e.tags[r].operations ||= [], "tag" in a ? p(a) : "operation" in a ? e.tags[r].operations.push({
+        id: a.id,
+        httpVerb: m(a.method),
+        path: a.path,
+        name: a.operation.summary || a.path || "",
+        description: a.operation.description || "",
+        isWebhook: !1,
+        information: a.operation,
+        pathParameters: (t = (u = e.paths) == null ? void 0 : u[a.path ?? ""]) == null ? void 0 : t.parameters
+      }) : "webhook" in a && e.tags[r].operations.push({
+        id: a.id,
+        httpVerb: m(a.method),
+        path: a.name,
+        name: a.webhook.summary || a.name || "",
+        description: a.webhook.description || "",
+        isWebhook: !0,
+        information: a.webhook,
+        pathParameters: (g = (n = e.webhooks) == null ? void 0 : n[a.name ?? ""]) == null ? void 0 : g.parameters
+      });
     });
-  }), Object.keys(((E = t.components) == null ? void 0 : E.schemas) ?? {}).forEach((s) => {
-    var d, r, e, n;
-    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) => A.includes(r.toUpperCase())
-    ).forEach((r) => {
-      var u, h, g, o, a, y;
-      const e = t.paths[s][r];
-      if (e === void 0 || m(e))
-        return;
-      const n = {
-        httpVerb: P(r),
-        path: s,
-        operationId: e.operationId || s,
-        name: e.summary || s || "",
-        description: e.description || "",
-        information: {
-          ...e
-        },
-        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({
-          name: "default",
-          description: "",
-          operations: []
-        });
-        const i = (a = t.tags) == null ? void 0 : a.findIndex((f) => f.name === "default");
-        i >= 0 && ((y = t.tags[i]) == null || y.operations.push(n));
-      } else
-        e.tags.forEach((i) => {
-          var k, x, j;
-          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: ""
-          }));
-          const I = f !== -1 ? f : t.tags.length - 1;
-          typeof ((j = t.tags[I]) == null ? void 0 : j.operations) > "u" && (t.tags[I].operations = []), t.tags[I].operations.push(n);
-        });
+  };
+  return i == null || i.forEach((o) => {
+    var h, a, r, f, u;
+    if (o.id.startsWith("tag/default") && "operation" in o) {
+      let t = (h = e.tags) == null ? void 0 : h.findIndex((n) => n.name === "default");
+      t === -1 && (e.tags.push({
+        name: "default",
+        description: "",
+        operations: []
+      }), t = e.tags.length - 1), e.tags[t].operations.push({
+        id: o.id,
+        httpVerb: m(o.method),
+        path: o.path,
+        name: o.operation.summary || o.path || "",
+        description: o.operation.description || "",
+        isWebhook: !1,
+        information: o.operation,
+        pathParameters: (r = (a = e.paths) == null ? void 0 : a[o.path ?? ""]) == null ? void 0 : r.parameters
+      });
+    }
+    "tag" in o && o.isGroup && ((f = o.children) != null && f.length) && o.children.forEach(p), "tag" in o && p(o), "isWebhooks" in o && o.isWebhooks && ((u = o.children) != null && u.length) && o.children.forEach((t) => {
+      var n, g;
+      "webhook" in t && t.name && t.method && b.push({
+        id: t.id,
+        httpVerb: m(t.method),
+        path: t.name,
+        name: t.webhook.summary || t.name || "",
+        description: t.webhook.description || "",
+        isWebhook: !0,
+        information: t.webhook,
+        pathParameters: (g = (n = e.webhooks) == null ? void 0 : n[t.name ?? ""]) == null ? void 0 : g.parameters
+      });
     });
-  }), t.tags = (O = t.tags) == null ? void 0 : O.filter((s) => !m(s)), {
-    ...t,
-    webhooks: p
+  }), {
+    ...e,
+    webhooks: b
   };
 };
 export {
-  C as parse
+  I as parse
 };

package/dist/hooks/useMultipleDocuments.d.ts

@@ -1,5 +1,5 @@
 import type { NavState } from '../hooks/useNavState.js';
-import { type AnyApiReferenceConfiguration, type SpecConfiguration } from '@scalar/types/api-reference';
+import { type AnyApiReferenceConfiguration, type ApiReferenceConfiguration, type SpecConfiguration } from '@scalar/types/api-reference';
 import { type Ref } from 'vue';
 type UseMultipleDocumentsProps = {
     /**
@@ -14,13 +14,13 @@ type UseMultipleDocumentsProps = {
  * Take any configuration and return a flat array of configurations.
  */
 export declare const normalizeConfigurations: (configuration: AnyApiReferenceConfiguration | undefined) => SpecConfiguration[];
-export declare const useMultipleDocuments: ({ configuration, initialIndex, isIntersectionEnabled, hash, hashPrefix, }: UseMultipleDocumentsProps) => 
 /**
- * This was needed for a the bug: The inferred type of 'useMultipleDocuments' cannot be named without a reference to
- * A limitation of typescript
+ * DEPRECATED: This is a temporary state solution while we migrate to the new workspace store
+ *
+ * @deprecated
  */
-{
-    selectedConfiguration: Ref<SpecConfiguration>;
+export declare const useMultipleDocuments: ({ configuration, initialIndex, isIntersectionEnabled, hash, hashPrefix, }: UseMultipleDocumentsProps) => {
+    selectedConfiguration: Ref<Partial<ApiReferenceConfiguration> & SpecConfiguration>;
     availableDocuments: Ref<SpecConfiguration[]>;
     selectedDocumentIndex: Ref<number>;
     isIntersectionEnabled: Ref<boolean>;

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

@@ -1 +1 @@
-{"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../src/hooks/useMultipleDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EAEvB,MAAM,6BAA6B,CAAA;AAGpC,OAAO,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAKpD,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,QAAQ,CAAA;AAIZ;;GAEG;AACH,eAAO,MAAM,uBAAuB,kBACnB,4BAA4B,GAAG,SAAS,KACtD,iBAAiB,EA6BnB,CAAA;AA0CD,eAAO,MAAM,oBAAoB,8EAM9B,yBAAyB;AAkIxB;;;GAGG;AACH;IACE,qBAAqB,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAC7C,kBAAkB,EAAE,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAC5C,qBAAqB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAClC,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACnC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAE5B,CAAA"}
+{"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../src/hooks/useMultipleDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EAEvB,MAAM,6BAA6B,CAAA;AAGpC,OAAO,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAKpD,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,QAAQ,CAAA;AAIZ;;GAEG;AACH,eAAO,MAAM,uBAAuB,kBACnB,4BAA4B,GAAG,SAAS,KACtD,iBAAiB,EA6BnB,CAAA;AA0CD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,8EAM9B,yBAAyB,KAAG;IAC7B,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,yBAAyB,CAAC,GAAG,iBAAiB,CAAC,CAAA;IAClF,kBAAkB,EAAE,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAC5C,qBAAqB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAClC,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACnC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAmIxB,CAAA"}

package/dist/hooks/useNavState.d.ts

@@ -48,7 +48,7 @@ export declare const useNavState: (_config?: Ref<ApiReferenceConfiguration>) =>
     }, parentTag?: OpenAPIV3_1.TagObject) => string;
     getModelId: (model?: {
         name: string;
-    }) => string;
+    }, parentTag?: OpenAPIV3_1.TagObject) => string;
     getHeadingId: (heading: Heading) => string;
     getOperationId: (operation: {
         path: string;

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,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"}
+{"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;;IAoJhE,mCAAmC;4BACX,MAAM;IAG9B;;;;OAIG;+BAlF4B,MAAM;IAoFrC;;;;;OAKG;oCAxGkC,MAAM;IA0G3C;;;OAGG;uCA/HqC,MAAM;;6BA2FhB;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,cAAc,WAAW,CAAC,SAAS;yBAxCxE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,cAAc,WAAW,CAAC,SAAS;4BAXhD,OAAO;gCAiCzB;QACT,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,WAAW,CAAC,WAAW,CAAA;KAChC,GAAG,WAAW,CAAC,eAAe,aACpB,WAAW,CAAC,SAAS;iCA7GE,MAAM;;oBAiGnB,WAAW,CAAC,SAAS;;;CA2E7C,CAAA;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA"}

package/dist/hooks/useNavState.js

@@ -7,7 +7,7 @@ const P = Symbol(), U = l(!1), x = l(""), k = l(""), T = (f) => {
     isIntersectionEnabled: U,
     hash: x,
     hashPrefix: k
-  }), t = f ?? b(), g = (e) => {
+  }), t = f ?? b(), c = (e) => {
     var a;
     if (!t.value.pathRouting)
       return "";
@@ -17,16 +17,21 @@ const P = Symbol(), U = l(!1), x = l(""), k = l(""), T = (f) => {
     var h;
     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) : (
+  }, g = () => t.value.pathRouting ? c(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, n = window.location.href) => {
+  ), m = () => r.value = g(), $ = (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) => {
+  }, I = (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 ?? "")}`;
+  }, 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, n) => {
+    if (!(e != null && e.name))
+      return "models";
+    const a = n ? `${s(n)}/` : "";
+    return typeof t.value.generateModelSlug == "function" ? `${a}model/${t.value.generateModelSlug(e)}` : `${a}model/${i(e.name)}`;
+  }, 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 */
@@ -45,13 +50,13 @@ const P = Symbol(), U = l(!1), x = l(""), k = l(""), T = (f) => {
      * @param url The url to get the hashed url from
      * @returns The hashed url
      */
-    getHashedUrl: $,
+    getHashedUrl: I,
     /**
      * 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,
+    replaceUrlState: $,
+    getReferenceId: g,
     getWebhookId: (e, n) => {
       if (!(e != null && e.name))
         return "webhooks";
@@ -66,7 +71,7 @@ const P = Symbol(), U = l(!1), x = l(""), k = l(""), T = (f) => {
       method: e.method,
       summary: e.summary
     })}` : `${s(n)}/${e.method}${e.path}`,
-    getPathRoutingId: g,
+    getPathRoutingId: c,
     getSectionId: v,
     getTagId: s,
     isIntersectionEnabled: p,

package/dist/hooks/useOperation.d.ts

@@ -1,11 +1,11 @@
-import type { Parameter, TransformedOperation } from '@scalar/types/legacy';
+import type { OpenAPIV3_1, TransformedOperation } from '@scalar/types/legacy';
 export type ParamMap = {
-    path: Parameter[];
-    query: Parameter[];
-    header: Parameter[];
-    cookie: Parameter[];
-    body: Parameter[];
-    formData: Parameter[];
+    path: OpenAPIV3_1.ParameterObject[];
+    query: OpenAPIV3_1.ParameterObject[];
+    header: OpenAPIV3_1.ParameterObject[];
+    cookie: OpenAPIV3_1.ParameterObject[];
+    body: OpenAPIV3_1.ParameterObject[];
+    formData: OpenAPIV3_1.ParameterObject[];
 };
 /**
  * This hook is used to generate the parameters for the request from the parameters in the swagger file

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

@@ -1 +1 @@
-{"version":3,"file":"useOperation.d.ts","sourceRoot":"","sources":["../../src/hooks/useOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAG3E,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,SAAS,EAAE,CAAA;IACjB,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,MAAM,EAAE,SAAS,EAAE,CAAA;IACnB,MAAM,EAAE,SAAS,EAAE,CAAA;IACnB,IAAI,EAAE,SAAS,EAAE,CAAA;IACjB,QAAQ,EAAE,SAAS,EAAE,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,oBAAoB;;EAuD3D"}
+{"version":3,"file":"useOperation.d.ts","sourceRoot":"","sources":["../../src/hooks/useOperation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAI7E,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACnC,KAAK,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACpC,MAAM,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACrC,MAAM,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACrC,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;IACnC,QAAQ,EAAE,WAAW,CAAC,eAAe,EAAE,CAAA;CACxC,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,oBAAoB;;EA2D3D"}

package/dist/hooks/useOperation.js

@@ -1,9 +1,10 @@
-import { computed as u } from "vue";
-function e(o) {
+import { isDereferenced as u } from "@scalar/openapi-types/helpers";
+import { computed as n } from "vue";
+function l(s) {
   return {
-    parameterMap: u(() => {
-      var f;
-      const s = {
+    parameterMap: n(() => {
+      var h;
+      const o = {
         path: [],
         query: [],
         header: [],
@@ -11,16 +12,16 @@ function e(o) {
         body: [],
         formData: []
       };
-      o.pathParameters && o.pathParameters.forEach((i) => {
-        i.in === "path" ? s.path.push(i) : i.in === "query" ? s.query.push(i) : i.in === "header" ? s.header.push(i) : i.in === "cookie" ? s.cookie.push(i) : i.in === "body" ? s.body.push(i) : i.in === "formData" && s.formData.push(i);
+      s.pathParameters && s.pathParameters.forEach((i) => {
+        i.in === "path" ? o.path.push(i) : i.in === "query" ? o.query.push(i) : i.in === "header" ? o.header.push(i) : i.in === "cookie" ? o.cookie.push(i) : i.in === "body" ? o.body.push(i) : i.in === "formData" && o.formData.push(i);
       });
-      const h = ((f = o.information) == null ? void 0 : f.parameters) ?? [];
-      return h && h.forEach((i) => {
-        i.in === "path" ? s.path.push(i) : i.in === "query" ? s.query.push(i) : i.in === "header" ? s.header.push(i) : i.in === "cookie" ? s.cookie.push(i) : i.in === "body" ? s.body.push(i) : i.in === "formData" && s.formData.push(i);
-      }), s;
+      const f = ((h = s.information) == null ? void 0 : h.parameters) ?? [];
+      return f && f.forEach((i) => {
+        u(i) && (i.in === "path" ? o.path.push(i) : i.in === "query" ? o.query.push(i) : i.in === "header" ? o.header.push(i) : i.in === "cookie" ? o.cookie.push(i) : i.in === "body" ? o.body.push(i) : i.in === "formData" && o.formData.push(i));
+      }), o;
     })
   };
 }
 export {
-  e as useOperation
+  l as useOperation
 };

package/dist/index.d.ts

@@ -8,7 +8,6 @@ export { Card, CardHeader, CardContent, CardFooter, CardTabHeader, CardTab } fro
 export { parse } from './helpers/parse.js';
 export { createEmptySpecification } from './libs/openapi.js';
 export { useNavState } from './hooks/useNavState.js';
-export { useSidebar } from './hooks/useSidebar.js';
 export { useHttpClientStore } from './stores/useHttpClientStore.js';
 export type { ApiReferenceConfiguration, ReferenceProps, } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAE3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAE9D,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAGrG,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAE3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAE9D,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAC9C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAGrG,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA"}