mass-queue-types 0.7.0 → 0.7.1

package/README.md

@@ -25,31 +25,13 @@ Typescript types and interfaces for the [Music Assistant Queue Actions](https://
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-  - [Installation](#installation)
-- [Configuration](#configuration)
-  - [Base Config](#base-config)
-  - [Entity Config](#entity-config)
-  - [Entity Hidden Elements Config](#entity-hidden-elements-config)
-  - [Music Player Config](#music-player-config)
-  - [Music Player Hidden Elements Config](#music-player-hidden-elements-config)
-  - [Music Player Layout Config](#music-player-layout-config)
-  - [Queue Config](#queue-config)
-  - [Queue Hidden Elements Config](#queue-hidden-elements-config)
-  - [Media Browser Config](#media-browser-config)
-  - [Media Browser Hidden Elements Config](#media-browser-hidden-elements-config)
-  - [Favorites Config](#favorites-config)
-  - [Recommendations Config](#recommendations-config)
-  - [Sections Config](#sections-config)
-  - [Section Item Config](#section-item-config)
-  - [Players Config](#players-config)
-  - [Players Hidden Elements Config](#players-hidden-elements-config)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Service Schemas](#service-schemas)
+  - [Response Schemas](#response-schemas)
+  - [Websocket Commands](#websocket-commands)
 - [FAQs](#faqs)
-  - [The card won't display at all or won't display properly!](#the-card-wont-display-at-all-or-wont-display-properly)
-  - [The media browser won't display any items for:](#the-media-browser-wont-display-any-items-for)
-  - [I'm not seeing any artwork in the queue or media browser!](#im-not-seeing-any-artwork-in-the-queue-or-media-browser)
-  - [How do I theme the card?](#how-do-i-theme-the-card)
-  - [Can this card work in my local language?](#can-this-card-work-in-my-local-language)
-  - [I am having issues with this card on my iOS/OSX device but it works fine elsewhere.](#i-am-having-issues-with-this-card-on-my-iososx-device-but-it-works-fine-elsewhere)
+  - [I would like to sponsor you/the card and/or pay to add a new feature!](#i-would-like-to-sponsor-youthe-card-andor-pay-to-add-a-new-feature)
   - [I have other questions or issues not addressed](#i-have-other-questions-or-issues-not-addressed)
 - [Contributing](#contributing)
 - [Developing](#developing)

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.0",
+  "version": "0.7.1",
   "module": "mass-queue-types.js",
   "keywords": [
     "home-assistant",
@@ -43,7 +43,7 @@
   },
   "scripts": {
     "build": "yarn rollup",
-    "prettier": "prettier ./src --write",
+    "prettier": "prettier ./packages --write",
     "lint": "eslint packages/**/*.ts --max-warnings 0 --no-warn-ignored",
     "full": "echo 'Generating TOC' && yarn docs && echo 'Running Prettier' && yarn prettier && echo 'Linting' && yarn lint",
     "docs": "doctoc ./README.md --maxlevel 2"

package/packages/actions/get_group_volume.ts

@@ -1,18 +1,19 @@
 import { baseMassQueueServiceWithResponseSchema } from "../utils.js";
 
 export interface getGroupVolumePartialServiceResponse {
-  volume_level: number
+  volume_level: number;
 }
 
 export interface getGroupVolumeServiceResponse {
-  response: getGroupVolumePartialSchema
+  response: getGroupVolumePartialSchema;
 }
 
 export interface getGroupVolumePartialSchema {
   entity: string;
 }
 
-export interface getGroupVolumeServiceSchema extends baseMassQueueServiceWithResponseSchema {
-  service: "get_group_volume",
-  service_data: getGroupVolumePartialSchema,
-}
+export interface getGroupVolumeServiceSchema
+  extends baseMassQueueServiceWithResponseSchema {
+  service: "get_group_volume";
+  service_data: getGroupVolumePartialSchema;
+}

package/packages/actions/get_queue_items.ts

@@ -13,14 +13,14 @@ export interface queueItem {
   show_artist_name: boolean;
   show_move_up_next: boolean;
   favorite: boolean;
-};
+}
 
 export type queueItems = queueItem[];
 
 type getQueueItemsPartialResponse = Record<string, queueItems>;
 
 export interface getQueueItemsServiceResponse {
-  response: getQueueItemsPartialResponse
+  response: getQueueItemsPartialResponse;
 }
 
 export interface getQueueItemsPartialSchema {
@@ -31,7 +31,8 @@ export interface getQueueItemsPartialSchema {
   offset?: number;
 }
 
-export interface getQueueItemsServiceSchema extends baseMassQueueServiceWithResponseSchema {
-  service: "get_queue_items",
-  service_data: getQueueItemsPartialSchema,
-}
+export interface getQueueItemsServiceSchema
+  extends baseMassQueueServiceWithResponseSchema {
+  service: "get_queue_items";
+  service_data: getQueueItemsPartialSchema;
+}

package/packages/actions/get_recommendations.ts

@@ -34,7 +34,8 @@ export interface getRecommendationsPartialSchema {
   entity: string;
 }
 
-export interface getRecommendationsServiceSchema extends baseMassQueueServiceWithResponseSchema {
-  service: "get_recommendations",
-  service_data: getRecommendationsPartialSchema,
-}
+export interface getRecommendationsServiceSchema
+  extends baseMassQueueServiceWithResponseSchema {
+  service: "get_recommendations";
+  service_data: getRecommendationsPartialSchema;
+}

package/packages/actions/move_queue_item_down.ts

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

package/packages/actions/move_queue_item_next.ts

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

package/packages/actions/move_queue_item_up.ts

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

package/packages/actions/play_queue_item.ts

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

package/packages/actions/remove_queue_item.ts

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

package/packages/actions/send_command.ts

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

package/packages/actions/set_group_volume.ts

@@ -5,7 +5,8 @@ export interface setGroupVolumePartialSchema {
   volume_level: number;
 }
 
-export interface setGroupVolumeServiceSchema extends baseMassQueueServiceSchema {
-  service: "set_group_volume",
-  service_data: setGroupVolumePartialSchema,
+export interface setGroupVolumeServiceSchema
+  extends baseMassQueueServiceSchema {
+  service: "set_group_volume";
+  service_data: setGroupVolumePartialSchema;
 }

package/packages/actions/unfavorite_current_item.ts

@@ -4,7 +4,8 @@ export interface unfavoriteCurrentItemPartialSchema {
   entity: string;
 }
 
-export interface unfavoriteCurrentItemServiceSchema extends baseMassQueueServiceSchema {
-  service: "unfavorite_current_item",
-  service_data: unfavoriteCurrentItemPartialSchema,
+export interface unfavoriteCurrentItemServiceSchema
+  extends baseMassQueueServiceSchema {
+  service: "unfavorite_current_item";
+  service_data: unfavoriteCurrentItemPartialSchema;
 }

package/packages/utils.ts

@@ -1,14 +1,15 @@
 export interface baseMassQueueServiceSchema {
-  type: "call_service",
-  domain: "mass_queue",
-  service: string
+  type: "call_service";
+  domain: "mass_queue";
+  service: string;
 }
 
-export interface baseMassQueueServiceWithResponseSchema extends baseMassQueueServiceSchema {
+export interface baseMassQueueServiceWithResponseSchema
+  extends baseMassQueueServiceSchema {
   return_response: true;
 }
 
 export interface queueItemPartialSchema {
   entity: string;
   queue_item_id: string;
-}
+}

package/packages/ws/encode_images.ts

@@ -15,4 +15,4 @@ export interface encodedImageData extends imageData {
   encoded: string;
 }
 
-export type encodeImagesWSServiceResponse = encodedImageData[];
+export type encodeImagesWSServiceResponse = encodedImageData[];

package/packages/ws/get_info.ts

@@ -27,6 +27,6 @@ export interface getInfoWSResponseSchema {
       websocket: string;
     };
   };
-  synced_to: string|null
+  synced_to: string | null;
   type: string;
-}
+}