@touchcastllc/napster-companion-api-dev 2.0.0-alpha.7 → 2.0.0-alpha.8

package/lib/services/micRecovery.d.ts

@@ -0,0 +1,33 @@
+export interface MicRecoveryController {
+    destroy(): void;
+}
+export interface MicRecoveryOptions {
+    /** Element the card mounts into — `#np_companion-sdk-root`. */
+    root: HTMLElement;
+    /**
+     * The avatar shape to render the card as, read when the card opens rather
+     * than once at creation: this controller lives as long as the widget, and
+     * the view can change under it (`updateStyle()`).
+     */
+    getView: () => string | undefined;
+}
+/**
+ * A click on the badged mute button: ask for the microphone back.
+ *
+ * Where the browser can still ask (Firefox reports "prompt" after a
+ * mid-session revoke) the retry puts the browser's own Allow/Block prompt on
+ * screen, and that prompt is the whole interaction — no card on top of it,
+ * and none after the user answers it. Only "blocked" opens the card: the
+ * browser will not ask (Chrome, "denied"), so the user has to be told how to
+ * unblock it themselves.
+ */
+export declare function requestMicRecovery(): Promise<void>;
+/**
+ * The recovery card for a microphone lost MID-session (CA-1076) — the same
+ * `MicPermission` card micGate.ts mounts at session start, but driven purely
+ * by `avatar.micRecoveryOpen` instead of by a session attempt: the session is
+ * live here, `session.status` stays ready, and the card can be closed back to
+ * it. requestMicRecovery() above sets the flag; it drops by itself once the
+ * microphone is available again (avatarSlice).
+ */
+export declare function createMicRecovery(options: MicRecoveryOptions): MicRecoveryController;

package/lib/services/microphoneManager.d.ts

@@ -1,8 +1,12 @@
+export type MicAvailability = "available" | "unavailable";
+export type MicRetryResult = "granted" | "refused" | "blocked";
 export type MicManagerEventMap = {
     stream: MediaStream | null;
     muted: boolean;
     device: string | undefined;
     error: Error;
+    availability: MicAvailability;
+    sourceMuted: boolean;
 };
 export type MicManagerEvent = keyof MicManagerEventMap;
 type Handler<E extends MicManagerEvent> = (payload: MicManagerEventMap[E]) => void;
@@ -19,6 +23,15 @@ export interface MicrophoneManager {
     getTrack(): MediaStreamTrack | null;
     getAnalyser(): AnalyserNode | null;
     getCurrentDeviceId(): string | undefined;
+    /** False while the microphone is lost and cannot be re-acquired unprompted. */
+    isAvailable(): boolean;
+    /** True while the browser itself is holding the capture muted. */
+    isSourceMuted(): boolean;
+    /**
+     * Ask for a lost microphone again, on the user's initiative. The only path
+     * that may put a browser permission prompt on screen mid-session.
+     */
+    retry(): Promise<MicRetryResult>;
     on<E extends MicManagerEvent>(event: E, handler: Handler<E>): () => void;
 }
 export declare const DEFAULT_AUDIO_CONSTRAINTS: MediaTrackConstraints;

package/lib/stores/index.d.ts

@@ -2,7 +2,7 @@ export { store } from "./store";
 export type { RootState } from "./store";
 export { setOnFeaturesUpdateCallback } from "./middleware/featuresUpdateMiddleware";
 export * from "./selectors";
-export { setSessionId, setTransport, setStopInteraction, setMuted, setAutoMicActive, setVolume, setAvatarSpeaking, setScreenSharing, setUserTalking, setConnectionToken, setCloseConnectionHandler, setSessionTerminatedByServer, resetAvatar, } from "./slices/avatarSlice";
+export { setSessionId, setTransport, setStopInteraction, setMuted, setMicUnavailable, setMicRecoveryOpen, setMicSourceMuted, setAutoMicActive, setVolume, setAvatarSpeaking, setScreenSharing, setUserTalking, setConnectionToken, setCloseConnectionHandler, setSessionTerminatedByServer, resetAvatar, } from "./slices/avatarSlice";
 export { setSessionStatus, resetSession } from "./slices/sessionSlice";
 export type { SessionStatus } from "./slices/sessionSlice";
 export { setFeatures, resetFeatures, setDebugMode } from "./slices/appSlice";

