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

package/dist/i18n/index.d.ts

@@ -28,6 +28,11 @@ import type { I18nConfig, I18nServiceApi } from "./types.js";
  */
 export declare function createPieI18n(config?: I18nConfig): I18nServiceApi;
 export { BUNDLED_LOCALES, loadBundledCatalog } from "./catalogs.js";
-export { findBestLanguageMatch, languageTagLookupSequence, languageTagsEqual, normalizeLanguageTag, toLanguageTag, } from "./language-tags.js";
-export { DEFAULT_LOCALE, detectBrowserLocale, dynamicMessageKey, getDefaultI18n, localeDirection, resolveInterfaceI18n, SimpleI18n, } from "./provider.js";
+export { canonicalLanguageTag, findBestLanguageMatch, findClosestLanguageMatch, languageTagLookupSequence, languageTagScriptLookupSequence, languageTagsEqual, negotiateContentLanguage, normalizeLanguageTag, toLanguageTag, } from "./language-tags.js";
+export type { ContentLanguageMatch } from "./language-tags.js";
+export { DEFAULT_LOCALE, detectBrowserLocale, dynamicMessageKey, getDefaultI18n, hostChoseInterfaceLocale, isLocaleRequested, localeDirection, requestedInterfaceLocale, resolveInterfaceI18n, SimpleI18n, stampInterfaceLocale, } from "./provider.js";
+export { type ContentLanguageAttributes, contentLanguageAttributes, defaultContentLanguage, firstStrongDirection, stampContentLanguage, UNDECLARED_CONTENT_LANGUAGE, undeclaredDirectionMismatch, } from "./content-language.js";
+export { type InterfaceLocaleLoadErrorModel, reportInterfaceLocaleLoadError, } from "./locale-load-error.js";
+export { PSEUDO_LOCALE_EXPANDED, PSEUDO_LOCALE_RTL, pseudoLocalize, } from "./pseudo.js";
+export type { PseudoLocalizeOptions } from "./pseudo.js";
 export type { BundledLocaleCode, DynamicMessageKey, I18nConfig, I18nProvider, I18nServiceApi, InterpolationValues, LocaleCode, MessageCatalog, MessageKey, MessageKeyInput, MessageNode, PluralOptions, PluralTranslation, TextDirection, TranslationBundle, } from "./types.js";

package/dist/i18n/index.js

@@ -35,5 +35,8 @@ export function createPieI18n(config = {}) {
     });
 }
 export { BUNDLED_LOCALES, loadBundledCatalog } from "./catalogs.js";
-export { findBestLanguageMatch, languageTagLookupSequence, languageTagsEqual, normalizeLanguageTag, toLanguageTag, } from "./language-tags.js";
-export { DEFAULT_LOCALE, detectBrowserLocale, dynamicMessageKey, getDefaultI18n, localeDirection, resolveInterfaceI18n, SimpleI18n, } from "./provider.js";
+export { canonicalLanguageTag, findBestLanguageMatch, findClosestLanguageMatch, languageTagLookupSequence, languageTagScriptLookupSequence, languageTagsEqual, negotiateContentLanguage, normalizeLanguageTag, toLanguageTag, } from "./language-tags.js";
+export { DEFAULT_LOCALE, detectBrowserLocale, dynamicMessageKey, getDefaultI18n, hostChoseInterfaceLocale, isLocaleRequested, localeDirection, requestedInterfaceLocale, resolveInterfaceI18n, SimpleI18n, stampInterfaceLocale, } from "./provider.js";
+export { contentLanguageAttributes, defaultContentLanguage, firstStrongDirection, stampContentLanguage, UNDECLARED_CONTENT_LANGUAGE, undeclaredDirectionMismatch, } from "./content-language.js";
+export { reportInterfaceLocaleLoadError, } from "./locale-load-error.js";
+export { PSEUDO_LOCALE_EXPANDED, PSEUDO_LOCALE_RTL, pseudoLocalize, } from "./pseudo.js";

package/dist/i18n/language-tags.d.ts

