OfficialDakari
/
ts-npm-ytmusic-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

✨ add back year to album detailed

This commit is contained in:
Zechariah 2022-06-28 00:24:19 +08:00
parent 5c93e58da4
commit 149fc48a00
5 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/references/interfaces/AlbumDetailed.md
View File

@ -9,6 +9,7 @@
| `playlistId` | `string` | Playlist ID for Album |
| `name` | `string` | Name |
| `artists` | [ArtistBasic](./ArtistBasic.html)`[]` | Creators of the Album |
| `year` | `number \| null` | Year of release |
| `thumbnails` | [ThumbnailFull](./ThumbnailFull.html)`[]` | Thumbnails |
## TypeScript Source Code
@ -20,6 +21,7 @@ interface AlbumDetailed {
playlistId: string
name: string
artists: ArtistBasic[]
year: number | null
thumbnails: ThumbnailFull[]
}
```

2
docs/references/interfaces/AlbumFull.md
View File

@ -9,6 +9,7 @@
| `playlistId` | `string` | Playlist ID for Album |
| `name` | `string` | Name |
| `artists` | [ArtistBasic](./ArtistBasic.html)`[]` | Creators of the Album |
| `year` | `number \| null` | Year of release |
| `thumbnails` | [ThumbnailFull](./ThumbnailFull.html)`[]` | Thumbnails |
| `description` | `string` | Description |
| `songs` | [SongDetailed](./SongDetailed.html)`[]` | Songs in the Album |
@ -22,6 +23,7 @@ interface AlbumFull {
playlistId: string
name: string
artists: ArtistBasic[]
year: number | null
thumbnails: ThumbnailFull[]
description: string
songs: SongDetailed[]

1
src/index.ts
View File

@ -65,6 +65,7 @@ export interface AlbumDetailed extends AlbumBasic {
type: "ALBUM"
playlistId: string
artists: ArtistBasic[]
year: number | null
thumbnails: ThumbnailFull[]
}

4
src/interfaces.ts
View File

@ -1,4 +1,4 @@
import { BOOLEAN, LIST, NUMBER, OBJECT, STRING } from "validate-any"
import { BOOLEAN, LIST, NULL, NUMBER, OBJECT, OR, STRING } from "validate-any"
import ObjectValidator from "validate-any/dist/validators/ObjectValidator"
import {
@ -54,6 +54,7 @@ export const ALBUM_DETAILED: ObjectValidator<AlbumDetailed> = OBJECT({
playlistId: STRING(),
name: STRING(),
artists: LIST(ARTIST_BASIC),
year: OR(NUMBER(), NULL()),
thumbnails: LIST(THUMBNAIL_FULL)
})
@ -108,6 +109,7 @@ export const ALBUM_FULL: ObjectValidator<AlbumFull> = OBJECT({
playlistId: STRING(),
name: STRING(),
artists: LIST(ARTIST_BASIC),
year: OR(NUMBER(), NULL()),
thumbnails: LIST(THUMBNAIL_FULL),
description: STRING(),
songs: LIST(SONG_DETAILED)

10
src/parsers/AlbumParser.ts
View File

@ -25,6 +25,9 @@ export default class AlbumParser {
...albumBasic,
playlistId: traverseString(data, "buttonRenderer", "playlistId")(),
artists,
year: AlbumParser.processYear(
traverseString(data, "header", "subtitle", "text")(-1)
),
thumbnails,
description: traverseString(data, "description", "text")(),
songs: traverseList(data, "musicResponsiveListItemRenderer").map(item =>
@ -49,6 +52,7 @@ export default class AlbumParser {
artistId: traverseString(run, "browseId")(),
name: traverseString(run, "text")()
})),
year: AlbumParser.processYear(traverseString(flexColumns[1], "runs", "text")(-1)),
name: traverseString(flexColumns[0], "runs", "text")(),
thumbnails: traverseList(item, "thumbnails")
},
@ -64,6 +68,7 @@ export default class AlbumParser {
playlistId: traverseString(item, "thumbnailOverlay", "playlistId")(),
name: traverseString(item, "title", "text")(),
artists: [artistBasic],
year: AlbumParser.processYear(traverseString(item, "subtitle", "text")(-1)),
thumbnails: traverseList(item, "thumbnails")
},
ALBUM_DETAILED
@ -78,9 +83,14 @@ export default class AlbumParser {
playlistId: traverseString(item, "musicPlayButtonRenderer", "playlistId")(),
name: traverseString(item, "title", "text")(),
artists: [artistBasic],
year: AlbumParser.processYear(traverseString(item, "subtitle", "text")(-1)),
thumbnails: traverseList(item, "thumbnails")
},
ALBUM_DETAILED
)
}
private static processYear(year: string) {
return year.match(/^\d{4}$/) ? +year : null
}
}