monday-sdk-js 0.5.1 → 0.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monday-sdk-js",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "private": false,
   "repository": "https://github.com/mondaycom/monday-sdk-js",
   "main": "src/index.js",

package/types/client-api.interface.ts

@@ -38,7 +38,7 @@ export interface ClientApi {
      * Placeholders may be used, which will be substituted by the variables object passed within the options.
      * @param options
      */
-    api(query: string, options?: APIOptions): Promise<{ data: object }>;
+    api<T = any>(query: string, options?: APIOptions): Promise<{ data: T, account_id: number }>;
 
     /**
      * Instead of passing the API token to the `api()` method on each request, you can set the API token once using:
@@ -58,4 +58,4 @@ export interface ClientApi {
      * @param object An object with options
      */
     oauth(object?: OAuthOptions): void;
-}
+}

package/types/client-context.type.ts

@@ -32,6 +32,11 @@ type AppVersion = {
   };
 };
 
+export type Permissions = {
+  approvedScopes: string[];
+  requiredScopes: string[];
+};
+
 export type BaseContext = {
   themeConfig?: Theme;
   theme: string;
@@ -40,6 +45,7 @@ export type BaseContext = {
   region: string;
   app: App;
   appVersion: AppVersion;
+  permissions: Permissions;
 };
 
 export type AppFeatureBoardViewContext = BaseContext & {

package/types/client-data.interface.ts

@@ -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;
@@ -32,7 +34,7 @@ interface DeleteResponse {
   method: string;
   requestId: string;
   type?: string | undefined;
-}
+};
 
 interface SetResponse {
   data: {
@@ -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.
@@ -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;
 
   /**
@@ -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**)
@@ -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

package/types/server-sdk.interface.ts

@@ -5,7 +5,7 @@ export interface MondayServerSdk {
 
     setApiVersion(version: string): void;
 
-    api(query: string, options?: APIOptions): Promise<any>;
+    api<T = any>(query: string, options?: APIOptions): Promise<T>;
 
     oauthToken(code: string, clientId: string, clientSecret: string): Promise<any>;
 }