@@ -1,59 +1,7 @@
 /**
- * BCP-47 language tag comparison.
- *
- * Deliberately carries no locale data and no DOM access: this module is the one
- * piece of language machinery that everything else needs, including the
- * accessibility catalog resolver and TTS voice selection, neither of which wants
- * a message catalog. Importing `../i18n/index.js` would pull the eagerly-bundled
- * English translations, so this stays a separate entry point.
- *
- * Content producers do not agree on tag syntax. The Learnosity transform emits
- * POSIX `es_ES`, QTI catalog cards carry BCP-47 `xml:lang`, and pie-elements-ng
- * carries a hand-written POSIX-to-BCP-47 mapping table of its own. Comparing
- * with `===`, as the catalog resolver did, means an `es_ES` card matches no
- * request for `es-ES` and surfaces only through a no-language-constraint
- * fallback — resolution by accident.
+ * BCP-47 language tag comparison, from `@pie-players/pie-language-tags`, which
+ * pie-elements-ng's i18n engine imports too.
  *
  * @module @pie-players/pie-players-shared/i18n/language-tags
  */
-/**
- * Canonicalize a language tag for comparison.
- *
- * Converts POSIX underscores to hyphens, strips a POSIX charset or modifier
- * suffix (`es_ES.UTF-8`, `es_ES@euro`), and lowercases. Lowercasing rather than
- * applying BCP-47 display casing is intentional — this output is a comparison
- * key, not something to render. `toLanguageTag` is the form to render.
- *
- * Returns an empty string for nullish or blank input, which callers read as
- * "this card declares no language".
- */
-export declare function normalizeLanguageTag(tag: string | null | undefined): string;
-/**
- * A tag in BCP-47 syntax with its authored casing kept: POSIX underscores become
- * hyphens, so `es_ES` renders as `es-ES`. The form for a `lang` attribute or a
- * platform locale API.
- *
- * Returns an empty string for nullish or blank input.
- */
-export declare function toLanguageTag(tag: string | null | undefined): string;
-/**
- * Whether two language tags denote the same locale, ignoring separator style and
- * case. Two tags that both declare no language are not a match.
- */
-export declare function languageTagsEqual(a: string | null | undefined, b: string | null | undefined): boolean;
-/**
- * The RFC 4647 lookup sequence for a tag, most specific first.
- *
- * `es-MX` yields `["es-mx", "es"]`, so a request for Mexican Spanish reaches a
- * card tagged plain `es` without also reaching one tagged `es-ES`. Truncation
- * never stops on a singleton subtag (`x`, `u`), per RFC 4647 §3.4, and never
- * produces a bare region or script.
- */
-export declare function languageTagLookupSequence(tag: string | null | undefined): string[];
-/**
- * Best available tag for a request, by RFC 4647 lookup, or `undefined` when
- * nothing matches. Ranking is by the request's specificity rather than the
- * candidates' order, so `es-MX` prefers an `es-MX` candidate over an `es` one
- * however they were authored.
- */
-export declare function findBestLanguageMatch(requested: string | null | undefined, available: readonly (string | null | undefined)[]): string | undefined;
+export * from "@pie-players/pie-language-tags";

package/dist/i18n/language-tags.js

@@ -1,94 +1,7 @@
 /**
- * BCP-47 language tag comparison.
- *
- * Deliberately carries no locale data and no DOM access: this module is the one
- * piece of language machinery that everything else needs, including the
- * accessibility catalog resolver and TTS voice selection, neither of which wants
- * a message catalog. Importing `../i18n/index.js` would pull the eagerly-bundled
- * English translations, so this stays a separate entry point.
- *
- * Content producers do not agree on tag syntax. The Learnosity transform emits
- * POSIX `es_ES`, QTI catalog cards carry BCP-47 `xml:lang`, and pie-elements-ng
- * carries a hand-written POSIX-to-BCP-47 mapping table of its own. Comparing
- * with `===`, as the catalog resolver did, means an `es_ES` card matches no
- * request for `es-ES` and surfaces only through a no-language-constraint
- * fallback — resolution by accident.
+ * BCP-47 language tag comparison, from `@pie-players/pie-language-tags`, which
+ * pie-elements-ng's i18n engine imports too.
  *
  * @module @pie-players/pie-players-shared/i18n/language-tags
  */
