@slidev/types 0.22.5 → 0.23.1

package/dist/index.d.ts

@@ -8,93 +8,6 @@ import mermaid from 'mermaid';
 import { KatexOptions } from 'katex';
 import { WindiCssOptions } from 'vite-plugin-windicss';
 
-interface SlideInfoBase {
-    raw: string;
-    content: string;
-    note?: string;
-    frontmatter: Record<string, any>;
-    title?: string;
-}
-interface SlideInfo extends SlideInfoBase {
-    index: number;
-    start: number;
-    end: number;
-    inline?: SlideInfoBase;
-    source?: SlideInfoWithPath;
-}
-interface SlideInfoWithPath extends SlideInfoBase {
-    filepath: string;
-}
-interface SlideInfoExtended extends SlideInfo {
-    notesHTML: string;
-}
-/**
- * Metadata for "slidev" field in themes' package.json
- */
-interface SlidevThemeMeta {
-    defaults?: Partial<SlidevConfig>;
-    colorSchema?: 'dark' | 'light' | 'both';
-    highlighter?: 'prism' | 'shiki' | 'both';
-}
-declare type SlidevThemeConfig = Record<string, string | number>;
-declare type FontOptions = {
-    /**
-     * Sans serif fonts (default fonts for most text)
-     */
-    sans?: string | string[];
-    /**
-     * Serif fonts
-     */
-    serif?: string | string[];
-    /**
-     * Monospace fonts, for code blocks and etc.
-     */
-    mono?: string | string[];
-    /**
-     * Load webfonts for custom CSS (does not apply anywhere by default)
-     */
-    custom?: string | string[];
-    /**
-     * Weights for fonts
-     *
-     * @default [200, 400, 600]
-     */
-    weights?: string | (string | number)[];
-    /**
-     * Import italic fonts
-     *
-     * @default false
-     */
-    italic?: boolean;
-    /**
-     * @default 'google'
-     */
-    provider?: 'none' | 'google';
-    /**
-     * Specify web fonts names, will detect from `sans`, `mono`, `serif` if not provided
-     */
-    webfonts?: string[];
-    /**
-     * Specify local fonts names, be excluded from webfonts
-     */
-    local?: string[];
-    /**
-     * Use fonts fallback
-     *
-     * @default true
-     */
-    fallbacks?: boolean;
-};
-declare type ResolvedFontOptions = {
-    sans: string[];
-    mono: string[];
-    serif: string[];
-    weights: string[];
-    italic: boolean;
-    provider: 'none' | 'google';
-    webfonts: string[];
-    local: string[];
-};
 interface SlidevConfig {
     title: string;
     /**
@@ -141,6 +54,12 @@ interface SlidevConfig {
      * @default prism
      */
     highlighter: 'prism' | 'shiki';
+    /**
+     * Show line numbers in code blocks
+     *
+     * @default false
+     */
+    lineNumbers: boolean;
     /**
      * Force slides color schema
      *
@@ -189,7 +108,116 @@ interface SlidevConfig {
      * @default {}
      */
     fonts: ResolvedFontOptions;
+    /**
+     * Options for drawings
+     */
+    drawings: ResolvedDrawingsOptions;
+}
+interface FontOptions {
+    /**
+     * Sans serif fonts (default fonts for most text)
+     */
+    sans?: string | string[];
+    /**
+     * Serif fonts
+     */
+    serif?: string | string[];
+    /**
+     * Monospace fonts, for code blocks and etc.
+     */
+    mono?: string | string[];
+    /**
+     * Load webfonts for custom CSS (does not apply anywhere by default)
+     */
+    custom?: string | string[];
+    /**
+     * Weights for fonts
+     *
+     * @default [200, 400, 600]
+     */
+    weights?: string | (string | number)[];
+    /**
+     * Import italic fonts
+     *
+     * @default false
+     */
+    italic?: boolean;
+    /**
+     * @default 'google'
+     */
+    provider?: 'none' | 'google';
+    /**
+     * Specify web fonts names, will detect from `sans`, `mono`, `serif` if not provided
+     */
+    webfonts?: string[];
+    /**
+     * Specify local fonts names, be excluded from webfonts
+     */
+    local?: string[];
+    /**
+     * Use fonts fallback
+     *
+     * @default true
+     */
+    fallbacks?: boolean;
+}
+interface DrawingsOptions {
+    /**
+     * Persist the drawings to disk
+     * Passing string to specify the directory (default to `.slidev/drawings`)
+     *
+     * @default false
+     */
+    persist?: boolean | string;
+    /**
+     * @defult true
+     */
+    enabled?: boolean | 'dev' | 'build';
+}
+interface ResolvedFontOptions {
+    sans: string[];
+    mono: string[];
+    serif: string[];
+    weights: string[];
+    italic: boolean;
+    provider: 'none' | 'google';
+    webfonts: string[];
+    local: string[];
+}
+interface ResolvedDrawingsOptions {
+    persist: string | false;
+    enabled: boolean | 'dev' | 'build';
+}
+
+interface SlideInfoBase {
+    raw: string;
+    content: string;
+    note?: string;
+    frontmatter: Record<string, any>;
+    title?: string;
+}
+interface SlideInfo extends SlideInfoBase {
+    index: number;
+    start: number;
+    end: number;
+    inline?: SlideInfoBase;
+    source?: SlideInfoWithPath;
+}
+interface SlideInfoWithPath extends SlideInfoBase {
+    filepath: string;
 }
