Convert the project into typescript #93

BobVarioa · 2022-07-08T14:54:03Z

Description

This attempted to convert the entire project to typescript. This is a big change but I think it will improve the code quality of the library. It also is an essential part of my goal to convert this project to AssemblyScript so that I can use the (currently extremely alpha) Rosetta compiler to convert this into Kotlin so that there are bindings for android. That change itself is most likely out of scope of this library, although it might be beneficial to the library's performance, regardless that change won't be complete for a good amount of time because there are a lot of huge issues converting a dynamically typed javascript-y library into a strictly typed language with a similar but not identical standard library. Back on topic, this is just part 1 of that change, and simply intends to convert the project into typescript.

This currently is not finished in the slightest.

Type of change

New feature (non-breaking change which adds functionality)
This change requires a documentation update

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
I have checked my code and corrected any misspellings

Innertube.ts

AccountManager.ts

Actions.ts

lib/core/Actions.ts

lib/Innertube.ts

Feed.ts

FilterableFeed.ts

InteractionManager.ts

Music.ts

OAuth.ts

Player.ts

PlaylistManager.ts

LuanRT · 2022-07-08T17:37:14Z

lib/core/OAuth.ts

@@ -165,7 +167,7 @@ class OAuth {
    this.#credentials = {
      access_token: response.data.access_token,
      refresh_token: response.data.refresh_token || this.credentials.refresh_token,
-      expires: expiration_date
+      expires_in: expiration_date


This is intentionally named expires. The expiration time is converted from seconds to a date, so it wouldn't make sense to have the original name there.

Ohh okay, I was going to leave a comment but it seemed like a simple mistake.

Wykerd · 2022-07-11T18:50:44Z

This will probably be helpful to you: https://gist.github.com/Wykerd/6a97a810340f5382d9c38360bd12182c

It's the original TypeScript files I wrote for the NToken and Signature deciphering classes.

To aid with #93 I will make all my changes in TypeScript instead. This is the first step into making that happen. Used: https://github.com/wessberg/cjstoesm

Bring this PR up to speed with #93

Initial TS support for parsers as per #93 This adds several type safety checks to the parser which'll help to ensure valid data is returned by the parser.

Again, this also does some work for #93

Also, remove “strict” rule in favor of typescript (#93, #97)

BobVarioa · 2022-07-13T03:31:20Z

This will probably be helpful to you: https://gist.github.com/Wykerd/6a97a810340f5382d9c38360bd12182c

It's the original TypeScript files I wrote for the NToken and Signature deciphering classes.

Sweet! Thanks!

@ts-ignore

* refactor: remove dependancies removes node-forge and uuid in favor of Web APIs * refactor!: commonjs to es6 To aid with #93 I will make all my changes in TypeScript instead. This is the first step into making that happen. Used: https://github.com/wessberg/cjstoesm * refactor!: NToken and Signature TS files Bring this PR up to speed with #93 * feat: cross platform cache (WIP) this is untested! should remove idb as dependecy. * feat: EventEmitter polyfill * refactor: remove events * feat: HTTPClient based on Fetch API (WIP) * refactor!: parsers refactor (WIP) Initial TS support for parsers as per #93 This adds several type safety checks to the parser which'll help to ensure valid data is returned by the parser. * refactor!: parsers refactor (WIP) Bring more in line with the existing implementations & make less verbose * refactor!: parser refactor I was overcomplicating things, this is much simpler and compatible with the existing JS API * fix: some missed parsers while refactoring * fix: better type inferance for parseResponse * feat(TS): typesafe YTNode casts * feat: more type safety in YTNode and Parser * refactor: VideoInfo download with fetch & TS (WIP) Again, this also does some work for #93 * fix: LiveChat in VideoInfo * refactor!: more typesafety in parser * refactor!: VideoInfo almost completed * refactor!: player and session refactors - Remove the Player class' dependance on Session. - Add additional context to the Session. * refactor!: move auth logic to Session (WIP) * refactor: TS port for Actions and Innertube My fingers hurt from typing out all those types :-P * refactor: NavigationEndpoint TS this is still a WIP and should be improved. NavigationEndpoint should probably be refactored further. * refactor!: VideoInfo compiles without errors * chore: delete old player * fix: import errors It compiles and runs!! * fix: Utils import fixes * fix: several runtime errors * fix: video streaming * chore: remove console.log debugging Whoops, forgot to remove these before I pushed the previous commit * chore: remove old unused dependencies * fix: typescript errors Now emitting declarations and source maps * refactor: TS feed * chore: delete old Feed * refactor: move streamToIterable into Utils * refactor: AccountManager TS * refactor: FilterableFeed to TS * refactor: InteractionManager to TS * refactor: PlaylistManager to TS * refactor: TabbedFeed to TS * refactor: Music to TS (WIP) more work to be done, see TODO comments * fix: getting the tests to pass (6/12) YouTube.js Tests Search ✓ Should search on YouTube (1152 ms) ✕ Should search on YouTube Music (705 ms) ✕ Should retrieve YouTube search suggestions (722 ms) ✓ Should retrieve YouTube Music search suggestions (233 ms) Comments ✓ Should retrieve comments (585 ms) ✕ Should retrieve next batch of comments (221 ms) ✕ Should retrieve comment replies (1 ms) General ✕ Should retrieve playlist with YouTube (732 ms) ✓ Should retrieve home feed (838 ms) ✓ Should retrieve trending content (543 ms) ✓ Should retrieve video info (639 ms) ✕ Should download video (5 ms) * fix: tests (7/12) YouTube.js Tests Search ✓ Should search on YouTube (1984 ms) ✕ Should search on YouTube Music (1139 ms) ✕ Should retrieve YouTube search suggestions (1433 ms) ✓ Should retrieve YouTube Music search suggestions (529 ms) Comments ✓ Should retrieve comments (324 ms) ✓ Should retrieve next batch of comments (395 ms) ✕ Should retrieve comment replies General ✕ Should retrieve playlist with YouTube (653 ms) ✓ Should retrieve home feed (1085 ms) ✓ Should retrieve trending content (513 ms) ✓ Should retrieve video info (921 ms) ✕ Should download video (3 ms) * fix: download tests (8/12) YouTube.js Tests Search ✓ Should search on YouTube (1293 ms) ✕ Should search on YouTube Music (927 ms) ✕ Should retrieve YouTube search suggestions (1250 ms) ✓ Should retrieve YouTube Music search suggestions (258 ms) Comments ✓ Should retrieve comments (803 ms) ✓ Should retrieve next batch of comments (511 ms) ✕ Should retrieve comment replies General ✕ Should retrieve playlist with YouTube (528 ms) ✓ Should retrieve home feed (1047 ms) ✓ Should retrieve trending content (548 ms) ✓ Should retrieve video info (825 ms) ✓ Should download video (1779 ms) * fix: tests (9/12) YouTube.js Tests Search ✓ Should search on YouTube (1276 ms) ✕ Should search on YouTube Music (955 ms) ✓ Should retrieve YouTube search suggestions (661 ms) ✓ Should retrieve YouTube Music search suggestions (491 ms) Comments ✓ Should retrieve comments (624 ms) ✓ Should retrieve next batch of comments (353 ms) ✕ Should retrieve comment replies General ✕ Should retrieve playlist with YouTube (672 ms) ✓ Should retrieve home feed (1277 ms) ✓ Should retrieve trending content (999 ms) ✓ Should retrieve video info (1106 ms) ✓ Should download video (2514 ms) * feat: key based type validation for parsers * fix: comments tests pass (10/12) YouTube.js Tests Search ✓ Should search on YouTube (938 ms) ✕ Should search on YouTube Music (850 ms) ✓ Should retrieve YouTube search suggestions (528 ms) ✓ Should retrieve YouTube Music search suggestions (224 ms) Comments ✓ Should retrieve comments (518 ms) ✓ Should retrieve next batch of comments (337 ms) ✓ Should retrieve comment replies (358 ms) General ✕ Should retrieve playlist with YouTube (466 ms) ✓ Should retrieve home feed (1051 ms) ✓ Should retrieve trending content (623 ms) ✓ Should retrieve video info (863 ms) ✓ Should download video (2656 ms) * refactor: type safety checks removing @ts-ignore * fix: playlist tests pass (11/12) YouTube.js Tests Search ✓ Should search on YouTube (991 ms) ✕ Should search on YouTube Music (924 ms) ✓ Should retrieve YouTube search suggestions (606 ms) ✓ Should retrieve YouTube Music search suggestions (225 ms) Comments ✓ Should retrieve comments (393 ms) ✓ Should retrieve next batch of comments (284 ms) ✓ Should retrieve comment replies (252 ms) General ✓ Should retrieve playlist with YouTube (578 ms) ✓ Should retrieve home feed (1148 ms) ✓ Should retrieve trending content (541 ms) ✓ Should retrieve video info (799 ms) ✓ Should download video (1419 ms) * fix: all tests pass for node 🎉 YouTube.js Tests Search ✓ Should search on YouTube (1053 ms) ✓ Should search on YouTube Music (761 ms) ✓ Should retrieve YouTube search suggestions (453 ms) ✓ Should retrieve YouTube Music search suggestions (221 ms) Comments ✓ Should retrieve comments (627 ms) ✓ Should retrieve next batch of comments (412 ms) ✓ Should retrieve comment replies (268 ms) General ✓ Should retrieve playlist with YouTube (565 ms) ✓ Should retrieve home feed (775 ms) ✓ Should retrieve trending content (498 ms) ✓ Should retrieve video info (875 ms) ✓ Should download video (1364 ms) * build: working Deno bundle Still need to test whether this bundle works in the browser * docs: update deno example to download video * refactor: MusicResponsiveListItem to TS * docs: TSDoc for Parser helpers * docs: Parser documentation for TS * docs: add note about parseItem and parseArray * test: remove browser tests since they're identical * feat: browser support and proxy example * fix: PlaylistManager TS after merge * feat: in-browser video streaming * refactor: cleanup the Dash example * feat: allow custom fetch implementations * feat: fetch debugger * fix: OAuth login * refactor: remove file extensions from imports * refactor: build scripts * fix: CustomEvent on node * fix: LiveChat * fix: linting * fix: liniting in build-parser-json * chore: update test workflow * fix: NToken errors after lint fixes * fix: codacy complaints * docs: update to reflect changes Definitly needs more work but its a start * refactor: cleanup imports/exports * fix: browser example - Remove user-agent before making request. - Fix cache on browsers * fix: cache on node * fix: stupid mistake * refactor: Session#signIn to wait untill success This also splits the 'auth' event up into 3 distinct events: - 'auth' -> fired on success - 'auth-pending' -> fired when pending authentication - 'auth-error' -> fired when an error occurred * refactor: freeze Constants * refactor: cleanup HTTPClient Request * refactor: debugFetch readability * chore: lint * refactor: replace jsdoc with tsdoc eslint plugin remove @param annotations without descriptions * fix: bunch of liniting warnings * refactor: better inference on YTNode#is As suggested by @MasterOfBob777 * fix: linting warnings * revert: undici import * refactor: rename `list_type` to `item_type`

github-actions · 2022-08-13T03:09:05Z

This PR has been automatically marked as stale because it has not had recent activity. Remove the stale label or comment or this will be closed in 2 days

bob added 5 commits July 8, 2022 09:42

refactor: rename all .js to .ts files

8161a12

refactor: convert to esm module when possible

f799e13

chore: move jsdoc types to typescript types

2db0cc4

Innertube.ts

chore: move jsdoc types to typescript types

31bf44f

AccountManager.ts

chore: move jsdoc types to typescript types

7433f02

Actions.ts

LuanRT reviewed Jul 8, 2022

View reviewed changes

lib/core/Actions.ts Outdated Show resolved Hide resolved

LuanRT reviewed Jul 8, 2022

View reviewed changes

lib/core/Actions.ts Outdated Show resolved Hide resolved

LuanRT reviewed Jul 8, 2022

View reviewed changes

lib/Innertube.ts Outdated Show resolved Hide resolved

bob added 13 commits July 8, 2022 11:46

fix: add common types

f86a9aa

chore: move jsdoc types to typescript types

c44ea68

Feed.ts

fix: rename oauth method from its legacy name

2ff0429

chore: move jsdoc types to typescript types

26fd2c5

FilterableFeed.ts

chore: move jsdoc types to typescript types

0a28322

InteractionManager.ts

chore: move jsdoc types to typescript types

9f521d2

Music.ts

chore: export interfaces

343f577

chore: move jsdoc types to typescript types

39b518d

OAuth.ts

chore: install node types

c7eada5

chore: move jsdoc types to typescript types

5c13b72

Player.ts

chore: move jsdoc types to typescript types

bd87f5c

PlaylistManager.ts

chore: remove comment

2ab2f1a

fix: revert unnecessary optimazation

cb3cb45

LuanRT reviewed Jul 8, 2022

View reviewed changes

LuanRT added the enhancement New feature or request label Jul 8, 2022

Wykerd added a commit that referenced this pull request Jul 11, 2022

refactor!: commonjs to es6

34cb9da

To aid with #93 I will make all my changes in TypeScript instead. This is the first step into making that happen. Used: https://github.com/wessberg/cjstoesm

LuanRT mentioned this pull request Jul 11, 2022

refactor!: better cross runtime support #97

Merged

13 tasks

Wykerd added a commit that referenced this pull request Jul 12, 2022

refactor!: NToken and Signature TS files

1e7a6f0

Bring this PR up to speed with #93

Wykerd added a commit that referenced this pull request Jul 12, 2022

refactor!: parsers refactor (WIP)

27965ec

Initial TS support for parsers as per #93 This adds several type safety checks to the parser which'll help to ensure valid data is returned by the parser.

Wykerd added a commit that referenced this pull request Jul 13, 2022

refactor: VideoInfo download with fetch & TS (WIP)

5a2e465

Again, this also does some work for #93

Wykerd added this to the v2 milestone Jul 13, 2022

LuanRT added a commit that referenced this pull request Jul 13, 2022

style: lint code

1ce2feb

Also, remove “strict” rule in favor of typescript (#93, #97)

LuanRT mentioned this pull request Jul 17, 2022

Updating YouTube Thumbnails #104

Closed

4 tasks

github-actions bot added the Stale label Aug 13, 2022

github-actions bot closed this Aug 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert the project into typescript #93

Convert the project into typescript #93

BobVarioa commented Jul 8, 2022

LuanRT Jul 8, 2022

BobVarioa Jul 8, 2022

Wykerd commented Jul 11, 2022

BobVarioa commented Jul 13, 2022

github-actions bot commented Aug 13, 2022

Convert the project into typescript #93

Convert the project into typescript #93

Conversation

BobVarioa commented Jul 8, 2022

Description

Type of change

Checklist:

LuanRT Jul 8, 2022

Choose a reason for hiding this comment

BobVarioa Jul 8, 2022

Choose a reason for hiding this comment

Wykerd commented Jul 11, 2022

BobVarioa commented Jul 13, 2022

github-actions bot commented Aug 13, 2022