@nuclearplayer/plugin-sdk 1.0.0 → 1.2.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 {
@@ -139,6 +186,23 @@ export declare type LocalFileInfo = {
     scannedAtIso?: string;
 };
 
+export declare class LoggerAPI {
+    private host;
+    constructor(host?: LoggerHost);
+    trace(message: string): void;
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+    log(level: LogLevel, message: string): void;
+}
+
+export declare type LoggerHost = {
+    log: (level: LogLevel, message: string) => void;
+};
+
+export declare type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error';
+
 declare class MetadataAPI {
     #private;
     constructor(host?: MetadataHost);
@@ -187,6 +251,8 @@ export declare class NuclearAPI {
     readonly Metadata: MetadataAPI;
     readonly Http: HttpAPI;
     readonly Ytdlp: YtdlpAPI;
+    readonly Favorites: FavoritesAPI;
+    readonly Logger: LoggerAPI;
     constructor(opts?: {
         settingsHost?: SettingsHost;
         providersHost?: ProvidersHost;
@@ -195,6 +261,8 @@ export declare class NuclearAPI {
         metadataHost?: MetadataHost;
         httpHost?: HttpHost;
         ytdlpHost?: YtdlpHost;
+        favoritesHost?: FavoritesHost;
+        loggerHost?: LoggerHost;
     });
 }
 

package/dist/index.js

@@ -1,40 +1,119 @@
-import { useState as l, useEffect as f, useMemo as g } from "react";
-const b = (s) => {
-  if (s instanceof Headers) {
+import { useState as l, useEffect as g, useMemo as f } from "react";
+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 = (r) => {
+  if (r instanceof Headers) {
     const t = {};
-    return s.forEach((e, r) => {
-      t[r] = e;
+    return r.forEach((e, s) => {
+      t[s] = e;
     }), t;
   }
-  return Array.isArray(s) ? Object.fromEntries(s) : s;
+  return Array.isArray(r) ? Object.fromEntries(r) : r;
 };
-function m(s) {
+function A(r) {
   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 s = String(t instanceof Request ? t.url : t), u = e?.headers ? m(e.headers) : void 0, n = typeof e?.body == "string" ? e.body : void 0, a = await r.fetch(s, {
       method: e?.method,
-      headers: a,
-      body: o
+      headers: u,
+      body: n
     });
-    return new Response(u.body, {
-      status: u.status,
-      headers: new Headers(u.headers)
+    return new Response(a.body, {
+      status: a.status,
+      headers: new Headers(a.headers)
     });
   };
 }
-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);
+  }
+}
+const T = {
+  log: () => {
+  }
+};
+class p {
+  host;
+  constructor(t) {
+    this.host = t ?? T;
+  }
+  trace(t) {
+    this.host.log("trace", t);
+  }
+  debug(t) {
+    this.host.log("debug", t);
+  }
+  info(t) {
+    this.host.log("info", t);
+  }
+  warn(t) {
+    this.host.log("warn", t);
+  }
+  error(t) {
+    this.host.log("error", t);
+  }
+  log(t, e) {
+    this.host.log(t, e);
   }
 }
-class v {
+class I {
   #e;
   constructor(t) {
     this.#e = t;
@@ -46,27 +125,27 @@ class v {
     return t(e);
   }
   search(t, e) {
-    return this.#t((r) => r.search(t, e));
+    return this.#t((s) => s.search(t, e));
   }
   fetchArtistDetails(t, e) {
-    return this.#t((r) => r.fetchArtistDetails(t, e));
+    return this.#t((s) => s.fetchArtistDetails(t, e));
   }
   fetchArtistAlbums(t, e) {
-    return this.#t((r) => r.fetchArtistAlbums(t, e));
+    return this.#t((s) => s.fetchArtistAlbums(t, e));
   }
   fetchArtistTopTracks(t, e) {
-    return this.#t((r) => r.fetchArtistTopTracks(t, e));
+    return this.#t((s) => s.fetchArtistTopTracks(t, e));
   }
   fetchArtistRelatedArtists(t, e) {
     return this.#t(
-      (r) => r.fetchArtistRelatedArtists(t, e)
+      (s) => s.fetchArtistRelatedArtists(t, e)
     );
   }
   fetchAlbumDetails(t, e) {
-    return this.#t((r) => r.fetchAlbumDetails(t, e));
+    return this.#t((s) => s.fetchAlbumDetails(t, e));
   }
 }
-class w {
+class H {
   #e;
   constructor(t) {
     this.#e = t;
@@ -90,7 +169,7 @@ class w {
     return this.#t((e) => e.get(t));
   }
 }
-class I {
+class y {
   #e;
   constructor(t) {
     this.#e = t;
@@ -114,7 +193,7 @@ class I {
     return this.#t((e) => e.addNext(t));
   }
   addAt(t, e) {
-    return this.#t((r) => r.addAt(t, e));
+    return this.#t((s) => s.addAt(t, e));
   }
   removeByIds(t) {
     return this.#t((e) => e.removeByIds(t));
@@ -126,10 +205,10 @@ class I {
     return this.#t((t) => t.clearQueue());
   }
   reorder(t, e) {
-    return this.#t((r) => r.reorder(t, e));
+    return this.#t((s) => s.reorder(t, e));
   }
   updateItemState(t, e) {
-    return this.#t((r) => r.updateItemState(t, e));
+    return this.#t((s) => s.updateItemState(t, e));
   }
   goToNext() {
     return this.#t((t) => t.goToNext());
@@ -156,7 +235,7 @@ class I {
     return this.#t((e) => e.subscribeToCurrentItem(t));
   }
 }
-class T {
+class S {
   #e;
   constructor(t) {
     this.#e = t;
@@ -174,13 +253,13 @@ class T {
     return this.#t((e) => e.get(t));
   }
   set(t, e) {
-    return this.#t((r) => r.set(t, e));
+    return this.#t((s) => s.set(t, e));
   }
   subscribe(t, e) {
-    return this.#t((r) => r.subscribe(t, e));
+    return this.#t((s) => s.subscribe(t, e));
   }
 }
-class y {
+class F {
   #e;
   constructor(t) {
     this.#e = t;
@@ -198,7 +277,7 @@ class y {
     return this.#t((e) => e.resolveStreamForCandidate(t));
   }
 }
-class H {
+class P {
   host;
   constructor(t) {
     this.host = t;
@@ -217,7 +296,7 @@ class H {
     return this.host.getStream(t);
   }
 }
-class S {
+class E {
   Settings;
   Providers;
   Queue;
@@ -225,48 +304,49 @@ class S {
   Metadata;
   Http;
   Ytdlp;
-  // All these are optional so we don't have to provide all of them in tests
+  Favorites;
+  Logger;
   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 S(t?.settingsHost), this.Providers = new H(t?.providersHost), this.Queue = new y(t?.queueHost), this.Streaming = new F(t?.streamingHost), this.Metadata = new I(t?.metadataHost), this.Http = new w(t?.httpHost), this.Ytdlp = new P(t?.ytdlpHost), this.Favorites = new b(t?.favoritesHost), this.Logger = new p(t?.loggerHost);
   }
 }
-class P extends S {
+class C extends E {
 }
-class M extends Error {
+class R extends Error {
   constructor(t) {
     super(`Missing capability: ${t}`), this.name = "MissingCapabilityError";
   }
 }
-const C = (s, t) => {
-  const [e, r] = l(void 0);
-  f(() => {
-    if (!s)
+const k = (r, t) => {
+  const [e, s] = l(void 0);
+  g(() => {
+    if (!r)
       return;
-    let o = !0, u = !1;
-    const i = s.subscribe(t, (n) => {
-      o && (u = !0, r(n));
+    let n = !0, a = !1;
+    const i = r.subscribe(t, (o) => {
+      n && (a = !0, s(o));
     });
-    return s.get(t).then((n) => {
-      o && (u || r(n));
+    return r.get(t).then((o) => {
+      n && (a || s(o));
     }), () => {
-      o = !1, i && i();
+      n = !1, i && i();
     };
-  }, [t, s]);
-  const a = g(
-    () => (o) => {
-      s && s.set(t, o);
+  }, [t, r]);
+  const u = f(
+    () => (n) => {
+      r && r.set(t, n);
     },
-    [t, s]
+    [t, r]
   );
-  return [e, a];
+  return [e, u];
 };
-function R(s, t, e) {
-  if (!s?.items?.length)
+function Q(r, t, e) {
+  if (!r?.items?.length)
     return;
-  const r = s.items.filter((i) => !(i.purpose && i.purpose !== t || !i.url));
-  if (!r.length)
-    return s.items[0];
-  const a = (i) => !i.width || !i.height ? 1 : i.width / i.height, u = ((i) => {
+  const s = r.items.filter((i) => !(i.purpose && i.purpose !== t || !i.url));
+  if (!s.length)
+    return r.items[0];
+  const u = (i) => !i.width || !i.height ? 1 : i.width / i.height, a = ((i) => {
     switch (i) {
       case "avatar":
       case "thumbnail":
@@ -279,20 +359,22 @@ function R(s, t, e) {
         return 1;
     }
   })(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;
+  return s.map((i) => {
+    const o = Math.min(i.width || 0, i.height || 0), h = Math.abs(u(i) - a), 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,
-  M as MissingCapabilityError,
-  S as NuclearAPI,
-  P as NuclearPluginAPI,
-  H as YtdlpAPI,
-  R as pickArtwork,
-  C as useSetting
+  b as FavoritesAPI,
+  w as HttpAPI,
+  p as LoggerAPI,
+  R as MissingCapabilityError,
+  E as NuclearAPI,
+  C as NuclearPluginAPI,
+  P as YtdlpAPI,
+  Q as pickArtwork,
+  k as useSetting
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuclearplayer/plugin-sdk",
-  "version": "1.0.0",
+  "version": "1.2.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"