@webex/common 2.59.3-next.1 → 2.59.4

package/src/uuid-utils.js

@@ -1,189 +1,189 @@
-import {encode, decode} from './base64';
-import {
-  SDK_EVENT,
-  hydraTypes,
-  INTERNAL_US_CLUSTER_NAME,
-  INTERNAL_US_INTEGRATION_CLUSTER_NAME,
-} from './constants';
-
-const hydraBaseUrl = 'https://api.ciscospark.com/v1';
-
-const isRequired = () => {
-  throw Error('parameter is required');
-};
-
-/**
- * Constructs a Hydra ID for a given UUID and type.
- *
- * @export
- * @param {string} type one of PEOPLE, TEAM, ROOM
- * @param {any} id identifying the "TYPE" object
- * @param {string} cluster containing the "TYPE" object
- * @returns {string}
- */
-export function constructHydraId(type = isRequired(), id = isRequired(), cluster = 'us') {
-  if (!type.toUpperCase) {
-    throw Error('"type" must be a string');
-  }
-
-  if (type === hydraTypes.PEOPLE || type === hydraTypes.ORGANIZATION) {
-    // Cluster is always "us" for people and orgs
-    return encode(`ciscospark://us/${type.toUpperCase()}/${id}`);
-  }
-
-  return encode(`ciscospark://${cluster}/${type.toUpperCase()}/${id}`);
-}
-
-/**
- * @typedef {Object} DeconstructedHydraId
- * @property {UUID} id identifying the object
- * @property {String} type of the object
- * @property {String} cluster containing the object
- */
-
-/**
- * Deconstructs a Hydra ID.
- *
- * @export
- * @param {String} id Hydra style id
- * @returns {DeconstructedHydraId} deconstructed id
- */
-export function deconstructHydraId(id) {
-  const payload = decode(id).split('/');
-
-  return {
-    id: payload.pop(),
-    type: payload.pop(),
-    cluster: payload.pop(),
-  };
-}
-
-/**
- * Constructs a Hydra ID for a message based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the message
- * @returns {string}
- */
-export function buildHydraMessageId(uuid, cluster) {
-  return constructHydraId(hydraTypes.MESSAGE, uuid, cluster);
-}
-
-/**
- * Constructs a Hydra ID for a person based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the person
- * @returns {string}
- */
-export function buildHydraPersonId(uuid, cluster) {
-  return constructHydraId(hydraTypes.PEOPLE, uuid, cluster);
-}
-
-/**
- * Constructs a Hydra ID for a room based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the room
- * @returns {string}
- */
-export function buildHydraRoomId(uuid, cluster) {
-  return constructHydraId(hydraTypes.ROOM, uuid, cluster);
-}
-
-/**
- * Constructs a Hydra ID for an organization based on internal UUID
- *
- * @export
- * @param {any} uuid
- * @param {string} cluster containing the organization
- * @returns {string}
- */
-export function buildHydraOrgId(uuid, cluster) {
-  return constructHydraId(hydraTypes.ORGANIZATION, uuid, cluster);
-}
-
-/**
- * Constructs a Hydra ID for an membership based on an
- * internal UUID for the person, and the space
- *
- * @export
- * @param {any} personUUID
- * @param {any} spaceUUID
- * @param {string} cluster containing the membership
- * @returns {string}
- */
-export function buildHydraMembershipId(personUUID, spaceUUID, cluster) {
-  return constructHydraId(hydraTypes.MEMBERSHIP, `${personUUID}:${spaceUUID}`, cluster);
-}
-
-/**
- * Returns a hydra cluster string based on a conversation url
- * @private
- * @memberof Messages
- * @param {Object} webex sdk instance
- * @param {String} conversationUrl url of space where activity took place
- * @returns {String} string suitable for UUID -> public ID encoding
- */
-export function getHydraClusterString(webex, conversationUrl) {
-  const internalClusterString = webex.internal.services.getClusterId(conversationUrl);
-
-  if (
-    internalClusterString.startsWith(INTERNAL_US_CLUSTER_NAME) ||
-    internalClusterString.startsWith(INTERNAL_US_INTEGRATION_CLUSTER_NAME)
-  ) {
-    // Original US cluster is simply 'us' for backwards compatibility
-    return 'us';
-  }
-  const clusterParts = internalClusterString.split(':');
-
-  if (clusterParts.length < 3) {
-    throw Error(`Unable to determine cluster for convo: ${conversationUrl}`);
-  }
-
-  return `${clusterParts[0]}:${clusterParts[1]}:${clusterParts[2]}`;
-}
-
-/**
- * Returns a Hydra roomType based on conversation tags
- *
- * @export
- * @param {arra} tags
- * @returns {string}
- */
-export function getHydraRoomType(tags) {
-  if (tags.includes(SDK_EVENT.INTERNAL.ACTIVITY_TAG.ONE_ON_ONE)) {
-    return SDK_EVENT.EXTERNAL.SPACE_TYPE.DIRECT;
-  }
-
-  return SDK_EVENT.EXTERNAL.SPACE_TYPE.GROUP;
-}
-
-/**
- * Returns file URLs for the activity, adhering to Hydra details,
- * e.g., https://api.ciscospark.com/v1/contents/Y2lzY29zcGF...
- * @see https://developer.webex.com/docs/api/v1/messages/get-message-details
- * @param {Object} activity from mercury
- * @param {string} cluster containing the files
- * @returns {Array} file URLs
- */
-export function getHydraFiles(activity, cluster) {
-  const hydraFiles = [];
-  const {files} = activity.object;
-
-  if (files) {
-    const {items} = files;
-
-    // Note: Generated ID is dependent on file order.
-    for (let i = 0; i < items.length; i += 1) {
-      const contentId = constructHydraId(hydraTypes.CONTENT, `${activity.id}/${i}`, cluster);
-
-      hydraFiles.push(`${hydraBaseUrl}/contents/${contentId}`);
-    }
-  }
-
-  return hydraFiles;
-}
+import {encode, decode} from './base64';
+import {
+  SDK_EVENT,
+  hydraTypes,
+  INTERNAL_US_CLUSTER_NAME,
+  INTERNAL_US_INTEGRATION_CLUSTER_NAME,
+} from './constants';
+
+const hydraBaseUrl = 'https://api.ciscospark.com/v1';
+
+const isRequired = () => {
+  throw Error('parameter is required');
+};
+
+/**
+ * Constructs a Hydra ID for a given UUID and type.
+ *
+ * @export
+ * @param {string} type one of PEOPLE, TEAM, ROOM
+ * @param {any} id identifying the "TYPE" object
+ * @param {string} cluster containing the "TYPE" object
+ * @returns {string}
+ */
+export function constructHydraId(type = isRequired(), id = isRequired(), cluster = 'us') {
+  if (!type.toUpperCase) {
+    throw Error('"type" must be a string');
+  }
+
+  if (type === hydraTypes.PEOPLE || type === hydraTypes.ORGANIZATION) {
+    // Cluster is always "us" for people and orgs
+    return encode(`ciscospark://us/${type.toUpperCase()}/${id}`);
+  }
+
+  return encode(`ciscospark://${cluster}/${type.toUpperCase()}/${id}`);
+}
+
+/**
+ * @typedef {Object} DeconstructedHydraId
+ * @property {UUID} id identifying the object
+ * @property {String} type of the object
+ * @property {String} cluster containing the object
+ */
+
+/**
+ * Deconstructs a Hydra ID.
+ *
+ * @export
+ * @param {String} id Hydra style id
+ * @returns {DeconstructedHydraId} deconstructed id
+ */
+export function deconstructHydraId(id) {
+  const payload = decode(id).split('/');
+
+  return {
+    id: payload.pop(),
+    type: payload.pop(),
+    cluster: payload.pop(),
+  };
+}
+
+/**
+ * Constructs a Hydra ID for a message based on internal UUID
+ *
+ * @export
+ * @param {any} uuid
+ * @param {string} cluster containing the message
+ * @returns {string}
+ */
+export function buildHydraMessageId(uuid, cluster) {
+  return constructHydraId(hydraTypes.MESSAGE, uuid, cluster);
+}
+
+/**
+ * Constructs a Hydra ID for a person based on internal UUID
+ *
+ * @export
+ * @param {any} uuid
+ * @param {string} cluster containing the person
+ * @returns {string}
+ */
+export function buildHydraPersonId(uuid, cluster) {
+  return constructHydraId(hydraTypes.PEOPLE, uuid, cluster);
+}
+
+/**
+ * Constructs a Hydra ID for a room based on internal UUID
+ *
+ * @export
+ * @param {any} uuid
+ * @param {string} cluster containing the room
+ * @returns {string}
+ */
+export function buildHydraRoomId(uuid, cluster) {
+  return constructHydraId(hydraTypes.ROOM, uuid, cluster);
+}
+
+/**
+ * Constructs a Hydra ID for an organization based on internal UUID
+ *
+ * @export
+ * @param {any} uuid
+ * @param {string} cluster containing the organization
+ * @returns {string}
+ */
+export function buildHydraOrgId(uuid, cluster) {
+  return constructHydraId(hydraTypes.ORGANIZATION, uuid, cluster);
+}
+
+/**
+ * Constructs a Hydra ID for an membership based on an
+ * internal UUID for the person, and the space
+ *
+ * @export
+ * @param {any} personUUID
+ * @param {any} spaceUUID
+ * @param {string} cluster containing the membership
+ * @returns {string}
+ */
+export function buildHydraMembershipId(personUUID, spaceUUID, cluster) {
+  return constructHydraId(hydraTypes.MEMBERSHIP, `${personUUID}:${spaceUUID}`, cluster);
+}
+
+/**
+ * Returns a hydra cluster string based on a conversation url
+ * @private
+ * @memberof Messages
+ * @param {Object} webex sdk instance
+ * @param {String} conversationUrl url of space where activity took place
+ * @returns {String} string suitable for UUID -> public ID encoding
+ */
+export function getHydraClusterString(webex, conversationUrl) {
+  const internalClusterString = webex.internal.services.getClusterId(conversationUrl);
+
+  if (
+    internalClusterString.startsWith(INTERNAL_US_CLUSTER_NAME) ||
+    internalClusterString.startsWith(INTERNAL_US_INTEGRATION_CLUSTER_NAME)
+  ) {
+    // Original US cluster is simply 'us' for backwards compatibility
+    return 'us';
+  }
+  const clusterParts = internalClusterString.split(':');
+
+  if (clusterParts.length < 3) {
+    throw Error(`Unable to determine cluster for convo: ${conversationUrl}`);
+  }
+
+  return `${clusterParts[0]}:${clusterParts[1]}:${clusterParts[2]}`;
+}
+
+/**
+ * Returns a Hydra roomType based on conversation tags
+ *
+ * @export
+ * @param {arra} tags
+ * @returns {string}
+ */
+export function getHydraRoomType(tags) {
+  if (tags.includes(SDK_EVENT.INTERNAL.ACTIVITY_TAG.ONE_ON_ONE)) {
+    return SDK_EVENT.EXTERNAL.SPACE_TYPE.DIRECT;
+  }
+
+  return SDK_EVENT.EXTERNAL.SPACE_TYPE.GROUP;
+}
+
+/**
+ * Returns file URLs for the activity, adhering to Hydra details,
+ * e.g., https://api.ciscospark.com/v1/contents/Y2lzY29zcGF...
+ * @see https://developer.webex.com/docs/api/v1/messages/get-message-details
+ * @param {Object} activity from mercury
+ * @param {string} cluster containing the files
+ * @returns {Array} file URLs
+ */
+export function getHydraFiles(activity, cluster) {
+  const hydraFiles = [];
+  const {files} = activity.object;
+
+  if (files) {
+    const {items} = files;
+
+    // Note: Generated ID is dependent on file order.
+    for (let i = 0; i < items.length; i += 1) {
+      const contentId = constructHydraId(hydraTypes.CONTENT, `${activity.id}/${i}`, cluster);
+
+      hydraFiles.push(`${hydraBaseUrl}/contents/${contentId}`);
+    }
+  }
+
+  return hydraFiles;
+}

