generated from sapphiredev/sapphire-template
-
-
Notifications
You must be signed in to change notification settings - Fork 35
/
InternationalizationHandler.ts
255 lines (225 loc) · 8.54 KB
/
InternationalizationHandler.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
import { fromAsync, isErr } from '@sapphire/framework';
import { container, getRootData } from '@sapphire/pieces';
import { Awaitable, isFunction, NonNullObject } from '@sapphire/utilities';
import { Backend, PathResolvable } from '@skyra/i18next-backend';
import i18next, { StringMap, TFunction, TFunctionKeys, TFunctionResult, TOptions } from 'i18next';
import type { PathLike } from 'node:fs';
import { opendir } from 'node:fs/promises';
import { join } from 'node:path';
import type { InternationalizationContext, InternationalizationOptions } from './types';
/**
* A generalized class for handling `i18next` JSON files and their discovery.
* @since 1.0.0
*/
export class InternationalizationHandler {
/**
* Describes whether {@link InternationalizationHandler.init} has been run and languages are loaded in {@link InternationalizationHandler.languages}.
* @since 1.0.0
*/
public languagesLoaded = false;
/**
* A `Set` of initially loaded namespaces.
* @since 1.2.0
*/
public namespaces = new Set<string>();
/**
* A `Map` of `i18next` language functions keyed by their language code.
* @since 1.0.0
*/
public readonly languages = new Map<string, TFunction>();
/**
* The options InternationalizationHandler was initialized with in the client.
* @since 1.0.0
*/
public readonly options: InternationalizationOptions;
/**
* The director passed to `@skyra/i18next-backend`.
* Also used in {@link InternationalizationHandler.walkLanguageDirectory}.
* @since 1.2.0
*/
public readonly languagesDirectory: string;
/**
* The backend options for `@skyra/i18next-backend` used by `i18next`.
* @since 1.0.0
*/
protected readonly backendOptions: Backend.Options;
/**
* @param options The options that `i18next`, `@skyra/i18next-backend`, and {@link InternationalizationHandler} should use.
* @since 1.0.0
* @constructor
*/
public constructor(options?: InternationalizationOptions) {
this.options = options ?? { i18next: { ignoreJSONStructure: false } };
this.languagesDirectory =
this.options.defaultLanguageDirectory ?? join(container.client?.options?.baseUserDirectory ?? getRootData().root, 'languages');
const languagePaths = new Set<PathResolvable>([
join(this.languagesDirectory, '{{lng}}', '{{ns}}.json'), //
...(options?.backend?.paths ?? [])
]);
this.backendOptions = {
paths: [...languagePaths],
...this.options.backend
};
if (isFunction(this.options.fetchLanguage)) {
this.fetchLanguage = this.options.fetchLanguage;
}
}
/**
* The method to be overridden by the developer.
*
* @note In the event that fetchLanguage is not defined or returns null / undefined, the defaulting from {@link fetchLanguage} will be used.
* @since 2.0.0
* @return A string for the desired language or null for no match.
* @see {@link fetchLanguage}
* @example
* ```typescript
* // Always use the same language (no per-guild configuration):
* container.i18n.fetchLanguage = () => 'en-US';
* ```
* @example
* ```typescript
* // Retrieving the language from an SQL database:
* container.i18n.fetchLanguage = async (context) => {
* const guild = await driver.getOne('SELECT language FROM public.guild WHERE id = $1', [context.guild.id]);
* return guild?.language ?? 'en-US';
* };
* ```
* @example
* ```typescript
* // Retrieving the language from an ORM:
* container.i18n.fetchLanguage = async (context) => {
* const guild = await driver.getRepository(GuildEntity).findOne({ id: context.guild.id });
* return guild?.language ?? 'en-US';
* };
* ```
* @example
* ```typescript
* // Retrieving the language on a per channel basis, e.g. per user or guild channel (ORM example but same principles apply):
* container.i18n.fetchLanguage = async (context) => {
* const channel = await driver.getRepository(ChannelEntity).findOne({ id: context.channel.id });
* return channel?.language ?? 'en-US';
* };
* ```
*/
public fetchLanguage: (context: InternationalizationContext) => Awaitable<string | null> = () => null;
/**
* Initializes the handler by loading in the namespaces, passing the data to i18next, and filling in the {@link InternationalizationHandler#languages}.
* @since 1.0.0
*/
public async init() {
const { namespaces, languages } = await this.walkRootDirectory(this.languagesDirectory);
const userOptions = isFunction(this.options.i18next) ? this.options.i18next(namespaces, languages) : this.options.i18next;
const ignoreJSONStructure = userOptions?.ignoreJSONStructure ?? false;
const skipOnVariables = userOptions?.interpolation?.skipOnVariables ?? false;
i18next.use(Backend);
await i18next.init({
backend: this.backendOptions,
fallbackLng: this.options.defaultName ?? 'en-US',
initImmediate: false,
interpolation: {
escapeValue: false,
...userOptions?.interpolation,
skipOnVariables
},
load: 'all',
defaultNS: 'default',
ns: namespaces,
preload: languages,
...userOptions,
ignoreJSONStructure
});
this.namespaces = new Set(namespaces);
for (const item of languages) {
this.languages.set(item, i18next.getFixedT(item));
}
this.languagesLoaded = true;
const formatters = this.options.formatters ?? [];
for (const { name, format } of formatters) {
i18next.services.formatter!.add(name, format);
}
}
/**
* Retrieve a raw TFunction from the passed locale.
* @param locale The language to be used.
* @since 1.0.0
*/
public getT(locale: string) {
if (!this.languagesLoaded) throw new Error('Cannot call this method until InternationalizationHandler#init has been called');
const t = this.languages.get(locale);
if (t) return t;
throw new ReferenceError('Invalid language provided');
}
/**
* Localizes a content given one or more keys and i18next options.
* @since 2.0.0
* @param locale The language to be used.
* @param key The key or keys to retrieve the content from.
* @param options The interpolation options.
* @see {@link https://www.i18next.com/overview/api#t}
* @returns The localized content.
*/
public format<
TResult extends TFunctionResult = string,
TKeys extends TFunctionKeys = string,
TInterpolationMap extends NonNullObject = StringMap
>(locale: string, key: TKeys | TKeys[], options?: TOptions<TInterpolationMap>): TResult {
if (!this.languagesLoaded) throw new Error('Cannot call this method until InternationalizationHandler#init has been called');
const language = this.languages.get(locale);
if (!language) throw new ReferenceError('Invalid language provided');
const missingHandlers = this.options.defaultMissingKey
? { defaultValue: language(this.options.defaultMissingKey, { replace: { key } }) }
: undefined;
return language(key, { ...missingHandlers, ...options });
}
/**
* @param directory The directory that should be walked.
* @since 3.0.0
*/
public async walkRootDirectory(directory: PathLike) {
const languages = new Set<string>();
const namespaces = new Set<string>();
const dir = await opendir(directory);
for await (const entry of dir) {
// If the entry is not a directory, skip:
if (!entry.isDirectory()) continue;
// Load the directory:
languages.add(entry.name);
for await (const namespace of this.walkLocaleDirectory(join(dir.path, entry.name), '')) {
namespaces.add(namespace);
}
}
return { namespaces: [...namespaces], languages: [...languages] };
}
public async reloadResources() {
const result = await fromAsync(async () => {
let languages = this.options.hmr?.languages;
let namespaces = this.options.hmr?.namespaces;
if (!languages || !namespaces) {
const languageDirectoryResult = await this.walkRootDirectory(this.languagesDirectory);
languages ??= languageDirectoryResult.languages;
namespaces ??= languageDirectoryResult.namespaces;
}
await i18next.reloadResources(languages, namespaces);
container.logger.info('[i18next-Plugin] Reloaded language resources.');
});
if (isErr(result)) {
container.logger.error('[i18next-Plugin]: Failed to reload language resources.', result.error);
}
}
/**
* @description Skips any files that don't end with `.json`.
* @param directory The directory that should be walked.
* @param ns The current namespace.
* @since 3.0.0
*/
private async *walkLocaleDirectory(directory: string, ns: string): AsyncGenerator<string> {
const dir = await opendir(directory);
for await (const entry of dir) {
if (entry.isDirectory()) {
yield* this.walkLocaleDirectory(join(dir.path, entry.name), `${ns}${entry.name}/`);
} else if (entry.isFile() && entry.name.endsWith('.json')) {
yield `${ns}${entry.name.slice(0, -5)}`;
}
}
}
}