@pie-players/pie-i18n-generated 0.0.0-stage → 1.0.0-beta.4

package/README.md

@@ -1,3 +1,179 @@
-# Temporary Holding Version
+# @pie-players/pie-i18n-generated
 
-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.
+Machine-generated, **unreviewed** interface locale catalogs for PIE players —
+the optional tier beneath the reviewed catalogs that
+[`@pie-players/pie-players-shared/i18n`](../players-shared/src/i18n/README.md)
+ships. Every catalog here is generated from the English source against a
+per-locale terminology brief, is provenance-marked, and is **not** presented
+as reviewed: the coverage number certifies structure (keys, placeholders,
+plural shape, freshness), never translation quality.
+
+Installing this package changes nothing on its own. A host opts in per
+deployment by wiring the loaders into the provider; a host that never sets a
+generated locale fetches nothing, because every catalog is a lazy chunk
+behind a static `import()` map and the default locale (`en-US`) is statically
+resident in `players-shared` and never hits a loader at all.
+
+## Wiring
+
+```ts
+import {
+	BUNDLED_LOCALES,
+	createPieI18n,
+	loadBundledCatalog,
+} from "@pie-players/pie-players-shared/i18n";
+import {
+	GENERATED_LOCALES,
+	loadGeneratedCatalog,
+} from "@pie-players/pie-i18n-generated";
+
+const i18n = createPieI18n({
+	availableLocales: [...BUNDLED_LOCALES, ...GENERATED_LOCALES],
+	// Bundled first: a reviewed catalog silently wins over a generated one for
+	// the same tag, so promoting a locale out of this package into the
+	// reviewed set needs no host action.
+	loadCatalog: (locale) =>
+		loadBundledCatalog(locale).catch(() => loadGeneratedCatalog(locale)),
+});
+
+// Hand the provider to the player; the element's `locale` names the locale
+// and is the only thing that drives it. Built without `locale` on purpose:
+// the factory names a tag without loading its catalog.
+document.querySelector("pie-section-player-splitpane").runtime = { i18n };
+```
+
+```html
+<pie-section-player-splitpane locale="th-TH" …></pie-section-player-splitpane>
+```
+
+Hosts may also override individual strings of a generated catalog the same
+way they override reviewed ones: `customMessages` is consulted ahead of any
+loaded catalog.
+
+## Locales
+
+| Tag | Status | Brief | Generated |
+| --- | --- | --- | --- |
+| `th-TH` | generated, unreviewed | [`briefs/th-TH.md`](./briefs/th-TH.md) | 2026-10-19 |
+| `en-GB` | generated, unreviewed | [`briefs/en-GB.md`](./briefs/en-GB.md) | 2026-10-19 |
+| `en-AU` | generated, unreviewed | [`briefs/en-AU.md`](./briefs/en-AU.md) | 2026-10-19 |
+| `es` | generated, unreviewed (Latin-American neutral; serves `es*`) | [`briefs/es.md`](./briefs/es.md) | 2026-10-19 |
+| `fr` | generated, unreviewed (France flavour; serves `fr*`) | [`briefs/fr.md`](./briefs/fr.md) | 2026-10-19 |
+| `ar` | generated, unreviewed (MSA; serves `ar*`; RTL — first RTL locale, layout not yet audited) | [`briefs/ar.md`](./briefs/ar.md) | 2026-10-19 |
+| `pt` | generated, unreviewed (Brazilian; serves `pt*`) | [`briefs/pt.md`](./briefs/pt.md) | 2026-10-19 |
+| `ko` | generated, unreviewed | [`briefs/ko.md`](./briefs/ko.md) | 2026-10-19 |
+| `ja` | generated, unreviewed | [`briefs/ja.md`](./briefs/ja.md) | 2026-10-19 |
+| `zh` | generated, unreviewed (Simplified; serves `zh`, `zh-CN`, `zh-SG`; Traditional hosts supply `customMessages`) | [`briefs/zh.md`](./briefs/zh.md) | 2026-10-19 |
+| `cy` | generated, unreviewed (serves `cy`, `cy-GB`; six CLDR plural categories) | [`briefs/cy.md`](./briefs/cy.md) | 2026-10-19 |
+| `sv` | generated, unreviewed (serves `sv`, `sv-SE`, `sv-FI`) | [`briefs/sv.md`](./briefs/sv.md) | 2026-10-19 |
+| `ro` | generated, unreviewed (serves `ro`, `ro-RO`, `ro-MD`; three CLDR plural categories, `other` takes `de`) | [`briefs/ro.md`](./briefs/ro.md) | 2026-10-19 |
+
+Locale tags are chosen for variant reach: bare tags (`es`, `fr`, `ar`) let
+`es-MX`, `fr-CA` and `ar-SA` widen onto them through RFC 4647 lookup, while
+`en-GB`/`en-AU` are regional on purpose so bare `en` keeps resolving to the
+bundled English.
+
+Provenance — the exact `en-US` source hash each catalog was generated from,
+the generating model and date — is recorded in
+[`catalog-manifest.json`](./catalog-manifest.json).
+
+The `calibration/` directory holds a pipeline measurement against the one
+locale that has audited ground truth (Dutch), not a shippable catalog. See
+[`calibration/nl-NL-calibration.md`](./calibration/nl-NL-calibration.md) for
+what the pipeline does and does not deliver, and what that means for reviewing
+a generated locale.
+
+## Checks
+
+```bash
+bun run check:i18n-generated
+```
+
+runs `scripts/check-catalogs.ts`, which fails on:
+
+- **staleness** — per the locale's status: a `generated` locale whose recorded
+  `en-US` hash no longer matches the current English source (its untranslated
+  keys would silently fall back to English); a `reviewed` locale whose English
+  snapshot no longer matches current English, listing exactly the keys whose
+  English moved;
+- **key drift** — a missing key, or a key English no longer defines;
+- **placeholder drift** — a lost `{name}` slot or an invented one, in string
+  or plural-group leaves;
+- **plural shape** — a missing plural group, or a group without `other`;
+- **manifest disagreement** — a locale present in the loader map but not the
+  manifest, or the reverse.
+
+The check runs in the repository's pre-commit and CI gates: changing English
+fails the gate until the affected catalogs are regenerated — wholesale for
+`generated` locales, surgically for `reviewed` ones.
+
+## The review lifecycle
+
+A locale moves through two statuses, recorded in `catalog-manifest.json`, and
+what regeneration may touch follows from the status:
+
+**`generated` — machine output, no reader behind it.** Regeneration is
+wholesale, and losing nothing makes that safe:
+
+1. Read `briefs/<locale>.md`, then regenerate `src/messages/<locale>.ts` from
+   the current `packages/players-shared/src/i18n/messages/en-US.ts`, keeping
+   every `{placeholder}` slot and the plural-group shape.
+2. Update `catalog-manifest.json`: the new `source.hash` (sha256 over the
+   JSON serialization of the `en-US` default export), and the locale's
+   `generatedAt` and `model`.
+3. Run `bun run check:i18n-generated` until it passes.
+
+**Taking a review pass** promotes the locale in place, and this is the step
+that makes iteration to audited quality a ratchet instead of a treadmill:
+
+1. A native reader goes through the catalog — the calibration report's
+   finding list is the checklist — correcting the file in place.
+2. Flip the locale's `status` to `reviewed` in the manifest, add `reviewedAt`
+   (and a `reviewedBy` note if wanted), and keep `sourceHash` as the
+   generation it started from.
+3. Run `bun run scripts/write-english-snapshot.ts <locale>`, which anchors
+   the corrections to the English they were reviewed against
+   (`src/messages/<locale>.english-snapshot.json`).
+4. `bun run check:i18n-generated` passes again — and from now on, changing a
+   translated string is preserved work: only keys whose *English* changed
+   ever need regenerating.
+
+**`reviewed` — regeneration is surgical, never wholesale.** When the gate
+lists keys whose English moved:
+
+1. Regenerate **only the listed keys**, against the brief and the new English
+   strings. Every translation the gate does not name stays exactly as the
+   review left it.
+2. Refresh the anchor:
+   `bun run scripts/write-english-snapshot.ts <locale>`.
+3. `bun run check:i18n-generated` until it passes.
+
+Wholesale regeneration of a `reviewed` locale discards review work; do it
+only deliberately, by flipping the status back to `generated` first.
+
+## Adding a locale
+
+Add `briefs/<locale>.md` (register, glossary, untranslated product names —
+the th-TH brief is the template), translate `en-US` under it into
+`src/messages/<locale>.ts`, then register the tag in both `GENERATED_LOCALES`
+(`src/index.ts`) and `catalog-manifest.json`. The static `import()` map keeps
+each locale its own lazy chunk, exactly as `players-shared`'s `catalogs.ts`
+does.
+
+## Promoting a locale to the reviewed set
+
+A locale that has been through a review pass above can go further — into the
+audited set `players-shared` itself ships — and hosts need no migration
+either way:
+
+1. A native speaker with domain context reviews the catalog — the
+   calibration report's finding list is the review checklist.
+2. Move the corrected catalog into
+   `packages/players-shared/src/i18n/messages/<locale>.ts`, add the tag to
+   `BundledLocaleCode`, `catalogs.ts` and `COMPLETE_LOCALES` per that
+   package's README, and give it a changeset.
+3. Delete the catalog from this package and the tag from the loader map and
+   manifest.
+
+Because hosts compose the loaders bundled-first, the reviewed catalog wins
+from the moment it ships, whether or not the host has removed this package.

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Generated interface catalogs for PIE Players — the optional locale tier.
+ *
+ * Every catalog here is machine-generated against the terminology brief named
+ * in `catalog-manifest.json` and is **not reviewed** by a native speaker. The
+ * reviewed catalogs ship from `@pie-players/pie-players-shared/i18n`; this
+ * package is pure data a host opts into by installing it and wiring it into
+ * the provider alongside the bundled loaders:
+ *
+ * ```ts
+ * import {
+ * 	BUNDLED_LOCALES,
+ * 	createPieI18n,
+ * 	loadBundledCatalog,
+ * } from "@pie-players/pie-players-shared/i18n";
+ * import {
+ * 	GENERATED_LOCALES,
+ * 	loadGeneratedCatalog,
+ * } from "@pie-players/pie-i18n-generated";
+ *
+ * const i18n = createPieI18n({
+ * 	locale: "th-TH",
+ * 	availableLocales: [...BUNDLED_LOCALES, ...GENERATED_LOCALES],
+ * 	// Bundled first: a reviewed catalog silently wins over a generated one
+ * 	// for the same tag, which is what makes promotion from generated to
+ * 	// reviewed a no-op for a wired host.
+ * 	loadCatalog: (locale) =>
+ * 		loadBundledCatalog(locale).catch(() => loadGeneratedCatalog(locale)),
+ * });
+ * ```
+ *
+ * Nothing here loads unless a host asks for a generated locale: the loaders
+ * are never invoked for the default `en-US` (statically resident in
+ * `players-shared`), and each locale stays its own lazy chunk because `tsc`
+ * emits these `import()` calls verbatim — the same property
+ * `players-shared`'s `catalogs.ts` relies on.
+ *
+ * Provenance per locale — source hash, brief, model, generation date — lives
+ * in `catalog-manifest.json`. `scripts/check-catalogs.ts` fails when a catalog
+ * drifts from the English source or from its brief's structural rules.
+ *
+ * @module @pie-players/pie-i18n-generated
+ */
+import type { MessageCatalog } from "@pie-players/pie-players-shared/i18n/types";
+/**
+ * Every locale tag this package ships a generated catalog for.
+ *
+ * `en-GB` and `en-AU` are regional on purpose: bare `en` must keep resolving
+ * to the statically bundled English, never to a regional variant.
+ */
+export declare const GENERATED_LOCALES: readonly string[];
+/**
+ * Load one generated catalog.
+ *
+ * Throws for a locale with no generated catalog; the provider treats that as
+ * "resolve through the fallback chain" rather than an error, mirroring
+ * `loadBundledCatalog`.
+ */
+export declare function loadGeneratedCatalog(locale: string): Promise<MessageCatalog>;