package/src/while-in-flight.js

@@ -1,38 +1,38 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-/* eslint no-invalid-this: [0] */
-
-import {wrap} from 'lodash';
-
-import tap from './tap';
-
-/**
- * While the promise returned by the decorated is unfullfilled, sets, the
- * specified boolean on the target class to `true`
- * @param {string} param
- * @returns {Function}
- */
-export default function whileInFlight(param) {
-  return function whileInFlightDecorator(target, name, descriptor) {
-    descriptor.value = wrap(descriptor.value, function whileInFlightExecutor(fn, ...args) {
-      return new Promise((resolve) => {
-        this[param] = true;
-        resolve(
-          Reflect.apply(fn, this, args)
-            .then(
-              tap(() => {
-                this[param] = false;
-              })
-            )
-            .catch((reason) => {
-              this[param] = false;
-
-              return Promise.reject(reason);
-            })
-        );
-      });
-    });
-  };
-}
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+/* eslint no-invalid-this: [0] */
+
+import {wrap} from 'lodash';
+
+import tap from './tap';
+
+/**
+ * While the promise returned by the decorated is unfullfilled, sets, the
+ * specified boolean on the target class to `true`
+ * @param {string} param
+ * @returns {Function}
+ */
+export default function whileInFlight(param) {
+  return function whileInFlightDecorator(target, name, descriptor) {
+    descriptor.value = wrap(descriptor.value, function whileInFlightExecutor(fn, ...args) {
+      return new Promise((resolve) => {
+        this[param] = true;
+        resolve(
+          Reflect.apply(fn, this, args)
+            .then(
+              tap(() => {
+                this[param] = false;
+              })
+            )
+            .catch((reason) => {
+              this[param] = false;
+
+              return Promise.reject(reason);
+            })
+        );
+      });
+    });
+  };
+}

