@deot/docs-client 1.0.2 → 1.0.4

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import { DocsThemeOptions } from '@deot/docs-theme';
 import { DocsThemePreference } from '@deot/docs-theme';
 import { HTTPController } from '@deot/http-core';
 import { Language } from '@deot/docs-locale';
-import type { Ref } from 'vue';
+import { Ref } from 'vue';
 import type { RendererDocument } from '@deot/docs-renderer';
 import type { RendererModuleSource } from '@deot/docs-renderer';
 import type { RouteLocationNormalized } from 'vue-router';
@@ -30,12 +30,14 @@ export declare interface DocsConfig {
     locales: Record<string, DocsLocaleEntry>;
     routes: Record<string, DocsRouteConfig>;
     base?: string;
+    repository?: string;
     namespace?: string;
     modules?: Record<string, string>;
     styles?: Record<string, string>;
     prefetch?: boolean | DocsPrefetchOptions;
     theme?: boolean | DocsThemeOptions;
     home?: DocsHomeOptions;
+    layout?: DocsLayoutOptions;
     renderers?: RendererModuleSource[];
     resolve?: {
         markdown?: (context: DocsMarkdownContext) => string | Promise<string>;
@@ -47,10 +49,21 @@ export declare interface DocsConfig {
 
 export declare type DocsContent = DocsSlot | RendererDocument;
 
+export declare interface DocsFooterOptions {
+    groups?: DocsLocalized<SidebarItem[]>;
+    poweredBy?: DocsLocalized<DocsFooterPoweredBy>;
+}
+
+export declare type DocsFooterPoweredBy = 'default' | string | false;
+
 export declare interface DocsHomeOptions {
     locales: Record<string, RendererDocument | string>;
 }
 
+export declare interface DocsLayoutOptions {
+    footer?: 'default' | DocsFooterOptions | false;
+}
+
 export declare interface DocsLinkContext {
     href: string;
     lang: string;
@@ -60,6 +73,8 @@ export declare interface DocsLinkContext {
 
 export { DocsLocaleEntry }
 
+export declare type DocsLocalized<T> = T | Record<string, T>;
+
 export declare interface DocsMarkdownContext {
     lang: string;
     value: string;
@@ -398,6 +413,11 @@ export declare interface ResourceVersion {
     updatedAt: number;
 }
 
+declare interface SettingsAccess {
+    get<T>(namespace: string, key: string): Promise<T | null>;
+    set<T>(namespace: string, key: string, value: T): Promise<void>;
+}
+
 export declare interface SidebarItem {
     label: string;
     value?: string;
@@ -415,7 +435,47 @@ declare interface TextResponse {
     lastModified?: string;
 }
 
-export declare const Theme: DocsThemeController;
+export declare const Theme: ThemeSettingsManager;
+
+declare class ThemeSettingsManager implements DocsThemeController {
+    private settings;
+    private value;
+    private enabledValue;
+    private readyValue;
+    private active;
+    private namespace;
+    private media?;
+    private session;
+    private preferenceVersion;
+    private followingSystem;
+    private target?;
+    private appliedTarget?;
+    private appliedTheme?;
+    private operation?;
+    private queued?;
+    private requested?;
+    readonly current: Readonly<Ref<"light" | "dark", "light" | "dark">>;
+    readonly enabled: Readonly<Ref<boolean, boolean>>;
+    readonly ready: Readonly<Ref<boolean, boolean>>;
+    constructor(settings: SettingsAccess);
+    private normalizeDefault;
+    private getSystemTheme;
+    private resolveInitialTheme;
+    private apply;
+    private detachSystemListener;
+    private attachSystemListener;
+    private handleSystemChange;
+    private shouldAnimate;
+    private resolveTransitionPoint;
+    private applyWithTransition;
+    private restore;
+    start(config: DocsConfig, target?: Window): () => void;
+    private stop;
+    private flush;
+    private ensureFlush;
+    set(theme: DocsTheme, origin?: HTMLElement): Promise<void>;
+    toggle(origin?: HTMLElement): Promise<void>;
+}
 
 export declare const trimSlashes: (value: string) => string;