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

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import { ComputedRef } from '@vue/reactivity';
 import { RouteMeta, RouteComponent, Router } from 'vue-router';
 import { TransitionGroupProps, App, Ref } from 'vue';
-import { Awaitable } from '@antfu/utils';
+import { Arrayable, Awaitable } from '@antfu/utils';
 import * as monaco from 'monaco-editor';
 import mermaid from 'mermaid';
 import { KatexOptions } from 'katex';
@@ -64,7 +64,7 @@ interface SlidevConfig {
      * Enable Monaco
      *
      * @see https://sli.dev/custom/config-monaco.html
-     * @default 'dev'
+     * @default true
      */
     monaco: boolean | 'dev' | 'build';
     /**
@@ -493,10 +493,56 @@ interface ClicksContext {
     };
     register: (el: ClicksElement, info: ClicksInfo) => void;
     unregister: (el: ClicksElement) => void;
+    onMounted: () => void;
     readonly currentOffset: number;
     readonly total: number;
 }
 
+interface CodeRunnerContext {
+    options: Record<string, unknown>;
+    highlight: (code: string, lang: string, options?: Partial<CodeToHastOptions>) => Promise<string>;
+    run: (code: string, lang: string) => Promise<CodeRunnerOutputs>;
+}
+interface CodeRunnerOutputHtml {
+    /**
+     * The HTML to be rendered.
+     *
+     * Slidev does NOT sanitize the HTML for you - make sure it's from trusted sources or sanitize it before passing it in
+     */
+    html: string;
+}
+interface CodeRunnerOutputDom {
+    /**
+     * The DOM element to be rendered.
+     */
+    element: HTMLElement;
+}
+interface CodeRunnerOutputError {
+    /**
+     * The error message to be displayed.
+     */
+    error: string;
+}
+interface CodeRunnerOutputText {
+    /**
+     * The text to be displayed.
+     */
+    text: string;
+    /**
+     * The class to be applied to the text.
+     */
+    class?: string;
+    /**
+     * The language to be highlighted.
+     */
+    highlightLang?: string;
+}
+type CodeRunnerOutputTextArray = CodeRunnerOutputText[];
+type CodeRunnerOutput = CodeRunnerOutputHtml | CodeRunnerOutputError | CodeRunnerOutputText | CodeRunnerOutputTextArray | CodeRunnerOutputDom;
+type CodeRunnerOutputs = Arrayable<CodeRunnerOutput>;
+type CodeRunner = (code: string, ctx: CodeRunnerContext) => Awaitable<CodeRunnerOutputs>;
+type CodeRunnerProviders = Record<string, CodeRunner>;
+
 interface AppContext {
     app: App;
     router: Router;
@@ -544,6 +590,7 @@ 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>;
+type CodeRunnersSetup = (runners: CodeRunnerProviders) => Awaitable<CodeRunnerProviders | void>;
 declare function defineShikiSetup(fn: ShikiSetup): ShikiSetup;
 declare function defineUnoSetup(fn: UnoSetup): UnoSetup;
 declare function defineMonacoSetup(fn: MonacoSetup): MonacoSetup;
@@ -552,6 +599,7 @@ declare function defineMermaidSetup(fn: MermaidSetup): MermaidSetup;
 declare function defineKatexSetup(fn: KatexSetup): KatexSetup;
 declare function defineShortcutsSetup(fn: ShortcutsSetup): ShortcutsSetup;
 declare function definePreparserSetup(fn: PreparserSetup): PreparserSetup;
+declare function defineCodeRunnersSetup(fn: CodeRunnersSetup): CodeRunnersSetup;
 
 interface TocItem {
     no: number;
@@ -568,15 +616,15 @@ interface TocItem {
 declare module 'vite' {
     interface CustomEventMap {
         'slidev:update-slide': {
-            id: number;
+            no: number;
             data: SlideInfo;
         };
         'slidev:update-note': {
-            id: number;
+            no: 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 };
+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 };

package/dist/index.mjs

@@ -23,8 +23,12 @@ function defineShortcutsSetup(fn) {
 function definePreparserSetup(fn) {
   return fn;
 }
+function defineCodeRunnersSetup(fn) {
+  return fn;
+}
 export {
   defineAppSetup,
+  defineCodeRunnersSetup,
   defineKatexSetup,
   defineMermaidSetup,
   defineMonacoSetup,

package/package.json

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