-/**
- * Canonicalize a language tag for comparison.
- *
- * Converts POSIX underscores to hyphens, strips a POSIX charset or modifier
- * suffix (`es_ES.UTF-8`, `es_ES@euro`), and lowercases. Lowercasing rather than
- * applying BCP-47 display casing is intentional — this output is a comparison
- * key, not something to render. `toLanguageTag` is the form to render.
- *
- * Returns an empty string for nullish or blank input, which callers read as
- * "this card declares no language".
- */
-export function normalizeLanguageTag(tag) {
-    if (!tag)
-        return "";
-    const separatorsUnified = tag.trim().replace(/_/g, "-");
-    const withoutPosixSuffix = separatorsUnified.split(/[.@]/)[0];
-    return withoutPosixSuffix.toLowerCase();
-}
-/**
- * A tag in BCP-47 syntax with its authored casing kept: POSIX underscores become
- * hyphens, so `es_ES` renders as `es-ES`. The form for a `lang` attribute or a
- * platform locale API.
- *
- * Returns an empty string for nullish or blank input.
- */
-export function toLanguageTag(tag) {
-    return tag ? tag.trim().replace(/_/g, "-") : "";
-}
-/**
- * Whether two language tags denote the same locale, ignoring separator style and
- * case. Two tags that both declare no language are not a match.
- */
-export function languageTagsEqual(a, b) {
-    const left = normalizeLanguageTag(a);
-    if (!left)
-        return false;
-    return left === normalizeLanguageTag(b);
-}
-/**
- * The RFC 4647 lookup sequence for a tag, most specific first.
- *
- * `es-MX` yields `["es-mx", "es"]`, so a request for Mexican Spanish reaches a
- * card tagged plain `es` without also reaching one tagged `es-ES`. Truncation
- * never stops on a singleton subtag (`x`, `u`), per RFC 4647 §3.4, and never
- * produces a bare region or script.
- */
-export function languageTagLookupSequence(tag) {
-    const normalized = normalizeLanguageTag(tag);
-    if (!normalized)
-        return [];
-    const subtags = normalized.split("-");
-    const sequence = [];
-    for (let length = subtags.length; length > 0; length--) {
-        const candidate = subtags.slice(0, length);
-        // A trailing singleton introduces an extension with nothing left in it.
-        if (candidate.length > 1 && candidate[candidate.length - 1].length === 1) {
-            continue;
-        }
-        sequence.push(candidate.join("-"));
-    }
-    return sequence;
-}
-/**
- * Best available tag for a request, by RFC 4647 lookup, or `undefined` when
- * nothing matches. Ranking is by the request's specificity rather than the
- * candidates' order, so `es-MX` prefers an `es-MX` candidate over an `es` one
- * however they were authored.
- */
-export function findBestLanguageMatch(requested, available) {
-    for (const step of languageTagLookupSequence(requested)) {
-        const hit = available.find((candidate) => normalizeLanguageTag(candidate) === step);
-        if (hit != null)
-            return hit;
-    }
-    return undefined;
-}
+export * from "@pie-players/pie-language-tags";

package/dist/i18n/locale-load-error.d.ts

@@ -0,0 +1,35 @@
+/**
+ * The `framework-error` report for a failed interface-locale catalog load.
+ *
+ * Every locale driver — the toolkit through its error bus, the standalone item
+ * player and the reference assembly through this helper — reports the same
+ * failure the same way: a `framework-error` DOM event whose detail carries the
+ * `i18n-locale-load` kind with `recoverable: true`, because every key still
+ * resolves through the English fallback chain and the player renders — in the
+ * wrong language, which a host wants to know about.
+ *
+ * The shape mirrors the toolkit's `FrameworkErrorModel` field for field. It is
+ * declared here, narrowly, because the standalone item player does not depend
+ * on the toolkit and a type-only import would still drag it into the published
+ * declarations; what this module commits to is the fields below, which is what
+ * a host reading `.kind` and `.recoverable` consumes.
+ */
+export interface InterfaceLocaleLoadErrorModel {
+    kind: "i18n-locale-load";
+    source: string;
+    message: string;
+    details: string[];
+    recoverable: true;
+    scope: "runtime";
+    cause?: unknown;
+}
+/**
+ * Dispatches the recoverable load-failure report on `target` as a
+ * `bubbles`/`composed` `framework-error` event. No-op without a target, so a
+ * caller mounted as a plain component rather than an element stays silent.
+ *
+ * Failed loads are not cached: a later change of the `locale` attribute back
+ * to that locale, or recomposing the `i18n` provider, drives `setLocale` again
+ * and so retries.
+ */
+export declare function reportInterfaceLocaleLoadError(target: Element | null | undefined, source: string, cause: unknown): void;

package/dist/i18n/locale-load-error.js

