@slidev/types 51.4.0 → 51.5.0

package/dist/index.d.mts

@@ -8,6 +8,7 @@ import { KatexOptions } from 'katex';
 import { MermaidConfig } from 'mermaid';
 import * as monaco from 'monaco-editor';
 import { VitePluginConfig } from 'unocss/vite';
+import { Plugin } from 'vite';
 import MagicString from 'magic-string-stack';
 import Vue from '@vitejs/plugin-vue';
 import VueJsx from '@vitejs/plugin-vue-jsx';
@@ -180,6 +181,10 @@ interface SourceSlideInfo extends SlideInfoBase {
     contentStart: number;
     end: number;
     raw: string;
+    /**
+     * Raw content before being processed by preparsers (if any)
+     */
+    contentRaw: string;
     /**
      * Slides import by this slide.
      */
@@ -266,6 +271,7 @@ interface SlidevPreparserExtension {
     name?: string;
     transformRawLines?: (lines: string[]) => Promise<void> | void;
     transformSlide?: (content: string, frontmatter: any) => Promise<string | undefined>;
+    transformNote?: (note: string | undefined, frontmatter: any) => Promise<string | undefined>;
 }
 type PreparserExtensionLoader = (headmatter: Record<string, unknown>, filepath: string, mode?: string) => Promise<SlidevPreparserExtension[]>;
 type RenderContext = 'none' | 'slide' | 'overview' | 'presenter' | 'previewNext';
@@ -382,7 +388,7 @@ interface HeadmatterConfig extends TransitionOptions {
      *
      * @default '16/9'
      */
-    aspectRatio?: number;
+    aspectRatio?: number | string;
     /**
      * The actual width for slides canvas.
      * unit in px.
@@ -537,6 +543,12 @@ interface HeadmatterConfig extends TransitionOptions {
      * @default []
      */
     monacoRunAdditionalDeps?: string[];
+    /**
+     * Seo meta tags settings
+     *
+     * @default {}
+     */
+    seoMeta?: SeoMeta;
 }
 interface Frontmatter extends TransitionOptions {
     /**
@@ -727,11 +739,27 @@ interface TransitionGroupProps {
     leaveActiveClass?: string;
     leaveToClass?: string;
 }
+/**
+ * The following type should map to unhead MataFlat type
+ */
+interface SeoMeta {
+    ogTitle?: string;
+    ogDescription?: string;
+    ogImage?: string;
+    ogUrl?: string;
+    twitterCard?: 'summary' | 'summary_large_image' | 'app' | 'player';
+    twitterSite?: string;
+    twitterTitle?: string;
+    twitterDescription?: string;
+    twitterImage?: string;
+    twitterUrl?: string;
+}
 
 interface ResolvedSlidevConfigSub {
     export: ResolvedExportOptions;
     drawings: ResolvedDrawingsOptions;
     fonts: ResolvedFontOptions;
+    aspectRatio: number;
 }
 interface SlidevConfig extends Omit<Required<HeadmatterConfig>, keyof ResolvedSlidevConfigSub>, ResolvedSlidevConfigSub {
 }
@@ -917,6 +945,7 @@ type PreparserSetup = (context: {
     headmatter: Record<string, unknown>;
     mode?: string;
 }) => Awaitable<SlidevPreparserExtension[]>;
+type VitePluginsSetup = (options: ResolvedSlidevOptions) => Awaitable<Plugin[]>;
 type MonacoSetup = (m: typeof monaco) => Awaitable<MonacoSetupReturn | void>;
 type AppSetup = (context: AppContext) => Awaitable<void>;
 type RootSetup = () => Awaitable<void>;
@@ -936,6 +965,7 @@ declare const defineKatexSetup: (fn: KatexSetup) => KatexSetup;
 declare const defineShortcutsSetup: (fn: ShortcutsSetup) => ShortcutsSetup;
 declare const defineTransformersSetup: (fn: TransformersSetup) => TransformersSetup;
 declare const definePreparserSetup: (fn: PreparserSetup) => PreparserSetup;
+declare const defineVitePluginsSetup: (fn: VitePluginsSetup) => VitePluginsSetup;
 declare const defineCodeRunnersSetup: (fn: CodeRunnersSetup) => CodeRunnersSetup;
 declare const defineContextMenuSetup: (fn: ContextMenuSetup) => ContextMenuSetup;
 
@@ -975,4 +1005,4 @@ declare module 'vite' {
     }
 }
 
-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 Frontmatter, type FrontmatterStyle, type Headmatter, type HeadmatterConfig, type KatexSetup, type MarkdownTransformContext, type MarkdownTransformer, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type NormalizedAtValue, type NormalizedRangeClickValue, type NormalizedSingleClickValue, type PreparserExtensionLoader, type PreparserSetup, type RawAtValue, type RawRangeAtValue, type RawSingleAtValue, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedSlidevConfigSub, type ResolvedSlidevOptions, type ResolvedSlidevUtils, 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 SlidevDetectedFeatures, type SlidevEntryOptions, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type TransformersSetup, type TransformersSetupReturn, type TransitionGroupProps, type TransitionOptions, type UnoSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineTransformersSetup, defineUnoSetup };
+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 Frontmatter, type FrontmatterStyle, type Headmatter, type HeadmatterConfig, type KatexSetup, type MarkdownTransformContext, type MarkdownTransformer, type MermaidSetup, type MonacoSetup, type MonacoSetupReturn, type NavOperations, type NormalizedAtValue, type NormalizedRangeClickValue, type NormalizedSingleClickValue, type PreparserExtensionLoader, type PreparserSetup, type RawAtValue, type RawRangeAtValue, type RawSingleAtValue, type RenderContext, type ResolvedDrawingsOptions, type ResolvedExportOptions, type ResolvedFontOptions, type ResolvedSlidevConfigSub, type ResolvedSlidevOptions, type ResolvedSlidevUtils, type RootSetup, type RootsInfo, type RoutesSetup, type SeoMeta, type ShikiContext, type ShikiSetup, type ShikiSetupReturn, type ShortcutOptions, type ShortcutsSetup, type SlideInfo, type SlideInfoBase, type SlidePatch, type SlideRoute, type SlidevConfig, type SlidevData, type SlidevDetectedFeatures, type SlidevEntryOptions, type SlidevMarkdown, type SlidevPluginOptions, type SlidevPreparserExtension, type SlidevServerOptions, type SlidevThemeConfig, type SlidevThemeMeta, type SourceSlideInfo, type TocItem, type TransformersSetup, type TransformersSetupReturn, type TransitionGroupProps, type TransitionOptions, type UnoSetup, type VitePluginsSetup, defineAppSetup, defineCodeRunnersSetup, defineContextMenuSetup, defineKatexSetup, defineMermaidSetup, defineMonacoSetup, definePreparserSetup, defineRootSetup, defineRoutesSetup, defineShikiSetup, defineShortcutsSetup, defineTransformersSetup, defineUnoSetup, defineVitePluginsSetup };

