@slidev/types 0.48.0-beta.8 → 0.48.0

package/client.d.ts

@@ -1,5 +1,106 @@
-declare module '/@slidev/configs' {
-  import { SlidevConfig } from './types'
+// Types for virtual modules
+// `#slidev/*` is an alias for `/@slidev/*`, because TS will consider `/@slidev/*` as an absolute path that we can't override
 
-  export default SlidevConfig
+declare module '#slidev/configs' {
+  import type { SlidevConfig } from '@slidev/types'
+
+  const configs: SlidevConfig
+  export default configs
+}
+
+declare module '#slidev/global-components/top' {
+  import type { ComponentOptions } from 'vue'
+
+  const component: ComponentOptions
+  export default component
+}
+
+declare module '#slidev/global-components/bottom' {
+  import type { ComponentOptions } from 'vue'
+
+  const component: ComponentOptions
+  export default component
+}
+
+declare module '#slidev/slides' {
+  import type { ShallowRef } from 'vue'
+  import type { SlideRoute } from '@slidev/types'
+
+  const slides: ShallowRef<SlideRoute[]>
+  export { slides }
+}
+
+declare module '#slidev/title-renderer' {
+  import type { ComponentOptions } from 'vue'
+
+  const component: ComponentOptions
+  export default component
+}
+
+declare module '#slidev/custom-nav-controls' {
+  import type { ComponentOptions } from 'vue'
+
+  const component: ComponentOptions
+  export default component
+}
+
+declare module '#slidev/shiki' {
+  import type { ShikiHighlighterCore } from 'shiki/core'
+  import type { BundledLanguage, BundledTheme } from 'shiki'
+
+  export { shikiToMonaco } from '@shikijs/monaco'
+
+  export const langs: BundledLanguage[]
+  export const themes: BundledTheme | Record<string, BundledTheme>
+  export const shiki: Promise<ShikiHighlighterCore>
+}
+
+declare module '#slidev/setups/monaco' {
+  import type { MonacoSetup } from '@slidev/types'
+
+  const setups: MonacoSetup[]
+  export default setups
+}
+
+declare module '#slidev/setups/code-runners' {
+  import type { CodeRunnersSetup } from '@slidev/types'
+
+  const setups: CodeRunnersSetup[]
+  export default setups
+}
+
+declare module '#slidev/setups/mermaid' {
+  import type { MermaidSetup } from '@slidev/types'
+
+  const setups: MermaidSetup[]
+  export default setups
+}
+
+declare module '#slidev/setups/main' {
+  import type { AppSetup } from '@slidev/types'
+
+  const setups: AppSetup[]
+  export default setups
+}
+
+declare module '#slidev/setups/root' {
+  import type { RootSetup } from '@slidev/types'
+
+  const setups: RootSetup[]
+  export default setups
+}
+
+declare module '#slidev/setups/shortcuts' {
+  import type { ShortcutsSetup } from '@slidev/types'
+
+  const setups: ShortcutsSetup[]
+  export default setups
+}
+
+declare module '#slidev/styles' {
+  // side-effects only
+}
+
+declare module '#slidev/monaco-types' {
+  // side-effects only
 }

package/dist/index.d.mts

@@ -1,28 +1,34 @@
-import { ComputedRef } from '@vue/reactivity';
-import { TransitionGroupProps, App, Ref } from 'vue';
-import { Awaitable } from '@antfu/utils';
+import { TransitionGroupProps, ComputedRef, App, Ref } from 'vue';
+import { RouteMeta, RouteComponent, Router } from 'vue-router';
+import { Arrayable, Awaitable, ArgumentsType } from '@antfu/utils';
 import * as monaco from 'monaco-editor';
-import { Router } from 'vue-router';
 import mermaid from 'mermaid';
 import { KatexOptions } from 'katex';
-import { CodeToHastOptions, Highlighter } from 'shiki';
+import { CodeToHastOptions, CodeToHastOptionsCommon, BuiltinLanguage, CodeOptionsThemes, BuiltinTheme, CodeOptionsMeta, Highlighter, LanguageInput } from 'shiki';
 import { VitePluginConfig } from 'unocss/vite';
+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 RemoteAssets from 'vite-plugin-remote-assets';
+import ServerRef from 'vite-plugin-vue-server-ref';
 
 interface CommonArgs {
     entry: string;
     theme?: string;
 }
 interface ExportArgs extends CommonArgs {
-    output?: string;
-    format?: string;
-    timeout?: number;
-    range?: string;
-    dark?: boolean;
+    'output'?: string;
+    'format'?: string;
+    'timeout'?: number;
+    'range'?: string;
+    'dark'?: boolean;
     'with-clicks'?: boolean;
     'executable-path'?: string;
     'with-toc'?: boolean;
     'per-slide'?: boolean;
-    scale?: number;
+    'scale'?: number;
 }
 interface BuildArgs extends ExportArgs {
     watch: boolean;
@@ -64,9 +70,24 @@ interface SlidevConfig {
      * Enable Monaco
      *
      * @see https://sli.dev/custom/config-monaco.html
-     * @default 'dev'
+     * @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[];
     /**
      * Show a download button in the SPA build,
      * could also be a link to custom pdf
@@ -419,8 +440,13 @@ interface SlidevPreparserExtension {
     transformRawLines?: (lines: string[]) => Promise<void> | void;
     transformSlide?: (content: string, frontmatter: any) => Promise<string | undefined>;
 }
-type PreparserExtensionLoader = (headmatter?: Record<string, unknown>, filepath?: string) => Promise<SlidevPreparserExtension[]>;
+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;
+    component: () => Promise<RouteComponent>;
+}
 type LoadedSnippets = Record<string, string>;
 type ClicksElement = Element | string;
 type ClicksRelativeEls = Map<ClicksElement, number>;
@@ -462,8 +488,8 @@ interface ClicksInfo {
 type ResolvedClicksInfo = Required<ClicksInfo>;
 type ClicksMap = Map<ClicksElement, ClicksInfo>;
 interface ClicksContext {
+    current: number;
     readonly disabled: boolean;
-    readonly current: number;
     readonly relativeOffsets: ClicksRelativeEls;
     readonly map: ClicksMap;
     resolve: (at: string | number, size?: number) => {
@@ -473,19 +499,70 @@ interface ClicksContext {
     };
     register: (el: ClicksElement, info: ClicksInfo) => void;
     unregister: (el: ClicksElement) => void;
+    onMounted: () => 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>) => Promise<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 = Arrayable<CodeRunnerOutput>;
+type CodeRunner = (code: string, ctx: CodeRunnerContext) => Awaitable<CodeRunnerOutputs>;
+type CodeRunnerProviders = Record<string, CodeRunner>;
+
 interface AppContext {
     app: App;
     router: Router;
 }
 interface MonacoSetupReturn {
-    theme?: {
-        light?: string;
-        dark?: string;
-    };
     editorOptions?: monaco.editor.IEditorOptions;
 }
 type MermaidOptions = (typeof mermaid.initialize) extends (a: infer A) => any ? A : never;
@@ -517,17 +594,20 @@ interface ShikiContext {
      */
     loadTheme: (path: string) => Promise<any>;
 }
-type ShikiSetupReturn = Partial<CodeToHastOptions> & {
+type ShikiSetupReturn = Partial<Omit<CodeToHastOptionsCommon<BuiltinLanguage>, 'lang'>> & CodeOptionsThemes<BuiltinTheme> & CodeOptionsMeta & {
     setup?: (highlighter: Highlighter) => Awaitable<void>;
+    langs?: (LanguageInput | BuiltinLanguage)[];
 };
 type ShikiSetup = (shiki: ShikiContext) => Awaitable<ShikiSetupReturn | void>;
 type KatexSetup = () => Awaitable<Partial<KatexOptions> | void>;
 type UnoSetup = () => Awaitable<Partial<VitePluginConfig> | void>;
 type PreparserSetup = (filepath: string) => SlidevPreparserExtension;
-type MonacoSetup = (m: typeof monaco) => Awaitable<MonacoSetupReturn>;
+type MonacoSetup = (m: typeof monaco) => Awaitable<MonacoSetupReturn | void>;
 type AppSetup = (context: AppContext) => Awaitable<void>;
+type RootSetup = () => Awaitable<void>;
 type MermaidSetup = () => Partial<MermaidOptions> | void;
 type ShortcutsSetup = (nav: NavOperations, defaultShortcuts: ShortcutOptions[]) => Array<ShortcutOptions>;
+type CodeRunnersSetup = (runners: CodeRunnerProviders) => Awaitable<CodeRunnerProviders | void>;
 declare function defineShikiSetup(fn: ShikiSetup): ShikiSetup;
 declare function defineUnoSetup(fn: UnoSetup): UnoSetup;
 declare function defineMonacoSetup(fn: MonacoSetup): MonacoSetup;
@@ -536,8 +616,10 @@ declare function defineMermaidSetup(fn: MermaidSetup): MermaidSetup;
 declare function defineKatexSetup(fn: KatexSetup): KatexSetup;
 declare function defineShortcutsSetup(fn: ShortcutsSetup): ShortcutsSetup;
 declare function definePreparserSetup(fn: PreparserSetup): PreparserSetup;
+declare function defineCodeRunnersSetup(fn: CodeRunnersSetup): CodeRunnersSetup;
 
 interface TocItem {
+    no: number;
     active?: boolean;
     activeParent?: boolean;
     children: TocItem[];
@@ -548,4 +630,86 @@ interface TocItem {
     title?: string;
 }
 
-export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type ClicksContext, type ClicksElement, type ClicksInfo, type ClicksMap, type ClicksRelativeEls, type CommonArgs, type DrawingsOptions, type ExportArgs, type FontOptions, type FrontmatterStyle, type KatexSetup, type LoadedSnippets, type MermaidOptions, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type PreparserExtensionLoader, type PreparserSetup, type RenderContext, type ResolvedClicksInfo, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlidevConfig, type SlidevData, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPreparserExtension, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type UnoSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };
+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;
+    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;
+}
+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];
+    markdown?: ArgumentsType<typeof Markdown>[0];
+    components?: ArgumentsType<typeof Components>[0];
+    icons?: ArgumentsType<typeof Icons>[0];
+    remoteAssets?: ArgumentsType<typeof RemoteAssets>[0];
+    serverRef?: ArgumentsType<typeof ServerRef>[0];
+    unocss?: VitePluginConfig;
+}
+declare module 'vite' {
+    interface UserConfig {
+        /**
+         * Custom internal plugin options for Slidev (advanced)
+         *
+         * @see https://github.com/slidevjs/slidev/blob/main/packages/slidev/node/options.ts#L50
+         */
+        slidev?: SlidevPluginOptions;
+    }
+}
+
+export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type ClicksContext, type ClicksElement, type ClicksInfo, type ClicksMap, type ClicksRelativeEls, 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 DrawingsOptions, type ExportArgs, type FontOptions, type FrontmatterStyle, type KatexSetup, type LoadedSnippets, type MermaidOptions, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type PreparserExtensionLoader, type PreparserSetup, type RenderContext, type ResolvedClicksInfo, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedSlidevOptions, type RootSetup, type RootsInfo, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevEntryOptions, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };

