@scalar/api-reference 1.32.10 → 1.34.0

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,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"}
+{"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,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6DAA6D,CAAA;AAClG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oDAAoD,CAAA;AACtF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iDAAiD,CAAA;AAChF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAA;AAClF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAE9B,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,EAAE;IAAE,GAAG,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IAAC,OAAO,EAAE,cAAc,EAAE,CAAA;CAAE,CAAC,CAAA;AAE7F,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,CAAC,CAAA;CACxC,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,CAAC,CAAA;CAClC,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,CAAC,CAAA;IAC3B,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,CAAC,CAAA;CACtC,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/test-utils.d.ts

@@ -0,0 +1,60 @@
+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>;
+    hashPrefix: 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;
+export declare const createMockLocalStorage: () => {
+    getItem: import("vitest").Mock<(...args: any[]) => any>;
+    setItem: import("vitest").Mock<(...args: any[]) => any>;
+    removeItem: import("vitest").Mock<(...args: any[]) => any>;
+    clear: import("vitest").Mock<(...args: any[]) => any>;
+    key: import("vitest").Mock<(...args: any[]) => any>;
+    length: number;
+};
+//# 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;;;;;;;;;;;;;;;;;CAiB7B,CAAA;AAEF,eAAO,MAAM,eAAe,mBAAoB,iBAAiB,KAAG,cAqBlE,CAAA;AAEF,eAAO,MAAM,sBAAsB;;;;;;;CAOjC,CAAA"}

package/dist/hooks/useNavState.d.ts

@@ -1,5 +1,8 @@
 import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
 import type { Heading, OpenAPIV3_1 } from '@scalar/types/legacy';
+import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/path-operations';
+import type { TagObject } from '@scalar/workspace-store/schemas/v3.1/strict/tag';
+import type { Dereference } from '@scalar/workspace-store/schemas/v3.1/type-guard';
 import { type InjectionKey, type Ref } from 'vue';
 export type NavState = {
     /** The URL hash without the #, also the "hash" pulled from pathRouting */
@@ -53,7 +56,7 @@ export declare const useNavState: (_config?: Ref<ApiReferenceConfiguration>) =>
     getOperationId: (operation: {
         path: string;
         method: OpenAPIV3_1.HttpMethods;
-    } & OpenAPIV3_1.OperationObject, parentTag: OpenAPIV3_1.TagObject) => string;
+    } & Dereference<OperationObject>, parentTag: Dereference<TagObject>) => string;
     getPathRoutingId: (pathName: string) => string;
     getSectionId: (hashStr?: string) => string;
     getTagId: (tag: OpenAPIV3_1.TagObject) => 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;;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"}
+{"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;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6DAA6D,CAAA;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iDAAiD,CAAA;AAChF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAA;AAElF,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,CAAC,aACrB,WAAW,CAAC,SAAS,CAAC;iCA7GC,MAAM;;oBAiGnB,WAAW,CAAC,SAAS;;;CA2E7C,CAAA;AAED,mCAAmC;AACnC,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA"}

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 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';
 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 type { ApiReferenceConfiguration, ReferenceProps, } from './types';

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,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,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA"}