@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.20

package/src/locus-info/{mediaSharesUtils.js → mediaSharesUtils.ts}

@@ -1,24 +1,24 @@
 import {CONTENT, WHITEBOARD} from '../constants';
 
-const MediaSharesUtils = {};
+const MediaSharesUtils: any = {};
 
 /**
  * parses the relevant values for mediaShares: contentId, disposition
  * @param {Object} mediaShares
  * @returns {undefined}
  */
-MediaSharesUtils.parse = (mediaShares) => {
+MediaSharesUtils.parse = (mediaShares: object) => {
   if (mediaShares) {
     return {
       content: {
         beneficiaryId: MediaSharesUtils.getContentBeneficiaryId(mediaShares),
-        disposition: MediaSharesUtils.getContentDisposition(mediaShares)
+        disposition: MediaSharesUtils.getContentDisposition(mediaShares),
       },
       whiteboard: {
         beneficiaryId: MediaSharesUtils.getWhiteboardBeneficiaryId(mediaShares),
         disposition: MediaSharesUtils.getWhiteboardDisposition(mediaShares),
-        resourceUrl: MediaSharesUtils.getWhiteboardResourceUrl(mediaShares)
-      }
+        resourceUrl: MediaSharesUtils.getWhiteboardResourceUrl(mediaShares),
+      },
     };
   }
 
@@ -32,13 +32,13 @@ MediaSharesUtils.parse = (mediaShares) => {
  * @returns {Object}
  * previous: {Object} old share, current: {Object} new share,
  */
-MediaSharesUtils.getMediaShares = (oldShare, newShare) => {
+MediaSharesUtils.getMediaShares = (oldShare: object, newShare: object) => {
   const previous = oldShare && MediaSharesUtils.parse(oldShare);
   const current = newShare && MediaSharesUtils.parse(newShare);
 
   return {
     previous,
-    current
+    current,
   };
 };
 
@@ -47,7 +47,7 @@ MediaSharesUtils.getMediaShares = (oldShare, newShare) => {
  * @param {Object} mediaShares
  * @returns {Boolean} disposition
  */
-MediaSharesUtils.getContentDisposition = (mediaShares) => {
+MediaSharesUtils.getContentDisposition = (mediaShares: object) => {
   const contentFloor = MediaSharesUtils.extractContentFloor(mediaShares);
 
   return contentFloor ? contentFloor.disposition : null;
@@ -58,7 +58,7 @@ MediaSharesUtils.getContentDisposition = (mediaShares) => {
  * @param {Object} mediaShares
  * @returns {Boolean} disposition
  */
-MediaSharesUtils.getWhiteboardDisposition = (mediaShares) => {
+MediaSharesUtils.getWhiteboardDisposition = (mediaShares: object) => {
   const whiteboardFloor = MediaSharesUtils.extractWhiteboardFloor(mediaShares);
 
   return whiteboardFloor ? whiteboardFloor.disposition : null;
@@ -69,7 +69,7 @@ MediaSharesUtils.getWhiteboardDisposition = (mediaShares) => {
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.extractContent = (mediaShares) => {
+MediaSharesUtils.extractContent = (mediaShares: any) => {
   if (!mediaShares || !mediaShares.length) {
     return null;
   }
@@ -82,7 +82,7 @@ MediaSharesUtils.extractContent = (mediaShares) => {
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.extractWhiteboard = (mediaShares) => {
+MediaSharesUtils.extractWhiteboard = (mediaShares: any) => {
   if (!mediaShares || !mediaShares.length) {
     return null;
   }
@@ -95,7 +95,7 @@ MediaSharesUtils.extractWhiteboard = (mediaShares) => {
  * @param {Object} mediaStream
  * @returns {Object}
  */
-MediaSharesUtils.extractFloor = (mediaStream) => {
+MediaSharesUtils.extractFloor = (mediaStream: any) => {
   if (!mediaStream) {
     return null;
   }
@@ -108,7 +108,7 @@ MediaSharesUtils.extractFloor = (mediaStream) => {
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.extractContentFloor = (mediaShares) => {
+MediaSharesUtils.extractContentFloor = (mediaShares: object) => {
   const content = MediaSharesUtils.extractContent(mediaShares);
 
   return MediaSharesUtils.extractFloor(content);
@@ -119,7 +119,7 @@ MediaSharesUtils.extractContentFloor = (mediaShares) => {
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.extractWhiteboardFloor = (mediaShares) => {
+MediaSharesUtils.extractWhiteboardFloor = (mediaShares: object) => {
   const whiteboard = MediaSharesUtils.extractWhiteboard(mediaShares);
 
   return MediaSharesUtils.extractFloor(whiteboard);
@@ -130,7 +130,7 @@ MediaSharesUtils.extractWhiteboardFloor = (mediaShares) => {
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.getContentBeneficiaryId = (mediaShares) => {
+MediaSharesUtils.getContentBeneficiaryId = (mediaShares: object) => {
   const contentFloor = MediaSharesUtils.extractContentFloor(mediaShares);
 
   if (!contentFloor || !contentFloor.beneficiary) {
@@ -145,7 +145,7 @@ MediaSharesUtils.getContentBeneficiaryId = (mediaShares) => {
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.getWhiteboardBeneficiaryId = (mediaShares) => {
+MediaSharesUtils.getWhiteboardBeneficiaryId = (mediaShares: object) => {
   const whiteboardFloor = MediaSharesUtils.extractWhiteboardFloor(mediaShares);
 
   if (!whiteboardFloor || !whiteboardFloor.beneficiary) {
@@ -160,7 +160,7 @@ MediaSharesUtils.getWhiteboardBeneficiaryId = (mediaShares) => {
  * @param {Object} mediaShares
  * @returns {Object}
  */
-MediaSharesUtils.getWhiteboardResourceUrl = (mediaShares) => {
+MediaSharesUtils.getWhiteboardResourceUrl = (mediaShares: object) => {
   const whiteboard = MediaSharesUtils.extractWhiteboard(mediaShares);
 
   if (!whiteboard || !whiteboard.resourceUrl) {

package/src/locus-info/{parser.js → parser.ts}

@@ -13,7 +13,7 @@ export default class Parser {
   static status = {
     IDLE: 'IDLE',
     PAUSED: 'PAUSED',
-    WORKING: 'WORKING'
+    WORKING: 'WORKING',
   };
 
   // loci comparison states
@@ -24,21 +24,23 @@ export default class Parser {
     DESYNC: 'DESYNC',
     USE_INCOMING: 'USE_INCOMING',
     USE_CURRENT: 'USE_CURRENT',
-    ERROR: 'ERROR'
+    ERROR: 'ERROR',
   };
 
+  queue: any;
+  workingCopy: any;
 
   /**
    * @constructs Parser
    */
   constructor() {
     this.queue = new SimpleQueue();
+    // @ts-ignore - This is declared as static class member and again being initialized here from same
     this.status = Parser.status.IDLE;
     this.onDeltaAction = null;
     this.workingCopy = null;
   }
 
-
   /**
    * Checks if two sequences overlap in time,
    * the sequence with the higher minimum value is greater.
@@ -65,7 +67,6 @@ export default class Parser {
     return comparison;
   }
 
-
   /**
    * Checks if two sequences have unequal ranges.
    * Chooses sequence with most larger range.
@@ -91,8 +92,7 @@ export default class Parser {
       else if (currentTotalRange < incomingTotalRange) {
         // choose right side (incoming)
         comparison = `${Parser.loci.LT}:UR002`;
-      }
-      else {
+      } else {
         // with no unique entries and with ranges either absent or
         // of the same size, the sequences are considered equal.
         comparison = `${Parser.loci.EQ}:UR003`;
@@ -102,7 +102,6 @@ export default class Parser {
     return comparison;
   }
 
-
   /**
    * Checks if either sequences has unique entries.
    * Entries are considered unique if they do not overlap
@@ -131,7 +130,6 @@ export default class Parser {
     return comparison;
   }
 
-
   /**
    * Checks both Locus Delta objects to see if they are
    * out of sync with one another. If so sends a DESYNC
@@ -161,12 +159,10 @@ export default class Parser {
 
       // send DESYNC to server
       comparison = `${Parser.loci.DESYNC}:OOS001:${debugInfo}`;
-    }
-    else if (currentUniqueMin > incomingUniqueMin) {
+    } else if (currentUniqueMin > incomingUniqueMin) {
       // choose left side (current)
       comparison = `${Parser.loci.GT}:OOS002`;
-    }
-    else {
+    } else {
       // choose right side (incoming)
       comparison = `${Parser.loci.LT}:OOS003`;
     }
@@ -174,7 +170,6 @@ export default class Parser {
     return comparison;
   }
 
-
   /**
    * Compares two loci to determine which one contains the most recent state
    * @instance
@@ -188,7 +183,6 @@ export default class Parser {
     const {extractComparisonState: extract} = Parser;
     const {packComparisonResult: pack} = Parser;
 
-
     if (isSequenceEmpty(current) || isSequenceEmpty(incoming)) {
       return pack(Parser.loci.USE_INCOMING, 'C001');
     }
@@ -203,7 +197,6 @@ export default class Parser {
     return pack(action, result);
   }
 
-
   /**
    * Compares two loci sequences (with delta params) and indicates what action
    * to take.
@@ -214,17 +207,15 @@ export default class Parser {
    * @private
    * @returns {string} loci comparison state
    */
-  static compareDelta(current, incoming) {
-    const {
-      LT, GT, EQ, DESYNC, USE_INCOMING
-    } = Parser.loci;
+  private static compareDelta(current, incoming) {
+    const {LT, GT, EQ, DESYNC, USE_INCOMING} = Parser.loci;
+
     const {extractComparisonState: extract} = Parser;
     const {packComparisonResult: pack} = Parser;
 
     const result = Parser.compareSequence(current.sequence, incoming.sequence);
     let comparison = extract(result);
 
-
     if (comparison !== LT) {
       return pack(Parser.compareToAction(comparison), result);
     }
@@ -244,7 +235,6 @@ export default class Parser {
     return pack(comparison, result);
   }
 
-
   /**
    * Compares Locus sequences
    * @param {Types~Locus} current Current working copy
@@ -255,8 +245,8 @@ export default class Parser {
     // Locus sequence comparison rules in order of priority.
     // https://sqbu-github.cisco.com/WebExSquared/cloud-apps/wiki/Locus-Sequence-Comparison-Algorithm
 
-    const local = Parser.getMetaData(current);
-    const delta = Parser.getMetaData(incoming);
+    const local: any = Parser.getMetaData(current);
+    const delta: any = Parser.getMetaData(incoming);
 
     // update loci metadata
     local.unique = Parser.getUniqueSequences(local, delta);
@@ -268,7 +258,7 @@ export default class Parser {
       Parser.checkSequenceOverlap,
       Parser.checkUnequalRanges,
       Parser.checkForUniqueEntries,
-      Parser.checkIfOutOfSync
+      Parser.checkIfOutOfSync,
     ];
 
     for (const rule of rules) {
@@ -287,16 +277,13 @@ export default class Parser {
     return Parser.loci.ERROR;
   }
 
-
   /**
    * Transates the result of a sequence comparison into an intended behavior
    * @param {string} result
    * @returns {string} Locus comparison action
    */
-  static compareToAction(result) {
-    const {
-      DESYNC, EQ, ERROR, GT, LT, USE_CURRENT, USE_INCOMING
-    } = Parser.loci;
+  static compareToAction(result: string) {
+    const {DESYNC, EQ, ERROR, GT, LT, USE_CURRENT, USE_INCOMING} = Parser.loci;
 
     let action = ERROR;
 
@@ -312,23 +299,23 @@ export default class Parser {
         action = DESYNC;
         break;
       default:
-        LoggerProxy.logger.info(`Locus-info:parser#compareToAction --> Error: ${result} is not a recognized sequence comparison result.`);
+        LoggerProxy.logger.info(
+          `Locus-info:parser#compareToAction --> Error: ${result} is not a recognized sequence comparison result.`
+        );
     }
 
     return action;
   }
 
-
   /**
    * Extracts a loci comparison from a string of data.
    * @param {string} lociComparisonResult Comparison result with extra data
    * @returns {string} Comparison of EQ, LT, GT, or DESYNC.
    */
-  static extractComparisonState(lociComparisonResult) {
+  static extractComparisonState(lociComparisonResult: string) {
     return lociComparisonResult.split(':')[0];
   }
 
-
   /**
    * @typedef {object} LociMetadata
    * @property {number} start - Starting sequence number
@@ -345,7 +332,7 @@ export default class Parser {
    * @param {Array.<number>} sequence Locus delta sequence
    * @returns {LociMetadata} Locus Delta Metadata
    */
-  static getMetaData(sequence) {
+  static getMetaData(sequence: any) {
     const {entries} = sequence;
     const first = entries[0];
     const last = entries.slice(-1)[0];
@@ -365,11 +352,10 @@ export default class Parser {
       // Grab last entry if exist else default to rangeEnd
       max: last || end,
       // keep reference to actual sequence entries
-      entries
+      entries,
     };
   }
 
-
   /**
    * Compares two Locus delta objects and notes unique
    * values contained within baseLoci.
@@ -377,17 +363,14 @@ export default class Parser {
    * @param {LociMetadata} otherLoci
    * @returns {Array.<number>} List of unique sequences
    */
-  static getUniqueSequences(baseLoci, otherLoci) {
-    const diff = difference(
-      baseLoci.entries,
-      otherLoci.entries
-    );
+  static getUniqueSequences(baseLoci: any, otherLoci: any) {
+    const diff: any = difference(baseLoci.entries, otherLoci.entries);
+
     const {start, end} = otherLoci;
 
     return Parser.getNumbersOutOfRange(diff, start, end);
   }
 
-
   /**
    * Returns an array of numbers outside of a given range.
    * @param {Array.<number>} list Array to filter
@@ -395,7 +378,7 @@ export default class Parser {
    * @param {number} rangeEnd End of range
    * @returns {Array.<number>} Array of numbers sorted ASC
    */
-  static getNumbersOutOfRange(list, rangeStart, rangeEnd) {
+  static getNumbersOutOfRange(list: Array<number>, rangeStart: number, rangeEnd: number) {
     // Collect all numbers if number is outside of specified range
     const output = list.filter((num) => num < rangeStart || num > rangeEnd);
 
@@ -403,7 +386,6 @@ export default class Parser {
     return output.sort((a, b) => a - b);
   }
 
-
   /**
    * Checks if newLoci or workingCopy is invalid.
    * @param {Types~Locus} newLoci
@@ -413,21 +395,28 @@ export default class Parser {
     let isValid = false;
     const {IDLE} = Parser.status;
     const {isLoci} = Parser;
-    const setStatus = (status) => { this.status = status; };
+    // @ts-ignore
+    const setStatus = (status) => {
+      // @ts-ignore
+      this.status = status;
+    };
 
     // one or both objects are not locus delta events
     if (!isLoci(this.workingCopy) || !isLoci(newLoci)) {
       setStatus(IDLE);
-      LoggerProxy.logger.info('Locus-info:parser#processDeltaEvent --> Ignoring non-locus object. workingCopy:', this.workingCopy, 'newLoci:', newLoci);
-    }
-    else {
+      LoggerProxy.logger.info(
+        'Locus-info:parser#processDeltaEvent --> Ignoring non-locus object. workingCopy:',
+        this.workingCopy,
+        'newLoci:',
+        newLoci
+      );
+    } else {
       isValid = true;
     }
 
     return isValid;
   }
 
-
   /**
    * Determines if a paricular locus's sequence is empty
    * @param {Types~Locus} locus
@@ -441,7 +430,6 @@ export default class Parser {
     return hasEmptyEntries && hasEmptyRange;
   }
 
-
   /**
    * Determines if an object has basic
    * structure of a locus object.
@@ -452,8 +440,7 @@ export default class Parser {
     if (!loci || !loci.sequence) {
       return false;
     }
-    const hasProp = (prop) =>
-      Object.prototype.hasOwnProperty.call(loci.sequence, prop);
+    const hasProp = (prop) => Object.prototype.hasOwnProperty.call(loci.sequence, prop);
 
     if (hasProp('rangeStart') && hasProp('rangeEnd')) {
       return true;
@@ -468,6 +455,7 @@ export default class Parser {
    * @returns {undefined}
    */
   nextEvent() {
+    // @ts-ignore
     if (this.status === Parser.status.PAUSED) {
       LoggerProxy.logger.info('Locus-info:parser#nextEvent --> Locus parser paused.');
 
@@ -477,13 +465,12 @@ export default class Parser {
     // continue processing until queue is empty
     if (this.queue.size() > 0) {
       this.processDeltaEvent();
-    }
-    else {
+    } else {
+      // @ts-ignore
       this.status = Parser.status.IDLE;
     }
   }
 
-
   /**
    * Function handler for delta actions,
    * is set by instance callee.
@@ -492,8 +479,7 @@ export default class Parser {
    * @returns {undefined}
    */
   // eslint-disable-next-line no-unused-vars
-  onDeltaAction(action, locus) {}
-
+  onDeltaAction(action: string, locus) {}
 
   /**
    * Event handler for locus delta events
@@ -505,36 +491,36 @@ export default class Parser {
     this.queue.enqueue(loci);
     // start processing events in the queue if idle
     // and a function handler is defined
+    // @ts-ignore
     if (this.status === Parser.status.IDLE && this.onDeltaAction) {
       // Update status, ensure we only process one event at a time.
+      // @ts-ignore
       this.status = Parser.status.WORKING;
 
       this.processDeltaEvent();
     }
   }
 
-
   /**
    * Appends new data onto a string of existing data.
    * @param {string} newData
    * @param {string} oldData
    * @returns {string}
    */
-  static packComparisonResult(newData, oldData) {
+  static packComparisonResult(newData: string, oldData: string) {
     return `${newData}:${oldData}`;
   }
 
-
   /**
    * Pause locus processing
    * @returns {undefined}
    */
   pause() {
+    // @ts-ignore
     this.status = Parser.status.PAUSED;
     LoggerProxy.logger.info('Locus-info:parser#pause --> Locus parser paused.');
   }
 
-
   /**
    * Processes next locus delta in the queue,
    * continues until the queue is empty
@@ -560,8 +546,7 @@ export default class Parser {
     if (lociComparison === DESYNC) {
       // wait for desync response
       this.pause();
-    }
-    else if (lociComparison === USE_INCOMING) {
+    } else if (lociComparison === USE_INCOMING) {
       // update working copy for future comparisons.
       // Note: The working copy of parser gets updated in .onFullLocus()
       // and here when USE_INCOMING locus.
@@ -569,39 +554,42 @@ export default class Parser {
     }
 
     if (this.onDeltaAction) {
-      LoggerProxy.logger.info(`Locus-info:parser#processDeltaEvent --> Locus Delta Action: ${lociComparison}`);
+      LoggerProxy.logger.info(
+        `Locus-info:parser#processDeltaEvent --> Locus Delta Action: ${lociComparison}`
+      );
+
+      // eslint-disable-next-line no-useless-call
       this.onDeltaAction.call(this, lociComparison, newLoci);
     }
 
     this.nextEvent();
   }
 
-
   /**
    * Resume from a paused state
    * @returns {undefined}
    */
   resume() {
     LoggerProxy.logger.info('Locus-info:parser#resume --> Locus parser resumed.');
+    // @ts-ignore
     this.status = Parser.status.WORKING;
     this.nextEvent();
   }
 
-
   /**
    * Gets related debug info for given error code
    * @param {string} debugCode Debug code
    * @param {string} comparison Locus comparison string
    * @returns {object} Debug message
    */
-  static getDebugMessage(debugCode, comparison) {
+  static getDebugMessage(debugCode: string, comparison: string) {
     // removes extra spaces from multiline string
     const mStr = (strings) => strings.join('').replace(/\s{2,}/g, ' ');
 
     const resolutionMap = {
       EQ: `${Parser.loci.LT}: is equal (current == incoming).`,
       LT: `${Parser.loci.LT}: choose right side (incoming).`,
-      GT: `${Parser.loci.GT}: choose left side (current).`
+      GT: `${Parser.loci.GT}: choose left side (current).`,
     };
 
     const debugMap = {
@@ -609,28 +597,28 @@ export default class Parser {
         title: 'checkSequenceOverlap-001',
         description: mStr`Occurs if earliest working copy sequence is more \
             recent than last incoming sequence.`,
-        logic: 'current.min > incoming.max'
+        logic: 'current.min > incoming.max',
       },
 
       SO002: {
         title: 'checkSequenceOverlap-002',
         description: mStr`Occurs if last working copy sequence is before the \
           earliest incoming sequence.`,
-        logic: 'current.max < incoming.min'
+        logic: 'current.max < incoming.min',
       },
 
       UR001: {
         title: 'checkUnequalRanges-001',
         description: mStr`Occurs if there are no unique values for both loci, \
           and the current working copy loci has a larger range.`,
-        logic: 'currentTotalRange > incomingTotalRange'
+        logic: 'currentTotalRange > incomingTotalRange',
       },
 
       UR002: {
         title: 'checkUnequalRanges-002',
         description: mStr`Occurs if there are no unique values for both loci, \
           and the incoming delta loci has a larger range.`,
-        logic: 'currentTotalRange < incomingTotalRange'
+        logic: 'currentTotalRange < incomingTotalRange',
       },
 
       UR003: {
@@ -638,7 +626,7 @@ export default class Parser {
         description: mStr`Occurs if there are no unique values for both loci, \
           and with ranges either absent or of the same size, the sequences \
           are considered equal.`,
-        logic: 'currentTotalRange == incomingTotalRange'
+        logic: 'currentTotalRange == incomingTotalRange',
       },
 
       UE001: {
@@ -646,7 +634,7 @@ export default class Parser {
         description: mStr`Occurs if current loci has unique entries and \
           incoming does not. Entries are considered unique if they \
           do not overlap with other Loci sequences or range values.`,
-        logic: 'currentIsUnique && !incomingIsUnique'
+        logic: 'currentIsUnique && !incomingIsUnique',
       },
 
       UE002: {
@@ -654,7 +642,7 @@ export default class Parser {
         description: mStr`Occurs if current has no unique entries but \
           incoming does. Entries are considered unique if they \
           do not overlap with other Loci sequences or range values.`,
-        logic: '!currentIsUnique && incomingIsUnique'
+        logic: '!currentIsUnique && incomingIsUnique',
       },
 
       OOS001: {
@@ -663,7 +651,7 @@ export default class Parser {
           if the current loci unique entries overlap the total range of the \
           incoming sequence, or if the incoming unique entries overlap \
           the total range of current sequence.`,
-        logic: 'neitherSeqHasRange || currentUniqOverlap || incomingUniqOverlap'
+        logic: 'neitherSeqHasRange || currentUniqOverlap || incomingUniqOverlap',
       },
 
       OOS002: {
@@ -671,15 +659,15 @@ export default class Parser {
         description: mStr`Occurs if the minimum value from sequences that are \
           unique to the current loci is greater than the minimum value from \
           sequences that are unique to the incoming loci.`,
-        logic: 'currentUniqueMin > incomingUniqueMin'
+        logic: 'currentUniqueMin > incomingUniqueMin',
       },
 
       OOS003: {
         title: 'checkIfOutOfSync-003',
         description: mStr`Occurs if none of the comparison rules applied. \
           It is a catch all.`,
-        logic: 'else (catch all)'
-      }
+        logic: 'else (catch all)',
+      },
     };
 
     const debugObj = debugMap[debugCode];