@krizaka/i18n 0.1.0-beta.0 → 0.1.0-beta.1

package/dist/react.d.ts

@@ -1,75 +1,7 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { PluralForms } from '@krizaka/intl/plural';
-
-/**
- * The types of a message catalogue. `en.json` (the reference) gives the shape; every other locale has the same one.
- * A key is the dotted path to a leaf (`"auction.phase.SOLD"`); a leaf is a message string or a set of plural forms.
- */
-
-/** A value a message may hold: a string, a plural set, a nested branch, or a list (long structured content). */
-type MessageValue = string | Dictionary | readonly MessageValue[];
-/** A message catalogue, as `import en from "./messages/en.json"` types it. */
-interface Dictionary {
-    readonly [key: string]: MessageValue;
-}
-/** A value a placeholder accepts. */
-type PlaceholderValue = string | number;
-/** The values handed to `format` / `t`: `{ count: 3, name: "Ada" }`. */
-type Values = Readonly<Record<string, PlaceholderValue | null | undefined>>;
-/** The plural categories a plural set may carry (`zero` is the explicit "exactly 0" form). */
-type PluralCategory = keyof PluralForms;
-type Join<P extends string, K extends string> = P extends "" ? K : `${P}.${K}`;
-/** True when T is a plural set: an object whose keys are plural categories, `other` included. */
-type IsPlural<T> = T extends {
-    other: string;
-} ? Exclude<keyof T, PluralCategory> extends never ? true : false : false;
-/**
- * Every key of a catalogue: the dotted path to each string and each plural set. Lists are not keys (read them as a
- * branch with `getDictionary`). `MessageKey<typeof en>` → `"home.title" | "auction.bids" | …`.
- */
-type MessageKey<D, P extends string = ""> = D extends readonly unknown[] ? never : {
-    [K in keyof D & string]: D[K] extends string ? Join<P, K> : IsPlural<D[K]> extends true ? Join<P, K> : D[K] extends readonly unknown[] ? never : D[K] extends object ? MessageKey<D[K], Join<P, K>> : never;
-}[keyof D & string];
-/** The message at a key: `MessageAt<typeof en, "home.title">`. */
-type MessageAt<D, K extends string> = K extends `${infer H}.${infer R}` ? H extends keyof D ? MessageAt<D[H], R> : never : K extends keyof D ? D[K] : never;
-/** The `{placeholders}` of a literal message type: `Placeholders<"{count} of {total}">` → `"count" | "total"`. */
-type Placeholders<S extends string> = S extends `${string}{${infer N}}${infer R}` ? N extends `${string}${" " | "{"}${string}` ? Placeholders<R> : N | Placeholders<R> : never;
-/**
- * The arguments `t` takes after the key. A message typed as a literal (a catalogue written `as const`) requires its
- * placeholders; a plural set requires `count`; a message typed `string` (a JSON import widens literals) takes any values.
- */
-type ValuesArgs<M> = IsPlural<M> extends true ? [values: Values & {
-    readonly count: number;
-}] : M extends string ? string extends M ? [values?: Values] : [Placeholders<M>] extends [never] ? [values?: Values] : [values: Values & {
-    readonly [N in Placeholders<M>]: PlaceholderValue;
-}] : [values?: Values];
-/** A translator bound to one locale: `t("auction.bids", { count: 3 })`. */
-type Translate<D> = <K extends MessageKey<D>>(key: K, ...values: ValuesArgs<MessageAt<D, K>>) => string;
-
-/**
- * Replaces the `{name}` placeholders of a message: `format("{count} repositories", { count: 23 })` → `"23 repositories"`.
- * A placeholder without a value (missing, `null` or `undefined`) stays as written, so a gap is visible, never silent.
- */
-declare function format(message: string, values?: Values): string;
-
-interface I18n<D extends Dictionary, L extends string = string> {
-    /** The supported locales, in the order the catalogues were given. */
-    readonly locales: readonly L[];
-    readonly defaultLocale: L;
-    /** True when the value is a supported locale. */
-    isLocale(value: unknown): value is L;
-    /** Narrows any value (a route segment, a cookie) to a supported locale: the default one for anything else. */
-    asLocale(value: unknown): L;
-    /** The whole catalogue of a locale (the default one for an unknown locale) — for Server Components and branches. */
-    getDictionary(locale: unknown): D;
-    /** The translator bound to a locale: `translator("fr")("auction.bids", { count: 3 })`. */
-    translator(locale: unknown): Translate<D>;
-    /** The translator of the default locale. */
-    t: Translate<D>;
-    /** `{placeholder}` replacement, the same function as the package's `format`. */
-    format: typeof format;
-}
+import { Dictionary, Translate, format, I18n } from './index.js';
+import '@krizaka/intl/plural';
 
 /** What `useI18n()` returns. */
 interface I18nContextValue<D extends Dictionary, L extends string> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@krizaka/i18n",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.0-beta.1",
   "description": "The i18n engine of every Krizaka app: typed message keys and placeholders from en.json, format(), plurals through @krizaka/intl, <Rich> (<b>, <a>), a React provider, and the krizaka-i18n CLI that checks catalogues and finds hard-coded strings.",
   "keywords": [
     "krizaka",
@@ -123,6 +123,6 @@
     "typecheck": "tsc --noEmit",
     "test": "vitest run --coverage",
     "size": "size-limit",
-    "publint": "publint && attw --pack . --profile esm-only"
+    "publint": "publint && attw --pack . --profile esm-only && tsc -p test/consumer/tsconfig.json"
   }
 }