@intlify/core-base 9.3.0-beta.9 → 9.3.0

package/dist/core-base.d.ts

@@ -1,3 +1,4 @@
+import type { BaseError } from '@intlify/shared';
 import { CompileError } from '@intlify/message-compiler';
 import { CompileErrorCodes } from '@intlify/message-compiler';
 import type { CompileOptions } from '@intlify/message-compiler';
@@ -5,6 +6,7 @@ import { createCompileError } from '@intlify/message-compiler';
 import type { IntlifyDevToolsEmitter } from '@intlify/devtools-if';
 import type { IntlifyDevToolsHookPayloads } from '@intlify/devtools-if';
 import { IntlifyDevToolsHooks } from '@intlify/devtools-if';
+import { ResourceNode } from '@intlify/message-compiler';
 import type { VueDevToolsEmitter } from '@intlify/vue-devtools';
 
 declare type __ResourceFormatPath<T, Key extends keyof T> = Key extends string ? T[Key] extends Record<string, any> ? `${Key}` : never : never;
@@ -16,10 +18,12 @@ export declare function clearCompileCache(): void;
 /* Excluded from this release type: clearDateTimeFormat */
 
 /* Excluded from this release type: clearNumberFormat */
+
+export declare function compile<Message = string, MessageSource = string | ResourceNode>(message: MessageSource, context: MessageCompilerContext): MessageFunction<Message>;
 export { CompileError }
 export { CompileErrorCodes }
 
-export declare function compileToFunction<T = string>(source: string, options?: CompileOptions): MessageFunction<T>;
+export declare function compileToFunction<Message = string, MessageSource = string | ResourceNode>(message: MessageSource, context: MessageCompilerContext): MessageFunction<Message>;
 
 export declare interface CoreCommonContext<Message = string, Locales = 'en-US'> {
     cid: number;
@@ -45,18 +49,18 @@ export declare interface CoreDateTimeContext<DateTimeFormats = {}> {
     };
 }
 
