@deot/docs-client 1.0.9 → 1.1.0

package/dist/index.d.ts

@@ -5,8 +5,12 @@ 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 { MarkdownIndicatorConfig } from '@deot/docs-markdown';
+import type { MarkdownPlaygroundConfig } from '@deot/docs-markdown';
+import { MarkdownTheme } from '@deot/docs-markdown';
 import { Ref } from 'vue';
 import type { RendererDocument } from '@deot/docs-renderer';
+import { RendererFit } from '@deot/docs-renderer';
 import type { RendererModuleSource } from '@deot/docs-renderer';
 import type { RouteLocationNormalized } from 'vue-router';
 import type { RouteLocationNormalizedGeneric } from 'vue-router';
@@ -26,6 +30,12 @@ export declare const createResourceIdentity: (config: DocsConfig, lang: string,
 
 export declare const DOCS_RESOURCE_TYPES: readonly ["markdown", "sidebar", "page", "sfc", "module", "style"];
 
+export declare interface DocsComponentsOptions {
+    markdown?: DocsMarkdownComponentOptions;
+    playground?: DocsPlaygroundComponentOptions;
+    renderer?: DocsRendererComponentOptions;
+}
+
 export declare interface DocsConfig {
     locales: Record<string, DocsLocaleEntry>;
     routes: Record<string, DocsRouteConfig>;
@@ -36,6 +46,7 @@ export declare interface DocsConfig {
     styles?: Record<string, string>;
     prefetch?: boolean | DocsPrefetchOptions;
     theme?: boolean | DocsThemeOptions;
+    components?: DocsComponentsOptions;
     layout?: DocsLayoutOptions;
     renderers?: RendererModuleSource[];
     resolve?: {
@@ -82,17 +93,28 @@ export { DocsLocaleEntry }
 
 export declare type DocsLocalized<T> = T | Record<string, T>;
 
+export declare interface DocsMarkdownComponentOptions {
+    theme?: MarkdownTheme;
+    indicator?: MarkdownIndicatorConfig;
+}
+
 export declare interface DocsMarkdownContext {
     lang: string;
     value: string;
     route: RouteLocationNormalizedGeneric;
 }
 
+export declare type DocsPlaygroundComponentOptions = Omit<MarkdownPlaygroundConfig, 'entry' | 'title' | 'id'>;
+
 export declare interface DocsPrefetchOptions {
     batchSize?: number;
     idleTimeout?: number;
 }
 
+export declare interface DocsRendererComponentOptions {
+    fit?: RendererFit;
+}
+
 export declare interface DocsResourceContext {
     source: string;
     type: DocsResourceType;
@@ -163,6 +185,10 @@ declare type LegacyResourceField = Exclude<keyof ResourceRecord, 'identity' | 'u
 
 export declare const listRendererEditorDemos: (lang: string) => RendererEditorDemoItem[];
 
+export { MarkdownIndicatorConfig }
+
+export { MarkdownTheme }
+
 export declare const Network: HTTPController;
 
 export declare const normalizeWorkspaceBase: (value?: string) => string;
@@ -270,6 +296,8 @@ declare interface RendererEditorDemoItem {
 
 export declare const rendererEditorDemoPath: (lang: string, demo?: RendererEditorDemo) => string;
 
+export { RendererFit }
+
 export declare const resolveResource: (config: DocsConfig, context: Omit<DocsResourceContext, "runtime" | "base">) => Promise<string>;
 
 declare interface ResourceCache {
@@ -428,6 +456,8 @@ declare interface SettingsAccess {
 export declare interface SidebarItem {
     label: string;
     value?: string;
+    icon?: string | [normal: string, selected: string];
+    tag?: string;
     children?: SidebarItem[];
 }