@saavn-labs/sdk 0.1.0

package/dist/core/modules/album.module.js

@@ -0,0 +1,74 @@
+import { SaavnGetDetails, SaavnGetReco, SaavnGetTrending, SaavnSearchResults, SaavnWebAPI, } from '../../saavn/operations';
+import { runOperation } from '../../saavn/run-operation';
+import { extractPermalinkToken } from '../../helpers/utils';
+import { SDKError } from '../../helpers/errors';
+/**
+ * Fetch an album by Saavn ID.
+ *
+ * @param params - Parameters object
+ * @param params.albumId - Saavn album ID
+ * @returns Normalized album object
+ */
+function getById({ albumId }) {
+    return runOperation(SaavnGetDetails.album, { albumid: albumId });
+}
+/**
+ * Fetch an album by permalink.
+ *
+ * @param params - Parameters object
+ * @param params.permalink - Album permalink string
+ * @returns Normalized album object
+ */
+function getByPermalink({ permalink }) {
+    const { token, type } = extractPermalinkToken(permalink) ?? {};
+    if (!token || type !== 'album') {
+        throw new SDKError('INVALID_PARAMS', 'Invalid permalink provided');
+    }
+    return runOperation(SaavnWebAPI.album, { token, type: 'album' });
+}
+/**
+ * Fetch album recommendations by Saavn ID.
+ *
+ * @param params - Parameters object
+ * @param params.albumId - Saavn album ID
+ * @returns List of recommended albums
+ */
+function getRecommendations({ albumId }) {
+    return runOperation(SaavnGetReco.albums, { albumid: albumId });
+}
+/**
+ * Get trending albums by language.
+ *
+ * @param params - Parameters object
+ * @param params.language - Language code
+ * @returns List of trending albums
+ */
+function getTrending({ language }) {
+    return runOperation(SaavnGetTrending.albums, {
+        entity_language: language,
+        entity_type: 'album',
+    });
+}
+/**
+ * Search for albums by query.
+ *
+ * @param params - Parameters object
+ * @param params.query - Search query string
+ * @param params.limit - Number of results to return (default: 10)
+ * @param params.offset - Offset for pagination (default: 1)
+ * @returns List of matching albums
+ */
+function search({ query, limit = 20, offset = 1, }) {
+    return runOperation(SaavnSearchResults.albums, {
+        q: query,
+        p: String(offset),
+        n: String(limit),
+    });
+}
+export const AlbumModule = {
+    getById,
+    getByPermalink,
+    getRecommendations,
+    getTrending,
+    search,
+};

package/dist/core/modules/artist.module.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Fetch an artist by Saavn ID.
+ *
+ * @param params - Parameters object
+ * @param params.artistId - Saavn artist ID
+ * @returns Normalized artist object
+ */
+declare function getById({ artistId }: {
+    artistId: string;
+}): Promise<import("../models").Artist>;
+/**
+ * Fetch an artist by permalink.
+ *
+ * @param params - Parameters object
+ * @param params.permalink - Artist permalink string
+ * @returns Normalized artist object
+ */
+declare function getByPermalink({ permalink }: {
+    permalink: string;
+}): Promise<import("../models").Artist>;
+/**
+ * Search for artists by query.
+ *
+ * @param params - Parameters object
+ * @param params.query - Search query string
+ * @param params.limit - Number of results to return (default: 10)
+ * @param params.offset - Offset for pagination (default: 1)
+ * @returns List of matching artists
+ */
+declare function search({ query, limit, offset, }: {
+    query: string;
+    limit?: number;
+    offset?: number;
+}): Promise<{
+    total: number;
+    start: number;
+    results: {
+        flags: {
+            isRadioPresent: boolean;
+            isFollowed: boolean;
+        };
+        id: string;
+        type: "artist";
+        name: string;
+        subtitle?: string;
+        url: string;
+        images: import("../..").Image[];
+        stats?: {
+            followerCount?: number;
+            fanCount?: number;
+        };
+        language?: {
+            primary?: string;
+            available?: string[];
+        };
+        profile?: {
+            bio?: import("../models").BioSection[];
+            dob?: string;
+        };
+        links?: {
+            saavn?: {
+                overview?: string;
+                albums?: string;
+                songs?: string;
+                bio?: string;
+                comments?: string;
+            };
+            social?: {
+                wiki?: string;
+                facebook?: string;
+                twitter?: string;
+            };
+        };
+        songs?: {
+            top?: import("../models").Song[];
+            latest?: import("../models").Song[];
+        };
+        albums?: {
+            top?: import("../models").Album[];
+            singles?: import("../models").Album[];
+            latest?: import("../models").Album[];
+        };
+        playlists?: {
+            dedicated?: import("../models").Playlist[];
+            featured?: import("../models").Playlist[];
+        };
+        related?: {
+            similar?: import("../models").Artist[];
+        };
+    }[];
+}>;
+export declare const ArtistModule: {
+    getById: typeof getById;
+    getByPermalink: typeof getByPermalink;
+    search: typeof search;
+};
+export {};

