🤖 Merge PR DefinitelyTyped#69253 Add additional message types to cast…

…v2 by @joeyparrish
jdelStrother · Apr 15, 2024 · 7edaa7d · 7edaa7d
1 parent da49c53
commit 7edaa7d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 3 deletions.
diff --git a/types/castv2/castv2-tests.ts b/types/castv2/castv2-tests.ts
@@ -3,6 +3,7 @@ import {
     Client,
     ClientOptions,
     LaunchRequestMessage,
+    MediaStatusMessage,
     ReceiverLaunchErrorMessage,
     ReceiverLaunchStatusMessage,
     ReceiverMessage,
@@ -111,6 +112,11 @@ function handleStatusMessages(channel: Channel): void {
             }
             console.log(`isActiveInput: ${status.isActiveInput}`);
             console.log(`isStandBy: ${status.isStandBy}`);
+        } else if (message.type == "MEDIA_STATUS") {
+            const status = (message as MediaStatusMessage).status[0];
+            console.log(`mediaSessionId: ${status.mediaSessionId}`);
+            console.log(`playerState: ${status.playerState}`);
+            console.log(`currentTime: ${status.currentTime}`);
         }
     });
 }

diff --git a/types/castv2/index.d.ts b/types/castv2/index.d.ts
@@ -1,5 +1,6 @@
 /// <reference types="node" />
 
+import { MediaInformation, MediaStatus } from "chromecast-caf-receiver/cast.framework.messages";
 import { EventEmitter } from "node:events";
 
 // To start a new client.
@@ -60,10 +61,10 @@ export interface ApplicationInfo {
 }
 
 export interface VolumeInfo {
-    controlType: string;
+    controlType?: string;
     level: number;
     muted: boolean;
-    stepInterval: number;
+    stepInterval?: number;
 }
 
 // A status message from the receiver.
@@ -89,6 +90,11 @@ export interface ReceiverLaunchStatusMessage extends ReceiverMessage {
     status: "USER_PENDING_AUTHORIZATION" | "USER_ALLOWED";
 }
 
+export interface MediaStatusMessage extends ReceiverMessage {
+    type: "MEDIA_STATUS";
+    status: MediaStatus[];
+}
+
 export type MessageHandler = (data: ReceiverMessage, broadcast: boolean) => void;
 
 export type ErrorHandler = (error: Error) => void;
@@ -105,6 +111,7 @@ export interface Channel extends EventEmitter {
     close(): void;
 
     on(eventName: "message", callback: MessageHandler): this;
+    on(eventName: "close", callback: () => void): this;
 }
 
 export class Client extends EventEmitter {
@@ -114,5 +121,11 @@ export class Client extends EventEmitter {
 
     createChannel(sourceId: string, destinationId: string, namespace: string, encoding: string): Channel;
 
+    on(
+        eventName: "message",
+        callback: (sourceId: string, destinationId: string, namespace: string, message: string) => void,
+    ): this;
+    on(eventName: "connect", callback: () => void): this;
     on(eventName: "error", callback: ErrorHandler): this;
+    on(eventName: "close", callback: () => void): this;
 }
diff --git a/types/castv2/package.json b/types/castv2/package.json
@@ -6,8 +6,8 @@
         "https://github.com/thibauts/node-castv2#readme"
     ],
     "dependencies": {
+        "@types/chromecast-caf-receiver": "*",
         "@types/events": "*",
-        "@types/mdns": "*",
         "@types/node": "*"
     },
     "devDependencies": {