@staffbase/plugins-client-sdk 2.0.0 → 2.0.2

package/dist/plugins-client-sdk.umd.js

@@ -2,12 +2,12 @@
  * Bundle of @staffbase/plugins-client-sdk
  * @file Staffbase plugins client SDK for JavaScript
  * @see https://github.com/Staffbase/plugins-client-sdk#readme
- * @version 1.2.3
+ * @version 2.0.1
  *
  * @author Stefan Staude <stefan.staude@staffbase.com>
  * @author Daniel Große <daniel.grosse@staffbase.com>
  *
- * @copyright  2023
+ * @copyright  2024
  * @license Apache-2.0
  */
 
@@ -237,6 +237,9 @@
 	        self.setLevel(defaultLevel, false);
 	        clearPersistedLevel();
 	      };
+	      self.enableAll = function (persist) {
+	        self.setLevel(self.levels.TRACE, persist);
+	      };
 	      self.disableAll = function (persist) {
 	        self.setLevel(self.levels.SILENT, persist);
 	      };
@@ -520,9 +523,9 @@
 	    name: 'Magyar',
 	    localizedName: 'Hungarian'
 	  },
-	  in: {
-	    key: 'in',
-	    locale: 'in_ID',
+	  id: {
+	    key: 'id',
+	    locale: 'id_ID',
 	    name: 'Bahasa Indonesia',
 	    localizedName: 'Indonesian'
 	  },
@@ -938,7 +941,7 @@
 	  }
 	};
 
