use-intl 2.7.1-alpha.5 → 2.7.2
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/_virtual/use-intl.esm.js +126 -0
- package/dist/_virtual/use-intl.esm.js.map +1 -0
- package/dist/use-intl.cjs.development.js +31 -33
- package/dist/use-intl.cjs.development.js.map +1 -1
- package/dist/use-intl.cjs.production.min.js +1 -1
- package/dist/use-intl.cjs.production.min.js.map +1 -1
- package/dist/use-intl.esm.js +7 -713
- package/dist/use-intl.esm.js.map +1 -1
- package/dist/use-intl.esm10.js +32 -0
- package/dist/use-intl.esm10.js.map +1 -0
- package/dist/use-intl.esm11.js +15 -0
- package/dist/use-intl.esm11.js.map +1 -0
- package/dist/use-intl.esm12.js +213 -0
- package/dist/use-intl.esm12.js.map +1 -0
- package/dist/use-intl.esm13.js +34 -0
- package/dist/use-intl.esm13.js.map +1 -0
- package/dist/use-intl.esm2.js +48 -0
- package/dist/use-intl.esm2.js.map +1 -0
- package/dist/use-intl.esm3.js +34 -0
- package/dist/use-intl.esm3.js.map +1 -0
- package/dist/use-intl.esm4.js +155 -0
- package/dist/use-intl.esm4.js.map +1 -0
- package/dist/use-intl.esm5.js +8 -0
- package/dist/use-intl.esm5.js.map +1 -0
- package/dist/use-intl.esm6.js +50 -0
- package/dist/use-intl.esm6.js.map +1 -0
- package/dist/use-intl.esm7.js +8 -0
- package/dist/use-intl.esm7.js.map +1 -0
- package/dist/use-intl.esm8.js +42 -0
- package/dist/use-intl.esm8.js.map +1 -0
- package/dist/use-intl.esm9.js +6 -0
- package/dist/use-intl.esm9.js.map +1 -0
- package/dist/validateMessages.d.ts +3 -0
- package/package.json +2 -2
- package/src/IntlProvider.tsx +5 -44
- package/src/validateMessages.tsx +43 -0
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
import { extends as _extends } from './_virtual/use-intl.esm.js';
|
|
2
|
+
import IntlError, { IntlErrorCode } from './use-intl.esm8.js';
|
|
3
|
+
import useIntlContext from './use-intl.esm11.js';
|
|
4
|
+
|
|
5
|
+
var MINUTE = 60;
|
|
6
|
+
var HOUR = MINUTE * 60;
|
|
7
|
+
var DAY = HOUR * 24;
|
|
8
|
+
var WEEK = DAY * 7;
|
|
9
|
+
var MONTH = DAY * (365 / 12); // Approximation
|
|
10
|
+
|
|
11
|
+
var YEAR = DAY * 365;
|
|
12
|
+
|
|
13
|
+
function getRelativeTimeFormatConfig(seconds) {
|
|
14
|
+
var absValue = Math.abs(seconds);
|
|
15
|
+
var value, unit; // We have to round the resulting values, as `Intl.RelativeTimeFormat`
|
|
16
|
+
// will include fractions like '2.1 hours ago'.
|
|
17
|
+
|
|
18
|
+
if (absValue < MINUTE) {
|
|
19
|
+
unit = 'second';
|
|
20
|
+
value = Math.round(seconds);
|
|
21
|
+
} else if (absValue < HOUR) {
|
|
22
|
+
unit = 'minute';
|
|
23
|
+
value = Math.round(seconds / MINUTE);
|
|
24
|
+
} else if (absValue < DAY) {
|
|
25
|
+
unit = 'hour';
|
|
26
|
+
value = Math.round(seconds / HOUR);
|
|
27
|
+
} else if (absValue < WEEK) {
|
|
28
|
+
unit = 'day';
|
|
29
|
+
value = Math.round(seconds / DAY);
|
|
30
|
+
} else if (absValue < MONTH) {
|
|
31
|
+
unit = 'week';
|
|
32
|
+
value = Math.round(seconds / WEEK);
|
|
33
|
+
} else if (absValue < YEAR) {
|
|
34
|
+
unit = 'month';
|
|
35
|
+
value = Math.round(seconds / MONTH);
|
|
36
|
+
} else {
|
|
37
|
+
unit = 'year';
|
|
38
|
+
value = Math.round(seconds / YEAR);
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
return {
|
|
42
|
+
value: value,
|
|
43
|
+
unit: unit
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
function useIntl() {
|
|
48
|
+
var _useIntlContext = useIntlContext(),
|
|
49
|
+
formats = _useIntlContext.formats,
|
|
50
|
+
locale = _useIntlContext.locale,
|
|
51
|
+
globalNow = _useIntlContext.now,
|
|
52
|
+
onError = _useIntlContext.onError,
|
|
53
|
+
timeZone = _useIntlContext.timeZone;
|
|
54
|
+
|
|
55
|
+
function resolveFormatOrOptions(typeFormats, formatOrOptions) {
|
|
56
|
+
var options;
|
|
57
|
+
|
|
58
|
+
if (typeof formatOrOptions === 'string') {
|
|
59
|
+
var formatName = formatOrOptions;
|
|
60
|
+
options = typeFormats == null ? void 0 : typeFormats[formatName];
|
|
61
|
+
|
|
62
|
+
if (!options) {
|
|
63
|
+
var error = new IntlError(IntlErrorCode.MISSING_FORMAT, process.env.NODE_ENV !== "production" ? "Format `" + formatName + "` is not available. You can configure it on the provider or provide custom options." : undefined);
|
|
64
|
+
onError(error);
|
|
65
|
+
throw error;
|
|
66
|
+
}
|
|
67
|
+
} else {
|
|
68
|
+
options = formatOrOptions;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
return options;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function getFormattedValue(value, formatOrOptions, typeFormats, formatter) {
|
|
75
|
+
var options;
|
|
76
|
+
|
|
77
|
+
try {
|
|
78
|
+
options = resolveFormatOrOptions(typeFormats, formatOrOptions);
|
|
79
|
+
} catch (error) {
|
|
80
|
+
return String(value);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
try {
|
|
84
|
+
return formatter(options);
|
|
85
|
+
} catch (error) {
|
|
86
|
+
onError(new IntlError(IntlErrorCode.FORMATTING_ERROR, error.message));
|
|
87
|
+
return String(value);
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
function formatDateTime(
|
|
92
|
+
/** If a number is supplied, this is interpreted as a UTC timestamp. */
|
|
93
|
+
value,
|
|
94
|
+
/** If a time zone is supplied, the `value` is converted to that time zone.
|
|
95
|
+
* Otherwise the user time zone will be used. */
|
|
96
|
+
formatOrOptions) {
|
|
97
|
+
return getFormattedValue(value, formatOrOptions, formats == null ? void 0 : formats.dateTime, function (options) {
|
|
98
|
+
var _options;
|
|
99
|
+
|
|
100
|
+
if (timeZone && !((_options = options) != null && _options.timeZone)) {
|
|
101
|
+
options = _extends({}, options, {
|
|
102
|
+
timeZone: timeZone
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
return new Intl.DateTimeFormat(locale, options).format(value);
|
|
107
|
+
});
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
function formatNumber(value, formatOrOptions) {
|
|
111
|
+
return getFormattedValue(value, formatOrOptions, formats == null ? void 0 : formats.number, function (options) {
|
|
112
|
+
return new Intl.NumberFormat(locale, options).format(value);
|
|
113
|
+
});
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
function formatRelativeTime(
|
|
117
|
+
/** The date time that needs to be formatted. */
|
|
118
|
+
date,
|
|
119
|
+
/** The reference point in time to which `date` will be formatted in relation to. */
|
|
120
|
+
now) {
|
|
121
|
+
try {
|
|
122
|
+
if (!now) {
|
|
123
|
+
if (globalNow) {
|
|
124
|
+
now = globalNow;
|
|
125
|
+
} else {
|
|
126
|
+
throw new Error(process.env.NODE_ENV !== "production" ? "The `now` parameter wasn't provided to `formatRelativeTime` and there was no global fallback configured on the provider." : undefined);
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
var dateDate = date instanceof Date ? date : new Date(date);
|
|
131
|
+
var nowDate = now instanceof Date ? now : new Date(now);
|
|
132
|
+
var seconds = (dateDate.getTime() - nowDate.getTime()) / 1000;
|
|
133
|
+
|
|
134
|
+
var _getRelativeTimeForma = getRelativeTimeFormatConfig(seconds),
|
|
135
|
+
unit = _getRelativeTimeForma.unit,
|
|
136
|
+
value = _getRelativeTimeForma.value;
|
|
137
|
+
|
|
138
|
+
return new Intl.RelativeTimeFormat(locale, {
|
|
139
|
+
numeric: 'auto'
|
|
140
|
+
}).format(value, unit);
|
|
141
|
+
} catch (error) {
|
|
142
|
+
onError(new IntlError(IntlErrorCode.FORMATTING_ERROR, error.message));
|
|
143
|
+
return String(date);
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
return {
|
|
148
|
+
formatDateTime: formatDateTime,
|
|
149
|
+
formatNumber: formatNumber,
|
|
150
|
+
formatRelativeTime: formatRelativeTime
|
|
151
|
+
};
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
export { useIntl as default };
|
|
155
|
+
//# sourceMappingURL=use-intl.esm4.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-intl.esm4.js","sources":["../src/useIntl.tsx"],"sourcesContent":["import DateTimeFormatOptions from './DateTimeFormatOptions';\nimport IntlError, {IntlErrorCode} from './IntlError';\nimport NumberFormatOptions from './NumberFormatOptions';\nimport useIntlContext from './useIntlContext';\n\nconst MINUTE = 60;\nconst HOUR = MINUTE * 60;\nconst DAY = HOUR * 24;\nconst WEEK = DAY * 7;\nconst MONTH = DAY * (365 / 12); // Approximation\nconst YEAR = DAY * 365;\n\nfunction getRelativeTimeFormatConfig(seconds: number) {\n const absValue = Math.abs(seconds);\n let value, unit: Intl.RelativeTimeFormatUnit;\n\n // We have to round the resulting values, as `Intl.RelativeTimeFormat`\n // will include fractions like '2.1 hours ago'.\n\n if (absValue < MINUTE) {\n unit = 'second';\n value = Math.round(seconds);\n } else if (absValue < HOUR) {\n unit = 'minute';\n value = Math.round(seconds / MINUTE);\n } else if (absValue < DAY) {\n unit = 'hour';\n value = Math.round(seconds / HOUR);\n } else if (absValue < WEEK) {\n unit = 'day';\n value = Math.round(seconds / DAY);\n } else if (absValue < MONTH) {\n unit = 'week';\n value = Math.round(seconds / WEEK);\n } else if (absValue < YEAR) {\n unit = 'month';\n value = Math.round(seconds / MONTH);\n } else {\n unit = 'year';\n value = Math.round(seconds / YEAR);\n }\n\n return {value, unit};\n}\n\nexport default function useIntl() {\n const {formats, locale, now: globalNow, onError, timeZone} = useIntlContext();\n\n function resolveFormatOrOptions<Options>(\n typeFormats: Record<string, Options> | undefined,\n formatOrOptions?: string | Options\n ) {\n let options;\n if (typeof formatOrOptions === 'string') {\n const formatName = formatOrOptions;\n options = typeFormats?.[formatName];\n\n if (!options) {\n const error = new IntlError(\n IntlErrorCode.MISSING_FORMAT,\n __DEV__\n ? `Format \\`${formatName}\\` is not available. You can configure it on the provider or provide custom options.`\n : undefined\n );\n onError(error);\n throw error;\n }\n } else {\n options = formatOrOptions;\n }\n\n return options;\n }\n\n function getFormattedValue<Value, Options>(\n value: Value,\n formatOrOptions: string | Options | undefined,\n typeFormats: Record<string, Options> | undefined,\n formatter: (options?: Options) => string\n ) {\n let options;\n try {\n options = resolveFormatOrOptions(typeFormats, formatOrOptions);\n } catch (error) {\n return String(value);\n }\n\n try {\n return formatter(options);\n } catch (error) {\n onError(\n new IntlError(IntlErrorCode.FORMATTING_ERROR, (error as Error).message)\n );\n return String(value);\n }\n }\n\n function formatDateTime(\n /** If a number is supplied, this is interpreted as a UTC timestamp. */\n value: Date | number,\n /** If a time zone is supplied, the `value` is converted to that time zone.\n * Otherwise the user time zone will be used. */\n formatOrOptions?: string | DateTimeFormatOptions\n ) {\n return getFormattedValue(\n value,\n formatOrOptions,\n formats?.dateTime,\n (options) => {\n if (timeZone && !options?.timeZone) {\n options = {...options, timeZone};\n }\n\n return new Intl.DateTimeFormat(locale, options).format(value);\n }\n );\n }\n\n function formatNumber(\n value: number,\n formatOrOptions?: string | NumberFormatOptions\n ) {\n return getFormattedValue(\n value,\n formatOrOptions,\n formats?.number,\n (options) => new Intl.NumberFormat(locale, options).format(value)\n );\n }\n\n function formatRelativeTime(\n /** The date time that needs to be formatted. */\n date: number | Date,\n /** The reference point in time to which `date` will be formatted in relation to. */\n now?: number | Date\n ) {\n try {\n if (!now) {\n if (globalNow) {\n now = globalNow;\n } else {\n throw new Error(\n __DEV__\n ? `The \\`now\\` parameter wasn't provided to \\`formatRelativeTime\\` and there was no global fallback configured on the provider.`\n : undefined\n );\n }\n }\n\n const dateDate = date instanceof Date ? date : new Date(date);\n const nowDate = now instanceof Date ? now : new Date(now);\n\n const seconds = (dateDate.getTime() - nowDate.getTime()) / 1000;\n const {unit, value} = getRelativeTimeFormatConfig(seconds);\n\n return new Intl.RelativeTimeFormat(locale, {\n numeric: 'auto'\n }).format(value, unit);\n } catch (error) {\n onError(\n new IntlError(IntlErrorCode.FORMATTING_ERROR, (error as Error).message)\n );\n return String(date);\n }\n }\n\n return {formatDateTime, formatNumber, formatRelativeTime};\n}\n"],"names":["MINUTE","HOUR","DAY","WEEK","MONTH","YEAR","getRelativeTimeFormatConfig","seconds","absValue","Math","abs","value","unit","round","useIntl","useIntlContext","formats","locale","globalNow","now","onError","timeZone","resolveFormatOrOptions","typeFormats","formatOrOptions","options","formatName","error","IntlError","IntlErrorCode","MISSING_FORMAT","undefined","getFormattedValue","formatter","String","FORMATTING_ERROR","message","formatDateTime","dateTime","Intl","DateTimeFormat","format","formatNumber","number","NumberFormat","formatRelativeTime","date","Error","dateDate","Date","nowDate","getTime","RelativeTimeFormat","numeric"],"mappings":";;;;AAKA,IAAMA,MAAM,GAAG,EAAf,CAAA;AACA,IAAMC,IAAI,GAAGD,MAAM,GAAG,EAAtB,CAAA;AACA,IAAME,GAAG,GAAGD,IAAI,GAAG,EAAnB,CAAA;AACA,IAAME,IAAI,GAAGD,GAAG,GAAG,CAAnB,CAAA;AACA,IAAME,KAAK,GAAGF,GAAG,IAAI,MAAM,EAAV,CAAjB;;AACA,IAAMG,IAAI,GAAGH,GAAG,GAAG,GAAnB,CAAA;;AAEA,SAASI,2BAAT,CAAqCC,OAArC,EAAoD;AAClD,EAAA,IAAMC,QAAQ,GAAGC,IAAI,CAACC,GAAL,CAASH,OAAT,CAAjB,CAAA;AACA,EAAA,IAAII,KAAJ,EAAWC,IAAX,CAFkD;AAKlD;;AAEA,EAAIJ,IAAAA,QAAQ,GAAGR,MAAf,EAAuB;AACrBY,IAAAA,IAAI,GAAG,QAAP,CAAA;AACAD,IAAAA,KAAK,GAAGF,IAAI,CAACI,KAAL,CAAWN,OAAX,CAAR,CAAA;AACD,GAHD,MAGO,IAAIC,QAAQ,GAAGP,IAAf,EAAqB;AAC1BW,IAAAA,IAAI,GAAG,QAAP,CAAA;AACAD,IAAAA,KAAK,GAAGF,IAAI,CAACI,KAAL,CAAWN,OAAO,GAAGP,MAArB,CAAR,CAAA;AACD,GAHM,MAGA,IAAIQ,QAAQ,GAAGN,GAAf,EAAoB;AACzBU,IAAAA,IAAI,GAAG,MAAP,CAAA;AACAD,IAAAA,KAAK,GAAGF,IAAI,CAACI,KAAL,CAAWN,OAAO,GAAGN,IAArB,CAAR,CAAA;AACD,GAHM,MAGA,IAAIO,QAAQ,GAAGL,IAAf,EAAqB;AAC1BS,IAAAA,IAAI,GAAG,KAAP,CAAA;AACAD,IAAAA,KAAK,GAAGF,IAAI,CAACI,KAAL,CAAWN,OAAO,GAAGL,GAArB,CAAR,CAAA;AACD,GAHM,MAGA,IAAIM,QAAQ,GAAGJ,KAAf,EAAsB;AAC3BQ,IAAAA,IAAI,GAAG,MAAP,CAAA;AACAD,IAAAA,KAAK,GAAGF,IAAI,CAACI,KAAL,CAAWN,OAAO,GAAGJ,IAArB,CAAR,CAAA;AACD,GAHM,MAGA,IAAIK,QAAQ,GAAGH,IAAf,EAAqB;AAC1BO,IAAAA,IAAI,GAAG,OAAP,CAAA;AACAD,IAAAA,KAAK,GAAGF,IAAI,CAACI,KAAL,CAAWN,OAAO,GAAGH,KAArB,CAAR,CAAA;AACD,GAHM,MAGA;AACLQ,IAAAA,IAAI,GAAG,MAAP,CAAA;AACAD,IAAAA,KAAK,GAAGF,IAAI,CAACI,KAAL,CAAWN,OAAO,GAAGF,IAArB,CAAR,CAAA;AACD,GAAA;;AAED,EAAO,OAAA;AAACM,IAAAA,KAAK,EAALA,KAAD;AAAQC,IAAAA,IAAI,EAAJA,IAAAA;AAAR,GAAP,CAAA;AACD,CAAA;;AAEa,SAAUE,OAAV,GAAiB;AAC7B,EAAA,IAAA,eAAA,GAA6DC,cAAc,EAA3E;AAAA,MAAOC,OAAP,mBAAOA,OAAP;AAAA,MAAgBC,MAAhB,mBAAgBA,MAAhB;AAAA,MAA6BC,SAA7B,mBAAwBC,GAAxB;AAAA,MAAwCC,OAAxC,mBAAwCA,OAAxC;AAAA,MAAiDC,QAAjD,mBAAiDA,QAAjD,CAAA;;AAEA,EAAA,SAASC,sBAAT,CACEC,WADF,EAEEC,eAFF,EAEoC;AAElC,IAAA,IAAIC,OAAJ,CAAA;;AACA,IAAA,IAAI,OAAOD,eAAP,KAA2B,QAA/B,EAAyC;AACvC,MAAME,IAAAA,UAAU,GAAGF,eAAnB,CAAA;AACAC,MAAAA,OAAO,GAAGF,WAAH,oBAAGA,WAAW,CAAGG,UAAH,CAArB,CAAA;;AAEA,MAAI,IAAA,CAACD,OAAL,EAAc;AACZ,QAAA,IAAME,KAAK,GAAG,IAAIC,SAAJ,CACZC,aAAa,CAACC,cADF,EAEZ,OAAA,CAAA,GAAA,CAAA,QAAA,KAAA,YAAA,GAAA,UAAA,GACgBJ,UADhB,GAAA,qFAAA,GAEIK,SAJQ,CAAd,CAAA;AAMAX,QAAAA,OAAO,CAACO,KAAD,CAAP,CAAA;AACA,QAAA,MAAMA,KAAN,CAAA;AACD,OAAA;AACF,KAdD,MAcO;AACLF,MAAAA,OAAO,GAAGD,eAAV,CAAA;AACD,KAAA;;AAED,IAAA,OAAOC,OAAP,CAAA;AACD,GAAA;;AAED,EAASO,SAAAA,iBAAT,CACErB,KADF,EAEEa,eAFF,EAGED,WAHF,EAIEU,SAJF,EAI0C;AAExC,IAAA,IAAIR,OAAJ,CAAA;;AACA,IAAI,IAAA;AACFA,MAAAA,OAAO,GAAGH,sBAAsB,CAACC,WAAD,EAAcC,eAAd,CAAhC,CAAA;AACD,KAFD,CAEE,OAAOG,KAAP,EAAc;AACd,MAAOO,OAAAA,MAAM,CAACvB,KAAD,CAAb,CAAA;AACD,KAAA;;AAED,IAAI,IAAA;AACF,MAAOsB,OAAAA,SAAS,CAACR,OAAD,CAAhB,CAAA;AACD,KAFD,CAEE,OAAOE,KAAP,EAAc;AACdP,MAAAA,OAAO,CACL,IAAIQ,SAAJ,CAAcC,aAAa,CAACM,gBAA5B,EAA+CR,KAAe,CAACS,OAA/D,CADK,CAAP,CAAA;AAGA,MAAOF,OAAAA,MAAM,CAACvB,KAAD,CAAb,CAAA;AACD,KAAA;AACF,GAAA;;AAED,EAAA,SAAS0B,cAAT;AACE;AACA1B,EAAAA,KAFF;AAGE;AACgD;AAChDa,EAAAA,eALF,EAKkD;AAEhD,IAAA,OAAOQ,iBAAiB,CACtBrB,KADsB,EAEtBa,eAFsB,EAGtBR,OAHsB,IAGtBA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,OAAO,CAAEsB,QAHa,EAItB,UAACb,OAAD,EAAY;AAAA,MAAA,IAAA,QAAA,CAAA;;AACV,MAAIJ,IAAAA,QAAQ,IAAI,EAACI,CAAAA,QAAAA,GAAAA,OAAD,aAAC,QAASJ,CAAAA,QAAV,CAAhB,EAAoC;AAClCI,QAAAA,OAAO,gBAAOA,OAAP,EAAA;AAAgBJ,UAAAA,QAAQ,EAARA,QAAAA;AAAhB,SAAP,CAAA,CAAA;AACD,OAAA;;AAED,MAAA,OAAO,IAAIkB,IAAI,CAACC,cAAT,CAAwBvB,MAAxB,EAAgCQ,OAAhC,CAAyCgB,CAAAA,MAAzC,CAAgD9B,KAAhD,CAAP,CAAA;AACD,KAVqB,CAAxB,CAAA;AAYD,GAAA;;AAED,EAAA,SAAS+B,YAAT,CACE/B,KADF,EAEEa,eAFF,EAEgD;AAE9C,IAAA,OAAOQ,iBAAiB,CACtBrB,KADsB,EAEtBa,eAFsB,EAGtBR,OAHsB,IAAA,IAAA,GAAA,KAAA,CAAA,GAGtBA,OAAO,CAAE2B,MAHa,EAItB,UAAClB,OAAD,EAAA;AAAA,MAAA,OAAa,IAAIc,IAAI,CAACK,YAAT,CAAsB3B,MAAtB,EAA8BQ,OAA9B,CAAuCgB,CAAAA,MAAvC,CAA8C9B,KAA9C,CAAb,CAAA;AAAA,KAJsB,CAAxB,CAAA;AAMD,GAAA;;AAED,EAAA,SAASkC,kBAAT;AACE;AACAC,EAAAA,IAFF;AAGE;AACA3B,EAAAA,GAJF,EAIqB;AAEnB,IAAI,IAAA;AACF,MAAI,IAAA,CAACA,GAAL,EAAU;AACR,QAAA,IAAID,SAAJ,EAAe;AACbC,UAAAA,GAAG,GAAGD,SAAN,CAAA;AACD,SAFD,MAEO;AACL,UAAA,MAAM,IAAI6B,KAAJ,CACJ,OAAA,CAAA,GAAA,CAAA,QAAA,KAAA,YAAA,GAAA,0HAAA,GAEIhB,SAHA,CAAN,CAAA;AAKD,SAAA;AACF,OAAA;;AAED,MAAA,IAAMiB,QAAQ,GAAGF,IAAI,YAAYG,IAAhB,GAAuBH,IAAvB,GAA8B,IAAIG,IAAJ,CAASH,IAAT,CAA/C,CAAA;AACA,MAAA,IAAMI,OAAO,GAAG/B,GAAG,YAAY8B,IAAf,GAAsB9B,GAAtB,GAA4B,IAAI8B,IAAJ,CAAS9B,GAAT,CAA5C,CAAA;AAEA,MAAA,IAAMZ,OAAO,GAAG,CAACyC,QAAQ,CAACG,OAAT,EAAqBD,GAAAA,OAAO,CAACC,OAAR,EAAtB,IAA2C,IAA3D,CAAA;;AACA,MAAsB7C,IAAAA,qBAAAA,GAAAA,2BAA2B,CAACC,OAAD,CAAjD;AAAA,UAAOK,IAAP,yBAAOA,IAAP;AAAA,UAAaD,KAAb,yBAAaA,KAAb,CAAA;;AAEA,MAAA,OAAO,IAAI4B,IAAI,CAACa,kBAAT,CAA4BnC,MAA5B,EAAoC;AACzCoC,QAAAA,OAAO,EAAE,MAAA;AADgC,OAApC,EAEJZ,MAFI,CAEG9B,KAFH,EAEUC,IAFV,CAAP,CAAA;AAGD,KAtBD,CAsBE,OAAOe,KAAP,EAAc;AACdP,MAAAA,OAAO,CACL,IAAIQ,SAAJ,CAAcC,aAAa,CAACM,gBAA5B,EAA+CR,KAAe,CAACS,OAA/D,CADK,CAAP,CAAA;AAGA,MAAOF,OAAAA,MAAM,CAACY,IAAD,CAAb,CAAA;AACD,KAAA;AACF,GAAA;;AAED,EAAO,OAAA;AAACT,IAAAA,cAAc,EAAdA,cAAD;AAAiBK,IAAAA,YAAY,EAAZA,YAAjB;AAA+BG,IAAAA,kBAAkB,EAAlBA,kBAAAA;AAA/B,GAAP,CAAA;AACD;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-intl.esm5.js","sources":["../src/useLocale.tsx"],"sourcesContent":["import useIntlContext from './useIntlContext';\n\nexport default function useLocale() {\n return useIntlContext().locale;\n}\n"],"names":["useLocale","useIntlContext","locale"],"mappings":";;AAEc,SAAUA,SAAV,GAAmB;AAC/B,EAAOC,OAAAA,cAAc,GAAGC,MAAxB,CAAA;AACD;;;;"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { useState, useEffect } from 'react';
|
|
2
|
+
import useIntlContext from './use-intl.esm11.js';
|
|
3
|
+
|
|
4
|
+
function getNow() {
|
|
5
|
+
return new Date();
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Reading the current date via `new Date()` in components should be avoided, as
|
|
9
|
+
* it causes components to be impure and can lead to flaky tests. Instead, this
|
|
10
|
+
* hook can be used.
|
|
11
|
+
*
|
|
12
|
+
* By default, it returns the time when the component mounts. If `updateInterval`
|
|
13
|
+
* is specified, the value will be updated based on the interval.
|
|
14
|
+
*
|
|
15
|
+
* You can however also return a static value from this hook, if you
|
|
16
|
+
* configure the `now` parameter on the context provider. Note however,
|
|
17
|
+
* that if `updateInterval` is configured in this case, the component
|
|
18
|
+
* will initialize with the global value, but will afterwards update
|
|
19
|
+
* continuously based on the interval.
|
|
20
|
+
*
|
|
21
|
+
* For unit tests, this can be mocked to a constant value. For end-to-end
|
|
22
|
+
* testing, an environment parameter can be passed to the `now` parameter
|
|
23
|
+
* of the provider to mock this to a static value.
|
|
24
|
+
*/
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
function useNow(options) {
|
|
28
|
+
var updateInterval = options == null ? void 0 : options.updateInterval;
|
|
29
|
+
|
|
30
|
+
var _useIntlContext = useIntlContext(),
|
|
31
|
+
globalNow = _useIntlContext.now;
|
|
32
|
+
|
|
33
|
+
var _useState = useState(globalNow || getNow()),
|
|
34
|
+
now = _useState[0],
|
|
35
|
+
setNow = _useState[1];
|
|
36
|
+
|
|
37
|
+
useEffect(function () {
|
|
38
|
+
if (!updateInterval) return;
|
|
39
|
+
var intervalId = setInterval(function () {
|
|
40
|
+
setNow(getNow());
|
|
41
|
+
}, updateInterval);
|
|
42
|
+
return function () {
|
|
43
|
+
clearInterval(intervalId);
|
|
44
|
+
};
|
|
45
|
+
}, [globalNow, updateInterval]);
|
|
46
|
+
return now;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
export { useNow as default };
|
|
50
|
+
//# sourceMappingURL=use-intl.esm6.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-intl.esm6.js","sources":["../src/useNow.tsx"],"sourcesContent":["import {useState, useEffect} from 'react';\nimport useIntlContext from './useIntlContext';\n\ntype Options = {\n updateInterval?: number;\n};\n\nfunction getNow() {\n return new Date();\n}\n\n/**\n * Reading the current date via `new Date()` in components should be avoided, as\n * it causes components to be impure and can lead to flaky tests. Instead, this\n * hook can be used.\n *\n * By default, it returns the time when the component mounts. If `updateInterval`\n * is specified, the value will be updated based on the interval.\n *\n * You can however also return a static value from this hook, if you\n * configure the `now` parameter on the context provider. Note however,\n * that if `updateInterval` is configured in this case, the component\n * will initialize with the global value, but will afterwards update\n * continuously based on the interval.\n *\n * For unit tests, this can be mocked to a constant value. For end-to-end\n * testing, an environment parameter can be passed to the `now` parameter\n * of the provider to mock this to a static value.\n */\nexport default function useNow(options?: Options) {\n const updateInterval = options?.updateInterval;\n\n const {now: globalNow} = useIntlContext();\n const [now, setNow] = useState(globalNow || getNow());\n\n useEffect(() => {\n if (!updateInterval) return;\n\n const intervalId = setInterval(() => {\n setNow(getNow());\n }, updateInterval);\n\n return () => {\n clearInterval(intervalId);\n };\n }, [globalNow, updateInterval]);\n\n return now;\n}\n"],"names":["getNow","Date","useNow","options","updateInterval","useIntlContext","globalNow","now","useState","setNow","useEffect","intervalId","setInterval","clearInterval"],"mappings":";;;AAOA,SAASA,MAAT,GAAe;AACb,EAAO,OAAA,IAAIC,IAAJ,EAAP,CAAA;AACD,CAAA;AAED;;;;;;;;;;;;;;;;;AAiBG;;;AACqB,SAAAC,MAAA,CAAOC,OAAP,EAAwB;AAC9C,EAAA,IAAMC,cAAc,GAAGD,OAAH,IAAGA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,OAAO,CAAEC,cAAhC,CAAA;;AAEA,EAAA,IAAA,eAAA,GAAyBC,cAAc,EAAvC;AAAA,MAAYC,SAAZ,mBAAOC,GAAP,CAAA;;AACA,EAAA,IAAA,SAAA,GAAsBC,QAAQ,CAACF,SAAS,IAAIN,MAAM,EAApB,CAA9B;AAAA,MAAOO,GAAP,GAAA,SAAA,CAAA,CAAA,CAAA;AAAA,MAAYE,MAAZ,GAAA,SAAA,CAAA,CAAA,CAAA,CAAA;;AAEAC,EAAAA,SAAS,CAAC,YAAK;AACb,IAAI,IAAA,CAACN,cAAL,EAAqB,OAAA;AAErB,IAAA,IAAMO,UAAU,GAAGC,WAAW,CAAC,YAAK;AAClCH,MAAAA,MAAM,CAACT,MAAM,EAAP,CAAN,CAAA;AACD,KAF6B,EAE3BI,cAF2B,CAA9B,CAAA;AAIA,IAAA,OAAO,YAAK;AACVS,MAAAA,aAAa,CAACF,UAAD,CAAb,CAAA;AACD,KAFD,CAAA;AAGD,GAVQ,EAUN,CAACL,SAAD,EAAYF,cAAZ,CAVM,CAAT,CAAA;AAYA,EAAA,OAAOG,GAAP,CAAA;AACD;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-intl.esm7.js","sources":["../src/useTimeZone.tsx"],"sourcesContent":["import useIntlContext from './useIntlContext';\n\nexport default function useTimeZone() {\n return useIntlContext().timeZone;\n}\n"],"names":["useTimeZone","useIntlContext","timeZone"],"mappings":";;AAEc,SAAUA,WAAV,GAAqB;AACjC,EAAOC,OAAAA,cAAc,GAAGC,QAAxB,CAAA;AACD;;;;"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import { inheritsLoose as _inheritsLoose, wrapNativeSuper as _wrapNativeSuper } from './_virtual/use-intl.esm.js';
|
|
2
|
+
|
|
3
|
+
var IntlErrorCode;
|
|
4
|
+
|
|
5
|
+
(function (IntlErrorCode) {
|
|
6
|
+
IntlErrorCode["MISSING_MESSAGE"] = "MISSING_MESSAGE";
|
|
7
|
+
IntlErrorCode["MISSING_FORMAT"] = "MISSING_FORMAT";
|
|
8
|
+
IntlErrorCode["INSUFFICIENT_PATH"] = "INSUFFICIENT_PATH";
|
|
9
|
+
IntlErrorCode["INVALID_MESSAGE"] = "INVALID_MESSAGE";
|
|
10
|
+
IntlErrorCode["INVALID_KEY"] = "INVALID_KEY";
|
|
11
|
+
IntlErrorCode["FORMATTING_ERROR"] = "FORMATTING_ERROR";
|
|
12
|
+
})(IntlErrorCode || (IntlErrorCode = {}));
|
|
13
|
+
|
|
14
|
+
var IntlError = /*#__PURE__*/function (_Error) {
|
|
15
|
+
_inheritsLoose(IntlError, _Error);
|
|
16
|
+
|
|
17
|
+
function IntlError(code, originalMessage) {
|
|
18
|
+
var _this;
|
|
19
|
+
|
|
20
|
+
var message = code;
|
|
21
|
+
|
|
22
|
+
if (originalMessage) {
|
|
23
|
+
message += ': ' + originalMessage;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
_this = _Error.call(this, message) || this;
|
|
27
|
+
_this.code = void 0;
|
|
28
|
+
_this.originalMessage = void 0;
|
|
29
|
+
_this.code = code;
|
|
30
|
+
|
|
31
|
+
if (originalMessage) {
|
|
32
|
+
_this.originalMessage = originalMessage;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return _this;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
return IntlError;
|
|
39
|
+
}( /*#__PURE__*/_wrapNativeSuper(Error));
|
|
40
|
+
|
|
41
|
+
export { IntlErrorCode, IntlError as default };
|
|
42
|
+
//# sourceMappingURL=use-intl.esm8.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-intl.esm8.js","sources":["../src/IntlError.tsx"],"sourcesContent":["export enum IntlErrorCode {\n MISSING_MESSAGE = 'MISSING_MESSAGE',\n MISSING_FORMAT = 'MISSING_FORMAT',\n INSUFFICIENT_PATH = 'INSUFFICIENT_PATH',\n INVALID_MESSAGE = 'INVALID_MESSAGE',\n INVALID_KEY = 'INVALID_KEY',\n FORMATTING_ERROR = 'FORMATTING_ERROR'\n}\n\nexport default class IntlError extends Error {\n public readonly code: IntlErrorCode;\n public readonly originalMessage: string | undefined;\n\n constructor(code: IntlErrorCode, originalMessage?: string) {\n let message: string = code;\n if (originalMessage) {\n message += ': ' + originalMessage;\n }\n super(message);\n\n this.code = code;\n if (originalMessage) {\n this.originalMessage = originalMessage;\n }\n }\n}\n"],"names":["IntlErrorCode","IntlError","code","originalMessage","message","Error"],"mappings":";;IAAYA,cAAZ;;AAAA,CAAA,UAAYA,aAAZ,EAAyB;AACvBA,EAAAA,aAAA,CAAA,iBAAA,CAAA,GAAA,iBAAA,CAAA;AACAA,EAAAA,aAAA,CAAA,gBAAA,CAAA,GAAA,gBAAA,CAAA;AACAA,EAAAA,aAAA,CAAA,mBAAA,CAAA,GAAA,mBAAA,CAAA;AACAA,EAAAA,aAAA,CAAA,iBAAA,CAAA,GAAA,iBAAA,CAAA;AACAA,EAAAA,aAAA,CAAA,aAAA,CAAA,GAAA,aAAA,CAAA;AACAA,EAAAA,aAAA,CAAA,kBAAA,CAAA,GAAA,kBAAA,CAAA;AACD,CAPD,EAAYA,aAAa,KAAbA,aAAa,GAOxB,EAPwB,CAAzB,CAAA,CAAA;;IASqBC;;;AAInB,EAAYC,SAAAA,SAAAA,CAAAA,IAAZ,EAAiCC,eAAjC,EAAyD;AAAA,IAAA,IAAA,KAAA,CAAA;;AACvD,IAAIC,IAAAA,OAAO,GAAWF,IAAtB,CAAA;;AACA,IAAA,IAAIC,eAAJ,EAAqB;AACnBC,MAAAA,OAAO,IAAI,IAAA,GAAOD,eAAlB,CAAA;AACD,KAAA;;AACD,IAAA,KAAA,GAAA,MAAA,CAAA,IAAA,CAAA,IAAA,EAAMC,OAAN,CAAA,IAAA,IAAA,CAAA;AALuD,IAAA,KAAA,CAHzCF,IAGyC,GAAA,KAAA,CAAA,CAAA;AAAA,IAAA,KAAA,CAFzCC,eAEyC,GAAA,KAAA,CAAA,CAAA;AAOvD,IAAKD,KAAAA,CAAAA,IAAL,GAAYA,IAAZ,CAAA;;AACA,IAAA,IAAIC,eAAJ,EAAqB;AACnB,MAAKA,KAAAA,CAAAA,eAAL,GAAuBA,eAAvB,CAAA;AACD,KAAA;;AAVsD,IAAA,OAAA,KAAA,CAAA;AAWxD,GAAA;;;iCAfoCE;;;;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"use-intl.esm9.js","sources":["../src/IntlContext.tsx"],"sourcesContent":["import {createContext} from 'react';\nimport AbstractIntlMessages from './AbstractIntlMessages';\nimport Formats from './Formats';\nimport IntlError from './IntlError';\nimport {RichTranslationValues} from './TranslationValues';\n\nexport type IntlContextShape = {\n messages?: AbstractIntlMessages;\n locale: string;\n formats?: Partial<Formats>;\n timeZone?: string;\n onError(error: IntlError): void;\n getMessageFallback(info: {\n error: IntlError;\n key: string;\n namespace?: string;\n }): string;\n now?: Date;\n defaultTranslationValues?: RichTranslationValues;\n};\n\nconst IntlContext = createContext<IntlContextShape | undefined>(undefined);\n\nexport default IntlContext;\n"],"names":["IntlContext","createContext","undefined"],"mappings":";;AAqBA,IAAMA,WAAW,gBAAGC,aAAa,CAA+BC,SAA/B;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "use-intl",
|
|
3
|
-
"version": "2.7.
|
|
3
|
+
"version": "2.7.2",
|
|
4
4
|
"sideEffects": false,
|
|
5
5
|
"author": "Jan Amann <jan@amann.me>",
|
|
6
6
|
"description": "Minimal, but complete solution for managing internationalization in React apps.",
|
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
"engines": {
|
|
60
60
|
"node": ">=10"
|
|
61
61
|
},
|
|
62
|
-
"gitHead": "
|
|
62
|
+
"gitHead": "0e4dd6047240d66186b376eaf9c9b6d18dee3c53"
|
|
63
63
|
}
|
package/src/IntlProvider.tsx
CHANGED
|
@@ -2,8 +2,9 @@ import React, {ReactNode, useEffect} from 'react';
|
|
|
2
2
|
import AbstractIntlMessages from './AbstractIntlMessages';
|
|
3
3
|
import Formats from './Formats';
|
|
4
4
|
import IntlContext from './IntlContext';
|
|
5
|
-
import IntlError
|
|
5
|
+
import IntlError from './IntlError';
|
|
6
6
|
import {RichTranslationValues} from './TranslationValues';
|
|
7
|
+
import validateMessages from './validateMessages';
|
|
7
8
|
|
|
8
9
|
type Props = {
|
|
9
10
|
/** All messages that will be available in your components. */
|
|
@@ -67,58 +68,18 @@ export default function IntlProvider({
|
|
|
67
68
|
messages,
|
|
68
69
|
...contextValues
|
|
69
70
|
}: Props) {
|
|
70
|
-
// Validation of the namespace keys is currently inlined as the bundler that
|
|
71
|
-
// Bundlephobia uses is apparently not smart enough to throw the import out if
|
|
72
|
-
// this is imported from a separate module.
|
|
73
71
|
if (__DEV__) {
|
|
74
72
|
// eslint-disable-next-line react-hooks/rules-of-hooks
|
|
75
73
|
useEffect(() => {
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
invalidKeyLabels: Array<string>,
|
|
79
|
-
parentPath?: string
|
|
80
|
-
) {
|
|
81
|
-
Object.entries(messagesPart).forEach(([key, messageOrMessages]) => {
|
|
82
|
-
if (key.includes('.')) {
|
|
83
|
-
let keyLabel = key;
|
|
84
|
-
if (parentPath) keyLabel += ` (at ${parentPath})`;
|
|
85
|
-
invalidKeyLabels.push(keyLabel);
|
|
86
|
-
}
|
|
87
|
-
if (typeof messageOrMessages === 'object') {
|
|
88
|
-
validateMessagesSegment(
|
|
89
|
-
messageOrMessages,
|
|
90
|
-
invalidKeyLabels,
|
|
91
|
-
[parentPath, key].filter((part) => part != null).join('.')
|
|
92
|
-
);
|
|
93
|
-
}
|
|
94
|
-
});
|
|
74
|
+
if (messages) {
|
|
75
|
+
validateMessages(messages, onError);
|
|
95
76
|
}
|
|
96
|
-
|
|
97
|
-
function validateMessages() {
|
|
98
|
-
if (!messages) return;
|
|
99
|
-
|
|
100
|
-
const invalidKeyLabels: Array<string> = [];
|
|
101
|
-
validateMessagesSegment(messages, invalidKeyLabels);
|
|
102
|
-
|
|
103
|
-
if (invalidKeyLabels.length > 0) {
|
|
104
|
-
onError(
|
|
105
|
-
new IntlError(
|
|
106
|
-
IntlErrorCode.INVALID_KEY,
|
|
107
|
-
`Namespace keys can not contain the character "." as this is used to express nesting. Please remove it or replace it with another character.\n\nInvalid ${
|
|
108
|
-
invalidKeyLabels.length === 1 ? 'key' : 'keys'
|
|
109
|
-
}: ${invalidKeyLabels.join(', ')}`
|
|
110
|
-
)
|
|
111
|
-
);
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
validateMessages();
|
|
116
77
|
}, [messages, onError]);
|
|
117
78
|
}
|
|
118
79
|
|
|
119
80
|
return (
|
|
120
81
|
<IntlContext.Provider
|
|
121
|
-
value={{...contextValues,
|
|
82
|
+
value={{...contextValues, messages, onError, getMessageFallback}}
|
|
122
83
|
>
|
|
123
84
|
{children}
|
|
124
85
|
</IntlContext.Provider>
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import AbstractIntlMessages from './AbstractIntlMessages';
|
|
2
|
+
import IntlError, {IntlErrorCode} from './IntlError';
|
|
3
|
+
|
|
4
|
+
function validateMessagesSegment(
|
|
5
|
+
messages: AbstractIntlMessages,
|
|
6
|
+
invalidKeyLabels: Array<string>,
|
|
7
|
+
parentPath?: string
|
|
8
|
+
) {
|
|
9
|
+
Object.entries(messages).forEach(([key, messageOrMessages]) => {
|
|
10
|
+
if (key.includes('.')) {
|
|
11
|
+
let keyLabel = key;
|
|
12
|
+
if (parentPath) keyLabel += ` (at ${parentPath})`;
|
|
13
|
+
invalidKeyLabels.push(keyLabel);
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
if (messageOrMessages != null && typeof messageOrMessages === 'object') {
|
|
17
|
+
validateMessagesSegment(
|
|
18
|
+
messageOrMessages,
|
|
19
|
+
invalidKeyLabels,
|
|
20
|
+
[parentPath, key].filter((part) => part != null).join('.')
|
|
21
|
+
);
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export default function validateMessages(
|
|
27
|
+
messages: AbstractIntlMessages,
|
|
28
|
+
onError: (error: IntlError) => void
|
|
29
|
+
) {
|
|
30
|
+
const invalidKeyLabels: Array<string> = [];
|
|
31
|
+
validateMessagesSegment(messages, invalidKeyLabels);
|
|
32
|
+
|
|
33
|
+
if (invalidKeyLabels.length > 0) {
|
|
34
|
+
onError(
|
|
35
|
+
new IntlError(
|
|
36
|
+
IntlErrorCode.INVALID_KEY,
|
|
37
|
+
`Namespace keys can not contain the character "." as this is used to express nesting. Please remove it or replace it with another character.\n\nInvalid ${
|
|
38
|
+
invalidKeyLabels.length === 1 ? 'key' : 'keys'
|
|
39
|
+
}: ${invalidKeyLabels.join(', ')}`
|
|
40
|
+
)
|
|
41
|
+
);
|
|
42
|
+
}
|
|
43
|
+
}
|