mass-queue-types 0.9.2 → 0.10.0

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

package/packages/mass_queue/actions/get_album.ts

@@ -0,0 +1,11 @@
+import { Album } from "../types/media-items.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialSchema } from "../utils.js";
+
+export type getAlbumServiceResponse = Album;
+
+export type getAlbumPartialSchema = getCollectionDataPartialSchema
+
+export interface getAlbumSchema extends baseMassQueueServiceWithResponseSchema {
+  service: 'get_album';
+  service_data: getAlbumPartialSchema;
+}

package/packages/mass_queue/actions/get_album_tracks.ts

@@ -0,0 +1,10 @@
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialSchema, getTracksServiceResponse } from "../utils.js";
+
+export type getAlbumTracksServiceResponse = getTracksServiceResponse;
+
+export type getAlbumTracksPartialSchema = getCollectionDataPartialSchema
+
+export interface getAlbumTracksSchema extends baseMassQueueServiceWithResponseSchema {
+  service: 'get_album_tracks';
+  service_data: getAlbumTracksPartialSchema;
+}

package/packages/mass_queue/actions/get_artist.ts

@@ -0,0 +1,11 @@
+import { Artist } from "../types/media-items.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialSchema } from "../utils.js";
+
+export type getArtistServiceResponse = Artist;
+
+export type getArtistPartialSchema = getCollectionDataPartialSchema
+
+export interface getArtistSchema extends baseMassQueueServiceWithResponseSchema {
+  service: 'get_artist';
+  service_data: getArtistPartialSchema;
+}

package/packages/mass_queue/actions/get_artist_tracks.ts

@@ -0,0 +1,10 @@
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialSchema, getTracksServiceResponse } from "../utils.js";
+
+export type getArtistTracksServiceResponse = getTracksServiceResponse;
+
+export type getArtistTracksPartialSchema = getCollectionDataPartialSchema
+
+export interface getArtistTracksSchema extends baseMassQueueServiceWithResponseSchema {
+  service: 'get_artust_tracks';
+  service_data: getArtistTracksPartialSchema;
+}

package/packages/mass_queue/actions/get_playlist.ts

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

package/packages/mass_queue/actions/get_playlist_tracks.ts

@@ -1,30 +1,10 @@
-import { baseMassQueueServiceWithResponseSchema } from "../utils.js";
+import { baseMassQueueServiceWithResponseSchema, getCollectionDataPartialSchema, getTracksServiceResponse } from "../utils.js";
 
-export interface playlistTrack {
-  media_title: string;
-  media_album_name: string;
-  media_artist: string;
-  media_content_id: string;
-  media_image: string;
-  local_image_encoded?: string;
-  favorite: boolean;
-}
+export type getPlaylistTracksServiceResponse = getTracksServiceResponse;
 
-export type playlistTracks = playlistTrack[];
+export type getPlaylistTracksPartialSchema = getCollectionDataPartialSchema
 
-export interface getPlaylistTracksServiceResponse {
-  response: {
-    tracks: playlistTracks
-  };
-}
-
-export interface getPlaylistTracksPartialSchema {
-  uri: string;
-  config_entry_id: string;
-}
-
-export interface getPlaylistTracksServiceSchema
-  extends baseMassQueueServiceWithResponseSchema {
-  service: "get_playlist_tracks";
+export interface getPlaylistTracksSchema extends baseMassQueueServiceWithResponseSchema {
+  service: 'get_playlist_tracks';
   service_data: getPlaylistTracksPartialSchema;
-}
+}

package/packages/mass_queue/types/audio-format.ts

@@ -0,0 +1,9 @@
+export interface AudioFormat {
+  content_type: string;
+  codec_type: string;
+  sample_rate: number;
+  bit_depth: number;
+  channels: number;
+  output_format_str: string;
+  bit_rate: number;
+}

package/packages/mass_queue/types/media-items.ts

