@slidev/types 0.48.0-beta.1 → 0.48.0-beta.10

package/dist/index.d.mts

@@ -341,29 +341,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 SlideInfoBase {
-    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,14 +394,25 @@ 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;
+    markdownFiles: Record<string, SlidevMarkdown>;
+    watchFiles: string[];
 }
 interface SlidevPreparserExtension {
     name: string;
@@ -395,8 +420,7 @@ interface SlidevPreparserExtension {
     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 RenderContext = 'none' | 'slide' | 'overview' | 'presenter' | 'previewNext';
 type LoadedSnippets = Record<string, string>;
 type ClicksElement = Element | string;
 type ClicksRelativeEls = Map<ClicksElement, number>;
@@ -524,4 +548,4 @@ 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 };
+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 };

package/package.json

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