package/dist/index.js

@@ -0,0 +1,109 @@
+/**
+ * Generated interface catalogs for PIE Players — the optional locale tier.
+ *
+ * Every catalog here is machine-generated against the terminology brief named
+ * in `catalog-manifest.json` and is **not reviewed** by a native speaker. The
+ * reviewed catalogs ship from `@pie-players/pie-players-shared/i18n`; this
+ * package is pure data a host opts into by installing it and wiring it into
+ * the provider alongside the bundled loaders:
+ *
+ * ```ts
+ * import {
+ * 	BUNDLED_LOCALES,
+ * 	createPieI18n,
+ * 	loadBundledCatalog,
+ * } from "@pie-players/pie-players-shared/i18n";
+ * import {
+ * 	GENERATED_LOCALES,
+ * 	loadGeneratedCatalog,
+ * } from "@pie-players/pie-i18n-generated";
+ *
+ * const i18n = createPieI18n({
+ * 	locale: "th-TH",
+ * 	availableLocales: [...BUNDLED_LOCALES, ...GENERATED_LOCALES],
+ * 	// Bundled first: a reviewed catalog silently wins over a generated one
+ * 	// for the same tag, which is what makes promotion from generated to
+ * 	// reviewed a no-op for a wired host.
+ * 	loadCatalog: (locale) =>
+ * 		loadBundledCatalog(locale).catch(() => loadGeneratedCatalog(locale)),
+ * });
+ * ```
+ *
+ * Nothing here loads unless a host asks for a generated locale: the loaders
+ * are never invoked for the default `en-US` (statically resident in
+ * `players-shared`), and each locale stays its own lazy chunk because `tsc`
+ * emits these `import()` calls verbatim — the same property
+ * `players-shared`'s `catalogs.ts` relies on.
+ *
+ * Provenance per locale — source hash, brief, model, generation date — lives
+ * in `catalog-manifest.json`. `scripts/check-catalogs.ts` fails when a catalog
+ * drifts from the English source or from its brief's structural rules.
+ *
+ * @module @pie-players/pie-i18n-generated
+ */
+/**
+ * An explicit static map rather than a bundler macro, for the same reason
+ * `catalogs.ts` gives: `tsc` emits the `import()` calls verbatim, so `dist`
+ * evaluates under every ESM runtime, and every bundler keeps each locale its
+ * own chunk. String-keyed: the generated set is open, and a host adding a
+ * locale adds one line here alongside the file.
+ */
+const GENERATED_CATALOG_LOADERS = {
+    "th-TH": () => import("./messages/th-TH.js"),
+    "en-GB": () => import("./messages/en-GB.js"),
+    "en-AU": () => import("./messages/en-AU.js"),
+    // Bare tags on purpose: the provider's RFC 4647 lookup plus
+    // primary-subtag widening lands `es-MX`, `es-419`, `fr-CA`, `pt-BR` and
+    // `ar-SA` on these, and a host wanting a different national flavour
+    // overrides per key through `customMessages`. `zh` is Simplified Chinese
+    // and catches `zh-CN`/`zh-SG`; Traditional-Chinese hosts supply their own
+    // messages.
+    es: () => import("./messages/es.js"),
+    fr: () => import("./messages/fr.js"),
+    ar: () => import("./messages/ar.js"),
+    pt: () => import("./messages/pt.js"),
+    ko: () => import("./messages/ko.js"),
+    ja: () => import("./messages/ja.js"),
+    zh: () => import("./messages/zh.js"),
+    // Bare tags: `cy-GB` widens to `cy`, `sv-SE`/`sv-FI` to `sv`, and
+    // `ro-RO`/`ro-MD` to `ro`.
+    cy: () => import("./messages/cy.js"),
+    sv: () => import("./messages/sv.js"),
+    ro: () => import("./messages/ro.js"),
+};
+/**
+ * Every locale tag this package ships a generated catalog for.
+ *
+ * `en-GB` and `en-AU` are regional on purpose: bare `en` must keep resolving
+ * to the statically bundled English, never to a regional variant.
+ */
+export const GENERATED_LOCALES = [
+    "th-TH",
+    "en-GB",
+    "en-AU",
+    "es",
+    "fr",
+    "ar",
+    "pt",
+    "ko",
+    "ja",
+    "zh",
+    "cy",
+    "sv",
+    "ro",
+];
+/**
+ * Load one generated catalog.
+ *
+ * Throws for a locale with no generated catalog; the provider treats that as
+ * "resolve through the fallback chain" rather than an error, mirroring
+ * `loadBundledCatalog`.
+ */
+export async function loadGeneratedCatalog(locale) {
+    const loader = GENERATED_CATALOG_LOADERS[locale];
+    if (!loader) {
+        throw new Error(`No generated i18n catalog for locale: ${locale}`);
+    }
+    const module = await loader();
+    return module.default;
+}