package/dist/core/modules/artist.module.js

@@ -0,0 +1,49 @@
+import { SaavnGetDetails, SaavnSearchResults, SaavnWebAPI, } from '../../saavn/operations';
+import { runOperation } from '../../saavn/run-operation';
+import { extractPermalinkToken } from '../../helpers/utils';
+import { SDKError } from '../../helpers/errors';
+/**
+ * Fetch an artist by Saavn ID.
+ *
+ * @param params - Parameters object
+ * @param params.artistId - Saavn artist ID
+ * @returns Normalized artist object
+ */
+function getById({ artistId }) {
+    return runOperation(SaavnGetDetails.artist, { artistId });
+}
+/**
+ * Fetch an artist by permalink.
+ *
+ * @param params - Parameters object
+ * @param params.permalink - Artist permalink string
+ * @returns Normalized artist object
+ */
+function getByPermalink({ permalink }) {
+    const { token, type } = extractPermalinkToken(permalink) ?? {};
+    if (!token || type !== 'artist') {
+        throw new SDKError('INVALID_PARAMS', 'Invalid permalink provided');
+    }
+    return runOperation(SaavnWebAPI.artist, { token, type: 'artist' });
+}
+/**
+ * Search for artists by query.
+ *
+ * @param params - Parameters object
+ * @param params.query - Search query string
+ * @param params.limit - Number of results to return (default: 10)
+ * @param params.offset - Offset for pagination (default: 1)
+ * @returns List of matching artists
+ */
+function search({ query, limit = 20, offset = 1, }) {
+    return runOperation(SaavnSearchResults.artists, {
+        q: query,
+        p: String(offset),
+        n: String(limit),
+    });
+}
+export const ArtistModule = {
+    getById,
+    getByPermalink,
+    search,
+};

package/dist/core/modules/extras.module.d.ts

