feat: new JS API #19154
feat: new JS API #19154
Conversation
BrayanDSO
force-pushed
the
api
branch
2 times, most recently
from
ab15560 to
5de449e
Compare
BrayanDSO
force-pushed
the
api
branch
2 times, most recently
from
bf8a82e to
b3d453b
Compare
| const match = returnType.match(API_METHOD_RETURN_TYPE_REGEX); | ||
|
|
||
| if (!match) { | ||
| continue; |
There was a problem hiding this comment.
We should probably log here
| const callExpressions = method.getDescendantsOfKind(SyntaxKind.CallExpression); | ||
| for (const callExpr of callExpressions) { | ||
| const expression = callExpr.getExpression(); | ||
| if (Node.isPropertyAccessExpression(expression)) { |
There was a problem hiding this comment.
nit: I prefer to invert & continue; to reduce nesting
| * Whether the card is New (0), Learning (1), Review (2), Relearning (3) | ||
| * @returns The card `type` property | ||
| */ | ||
| public getType(): Promise<Result<number>> { |
There was a problem hiding this comment.
Can we return this as a union/branded type
| /** | ||
| * @returns The card ID. | ||
| */ | ||
| public getId(): Promise<Result<number>> { |
There was a problem hiding this comment.
For a number of these: do we want branded types?
Or at least aliasing CardId to number
| * Gets the card remaining steps | ||
| * @returns The card `left` property | ||
| */ | ||
| public getLeft(): Promise<Result<number>> { |
There was a problem hiding this comment.
Is this true? It's been a long while, but I believe it's more complex, depending on whether the card has inter or intra-day steps
| throw new Error(`Request failed with status ${response.status}`); | ||
| } | ||
|
|
||
| const responseData = await response.text(); |
There was a problem hiding this comment.
unusual to not use response.json() is there a reason? (old WebViews?)
| /** | ||
| * @param error Error message. | ||
| */ | ||
| export type Failure = { success: false; error: string }; |
There was a problem hiding this comment.
Explain if this is translated or not
Do we want a (string) error code which users can Google?
| interval: number; | ||
| ease: number; | ||
| takenSecs: number; | ||
| memoryState?: FsrsMemoryState; |
There was a problem hiding this comment.
Be aware that this will likely be extended, and how we handle this
| @@ -0,0 +1,13 @@ | |||
| Copyright (year) (author) | |||
There was a problem hiding this comment.
If you mean (year) and (author), they are part of the eslint-plugin-headers template syntax.
| @@ -0,0 +1,28 @@ | |||
| { | |||
| "name": "ankidroid-js-api", | |||
| "private": false, | |||
There was a problem hiding this comment.
How is this going to be published/updated/pushed to consumers?
|
We probably want a longer discussion over architecture I'd prefer this as a separate repo:
|
BrayanDSO
added
the
Needs Author Reply
2 participants
Purpose / Description
https://github.com/BrayanDSO/AnkiDroid-JS-API in a PR. Not sure if it's better placed in this repo or on a separate one.
This is basically the typescript source for generating ankidroid-js-api.js, js-api-endpoints.json and all the docs, used in #19152
package-lock.json is 3100 lines of the PR, so don't get too afraid
Pending tasks (for other PRs) are: