gerdur-core 2.17.0 → 2.18.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Changelog
 
+## 2.18.0 - 2026-08-31
+
+Write operations — the first part of this package that changes an account.
+
+### Added
+
+- **`src/api/favorites.ts`** — mutating library operations, in their own module
+  and wired into no download path, so they only run when called deliberately:
+  - `addFavoriteTracks(ids)` / `removeFavoriteTracks(ids)` (`song.addFavorites` /
+    `song.removeFavorites` — note the plural)
+  - `addFavoriteAlbum` / `removeFavoriteAlbum`, `addFavoriteArtist` /
+    `removeFavoriteArtist`
+  - `followPlaylist` / `unfollowPlaylist` (the gateway wants
+    `parent_playlist_id` to follow but `playlist_id` to unfollow)
+  - `addFavoriteShow`, `createPlaylist`, `addTracksToPlaylist`,
+    `removeTracksFromPlaylist`
+
+  The surface was mapped by calling each candidate with **incomplete
+  parameters** — an existing method answers `MISSING_PARAMETER_*`, an absent one
+  `GATEWAY_ERROR` — so method names and their parameter names were established
+  without creating or changing anything.
+
+### Verification status
+
+- Method existence and parameter names: **confirmed by probe**.
+- End-to-end execution: **not run.** `__tests__/favorites.ts` contains
+  snapshot → mutate → assert → revert → assert-restored round trips, gated
+  behind `GERDUR_ALLOW_WRITE_TESTS=1` so they never fire by accident.
+
+### Known gaps
+
+- **Deezer's gateway has no playlist delete.** `playlist.delete`, `.remove`,
+  `.destroy`, `.deletePlaylist` and eight other spellings all answer
+  `GATEWAY_ERROR`, so `createPlaylist` is one-way — remove what it makes from a
+  Deezer client. Everything else here has a confirmed inverse.
+- No `show.deleteFavorite` was found, so `addFavoriteShow` is one-way too.
+- **`log.listen` (scrobbling) is not implemented.** It never answered the probe,
+  so its shape is unknown, and it writes to listening history that cannot be
+  undone — not something to ship on a guess.
+
 ## 2.17.0 - 2026-08-31
 
 The account's own library, over the authenticated gateway.

package/README.md

