@i18n-micro/vue 1.4.11 → 2.0.1

package/dist/index.d.ts

@@ -4,15 +4,19 @@ import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { CSSProperties } from 'vue';
+import { DateTimeFormatsConfig } from '@i18n-micro/core';
 import { defaultPlural } from '@i18n-micro/core';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { FormatService } from '@i18n-micro/core';
+import { FunctionalComponent } from 'vue';
 import { Getter } from '@i18n-micro/types';
 import { InjectionKey } from 'vue';
 import { interpolate } from '@i18n-micro/core';
 import { Locale } from '@i18n-micro/types';
 import { LocaleCode } from '@i18n-micro/types';
+import { LocaleHead } from '@i18n-micro/utils/locale-head';
+import { NumberFormatsConfig } from '@i18n-micro/core';
 import { Params } from '@i18n-micro/types';
 import { Plugin as Plugin_2 } from 'vue';
 import { PluralFunc } from '@i18n-micro/types';
@@ -64,9 +68,7 @@ export declare const I18nInjectionKey: InjectionKey<VueI18n>;
 
 export declare const I18nLink: DefineComponent<ExtractPropTypes<{
     to: {
-        type: PropType<string | {
-            path?: string;
-        }>;
+        type: PropType<I18nRouteTarget>;
         required: true;
     };
     activeStyle: {
@@ -74,9 +76,7 @@ export declare const I18nLink: DefineComponent<ExtractPropTypes<{
         default: () => {};
     };
     localeRoute: {
-        type: PropType<(to: string | {
-            path?: string;
-        }, locale?: string) => string | {
+        type: PropType<(to: I18nRouteTarget, locale?: string) => string | {
             path?: string;
         }>;
         default: undefined;
@@ -85,9 +85,7 @@ export declare const I18nLink: DefineComponent<ExtractPropTypes<{
     [key: string]: any;
 }>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
     to: {
-        type: PropType<string | {
-            path?: string;
-        }>;
+        type: PropType<I18nRouteTarget>;
         required: true;
     };
     activeStyle: {
@@ -95,18 +93,14 @@ export declare const I18nLink: DefineComponent<ExtractPropTypes<{
         default: () => {};
     };
     localeRoute: {
-        type: PropType<(to: string | {
-            path?: string;
-        }, locale?: string) => string | {
+        type: PropType<(to: I18nRouteTarget, locale?: string) => string | {
             path?: string;
         }>;
         default: undefined;
     };
 }>> & Readonly<{}>, {
     activeStyle: CSSProperties;
-    localeRoute: (to: string | {
-        path?: string;
-    }, locale?: string) => string | {
+    localeRoute: (to: I18nRouteTarget, locale?: string) => string | {
         path?: string;
     };
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
@@ -118,6 +112,15 @@ export declare type I18nPlugin = Plugin_2 & {
     setRoutingStrategy: (strategy: I18nRoutingStrategy) => void;
 };
 
+/** A link target: a path with its query and hash, or a location (a named one needs a router that resolves names). */
+export declare type I18nRouteTarget = string | {
+    path?: string;
+    name?: string | symbol;
+    params?: object;
+    query?: object;
+    hash?: string;
+};
+
 /**
  * Routing strategy interface for i18n
  * Implement this interface to integrate with any router library
@@ -147,11 +150,14 @@ export declare interface I18nRoutingStrategy {
     /**
      * Generate path for specific locale
      */
-    resolvePath?: (to: string | {
-        path?: string;
-    }, locale: string) => string | {
+    resolvePath?: (to: I18nRouteTarget, locale: string) => string | {
         path?: string;
     };
+    /**
+     * `href` of a path from `resolvePath`, for a router that navigates by something else
+     * (VitePress: paths are relative to the site base, the address bar is not)
+     */
+    toHref?: (path: string) => string;
     /**
      * (Optional) Get current route object for SEO/Meta tags
      */
@@ -229,9 +235,7 @@ export declare const I18nSwitcher: DefineComponent<ExtractPropTypes<{
         }>;
         default: undefined;
     };
-}>, () => VNode< RendererNode, RendererElement, {
-    [key: string]: any;
-}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
+}>, () => unknown, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
     customLabels: {
         type: PropType<Record<string, string>>;
         default: () => {};
@@ -305,7 +309,6 @@ export declare const I18nSwitcher: DefineComponent<ExtractPropTypes<{
     }, locale?: string) => string | {
         path?: string;
     };
-    customLabels: Record<string, string>;
     customWrapperStyle: CSSProperties;
     customButtonStyle: CSSProperties;
     customDropdownStyle: CSSProperties;
@@ -314,104 +317,72 @@ export declare const I18nSwitcher: DefineComponent<ExtractPropTypes<{
     customActiveLinkStyle: CSSProperties;
     customDisabledLinkStyle: CSSProperties;
     customIconStyle: CSSProperties;
+    customLabels: Record<string, string>;
     locales: Locale[];
     currentLocale: string | (() => string);
     getLocaleName: () => string | null;
     switchLocale: (locale: string) => void;
 }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
-export declare const I18nT: DefineComponent<ExtractPropTypes<{
-    keypath: {
-        type: PropType<TranslationKey>;
-        required: true;
-    };
-    plural: {
-        type: PropType<number | string>;
-    };
-    tag: {
-        type: PropType<string>;
-        default: string;
-    };
-    params: {
-        type: PropType<Record<string, string | number | boolean>>;
-        default: () => {};
-    };
-    defaultValue: {
-        type: PropType<string>;
-        default: string;
-    };
-    html: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    hideIfEmpty: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    customPluralRule: {
-        type: PropType<PluralFunc>;
-        default: null;
-    };
-    number: {
-        type: PropType<number | string>;
-    };
-    date: {
-        type: PropType<Date | string | number>;
-    };
-    relativeDate: {
-        type: PropType<Date | string | number>;
-    };
-}>, () => string | VNode< RendererNode, RendererElement, {
-    [key: string]: any;
-}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< ExtractPropTypes<{
-    keypath: {
-        type: PropType<TranslationKey>;
-        required: true;
-    };
-    plural: {
-        type: PropType<number | string>;
-    };
-    tag: {
-        type: PropType<string>;
-        default: string;
-    };
-    params: {
-        type: PropType<Record<string, string | number | boolean>>;
-        default: () => {};
-    };
-    defaultValue: {
-        type: PropType<string>;
-        default: string;
-    };
-    html: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    hideIfEmpty: {
-        type: PropType<boolean>;
-        default: boolean;
-    };
-    customPluralRule: {
-        type: PropType<PluralFunc>;
-        default: null;
-    };
-    number: {
-        type: PropType<number | string>;
-    };
-    date: {
-        type: PropType<Date | string | number>;
-    };
-    relativeDate: {
-        type: PropType<Date | string | number>;
+export declare const I18nT: FunctionalComponent<I18nTProps, {}, any, {}> & {
+    displayName: string;
+    inheritAttrs: boolean;
+    props: {
+        keypath: {
+            type: PropType<TranslationKey>;
+            required: boolean;
+        };
+        plural: {
+            type: PropType<number | string | null>;
+        };
+        tag: {
+            type: StringConstructor;
+            default: string;
+        };
+        params: {
+            type: PropType<Record<string, string | number | boolean>>;
+        };
+        defaultValue: {
+            type: StringConstructor;
+            default: string;
+        };
+        html: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        hideIfEmpty: {
+            type: BooleanConstructor;
+            default: boolean;
+        };
+        customPluralRule: {
+            type: PropType<PluralFunc>;
+            default: null;
+        };
+        number: {
+            type: PropType<number | string | null>;
+        };
+        date: {
+            type: PropType<Date | string | number | null>;
+        };
+        relativeDate: {
+            type: PropType<Date | string | number | null>;
+        };
     };
-}>> & Readonly<{}>, {
-    html: boolean;
-    tag: string;
-    params: Record<string, string | number | boolean>;
-    defaultValue: string;
-    hideIfEmpty: boolean;
-    customPluralRule: PluralFunc;
-}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+};
+
+export declare interface I18nTProps {
+    keypath: TranslationKey;
+    plural?: number | string | null;
+    tag?: string;
+    params?: Record<string, string | number | boolean>;
+    defaultValue?: string;
+    html?: boolean;
+    hideIfEmpty?: boolean;
+    customPluralRule?: PluralFunc | null;
+    number?: number | string | null;
+    date?: Date | string | number | null;
+    relativeDate?: Date | string | number | null;
+}
 
 export { interpolate }
 
@@ -419,28 +390,6 @@ export { Locale }
 
 export { LocaleCode }
 
-declare interface MetaLink {
-    [key: string]: string | undefined;
-    rel: string;
-    href: string;
-    hreflang?: string;
-}
-
-declare interface MetaObject {
-    htmlAttrs: {
-        lang?: string;
-        dir?: 'ltr' | 'rtl' | 'auto';
-    };
-    link: MetaLink[];
-    meta: MetaTag[];
-}
-
-declare interface MetaTag {
-    [key: string]: string;
-    property: string;
-    content: string;
-}
-
 export { Params }
 
 export { PluralFunc }
@@ -457,14 +406,8 @@ export declare function useI18n(options?: UseI18nOptions): {
     getLocales: () => Locale[];
     defaultLocale: () => string;
     getLocaleName: () => string | null;
-    localeRoute: (to: string | {
-        path?: string;
-    }, localeCode?: string) => string | {
-        path?: string;
-    };
-    localePath: (to: string | {
-        path?: string;
-    }, locale?: string) => string;
+    localeRoute: (to: I18nRouteTarget, localeCode?: string) => I18nRouteTarget;
+    localePath: (to: I18nRouteTarget, locale?: string) => string;
     switchLocale: (newLocale: string) => void;
     t: (key: TranslationKey, params?: Params, defaultValue?: string | null, routeContext?: unknown) => CleanTranslation;
     ts: (key: TranslationKey, params?: Params, defaultValue?: string, routeContext?: unknown) => string;
@@ -500,31 +443,41 @@ export declare interface UseI18nOptions {
 export declare function useLocaleHead(options?: UseLocaleHeadOptions): {
     metaObject: Ref<{
         htmlAttrs: {
+            [x: string]: string | undefined;
             lang?: string | undefined;
             dir?: "ltr" | "rtl" | "auto" | undefined;
         };
-        link: {
+        link: ({
             [x: string]: string | undefined;
-            rel: string;
+            rel: "canonical";
             href: string;
-            hreflang?: string | undefined;
-        }[];
+        } | {
+            [x: string]: string | undefined;
+            rel: "alternate";
+            href: string;
+            hreflang: string;
+        })[];
         meta: {
             [x: string]: string;
             property: string;
             content: string;
         }[];
-    }, MetaObject | {
+    }, LocaleHead | {
         htmlAttrs: {
+            [x: string]: string | undefined;
             lang?: string | undefined;
             dir?: "ltr" | "rtl" | "auto" | undefined;
         };
-        link: {
+        link: ({
             [x: string]: string | undefined;
-            rel: string;
+            rel: "canonical";
             href: string;
-            hreflang?: string | undefined;
-        }[];
+        } | {
+            [x: string]: string | undefined;
+            rel: "alternate";
+            href: string;
+            hreflang: string;
+        })[];
         meta: {
             [x: string]: string;
             property: string;
@@ -566,7 +519,8 @@ export declare class VueI18n extends BaseI18n {
     addTranslations(locale: string, translations: Translations, merge?: boolean): void;
     addRouteTranslations(locale: string, routeName: string, translations: Translations, merge?: boolean): void;
     mergeTranslations(locale: string, routeName: string, translations: Translations): void;
-    clearCache(): void;
+    /** Every read depends on the revision, so `computed(() => t(key))` re-runs after a write. */
+    protected touch(): void;
     protected onTranslationsChanged(): void;
     subscribeToChanges(cb: () => void): () => void;
     private notifyListeners;
@@ -581,6 +535,14 @@ export declare interface VueI18nOptions {
     plural?: PluralFunc;
     missingWarn?: boolean;
     missingHandler?: (locale: string, key: string, routeName: string) => void;
+    /** Named number formats per locale (`tn(n, 'currency')`). */
+    numberFormats?: NumberFormatsConfig;
+    /** Named datetime formats per locale (`td(d, 'short')`). */
+    datetimeFormats?: DateTimeFormatsConfig;
+    /** IANA zone for dates (`Europe/Berlin`): set it so server and browser render one date. */
+    timeZone?: string;
+    /** BCP 47 tag per locale code, for plurals of a code that is no language tag. `createI18n` fills it from `locales`. */
+    localeIso?: Record<string, string>;
 }
 
 export { }
@@ -590,9 +552,19 @@ export { }
 // Extend '@vue/runtime-core' module so types work correctly in all environments
 declare module '@vue/runtime-core' {
   interface ComponentCustomProperties {
-    $t: (key: TranslationKey, params?: Params, defaultValue?: string | null, routeName?: string) => CleanTranslation
-    $ts: (key: TranslationKey, params?: Params, defaultValue?: string, routeName?: string) => string
-    $tc: (key: TranslationKey, count: number | Params, defaultValue?: string) => string
+    $t: (
+      key: import('@i18n-micro/types').TranslationKey,
+      params?: import('@i18n-micro/types').Params,
+      defaultValue?: string | null,
+      routeName?: string,
+    ) => import('@i18n-micro/types').CleanTranslation
+    $ts: (
+      key: import('@i18n-micro/types').TranslationKey,
+      params?: import('@i18n-micro/types').Params,
+      defaultValue?: string,
+      routeName?: string,
+    ) => string
+    $tc: (key: import('@i18n-micro/types').TranslationKey, count: number | import('@i18n-micro/types').Params, defaultValue?: string) => string
     $tn: {
       (value: number, options?: Intl.NumberFormatOptions): string
       (value: number, key: string, overrides?: Intl.NumberFormatOptions): string
@@ -604,7 +576,7 @@ declare module '@vue/runtime-core' {
       (value: Date | number | string, key: string, locale: string, overrides?: Intl.DateTimeFormatOptions): string
     }
     $tdr: (value: Date | number | string, options?: Intl.RelativeTimeFormatOptions) => string
-    $has: (key: TranslationKey, routeName?: string) => boolean
+    $has: (key: import('@i18n-micro/types').TranslationKey, routeName?: string) => boolean
     $i18n: any
   }
 }