@webex/internal-plugin-presence 3.4.0-next.2 → 3.4.0-next.4

package/dist/presence.js

@@ -232,6 +232,7 @@ var Presence = _webexCore.WebexPlugin.extend({
       body: {
         subject: this.webex.internal.device.userId,
         eventType: status,
+        label: this.webex.internal.device.userId,
         ttl: ttl
       }
     }).then(function (response) {
@@ -254,7 +255,7 @@ var Presence = _webexCore.WebexPlugin.extend({
   dequeue: function dequeue(id) {
     return this.worker.dequeue(id);
   },
-  version: "3.4.0-next.2"
+  version: "3.4.0-next.4"
 });
 var _default2 = exports.default = Presence;
 //# sourceMappingURL=presence.js.map

package/dist/presence.js.map

@@ -1 +1 @@
-{"version":3,"names":["require","_webexCore","_presenceBatcher","_interopRequireDefault","_presenceWorker","defaultSubscriptionTtl","USER","USER_PRESENCE_ENABLED","Presence","WebexPlugin","extend","namespace","children","batcher","PresenceBatcher","session","worker","default","_default","PresenceWorker","type","initialize","_this","webex","once","config","initializeWorker","emitEvent","event","payload","trigger","enable","internal","feature","setFeature","then","response","value","disable","isEnabled","getFeature","get","personId","_promise","reject","Error","request","method","service","resource","concat","body","list","personIds","_this2","_isArray","all","map","id","presences","statusList","subscribe","_this3","subscriptionTtl","arguments","length","undefined","subjects","batches","batchLimit","i","push","slice","ids","api","includeStatus","responses","idBatches","_ref","apply","_toConsumableArray2","unsubscribe","setStatus","status","ttl","subject","device","userId","eventType","enqueue","dequeue","version","_default2","exports"],"sources":["presence.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport '@webex/internal-plugin-device';\n\nimport {WebexPlugin} from '@webex/webex-core';\n\nimport PresenceBatcher from './presence-batcher';\nimport PresenceWorker from './presence-worker';\n\nconst defaultSubscriptionTtl = 600;\nconst USER = 'user';\nconst USER_PRESENCE_ENABLED = 'user-presence-enabled';\n\n/**\n * @class\n * @extends WebexPlugin\n */\nconst Presence = WebexPlugin.extend({\n  namespace: 'Presence',\n\n  children: {\n    batcher: PresenceBatcher,\n  },\n\n  session: {\n    worker: {\n      default() {\n        return new PresenceWorker();\n      },\n      type: 'any',\n    },\n  },\n\n  /**\n   * Initialize the presence worker for client\n   * @returns {undefined}\n   */\n  initialize() {\n    this.webex.once('ready', () => {\n      if (this.config.initializeWorker) {\n        this.worker.initialize(this.webex);\n      }\n    });\n  },\n\n  /**\n   * Trigger an event.\n   * @param {string} event\n   * @param {string} payload\n   * @returns {undefined}\n   */\n  emitEvent(event, payload) {\n    if (payload.type && payload.payload) {\n      this.trigger(event, payload);\n    }\n  },\n\n  /**\n   * Enables presence feature\n   * @returns {Promise<boolean>} resolves with true, if successful\n   */\n  enable() {\n    return this.webex.internal.feature\n      .setFeature(USER, USER_PRESENCE_ENABLED, true)\n      .then((response) => response.value);\n  },\n\n  /**\n   * Disables presence feature\n   * @returns {Promise<boolean>} resolves with false, if successful\n   */\n  disable() {\n    return this.webex.internal.feature\n      .setFeature(USER, USER_PRESENCE_ENABLED, false)\n      .then((response) => response.value);\n  },\n\n  /**\n   * Returns true if presence is enabled, false otherwise\n   * @returns {Promise<boolean>} resolves with true if presence is enabled\n   */\n  isEnabled() {\n    return this.webex.internal.feature.getFeature(USER, USER_PRESENCE_ENABLED);\n  },\n\n  /**\n   * The status object\n   * @typedef {Object} PresenceStatusObject\n   * @property {string} url: Public resource identifier for presence\n   * @property {string} subject: User ID for the user the returned composed presence represents\n   * @property {string} status: Current composed presence state\n   * @property {string} statusTime: DateTime in RFC3339 format that the current status began\n   * @property {string} lastActive: DateTime in RFC3339 format that the service last saw activity from the user.\n   * @property {string} expires: DEPRECATED - DateTime in RFC3339 format that represents when the current\n   * status will expire. Will not exist if expiresTTL is -1.\n   * @property {Number} expiresTTL: TTL in seconds until the status will expire. If TTL is -1 the current\n   * status has no known expiration.\n   * @property {string} expiresTime: DateTime in RFC3339 format that the current status will expire. Missing\n   * field means no known expiration.\n   * @property {Object} vectorCounters: Used for packet ordering and tracking.\n   * @property {Boolean} suppressNotifications: Indicates if notification suppression is recommended for this status.\n   * @property {string} lastSeenDeviceUrl: Resource Identifier of the last device to post presence activity for\n   * this user.\n   */\n\n  /**\n   * Gets the current presence status of a given person id\n   * @param {string} personId\n   * @returns {Promise<PresenceStatusObject>} resolves with status object of person\n   */\n  get(personId) {\n    if (!personId) {\n      return Promise.reject(new Error('A person id is required'));\n    }\n\n    return this.webex\n      .request({\n        method: 'GET',\n        service: 'apheleia',\n        resource: `compositions?userId=${personId}`,\n      })\n      .then((response) => response.body);\n  },\n\n  /**\n   * @typedef {Object} PresenceStatusesObject\n   * @property {Array.<PresenceStatusObject>} statusList\n   */\n  /**\n   * Gets the current presence statuses of an array of people ids\n   * @param {Array} personIds\n   * @returns {Promise<PresenceStatusesObject>} resolves with an object with key of `statusList` array\n   */\n  list(personIds) {\n    if (!personIds || !Array.isArray(personIds)) {\n      return Promise.reject(new Error('An array of person ids is required'));\n    }\n\n    return Promise.all(personIds.map((id) => this.batcher.request(id))).then((presences) => ({\n      statusList: presences,\n    }));\n  },\n\n  /**\n   * Subscribes to a person's presence status updates\n   * Updates are sent via mercury events `apheleia.subscription_update`\n   * @param {string | Array} personIds\n   * @param {number} subscriptionTtl - Requested length of subscriptions in seconds.\n   * @returns {Promise}\n   */\n  subscribe(personIds, subscriptionTtl = defaultSubscriptionTtl) {\n    let subjects;\n    const batches = [];\n    const batchLimit = 50;\n\n    if (!personIds) {\n      return Promise.reject(new Error('A person id is required'));\n    }\n    if (Array.isArray(personIds)) {\n      subjects = personIds;\n    } else {\n      subjects = [personIds];\n    }\n    // Limit batches to 50 ids per request\n    for (let i = 0; i < subjects.length; i += batchLimit) {\n      batches.push(subjects.slice(i, i + batchLimit));\n    }\n\n    return Promise.all(\n      batches.map((ids) =>\n        this.webex\n          .request({\n            method: 'POST',\n            api: 'apheleia',\n            resource: 'subscriptions',\n            body: {\n              subjects: ids,\n              subscriptionTtl,\n              includeStatus: true,\n            },\n          })\n          .then((response) => response.body.responses)\n      )\n    ).then((idBatches) => ({responses: [].concat(...idBatches)}));\n  },\n\n  /**\n   * Unsubscribes from a person or group of people's presence subscription\n   * @param {string | Array} personIds\n   * @returns {Promise}\n   */\n  unsubscribe(personIds) {\n    let subjects;\n\n    if (!personIds) {\n      return Promise.reject(new Error('A person id is required'));\n    }\n    if (Array.isArray(personIds)) {\n      subjects = personIds;\n    } else {\n      subjects = [personIds];\n    }\n\n    return this.webex.request({\n      method: 'POST',\n      api: 'apheleia',\n      resource: 'subscriptions',\n      body: {\n        subjects,\n        subscriptionTtl: 0,\n        includeStatus: true,\n      },\n    });\n  },\n\n  /**\n   * Sets the status of the current user\n   * @param {string} status - active | inactive | ooo | dnd\n   * @param {number} ttl - Time To Live for the event in seconds.\n   * @returns {Promise}\n   */\n  setStatus(status, ttl) {\n    if (!status) {\n      return Promise.reject(new Error('A status is required'));\n    }\n\n    return this.webex\n      .request({\n        method: 'POST',\n        api: 'apheleia',\n        resource: 'events',\n        body: {\n          subject: this.webex.internal.device.userId,\n          eventType: status,\n          ttl,\n        },\n      })\n      .then((response) => response.body);\n  },\n\n  /**\n   * Retrieves and subscribes to a user's presence.\n   * @param {string} id\n   * @returns {undefined}\n   */\n  enqueue(id) {\n    return this.worker.enqueue(id);\n  },\n\n  /**\n   * Retract from subscribing to a user's presence.\n   * @param {string} id\n   * @returns {undefined}\n   */\n  dequeue(id) {\n    return this.worker.dequeue(id);\n  },\n});\n\nexport default Presence;\n"],"mappings":";;;;;;;;;;;AAIAA,OAAA;AAEA,IAAAC,UAAA,GAAAD,OAAA;AAEA,IAAAE,gBAAA,GAAAC,sBAAA,CAAAH,OAAA;AACA,IAAAI,eAAA,GAAAD,sBAAA,CAAAH,OAAA;AATA;AACA;AACA;;AASA,IAAMK,sBAAsB,GAAG,GAAG;AAClC,IAAMC,IAAI,GAAG,MAAM;AACnB,IAAMC,qBAAqB,GAAG,uBAAuB;;AAErD;AACA;AACA;AACA;AACA,IAAMC,QAAQ,GAAGC,sBAAW,CAACC,MAAM,CAAC;EAClCC,SAAS,EAAE,UAAU;EAErBC,QAAQ,EAAE;IACRC,OAAO,EAAEC;EACX,CAAC;EAEDC,OAAO,EAAE;IACPC,MAAM,EAAE;MACNC,OAAO,WAAAC,SAAA,EAAG;QACR,OAAO,IAAIC,uBAAc,CAAC,CAAC;MAC7B,CAAC;MACDC,IAAI,EAAE;IACR;EACF,CAAC;EAED;AACF;AACA;AACA;EACEC,UAAU,WAAAA,WAAA,EAAG;IAAA,IAAAC,KAAA;IACX,IAAI,CAACC,KAAK,CAACC,IAAI,CAAC,OAAO,EAAE,YAAM;MAC7B,IAAIF,KAAI,CAACG,MAAM,CAACC,gBAAgB,EAAE;QAChCJ,KAAI,CAACN,MAAM,CAACK,UAAU,CAACC,KAAI,CAACC,KAAK,CAAC;MACpC;IACF,CAAC,CAAC;EACJ,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACEI,SAAS,WAAAA,UAACC,KAAK,EAAEC,OAAO,EAAE;IACxB,IAAIA,OAAO,CAACT,IAAI,IAAIS,OAAO,CAACA,OAAO,EAAE;MACnC,IAAI,CAACC,OAAO,CAACF,KAAK,EAAEC,OAAO,CAAC;IAC9B;EACF,CAAC;EAED;AACF;AACA;AACA;EACEE,MAAM,WAAAA,OAAA,EAAG;IACP,OAAO,IAAI,CAACR,KAAK,CAACS,QAAQ,CAACC,OAAO,CAC/BC,UAAU,CAAC5B,IAAI,EAAEC,qBAAqB,EAAE,IAAI,CAAC,CAC7C4B,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACC,KAAK;IAAA,EAAC;EACvC,CAAC;EAED;AACF;AACA;AACA;EACEC,OAAO,WAAAA,QAAA,EAAG;IACR,OAAO,IAAI,CAACf,KAAK,CAACS,QAAQ,CAACC,OAAO,CAC/BC,UAAU,CAAC5B,IAAI,EAAEC,qBAAqB,EAAE,KAAK,CAAC,CAC9C4B,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACC,KAAK;IAAA,EAAC;EACvC,CAAC;EAED;AACF;AACA;AACA;EACEE,SAAS,WAAAA,UAAA,EAAG;IACV,OAAO,IAAI,CAAChB,KAAK,CAACS,QAAQ,CAACC,OAAO,CAACO,UAAU,CAAClC,IAAI,EAAEC,qBAAqB,CAAC;EAC5E,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAEE;AACF;AACA;AACA;AACA;EACEkC,GAAG,WAAAA,IAACC,QAAQ,EAAE;IACZ,IAAI,CAACA,QAAQ,EAAE;MACb,OAAOC,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7D;IAEA,OAAO,IAAI,CAACtB,KAAK,CACduB,OAAO,CAAC;MACPC,MAAM,EAAE,KAAK;MACbC,OAAO,EAAE,UAAU;MACnBC,QAAQ,yBAAAC,MAAA,CAAyBR,QAAQ;IAC3C,CAAC,CAAC,CACDP,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACe,IAAI;IAAA,EAAC;EACtC,CAAC;EAED;AACF;AACA;AACA;EACE;AACF;AACA;AACA;AACA;EACEC,IAAI,WAAAA,KAACC,SAAS,EAAE;IAAA,IAAAC,MAAA;IACd,IAAI,CAACD,SAAS,IAAI,CAAC,IAAAE,QAAA,CAAAtC,OAAA,EAAcoC,SAAS,CAAC,EAAE;MAC3C,OAAOV,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxE;IAEA,OAAOF,QAAA,CAAA1B,OAAA,CAAQuC,GAAG,CAACH,SAAS,CAACI,GAAG,CAAC,UAACC,EAAE;MAAA,OAAKJ,MAAI,CAACzC,OAAO,CAACiC,OAAO,CAACY,EAAE,CAAC;IAAA,EAAC,CAAC,CAACvB,IAAI,CAAC,UAACwB,SAAS;MAAA,OAAM;QACvFC,UAAU,EAAED;MACd,CAAC;IAAA,CAAC,CAAC;EACL,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,SAAS,WAAAA,UAACR,SAAS,EAA4C;IAAA,IAAAS,MAAA;IAAA,IAA1CC,eAAe,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG3D,sBAAsB;IAC3D,IAAI8D,QAAQ;IACZ,IAAMC,OAAO,GAAG,EAAE;IAClB,IAAMC,UAAU,GAAG,EAAE;IAErB,IAAI,CAAChB,SAAS,EAAE;MACd,OAAOV,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7D;IACA,IAAI,IAAAU,QAAA,CAAAtC,OAAA,EAAcoC,SAAS,CAAC,EAAE;MAC5Bc,QAAQ,GAAGd,SAAS;IACtB,CAAC,MAAM;MACLc,QAAQ,GAAG,CAACd,SAAS,CAAC;IACxB;IACA;IACA,KAAK,IAAIiB,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGH,QAAQ,CAACF,MAAM,EAAEK,CAAC,IAAID,UAAU,EAAE;MACpDD,OAAO,CAACG,IAAI,CAACJ,QAAQ,CAACK,KAAK,CAACF,CAAC,EAAEA,CAAC,GAAGD,UAAU,CAAC,CAAC;IACjD;IAEA,OAAO1B,QAAA,CAAA1B,OAAA,CAAQuC,GAAG,CAChBY,OAAO,CAACX,GAAG,CAAC,UAACgB,GAAG;MAAA,OACdX,MAAI,CAACvC,KAAK,CACPuB,OAAO,CAAC;QACPC,MAAM,EAAE,MAAM;QACd2B,GAAG,EAAE,UAAU;QACfzB,QAAQ,EAAE,eAAe;QACzBE,IAAI,EAAE;UACJgB,QAAQ,EAAEM,GAAG;UACbV,eAAe,EAAfA,eAAe;UACfY,aAAa,EAAE;QACjB;MACF,CAAC,CAAC,CACDxC,IAAI,CAAC,UAACC,QAAQ;QAAA,OAAKA,QAAQ,CAACe,IAAI,CAACyB,SAAS;MAAA,EAAC;IAAA,CAChD,CACF,CAAC,CAACzC,IAAI,CAAC,UAAC0C,SAAS;MAAA,IAAAC,IAAA;MAAA,OAAM;QAACF,SAAS,EAAE,CAAAE,IAAA,KAAE,EAAC5B,MAAM,CAAA6B,KAAA,CAAAD,IAAA,MAAAE,mBAAA,CAAA/D,OAAA,EAAI4D,SAAS;MAAC,CAAC;IAAA,CAAC,CAAC;EAC/D,CAAC;EAED;AACF;AACA;AACA;AACA;EACEI,WAAW,WAAAA,YAAC5B,SAAS,EAAE;IACrB,IAAIc,QAAQ;IAEZ,IAAI,CAACd,SAAS,EAAE;MACd,OAAOV,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7D;IACA,IAAI,IAAAU,QAAA,CAAAtC,OAAA,EAAcoC,SAAS,CAAC,EAAE;MAC5Bc,QAAQ,GAAGd,SAAS;IACtB,CAAC,MAAM;MACLc,QAAQ,GAAG,CAACd,SAAS,CAAC;IACxB;IAEA,OAAO,IAAI,CAAC9B,KAAK,CAACuB,OAAO,CAAC;MACxBC,MAAM,EAAE,MAAM;MACd2B,GAAG,EAAE,UAAU;MACfzB,QAAQ,EAAE,eAAe;MACzBE,IAAI,EAAE;QACJgB,QAAQ,EAARA,QAAQ;QACRJ,eAAe,EAAE,CAAC;QAClBY,aAAa,EAAE;MACjB;IACF,CAAC,CAAC;EACJ,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACEO,SAAS,WAAAA,UAACC,MAAM,EAAEC,GAAG,EAAE;IACrB,IAAI,CAACD,MAAM,EAAE;MACX,OAAOxC,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1D;IAEA,OAAO,IAAI,CAACtB,KAAK,CACduB,OAAO,CAAC;MACPC,MAAM,EAAE,MAAM;MACd2B,GAAG,EAAE,UAAU;MACfzB,QAAQ,EAAE,QAAQ;MAClBE,IAAI,EAAE;QACJkC,OAAO,EAAE,IAAI,CAAC9D,KAAK,CAACS,QAAQ,CAACsD,MAAM,CAACC,MAAM;QAC1CC,SAAS,EAAEL,MAAM;QACjBC,GAAG,EAAHA;MACF;IACF,CAAC,CAAC,CACDjD,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACe,IAAI;IAAA,EAAC;EACtC,CAAC;EAED;AACF;AACA;AACA;AACA;EACEsC,OAAO,WAAAA,QAAC/B,EAAE,EAAE;IACV,OAAO,IAAI,CAAC1C,MAAM,CAACyE,OAAO,CAAC/B,EAAE,CAAC;EAChC,CAAC;EAED;AACF;AACA;AACA;AACA;EACEgC,OAAO,WAAAA,QAAChC,EAAE,EAAE;IACV,OAAO,IAAI,CAAC1C,MAAM,CAAC0E,OAAO,CAAChC,EAAE,CAAC;EAChC,CAAC;EAAAiC,OAAA;AACH,CAAC,CAAC;AAAC,IAAAC,SAAA,GAAAC,OAAA,CAAA5E,OAAA,GAEYT,QAAQ"}
+{"version":3,"names":["require","_webexCore","_presenceBatcher","_interopRequireDefault","_presenceWorker","defaultSubscriptionTtl","USER","USER_PRESENCE_ENABLED","Presence","WebexPlugin","extend","namespace","children","batcher","PresenceBatcher","session","worker","default","_default","PresenceWorker","type","initialize","_this","webex","once","config","initializeWorker","emitEvent","event","payload","trigger","enable","internal","feature","setFeature","then","response","value","disable","isEnabled","getFeature","get","personId","_promise","reject","Error","request","method","service","resource","concat","body","list","personIds","_this2","_isArray","all","map","id","presences","statusList","subscribe","_this3","subscriptionTtl","arguments","length","undefined","subjects","batches","batchLimit","i","push","slice","ids","api","includeStatus","responses","idBatches","_ref","apply","_toConsumableArray2","unsubscribe","setStatus","status","ttl","subject","device","userId","eventType","label","enqueue","dequeue","version","_default2","exports"],"sources":["presence.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport '@webex/internal-plugin-device';\n\nimport {WebexPlugin} from '@webex/webex-core';\n\nimport PresenceBatcher from './presence-batcher';\nimport PresenceWorker from './presence-worker';\n\nconst defaultSubscriptionTtl = 600;\nconst USER = 'user';\nconst USER_PRESENCE_ENABLED = 'user-presence-enabled';\n\n/**\n * @class\n * @extends WebexPlugin\n */\nconst Presence = WebexPlugin.extend({\n  namespace: 'Presence',\n\n  children: {\n    batcher: PresenceBatcher,\n  },\n\n  session: {\n    worker: {\n      default() {\n        return new PresenceWorker();\n      },\n      type: 'any',\n    },\n  },\n\n  /**\n   * Initialize the presence worker for client\n   * @returns {undefined}\n   */\n  initialize() {\n    this.webex.once('ready', () => {\n      if (this.config.initializeWorker) {\n        this.worker.initialize(this.webex);\n      }\n    });\n  },\n\n  /**\n   * Trigger an event.\n   * @param {string} event\n   * @param {string} payload\n   * @returns {undefined}\n   */\n  emitEvent(event, payload) {\n    if (payload.type && payload.payload) {\n      this.trigger(event, payload);\n    }\n  },\n\n  /**\n   * Enables presence feature\n   * @returns {Promise<boolean>} resolves with true, if successful\n   */\n  enable() {\n    return this.webex.internal.feature\n      .setFeature(USER, USER_PRESENCE_ENABLED, true)\n      .then((response) => response.value);\n  },\n\n  /**\n   * Disables presence feature\n   * @returns {Promise<boolean>} resolves with false, if successful\n   */\n  disable() {\n    return this.webex.internal.feature\n      .setFeature(USER, USER_PRESENCE_ENABLED, false)\n      .then((response) => response.value);\n  },\n\n  /**\n   * Returns true if presence is enabled, false otherwise\n   * @returns {Promise<boolean>} resolves with true if presence is enabled\n   */\n  isEnabled() {\n    return this.webex.internal.feature.getFeature(USER, USER_PRESENCE_ENABLED);\n  },\n\n  /**\n   * The status object\n   * @typedef {Object} PresenceStatusObject\n   * @property {string} url: Public resource identifier for presence\n   * @property {string} subject: User ID for the user the returned composed presence represents\n   * @property {string} status: Current composed presence state\n   * @property {string} statusTime: DateTime in RFC3339 format that the current status began\n   * @property {string} lastActive: DateTime in RFC3339 format that the service last saw activity from the user.\n   * @property {string} expires: DEPRECATED - DateTime in RFC3339 format that represents when the current\n   * status will expire. Will not exist if expiresTTL is -1.\n   * @property {Number} expiresTTL: TTL in seconds until the status will expire. If TTL is -1 the current\n   * status has no known expiration.\n   * @property {string} expiresTime: DateTime in RFC3339 format that the current status will expire. Missing\n   * field means no known expiration.\n   * @property {Object} vectorCounters: Used for packet ordering and tracking.\n   * @property {Boolean} suppressNotifications: Indicates if notification suppression is recommended for this status.\n   * @property {string} lastSeenDeviceUrl: Resource Identifier of the last device to post presence activity for\n   * this user.\n   */\n\n  /**\n   * Gets the current presence status of a given person id\n   * @param {string} personId\n   * @returns {Promise<PresenceStatusObject>} resolves with status object of person\n   */\n  get(personId) {\n    if (!personId) {\n      return Promise.reject(new Error('A person id is required'));\n    }\n\n    return this.webex\n      .request({\n        method: 'GET',\n        service: 'apheleia',\n        resource: `compositions?userId=${personId}`,\n      })\n      .then((response) => response.body);\n  },\n\n  /**\n   * @typedef {Object} PresenceStatusesObject\n   * @property {Array.<PresenceStatusObject>} statusList\n   */\n  /**\n   * Gets the current presence statuses of an array of people ids\n   * @param {Array} personIds\n   * @returns {Promise<PresenceStatusesObject>} resolves with an object with key of `statusList` array\n   */\n  list(personIds) {\n    if (!personIds || !Array.isArray(personIds)) {\n      return Promise.reject(new Error('An array of person ids is required'));\n    }\n\n    return Promise.all(personIds.map((id) => this.batcher.request(id))).then((presences) => ({\n      statusList: presences,\n    }));\n  },\n\n  /**\n   * Subscribes to a person's presence status updates\n   * Updates are sent via mercury events `apheleia.subscription_update`\n   * @param {string | Array} personIds\n   * @param {number} subscriptionTtl - Requested length of subscriptions in seconds.\n   * @returns {Promise}\n   */\n  subscribe(personIds, subscriptionTtl = defaultSubscriptionTtl) {\n    let subjects;\n    const batches = [];\n    const batchLimit = 50;\n\n    if (!personIds) {\n      return Promise.reject(new Error('A person id is required'));\n    }\n    if (Array.isArray(personIds)) {\n      subjects = personIds;\n    } else {\n      subjects = [personIds];\n    }\n    // Limit batches to 50 ids per request\n    for (let i = 0; i < subjects.length; i += batchLimit) {\n      batches.push(subjects.slice(i, i + batchLimit));\n    }\n\n    return Promise.all(\n      batches.map((ids) =>\n        this.webex\n          .request({\n            method: 'POST',\n            api: 'apheleia',\n            resource: 'subscriptions',\n            body: {\n              subjects: ids,\n              subscriptionTtl,\n              includeStatus: true,\n            },\n          })\n          .then((response) => response.body.responses)\n      )\n    ).then((idBatches) => ({responses: [].concat(...idBatches)}));\n  },\n\n  /**\n   * Unsubscribes from a person or group of people's presence subscription\n   * @param {string | Array} personIds\n   * @returns {Promise}\n   */\n  unsubscribe(personIds) {\n    let subjects;\n\n    if (!personIds) {\n      return Promise.reject(new Error('A person id is required'));\n    }\n    if (Array.isArray(personIds)) {\n      subjects = personIds;\n    } else {\n      subjects = [personIds];\n    }\n\n    return this.webex.request({\n      method: 'POST',\n      api: 'apheleia',\n      resource: 'subscriptions',\n      body: {\n        subjects,\n        subscriptionTtl: 0,\n        includeStatus: true,\n      },\n    });\n  },\n\n  /**\n   * Sets the status of the current user\n   * @param {string} status - active | inactive | ooo | dnd\n   * @param {number} ttl - Time To Live for the event in seconds.\n   * @returns {Promise}\n   */\n  setStatus(status, ttl) {\n    if (!status) {\n      return Promise.reject(new Error('A status is required'));\n    }\n\n    return this.webex\n      .request({\n        method: 'POST',\n        api: 'apheleia',\n        resource: 'events',\n        body: {\n          subject: this.webex.internal.device.userId,\n          eventType: status,\n          label: this.webex.internal.device.userId,\n          ttl,\n        },\n      })\n      .then((response) => response.body);\n  },\n\n  /**\n   * Retrieves and subscribes to a user's presence.\n   * @param {string} id\n   * @returns {undefined}\n   */\n  enqueue(id) {\n    return this.worker.enqueue(id);\n  },\n\n  /**\n   * Retract from subscribing to a user's presence.\n   * @param {string} id\n   * @returns {undefined}\n   */\n  dequeue(id) {\n    return this.worker.dequeue(id);\n  },\n});\n\nexport default Presence;\n"],"mappings":";;;;;;;;;;;AAIAA,OAAA;AAEA,IAAAC,UAAA,GAAAD,OAAA;AAEA,IAAAE,gBAAA,GAAAC,sBAAA,CAAAH,OAAA;AACA,IAAAI,eAAA,GAAAD,sBAAA,CAAAH,OAAA;AATA;AACA;AACA;;AASA,IAAMK,sBAAsB,GAAG,GAAG;AAClC,IAAMC,IAAI,GAAG,MAAM;AACnB,IAAMC,qBAAqB,GAAG,uBAAuB;;AAErD;AACA;AACA;AACA;AACA,IAAMC,QAAQ,GAAGC,sBAAW,CAACC,MAAM,CAAC;EAClCC,SAAS,EAAE,UAAU;EAErBC,QAAQ,EAAE;IACRC,OAAO,EAAEC;EACX,CAAC;EAEDC,OAAO,EAAE;IACPC,MAAM,EAAE;MACNC,OAAO,WAAAC,SAAA,EAAG;QACR,OAAO,IAAIC,uBAAc,CAAC,CAAC;MAC7B,CAAC;MACDC,IAAI,EAAE;IACR;EACF,CAAC;EAED;AACF;AACA;AACA;EACEC,UAAU,WAAAA,WAAA,EAAG;IAAA,IAAAC,KAAA;IACX,IAAI,CAACC,KAAK,CAACC,IAAI,CAAC,OAAO,EAAE,YAAM;MAC7B,IAAIF,KAAI,CAACG,MAAM,CAACC,gBAAgB,EAAE;QAChCJ,KAAI,CAACN,MAAM,CAACK,UAAU,CAACC,KAAI,CAACC,KAAK,CAAC;MACpC;IACF,CAAC,CAAC;EACJ,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACEI,SAAS,WAAAA,UAACC,KAAK,EAAEC,OAAO,EAAE;IACxB,IAAIA,OAAO,CAACT,IAAI,IAAIS,OAAO,CAACA,OAAO,EAAE;MACnC,IAAI,CAACC,OAAO,CAACF,KAAK,EAAEC,OAAO,CAAC;IAC9B;EACF,CAAC;EAED;AACF;AACA;AACA;EACEE,MAAM,WAAAA,OAAA,EAAG;IACP,OAAO,IAAI,CAACR,KAAK,CAACS,QAAQ,CAACC,OAAO,CAC/BC,UAAU,CAAC5B,IAAI,EAAEC,qBAAqB,EAAE,IAAI,CAAC,CAC7C4B,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACC,KAAK;IAAA,EAAC;EACvC,CAAC;EAED;AACF;AACA;AACA;EACEC,OAAO,WAAAA,QAAA,EAAG;IACR,OAAO,IAAI,CAACf,KAAK,CAACS,QAAQ,CAACC,OAAO,CAC/BC,UAAU,CAAC5B,IAAI,EAAEC,qBAAqB,EAAE,KAAK,CAAC,CAC9C4B,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACC,KAAK;IAAA,EAAC;EACvC,CAAC;EAED;AACF;AACA;AACA;EACEE,SAAS,WAAAA,UAAA,EAAG;IACV,OAAO,IAAI,CAAChB,KAAK,CAACS,QAAQ,CAACC,OAAO,CAACO,UAAU,CAAClC,IAAI,EAAEC,qBAAqB,CAAC;EAC5E,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAEE;AACF;AACA;AACA;AACA;EACEkC,GAAG,WAAAA,IAACC,QAAQ,EAAE;IACZ,IAAI,CAACA,QAAQ,EAAE;MACb,OAAOC,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7D;IAEA,OAAO,IAAI,CAACtB,KAAK,CACduB,OAAO,CAAC;MACPC,MAAM,EAAE,KAAK;MACbC,OAAO,EAAE,UAAU;MACnBC,QAAQ,yBAAAC,MAAA,CAAyBR,QAAQ;IAC3C,CAAC,CAAC,CACDP,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACe,IAAI;IAAA,EAAC;EACtC,CAAC;EAED;AACF;AACA;AACA;EACE;AACF;AACA;AACA;AACA;EACEC,IAAI,WAAAA,KAACC,SAAS,EAAE;IAAA,IAAAC,MAAA;IACd,IAAI,CAACD,SAAS,IAAI,CAAC,IAAAE,QAAA,CAAAtC,OAAA,EAAcoC,SAAS,CAAC,EAAE;MAC3C,OAAOV,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxE;IAEA,OAAOF,QAAA,CAAA1B,OAAA,CAAQuC,GAAG,CAACH,SAAS,CAACI,GAAG,CAAC,UAACC,EAAE;MAAA,OAAKJ,MAAI,CAACzC,OAAO,CAACiC,OAAO,CAACY,EAAE,CAAC;IAAA,EAAC,CAAC,CAACvB,IAAI,CAAC,UAACwB,SAAS;MAAA,OAAM;QACvFC,UAAU,EAAED;MACd,CAAC;IAAA,CAAC,CAAC;EACL,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,SAAS,WAAAA,UAACR,SAAS,EAA4C;IAAA,IAAAS,MAAA;IAAA,IAA1CC,eAAe,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG3D,sBAAsB;IAC3D,IAAI8D,QAAQ;IACZ,IAAMC,OAAO,GAAG,EAAE;IAClB,IAAMC,UAAU,GAAG,EAAE;IAErB,IAAI,CAAChB,SAAS,EAAE;MACd,OAAOV,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7D;IACA,IAAI,IAAAU,QAAA,CAAAtC,OAAA,EAAcoC,SAAS,CAAC,EAAE;MAC5Bc,QAAQ,GAAGd,SAAS;IACtB,CAAC,MAAM;MACLc,QAAQ,GAAG,CAACd,SAAS,CAAC;IACxB;IACA;IACA,KAAK,IAAIiB,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGH,QAAQ,CAACF,MAAM,EAAEK,CAAC,IAAID,UAAU,EAAE;MACpDD,OAAO,CAACG,IAAI,CAACJ,QAAQ,CAACK,KAAK,CAACF,CAAC,EAAEA,CAAC,GAAGD,UAAU,CAAC,CAAC;IACjD;IAEA,OAAO1B,QAAA,CAAA1B,OAAA,CAAQuC,GAAG,CAChBY,OAAO,CAACX,GAAG,CAAC,UAACgB,GAAG;MAAA,OACdX,MAAI,CAACvC,KAAK,CACPuB,OAAO,CAAC;QACPC,MAAM,EAAE,MAAM;QACd2B,GAAG,EAAE,UAAU;QACfzB,QAAQ,EAAE,eAAe;QACzBE,IAAI,EAAE;UACJgB,QAAQ,EAAEM,GAAG;UACbV,eAAe,EAAfA,eAAe;UACfY,aAAa,EAAE;QACjB;MACF,CAAC,CAAC,CACDxC,IAAI,CAAC,UAACC,QAAQ;QAAA,OAAKA,QAAQ,CAACe,IAAI,CAACyB,SAAS;MAAA,EAAC;IAAA,CAChD,CACF,CAAC,CAACzC,IAAI,CAAC,UAAC0C,SAAS;MAAA,IAAAC,IAAA;MAAA,OAAM;QAACF,SAAS,EAAE,CAAAE,IAAA,KAAE,EAAC5B,MAAM,CAAA6B,KAAA,CAAAD,IAAA,MAAAE,mBAAA,CAAA/D,OAAA,EAAI4D,SAAS;MAAC,CAAC;IAAA,CAAC,CAAC;EAC/D,CAAC;EAED;AACF;AACA;AACA;AACA;EACEI,WAAW,WAAAA,YAAC5B,SAAS,EAAE;IACrB,IAAIc,QAAQ;IAEZ,IAAI,CAACd,SAAS,EAAE;MACd,OAAOV,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7D;IACA,IAAI,IAAAU,QAAA,CAAAtC,OAAA,EAAcoC,SAAS,CAAC,EAAE;MAC5Bc,QAAQ,GAAGd,SAAS;IACtB,CAAC,MAAM;MACLc,QAAQ,GAAG,CAACd,SAAS,CAAC;IACxB;IAEA,OAAO,IAAI,CAAC9B,KAAK,CAACuB,OAAO,CAAC;MACxBC,MAAM,EAAE,MAAM;MACd2B,GAAG,EAAE,UAAU;MACfzB,QAAQ,EAAE,eAAe;MACzBE,IAAI,EAAE;QACJgB,QAAQ,EAARA,QAAQ;QACRJ,eAAe,EAAE,CAAC;QAClBY,aAAa,EAAE;MACjB;IACF,CAAC,CAAC;EACJ,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;EACEO,SAAS,WAAAA,UAACC,MAAM,EAAEC,GAAG,EAAE;IACrB,IAAI,CAACD,MAAM,EAAE;MACX,OAAOxC,QAAA,CAAA1B,OAAA,CAAQ2B,MAAM,CAAC,IAAIC,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1D;IAEA,OAAO,IAAI,CAACtB,KAAK,CACduB,OAAO,CAAC;MACPC,MAAM,EAAE,MAAM;MACd2B,GAAG,EAAE,UAAU;MACfzB,QAAQ,EAAE,QAAQ;MAClBE,IAAI,EAAE;QACJkC,OAAO,EAAE,IAAI,CAAC9D,KAAK,CAACS,QAAQ,CAACsD,MAAM,CAACC,MAAM;QAC1CC,SAAS,EAAEL,MAAM;QACjBM,KAAK,EAAE,IAAI,CAAClE,KAAK,CAACS,QAAQ,CAACsD,MAAM,CAACC,MAAM;QACxCH,GAAG,EAAHA;MACF;IACF,CAAC,CAAC,CACDjD,IAAI,CAAC,UAACC,QAAQ;MAAA,OAAKA,QAAQ,CAACe,IAAI;IAAA,EAAC;EACtC,CAAC;EAED;AACF;AACA;AACA;AACA;EACEuC,OAAO,WAAAA,QAAChC,EAAE,EAAE;IACV,OAAO,IAAI,CAAC1C,MAAM,CAAC0E,OAAO,CAAChC,EAAE,CAAC;EAChC,CAAC;EAED;AACF;AACA;AACA;AACA;EACEiC,OAAO,WAAAA,QAACjC,EAAE,EAAE;IACV,OAAO,IAAI,CAAC1C,MAAM,CAAC2E,OAAO,CAACjC,EAAE,CAAC;EAChC,CAAC;EAAAkC,OAAA;AACH,CAAC,CAAC;AAAC,IAAAC,SAAA,GAAAC,OAAA,CAAA7E,OAAA,GAEYT,QAAQ"}

package/package.json

@@ -24,22 +24,22 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.4.0-next.2",
-    "@webex/test-helper-mocha": "3.4.0-next.2",
-    "@webex/test-helper-mock-webex": "3.4.0-next.2",
-    "@webex/test-helper-test-users": "3.4.0-next.2",
+    "@webex/test-helper-chai": "3.4.0-next.3",
+    "@webex/test-helper-mocha": "3.4.0-next.3",
+    "@webex/test-helper-mock-webex": "3.4.0-next.3",
+    "@webex/test-helper-test-users": "3.4.0-next.3",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/internal-plugin-device": "3.4.0-next.2",
-    "@webex/internal-plugin-mercury": "3.4.0-next.2",
-    "@webex/test-helper-chai": "3.4.0-next.2",
-    "@webex/test-helper-mocha": "3.4.0-next.2",
-    "@webex/test-helper-mock-webex": "3.4.0-next.2",
-    "@webex/test-helper-test-users": "3.4.0-next.2",
-    "@webex/webex-core": "3.4.0-next.2",
+    "@webex/internal-plugin-device": "3.4.0-next.3",
+    "@webex/internal-plugin-mercury": "3.4.0-next.3",
+    "@webex/test-helper-chai": "3.4.0-next.3",
+    "@webex/test-helper-mocha": "3.4.0-next.3",
+    "@webex/test-helper-mock-webex": "3.4.0-next.3",
+    "@webex/test-helper-test-users": "3.4.0-next.3",
+    "@webex/webex-core": "3.4.0-next.3",
     "lodash": "^4.17.21"
   },
   "scripts": {
@@ -51,5 +51,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner jest"
   },
-  "version": "3.4.0-next.2"
+  "version": "3.4.0-next.4"
 }

