@scalar/api-reference 1.28.24 → 1.28.26

package/dist/hooks/useMultipleDocuments.d.ts

@@ -14,100 +14,18 @@ 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) => {
-    selectedConfiguration: import("vue").ComputedRef<{
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-        default?: boolean;
-        hideClientButton?: boolean | undefined;
-        showSidebar?: boolean | undefined;
-        theme?: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none" | undefined;
-        layout?: "modern" | "classic" | undefined;
-        isEditable?: boolean | undefined;
-        isLoading?: boolean | undefined;
-        hideModels?: boolean | undefined;
-        hideDownloadButton?: boolean | undefined;
-        hideTestRequestButton?: boolean | undefined;
-        hideSearch?: boolean | undefined;
-        hideDarkModeToggle?: boolean | undefined;
-        withDefaultFonts?: boolean | undefined;
-        authentication?: any;
-        baseServerURL?: string | undefined;
-        proxyUrl?: string | undefined;
-        searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
-        servers?: any[] | undefined;
-        _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
-        onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-        plugins?: ((...args: unknown[]) => {
-            name: string;
-            extensions: {
-                name: string;
-                component?: unknown;
-            }[];
-        })[] | undefined;
-        darkMode?: boolean | undefined;
-        forceDarkModeState?: "dark" | "light" | undefined;
-        metaData?: any;
-        favicon?: string | undefined;
-        hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
-        defaultHttpClient?: {
-            targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
-            clientKey: string;
-        } | undefined;
-        customCss?: string | undefined;
-        onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-        onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-        onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
-        onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
-        onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
-        onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
-        pathRouting?: {
-            basePath: string;
-        } | undefined;
-        generateHeadingSlug?: ((args_0: {
-            slug?: string | undefined;
-        }, ...args: unknown[]) => string) | undefined;
-        generateModelSlug?: ((args_0: {
-            name?: string | undefined;
-        }, ...args: unknown[]) => string) | undefined;
-        generateTagSlug?: ((args_0: {
-            name?: string | undefined;
-        }, ...args: unknown[]) => string) | undefined;
-        generateOperationSlug?: ((args_0: {
-            path: string;
-            method: string;
-            operationId?: string | undefined;
-            summary?: string | undefined;
-        }, ...args: unknown[]) => string) | undefined;
-        generateWebhookSlug?: ((args_0: {
-            name: string;
-            method?: string | undefined;
-        }, ...args: unknown[]) => string) | undefined;
-        redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
-        defaultOpenAllTags?: boolean | undefined;
-        tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-        operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-        sources?: ({
-            url?: string | undefined;
-            content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-            title?: string | undefined;
-            slug?: string | undefined;
-        } & {
-            default?: boolean;
-        })[] | undefined;
-    }>;
-    availableDocuments: import("vue").ComputedRef<{
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }[]>;
-    selectedDocumentIndex: Ref<number, number>;
-    isIntersectionEnabled: Ref<boolean, boolean>;
-    hash: Ref<string, string>;
-    hashPrefix: Ref<string, string>;
+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
+ */
+{
+    selectedConfiguration: Ref<SpecConfiguration>;
+    availableDocuments: Ref<SpecConfiguration[]>;
+    selectedDocumentIndex: Ref<number>;
+    isIntersectionEnabled: Ref<boolean>;
+    hash: Ref<string>;
+    hashPrefix: Ref<string>;
 };
 export {};
 //# sourceMappingURL=useMultipleDocuments.d.ts.map

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;;;;;;;;;;;;;;;;;;;;;;;;;0CAmIgooB,GAAI;oBAAuF,GAAG;;;;yBAAiH,CAAC;;;;;;;;;;;;;yCAAymB,GAAI;2CAA6E,GAAI;6BAAgE,GAAG;qBAAwE,GAAG;uCAAyF,GAAI;2CAA6F,GAAI;;;;;gBAA0K,CAAC;WAA4B,GAAI;;gBAAyF,CAAC;WAA4B,GAAI;;gBAAuF,CAAC;WAA4B,GAAI;;;;uBAAkJ,CAAC;mBAAqC,CAAC;WAA4B,GAAI;;;kBAAmH,CAAC;WAA4B,GAAI;qCAAyE,GAAI;;2DAAgK,GAAI;4EAAgH,GAAI;;;uDApLl9sB,GAAG;;;;;;;;;mDAAH,GAAG;;;;;;;;CAmLrD,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,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"}