@touchcastllc/napster-companion-api-dev 1.0.0-alpha.45 → 1.0.0-alpha.47

package/lib/services/microphoneManager.d.ts

@@ -0,0 +1,26 @@
+export type MicManagerEventMap = {
+    stream: MediaStream | null;
+    muted: boolean;
+    device: string | undefined;
+    error: Error;
+};
+export type MicManagerEvent = keyof MicManagerEventMap;
+type Handler<E extends MicManagerEvent> = (payload: MicManagerEventMap[E]) => void;
+export interface MicrophoneStartOptions {
+    deviceId?: string;
+}
+export interface MicrophoneManager {
+    start(options?: MicrophoneStartOptions): Promise<MediaStream>;
+    stop(): void;
+    switchDevice(deviceId: string): Promise<MediaStream>;
+    setMuted(muted: boolean): void;
+    isMuted(): boolean;
+    getStream(): MediaStream | null;
+    getTrack(): MediaStreamTrack | null;
+    getAnalyser(): AnalyserNode | null;
+    getCurrentDeviceId(): string | undefined;
+    on<E extends MicManagerEvent>(event: E, handler: Handler<E>): () => void;
+}
+export declare const DEFAULT_AUDIO_CONSTRAINTS: MediaTrackConstraints;
+export declare function getMicrophoneManager(): MicrophoneManager;
+export {};

package/lib/services/webrtc.d.ts

