@slidev/types 0.49.17 → 0.49.18

package/dist/index.d.mts

@@ -7,6 +7,9 @@ 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 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';
@@ -14,7 +17,8 @@ import Components from 'unplugin-vue-components/vite';
 import Markdown from 'unplugin-vue-markdown/vite';
 import RemoteAssets from 'vite-plugin-remote-assets';
 import ServerRef from 'vite-plugin-vue-server-ref';
-import MagicString from 'magic-string-stack';
+import { ViteStaticCopyOptions } from 'vite-plugin-static-copy';
+import { Options } from 'vite-plugin-inspect';
 
 interface CommonArgs {
     entry: string;
@@ -41,152 +45,108 @@ interface BuildArgs extends ExportArgs {
     inspect: boolean;
 }
 
-interface SlidevConfig {
-    title: string;
+interface Headmatter {
+    /**
+     * Title of the slides
+     */
+    title?: string;
     /**
      * String template to compose title
      *
      * @example "%s - Slidev" - to suffix " - Slidev" to all pages
      * @default '%s - Slidev'
      */
-    titleTemplate: string;
+    titleTemplate?: string;
     /**
      * Theme to use for the slides
      *
      * @see https://sli.dev/themes/use.html
      * @default 'default'
      */
-    theme: string;
+    theme?: string;
     /**
      * List of Slidev addons
      *
      * @default []
      */
-    addons: string[];
+    addons?: string[];
     /**
      * Download remote assets in local using vite-plugin-remote-assets
      *
      * @default false
      */
-    remoteAssets: boolean | 'dev' | 'build';
-    /**
-     * Enable Monaco
-     *
-     * @see https://sli.dev/custom/config-monaco.html
-     * @default true
-     */
-    monaco: boolean | 'dev' | 'build';
-    /**
-     * Where to load monaco types from
-     *
-     * - `cdn` - load from CDN with `@typescript/ata`
-     * - `local` - load from local node_modules
-     *
-     * @default 'local'
-     */
-    monacoTypesSource: 'cdn' | 'local' | 'none';
-    /**
-     * Additional node packages to load as monaco types
-     *
-     * @default []
-     */
-    monacoTypesAdditionalPackages: string[];
-    /**
-     * Packages to ignore when loading monaco types
-     *
-     * @default []
-     */
-    monacoTypesIgnorePackages: string[];
-    /**
-     * Additional local modules to load as dependencies of monaco runnable
-     *
-     * @default []
-     */
-    monacoRunAdditionalDeps: string[];
+    remoteAssets?: boolean | 'dev' | 'build';
     /**
      * Show a download button in the SPA build,
      * could also be a link to custom pdf
      *
      * @default false
      */
-    download: boolean | string;
-    /**
-     * Options for export
-     *
-     * @default {}
-     */
-    export: ResolvedExportOptions;
+    download?: boolean | string;
     /**
      * Show a copy button in code blocks
      *
      * @default true
      */
-    codeCopy: boolean;
+    codeCopy?: boolean;
     /**
      * Information shows on the built SPA
      * Can be a markdown string
      *
      * @default false
      */
-    info: string | boolean;
+    info?: string | boolean;
     /**
      * Prefer highlighter
      *
      * @see https://sli.dev/custom/config-highlighter.html
      * @default shiki
      */
-    highlighter: 'shiki' | 'prism';
+    highlighter?: 'shiki' | 'prism';
     /**
      * Enable Twoslash
      *
      * @default true
      */
-    twoslash: boolean | 'dev' | 'build';
+    twoslash?: boolean | 'dev' | 'build';
     /**
      * Show line numbers in code blocks
      *
      * @default false
      */
-    lineNumbers: boolean;
+    lineNumbers?: boolean;
     /**
      * Force slides color schema
      *
      * @default 'auto'
      */
-    colorSchema: 'dark' | 'light' | 'all' | 'auto';
+    colorSchema?: 'dark' | 'light' | 'all' | 'auto';
     /**
      * Router mode for vue-router
      *
      * @default 'history'
      */
-    routerMode: 'hash' | 'history';
+    routerMode?: 'hash' | 'history';
     /**
      * Aspect ratio for slides
      * should be like `16/9` or `1:1`
      *
      * @default '16/9'
      */
-    aspectRatio: number;
+    aspectRatio?: number;
     /**
      * The actual width for slides canvas.
      * unit in px.
      *
      * @default '980'
      */
-    canvasWidth: number;
-    /**
-     * Force the filename used when exporting the presentation.
-     * The extension, e.g. .pdf, gets automatically added.
-     *
-     * @default ''
-     */
-    exportFilename: string | null;
+    canvasWidth?: number;
     /**
      * Controls whether texts in slides are selectable
      *
      * @default true
      */
-    selectable: boolean;
+    selectable?: boolean;
     /**
      * Configure for themes, will inject intro root styles as
      * `--slidev-theme-x` for attribute `x`
@@ -196,37 +156,37 @@ interface SlidevConfig {
      *
      * @default {}
      */
-    themeConfig: SlidevThemeConfig;
+    themeConfig?: SlidevThemeConfig;
     /**
      * Configure fonts for the slides and app
      *
      * @default {}
      */
-    fonts: ResolvedFontOptions;
+    fonts?: ResolvedFontOptions;
     /**
      * Configure the icon for app
      *
      * @default 'https://cdn.jsdelivr.net/gh/slidevjs/slidev/assets/favicon.png'
      */
-    favicon: string;
+    favicon?: string;
     /**
      * Options for drawings
      *
      * @default {}
      */
-    drawings: ResolvedDrawingsOptions;
+    drawings?: ResolvedDrawingsOptions;
     /**
      * URL of PlantUML server used to render diagrams
      *
      * @default https://www.plantuml.com/plantuml
      */
-    plantUmlServer: string;
+    plantUmlServer?: string;
     /**
      * Enable slides recording
      *
      * @default 'dev'
      */
-    record: boolean | 'dev' | 'build';
+    record?: boolean | 'dev' | 'build';
     /**
      * Expose the server to inbound requests (listen to `0.0.0.0`)
      *
@@ -242,19 +202,19 @@ interface SlidevConfig {
      * @deprecated
      * @default 'unocss'
      */
-    css: 'unocss';
+    css?: 'unocss';
     /**
      * Enable presenter mode
      *
      * @default true
      */
-    presenter: boolean | 'dev' | 'build';
+    presenter?: boolean | 'dev' | 'build';
     /**
      * Attributes to apply to the HTML element
      *
      * @default {}
      */
-    htmlAttrs: Record<string, string>;
+    htmlAttrs?: Record<string, string>;
     /**
      * Page transition, powered by Vue's <TransitionGroup/>
      *
@@ -269,7 +229,7 @@ interface SlidevConfig {
      * @see https://sli.dev/guide/animations.html#pages-transitions
      * @see https://vuejs.org/guide/built-ins/transition.html
      */
-    transition?: BuiltinSlideTransition | string | TransitionGroupProps;
+    transition?: BuiltinSlideTransition | string | TransitionGroupProps | null;
     /**
      * Suppport MDC syntax
      *
@@ -284,17 +244,66 @@ interface SlidevConfig {
      *
      * @default true
      */
-    editor: boolean;
+    editor?: boolean;
     /**
      * Enable context menu
      *
      * @default true
      */
-    contextMenu: boolean | 'dev' | 'build' | undefined;
+    contextMenu?: boolean | 'dev' | 'build' | null;
     /**
      * Enable wake lock
      */
-    wakeLock: boolean | 'dev' | 'build';
+    wakeLock?: boolean | 'dev' | 'build';
+    /**
+     * Options for export
+     *
+     * @default {}
+     */
+    export?: ResolvedExportOptions;
+    /**
+     * Force the filename used when exporting the presentation.
+     * The extension, e.g. .pdf, gets automatically added.
+     *
+     * @default ''
+     */
+    exportFilename?: string | null;
+    /**
+     * Enable Monaco
+     *
+     * @see https://sli.dev/custom/config-monaco.html
+     * @default true
+     */
+    monaco?: boolean | 'dev' | 'build';
+    /**
+     * Where to load monaco types from
+     *
+     * - `cdn` - load from CDN with `@typescript/ata`
+     * - `local` - load from local node_modules
+     *
+     * @default 'local'
+     */
+    monacoTypesSource?: 'cdn' | 'local' | 'none';
+    /**
+     * Additional node packages to load as monaco types
+     *
+     * @default []
+     */
+    monacoTypesAdditionalPackages?: string[];
+    /**
+     * Packages to ignore when loading monaco types
+     *
+     * @default []
+     */
+    monacoTypesIgnorePackages?: string[];
+    /**
+     * Additional local modules to load as dependencies of monaco runnable
+     *
+     * @default []
+     */
+    monacoRunAdditionalDeps?: string[];
+}
+interface SlidevConfig extends Required<Headmatter> {
 }
 interface FontOptions {
     /**
@@ -588,6 +597,72 @@ type ContextMenuOption = {
 });
 type ContextMenuItem = ContextMenuOption | 'separator';
 
+interface RootsInfo {
+    cliRoot: string;
+    clientRoot: string;
+    userRoot: string;
+    userPkgJson: Record<string, any>;
+    userWorkspaceRoot: string;
+}
+interface SlidevEntryOptions {
+    /**
+     * Markdown entry
+     */
+    entry: string;
+    /**
+     * Theme id
+     */
+    theme?: string;
+    /**
+     * Remote password
+     */
+    remote?: string;
+    /**
+     * Enable inspect plugin
+     */
+    inspect?: boolean;
+}
+interface ResolvedSlidevOptions extends RootsInfo, SlidevEntryOptions {
+    data: SlidevData;
+    themeRaw: string;
+    themeRoots: string[];
+    addonRoots: string[];
+    /**
+     * =`[...themeRoots, ...addonRoots, userRoot]` (`clientRoot` excluded)
+     */
+    roots: string[];
+    mode: 'dev' | 'build' | 'export';
+    utils: ResolvedSlidevUtils;
+}
+interface ResolvedSlidevUtils {
+    shiki: HighlighterGeneric<any, any>;
+    shikiOptions: MarkdownItShikiOptions;
+    isMonacoTypesIgnored: (pkg: string) => boolean;
+    getLayouts: () => Record<string, string>;
+}
+interface SlidevServerOptions {
+    /**
+     * @returns `false` if server should be restarted
+     */
+    loadData?: () => Promise<SlidevData | false>;
+}
+
+interface MarkdownTransformContext {
+    /**
+     * The magic string instance for the current markdown content
+     */
+    s: MagicString;
+    /**
+     * The slide info of the current slide
+     */
+    slide: SlideInfo;
+    /**
+     * Resolved Slidev options
+     */
+    options: ResolvedSlidevOptions;
+}
+type MarkdownTransformer = (ctx: MarkdownTransformContext) => void;
+
 interface AppContext {
     app: App;
     router: Router;
@@ -627,14 +702,21 @@ type ShikiSetupReturn = Partial<Omit<CodeToHastOptionsCommon<BuiltinLanguage>, '
     setup: (highlighter: Highlighter) => Awaitable<void>;
     langs: (LanguageInput | BuiltinLanguage)[];
 }>;
+interface TransformersSetupReturn {
+    pre: (MarkdownTransformer | false)[];
+    preCodeblock: (MarkdownTransformer | false)[];
+    postCodeblock: (MarkdownTransformer | false)[];
+    post: (MarkdownTransformer | false)[];
+}
 type ShikiSetup = (shiki: ShikiContext) => Awaitable<ShikiSetupReturn | void>;
 type KatexSetup = () => Awaitable<Partial<KatexOptions> | void>;
 type UnoSetup = () => Awaitable<Partial<VitePluginConfig> | void>;
+type TransformersSetup = () => Awaitable<Partial<TransformersSetupReturn>>;
 type PreparserSetup = (context: {
     filepath: string;
     headmatter: Record<string, unknown>;
     mode?: string;
-}) => SlidevPreparserExtension[];
+}) => Awaitable<SlidevPreparserExtension[]>;
 type MonacoSetup = (m: typeof monaco) => Awaitable<MonacoSetupReturn | void>;
 type AppSetup = (context: AppContext) => Awaitable<void>;
 type RootSetup = () => Awaitable<void>;
