monday-sdk-js 0.4.7 → 0.4.9

package/README.md

@@ -42,4 +42,4 @@ const monday = window.mondaySdk()
 
 ## Docs
 
-To get started, check out the [SDK Documentation](https://developer.monday.com/apps/docs/introduction-to-the-sdk)
+To get started, check out the [SDK Documentation](https://developer.monday.com/apps/docs/introduction-to-the-sdk)

package/package.json

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

package/src/client.js

@@ -3,6 +3,7 @@ const { MONDAY_OAUTH_URL } = require("./constants.js");
 const { convertToArrayIfNeeded } = require("./helpers");
 const { initScrollHelperIfNeeded } = require("./helpers/ui-helpers");
 const { initBackgroundTracking } = require("./services/background-tracking-service");
+const { logWarnings } = require("./helpers/monday-api-helpers");
 
 const EMPTY_ARRAY = [];
 
@@ -65,17 +66,14 @@ class MondayClientSdk {
     const token = options.token || this._apiToken;
     const apiVersion = options.apiVersion || this._apiVersion;
 
+    let responsePromise;
     if (token) {
-      return mondayApiClient.execute(params, token, { apiVersion });
+      responsePromise = mondayApiClient.execute(params, token, { apiVersion });
     } else {
-      return new Promise((resolve, reject) => {
-        this._localApi("api", { params, apiVersion })
-          .then(result => {
-            resolve(result.data);
-          })
-          .catch(err => reject(err));
-      });
+      responsePromise = this._localApi("api", { params, apiVersion }).then(result => result.data);
     }
+
+    return responsePromise.then(logWarnings);
   }
 
   listen(typeOrTypes, callback, params) {

package/src/helpers/monday-api-helpers.js

@@ -0,0 +1,43 @@
+const logWarnings = res => {
+  const warnings = res && res.extensions && res.extensions.warnings;
+  if (!warnings || !Array.isArray(warnings)) return res;
+
+  warnings.forEach(warning => {
+    if (!warning || !warning.message) return;
+
+    try {
+      const locations =
+        warning.locations && warning.locations.map(loc => `line ${loc.line}, column ${loc.column}`).join("; ");
+      const path = warning.path && warning.path.join(" → ");
+
+      let message = warning.message;
+
+      // remove the dot at the end of the message
+      message = message.replace(/\.$/, "");
+      // start the message with lower case letter
+      message = message.charAt(0).toLowerCase() + message.slice(1);
+
+      const messageParts = [
+        "[monday API]",
+        `${path}:`,
+        message,
+        locations && `@ ${locations}`,
+        warning.extensions ? ["\n\nAdditional details:", warning.extensions] : undefined
+      ]
+        .flat()
+        .filter(Boolean);
+
+      console.warn(...messageParts);
+    } catch (e) {
+      if (warning) {
+        console.warn("[monday API] Warning:", warning);
+      }
+    }
+  });
+
+  return res;
+};
+
+module.exports = {
+  logWarnings
+};

package/src/server.js

@@ -1,3 +1,4 @@
+const { logWarnings } = require("./helpers/monday-api-helpers");
 const mondayApiClient = require("./monday-api-client");
 const { oauthToken } = require("./services/oauth-service.js");
 
@@ -21,14 +22,14 @@ class MondayServerSdk {
     this._apiVersion = apiVersion;
   }
 
-  async api(query, options = {}) {
+  api(query, options = {}) {
     const params = { query, variables: options.variables };
     const token = options.token || this._token;
     const apiVersion = options.apiVersion || this._apiVersion;
 
     if (!token) throw new Error(TOKEN_MISSING_ERROR);
 
-    return await mondayApiClient.execute(params, token, { apiVersion });
+    return mondayApiClient.execute(params, token, { apiVersion }).then(logWarnings);
   }
 
   oauthToken(code, clientId, clientSecret) {

package/types/client-execute.interface.ts

@@ -7,11 +7,10 @@ type BlockTypes = 'normal text' | 'large title' | 'medium title' | 'small title'
  * Block content in delta format
  */
 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. 
+     * 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>;
 
@@ -205,6 +204,40 @@ export interface ClientExecute {
     },
   ): Promise<{ data: Record<string, any> }>;
     /**
+     * Doc command, This method adds multiple blocks to the beginning of a workdoc using HTML..
+     * @param type Which action to perform
+     */
+    execute(type: 'addMultiBlocksFromHtml'): Promise<{ html: string }>;   /**
+    /**
+     * Doc command, This method opens the app modal on the first selected block when multiple are open.
+     * @param type Which action to perform
+     */
+    execute(type: 'openAppOnFirstTextualSelectedBlock'): Promise<{ data: any }>;   /**
+    /**
+     * Doc command This method opens the app on the next block when multiple are selected. This is only available after calling the "openAppOnFirstTextualBlock" function.
+     * @param type Which action to perform
+     */
+    execute(type: 'moveToNextSelectedTextualBlock'): Promise<{ data: any }>;   /**
+    /**
+     * Doc command This method opens the app on the next block when multiple are selected. This is only available after calling the "openAppOnFirstTextualBlock" function.
+     * @param type Which action to perform
+     */
+    execute(type: 'moveToPrevSelectedTextualBlock'): Promise<{ data: any }>;   /**
+    /**
+     * Doc command, This method replaces the highlighted text with text of your choosing at the beginning of the block.
+     * @param type Which action to perform
+     */
+    execute(type: 'replaceHighlightText'): Promise<{ text: string }>;    /**
+    /**
+     * Item Update section, This method creates or changes the content of an item's update.
+     * @param type Which action to perform
+     */
+    execute(type: 'updatePostContentAction'): Promise<{ suggestedRephrase: string }>;    /**
+     /**
+     * This method closes the AI assistant's dialog.
+     * @param type Which action to perform
+     */
+    execute(type: 'closeDialog'): Promise<{ data: any }>;    /**
      * Closes the modal window.
      * @param type Which action to perform
      */