@@ -19,7 +19,6 @@ interface WebRTCParams {
     onStreams?: (streams: {
         videoStream?: MediaStream | null;
         audioStream?: MediaStream | null;
-        userMicrophoneStream?: MediaStream | null;
     }) => void;
     onDataChannel?: (dc: RTCDataChannel) => void;
     maxReconnectAttempts?: number;

package/lib/stores/index.d.ts

@@ -2,7 +2,7 @@ export { store } from "./store";
 export type { RootState, AppDispatch } from "./store";
 export { setOnFeaturesUpdateCallback } from "./middleware/featuresUpdateMiddleware";
 export * from "./selectors";
-export { setSessionId, setAvatarReady, setDataChannel, setAvatarId, setVideoId, setStopInteraction, setMuted, addTranscript, setCustomVoiceId, setDefaultVoiceId, setConnectionToken, setCloseConnectionHandler, avatarReducer, } from "./slices/avatarSlice";
+export { setSessionId, setAvatarReady, setDataChannel, setAvatarId, setVideoId, setStopInteraction, setMuted, setVolume, setAvatarSpeaking, setScreenSharing, setUserTalking, addTranscript, setCustomVoiceId, setDefaultVoiceId, setConnectionToken, setCloseConnectionHandler, avatarReducer, } from "./slices/avatarSlice";
 export type { WebRTCStatus, AvatarState, Transcript, } from "./slices/avatarSlice";
 export { appReducer, setFeatures, resetFeatures, setPosition, setShowExperience, setDebugMode, } from "./slices/appSlice";
 export type { AppState } from "./slices/appSlice";

package/lib/stores/selectors.d.ts

@@ -10,6 +10,10 @@ export declare const selectDataChannel: (state: RootState) => RTCDataChannel | n
 export declare const selectAvatarId: (state: RootState) => string | undefined;
 export declare const selectVideoId: (state: RootState) => string | undefined;
 export declare const selectMuted: (state: RootState) => boolean;
+export declare const selectVolume: (state: RootState) => number;
+export declare const selectAvatarSpeaking: (state: RootState) => boolean;
+export declare const selectScreenSharing: (state: RootState) => boolean;
+export declare const selectUserTalking: (state: RootState) => boolean;
 export declare const selectTranscript: (state: RootState) => Transcript | undefined;
 export declare const selectCustomVoiceId: (state: RootState) => string | undefined;
 export declare const selectDefaultVoiceId: (state: RootState) => string | undefined;

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

@@ -15,6 +15,10 @@ export interface AvatarState {
     videoId?: string;
     stopInteraction: boolean;
     muted: boolean;
+    volume: number;
+    avatarSpeaking: boolean;
+    isScreenSharing: boolean;
+    isUserTalking: boolean;
     transcript?: Transcript;
     customVoiceId: string | undefined;
     defaultVoiceId: string | undefined;
@@ -22,5 +26,5 @@ export interface AvatarState {
     companionId?: string;
     closeConnectionHandler?: () => void;
 }
-export declare const setSessionId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setSessionId">, setAvatarReady: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setAvatarReady">, setDataChannel: import("@reduxjs/toolkit").ActionCreatorWithPayload<RTCDataChannel | null, "avatar/setDataChannel">, setAvatarId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setAvatarId">, setVideoId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setVideoId">, setStopInteraction: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setStopInteraction">, setMuted: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setMuted">, addTranscript: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<Transcript | undefined, "avatar/addTranscript">, setCustomVoiceId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setCustomVoiceId">, setDefaultVoiceId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setDefaultVoiceId">, setConnectionToken: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setConnectionToken">, setCloseConnectionHandler: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<(() => void) | undefined, "avatar/setCloseConnectionHandler">;
+export declare const setSessionId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setSessionId">, setAvatarReady: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setAvatarReady">, setDataChannel: import("@reduxjs/toolkit").ActionCreatorWithPayload<RTCDataChannel | null, "avatar/setDataChannel">, setAvatarId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setAvatarId">, setVideoId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setVideoId">, setStopInteraction: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setStopInteraction">, setMuted: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "avatar/setMuted">, 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">, addTranscript: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<Transcript | undefined, "avatar/addTranscript">, setCustomVoiceId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setCustomVoiceId">, setDefaultVoiceId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setDefaultVoiceId">, setConnectionToken: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setConnectionToken">, setCloseConnectionHandler: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<(() => void) | undefined, "avatar/setCloseConnectionHandler">;
 export declare const avatarReducer: import("redux").Reducer<AvatarState>;

package/lib/types/documentPiP.d.ts

@@ -0,0 +1,17 @@
+interface DocumentPictureInPicture {
+    requestWindow(options?: {
+        width?: number;
+        height?: number;
+        disallowReturnToOpener?: boolean;
+    }): Promise<Window>;
+    readonly window: Window | null;
+}
+declare global {
+    interface Window {
+        documentPictureInPicture?: DocumentPictureInPicture;
+    }
+    interface MediaSession {
+        setActionHandler(action: "enterpictureinpicture", handler: (() => void) | null): void;
+    }
+}
+export {};

package/lib/types/index.d.ts

@@ -133,6 +133,15 @@ export interface FeatureConfig {
         /** Optional loader animation type. */
         type?: "spinner" | "pulse";
     };
+    /** Document Picture-in-Picture. When enabled, the avatar automatically
+     *  opens in a PiP window when the user switches browser tabs (Chrome/Edge 116+). */
+    pictureInPicture?: {
+        enabled: boolean;
+        /** PiP window width in pixels. Default: 400. */
+        width?: number;
+        /** PiP window height in pixels. Default: 300. */
+        height?: number;
+    };
     /** Screen sharing feature. When enabled, users can share their screen during a session. */
     screenShare?: {
         enabled: boolean;
@@ -295,6 +304,11 @@ export interface NapsterCompanionApiInstance {
     avatarIsVisible: () => boolean;
     /** Tear down the SDK, remove DOM nodes and clean up resources. */
     destroy: () => void;
+    /**
+     * The current session identifier. Available after a connection is established
+     * and reset to `undefined` once the connection is closed.
+     */
+    readonly sessionId: string | undefined;
     /** Update the inline style object applied to the SDK root container. */
     updateStyles: (styles: NapsterCompanionApiConfig["style"]) => void;
     /** Set the position of the SDK on screen (see `Position`). */

package/lib/utils/PiPManager.d.ts

@@ -0,0 +1,19 @@
+export interface PiPController {
+    destroy: () => void;
+}
+/**
+ * Creates a PiP controller that opens a Document Picture-in-Picture window
+ * via Media Session API when the user switches tabs, and closes it on return.
+ * Chrome/Edge 116+.
+ *
+ * Requirements for auto-PiP trigger:
+ * - Secure context (HTTPS) — https://developer.mozilla.org/en-US/docs/Web/API/Document_Picture-in-Picture_API
+ * - Active media playback with audio — https://developer.chrome.com/blog/automatic-picture-in-picture-media-playback
+ * - Media Engagement Index threshold met (user frequently consumes media on the site)
+ * - enterpictureinpicture Media Session action handler registered
+ */
+export declare function createPiPManager(handlers: {
+    onEnd: () => void;
+    onScreenShareToggle: () => void;
+    isScreenShareSupported: () => boolean;
+}): PiPController;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@touchcastllc/napster-companion-api-dev",
-  "version": "1.0.0-alpha.45",
+  "version": "1.0.0-alpha.47",
   "keywords": [
     "napster",
     "companion-api",
@@ -51,6 +51,6 @@
     }
   },
   "publishConfig": {
-    "access": "restricted"
+    "access": "public"
   }
 }