@@ -652,6 +734,7 @@ declare const defineRoutesSetup: (fn: RoutesSetup) => RoutesSetup;
 declare const defineMermaidSetup: (fn: MermaidSetup) => MermaidSetup;
 declare const defineKatexSetup: (fn: KatexSetup) => KatexSetup;
 declare const defineShortcutsSetup: (fn: ShortcutsSetup) => ShortcutsSetup;
+declare const defineTransformersSetup: (fn: TransformersSetup) => TransformersSetup;
 declare const definePreparserSetup: (fn: PreparserSetup) => PreparserSetup;
 declare const defineCodeRunnersSetup: (fn: CodeRunnersSetup) => CodeRunnersSetup;
 declare const defineContextMenuSetup: (fn: ContextMenuSetup) => ContextMenuSetup;
@@ -683,58 +766,6 @@ declare module 'vite' {
     }
 }
 
-interface RootsInfo {
-    cliRoot: string;
-    clientRoot: string;
-    userRoot: string;
-    userPkgJson: Record<string, any>;
-    userWorkspaceRoot: string;
-}
-interface SlidevEntryOptions {
-    /**
-     * Markdown entry
-     */
-    entry: string;
-    /**
-     * Theme id
-     */
-    theme?: string;
-    /**
-     * Remote password
-     */
-    remote?: string;
-    /**
-     * Enable inspect plugin
-     */
-    inspect?: boolean;
-}
-interface ResolvedSlidevOptions extends RootsInfo {
-    data: SlidevData;
-    entry: string;
-    themeRaw: string;
-    theme: string;
-    themeRoots: string[];
-    addonRoots: string[];
-    /**
-     * =`[...themeRoots, ...addonRoots, userRoot]` (`clientRoot` excluded)
-     */
-    roots: string[];
-    mode: 'dev' | 'build' | 'export';
-    remote?: string;
-    inspect?: boolean;
-    utils: ResolvedSlidevUtils;
-}
-interface ResolvedSlidevUtils {
-    isMonacoTypesIgnored: (pkg: string) => boolean;
-    getLayouts: () => Promise<Record<string, string>>;
-}
-interface SlidevServerOptions {
-    /**
-     * @returns `false` if server should be restarted
-     */
-    loadData?: () => Promise<SlidevData | false>;
-}
-
 interface SlidevPluginOptions {
     vue?: ArgumentsType<typeof Vue>[0];
     vuejsx?: ArgumentsType<typeof VueJsx>[0];
@@ -744,6 +775,8 @@ interface SlidevPluginOptions {
     remoteAssets?: ArgumentsType<typeof RemoteAssets>[0];
     serverRef?: ArgumentsType<typeof ServerRef>[0];
     unocss?: VitePluginConfig;
+    staticCopy?: ViteStaticCopyOptions;
+    inspect?: Options;
 }
 declare module 'vite' {
     interface UserConfig {
@@ -756,13 +789,6 @@ declare module 'vite' {
     }
 }
 
-interface MarkdownTransformContext {
-    s: MagicString;
-    id: string;
-    options: ResolvedSlidevOptions;
-}
-type MarkdownTransformer = (ctx: MarkdownTransformContext) => void;
-
 type RawSingleAtValue = null | undefined | boolean | string | number;
 type RawRangeAtValue = null | undefined | false | [string | number, string | number];
 type RawAtValue = RawSingleAtValue | RawRangeAtValue;
@@ -816,4 +842,4 @@ interface ClicksContext {
     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 FrontmatterStyle, type KatexSetup, type LoadedSnippets, 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 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 UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };
+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 FrontmatterStyle, type Headmatter, type KatexSetup, type LoadedSnippets, 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 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 UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineTransformersSetup, defineUnoSetup };

package/dist/index.mjs

@@ -11,6 +11,7 @@ var defineRoutesSetup = defineSetup;
 var defineMermaidSetup = defineSetup;
 var defineKatexSetup = defineSetup;
 var defineShortcutsSetup = defineSetup;
+var defineTransformersSetup = defineSetup;
 var definePreparserSetup = defineSetup;
 var defineCodeRunnersSetup = defineSetup;
 var defineContextMenuSetup = defineSetup;
@@ -26,5 +27,6 @@ export {
   defineRoutesSetup,
   defineShikiSetup,
   defineShortcutsSetup,
+  defineTransformersSetup,
   defineUnoSetup
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "0.49.17",
+  "version": "0.49.18",
   "description": "Shared types declarations for Slidev",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -24,18 +24,21 @@
   },
   "dependencies": {
     "@antfu/utils": "^0.7.10",
+    "@shikijs/markdown-it": "^1.10.3",
     "@vitejs/plugin-vue": "^5.0.5",
     "@vitejs/plugin-vue-jsx": "^4.0.0",
     "katex": "^0.16.11",
     "mermaid": "^10.9.1",
     "monaco-editor": "^0.50.0",
     "shiki": "^1.10.3",
-    "unocss": "^0.61.3",
+    "unocss": "^0.61.5",
     "unplugin-icons": "^0.19.0",
     "unplugin-vue-markdown": "^0.26.2",
+    "vite-plugin-inspect": "^0.8.5",
     "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.32",
+    "vue": "^3.4.33",
     "vue-router": "^4.4.0"
   },
   "scripts": {