@scalar/api-reference 1.37.0 → 1.38.0

package/dist/features/document-source/hooks/useDocumentFetcher.d.ts

@@ -1,10 +1,10 @@
-import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
+import type { ApiReferenceConfigurationWithSource } from '@scalar/types/api-reference';
 import { type MaybeRefOrGetter } from 'vue';
 /**
  * Pass a configuration object containg content or an URL, and retrieve the OpenAPI document as a string.
  */
 export declare function useDocumentFetcher({ configuration, }: {
-    configuration?: MaybeRefOrGetter<Pick<ApiReferenceConfiguration, 'url' | 'content' | 'proxyUrl' | 'fetch'>>;
+    configuration?: MaybeRefOrGetter<Pick<ApiReferenceConfigurationWithSource, 'url' | 'content' | 'proxyUrl' | 'fetch'>>;
 }): {
     originalDocument: import("vue").Ref<string, string>;
 };

package/dist/features/document-source/hooks/useDocumentFetcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDocumentFetcher.d.ts","sourceRoot":"","sources":["../../../../src/features/document-source/hooks/useDocumentFetcher.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAqB,MAAM,6BAA6B,CAAA;AAC/F,OAAO,EAAE,KAAK,gBAAgB,EAAuB,MAAM,KAAK,CAAA;AAEhE;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,aAAa,GACd,EAAE;IACD,aAAa,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,yBAAyB,EAAE,KAAK,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC,CAAC,CAAA;CAC5G;;EAuBA"}
+{"version":3,"file":"useDocumentFetcher.d.ts","sourceRoot":"","sources":["../../../../src/features/document-source/hooks/useDocumentFetcher.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mCAAmC,EAAuB,MAAM,6BAA6B,CAAA;AAC3G,OAAO,EAAE,KAAK,gBAAgB,EAAuB,MAAM,KAAK,CAAA;AAEhE;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,aAAa,GACd,EAAE;IACD,aAAa,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC,mCAAmC,EAAE,KAAK,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC,CAAC,CAAA;CACtH;;EAuBA"}

package/dist/features/document-source/hooks/useDocumentSource.d.ts

@@ -1,6 +1,6 @@
 import { createActiveEntitiesStore, createWorkspaceStore } from '@scalar/api-client/store';
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-import { type ApiReferenceConfiguration } from '@scalar/types/api-reference';
+import { type ApiReferenceConfigurationWithSource } from '@scalar/types/api-reference';
 import { type MaybeRefOrGetter, type Ref } from 'vue';
 /**
  * Pass any data source, retrieve all the data stores and whatever we need to render the API reference.
@@ -8,7 +8,7 @@ import { type MaybeRefOrGetter, type Ref } from 'vue';
 export declare function useDocumentSource({ originalDocument: providedOriginalDocument, dereferencedDocument: providedDereferencedDocument, configuration, }: {
     originalDocument?: MaybeRefOrGetter<string>;
     dereferencedDocument?: MaybeRefOrGetter<OpenAPIV3_1.Document>;
-    configuration?: MaybeRefOrGetter<Pick<ApiReferenceConfiguration, 'url' | 'content' | 'proxyUrl' | 'fetch' | 'proxyUrl' | 'showSidebar' | 'hideClientButton' | 'theme' | '_integration'>>;
+    configuration?: MaybeRefOrGetter<Pick<ApiReferenceConfigurationWithSource, 'url' | 'content' | 'proxyUrl' | 'fetch' | 'proxyUrl' | 'showSidebar' | 'hideClientButton' | 'theme' | '_integration'>>;
 }): {
     originalDocument: Ref<string>;
     originalOpenApiVersion: Ref<string>;

package/dist/features/document-source/hooks/useDocumentSource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDocumentSource.d.ts","sourceRoot":"","sources":["../../../../src/features/document-source/hooks/useDocumentSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAG1F,OAAO,KAAK,EAAW,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEjE,OAAO,EAAE,KAAK,yBAAyB,EAAmC,MAAM,6BAA6B,CAAA;AAC7G,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,GAAG,EAAiC,MAAM,KAAK,CAAA;AAIpF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,gBAAgB,EAAE,wBAAwB,EAC1C,oBAAoB,EAAE,4BAA4B,EAClD,aAAa,GACd,EAAE;IACD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC3C,oBAAoB,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC7D,aAAa,CAAC,EAAE,gBAAgB,CAC9B,IAAI,CACF,yBAAyB,EACvB,KAAK,GACL,SAAS,GACT,UAAU,GACV,OAAO,GACP,UAAU,GACV,aAAa,GACb,kBAAkB,GAClB,OAAO,GACP,cAAc,CACjB,CACF,CAAA;CACF,GAAG;IACF,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC7B,sBAAsB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACnC,oBAAoB,EAAE,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC/C,cAAc,EAAE,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;IACvD,mBAAmB,EAAE,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;CAClE,CA2GA"}
+{"version":3,"file":"useDocumentSource.d.ts","sourceRoot":"","sources":["../../../../src/features/document-source/hooks/useDocumentSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAG1F,OAAO,KAAK,EAAW,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEjE,OAAO,EAAE,KAAK,mCAAmC,EAAmC,MAAM,6BAA6B,CAAA;AACvH,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,GAAG,EAAiC,MAAM,KAAK,CAAA;AAIpF;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,gBAAgB,EAAE,wBAAwB,EAC1C,oBAAoB,EAAE,4BAA4B,EAClD,aAAa,GACd,EAAE;IACD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC3C,oBAAoB,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC7D,aAAa,CAAC,EAAE,gBAAgB,CAC9B,IAAI,CACF,mCAAmC,EACjC,KAAK,GACL,SAAS,GACT,UAAU,GACV,OAAO,GACP,UAAU,GACV,aAAa,GACb,kBAAkB,GAClB,OAAO,GACP,cAAc,CACjB,CACF,CAAA;CACF,GAAG;IACF,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC7B,sBAAsB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACnC,oBAAoB,EAAE,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;IAC/C,cAAc,EAAE,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;IACvD,mBAAmB,EAAE,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;CAClE,CAiHA"}

package/dist/features/document-source/hooks/useDocumentSource.js

@@ -1,18 +1,18 @@
-import { createWorkspaceStore as v, createActiveEntitiesStore as y } from "@scalar/api-client/store";
+import { createWorkspaceStore as A, createActiveEntitiesStore as v } from "@scalar/api-client/store";
 import { measureAsync as P } from "@scalar/helpers/testing/measure";
-import { normalize as w, dereference as O } from "@scalar/openapi-parser";
+import { normalize as b, dereference as O } from "@scalar/openapi-parser";
 import { upgrade as V } from "@scalar/openapi-upgrader";
-import { apiReferenceConfigurationSchema as D } from "@scalar/types/api-reference";
-import { computed as f, toValue as r, ref as l, watch as F } from "vue";
-import { useDocumentFetcher as I } from "./useDocumentFetcher.js";
-function L({
+import { apiReferenceConfigurationSchema as x } from "@scalar/types/api-reference";
+import { computed as f, toValue as t, ref as d, watch as C } from "vue";
+import { useDocumentFetcher as D } from "./useDocumentFetcher.js";
+function j({
   originalDocument: c,
-  dereferencedDocument: t,
-  configuration: i
+  dereferencedDocument: o,
+  configuration: s
 }) {
-  const { originalDocument: d } = I({
-    configuration: i
-  }), s = f(() => c ? r(c) : r(d)), o = l(""), h = f(() => t ? r(t) : r(u)), u = l({
+  const { originalDocument: h } = D({
+    configuration: s
+  }), u = f(() => c ? t(c) : t(h)), n = d(""), g = f(() => o ? t(o) : t(m)), m = d({
     openapi: "3.1.0",
     info: {
       title: "",
@@ -20,50 +20,54 @@ function L({
     },
     paths: {}
   });
-  F(
-    () => r(s),
-    async (n) => {
-      if (!n)
+  C(
+    () => t(u),
+    async (a) => {
+      if (!a)
         return;
-      const e = w(n);
+      const e = b(a);
       if (e === void 0) {
-        console.error("Failed to parse the OpenAPI document:", n);
+        console.error("Failed to parse the OpenAPI document:", a);
         return;
       }
-      if (o.value = typeof e == "object" && (e.openapi || e.swagger) || "", t)
+      if (n.value = typeof e == "object" && (e.openapi || e.swagger) || "", o)
         return;
-      const S = !o.value.startsWith("3.1") ? (
+      const y = !n.value.startsWith("3.1") ? (
         // Upgrade needed
         V(e, "3.1")
       ) : (
         // Skip the upgrade
         e
-      ), A = await P("dereference", async () => {
-        const { schema: p, errors: a } = await O(S);
-        return a?.length && console.warn(
+      ), w = await P("dereference", async () => {
+        const { schema: p, errors: i } = await O(y);
+        return i?.length && console.warn(
           `Please open an issue on https://github.com/scalar/scalar
 `,
           `Scalar OpenAPI Parser Warning:
 `,
-          a
-        ), p === void 0 && console.error("Failed to dereference the OpenAPI document", a), p;
+          i
+        ), p === void 0 && console.error("Failed to dereference the OpenAPI document", i), p;
       });
-      u.value = A;
+      m.value = w;
     },
     { immediate: !0 }
   );
-  const m = v({
+  const r = t(s) ?? x.parse({}), l = A({
     useLocalStorage: !1,
-    ...r(i) ?? D.parse({})
-  }), g = y(m);
+    proxyUrl: r.proxyUrl,
+    theme: r.theme,
+    showSidebar: r.showSidebar,
+    hideClientButton: r.hideClientButton,
+    _integration: r._integration
+  }), S = v(l);
   return {
-    originalDocument: s,
-    originalOpenApiVersion: o,
-    dereferencedDocument: h,
-    workspaceStore: m,
-    activeEntitiesStore: g
+    originalDocument: u,
+    originalOpenApiVersion: n,
+    dereferencedDocument: g,
+    workspaceStore: l,
+    activeEntitiesStore: S
   };
 }
 export {
-  L as useDocumentSource
+  j as useDocumentSource
 };

package/dist/features/multiple-documents/DocumentSelector.vue.d.ts

@@ -1,6 +1,6 @@
-import type { SpecConfiguration } from '@scalar/types/api-reference';
+import type { SourceConfiguration } from '@scalar/types/api-reference';
 type __VLS_Props = {
-    options?: SpecConfiguration[];
+    options?: SourceConfiguration[];
     modelValue?: number;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {

package/dist/features/multiple-documents/DocumentSelector.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentSelector.vue.d.ts","sourceRoot":"","sources":["../../../src/features/multiple-documents/DocumentSelector.vue"],"names":[],"mappings":"AAwDA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAGpE,KAAK,WAAW,GAAG;IACjB,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAC;;;;;;AAsHF,wBAOG"}
+{"version":3,"file":"DocumentSelector.vue.d.ts","sourceRoot":"","sources":["../../../src/features/multiple-documents/DocumentSelector.vue"],"names":[],"mappings":"AAwDA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AAGtE,KAAK,WAAW,GAAG;IACjB,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAC;;;;;;AAsHF,wBAOG"}

package/dist/features/multiple-documents/useMultipleDocuments.d.ts

@@ -1,4 +1,4 @@
-import { type AnyApiReferenceConfiguration, type ApiReferenceConfiguration, type SpecConfiguration, apiReferenceConfigurationSchema } from '@scalar/types/api-reference';
+import { type AnyApiReferenceConfiguration, type ApiReferenceConfiguration, type SourceConfiguration, apiReferenceConfigurationWithSourceSchema } from '@scalar/types/api-reference';
 import { type ComputedRef, type Ref } from 'vue';
 import type { z } from 'zod';
 type UseMultipleDocumentsProps = {
@@ -18,15 +18,15 @@ type UseMultipleDocumentsProps = {
 /**
  * Take any configuration and return a flat array of configurations.
  */
-export declare const normalizeConfigurations: (configuration: AnyApiReferenceConfiguration | undefined) => SpecConfiguration[];
+export declare const normalizeConfigurations: (configuration: AnyApiReferenceConfiguration | undefined) => SourceConfiguration[];
 /**
  * DEPRECATED: This is a temporary state solution while we migrate to the new workspace store
  *
  * @deprecated
  */
 export declare const useMultipleDocuments: ({ configuration, configurationOverrides, initialIndex, isIntersectionEnabled, hash, hashPrefix, }: UseMultipleDocumentsProps) => {
-    selectedConfiguration: ComputedRef<z.infer<typeof apiReferenceConfigurationSchema>>;
-    availableDocuments: Ref<SpecConfiguration[]>;
+    selectedConfiguration: ComputedRef<z.infer<typeof apiReferenceConfigurationWithSourceSchema>>;
+    availableDocuments: Ref<SourceConfiguration[]>;
     selectedDocumentIndex: Ref<number>;
     isIntersectionEnabled: Ref<boolean>;
     hash: Ref<string>;

package/dist/features/multiple-documents/useMultipleDocuments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../../src/features/multiple-documents/useMultipleDocuments.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,+BAA+B,EAEhC,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AACtE,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAK5B,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,+EAA+E;IAC/E,sBAAsB,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC,CAAA;IAC5E,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACnC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CACxB,CAAA;AAID;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAClC,eAAe,4BAA4B,GAAG,SAAS,KACtD,iBAAiB,EA6BnB,CAAA;AA0CD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,mGAOlC,yBAAyB,KAAG;IAC7B,qBAAqB,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC,CAAA;IACnF,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;CAwIxB,CAAA"}
+{"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../../src/features/multiple-documents/useMultipleDocuments.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,yCAAyC,EAE1C,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AACtE,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAK5B,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,+EAA+E;IAC/E,sBAAsB,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,yBAAyB,CAAC,GAAG,SAAS,CAAC,CAAA;IAC5E,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACnC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CACxB,CAAA;AAID;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAClC,eAAe,4BAA4B,GAAG,SAAS,KACtD,mBAAmB,EA6BrB,CAAA;AA0CD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,mGAOlC,yBAAyB,KAAG;IAC7B,qBAAqB,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,yCAAyC,CAAC,CAAC,CAAA;IAC7F,kBAAkB,EAAE,GAAG,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAC9C,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;CAwIxB,CAAA"}

package/dist/features/multiple-documents/useMultipleDocuments.js

@@ -1,5 +1,5 @@
 import { isDefined as y } from "@scalar/oas-utils/helpers";
-import { isConfigurationWithSources as h, apiReferenceConfigurationSchema as v } from "@scalar/types/api-reference";
+import { isConfigurationWithSources as h, apiReferenceConfigurationWithSourceSchema as v } from "@scalar/types/api-reference";
 import R from "github-slugger";
 import { computed as m, ref as D, watch as b } from "vue";
 const g = "api", w = new R(), A = (t) => t ? (Array.isArray(t) ? t : [t]).flatMap((u) => {
@@ -11,7 +11,7 @@ const g = "api", w = new R(), A = (t) => t ? (Array.isArray(t) ? t : [t]).flatMa
 }).map((u, o) => u && C(u, o)).filter(y) : [], C = (t, i = 0) => {
   const e = {
     ...t,
-    // @ts-expect-error this is before parsing so we transform the old style
+    // this is before parsing so we transform the old style
     ...t.spec ?? {}
   };
   if (!(!e?.url && !e?.content))