genshin-text 4.3.3 → 4.4.0

package/README.md

@@ -5,18 +5,16 @@
 [![NPM downloads][badge-npm-downloads]][url-npm]
 [![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
 
-Genshin Impact's own text in its fifteen languages, as an unofficial, non-commercial fan work and not affiliated with HoYoverse:
-
-- the game's languages, each with its BCP-47 tag and its own name for itself;
-- `matchGameLanguage`, the game language nearest a reader's browser locale or `Accept-Language` header;
-- every string the package references, looked up by the game's own text id, with English bundled and every other language a chunk loaded on first use.
+Genshin Impact's own text in its fifteen languages, as an unofficial, non-commercial fan work and not affiliated with HoYoverse.
 
 Nothing is translated by hand: each string is the game's own, in the game's own translation.
 
+Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/openspec/specs/genshin/game-text).
+
 ## Table of Contents
 
 - 🚀 [Getting Started](#getting-started)
-- 📖 [Documentation](#documentation)
+- 🧩 [Key Exports](#key-exports)
 - ⚖️ [License](#license)
 
 ---
@@ -32,14 +30,25 @@ Pick the reader's language, load its text once, and index it by key:
 ```ts
 import { GameTextKey, GameTextLoaderMap, matchGameLanguage } from "genshin-text";
 
-const language = matchGameLanguage(navigator.languages);
+const language = matchGameLanguage(window.navigator.languages);
 const gameText = await GameTextLoaderMap[language]();
 console.log(gameText[GameTextKey.Loading]);
 ```
 
-## <a name="documentation">📖 Documentation</a>
-
-We highly recommend you take a look at the [documentation](https://github.com/Esposter/Esposter/blob/main/openspec/specs/genshin/game-text/design.md) to level up. It explains where the text comes from and how to reference a new string.
+## <a name="key-exports">🧩 Key Exports</a>
+
+| Export                   | Kind      | Purpose                                                                                        |
+| ------------------------ | --------- | ---------------------------------------------------------------------------------------------- |
+| `fillGameTextValues`     | function  | Fills a string's numbered placeholders with the values given, keeping any with no value        |
+| `GameLanguage`           | enum      | The fifteen languages the game is written in                                                   |
+| `GameText`               | type      | Every referenced string in one language, keyed by `GameTextKey`                                |
+| `GameTextKey`            | enum      | Every string a consumer shows, by the game's own text id                                       |
+| `GameTextLoaderMap`      | const     | Loads one language's `GameText`: English bundled, every other language a chunk on first use    |
+| `GameTextSegment`        | interface | A run of a game string under one colour, or plain when it has none                             |
+| `getAcceptLanguageTags`  | function  | The tags of an `Accept-Language` header, most preferred first, weighed by their `q`            |
+| `getLanguageDisplayName` | function  | A game language's name as written in another game language, or as given when either is not one |
+| `matchGameLanguage`      | function  | The game language nearest a list of preferred tags, English when none matches                  |
+| `splitGameTextColors`    | function  | Splits a game string into plain runs and colour-tagged runs                                    |
 
 ## <a name="license">⚖️ License</a>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genshin-text",
-  "version": "4.3.3",
+  "version": "4.4.0",
   "description": "Genshin Impact's own text in its fifteen languages: the language registry, a matcher from a browser's locale, and the game's strings looked up by the game's own text id, one lazily loaded chunk per language.",
   "keywords": [
     "genshin",
@@ -43,14 +43,14 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "vitest",
-    "typecheck": "tsc"
+    "typecheck": "tsrs --fast"
   },
   "dependencies": {
-    "@esposter/shared": "4.3.3"
+    "@esposter/shared": "4.4.0"
   },
   "devDependencies": {
-    "@esposter/configuration": "4.3.3",
-    "tsdown": "^0.23.1"
+    "@esposter/configuration": "4.4.0",
+    "tsdown": "0.23.2"
   },
-  "gitHead": "955bbc130ad9b28877fd4ae8efc73a045141ce01"
+  "gitHead": "e1a416c4b91da69cc2aa259b50a4d656f204d272"
 }