refactor: update i18next to v23

typings: `getT` now returns `TFunction` with the correct default namespace typings: `LocalePrefixKey`'s type now doesn't force a `commands/` prefix typings: `LocalePrefixKey` now uses i18next's `nsSeparator` type instead of a hardcoded `:` typings: All functions using `TypedT` now requires `LocalePrefixKey` BREAKING CHANGE: refactor: Removed `resolveKey`, use `getSupportedLanguageT(interaction)(...args)` instead BREAKING CHANGE: refactor: Removed `resolveUserKey`, use `getSupportedUserLanguageT(interaction)(...args)` instead BREAKING CHANGE: typings: Removed `T` type utility function BREAKING CHANGE: typings: Removed `FT` type utility function BREAKING CHANGE: typings: Removed `TypedT` type utility BREAKING CHANGE: typings: Removed `TypedFT` type utility BREAKING CHANGE: typings: Removed `Value` type utility BREAKING CHANGE: typings: Removed `Values` type utility BREAKING CHANGE: typings: Removed `Difference` type utility BREAKING CHANGE: typings: `i18next.TFunction` is not longer augmented, `lng` and `ns` is not longer assumed to exist
skyra-project · Aug 20, 2023 · 2e39517 · 2e39517
1 parent e54a14a
commit 2e39517
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 96 deletions.
diff --git a/packages/http-framework-i18n/README.md b/packages/http-framework-i18n/README.md
@@ -34,6 +34,8 @@ addFormatters(
 await init();
 ```
 
+> **Note**: If you want to customize the options, please check [i18next's TypeScript guide](https://www.i18next.com/overview/typescript) to improve the experience.
+
 ### Definition
 
 ```typescript

diff --git a/packages/http-framework-i18n/src/index.ts b/packages/http-framework-i18n/src/index.ts
@@ -1,20 +1,3 @@
 export { default as i18next, type InitOptions, type TFunction, type TOptions, type TOptionsBase } from 'i18next';
-export * from './lib/functions.js';
 export * from './lib/registry.js';
-export type * from './lib/types.js';
 export * from './lib/utils.js';
-
-import type { NonNullObject } from '@sapphire/utilities';
-import type { TypedFT, TypedT } from './lib/types.js';
-
-declare module 'i18next' {
-	export interface TFunction {
-		lng: string;
-		ns?: string;
-
-		<TReturn>(key: TypedT<TReturn>, options?: TOptionsBase | string): TReturn;
-		<TReturn>(key: TypedT<TReturn>, defaultValue: TReturn, options?: TOptionsBase | string): TReturn;
-		<TArgs extends NonNullObject, TReturn>(key: TypedFT<TArgs, TReturn>, options?: TOptions<TArgs>): TReturn;
-		<TArgs extends NonNullObject, TReturn>(key: TypedFT<TArgs, TReturn>, defaultValue: TReturn, options?: TOptions<TArgs>): TReturn;
-	}
-}
diff --git a/packages/http-framework-i18n/src/lib/functions.ts b/packages/http-framework-i18n/src/lib/functions.ts
diff --git a/packages/http-framework-i18n/src/lib/registry.ts b/packages/http-framework-i18n/src/lib/registry.ts
@@ -83,7 +83,7 @@ async function loadLocale(directory: string, ns: string) {
 }
 
 const fixedCache = new Collection<LocaleString, TFunction>();
-export function getT(locale: LocaleString): TFunction<'translation', undefined, 'translation'> {
+export function getT(locale: LocaleString): TFunction {
 	if (!loadedLocales.has(locale)) throw new ReferenceError(`Invalid language (${locale})`);
 	return fixedCache.ensure(locale, () => getFixedT(locale));
 }
diff --git a/packages/http-framework-i18n/src/lib/types.ts b/packages/http-framework-i18n/src/lib/types.ts
diff --git a/packages/http-framework-i18n/src/lib/utils.ts b/packages/http-framework-i18n/src/lib/utils.ts
@@ -2,11 +2,12 @@ import { Collection } from '@discordjs/collection';
 import type { NonNullObject } from '@sapphire/utilities';
 import { lazy } from '@sapphire/utilities';
 import type { APIInteraction, APIPingInteraction, LocaleString, LocalizationMap } from 'discord-api-types/v10';
-import type { TFunction, TOptions, TOptionsBase } from 'i18next';
+import type { TFunction, TypeOptions } from 'i18next';
 import { getT, loadedLocales } from './registry.js';
-import type { LocalePrefixKey, TypedFT, TypedT } from './types.js';
 
 export type Interaction = Pick<Exclude<APIInteraction, APIPingInteraction>, 'locale' | 'guild_locale' | 'guild_id'>;
+export type LocaleSeparator = TypeOptions['nsSeparator'];
+export type LocalePrefixKey = `${string}${LocaleSeparator}${string}`;
 
 export function getSupportedUserLanguageName(interaction: Interaction): LocaleString {
 	if (loadedLocales.has(interaction.locale)) return interaction.locale;
@@ -31,45 +32,6 @@ export function getSupportedLanguageT(interaction: Interaction): TFunction {
 	return getT(getSupportedLanguageName(interaction));
 }
 
-export function resolveUserKey<TReturn>(interaction: Interaction, key: TypedT<TReturn>, options?: TOptionsBase | string): TReturn;
-export function resolveUserKey<TReturn>(
-	interaction: Interaction,
-	key: TypedT<TReturn>,
-	defaultValue: TReturn,
-	options?: TOptionsBase | string
-): TReturn;
-export function resolveUserKey<TArgs extends NonNullObject, TReturn>(
-	interaction: Interaction,
-	key: TypedFT<TArgs, TReturn>,
-	options?: TOptions<TArgs>
-): TReturn;
-export function resolveUserKey<TArgs extends NonNullObject, TReturn>(
-	interaction: Interaction,
-	key: TypedFT<TArgs, TReturn>,
-	defaultValue: TReturn,
-	options?: TOptions<TArgs>
-): TReturn;
-export function resolveUserKey(interaction: Interaction, ...args: [any, any, any?]) {
-	return getSupportedUserLanguageT(interaction)(...args);
-}
-
-export function resolveKey<TReturn>(interaction: Interaction, key: TypedT<TReturn>, options?: TOptionsBase | string): TReturn;
-export function resolveKey<TReturn>(interaction: Interaction, key: TypedT<TReturn>, defaultValue: TReturn, options?: TOptionsBase | string): TReturn;
-export function resolveKey<TArgs extends NonNullObject, TReturn>(
-	interaction: Interaction,
-	key: TypedFT<TArgs, TReturn>,
-	options?: TOptions<TArgs>
-): TReturn;
-export function resolveKey<TArgs extends NonNullObject, TReturn>(
-	interaction: Interaction,
-	key: TypedFT<TArgs, TReturn>,
-	defaultValue: TReturn,
-	options?: TOptions<TArgs>
-): TReturn;
-export function resolveKey(interaction: Interaction, ...args: [any, any, any?]) {
-	return getSupportedLanguageT(interaction)(...args);
-}
-
 const getLocales = lazy(() => new Collection([...loadedLocales].map((locale) => [locale, getT(locale)])));
 const getDefaultT = lazy(() => {
 	const defaultT = getLocales().get('en-US');
@@ -83,7 +45,7 @@ const getDefaultT = lazy(() => {
  * @returns The retrieved data.
  * @remarks This should be called **strictly** after loading the locales.
  */
-export function getLocalizedData(key: TypedT): LocalizedData {
+export function getLocalizedData(key: LocalePrefixKey): LocalizedData {
 	const locales = getLocales();
 	const defaultT = getDefaultT();
 
@@ -99,7 +61,7 @@ export function getLocalizedData(key: TypedT): LocalizedData {
  * @param key The key to get the localizations from.
  * @returns The updated builder.
  */
-export function applyNameLocalizedBuilder<T extends BuilderWithName>(builder: T, key: TypedT) {
+export function applyNameLocalizedBuilder<T extends BuilderWithName>(builder: T, key: LocalePrefixKey) {
 	const result = getLocalizedData(key);
 	return builder.setName(result.value).setNameLocalizations(result.localizations);
 }
@@ -110,7 +72,7 @@ export function applyNameLocalizedBuilder<T extends BuilderWithName>(builder: T,
  * @param key The key to get the localizations from.
  * @returns The updated builder.
  */
-export function applyDescriptionLocalizedBuilder<T extends BuilderWithDescription>(builder: T, key: TypedT) {
+export function applyDescriptionLocalizedBuilder<T extends BuilderWithDescription>(builder: T, key: LocalePrefixKey) {
 	const result = getLocalizedData(key);
 	return builder.setDescription(result.value).setDescriptionLocalizations(result.localizations);
 }
@@ -126,16 +88,16 @@ export function applyDescriptionLocalizedBuilder<T extends BuilderWithDescriptio
  */
 export function applyLocalizedBuilder<T extends BuilderWithNameAndDescription>(
 	builder: T,
-	...params: [root: LocalePrefixKey] | [name: TypedT, description: TypedT]
+	...params: [root: LocalePrefixKey] | [name: LocalePrefixKey, description: LocalePrefixKey]
 ): T {
-	const [localeName, localeDescription] = params.length === 1 ? [`${params[0]}Name` as TypedT, `${params[0]}Description` as TypedT] : params;
+	const [localeName, localeDescription] = params.length === 1 ? [`${params[0]}Name` as const, `${params[0]}Description` as const] : params;
 
 	applyNameLocalizedBuilder(builder, localeName);
 	applyDescriptionLocalizedBuilder(builder, localeDescription);
 	return builder;
 }
 
-export function createSelectMenuChoiceName<V extends NonNullObject>(key: TypedT, value?: V): createSelectMenuChoiceName.Result<V> {
+export function createSelectMenuChoiceName<V extends NonNullObject>(key: LocalePrefixKey, value?: V): createSelectMenuChoiceName.Result<V> {
 	const result = getLocalizedData(key);
 	return {
 		...value,