cody-music - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

dist/index.d.ts

@@ -30,2 +30,8 @@ import { PlayerName, TrackState, PlayerDevice, SpotifyAudioFeature } from "./lib/models";
 /**
+ * Returns the currently running track info (player and track).
+ * This only supports returning the state for itunes and spotify desktop
+ * on Mac and spotify desktop on windows.
+ **/
+export declare function getRunningPlayerState(): Promise<TrackState>;
+/**
  * Returns the player state and track of a given player {spotify|spotify-web|itunes}
@@ -39,9 +45,2 @@ * - Spotify does not return a "genre"
 /**
- * Returns the currently running track info (player and track).
- * This only supports returning the state for itunes and spotify desktop
- * on Mac and spotify desktop on windows.
- * Deprecated - use "getState(player:PlayerName)" instead
- */
-export declare function getCurrentlyRunningTrackState(): Promise<TrackState>;
-/**
  * Returns the tracks that are found by the given playlist name
@@ -187,8 +186,33 @@ * @param player {spotify|spotify-web|itunes}
 export declare function getSpotifyAudioFeatures(ids: string[]): Promise<SpotifyAudioFeature[]>;
+/**
+ * Deprecated - use "getRunningPlayerState()" instead
+ */
+export declare function getCurrentlyRunningTrackState(): Promise<TrackState>;
+/**
+ * deprecated, please use "getPlayerState"
+ */
 export declare function getState(player: PlayerName): Promise<TrackState>;
+/**
+ * deprecated, please use "launchPlayer('spotify')"
+ **/
 export declare function startSpotifyIfNotRunning(): Promise<any>;
+/**
+ * deprecated, please use "launchPlayer('itunes')"
+ */
 export declare function startItunesIfNotRunning(): Promise<any>;
+/**
+ * deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+ */
 export declare function isRunning(player: PlayerName): Promise<boolean>;
+/**
+ * deprecated, pluse use "setRepat(player, repeat)"
+ */
 export declare function repeatOn(player: PlayerName): Promise<any>;
+/**
+ * deprecated, pluse use "setRepat(player, repeat)"
+ */
 export declare function repeatOff(player: PlayerName): Promise<any>;
+/**
+ * deprecated, pluse use "unmute(player)"
+ */
 export declare function unMute(player: PlayerName): Promise<any>;

dist/index.js

