gerdur 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.4.0 - 2026-08-31
+
+### Added
+
+- **`gerdur-core@^2.3.0`** — re-exports `getTrackPreview`, `downloadPreview`,
+  `formatName`, `toFormat`, `DEEZER_FORMATS` and the `DeezerFormat` /
+  `TrackPreview` types.
+- **`--preview`** — download the 30-second clip for each track as
+  `<name>.preview.mp3` instead of the full file. Plain licence-free MP3s: no
+  `--quality`, no decryption, no tagging. Works with every source and headless.
+- **`Session.trackPreview(track)`** and **`Session.downloadPreview(track)`**.
+
 ## 2.3.0 - 2026-08-31
 
 ### Added

package/README.md

@@ -142,6 +142,7 @@ All options are optional. You can suppress prompts via providing `quality` and `
 | `--bpm-min` / `--bpm-max` | *None*      |                                                        number                                                          |                                                    Search filter — tempo range (beats per minute)                                            |
 | `--dur-min` / `--dur-max` | *None*      |                                                    number (seconds)                                                    |                                                       Search filter — track duration range                                                    |
 | `--search-limit`      |     *None*      |                                                   number (default 50)                                                  |                                                       How many search results to fetch                                                        |
+| `--preview`           |     *None*      |                                                        *Nothing*                                                        |                            Download the 30-second preview clips (`.preview.mp3`) instead of full tracks — no `--quality` needed                |
 
 ## Search
 
@@ -198,6 +199,18 @@ only on **track** search:
 | `dur_min:` / `dur_max:` | `dur_min:200` (seconds) |
 | `bpm_min:` / `bpm_max:` | `bpm_min:120` |
 
+## Previews
+
+`--preview` writes the 30-second clip for each track as `<name>.preview.mp3`
+instead of downloading the full file. The clips are plain, licence-free MP3s —
+no `--quality`, no decryption, no tagging. Works with every source (URL, search,
+`isrc:` / `upc:`) and in `--headless` mode.
+
+```bash
+gerdur --preview -u https://deezer.com/album/302127          # 14 clips
+gerdur -d --preview --artist "Justice" --search-limit 10     # audition a search
+```
+
 ## Programmatic API
 
 When installed as a dependency, `gerdur` exposes a side-effect-free API
@@ -246,7 +259,7 @@ Session methods:
   `artistTopTracks`, `relatedArtists`, `artistAlbums`, `artistRadio`,
   `trackByISRC`, `albumByUPC`
 - **user / download** — `getUser`, `getTrackBuffer`, `downloadTrack`,
-  `downloadTracks`, `downloadUrl`
+  `downloadTracks`, `downloadUrl`, `trackPreview`, `downloadPreview`
 
 Every download call is silent; `downloadTracks` / `downloadUrl` accept
 `concurrency` and an `onProgress` callback and return one `{path, written} | null`
@@ -302,7 +315,8 @@ or `createSession`):
   `getEditorialCharts`, `getArtistTopTracks`, `getRelatedArtists`,
   `getArtistAlbums`, `getArtistPlaylists`, `getArtistRadioTracks`,
   `getTrackByISRC`, `getAlbumByUPC`
-- **Download** — `getTrackDownloadUrl`, `resolveDownloadUrls`, `GeoBlocked`
+- **Download** — `getTrackDownloadUrl`, `resolveDownloadUrls`, `getTrackPreview`,
+  `downloadPreview`, `formatName`, `toFormat`, `DEEZER_FORMATS`, `GeoBlocked`
 
 ### Auth & config helpers
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gerdur",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "description": "The crucial streaming module for dabox systems.",
     "author": "Christian",
     "license": "SEE LICENSE IN LICENSE",
@@ -48,7 +48,7 @@
         "adm-zip": "^0.5.16",
         "chalk": "^4.1.2",
         "commander": "^9.5.0",
-        "gerdur-core": "^2.2.0",
+        "gerdur-core": "^2.3.0",
         "dot-prop": "^6.0.1",
         "got": "^11.8.6",
         "gradient-string": "^2.0.2",

package/dist/src/gerdur.js

@@ -57,7 +57,8 @@ const cmd = new commander_1.Command()
     .option('--bpm-max <n>', 'Search filter: maximum BPM')
     .option('--dur-min <seconds>', 'Search filter: minimum duration')
     .option('--dur-max <seconds>', 'Search filter: maximum duration')
-    .option('--search-limit <n>', 'Max search results to fetch', '50');
+    .option('--search-limit <n>', 'Max search results to fetch', '50')
+    .option('--preview', 'Download the 30-second preview clips instead of full tracks', false);
 if (process.pkg) {
     cmd.option('-U, --update', 'Update this program to latest version');
 }
@@ -79,7 +80,7 @@ const toFiniteNumber = (value) => {
 };
 const advancedFilters = (0, search_1.advancedFiltersFromFlags)(options);
 let advancedFiltersConsumed = false;
-if (options.headless && !options.quality) {
+if (options.headless && !options.quality && !options.preview) {
     console.error(signale_1.default.error('Missing parameters --quality'));
     console.error(signale_1.default.note('Quality must be provided with headless mode'));
     process.exit(1);
@@ -152,10 +153,48 @@ const resolveAdvancedSearch = async (filters) => {
     }
     return { info: { type: 'track', id: query }, linktype: 'track', linkinfo: {}, tracks };
 };
+/**
+ * `--preview`: fetch the 30-second clip for each selected track and write it as
+ * `<saveLayout path>.preview.mp3`. Bypasses the get_url / decrypt / tag pipeline
+ * entirely — previews are plain, licence-free MP3s.
+ */
+const downloadPreviews = async (tracks, info, template, totalTracks, trackNumber, overwrite) => {
+    const saved = [];
+    await queue.addAll(tracks.map((track, index) => async () => {
+        const rel = (0, util_1.saveLayout)({
+            track,
+            album: info,
+            path: template,
+            trackNumber,
+            minimumIntegerDigits: totalTracks >= 100 ? 3 : 2,
+        }) + '.preview.mp3';
+        (0, log_update_1.default)(signale_1.default.pending(`(${index + 1}/${tracks.length}) ${track.ART_NAME} - ${track.SNG_TITLE}`));
+        if (!overwrite && (0, fs_1.existsSync)(rel)) {
+            saved.push(rel);
+            return;
+        }
+        try {
+            const clip = await (0, gerdur_core_1.downloadPreview)(track);
+            if (!clip) {
+                (0, log_update_1.default)(signale_1.default.warn(`No preview for ${track.SNG_TITLE}`));
+                return;
+            }
+            (0, fs_1.mkdirSync)((0, path_1.dirname)(rel), { recursive: true });
+            (0, fs_1.writeFileSync)(rel, clip);
+            saved.push(rel);
+            (0, log_update_1.default)(signale_1.default.success(`${track.ART_NAME} - ${track.SNG_TITLE} (preview)`));
+        }
+        catch (err) {
+            (0, log_update_1.default)(signale_1.default.error(`${track.SNG_TITLE}: ${err.message}`));
+        }
+    }));
+    log_update_1.default.done();
+    return saved;
+};
 const startDownload = async (saveLayout, url, skipPrompt) => {
     try {
         url = url ?? '';
-        if (!options.quality) {
+        if (!options.quality && !options.preview) {
             const { musicQuality } = await (0, prompts_1.default)([
                 {
                     type: 'select',
@@ -327,56 +366,63 @@ const startDownload = async (saveLayout, url, skipPrompt) => {
             const resolveFullPath = options.resolveFullPath ?? conf.get('playlist.resolveFullPath');
             const savedFiles = [];
             let m3u8 = [];
-            // One batched get_url for the whole selection instead of a request per track.
-            // Deezer returns the best licensed format, so pass an ordered preference list.
-            const QUALITY_PREF = {
-                '1': [1],
-                '128': [1],
-                '3': [3, 1],
-                '320': [3, 1],
-                '9': [9, 3, 1],
-                flac: [9, 3, 1],
-            };
-            const prefetchedUrls = new Map();
-            if (data.tracks.length > 1 && !process.env.SIMULATE) {
-                try {
-                    const base = QUALITY_PREF[String(options.quality).toLowerCase()] ?? [3, 1];
-                    const pref = fallbackQuality ? base : [base[0]];
-                    const resolved = await (0, gerdur_core_1.resolveDownloadUrls)(data.tracks, pref);
-                    resolved.forEach((r, i) => {
-                        if (r) {
-                            prefetchedUrls.set(data.tracks[i].SNG_ID, r);
-                        }
-                    });
-                }
-                catch {
-                    // batch resolve failed wholesale — every track falls back to per-track resolution
-                }
+            const layoutTemplate = options.output ? options.output : saveLayout[data.linktype];
+            if (options.preview) {
+                const clips = await downloadPreviews(data.tracks, data.linkinfo, layoutTemplate, data.tracks.length, trackNumber, overwrite);
+                savedFiles.push(...clips);
             }
-            await queue.addAll(data.tracks.map((track, index) => {
-                return async () => {
-                    const savedPath = await (0, download_track_1.default)({
-                        track,
-                        quality: options.quality,
-                        info: data.linkinfo,
-                        coverSizes,
-                        path: options.output ? options.output : saveLayout[data.linktype],
-                        totalTracks: data ? data.tracks.length : 10,
-                        trackNumber,
-                        fallbackTrack,
-                        fallbackQuality,
-                        overwrite,
-                        message: `(${index}/${data.tracks.length})`,
-                        lrc,
-                        prefetched: prefetchedUrls.get(track.SNG_ID) ?? null,
-                    });
-                    // Add to saved list
-                    if (savedPath) {
-                        m3u8.push((0, path_1.resolve)(process.env.SIMULATE ? savedPath : (0, true_case_path_1.trueCasePathSync)(savedPath)));
-                        savedFiles.push(savedPath);
-                    }
+            else {
+                // One batched get_url for the whole selection instead of a request per track.
+                // Deezer returns the best licensed format, so pass an ordered preference list.
+                const QUALITY_PREF = {
+                    '1': [1],
+                    '128': [1],
+                    '3': [3, 1],
+                    '320': [3, 1],
+                    '9': [9, 3, 1],
+                    flac: [9, 3, 1],
                 };
-            }));
+                const prefetchedUrls = new Map();
+                if (data.tracks.length > 1 && !process.env.SIMULATE) {
+                    try {
+                        const base = QUALITY_PREF[String(options.quality).toLowerCase()] ?? [3, 1];
+                        const pref = fallbackQuality ? base : [base[0]];
+                        const resolved = await (0, gerdur_core_1.resolveDownloadUrls)(data.tracks, pref);
+                        resolved.forEach((r, i) => {
+                            if (r) {
+                                prefetchedUrls.set(data.tracks[i].SNG_ID, r);
+                            }
+                        });
+                    }
+                    catch {
+                        // batch resolve failed wholesale — every track falls back to per-track resolution
+                    }
+                }
+                await queue.addAll(data.tracks.map((track, index) => {
+                    return async () => {
+                        const savedPath = await (0, download_track_1.default)({
+                            track,
+                            quality: options.quality,
+                            info: data.linkinfo,
+                            coverSizes,
+                            path: layoutTemplate,
+                            totalTracks: data ? data.tracks.length : 10,
+                            trackNumber,
+                            fallbackTrack,
+                            fallbackQuality,
+                            overwrite,
+                            message: `(${index}/${data.tracks.length})`,
+                            lrc,
+                            prefetched: prefetchedUrls.get(track.SNG_ID) ?? null,
+                        });
+                        // Add to saved list
+                        if (savedPath) {
+                            m3u8.push((0, path_1.resolve)(process.env.SIMULATE ? savedPath : (0, true_case_path_1.trueCasePathSync)(savedPath)));
+                            savedFiles.push(savedPath);
+                        }
+                    };
+                }));
+            }
             // Display downloaded location
             if (savedFiles.length > 0) {
                 const savedIn = new Set(savedFiles.map((l) => (0, path_1.dirname)(l)));

package/dist/src/index.d.ts

@@ -59,6 +59,7 @@ export type { SessionOptions, DownloadTracksOptions, SearchType } from './lib/se
 export { getTrackBuffer, getTaggedTrack, downloadTrackToFile } from './lib/api-download';
 export type { Quality, GetTrackBufferOptions, DownloadTrackOptions, DownloadResult } from './lib/api-download';
 export { default as Config, globalConfigPath, resolveConfigFile } from './lib/config';
-export { initDeezerApi, parseInfo, searchMusic, searchPublicApi, searchTracks, searchAlbums, searchArtists, searchPlaylists, buildAdvancedQuery, suggest, getGenres, getChart, getChartTracks, getGenreArtists, getEditorialList, getEditorialReleases, getEditorialSelection, getEditorialCharts, getArtistTopTracks, getRelatedArtists, getArtistAlbums, getArtistPlaylists, getArtistRadioTracks, getTrackByISRC, getAlbumByUPC, getUser, getTrackInfo, getAlbumInfo, getAlbumTracks, getPlaylistInfo, getPlaylistTracks, getArtistInfo, getDiscography, getLyrics, getTrackDownloadUrl, resolveDownloadUrls, addTrackTags, getRichAlbum, normalizeContributors, toLrc, GeoBlocked, } from 'gerdur-core';
+export { initDeezerApi, parseInfo, searchMusic, searchPublicApi, searchTracks, searchAlbums, searchArtists, searchPlaylists, buildAdvancedQuery, suggest, getGenres, getChart, getChartTracks, getGenreArtists, getEditorialList, getEditorialReleases, getEditorialSelection, getEditorialCharts, getArtistTopTracks, getRelatedArtists, getArtistAlbums, getArtistPlaylists, getArtistRadioTracks, getTrackByISRC, getAlbumByUPC, getTrackPreview, downloadPreview, formatName, toFormat, DEEZER_FORMATS, getUser, getTrackInfo, getAlbumInfo, getAlbumTracks, getPlaylistInfo, getPlaylistTracks, getArtistInfo, getDiscography, getLyrics, getTrackDownloadUrl, resolveDownloadUrls, addTrackTags, getRichAlbum, normalizeContributors, toLrc, GeoBlocked, } from 'gerdur-core';
 export type { AddTrackTagsOptions, TaggedTrack, TrackTagModel, RichAlbum, ResolvedUrl, NormalizedContributors, } from 'gerdur-core';
 export type { advancedSearchFilters, searchOrder, searchEntity, publicApiSearchOptions, publicApiSearchResponse, searchResultTrack, searchResultAlbum, searchResultArtist, searchResultPlaylist, suggestResult, publicApiList, chartType, chartTrack, chartAlbum, chartArtist, chartPlaylist, chartPodcast, genreType, editorialType, artistAlbumResult, } from 'gerdur-core/types';
+export type { Quality as MediaFormat, DeezerFormat, TrackPreview } from 'gerdur-core';

package/dist/src/index.js

@@ -33,8 +33,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeContributors = exports.getRichAlbum = exports.addTrackTags = exports.resolveDownloadUrls = exports.getTrackDownloadUrl = exports.getLyrics = exports.getDiscography = exports.getArtistInfo = exports.getPlaylistTracks = exports.getPlaylistInfo = exports.getAlbumTracks = exports.getAlbumInfo = exports.getTrackInfo = exports.getUser = exports.getAlbumByUPC = exports.getTrackByISRC = exports.getArtistRadioTracks = exports.getArtistPlaylists = exports.getArtistAlbums = exports.getRelatedArtists = exports.getArtistTopTracks = exports.getEditorialCharts = exports.getEditorialSelection = exports.getEditorialReleases = exports.getEditorialList = exports.getGenreArtists = exports.getChartTracks = exports.getChart = exports.getGenres = exports.suggest = exports.buildAdvancedQuery = exports.searchPlaylists = exports.searchArtists = exports.searchAlbums = exports.searchTracks = exports.searchPublicApi = exports.searchMusic = exports.parseInfo = exports.initDeezerApi = exports.resolveConfigFile = exports.globalConfigPath = exports.Config = exports.downloadTrackToFile = exports.getTaggedTrack = exports.getTrackBuffer = exports.Session = exports.createSession = exports.getArl = exports.LoginError = exports.loginWithEmail = void 0;
-exports.GeoBlocked = exports.toLrc = void 0;
+exports.getLyrics = exports.getDiscography = exports.getArtistInfo = exports.getPlaylistTracks = exports.getPlaylistInfo = exports.getAlbumTracks = exports.getAlbumInfo = exports.getTrackInfo = exports.getUser = exports.DEEZER_FORMATS = exports.toFormat = exports.formatName = exports.downloadPreview = exports.getTrackPreview = exports.getAlbumByUPC = exports.getTrackByISRC = exports.getArtistRadioTracks = exports.getArtistPlaylists = exports.getArtistAlbums = exports.getRelatedArtists = exports.getArtistTopTracks = exports.getEditorialCharts = exports.getEditorialSelection = exports.getEditorialReleases = exports.getEditorialList = exports.getGenreArtists = exports.getChartTracks = exports.getChart = exports.getGenres = exports.suggest = exports.buildAdvancedQuery = exports.searchPlaylists = exports.searchArtists = exports.searchAlbums = exports.searchTracks = exports.searchPublicApi = exports.searchMusic = exports.parseInfo = exports.initDeezerApi = exports.resolveConfigFile = exports.globalConfigPath = exports.Config = exports.downloadTrackToFile = exports.getTaggedTrack = exports.getTrackBuffer = exports.Session = exports.createSession = exports.getArl = exports.LoginError = exports.loginWithEmail = void 0;
+exports.GeoBlocked = exports.toLrc = exports.normalizeContributors = exports.getRichAlbum = exports.addTrackTags = exports.resolveDownloadUrls = exports.getTrackDownloadUrl = void 0;
 // ─── Authentication ────────────────────────────────────────────────────────
 const email_login_1 = require("./lib/email-login");
 Object.defineProperty(exports, "loginWithEmail", { enumerable: true, get: function () { return email_login_1.loginWithEmail; } });
@@ -112,6 +112,11 @@ Object.defineProperty(exports, "getArtistPlaylists", { enumerable: true, get: fu
 Object.defineProperty(exports, "getArtistRadioTracks", { enumerable: true, get: function () { return gerdur_core_1.getArtistRadioTracks; } });
 Object.defineProperty(exports, "getTrackByISRC", { enumerable: true, get: function () { return gerdur_core_1.getTrackByISRC; } });
 Object.defineProperty(exports, "getAlbumByUPC", { enumerable: true, get: function () { return gerdur_core_1.getAlbumByUPC; } });
+Object.defineProperty(exports, "getTrackPreview", { enumerable: true, get: function () { return gerdur_core_1.getTrackPreview; } });
+Object.defineProperty(exports, "downloadPreview", { enumerable: true, get: function () { return gerdur_core_1.downloadPreview; } });
+Object.defineProperty(exports, "formatName", { enumerable: true, get: function () { return gerdur_core_1.formatName; } });
+Object.defineProperty(exports, "toFormat", { enumerable: true, get: function () { return gerdur_core_1.toFormat; } });
+Object.defineProperty(exports, "DEEZER_FORMATS", { enumerable: true, get: function () { return gerdur_core_1.DEEZER_FORMATS; } });
 Object.defineProperty(exports, "getUser", { enumerable: true, get: function () { return gerdur_core_1.getUser; } });
 Object.defineProperty(exports, "getTrackInfo", { enumerable: true, get: function () { return gerdur_core_1.getTrackInfo; } });
 Object.defineProperty(exports, "getAlbumInfo", { enumerable: true, get: function () { return gerdur_core_1.getAlbumInfo; } });

package/dist/src/lib/session.d.ts

@@ -3,6 +3,7 @@ import { parseInfo, searchMusic } from 'gerdur-core';
 import type { AdvancedSearchOptions } from './search';
 import type { Quality, DownloadTrackOptions, DownloadResult } from './api-download';
 import type { trackType, userType, advancedSearchFilters, publicApiSearchResponse, searchResultTrack, suggestResult, chartType, genreType, editorialType, artistAlbumResult, searchResultArtist, publicApiList, trackTypePublicApi, albumTypePublicApi } from 'gerdur-core/types';
+import type { TrackPreview } from 'gerdur-core';
 /** Search result categories accepted by {@link Session.search}. */
 export type SearchType = 'ALBUM' | 'ARTIST' | 'TRACK' | 'PLAYLIST' | 'RADIO' | 'SHOW' | 'USER' | 'LIVESTREAM' | 'CHANNEL';
 export interface SessionOptions {
@@ -85,6 +86,10 @@ export declare class Session {
     trackByISRC(isrc: string): Promise<trackTypePublicApi>;
     /** Resolve a UPC/EAN barcode to the public-API album (with its `tracks`). */
     albumByUPC(upc: string): Promise<albumTypePublicApi>;
+    /** The 30-second preview clip URL for a track (plain MP3 — no licence, no decryption). */
+    trackPreview(track: trackType | string | number): Promise<TrackPreview | null>;
+    /** Fetch a track's 30-second preview clip as a `Buffer` (plain MP3). */
+    downloadPreview(track: trackType | string | number): Promise<Buffer | null>;
     /** Return a fully tagged audio Buffer for a track (nothing written to disk). */
     getTrackBuffer(track: trackType, quality?: Quality, options?: {}): Promise<Buffer | null>;
     /** Download a single track to disk. */

package/dist/src/lib/session.js

@@ -116,6 +116,14 @@ class Session {
     albumByUPC(upc) {
         return (0, gerdur_core_1.getAlbumByUPC)(upc);
     }
+    /** The 30-second preview clip URL for a track (plain MP3 — no licence, no decryption). */
+    trackPreview(track) {
+        return (0, gerdur_core_1.getTrackPreview)(track);
+    }
+    /** Fetch a track's 30-second preview clip as a `Buffer` (plain MP3). */
+    downloadPreview(track) {
+        return (0, gerdur_core_1.downloadPreview)(track);
+    }
     /** Return a fully tagged audio Buffer for a track (nothing written to disk). */
     getTrackBuffer(track, quality = '320', options = {}) {
         return (0, api_download_1.getTrackBuffer)(track, quality, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gerdur",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "The crucial streaming module for dabox systems.",
   "author": "Christian",
   "license": "SEE LICENSE IN LICENSE",
@@ -48,7 +48,7 @@
     "adm-zip": "^0.5.16",
     "chalk": "^4.1.2",
     "commander": "^9.5.0",
-    "gerdur-core": "^2.2.0",
+    "gerdur-core": "^2.3.0",
     "dot-prop": "^6.0.1",
     "got": "^11.8.6",
     "gradient-string": "^2.0.2",