@sheet-i18n/react-client 1.6.0-canary.4 → 1.6.0-canary.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +26 -32
- package/dist/index.d.ts +26 -32
- package/dist/index.js +2 -10
- package/dist/index.mjs +1 -5
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { I18nStore } from '@sheet-i18n/react-core';
|
|
2
2
|
import { ObserverManager } from '@sheet-i18n/shared-utils';
|
|
3
|
-
import { MessageDescriptor, IntlShape } from 'react-intl';
|
|
4
|
-
export { IntlShape, MessageDescriptor } from 'react-intl';
|
|
5
3
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
|
+
import { MessageDescriptor, IntlShape } from 'react-intl';
|
|
6
5
|
import * as react from 'react';
|
|
7
6
|
|
|
8
7
|
interface IStorageService<V extends string> {
|
|
@@ -38,6 +37,17 @@ declare class LocaleStorageManager<TSupportedLocales extends readonly string[],
|
|
|
38
37
|
*/
|
|
39
38
|
declare const getLocaleStorageManager: <TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, storage?: IStorageService<string>) => LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
40
39
|
|
|
40
|
+
declare function useLocaleStorage<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(localeStorageManager: LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>): {
|
|
41
|
+
locale: TSupportedLocales[number] | undefined;
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
type IntlProviderProps<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false> = {
|
|
45
|
+
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
46
|
+
currentLocale?: TSupportedLocales[number];
|
|
47
|
+
children: React.ReactNode;
|
|
48
|
+
};
|
|
49
|
+
declare function IntlProvider<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>({ i18nStore, currentLocale, children, }: IntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>): react_jsx_runtime.JSX.Element;
|
|
50
|
+
|
|
41
51
|
type UseIntlParams<D = MessageDescriptor> = Parameters<IntlShape['$t']> extends [D, ...infer R] ? [...R, Omit<D, 'id'>] : never;
|
|
42
52
|
type ExtendedUseIntlParams<D = MessageDescriptor> = UseIntlParams<D> extends [infer A, infer B, ...infer Rest] ? A extends Record<string, infer V> ? [Record<string, V | React.ReactNode>, B, ...Rest] : [A, B, ...Rest] : UseIntlParams<D>;
|
|
43
53
|
type $TParams = Partial<ExtendedUseIntlParams>;
|
|
@@ -61,45 +71,28 @@ type RuleKey = string;
|
|
|
61
71
|
type RuleFn<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues = any> = (values: TValues, currentLocaleSet: ReturnType<TI18nStore['getCurrentLocaleSet']>) => TMessageId;
|
|
62
72
|
type Rules<TSupportedLocales extends SupportedLocales = SupportedLocales, TLocaleSet extends LocaleSet = LocaleSet, TTypeSafe extends TypeSafe = TypeSafe, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe> = I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe> = SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe> = SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> = Record<RuleKey, RuleFn<TSupportedLocales, TLocaleSet, TI18nStore, TTypeSafe, TSheetTitle, TMessageId>>;
|
|
63
73
|
|
|
64
|
-
|
|
65
|
-
sheetTitle: TSheetTitle;
|
|
66
|
-
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
67
|
-
}
|
|
68
|
-
type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
|
|
74
|
+
type UseTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Partial<Record<TSupportedLocales[number], Record<string, any>>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TRules extends Rules> = {
|
|
69
75
|
t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
|
|
70
76
|
} & {
|
|
71
77
|
t: {
|
|
72
78
|
dynamic: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: string, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? string : any;
|
|
73
|
-
|
|
79
|
+
rule: <TRuleKey extends keyof TRules, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>(ruleKey: TRuleKey, values?: Parameters<TRules[TRuleKey]>[0]) => TTypeSafe extends true ? TMessageId : any;
|
|
74
80
|
};
|
|
75
81
|
};
|
|
76
|
-
declare function getTranslation<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>({ sheetTitle, i18nStore, }: GetTranslationParams<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>): GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
|
|
77
82
|
|
|
78
|
-
interface
|
|
83
|
+
interface GetTranslationParams<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false, TSheetTitle = TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] : string> {
|
|
79
84
|
sheetTitle: TSheetTitle;
|
|
80
85
|
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
81
|
-
rules?: TRules;
|
|
82
86
|
}
|
|
83
|
-
type
|
|
87
|
+
type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
|
|
84
88
|
t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
|
|
85
89
|
} & {
|
|
86
90
|
t: {
|
|
87
91
|
dynamic: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: string, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? string : any;
|
|
88
|
-
|
|
92
|
+
promise: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? Promise<TMessageId> : any;
|
|
89
93
|
};
|
|
90
94
|
};
|
|
91
|
-
declare function
|
|
92
|
-
|
|
93
|
-
type IntlProviderProps<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false> = {
|
|
94
|
-
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
95
|
-
currentLocale?: TSupportedLocales[number];
|
|
96
|
-
children: React.ReactNode;
|
|
97
|
-
};
|
|
98
|
-
declare function IntlProvider<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>({ i18nStore, currentLocale, children, }: IntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>): react_jsx_runtime.JSX.Element;
|
|
99
|
-
|
|
100
|
-
declare function useLocaleStorage<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(localeStorageManager: LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>): {
|
|
101
|
-
locale: TSupportedLocales[number] | undefined;
|
|
102
|
-
};
|
|
95
|
+
declare function getTranslation<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>({ sheetTitle, i18nStore, }: GetTranslationParams<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>): GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
|
|
103
96
|
|
|
104
97
|
type StorageBasedIntlProviderProps<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false> = {
|
|
105
98
|
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
@@ -112,17 +105,18 @@ declare function StorageBasedIntlProvider<TSupportedLocales extends readonly str
|
|
|
112
105
|
interface Plugins<TRules extends Rules> {
|
|
113
106
|
rules?: TRules;
|
|
114
107
|
}
|
|
115
|
-
|
|
116
|
-
IntlProvider: (
|
|
108
|
+
type CreateI18nContextReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TRules extends Rules, TTypeSafe extends boolean = false> = {
|
|
109
|
+
IntlProvider: (props: Omit<IntlProviderProps<TSupportedLocales, TLocaleSet>, 'currentLocale' | 'i18nStore'> & {
|
|
117
110
|
currentLocale?: string;
|
|
118
111
|
children?: React.ReactNode;
|
|
119
|
-
}) =>
|
|
120
|
-
StorageBasedIntlProvider: (
|
|
112
|
+
}) => ReturnType<typeof IntlProvider>;
|
|
113
|
+
StorageBasedIntlProvider: (props: Omit<StorageBasedIntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>, 'i18nStore'>) => ReturnType<typeof StorageBasedIntlProvider>;
|
|
121
114
|
useTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => UseTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle, TRules>;
|
|
122
|
-
getTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) =>
|
|
123
|
-
getLocaleStorageManager: (storageService?: IStorageService<string>) =>
|
|
115
|
+
getTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => ReturnType<typeof getTranslation>;
|
|
116
|
+
getLocaleStorageManager: (storageService?: IStorageService<string>) => ReturnType<typeof getLocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>>;
|
|
124
117
|
useLocaleStorage: typeof useLocaleStorage;
|
|
125
118
|
};
|
|
119
|
+
declare function createI18nContext<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TRules extends Rules, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, plugins?: Plugins<TRules>): CreateI18nContextReturn<TSupportedLocales, TLocaleSet, TRules, TTypeSafe>;
|
|
126
120
|
|
|
127
121
|
declare class RuleService<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> {
|
|
128
122
|
private readonly i18nStore;
|
|
@@ -131,4 +125,4 @@ declare class RuleService<TSupportedLocales extends SupportedLocales, TLocaleSet
|
|
|
131
125
|
}
|
|
132
126
|
declare const ruleFactory: <TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>) => RuleService<TSupportedLocales, TLocaleSet, TTypeSafe, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, SafeMessageId<TSupportedLocales, TLocaleSet, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe>>;
|
|
133
127
|
|
|
134
|
-
export { type IStorageService, IntlProvider, LocaleStorageManager,
|
|
128
|
+
export { type CreateI18nContextReturn, type IStorageService, IntlProvider, LocaleStorageManager, createI18nContext, ruleFactory };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { I18nStore } from '@sheet-i18n/react-core';
|
|
2
2
|
import { ObserverManager } from '@sheet-i18n/shared-utils';
|
|
3
|
-
import { MessageDescriptor, IntlShape } from 'react-intl';
|
|
4
|
-
export { IntlShape, MessageDescriptor } from 'react-intl';
|
|
5
3
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
4
|
+
import { MessageDescriptor, IntlShape } from 'react-intl';
|
|
6
5
|
import * as react from 'react';
|
|
7
6
|
|
|
8
7
|
interface IStorageService<V extends string> {
|
|
@@ -38,6 +37,17 @@ declare class LocaleStorageManager<TSupportedLocales extends readonly string[],
|
|
|
38
37
|
*/
|
|
39
38
|
declare const getLocaleStorageManager: <TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, storage?: IStorageService<string>) => LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
40
39
|
|
|
40
|
+
declare function useLocaleStorage<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(localeStorageManager: LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>): {
|
|
41
|
+
locale: TSupportedLocales[number] | undefined;
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
type IntlProviderProps<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false> = {
|
|
45
|
+
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
46
|
+
currentLocale?: TSupportedLocales[number];
|
|
47
|
+
children: React.ReactNode;
|
|
48
|
+
};
|
|
49
|
+
declare function IntlProvider<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>({ i18nStore, currentLocale, children, }: IntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>): react_jsx_runtime.JSX.Element;
|
|
50
|
+
|
|
41
51
|
type UseIntlParams<D = MessageDescriptor> = Parameters<IntlShape['$t']> extends [D, ...infer R] ? [...R, Omit<D, 'id'>] : never;
|
|
42
52
|
type ExtendedUseIntlParams<D = MessageDescriptor> = UseIntlParams<D> extends [infer A, infer B, ...infer Rest] ? A extends Record<string, infer V> ? [Record<string, V | React.ReactNode>, B, ...Rest] : [A, B, ...Rest] : UseIntlParams<D>;
|
|
43
53
|
type $TParams = Partial<ExtendedUseIntlParams>;
|
|
@@ -61,45 +71,28 @@ type RuleKey = string;
|
|
|
61
71
|
type RuleFn<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues = any> = (values: TValues, currentLocaleSet: ReturnType<TI18nStore['getCurrentLocaleSet']>) => TMessageId;
|
|
62
72
|
type Rules<TSupportedLocales extends SupportedLocales = SupportedLocales, TLocaleSet extends LocaleSet = LocaleSet, TTypeSafe extends TypeSafe = TypeSafe, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe> = I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe> = SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe> = SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> = Record<RuleKey, RuleFn<TSupportedLocales, TLocaleSet, TI18nStore, TTypeSafe, TSheetTitle, TMessageId>>;
|
|
63
73
|
|
|
64
|
-
|
|
65
|
-
sheetTitle: TSheetTitle;
|
|
66
|
-
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
67
|
-
}
|
|
68
|
-
type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
|
|
74
|
+
type UseTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Partial<Record<TSupportedLocales[number], Record<string, any>>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TRules extends Rules> = {
|
|
69
75
|
t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
|
|
70
76
|
} & {
|
|
71
77
|
t: {
|
|
72
78
|
dynamic: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: string, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? string : any;
|
|
73
|
-
|
|
79
|
+
rule: <TRuleKey extends keyof TRules, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>(ruleKey: TRuleKey, values?: Parameters<TRules[TRuleKey]>[0]) => TTypeSafe extends true ? TMessageId : any;
|
|
74
80
|
};
|
|
75
81
|
};
|
|
76
|
-
declare function getTranslation<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>({ sheetTitle, i18nStore, }: GetTranslationParams<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>): GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
|
|
77
82
|
|
|
78
|
-
interface
|
|
83
|
+
interface GetTranslationParams<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false, TSheetTitle = TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] : string> {
|
|
79
84
|
sheetTitle: TSheetTitle;
|
|
80
85
|
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
81
|
-
rules?: TRules;
|
|
82
86
|
}
|
|
83
|
-
type
|
|
87
|
+
type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
|
|
84
88
|
t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
|
|
85
89
|
} & {
|
|
86
90
|
t: {
|
|
87
91
|
dynamic: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: string, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? string : any;
|
|
88
|
-
|
|
92
|
+
promise: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? Promise<TMessageId> : any;
|
|
89
93
|
};
|
|
90
94
|
};
|
|
91
|
-
declare function
|
|
92
|
-
|
|
93
|
-
type IntlProviderProps<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false> = {
|
|
94
|
-
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
95
|
-
currentLocale?: TSupportedLocales[number];
|
|
96
|
-
children: React.ReactNode;
|
|
97
|
-
};
|
|
98
|
-
declare function IntlProvider<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>({ i18nStore, currentLocale, children, }: IntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>): react_jsx_runtime.JSX.Element;
|
|
99
|
-
|
|
100
|
-
declare function useLocaleStorage<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(localeStorageManager: LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>): {
|
|
101
|
-
locale: TSupportedLocales[number] | undefined;
|
|
102
|
-
};
|
|
95
|
+
declare function getTranslation<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>({ sheetTitle, i18nStore, }: GetTranslationParams<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>): GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
|
|
103
96
|
|
|
104
97
|
type StorageBasedIntlProviderProps<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false> = {
|
|
105
98
|
i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>;
|
|
@@ -112,17 +105,18 @@ declare function StorageBasedIntlProvider<TSupportedLocales extends readonly str
|
|
|
112
105
|
interface Plugins<TRules extends Rules> {
|
|
113
106
|
rules?: TRules;
|
|
114
107
|
}
|
|
115
|
-
|
|
116
|
-
IntlProvider: (
|
|
108
|
+
type CreateI18nContextReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TRules extends Rules, TTypeSafe extends boolean = false> = {
|
|
109
|
+
IntlProvider: (props: Omit<IntlProviderProps<TSupportedLocales, TLocaleSet>, 'currentLocale' | 'i18nStore'> & {
|
|
117
110
|
currentLocale?: string;
|
|
118
111
|
children?: React.ReactNode;
|
|
119
|
-
}) =>
|
|
120
|
-
StorageBasedIntlProvider: (
|
|
112
|
+
}) => ReturnType<typeof IntlProvider>;
|
|
113
|
+
StorageBasedIntlProvider: (props: Omit<StorageBasedIntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>, 'i18nStore'>) => ReturnType<typeof StorageBasedIntlProvider>;
|
|
121
114
|
useTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => UseTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle, TRules>;
|
|
122
|
-
getTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) =>
|
|
123
|
-
getLocaleStorageManager: (storageService?: IStorageService<string>) =>
|
|
115
|
+
getTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => ReturnType<typeof getTranslation>;
|
|
116
|
+
getLocaleStorageManager: (storageService?: IStorageService<string>) => ReturnType<typeof getLocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>>;
|
|
124
117
|
useLocaleStorage: typeof useLocaleStorage;
|
|
125
118
|
};
|
|
119
|
+
declare function createI18nContext<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TRules extends Rules, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, plugins?: Plugins<TRules>): CreateI18nContextReturn<TSupportedLocales, TLocaleSet, TRules, TTypeSafe>;
|
|
126
120
|
|
|
127
121
|
declare class RuleService<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> {
|
|
128
122
|
private readonly i18nStore;
|
|
@@ -131,4 +125,4 @@ declare class RuleService<TSupportedLocales extends SupportedLocales, TLocaleSet
|
|
|
131
125
|
}
|
|
132
126
|
declare const ruleFactory: <TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>) => RuleService<TSupportedLocales, TLocaleSet, TTypeSafe, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, SafeMessageId<TSupportedLocales, TLocaleSet, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe>>;
|
|
133
127
|
|
|
134
|
-
export { type IStorageService, IntlProvider, LocaleStorageManager,
|
|
128
|
+
export { type CreateI18nContextReturn, type IStorageService, IntlProvider, LocaleStorageManager, createI18nContext, ruleFactory };
|
package/dist/index.js
CHANGED
|
@@ -40,12 +40,8 @@ var src_exports = {};
|
|
|
40
40
|
__export(src_exports, {
|
|
41
41
|
IntlProvider: () => IntlProvider,
|
|
42
42
|
LocaleStorageManager: () => LocaleStorageManager,
|
|
43
|
-
StorageBasedIntlProvider: () => StorageBasedIntlProvider,
|
|
44
43
|
createI18nContext: () => createI18nContext,
|
|
45
|
-
|
|
46
|
-
getTranslation: () => getTranslation,
|
|
47
|
-
ruleFactory: () => ruleFactory,
|
|
48
|
-
useTranslation: () => useTranslation
|
|
44
|
+
ruleFactory: () => ruleFactory
|
|
49
45
|
});
|
|
50
46
|
module.exports = __toCommonJS(src_exports);
|
|
51
47
|
|
|
@@ -570,10 +566,6 @@ var ruleFactory = (i18nStore) => {
|
|
|
570
566
|
0 && (module.exports = {
|
|
571
567
|
IntlProvider,
|
|
572
568
|
LocaleStorageManager,
|
|
573
|
-
StorageBasedIntlProvider,
|
|
574
569
|
createI18nContext,
|
|
575
|
-
|
|
576
|
-
getTranslation,
|
|
577
|
-
ruleFactory,
|
|
578
|
-
useTranslation
|
|
570
|
+
ruleFactory
|
|
579
571
|
});
|
package/dist/index.mjs
CHANGED
|
@@ -539,10 +539,6 @@ var ruleFactory = (i18nStore) => {
|
|
|
539
539
|
export {
|
|
540
540
|
IntlProvider,
|
|
541
541
|
LocaleStorageManager,
|
|
542
|
-
StorageBasedIntlProvider,
|
|
543
542
|
createI18nContext,
|
|
544
|
-
|
|
545
|
-
getTranslation,
|
|
546
|
-
ruleFactory,
|
|
547
|
-
useTranslation
|
|
543
|
+
ruleFactory
|
|
548
544
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sheet-i18n/react-client",
|
|
3
|
-
"version": "1.6.0-canary.
|
|
3
|
+
"version": "1.6.0-canary.6",
|
|
4
4
|
"description": "a client package for react modules used by sheet-i18n",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
},
|
|
26
26
|
"license": "ISC",
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@sheet-i18n/react-core": "1.6.0-canary.4",
|
|
29
28
|
"@sheet-i18n/shared-utils": "1.8.2",
|
|
30
|
-
"@sheet-i18n/errors": "1.8.1"
|
|
29
|
+
"@sheet-i18n/errors": "1.8.1",
|
|
30
|
+
"@sheet-i18n/react-core": "1.6.0-canary.6"
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
33
|
"@types/react": "^19.0.2",
|