@@ -0,0 +1,30 @@
+/**
+ * Dispatches the recoverable load-failure report on `target` as a
+ * `bubbles`/`composed` `framework-error` event. No-op without a target, so a
+ * caller mounted as a plain component rather than an element stays silent.
+ *
+ * Failed loads are not cached: a later change of the `locale` attribute back
+ * to that locale, or recomposing the `i18n` provider, drives `setLocale` again
+ * and so retries.
+ */
+export function reportInterfaceLocaleLoadError(target, source, cause) {
+    if (!target)
+        return;
+    const message = cause instanceof Error && cause.message.trim().length > 0
+        ? cause.message
+        : String(cause ?? "Unknown catalog load failure");
+    const detail = {
+        kind: "i18n-locale-load",
+        source,
+        message,
+        details: [],
+        recoverable: true,
+        scope: "runtime",
+        cause,
+    };
+    target.dispatchEvent(new CustomEvent("framework-error", {
+        detail,
+        bubbles: true,
+        composed: true,
+    }));
+}

package/dist/i18n/messages/en-US.d.ts

@@ -57,6 +57,8 @@ declare const enUS: {
         apply: string;
         enabled: string;
         disabled: string;
+        lookUp: string;
+        wordOrPhrase: string;
         closeA11y: string;
         settingsA11y: string;
     };
