@authup/i18n

Authup's translation catalogs in English, German, French and Spanish, ready for an ilingo store.
The labels, error messages and mail copy the consoles and the server use, without a framework attached.

Installation · Usage · API · Documentation

Why @authup/i18n?

An application that embeds Authup's UI components, renders Authup's error codes or names its permissions needs the same words Authup uses, in the same languages. This package is those words as plain data: an ilingo catalog tree you load into a store, plus the locale registry and the key enums.

Installation

npm install @authup/i18n ilingo

ESM only. Node.js >=26.0.0. ilingo is a dependency of this package; install it yourself as well when your code builds the Ilingo instance. @ebec/core and validup are optional peers: they matter only for the typed IssueDataByCode augmentation this package declares.

Usage

Load the catalogs

import {
    CATALOGS,
    DEFAULT_LOCALE,
    TranslatorTranslationMailKey,
    TranslatorTranslationNamespace,
    matchLocale,
} from '@authup/i18n';
import { ErrorCode } from '@authup/errors';
import { Ilingo, MemoryStore } from 'ilingo';

const ilingo = new Ilingo({
    store: new MemoryStore({ data: CATALOGS }),
    locale: DEFAULT_LOCALE,
});

const locale = matchLocale('de-DE') ?? DEFAULT_LOCALE; // 'de'

await ilingo.get({
    namespace: TranslatorTranslationNamespace.ERROR,
    key: ErrorCode.ENTITY_NOT_FOUND,
    locale,
});

await ilingo.get({
    namespace: TranslatorTranslationNamespace.MAIL,
    key: TranslatorTranslationMailKey.PASSWORD_RESET_EXPIRY,
    data: { minutes: 30 },
}); // 'The code expires in 30 minutes.'

• CATALOGS is an ilingo CatalogNode (locale, then namespace, then translations), so MemoryStore({ data: CATALOGS }) takes it as is and getSync works too.
• matchLocale lowercases the tag, keeps the primary subtag and returns it when it is an authored locale, else undefined.
• Values may carry {{name}} placeholders, filled from data.

Pick singular or plural

import { TranslatorTranslationEntityKey, TranslatorTranslationNamespace } from '@authup/i18n';
import type { Ilingo } from 'ilingo';

declare const ilingo: Ilingo;

await ilingo.get({
    namespace: TranslatorTranslationNamespace.ENTITY,
    key: TranslatorTranslationEntityKey.USER,
    count: 1,
}); // 'User'

Entity nouns are ilingo plural nodes: count: 1 selects the singular, any other count the plural.

Namespaces

API

Notes

• Policy names contain dots. system.default is a path to ilingo, so escape the dots when you look one up: key: 'system\\.default'.
• The namespaces are prefixed with authup so they cannot collide with a host application's own catalogs. Only vuecs is not, because it overrides the @vuecs/* components' own namespace.
• Every catalog is loaded eagerly. All four locales are in CATALOGS; there is no lazy loading per locale yet.

License

Made with 💚

Published under the Apache 2.0 License.