@pie-players/pie-players-shared 1.0.0-beta.0 → 1.0.0-beta.10

package/dist/i18n/messages/en-US.js

@@ -57,6 +57,8 @@ const enUS = {
         apply: "Apply",
         enabled: "Enabled",
         disabled: "Disabled",
+        lookUp: "Look up",
+        wordOrPhrase: "Word or phrase",
         closeA11y: "Close",
         settingsA11y: "Open settings menu",
     },
@@ -89,6 +91,14 @@ const enUS = {
         resizeMediaRegion: "Resize media region",
         resizeQuestionAndMediaA11y: "Resize question and media panels",
         resizePassageAndMediaA11y: "Resize passage and media panels",
+        resizePassageAndQuestionA11y: "Resize passage and question panels",
+        passageWidthA11y: "{percent}% passage width",
+        /**
+         * The section player's navigation live region, announced when the active
+         * item changes; `{label}` is the item's own label when it has one.
+         */
+        questionPositionA11y: "Question {position} of {total}",
+        questionPositionLabeledA11y: "{label}, question {position} of {total}",
         /**
          * The assessment player's own section-to-section navigation. Its Back and
          * Next controls take `common.back` / `common.next`.
@@ -99,16 +109,16 @@ const enUS = {
             loadFailed: "The assessment could not be loaded. Try again.",
             restoreFailed: "Your saved answers for this section could not be restored. Try again.",
         },
-        /** Formative delivery: check-answer control and its outcome announcements. */
-        formative: {
-            checkAnswer: "Check answer",
+        /** Item session control: check-answer control and its outcome announcements. */
+        check: {
+            answer: "Check answer",
             tryAgain: "Try again",
             answerRecorded: "Answer recorded.",
             correct: "Correct.",
             partlyCorrect: "Partly correct.",
             notCorrect: "Not correct.",
             notAutoScored: "Answer recorded. This question is not scored automatically.",
-            checkFailed: "This question could not be checked. Try again.",
+            failed: "This question could not be checked. Try again.",
             /**
              * Appended after the outcome, so the announcement reads
              * "Not correct. 2 tries left." Kept a separate plural group rather than
@@ -139,6 +149,29 @@ const enUS = {
             playbackAdvisory: "Answer question {position} before continuing with the media.",
             playbackReleased: "Answer accepted. Continue playing the media.",
         },
+        /**
+         * `<pie-item-summary>`: an item described as a list row, without loading its
+         * elements. The correct marker's glyph is hidden from assistive technology,
+         * which reads `correctA11y` instead.
+         */
+        summary: {
+            correctA11y: "Correct answer",
+            answer: "Answer",
+            manualScoring: "Scored by a teacher",
+            audio: "Audio",
+            video: "Video",
+        },
+        /** `<pie-item-list>`. */
+        list: {
+            /** The row toggle, a disclosure button whose `aria-expanded` carries the state, so its label stays the same either way. */
+            expandA11y: "Show the full item",
+            /** Names the block of an entry's search matches below its summary. */
+            highlights: "Search matches",
+            /** The row toggle's tooltip while the row is expanded: collapsing returns it to the summary. */
+            collapse: "Show the summary",
+            /** Shown in an expanded row whose player failed to load; the summary keeps showing above it. */
+            playerError: "The full item could not be loaded.",
+        },
     },
     /** Toolbar and tool-shell chrome owned by the assessment toolkit. */
     toolkit: {
@@ -159,17 +192,20 @@ const enUS = {
             moveRightA11y: "Move tool right",
             moveUpA11y: "Move tool up",
             moveDownA11y: "Move tool down",
-            shrinkA11y: "Shrink tool window",
-            growA11y: "Grow tool window",
+            narrowerA11y: "Make tool window narrower",
+            widerA11y: "Make tool window wider",
+            shorterA11y: "Make tool window shorter",
+            tallerA11y: "Make tool window taller",
             centerA11y: "Center tool window",
             closeA11y: "Close tool",
         },
         /**
-         * The tap controls that move and turn the ruler and protractor without a
+         * The tap controls that move, turn and resize a placed tool without a
          * drag. The move buttons reuse the `window` labels above.
          */
         placement: {
             controlsA11y: "Move and rotate",
+            moveAndResizeA11y: "Move and resize",
             rotateClockwiseA11y: "Rotate {degrees}° clockwise",
             rotateCounterclockwiseA11y: "Rotate {degrees}° counterclockwise",
         },
@@ -214,6 +250,7 @@ const enUS = {
             toolA11y: "Calculator tool",
             loading: "Loading calculator…",
             providerUnavailable: "The calculator is unavailable.",
+            initFailed: "Calculator failed to initialize.",
         },
         graph: {
             name: "Graph",
@@ -269,6 +306,12 @@ const enUS = {
                 lanthanide: "Lanthanide",
                 actinide: "Actinide",
             },
+            /** Standard-state phase, keyed by the data file's lowercased `phase` value. */
+            phaseValue: {
+                solid: "Solid",
+                liquid: "Liquid",
+                gas: "Gas",
+            },
         },
         ruler: {
             name: "Ruler",
@@ -313,6 +356,21 @@ const enUS = {
             buttonA11y: "Dictionary, look up word definitions",
             tooltip: "Dictionary",
             toolA11y: "Dictionary",
+            // The lookup panel's notices are authored whole: the term interpolates
+            // into the sentence, never around it.
+            notConfigured: "No dictionary service is configured for this assessment.",
+            idleHint: "Type a word to look it up.",
+            lookingUp: "Looking up “{term}”…",
+            noEntryFor: "No entry for “{term}”.",
+            // The polite live-region status after a lookup: the count summary and
+            // the no-entry announcement, phrased without the quotation marks the
+            // visible notices carry. The count calls plural(), never a `=== 1`
+            // branch.
+            entriesCount: {
+                one: "{count} entry",
+                other: "{count} entries",
+            },
+            noEntryStatusFor: "No dictionary entry for {term}.",
         },
         pictureDictionary: {
             name: "Picture Dictionary",
@@ -320,6 +378,15 @@ const enUS = {
             buttonA11y: "Picture Dictionary, look up pictures for words",
             tooltip: "Picture Dictionary",
             toolA11y: "Picture Dictionary",
+            notConfigured: "No picture dictionary service is configured for this assessment.",
+            idleHint: "Type a word to see a picture of it.",
+            lookingUp: "Looking up “{term}”…",
+            noEntryFor: "No picture for “{term}”.",
+            entriesCount: {
+                one: "{count} picture",
+                other: "{count} pictures",
+            },
+            noEntryStatusFor: "No picture for {term}.",
         },
         /**
          * The Spanish variants. Named in the interface locale like every other tool label —
@@ -352,15 +419,47 @@ const enUS = {
             windowHeightAnnounce: "Reading window height {pixels} pixels",
             frameHeightAnnounce: "Frame height {pixels} pixels",
             widthAnnounce: "Width {pixels} pixels",
+            shorterWindowA11y: "Make the reading window shorter",
+            tallerWindowA11y: "Make the reading window taller",
+            shorterFrameA11y: "Make the frame shorter",
+            tallerFrameA11y: "Make the frame taller",
+            narrowerA11y: "Make the line reader narrower",
+            widerA11y: "Make the line reader wider",
             applicationA11y: "Line Reader tool. A clear reading window inside an obscuring frame. Use arrow keys to move, +/- to resize the reading window, Escape to close. Reading window height: {paneHeight} pixels, Frame height: {frameHeight} pixels",
             resizeWindowFullA11y: "Resize the reading window. Drag, or use the up and down arrow keys to change its height. Current height {paneHeight} pixels",
             resizeFrameFullA11y: "Resize the frame. Drag, or use the up and down arrow keys to change the frame height and the left and right arrow keys to change the width. Current frame height {frameHeight} pixels, width {width} pixels",
         },
+        magnification: {
+            name: "Magnifier",
+            description: "Magnify the content under a movable lens",
+            buttonA11y: "Magnifier, enlarge the content under a lens",
+            tooltip: "Magnifier",
+            roleA11y: "Draggable and resizable magnifying lens",
+            applicationA11y: "Magnifier at {zoom} times. Use the arrow keys to move the lens, + and - to change the zoom, and Escape to close.",
+            zoomIn: "Zoom in",
+            zoomOut: "Zoom out",
+            zoomLevel: "{zoom}×",
+            zoomAnnounce: "Zoom {zoom} times",
+            close: "Close magnifier",
+            resizeA11y: "Drag to resize the magnifier",
+            resizeFullA11y: "Resize the magnifier. Drag, or use the arrow keys. Current size {width} by {height} pixels",
+            sizeAnnounce: "Magnifier {width} by {height} pixels",
+            narrowerA11y: "Make the magnifier narrower",
+            widerA11y: "Make the magnifier wider",
+            shorterA11y: "Make the magnifier shorter",
+            tallerA11y: "Make the magnifier taller",
+        },
         answerEliminator: {
             name: "Answer Eliminator",
             description: "Strike through answer choices",
             buttonA11y: "Strike Through, eliminate answer choices",
             tooltip: "Strike Through",
+            /** A choice's toggle; `{choice}` is the choice's own accessible name. */
+            toggleA11y: "Toggle elimination for {choice}",
+            /** Appended to an eliminated choice's label for assistive technology. */
+            eliminatedA11y: "(eliminated)",
+            /** Stands in for `{choice}` when a choice has no text of its own. */
+            unlabeledChoice: "Unlabeled choice",
         },
         highlighter: {
             name: "Highlighter",
@@ -389,6 +488,19 @@ const enUS = {
             highlightPinkA11y: "Pink highlight",
             highlightBlueA11y: "Blue highlight",
             highlightGreenA11y: "Green highlight",
+            // Announced in the strip's live region. A colour is authored per phrase:
+            // a colour adjective agrees with its noun in some languages.
+            selectionAvailableA11y: "Annotation toolbar available for “{text}”. Press Shift+F10 for annotation tools.",
+            highlightedYellowA11y: "“{text}” highlighted in yellow",
+            highlightedPinkA11y: "“{text}” highlighted in pink",
+            highlightedBlueA11y: "“{text}” highlighted in blue",
+            highlightedGreenA11y: "“{text}” highlighted in green",
+            underlinedA11y: "“{text}” underlined",
+            removedA11y: "Removed annotation from “{text}”",
+            clearedA11y: {
+                one: "{count} annotation cleared",
+                other: "{count} annotations cleared",
+            },
         },
         theme: {
             name: "Theme",
@@ -512,6 +624,39 @@ const enUS = {
         toggleEventPanelA11y: "Toggle event broadcast panel",
         toggleDatabasePanelA11y: "Toggle database state panel",
         toggleInstrumentationPanelA11y: "Toggle instrumentation panel",
+        // Panel actions and status. "clear"/"pause"/"resume" stay lowercase in
+        // English to match the dev panels' chrome; locales render their own
+        // register.
+        clear: "clear",
+        pause: "pause",
+        resume: "resume",
+        controllerUnavailable: "controller unavailable",
+        noMatchingEvents: "No matching events yet. Interact with an item to capture controller events.",
+        noSectionSessionYet: "No section session data yet. Interact with the questions to see updates.",
+        eventLevelItem: "item",
+        eventLevelSection: "section",
+        // Instrumentation record-kind identifiers. They name the emitted
+        // records, so every locale carries them verbatim; a locale that
+        // prefers translated labels can override per key.
+        instrumentationKindAll: "all",
+        instrumentationKindEvent: "event",
+        instrumentationKindError: "error",
+        instrumentationKindMetric: "metric",
+        instrumentationKindUserContext: "user-context",
+        instrumentationKindGlobalAttributes: "global-attributes",
+        // Instrumentation detail-field labels.
+        instrumentationFieldName: "name:",
+        instrumentationFieldKind: "kind:",
+        instrumentationFieldProvider: "provider:",
+        instrumentationFieldTimestamp: "timestamp:",
+        instrumentationFieldValue: "value:",
+        instrumentationFieldError: "error:",
+        // Session-db payload field names — identifiers, verbatim across
+        // locales like the record kinds above.
+        sessionDbAssessmentId: "assessmentId:",
+        sessionDbSectionId: "sectionId:",
+        sessionDbAttemptId: "attemptId:",
+        sessionDbMode: "mode:",
         /** PNP debugger. */
         pnp: {
             title: "PNP Profile",
@@ -531,6 +676,12 @@ const enUS = {
             perToolDecisions: "Per-Tool Decisions",
             policyDiagnostics: "Policy Diagnostics",
             profileReadOnly: "PNP Profile (read-only)",
+            on: "On",
+            effective: "Effective:",
+            needs: "needs",
+            hostSurfaceNotPlaced: "host surface (not placed)",
+            support: "support",
+            prohibit: "prohibit",
         },
         /** TTS settings panel. */
         tts: {
@@ -628,6 +779,16 @@ const enUS = {
             previewHintGoogleSsml: "SSML preserved. Tracking disabled.",
             previewHintCustom: "Tracking enabled when provider returns speech marks.",
             previewHintTracking: "Tracking enabled while preview plays.",
+            formatMp3: "MP3",
+            formatOgg: "OGG",
+            formatPcm: "PCM",
+            sampleRate8000: "8000 Hz",
+            sampleRate16000: "16000 Hz",
+            sampleRate22050: "22050 Hz",
+            sampleRate24000: "24000 Hz",
+            apiEndpointPlaceholder: "/api/tts",
+            languagePlaceholder: "en-US",
+            ssml: "SSML",
         },
     },
 };

package/dist/i18n/provider.d.ts

@@ -51,12 +51,20 @@ export declare function detectBrowserLocale(): string;
 export declare class SimpleI18n implements I18nServiceApi {
     /** Shared across instances and views: `Intl.PluralRules` is not cheap. */
     private static readonly pluralRules;
-    private locale;
+    /** The latest request, canonical; what `getRequestedLocale` names. */
+    private requested;
+    /** The request whose strings are served; moves once its catalog is resident. */
+    private active;
+    /** The catalog serving `active`, resolved against catalogs alone. */
+    private activeCatalog;
     private readonly fallbackLocale;
     /** Shared by reference with every `withLocale` view. */
     private catalogs;
+    /** Keyed by normalized tag, so `ES`, `es_ES` and `es-es` reach one set. */
     private customMessages;
     private loading;
+    /** Counts `setLocale` calls, so a slow load cannot overwrite a later request. */
+    private requests;
     private readonly listeners;
     private config;
     constructor(config?: I18nConfig);
@@ -68,14 +76,30 @@ export declare class SimpleI18n implements I18nServiceApi {
      * {@link detectBrowserLocale}.
      */
     initialize(config: I18nConfig): Promise<void>;
+    /**
+     * The locale the strings are served in: the resolved catalog locale once
+     * resident, else the most specific host-message tag on the request's
+     * truncation chain, canonical, else the fallback. A request nothing serves
+     * names the fallback, so a chrome root stamped from it never names a
+     * language its text is not in.
+     */
     getLocale(): string;
+    /**
+     * The latest `setLocale` request (or the configured `locale`), canonical, as
+     * soon as it is made and whatever its load does. `getLocale` names what is
+     * served instead, so the two differ while a catalog loads, after a load
+     * fails, and for a tag nothing ships.
+     */
+    getRequestedLocale(): string;
     /**
      * Switch locale.
      *
      * Resolves the request against the catalogs this provider can serve, loads
      * the winner if it is not resident, then notifies subscribers — in that
      * order, so a component's reactive read re-runs against a catalog that is
-     * already in place rather than against the previous locale.
+     * already in place rather than against the previous locale. The last call
+     * wins: a call whose load finishes after a later call's leaves the locale
+     * to that later call.
      */
     setLocale(locale: LocaleCode): Promise<void>;
     t(key: MessageKeyInput, values?: InterpolationValues): string;
@@ -84,8 +108,12 @@ export declare class SimpleI18n implements I18nServiceApi {
      *
      * The category comes from `Intl.PluralRules` for the active locale, so a
      * locale with more than two forms resolves correctly: Arabic selects among
-     * zero/one/two/few/many/other, Polish among one/few/many/other. A category the
-     * catalog does not carry resolves to `other`.
+     * zero/one/two/few/many/other, Polish among one/few/many/other.
+     *
+     * Each form resolves on its own, tier by tier (`resolveMessage`): a host
+     * overriding one category leaves the others to the catalog, and a locale's
+     * own `other` wins over the fallback's `one`. A group no source completes is
+     * a miss and returns the key.
      */
     plural(key: MessageKeyInput, options: PluralOptions): string;
     getDirection(): TextDirection;
@@ -101,9 +129,11 @@ export declare class SimpleI18n implements I18nServiceApi {
      * Add or override messages for one locale.
      *
      * Deep-merged, so a deployment can override a single label without restating
-     * a catalog.
+     * a catalog, and keyed by normalized tag, so `es-mx` and `es-MX` are one
+     * locale's messages.
      */
     addCustomMessages(locale: string, messages: MessageCatalog): void;
+    private mergeCustomMessages;
     /**
      * A view of this provider fixed to another locale.
      *
@@ -118,21 +148,30 @@ export declare class SimpleI18n implements I18nServiceApi {
     /** The resolved catalog for a locale, for a host that wants to inspect it. */
     getBundle(locale?: LocaleCode): TranslationBundle | undefined;
     /**
-     * Which shipped catalog serves a requested tag.
-     *
-     * RFC 4647 lookup first, so `nl-BE` reaches `nl-NL` through `nl`; then
-     * primary-subtag widening, so a bare `nl` reaches the regional `nl-NL`
-     * catalog we actually ship. POSIX `nl_NL` normalizes on the way in, which is
-     * the form the Learnosity transform emits.
+     * Which catalog serves a requested tag, under `findClosestLanguageMatch`
+     * over the resident catalogs and the loader's declared tags. Host messages
+     * take no part: they resolve separately (`hostMessageLocale`), so a host
+     * override for `es-MX` cannot hide a shipped `es`.
      */
-    private resolveLocaleTag;
+    private resolveCatalogLocale;
+    /** The most specific host-message tag on a request's truncation chain, normalized. */
+    private hostMessageLocale;
     private loadCatalog;
     /**
-     * Resolution order for one key. Host overrides for the active locale win, so
-     * a deployment can rename one label without forking a catalog.
+     * Two tiers in lookup order: host messages along the active request's
+     * truncation chain (`es-MX`, then `es`) and the active catalog, then host
+     * messages and the catalog for the fallback locale. Host overrides win, so a
+     * deployment can rename one label without forking a catalog.
      */
-    private lookupNode;
-    private lookup;
+    private sourceTiers;
+    /**
+     * The text for `key`. The first source that has it decides its shape: a
+     * string is the text, and a plural group resolves `category`, else `other`,
+     * within the first tier that has a group, so a locale's own `other` wins
+     * over the fallback's `one`. A namespace (`t("common")`) is a miss:
+     * returning the object would put one where the caller expects a string.
+     */
+    private resolveMessage;
     private selectPluralCategory;
     private notify;
 }
@@ -143,7 +182,7 @@ export declare class SimpleI18n implements I18nServiceApi {
  * present, and this is that state. A tool mounted bare — in `print-player` or
  * an authoring harness — resolves this and renders English rather than
  * leaking raw message keys onto the screen. It carries no locale loader, so it
- * pulls no catalog beyond the 5 KB English one already in the bundle.
+ * pulls no catalog beyond the English one already in the bundle.
  */
 export declare function getDefaultI18n(): I18nServiceApi;
 /**
@@ -169,6 +208,71 @@ export declare function getDefaultI18n(): I18nServiceApi;
  * default rather than nothing, which is the graceful default the pull pattern
  * requires.
  */
+/** The rendering surface `resolveInterfaceI18n` promises. */
+export interface ResolvedInterfaceI18n extends I18nProvider {
+    /** Locale-aware number formatting, at the resolved locale. */
+    formatNumber(value: number, options?: Intl.NumberFormatOptions): string;
+    /** Locale-aware date formatting, at the resolved locale. */
+    formatDate(date: Date, options?: Intl.DateTimeFormatOptions): string;
+}
 export declare function resolveInterfaceI18n(source: {
     i18n?: I18nProvider;
-} | null | undefined): I18nProvider;
+} | null | undefined): ResolvedInterfaceI18n;
+/**
+ * Stamp the interface locale's `lang` and `dir` on a chrome element.
+ *
+ * The imperative form of the `lang={…} dir={…}` pair a template puts on its
+ * root, for the elements a template cannot reach: a shadow host whose chrome
+ * is slotted light DOM, a shell built with `document.createElement`, a vanilla
+ * element stamping itself. Call it from whatever already re-runs on a locale
+ * change and on a catalog load: `getLocale()` moves only once the requested
+ * catalog is resident, so a stamp taken at setup alone names the locale that
+ * rendered before the load.
+ */
+export declare function stampInterfaceLocale(target: Element, provider: Pick<I18nProvider, "getLocale" | "getDirection">): void;
+/**
+ * Whether `provider` was already asked for `locale`. An element handed its
+ * owner's provider together with the owner's `locale` skips asking again, so a
+ * catalog that fails to load is fetched and reported once, by the owner, and
+ * not again by every row and player under it.
+ */
+export declare function isLocaleRequested(provider: Pick<I18nProvider, "getRequestedLocale">, locale: string): boolean;
+/**
+ * Whether a host chose a player's interface locale: it set the player's
+ * `locale`, or supplied a provider that was asked for a locale other than
+ * `en-US`.
+ *
+ * A player answers `interfaceLocaleContext` from the first time this holds,
+ * and never before it. An element left unanswered labels its chrome in the
+ * language its item declares, which is how an item declaring Spanish keeps
+ * Spanish labels under a host that sets no locale; a default `en-US` answer
+ * would override that declaration. A supplied provider asked for `en-US` is
+ * not a choice, because hosts supply one to add catalogs or messages; a host
+ * that wants `en-US` chrome over the item's language sets `locale="en-US"`.
+ * Once answering, a player keeps answering, so clearing `locale` republishes
+ * `en-US` to the elements that subscribed.
+ *
+ * The toolkit and the item player both decide through this rule. An item
+ * player a section mounts receives the toolkit's provider, so it answers only
+ * when the toolkit above it would. Callers re-evaluate it on the provider's
+ * change signal, since a supplied provider's locale moves without a property
+ * change.
+ */
+export declare function hostChoseInterfaceLocale(player: {
+    locale?: unknown;
+    i18n?: Pick<I18nProvider, "getLocale" | "getRequestedLocale"> | null;
+}): boolean;
+/**
+ * The tag a player answers `interfaceLocaleContext` with: its `locale`,
+ * canonical, from the moment it is set, else its provider's requested tag.
+ *
+ * The request rather than the players' own catalog match, because elements
+ * resolve the tag against their own catalogs: a host asking for `en-GB` or
+ * `fr-CA` reaches the elements' catalogs and host messages for that tag
+ * whatever the players ship, and neither a players' catalog still loading nor
+ * one that failed holds the elements on the previous locale.
+ */
+export declare function requestedInterfaceLocale(player: {
+    locale?: unknown;
+    i18n: Pick<I18nProvider, "getLocale" | "getRequestedLocale">;
+}): string;