@slidev/types 0.49.0-beta.1 → 0.49.0-beta.3

package/client.d.ts

@@ -97,6 +97,20 @@ declare module '#slidev/setups/shortcuts' {
   export default setups
 }
 
+declare module '#slidev/setups/routes' {
+  import type { RoutesSetup } from '@slidev/types'
+
+  const setups: RoutesSetup[]
+  export default setups
+}
+
+declare module '#slidev/setups/context-menu' {
+  import type { ContextMenuSetup } from '@slidev/types'
+
+  const setups: ContextMenuSetup[]
+  export default setups
+}
+
 declare module '#slidev/styles' {
   // side-effects only
 }

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { TransitionGroupProps, ComputedRef, App, Ref } from 'vue';
-import { RouteMeta, RouteComponent, Router } from 'vue-router';
+import { RouteMeta, RouteComponent, Router, RouteRecordRaw } from 'vue-router';
+import YAML from 'yaml';
+import { TransitionGroupProps, Component, App, Ref, ComputedRef } from 'vue';
 import { Arrayable, Awaitable, ArgumentsType } from '@antfu/utils';
 import * as monaco from 'monaco-editor';
 import mermaid from 'mermaid';
@@ -271,6 +272,12 @@ interface SlidevConfig {
      * @default true
      */
     editor: boolean;
+    /**
+     * Enable context menu
+     *
+     * @default true
+     */
+    contextMenu: boolean | 'dev' | 'build' | undefined;
 }
 interface FontOptions {
     /**
@@ -392,6 +399,7 @@ interface SourceSlideInfo extends SlideInfoBase {
     end: number;
     raw: string;
     frontmatterRaw?: string;
+    frontmatterDoc?: YAML.Document;
     frontmatterStyle?: FrontmatterStyle;
 }
 interface SlideInfo extends SlideInfoBase {
@@ -406,8 +414,13 @@ interface SlideInfo extends SlideInfoBase {
 /**
  * Editable fields for a slide
  */
-type SlidePatch = Partial<Pick<SlideInfoBase, 'content' | 'note' | 'frontmatter'>> & {
+type SlidePatch = Partial<Pick<SlideInfoBase, 'content' | 'note'>> & {
     skipHmr?: boolean;
+    /**
+     * The frontmatter patch (only the changed fields)
+     * `null` to remove a field
+     */
+    frontmatter?: Record<string, any>;
 };
 /**
  * Metadata for "slidev" field in themes' package.json
@@ -458,61 +471,6 @@ interface SlideRoute {
     component: () => Promise<RouteComponent>;
 }
 type LoadedSnippets = Record<string, string>;
-type ClicksElement = Element | string;
-type ClicksRelativeEls = Map<ClicksElement, number>;
-interface ClicksInfo {
-    /**
-     * The maximum clicks, used to calculate the total clicks for current slide
-     */
-    max?: number;
-    /**
-     * The offsets added to the subsequent clicks
-     * Delta is 0 when the click is absolute
-     */
-    delta: number;
-    /**
-     * Resolved clicks
-     */
-    clicks?: number | [number, number];
-    /**
-     * Computed ref of whether the click is exactly matched
-     */
-    isCurrent?: ComputedRef<boolean>;
-    /**
-     * Computed ref of whether the click is active
-     */
-    isActive?: ComputedRef<boolean>;
-    /**
-     * Computed ref of whether the click is shown, it take flagHide into account
-     */
-    isShown?: ComputedRef<boolean>;
-    /**
-     * Having the hide flag
-     */
-    flagHide?: boolean;
-    /**
-     * Having the fade flag
-     */
-    flagFade?: boolean;
-}
-type ResolvedClicksInfo = Required<ClicksInfo>;
-type ClicksMap = Map<ClicksElement, ClicksInfo>;
-interface ClicksContext {
-    current: number;
-    readonly clicksStart: number;
-    readonly relativeOffsets: ClicksRelativeEls;
-    readonly map: ClicksMap;
-    resolve: (at: string | number, size?: number) => {
-        start: number;
-        end: number;
-        delta: number;
-    };
-    register: (el: ClicksElement, info: ClicksInfo) => void;
-    unregister: (el: ClicksElement) => void;
-    onMounted: () => void;
-    readonly currentOffset: number;
-    readonly total: number;
-}
 
 interface CodeRunnerContext {
     /**
@@ -572,6 +530,20 @@ type CodeRunnerOutputs = Arrayable<CodeRunnerOutput>;
 type CodeRunner = (code: string, ctx: CodeRunnerContext) => Awaitable<CodeRunnerOutputs>;
 type CodeRunnerProviders = Record<string, CodeRunner>;
 
+type ContextMenuOption = {
+    action: () => void;
+    disabled?: boolean;
+} & ({
+    small?: false;
+    icon?: Component;
+    label: string | Component;
+} | {
+    small: true;
+    icon: Component;
+    label: string;
+});
+type ContextMenuItem = ContextMenuOption | 'separator';
+
 interface AppContext {
     app: App;
     router: Router;
@@ -608,10 +580,10 @@ interface ShikiContext {
      */
     loadTheme: (path: string) => Promise<any>;
 }
-type ShikiSetupReturn = Partial<Omit<CodeToHastOptionsCommon<BuiltinLanguage>, 'lang'>> & CodeOptionsThemes<BuiltinTheme> & CodeOptionsMeta & {
-    setup?: (highlighter: Highlighter) => Awaitable<void>;
-    langs?: (LanguageInput | BuiltinLanguage)[];
-};
+type ShikiSetupReturn = Partial<Omit<CodeToHastOptionsCommon<BuiltinLanguage>, 'lang'> & CodeOptionsThemes<BuiltinTheme> & CodeOptionsMeta & {
+    setup: (highlighter: Highlighter) => Awaitable<void>;
+    langs: (LanguageInput | BuiltinLanguage)[];
+}>;
 type ShikiSetup = (shiki: ShikiContext) => Awaitable<ShikiSetupReturn | void>;
 type KatexSetup = () => Awaitable<Partial<KatexOptions> | void>;
 type UnoSetup = () => Awaitable<Partial<VitePluginConfig> | void>;
@@ -619,18 +591,23 @@ type PreparserSetup = (filepath: string) => SlidevPreparserExtension;
 type MonacoSetup = (m: typeof monaco) => Awaitable<MonacoSetupReturn | void>;
 type AppSetup = (context: AppContext) => Awaitable<void>;
 type RootSetup = () => Awaitable<void>;
+type RoutesSetup = (routes: RouteRecordRaw[]) => RouteRecordRaw[];
 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;
-declare function defineAppSetup(fn: AppSetup): AppSetup;
-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;
+type ContextMenuSetup = (items: ComputedRef<ContextMenuItem[]>) => ComputedRef<ContextMenuItem[]>;
+declare const defineShikiSetup: (fn: ShikiSetup) => ShikiSetup;
+declare const defineUnoSetup: (fn: UnoSetup) => UnoSetup;
+declare const defineMonacoSetup: (fn: MonacoSetup) => MonacoSetup;
+declare const defineAppSetup: (fn: AppSetup) => AppSetup;
+declare const defineRootSetup: (fn: RootSetup) => RootSetup;
+declare const defineRoutesSetup: (fn: RoutesSetup) => RoutesSetup;
+declare const defineMermaidSetup: (fn: MermaidSetup) => MermaidSetup;
+declare const defineKatexSetup: (fn: KatexSetup) => KatexSetup;
+declare const defineShortcutsSetup: (fn: ShortcutsSetup) => ShortcutsSetup;
+declare const definePreparserSetup: (fn: PreparserSetup) => PreparserSetup;
+declare const defineCodeRunnersSetup: (fn: CodeRunnersSetup) => CodeRunnersSetup;
+declare const defineContextMenuSetup: (fn: ContextMenuSetup) => ContextMenuSetup;
 
 interface TocItem {
     no: number;
@@ -732,4 +709,50 @@ interface MarkdownTransformContext {
     isIgnored: (index: number) => boolean;
 }
 
-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 MarkdownTransformContext, 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 ResolvedSlidevOptions, type RootSetup, type RootsInfo, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevEntryOptions, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };
+type RawAtValue = undefined | boolean | string | number | [string | number, string | number];
+type NormalizedSinceClickValue = number | string;
+type NormalizedRangeClickValue = [number, number] | [number, string] | [string, number] | [string, string];
+type NormalizedAtValue = NormalizedSinceClickValue | NormalizedRangeClickValue | null;
+type ClicksElement = Element | string;
+interface ClicksInfo {
+    /**
+     * The absolute start click num
+     */
+    start: number;
+    /**
+     * The absolute end click num
+     */
+    end: number;
+    /**
+     * The required total click num
+     */
+    max: number;
+    /**
+     * The delta for relative clicks
+     */
+    delta: number;
+    /**
+     * Computed ref of whether the click is exactly matched
+     */
+    isCurrent: ComputedRef<boolean>;
+    /**
+     * Computed ref of whether the click is active
+     */
+    isActive: ComputedRef<boolean>;
+}
+interface ClicksContext {
+    current: number;
+    readonly clicksStart: number;
+    readonly relativeOffsets: Map<ClicksElement, number>;
+    readonly maxMap: Map<ClicksElement, number>;
+    calculateSince: (at: NormalizedSinceClickValue, size?: number) => ClicksInfo;
+    calculateRange: (at: NormalizedRangeClickValue) => ClicksInfo;
+    calculate: (at: NormalizedAtValue) => ClicksInfo | null;
+    register: (el: ClicksElement, info: Pick<ClicksInfo, 'delta' | 'max'>) => void;
+    unregister: (el: ClicksElement) => void;
+    onMounted: () => void;
+    readonly currentOffset: number;
+    readonly total: number;
+}
+
+export { type AppContext, type AppSetup, type BuildArgs, type BuiltinSlideTransition, type ClicksContext, type ClicksElement, type ClicksInfo, 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 ContextMenuItem, type ContextMenuSetup, type DrawingsOptions, type ExportArgs, type FontOptions, type FrontmatterStyle, type KatexSetup, type LoadedSnippets, type MarkdownTransformContext, type MermaidOptions, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type NormalizedAtValue, type NormalizedRangeClickValue, type NormalizedSinceClickValue, type PreparserExtensionLoader, type PreparserSetup, type RawAtValue, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedSlidevOptions, type RootSetup, type RootsInfo, type RoutesSetup, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevEntryOptions, type SlidevFeatureFlags, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineUnoSetup };

package/dist/index.mjs

@@ -1,38 +1,29 @@
 // src/setups.ts
-function defineShikiSetup(fn) {
-  return fn;
-}
-function defineUnoSetup(fn) {
-  return fn;
-}
-function defineMonacoSetup(fn) {
-  return fn;
-}
-function defineAppSetup(fn) {
-  return fn;
-}
-function defineMermaidSetup(fn) {
-  return fn;
-}
-function defineKatexSetup(fn) {
-  return fn;
-}
-function defineShortcutsSetup(fn) {
-  return fn;
-}
-function definePreparserSetup(fn) {
-  return fn;
-}
-function defineCodeRunnersSetup(fn) {
-  return fn;
-}
+function defineSetup(fn) {
+  return fn;
+}
+var defineShikiSetup = defineSetup;
+var defineUnoSetup = defineSetup;
+var defineMonacoSetup = defineSetup;
+var defineAppSetup = defineSetup;
+var defineRootSetup = defineSetup;
+var defineRoutesSetup = defineSetup;
+var defineMermaidSetup = defineSetup;
+var defineKatexSetup = defineSetup;
+var defineShortcutsSetup = defineSetup;
+var definePreparserSetup = defineSetup;
+var defineCodeRunnersSetup = defineSetup;
+var defineContextMenuSetup = defineSetup;
 export {
   defineAppSetup,
   defineCodeRunnersSetup,
+  defineContextMenuSetup,
   defineKatexSetup,
   defineMermaidSetup,
   defineMonacoSetup,
   definePreparserSetup,
+  defineRootSetup,
+  defineRoutesSetup,
   defineShikiSetup,
   defineShortcutsSetup,
   defineUnoSetup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "0.49.0-beta.1",
+  "version": "0.49.0-beta.3",
   "description": "Shared types declarations for Slidev",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "mermaid": "^10.9.0",
     "monaco-editor": "^0.47.0",
     "shiki": "^1.3.0",
-    "unocss": "^0.59.0",
+    "unocss": "^0.59.2",
     "unplugin-icons": "^0.18.5",
     "unplugin-vue-markdown": "^0.26.0",
     "vite-plugin-remote-assets": "^0.4.1",