@readium/speech 0.8.1 → 0.9.1

package/build/navigator.d.ts

@@ -16,7 +16,7 @@ export interface ReadiumSpeechNavigatorContract extends Configurable<SpeechSetti
     setSpeakInContentLanguage(enabled: boolean): void;
     getSpeakInContentLanguage(): boolean;
     loadContent(content: ReadiumSpeechUtterance | ReadiumSpeechUtterance[]): void;
-    loadGndContent(nodes: GndObject[]): void;
+    loadGndContent(nodes: GndObject[]): Promise<void>;
     getCurrentContent(): ReadiumSpeechUtterance | null;
     getContentQueue(): ReadiumSpeechUtterance[];
     play(): void;

package/build/preferences/Configurable.d.ts

@@ -7,6 +7,6 @@ export interface ConfigurablePreferences<T> {
 }
 export interface Configurable<S extends ConfigurableSettings, P extends ConfigurablePreferences<P>> {
     settings: S;
-    submitPreferences(preferences: P): void;
+    submitPreferences(preferences: P): Promise<void>;
     preferencesEditor: IPreferencesEditor;
 }

package/build/preferences/index.d.ts

@@ -8,4 +8,4 @@ export { SpeechDefaults } from './SpeechDefaults.js';
 export type { ISpeechDefaults } from './SpeechDefaults.js';
 export { SpeechSettings } from './SpeechSettings.js';
 export { SpeechPreferencesEditor } from './SpeechPreferencesEditor.js';
-export { contextualizedAtVerbosity, skippableAtVerbosity } from './verbosityTables.js';
+export { contextualizationShapesAtVerbosity, contextualizedAtVerbosity, shapeableRoles, skippedAtVerbosity, } from './verbosityTables.js';

package/build/preferences/verbosityTables.d.ts

@@ -1,4 +1,10 @@
 import { GndRole } from '../gnd/types.js';
 import { VerbosityPreset } from './SpeechPreferences.js';
-export declare const skippableAtVerbosity: Readonly<Record<Exclude<VerbosityPreset, "custom">, ReadonlySet<GndRole>>>;
+export declare const skippedAtVerbosity: Readonly<Record<Exclude<VerbosityPreset, "custom">, ReadonlySet<GndRole>>>;
 export declare const contextualizedAtVerbosity: Readonly<Record<Exclude<VerbosityPreset, "custom">, ReadonlySet<GndRole>>>;
+type ContextualizationShape = "inline" | "block";
+export declare const contextualizationShapesAtVerbosity: Readonly<Record<Exclude<VerbosityPreset, "custom">, Readonly<Partial<Record<GndRole, ContextualizationShape>>>>>;
+export declare const shapeableRoles: readonly GndRole[];
+export type ContextualizationShapeOverrides = Partial<Record<GndRole, Partial<Record<VerbosityPreset, ContextualizationShape>>>>;
+export declare function resolveContextualizationShapes(verbosity: VerbosityPreset, overrides: ContextualizationShapeOverrides | undefined): Partial<Record<GndRole, ContextualizationShape>>;
+export {};

package/build/speechNavigator.d.ts

@@ -5,11 +5,19 @@ import { ISpeechDefaults } from './preferences/SpeechDefaults';
 import { ISpeechPreferences, SpeechPreferences } from './preferences/SpeechPreferences';
 import { SpeechPreferencesEditor } from './preferences/SpeechPreferencesEditor';
 import { SpeechSettings } from './preferences/SpeechSettings';
+import { ContextualizationShapeOverrides } from './preferences/verbosityTables';
 import { ReadiumSpeechUtterance } from './utterance';
+import { Contextualizations } from './utterances/types';
 import { ReadiumSpeechVoice } from './voices/types';
