monday-sdk-js 0.3.4 → 0.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monday-sdk-js",
-  "version": "0.3.4",
+  "version": "0.4.1",
   "private": false,
   "repository": "https://github.com/mondaycom/monday-sdk-js",
   "main": "src/index.js",
@@ -25,6 +25,7 @@
     "@babel/preset-env": "^7.6.0",
     "@babel/preset-react": "^7.0.0",
     "@babel/register": "^7.6.0",
+    "@types/source-map": "^0.5.2",
     "babel-loader": "^8.0.6",
     "chai": "^4.2.0",
     "eslint": "^6.8.0",
@@ -33,11 +34,10 @@
     "prettier": "^1.19.1",
     "sinon": "^9.0.0",
     "sinon-chai": "^3.5.0",
+    "typescript": "^4.9.5",
     "webpack": "^4.38.0",
     "webpack-cli": "^3.3.6",
-    "webpack-dev-server": "^3.7.2",
-    "@types/source-map": "^0.5.2",
-    "typescript": "^4.9.5"
+    "webpack-dev-server": "^3.7.2"
   },
   "scripts": {
     "start": "webpack-dev-server",
@@ -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-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/client-execute.interface.ts

@@ -9,6 +9,12 @@ type BlockTypes = 'normal text' | 'large title' | 'medium title' | 'small title'
 interface BlockContent { deltaFormat: Array<object> };
 
 export interface ClientExecute {
+    /**
+     * Type fallback to account for new execute methods during the AI hackathon. 
+     * This will be removed when the 0.4.0 version goes out of beta. 
+     */
+    execute (type: any, params?: any): Promise<any>;
+
     /**
      * Opens a popup card with information from the selected item
      * @param type Which action to perform