Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixing the type of get response #139

Merged
merged 5 commits into from
Jan 11, 2024
Merged

fixing the type of get response #139

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
107975c
fixing the type of get response
rami-monday Jan 10, 2024
c710fb7
add tests for get response types
rami-monday Jan 10, 2024
792248c
test types
rami-monday Jan 10, 2024
e97a04b
add more test for global storage types
rami-monday Jan 10, 2024
6a7d665
remove fro ts-tests
rami-monday Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "monday-sdk-js",
"version": "0.5.2",
"version": "0.5.3",
"private": false,
"repository": "https://github.com/mondaycom/monday-sdk-js",
"main": "src/index.js",
Expand Down
8 changes: 4 additions & 4 deletions ts-tests/monday-sdk-js-module.test.ts
View file
Open in desktop
Copy link
Collaborator

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 $ExpectType comments as we're not using typescript lint here anyway, so they don't have any influence and they are only confusing

Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ monday.api('test', { apiVersion: '2023-07' }); // $ExpectType Promise<{ data: ob

monday.setToken('test'); // $ExpectType void

monday.get('context'); // $ExpectType Promise<any>
monday.get('settings'); // $ExpectType Promise<any>
monday.get('itemIds'); // $ExpectType Promise<any>
monday.get('sessionToken'); // $ExpectType Promise<any>
monday.get('context'); // $ExpectType Promise<{ data: object; }>
monday.get('settings'); // $ExpectType Promise<{ data: object; }>
monday.get('itemIds'); // $ExpectType Promise<{ data: number[]; }>
monday.get('sessionToken'); // $ExpectType Promise<{ data: string; }>

monday.set('settings', {'text' : 'this is a test', 'number' : 23}); // $ExpectType Promise<any>

Expand Down
6 changes: 6 additions & 0 deletions types/client-context.type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ type AppVersion = {
};
};

export type Permissions = {
approvedScopes: string[];
requiredScopes: string[];
};

export type BaseContext = {
themeConfig?: Theme;
theme: string;
Expand All @@ -40,6 +45,7 @@ export type BaseContext = {
region: string;
app: App;
appVersion: AppVersion;
permissions: Permissions;
};

export type AppFeatureBoardViewContext = BaseContext & {
Expand Down
30 changes: 16 additions & 14 deletions types/client-data.interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,21 @@ type SubscribableEvents = keyof SubscribableEventsResponse;

type SettableTypes = "settings";

interface GetResponse {
data: {
success: boolean;
value: any;
version?: any;
};
type StorageResponse = {
success: boolean;
value: any;
version?: any;
};

type Response<T = StorageResponse> = {
data: T;
errorMessage?: string | undefined;
method: string;
requestId: string;
type?: string | undefined;
}
};

interface DeleteResponse {
type DeleteResponse = {
data: {
success: boolean;
value: any;
Expand All @@ -32,7 +34,7 @@ interface DeleteResponse {
method: string;
requestId: string;
type?: string | undefined;
}
};

interface SetResponse {
data: {
Expand Down Expand Up @@ -70,8 +72,8 @@ export interface ClientData {
AppFeatureType extends AppFeatureTypes = AppFeatureTypes
>(
type: T,
params?: object & { appFeatureType?: AppFeatureType }
): Promise<GetterResponse<AppFeatureType>[T] & CustomResponse>;
params?: Record<string, any> & { appFeatureType?: AppFeatureType }
): Promise<Response<GetterResponse<AppFeatureType>[T] & CustomResponse>>;

/**
* Creates a listener which allows subscribing to certain types of client-side events.
Expand All @@ -86,7 +88,7 @@ export interface ClientData {
>(
typeOrTypes: T | ReadonlyArray<T>,
callback: (res: { data: SubscribableEventsResponse<AppFeatureType>[T] & CustomResponse }) => void,
params?: object & { appFeatureType?: AppFeatureType }
params?: Record<string, any> & { appFeatureType?: AppFeatureType }
): void;

/**
Expand All @@ -110,7 +112,7 @@ export interface ClientData {
* Returns a stored value from the database under `key` for the app (**without any reference to the instance**)
* @param {string} key - Used to access to stored data
*/
getItem(key: string): Promise<GetResponse>;
getItem(key: string): Promise<Response>;

/**
* Deletes a stored value from the database under `key` for the app (**without any reference to the instance**)
Expand All @@ -135,7 +137,7 @@ export interface ClientData {
* Returns a stored value from the database under `key` for a specific app instance
* @param key
*/
getItem(key: string): Promise<GetResponse>;
getItem(key: string): Promise<Response>;

/**
* Deletes a stored value from the database under `key` for a specific app instance
Expand Down
Loading