package/test/unit/spec/capped-debounce.js

@@ -1,103 +1,103 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-
-import {assert} from '@webex/test-helper-chai';
-import sinon from 'sinon';
-import {cappedDebounce} from '@webex/common';
-import FakeTimers from '@sinonjs/fake-timers';
-
-describe('common', () => {
-  describe('cappedDebounce()', () => {
-    let clock;
-
-    beforeEach(() => {
-      clock = FakeTimers.install({now: Date.now()});
-    });
-
-    afterEach(() => {
-      clock.uninstall();
-    });
-
-    it('requires a function', () => {
-      assert.throws(cappedDebounce, /`fn` must be a function/);
-    });
-
-    it('requires a `wait`', () => {
-      assert.throws(cappedDebounce.bind(null, sinon.spy()), /`wait` is required/);
-    });
-
-    it('requires a `maxWait`', () => {
-      assert.throws(cappedDebounce.bind(null, sinon.spy(), 5), /`options.maxWait` is required/);
-    });
-
-    it('requires a `maxCalls`', () => {
-      assert.throws(
-        cappedDebounce.bind(null, sinon.spy(), 5, {maxWait: 10}),
-        /`options.maxCalls` is required/
-      );
-    });
-
-    it('returns a function that will execute once it stops being invoked for `wait` ms', () => {
-      const spy = sinon.spy();
-      const fn = cappedDebounce(spy, 50, {maxWait: 1000, maxCalls: 10000});
-
-      fn();
-      fn();
-      fn();
-      fn();
-      assert.notCalled(spy);
-      clock.tick(20);
-      assert.notCalled(spy);
-      clock.tick(40);
-      assert.calledOnce(spy);
-      clock.tick(40);
-      assert.calledOnce(spy);
-    });
-
-    it('returns a function that will execute once if it continues to be invoked for `wait` ms after `maxWait` ms', () => {
-      const spy = sinon.spy();
-      const fn = cappedDebounce(spy, 100, {maxWait: 130, maxCalls: 10000});
-
-      fn();
-      assert.notCalled(spy);
-      clock.tick(50);
-      fn();
-      assert.notCalled(spy);
-      clock.tick(50);
-      fn();
-      assert.notCalled(spy);
-      clock.tick(50);
-      fn();
-      assert.calledOnce(spy);
-    });
-
-    it('returns a function that will execute once it has been invoked `maxCalls` times', () => {
-      const spy = sinon.spy();
-      const fn = cappedDebounce(spy, 50, {maxWait: 100, maxCalls: 4});
-
-      fn();
-      assert.notCalled(spy);
-      fn();
-      assert.notCalled(spy);
-      fn();
-      assert.notCalled(spy);
-      fn();
-      assert.called(spy);
-    });
-
-    it('returns a function that will execute once it has been invoked `maxCalls` times and executes again after `maxWait` ms', () => {
-      const spy = sinon.spy();
-      const fn = cappedDebounce(spy, 50, {maxWait: 100, maxCalls: 3});
-
-      fn();
-      fn();
-      fn();
-      assert.called(spy);
-      fn();
-      fn();
-      clock.tick(150);
-      assert.calledTwice(spy);
-    });
-  });
-});
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {assert} from '@webex/test-helper-chai';
+import sinon from 'sinon';
+import {cappedDebounce} from '@webex/common';
+import FakeTimers from '@sinonjs/fake-timers';
+
+describe('common', () => {
+  describe('cappedDebounce()', () => {
+    let clock;
+
+    beforeEach(() => {
+      clock = FakeTimers.install({now: Date.now()});
+    });
+
+    afterEach(() => {
+      clock.uninstall();
+    });
+
+    it('requires a function', () => {
+      assert.throws(cappedDebounce, /`fn` must be a function/);
+    });
+
+    it('requires a `wait`', () => {
+      assert.throws(cappedDebounce.bind(null, sinon.spy()), /`wait` is required/);
+    });
+
+    it('requires a `maxWait`', () => {
+      assert.throws(cappedDebounce.bind(null, sinon.spy(), 5), /`options.maxWait` is required/);
+    });
+
+    it('requires a `maxCalls`', () => {
+      assert.throws(
+        cappedDebounce.bind(null, sinon.spy(), 5, {maxWait: 10}),
+        /`options.maxCalls` is required/
+      );
+    });
+
+    it('returns a function that will execute once it stops being invoked for `wait` ms', () => {
+      const spy = sinon.spy();
+      const fn = cappedDebounce(spy, 50, {maxWait: 1000, maxCalls: 10000});
+
+      fn();
+      fn();
+      fn();
+      fn();
+      assert.notCalled(spy);
+      clock.tick(20);
+      assert.notCalled(spy);
+      clock.tick(40);
+      assert.calledOnce(spy);
+      clock.tick(40);
+      assert.calledOnce(spy);
+    });
+
+    it('returns a function that will execute once if it continues to be invoked for `wait` ms after `maxWait` ms', () => {
+      const spy = sinon.spy();
+      const fn = cappedDebounce(spy, 100, {maxWait: 130, maxCalls: 10000});
+
+      fn();
+      assert.notCalled(spy);
+      clock.tick(50);
+      fn();
+      assert.notCalled(spy);
+      clock.tick(50);
+      fn();
+      assert.notCalled(spy);
+      clock.tick(50);
+      fn();
+      assert.calledOnce(spy);
+    });
+
+    it('returns a function that will execute once it has been invoked `maxCalls` times', () => {
+      const spy = sinon.spy();
+      const fn = cappedDebounce(spy, 50, {maxWait: 100, maxCalls: 4});
+
+      fn();
+      assert.notCalled(spy);
+      fn();
+      assert.notCalled(spy);
+      fn();
+      assert.notCalled(spy);
+      fn();
+      assert.called(spy);
+    });
+
+    it('returns a function that will execute once it has been invoked `maxCalls` times and executes again after `maxWait` ms', () => {
+      const spy = sinon.spy();
+      const fn = cappedDebounce(spy, 50, {maxWait: 100, maxCalls: 3});
+
+      fn();
+      fn();
+      fn();
+      assert.called(spy);
+      fn();
+      fn();
+      clock.tick(150);
+      assert.calledTwice(spy);
+    });
+  });
+});