@xndrjs/i18n 0.6.0 → 0.7.0-alpha.0

package/src/scope-multi.ts

@@ -0,0 +1,124 @@
+import type { IcuTranslationProviderMulti } from "./IcuTranslationProviderMulti.js";
+import type { LocaleFallbackMap, LocaleOfMulti, MultiDictionary } from "./types.js";
+import type { MultiParams, ParamArgs } from "./scope-types.js";
+
+/** Type-safe translation scope for a multi-namespace schema subset. */
+export interface I18nScopeMulti<
+  Schema extends MultiDictionary,
+  Params,
+  RequestLocales extends string = LocaleOfMulti<Schema>,
+> {
+  t<
+    const NS extends keyof Schema & keyof Params & string,
+    const K extends keyof Schema[NS] & keyof Params[NS] & string,
+  >(
+    namespace: NS,
+    key: K,
+    locale: RequestLocales,
+    ...params: ParamArgs<Params[NS][K]>
+  ): string;
+  forLocale<Locale extends RequestLocales>(
+    locale: Locale
+  ): I18nScopeMultiForLocale<Schema, Params, RequestLocales, Locale>;
+}
+
+/** Multi-namespace scope with a bound locale — `t(namespace, key)` and `set(...)` without a locale argument. */
+export interface I18nScopeMultiForLocale<
+  Schema extends MultiDictionary,
+  Params,
+  RequestLocales extends string,
+  Locale extends RequestLocales,
+> {
+  readonly locale: Locale;
+  t<
+    const NS extends keyof Schema & keyof Params & string,
+    const K extends keyof Schema[NS] & keyof Params[NS] & string,
+  >(
+    namespace: NS,
+    key: K,
+    ...params: ParamArgs<Params[NS][K]>
+  ): string;
+  set<
+    const NS extends keyof Schema & keyof Params & string,
+    const K extends keyof Schema[NS] & keyof Params[NS] & string,
+  >(
+    namespace: NS,
+    key: K,
+    template: string
+  ): void;
+  forLocale<Next extends RequestLocales>(
+    locale: Next
+  ): I18nScopeMultiForLocale<Schema, Params, RequestLocales, Next>;
+}
+
+export class I18nScopeMultiImpl<
+  Schema extends MultiDictionary,
+  Params extends MultiParams<Schema>,
+  RequestLocales extends string,
+  Fallback extends LocaleFallbackMap | undefined,
+> implements I18nScopeMulti<Schema, Params, RequestLocales> {
+  constructor(
+    private readonly engine: IcuTranslationProviderMulti<Schema, Params, RequestLocales, Fallback>
+  ) {}
+
+  t = <
+    const NS extends keyof Schema & keyof Params & string,
+    const K extends keyof Schema[NS] & keyof Params[NS] & string,
+  >(
+    namespace: NS,
+    key: K,
+    locale: RequestLocales,
+    ...args: ParamArgs<Params[NS][K]>
+  ): string => {
+    const params = args[0] as Record<string, unknown> | undefined;
+    return this.engine.getWithLocale(String(namespace), String(key), locale, params);
+  };
+
+  forLocale = <Locale extends RequestLocales>(
+    locale: Locale
+  ): I18nScopeMultiForLocaleImpl<Schema, Params, RequestLocales, Locale, Fallback> => {
+    return new I18nScopeMultiForLocaleImpl(this.engine, locale);
+  };
+}
+
+export class I18nScopeMultiForLocaleImpl<
+  Schema extends MultiDictionary,
+  Params extends MultiParams<Schema>,
+  RequestLocales extends string,
+  Locale extends RequestLocales,
+  Fallback extends LocaleFallbackMap | undefined,
+> implements I18nScopeMultiForLocale<Schema, Params, RequestLocales, Locale> {
+  constructor(
+    private readonly engine: IcuTranslationProviderMulti<Schema, Params, RequestLocales, Fallback>,
+    readonly locale: Locale
+  ) {}
+
+  t = <
+    const NS extends keyof Schema & keyof Params & string,
+    const K extends keyof Schema[NS] & keyof Params[NS] & string,
+  >(
+    namespace: NS,
+    key: K,
+    ...args: ParamArgs<Params[NS][K]>
+  ): string => {
+    const params = args[0] as Record<string, unknown> | undefined;
+    return this.engine.getWithLocale(String(namespace), String(key), this.locale, params);
+  };
+
+  set = <
+    const NS extends keyof Schema & keyof Params & string,
+    const K extends keyof Schema[NS] & keyof Params[NS] & string,
+  >(
+    namespace: NS,
+    key: K,
+    template: string
+  ): void => {
+    this.engine.patchKeyMulti(String(namespace), String(key), this.locale, template);
+  };
+
+  forLocale = <Next extends RequestLocales>(
+    locale: Next
+  ): I18nScopeMultiForLocaleImpl<Schema, Params, RequestLocales, Next, Fallback> => {
+    return new I18nScopeMultiForLocaleImpl(this.engine, locale);
+  };
+}

package/src/scope-single.ts

