monday-sdk-js 0.4.0 → 0.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monday-sdk-js",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "private": false,
   "repository": "https://github.com/mondaycom/monday-sdk-js",
   "main": "src/index.js",
@@ -47,6 +47,7 @@
     "precommit": "yarn lint && yarn style-check",
     "lint": "eslint './src/**/*.*'",
     "style-check": "prettier --check './src/**/*.js'",
+    "style-fix": "prettier --write './src/**/*.js'",
     "compile-types": "tsc --noEmit"
   }
 }

package/src/client.js

@@ -6,6 +6,11 @@ const { initBackgroundTracking } = require("./services/background-tracking-servi
 
 const EMPTY_ARRAY = [];
 
+const STORAGE_SEGMENT_KINDS = {
+  GLOBAL: "v2",
+  INSTANCE: "instance"
+};
+
 class MondayClientSdk {
   constructor(options = {}) {
     this._clientId = options.clientId;
@@ -26,6 +31,9 @@ class MondayClientSdk {
     this._receiveMessage = this._receiveMessage.bind(this);
 
     this.storage = {
+      setItem: this.setStorageItem.bind(this),
+      getItem: this.getStorageItem.bind(this),
+      deleteItem: this.deleteStorageItem.bind(this),
       instance: {
         setItem: this.setStorageInstanceItem.bind(this),
         getItem: this.getStorageInstanceItem.bind(this),
@@ -110,16 +118,28 @@ class MondayClientSdk {
     window.location = url;
   }
 
+  setStorageItem(key, value, options = {}) {
+    return this._localApi("storage", { method: "set", key, value, options, segment: STORAGE_SEGMENT_KINDS.GLOBAL });
+  }
+
+  getStorageItem(key, options = {}) {
+    return this._localApi("storage", { method: "get", key, options, segment: STORAGE_SEGMENT_KINDS.GLOBAL });
+  }
+
+  deleteStorageItem(key, options = {}) {
+    return this._localApi("storage", { method: "delete", key, options, segment: STORAGE_SEGMENT_KINDS.GLOBAL });
+  }
+
   setStorageInstanceItem(key, value, options = {}) {
-    return this._localApi("storage", { method: "set", key, value, options, segment: "instance" });
+    return this._localApi("storage", { method: "set", key, value, options, segment: STORAGE_SEGMENT_KINDS.INSTANCE });
   }
 
   getStorageInstanceItem(key, options = {}) {
-    return this._localApi("storage", { method: "get", key, options, segment: "instance" });
+    return this._localApi("storage", { method: "get", key, options, segment: STORAGE_SEGMENT_KINDS.INSTANCE });
   }
 
   deleteStorageInstanceItem(key, options = {}) {
-    return this._localApi("storage", { method: "delete", key, options, segment: "instance" });
+    return this._localApi("storage", { method: "delete", key, options, segment: STORAGE_SEGMENT_KINDS.INSTANCE });
   }
 
   _localApi(method, args) {

package/types/client-api.interface.ts

@@ -1,4 +1,4 @@
-interface APIOptions {
+export interface APIOptions {
     /**
      * Access token for the API
      * If not set, will use the credentials of the current user (client only)
@@ -12,9 +12,9 @@ interface APIOptions {
 
     /**
      * A string specifying which version of the API should be used
-     * If not set, will use the default version (stable)
+     * If not set, will use the current API version
      */
-    apiVersion?: string;
+    apiVersion?: string | undefined;
 }
 
 interface OAuthOptions {
@@ -46,6 +46,12 @@ export interface ClientApi {
      */
     setToken(token: string): void;
 
+    /**
+     * Allows to set the API version for future requests.
+     * @param version A string specifying which version of the API should be used 
+     */ 
+    setApiVersion(version: string): void;
+
     /**
      * Performs a client-side redirection of the user to the monday OAuth screen with your client ID embedded in the URL,
      * sin order to get their approval to generate a temporary OAuth token based on your requested permission scopes.

package/types/client-data.interface.ts

@@ -17,7 +17,7 @@ interface GetResponse {
 interface DeleteResponse {
     data: {
         success: boolean;
-        value: any; 
+        value: any;
     };
     errorMessage?: string | undefined;
     method: string;
@@ -70,7 +70,7 @@ export interface ClientData {
      * @param params object containing the data you want to update
      */
     set(
-        type: SettableTypes, 
+        type: SettableTypes,
         params: object,
     ): Promise<any>;
 
@@ -84,26 +84,50 @@ export interface ClientData {
      * Apps cannot share storage across accounts or even across apps installed in the same location.
      */
     storage: {
+        /**
+         * 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>;
+        
+        /**
+         * Deletes a stored value from the database under `key` for the app (**without any reference to the instance**)
+         * @param {string} key - Used to delete the stored data
+         */
+        deleteItem(key: string): Promise<DeleteResponse>;
+        
+        /**
+         * Stores `value` under `key` in the database for the app  (**without any reference to the instance**)
+         * @param {string} key - Used to delete the stored data
+         * @param {any} value - The value to store
+         * @param {object=} options
+         * @param {string=} options.previous_version - Use the new version of the storage (instance-less)
+         */
+        setItem(key: string, value: any, options?: { previous_version?: string }): Promise<SetResponse>;
+        /***
+         * The instance storage is a key-value database that is scoped to a specific app instance.
+         * **Does not work** for instance-less apps.
+         */
         instance: {
             /**
-             * Returns a stored value from the database under `key`
+             * Returns a stored value from the database under `key` for a specific app instance
              * @param key
              */
             getItem(key: string): Promise<GetResponse>;
-
+            
             /**
-             * Deletes a stored value from the database under `key`
+             * Deletes a stored value from the database under `key` for a specific app instance
              * @param key
              */
             deleteItem(key: string): Promise<DeleteResponse>;
-
+            
             /**
-             * Stores `value` under `key` in the database
+             * Stores `value` under `key` in the database for a specific app instance
              * @param key
              * @param value
              * @param options
              */
             setItem(key: string, value: any, options?: { previous_version?: string }): Promise<SetResponse>;
         };
-    };    
+    };
 }

package/types/index.d.ts

@@ -1,7 +1,7 @@
 // Original Definitions were contributed by: Josh Parnham <https://github.com/josh->
 import { ClientData } from './client-data.interface';
 import { ClientExecute } from './client-execute.interface';
-import { ClientApi } from './client-api.interface';
+import { ClientApi, APIOptions } from './client-api.interface';
 
 export as namespace mondaySdk;
 
@@ -10,7 +10,9 @@ type MondayClientSdk = ClientData & ClientExecute & ClientApi;
 interface MondayServerSdk {
     setToken(token: string): void;
 
-    api(query: string, options?: Partial<{ token: string, variables: object, apiVersion: string } >): Promise<any>;
+    setApiVersion(version: string): void;
+
+    api(query: string, options?: APIOptions): Promise<any>;
 
     oauthToken(code: string, clientId: string, clientSecret: string): Promise<any>;
 }
@@ -19,12 +21,14 @@ declare function init(
     config?: Partial<{
         clientId: string;
         apiToken: string;
+        apiVersion: string;
     }>,
 ): MondayClientSdk;
 
 declare function init(
     config?: Partial<{
         token: string;
+        apiVersion: string;
     }>,
 ): MondayServerSdk;