@nuclearplayer/plugin-sdk 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -99,6 +99,53 @@ export declare type EnumWidget = {
     type: 'radio';
 };
 
+export declare type FavoriteEntry<T> = {
+    ref: T;
+    addedAtIso: string;
+};
+
+export declare class FavoritesAPI {
+    #private;
+    constructor(host?: FavoritesHost);
+    getTracks(): Promise<FavoriteEntry<Track>[]>;
+    getAlbums(): Promise<FavoriteEntry<AlbumRef>[]>;
+    getArtists(): Promise<FavoriteEntry<ArtistRef>[]>;
+    addTrack(track: Track): Promise<void>;
+    removeTrack(source: ProviderRef): Promise<void>;
+    isTrackFavorite(source: ProviderRef): Promise<boolean>;
+    addAlbum(ref: AlbumRef): Promise<void>;
+    removeAlbum(source: ProviderRef): Promise<void>;
+    isAlbumFavorite(source: ProviderRef): Promise<boolean>;
+    addArtist(ref: ArtistRef): Promise<void>;
+    removeArtist(source: ProviderRef): Promise<void>;
+    isArtistFavorite(source: ProviderRef): Promise<boolean>;
+    subscribe(listener: FavoritesListener): () => void;
+}
+
+export declare type FavoritesData = {
+    tracks: FavoriteEntry<Track>[];
+    albums: FavoriteEntry<AlbumRef>[];
+    artists: FavoriteEntry<ArtistRef>[];
+};
+
+export declare type FavoritesHost = {
+    getTracks: () => Promise<FavoriteEntry<Track>[]>;
+    getAlbums: () => Promise<FavoriteEntry<AlbumRef>[]>;
+    getArtists: () => Promise<FavoriteEntry<ArtistRef>[]>;
+    addTrack: (track: Track) => Promise<void>;
+    removeTrack: (source: ProviderRef) => Promise<void>;
+    isTrackFavorite: (source: ProviderRef) => Promise<boolean>;
+    addAlbum: (ref: AlbumRef) => Promise<void>;
+    removeAlbum: (source: ProviderRef) => Promise<void>;
+    isAlbumFavorite: (source: ProviderRef) => Promise<boolean>;
+    addArtist: (ref: ArtistRef) => Promise<void>;
+    removeArtist: (source: ProviderRef) => Promise<void>;
+    isArtistFavorite: (source: ProviderRef) => Promise<boolean>;
+    subscribe: (listener: FavoritesListener) => () => void;
+};
+
+export declare type FavoritesListener = (favorites: FavoritesData) => void;
+
 export declare type FetchFunction = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 
 export declare class HttpAPI {
@@ -187,6 +234,7 @@ export declare class NuclearAPI {
     readonly Metadata: MetadataAPI;
     readonly Http: HttpAPI;
     readonly Ytdlp: YtdlpAPI;
+    readonly Favorites: FavoritesAPI;
     constructor(opts?: {
         settingsHost?: SettingsHost;
         providersHost?: ProvidersHost;
@@ -195,6 +243,7 @@ export declare class NuclearAPI {
         metadataHost?: MetadataHost;
         httpHost?: HttpHost;
         ytdlpHost?: YtdlpHost;
+        favoritesHost?: FavoritesHost;
     });
 }
 

package/dist/index.js

@@ -1,5 +1,56 @@
 import { useState as l, useEffect as f, useMemo as g } from "react";
-const b = (s) => {
+class b {
+  #e;
+  constructor(t) {
+    this.#e = t;
+  }
+  #t(t) {
+    const e = this.#e;
+    if (!e)
+      throw new Error("Favorites host not available");
+    return t(e);
+  }
+  getTracks() {
+    return this.#t((t) => t.getTracks());
+  }
+  getAlbums() {
+    return this.#t((t) => t.getAlbums());
+  }
+  getArtists() {
+    return this.#t((t) => t.getArtists());
+  }
+  addTrack(t) {
+    return this.#t((e) => e.addTrack(t));
+  }
+  removeTrack(t) {
+    return this.#t((e) => e.removeTrack(t));
+  }
+  isTrackFavorite(t) {
+    return this.#t((e) => e.isTrackFavorite(t));
+  }
+  addAlbum(t) {
+    return this.#t((e) => e.addAlbum(t));
+  }
+  removeAlbum(t) {
+    return this.#t((e) => e.removeAlbum(t));
+  }
+  isAlbumFavorite(t) {
+    return this.#t((e) => e.isAlbumFavorite(t));
+  }
+  addArtist(t) {
+    return this.#t((e) => e.addArtist(t));
+  }
+  removeArtist(t) {
+    return this.#t((e) => e.removeArtist(t));
+  }
+  isArtistFavorite(t) {
+    return this.#t((e) => e.isArtistFavorite(t));
+  }
+  subscribe(t) {
+    return this.#t((e) => e.subscribe(t));
+  }
+}
+const m = (s) => {
   if (s instanceof Headers) {
     const t = {};
     return s.forEach((e, r) => {
@@ -8,12 +59,12 @@ const b = (s) => {
   }
   return Array.isArray(s) ? Object.fromEntries(s) : s;
 };
-function m(s) {
+function A(s) {
   return async (t, e) => {
-    const r = String(t instanceof Request ? t.url : t), a = e?.headers ? b(e.headers) : void 0, o = typeof e?.body == "string" ? e.body : void 0, u = await s.fetch(r, {
+    const r = String(t instanceof Request ? t.url : t), a = e?.headers ? m(e.headers) : void 0, n = typeof e?.body == "string" ? e.body : void 0, u = await s.fetch(r, {
       method: e?.method,
       headers: a,
-      body: o
+      body: n
     });
     return new Response(u.body, {
       status: u.status,
@@ -21,20 +72,20 @@ function m(s) {
     });
   };
 }
-const A = {
+const v = {
   fetch: async () => ({
     status: 501,
     headers: {},
     body: "HTTP host not configured"
   })
 };
-class p {
+class w {
   fetch;
   constructor(t) {
-    this.fetch = m(t ?? A);
+    this.fetch = A(t ?? v);
   }
 }
-class v {
+class T {
   #e;
   constructor(t) {
     this.#e = t;
@@ -66,7 +117,7 @@ class v {
     return this.#t((r) => r.fetchAlbumDetails(t, e));
   }
 }
-class w {
+class p {
   #e;
   constructor(t) {
     this.#e = t;
@@ -156,7 +207,7 @@ class I {
     return this.#t((e) => e.subscribeToCurrentItem(t));
   }
 }
-class T {
+class H {
   #e;
   constructor(t) {
     this.#e = t;
@@ -198,7 +249,7 @@ class y {
     return this.#t((e) => e.resolveStreamForCandidate(t));
   }
 }
-class H {
+class S {
   host;
   constructor(t) {
     this.host = t;
@@ -217,7 +268,7 @@ class H {
     return this.host.getStream(t);
   }
 }
-class S {
+class F {
   Settings;
   Providers;
   Queue;
@@ -225,12 +276,12 @@ class S {
   Metadata;
   Http;
   Ytdlp;
-  // All these are optional so we don't have to provide all of them in tests
+  Favorites;
   constructor(t) {
-    this.Settings = new T(t?.settingsHost), this.Providers = new w(t?.providersHost), this.Queue = new I(t?.queueHost), this.Streaming = new y(t?.streamingHost), this.Metadata = new v(t?.metadataHost), this.Http = new p(t?.httpHost), this.Ytdlp = new H(t?.ytdlpHost);
+    this.Settings = new H(t?.settingsHost), this.Providers = new p(t?.providersHost), this.Queue = new I(t?.queueHost), this.Streaming = new y(t?.streamingHost), this.Metadata = new T(t?.metadataHost), this.Http = new w(t?.httpHost), this.Ytdlp = new S(t?.ytdlpHost), this.Favorites = new b(t?.favoritesHost);
   }
 }
-class P extends S {
+class P extends F {
 }
 class M extends Error {
   constructor(t) {
@@ -242,19 +293,19 @@ const C = (s, t) => {
   f(() => {
     if (!s)
       return;
-    let o = !0, u = !1;
-    const i = s.subscribe(t, (n) => {
-      o && (u = !0, r(n));
+    let n = !0, u = !1;
+    const i = s.subscribe(t, (o) => {
+      n && (u = !0, r(o));
     });
-    return s.get(t).then((n) => {
-      o && (u || r(n));
+    return s.get(t).then((o) => {
+      n && (u || r(o));
     }), () => {
-      o = !1, i && i();
+      n = !1, i && i();
     };
   }, [t, s]);
   const a = g(
-    () => (o) => {
-      s && s.set(t, o);
+    () => (n) => {
+      s && s.set(t, n);
     },
     [t, s]
   );
@@ -280,19 +331,20 @@ function R(s, t, e) {
     }
   })(t);
   return r.map((i) => {
-    const n = Math.min(i.width || 0, i.height || 0), h = Math.abs(a(i) - u), c = Math.abs(n - e), d = n < e ? e / n : 1;
+    const o = Math.min(i.width || 0, i.height || 0), h = Math.abs(a(i) - u), c = Math.abs(o - e), d = o < e ? e / o : 1;
     return {
       artwork: i,
       score: (d > 1.5 ? -1e3 : 0) + -h * 50 + -c * 0.1
     };
-  }).sort((i, n) => n.score - i.score)[0]?.artwork;
+  }).sort((i, o) => o.score - i.score)[0]?.artwork;
 }
 export {
-  p as HttpAPI,
+  b as FavoritesAPI,
+  w as HttpAPI,
   M as MissingCapabilityError,
-  S as NuclearAPI,
+  F as NuclearAPI,
   P as NuclearPluginAPI,
-  H as YtdlpAPI,
+  S as YtdlpAPI,
   R as pickArtwork,
   C as useSetting
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuclearplayer/plugin-sdk",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Plugin SDK for Nuclear music player",
   "type": "module",
   "main": "./dist/index.js",
@@ -38,8 +38,8 @@
     "vite": "^7.1.3",
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^3.2.4",
-    "@nuclearplayer/tailwind-config": "0.0.10",
-    "@nuclearplayer/eslint-config": "0.0.10"
+    "@nuclearplayer/eslint-config": "0.0.10",
+    "@nuclearplayer/tailwind-config": "0.0.10"
   },
   "peerDependencies": {
     "react": "^18.3.1"