wizards 0.5.12 → 0.6.0

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

@@ -190,6 +190,60 @@ export const FONT_USE_WORDS = {
     images: "images and social graphics",
     video: "video",
 };
+const BACKGROUND_WORDS = /hintergrund|background|untergrund|grund|paper|papier|fläche|surface/i;
+const TEXT_WORDS = /\btext|schrift|ink|typo/i;
+const DISPLAY_ROLES = /head|überschrift|display|titel|title|headline/i;
+const BODY_ROLES = /body|fließ|copy|lauf|text|ui|interface/i;
+/** The channels of a #rrggbb colour, 0–255; null for anything else. */
+function rgbOf(hex) {
+    const m = /^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/i.exec(hex.trim());
+    return m
+        ? [Number.parseInt(m[1], 16), Number.parseInt(m[2], 16), Number.parseInt(m[3], 16)]
+        : null;
+}
+/** How light a colour looks, 0–1 (relative luminance). */
+function luminance(hex) {
+    const rgb = rgbOf(hex);
+    if (!rgb) {
+        return 1;
+    }
+    const [r, g, b] = rgb.map((c) => {
+        const v = c / 255;
+        return v <= 0.04045 ? v / 12.92 : ((v + 0.055) / 1.055) ** 2.4;
+    });
+    return 0.2126 * r + 0.7152 * g + 0.0722 * b;
+}
+/** A colour with a hue of its own, not a grey, white or black. */
+function colourful(hex) {
+    const rgb = rgbOf(hex);
+    return rgb ? Math.max(...rgb) - Math.min(...rgb) > 40 : false;
+}
+/**
+ * How a wizard's pages look, from the brand: the first standard colour is the accent, a standard
+ * colour named as the ground ("Hintergrund") the background, the next colourful one the second
+ * colour; the typeface for headings and the one for text by their roles. What the brand does not
+ * say stays the runner's own.
+ */
+export function runTheme(brand) {
+    const standard = (brand.colors ?? []).filter((c) => !c.section && rgbOf(c.value));
+    const accent = standard[0]?.value ?? null;
+    const background = standard.find((c) => BACKGROUND_WORDS.test(c.name))?.value ?? null;
+    const second = standard
+        .slice(1)
+        .find((c) => c.value !== background && !TEXT_WORDS.test(c.name) && colourful(c.value))
+        ?.value ?? null;
+    const fonts = brand.fonts ?? [];
+    const display = fonts.find((f) => DISPLAY_ROLES.test(f.role)) ?? fonts[0];
+    const body = fonts.find((f) => f !== display && BODY_ROLES.test(f.role)) ?? fonts.find((f) => f !== display);
+    return {
+        accent,
+        second,
+        background,
+        display: display?.family ?? null,
+        body: body?.family ?? null,
+        dark: background ? luminance(background) < 0.18 : false,
+    };
+}
 /** The font's licence as a model reads it: ", licence …, may only be used for …". */
 export function fontLicenseWords(f) {
     return [

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;
@@ -23,6 +23,11 @@ export interface StepOutput {
     /** A view from the surface catalog and the data it is bound to. */
     surface?: Surface;
     assets?: AssetRef[];
+    /**
+     * What the person did in the step's view, kept with the run: a checklist's ticks by component
+     * id, a widget's own state (`wizard.save`).
+     */
+    view?: Record<string, unknown>;
     /** Widgets: what loading it with this run's data showed. */
     widget?: {
         /** Seconds of animation the widget registered for video export; null = a still widget. */
@@ -61,6 +66,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 {
@@ -172,6 +182,7 @@ declare const NOTES_EN: {
     };
     readonly videoRendering: "Rendering the video – this usually takes 1–3 minutes.";
     readonly photo: "Looking at photo {n} of {total}";
+    readonly found: "{label}: {name}";
     readonly listen: "Listening to “{label}”…";
     readonly listenFailed: "“{label}” couldn’t be transcribed.";
     readonly filmCutting: "Cutting the film – this takes about a minute.";
@@ -225,6 +236,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 +479,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 +503,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 +562,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;
@@ -556,6 +590,22 @@ export interface BrandView {
     name: string;
     accent: string | null;
     logoUrl: string | null;
+    /** How the pages look: the run page sets its tokens from it. */
+    theme: RunTheme;
+}
+/** How a wizard's pages look, taken from its space's brand (`runTheme`). Null: the runner's own. */
+export interface RunTheme {
+    /** Buttons and marks. */
+    accent: string | null;
+    /** What is there, done or good to know: ticks, tips, group headings. */
+    second: string | null;
+    /** The ground the pages stand on; its hue tints paper and ink. */
+    background: string | null;
+    /** Typefaces as CSS names them. */
+    display: string | null;
+    body: string | null;
+    /** The brand stands on a dark ground. */
+    dark: boolean;
 }
 export interface PublicWizard {
     token: string;
@@ -577,6 +627,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
@@ -18,6 +20,8 @@ const NOTES_EN = {
     },
     videoRendering: "Rendering the video – this usually takes 1–3 minutes.",
     photo: "Looking at photo {n} of {total}",
+    // An entry a step has just written, while it writes the rest: "Rezepte: Shakshuka mit Feta".
+    found: "{label}: {name}",
     listen: "Listening to “{label}”…",
     listenFailed: "“{label}” couldn’t be transcribed.",
     filmCutting: "Cutting the film – this takes about a minute.",
@@ -65,6 +69,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.",
@@ -303,6 +310,7 @@ const NOTES_DE = {
     },
     videoRendering: "Das Video wird gerendert – das dauert meist 1–3 Minuten.",
     photo: "Sieht sich Foto {n} von {total} an",
+    found: "{label}: {name}",
     listen: "Hört „{label}“ an …",
     listenFailed: "„{label}“ konnte nicht verschriftlicht werden.",
     filmCutting: "Der Film wird geschnitten – das dauert etwa eine Minute.",
@@ -350,6 +358,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 +589,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);
 }