@slidev/types 0.49.29 → 0.50.0-beta.1

package/client.d.ts

@@ -19,8 +19,8 @@ declare module '#slidev/global-layers' {
 }
 
 declare module '#slidev/slides' {
-  import type { ShallowRef } from 'vue'
   import type { SlideRoute } from '@slidev/types'
+  import type { ShallowRef } from 'vue'
 
   const slides: ShallowRef<SlideRoute[]>
   export { slides }
@@ -41,12 +41,12 @@ declare module '#slidev/custom-nav-controls' {
 }
 
 declare module '#slidev/shiki' {
-  import type { ShikiHighlighterCore } from 'shiki/core'
   import type { BundledLanguage, BundledTheme, CodeToHastOptions } from 'shiki'
+  import type { ShikiHighlighterCore } from 'shiki/core'
 
   export { shikiToMonaco } from '@shikijs/monaco'
 
-  export const langs: BundledLanguage[]
+  export const languages: BundledLanguage[]
   export const themes: BundledTheme | Record<string, BundledTheme>
   export const shiki: Promise<ShikiHighlighterCore>
   export function getHighlighter(): Promise<(code: string, lang: string, options?: Partial<CodeToHastOptions>) => string>

package/dist/index.d.mts

@@ -1,24 +1,24 @@
+import { ComputedRef, MaybeRefOrGetter, Component, App, Ref } from 'vue';
+import { Arrayable, Awaitable, ArgumentsType } from '@antfu/utils';
+import { CodeToHastOptions, CodeToHastOptionsCommon, BuiltinLanguage, CodeOptionsThemes, BuiltinTheme, CodeOptionsMeta, Highlighter, LanguageInput } from 'shiki';
 import { RouteMeta, RouteComponent, Router, RouteRecordRaw } from 'vue-router';
 import YAML from 'yaml';
-import { Component, MaybeRefOrGetter, App, Ref, ComputedRef } from 'vue';
-import { Arrayable, Awaitable, ArgumentsType } from '@antfu/utils';
-import * as monaco from 'monaco-editor';
+import { MarkdownItShikiOptions } from '@shikijs/markdown-it/index.mjs';
+import { HighlighterGeneric } from 'shiki/types.mjs';
 import { KatexOptions } from 'katex';
-import { CodeToHastOptions, CodeToHastOptionsCommon, BuiltinLanguage, CodeOptionsThemes, BuiltinTheme, CodeOptionsMeta, Highlighter, LanguageInput } from 'shiki';
-import { VitePluginConfig } from 'unocss/vite';
 import { MermaidConfig } from 'mermaid';
+import * as monaco from 'monaco-editor';
+import { VitePluginConfig } from 'unocss/vite';
 import MagicString from 'magic-string-stack';
-import { MarkdownItShikiOptions } from '@shikijs/markdown-it/index.mjs';
-import { HighlighterGeneric } from 'shiki/types.mjs';
 import Vue from '@vitejs/plugin-vue';
 import VueJsx from '@vitejs/plugin-vue-jsx';
 import Icons from 'unplugin-icons/vite';
 import Components from 'unplugin-vue-components/vite';
 import Markdown from 'unplugin-vue-markdown/vite';
+import { Options } from 'vite-plugin-inspect';
 import RemoteAssets from 'vite-plugin-remote-assets';
-import ServerRef from 'vite-plugin-vue-server-ref';
 import { ViteStaticCopyOptions } from 'vite-plugin-static-copy';
-import { Options } from 'vite-plugin-inspect';
+import ServerRef from 'vite-plugin-vue-server-ref';
 
 interface CommonArgs {
     entry: string;
@@ -46,8 +46,245 @@ interface BuildArgs extends ExportArgs {
     inspect: boolean;
 }
 
+type RawSingleAtValue = null | undefined | boolean | string | number;
+type RawRangeAtValue = null | undefined | false | [string | number, string | number];
+type RawAtValue = RawSingleAtValue | RawRangeAtValue;
+type NormalizedSingleClickValue = number | string | null;
+type NormalizedRangeClickValue = [number, number] | [number, string] | [string, number] | [string, string] | [string | number, string | number] | null;
+type NormalizedAtValue = NormalizedSingleClickValue | NormalizedRangeClickValue;
+type ClicksElement = Element | string;
+interface ClicksInfo {
+    /**
+     * The absolute start click num
+     */
+    start: number;
+    /**
+     * The absolute end click num
+     */
+    end: number;
+    /**
+     * The required total click num
+     */
+    max: number;
+    /**
+     * The delta for relative clicks
+     */
+    delta: number;
+    /**
+     * currentClicks - start
+     */
+    currentOffset: ComputedRef<number>;
+    /**
+     * currentOffset === 0
+     */
+    isCurrent: ComputedRef<boolean>;
+    /**
+     * Computed ref of whether the click is active
+     */
+    isActive: ComputedRef<boolean>;
+}
+interface ClicksContext {
+    current: number;
+    readonly clicksStart: number;
+    readonly relativeSizeMap: Map<ClicksElement, number>;
+    readonly maxMap: Map<ClicksElement, number>;
+    calculateSince: (at: RawSingleAtValue, size?: number) => ClicksInfo | null;
+    calculateRange: (at: RawRangeAtValue) => ClicksInfo | null;
+    calculate: (at: RawAtValue) => ClicksInfo | null;
+    register: (el: ClicksElement, info: Pick<ClicksInfo, 'delta' | 'max'> | null) => void;
+    unregister: (el: ClicksElement) => void;
+    readonly isMounted: boolean;
+    setup: () => void;
+    readonly currentOffset: number;
+    readonly total: number;
+}
+
+interface CodeRunnerContext {
+    /**
+     * Options passed to runner via the `runnerOptions` prop.
+     */
+    options: Record<string, unknown>;
+    /**
+     * Highlight code with shiki.
+     */
+    highlight: (code: string, lang: string, options?: Partial<CodeToHastOptions>) => string;
+    /**
+     * Use (other) code runner to run code.
+     */
+    run: (code: string, lang: string) => Promise<CodeRunnerOutputs>;
+}
+interface CodeRunnerOutputHtml {
+    /**
+     * The HTML to be rendered.
+     *
+     * Slidev does NOT sanitize the HTML for you - make sure it's from trusted sources or sanitize it before passing it in
+     */
+    html: string;
+}
+interface CodeRunnerOutputDom {
+    /**
+     * The DOM element to be rendered.
+     */
+    element: HTMLElement;
+}
+interface CodeRunnerOutputError {
+    /**
+     * The error message to be displayed.
+     */
+    error: string;
+}
+interface CodeRunnerOutputText {
+    /**
+     * The text to be displayed.
+     */
+    text: string;
+    /**
+     * The class to be applied to the text.
+     */
+    class?: string;
+    /**
+     * The language to be highlighted.
+     */
+    highlightLang?: string;
+}
+type CodeRunnerOutputTextArray = CodeRunnerOutputText[];
+type CodeRunnerOutput = CodeRunnerOutputHtml | CodeRunnerOutputError | CodeRunnerOutputText | CodeRunnerOutputTextArray | CodeRunnerOutputDom;
+type CodeRunnerOutputs = MaybeRefOrGetter<Arrayable<CodeRunnerOutput>>;
+type CodeRunner = (code: string, ctx: CodeRunnerContext) => Awaitable<CodeRunnerOutputs>;
+type CodeRunnerProviders = Record<string, CodeRunner>;
+
 type BuiltinLayouts = '404' | 'center' | 'cover' | 'default' | 'end' | 'error' | 'fact' | 'full' | 'iframe-left' | 'iframe-right' | 'iframe' | 'image-left' | 'image-right' | 'image' | 'intro' | 'none' | 'quote' | 'section' | 'statement' | 'two-cols-header' | 'two-cols';
 
+type FrontmatterStyle = 'frontmatter' | 'yaml';
+interface SlideInfoBase {
+    revision: string;
+    frontmatter: Record<string, any>;
+    content: string;
+    frontmatterRaw?: string;
+    note?: string;
+    title?: string;
+    level?: number;
+}
+interface SourceSlideInfo extends SlideInfoBase {
+    /**
+     * The filepath of the markdown file
+     */
+    filepath: string;
+    /**
+     * The index of the slide in the markdown file
+     */
+    index: number;
+    /**
+     * The range of the slide in the markdown file
+     */
+    start: number;
+    contentStart: number;
+    end: number;
+    raw: string;
+    /**
+     * Slides import by this slide.
+     */
+    imports?: SourceSlideInfo[];
+    frontmatterDoc?: YAML.Document;
+    frontmatterStyle?: FrontmatterStyle;
+}
+interface SlideInfo extends SlideInfoBase {
+    /**
+     * The index of the slide in the presentation
+     */
+    index: number;
+    /**
+     * The importers of this slide. `[]` if this slide is the entry markdown file
+     */
+    importChain?: SourceSlideInfo[];
+    /**
+     * The source slide where the content is from
+     */
+    source: SourceSlideInfo;
+    noteHTML?: string;
+}
+/**
+ * Editable fields for a slide
+ */
+type SlidePatch = Partial<Pick<SlideInfoBase, 'content' | 'note' | 'frontmatterRaw'>> & {
+    skipHmr?: boolean;
+    /**
+     * The frontmatter patch (only the changed fields)
+     * `null` to remove a field
+     */
+    frontmatter?: Record<string, any>;
+};
+/**
+ * Metadata for "slidev" field in themes' package.json
+ */
+interface SlidevThemeMeta {
+    defaults?: Partial<SlidevConfig>;
+    colorSchema?: 'dark' | 'light' | 'both';
+    highlighter?: 'prism' | 'shiki' | 'both';
+}
+type SlidevThemeConfig = Record<string, string | number>;
+interface SlidevDetectedFeatures {
+    katex: boolean;
+    /**
+     * `false` or referenced module specifiers
+     */
+    monaco: false | {
+        types: string[];
+        deps: string[];
+    };
+    tweet: boolean;
+    mermaid: boolean;
+}
+interface SlidevMarkdown {
+    filepath: string;
+    raw: string;
+    /**
+     * All slides in this markdown file
+     */
+    slides: SourceSlideInfo[];
+    errors?: {
+        row: number;
+        message: string;
+    }[];
+}
+interface SlidevData {
+    /**
+     * Slides that should be rendered (disabled slides excluded)
+     */
+    slides: SlideInfo[];
+    entry: SlidevMarkdown;
+    config: SlidevConfig;
+    headmatter: Record<string, unknown>;
+    features: SlidevDetectedFeatures;
+    themeMeta?: SlidevThemeMeta;
+    markdownFiles: Record<string, SlidevMarkdown>;
+    /**
+     * From watched files to indexes of slides that must be reloaded regardless of the loaded content
+     */
+    watchFiles: Record<string, Set<number>>;
+}
+interface SlidevPreparserExtension {
+    name?: string;
+    transformRawLines?: (lines: string[]) => Promise<void> | void;
+    transformSlide?: (content: string, frontmatter: any) => Promise<string | undefined>;
+}
+type PreparserExtensionLoader = (headmatter: Record<string, unknown>, filepath: string, mode?: string) => Promise<SlidevPreparserExtension[]>;
+type RenderContext = 'none' | 'slide' | 'overview' | 'presenter' | 'previewNext';
+interface SlideRoute {
+    no: number;
+    meta: RouteMeta & Required<Pick<RouteMeta, 'slide'>>;
+    /**
+     * load the slide component itself
+     */
+    load: () => Promise<{
+        default: RouteComponent;
+    }>;
+    /**
+     * Wrapped async component
+     */
+    component: Component;
+}
+
 interface Headmatter extends HeadmatterConfig, Frontmatter {
     /**
      * Default frontmatter options applied to all slides
@@ -257,6 +494,13 @@ interface HeadmatterConfig extends TransitionOptions {
      * @default ''
      */
     exportFilename?: string | null;
+    /**
+     * Use image snapshot for quick overview
+     *
+     * @experimental
+     * @default false
+     */
+    overviewSnapshots?: boolean;
     /**
      * Enable Monaco
      *
@@ -506,189 +750,6 @@ interface ResolvedExportOptions extends Omit<ExportArgs, 'entry' | 'theme'> {
     withToc?: boolean;
 }
 
-type FrontmatterStyle = 'frontmatter' | 'yaml';
-interface SlideInfoBase {
-    frontmatter: Record<string, any>;
-    content: string;
-    frontmatterRaw?: string;
-    note?: string;
-    title?: string;
-    level?: number;
-}
-interface SourceSlideInfo extends SlideInfoBase {
-    /**
-     * The filepath of the markdown file
-     */
-    filepath: string;
-    /**
-     * The index of the slide in the markdown file
-     */
-    index: number;
-    /**
-     * The range of the slide in the markdown file
-     */
-    start: number;
-    contentStart: number;
-    end: number;
-    raw: string;
-    /**
-     * Slides import by this slide.
-     */
-    imports?: SourceSlideInfo[];
-    frontmatterDoc?: YAML.Document;
-    frontmatterStyle?: FrontmatterStyle;
-}
-interface SlideInfo extends SlideInfoBase {
-    /**
-     * The index of the slide in the presentation
-     */
-    index: number;
-    /**
-     * The importers of this slide. `[]` if this slide is the entry markdown file
-     */
-    importChain?: SourceSlideInfo[];
-    /**
-     * The source slide where the content is from
-     */
-    source: SourceSlideInfo;
-    noteHTML?: string;
-}
-/**
- * Editable fields for a slide
- */
-type SlidePatch = Partial<Pick<SlideInfoBase, 'content' | 'note' | 'frontmatterRaw'>> & {
-    skipHmr?: boolean;
-    /**
-     * The frontmatter patch (only the changed fields)
-     * `null` to remove a field
-     */
-    frontmatter?: Record<string, any>;
-};
-/**
- * Metadata for "slidev" field in themes' package.json
- */
-interface SlidevThemeMeta {
-    defaults?: Partial<SlidevConfig>;
-    colorSchema?: 'dark' | 'light' | 'both';
-    highlighter?: 'prism' | 'shiki' | 'both';
-}
-type SlidevThemeConfig = Record<string, string | number>;
-interface SlidevDetectedFeatures {
-    katex: boolean;
-    /**
-     * `false` or referenced module specifiers
-     */
-    monaco: false | {
-        types: string[];
-        deps: string[];
-    };
-    tweet: boolean;
-    mermaid: boolean;
-}
-interface SlidevMarkdown {
-    filepath: string;
-    raw: string;
-    /**
-     * All slides in this markdown file
-     */
-    slides: SourceSlideInfo[];
-    errors?: {
-        row: number;
-        message: string;
-    }[];
-}
-interface SlidevData {
-    /**
-     * Slides that should be rendered (disabled slides excluded)
-     */
-    slides: SlideInfo[];
-    entry: SlidevMarkdown;
-    config: SlidevConfig;
-    headmatter: Record<string, unknown>;
-    features: SlidevDetectedFeatures;
-    themeMeta?: SlidevThemeMeta;
-    markdownFiles: Record<string, SlidevMarkdown>;
-    /**
-     * From watched files to indexes of slides that must be reloaded regardless of the loaded content
-     */
-    watchFiles: Record<string, Set<number>>;
-}
-interface SlidevPreparserExtension {
-    name?: string;
-    transformRawLines?: (lines: string[]) => Promise<void> | void;
-    transformSlide?: (content: string, frontmatter: any) => Promise<string | undefined>;
-}
-type PreparserExtensionLoader = (headmatter: Record<string, unknown>, filepath: string, mode?: string) => Promise<SlidevPreparserExtension[]>;
-type RenderContext = 'none' | 'slide' | 'overview' | 'presenter' | 'previewNext';
-interface SlideRoute {
-    no: number;
-    meta: RouteMeta & Required<Pick<RouteMeta, 'slide'>>;
-    /**
-     * load the slide component itself
-     */
-    load: () => Promise<{
-        default: RouteComponent;
-    }>;
-    /**
-     * Wrapped async component
-     */
-    component: Component;
-}
-
-interface CodeRunnerContext {
-    /**
-     * Options passed to runner via the `runnerOptions` prop.
-     */
-    options: Record<string, unknown>;
-    /**
-     * Highlight code with shiki.
-     */
-    highlight: (code: string, lang: string, options?: Partial<CodeToHastOptions>) => string;
-    /**
-     * Use (other) code runner to run code.
-     */
-    run: (code: string, lang: string) => Promise<CodeRunnerOutputs>;
-}
-interface CodeRunnerOutputHtml {
-    /**
-     * The HTML to be rendered.
-     *
-     * Slidev does NOT sanitize the HTML for you - make sure it's from trusted sources or sanitize it before passing it in
-     */
-    html: string;
-}
-interface CodeRunnerOutputDom {
-    /**
-     * The DOM element to be rendered.
-     */
-    element: HTMLElement;
-}
-interface CodeRunnerOutputError {
-    /**
-     * The error message to be displayed.
-     */
-    error: string;
-}
-interface CodeRunnerOutputText {
-    /**
-     * The text to be displayed.
-     */
-    text: string;
-    /**
-     * The class to be applied to the text.
-     */
-    class?: string;
-    /**
-     * The language to be highlighted.
-     */
-    highlightLang?: string;
-}
-type CodeRunnerOutputTextArray = CodeRunnerOutputText[];
-type CodeRunnerOutput = CodeRunnerOutputHtml | CodeRunnerOutputError | CodeRunnerOutputText | CodeRunnerOutputTextArray | CodeRunnerOutputDom;
-type CodeRunnerOutputs = MaybeRefOrGetter<Arrayable<CodeRunnerOutput>>;
-type CodeRunner = (code: string, ctx: CodeRunnerContext) => Awaitable<CodeRunnerOutputs>;
-type CodeRunnerProviders = Record<string, CodeRunner>;
-
 type ContextMenuOption = {
     action: () => void;
     disabled?: boolean;
@@ -703,6 +764,20 @@ type ContextMenuOption = {
 });
 type ContextMenuItem = ContextMenuOption | 'separator';
 
+declare module 'vite' {
+    interface CustomEventMap {
+        'slidev:update-slide': {
+            no: number;
+            data: SlideInfo;
+        };
+        'slidev:update-note': {
+            no: number;
+            note: string;
+            noteHTML: string;
+        };
+    }
+}
+
 interface RootsInfo {
     cliRoot: string;
     clientRoot: string;
@@ -860,20 +935,6 @@ interface TocItem {
     title?: string;
 }
 
-declare module 'vite' {
-    interface CustomEventMap {
-        'slidev:update-slide': {
-            no: number;
-            data: SlideInfo;
-        };
-        'slidev:update-note': {
-            no: number;
-            note: string;
-            noteHTML: string;
-        };
-    }
-}
-
 interface SlidevPluginOptions {
     vue?: ArgumentsType<typeof Vue>[0];
     vuejsx?: ArgumentsType<typeof VueJsx>[0];
@@ -897,57 +958,4 @@ declare module 'vite' {
     }
 }
 
-type RawSingleAtValue = null | undefined | boolean | string | number;
-type RawRangeAtValue = null | undefined | false | [string | number, string | number];
-type RawAtValue = RawSingleAtValue | RawRangeAtValue;
-type NormalizedSingleClickValue = number | string | null;
-type NormalizedRangeClickValue = [number, number] | [number, string] | [string, number] | [string, string] | [string | number, string | number] | null;
-type NormalizedAtValue = NormalizedSingleClickValue | NormalizedRangeClickValue;
-type ClicksElement = Element | string;
-interface ClicksInfo {
-    /**
-     * The absolute start click num
-     */
-    start: number;
-    /**
-     * The absolute end click num
-     */
-    end: number;
-    /**
-     * The required total click num
-     */
-    max: number;
-    /**
-     * The delta for relative clicks
-     */
-    delta: number;
-    /**
-     * currentClicks - start
-     */
-    currentOffset: ComputedRef<number>;
-    /**
-     * currentOffset === 0
-     */
-    isCurrent: ComputedRef<boolean>;
-    /**
-     * Computed ref of whether the click is active
-     */
-    isActive: ComputedRef<boolean>;
-}
-interface ClicksContext {
-    current: number;
-    readonly clicksStart: number;
-    readonly relativeSizeMap: Map<ClicksElement, number>;
-    readonly maxMap: Map<ClicksElement, number>;
-    calculateSince: (at: RawSingleAtValue, size?: number) => ClicksInfo | null;
-    calculateRange: (at: RawRangeAtValue) => ClicksInfo | null;
-    calculate: (at: RawAtValue) => ClicksInfo | null;
-    register: (el: ClicksElement, info: Pick<ClicksInfo, 'delta' | 'max'> | null) => void;
-    unregister: (el: ClicksElement) => void;
-    readonly isMounted: boolean;
-    setup: () => void;
-    readonly currentOffset: number;
-    readonly total: number;
-}
-
 export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type ClicksContext, type ClicksElement, type ClicksInfo, type CodeRunner, type CodeRunnerContext, type CodeRunnerOutput, type CodeRunnerOutputDom, type CodeRunnerOutputError, type CodeRunnerOutputHtml, type CodeRunnerOutputText, type CodeRunnerOutputTextArray, type CodeRunnerOutputs, type CodeRunnerProviders, type CodeRunnersSetup, type CommonArgs, type ContextMenuItem, type ContextMenuSetup, type DrawingsOptions, type ExportArgs, type FontOptions, type Frontmatter, type FrontmatterStyle, type Headmatter, type HeadmatterConfig, type KatexSetup, type MarkdownTransformContext, type MarkdownTransformer, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type NormalizedAtValue, type NormalizedRangeClickValue, type NormalizedSingleClickValue, type PreparserExtensionLoader, type PreparserSetup, type RawAtValue, type RawRangeAtValue, type RawSingleAtValue, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedSlidevConfigSub, type ResolvedSlidevOptions, type ResolvedSlidevUtils, type RootSetup, type RootsInfo, type RoutesSetup, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevDetectedFeatures, type SlidevEntryOptions, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type TransformersSetup, type TransformersSetupReturn, type TransitionGroupProps, type TransitionOptions, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineTransformersSetup, defineUnoSetup };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "0.49.29",
+  "version": "0.50.0-beta.1",
   "description": "Shared types declarations for Slidev",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -24,22 +24,22 @@
   },
   "dependencies": {
     "@antfu/utils": "^0.7.10",
-    "@shikijs/markdown-it": "^1.14.1",
-    "@vitejs/plugin-vue": "^5.1.2",
+    "@shikijs/markdown-it": "^1.20.0",
+    "@vitejs/plugin-vue": "^5.1.4",
     "@vitejs/plugin-vue-jsx": "^4.0.1",
     "katex": "^0.16.11",
-    "mermaid": "^11.0.2",
-    "monaco-editor": "^0.51.0",
-    "shiki": "^1.14.1",
-    "unocss": "^0.62.3",
-    "unplugin-icons": "^0.19.2",
+    "mermaid": "^11.2.1",
+    "monaco-editor": "^0.52.0",
+    "shiki": "^1.20.0",
+    "unocss": "^0.62.4",
+    "unplugin-icons": "^0.19.3",
     "unplugin-vue-markdown": "^0.26.2",
     "vite-plugin-inspect": "^0.8.7",
     "vite-plugin-remote-assets": "^0.5.0",
     "vite-plugin-static-copy": "^1.0.6",
     "vite-plugin-vue-server-ref": "^0.4.2",
-    "vue": "^3.4.38",
-    "vue-router": "^4.4.3"
+    "vue": "^3.5.9",
+    "vue-router": "^4.4.5"
   },
   "scripts": {
     "build": "tsup src/index.ts",