@namiml/web-sdk 3.4.0-dev.202605141714 → 3.4.0-dev.202605182046

package/dist/utils/tts.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Cross-platform text-to-speech for the Nami Web SDK.
+ *
+ * Targets:
+ *   - VIZIO  → window.VIZIO.Chromevox.play(text)
+ *   - Other CTV (Samsung Tizen, LG webOS, Xbox) + desktop browsers
+ *            → window.speechSynthesis.speak(SpeechSynthesisUtterance)
+ *   - Headless / no API available → no-op; callers should also set `aria-label`
+ *     on the focused element so the platform screenreader picks it up via the
+ *     ARIA path as a last resort.
+ *
+ * Selection precedence on `speak()`:
+ *   1. VIZIO Chromevox (when present and enabled by the user).
+ *   2. `window.speechSynthesis` (most other modern browsers including the
+ *      Chromium-based CTV runtimes).
+ *   3. No-op; the caller's ARIA label remains the final fallback.
+ *
+ * Replaces the original `vizio-tts.ts` which only covered VIZIO and silently
+ * dropped speech requests on every other platform.
+ */
+/**
+ * Attach platform-specific TTS event listeners. Idempotent. Currently only
+ * VIZIO surfaces enable/disable events at runtime; other engines are queried
+ * on demand inside `speak()`.
+ */
+export declare function attachTtsEventListeners(): void;
+/**
+ * Set whether a page's media is currently producing audio. Toggled by
+ * `VideoService` (`onplay`/`onpause`/`onended`). When set to `false`, any
+ * deferred speech is flushed in this call.
+ */
+export declare function setMediaPlaying(playing: boolean): void;
+/** Whether media is currently flagged as playing (test/debug helper). */
+export declare function isMediaPlaying(): boolean;
+/**
+ * Cancel any in-flight or queued speech across every available engine.
+ * Used implicitly by {@link speak} before starting a new utterance so that
+ * a focus change mid-announcement interrupts the previous announcement
+ * instead of letting it run concurrently. Also called when a page changes
+ * and the previous announcement is no longer relevant.
+ *
+ * VIZIO Chromevox does not document a single cancel method across firmware
+ * revisions, so we try the names that have appeared in the wild (`cancel`,
+ * `stop`) and ignore any errors — silence on cancel is a strict improvement
+ * over the overlap the user otherwise hears.
+ */
+export declare function cancelSpeech(): void;
+/**
+ * Speak `text` via the highest-priority TTS engine available. Empty / falsy
+ * input is a no-op. While media is playing the latest request is buffered
+ * and flushed on `setMediaPlaying(false)`. Errors are swallowed — TTS should
+ * never break the paywall.
+ *
+ * NOTE: This function does NOT cancel any in-flight speech on its own.
+ * Cancellation is the caller's responsibility — call {@link cancelSpeech}
+ * at semantic interaction boundaries (e.g. inside a focus-change handler)
+ * rather than on every utterance. Cancelling unconditionally inside
+ * `speak()` is destructive on some VIZIO Chromevox firmware revisions
+ * where the cancel + play sequence aborts the very utterance we just
+ * tried to start.
+ */
+export declare function speak(text: string): void;
+import type { TPages } from '@namiml/sdk-core';
+/** Inform the screenreader subsystem which page is currently rendered.
+ *  Resets the announced flag when the page actually changes. Safe to call
+ *  on every render.
+ *
+ *  Comparison is by object identity, NOT by `page.name`. Every paywall in
+ *  the `a_onboarding_flow` staging payload contains a single page named
+ *  literally `'page1'` — comparing by name would let Page 2's first focus
+ *  inherit Page 1's `pageAnnounced=true` state and silently drop the
+ *  composite. Page objects are sourced from each paywall's own
+ *  `template.pages` array, so reference equality cleanly distinguishes
+ *  pages across paywalls. */
+export declare function setActivePage(page: TPages | null | undefined): void;
+/** Get the currently active page (or null if none). */
+export declare function getActivePage(): TPages | null;
+/** Whether the page-level composite has not yet been announced for the active page. */
+export declare function shouldAnnounceComposite(): boolean;
+/** Mark the active page as having had its composite announced. */
+export declare function markPageAnnounced(): void;
+/** Clear all screenreader state — called when the paywall closes. */
+export declare function resetScreenreaderState(): void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@namiml/web-sdk",
   "type": "module",
-  "version": "3.4.0-dev.202605141714",
+  "version": "3.4.0-dev.202605182046",
   "source": "src/nami-web.ts",
   "description": "Subscription monetization infrastructure — drop-in SDK with no-code paywalls, onboarding flows, A/B testing for web",
   "scripts": {
@@ -101,7 +101,7 @@
   "dependencies": {
     "@lit-labs/ssr-dom-shim": "^1.2.1",
     "@lit/context": "^1.1.3",
-    "@namiml/sdk-core": "3.4.0-dev.202605141714",
+    "@namiml/sdk-core": "3.4.0-dev.202605182046",
     "bowser": "^2.11.0",
     "hls.js": "^1.5.18",
     "lit": "^3.3.1",

package/dist/utils/vizio-tts.d.ts

@@ -1,2 +0,0 @@
-export declare function attachVizioTtsEventListeners(): void;
-export declare function speak(text: string): void;