@touchcastllc/napster-companion-api-dev 1.6.0-alpha.4 → 1.6.0-alpha.5

package/lib/services/transport/index.d.ts

@@ -0,0 +1,2 @@
+export type { Transport } from "./types";
+export { createWebRtcTransport } from "./webrtcTransport";

package/lib/services/transport/types.d.ts

@@ -0,0 +1,25 @@
+import type { DataChannelCommand } from "../../types";
+/**
+ * The control plane of a session: the channel that carries client commands.
+ *
+ * Deliberately narrow. It knows nothing about media and nothing about how a
+ * session is established — WebRTC implements it over an RTCDataChannel, and a
+ * WebSocket session will implement it over the socket itself, carrying the
+ * identical command payloads.
+ *
+ * Session policy (e.g. `stopInteraction`) lives in `sendCommand`, NOT here, so
+ * a future implementation cannot forget to honour it.
+ *
+ * Ownership: whoever creates a transport owns its lifecycle and is responsible
+ * for clearing the store slot (`setTransport(null)`) when the underlying
+ * connection closes. An implementation must not register its own close handler
+ * to do that — it would compete with the owner's.
+ */
+export interface Transport {
+    /** Send a command. Returns false when the channel cannot carry it. */
+    send(command: DataChannelCommand): boolean;
+    /** Whether the control channel is ready to accept commands. */
+    isOpen(): boolean;
+    /** Close the control channel. */
+    close(): void;
+}

package/lib/services/transport/webrtcTransport.d.ts

@@ -0,0 +1,12 @@
+import type { Transport } from "./types";
+/**
+ * Wrap an RTCDataChannel as a {@link Transport}.
+ *
+ * Framing belongs to the transport, not the caller: a WebSocket session may
+ * need a different envelope, and callers should not know which one they are on.
+ *
+ * The adapter deliberately attaches no event handlers — the WebRTC controller
+ * owns the channel's lifecycle and clears the store slot from its own
+ * `onclose`. See the spec's "Lifecycle and ownership" section.
+ */
+export declare function createWebRtcTransport(dc: RTCDataChannel): Transport;

package/lib/stores/index.d.ts

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

package/lib/stores/selectors.d.ts

@@ -1,10 +1,11 @@
 import { RootState } from "./index";
 import { FeatureConfig } from "../types";
+import type { Transport } from "../services/transport";
 /**
  * Avatar state selectors
  */
 export declare const selectSessionId: (state: RootState) => string | undefined;
-export declare const selectDataChannel: (state: RootState) => RTCDataChannel | null;
+export declare const selectTransport: (state: RootState) => Transport | null;
 export declare const selectMuted: (state: RootState) => boolean;
 export declare const selectAutoMicActive: (state: RootState) => boolean;
 export declare const selectAvatarSpeaking: (state: RootState) => boolean;

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

@@ -1,6 +1,7 @@
+import type { Transport } from "../../services/transport";
 export interface AvatarState {
     sessionId?: string;
-    dataChannel: RTCDataChannel | null;
+    transport: Transport | null;
     stopInteraction: boolean;
     muted: boolean;
     autoMicActive: boolean;
@@ -12,5 +13,5 @@ export interface AvatarState {
     closeConnectionHandler?: () => void;
     sessionTerminatedByServer: boolean;
 }
-export declare const setSessionId: import("@reduxjs/toolkit").ActionCreatorWithOptionalPayload<string | undefined, "avatar/setSessionId">, setDataChannel: import("@reduxjs/toolkit").ActionCreatorWithPayload<RTCDataChannel | null, "avatar/setDataChannel">, 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">, 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@touchcastllc/napster-companion-api-dev",
-  "version": "1.6.0-alpha.4",
+  "version": "1.6.0-alpha.5",
   "keywords": [
     "napster",
     "companion-api",