@webex/common 3.0.0-beta.2 → 3.0.0-beta.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/common",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.20",
   "description": "Common utilities for Cisco Webex",
   "license": "MIT",
   "main": "dist/index.js",
@@ -25,8 +25,8 @@
   },
   "devDependencies": {
     "@sinonjs/fake-timers": "^6.0.1",
-    "@webex/common": "3.0.0-beta.2",
-    "@webex/test-helper-chai": "3.0.0-beta.2",
+    "@webex/common": "3.0.0-beta.20",
+    "@webex/test-helper-chai": "3.0.0-beta.20",
     "ampersand-state": "^5.0.3",
     "sinon": "^9.2.4"
   },

package/src/base64.js

@@ -63,5 +63,5 @@ export default {
   toBase64Url,
   encode,
   decode,
-  validate
+  validate,
 };

package/src/browser-detection.js

@@ -9,7 +9,7 @@ const mockDetectionObject = {
   /* eslint-enable global-require */
   getBrowserName: () => '',
   getBrowserVersion: () => '',
-  isBrowser: () => false
+  isBrowser: () => false,
 };
 
 const createDetectionObject = (results) => {
@@ -26,11 +26,12 @@ const createDetectionObject = (results) => {
     getOSVersion,
     getBrowserName,
     getBrowserVersion,
-    isBrowser
+    isBrowser,
   };
 };
 
-export default memoize((agent) => (agent || window.navigator?.userAgent ?
-  createDetectionObject(bowser.getParser(agent || window.navigator.userAgent)) :
-  mockDetectionObject
-));
+export default memoize((agent) =>
+  agent || window.navigator?.userAgent
+    ? createDetectionObject(bowser.getParser(agent || window.navigator.userAgent))
+    : mockDetectionObject
+);

package/src/capped-debounce.js

