@magicdoor/magic-localization 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                             Apache License
+                       Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 MagicDoor, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,187 @@
-# Temporary Holding Version
+# magic-localization
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Translations from string enums, checked by the compiler. You write one enum per language, hand them all to a
+single `createDictionary` call, and TypeScript refuses to build if any language:
+
+- is missing a key the base language has, or carries one it does not;
+- fills a string with different placeholders than the base language (`{name}` vs `{nombre}`, a dropped or an
+  added placeholder — the order may differ);
+- is anything other than a string enum (an `as const` object, a plain record, a numeric enum).
+
+The library holds no state and knows no framework. Which language the screen is in belongs to your app: a
+signal, a store, a context, application state. You pass it to `translate` on every call.
+
+```sh
+npm install @magicdoor/magic-localization
+```
+
+## The dictionary
+
+```ts
+import {
+  createDictionary,
+  type DictionaryKey,
+  type DictionaryLanguage,
+  type TranslatableText,
+  type Translator,
+} from '@magicdoor/magic-localization';
+
+// your languages: name and code them however your app does
+export enum Language {
+  En = 'en',
+  Es = 'es',
+}
+
+export enum English {
+  WELCOME = 'Welcome, {name}',
+  LEASE_STATUS = 'Lease {status}',
+  ACTIVE = 'active',
+}
+
+export enum Spanish {
+  WELCOME = 'Bienvenido, {name}',
+  LEASE_STATUS = 'Contrato {status}',
+  ACTIVE = 'activo',
+}
+
+export const dictionary = createDictionary({
+  base: Language.En,
+  translations: { [Language.En]: English, [Language.Es]: Spanish },
+});
+
+export type Key = DictionaryKey<typeof dictionary>; // 'WELCOME' | 'LEASE_STATUS' | 'ACTIVE'
+```
+
+The library has no languages of its own. A dictionary's languages are exactly the keys of `translations`, coded
+however your app codes them — `'en'`, `'en-GB'`, `'pt-BR'`, `'klingon'` — and `base` is one of them. An app
+without its own enum can name them from the dictionary instead:
+
+```ts
+const dictionary = createDictionary({ base: 'en-GB', translations: { 'en-GB': English, 'pt-BR': Portuguese } });
+
+type Language = DictionaryLanguage<typeof dictionary>; // 'en-GB' | 'pt-BR'
+```
+
+`createDictionary` returns:
+
+| Member                              | What it is                                                          |
+| ----------------------------------- | ------------------------------------------------------------------- |
+| `keys`                              | every key of the base language, named after itself: `keys.WELCOME`  |
+| `base`                              | the base language                                                   |
+| `translate(language, key, params?)` | the key in that language, its `{placeholders}` filled from `params` |
+| `translate(language, text)`         | a `TranslatableText` in that language                               |
+| `isLanguage(code)`                  | whether `code` is a language the dictionary has, narrowing it if so |
+
+```ts
+dictionary.translate(Language.Es, dictionary.keys.WELCOME, { name: 'Ana' }); // 'Bienvenido, Ana'
+```
+
+Code that decides what to say — a presenter, a view model — returns a `TranslatableText` instead of a string,
+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> = {
+  key: dictionary.keys.LEASE_STATUS,
+  params: { status: { key: dictionary.keys.ACTIVE } },
+};
+
+dictionary.translate(Language.Es, label); // 'Contrato activo'
+dictionary.translate(Language.Es, { params: { text: 'Maple Grove, 4B' } }); // shown as it is, in any language
+```
+
+## Your `t`
+
+Each app writes a few lines that read its language and hand it to `translate`. Type `t` as `Translator<Key>`
+and it checks keys and texts as strictly as `translate` does.
+
+Build `t` so it reads the language **every time it runs**. A `t` that captured the language once keeps
+translating into that language after it changes.
+
+### Solid, with a signal
+
+```ts
+import { createSignal } from 'solid-js';
+
+const [language, setLanguage] = createSignal<Language>(dictionary.base);
+
+export const changeLanguage = setLanguage;
+
+export const useTranslation = () => {
+  const t: Translator<Key> = (keyOrText, params?) => dictionary.translate(language(), keyOrText, params);
+  return { t };
+};
+```
+
+Whatever shows `t(...)` updates when `changeLanguage` is called, because `t` reads the signal.
+
+### Solid, with the language in application state
+
+When the language already lives in application state that components read through presenters, the hook reads
+it the same way — it never touches the state itself, and changing the language stays with whatever already
+writes that state.
+
+```ts
+import { usePresenter } from '@magicdoor/magic-use-case-solid';
+
+export const presentSelectedLanguage = (state: AppState) => ({ language: state.selectedLanguage });
+
+export const useTranslation = () => {
+  const { model } = usePresenter(presentSelectedLanguage);
+  const t: Translator<Key> = (keyOrText, params?) =>
+    dictionary.translate(model()?.language ?? dictionary.base, keyOrText, params);
+  return { t };
+};
+```
+
+### React, with a context
+
+```tsx
+import { createContext, useContext, useMemo, useState, type ReactNode } from 'react';
+
+const LanguageContext = createContext<{ language: Language; setLanguage: (language: Language) => void }>({
+  language: dictionary.base,
+  setLanguage: () => {},
+});
+
+export const LanguageProvider = ({ children }: { children: ReactNode }) => {
+  const [language, setLanguage] = useState<Language>(dictionary.base);
+  const value = useMemo(() => ({ language, setLanguage }), [language]);
+  return <LanguageContext.Provider value={value}>{children}</LanguageContext.Provider>;
+};
+
+export const useTranslation = () => {
+  const { language, setLanguage } = useContext(LanguageContext);
+  const t = useMemo<Translator<Key>>(
+    () => (keyOrText, params?) => dictionary.translate(language, keyOrText, params),
+    [language],
+  );
+  return { t, changeLanguage: setLanguage };
+};
+```
+
+The language can as well come from a store — Redux, Zustand, `useSyncExternalStore` — as long as `t` is rebuilt
+when it changes.
+
+### Restoring a language chosen earlier
+
+A code read back from storage is a plain string. Check it before it becomes the language:
+
+```ts
+const stored = localStorage.getItem('language') ?? undefined;
+const initial: Language = dictionary.isLanguage(stored) ? stored : dictionary.base;
+```
+
+## Development
+
+```sh
+npm install
+npm run build
+npm run type-check   # includes the tests, whose @ts-expect-error lines are the compile-time checks
+npm run lint
+npm run format-check
+npm run coverage     # the suite, failing under 100%
+npm run check-package
+```
+
+Releases are versioned with [changesets](https://github.com/changesets/changesets): `npm run changeset` to record
+a change, `npm run release` to build and publish.

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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> = {
+    readonly key: Key;
+    readonly params?: Readonly<Record<string, string | number | TranslatableText<Key>>>;
+} | {
+    readonly params: {
+        readonly text: string;
+    };
+};
+type Placeholders<Text extends string> = Text extends `${string}{${infer Name}}${infer Rest}` ? Name | Placeholders<Rest> : never;
+type PlaceholdersOf<Value> = Value extends string ? Placeholders<`${Value}`> : never;
+type SameUnion<A, B> = [A] extends [B] ? ([B] extends [A] ? true : false) : false;
+type Exact<Base, T> = {
+    [K in keyof Base]: K extends keyof T ? SameUnion<PlaceholdersOf<Base[K]>, PlaceholdersOf<T[K]>> extends true ? string : {
+        placeholdersExpected: PlaceholdersOf<Base[K]>;
+    } : string;
+} & {
+    [K in Exclude<keyof T, keyof Base>]: never;
+};
+type IsEnumMember<V> = V extends string ? (`${V}` extends V ? false : true) : false;
+type IsStringEnum<T> = false extends {
+    [K in keyof T]: IsEnumMember<T[K]>;
+}[keyof T] ? false : true;
+type Dictionaries<T extends Record<string, object>, Base extends keyof T> = {
+    [Language in keyof T]: IsStringEnum<T[Language]> extends true ? Exact<T[Base], T[Language]> : 'a translation file must be a string enum';
+} & T;
+/**
+ * Every language must carry exactly the keys of `base`, each with the same placeholders, so a string
+ * missing from, misspelled in, or filled differently by any language is a compile error naming that
+ * language. Only string enums are accepted as translation files.
+ */
+interface LocalizationConfig<T extends Record<string, object>, Base extends LanguageOf<T>> {
+    base: Base;
+    translations: Dictionaries<T, Base>;
+}
+type KeyOf<T extends Record<string, object>, Base extends keyof T> = Extract<keyof T[Base], string>;
+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;
+}
+/** The keys of a dictionary `createDictionary` made, named from its type: `DictionaryKey<typeof dictionary>`. */
+type DictionaryKey<D extends {
+    readonly keys: Readonly<Record<string, string>>;
+}> = Extract<keyof D['keys'], string>;
+/** The languages of a dictionary `createDictionary` made, named from its type: `DictionaryLanguage<typeof dictionary>`. */
+type DictionaryLanguage<D extends {
+    readonly isLanguage: (code?: string) => boolean;
+}> = D['isLanguage'] extends ((code?: string) => code is infer Language extends string) ? Language : never;
+
+/** The translations themselves, independent of any framework: the language is the caller's to pass. */
+declare function createDictionary<T extends Record<string, object>, Base extends LanguageOf<T>>(config: LocalizationConfig<T, Base>): {
+    base: Base;
+    keys: Record<KeyOf<T, Base>, KeyOf<T, Base>>;
+    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;
+    };
+};
+
+export { type Dictionaries, type DictionaryKey, type DictionaryLanguage, type KeyOf, type LanguageOf, type LocalizationConfig, type TranslatableText, type Translator, createDictionary };

package/dist/index.js

@@ -0,0 +1,26 @@
+// src/createDictionary.ts
+function createDictionary(config) {
+  const dictionaries = config.translations;
+  const base = config.base;
+  const keys = Object.fromEntries(
+    Object.keys(dictionaries[base]).map((key) => [key, key])
+  );
+  const isText = (value) => value instanceof Object && ("key" in value || "params" in value);
+  const textIn = (text, language) => "key" in text ? keyIn(text.key, language, text.params) : text.params.text;
+  const keyIn = (key, language, params = {}) => {
+    let text = dictionaries[language][key];
+    for (const [name, value] of Object.entries(params)) {
+      const filling = isText(value) ? textIn(value, language) : String(value);
+      text = text.replaceAll(`{${name}}`, filling);
+    }
+    return text;
+  };
+  function translate(language, keyOrText, params = {}) {
+    return isText(keyOrText) ? textIn(keyOrText, language) : keyIn(keyOrText, language, params);
+  }
+  const isLanguage = (code) => code !== void 0 && Object.hasOwn(dictionaries, code);
+  return { base, keys, isLanguage, translate };
+}
+export {
+  createDictionary
+};

package/package.json

@@ -1,6 +1,63 @@
 {
   "name": "@magicdoor/magic-localization",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Type-checked translations from string enums, for any framework.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "coverage": "vitest run --coverage",
+    "lint": "eslint src test",
+    "check-package": "attw --pack . --ignore-rules cjs-resolves-to-esm && publint --strict",
+    "type-check": "tsc --project typecheckconfig.json",
+    "changeset": "changeset",
+    "release": "npm run build && NPM_CONFIG_PROVENANCE=false changeset publish",
+    "format": "prettier --write src test",
+    "format-check": "prettier --check src test",
+    "prepack": "npm run build"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "localization",
+    "i18n",
+    "translation",
+    "typescript"
+  ],
+  "author": "Norbert Nemes",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.5",
+    "@changesets/cli": "^2.31.1",
+    "@eslint/js": "^9.39.5",
+    "@vitest/coverage-v8": "^2.1.9",
+    "eslint": "^9.39.5",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.7",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "prettier": "^3.9.10",
+    "publint": "^0.3.25",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.72.1",
+    "vitest": "^2.1.9"
+  }
+}