@@ -0,0 +1,85 @@
+import type { IcuTranslationProviderSingle } from "./IcuTranslationProviderSingle.js";
+import type { KeyDictionary, LocaleFallbackMap, LocaleOfSingle } from "./types.js";
+import type { ParamArgs } from "./scope-types.js";
+
+/** Type-safe translation scope for a single-namespace schema. */
+export interface I18nScopeSingle<
+  Schema extends KeyDictionary,
+  Params extends { [K in keyof Schema]: unknown },
+  RequestLocales extends string = LocaleOfSingle<Schema>,
+> {
+  t<const K extends keyof Schema & string>(
+    key: K,
+    locale: RequestLocales,
+    ...params: ParamArgs<Params[K]>
+  ): string;
+  forLocale<Locale extends RequestLocales>(
+    locale: Locale
+  ): I18nScopeSingleForLocale<Schema, Params, Locale>;
+}
+
+/** Single-namespace scope with a bound locale — `t(key)` and `set(key)` without a locale argument. */
+export interface I18nScopeSingleForLocale<
+  Schema extends KeyDictionary,
+  Params extends { [K in keyof Schema]: unknown },
+  Locale extends string,
+> {
+  readonly locale: Locale;
+  t<const K extends keyof Schema & string>(key: K, ...params: ParamArgs<Params[K]>): string;
+  set<const K extends keyof Schema & string>(key: K, template: string): void;
+  forLocale<Next extends Locale>(locale: Next): I18nScopeSingleForLocale<Schema, Params, Next>;
+}
+
+export class I18nScopeSingleImpl<
+  Schema extends KeyDictionary,
+  Params extends { [K in keyof Schema]: unknown },
+  RequestLocales extends string,
+  Fallback extends LocaleFallbackMap | undefined,
+> implements I18nScopeSingle<Schema, Params, RequestLocales> {
+  constructor(
+    private readonly engine: IcuTranslationProviderSingle<Schema, Params, RequestLocales, Fallback>
+  ) {}
+
+  t = <const K extends keyof Schema & string>(
+    key: K,
+    locale: RequestLocales,
+    ...args: ParamArgs<Params[K]>
+  ): string => {
+    const params = args[0] as Record<string, unknown> | undefined;
+    return this.engine.getWithLocale(String(key), locale, params);
+  };
+
+  forLocale = <Locale extends RequestLocales>(
+    locale: Locale
+  ): I18nScopeSingleForLocaleImpl<Schema, Params, RequestLocales, Locale, Fallback> => {
+    return new I18nScopeSingleForLocaleImpl(this.engine, locale);
+  };
+}
+
+export class I18nScopeSingleForLocaleImpl<
+  Schema extends KeyDictionary,
+  Params extends { [K in keyof Schema]: unknown },
+  RequestLocales extends string,
+  Locale extends RequestLocales,
+  Fallback extends LocaleFallbackMap | undefined,
+> implements I18nScopeSingleForLocale<Schema, Params, Locale> {
+  constructor(
+    private readonly engine: IcuTranslationProviderSingle<Schema, Params, RequestLocales, Fallback>,
+    readonly locale: Locale
+  ) {}
+
+  t = <const K extends keyof Schema & string>(key: K, ...args: ParamArgs<Params[K]>): string => {
+    const params = args[0] as Record<string, unknown> | undefined;
+    return this.engine.getWithLocale(String(key), this.locale, params);
+  };
+
+  set = <const K extends keyof Schema & string>(key: K, template: string): void => {
+    this.engine.patchKey(String(key), this.locale, template);
+  };
+
+  forLocale = <Next extends Locale>(
+    locale: Next
+  ): I18nScopeSingleForLocaleImpl<Schema, Params, RequestLocales, Next, Fallback> => {
+    return new I18nScopeSingleForLocaleImpl(this.engine, locale);
+  };
+}

package/src/scope-types.ts

@@ -0,0 +1,27 @@
+import type { KeyDictionary, MultiDictionary } from "./types.js";
+
+/** ICU argument map for a multi-namespace schema. */
+export type MultiParams<Schema extends MultiDictionary> = {
+  [NS in keyof Schema]: { [K in keyof Schema[NS]]: unknown };
+};
+
+/** Restrict a multi schema to a subset of namespaces. */
+export type SchemaForNamespaces<
+  Schema extends MultiDictionary,
+  NsList extends readonly (keyof Schema & string)[],
+> = Pick<Schema, NsList[number]>;
+
+/** Restrict multi ICU params to a subset of namespaces. */
+export type ParamsForNamespaces<
+  Schema extends MultiDictionary,
+  Params extends MultiParams<Schema>,
+  NsList extends readonly (keyof Schema & string)[],
+> = Pick<Params, NsList[number]>;
+
+/** ICU argument map for a single-namespace schema. */
+export type SingleParams<Schema extends KeyDictionary> = {
+  [K in keyof Schema]: unknown;
+};
+
+/** Rest args for `t()` — `never` params omit the third argument. */
+export type ParamArgs<P> = [P] extends [never] ? [] : [params: P];