fixing the type of get response #139
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,77 +1,125 @@ | ||
| import mondaySdk from "../types"; | ||
| const monday = mondaySdk(); | ||
|
|
||
| monday.api("test"); // $ExpectType Promise<{ data: object; }> | ||
|
|
||
| monday.setApiVersion("2023-10"); // $ExpectType void | ||
| mondaySdk({ apiVersion: "2023-10" }); | ||
| monday.api("test", { apiVersion: "2023-07" }); // $ExpectType Promise<{ data: object; }> | ||
|
|
||
| monday.setToken("test"); // $ExpectType void | ||
|
|
||
| monday.get("context", { appFeatureType: "AppFeatureBoardView" }).then(res => { | ||
| const { data } = res; | ||
| data.app.id; // $ExpectType number | ||
| data.permissions.approvedScopes; // $ExpectType string[] | ||
| data.theme; // $ExpectType string | ||
| data.boardId; // $ExpectType number | ||
| data.viewMode; // $ExpectType string | ||
| }); // $ExpectType Promise<{ data: string; }> | ||
|
There was a problem hiding this comment. these assertions are not promising anything about the types of these primitives, i.e. if boardId changes to string, this test won't catch it. I recommend using https://www.npmjs.com/package/expect-type |
||
|
|
||
| monday.get<{ text: string; level: number }>("settings").then(res => { | ||
| const { data } = res; | ||
| data.text; // $ExpectType string | ||
| data.level; // $ExpectType number | ||
| }); // $ExpectType Promise<{ data: object; }> | ||
|
|
||
| monday.get("itemIds").then(res => { | ||
| const { data } = res; | ||
| data[0]; // $ExpectType number | ||
| }); // $ExpectType Promise<{ data: number[]; }> | ||
|
|
||
| monday.get("sessionToken").then(res => { | ||
| const { data } = res; | ||
| data; // $ExpectType string | ||
| }); // $ExpectType Promise<{ data: string; }> | ||
|
|
||
| monday.set("settings", { text: "this is a test", number: 23 }); // $ExpectType Promise<any> | ||
|
|
||
| monday.listen("context", res => res); // $ExpectType void | ||
|
|
||
| monday.execute("openItemCard", { itemId: 123 }); // $ExpectType Promise<any> | ||
| monday.execute("confirm", { message: "Hello" }); // $ExpectType Promise<{ data: { confirm: boolean; }; }> | ||
| monday.execute("notice", { message: "Hello" }); // $ExpectType Promise<any> | ||
| // $ExpectType Promise<any> | ||
| monday.execute("openFilesDialog", { | ||
| boardId: 12345, | ||
| itemId: 23456, | ||
| columnId: "files", | ||
| assetId: 34567 | ||
| }); | ||
| // $ExpectType Promise<any> | ||
| monday.execute("triggerFilesUpload", { | ||
| boardId: 12345, | ||
| itemId: 23456, | ||
| columnId: "files" | ||
| }); | ||
| monday.execute("openAppFeatureModal", { urlPath: "/path", urlParams: {}, width: "100px", height: "100px" }); // $ExpectType Promise<{ data: any; }> | ||
| monday.execute("closeAppFeatureModal"); // $ExpectType Promise<{ data: any; }> | ||
| monday.execute("valueCreatedForUser"); // $ExpectType Promise<any}> | ||
| // $ExpectType Promise<any> | ||
| monday.execute("addDocBlock", { | ||
| type: "normal text", | ||
| content: { deltaFormat: [{ insert: "test" }] } | ||
| }); | ||
| // $ExpectType Promise<any> | ||
| monday.execute("updateDocBlock", { | ||
| id: "1234-1234-23434dsf", | ||
| content: { deltaFormat: [{ insert: "test" }] } | ||
| }); | ||
| // $ExpectType Promise<any> | ||
| monday.execute("addMultiBlocks", { | ||
| afterBlockId: "1234-1234-23434dsf", | ||
| blocks: [ | ||
| { | ||
| type: "normal text", | ||
| content: { deltaFormat: [{ insert: "test" }] } | ||
| } | ||
| ] | ||
| }); | ||
| monday.execute("closeDocModal"); // $ExpectType Promise<any> | ||
|
|
||
| monday.oauth({ clientId: "clientId" }); | ||
|
|
||
| monday.storage.instance.getItem("test").then(res => { | ||
| const { data } = res; | ||
| data.success; // $ExpectType boolean | ||
| data.value; // $ExpectType any | ||
| }); // $ExpectType Promise<GetResponse> | ||
|
|
||
| monday.storage.instance.setItem("test", "123").then(res => { | ||
| const { data } = res; | ||
| data.success; // $ExpectType boolean | ||
| }); // $ExpectType Promise<SetResponse> | ||
|
|
||
| monday.storage.instance.deleteItem("test").then(res => { | ||
| const { data } = res; | ||
| data.success; // $ExpectType boolean | ||
| }); // $ExpectType Promise<DeleteResponse> | ||
|
|
||
| monday.storage.getItem("test").then(res => { | ||
| const { data } = res; | ||
| data.success; // $ExpectType boolean | ||
| data.value; // $ExpectType any | ||
| }); // $ExpectType Promise<GetResponse> | ||
|
|
||
| monday.storage.setItem("test", "123").then(res => { | ||
| const { data } = res; | ||
| data.success; // $ExpectType boolean | ||
| }); // $ExpectType Promise<SetResponse> | ||
|
|
||
| monday.storage.deleteItem("test").then(res => { | ||
| const { data } = res; | ||
| data.success; // $ExpectType boolean | ||
| }); // $ExpectType Promise<DeleteResponse> | ||
|
|
||
| const mondayServer = mondaySdk({ token: "123", apiVersion: "2023-10" }); | ||
|
|
||
| mondayServer.setToken("123"); // $ExpectType void | ||
| mondayServer.setApiVersion("2023-10"); // $ExpectType void | ||
| mondayServer.api("test"); // $ExpectType Promise<any> | ||
| mondayServer.api("test", { token: "test" }); // $ExpectType Promise<any> | ||
| mondayServer.api("test", { variables: { variable1: "test" } }); // $ExpectType Promise<any> | ||
| mondayServer.api("test", { token: "test", variables: { variable1: "test" } }); // $ExpectType Promise<any> | ||
| mondayServer.api("test", { token: "test", apiVersion: "2023-07" }); // $ExpectType Promise<any> | ||
| mondayServer.oauthToken("test", "test", "test"); // $ExpectType Promise<any> | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rami-monday let's remove all the
$ExpectTypecomments as we're not using typescript lint here anyway, so they don't have any influence and they are only confusing