@saavn-labs/sdk 0.1.0

package/dist/saavn/operations/search-results/schema.ops.d.ts

@@ -0,0 +1,366 @@
+import { z } from 'zod';
+export declare const SaavnSearchResultsSchema: {
+    readonly all: {
+        readonly params: z.ZodObject<{
+            query: z.ZodString;
+        }, z.core.$strict>;
+        readonly response: z.ZodObject<{
+            albums: z.ZodObject<{
+                position: z.ZodNumber;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"album">;
+                    image: z.ZodString;
+                    perma_url: z.ZodString;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                    more_info: z.ZodObject<{
+                        music: z.ZodNullable<z.ZodString>;
+                        ctr: z.ZodNumber;
+                        year: z.ZodString;
+                        language: z.ZodString;
+                        song_pids: z.ZodString;
+                    }, z.core.$loose>;
+                }, z.core.$loose>>;
+            }, z.core.$loose>;
+            artists: z.ZodObject<{
+                position: z.ZodNumber;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    image: z.ZodString;
+                    type: z.ZodLiteral<"artist">;
+                    isRadioPresent: z.ZodBoolean;
+                    ctr: z.ZodNumber;
+                    description: z.ZodString;
+                    position: z.ZodNumber;
+                }, z.core.$loose>>;
+            }, z.core.$loose>;
+            playlists: z.ZodObject<{
+                position: z.ZodNumber;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"playlist">;
+                    image: z.ZodString;
+                    perma_url: z.ZodString;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                    more_info: z.ZodObject<{
+                        firstname: z.ZodString;
+                        lastname: z.ZodOptional<z.ZodString>;
+                        artist_name: z.ZodNullable<z.ZodArray<z.ZodString>>;
+                        entity_type: z.ZodString;
+                        is_dolby_content: z.ZodNullable<z.ZodBoolean>;
+                        language: z.ZodString;
+                    }, z.core.$loose>;
+                }, z.core.$loose>>;
+            }, z.core.$loose>;
+            shows: z.ZodObject<{
+                position: z.ZodNumber;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"show">;
+                    image: z.ZodString;
+                    perma_url: z.ZodString;
+                    more_info: z.ZodObject<{
+                        season_number: z.ZodNumber;
+                    }, z.core.$loose>;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                }, z.core.$loose>>;
+            }, z.core.$loose>;
+            songs: z.ZodObject<{
+                position: z.ZodNumber;
+                data: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"song">;
+                    perma_url: z.ZodString;
+                    image: z.ZodString;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                    more_info: z.ZodObject<{
+                        album: z.ZodString;
+                        album_id: z.ZodString;
+                        ctr: z.ZodNumber;
+                        score: z.ZodString;
+                        vcode: z.ZodString;
+                        vlink: z.ZodString;
+                        primary_artists: z.ZodString;
+                        singers: z.ZodString;
+                        language: z.ZodString;
+                    }, z.core.$loose>;
+                }, z.core.$loose>>;
+            }, z.core.$loose>;
+            episodes: z.ZodObject<{
+                position: z.ZodNumber;
+                data: z.ZodArray<z.ZodAny>;
+            }, z.core.$loose>;
+            topquery: z.ZodObject<{
+                position: z.ZodNumber;
+                data: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"album">;
+                    image: z.ZodString;
+                    perma_url: z.ZodString;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                    more_info: z.ZodObject<{
+                        music: z.ZodNullable<z.ZodString>;
+                        ctr: z.ZodNumber;
+                        year: z.ZodString;
+                        language: z.ZodString;
+                        song_pids: z.ZodString;
+                    }, z.core.$loose>;
+                }, z.core.$loose>, z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    image: z.ZodString;
+                    type: z.ZodLiteral<"artist">;
+                    isRadioPresent: z.ZodBoolean;
+                    ctr: z.ZodNumber;
+                    description: z.ZodString;
+                    position: z.ZodNumber;
+                }, z.core.$loose>, z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"playlist">;
+                    image: z.ZodString;
+                    perma_url: z.ZodString;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                    more_info: z.ZodObject<{
+                        firstname: z.ZodString;
+                        lastname: z.ZodOptional<z.ZodString>;
+                        artist_name: z.ZodNullable<z.ZodArray<z.ZodString>>;
+                        entity_type: z.ZodString;
+                        is_dolby_content: z.ZodNullable<z.ZodBoolean>;
+                        language: z.ZodString;
+                    }, z.core.$loose>;
+                }, z.core.$loose>, z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"song">;
+                    perma_url: z.ZodString;
+                    image: z.ZodString;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                    more_info: z.ZodObject<{
+                        album: z.ZodString;
+                        album_id: z.ZodString;
+                        ctr: z.ZodNumber;
+                        score: z.ZodString;
+                        vcode: z.ZodString;
+                        vlink: z.ZodString;
+                        primary_artists: z.ZodString;
+                        singers: z.ZodString;
+                        language: z.ZodString;
+                    }, z.core.$loose>;
+                }, z.core.$loose>, z.ZodObject<{
+                    id: z.ZodString;
+                    title: z.ZodString;
+                    subtitle: z.ZodString;
+                    type: z.ZodLiteral<"show">;
+                    image: z.ZodString;
+                    perma_url: z.ZodString;
+                    more_info: z.ZodObject<{
+                        season_number: z.ZodNumber;
+                    }, z.core.$loose>;
+                    explicit_content: z.ZodString;
+                    description: z.ZodString;
+                }, z.core.$loose>], "type">>;
+            }, z.core.$loose>;
+        }, z.core.$loose>;
+    };
+    readonly albums: {
+        readonly params: z.ZodObject<{
+            q: z.ZodString;
+            p: z.ZodOptional<z.ZodString>;
+            n: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        readonly response: z.ZodObject<{
+            total: z.ZodNumber;
+            start: z.ZodNumber;
+            results: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                title: z.ZodString;
+                subtitle: z.ZodString;
+                type: z.ZodLiteral<"album">;
+                image: z.ZodString;
+                perma_url: z.ZodString;
+                explicit_content: z.ZodString;
+                header_desc: z.ZodString;
+                language: z.ZodString;
+                year: z.ZodString;
+                play_count: z.ZodString;
+                more_info: z.ZodObject<{
+                    query: z.ZodString;
+                    text: z.ZodString;
+                    music: z.ZodNullable<z.ZodString>;
+                    song_count: z.ZodString;
+                    artistMap: z.ZodObject<{
+                        primary_artists: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            name: z.ZodString;
+                            role: z.ZodString;
+                            image: z.ZodString;
+                            type: z.ZodLiteral<"artist">;
+                            perma_url: z.ZodString;
+                        }, z.core.$loose>>;
+                        featured_artists: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            name: z.ZodString;
+                            role: z.ZodString;
+                            image: z.ZodString;
+                            type: z.ZodLiteral<"artist">;
+                            perma_url: z.ZodString;
+                        }, z.core.$loose>>;
+                        artists: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            name: z.ZodString;
+                            role: z.ZodString;
+                            image: z.ZodString;
+                            type: z.ZodLiteral<"artist">;
+                            perma_url: z.ZodString;
+                        }, z.core.$loose>>;
+                    }, z.core.$loose>;
+                }, z.core.$loose>;
+            }, z.core.$loose>>;
+        }, z.core.$loose>;
+    };
+    readonly artists: {
+        readonly params: z.ZodObject<{
+            q: z.ZodString;
+            p: z.ZodOptional<z.ZodString>;
+            n: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        readonly response: z.ZodObject<{
+            total: z.ZodNumber;
+            start: z.ZodNumber;
+            results: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                role: z.ZodString;
+                image: z.ZodString;
+                type: z.ZodLiteral<"artist">;
+                perma_url: z.ZodString;
+                ctr: z.ZodNumber;
+                entity: z.ZodNumber;
+                isRadioPresent: z.ZodBoolean;
+                is_followed: z.ZodBoolean;
+            }, z.core.$loose>>;
+        }, z.core.$loose>;
+    };
+    readonly playlists: {
+        readonly params: z.ZodObject<{
+            q: z.ZodString;
+            p: z.ZodOptional<z.ZodString>;
+            n: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        readonly response: z.ZodObject<{
+            total: z.ZodNumber;
+            start: z.ZodNumber;
+            results: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                title: z.ZodString;
+                subtitle: z.ZodString;
+                type: z.ZodLiteral<"playlist">;
+                image: z.ZodString;
+                perma_url: z.ZodString;
+                explicit_content: z.ZodString;
+                more_info: z.ZodObject<{
+                    firstname: z.ZodString;
+                    lastname: z.ZodOptional<z.ZodString>;
+                    artist_name: z.ZodNullable<z.ZodArray<z.ZodString>>;
+                    entity_type: z.ZodString;
+                    is_dolby_content: z.ZodNullable<z.ZodBoolean>;
+                    language: z.ZodString;
+                    uid: z.ZodString;
+                    song_count: z.ZodString;
+                }, z.core.$loose>;
+            }, z.core.$loose>>;
+        }, z.core.$loose>;
+    };
+    readonly songs: {
+        readonly params: z.ZodObject<{
+            q: z.ZodString;
+            p: z.ZodOptional<z.ZodString>;
+            n: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        readonly response: z.ZodObject<{
+            total: z.ZodNumber;
+            start: z.ZodNumber;
+            results: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                title: z.ZodString;
+                subtitle: z.ZodString;
+                type: z.ZodLiteral<"song">;
+                perma_url: z.ZodString;
+                image: z.ZodString;
+                explicit_content: z.ZodString;
+                header_desc: z.ZodString;
+                language: z.ZodString;
+                year: z.ZodString;
+                play_count: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+                more_info: z.ZodObject<{
+                    music: z.ZodString;
+                    album_id: z.ZodString;
+                    album: z.ZodString;
+                    label: z.ZodString;
+                    label_id: z.ZodNullable<z.ZodString>;
+                    origin: z.ZodString;
+                    is_dolby_content: z.ZodBoolean;
+                    encrypted_media_url: z.ZodString;
+                    encrypted_drm_media_url: z.ZodString;
+                    album_url: z.ZodString;
+                    duration: z.ZodString;
+                    has_lyrics: z.ZodString;
+                    lyrics_snippet: z.ZodString;
+                    lyrics_id: z.ZodOptional<z.ZodString>;
+                    copyright_text: z.ZodString;
+                    release_date: z.ZodNullable<z.ZodString>;
+                    label_url: z.ZodOptional<z.ZodString>;
+                    vcode: z.ZodOptional<z.ZodString>;
+                    vlink: z.ZodOptional<z.ZodString>;
+                    artistMap: z.ZodLazy<z.ZodObject<{
+                        primary_artists: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            name: z.ZodString;
+                            role: z.ZodString;
+                            image: z.ZodString;
+                            type: z.ZodLiteral<"artist">;
+                            perma_url: z.ZodString;
+                        }, z.core.$loose>>;
+                        featured_artists: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            name: z.ZodString;
+                            role: z.ZodString;
+                            image: z.ZodString;
+                            type: z.ZodLiteral<"artist">;
+                            perma_url: z.ZodString;
+                        }, z.core.$loose>>;
+                        artists: z.ZodArray<z.ZodObject<{
+                            id: z.ZodString;
+                            name: z.ZodString;
+                            role: z.ZodString;
+                            image: z.ZodString;
+                            type: z.ZodLiteral<"artist">;
+                            perma_url: z.ZodString;
+                        }, z.core.$loose>>;
+                    }, z.core.$loose>>;
+                }, z.core.$loose>;
+            }, z.core.$loose>>;
+        }, z.core.$loose>;
+    };
+};