package/lib/stores/selectors.d.ts

@@ -8,6 +8,9 @@ import type { SessionStatus } from "./slices/sessionSlice";
 export declare const selectSessionId: (state: RootState) => string | undefined;
 export declare const selectTransport: (state: RootState) => Transport | null;
 export declare const selectMuted: (state: RootState) => boolean;
+export declare const selectMicUnavailable: (state: RootState) => boolean;
+export declare const selectMicRecoveryOpen: (state: RootState) => boolean;
+export declare const selectMicSourceMuted: (state: RootState) => boolean;
 export declare const selectAutoMicActive: (state: RootState) => boolean;
 export declare const selectAvatarSpeaking: (state: RootState) => boolean;
 export declare const selectUserTalking: (state: RootState) => boolean;

package/lib/stores/slices/avatarSlice.d.ts

@@ -4,6 +4,9 @@ export interface AvatarState {
     transport: Transport | null;
     stopInteraction: boolean;
     muted: boolean;
+    micUnavailable: boolean;
+    micRecoveryOpen: boolean;
+    micSourceMuted: boolean;
     autoMicActive: boolean;
     volume: number;
     avatarSpeaking: boolean;
@@ -13,5 +16,5 @@ export interface AvatarState {
     closeConnectionHandler?: () => void;
     sessionTerminatedByServer: boolean;
 }
-export declare const setSessionId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setSessionId">, setTransport: import("@reduxjs/toolkit").ActionCreatorWithPayload<Transport | null, "avatar/setTransport">, setStopInteraction: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setStopInteraction">, setMuted: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setMuted">, setAutoMicActive: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setAutoMicActive">, setVolume: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "avatar/setVolume">, setAvatarSpeaking: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setAvatarSpeaking">, setScreenSharing: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setScreenSharing">, setUserTalking: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setUserTalking">, setConnectionToken: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setConnectionToken">, setCloseConnectionHandler: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<(() => void) | undefined, "avatar/setCloseConnectionHandler">, setSessionTerminatedByServer: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setSessionTerminatedByServer">, resetAvatar: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"avatar/resetAvatar">;
+export declare const setSessionId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setSessionId">, setTransport: import("@reduxjs/toolkit").ActionCreatorWithPayload<Transport | null, "avatar/setTransport">, setStopInteraction: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setStopInteraction">, setMuted: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setMuted">, setMicUnavailable: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setMicUnavailable">, setMicRecoveryOpen: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setMicRecoveryOpen">, setMicSourceMuted: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setMicSourceMuted">, setAutoMicActive: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setAutoMicActive">, setVolume: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "avatar/setVolume">, setAvatarSpeaking: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setAvatarSpeaking">, setScreenSharing: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setScreenSharing">, setUserTalking: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setUserTalking">, setConnectionToken: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setConnectionToken">, setCloseConnectionHandler: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<(() => void) | undefined, "avatar/setCloseConnectionHandler">, setSessionTerminatedByServer: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setSessionTerminatedByServer">, resetAvatar: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"avatar/resetAvatar">;
 export declare const avatarReducer: import("redux").Reducer<AvatarState>;

package/lib/utils/classnames.d.ts

@@ -35,6 +35,8 @@ export declare const ControlClasses: {
     readonly stop: "np_companion-action-btn-container-stop";
     readonly questionBar: "np_companion-chat-question-bar-container";
     readonly muted: "np_companion-muted";
+    /** Mic lost mid-session — ControlBar.css draws the warning badge off this. */
+    readonly micUnavailable: "np_companion-mic-unavailable";
     readonly hidden: "np_companion-hidden";
     readonly expanded: "np_companion-action-btn-container-expanded";
     readonly collapse: "np_companion-action-btn-container-collapse";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@touchcastllc/napster-companion-api-dev",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-alpha.8",
   "keywords": [
     "napster",
     "companion-api",