@slidev/types 0.46.3 → 0.47.0

package/dist/index.d.mts

@@ -1,13 +1,10 @@
 import { TransitionGroupProps, App, Ref } from 'vue';
 import { Awaitable } from '@antfu/utils';
-import * as Shiki from 'shiki';
-import { IThemeRegistration, Theme, ILanguageRegistration, Lang, Highlighter } from 'shiki';
-import { CodeToHastOptions } from 'shikiji';
 import * as monaco from 'monaco-editor';
 import { Router } from 'vue-router';
 import mermaid from 'mermaid';
 import { KatexOptions } from 'katex';
-import { WindiCssOptions } from 'vite-plugin-windicss';
+import { CodeToHastOptions, Highlighter } from 'shiki';
 import { VitePluginConfig } from 'unocss/vite';
 
 interface CommonArgs {
@@ -98,9 +95,9 @@ interface SlidevConfig {
      * Prefer highlighter
      *
      * @see https://sli.dev/custom/highlighters.html
-     * @default prism
+     * @default shiki
      */
-    highlighter: 'prism' | 'shiki' | 'shikiji';
+    highlighter: 'prism' | 'shiki';
     /**
      * Show line numbers in code blocks
      *
@@ -198,10 +195,9 @@ interface SlidevConfig {
      * Engine for Atomic CSS
      *
      * @see https://unocss.dev/
-     * @see https://windicss.org/
      * @default 'unocss'
      */
-    css: 'unocss' | 'windicss' | 'none';
+    css: 'unocss' | 'none';
     /**
      * Enable presenter mode
      *
@@ -357,6 +353,7 @@ interface SlideInfo extends SlideInfoBase {
     end: number;
     inline?: SlideInfoBase;
     source?: SlideInfoWithPath;
+    snippetsUsed?: LoadedSnippets;
 }
 interface SlideInfoWithPath extends SlideInfoBase {
     filepath: string;
@@ -397,27 +394,12 @@ interface SlidevPreparserExtension {
 type PreparserExtensionLoader = (headmatter?: Record<string, unknown>, filepath?: string) => Promise<SlidevPreparserExtension[]>;
 type PreparserExtensionFromHeadmatter = (headmatter: any, exts: SlidevPreparserExtension[], filepath?: string) => Promise<SlidevPreparserExtension[]>;
 type RenderContext = 'slide' | 'overview' | 'presenter' | 'previewNext';
+type LoadedSnippets = Record<string, string>;
 
 interface AppContext {
     app: App;
     router: Router;
 }
-interface ShikiDarkModeThemes {
-    dark: IThemeRegistration | Theme;
-    light: IThemeRegistration | Theme;
-}
-interface ShikiOptions {
-    theme?: IThemeRegistration | ShikiDarkModeThemes | Theme;
-    langs?: (ILanguageRegistration | Lang)[];
-    highlighter?: Highlighter;
-}
-interface ResolvedShikiOptions extends ShikiOptions {
-    themes: (IThemeRegistration | Theme)[];
-    darkModeThemes?: {
-        dark: Theme;
-        light: Theme;
-    };
-}
 interface MonacoSetupReturn {
     theme?: {
         light?: string;
@@ -447,19 +429,25 @@ interface ShortcutOptions {
     autoRepeat?: boolean;
     name?: string;
 }
-type ShikiSetup = (shiki: typeof Shiki) => Awaitable<ShikiOptions | undefined>;
-type ShikijiSetup = () => Awaitable<Partial<CodeToHastOptions> | undefined>;
-type KatexSetup = () => Awaitable<Partial<KatexOptions> | undefined>;
-type WindiSetup = () => Awaitable<Partial<WindiCssOptions> | undefined>;
-type UnoSetup = () => Awaitable<Partial<VitePluginConfig> | undefined>;
+interface ShikiContext {
+    /**
+     * @deprecated Pass directly the theme name it's supported by Shiki.
+     * For custom themes, load it manually via `JSON.parse(fs.readFileSync(path, 'utf-8'))` and pass the raw JSON object instead.
+     */
+    loadTheme(path: string): Promise<any>;
+}
+type ShikiSetupReturn = Partial<CodeToHastOptions> & {
+    setup?(highlighter: Highlighter): Awaitable<void>;
+};
+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 AppSetup = (context: AppContext) => Awaitable<void>;
-type MermaidSetup = () => Partial<MermaidOptions> | undefined;
+type MermaidSetup = () => Partial<MermaidOptions> | void;
 type ShortcutsSetup = (nav: NavOperations, defaultShortcuts: ShortcutOptions[]) => Array<ShortcutOptions>;
 declare function defineShikiSetup(fn: ShikiSetup): ShikiSetup;
-declare function defineShikijiSetup(fn: ShikijiSetup): ShikijiSetup;
-declare function defineWindiSetup(fn: WindiSetup): WindiSetup;
 declare function defineUnoSetup(fn: UnoSetup): UnoSetup;
 declare function defineMonacoSetup(fn: MonacoSetup): MonacoSetup;
 declare function defineAppSetup(fn: AppSetup): AppSetup;
@@ -479,4 +467,4 @@ interface TocItem {
     title?: string;
 }
 
-export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type CommonArgs, type DrawingsOptions, type ExportArgs, type FontOptions, type FrontmatterStyle, type KatexSetup, type MermaidOptions, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type PreparserExtensionFromHeadmatter, type PreparserExtensionLoader, type PreparserSetup, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedShikiOptions, type ShikiDarkModeThemes, type ShikiOptions, type ShikiSetup, type ShikijiSetup, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlideInfoExtended, type SlideInfoWithPath, type SlidevConfig, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPreparserExtension, type SlidevThemeConfig, type SlidevThemeMeta, type TocItem, type UnoSetup, type WindiSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShikijiSetup, defineShortcutsSetup, defineUnoSetup, defineWindiSetup };
+export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, 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 PreparserExtensionFromHeadmatter, type PreparserExtensionLoader, type PreparserSetup, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlideInfoExtended, type SlideInfoWithPath, type SlidevConfig, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPreparserExtension, type SlidevThemeConfig, type SlidevThemeMeta, type TocItem, type UnoSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };

package/dist/index.mjs

@@ -2,12 +2,6 @@
 function defineShikiSetup(fn) {
   return fn;
 }
-function defineShikijiSetup(fn) {
-  return fn;
-}
-function defineWindiSetup(fn) {
-  return fn;
-}
 function defineUnoSetup(fn) {
   return fn;
 }
@@ -36,8 +30,6 @@ export {
   defineMonacoSetup,
   definePreparserSetup,
   defineShikiSetup,
-  defineShikijiSetup,
   defineShortcutsSetup,
-  defineUnoSetup,
-  defineWindiSetup
+  defineUnoSetup
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "0.46.3",
+  "version": "0.47.0",
   "description": "Shared types declarations for Slidev",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",