@scalar/api-reference 1.32.9 → 1.33.0

package/dist/features/sidebar/helpers/create-sidebar.js

@@ -1,31 +1,31 @@
-import { lazyBus as b } from "../../../components/Content/Lazy/lazyBus.js";
-import { reactive as p, ref as S, computed as g } from "vue";
+import { reactive as b, ref as p, computed as S } from "vue";
 import { scrollToId as l } from "@scalar/helpers/dom/scroll-to-id";
-import { measure as v } from "@scalar/helpers/testing/measure";
-import { traverseDocument as O } from "../../traverse-schema/helpers/traverse-document.js";
-const z = (i, o) => {
-  const r = p({}), m = S(!1), a = (e) => r[e] = !r[e], c = (e, t) => r[e] = t, n = (e, t) => {
+import { measure as g } from "@scalar/helpers/testing/measure";
+import { traverseDocument as v } from "../../traverse-schema/helpers/traverse-document.js";
+import { lazyBus as O } from "../../../components/Lazy/lazyBus.js";
+const z = (a, o) => {
+  const r = b({}), i = p(!1), m = (e) => r[e] = !r[e], c = (e, t) => r[e] = t, n = (e, t) => {
     const s = o.getSectionId(e);
     if (s && s !== e)
       if (r[s])
         l(e, t);
       else {
-        const f = b.on((d) => {
-          d.id === e && (l(e, t), f());
+        const d = O.on((f) => {
+          f.loaded === e && (l(e, t), d());
         });
         c(s, !0);
       }
-  }, u = g(() => {
-    const e = v("traverse-document", () => O(i.value, o));
+  }, u = S(() => {
+    const e = g("traverse-document", () => v(a.value, o));
     return o.config.value.defaultOpenAllTags && e.entries.forEach((t) => c(t.id, !0)), e;
   });
   return {
     collapsedSidebarItems: r,
-    isSidebarOpen: m,
+    isSidebarOpen: i,
     items: u,
     scrollToOperation: n,
     setCollapsedSidebarItem: c,
-    toggleCollapsedSidebarItem: a
+    toggleCollapsedSidebarItem: m
   };
 };
 export {

package/dist/features/test-request-button/TestRequestButton.vue.d.ts

@@ -1,6 +1,7 @@
-import type { Request as RequestEntity } from '@scalar/oas-utils/entities/spec';
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 type __VLS_Props = {
-    operation?: Pick<RequestEntity, 'method' | 'path' | 'uid'>;
+    method: HttpMethod;
+    path: string;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 export default _default;

package/dist/features/test-request-button/TestRequestButton.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TestRequestButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/test-request-button/TestRequestButton.vue"],"names":[],"mappings":"AAqFA,OAAO,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iCAAiC,CAAA;AAS/E,KAAK,WAAW,GAAG;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,CAAA;CAC3D,CAAC;;AAuGF,wBAMG"}
+{"version":3,"file":"TestRequestButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/test-request-button/TestRequestButton.vue"],"names":[],"mappings":"AAmFA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAUnE,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACb,CAAC;;AAsGF,wBAMG"}

package/dist/features/test-request-button/TestRequestButton.vue.js

@@ -1,7 +1,7 @@
 import t from "./TestRequestButton.vue2.js";
-/* empty css                       */
+import "./TestRequestButton.vue3.js";
 import o from "../../_virtual/_plugin-vue_export-helper.js";
-const a = /* @__PURE__ */ o(t, [["__scopeId", "data-v-321199ae"]]);
+const c = /* @__PURE__ */ o(t, [["__scopeId", "data-v-976c9c1f"]]);
 export {
-  a as default
+  c as default
 };

package/dist/features/test-request-button/TestRequestButton.vue2.js

@@ -1,42 +1,44 @@
-import { defineComponent as d, computed as c, createElementBlock as i, openBlock as r, withModifiers as f, createVNode as a, createElementVNode as h, unref as k, withCtx as C, createTextVNode as s, toDisplayString as u, Fragment as g } from "vue";
+import { defineComponent as c, computed as d, createElementBlock as n, openBlock as i, withModifiers as h, createVNode as s, createElementVNode as f, unref as k, withCtx as C, createTextVNode as l, toDisplayString as r, Fragment as g } from "vue";
 import { ScalarIconPlay as y } from "@scalar/icons";
 import B from "../../components/ScreenReader.vue.js";
 import { useConfig as b } from "../../hooks/useConfig.js";
-import { useApiClient as q } from "../api-client-modal/useApiClient.js";
-const v = ["method"], S = /* @__PURE__ */ d({
+import { useApiClient as w } from "../api-client-modal/useApiClient.js";
+const R = ["method"], S = /* @__PURE__ */ c({
   __name: "TestRequestButton",
   props: {
-    operation: {}
+    method: {},
+    path: {}
   },
-  setup(o) {
-    const { client: t } = q(), l = b(), p = c(
-      () => l.value.hideTestRequestButton !== !0
-    ), m = () => {
+  setup(t) {
+    const { client: a } = w(), m = b(), u = d(
+      () => m.value.hideTestRequestButton !== !0
+    ), p = () => {
       var e;
-      o.operation && ((e = t == null ? void 0 : t.value) != null && e.open) && t.value.open({
-        requestUid: o.operation.uid
+      (e = a.value) == null || e.open({
+        method: t.method,
+        path: t.path
       });
     };
-    return (e, n) => e.operation && p.value ? (r(), i("button", {
+    return (e, o) => u.value ? (i(), n("button", {
       key: 0,
       class: "show-api-client-button",
-      method: e.operation.method,
+      method: e.method,
       type: "button",
-      onClick: f(m, ["stop"])
+      onClick: h(p, ["stop"])
     }, [
-      a(k(y), {
+      s(k(y), {
         class: "size-3",
         weight: "fill"
       }),
-      n[0] || (n[0] = h("span", null, "Test Request", -1)),
-      a(B, null, {
+      o[0] || (o[0] = f("span", null, "Test Request", -1)),
+      s(B, null, {
         default: C(() => [
-          s("(" + u(e.operation.method) + " " + u(e.operation.path) + ")", 1)
+          l("(" + r(e.method) + " " + r(e.path) + ")", 1)
         ]),
         _: 1
       })
-    ], 8, v)) : (r(), i(g, { key: 1 }, [
-      s(" ")
+    ], 8, R)) : (i(), n(g, { key: 1 }, [
+      l(" ")
     ], 64));
   }
 });

package/dist/features/test-request-button/TestRequestButton.vue3.js

@@ -0,0 +1,4 @@
+const e = "";
+export {
+  e as default
+};

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

@@ -1,4 +1,5 @@
-export type { TraverseSpecOptions, TraversedOperation, TraversedEntry, TraversedDescription, TraversedTag, } from './types';
+export type { TraverseSpecOptions, TraversedOperation, TraversedEntry, TraversedDescription, TraversedTag, TraversedWebhook, TagsMap, } from './types';
 export { traverseDocument } from './helpers/traverse-document.js';
+export { traverseTags } from './helpers/traverse-tags.js';
 export { DEFAULT_INTRODUCTION_SLUG } from './helpers/traverse-description.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/traverse-schema/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,YAAY,GACb,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/traverse-schema/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,EAChB,OAAO,GACR,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA"}

package/dist/helpers/convert-security-scheme.js

@@ -0,0 +1,23 @@
+const e = (r) => r.type === "apiKey" ? {
+  ...r,
+  "x-scalar-secret-token": r.value
+} : r.type === "http" ? {
+  ...r,
+  "x-scalar-secret-token": r.token,
+  "x-scalar-secret-username": r.username,
+  "x-scalar-secret-password": r.password
+} : r.type === "oauth2" ? {
+  ...r,
+  flows: Object.fromEntries(
+    Object.entries(r.flows).map(([a, t]) => [
+      a,
+      t && {
+        ...t,
+        "x-scalar-secret-token": t.token
+      }
+    ])
+  )
+} : r;
+export {
+  e as convertSecurityScheme
+};

package/dist/helpers/test-utils.d.ts

@@ -0,0 +1,51 @@
+import { type TraversedEntry } from '../features/traverse-schema';
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { WorkspaceStore } from '@scalar/workspace-store/client';
+import type { WorkspaceDocument } from '@scalar/workspace-store/schemas/schemas/workspace';
+/**
+ * A collection of tools which are used strictly for testing
+ */
+export declare const createMockSidebar: (collapsedItems?: Record<string, boolean>, entries?: TraversedEntry[]) => {
+    collapsedSidebarItems: Record<string, boolean>;
+    isSidebarOpen: import("vue").Ref<boolean, boolean>;
+    items: import("vue").ComputedRef<{
+        entries: TraversedEntry[];
+        titles: Map<any, any>;
+    }>;
+    scrollToOperation: import("vitest").Mock<(...args: any[]) => any>;
+    setCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
+    toggleCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
+};
+export declare const createMockSidebarFromDocument: (document: OpenAPIV3_1.Document) => {
+    collapsedSidebarItems: Record<string, boolean>;
+    isSidebarOpen: import("vue").Ref<boolean, boolean>;
+    items: import("vue").ComputedRef<{
+        entries: TraversedEntry[];
+        titles: Map<any, any>;
+    }>;
+    scrollToOperation: import("vitest").Mock<(...args: any[]) => any>;
+    setCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
+    toggleCollapsedSidebarItem: import("vitest").Mock<(...args: any[]) => any>;
+};
+export declare const createMockPluginManager: () => {
+    getSpecificationExtensions: import("vitest").Mock<(...args: any[]) => any>;
+};
+export declare const createMockNavState: (hash?: string) => {
+    hash: import("vue").Ref<string, string>;
+    isIntersectionEnabled: import("vue").Ref<boolean, boolean>;
+    setHashPrefix: import("vitest").Mock<(...args: any[]) => any>;
+    getFullHash: import("vitest").Mock<(...args: any[]) => any>;
+    getHashedUrl: import("vitest").Mock<(...args: any[]) => any>;
+    replaceUrlState: import("vitest").Mock<(...args: any[]) => any>;
+    getReferenceId: import("vitest").Mock<(...args: any[]) => any>;
+    getWebhookId: import("vitest").Mock<(...args: any[]) => any>;
+    getModelId: import("vitest").Mock<(...args: any[]) => any>;
+    getHeadingId: import("vitest").Mock<(...args: any[]) => any>;
+    getOperationId: import("vitest").Mock<(...args: any[]) => any>;
+    getPathRoutingId: import("vitest").Mock<(...args: any[]) => any>;
+    getSectionId: import("vitest").Mock<(...args: any[]) => any>;
+    getTagId: import("vitest").Mock<(...args: any[]) => any>;
+    updateHash: import("vitest").Mock<(...args: any[]) => any>;
+};
+export declare const createMockStore: (activeDocument: WorkspaceDocument) => WorkspaceStore;
+//# sourceMappingURL=test-utils.d.ts.map

package/dist/helpers/test-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../src/helpers/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mDAAmD,CAAA;AAI1F;;GAEG;AAEH,eAAO,MAAM,iBAAiB,oBAAoB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YAAgB,cAAc,EAAE;;;;;;;;;;CAOvG,CAAA;AAEF,eAAO,MAAM,6BAA6B,aAAc,WAAW,CAAC,QAAQ;;;;;;;;;;CAe3E,CAAA;AAED,eAAO,MAAM,uBAAuB;;CAElC,CAAA;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;CAgB7B,CAAA;AAEF,eAAO,MAAM,eAAe,mBAAoB,iBAAiB,KAAG,cAqBlE,CAAA"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { default as ApiReference } from './components/ApiReference.vue.js';
 export { default as ApiReferenceLayout } from './components/ApiReferenceLayout.vue.js';
+export { default as ApiReferenceWorkspace } from './v2/ApiReferenceWorkspace.vue.js';
 export { SearchButton, SearchModal } from './features/Search';
 export { default as GettingStarted } from './components/GettingStarted.vue.js';
 export { createApiReference } from './standalone/lib/html-api.js';
@@ -7,6 +8,5 @@ export { useSidebar, Sidebar } from './features/sidebar';
 export { parse } from './helpers/parse.js';
 export { createEmptySpecification } from './libs/openapi.js';
 export { useNavState } from './hooks/useNavState.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,UAAU,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAGxD,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"}
+{"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,OAAO,IAAI,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACjF,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,UAAU,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAGxD,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA"}