monday-sdk-js 0.3.3 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monday-sdk-js",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "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",

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
@@ -184,13 +190,27 @@ export interface ClientExecute {
             height?: string;
         },
     ): Promise<{ data: any }>;
+  /**
+   * Opens the provided link in a new tab.
+   * @param type Which action to perform
+   * @param params Optional parameters for the action
+   */
+  execute(
+    type: 'openLinkInTab',
+    params: {
+      /**
+       * The URL to open a new tab with
+       */
+      url: string;
+    },
+  ): Promise<{ data: Record<string, any> }>;
     /**
      * Closes the modal window.
      * @param type Which action to perform
      */
     execute(type: 'closeAppFeatureModal'): Promise<{ data: any }>;
     /**
-     * Notifies the monday platform when a user gains a first value in your app. 
+     * Notifies the monday platform when a user gains a first value in your app.
      * @param type Which action to perform
      */
     execute(type: 'valueCreatedForUser'): Promise<any>;
@@ -207,9 +227,9 @@ export interface ClientExecute {
              */
             type: BlockTypes;
             /**
-             * Used to specify where in the doc the new block should go. 
-             * Provide the block's ID that will be above the new block. 
-             * Without this parameter, the block will appear at the top of the doc.	
+             * Used to specify where in the doc the new block should go.
+             * Provide the block's ID that will be above the new block.
+             * Without this parameter, the block will appear at the top of the doc.
              */
             afterBlockId?: string | undefined;
             /**
@@ -217,7 +237,7 @@ export interface ClientExecute {
              */
             content: BlockContent;
         },
-    ): Promise<any>; 
+    ): Promise<any>;
     /**
      * Updates a block's content
      * @param type Which action to perform
@@ -227,7 +247,7 @@ export interface ClientExecute {
         type: 'updateDocBlock',
         params: {
             /**
-             * The block's unique identifier.	
+             * The block's unique identifier.
              */
             id: string;
             /**
@@ -245,11 +265,11 @@ export interface ClientExecute {
         type: 'addMultiBlocks',
         params: {
             /**
-             * The block's unique identifier.	
+             * The block's unique identifier.
              */
             afterBlockId?: string | undefined;
             /**
-             * The block's content in Delta format. 
+             * The block's content in Delta format.
              * We support the following block types
              */
             blocks: Array<{ type: BlockTypes,  content: BlockContent}>;
@@ -260,4 +280,4 @@ export interface ClientExecute {
      * @param type Which action to perform
      */
     execute (type: 'closeDocModal'): Promise<any>;
-}
+}