@i18n-micro/vue 1.3.2 → 1.3.4

package/dist/index.d.cts

@@ -0,0 +1,565 @@
+import { BaseI18n } from '@i18n-micro/core';
+import { CleanTranslation } from '@i18n-micro/types';
+import { Component } from 'vue';
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { CSSProperties } from 'vue';
+import { defaultPlural } from '@i18n-micro/core';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { FormatService } from '@i18n-micro/core';
+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 { Params } from '@i18n-micro/types';
+import { Plugin as Plugin_2 } from 'vue';
+import { PluralFunc } from '@i18n-micro/types';
+import { PropType } from 'vue';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+import { RendererElement } from 'vue';
+import { RendererNode } from 'vue';
+import { Router } from 'vue-router';
+import { TranslationKey } from '@i18n-micro/types';
+import { Translations } from '@i18n-micro/types';
+import { TranslationStorage } from '@i18n-micro/core';
+import { VNode } from 'vue';
+import { WritableComputedRef } from 'vue';
+
+export { CleanTranslation }
+
+export declare function createI18n(options: CreateI18nOptions): I18nPlugin;
+
+declare interface CreateI18nOptions extends VueI18nOptions {
+    routingStrategy?: I18nRoutingStrategy;
+    /**
+     * Array of locale configurations
+     * If provided, will be automatically provided to the app via I18nLocalesKey
+     */
+    locales?: Locale[];
+    /**
+     * Default locale code
+     * If provided, will be automatically provided to the app via I18nDefaultLocaleKey
+     */
+    defaultLocale?: string;
+}
+
+/**
+ * Factory for Vue Router adapter
+ * Implements routing utilities for Vue Router
+ * Uses vue-router APIs for navigation and path resolution
+ */
+export declare function createVueRouterAdapter(router: Router, locales: Locale[], defaultLocale: string): I18nRoutingStrategy;
+
+export { defaultPlural }
+
+export { FormatService }
+
+export { Getter }
+
+export declare const I18nDefaultLocaleKey: InjectionKey<string>;
+
+export declare const I18nGroup: DefineComponent<I18nGroupProps, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<I18nGroupProps> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+
+declare interface I18nGroupProps {
+    prefix: string;
+    groupClass?: string;
+}
+
+export declare const I18nInjectionKey: InjectionKey<VueI18n>;
+
+export declare const I18nLink: DefineComponent<ExtractPropTypes<    {
+to: {
+type: PropType<string | {
+path?: string;
+}>;
+required: true;
+};
+activeStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+localeRoute: {
+type: PropType<(to: string | {
+path?: string;
+}, locale?: string) => string | {
+path?: string;
+}>;
+default: undefined;
+};
+}>, () => VNode<RendererNode, RendererElement, {
+[key: string]: any;
+}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+to: {
+type: PropType<string | {
+path?: string;
+}>;
+required: true;
+};
+activeStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+localeRoute: {
+type: PropType<(to: string | {
+path?: string;
+}, locale?: string) => string | {
+path?: string;
+}>;
+default: undefined;
+};
+}>> & Readonly<{}>, {
+activeStyle: CSSProperties;
+localeRoute: (to: string | {
+path?: string;
+}, locale?: string) => string | {
+path?: string;
+};
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export declare const I18nLocalesKey: InjectionKey<Locale[]>;
+
+export declare type I18nPlugin = Plugin_2 & {
+    global: VueI18n;
+    setRoutingStrategy: (strategy: I18nRoutingStrategy) => void;
+};
+
+/**
+ * Routing strategy interface for i18n
+ * Implement this interface to integrate with any router library
+ */
+export declare interface I18nRoutingStrategy {
+    /**
+     * Returns current path (without locale prefix if needed, or full path)
+     * Used for determining active classes in links
+     */
+    getCurrentPath: () => string;
+    /**
+     * Component to use for rendering links (e.g., RouterLink)
+     */
+    linkComponent?: string | Component;
+    /**
+     * Function to navigate to another route/locale
+     */
+    push: (target: {
+        path: string;
+    }) => void;
+    /**
+     * Function to replace current route
+     */
+    replace: (target: {
+        path: string;
+    }) => void;
+    /**
+     * Generate path for specific locale
+     */
+    resolvePath?: (to: string | {
+        path?: string;
+    }, locale: string) => string | {
+        path?: string;
+    };
+    /**
+     * (Optional) Get current route object for SEO/Meta tags
+     */
+    getRoute?: () => {
+        fullPath: string;
+        query: Record<string, unknown>;
+    };
+}
+
+export declare const I18nSwitcher: DefineComponent<ExtractPropTypes<    {
+customLabels: {
+type: PropType<Record<string, string>>;
+default: () => {};
+};
+customWrapperStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customButtonStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customDropdownStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customItemStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customLinkStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customActiveLinkStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customDisabledLinkStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customIconStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+locales: {
+type: PropType<Locale[]>;
+default: undefined;
+};
+currentLocale: {
+type: PropType<string | (() => string)>;
+default: undefined;
+};
+getLocaleName: {
+type: PropType<() => string | null>;
+default: undefined;
+};
+switchLocale: {
+type: PropType<(locale: string) => void>;
+default: undefined;
+};
+localeRoute: {
+type: PropType<(to: string | {
+path?: string;
+}, locale?: string) => string | {
+path?: string;
+}>;
+default: undefined;
+};
+}>, () => VNode<RendererNode, RendererElement, {
+[key: string]: any;
+}>, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+customLabels: {
+type: PropType<Record<string, string>>;
+default: () => {};
+};
+customWrapperStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customButtonStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customDropdownStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customItemStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customLinkStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customActiveLinkStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customDisabledLinkStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+customIconStyle: {
+type: PropType<CSSProperties>;
+default: () => {};
+};
+locales: {
+type: PropType<Locale[]>;
+default: undefined;
+};
+currentLocale: {
+type: PropType<string | (() => string)>;
+default: undefined;
+};
+getLocaleName: {
+type: PropType<() => string | null>;
+default: undefined;
+};
+switchLocale: {
+type: PropType<(locale: string) => void>;
+default: undefined;
+};
+localeRoute: {
+type: PropType<(to: string | {
+path?: string;
+}, locale?: string) => string | {
+path?: string;
+}>;
+default: undefined;
+};
+}>> & Readonly<{}>, {
+localeRoute: (to: string | {
+path?: string;
+}, locale?: string) => string | {
+path?: string;
+};
+customLabels: Record<string, string>;
+customWrapperStyle: CSSProperties;
+customButtonStyle: CSSProperties;
+customDropdownStyle: CSSProperties;
+customItemStyle: CSSProperties;
+customLinkStyle: CSSProperties;
+customActiveLinkStyle: CSSProperties;
+customDisabledLinkStyle: CSSProperties;
+customIconStyle: CSSProperties;
+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>;
+};
+}>> & Readonly<{}>, {
+html: boolean;
+tag: string;
+params: Record<string, string | number | boolean>;
+defaultValue: string;
+hideIfEmpty: boolean;
+customPluralRule: PluralFunc;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export { interpolate }
+
+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 }
+
+export { Translations }
+
+/**
+ * Get the i18n instance from the Vue app context
+ * Returns the same instance that was created with createI18n()
+ */
+export declare function useI18n(options?: UseI18nOptions): {
+    instance: VueI18n;
+    locale: WritableComputedRef<string, string>;
+    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;
+    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;
+    tc: (key: TranslationKey, count: number | Params, defaultValue?: string) => string;
+    tn: (value: number, options?: Intl.NumberFormatOptions) => string;
+    td: (value: Date | number | string, options?: Intl.DateTimeFormatOptions) => string;
+    tdr: (value: Date | number | string, options?: Intl.RelativeTimeFormatOptions) => string;
+    has: (key: TranslationKey, routeContext?: unknown) => boolean;
+    setRoute: (routeName: string) => void;
+    getRoute: () => string;
+    getLocale: () => string;
+    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;
+};
+
+export declare interface UseI18nOptions {
+    locales?: Locale[];
+    defaultLocale?: string;
+}
+
+export declare function useLocaleHead(options?: UseLocaleHeadOptions): {
+    metaObject: Ref<    {
+    htmlAttrs: {
+    lang?: string | undefined;
+    dir?: "ltr" | "rtl" | "auto" | undefined;
+    };
+    link: {
+    [x: string]: string | undefined;
+    rel: string;
+    href: string;
+    hreflang?: string | undefined;
+    }[];
+    meta: {
+    [x: string]: string;
+    property: string;
+    content: string;
+    }[];
+    }, MetaObject | {
+    htmlAttrs: {
+    lang?: string | undefined;
+    dir?: "ltr" | "rtl" | "auto" | undefined;
+    };
+    link: {
+    [x: string]: string | undefined;
+    rel: string;
+    href: string;
+    hreflang?: string | undefined;
+    }[];
+    meta: {
+    [x: string]: string;
+    property: string;
+    content: string;
+    }[];
+    }>;
+    updateMeta: (canonicalQueryWhitelist?: string[]) => void;
+};
+
+export declare interface UseLocaleHeadOptions {
+    addDirAttribute?: boolean;
+    identifierAttribute?: string;
+    addSeoAttributes?: boolean;
+    baseUrl?: string | (() => string);
+}
+
+export declare class VueI18n extends BaseI18n {
+    private _locale;
+    private _fallbackLocale;
+    private _currentRoute;
+    private _revision;
+    readonly storage: TranslationStorage;
+    private listeners;
+    constructor(options: VueI18nOptions);
+    get locale(): Ref<string>;
+    set locale(val: Ref<string> | string);
+    get fallbackLocale(): Ref<string>;
+    set fallbackLocale(val: Ref<string> | string);
+    get currentRoute(): Ref<string>;
+    setRoute(routeName: string): void;
+    getLocale(): string;
+    getFallbackLocale(): string;
+    getRoute(): string;
+    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;
+    subscribeToChanges(cb: () => void): () => void;
+    private notifyListeners;
+    getAllTranslations(): Record<string, Translations>;
+    getStorage(): TranslationStorage;
+    getRouteCache(): Record<string, Translations>;
+}
+
+export declare interface VueI18nOptions {
+    locale: string;
+    fallbackLocale?: string;
+    messages?: Record<string, Translations>;
+    plural?: PluralFunc;
+    missingWarn?: boolean;
+    missingHandler?: (locale: string, key: string, routeName: string) => void;
+}
+
+export { }