mass-queue-types 0.7.1 → 0.8.1-b1

package/package.json

@@ -3,7 +3,7 @@
   "description": "Custom Types and Interfaces for Music Assistant Queue Actions",
   "repository": "https://github.com/droans/mass-queue-types",
   "author": "Michael Carroll",
-  "version": "0.7.1",
+  "version": "0.8.1-b1",
   "module": "mass-queue-types.js",
   "keywords": [
     "home-assistant",

package/packages/{actions → mass_queue/actions}/get_group_volume.ts

@@ -5,7 +5,7 @@ export interface getGroupVolumePartialServiceResponse {
 }
 
 export interface getGroupVolumeServiceResponse {
-  response: getGroupVolumePartialSchema;
+  response: getGroupVolumePartialServiceResponse;
 }
 
 export interface getGroupVolumePartialSchema {

package/packages/{utils.ts → mass_queue/utils.ts}

@@ -12,4 +12,4 @@ export interface baseMassQueueServiceWithResponseSchema
 export interface queueItemPartialSchema {
   entity: string;
   queue_item_id: string;
-}
+}

package/packages/music_assistant/actions/get_library.ts

@@ -0,0 +1,30 @@
+import { baseMassQueueServiceWithResponseSchema } from "../../mass_queue/utils.js";
+import { MediaItem, MediaItemOrder, MediaTypes } from "../types.js";
+
+export interface getLibraryPartialServiceResponse {
+  items: MediaItem[];
+  limit: number;
+  offset: number;
+  ofder_by: MediaItemOrder;
+  media_type: MediaTypes;
+}
+export interface getLibraryServiceResponse {
+  response: getLibraryPartialServiceResponse
+}
+
+export interface getLibraryPartialSchema {
+  config_entry_id: string;
+  media_type: MediaTypes;
+  favorite?: boolean;
+  limit?: number;
+  offset?: number;
+  album_artists_only?: boolean;
+  search?: string;
+  order_by?: MediaItemOrder
+}
+
+export interface getLibraryServiceSchema
+  extends baseMassQueueServiceWithResponseSchema {
+  service: "get_library"
+  service_data: getLibraryPartialSchema  
+}

package/packages/music_assistant/actions/get_queue.ts

@@ -0,0 +1,31 @@
+import { baseMassQueueServiceWithResponseSchema } from "../../mass_queue/utils.js";
+import { QueueItemSchema } from "../types.js";
+
+export interface getQueuePartialServiceResponse {
+  queue_id: string;
+  active: boolean;
+  name: string;
+  items: number;
+  shuffle_enabled: boolean;
+  repeat_mode: boolean;
+  current_index: number | null;
+  elapsed_time: number;
+  current_item: QueueItemSchema;
+  next_item: QueueItemSchema;
+
+}
+type getQueueServiceEntitiesResponse = Record<string, getQueuePartialServiceResponse>;
+
+export interface getQueueServiceResponse {
+  response: getQueueServiceEntitiesResponse;
+}
+
+export interface getQueuePartialSchema {
+  entity_id: string;
+}
+
+export interface getQueueServiceSchema
+  extends baseMassQueueServiceWithResponseSchema {
+  service: "get_queue"
+  service_data: getQueuePartialSchema
+}

package/packages/music_assistant/actions/play_announcement.ts

@@ -0,0 +1,12 @@
+import { baseMusicAssistantServiceWithTargetSchema } from "../utils.js";
+
+export interface playAnnouncementPartialSchema {
+  url: string;
+  use_pre_announce?: boolean;
+}
+
+export interface playAnnouncementServiceSchema
+  extends baseMusicAssistantServiceWithTargetSchema {
+  service: "play_announcement"
+  service_data: playAnnouncementPartialSchema
+}

package/packages/music_assistant/actions/play_media.ts

@@ -0,0 +1,17 @@
+import { EnqueueModes, MediaTypes } from "../types.js";
+import { baseMusicAssistantServiceWithTargetSchema } from "../utils.js";
+
+export interface playMediaPartialSchema {
+  media_id: string;
+  media_type?: MediaTypes;
+  artist?: string;
+  album?: string;
+  enqueue?: EnqueueModes;
+  radio_mode?: boolean;
+}
+
+export interface playMediaServiceSchema
+  extends baseMusicAssistantServiceWithTargetSchema {
+  service: "play_media"
+  service_data: playMediaPartialSchema
+}

package/packages/music_assistant/actions/search.ts

@@ -0,0 +1,31 @@
+import { baseMassQueueServiceWithResponseSchema } from "../../mass_queue/utils.js";
+import { MediaItem, MediaTypes } from "../types.js";
+
+export interface searchPartialServiceResponse {
+  artists: MediaItem[];
+  albums: MediaItem[];
+  tracks: MediaItem[];
+  playlists: MediaItem[];
+  radio: MediaItem[];
+  audiobooks: MediaItem[];
+  podcasts: MediaItem[];
+}
+export interface searchServiceResponse {
+  response: searchPartialServiceResponse
+}
+
+export interface searchPartialSchema {
+  config_entry_id: string;
+  name: string;
+  media_type?: MediaTypes[];
+  artist?: string;
+  album?: string;
+  limit?: number;
+  library_only?: boolean;
+}
+
+export interface searchServiceSchema
+  extends baseMassQueueServiceWithResponseSchema {
+  service: "search"
+  service_data: searchPartialSchema  
+}

package/packages/music_assistant/actions/transfer_queue.ts

@@ -0,0 +1,12 @@
+import { baseMusicAssistantServiceWithTargetSchema } from "../utils.js";
+
+export interface transferQueuePartialSchema {
+  source_player?: string;
+  auto_play?: string;
+}
+
+export interface transferQueueServiceSchema
+  extends baseMusicAssistantServiceWithTargetSchema {
+  service: "transfer_queue"
+  service_data: transferQueuePartialSchema  
+}

package/packages/music_assistant/types.ts

@@ -0,0 +1,70 @@
+
+export type MediaTypes = 
+  "artist"
+  | "album"
+  | "audiobook"
+  | "playlist"
+  | "podcast"
+  | "radio"
+  | "track"
+
+export type MediaItemOrder = 
+  "name"
+  | "name_desc"
+  | "sort_name"
+  | "sort_name_desc"
+  | "timestamp_added"
+  | "timestamp_added_desc"
+  | "last_played"
+  | "last_played_desc"
+  | "play_count"
+  | "play_count_desc"
+  | "year"
+  | "year_desc"
+  | "position"
+  | "position_desc"
+  | "artist_name"
+  | "artist_name_desc"
+  | "random"
+  | "random_play_count"
+
+interface baseMediaItem {
+  media_type: MediaTypes;
+  uri: string;
+  name: string;
+  version: string;
+  image?: string | null;
+  favorite?: boolean;
+  explicit?: boolean | null;
+  discart_image?: boolean | null;
+  fanart_image?: boolean | null;
+}
+
+export interface MediaItem extends baseMediaItem {
+  artists?: baseMediaItem[];
+  album?: baseMediaItem;
+}
+
+export interface AudioFormatSchema {
+  provider: string;
+  item_id: string;
+  content_type: string;
+  sample_rate: number;
+  bit_depth: number;
+  bitrate?: number;
+}
+export interface QueueItemSchema {
+  queue_item_id: string;
+  name: string;
+  duration?: number | null;
+  media_item?: MediaItem | null;
+  stream_title?: string | null;
+  stream_details?: AudioFormatSchema | null;
+}
+
+export type EnqueueModes = 
+  "play"
+  | "replace"
+  | "next"
+  | "replace_next"
+  | "add"

package/packages/music_assistant/utils.ts

@@ -0,0 +1,23 @@
+export interface baseMusicAssistantServiceSchema {
+  type: "call_service";
+  domain: "music_assistant";
+  service: string;
+}
+export interface baseMusicAssistantServiceWithResponseSchema
+  extends baseMusicAssistantServiceSchema {
+  return_response: true;
+}
+
+export interface baseMusicAssistantServiceWithTargetSchema
+  extends baseMusicAssistantServiceSchema {
+    target: {
+      entity_id?: string | string[];
+      device_id?: string | string[];
+      floor_id?: string | string[];
+    }
+}
+
+export interface baseMusicAssistantServiceWithTargetAndResponseSchema
+  extends baseMusicAssistantServiceWithTargetSchema {
+    return_response: true
+  }