@@ -47,6 +47,7 @@ the CLI and the file-writing layer on top.
   - [Browse and discover](#browse-and-discover)
   - [Flow, radios and a user's library](#flow-radios-and-a-users-library)
   - [Your own library](#your-own-library)
+  - [Changing the account (write operations)](#changing-the-account-write-operations)
   - [Podcasts](#podcasts)
   - [Preview clips](#preview-clips)
   - [Resolve a download URL](#resolve-a-download-url)
@@ -409,6 +410,43 @@ const urls = await resolveDownloadUrls(mix, [9, 3, 1]); // straight to download
 `userId` defaults to the logged-in account. These are account-scoped, so they
 never enter the shared cross-session cache.
 
+### Changing the account (write operations)
+
+Everything above reads. These change the logged-in account's library for real —
+they are in their own module, wired into no download path, and only run when you
+call them.
+
+| Function | Inverse |
+| :--- | :--- |
+| `addFavoriteTracks(ids)` | `removeFavoriteTracks(ids)` |
+| `addFavoriteAlbum(id)` | `removeFavoriteAlbum(id)` |
+| `addFavoriteArtist(id)` | `removeFavoriteArtist(id)` |
+| `followPlaylist(id)` | `unfollowPlaylist(id)` |
+| `addFavoriteShow(id)` | — none found |
+| `createPlaylist(title, opts?)` | **— none exists, see below** |
+| `addTracksToPlaylist(id, sngIds)` | `removeTracksFromPlaylist(id, sngIds)` |
+
+```ts
+import {addFavoriteTracks, removeFavoriteTracks} from 'gerdur-core';
+
+await addFavoriteTracks(['3135556']);     // love it
+await removeFavoriteTracks(['3135556']);  // and back
+```
+
+> **`createPlaylist` is a one-way door.** Deezer's gateway exposes no delete —
+> a dozen spellings of `playlist.delete` all answer `GATEWAY_ERROR` — so a
+> playlist made here has to be removed from a Deezer client. It is also the one
+> function in this module that has not been exercised against a live account,
+> for exactly that reason.
+>
+> Method names and parameters were established by probing with incomplete
+> arguments (an existing method answers `MISSING_PARAMETER_*`), so the surface is
+> real; the round trips live in `__tests__/favorites.ts` behind
+> `GERDUR_ALLOW_WRITE_TESTS=1`.
+
+Scrobbling (`log.listen`) is deliberately absent: it never answered the probe and
+it writes history that cannot be undone.
+
 ### Podcasts
 
 ```ts
@@ -818,7 +856,11 @@ import type {
 `getUserChartTracks` · `getRadios` · `getRadioTracks` · `getRadioGenres` ·
 `getMyPlaylists` · `getMyFavoriteTracks` · `getMyFavoriteTrackIds` ·
 `getMyFavoriteAlbums` · `getMyFavoriteArtists` · `getMyFavoritePlaylists` ·
-`getMyFavoriteRadios` · `getMyFavoriteShows` · `getTrackMix`
+`getMyFavoriteRadios` · `getMyFavoriteShows` · `getTrackMix` ·
+`addFavoriteTracks` · `removeFavoriteTracks` · `addFavoriteAlbum` ·
+`removeFavoriteAlbum` · `addFavoriteArtist` · `removeFavoriteArtist` ·
+`followPlaylist` · `unfollowPlaylist` · `addFavoriteShow` · `createPlaylist` ·
+`addTracksToPlaylist` · `removeTracksFromPlaylist`
 </details>
 
 <details>

package/dist/api/favorites.d.ts

@@ -0,0 +1,59 @@
+/** What the gateway returns for a mutation — usually `true`, or the new id. */
+export type WriteResult = boolean | string | number | Record<string, any>;
+/**
+ * Love one or more tracks (`song.addFavorites`). Reversible with
+ * {@link removeFavoriteTracks}.
+ *
+ * @param sngIds `SNG_ID`s
+ */
+export declare const addFavoriteTracks: (sngIds: (string | number)[]) => Promise<WriteResult>;
+/** Un-love one or more tracks (`song.removeFavorites`). */
+export declare const removeFavoriteTracks: (sngIds: (string | number)[]) => Promise<WriteResult>;
+/** Add an album to favourites (`album.addFavorite`). */
+export declare const addFavoriteAlbum: (albId: string | number) => Promise<WriteResult>;
+/** Remove an album from favourites (`album.deleteFavorite`). */
+export declare const removeFavoriteAlbum: (albId: string | number) => Promise<WriteResult>;
+/** Follow an artist (`artist.addFavorite`). */
+export declare const addFavoriteArtist: (artId: string | number) => Promise<WriteResult>;
+/** Unfollow an artist (`artist.deleteFavorite`). */
+export declare const removeFavoriteArtist: (artId: string | number) => Promise<WriteResult>;
+/**
+ * Follow someone else's playlist (`playlist.addFavorite`). Note the gateway
+ * wants `parent_playlist_id` here but plain `playlist_id` to unfollow.
+ */
+export declare const followPlaylist: (playlistId: string | number) => Promise<WriteResult>;
+/** Unfollow a playlist (`playlist.deleteFavorite`). */
+export declare const unfollowPlaylist: (playlistId: string | number) => Promise<WriteResult>;
+/**
+ * Follow a podcast show (`show.addFavorite`).
+ *
+ * No `show.deleteFavorite` answered the probe, so treat this as one-way until
+ * the inverse is found.
+ */
+export declare const addFavoriteShow: (showId: string | number) => Promise<WriteResult>;
+/**
+ * Create a playlist (`playlist.create`). Resolves to the new `PLAYLIST_ID`.
+ *
+ * **One-way.** The gateway has no delete counterpart (see the module note), so
+ * anything created here has to be removed from a Deezer client. For the same
+ * reason this is the one function on this page that has not been exercised
+ * against a live account.
+ *
+ * @param title       playlist title
+ * @param options     `description`, `status` (0 public / 1 private / 2 collaborative),
+ *                    and `songs` to seed it with `SNG_ID`s
+ */
+export declare const createPlaylist: (title: string, options?: {
+    description?: string;
+    status?: 0 | 1 | 2;
+    songs?: (string | number)[];
+}) => Promise<WriteResult>;
+/**
+ * Append tracks to a playlist (`playlist.addSongs`). Reversible with
+ * {@link removeTracksFromPlaylist}.
+ *
+ * The gateway takes `songs` as `[[sngId, offset], …]`; this wraps that for you.
+ */
+export declare const addTracksToPlaylist: (playlistId: string | number, sngIds: (string | number)[]) => Promise<WriteResult>;
+/** Remove tracks from a playlist (`playlist.deleteSongs`). */
+export declare const removeTracksFromPlaylist: (playlistId: string | number, sngIds: (string | number)[]) => Promise<WriteResult>;

package/dist/api/favorites.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeTracksFromPlaylist = exports.addTracksToPlaylist = exports.createPlaylist = exports.addFavoriteShow = exports.unfollowPlaylist = exports.followPlaylist = exports.removeFavoriteArtist = exports.addFavoriteArtist = exports.removeFavoriteAlbum = exports.addFavoriteAlbum = exports.removeFavoriteTracks = exports.addFavoriteTracks = void 0;
+/**
+ * **Mutating** operations on the logged-in account's library.
+ *
+ * Everything else in this package reads. These change the account, so they are
+ * kept in their own module and none of them are wired into any download path —
+ * you have to call them deliberately.
+ *
+ * The method names here were established by probing the gateway with incomplete
+ * parameters, which makes an existing method answer `MISSING_PARAMETER_*` while
+ * an absent one answers `GATEWAY_ERROR` — so the surface was mapped without
+ * creating or changing anything.
+ *
+ * **Deezer's gateway exposes no way to delete a playlist.** `playlist.delete`,
+ * `.remove`, `.destroy` and nine other spellings all answer `GATEWAY_ERROR`.
+ * {@link createPlaylist} is therefore a one-way door: whatever it makes, you
+ * remove from a Deezer client, not from here. Everything else on this page has a
+ * confirmed inverse and is safe to undo.
+ */
+const request_1 = require("./request");
+// ─── Loved tracks ────────────────────────────────────────────────────────────
+/**
+ * Love one or more tracks (`song.addFavorites`). Reversible with
+ * {@link removeFavoriteTracks}.
+ *
+ * @param sngIds `SNG_ID`s
+ */
+const addFavoriteTracks = (sngIds) => (0, request_1.request)({ ids: sngIds.map(String) }, 'song.addFavorites');
+exports.addFavoriteTracks = addFavoriteTracks;
+/** Un-love one or more tracks (`song.removeFavorites`). */
+const removeFavoriteTracks = (sngIds) => (0, request_1.request)({ ids: sngIds.map(String) }, 'song.removeFavorites');
+exports.removeFavoriteTracks = removeFavoriteTracks;
+// ─── Albums / artists ────────────────────────────────────────────────────────
+/** Add an album to favourites (`album.addFavorite`). */
+const addFavoriteAlbum = (albId) => (0, request_1.request)({ alb_id: String(albId) }, 'album.addFavorite');
+exports.addFavoriteAlbum = addFavoriteAlbum;
+/** Remove an album from favourites (`album.deleteFavorite`). */
+const removeFavoriteAlbum = (albId) => (0, request_1.request)({ alb_id: String(albId) }, 'album.deleteFavorite');
+exports.removeFavoriteAlbum = removeFavoriteAlbum;
+/** Follow an artist (`artist.addFavorite`). */
+const addFavoriteArtist = (artId) => (0, request_1.request)({ art_id: String(artId) }, 'artist.addFavorite');
+exports.addFavoriteArtist = addFavoriteArtist;
+/** Unfollow an artist (`artist.deleteFavorite`). */
+const removeFavoriteArtist = (artId) => (0, request_1.request)({ art_id: String(artId) }, 'artist.deleteFavorite');
+exports.removeFavoriteArtist = removeFavoriteArtist;
+// ─── Playlists & shows ───────────────────────────────────────────────────────
+/**
+ * Follow someone else's playlist (`playlist.addFavorite`). Note the gateway
+ * wants `parent_playlist_id` here but plain `playlist_id` to unfollow.
+ */
+const followPlaylist = (playlistId) => (0, request_1.request)({ parent_playlist_id: String(playlistId) }, 'playlist.addFavorite');
+exports.followPlaylist = followPlaylist;
+/** Unfollow a playlist (`playlist.deleteFavorite`). */
+const unfollowPlaylist = (playlistId) => (0, request_1.request)({ playlist_id: String(playlistId) }, 'playlist.deleteFavorite');
+exports.unfollowPlaylist = unfollowPlaylist;
+/**
+ * Follow a podcast show (`show.addFavorite`).
+ *
+ * No `show.deleteFavorite` answered the probe, so treat this as one-way until
+ * the inverse is found.
+ */
+const addFavoriteShow = (showId) => (0, request_1.request)({ show_id: String(showId) }, 'show.addFavorite');
+exports.addFavoriteShow = addFavoriteShow;
+// ─── Playlist contents ───────────────────────────────────────────────────────
+/**
+ * Create a playlist (`playlist.create`). Resolves to the new `PLAYLIST_ID`.
+ *
+ * **One-way.** The gateway has no delete counterpart (see the module note), so
+ * anything created here has to be removed from a Deezer client. For the same
+ * reason this is the one function on this page that has not been exercised
+ * against a live account.
+ *
+ * @param title       playlist title
+ * @param options     `description`, `status` (0 public / 1 private / 2 collaborative),
+ *                    and `songs` to seed it with `SNG_ID`s
+ */
+const createPlaylist = (title, options = {}) => {
+    var _a, _b, _c;
+    return (0, request_1.request)({
+        title,
+        description: (_a = options.description) !== null && _a !== void 0 ? _a : '',
+        status: (_b = options.status) !== null && _b !== void 0 ? _b : 1,
+        songs: ((_c = options.songs) !== null && _c !== void 0 ? _c : []).map((id) => [String(id), 0]),
+    }, 'playlist.create');
+};
+exports.createPlaylist = createPlaylist;
+/**
+ * Append tracks to a playlist (`playlist.addSongs`). Reversible with
+ * {@link removeTracksFromPlaylist}.
+ *
+ * The gateway takes `songs` as `[[sngId, offset], …]`; this wraps that for you.
+ */
+const addTracksToPlaylist = (playlistId, sngIds) => (0, request_1.request)({ playlist_id: String(playlistId), songs: sngIds.map((id) => [String(id), 0]) }, 'playlist.addSongs');
+exports.addTracksToPlaylist = addTracksToPlaylist;
+/** Remove tracks from a playlist (`playlist.deleteSongs`). */
+const removeTracksFromPlaylist = (playlistId, sngIds) => (0, request_1.request)({ playlist_id: String(playlistId), songs: sngIds.map((id) => [String(id), 0]) }, 'playlist.deleteSongs');
+exports.removeTracksFromPlaylist = removeTracksFromPlaylist;

package/dist/api/index.d.ts

@@ -6,3 +6,4 @@ export * from './preview';
 export * from './user';
 export * from './podcast';
 export * from './library';
+export * from './favorites';

package/dist/api/index.js

@@ -22,3 +22,4 @@ __exportStar(require("./preview"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./podcast"), exports);
 __exportStar(require("./library"), exports);
+__exportStar(require("./favorites"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gerdur-core",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "description": "Deezer API client, cross-service URL resolution, Blowfish track decryption and MP3/FLAC metadata tagging — the engine behind the gerdur CLI.",
   "keywords": [
     "deezer",