package/dist/saavn/operations/search-results/schema.ops.js

@@ -0,0 +1,101 @@
+import { z } from 'zod';
+import { NonEmptyString, PositiveString } from '../../primitives/string';
+import { SaavnArtistBase } from '../../entities/base';
+import { SaavnAlbumEdgeCase, SaavnPlaylistEdgeCase, SaavnSongEntity, SaavnSearchAlbumEntity, SaavnArtistSearchEntity, SaavnPlaylistSearchEntity, SaavnSongSearchEntity, SaavnShowEntity, } from '../../entities';
+const PageString = z.string().regex(/^\d+$/);
+export const SaavnSearchResultsSchema = {
+    all: {
+        params: z.strictObject({
+            query: NonEmptyString,
+        }),
+        response: z.looseObject({
+            albums: z.looseObject({
+                position: z.number(),
+                data: z.array(SaavnSearchAlbumEntity),
+            }),
+            artists: z.looseObject({
+                position: z.number(),
+                data: z.array(SaavnArtistSearchEntity),
+            }),
+            playlists: z.looseObject({
+                position: z.number(),
+                data: z.array(SaavnPlaylistSearchEntity),
+            }),
+            shows: z.looseObject({
+                position: z.number(),
+                data: z.array(SaavnShowEntity),
+            }),
+            songs: z.looseObject({
+                position: z.number(),
+                data: z.array(SaavnSongSearchEntity),
+            }),
+            episodes: z.looseObject({
+                position: z.number(),
+                data: z.array(z.any()),
+            }),
+            topquery: z.looseObject({
+                position: z.number(),
+                data: z.array(z.discriminatedUnion('type', [
+                    SaavnSearchAlbumEntity,
+                    SaavnArtistSearchEntity,
+                    SaavnPlaylistSearchEntity,
+                    SaavnSongSearchEntity,
+                    SaavnShowEntity,
+                ])),
+            }),
+        }),
+    },
+    albums: {
+        params: z.strictObject({
+            q: NonEmptyString,
+            p: PageString.optional(),
+            n: PositiveString.optional(),
+        }),
+        response: z.looseObject({
+            total: z.number(),
+            start: z.number(),
+            results: z.array(SaavnAlbumEdgeCase),
+        }),
+    },
+    artists: {
+        params: z.strictObject({
+            q: NonEmptyString,
+            p: PageString.optional(),
+            n: PositiveString.optional(),
+        }),
+        response: z.looseObject({
+            total: z.number(),
+            start: z.number(),
+            results: z.array(SaavnArtistBase.extend({
+                ctr: z.number(),
+                entity: z.number(),
+                isRadioPresent: z.boolean(),
+                is_followed: z.boolean(),
+            })),
+        }),
+    },
+    playlists: {
+        params: z.strictObject({
+            q: NonEmptyString,
+            p: PageString.optional(),
+            n: PositiveString.optional(),
+        }),
+        response: z.looseObject({
+            total: z.number(),
+            start: z.number(),
+            results: z.array(SaavnPlaylistEdgeCase),
+        }),
+    },
+    songs: {
+        params: z.strictObject({
+            q: NonEmptyString,
+            p: PageString.optional(),
+            n: PositiveString.optional(),
+        }),
+        response: z.looseObject({
+            total: z.number(),
+            start: z.number(),
+            results: z.array(SaavnSongEntity),
+        }),
+    },
+};