@basmilius/apple-devices 0.9.15 → 0.9.16

package/dist/index.d.mts

@@ -14,6 +14,7 @@ declare class Player {
   get nowPlayingInfo(): Proto.NowPlayingInfo | null;
   get playbackQueue(): Proto.PlaybackQueue | null;
   get playbackState(): Proto.PlaybackState_Enum;
+  get rawPlaybackState(): Proto.PlaybackState_Enum;
   get playbackStateTimestamp(): number;
   get supportedCommands(): Proto.CommandInfo[];
   get title(): string;
@@ -33,10 +34,13 @@ declare class Player {
   get elapsedTime(): number;
   get currentItem(): Proto.ContentItem | null;
   get currentItemMetadata(): Proto.ContentItemMetadata | null;
+  get artworkId(): string | null;
+  artworkUrl(width?: number, height?: number): string | null;
   get currentItemArtwork(): Uint8Array | null;
   get currentItemArtworkUrl(): string | null;
   get currentItemLyrics(): Proto.LyricsItem | null;
   constructor(identifier: string, displayName: string);
+  findCommand(command: Proto.Command): Proto.CommandInfo | null;
   isCommandSupported(command: Proto.Command): boolean;
   setNowPlayingInfo(nowPlayingInfo: Proto.NowPlayingInfo): void;
   setPlaybackQueue(playbackQueue: Proto.PlaybackQueue): void;
@@ -72,6 +76,8 @@ declare class Client {
   get shuffleMode(): Proto.ShuffleMode_Enum;
   get repeatMode(): Proto.RepeatMode_Enum;
   get elapsedTime(): number;
+  get artworkId(): string | null;
+  artworkUrl(width?: number, height?: number): string | null;
   get currentItem(): Proto.ContentItem | null;
   get currentItemMetadata(): Proto.ContentItemMetadata | null;
   get currentItemArtwork(): Uint8Array | null;
@@ -82,7 +88,9 @@ declare class Client {
   setActivePlayer(identifier: string): void;
   removePlayer(identifier: string): void;
   setDefaultSupportedCommands(supportedCommands: Proto.CommandInfo[]): void;
+  findCommand(command: Proto.Command): Proto.CommandInfo | null;
   isCommandSupported(command: Proto.Command): boolean;
+  updateDisplayName(displayName: string): void;
 }
 //#endregion
 //#region src/airplay/const.d.ts
@@ -91,6 +99,11 @@ declare const STATE_SUBSCRIBE_SYMBOL: unique symbol;
 declare const STATE_UNSUBSCRIBE_SYMBOL: unique symbol;
 //#endregion
 //#region src/airplay/remote.d.ts
+declare class SendCommandError extends Error {
+  readonly sendError: Proto.SendError_Enum;
+  readonly handlerReturnStatus: Proto.HandlerReturnStatus_Enum;
+  constructor(sendError: Proto.SendError_Enum, handlerReturnStatus: Proto.HandlerReturnStatus_Enum);
+}
 declare class export_default$1 {
   #private;
   constructor(device: export_default);
@@ -123,8 +136,18 @@ declare class export_default$1 {
   commandSetShuffleMode(mode: Proto.ShuffleMode_Enum): Promise<void>;
   commandSetRepeatMode(mode: Proto.RepeatMode_Enum): Promise<void>;
   commandChangePlaybackRate(rate: number): Promise<void>;
+  commandAdvanceShuffleMode(): Promise<void>;
+  commandAdvanceRepeatMode(): Promise<void>;
+  commandBeginFastForward(): Promise<void>;
+  commandEndFastForward(): Promise<void>;
+  commandBeginRewind(): Promise<void>;
+  commandEndRewind(): Promise<void>;
   commandNextChapter(): Promise<void>;
   commandPreviousChapter(): Promise<void>;
+  commandLikeTrack(): Promise<void>;
+  commandDislikeTrack(): Promise<void>;
+  commandBookmarkTrack(): Promise<void>;
+  commandAddNowPlayingItemToLibrary(): Promise<void>;
   tap(x: number, y: number, finger?: number): Promise<void>;
   swipeUp(duration?: number): Promise<void>;
   swipeDown(duration?: number): Promise<void>;
@@ -363,4 +386,4 @@ declare class export_default$6 extends export_default$8 {}
 //#region src/model/homepod-mini.d.ts
 declare class export_default$7 extends export_default$8 {}
 //#endregion
-export { PROTOCOL as AIRPLAY, Client as AirPlayClient, export_default as AirPlayDevice, Player as AirPlayPlayer, export_default$1 as AirPlayRemote, export_default$2 as AirPlayState, export_default$3 as AirPlayVolume, export_default$4 as AppleTV, PROTOCOL$1 as COMPANION_LINK, export_default$5 as CompanionLinkDevice, export_default$6 as HomePod, export_default$7 as HomePodMini };
+export { PROTOCOL as AIRPLAY, Client as AirPlayClient, export_default as AirPlayDevice, Player as AirPlayPlayer, export_default$1 as AirPlayRemote, export_default$2 as AirPlayState, export_default$3 as AirPlayVolume, export_default$4 as AppleTV, PROTOCOL$1 as COMPANION_LINK, export_default$5 as CompanionLinkDevice, export_default$6 as HomePod, export_default$7 as HomePodMini, SendCommandError };

package/dist/index.mjs

@@ -30,6 +30,10 @@ var Player = class {
 		return this.#playbackQueue;
 	}
 	get playbackState() {
+		if (this.#playbackState === Proto.PlaybackState_Enum.Playing && this.playbackRate === 0) return Proto.PlaybackState_Enum.Paused;
+		return this.#playbackState;
+	}
+	get rawPlaybackState() {
 		return this.#playbackState;
 	}
 	get playbackStateTimestamp() {
@@ -100,6 +104,25 @@ var Player = class {
 	get currentItemMetadata() {
 		return this.currentItem?.metadata ?? null;
 	}
+	get artworkId() {
+		const metadata = this.currentItemMetadata;
+		if (!metadata) return null;
+		if (!metadata.artworkAvailable && !metadata.artworkURL && !metadata.artworkIdentifier) return null;
+		if (metadata.artworkIdentifier) return metadata.artworkIdentifier;
+		if (metadata.contentIdentifier) return metadata.contentIdentifier;
+		return this.currentItem?.identifier ?? null;
+	}
+	artworkUrl(width = 600, height = -1) {
+		const metadata = this.currentItemMetadata;
+		if (metadata?.artworkURL) return metadata.artworkURL;
+		const item = this.currentItem;
+		if (item?.remoteArtworks.length > 0 && item.remoteArtworks[0].artworkURLString) return item.remoteArtworks[0].artworkURLString;
+		if (metadata?.artworkIdentifier) try {
+			const url = metadata.artworkIdentifier.replace("{w}", String(width < 1 ? 999999 : width)).replace("{h}", String(height < 1 ? 999999 : height)).replace("{c}", "bb").replace("{f}", "png");
+			if (url.startsWith("http://") || url.startsWith("https://")) return url;
+		} catch {}
+		return null;
+	}
 	get currentItemArtwork() {
 		const item = this.currentItem;
 		if (!item) return null;
@@ -129,8 +152,12 @@ var Player = class {
 		this.#displayName = displayName;
 		this.#playbackState = Proto.PlaybackState_Enum.Unknown;
 	}
+	findCommand(command) {
+		return this.#supportedCommands.find((c) => c.command === command) ?? null;
+	}
 	isCommandSupported(command) {
-		return this.#supportedCommands.some((c) => c.command === command);
+		const info = this.findCommand(command);
+		return info != null && info.enabled !== false;
 	}
 	setNowPlayingInfo(nowPlayingInfo) {
 		this.#nowPlayingInfo = nowPlayingInfo;
@@ -188,7 +215,13 @@ var Client = class {
 		return this.activePlayer?.playbackStateTimestamp ?? -1;
 	}
 	get supportedCommands() {
-		return this.activePlayer?.supportedCommands ?? this.#defaultSupportedCommands;
+		const playerCommands = this.activePlayer?.supportedCommands ?? [];
+		if (playerCommands.length === 0) return this.#defaultSupportedCommands;
+		if (this.#defaultSupportedCommands.length === 0) return playerCommands;
+		const playerCommandSet = new Set(playerCommands.map((c) => c.command));
+		const merged = [...playerCommands];
+		for (const cmd of this.#defaultSupportedCommands) if (!playerCommandSet.has(cmd.command)) merged.push(cmd);
+		return merged;
 	}
 	get title() {
 		return this.activePlayer?.title ?? "";
@@ -235,6 +268,12 @@ var Client = class {
 	get elapsedTime() {
 		return this.activePlayer?.elapsedTime ?? 0;
 	}
+	get artworkId() {
+		return this.activePlayer?.artworkId ?? null;
+	}
+	artworkUrl(width = 600, height = -1) {
+		return this.activePlayer?.artworkUrl(width, height) ?? null;
+	}
 	get currentItem() {
 		return this.activePlayer?.currentItem ?? null;
 	}
@@ -277,8 +316,17 @@ var Client = class {
 	setDefaultSupportedCommands(supportedCommands) {
 		this.#defaultSupportedCommands = supportedCommands;
 	}
+	findCommand(command) {
+		const playerCmd = this.activePlayer?.findCommand(command) ?? null;
+		if (playerCmd) return playerCmd;
+		return this.#defaultSupportedCommands.find((c) => c.command === command) ?? null;
+	}
 	isCommandSupported(command) {
-		return this.activePlayer?.isCommandSupported(command) ?? false;
+		const info = this.findCommand(command);
+		return info != null && info.enabled !== false;
+	}
+	updateDisplayName(displayName) {
+		this.#displayName = displayName;
 	}
 };
 
@@ -291,6 +339,16 @@ const STATE_UNSUBSCRIBE_SYMBOL = Symbol("com.basmilius.airplay:unsubscribe");
 
 //#endregion
 //#region src/airplay/remote.ts
+var SendCommandError = class extends Error {
+	sendError;
+	handlerReturnStatus;
+	constructor(sendError, handlerReturnStatus) {
+		super(`SendCommand failed: sendError=${Proto.SendError_Enum[sendError]}, handlerReturnStatus=${Proto.HandlerReturnStatus_Enum[handlerReturnStatus]}`);
+		this.name = "SendCommandError";
+		this.sendError = sendError;
+		this.handlerReturnStatus = handlerReturnStatus;
+	}
+};
 var remote_default = class {
 	get #dataStream() {
 		return this.#protocol.dataStream;
@@ -373,22 +431,40 @@ var remote_default = class {
 		await this.#sendCommand(Proto.Command.PreviousTrack);
 	}
 	async commandSkipForward(interval = 15) {
-		await this.#dataStream.exchange(DataStreamMessage.sendCommandWithSkipInterval(Proto.Command.SkipForward, interval));
+		await this.#sendCommandRaw(DataStreamMessage.sendCommandWithSkipInterval(Proto.Command.SkipForward, interval));
 	}
 	async commandSkipBackward(interval = 15) {
-		await this.#dataStream.exchange(DataStreamMessage.sendCommandWithSkipInterval(Proto.Command.SkipBackward, interval));
+		await this.#sendCommandRaw(DataStreamMessage.sendCommandWithSkipInterval(Proto.Command.SkipBackward, interval));
 	}
 	async commandSeekToPosition(position) {
-		await this.#dataStream.exchange(DataStreamMessage.sendCommandWithPlaybackPosition(Proto.Command.SeekToPlaybackPosition, position));
+		await this.#sendCommandRaw(DataStreamMessage.sendCommandWithPlaybackPosition(Proto.Command.SeekToPlaybackPosition, position));
 	}
 	async commandSetShuffleMode(mode) {
-		await this.#dataStream.exchange(DataStreamMessage.sendCommandWithShuffleMode(Proto.Command.ChangeShuffleMode, mode));
+		await this.#sendCommandRaw(DataStreamMessage.sendCommandWithShuffleMode(Proto.Command.ChangeShuffleMode, mode));
 	}
 	async commandSetRepeatMode(mode) {
-		await this.#dataStream.exchange(DataStreamMessage.sendCommandWithRepeatMode(Proto.Command.ChangeRepeatMode, mode));
+		await this.#sendCommandRaw(DataStreamMessage.sendCommandWithRepeatMode(Proto.Command.ChangeRepeatMode, mode));
 	}
 	async commandChangePlaybackRate(rate) {
-		await this.#dataStream.exchange(DataStreamMessage.sendCommandWithPlaybackRate(Proto.Command.ChangePlaybackRate, rate));
+		await this.#sendCommandRaw(DataStreamMessage.sendCommandWithPlaybackRate(Proto.Command.ChangePlaybackRate, rate));
+	}
+	async commandAdvanceShuffleMode() {
+		await this.#sendCommand(Proto.Command.AdvanceShuffleMode);
+	}
+	async commandAdvanceRepeatMode() {
+		await this.#sendCommand(Proto.Command.AdvanceRepeatMode);
+	}
+	async commandBeginFastForward() {
+		await this.#sendCommand(Proto.Command.BeginFastForward);
+	}
+	async commandEndFastForward() {
+		await this.#sendCommand(Proto.Command.EndFastForward);
+	}
+	async commandBeginRewind() {
+		await this.#sendCommand(Proto.Command.BeginRewind);
+	}
+	async commandEndRewind() {
+		await this.#sendCommand(Proto.Command.EndRewind);
 	}
 	async commandNextChapter() {
 		await this.#sendCommand(Proto.Command.NextChapter);
@@ -396,6 +472,18 @@ var remote_default = class {
 	async commandPreviousChapter() {
 		await this.#sendCommand(Proto.Command.PreviousChapter);
 	}
+	async commandLikeTrack() {
+		await this.#sendCommand(Proto.Command.LikeTrack);
+	}
+	async commandDislikeTrack() {
+		await this.#sendCommand(Proto.Command.DislikeTrack);
+	}
+	async commandBookmarkTrack() {
+		await this.#sendCommand(Proto.Command.BookmarkTrack);
+	}
+	async commandAddNowPlayingItemToLibrary() {
+		await this.#sendCommand(Proto.Command.AddNowPlayingItemToLibrary);
+	}
 	async tap(x, y, finger = 1) {
 		await this.#sendTouch(x, y, 1, finger);
 		await waitFor(50);
@@ -429,7 +517,17 @@ var remote_default = class {
 		await this.#dataStream.exchange(DataStreamMessage.sendHIDEvent(usePage, usage, false));
 	}
 	async #sendCommand(command, options) {
-		await this.#dataStream.exchange(DataStreamMessage.sendCommand(command, options));
+		const response = await this.#dataStream.exchange(DataStreamMessage.sendCommand(command, options));
+		return this.#checkCommandResult(response);
+	}
+	async #sendCommandRaw(message) {
+		const response = await this.#dataStream.exchange(message);
+		return this.#checkCommandResult(response);
+	}
+	#checkCommandResult(response) {
+		const result = DataStreamMessage.getExtension(response, Proto.sendCommandResultMessage);
+		if (result.sendError !== Proto.SendError_Enum.NoError) throw new SendCommandError(result.sendError, result.handlerReturnStatus);
+		return result;
 	}
 	async #sendTouch(x, y, phase, finger) {
 		await this.#dataStream.exchange(DataStreamMessage.sendVirtualTouchEvent(x, y, phase, finger));
@@ -608,6 +706,7 @@ var state_default = class extends EventEmitter {
 	}
 	onSetNowPlayingClient(message) {
 		this.#nowPlayingClientBundleIdentifier = message.client?.bundleIdentifier ?? null;
+		if (message.client?.bundleIdentifier && message.client?.displayName) this.#client(message.client.bundleIdentifier, message.client.displayName);
 		this.emit("setNowPlayingClient", message);
 		this.#emitNowPlayingChangedIfNeeded();
 	}
@@ -679,8 +778,11 @@ var state_default = class extends EventEmitter {
 		this.emit("volumeDidChange", message.volume);
 	}
 	#client(bundleIdentifier, displayName) {
-		if (bundleIdentifier in this.#clients) return this.#clients[bundleIdentifier];
-		else {
+		if (bundleIdentifier in this.#clients) {
+			const client = this.#clients[bundleIdentifier];
+			if (displayName) client.updateDisplayName(displayName);
+			return client;
+		} else {
 			const client = new Client(bundleIdentifier, displayName);
 			this.#clients[bundleIdentifier] = client;
 			this.emit("clients", this.#clients);
@@ -705,7 +807,10 @@ var state_default = class extends EventEmitter {
 			seriesName: player?.seriesName ?? "",
 			seasonNumber: player?.seasonNumber ?? 0,
 			episodeNumber: player?.episodeNumber ?? 0,
-			contentIdentifier: player?.contentIdentifier ?? ""
+			contentIdentifier: player?.contentIdentifier ?? "",
+			artworkId: player?.artworkId ?? null,
+			hasArtworkUrl: player?.artworkUrl() != null,
+			hasArtworkData: player?.currentItemArtwork != null
 		};
 	}
 	#emitNowPlayingChangedIfNeeded() {
@@ -717,7 +822,7 @@ var state_default = class extends EventEmitter {
 		this.emit("nowPlayingChanged", client, client?.activePlayer ?? null);
 	}
 	#snapshotsEqual(a, b) {
-		return a.bundleIdentifier === b.bundleIdentifier && a.playerIdentifier === b.playerIdentifier && a.playbackState === b.playbackState && a.title === b.title && a.artist === b.artist && a.album === b.album && a.genre === b.genre && a.duration === b.duration && a.shuffleMode === b.shuffleMode && a.repeatMode === b.repeatMode && a.mediaType === b.mediaType && a.seriesName === b.seriesName && a.seasonNumber === b.seasonNumber && a.episodeNumber === b.episodeNumber && a.contentIdentifier === b.contentIdentifier;
+		return a.bundleIdentifier === b.bundleIdentifier && a.playerIdentifier === b.playerIdentifier && a.playbackState === b.playbackState && a.title === b.title && a.artist === b.artist && a.album === b.album && a.genre === b.genre && a.duration === b.duration && a.shuffleMode === b.shuffleMode && a.repeatMode === b.repeatMode && a.mediaType === b.mediaType && a.seriesName === b.seriesName && a.seasonNumber === b.seasonNumber && a.episodeNumber === b.episodeNumber && a.contentIdentifier === b.contentIdentifier && a.artworkId === b.artworkId && a.hasArtworkUrl === b.hasArtworkUrl && a.hasArtworkData === b.hasArtworkData;
 	}
 };
 
@@ -1354,4 +1459,4 @@ var homepod_default = class extends homepod_base_default {};
 var homepod_mini_default = class extends homepod_base_default {};
 
 //#endregion
-export { PROTOCOL as AIRPLAY, Client as AirPlayClient, device_default as AirPlayDevice, Player as AirPlayPlayer, remote_default as AirPlayRemote, state_default as AirPlayState, volume_default as AirPlayVolume, apple_tv_default as AppleTV, PROTOCOL$1 as COMPANION_LINK, device_default$1 as CompanionLinkDevice, homepod_default as HomePod, homepod_mini_default as HomePodMini };
+export { PROTOCOL as AIRPLAY, Client as AirPlayClient, device_default as AirPlayDevice, Player as AirPlayPlayer, remote_default as AirPlayRemote, state_default as AirPlayState, volume_default as AirPlayVolume, apple_tv_default as AppleTV, PROTOCOL$1 as COMPANION_LINK, device_default$1 as CompanionLinkDevice, homepod_default as HomePod, homepod_mini_default as HomePodMini, SendCommandError };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@basmilius/apple-devices",
     "description": "Exposes various Apple devices to connect with either AirPlay or Companion Link.",
-    "version": "0.9.15",
+    "version": "0.9.16",
     "type": "module",
     "license": "MIT",
     "author": {
@@ -49,10 +49,10 @@
         }
     },
     "dependencies": {
-        "@basmilius/apple-airplay": "0.9.15",
-        "@basmilius/apple-common": "0.9.15",
-        "@basmilius/apple-companion-link": "0.9.15",
-        "@basmilius/apple-encoding": "0.9.15"
+        "@basmilius/apple-airplay": "0.9.16",
+        "@basmilius/apple-common": "0.9.16",
+        "@basmilius/apple-companion-link": "0.9.16",
+        "@basmilius/apple-encoding": "0.9.16"
     },
     "devDependencies": {
         "@types/bun": "^1.3.11",