mass-queue-types 0.10.3 → 1.0.0

package/README.md

@@ -45,13 +45,13 @@ Typescript types and interfaces for the [Music Assistant Queue Actions](https://
 # Usage
 
 ## Service Schemas
-All service schemas are available as PARTIAL (service data only) or FULL (entire service call) schemas. Full will only work when calling `hass.callWS` due to the function schemas.
+All service schemas are available as ServiceData or FULL (entire service call) schemas. Full will only work when calling `hass.callWS` due to the function schemas.
 
 **Use FULL when...**
 * You are calling `hass.callWS`.
 * You want complete validation, including the `type`, `domain`, `service`, and (if applicable), `return_response`.
 
-**Use PARTIAL when...**
+**Use ServiceData only when...**
 * You are calling `hass.callService`.
 * You only want to validate the service data being passed.
 

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.10.3",
+  "version": "1.0.0",
   "module": "mass-queue-types.js",
   "keywords": [
     "home-assistant",

package/packages/mass_queue/actions/get_album.ts

@@ -1,11 +1,11 @@
 import { Album } from "../types/media-items.js";
-import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialServiceSchema } from "../utils.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataServiceData } from "../utils.js";
 
-export type getAlbumServiceResponse = Album;
+export type getAlbumServiceResponse = {response: Album};
 
-export type getAlbumPartialServiceSchema = getCollectionDataPartialServiceSchema
+export type getAlbumServiceData = getCollectionDataServiceData
 
 export interface getAlbumServiceSchema extends baseMassQueueServiceWithResponseSchema {
   service: 'get_album';
-  service_data: getAlbumPartialServiceSchema;
+  service_data: getAlbumServiceData;
 }

package/packages/mass_queue/actions/get_album_tracks.ts

@@ -1,10 +1,10 @@
-import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialServiceSchema, getTracksServiceResponse } from "../utils.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataServiceData, getTracksServiceResponse } from "../utils.js";
 
 export type getAlbumTracksServiceResponse = getTracksServiceResponse;
 
-export type getAlbumTracksPartialServiceSchema = getCollectionDataPartialServiceSchema
+export type getAlbumTracksServiceData = getCollectionDataServiceData
 
 export interface getAlbumTracksServiceSchema extends baseMassQueueServiceWithResponseSchema {
   service: 'get_album_tracks';
-  service_data: getAlbumTracksPartialServiceSchema;
+  service_data: getAlbumTracksServiceData;
 }

package/packages/mass_queue/actions/get_artist.ts

@@ -1,11 +1,11 @@
 import { Artist } from "../types/media-items.js";
-import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialServiceSchema } from "../utils.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataServiceData } from "../utils.js";
 
-export type getArtistServiceResponse = Artist;
+export type getArtistServiceResponse = {response: Artist};
 
-export type getArtistPartialServiceSchema = getCollectionDataPartialServiceSchema
+export type getArtistServiceData = getCollectionDataServiceData
 
 export interface getArtistServiceSchema extends baseMassQueueServiceWithResponseSchema {
   service: 'get_artist';
-  service_data: getArtistPartialServiceSchema;
+  service_data: getArtistServiceData;
 }

package/packages/mass_queue/actions/get_artist_tracks.ts

@@ -1,10 +1,10 @@
-import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialServiceSchema, getTracksServiceResponse } from "../utils.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataServiceData, getTracksServiceResponse } from "../utils.js";
 
 export type getArtistTracksServiceResponse = getTracksServiceResponse;
 
-export type getArtistTracksPartialServiceSchema = getCollectionDataPartialServiceSchema
+export type getArtistTracksServiceData = getCollectionDataServiceData
 
 export interface getArtistTracksServiceSchema extends baseMassQueueServiceWithResponseSchema {
   service: 'get_artist_tracks';
-  service_data: getArtistTracksPartialServiceSchema;
+  service_data: getArtistTracksServiceData;
 }