@@ -31,7 +31,8 @@ export default function debounce(fn, wait, options) {
 
   const {maxCalls, maxWait} = options;
   let count = 0;
-  let maxWaitTimer, waitTimer;
+  let maxWaitTimer;
+  let waitTimer;
 
   return function wrapper() {
     count += 1;

package/src/constants.js

@@ -4,7 +4,7 @@ export const SDK_EVENT = {
     ACTIVITY_FIELD: {
       ACTOR: 'actor',
       OBJECT: 'object',
-      TARGET: 'target'
+      TARGET: 'target',
     },
     ACTIVITY_VERB: {
       ACKNOWLEDGE: 'acknowledge',
@@ -20,43 +20,43 @@ export const SDK_EVENT = {
       LOCK: 'lock',
       UNLOCK: 'unlock',
       HIDE: 'hide',
-      UPDATE: 'update'
+      UPDATE: 'update',
     },
     ACTIVITY_TAG: {
       HIDDEN: 'HIDDEN',
       ONE_ON_ONE: 'ONE_ON_ONE',
-      LOCKED: 'LOCKED'
-    }
+      LOCKED: 'LOCKED',
+    },
   },
   EXTERNAL: {
     EVENT_TYPE: {
       CREATED: 'created',
       DELETED: 'deleted',
       UPDATED: 'updated',
-      SEEN: 'seen'
+      SEEN: 'seen',
     },
     OWNER: {
       CREATOR: 'creator',
-      ORG: 'org'
+      ORG: 'org',
     },
     STATUS: {
       ACTIVE: 'active',
-      DISABLED: 'disabled'
+      DISABLED: 'disabled',
     },
     SPACE_TYPE: {
       DIRECT: 'direct',
-      GROUP: 'group'
+      GROUP: 'group',
     },
     RESOURCE: {
       ATTACHMENT_ACTIONS: 'attachmentActions',
       MEMBERSHIPS: 'memberships',
       MESSAGES: 'messages',
-      ROOMS: 'rooms'
+      ROOMS: 'rooms',
     },
     ATTACHMENTS: {
-      CARD_CONTENT_TYPE: 'application/vnd.microsoft.card.adaptive'
-    }
-  }
+      CARD_CONTENT_TYPE: 'application/vnd.microsoft.card.adaptive',
+    },
+  },
 };
 
 export const hydraTypes = {
@@ -67,12 +67,12 @@ export const hydraTypes = {
   ORGANIZATION: 'ORGANIZATION',
   PEOPLE: 'PEOPLE',
   ROOM: 'ROOM',
-  TEAM: 'TEAM'
+  TEAM: 'TEAM',
 };
 
 export const deviceType = {
   PROVISIONAL: 'PROVISIONAL',
-  WEB: 'WEB'
+  WEB: 'WEB',
 };
 
 export const INTERNAL_US_CLUSTER_NAME = 'urn:TEAM:us-east-2_a';

package/src/deprecated.js

@@ -9,7 +9,9 @@ import {deprecated} from 'core-decorators';
  * @returns {function}
  */
 function emptyDecorator() {
-  return function noop() { /* eslint no-empty:[0] */ };
+  return function noop() {
+    /* eslint no-empty:[0] */
+  };
 }
 
 const exportedDeprecated = process.env.NODE_ENV === 'production' ? emptyDecorator : deprecated;

package/src/event-envelope.js

@@ -12,21 +12,26 @@ import {SDK_EVENT} from './constants';
  */
 export function createEventEnvelope(webex, resource) {
   return ensureMyIdIsAvailable(webex)
-    .then(() => Promise.resolve({
-      createdBy: webex.internal.me.id,
-      orgId: webex.internal.me.orgId,
-      resource,
-      // id -- webhook id concept does not correlate to SDK socket event
-      // name -- webhook name concept does not correlate to SDK socket event
-      // targetUrl -- targetUrl concept does not correlate to SDK socket event
-      // secret -- secret concept does not correlate to SDK socket event
-      ownedBy: SDK_EVENT.EXTERNAL.OWNER.CREATOR,
-      status: SDK_EVENT.EXTERNAL.STATUS.ACTIVE,
-      created: new Date().toISOString(),
-      data: {}
-    })).catch((e) => {
-      Promise.reject(new Error(`Unable to get person info for ${resource} \
-event envelope: ${e.message}`));
+    .then(() =>
+      Promise.resolve({
+        createdBy: webex.internal.me.id,
+        orgId: webex.internal.me.orgId,
+        resource,
+        // id -- webhook id concept does not correlate to SDK socket event
+        // name -- webhook name concept does not correlate to SDK socket event
+        // targetUrl -- targetUrl concept does not correlate to SDK socket event
+        // secret -- secret concept does not correlate to SDK socket event
+        ownedBy: SDK_EVENT.EXTERNAL.OWNER.CREATOR,
+        status: SDK_EVENT.EXTERNAL.STATUS.ACTIVE,
+        created: new Date().toISOString(),
+        data: {},
+      })
+    )
+    .catch((e) => {
+      Promise.reject(
+        new Error(`Unable to get person info for ${resource} \
+event envelope: ${e.message}`)
+      );
     });
 }
 
@@ -37,14 +42,13 @@ event envelope: ${e.message}`));
  */
 export async function ensureMyIdIsAvailable(webex) {
   // If we don't have it, save info about our user
-  if (('me' in webex.internal)) {
+  if ('me' in webex.internal) {
     return Promise.resolve();
   }
 
-  return webex.people.get('me')
-    .then((person) => {
-      webex.internal.me = person;
+  return webex.people.get('me').then((person) => {
+    webex.internal.me = person;
 
-      return Promise.resolve();
-    });
+    return Promise.resolve();
+  });
 }

package/src/events.js

@@ -11,10 +11,7 @@ import {isArray} from 'lodash';
  * @returns {EventEmitter} Returns the source emitter to ease use in promise chains
  */
 export function proxyEvents(emitter, proxy) {
-  [
-    'on',
-    'once'
-  ].forEach((key) => {
+  ['on', 'once'].forEach((key) => {
     proxy[key] = (...args) => {
       emitter[key](...args);
 

package/src/exception.js

@@ -20,8 +20,7 @@ export default class Exception extends Error {
 
     if (this.parse) {
       message = this.parse(...args);
-    }
-    else if (this.constructor.parse) {
+    } else if (this.constructor.parse) {
       message = this.constructor.parse(...args);
     }
 

package/src/index.js

@@ -10,11 +10,9 @@ export {default as Defer} from './defer';
 export {default as makeStateDataType} from './make-state-datatype';
 export {default as make} from './template-container';
 export {default as oneFlight} from './one-flight';
-export {default as patterns} from './patterns.js';
-export {
-  proxyEvents,
-  transferEvents
-} from './events';
+export {default as patterns} from './patterns';
+
+export {proxyEvents, transferEvents} from './events';
 export {createEventEnvelope, ensureMyIdIsAvailable} from './event-envelope';
 export {default as resolveWith} from './resolve-with';
 export {default as retry} from './retry';
@@ -28,7 +26,7 @@ export {
   hydraTypes,
   SDK_EVENT,
   INTERNAL_US_CLUSTER_NAME,
-  INTERNAL_US_INTEGRATION_CLUSTER_NAME
+  INTERNAL_US_INTEGRATION_CLUSTER_NAME,
 } from './constants';
 
 export {default as BrowserDetection} from './browser-detection';
@@ -42,5 +40,5 @@ export {
   getHydraClusterString,
   getHydraFiles,
   constructHydraId,
-  deconstructHydraId
+  deconstructHydraId,
 } from './uuid-utils';

package/src/make-state-datatype.js

@@ -36,7 +36,7 @@ export default function makeStateDataType(Constructor, name) {
 
           return {
             val: newVal,
-            type: name
+            type: name,
           };
         }
 
@@ -46,7 +46,7 @@ export default function makeStateDataType(Constructor, name) {
         // instance.
         return {
           val: newVal ? new Constructor(newVal, {parent: this}) : undefined,
-          type: name
+          type: name,
         };
       },
       compare: function compare(currentValue, newVal) {
@@ -57,13 +57,17 @@ export default function makeStateDataType(Constructor, name) {
         // if this has changed we want to also handle
         // event propagation
         if (previousVal) {
-          this.stopListening(previousVal, 'all', this._getCachedEventBubblingHandler(attributeName));
+          this.stopListening(
+            previousVal,
+            'all',
+            this._getCachedEventBubblingHandler(attributeName)
+          );
         }
 
         if (newVal) {
           this.listenTo(newVal, 'all', this._getCachedEventBubblingHandler(attributeName));
         }
-      }
+      },
     },
     prop: {
       /**
@@ -81,7 +85,7 @@ export default function makeStateDataType(Constructor, name) {
 
         return false;
       },
-      type: name
-    }
+      type: name,
+    },
   };
 }

package/src/one-flight.js

@@ -28,11 +28,7 @@ export default function oneFlight(...params) {
 
   const options = params[0] || {};
 
-  const {
-    cacheFailures,
-    cacheSuccesses,
-    keyFactory
-  } = options;
+  const {cacheFailures, cacheSuccesses, keyFactory} = options;
 
   return oneFlightDecorator;
 

package/src/patterns.js

@@ -18,7 +18,8 @@ export default {
    *
    * @type {RegExp}
    */
-  email: /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/,
+  email:
+    /^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/,
 
   /**
    * Regular expression that validates an ambiguous string contains emails
@@ -27,7 +28,8 @@ export default {
    *
    * @type {RegExp}
    */
-  containsEmails: /(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))/g,
+  containsEmails:
+    /(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))/g,
 
   /**
    * Matches a UUID
@@ -45,5 +47,5 @@ export default {
    * Same as this.uuid but allows for surrounding characters
    * @type {RegExp}
    */
-  execUuid: /[a-f\d]{8}(?:-[a-f\d]{4}){3}-[a-f\d]{12}/
+  execUuid: /[a-f\d]{8}(?:-[a-f\d]{4}){3}-[a-f\d]{12}/,
 };

package/src/retry.js

@@ -24,11 +24,11 @@ import backoff from 'backoff';
 export default function retry(...params) {
   let options = params[0] || {};
 
-  options = Object.assign({}, options);
+  options = {...options};
   defaults(options, {
     backoff: true,
     delay: 1,
-    maxAttempts: 3
+    maxAttempts: 3,
   });
 
   let strategyOptions;
@@ -36,13 +36,12 @@ export default function retry(...params) {
   if (options.backoff) {
     strategyOptions = {
       initialDelay: options.delay,
-      maxDelay: options.maxDelay
+      maxDelay: options.maxDelay,
     };
-  }
-  else {
+  } else {
     strategyOptions = {
       initialDelay: 1,
-      maxDelay: 1
+      maxDelay: 1,
     };
   }
 

package/src/tap.js

@@ -16,9 +16,10 @@
  *   // => 5
  */
 export default function tap(fn) {
-  return (r) => new Promise((resolve) => {
-    resolve(fn(r));
-  })
-    .then(() => r)
-    .catch(() => r);
+  return (r) =>
+    new Promise((resolve) => {
+      resolve(fn(r));
+    })
+      .then(() => r)
+      .catch(() => r);
 }

package/src/template-container.js

@@ -18,7 +18,9 @@ function make(...containers) {
 
   const ChildContainer = containers.length > 1 ? make(...containers) : containers[0];
 
-  const name = `(${[TopContainer.name].concat(containers.map((container) => container.name)).join(', ')})`;
+  const name = `(${[TopContainer.name]
+    .concat(containers.map((container) => container.name))
+    .join(', ')})`;
 
   /**
    * Container that wraps an arbitrary set of tupples to their values

package/src/uuid-utils.js

@@ -1,5 +1,10 @@
 import {encode, decode} from './base64';
-import {SDK_EVENT, hydraTypes, INTERNAL_US_CLUSTER_NAME, INTERNAL_US_INTEGRATION_CLUSTER_NAME} from './constants';
+import {
+  SDK_EVENT,
+  hydraTypes,
+  INTERNAL_US_CLUSTER_NAME,
+  INTERNAL_US_INTEGRATION_CLUSTER_NAME,
+} from './constants';
 
 const hydraBaseUrl = 'https://api.ciscospark.com/v1';
 
@@ -16,16 +21,12 @@ const isRequired = () => {
  * @param {string} cluster containing the "TYPE" object
  * @returns {string}
  */
-export function constructHydraId(
-  type = isRequired(),
-  id = isRequired(),
-  cluster = 'us'
-) {
+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)) {
+  if (type === hydraTypes.PEOPLE || type === hydraTypes.ORGANIZATION) {
     // Cluster is always "us" for people and orgs
     return encode(`ciscospark://us/${type.toUpperCase()}/${id}`);
   }
@@ -53,7 +54,7 @@ export function deconstructHydraId(id) {
   return {
     id: payload.pop(),
     type: payload.pop(),
-    cluster: payload.pop()
+    cluster: payload.pop(),
   };
 }
 
@@ -116,8 +117,7 @@ export function buildHydraOrgId(uuid, cluster) {
  * @returns {string}
  */
 export function buildHydraMembershipId(personUUID, spaceUUID, cluster) {
-  return constructHydraId(hydraTypes.MEMBERSHIP,
-    `${personUUID}:${spaceUUID}`, cluster);
+  return constructHydraId(hydraTypes.MEMBERSHIP, `${personUUID}:${spaceUUID}`, cluster);
 }
 
 /**
@@ -129,11 +129,12 @@ export function buildHydraMembershipId(personUUID, spaceUUID, cluster) {
  * @returns {String} string suitable for UUID -> public ID encoding
  */
 export function getHydraClusterString(webex, conversationUrl) {
-  const internalClusterString =
-    webex.internal.services.getClusterId(conversationUrl);
+  const internalClusterString = webex.internal.services.getClusterId(conversationUrl);
 
-  if ((internalClusterString.startsWith(INTERNAL_US_CLUSTER_NAME)) ||
-    (internalClusterString.startsWith(INTERNAL_US_INTEGRATION_CLUSTER_NAME))) {
+  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';
   }
@@ -179,8 +180,7 @@ export function getHydraFiles(activity, cluster) {
 
     // 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);
+      const contentId = constructHydraId(hydraTypes.CONTENT, `${activity.id}/${i}`, cluster);
 
       hydraFiles.push(`${hydraBaseUrl}/contents/${contentId}`);
     }

package/src/while-in-flight.js

@@ -19,15 +19,19 @@ export default function whileInFlight(param) {
     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;
+        resolve(
+          Reflect.apply(fn, this, args)
+            .then(
+              tap(() => {
+                this[param] = false;
+              })
+            )
+            .catch((reason) => {
+              this[param] = false;
 
-            return Promise.reject(reason);
-          }));
+              return Promise.reject(reason);
+            })
+        );
       });
     });
   };

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

@@ -32,7 +32,10 @@ describe('common', () => {
     });
 
     it('requires a `maxCalls`', () => {
-      assert.throws(cappedDebounce.bind(null, sinon.spy(), 5, {maxWait: 10}), /`options.maxCalls` is required/);
+      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', () => {

package/test/unit/spec/exception.js

@@ -14,9 +14,7 @@ describe('common', () => {
           static defaultMessage = 'no parser';
         }
 
-        class DerivedNoParserException extends NoParserException {
-
-        }
+        class DerivedNoParserException extends NoParserException {}
 
         class StaticBadParserException extends DerivedNoParserException {
           static parse() {