+interface SlideInfoExtended extends SlideInfo {
+    notesHTML: string;
+}
+/**
+ * Metadata for "slidev" field in themes' package.json
+ */
+interface SlidevThemeMeta {
+    defaults?: Partial<SlidevConfig>;
+    colorSchema?: 'dark' | 'light' | 'both';
+    highlighter?: 'prism' | 'shiki' | 'both';
+}
+declare type SlidevThemeConfig = Record<string, string | number>;
 interface SlidevFeatureFlags {
     katex: boolean;
     monaco: boolean;
@@ -258,4 +286,4 @@ declare function defineMermaidSetup(fn: MermaidSetup): MermaidSetup;
 declare function defineKatexSetup(fn: KatexSetup): KatexSetup;
 declare function defineShortcutsSetup(fn: ShortcutsSetup): ShortcutsSetup;
 
-export { AppContext, AppSetup, FontOptions, KatexSetup, MermaidOptions, MermaidSetup, MonacoSetup, MonacoSetupReturn, NavOperations, ResolvedFontOptions, ShikiDarkModeThemes, ShikiOptions, ShikiSetup, ShortcutOptions, ShortcutsSetup, SlideInfo, SlideInfoBase, SlideInfoExtended, SlideInfoWithPath, SlidevConfig, SlidevFeatureFlags, SlidevMarkdown, SlidevThemeConfig, SlidevThemeMeta, WindiSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, defineShikiSetup, defineShortcutsSetup, defineWindiSetup };
+export { AppContext, AppSetup, DrawingsOptions, FontOptions, KatexSetup, MermaidOptions, MermaidSetup, MonacoSetup, MonacoSetupReturn, NavOperations, ResolvedDrawingsOptions, ResolvedFontOptions, ShikiDarkModeThemes, ShikiOptions, ShikiSetup, ShortcutOptions, ShortcutsSetup, SlideInfo, SlideInfoBase, SlideInfoExtended, SlideInfoWithPath, SlidevConfig, SlidevFeatureFlags, SlidevMarkdown, SlidevThemeConfig, SlidevThemeMeta, WindiSetup, defineAppSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, defineShikiSetup, defineShortcutsSetup, defineWindiSetup };

package/package.json

@@ -1,29 +1,29 @@
 {
-	"name": "@slidev/types",
-	"version": "0.22.5",
-	"engines": {
-		"node": ">=14.0.0"
-	},
-	"description": "Shared types declerations for Slidev",
-	"license": "MIT",
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/slidevjs/slidev"
-	},
-	"funding": "https://github.com/sponsors/antfu",
-	"author": "antfu <anthonyfu117@hotmail.com>",
-	"files": [
-		"dist",
-		"client.d.ts",
-		"index.d.ts"
-	],
-	"main": "dist/index.js",
-	"module": "dist/index.mjs",
-	"types": "index.d.ts",
-	"homepage": "https://sli.dev",
-	"bugs": "https://github.com/slidevjs/slidev/issues",
-	"scripts": {
-		"build": "pnpx tsup src/index.ts --format cjs,esm --dts",
-		"dev": "nr build --watch"
-	}
-}
+  "name": "@slidev/types",
+  "version": "0.23.1",
+  "description": "Shared types declerations for Slidev",
+  "homepage": "https://sli.dev",
+  "bugs": "https://github.com/slidevjs/slidev/issues",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/slidevjs/slidev"
+  },
+  "funding": "https://github.com/sponsors/antfu",
+  "author": "antfu <anthonyfu117@hotmail.com>",
+  "files": [
+    "dist",
+    "client.d.ts",
+    "index.d.ts"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "index.d.ts",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "scripts": {
+    "build": "pnpx tsup src/index.ts --format cjs,esm --dts",
+    "dev": "nr build --watch"
+  }
+}