-	let connection$2 = null;
+	let connection$1 = null;
 	const fallbackKickIn = 500;
 
 	/**
@@ -949,15 +952,15 @@
 	 * @return {Promise<function>} An appropriate send function
 	 */
 	var fallback = (() => {
-	  if (connection$2) {
-	    return connection$2;
+	  if (connection$1) {
+	    return connection$1;
 	  }
-	  connection$2 = new Promise(resolve => {
+	  connection$1 = new Promise(resolve => {
 	    setTimeout(function () {
-	      resolve(sendMessage$3);
+	      resolve(sendMessage$2);
 	    }, fallbackKickIn);
 	  });
-	  return connection$2;
+	  return connection$1;
 	});
 
 	/**
@@ -969,7 +972,7 @@
 	 * @return {Promise<any>} which awaits the response of the Staffbase App
 	 * @throws {Error} on commands not supported by protocol
 	 */
-	const sendMessage$3 = async function (cmd) {
+	const sendMessage$2 = async function (cmd) {
 	  for (var _len = arguments.length, payload = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
 	    payload[_key - 1] = arguments[_key];
 	  }
@@ -1077,11 +1080,9 @@
 	 *
 	 * @param {string} id of the promise
 	 * @param {any} msg the message which will will be passed to resolve
-	 *
-	 * @throws {Error} on unknown id
 	 */
 	const resolve = (id, msg) => {
-	  if (!(id in promiseMap)) throw new Error('Tried to resolve an unknown [' + id + '] promise.');
+	  if (!(id in promiseMap)) return;
 	  promiseMap[id].resolve(msg);
 	  delete promiseMap[id];
 	};
@@ -1091,10 +1092,9 @@
 	 *
 	 * @param {string} id of the promise
 	 * @param {any} err the error which will will be passed to reject
-	 * @throws {Error} on unknown id
 	 */
 	const reject = (id, err) => {
-	  if (!(id in promiseMap)) throw new Error('Tried to reject an unknown [' + id + '] promise.');
+	  if (!(id in promiseMap)) return;
 	  promiseMap[id].reject(err);
 	  delete promiseMap[id];
 	};
@@ -1129,7 +1129,7 @@
 	 * @static
 	 * @return {StaticValueStore}
 	 */
-	const dataStore$1 = _ref => {
+	const dataStore = _ref => {
 	  let {
 	    platform,
 	    language
@@ -1144,26 +1144,53 @@
 	    branchDefaultLanguage: language.branchDefaultLanguage
 	  };
 	};
-	let connection$1 = null;
+	let connection = null;
 	const targetOrigin = '*';
 
 	/**
 	 * Connect to the Staffbase App.
 	 *
-	 * Create a connection to a Staffbase app 3.6
-	 * @return {Promise<function>} An appropriate send function
+	 * Create a connection to a Staffbase app
+	 * Tries to reconnect until an answer is received
+	 *
+	 * @return {Promise<Function>} An appropriate send function
 	 */
-	const connect$2 = () => {
-	  if (connection$1) {
-	    return connection$1;
+	const connect$1 = () => {
+	  if (connection) {
+	    return connection;
 	  }
 	  const connectId = create();
-	  connection$1 = get(connectId).then(function (payload) {
-	    return sendMessage$2(dataStore$1(payload));
+	  let timeout;
+	  const delayFactor = 1.2;
+	  connection = get(connectId).then(payload => {
+	    window.clearTimeout(timeout);
+	    return sendMessage$1(dataStore(payload));
 	  });
 	  window.addEventListener('message', receiveMessage);
-	  window.parent.postMessage([protocol.HELLO, connectId, []], targetOrigin);
-	  return connection$1;
+	  const recurringConnect = function () {
+	    let delay = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 500;
+	    timeout = window.setTimeout(() => {
+	      if (delay < 1200) {
+	        recurringConnect(delay * delayFactor);
+	      } else {
+	        reject(connectId, 'No answer from Staffbase App');
+	        disconnect();
+	      }
+	    }, delay);
+	    window.parent.postMessage([protocol.HELLO, connectId, []], targetOrigin);
+	  };
+	  recurringConnect();
+	  return connection;
+	};
+
+	/**
+	 * Disconnect from the Staffbase App
+	 *
+	 * Only useful for tests.
+	 */
+	const disconnect = () => {
+	  window.removeEventListener('message', receiveMessage);
+	  connection = null;
 	};
 
 	/**
@@ -1215,7 +1242,7 @@
 	 * @return {Promise<any>} which awaits the response of the Staffbase App
 	 * @throws {Error} on commands not supported by protocol
 	 */
-	const sendMessage$2 = store => async function (cmd) {
+	const sendMessage$1 = store => async function (cmd) {
 	  switch (cmd) {
 	    case commands.version:
 	    case commands.native:
@@ -1232,7 +1259,7 @@
 	      for (var _len = arguments.length, payload = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
 	        payload[_key - 1] = arguments[_key];
 	      }
-	      return sendInvocationCall$1(create())(invocationMapping[cmd], payload);
+	      return sendInvocationCall(create())(invocationMapping[cmd], payload);
 	    default:
 	      throw new Error('Command ' + cmd + ' not supported by driver');
 	  }
@@ -1247,164 +1274,16 @@
 	 *
 	 * @return {Promise}
 	 */
-	const sendInvocationCall$1 = promiseID => (process, args) => {
+	const sendInvocationCall = promiseID => (process, args) => {
 	  window.parent.postMessage([protocol.INVOCATION, promiseID, process, args], targetOrigin);
 	  return get(promiseID);
 	};
 
-	let connection = null;
-	let outMsgQueue = [];
-
-	/**
-	 * Simple store solution to make the initial data available
-	 * as static values
-	 *
-	 * @param {InitialValues} initial the initial data from the frontend
-	 * @static
-	 * @return {StaticValueStore}
-	 */
-	const dataStore = _ref => {
-	  let {
-	    platform,
-	    language
-	  } = _ref;
-	  return {
-	    mobile: platform.mobile,
-	    version: platform.version,
-	    native: platform.native,
-	    ios: platform.native === 'ios',
-	    android: platform.native === 'android',
-	    langInfos: language,
-	    branchDefaultLang: language.branchDefaultLanguage
-	  };
-	};
-	window.Staffbase = window.Staffbase || {};
-	window.Staffbase.plugins = {
-	  getMessages: multiMessageProvider,
-	  putMessage: singleMessageReceiver
-	};
-
-	/**
-	 * Connect to the Staffbase App.
-	 *
-	 * Create a connection to a Staffbase app 3.6 from a native tab
-	 * @return {Promise<function>} An appropriate send function
-	 */
-	const connect$1 = () => {
-	  if (connection) {
-	    return connection;
-	  }
-	  const connectId = create();
-	  connection = get(connectId).then(function (payload) {
-	    return sendMessage$1(dataStore(payload));
-	  });
-	  outMsgQueue.push([protocol.HELLO, connectId, []]);
-	  return connection;
-	};
-
-	/**
-	 * A function which returns an array of messages
-	 *
-	 * The return value holds all messages in the order the were
-	 * received over time by sendMessage
-	 *
-	 * @return {Array} ordered list of messages
-	 */
-	function multiMessageProvider() {
-	  const queueRef = outMsgQueue;
-	  if (queueRef.length) ;
-	  outMsgQueue = [];
-	  return queueRef;
-	}
-
-	/**
-	 * A function which can receive a single message.
-	 *
-	 * Can be attached to window.onPostMessage
-	 * @param {Array} msg Staffbase 3.6 message
-	 */
-	function singleMessageReceiver(msg) {
-	  let type;
-	  let id;
-	  let payload;
-
-	  // safe destructure
-	  try {
-	    [type, id, payload] = msg;
-	    switch (type) {
-	      case protocol.SUCCESS:
-	        resolve(id, payload);
-	        break;
-	      case protocol.ERROR:
-	        reject(id, payload);
-	        break;
-	      default:
-	        // even thought catch-ignore is a bad style
-	        // there may be other participants listening
-	        // to messages in a different format so we
-	        // silently ignore here
-	        return;
-	    }
-	  } catch (e) {
-	    // even thought catch-ignore is a bad style
-	    // there may be other participants listening
-	    // to messages in a different format so we
-	    // silently ignore here
-	    return;
-	  }
-	}
-
-	/**
-	 * Send a SDK command to the Staffbase App.
-	 *
-	 * Translates SDK commands into protocol native commands.
-	 * @param {StaticValueStore} store the store object
-	 * @param {String} cmd an SDK command
-	 * @param {array} payload for the command
-	 * @return {Promise<any>} which awaits the response of the Staffbase App
-	 * @throws {Error} on commands not supported by protocol
-	 */
-	const sendMessage$1 = store => async function (cmd) {
-	  switch (cmd) {
-	    case commands.version:
-	    case commands.native:
-	    case commands.mobile:
-	    case commands.ios:
-	    case commands.android:
-	    case commands.langInfos:
-	    case commands.branchDefaultLang:
-	      return store[reversedCommands[cmd]];
-	    case commands.openLink:
-	    case commands.prefContentLang:
-	      for (var _len = arguments.length, payload = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
-	        payload[_key - 1] = arguments[_key];
-	      }
-	      return sendInvocationCall(invocationMapping[cmd], payload);
-	    default:
-	      throw new Error('Command ' + cmd + ' not supported by driver');
-	  }
-	};
-
-	/**
-	 * Create a promise and send an invocation call to the frontend
-	 *
-	 * @param {string} process the name of the process to call
-	 * @param {array} args an array of arguments
-	 *
-	 * @return {Promise}
-	 */
-	const sendInvocationCall = (process, args) => {
-	  const promiseID = create();
-	  outMsgQueue.push([protocol.INVOCATION, promiseID, process, args]);
-	  return get(promiseID);
-	};
-
 	let connector;
 	const connect = async () => {
-	  const putMessageConnection = connect$1();
-	  const postMessageConnection = connect$2();
+	  const postMessageConnection = connect$1();
 	  const fallbackConnection = fallback();
-	  const realConnectionBucket = [putMessageConnection, postMessageConnection];
+	  const realConnectionBucket = [postMessageConnection];
 	  const fallbackConnectionBucket = realConnectionBucket.concat(fallbackConnection);
 
 	  // Wait on the real communication and replace the connector with
@@ -1673,6 +1552,7 @@
 	 * Interface exports
 	 */
 
+
 	/**
 	 * Check if device is able to perform a download.
 	 * @function