SDK: minor improvements & new api fields (#20)

Author: CheckSanity

README.md

@@ -1,10 +1,8 @@
 # Yandex.Music API SDK - TypeScript
 
-This is an unofficial JavaScript/TypeScript SDK for
-the [Yandex.Music](https://music.yandex.ru/).
+This is an unofficial JavaScript/TypeScript SDK for the [Yandex.Music](https://music.yandex.ru/).
 
-Current OpenAPI specification can be found
-here: [yamusicdocs.voir.dev](https://yamusicdocs.voir.dev)
+Current OpenAPI specification can be found here: [yamusicdocs.voir.dev](https://yamusicdocs.voir.dev)
 
 ## Requirements
 
@@ -57,7 +55,7 @@ console.table(status.account);
 
 ### Extensibility
 
-All of the constructors support a configuration object that lets you override the default behavior
+All the constructors support a configuration object that lets you override the default behavior
 of the SDK.
 
 ```ts

sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checksanity/yamusic-sdk",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Unofficial Yandex.Music SDK for Web API written in Typescript",
   "source": "src/index.ts",
   "main": "dist/yamusic-sdk.js",
@@ -37,26 +37,26 @@
     "url": "https://github.com/checksanity/yamusic-sdk"
   },
   "dependencies": {
-    "dotenv": "^16.4.1"
+    "dotenv": "^16.4.5"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.11",
-    "@types/node": "^20.11.13",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.4.2",
     "@types/uuid": "^9.0.8",
-    "@typescript-eslint/eslint-plugin": "^6.20.0",
-    "@typescript-eslint/parser": "^6.20.0",
-    "eslint": "^8.56.0",
+    "@typescript-eslint/eslint-plugin": "^8.2.0",
+    "@typescript-eslint/parser": "^8.2.0",
+    "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "husky": "^9.0.7",
+    "eslint-plugin-prettier": "^5.2.1",
+    "husky": "^9.1.5",
     "jest": "^29.7.0",
-    "lint-staged": "^15.2.1",
+    "lint-staged": "^15.2.9",
     "microbundle": "^0.15.1",
-    "prettier": "^3.2.4",
-    "ts-jest": "^29.1.2",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.4",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
+    "typescript": "^5.5.4",
     "uuid": "^9.0.1"
   },
   "keywords": [

sdk/src/artists/Artists.types.ts

@@ -12,11 +12,12 @@ export type Artist = {
   id: number;
   name: string;
   various?: boolean;
-  composer?: boolean;
+  available?: boolean;
   cover?: Cover;
   genres?: string[];
-  counts: ArtistCounts;
   disclaimers?: string[];
+  composer?: boolean;
+  counts?: ArtistCounts;
   dbAliases?: string[];
   likesCount?: number;
   error?: string;

sdk/src/common/Common.types.ts

@@ -1,5 +1,5 @@
 export type Cover = {
-  type?: string;
+  type?: 'from-artist-photos' | string; //
   prefix?: string;
   dir?: string; // Exist when type="pic"
   itemsUri?: string[]; // Exist when type mosaic
@@ -14,6 +14,7 @@ export type CustomWave = {
   animationUrl: string;
   position: string;
   header: string;
+  backgroundImageUrl?: string;
 };
 
 export type Pager = {

sdk/src/playlists/Playlists.api.spec.ts

@@ -8,75 +8,78 @@ import {
 
 export class PlaylistsApi extends BaseApi {
   public createPlaylist(args: {
-    login: number | string;
+    loginOrId: string | number;
     title: string;
     visibility: PlaylistVisibility;
   }) {
     const formData = new FormData();
     formData.append('title', args.title);
     formData.append('visibility', args.visibility);
 
-    return this.postRequest<Playlist>(`users/${args.login}/playlists/create`, {
-      formData: formData,
-    });
+    return this.postRequest<Playlist>(
+      `users/${args.loginOrId}/playlists/create`,
+      {
+        formData: formData,
+      },
+    );
   }
 
   public deletePlaylist(args: {
-    login: number | string;
+    loginOrId: string | number;
     kind: number | string;
   }): Promise<string> {
     return this.postRequest(
-      `users/${args.login}/playlists/${args.kind}/delete`,
+      `users/${args.loginOrId}/playlists/${args.kind}/delete`,
     );
   }
 
   public updatePlaylistName(args: {
-    login: number | string;
+    loginOrId: string | number;
     kind: number | string;
     newName: string;
   }): Promise<Playlist> {
     const formData = new FormData();
     formData.append('value', args.newName);
 
     return this.postRequest<Playlist>(
-      `users/${args.login}/playlists/${args.kind}/name`,
+      `users/${args.loginOrId}/playlists/${args.kind}/name`,
       {
         formData: formData,
       },
     );
   }
 
   public updatePlaylistVisibility(args: {
-    login: number | string;
+    loginOrId: string | number;
     kind: number | string;
     newVisibility: PlaylistVisibility;
   }): Promise<Playlist> {
     const formData = new FormData();
     formData.append('value', args.newVisibility);
 
     return this.postRequest<Playlist>(
-      `users/${args.login}/playlists/${args.kind}/visibility`,
+      `users/${args.loginOrId}/playlists/${args.kind}/visibility`,
       {
         formData: formData,
       },
     );
   }
 
   public playlist(args: {
-    login: number | string;
+    loginOrId: string | number;
     kind: number | string;
   }): Promise<PlaylistWithTracks> {
     return this.getRequest<PlaylistWithTracks>(
-      `users/${args.login}/playlists/${args.kind}`,
+      `users/${args.loginOrId}/playlists/${args.kind}`,
     );
   }
 
   public recommendations(args: {
-    login: number | string;
+    loginOrId: string | number;
     kind: number | string;
   }): Promise<PlaylistRecommendations> {
     return this.getRequest<PlaylistRecommendations>(
-      `users/${args.login}/playlists/${args.kind}/recommendations`,
+      `users/${args.loginOrId}/playlists/${args.kind}/recommendations`,
     );
   }
 }

sdk/src/playlists/Playlists.api.ts

@@ -1,4 +1,10 @@
-import { Cover, CustomWave, Region, UserInfo } from '../common/Common.types';
+import {
+  Cover,
+  CustomWave,
+  Pager,
+  Region,
+  UserInfo,
+} from '../common/Common.types';
 import { Track } from '../tracks/Track.types';
 
 export type Playlist = {
@@ -38,7 +44,10 @@ export type Playlist = {
   backgroundVideoUrl?: string;
   backgroundImageUrl?: string;
   likesCount?: number;
+  lastOwnerPlaylists?: Playlist[];
   customWave?: CustomWave;
+  hasTrailer?: boolean;
+  pager?: Pager;
   regions?: Region[];
 };
 
@@ -82,6 +91,8 @@ export type PlaylistTrack = {
    */
   originalIndex: number;
 
+  originalShuffleIndex?: number;
+
   /**
    * Is recent?
    */

sdk/src/playlists/Playlists.types.ts

@@ -6,6 +6,7 @@ export type Track = {
   id: number | string;
   realId?: number | string;
   title: string;
+  version?: string;
   contentWarning?: string;
   trackSource: TrackSource;
   major?: TrackMajor;
@@ -26,13 +27,24 @@ export type Track = {
   ogImage?: string;
   lyricsAvailable?: boolean;
   lyricsInfo?: TrackLyricsInfo;
+  derivedColors?: DerivedColors;
   type: TrackType;
   rememberPosition?: boolean;
+  backgroundVideoUri?: string;
   trackSharingFlag?: TrackSharingFlag;
+  playerId?: string;
+  specialAudioResources?: string[];
   error?: string;
   regions?: Region[];
 };
 
+export type DerivedColors = {
+  average: string;
+  waveText: string;
+  miniPlayer: string;
+  accent: string;
+};
+
 export type SimilarTracks = {
   track: Track;
   similarTracks: Track[];