-export declare interface CoreError extends CompileError {
-    code: CoreErrorCodes;
+export declare interface CoreError extends BaseError {
 }
 
 export declare const CoreErrorCodes: {
-    readonly INVALID_ARGUMENT: 15;
+    readonly INVALID_ARGUMENT: 17;
     readonly INVALID_DATE_ARGUMENT: number;
     readonly INVALID_ISO_DATE_ARGUMENT: number;
+    readonly NOT_SUPPORT_NON_STRING_MESSAGE: number;
     readonly __EXTEND_POINT__: number;
 };
 
-export declare type CoreErrorCodes = typeof CoreErrorCodes[keyof typeof CoreErrorCodes];
+export declare type CoreErrorCodes = (typeof CoreErrorCodes)[keyof typeof CoreErrorCodes];
 
 export declare interface CoreInternalContext {
     __datetimeFormatters: Map<string, Intl.DateTimeFormat>;
@@ -131,7 +135,7 @@ export declare interface CoreOptions<Message = string, Schema extends {
     processor?: MessageProcessor<Message>;
     warnHtmlMessage?: boolean;
     escapeParameter?: boolean;
-    messageCompiler?: MessageCompiler<Message>;
+    messageCompiler?: MessageCompiler<Message, string | ResourceNode>;
     messageResolver?: MessageResolver;
     localeFallbacker?: LocaleFallbacker;
     fallbackContext?: CoreContext<Message, MessagesLocales, DateTimeFormatsLocales, NumberFormatsLocales>;
@@ -148,7 +152,7 @@ export declare interface CoreTranslationContext<Messages = {}, Message = string>
     processor: MessageProcessor<Message> | null;
     warnHtmlMessage: boolean;
     escapeParameter: boolean;
-    messageCompiler: MessageCompiler<Message> | null;
+    messageCompiler: MessageCompiler<Message, string | ResourceNode> | null;
     messageResolver: MessageResolver;
 }
 
@@ -159,15 +163,16 @@ export declare const CoreWarnCodes: {
     readonly FALLBACK_TO_NUMBER_FORMAT: 4;
     readonly CANNOT_FORMAT_DATE: 5;
     readonly FALLBACK_TO_DATE_FORMAT: 6;
-    readonly __EXTEND_POINT__: 7;
+    readonly EXPERIMENTAL_CUSTOM_MESSAGE_COMPILER: 7;
+    readonly __EXTEND_POINT__: 8;
 };
 
-export declare type CoreWarnCodes = typeof CoreWarnCodes[keyof typeof CoreWarnCodes];
+export declare type CoreWarnCodes = (typeof CoreWarnCodes)[keyof typeof CoreWarnCodes];
 export { createCompileError }
 
-export declare function createCoreContext<Message = string, Options extends CoreOptions<Message> = CoreOptions<Message>, Messages = Options['messages'] extends object ? Options['messages'] : {}, DateTimeFormats = Options['datetimeFormats'] extends object ? Options['datetimeFormats'] : {}, NumberFormats = Options['numberFormats'] extends object ? Options['numberFormats'] : {}>(options: Options): CoreContext<Message, Messages, DateTimeFormats, NumberFormats>;
+export declare function createCoreContext<Message = string, Options extends CoreOptions<Message> = CoreOptions<Message>, Messages extends Record<string, any> = Options['messages'] extends Record<string, any> ? Options['messages'] : {}, DateTimeFormats extends Record<string, any> = Options['datetimeFormats'] extends Record<string, any> ? Options['datetimeFormats'] : {}, NumberFormats extends Record<string, any> = Options['numberFormats'] extends Record<string, any> ? Options['numberFormats'] : {}>(options: Options): CoreContext<Message, Messages, DateTimeFormats, NumberFormats>;
 
-export declare function createCoreContext<Schema = LocaleMessage, Locales = 'en-US', Message = string, Options extends CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>> = CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>>, Messages = Options['messages'] extends object ? Options['messages'] : {}, DateTimeFormats = Options['datetimeFormats'] extends object ? Options['datetimeFormats'] : {}, NumberFormats = Options['numberFormats'] extends object ? Options['numberFormats'] : {}>(options: Options): CoreContext<Message, Messages, DateTimeFormats, NumberFormats>;
+export declare function createCoreContext<Schema = LocaleMessage, Locales = 'en-US', Message = string, Options extends CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>> = CoreOptions<Message, SchemaParams<Schema, Message>, LocaleParams<Locales>>, Messages extends Record<string, any> = NonNullable<Options['messages']> extends Record<string, any> ? NonNullable<Options['messages']> : {}, DateTimeFormats extends Record<string, any> = NonNullable<Options['datetimeFormats']> extends Record<string, any> ? NonNullable<Options['datetimeFormats']> : {}, NumberFormats extends Record<string, any> = NonNullable<Options['numberFormats']> extends Record<string, any> ? NonNullable<Options['numberFormats']> : {}>(options: Options): CoreContext<Message, Messages, DateTimeFormats, NumberFormats>;
 
 export declare function createCoreError(code: CoreErrorCodes): CoreError;
 
@@ -189,15 +194,15 @@ export declare interface CurrencyNumberFormatOptions extends Intl.NumberFormatOp
 /**
  * `datetime` function overloads
  */
-export declare function datetime<Context extends CoreContext<Message, {}, Context['datetimeFormats'], {}>, Message = string>(context: Context, value: number | string | Date): string | number | Intl.DateTimeFormatPart[];
+export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Message = string>(context: Context, value: number | string | Date): string | number | Intl.DateTimeFormatPart[];
 
-export declare function datetime<Context extends CoreContext<Message, {}, Context['datetimeFormats'], {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>): string | number | Intl.DateTimeFormatPart[];
+export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>): string | number | Intl.DateTimeFormatPart[];
 
-export declare function datetime<Context extends CoreContext<Message, {}, Context['datetimeFormats'], {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale']): string | number | Intl.DateTimeFormatPart[];
+export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale']): string | number | Intl.DateTimeFormatPart[];
 
-export declare function datetime<Context extends CoreContext<Message, {}, Context['datetimeFormats'], {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, override: Intl.DateTimeFormatOptions): string | number | Intl.DateTimeFormatPart[];
+export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, override: Intl.DateTimeFormatOptions): string | number | Intl.DateTimeFormatPart[];
 
-export declare function datetime<Context extends CoreContext<Message, {}, Context['datetimeFormats'], {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale'], override: Intl.DateTimeFormatOptions): string | number | Intl.DateTimeFormatPart[];
+export declare function datetime<Context extends CoreContext<Message, {}, {}, {}>, Value extends number | string | Date = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['datetimeFormats']> = PickupFormatKeys<Context['datetimeFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | DateTimeOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale'], override: Intl.DateTimeFormatOptions): string | number | Intl.DateTimeFormatPart[];
 
 /* Excluded from this release type: DATETIME_FORMAT_OPTIONS_KEYS */
 
@@ -369,6 +374,8 @@ export declare function initI18nDevTools(i18n: unknown, version: string, meta?:
 
 export declare type IsEmptyObject<T> = [keyof T] extends [never] ? true : false;
 
+export declare const isMessageAST: (val: unknown) => val is ResourceNode;
+
 export declare const isMessageFunction: <T>(val: unknown) => val is MessageFunction<T>;
 
 export declare type IsNever<T> = [T] extends [never] ? true : false;
@@ -389,7 +396,13 @@ export declare type LinkedModifiers<T = string> = {
 export declare type LinkedModify<T = string> = (value: T, type: string) => MessageType<T>;
 
 export declare interface LinkedOptions {
+    /**
+     * The message type of linked message
+     */
     type?: string;
+    /**
+     * The modifier of linked message
+     */
     modifier?: string;
 }
 
@@ -417,7 +430,7 @@ export declare type LocaleMessageDictionary<T, Message = string> = {
 export declare type LocaleMessages<Schema, Locales = Locale, Message = string> = LocaleRecord<UnionToTuple<Locales>, Schema>;
 
 /** @VueI18nGeneral */
-export declare type LocaleMessageType<T, Message = string> = T extends string ? string : T extends () => Promise<infer P> ? LocaleMessageDictionary<P, Message> : T extends (...args: infer Arguments) => any ? (...args: Arguments) => ReturnType<T> : T extends Record<string, any> ? LocaleMessageDictionary<T, Message> : T extends Array<T> ? {
+export declare type LocaleMessageType<T, Message = string> = T extends string ? string : T extends () => Promise<infer P> ? LocaleMessageDictionary<P, Message> : T extends (...args: infer Arguments) => any ? (...args: Arguments) => ReturnType<T> : T extends Record<string, unknown> ? LocaleMessageDictionary<T, Message> : T extends Array<T> ? {
     [K in keyof T]: T[K];
 } : T;
 
@@ -452,19 +465,160 @@ export declare type LocaleRecord<T extends any[], R> = {
     [K in T[number]]: R;
 };
 
-export declare type MessageCompiler<Message = string> = (source: string, options?: CompileOptions) => MessageFunction<Message>;
+/**
+ * The message compiler
+ *
+ * @param message - A resolved message that ususally will be passed the string. if you can transform to it with bundler, will be passed the AST.
+ * @param context - A message context {@link MessageCompilerContext}
+ *
+ * @returns A {@link MessageFunction}
+ *
+ * @VueI18nGeneral
+ */
+export declare type MessageCompiler<Message = string, MessageSource = string | ResourceNode> = (message: MessageSource, context: MessageCompilerContext) => MessageFunction<Message>;
 
+/**
+ * The context that will pass the message compiler.
+ *
+ * @VueI18nGeneral
+ */
+export declare type MessageCompilerContext = Pick<CompileOptions, 'onError' | 'onCacheKey'> & {
+    /**
+     * Whether to allow the use locale messages of HTML formatting.
+     */
+    warnHtmlMessage?: boolean;
+    /**
+     * The resolved locale message key
+     */
+    key: string;
+    /**
+     * The locale
+     */
+    locale: Locale;
+};
+
+/**
+ * The message context.
+ *
+ * @VueI18nGeneral
+ */
 export declare interface MessageContext<T = string> {
+    /**
+     * Resolve message value from list.
+     *
+     * @param index - An index of message values.
+     *
+     * @returns A resolved message value.
+     *
+     * @example
+     * ```js
+     * const messages = {
+     *   en: {
+     *     greeting: ({ list }) => `hello, ${list(0)}!`
+     *   }
+     * }
+     * ```
+     */
     list(index: number): unknown;
+    /**
+     * Resolve message value from named.
+     *
+     * @param key - A key of message value.
+     *
+     * @returns A resolved message value.
+     *
+     * @example
+     * ```js
+     * const messages = {
+     *   en: {
+     *     greeting: ({ named }) => `hello, ${named('name')}!`
+     *   }
+     * }
+     * ```
+     */
     named(key: string): unknown;
+    /**
+     * Resolve message with plural index.
+     *
+     * @remarks
+     * That's resolved with plural index with translation function.
+     *
+     * @param messages - the messages, that is resolved with plural index with translation function.
+     *
+     * @returns A resolved message.
+     *
+     * @example
+     * ```js
+     * const messages = {
+     *   en: {
+     *     car: ({ plural }) => plural(['car', 'cars']),
+     *     apple: ({ plural, named }) =>
+     *       plural([
+     *         'no apples',
+     *         'one apple',
+     *         `${named('count')} apples`
+     *       ])
+     *   }
+     * }
+     * ```
+     */
     plural(messages: T[]): T;
+    /**
+     * Resolve linked message.
+     *
+     * @param key - A message key
+     * @param modifier - A modifier
+     *
+     * @returns A resolve message.
+     */
     linked(key: Path, modifier?: string): MessageType<T>;
+    /**
+     * Overloaded `linked`
+     *
+     * @param key - A message key
+     * @param modifier - A modifier
+     * @param type - A message type
+     *
+     * @returns A resolve message.
+     */
     linked(key: Path, modifier?: string, type?: string): MessageType<T>;
+    /**
+     * Overloaded `linked`
+     *
+     * @param key - A message key
+     * @param optoins - An {@link LinkedOptions | linked options}
+     *
+     * @returns A resolve message.
+     */
     linked(key: Path, optoins?: LinkedOptions): MessageType<T>;
-    message(key: Path): MessageFunction<T>;
+    /* Excluded from this release type: message */
+    /**
+     * The message type to be handled by the message function.
+     *
+     * @remarks
+     * Usually `text`, you need to return **string** in message function.
+     */
     type: string;
-    interpolate: MessageInterpolate<T>;
-    normalize: MessageNormalize<T>;
+    /* Excluded from this release type: interpolate */
+    /* Excluded from this release type: normalize */
+    /**
+     * The message values.
+     *
+     * @remarks
+     * The message values are the argument values passed from translation fucntion, such as `$t`, `t`, or `translate`.
+     *
+     * @example
+     * vue-i18n `$t` (or `t`) case:
+     * ```html
+     * <p>{{ $t('greeting', { name: 'DIO' }) }}</p> <!-- `{ name: 'DIO' }` is message vlaues -->
+     * ```
+     *
+     * `@intlify/core` (`@intlify/core-base`) `translate` case:
+     * ```js
+     * translate(context, 'foo.bar', ['dio']) // `['dio']` is message values
+     * ```
+     */
+    values: Record<string, unknown>;
 }
 
 export declare interface MessageContextOptions<T = string, N = {}> {
@@ -479,22 +633,29 @@ export declare interface MessageContextOptions<T = string, N = {}> {
     processor?: MessageProcessor<T>;
 }
 
+/**
+ * The Message Function.
+ *
+ * @param ctx - A {@link MessageContext}
+ *
+ * @return A resolved format message, that is string type basically.
+ *
+ * @VueI18nGeneral
+ */
 export declare type MessageFunction<T = string> = MessageFunctionCallable | MessageFunctionInternal<T>;
 
-export declare type MessageFunctionCallable = <T = string>(ctx: MessageContext<T>) => MessageType<T>;
+export declare type MessageFunctionCallable = <T = string>(ctx: MessageContext<T>) => MessageFunctionReturn<T>;
 
-export declare type MessageFunctionInternal<T = string> = {
-    (ctx: MessageContext<T>): MessageType<T>;
-    key?: string;
-    locale?: string;
-    source?: string;
-};
+/* Excluded from this release type: MessageFunctionInternal */
+
+/** @VueI18nGeneral */
+export declare type MessageFunctionReturn<T = string> = T extends string ? MessageType<T> : MessageType<T>[];
 
 export declare type MessageFunctions<T = string> = Record<string, MessageFunction<T>>;
 
 export declare type MessageInterpolate<T = string> = (val: unknown) => MessageType<T>;
 
-export declare type MessageNormalize<T = string> = (values: MessageType<string | T>[]) => MessageType<T | T[]>;
+export declare type MessageNormalize<T = string> = (values: MessageType<T>[]) => MessageFunctionReturn<T>;
 
 export declare interface MessageProcessor<T = string> {
     type?: string;
@@ -523,15 +684,15 @@ export declare const NOT_REOSLVED = -1;
 /**
  * `number` function overloads
  */
-export declare function number<Context extends CoreContext<Message, {}, {}, Context['numberFormats']>, Message = string>(context: Context, value: number): string | number | Intl.NumberFormatPart[];
+export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Message = string>(context: Context, value: number): string | number | Intl.NumberFormatPart[];
 
-export declare function number<Context extends CoreContext<Message, {}, {}, Context['numberFormats']>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>): string | number | Intl.NumberFormatPart[];
+export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>): string | number | Intl.NumberFormatPart[];
 
-export declare function number<Context extends CoreContext<Message, {}, {}, Context['numberFormats']>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale']): string | number | Intl.NumberFormatPart[];
+export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale']): string | number | Intl.NumberFormatPart[];
 
-export declare function number<Context extends CoreContext<Message, {}, {}, Context['numberFormats']>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, override: Intl.NumberFormatOptions): string | number | Intl.NumberFormatPart[];
+export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, override: Intl.NumberFormatOptions): string | number | Intl.NumberFormatPart[];
 
-export declare function number<Context extends CoreContext<Message, {}, {}, Context['numberFormats']>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale'], override: Intl.NumberFormatOptions): string | number | Intl.NumberFormatPart[];
+export declare function number<Context extends CoreContext<Message, {}, {}, {}>, Value extends number = number, Key extends string = string, ResourceKeys extends PickupFormatKeys<Context['numberFormats']> = PickupFormatKeys<Context['numberFormats']>, Message = string>(context: Context, value: Value, keyOrOptions: Key | ResourceKeys | NumberOptions<Key | ResourceKeys, Context['locale']>, locale: Context['locale'], override: Intl.NumberFormatOptions): string | number | Intl.NumberFormatPart[];
 
 /* Excluded from this release type: NUMBER_FORMAT_OPTIONS_KEYS */
 
@@ -665,7 +826,7 @@ export declare type PluralizationRules = {
 };
 
 /** @VueI18nGeneral */
-export declare type PostTranslationHandler<Message = string> = (translated: MessageType<Message>, key: string) => MessageType<Message>;
+export declare type PostTranslationHandler<Message = string> = (translated: MessageFunctionReturn<Message>, key: string) => MessageFunctionReturn<Message>;
 
 /**
  * Register the locale fallbacker
@@ -676,7 +837,7 @@ export declare type PostTranslationHandler<Message = string> = (translated: Mess
  */
 export declare function registerLocaleFallbacker(fallbacker: LocaleFallbacker): void;
 
-export declare function registerMessageCompiler<Message>(compiler: MessageCompiler<Message>): void;
+export declare function registerMessageCompiler<Message>(compiler: MessageCompiler<Message, string | ResourceNode>): void;
 
 /**
  * Register the message resolver
@@ -724,6 +885,7 @@ export declare function resolveWithKeyValue(obj: unknown, path: Path): PathValue
 export declare type ResourceFormatPath<T> = _ResourceFormatPath<T> extends string | keyof T ? _ResourceFormatPath<T> : keyof T;
 
 declare type _ResourceFormatPath<T> = __ResourceFormatPath<T, keyof T> | keyof T;
+export { ResourceNode }
 
 export declare type ResourcePath<T> = _ResourcePath<T> extends string | keyof T ? _ResourcePath<T> : keyof T;
 
@@ -782,31 +944,31 @@ declare type StringConvertable<T> = ExtractToStringKey<T> extends never ? unknow
 /**
  * `translate` function overloads
  */
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, plural: number): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, plural: number): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, plural: number, options: TranslateOptions<Context['locale']>): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, plural: number, options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, defaultMsg: string): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, defaultMsg: string): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, defaultMsg: string, options: TranslateOptions<Context['locale']>): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, defaultMsg: string, options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[]): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[]): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], plural: number): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], plural: number): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], defaultMsg: string): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], defaultMsg: string): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], options: TranslateOptions<Context['locale']>): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, list: unknown[], options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, plural: number): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, plural: number): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, defaultMsg: string): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, defaultMsg: string): MessageFunctionReturn<Message> | number;
 
-export declare function translate<Context extends CoreContext<Message, Context['messages'], {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, options: TranslateOptions<Context['locale']>): MessageType<Message> | number;
+export declare function translate<Context extends CoreContext<Message, {}, {}, {}>, Key extends string = string, ResourceKeys extends PickupKeys<Context['messages']> = PickupKeys<Context['messages']>, Message = string>(context: Context, key: Key | ResourceKeys | number | MessageFunction<Message>, named: NamedValue, options: TranslateOptions<Context['locale']>): MessageFunctionReturn<Message> | number;
 
 export declare const translateDevTools: (payloads: IntlifyDevToolsHookPayloads[IntlifyDevToolsHooks]) => void | null;