package/packages/mass_queue/actions/get_group_volume.ts

@@ -8,12 +8,12 @@ export interface getGroupVolumeServiceResponse {
   response: getGroupVolumePartialServiceResponse;
 }
 
-export interface getGroupVolumePartialSchema {
+export interface getGroupVolumeServiceData {
   entity: string;
 }
 
 export interface getGroupVolumeServiceSchema
   extends baseMassQueueServiceWithResponseSchema {
   service: "get_group_volume";
-  service_data: getGroupVolumePartialSchema;
+  service_data: getGroupVolumeServiceData;
 }

package/packages/mass_queue/actions/get_playlist.ts

@@ -1,11 +1,11 @@
 import { Playlist } from "../types/media-items.js";
-import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialServiceSchema } from "../utils.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataServiceData } from "../utils.js";
 
-export type getPlaylistServiceResponse = Playlist;
+export type getPlaylistServiceResponse = {response: Playlist};
 
-export type getPlaylistPartialSchema = getCollectionDataPartialServiceSchema
+export type getPlaylistServiceData = getCollectionDataServiceData
 
-export interface getPlaylistSchema extends baseMassQueueServiceWithResponseSchema {
+export interface getPlaylistServiceSchema extends baseMassQueueServiceWithResponseSchema {
   service: 'get_playlist';
-  service_data: getPlaylistPartialSchema;
+  service_data: getPlaylistServiceData;
 }

package/packages/mass_queue/actions/get_playlist_tracks.ts

@@ -1,10 +1,12 @@
-import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialServiceSchema, getTracksServiceResponse } from "../utils.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataServiceData, getTracksServiceResponse } from "../utils.js";
 
 export type getPlaylistTracksServiceResponse = getTracksServiceResponse;
 
-export type getPlaylistTracksPartialServiceSchema = getCollectionDataPartialServiceSchema
+export interface getPlaylistTracksServiceData extends getCollectionDataServiceData {
+  position: number
+}
 
 export interface getPlaylistTracksServiceSchema extends baseMassQueueServiceWithResponseSchema {
   service: 'get_playlist_tracks';
-  service_data: getPlaylistTracksPartialServiceSchema;
+  service_data: getPlaylistTracksServiceData;
 }

package/packages/mass_queue/actions/get_queue_items.ts

