@manyducks.co/dolla 2.0.0-alpha.8 → 2.0.0-alpha.9

package/dist/modules/dolla.d.ts

@@ -3,7 +3,7 @@ import { createSettableState, createState, derive, toSettableState, toState, val
 import { type ViewFunction, type ViewNode } from "../view.js";
 import { type CrashViewProps } from "../views/default-crash-view.js";
 import { HTTP } from "./http.js";
-import { Language } from "./language.js";
+import { I18n } from "./i18n.js";
 import { Render } from "./render.js";
 import { Router } from "./router.js";
 export type Environment = "development" | "production";
@@ -41,7 +41,7 @@ export type LoggerOptions = {
 export declare class Dolla {
     #private;
     readonly http: HTTP;
-    readonly language: Language;
+    readonly i18n: I18n;
     readonly render: Render;
     readonly router: Router;
     constructor();

package/dist/modules/i18n.d.ts

@@ -0,0 +1,59 @@
+import { MaybeState, type State } from "../state.js";
+import type { Stringable } from "../types.js";
+import type { Dolla } from "./dolla.js";
+/**
+ * An object where values are either a translated string or another nested Translation object.
+ */
+type LocalizedStrings = Record<string, string | Record<string, string | Record<string, string | Record<string, string>>>>;
+export interface TranslationConfig {
+    /**
+     * Name of the locale this translation is for (BCP 47 locale names recommended).
+     */
+    locale: string;
+    /**
+     * Path to a JSON file with translated strings for this language.
+     */
+    path?: string;
+    /**
+     * A callback function that returns a Promise that resolves to the translation object for this language.
+     */
+    fetch?: () => Promise<LocalizedStrings>;
+}
+export type I18nSetupOptions = {
+    /**
+     * Default locale to load on startup
+     */
+    locale?: string | null;
+    translations: TranslationConfig[];
+};
+/**
+ * Dolla's I(nternationalizatio)n module. Manages language translations and locale-based formatting.
+ */
+export declare class I18n {
+    #private;
+    $locale: State<string | undefined>;
+    constructor(dolla: Dolla);
+    get locales(): string[];
+    setup(options: I18nSetupOptions): void;
+    setLocale(name: string): Promise<void>;
+    /**
+     * Returns a State containing the value at `key`.
+    
+     * @param key - Key to the translated value.
+     * @param values - A map of {{placeholder}} names and the values to replace them with.
+     */
+    t(key: string, values?: Record<string, Stringable | State<Stringable>>): State<string>;
+    /**
+     * Format a number in the current locale.
+     */
+    formatNumber(count: number, options?: Intl.NumberFormatOptions): string;
+    /**
+     * Format a number in the current locale and get the result as a State that will update if the locale changes.
+     */
+    formatNumber$(count: MaybeState<number>, options?: Intl.NumberFormatOptions): State<string>;
+    formatDate(date: string | Date, options?: Intl.DateTimeFormatOptions): string;
+    formatDate$(date: MaybeState<string | Date>, options?: Intl.DateTimeFormatOptions): State<string>;
+    formatList(list: string[], options?: Intl.ListFormatOptions): string;
+    formatList$(list: MaybeState<string[]>, options?: Intl.ListFormatOptions): State<string>;
+}
+export {};

package/notes/scratch.md

@@ -48,8 +48,8 @@ Doing this would make it possible to access things inside the Dolla app from _ou
 import Dolla from "@manyducks.co/dolla";
 
 // Languages: add translation, set language and get localized string as a signal
-Dolla.language.setup({
-  initialLanguage: Dolla.language.detect({ fallback: "ja" }), // Detect user's language and fall back to passed value
+Dolla.i18n.setup({
+  initialLanguage: Dolla.i18n.detect({ fallback: "ja" }), // Detect user's language and fall back to passed value
   languages: [
     { name: "ja", path: "/static/locales/ja.json" },
     {
@@ -63,8 +63,8 @@ Dolla.language.setup({
   ]
 });
 
-Dolla.language.$current
-Dolla.language.t$()
+Dolla.i18n.$locale
+Dolla.i18n.t$()
 
 // A single setup call to keep things contained (must happen before mount)
 Dolla.router.setup({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyducks.co/dolla",
-  "version": "2.0.0-alpha.8",
+  "version": "2.0.0-alpha.9",
   "description": "Front-end components, routing and state management.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/modules/language.d.ts

@@ -1,41 +0,0 @@
-import { type State } from "../state.js";
-import type { Stringable } from "../types.js";
-import type { Dolla } from "./dolla.js";
-/**
- * An object where values are either a translated string or another nested Translation object.
- */
-type LocalizedStrings = Record<string, string | Record<string, string | Record<string, string | Record<string, string>>>>;
-export interface LanguageConfig {
-    name: string;
-    /**
-     * Path to a JSON file with translated strings for this language.
-     */
-    path?: string;
-    /**
-     * A callback function that returns a Promise that resolves to the translation object for this language.
-     */
-    fetch?: () => Promise<LocalizedStrings>;
-}
-export type LanguageSetupOptions = {
-    /**
-     * Default language to load on startup
-     */
-    initialLanguage?: string | null;
-    languages: LanguageConfig[];
-};
-export declare class Language {
-    #private;
-    $current: State<string | undefined>;
-    constructor(dolla: Dolla);
-    get supportedLanguages(): string[];
-    setup(options: LanguageSetupOptions): void;
-    setLanguage(name: string): Promise<void>;
-    /**
-     * Returns a State containing the value at `key`.
-    
-     * @param key - Key to the translated value.
-     * @param values - A map of {{placeholder}} names and the values to replace them with.
-     */
-    t(key: string, values?: Record<string, Stringable | State<Stringable>>): State<string>;
-}
-export {};