@slidev/types 0.48.0-beta.24 → 0.48.0-beta.25

package/client.d.ts

@@ -30,7 +30,7 @@ declare module '#slidev/slides' {
   export { slides }
 }
 
-declare module '#slidev/titles.md' {
+declare module '#slidev/title-renderer' {
   import type { ComponentOptions } from 'vue'
 
   const component: ComponentOptions
@@ -55,6 +55,48 @@ declare module '#slidev/shiki' {
   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
 }

package/dist/index.d.mts

@@ -1,12 +1,18 @@
-import { ComputedRef } from '@vue/reactivity';
+import { TransitionGroupProps, ComputedRef, App, Ref } from 'vue';
 import { RouteMeta, RouteComponent, Router } from 'vue-router';
-import { TransitionGroupProps, App, Ref } from 'vue';
-import { Arrayable, Awaitable } from '@antfu/utils';
+import { Arrayable, Awaitable, ArgumentsType } from '@antfu/utils';
 import * as monaco from 'monaco-editor';
 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;
@@ -499,8 +505,17 @@ interface ClicksContext {
 }
 
 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 {
@@ -579,8 +594,9 @@ 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>;
@@ -588,6 +604,7 @@ type UnoSetup = () => Awaitable<Partial<VitePluginConfig> | void>;
 type PreparserSetup = (filepath: string) => SlidevPreparserExtension;
 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>;
@@ -627,4 +644,74 @@ declare module 'vite' {
     }
 }
 
-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 ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPreparserExtension, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };
+interface RootsInfo {
+    cliRoot: string;
+    clientRoot: string;
+    userRoot: string;
+    userPkgJson: Record<string, any>;
+    userWorkspaceRoot: string;
+}
+interface SlidevEntryOptions {
+    /**
+     * Markdown entry
+     *
+     * @default 'slides.md'
+     */
+    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 extends SlidevEntryOptions {
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "0.48.0-beta.24",
+  "version": "0.48.0-beta.25",
   "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"