@@ -0,0 +1,135 @@
+import { MediaType } from "./media-type.js";
+import { ProviderMapping } from "./provider-mapping.js";
+
+export interface MediaItem extends MediaItemBase {
+  provider_mappings: ProviderMapping[],
+  metadata: MediaItemMetadata;
+  favorite: boolean;
+  position: number | null;
+}
+
+export interface Artist extends Omit<MediaItem, 'media_type'> {
+  media_type: 'artist';
+}
+export interface Album extends Omit<MediaItem, 'media_type'> {
+  media_type: 'album';
+  year: number | null;
+  album_type: AlbumType;
+  artists: Artist[];
+}
+export interface Track extends Omit<MediaItem, 'media_type'> {
+  media_type: 'track';
+  duration: number | undefined;
+  artists: Artist[];
+  album: Album[];
+  disc_number: number;
+  track_number: number;
+  image?: MediaItemImage | null;
+}
+export interface Playlist extends Omit<MediaItem, 'media_type'> {
+  media_type: 'playlist';
+  owner: string;
+  is_editable: boolean;
+}
+
+export interface Radio extends Omit<MediaItem, 'media_type'> {
+  media_type: 'radio';
+  duration: number | null;
+}
+export interface Audiobook extends Omit<MediaItem, 'media_type'> {
+  media_type: 'audiobook';
+  publisher: string;
+  authors: string[];
+  narrators: string[];
+  duration: number | null;
+  fully_played: boolean | null;
+  resume_position_ms: number | null;
+}
+export interface Podcast extends Omit<MediaItem, 'media_type'> {
+  media_type: 'podcast';
+  publisher: string;
+  total_episodes: number | null;
+}
+export interface PodcastEpisode extends Omit<MediaItem, 'media_type'> {
+  media_type: 'podcast_episode';
+  fully_played: boolean | null;
+  resume_position_ms: number | null;
+}
+
+type externalIds = [string, string][];
+
+interface MediaItemBase {
+  item_id: string;
+  provider: string;
+  name: string;
+  version: string;
+  sort_name: string | null;
+  uri: string | null;
+  external_ids: externalIds;
+  is_playable: boolean;
+  translation_key: string | null;
+  media_type: MediaType;
+}
+
+type MediaImageType = 
+  "thumb"
+  | "landscape"
+  | "fanart"
+  | "logo"
+  | "clearart"
+  | "banner"
+  | "cutout"
+  | "back"
+  | "discart"
+  | "other"
+
+type AlbumType = 
+  "album"
+  | "single"
+  | "live"
+  | "soundtrack"
+  | "compilation"
+  | "ep"
+  | "unknown"
+
+interface MediaItemImage {
+  type: MediaImageType;
+  path: string;
+  provider: string;
+  remotely_accessible: boolean;
+}
+
+interface MediaItemLinkType {
+  type: string;
+  url: string;
+}
+
+interface MediaItemChapter {
+  position: number;
+  name: string;
+  start: number;
+  end: number | null;
+}
+
+interface MediaItemMetadata {
+  description: string | null;
+  review: string | null;
+  explicit: boolean | null;
+  images: MediaItemImage | null;
+  grouping: string | null;
+  genres: string[] | null;
+  mood: string | null;
+  style: string | null;
+  copyright: string | null;
+  lyrics: string | null;
+  lrc_lyrics: string | null;
+  label: string | null;
+  links: MediaItemLinkType[] | null;
+  performers: string[] | null;
+  preview: string | null;
+  popularity: number | null;
+  release_date: string | null;
+  languages: string[] | null;
+  chapters: MediaItemChapter | null;
+  last_refresh: number | null;
+}

package/packages/mass_queue/types/media-type.ts

@@ -0,0 +1,16 @@
+export type MediaType = 
+  "album"
+  | "announcement"
+  | "artist"
+  | "audiobook"
+  | "flow_stream"
+  | "folder"
+  | "genre"
+  | "playlist"
+  | "plugin_source"
+  | "podcast"
+  | "podcast_episode"
+  | "radio"
+  | "sound_effect"
+  | "track"
+  | "unknown"

package/packages/mass_queue/types/provider-mapping.ts

@@ -0,0 +1,13 @@
+import { AudioFormat } from "./audio-format.js";
+
+export interface ProviderMapping {
+  item_id: string;
+  provider_domain: string;
+  provider_instance: string;
+  available: boolean;
+  in_library: boolean | null;
+  is_unique? : boolean | null;
+  audio_format: AudioFormat;
+  url: string | null;
+  details: string | null;
+}

package/packages/mass_queue/utils.ts

@@ -12,4 +12,26 @@ export interface baseMassQueueServiceWithResponseSchema
 export interface queueItemPartialSchema {
   entity: string;
   queue_item_id: string;
+}
+export interface Track {
+  media_title: string;
+  media_album_name: string;
+  media_artist: string;
+  media_content_id: string;
+  media_image: string;
+  local_image_encoded?: string;
+  favorite: boolean;
+}
+
+export type Tracks = Track[];
+
+export interface getTracksServiceResponse {
+  response: {
+    tracks: Tracks
+  };
+}
+
+export interface getCollectionDataPartialSchema {
+  uri: string;
+  config_entry_id: string;
 }