@@ -17,13 +17,13 @@ export interface queueItem {
 
 export type queueItems = queueItem[];
 
-type getQueueItemsPartialResponse = Record<string, queueItems>;
+type getQueueItemsPartialServiceResponse = Record<string, queueItems>;
 
 export interface getQueueItemsServiceResponse {
-  response: getQueueItemsPartialResponse;
+  response: getQueueItemsPartialServiceResponse;
 }
 
-export interface getQueueItemsPartialSchema {
+export interface getQueueItemsServiceData {
   entity: string;
   limit_before?: number;
   limit_after?: number;
@@ -34,5 +34,5 @@ export interface getQueueItemsPartialSchema {
 export interface getQueueItemsServiceSchema
   extends baseMassQueueServiceWithResponseSchema {
   service: "get_queue_items";
-  service_data: getQueueItemsPartialSchema;
+  service_data: getQueueItemsServiceData;
 }

package/packages/mass_queue/actions/get_recommendations.ts

@@ -30,12 +30,12 @@ export interface getRecommendationsServiceResponse {
   response: getRecommendationsPartialServiceResponse;
 }
 
-export interface getRecommendationsPartialSchema {
+export interface getRecommendationsServiceData {
   entity: string;
 }
 
 export interface getRecommendationsServiceSchema
   extends baseMassQueueServiceWithResponseSchema {
   service: "get_recommendations";
-  service_data: getRecommendationsPartialSchema;
+  service_data: getRecommendationsServiceData;
 }

package/packages/mass_queue/actions/move_queue_item_down.ts

@@ -1,10 +1,10 @@
 import {
   baseMassQueueServiceSchema,
-  queueItemPartialSchema,
+  queueItemServiceData,
 } from "../utils.js";
 
 export interface moveQueueItemDownServiceSchema
   extends baseMassQueueServiceSchema {
   service: "move_queue_item_down";
-  service_data: queueItemPartialSchema;
+  service_data: queueItemServiceData;
 }

package/packages/mass_queue/actions/move_queue_item_next.ts

@@ -1,10 +1,10 @@
 import {
   baseMassQueueServiceSchema,
-  queueItemPartialSchema,
+  queueItemServiceData,
 } from "../utils.js";
 
 export interface moveQueueItemNextServiceSchema
   extends baseMassQueueServiceSchema {
   service: "move_queue_item_next";
-  service_data: queueItemPartialSchema;
+  service_data: queueItemServiceData;
 }

package/packages/mass_queue/actions/move_queue_item_up.ts

@@ -1,10 +1,10 @@
 import {
   baseMassQueueServiceSchema,
-  queueItemPartialSchema,
+  queueItemServiceData,
 } from "../utils.js";
 
 export interface moveQueueItemUpServiceSchema
   extends baseMassQueueServiceSchema {
   service: "move_queue_item_up";
-  service_data: queueItemPartialSchema;
+  service_data: queueItemServiceData;
 }

package/packages/mass_queue/actions/play_queue_item.ts

@@ -1,9 +1,9 @@
 import {
   baseMassQueueServiceSchema,
-  queueItemPartialSchema,
+  queueItemServiceData,
 } from "../utils.js";
 
 export interface playQueueItemServiceSchema extends baseMassQueueServiceSchema {
   service: "play_queue_item";
-  service_data: queueItemPartialSchema;
+  service_data: queueItemServiceData;
 }

package/packages/mass_queue/actions/remove_playlist_tracks.ts

@@ -0,0 +1,12 @@
+import { baseMassQueueServiceSchema } from "../utils.js";
+
+export interface removePlaylistTracksServiceData {
+  config_entry_id: string;
+  playlist_id: number | string;
+  positions_to_remove: number[]
+}
+
+export interface removePlaylistTracksServiceSchema extends baseMassQueueServiceSchema {
+  service: "remove_playlist_tracks";
+  service_data: removePlaylistTracksServiceData;
+}

package/packages/mass_queue/actions/remove_queue_item.ts

@@ -1,9 +1,9 @@
 import {
   baseMassQueueServiceSchema,
-  queueItemPartialSchema,
+  queueItemServiceData,
 } from "../utils.js";
 
 export interface removeServiceSchema extends baseMassQueueServiceSchema {
   service: "remove_queue_item";
-  service_data: queueItemPartialSchema;
+  service_data: queueItemServiceData;
 }

package/packages/mass_queue/actions/send_command.ts

@@ -3,7 +3,7 @@ import { baseMassQueueServiceSchema } from "../utils.js";
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type dataSchema = Record<string, any>;
 
-export interface sendCommandPartialSchema {
+export interface sendCommandServiceData {
   command: string;
   config_entry_id: string;
   data: dataSchema | null | undefined;
@@ -11,5 +11,5 @@ export interface sendCommandPartialSchema {
 
 export interface sendCommandServiceSchema extends baseMassQueueServiceSchema {
   service: "send_command";
-  service_data: sendCommandPartialSchema;
+  service_data: sendCommandServiceData;
 }

package/packages/mass_queue/actions/set_group_volume.ts

@@ -1,6 +1,6 @@
 import { baseMassQueueServiceSchema } from "../utils.js";
 
-export interface setGroupVolumePartialSchema {
+export interface setGroupVolumeServiceData {
   entity: string;
   volume_level: number;
 }
@@ -8,5 +8,5 @@ export interface setGroupVolumePartialSchema {
 export interface setGroupVolumeServiceSchema
   extends baseMassQueueServiceSchema {
   service: "set_group_volume";
-  service_data: setGroupVolumePartialSchema;
+  service_data: setGroupVolumeServiceData;
 }

package/packages/mass_queue/actions/unfavorite_current_item.ts

@@ -1,11 +1,11 @@
 import { baseMassQueueServiceSchema } from "../utils.js";
 
-export interface unfavoriteCurrentItemPartialSchema {
+export interface unfavoriteCurrentItemServiceData {
   entity: string;
 }
 
 export interface unfavoriteCurrentItemServiceSchema
   extends baseMassQueueServiceSchema {
   service: "unfavorite_current_item";
-  service_data: unfavoriteCurrentItemPartialSchema;
+  service_data: unfavoriteCurrentItemServiceData;
 }

package/packages/mass_queue/utils.ts

@@ -9,7 +9,7 @@ export interface baseMassQueueServiceWithResponseSchema
   return_response: true;
 }
 
-export interface queueItemPartialSchema {
+export interface queueItemServiceData {
   entity: string;
   queue_item_id: string;
 }
@@ -32,7 +32,7 @@ export interface getTracksServiceResponse {
   };
 }
 
-export interface getCollectionDataPartialServiceSchema {
+export interface getCollectionDataServiceData {
   uri: string;
   config_entry_id: string;
 }

package/packages/music_assistant/actions/get_library.ts

@@ -12,7 +12,7 @@ export interface getLibraryServiceResponse {
   response: getLibraryPartialServiceResponse
 }
 
-export interface getLibraryPartialSchema {
+export interface getLibraryServiceData {
   config_entry_id: string;
   media_type: MediaTypes;
   favorite?: boolean;
@@ -26,5 +26,5 @@ export interface getLibraryPartialSchema {
 export interface getLibraryServiceSchema
   extends baseMusicAssistantServiceWithResponseSchema {
   service: "get_library"
-  service_data: getLibraryPartialSchema  
+  service_data: getLibraryServiceData  
 }

package/packages/music_assistant/actions/get_queue.ts

@@ -20,12 +20,12 @@ export interface getQueueServiceResponse {
   response: getQueueServiceEntitiesResponse;
 }
 
-export interface getQueuePartialSchema {
+export interface getQueueServiceData {
   entity_id: string;
 }
 
 export interface getQueueServiceSchema
   extends baseMusicAssistantServiceWithResponseSchema {
   service: "get_queue"
-  service_data: getQueuePartialSchema
+  service_data: getQueueServiceData
 }

package/packages/music_assistant/actions/play_announcement.ts

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

package/packages/music_assistant/actions/play_media.ts

@@ -1,7 +1,7 @@
 import { EnqueueModes, MediaTypes } from "../types.js";
 import { baseMusicAssistantServiceWithTargetSchema } from "../utils.js";
 
-export interface playMediaPartialSchema {
+export interface playMediaServiceData {
   media_id: string;
   media_type?: MediaTypes;
   artist?: string;
@@ -13,5 +13,5 @@ export interface playMediaPartialSchema {
 export interface playMediaServiceSchema
   extends baseMusicAssistantServiceWithTargetSchema {
   service: "play_media"
-  service_data: playMediaPartialSchema
+  service_data: playMediaServiceData
 }

package/packages/music_assistant/actions/search.ts

@@ -14,7 +14,7 @@ export interface searchServiceResponse {
   response: searchPartialServiceResponse
 }
 
-export interface searchPartialSchema {
+export interface searchServiceData {
   config_entry_id: string;
   name: string;
   media_type?: MediaTypes[];
@@ -27,5 +27,5 @@ export interface searchPartialSchema {
 export interface searchServiceSchema
   extends baseMusicAssistantServiceWithResponseSchema {
   service: "search"
-  service_data: searchPartialSchema  
+  service_data: searchServiceData  
 }

package/packages/music_assistant/actions/transfer_queue.ts

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