@@ -0,0 +1,385 @@
+export declare function stringArrayToJSONStringArray(value: readonly string[]): string;
+/**
+ * Search all entities by query.
+ *
+ * @param params - Parameters object
+ * @param params.query - Search query string
+ * @returns List of matching entities
+ */
+declare function searchAll({ query }: {
+    query: string;
+}): Promise<{
+    albums: {
+        position: number;
+        data: ({
+            id: any;
+            type: "song";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "album";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "artist";
+            name: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isRadioPresent: any;
+                isExplicit?: undefined;
+            };
+            title?: undefined;
+            subtitle?: undefined;
+            description?: undefined;
+        } | {
+            id: any;
+            type: "playlist";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "show";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags?: undefined;
+            name?: undefined;
+        } | null)[];
+    };
+    artists: {
+        position: number;
+        data: ({
+            id: any;
+            type: "song";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "album";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "artist";
+            name: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isRadioPresent: any;
+                isExplicit?: undefined;
+            };
+            title?: undefined;
+            subtitle?: undefined;
+            description?: undefined;
+        } | {
+            id: any;
+            type: "playlist";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "show";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags?: undefined;
+            name?: undefined;
+        } | null)[];
+    };
+    playlists: {
+        position: number;
+        data: ({
+            id: any;
+            type: "song";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "album";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "artist";
+            name: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isRadioPresent: any;
+                isExplicit?: undefined;
+            };
+            title?: undefined;
+            subtitle?: undefined;
+            description?: undefined;
+        } | {
+            id: any;
+            type: "playlist";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "show";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags?: undefined;
+            name?: undefined;
+        } | null)[];
+    };
+    shows: {
+        position: number;
+        data: ({
+            id: any;
+            type: "song";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "album";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "artist";
+            name: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isRadioPresent: any;
+                isExplicit?: undefined;
+            };
+            title?: undefined;
+            subtitle?: undefined;
+            description?: undefined;
+        } | {
+            id: any;
+            type: "playlist";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "show";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags?: undefined;
+            name?: undefined;
+        } | null)[];
+    };
+    songs: {
+        position: number;
+        data: ({
+            id: any;
+            type: "song";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "album";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "artist";
+            name: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isRadioPresent: any;
+                isExplicit?: undefined;
+            };
+            title?: undefined;
+            subtitle?: undefined;
+            description?: undefined;
+        } | {
+            id: any;
+            type: "playlist";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags: {
+                isExplicit: boolean;
+                isRadioPresent?: undefined;
+            };
+            name?: undefined;
+        } | {
+            id: any;
+            type: "show";
+            title: any;
+            subtitle: any;
+            description: any;
+            url: any;
+            images: import("../..").Image[];
+            flags?: undefined;
+            name?: undefined;
+        } | null)[];
+    };
+    topquery: {
+        position: any;
+        data: any;
+    };
+}>;
+/**
+ * Get trending entities.
+ *
+ * @returns List of trending entities
+ */
+declare function getTrendingAll(): Promise<(import("../models").Album | import("../models").Song | import("../models").Playlist)[]>;
+/**
+ * Create a station for an entity.
+ *
+ * @param params - Parameters object
+ * @param params.songIds - Array of song IDs
+ * @returns Station object
+ */
+declare function createEntityStation({ songIds }: {
+    songIds: string[];
+}): Promise<{
+    stationId: string;
+}>;
+/**
+ * Create a featured station by language and name.
+ *
+ * @param params - Parameters object
+ * @param params.language - Language code
+ * @param params.name - Station name
+ * @returns Station object
+ */
+declare function createFeaturedStation({ language, name, }: {
+    language: string;
+    name: string;
+}): Promise<{
+    stationId: string;
+}>;
+export declare const ExtrasModule: {
+    searchAll: typeof searchAll;
+    getTrendingAll: typeof getTrendingAll;
+    createEntityStation: typeof createEntityStation;
+    createFeaturedStation: typeof createFeaturedStation;
+};
+export {};

package/dist/core/modules/extras.module.js

@@ -0,0 +1,64 @@
+import { SDKError } from '../../helpers/errors';
+import { SaavnGetTrending, SaavnSearchResults, SaavnWebRadio, } from '../../saavn/operations';
+import { runOperation } from '../../saavn/run-operation';
+export function stringArrayToJSONStringArray(value) {
+    if (!Array.isArray(value) || value.length === 0) {
+        throw new SDKError('INVALID_PARAMS', 'Expected a non-empty array of strings');
+    }
+    if (!value.every((v) => typeof v === 'string' && v.length > 0)) {
+        throw new SDKError('INVALID_PARAMS', 'All items must be non-empty strings');
+    }
+    return JSON.stringify(value);
+}
+/**
+ * Search all entities by query.
+ *
+ * @param params - Parameters object
+ * @param params.query - Search query string
+ * @returns List of matching entities
+ */
+function searchAll({ query }) {
+    return runOperation(SaavnSearchResults.all, { query });
+}
+/**
+ * Get trending entities.
+ *
+ * @returns List of trending entities
+ */
+function getTrendingAll() {
+    return runOperation(SaavnGetTrending.all, {});
+}
+/**
+ * Create a station for an entity.
+ *
+ * @param params - Parameters object
+ * @param params.songIds - Array of song IDs
+ * @returns Station object
+ */
+function createEntityStation({ songIds }) {
+    return runOperation(SaavnWebRadio.createEntityStation, {
+        ctx: 'android',
+        entity_type: 'queue',
+        entity_id: stringArrayToJSONStringArray(songIds),
+    });
+}
+/**
+ * Create a featured station by language and name.
+ *
+ * @param params - Parameters object
+ * @param params.language - Language code
+ * @param params.name - Station name
+ * @returns Station object
+ */
+function createFeaturedStation({ language, name, }) {
+    return runOperation(SaavnWebRadio.createFeaturedStation, {
+        language,
+        name,
+    });
+}
+export const ExtrasModule = {
+    searchAll,
+    getTrendingAll,
+    createEntityStation,
+    createFeaturedStation,
+};