package/dist/index.mjs

@@ -13,6 +13,7 @@ var defineKatexSetup = defineSetup;
 var defineShortcutsSetup = defineSetup;
 var defineTransformersSetup = defineSetup;
 var definePreparserSetup = defineSetup;
+var defineVitePluginsSetup = defineSetup;
 var defineCodeRunnersSetup = defineSetup;
 var defineContextMenuSetup = defineSetup;
 export {
@@ -28,5 +29,6 @@ export {
   defineShikiSetup,
   defineShortcutsSetup,
   defineTransformersSetup,
-  defineUnoSetup
+  defineUnoSetup,
+  defineVitePluginsSetup
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slidev/types",
-  "version": "51.4.0",
+  "version": "51.5.0",
   "description": "Shared types declarations for Slidev",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -24,18 +24,18 @@
   },
   "dependencies": {
     "@antfu/utils": "^9.1.0",
-    "@shikijs/markdown-it": "^3.1.0",
-    "@vitejs/plugin-vue": "^5.2.1",
-    "@vitejs/plugin-vue-jsx": "^4.1.1",
+    "@shikijs/markdown-it": "^3.2.1",
+    "@vitejs/plugin-vue": "^5.2.3",
+    "@vitejs/plugin-vue-jsx": "^4.1.2",
     "katex": "^0.16.21",
-    "mermaid": "^11.4.1",
+    "mermaid": "^11.6.0",
     "monaco-editor": "0.51.0",
-    "shiki": "^3.1.0",
+    "shiki": "^3.2.1",
     "unocss": "^66.0.0",
     "unplugin-icons": "^22.1.0",
     "unplugin-vue-markdown": "^28.3.1",
     "vite-plugin-inspect": "^11.0.0",
-    "vite-plugin-remote-assets": "^1.0.0",
+    "vite-plugin-remote-assets": "^2.0.0",
     "vite-plugin-static-copy": "^2.3.0",
     "vite-plugin-vue-server-ref": "^1.0.0",
     "vue": "^3.5.13",