wizards 0.5.12 → 0.5.13

package/node_modules/@engenty-wizards/shared/dist/definition.d.ts

@@ -25,6 +25,25 @@ export declare function langOf(tag: string | null | undefined): Lang | null;
  * in; null where neither names one.
  */
 export declare function localLang(languages: readonly string[], timeZone?: string | null): Lang | null;
+/**
+ * A language a wizard can be translated into: any language, by its two- or three-letter code
+ * ("fr", "it", "pl"), not only those of `LANGS`.
+ */
+export declare const LANG_CODE: RegExp;
+/** The code of a tag such as "fr-CA" or "pt_BR"; null where it names no language. */
+export declare function langCodeOf(tag: string | null | undefined): string | null;
+/**
+ * The language the person reads, for a wizard translated on request: the first of their
+ * languages (the browser's, in its order), else the main language of the country their time
+ * zone lies in. Any language, not only one engenty's own strings are written in.
+ */
+export declare function viewerLang(languages: readonly string[], timeZone?: string | null): string | null;
+/** A language's name in that language, as a switch shows it: "Italiano", "Polski". */
+export declare function langName(code: string): string;
+/** A language's name in English, for a model told what to write in: "Italian". */
+export declare function langNameEn(code: string): string;
+/** The locale amounts, dates and plural forms are written in for any language. */
+export declare function localeOf(code: string): string;
 export declare const FIELD_KINDS: readonly ["text", "textarea", "number", "select", "multiselect", "date", "email", "url", "toggle", "color", "image", "file", "items", "connection", "list", "location", "audio", "signature", "slot"];
 export type FieldKind = (typeof FIELD_KINDS)[number];
 /**

package/node_modules/@engenty-wizards/shared/dist/definition.js

@@ -140,6 +140,57 @@ export function localLang(languages, timeZone) {
     const found = country ? langOf(COUNTRY_LANGUAGE[country]) : null;
     return found === "en" ? null : found;
 }
+/**
+ * A language a wizard can be translated into: any language, by its two- or three-letter code
+ * ("fr", "it", "pl"), not only those of `LANGS`.
+ */
+export const LANG_CODE = /^[a-z]{2,3}$/;
+/** The code of a tag such as "fr-CA" or "pt_BR"; null where it names no language. */
+export function langCodeOf(tag) {
+    const code = tag?.trim().toLowerCase().split(/[-_]/)[0] ?? "";
+    return LANG_CODE.test(code) ? code : null;
+}
+/**
+ * The language the person reads, for a wizard translated on request: the first of their
+ * languages (the browser's, in its order), else the main language of the country their time
+ * zone lies in. Any language, not only one engenty's own strings are written in.
+ */
+export function viewerLang(languages, timeZone) {
+    for (const tag of languages) {
+        const code = langCodeOf(tag);
+        if (code) {
+            return code;
+        }
+    }
+    const country = timeZone ? ZONE_COUNTRY[timeZone] : undefined;
+    return country ? langCodeOf(COUNTRY_LANGUAGE[country]) : null;
+}
+/** A language's name in that language, as a switch shows it: "Italiano", "Polski". */
+export function langName(code) {
+    if (isLang(code)) {
+        return LANG_NAMES[code];
+    }
+    try {
+        const name = new Intl.DisplayNames([code], { type: "language" }).of(code) ?? code;
+        return name.charAt(0).toLocaleUpperCase(code) + name.slice(1);
+    }
+    catch {
+        return code.toUpperCase();
+    }
+}
+/** A language's name in English, for a model told what to write in: "Italian". */
+export function langNameEn(code) {
+    try {
+        return new Intl.DisplayNames(["en"], { type: "language" }).of(code) ?? code;
+    }
+    catch {
+        return code;
+    }
+}
+/** The locale amounts, dates and plural forms are written in for any language. */
+export function localeOf(code) {
+    return isLang(code) ? LOCALES[code] : code;
+}
 export const FIELD_KINDS = [
     "text",
     "textarea",

package/node_modules/@engenty-wizards/shared/dist/run.d.ts

@@ -1,7 +1,7 @@
-import type { CardOption, Format, Lang, ModelClass, Step, WizardDefinition } from "./definition.js";
+import { type CardOption, type Format, type Lang, type ModelClass, type Step, type WizardDefinition } from "./definition.js";
 import type { ConnectionView, ListDef, ListRow } from "./store.js";
 import type { Surface } from "./surface.js";
-import { type Gap, type Texts } from "./texts.js";
+import { type Gap, type Texts, type TextTable } from "./texts.js";
 export type RunStatus = "waiting_input" | "running" | "done" | "failed" | "cancelled";
 export interface AssetRef {
     id: string;
@@ -61,6 +61,11 @@ export interface RunState {
      * pages stay as they are; the copy goes with the run.
      */
     memory?: Record<string, string>;
+    /**
+     * Finished results translated on request, by language and step: the text the person reads in
+     * place of the step's own (`StepOutput.text`); the step's output stays as it was made.
+     */
+    translated?: Record<string, Record<string, string>>;
 }
 /** What a decision over a step's `ask` branches found. */
 export interface BranchDecision {
@@ -225,6 +230,9 @@ declare const NOTES_EN: {
     readonly filmFix: "The film didn’t render – Claude Code is fixing it";
     readonly filmResume: "Picking the film up where it stopped";
     readonly wizardUnavailable: "This wizard isn’t available right now.";
+    readonly translationFailed: "This wizard can’t be translated right now. It’s shown as it was written.";
+    readonly translationOff: "This wizard is only offered as it was written.";
+    readonly translationPlaceholder: "The translation of “{text}” needs every placeholder in curly brackets the original has.";
     readonly wizardLimit: "This wizard has reached its limit for today. Try again tomorrow.";
     readonly confirmHuman: "Confirm that you’re a person.";
     readonly tooManyRuns: "You’ve started a lot of runs just now. Try again in an hour.";
@@ -465,8 +473,11 @@ export type Said = string | RunNote;
 export declare function note(code: RunNoteCode, params?: Record<string, NoteGap | undefined>): RunNote;
 /** What is said, in a language. */
 export declare function saidText(said: Said, lang: Lang): string;
-/** A note in a language, its gaps filled; English where the language lacks the line. */
-export declare function noteText(note: RunNote, lang: Lang): string;
+/**
+ * A note in a language, its gaps filled; English where the language lacks the line. A language
+ * outside `LANGS` reads its lines from `table`, the notes translated on request.
+ */
+export declare function noteText(note: RunNote, lang: string, table?: TextTable): string;
 export interface RunEvent {
     id: number;
     at: string;
@@ -486,6 +497,12 @@ export interface RunView {
     wizard: Pick<WizardDefinition, "title" | "description" | "avatar" | "intro">;
     /** The language the wizard speaks: what is read aloud, and in which voice. */
     lang: Lang;
+    /**
+     * The run in the viewer's language (a wizard translated on request): every text of the view
+     * is written in it, the choices keep their values and show `labels[value]`. Null: the
+     * wizard's own words.
+     */
+    translation: RunTranslation | null;
     /** A live conversation can be started on this run: the runtime has a model for it and the wizard has live voice or video on (always in a test). */
     talk: boolean;
     /** The step the person is on (interactive) or the one running. */
@@ -539,6 +556,17 @@ export interface RunView {
     /** When the run and its shared link are deleted; null = kept. */
     expiresAt: string | null;
 }
+/** How a run in the viewer's language shows. */
+export interface RunTranslation {
+    /** The language, by its code ("fr"): any language, not only one of `LANGS`. */
+    lang: string;
+    /** What a choice shows, by its value. */
+    labels: Record<string, string>;
+    /** A model wrote some of it; false where the author wrote every text by hand. */
+    machine: boolean;
+    /** Results shown in this language, by step (`RunState.translated`). */
+    results: Record<string, string>;
+}
 /** A shared result: what `/s/<token>` shows. Never the person's answers. */
 export interface ShareView {
     token: string;
@@ -577,6 +605,20 @@ export interface PublicWizard {
         kind: "page" | "channel";
         url: string | null;
     }[];
+    /** The language the wizard is written in: the page opens in it. */
+    lang: Lang;
+    /** The author offers the wizard in the viewer's language, translated on request. */
+    translatable: boolean;
+    /** The page in the viewer's language, where it was asked for (`?lang=`); null: the original. */
+    translation: Omit<RunTranslation, "results"> | null;
+}
+/** The runner's own words in a language outside `LANGS`: `GET /api/public/texts/:lang`. */
+export interface UiTexts {
+    lang: string;
+    /** The runner's table (`packages/shared/src/runner-texts.ts`). */
+    runner: TextTable;
+    /** The run notes (`RUN_NOTES`). */
+    notes: TextTable;
 }
 /** What a step is expected to cost, in credits. `high` is the 90th percentile once measured. */
 export interface StepEstimate {

package/node_modules/@engenty-wizards/shared/dist/run.js

@@ -1,4 +1,6 @@
-import { textOf } from "./texts.js";
+// SPDX-License-Identifier: FSL-1.1-MIT OR MIT
+import { isLang, } from "./definition.js";
+import { lineText, textOf } from "./texts.js";
 /**
  * What a step reports while it works, in words for each language: the runtime writes the English
  * line into the run's log, a runner shows it in the language the person reads. The runtime's
@@ -65,6 +67,9 @@ const NOTES_EN = {
     filmFix: "The film didn’t render – Claude Code is fixing it",
     filmResume: "Picking the film up where it stopped",
     wizardUnavailable: "This wizard isn’t available right now.",
+    translationFailed: "This wizard can’t be translated right now. It’s shown as it was written.",
+    translationOff: "This wizard is only offered as it was written.",
+    translationPlaceholder: "The translation of “{text}” needs every placeholder in curly brackets the original has.",
     wizardLimit: "This wizard has reached its limit for today. Try again tomorrow.",
     confirmHuman: "Confirm that you’re a person.",
     tooManyRuns: "You’ve started a lot of runs just now. Try again in an hour.",
@@ -350,6 +355,9 @@ const NOTES_DE = {
     filmFix: "Der Film ließ sich nicht rendern – Claude Code bessert nach",
     filmResume: "Macht dort weiter, wo der Film stehen geblieben ist",
     wizardUnavailable: "Dieser Wizard ist gerade nicht verfügbar.",
+    translationFailed: "Dieser Wizard lässt sich gerade nicht übersetzen. Du siehst ihn so, wie er geschrieben wurde.",
+    translationOff: "Diesen Wizard gibt es nur so, wie er geschrieben wurde.",
+    translationPlaceholder: "Die Übersetzung von „{text}“ braucht jeden Platzhalter in geschweiften Klammern, den das Original hat.",
     wizardLimit: "Für heute ist das Limit dieses Wizards erreicht. Versuch es morgen wieder.",
     confirmHuman: "Bestätige kurz, dass du ein Mensch bist.",
     tooManyRuns: "Du hast gerade viele Läufe gestartet. Versuch es in einer Stunde wieder.",
@@ -578,23 +586,30 @@ export function note(code, params) {
 export function saidText(said, lang) {
     return typeof said === "string" ? said : noteText(said, lang);
 }
-function gapIn(value, lang) {
+function gapIn(value, lang, table) {
     if (Array.isArray(value)) {
-        return value.map((item) => gapIn(item, lang));
+        return value.map((item) => gapIn(item, lang, table));
     }
     if (typeof value === "object" && value !== null && "code" in value) {
-        return noteText(value, lang);
+        return noteText(value, lang, table);
     }
     return value;
 }
-/** A note in a language, its gaps filled; English where the language lacks the line. */
-export function noteText(note, lang) {
+/**
+ * A note in a language, its gaps filled; English where the language lacks the line. A language
+ * outside `LANGS` reads its lines from `table`, the notes translated on request.
+ */
+export function noteText(note, lang, table) {
     if (!(note.code in NOTES_EN)) {
         return "";
     }
     const params = {};
     for (const [key, value] of Object.entries(note.params ?? {})) {
-        params[key] = value === undefined ? undefined : gapIn(value, lang);
+        params[key] = value === undefined ? undefined : gapIn(value, lang, table);
+    }
+    const own = table?.[note.code];
+    if (own !== undefined) {
+        return lineText(own, lang, params);
     }
-    return textOf(RUN_NOTES, note.code, lang, params);
+    return textOf(RUN_NOTES, note.code, isLang(lang) ? lang : "en", params);
 }