@@ -66,2 +66,17 @@ "use strict";
 /**
+ * Returns the currently running track info (player and track).
+ * This only supports returning the state for itunes and spotify desktop
+ * on Mac and spotify desktop on windows.
+ **/
+async function getRunningPlayerState() {
+    if (await musicCtr.isMusicPlayerActive(models_1.PlayerName.SpotifyDesktop)) {
+        return getPlayerState(models_1.PlayerName.SpotifyDesktop);
+    }
+    else if (await musicCtr.isMusicPlayerActive(models_1.PlayerName.ItunesDesktop)) {
+        return getPlayerState(models_1.PlayerName.ItunesDesktop);
+    }
+    return getPlayerState(models_1.PlayerName.SpotifyWeb);
+}
+exports.getRunningPlayerState = getRunningPlayerState;
+/**
  * Returns the player state and track of a given player {spotify|spotify-web|itunes}
@@ -85,12 +100,2 @@ * - Spotify does not return a "genre"
 /**
- * Returns the currently running track info (player and track).
- * This only supports returning the state for itunes and spotify desktop
- * on Mac and spotify desktop on windows.
- * Deprecated - use "getState(player:PlayerName)" instead
- */
-function getCurrentlyRunningTrackState() {
-    return musicPlayerCtr.getCurrentlyRunningTrackState();
-}
-exports.getCurrentlyRunningTrackState = getCurrentlyRunningTrackState;
-/**
  * Returns the tracks that are found by the given playlist name
@@ -368,6 +373,12 @@ * @param player {spotify|spotify-web|itunes}
 exports.getSpotifyAudioFeatures = getSpotifyAudioFeatures;
-//
-// Deprecated functions
-//
-// deprecated, please use "getPlayerState"
+/**
+ * Deprecated - use "getRunningPlayerState()" instead
+ */
+function getCurrentlyRunningTrackState() {
+    return musicPlayerCtr.getCurrentlyRunningTrackState();
+}
+exports.getCurrentlyRunningTrackState = getCurrentlyRunningTrackState;
+/**
+ * deprecated, please use "getPlayerState"
+ */
 function getState(player) {
@@ -377,3 +388,5 @@ return getPlayerState(player);
 exports.getState = getState;
-// deprecated, please use "launchPlayer('spotify')"
+/**
+ * deprecated, please use "launchPlayer('spotify')"
+ **/
 function startSpotifyIfNotRunning() {
@@ -383,3 +396,5 @@ return musicCtr.launchApp(models_1.PlayerName.SpotifyDesktop);
 exports.startSpotifyIfNotRunning = startSpotifyIfNotRunning;
-// deprecated, please use "launchPlayer('itunes')"
+/**
+ * deprecated, please use "launchPlayer('itunes')"
+ */
 function startItunesIfNotRunning() {
@@ -389,3 +404,5 @@ return musicCtr.launchApp(models_1.PlayerName.ItunesDesktop);
 exports.startItunesIfNotRunning = startItunesIfNotRunning;
-// deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+/**
+ * deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+ */
 function isRunning(player) {
@@ -395,3 +412,5 @@ return isPlayerRunning(player);
 exports.isRunning = isRunning;
-// deprecated, pluse use "setRepat(player, repeat)"
+/**
+ * deprecated, pluse use "setRepat(player, repeat)"
+ */
 function repeatOn(player) {
@@ -401,3 +420,5 @@ return setRepeat(player, true);
 exports.repeatOn = repeatOn;
-// deprecated, pluse use "setRepat(player, repeat)"
+/**
+ * deprecated, pluse use "setRepat(player, repeat)"
+ */
 function repeatOff(player) {
@@ -407,3 +428,5 @@ return setRepeat(player, false);
 exports.repeatOff = repeatOff;
-// deprecated, pluse use "unmute(player)"
+/**
+ * deprecated, pluse use "unmute(player)"
+ */
 function unMute(player) {
@@ -410,0 +433,0 @@ return unmute(player);

index.ts

@@ -72,2 +72,16 @@ "use strict";
 /**
+ * Returns the currently running track info (player and track).
+ * This only supports returning the state for itunes and spotify desktop
+ * on Mac and spotify desktop on windows.
+ **/
+export async function getRunningPlayerState(): Promise<TrackState> {
+    if (await musicCtr.isMusicPlayerActive(PlayerName.SpotifyDesktop)) {
+        return getPlayerState(PlayerName.SpotifyDesktop);
+    } else if (await musicCtr.isMusicPlayerActive(PlayerName.ItunesDesktop)) {
+        return getPlayerState(PlayerName.ItunesDesktop);
+    }
+    return getPlayerState(PlayerName.SpotifyWeb);
+}
+
+/**
  * Returns the player state and track of a given player {spotify|spotify-web|itunes}
@@ -91,12 +105,2 @@ * - Spotify does not return a "genre"
 /**
- * Returns the currently running track info (player and track).
- * This only supports returning the state for itunes and spotify desktop
- * on Mac and spotify desktop on windows.
- * Deprecated - use "getState(player:PlayerName)" instead
- */
-export function getCurrentlyRunningTrackState(): Promise<TrackState> {
-    return musicPlayerCtr.getCurrentlyRunningTrackState();
-}
-
-/**
  * Returns the tracks that are found by the given playlist name
@@ -383,7 +387,12 @@ * @param player {spotify|spotify-web|itunes}
 
-//
-// Deprecated functions
-//
+/**
+ * Deprecated - use "getRunningPlayerState()" instead
+ */
+export function getCurrentlyRunningTrackState(): Promise<TrackState> {
+    return musicPlayerCtr.getCurrentlyRunningTrackState();
+}
 
-// deprecated, please use "getPlayerState"
+/**
+ * deprecated, please use "getPlayerState"
+ */
 export function getState(player: PlayerName): Promise<TrackState> {
@@ -393,3 +402,5 @@ return getPlayerState(player);
 
-// deprecated, please use "launchPlayer('spotify')"
+/**
+ * deprecated, please use "launchPlayer('spotify')"
+ **/
 export function startSpotifyIfNotRunning() {
@@ -399,3 +410,5 @@ return musicCtr.launchApp(PlayerName.SpotifyDesktop);
 
-// deprecated, please use "launchPlayer('itunes')"
+/**
+ * deprecated, please use "launchPlayer('itunes')"
+ */
 export function startItunesIfNotRunning() {
@@ -405,3 +418,5 @@ return musicCtr.launchApp(PlayerName.ItunesDesktop);
 
-// deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+/**
+ * deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+ */
 export function isRunning(player: PlayerName): Promise<boolean> {
@@ -411,3 +426,5 @@ return isPlayerRunning(player);
 
-// deprecated, pluse use "setRepat(player, repeat)"
+/**
+ * deprecated, pluse use "setRepat(player, repeat)"
+ */
 export function repeatOn(player: PlayerName) {
@@ -417,3 +434,5 @@ return setRepeat(player, true);
 
-// deprecated, pluse use "setRepat(player, repeat)"
+/**
+ * deprecated, pluse use "setRepat(player, repeat)"
+ */
 export function repeatOff(player: PlayerName) {
@@ -423,5 +442,7 @@ return setRepeat(player, false);
 
-// deprecated, pluse use "unmute(player)"
+/**
+ * deprecated, pluse use "unmute(player)"
+ */
 export function unMute(player: PlayerName) {
     return unmute(player);
 }

package.json

 {
     "name": "cody-music",
-    "version": "1.2.0",
+    "version": "1.2.1",
     "description": "mac osx spotify and itunes music player controller, spotify audio features, itunes and spotify genre, and playlist control",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -115,7 +115,4 @@ # cody-music
  * Returns the currently running track info (player and track).
- * This only supports returning the state for itunes and spotify desktop
- * on Mac and spotify desktop on windows.
- * Deprecated - use "getState(player:PlayerName)" instead
  */
-getCurrentlyRunningTrackState(): Promise<TrackState>
+getRunningPlayerState(): Promise<TrackState>
 
@@ -292,2 +289,5 @@ /**
 
+// deprecated, please use "getRunningPlayerState()"
+getCurrentlyRunningTrackState(): Promise<TrackState>
+
 // deprecated, please use "getPlayerState"
@@ -294,0 +294,0 @@ getState(player: PlayerName): Promise<TrackState>

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

217479

increased by0.62%

Lines of code

5144

increased by1.34%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes