@slidev/types 0.48.0-beta.2 → 0.48.0-beta.21

package/client.d.ts

@@ -1,5 +1,64 @@
-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/titles.md' {
+  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/styles' {
+  // side-effects only
+}
+
+declare module '#slidev/monaco-types' {
+  // side-effects only
 }

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 import { ComputedRef } from '@vue/reactivity';
+import { RouteMeta, RouteComponent, Router } from 'vue-router';
 import { TransitionGroupProps, App, Ref } from 'vue';
 import { Awaitable } 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';
@@ -13,16 +13,16 @@ interface CommonArgs {
     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;
@@ -67,6 +67,21 @@ interface SlidevConfig {
      * @default 'dev'
      */
     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
@@ -341,29 +356,43 @@ type BuiltinSlideTransition = 'slide-up' | 'slide-down' | 'slide-left' | 'slide-
 
 type FrontmatterStyle = 'frontmatter' | 'yaml';
 interface SlideInfoBase {
-    raw: string;
+    frontmatter: Record<string, any>;
     content: string;
     note?: string;
-    frontmatter: Record<string, any>;
-    frontmatterRaw?: string;
-    frontmatterStyle?: FrontmatterStyle;
     title?: string;
     level?: number;
 }
-interface SlideInfo extends SlideInfoBase {
+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;
     end: number;
-    inline?: SlideInfoBase;
-    source?: SlideInfoWithPath;
-    snippetsUsed?: LoadedSnippets;
-}
-interface SlideInfoWithPath extends SlideInfo {
-    filepath: string;
+    raw: string;
+    frontmatterRaw?: string;
+    frontmatterStyle?: FrontmatterStyle;
 }
-interface SlideInfoExtended extends SlideInfo {
-    noteHTML: string;
+interface SlideInfo extends SlideInfoBase {
+    /**
+     * The index of the slide in the presentation
+     */
+    index: number;
+    source: SourceSlideInfo;
+    snippetsUsed?: LoadedSnippets;
+    noteHTML?: string;
 }
+/**
+ * Editable fields for a slide
+ */
+type SlidePatch = Partial<Pick<SlideInfoBase, 'content' | 'note'>>;
 /**
  * Metadata for "slidev" field in themes' package.json
  */
@@ -380,24 +409,38 @@ interface SlidevFeatureFlags {
     mermaid: boolean;
 }
 interface SlidevMarkdown {
-    slides: SlideInfo[];
+    filepath: string;
     raw: string;
+    /**
+     * All slides in this markdown file
+     */
+    slides: SourceSlideInfo[];
+}
+interface SlidevData {
+    /**
+     * Slides that should be rendered (disabled slides excluded)
+     */
+    slides: SlideInfo[];
+    entry: SlidevMarkdown;
     config: SlidevConfig;
-    features: SlidevFeatureFlags;
     headmatter: Record<string, unknown>;
-    filepath?: string;
-    entries?: string[];
+    features: SlidevFeatureFlags;
     themeMeta?: SlidevThemeMeta;
-    subSlides?: Record<string, SlidevMarkdown>;
+    markdownFiles: Record<string, SlidevMarkdown>;
+    watchFiles: string[];
 }
 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) => Promise<SlidevPreparserExtension[]>;
-type PreparserExtensionFromHeadmatter = (headmatter: any, exts: SlidevPreparserExtension[], filepath?: string) => Promise<SlidevPreparserExtension[]>;
-type RenderContext = 'slide' | 'overview' | 'presenter' | 'previewNext';
+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>;
@@ -439,8 +482,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) => {
@@ -459,10 +502,6 @@ interface AppContext {
     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;
@@ -501,7 +540,7 @@ 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 MermaidSetup = () => Partial<MermaidOptions> | void;
 type ShortcutsSetup = (nav: NavOperations, defaultShortcuts: ShortcutOptions[]) => Array<ShortcutOptions>;
@@ -515,6 +554,7 @@ declare function defineShortcutsSetup(fn: ShortcutsSetup): ShortcutsSetup;
 declare function definePreparserSetup(fn: PreparserSetup): PreparserSetup;
 
 interface TocItem {
+    no: number;
     active?: boolean;
     activeParent?: boolean;
     children: TocItem[];
@@ -525,4 +565,18 @@ 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 PreparserExtensionFromHeadmatter, 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 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 };
+declare module 'vite' {
+    interface CustomEventMap {
+        'slidev:update-slide': {
+            id: number;
+            data: SlideInfo;
+        };
+        'slidev:update-note': {
+            id: number;
+            note: string;
+            noteHTML: 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 SlideRoute, 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 };

package/package.json

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