+export interface ContextualizationOverrides {
+    contextualizations?: Contextualizations;
+    shapes?: ContextualizationShapeOverrides;
+    params?: (role: string, node: GndObject) => Record<string, string> | undefined;
+}
 export interface ReadiumSpeechNavigatorConfiguration {
     preferences?: ISpeechPreferences;
     defaults?: ISpeechDefaults;
+    contextualizationOverrides?: ContextualizationOverrides;
 }
 export declare class ReadiumSpeechNavigator implements ReadiumSpeechNavigatorContract {
     private engine;
@@ -21,6 +29,7 @@ export declare class ReadiumSpeechNavigator implements ReadiumSpeechNavigatorCon
     private _preferences;
     private _settings;
     private _preferencesEditor;
+    private readonly contextualizationOverrides?;
     private source;
     private contentSources;
     private contentBlockStarts;
@@ -38,7 +47,7 @@ export declare class ReadiumSpeechNavigator implements ReadiumSpeechNavigatorCon
     setSpeakInContentLanguage(enabled: boolean): void;
     getSpeakInContentLanguage(): boolean;
     loadContent(content: ReadiumSpeechUtterance | ReadiumSpeechUtterance[]): void;
-    loadGndContent(nodes: GndObject[]): void;
+    loadGndContent(nodes: GndObject[]): Promise<void>;
     private setContentQueue;
     private reextract;
     private resolveResumeIndex;
@@ -59,7 +68,7 @@ export declare class ReadiumSpeechNavigator implements ReadiumSpeechNavigatorCon
     private emitContentChangeEvent;
     get settings(): SpeechSettings;
     get preferencesEditor(): SpeechPreferencesEditor;
-    submitPreferences(preferences: SpeechPreferences): void;
+    submitPreferences(preferences: SpeechPreferences): Promise<void>;
     private applyPreferences;
     private sameSettingValue;
     destroy(): Promise<void>;

package/build/utils/clamp.d.ts

@@ -0,0 +1 @@
+export declare function clamp(value: number, min: number, max: number, fallback: number): number;

package/build/utterance.d.ts

@@ -1,6 +1,9 @@
+import { LocatorOptions } from './decorator/createLocator.js';
 export interface ReadiumSpeechUtterance {
     id?: string;
     plain?: string;
     ssml?: string;
     language?: string;
+    locate?: LocatorOptions;
+    synthetic?: boolean;
 }

package/build/utterances/contextualizations.d.ts

@@ -0,0 +1,3 @@
+import { Contextualizations } from './types.js';
+export declare const defaultContextualizations: Contextualizations;
+export declare function contextualizationsForLocale(locale: string): Promise<Contextualizations>;

package/build/utterances/extractUtterances.d.ts

@@ -9,13 +9,13 @@ import { ExtractUtterancesOptions } from './types.js';
  * Accepts `GndObject[]` (as returned by `parseMarkup()`, or `GndDocument.guided`)
  * rather than a wrapped document.
  */
-export declare function extractUtterances(nodes: GndObject[], options: ExtractUtterancesOptions): ReadiumSpeechUtterance[];
+export declare function extractUtterances(nodes: GndObject[], options: ExtractUtterancesOptions): Promise<ReadiumSpeechUtterance[]>;
 /**
  * Same as `extractUtterances()`, plus `sources[i]`: the node that produced `utterances[i]`,
  * and `blockStarts[i]`: whether `utterances[i]` begins a new block-level element.
  */
-export declare function extractUtterancesWithSources(nodes: GndObject[], options: ExtractUtterancesOptions): {
+export declare function extractUtterancesWithSources(nodes: GndObject[], options: ExtractUtterancesOptions): Promise<{
     utterances: ReadiumSpeechUtterance[];
     sources: (GndObject | undefined)[];
     blockStarts: boolean[];
-};
+}>;

package/build/utterances/index.d.ts

@@ -1,4 +1,4 @@
 export { extractUtterances } from './extractUtterances.js';
 export { blockLevelRoles, skippableRoles } from './roles.js';
-export { defaultAnnouncements } from './announcements.js';
-export type { Announcement, AnnouncementKey, AnnouncementPair, Announcements, RoleAnnouncement, ExtractUtterancesOptions, } from './types.js';
+export { defaultContextualizations } from './contextualizations.js';
+export type { ContextualizationEntry, Contextualizations, ContextualizationOptions, ExtractUtterancesOptions } from './types.js';

package/build/utterances/roles.d.ts

@@ -1,3 +1,11 @@
 import { GndRole } from '../gnd/types.js';
 export declare const skippableRoles: GndRole[];
 export declare const blockLevelRoles: GndRole[];
+export declare const roleDropOverrides: Partial<Record<GndRole, {
+    drops: GndRole[];
+    unconditional?: boolean;
+}>>;
+export declare const deferrablePlaceholderRoles: GndRole[];
+export declare const descriptionFoldingRoles: GndRole[];
+export declare const valueFoldingRoles: GndRole[];
+export declare const contentlessRoles: GndRole[];

package/build/utterances/tableStructure.d.ts

@@ -0,0 +1,9 @@
+import { GndObject } from '../gnd/types.js';
+export declare function plainTextOf(node: GndObject): string;
+export interface TableStructure {
+    lines: number;
+    columns: number;
+    rowNumbers: Map<GndObject, number>;
+    cellHeaders: Map<GndObject, string>;
+}
+export declare function computeTableStructure(rows: GndObject[]): TableStructure;

package/build/utterances/types.d.ts

@@ -1,16 +1,17 @@
-import { GndRole } from '../gnd/types.js';
-export type AnnouncementKey = string;
-export type Announcement = string | ((params?: Record<string, string>) => string);
-export interface AnnouncementPair {
-    start: Announcement;
-    end: Announcement;
+import { GndObject, GndRole } from '../gnd/types.js';
+export type ContextualizationEntry = string | {
+    [key: string]: ContextualizationEntry;
+};
+export type Contextualizations = Record<GndRole, ContextualizationEntry>;
+export interface ContextualizationOptions {
+    contextualizations?: Contextualizations;
+    shapes?: Partial<Record<GndRole, "inline" | "block">>;
+    params?: (role: GndRole, node: GndObject) => Record<string, string> | undefined;
 }
-export type RoleAnnouncement = Announcement | AnnouncementPair;
-export declare function isAnnouncementPair(a: RoleAnnouncement): a is AnnouncementPair;
-export type Announcements = Record<AnnouncementKey, RoleAnnouncement>;
 export interface ExtractUtterancesOptions {
     format?: "plain" | "ssml";
-    announcements?: Announcements;
+    contextualization?: ContextualizationOptions;
+    contextualizationLocale?: string;
     skip?: GndRole[];
     contextualize?: GndRole[];
     language?: "none" | "block-level" | "always";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/speech",
-  "version": "0.8.1",
+  "version": "0.9.1",
   "description": "A TypeScript library for implementing read aloud features with Web technologies, following best practices for digital publishing.",
   "author": "Readium Foundation",
   "keywords": [
@@ -50,9 +50,10 @@
   },
   "devDependencies": {
     "@ava/typescript": "^6.0.0",
+    "@types/jsdom": "^30.0.0",
     "ava": "^6.4.0",
     "http-server": "^14.1.1",
-    "linkedom": "^0.18.13",
+    "jsdom": "^30.0.1",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
@@ -60,8 +61,11 @@
     "vite-plugin-dts": "^4.5.4"
   },
   "dependencies": {
-    "@readium/decorator": "^1.0.1",
-    "@readium/shared": "^2.3.1",
+    "@readium/decorator": "1.2.0",
+    "@readium/helpers": "1.1.0",
+    "@readium/shared": "2.5.0",
+    "css-selector-generator": "^3.9.4",
+    "i18next": "^26.4.0",
     "string-strip-html": "^13.4.23"
   }
 }

package/build/utterances/announcements.d.ts

@@ -1,2 +0,0 @@
-import { Announcements } from './types.js';
-export declare const defaultAnnouncements: Announcements;