package/src/presence.js

@@ -234,6 +234,7 @@ const Presence = WebexPlugin.extend({
         body: {
           subject: this.webex.internal.device.userId,
           eventType: status,
+          label: this.webex.internal.device.userId,
           ttl,
         },
       })

package/test/integration/spec/presence.js

@@ -206,8 +206,10 @@ describe.skip('plugin-presence', function () {
         spock.webex.internal.presence.setStatus('dnd', 1500).then((statusResponse) => {
           assert.property(statusResponse, 'subject');
           assert.property(statusResponse, 'status');
+          assert.property(statusResponse, 'label');
           assert.equal(statusResponse.subject, spock.id);
           assert.equal(statusResponse.status, 'dnd');
+          assert.equal(statusResponse.label, spock.id);
         }));
     });
   });

package/test/unit/spec/presence.js

@@ -64,6 +64,29 @@ describe.skip('plugin-presence', () => {
     describe('#setStatus()', () => {
       it('requires a status', () =>
         assert.isRejected(webex.internal.presence.setStatus(), /A status is required/));
+
+      it('passes a label to the API', () => {
+        const testGuid = 'test-guid';
+
+        webex.internal.device.userId = testGuid;
+
+        webex.request = function (options) {
+          return Promise.resolve({
+            statusCode: 204,
+            body: [],
+            options,
+          });
+        };
+        sinon.spy(webex, 'request');
+
+        webex.internal.presence.setStatus('dnd');
+
+        assert.calledOnce(webex.request);
+
+        const request = webex.request.getCall(0);
+
+        assert.equal(request.args[0].body.label, testGuid);
+      });
     });
   });
 });