@magicdoor/magic-localization 0.1.0 → 0.2.0

package/README.md

@@ -22,7 +22,7 @@ import {
   createDictionary,
   type DictionaryKey,
   type DictionaryLanguage,
-  type TranslatableText,
+  type TranslatableTextOf,
   type Translator,
 } from '@magicdoor/magic-localization';
 
@@ -50,6 +50,7 @@ export const dictionary = createDictionary({
 });
 
 export type Key = DictionaryKey<typeof dictionary>; // 'WELCOME' | 'LEASE_STATUS' | 'ACTIVE'
+export type TranslatableText = TranslatableTextOf<Key>; // the one line that names your texts; declare with TranslatableText from here on
 ```
 
 The library has no languages of its own. A dictionary's languages are exactly the keys of `translations`, coded
@@ -80,7 +81,7 @@ Code that decides what to say — a presenter, a view model — returns a `Trans
 and only the UI translates it. A placeholder can be a text of its own, translated in the same language:
 
 ```ts
-const label: TranslatableText<Key> = {
+const label: TranslatableText = {
   key: dictionary.keys.LEASE_STATUS,
   params: { status: { key: dictionary.keys.ACTIVE } },
 };

package/dist/index.d.ts

@@ -2,9 +2,9 @@
  * A key with the values its placeholders take, a value being a text of its own where it is a word too —
  * or, with no key, a text shown as it is.
  */
-type TranslatableText<Key extends string> = {
+type TranslatableTextOf<Key extends string> = {
     readonly key: Key;
-    readonly params?: Readonly<Record<string, string | number | TranslatableText<Key>>>;
+    readonly params?: Readonly<Record<string, string | number | TranslatableTextOf<Key>>>;
 } | {
     readonly params: {
         readonly text: string;
@@ -40,7 +40,7 @@ type KeyOf<T extends Record<string, object>, Base extends keyof T> = Extract<key
 type LanguageOf<T extends Record<string, object>> = Extract<keyof T, string>;
 interface Translator<Key extends string> {
     (key: Key, params?: Record<string, unknown>): string;
-    (text: TranslatableText<Key>, params?: undefined): string;
+    (text: TranslatableTextOf<Key>, params?: undefined): string;
 }
 /** The keys of a dictionary `createDictionary` made, named from its type: `DictionaryKey<typeof dictionary>`. */
 type DictionaryKey<D extends {
@@ -58,9 +58,9 @@ declare function createDictionary<T extends Record<string, object>, Base extends
     isLanguage: (code?: string) => code is LanguageOf<T>;
     translate: {
         (language: LanguageOf<T>, key: KeyOf<T, Base>, params?: Record<string, unknown>): string;
-        (language: LanguageOf<T>, text: TranslatableText<KeyOf<T, Base>>): string;
-        (language: LanguageOf<T>, keyOrText: KeyOf<T, Base> | TranslatableText<KeyOf<T, Base>>, params?: Record<string, unknown>): string;
+        (language: LanguageOf<T>, text: TranslatableTextOf<KeyOf<T, Base>>): string;
+        (language: LanguageOf<T>, keyOrText: KeyOf<T, Base> | TranslatableTextOf<KeyOf<T, Base>>, params?: Record<string, unknown>): string;
     };
 };
 
-export { type Dictionaries, type DictionaryKey, type DictionaryLanguage, type KeyOf, type LanguageOf, type LocalizationConfig, type TranslatableText, type Translator, createDictionary };
+export { type Dictionaries, type DictionaryKey, type DictionaryLanguage, type KeyOf, type LanguageOf, type LocalizationConfig, type TranslatableTextOf, type Translator, createDictionary };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magicdoor/magic-localization",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Type-checked translations from string enums, for any framework.",
   "type": "module",
   "main": "./dist/index.js",