package/dist/index.mjs

@@ -23,8 +23,12 @@ function defineShortcutsSetup(fn) {
 function definePreparserSetup(fn) {
   return fn;
 }
+function defineCodeRunnersSetup(fn) {
+  return fn;
+}
 export {
   defineAppSetup,
+  defineCodeRunnersSetup,
   defineKatexSetup,
   defineMermaidSetup,
   defineMonacoSetup,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "0.48.0-beta.8",
+  "version": "0.48.0",
   "description": "Shared types declarations for Slidev",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -22,6 +22,22 @@
   "engines": {
     "node": ">=18.0.0"
   },
+  "dependencies": {
+    "@antfu/utils": "^0.7.7",
+    "@vitejs/plugin-vue": "^5.0.4",
+    "@vitejs/plugin-vue-jsx": "^3.1.0",
+    "katex": "^0.16.9",
+    "mermaid": "^10.9.0",
+    "monaco-editor": "^0.46.0",
+    "shiki": "^1.1.7",
+    "unocss": "^0.58.5",
+    "unplugin-icons": "^0.18.5",
+    "unplugin-vue-markdown": "^0.26.0",
+    "vite-plugin-remote-assets": "^0.4.1",
+    "vite-plugin-vue-server-ref": "^0.4.2",
+    "vue": "^3.4.21",
+    "vue-router": "^4.3.0"
+  },
   "scripts": {
     "build": "tsup src/index.ts",
     "dev": "nr build --watch"