@shikijs/types 3.16.0 → 3.17.0

package/dist/index.d.mts

@@ -47,7 +47,7 @@ interface Grammar extends IGrammar {
     name: string;
 }
 
-type PlainTextLanguage = 'text' | 'plaintext' | 'txt';
+type PlainTextLanguage = 'text' | 'plaintext' | 'txt' | 'plain';
 type AnsiLanguage = 'ansi';
 type SpecialLanguage = PlainTextLanguage | AnsiLanguage;
 type LanguageInput = MaybeGetter<MaybeArray<LanguageRegistration>>;
@@ -63,6 +63,7 @@ interface LanguageRegistration extends IRawGrammar {
      * languages for each parent language.
      */
     embeddedLangs?: string[];
+    embeddedLanguages?: string[];
     /**
      * A list of languages that embed the current language.
      * Unlike `embeddedLangs`, the embedded languages will not be loaded automatically.
@@ -617,7 +618,7 @@ interface CodeOptionsMultipleThemes<Themes extends string = string> {
      * <span style="color:#111;--shiki-dark:#fff;">code</span>
      * ```
      *
-     * @see https://github.com/shikijs/shiki#lightdark-dual-themes
+     * @see https://shiki.style/guide/dual-themes
      */
     themes: Partial<Record<string, ThemeRegistrationAny | StringLiteralUnion<Themes>>>;
     /**
@@ -846,11 +847,16 @@ type HighlighterCore = HighlighterGeneric<never, never>;
 /**
  * Options for creating a bundled highlighter.
  */
-interface CreatedBundledHighlighterOptions<BundledLangs extends string, BundledThemes extends string> {
+interface CreateBundledHighlighterOptions<BundledLangs extends string, BundledThemes extends string> {
     langs: Record<BundledLangs, LanguageInput>;
     themes: Record<BundledThemes, ThemeInput>;
     engine: () => Awaitable<RegexEngine>;
 }
+/**
+ * @deprecated Use `CreateBundledHighlighterOptions` instead.
+ */
+interface CreatedBundledHighlighterOptions<BundledLangs extends string, BundledThemes extends string> extends CreateBundledHighlighterOptions<BundledLangs, BundledThemes> {
+}
 
 type CreateHighlighterFactory<L extends string, T extends string> = (options: BundledHighlighterOptions<L, T>) => Promise<HighlighterGeneric<L, T>>;
 
@@ -859,4 +865,4 @@ declare class ShikiError extends Error {
 }
 
 export { ShikiError };
-export type { AnsiLanguage, Awaitable, BundledHighlighterOptions, BundledLanguageInfo, BundledThemeInfo, CodeOptionsMeta, CodeOptionsMultipleThemes, CodeOptionsSingleTheme, CodeOptionsThemes, CodeToHastOptions, CodeToHastOptionsCommon, CodeToHastRenderOptions, CodeToHastRenderOptionsCommon, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, CreateHighlighterFactory, CreatedBundledHighlighterOptions, DecorationItem, DecorationOptions, DecorationTransformType, DynamicImportLanguageRegistration, DynamicImportThemeRegistration, Grammar, GrammarState, GrammarStateMapKey, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, LanguageInput, LanguageRegistration, LoadWasmOptions, LoadWasmOptionsPlain, MaybeArray, MaybeGetter, MaybeModule, Offset, OffsetOrPosition, OnigurumaLoadOptions, PatternScanner, PlainTextLanguage, Position, RegexEngine, RegexEngineString, RequireKeys, ResolveBundleKey, ResolvedDecorationItem, ResolvedPosition, ShikiInternal, ShikiTransformer, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformerContextMeta, ShikiTransformerContextSource, SpecialLanguage, SpecialTheme, StringLiteralUnion, ThemeInput, ThemeRegistration, ThemeRegistrationAny, ThemeRegistrationRaw, ThemeRegistrationResolved, ThemedToken, ThemedTokenExplanation, ThemedTokenScopeExplanation, ThemedTokenWithVariants, TokenBase, TokenStyles, TokenizeWithThemeOptions, TokensResult, TransformerOptions, WebAssemblyInstance, WebAssemblyInstantiator };
+export type { AnsiLanguage, Awaitable, BundledHighlighterOptions, BundledLanguageInfo, BundledThemeInfo, CodeOptionsMeta, CodeOptionsMultipleThemes, CodeOptionsSingleTheme, CodeOptionsThemes, CodeToHastOptions, CodeToHastOptionsCommon, CodeToHastRenderOptions, CodeToHastRenderOptionsCommon, CodeToTokensBaseOptions, CodeToTokensOptions, CodeToTokensWithThemesOptions, CreateBundledHighlighterOptions, CreateHighlighterFactory, CreatedBundledHighlighterOptions, DecorationItem, DecorationOptions, DecorationTransformType, DynamicImportLanguageRegistration, DynamicImportThemeRegistration, Grammar, GrammarState, GrammarStateMapKey, HighlighterCore, HighlighterCoreOptions, HighlighterGeneric, LanguageInput, LanguageRegistration, LoadWasmOptions, LoadWasmOptionsPlain, MaybeArray, MaybeGetter, MaybeModule, Offset, OffsetOrPosition, OnigurumaLoadOptions, PatternScanner, PlainTextLanguage, Position, RegexEngine, RegexEngineString, RequireKeys, ResolveBundleKey, ResolvedDecorationItem, ResolvedPosition, ShikiInternal, ShikiTransformer, ShikiTransformerContext, ShikiTransformerContextCommon, ShikiTransformerContextMeta, ShikiTransformerContextSource, SpecialLanguage, SpecialTheme, StringLiteralUnion, ThemeInput, ThemeRegistration, ThemeRegistrationAny, ThemeRegistrationRaw, ThemeRegistrationResolved, ThemedToken, ThemedTokenExplanation, ThemedTokenScopeExplanation, ThemedTokenWithVariants, TokenBase, TokenStyles, TokenizeWithThemeOptions, TokensResult, TransformerOptions, WebAssemblyInstance, WebAssemblyInstantiator };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shikijs/types",
   "type": "module",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Type definitions for Shiki",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",