@@ -89,6 +91,14 @@ declare const enUS: {
         resizeMediaRegion: string;
         resizeQuestionAndMediaA11y: string;
         resizePassageAndMediaA11y: string;
+        resizePassageAndQuestionA11y: string;
+        passageWidthA11y: string;
+        /**
+         * 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: string;
+        questionPositionLabeledA11y: string;
         /**
          * The assessment player's own section-to-section navigation. Its Back and
          * Next controls take `common.back` / `common.next`.
@@ -99,16 +109,16 @@ declare const enUS: {
             loadFailed: string;
             restoreFailed: string;
         };
-        /** Formative delivery: check-answer control and its outcome announcements. */
-        formative: {
-            checkAnswer: string;
+        /** Item session control: check-answer control and its outcome announcements. */
+        check: {
+            answer: string;
             tryAgain: string;
             answerRecorded: string;
             correct: string;
             partlyCorrect: string;
             notCorrect: string;
             notAutoScored: string;
-            checkFailed: string;
+            failed: string;
             /**
              * Appended after the outcome, so the announcement reads
              * "Not correct. 2 tries left." Kept a separate plural group rather than
@@ -139,6 +149,29 @@ declare const enUS: {
             playbackAdvisory: string;
             playbackReleased: string;
         };
+        /**
+         * `<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: string;
+            answer: string;
+            manualScoring: string;
+            audio: string;
+            video: string;
+        };
+        /** `<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: string;
+            /** Names the block of an entry's search matches below its summary. */
+            highlights: string;
+            /** The row toggle's tooltip while the row is expanded: collapsing returns it to the summary. */
+            collapse: string;
+            /** Shown in an expanded row whose player failed to load; the summary keeps showing above it. */
+            playerError: string;
+        };
     };
     /** Toolbar and tool-shell chrome owned by the assessment toolkit. */
     toolkit: {
@@ -159,17 +192,20 @@ declare const enUS: {
             moveRightA11y: string;
             moveUpA11y: string;
             moveDownA11y: string;
-            shrinkA11y: string;
-            growA11y: string;
+            narrowerA11y: string;
+            widerA11y: string;
+            shorterA11y: string;
+            tallerA11y: string;
             centerA11y: string;
             closeA11y: string;
         };
         /**
-         * 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: string;
+            moveAndResizeA11y: string;
             rotateClockwiseA11y: string;
             rotateCounterclockwiseA11y: string;
         };
@@ -209,6 +245,7 @@ declare const enUS: {
             toolA11y: string;
             loading: string;
             providerUnavailable: string;
+            initFailed: string;
         };
         graph: {
             name: string;
@@ -264,6 +301,12 @@ declare const enUS: {
                 lanthanide: string;
                 actinide: string;
             };
+            /** Standard-state phase, keyed by the data file's lowercased `phase` value. */
+            phaseValue: {
+                solid: string;
+                liquid: string;
+                gas: string;
+            };
         };
         ruler: {
             name: string;
@@ -302,6 +345,15 @@ declare const enUS: {
             buttonA11y: string;
             tooltip: string;
             toolA11y: string;
+            notConfigured: string;
+            idleHint: string;
+            lookingUp: string;
+            noEntryFor: string;
+            entriesCount: {
+                one: string;
+                other: string;
+            };
+            noEntryStatusFor: string;
         };
         pictureDictionary: {
             name: string;
@@ -309,6 +361,15 @@ declare const enUS: {
             buttonA11y: string;
             tooltip: string;
             toolA11y: string;
+            notConfigured: string;
+            idleHint: string;
+            lookingUp: string;
+            noEntryFor: string;
+            entriesCount: {
+                one: string;
+                other: string;
+            };
+            noEntryStatusFor: string;
         };
         /**
          * The Spanish variants. Named in the interface locale like every other tool label —
@@ -341,15 +402,47 @@ declare const enUS: {
             windowHeightAnnounce: string;
             frameHeightAnnounce: string;
             widthAnnounce: string;
+            shorterWindowA11y: string;
+            tallerWindowA11y: string;
+            shorterFrameA11y: string;
+            tallerFrameA11y: string;
+            narrowerA11y: string;
+            widerA11y: string;
             applicationA11y: string;
             resizeWindowFullA11y: string;
             resizeFrameFullA11y: string;
         };
+        magnification: {
+            name: string;
+            description: string;
+            buttonA11y: string;
+            tooltip: string;
+            roleA11y: string;
+            applicationA11y: string;
+            zoomIn: string;
+            zoomOut: string;
+            zoomLevel: string;
+            zoomAnnounce: string;
+            close: string;
+            resizeA11y: string;
+            resizeFullA11y: string;
+            sizeAnnounce: string;
+            narrowerA11y: string;
+            widerA11y: string;
+            shorterA11y: string;
+            tallerA11y: string;
+        };
         answerEliminator: {
             name: string;
             description: string;
             buttonA11y: string;
             tooltip: string;
+            /** A choice's toggle; `{choice}` is the choice's own accessible name. */
+            toggleA11y: string;
+            /** Appended to an eliminated choice's label for assistive technology. */
+            eliminatedA11y: string;
+            /** Stands in for `{choice}` when a choice has no text of its own. */
+            unlabeledChoice: string;
         };
         highlighter: {
             name: string;
@@ -375,6 +468,17 @@ declare const enUS: {
             highlightPinkA11y: string;
             highlightBlueA11y: string;
             highlightGreenA11y: string;
+            selectionAvailableA11y: string;
+            highlightedYellowA11y: string;
+            highlightedPinkA11y: string;
+            highlightedBlueA11y: string;
+            highlightedGreenA11y: string;
+            underlinedA11y: string;
+            removedA11y: string;
+            clearedA11y: {
+                one: string;
+                other: string;
+            };
         };
         theme: {
             name: string;
@@ -498,6 +602,30 @@ declare const enUS: {
         toggleEventPanelA11y: string;
         toggleDatabasePanelA11y: string;
         toggleInstrumentationPanelA11y: string;
+        clear: string;
+        pause: string;
+        resume: string;
+        controllerUnavailable: string;
+        noMatchingEvents: string;
+        noSectionSessionYet: string;
+        eventLevelItem: string;
+        eventLevelSection: string;
+        instrumentationKindAll: string;
+        instrumentationKindEvent: string;
+        instrumentationKindError: string;
+        instrumentationKindMetric: string;
+        instrumentationKindUserContext: string;
+        instrumentationKindGlobalAttributes: string;
+        instrumentationFieldName: string;
+        instrumentationFieldKind: string;
+        instrumentationFieldProvider: string;
+        instrumentationFieldTimestamp: string;
+        instrumentationFieldValue: string;
+        instrumentationFieldError: string;
+        sessionDbAssessmentId: string;
+        sessionDbSectionId: string;
+        sessionDbAttemptId: string;
+        sessionDbMode: string;
         /** PNP debugger. */
         pnp: {
             title: string;
@@ -517,6 +645,12 @@ declare const enUS: {
             perToolDecisions: string;
             policyDiagnostics: string;
             profileReadOnly: string;
+            on: string;
+            effective: string;
+            needs: string;
+            hostSurfaceNotPlaced: string;
+            support: string;
+            prohibit: string;
         };
         /** TTS settings panel. */
         tts: {
@@ -612,6 +746,16 @@ declare const enUS: {
             previewHintGoogleSsml: string;
             previewHintCustom: string;
             previewHintTracking: string;
+            formatMp3: string;
+            formatOgg: string;
+            formatPcm: string;
+            sampleRate8000: string;
+            sampleRate16000: string;
+            sampleRate22050: string;
+            sampleRate24000: string;
+            apiEndpointPlaceholder: string;
+            languagePlaceholder: string;
+            ssml: string;
         };
     };
 };