monday-sdk-js 0.4.8 → 0.4.10

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.8",
+  "version": "0.4.10",
   "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/constants-test.js

@@ -5,6 +5,7 @@ describe("constants", () => {
   //setup
   beforeEach(() => {
     process.env.NODE_ENV = "development";
+    process.env.MONDAY_DOMAIN = undefined;
     process.env.MONDAY_COM_PROTOCOL = undefined;
     process.env.MONDAY_COM_DOMAIN = undefined;
     process.env.MONDAY_SUBDOMAIN_API = undefined;
@@ -35,44 +36,79 @@ describe("constants", () => {
     expect(constants.MONDAY_OAUTH_TOKEN_URL).to.eq(MONDAY_OAUTH_TOKEN_URL);
   });
 
-  it("constants should be correct", () => {
-    const keys = Object.keys(constants);
-    let key;
-    let value;
-    for (let i = 0; i < keys.length; i++) {
-      key = keys[i];
-      value = constants[key];
-
-      switch (key) {
-        case "MONDAY_DOMAIN": {
-          expect(value).to.eq("monday.com");
-          break;
-        }
-
-        case "MONDAY_PROTOCOL": {
-          expect(value).to.eq("https");
-          break;
-        }
-
-        case "MONDAY_API_URL": {
-          expect(value).to.eq("https://api.monday.com/v2");
-          break;
-        }
-
-        case "MONDAY_OAUTH_URL": {
-          expect(value).to.eq("https://auth.monday.com/oauth2/authorize");
-          break;
-        }
-
-        case "MONDAY_OAUTH_TOKEN_URL": {
-          expect(value).to.eq("https://auth.monday.com/oauth2/token");
-          break;
-        }
-
-        default: {
-          throw new Error(`missing test for this constant: ${key}`);
-        }
-      }
-    }
+  describe("check that constants are correct when NODE_ENV is development", () => {
+    it("MONDAY_DOMAIN should be correct", () => {
+      expect(constants.MONDAY_DOMAIN).to.eq("monday.com");
+    });
+
+    it("MONDAY_PROTOCOL should be correct", () => {
+      expect(constants.MONDAY_PROTOCOL).to.eq("https");
+    });
+
+    it("MONDAY_API_URL should be correct", () => {
+      expect(constants.MONDAY_API_URL).to.eq("https://api.monday.com/v2");
+    });
+
+    it("MONDAY_OAUTH_URL should be correct", () => {
+      expect(constants.MONDAY_OAUTH_URL).to.eq("https://auth.monday.com/oauth2/authorize");
+    });
+
+    it("MONDAY_OAUTH_TOKEN_URL should be correct", () => {
+      expect(constants.MONDAY_OAUTH_TOKEN_URL).to.eq("https://auth.monday.com/oauth2/token");
+    });
+  });
+
+  describe("check that constants are correct when NODE_ENV is undefined", () => {
+    beforeEach(() => {
+      process.env.NODE_ENV = undefined;
+      process.env.MONDAY_COM_DOMAIN = "should not be used";
+    });
+
+    it("MONDAY_DOMAIN should be correct", () => {
+      expect(constants.MONDAY_DOMAIN).to.eq("monday.com");
+    });
+
+    it("MONDAY_PROTOCOL should be correct", () => {
+      expect(constants.MONDAY_PROTOCOL).to.eq("https");
+    });
+
+    it("MONDAY_API_URL should be correct", () => {
+      expect(constants.MONDAY_API_URL).to.eq("https://api.monday.com/v2");
+    });
+
+    it("MONDAY_OAUTH_URL should be correct", () => {
+      expect(constants.MONDAY_OAUTH_URL).to.eq("https://auth.monday.com/oauth2/authorize");
+    });
+
+    it("MONDAY_OAUTH_TOKEN_URL should be correct", () => {
+      expect(constants.MONDAY_OAUTH_TOKEN_URL).to.eq("https://auth.monday.com/oauth2/token");
+    });
+  });
+
+  describe("check that constants are correct when NODE_ENV is undefined", () => {
+    beforeEach(() => {
+      process.env.NODE_ENV = "production";
+      process.env.MONDAY_COM_DOMAIN = "should not be used";
+    });
+
+    it("MONDAY_DOMAIN should be correct", () => {
+      expect(constants.MONDAY_DOMAIN).to.eq("monday.com");
+    });
+
+    it("MONDAY_PROTOCOL should be correct", () => {
+      expect(constants.MONDAY_PROTOCOL).to.eq("https");
+    });
+
+    it("MONDAY_API_URL should be correct", () => {
+      expect(constants.MONDAY_API_URL).to.eq("https://api.monday.com/v2");
+    });
+
+    it("MONDAY_OAUTH_URL should be correct", () => {
+      expect(constants.MONDAY_OAUTH_URL).to.eq("https://auth.monday.com/oauth2/authorize");
+    });
+
+    it("MONDAY_OAUTH_TOKEN_URL should be correct", () => {
+      expect(constants.MONDAY_OAUTH_TOKEN_URL).to.eq("https://auth.monday.com/oauth2/token");
+    });
   });
 });

package/src/constants.js

@@ -7,7 +7,9 @@ function isNodeDevStageEnv() {
 }
 
 const getEnvOrDefault = (key, defaultVal) => {
-  return isNodeDevStageEnv() && process.env[key] !== "undefined" ? process.env[key] : defaultVal;
+  return isNodeDevStageEnv() && process.env[key] !== "undefined" && process.env[key] !== undefined
+    ? process.env[key]
+    : defaultVal;
 };
 
 const MONDAY_PROTOCOL = () => getEnvOrDefault("MONDAY_COM_PROTOCOL", "https");

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) {