@webex/internal-plugin-dss 2.22.0

package/README.md

@@ -0,0 +1,74 @@
+# @webex/internal-plugin-dss
+
+[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
+
+> Plugin for Directory Search Service (DSS)
+
+This is an internal Cisco Webex plugin. As such, it does not strictly adhere to semantic versioning. Use at your own risk. If you're not working on one of our first party clients, please look at our [developer api](https://developer.webex.com/) and stick to our public plugins.
+
+- [Install](#install)
+- [Usage](#usage)
+- [Maintainers](#maintainers)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Install
+
+```bash
+npm install --save @webex/internal-plugin-dss
+```
+
+## Usage
+
+```js
+import '@webex/internal-plugin-dss';
+
+import WebexCore from '@webex/webex-core';
+
+const webex = new WebexCore();
+
+// Namespace.
+webex.internal.dss
+
+// Register the plugin (connects to mercury).
+webex.internal.dss.register()
+  .then(() => {}) // On successful registration.
+  .catch(() => {}); // On failed registration.
+
+// Unregister the plugin (disconnects from mercury).
+webex.internal.dss.unregister()
+  .then(() => {}) // On successful unregistration.
+  .catch(() => {}); // On failed unregistration.
+
+// Methods
+
+// Get detailed information on an entity
+webex.internal.dss.lookupDetail({id: <entity-uuid>}).then((results) => {})
+
+// Get information on multiple identities
+webex.internal.dss.lookup({ids: [<entity-uuid-1>, <entity-uuid-2>]}).then((results) => {})
+
+// Get information on entities by querying their email addresses
+webex.internal.dss.lookupByEmail(
+  {emails: ['email1@example.com', 'email2@example.com']}
+).then((results) => {})
+
+// Search for information on certain type(s)
+webex.internal.dss.search({
+  requestedTypes: [PERSON],
+  queryString: 'a name',
+  resultSize: 10,
+}).then((results) => {})
+```
+
+## Maintainers
+
+This package is maintained by [Cisco Webex for Developers](https://developer.webex.com/).
+
+## Contribute
+
+Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/webex-js-sdk/blob/master/CONTRIBUTING.md) for more details.
+
+## License
+
+© 2016-2022 Cisco and/or its affiliates. All Rights Reserved.

package/dist/constants.js

@@ -0,0 +1,32 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports.SEARCH_TYPES = exports.DSS_UNREGISTERED = exports.DSS_SERVICE_NAME = exports.DSS_SEARCH_MERCURY_EVENT = exports.DSS_RESULT = exports.DSS_REGISTERED = exports.DSS_LOOKUP_RESULT = exports.DSS_LOOKUP_MERCURY_EVENT = void 0;
+var DSS_REGISTERED = 'dss:registered';
+exports.DSS_REGISTERED = DSS_REGISTERED;
+var DSS_UNREGISTERED = 'dss:unregistered';
+exports.DSS_UNREGISTERED = DSS_UNREGISTERED;
+var DSS_LOOKUP_MERCURY_EVENT = 'event:directory.lookup';
+exports.DSS_LOOKUP_MERCURY_EVENT = DSS_LOOKUP_MERCURY_EVENT;
+var DSS_SEARCH_MERCURY_EVENT = 'event:directory.search';
+exports.DSS_SEARCH_MERCURY_EVENT = DSS_SEARCH_MERCURY_EVENT;
+var DSS_LOOKUP_RESULT = 'dss:lookup.result';
+exports.DSS_LOOKUP_RESULT = DSS_LOOKUP_RESULT;
+var DSS_RESULT = 'dss:result';
+exports.DSS_RESULT = DSS_RESULT;
+var DSS_SERVICE_NAME = 'directorySearch';
+exports.DSS_SERVICE_NAME = DSS_SERVICE_NAME;
+var SEARCH_TYPES = {
+  PERSON: 'PERSON',
+  CALLING_SERVICE: 'CALLING_SERVICE',
+  EXTERNAL_CALLING: 'EXTERNAL_CALLING',
+  ROOM: 'ROOM',
+  ROBOT: 'ROBOT'
+};
+exports.SEARCH_TYPES = SEARCH_TYPES;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["DSS_REGISTERED","DSS_UNREGISTERED","DSS_LOOKUP_MERCURY_EVENT","DSS_SEARCH_MERCURY_EVENT","DSS_LOOKUP_RESULT","DSS_RESULT","DSS_SERVICE_NAME","SEARCH_TYPES","PERSON","CALLING_SERVICE","EXTERNAL_CALLING","ROOM","ROBOT"],"sources":["constants.ts"],"sourcesContent":["export const DSS_REGISTERED = 'dss:registered';\nexport const DSS_UNREGISTERED = 'dss:unregistered';\nexport const DSS_LOOKUP_MERCURY_EVENT = 'event:directory.lookup';\nexport const DSS_SEARCH_MERCURY_EVENT = 'event:directory.search';\nexport const DSS_LOOKUP_RESULT = 'dss:lookup.result';\nexport const DSS_RESULT = 'dss:result';\nexport const DSS_SERVICE_NAME = 'directorySearch';\nexport const SEARCH_TYPES = {\n  PERSON: 'PERSON',\n  CALLING_SERVICE: 'CALLING_SERVICE',\n  EXTERNAL_CALLING: 'EXTERNAL_CALLING',\n  ROOM: 'ROOM',\n  ROBOT: 'ROBOT',\n};\n"],"mappings":";;;;;;;;;AAAO,IAAMA,cAAc,GAAG,gBAAvB;;AACA,IAAMC,gBAAgB,GAAG,kBAAzB;;AACA,IAAMC,wBAAwB,GAAG,wBAAjC;;AACA,IAAMC,wBAAwB,GAAG,wBAAjC;;AACA,IAAMC,iBAAiB,GAAG,mBAA1B;;AACA,IAAMC,UAAU,GAAG,YAAnB;;AACA,IAAMC,gBAAgB,GAAG,iBAAzB;;AACA,IAAMC,YAAY,GAAG;EAC1BC,MAAM,EAAE,QADkB;EAE1BC,eAAe,EAAE,iBAFS;EAG1BC,gBAAgB,EAAE,kBAHQ;EAI1BC,IAAI,EAAE,MAJoB;EAK1BC,KAAK,EAAE;AALmB,CAArB"}

package/dist/dss.js

@@ -0,0 +1,291 @@
+"use strict";
+
+var _Object$keys2 = require("@babel/runtime-corejs2/core-js/object/keys");
+
+var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs2/core-js/object/get-own-property-symbols");
+
+var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptor");
+
+var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs2/core-js/object/get-own-property-descriptors");
+
+var _Object$defineProperties = require("@babel/runtime-corejs2/core-js/object/define-properties");
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports.default = void 0;
+
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+
+var _keys = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/keys"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/toConsumableArray"));
+
+var _get2 = _interopRequireDefault(require("lodash/get"));
+
+var _isEqual2 = _interopRequireDefault(require("lodash/isEqual"));
+
+var _range2 = _interopRequireDefault(require("lodash/range"));
+
+var _uuid = _interopRequireDefault(require("uuid"));
+
+var _webexCore = require("@webex/webex-core");
+
+require("@webex/internal-plugin-mercury");
+
+var _constants = require("./constants");
+
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys2(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+var DSS = _webexCore.WebexPlugin.extend({
+  namespace: 'DSS',
+
+  /**
+   * registered value indicating events registration is successful
+   * @instance
+   * @type {Boolean}
+   * @memberof DSS
+   */
+  registered: false,
+
+  /**
+   * Explicitly sets up the DSS plugin by connecting to mercury, and listening for DSS events.
+   * @returns {Promise}
+   * @public
+   * @memberof DSS
+   */
+  register: function register() {
+    var _this = this;
+
+    if (!this.webex.canAuthorize) {
+      this.logger.error('DSS->register#ERROR, Unable to register, SDK cannot authorize');
+      return _promise.default.reject(new Error('SDK cannot authorize'));
+    }
+
+    if (this.registered) {
+      this.logger.info('dss->register#INFO, DSS plugin already registered');
+      return _promise.default.resolve();
+    }
+
+    return this.webex.internal.mercury.connect().then(function () {
+      _this.listenForEvents();
+
+      _this.trigger(_constants.DSS_REGISTERED);
+
+      _this.registered = true;
+    }).catch(function (error) {
+      _this.logger.error("DSS->register#ERROR, Unable to register, ".concat(error.message));
+
+      return _promise.default.reject(error);
+    });
+  },
+
+  /**
+   * Explicitly tears down the DSS plugin by disconnecting from mercury, and stops listening to DSS events
+   * @returns {Promise}
+   * @public
+   * @memberof DSS
+   */
+  unregister: function unregister() {
+    var _this2 = this;
+
+    if (!this.registered) {
+      this.logger.info('DSS->unregister#INFO, DSS plugin already unregistered');
+      return _promise.default.resolve();
+    }
+
+    this.stopListeningForEvents();
+    return this.webex.internal.mercury.disconnect().then(function () {
+      _this2.trigger(_constants.DSS_UNREGISTERED);
+
+      _this2.registered = false;
+    });
+  },
+
+  /**
+   * registers for DSS events through mercury
+   * @returns {undefined}
+   * @private
+   */
+  listenForEvents: function listenForEvents() {
+    var _this3 = this;
+
+    this.webex.internal.mercury.on(_constants.DSS_LOOKUP_MERCURY_EVENT, function (envelope) {
+      _this3._handleEvent(envelope.data);
+    });
+    this.webex.internal.mercury.on(_constants.DSS_SEARCH_MERCURY_EVENT, function (envelope) {
+      _this3._handleEvent(envelope.data);
+    });
+  },
+
+  /**
+   * unregisteres all the DSS events from mercury
+   * @returns {undefined}
+   * @private
+   */
+  stopListeningForEvents: function stopListeningForEvents() {
+    this.webex.internal.mercury.off(_constants.DSS_LOOKUP_MERCURY_EVENT);
+    this.webex.internal.mercury.off(_constants.DSS_SEARCH_MERCURY_EVENT);
+  },
+
+  /**
+   * @param {UUID} requestId the id of the request
+   * @returns {string}
+   */
+  _getResultEventName: function _getResultEventName(requestId) {
+    return "".concat(_constants.DSS_RESULT).concat(requestId);
+  },
+
+  /**
+   * @param {Object} data the event data
+   * @returns {undefined}
+   */
+  _handleEvent: function _handleEvent(data) {
+    this.trigger(this._getResultEventName(data.requestId), data);
+    this.trigger(_constants.DSS_LOOKUP_RESULT, data);
+  },
+
+  /**
+    * Makes the request to the directory service
+    * @param {Object} options
+    * @param {string} options.resource the URL to query
+    * @param {string} options.params additional params for the body of the request
+    * @param {string} options.dataPath to path to get the data in the result object
+    * @returns {Promise} Resolves with an array of entities found
+  */
+  _request: function _request(options) {
+    var _this4 = this;
+
+    var resource = options.resource,
+        params = options.params,
+        dataPath = options.dataPath;
+
+    var requestId = _uuid.default.v4();
+
+    var eventName = this._getResultEventName(requestId);
+
+    var result = {};
+    var expectedSeqNums;
+    return new _promise.default(function (resolve) {
+      _this4.listenTo(_this4, eventName, function (data) {
+        var resultData = (0, _get2.default)(data, dataPath);
+        result[data.sequence] = resultData;
+
+        if (data.finished) {
+          expectedSeqNums = (0, _range2.default)(data.sequence + 1).map(String);
+        }
+
+        var done = (0, _isEqual2.default)(expectedSeqNums, (0, _keys.default)(result));
+
+        if (done) {
+          var resultArray = [];
+          expectedSeqNums.forEach(function (index) {
+            var seqResult = result[index];
+
+            if (seqResult) {
+              resultArray.push.apply(resultArray, (0, _toConsumableArray2.default)(seqResult));
+            }
+          });
+          resolve(resultArray);
+
+          _this4.stopListening(_this4, eventName);
+        }
+      });
+
+      _this4.webex.request({
+        service: _constants.DSS_SERVICE_NAME,
+        resource: resource,
+        method: 'POST',
+        contentType: 'application/json',
+        body: _objectSpread({
+          requestId: requestId
+        }, params)
+      });
+    });
+  },
+
+  /**
+   * Retrieves detailed information about an entity
+   * @param {Object} options
+   * @param {UUID} options.id the id of the entity to lookup
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  lookupDetail: function lookupDetail(options) {
+    var id = options.id;
+    return this._request({
+      dataPath: 'lookupResult.entities',
+      resource: "/lookup/orgid/".concat(this.webex.internal.device.orgId, "/identity/").concat(id, "/detail")
+    });
+  },
+
+  /**
+   * Retrieves basic information about a list entities within an organization
+   * @param {Object} options
+   * @param {UUID} options.ids the id of the entity to lookup
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  lookup: function lookup(options) {
+    var ids = options.ids;
+    return this._request({
+      dataPath: 'lookupResult.entities',
+      resource: "/lookup/orgid/".concat(this.webex.internal.device.orgId, "/identities"),
+      params: {
+        lookupValues: ids
+      }
+    });
+  },
+
+  /**
+   * Retrieves basic information about a list entities within an organization
+   * @param {Object} options
+   * @param {UUID} options.emails the emails of the entities to lookup
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  lookupByEmail: function lookupByEmail(options) {
+    var emails = options.emails;
+    return this._request({
+      dataPath: 'lookupResult.entities',
+      resource: "/lookup/orgid/".concat(this.webex.internal.device.orgId, "/emails"),
+      params: {
+        lookupValues: emails
+      }
+    });
+  },
+
+  /**
+   * Search for information about entities
+   * @param {Object} options
+   * @param {SearchType[]} options.requestedTypes an array of search types from: PERSON, CALLING_SERVICE, EXTERNAL_CALLING, ROOM, ROBOT
+   * @param {string[]} options.queryString A query string that will be transformed into a Directory search filter query. It is used to search the following fields: username, givenName, familyName, displayName and email
+   * @param {number} options.resultSize The maximum number of results returned from each provider
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  search: function search(options) {
+    var requestedTypes = options.requestedTypes,
+        resultSize = options.resultSize,
+        queryString = options.queryString;
+    return this._request({
+      dataPath: 'directoryEntities',
+      resource: "/search/orgid/".concat(this.webex.internal.device.orgId, "/entities"),
+      params: {
+        queryString: queryString,
+        resultSize: resultSize,
+        requestedTypes: requestedTypes
+      }
+    });
+  },
+  version: "2.22.0"
+});
+
+var _default = DSS;
+exports.default = _default;
+//# sourceMappingURL=dss.js.map

package/dist/dss.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["DSS","WebexPlugin","extend","namespace","registered","register","webex","canAuthorize","logger","error","reject","Error","info","resolve","internal","mercury","connect","then","listenForEvents","trigger","DSS_REGISTERED","catch","message","unregister","stopListeningForEvents","disconnect","DSS_UNREGISTERED","on","DSS_LOOKUP_MERCURY_EVENT","envelope","_handleEvent","data","DSS_SEARCH_MERCURY_EVENT","off","_getResultEventName","requestId","DSS_RESULT","DSS_LOOKUP_RESULT","_request","options","resource","params","dataPath","uuid","v4","eventName","result","expectedSeqNums","listenTo","resultData","sequence","finished","map","String","done","resultArray","forEach","index","seqResult","push","stopListening","request","service","DSS_SERVICE_NAME","method","contentType","body","lookupDetail","id","device","orgId","lookup","ids","lookupValues","lookupByEmail","emails","search","requestedTypes","resultSize","queryString"],"sources":["dss.ts"],"sourcesContent":["/* eslint-disable no-underscore-dangle */\n/*!\n * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.\n */\nimport uuid from 'uuid';\nimport {WebexPlugin} from '@webex/webex-core';\nimport '@webex/internal-plugin-mercury';\nimport {range, isEqual, get} from 'lodash';\nimport type {SearchOptions, LookupDetailOptions, LookupOptions, LookupByEmailOptions} from './types';\n\nimport {\n  DSS_REGISTERED,\n  DSS_UNREGISTERED,\n  DSS_LOOKUP_MERCURY_EVENT,\n  DSS_LOOKUP_RESULT,\n  DSS_SERVICE_NAME,\n  DSS_SEARCH_MERCURY_EVENT,\n  DSS_RESULT,\n} from './constants';\n\nconst DSS = WebexPlugin.extend({\n  namespace: 'DSS',\n\n  /**\n   * registered value indicating events registration is successful\n   * @instance\n   * @type {Boolean}\n   * @memberof DSS\n   */\n  registered: false,\n\n  /**\n   * Explicitly sets up the DSS plugin by connecting to mercury, and listening for DSS events.\n   * @returns {Promise}\n   * @public\n   * @memberof DSS\n   */\n  register() {\n    if (!this.webex.canAuthorize) {\n      this.logger.error('DSS->register#ERROR, Unable to register, SDK cannot authorize');\n\n      return Promise.reject(new Error('SDK cannot authorize'));\n    }\n\n    if (this.registered) {\n      this.logger.info('dss->register#INFO, DSS plugin already registered');\n\n      return Promise.resolve();\n    }\n\n    return this.webex.internal.mercury.connect()\n      .then(() => {\n        this.listenForEvents();\n        this.trigger(DSS_REGISTERED);\n        this.registered = true;\n      })\n      .catch((error) => {\n        this.logger.error(`DSS->register#ERROR, Unable to register, ${error.message}`);\n\n        return Promise.reject(error);\n      });\n  },\n\n  /**\n   * Explicitly tears down the DSS plugin by disconnecting from mercury, and stops listening to DSS events\n   * @returns {Promise}\n   * @public\n   * @memberof DSS\n   */\n  unregister() {\n    if (!this.registered) {\n      this.logger.info('DSS->unregister#INFO, DSS plugin already unregistered');\n\n      return Promise.resolve();\n    }\n\n    this.stopListeningForEvents();\n\n    return this.webex.internal.mercury.disconnect()\n      .then(() => {\n        this.trigger(DSS_UNREGISTERED);\n        this.registered = false;\n      });\n  },\n\n  /**\n   * registers for DSS events through mercury\n   * @returns {undefined}\n   * @private\n   */\n  listenForEvents() {\n    this.webex.internal.mercury.on(DSS_LOOKUP_MERCURY_EVENT, (envelope) => {\n      this._handleEvent(envelope.data);\n    });\n    this.webex.internal.mercury.on(DSS_SEARCH_MERCURY_EVENT, (envelope) => {\n      this._handleEvent(envelope.data);\n    });\n  },\n\n  /**\n   * unregisteres all the DSS events from mercury\n   * @returns {undefined}\n   * @private\n   */\n  stopListeningForEvents() {\n    this.webex.internal.mercury.off(DSS_LOOKUP_MERCURY_EVENT);\n    this.webex.internal.mercury.off(DSS_SEARCH_MERCURY_EVENT);\n  },\n\n  /**\n   * @param {UUID} requestId the id of the request\n   * @returns {string}\n   */\n  _getResultEventName(requestId) {\n    return `${DSS_RESULT}${requestId}`;\n  },\n\n  /**\n   * @param {Object} data the event data\n   * @returns {undefined}\n   */\n  _handleEvent(data) {\n    this.trigger(this._getResultEventName(data.requestId), data);\n    this.trigger(DSS_LOOKUP_RESULT, data);\n  },\n\n  /**\n    * Makes the request to the directory service\n    * @param {Object} options\n    * @param {string} options.resource the URL to query\n    * @param {string} options.params additional params for the body of the request\n    * @param {string} options.dataPath to path to get the data in the result object\n    * @returns {Promise} Resolves with an array of entities found\n  */\n  _request(options) {\n    const {resource, params, dataPath} = options;\n\n    const requestId = uuid.v4();\n    const eventName = this._getResultEventName(requestId);\n    const result = {};\n    let expectedSeqNums;\n\n    return new Promise((resolve) => {\n      this.listenTo(this, eventName, (data) => {\n        const resultData = get(data, dataPath);\n\n        result[data.sequence] = resultData;\n\n        if (data.finished) {\n          expectedSeqNums = range(data.sequence + 1).map(String);\n        }\n\n        const done = isEqual(expectedSeqNums, Object.keys(result));\n\n        if (done) {\n          const resultArray = [];\n          expectedSeqNums.forEach((index) => {\n            const seqResult = result[index];\n            if (seqResult) {\n              resultArray.push(...seqResult);\n            }\n          })\n\n          resolve(resultArray);\n          this.stopListening(this, eventName);\n        }\n      });\n      this.webex.request({\n        service: DSS_SERVICE_NAME,\n        resource,\n        method: 'POST',\n        contentType: 'application/json',\n        body: {requestId, ...params}\n      });\n    });\n  },\n\n  /**\n   * Retrieves detailed information about an entity\n   * @param {Object} options\n   * @param {UUID} options.id the id of the entity to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookupDetail(options: LookupDetailOptions) {\n    const {id} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identity/${id}/detail`\n    });\n  },\n\n  /**\n   * Retrieves basic information about a list entities within an organization\n   * @param {Object} options\n   * @param {UUID} options.ids the id of the entity to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookup(options: LookupOptions) {\n    const {ids} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identities`,\n      params: {\n        lookupValues: ids,\n      }\n    });\n  },\n\n  /**\n   * Retrieves basic information about a list entities within an organization\n   * @param {Object} options\n   * @param {UUID} options.emails the emails of the entities to lookup\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  lookupByEmail(options: LookupByEmailOptions) {\n    const {emails} = options;\n\n    return this._request({\n      dataPath: 'lookupResult.entities',\n      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/emails`,\n      params: {\n        lookupValues: emails,\n      }\n    });\n  },\n\n  /**\n   * Search for information about entities\n   * @param {Object} options\n   * @param {SearchType[]} options.requestedTypes an array of search types from: PERSON, CALLING_SERVICE, EXTERNAL_CALLING, ROOM, ROBOT\n   * @param {string[]} options.queryString A query string that will be transformed into a Directory search filter query. It is used to search the following fields: username, givenName, familyName, displayName and email\n   * @param {number} options.resultSize The maximum number of results returned from each provider\n   * @returns {Promise} Resolves with an array of entities found\n   */\n  search(options: SearchOptions) {\n    const {\n      requestedTypes, resultSize, queryString\n    } = options;\n\n    return this._request({\n      dataPath: 'directoryEntities',\n      resource: `/search/orgid/${this.webex.internal.device.orgId}/entities`,\n      params: {\n        queryString,\n        resultSize,\n        requestedTypes\n      }\n    });\n  }\n\n});\n\nexport default DSS;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;AACA;;AAIA;;;;;;AAUA,IAAMA,GAAG,GAAGC,sBAAA,CAAYC,MAAZ,CAAmB;EAC7BC,SAAS,EAAE,KADkB;;EAG7B;AACF;AACA;AACA;AACA;AACA;EACEC,UAAU,EAAE,KATiB;;EAW7B;AACF;AACA;AACA;AACA;AACA;EACEC,QAjB6B,sBAiBlB;IAAA;;IACT,IAAI,CAAC,KAAKC,KAAL,CAAWC,YAAhB,EAA8B;MAC5B,KAAKC,MAAL,CAAYC,KAAZ,CAAkB,+DAAlB;MAEA,OAAO,iBAAQC,MAAR,CAAe,IAAIC,KAAJ,CAAU,sBAAV,CAAf,CAAP;IACD;;IAED,IAAI,KAAKP,UAAT,EAAqB;MACnB,KAAKI,MAAL,CAAYI,IAAZ,CAAiB,mDAAjB;MAEA,OAAO,iBAAQC,OAAR,EAAP;IACD;;IAED,OAAO,KAAKP,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BC,OAA5B,GACJC,IADI,CACC,YAAM;MACV,KAAI,CAACC,eAAL;;MACA,KAAI,CAACC,OAAL,CAAaC,yBAAb;;MACA,KAAI,CAAChB,UAAL,GAAkB,IAAlB;IACD,CALI,EAMJiB,KANI,CAME,UAACZ,KAAD,EAAW;MAChB,KAAI,CAACD,MAAL,CAAYC,KAAZ,oDAA8DA,KAAK,CAACa,OAApE;;MAEA,OAAO,iBAAQZ,MAAR,CAAeD,KAAf,CAAP;IACD,CAVI,CAAP;EAWD,CAzC4B;;EA2C7B;AACF;AACA;AACA;AACA;AACA;EACEc,UAjD6B,wBAiDhB;IAAA;;IACX,IAAI,CAAC,KAAKnB,UAAV,EAAsB;MACpB,KAAKI,MAAL,CAAYI,IAAZ,CAAiB,uDAAjB;MAEA,OAAO,iBAAQC,OAAR,EAAP;IACD;;IAED,KAAKW,sBAAL;IAEA,OAAO,KAAKlB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BU,UAA5B,GACJR,IADI,CACC,YAAM;MACV,MAAI,CAACE,OAAL,CAAaO,2BAAb;;MACA,MAAI,CAACtB,UAAL,GAAkB,KAAlB;IACD,CAJI,CAAP;EAKD,CA/D4B;;EAiE7B;AACF;AACA;AACA;AACA;EACEc,eAtE6B,6BAsEX;IAAA;;IAChB,KAAKZ,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BY,EAA5B,CAA+BC,mCAA/B,EAAyD,UAACC,QAAD,EAAc;MACrE,MAAI,CAACC,YAAL,CAAkBD,QAAQ,CAACE,IAA3B;IACD,CAFD;IAGA,KAAKzB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BY,EAA5B,CAA+BK,mCAA/B,EAAyD,UAACH,QAAD,EAAc;MACrE,MAAI,CAACC,YAAL,CAAkBD,QAAQ,CAACE,IAA3B;IACD,CAFD;EAGD,CA7E4B;;EA+E7B;AACF;AACA;AACA;AACA;EACEP,sBApF6B,oCAoFJ;IACvB,KAAKlB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BkB,GAA5B,CAAgCL,mCAAhC;IACA,KAAKtB,KAAL,CAAWQ,QAAX,CAAoBC,OAApB,CAA4BkB,GAA5B,CAAgCD,mCAAhC;EACD,CAvF4B;;EAyF7B;AACF;AACA;AACA;EACEE,mBA7F6B,+BA6FTC,SA7FS,EA6FE;IAC7B,iBAAUC,qBAAV,SAAuBD,SAAvB;EACD,CA/F4B;;EAiG7B;AACF;AACA;AACA;EACEL,YArG6B,wBAqGhBC,IArGgB,EAqGV;IACjB,KAAKZ,OAAL,CAAa,KAAKe,mBAAL,CAAyBH,IAAI,CAACI,SAA9B,CAAb,EAAuDJ,IAAvD;IACA,KAAKZ,OAAL,CAAakB,4BAAb,EAAgCN,IAAhC;EACD,CAxG4B;;EA0G7B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,QAlH6B,oBAkHpBC,OAlHoB,EAkHX;IAAA;;IAChB,IAAOC,QAAP,GAAqCD,OAArC,CAAOC,QAAP;IAAA,IAAiBC,MAAjB,GAAqCF,OAArC,CAAiBE,MAAjB;IAAA,IAAyBC,QAAzB,GAAqCH,OAArC,CAAyBG,QAAzB;;IAEA,IAAMP,SAAS,GAAGQ,aAAA,CAAKC,EAAL,EAAlB;;IACA,IAAMC,SAAS,GAAG,KAAKX,mBAAL,CAAyBC,SAAzB,CAAlB;;IACA,IAAMW,MAAM,GAAG,EAAf;IACA,IAAIC,eAAJ;IAEA,OAAO,qBAAY,UAAClC,OAAD,EAAa;MAC9B,MAAI,CAACmC,QAAL,CAAc,MAAd,EAAoBH,SAApB,EAA+B,UAACd,IAAD,EAAU;QACvC,IAAMkB,UAAU,GAAG,mBAAIlB,IAAJ,EAAUW,QAAV,CAAnB;QAEAI,MAAM,CAACf,IAAI,CAACmB,QAAN,CAAN,GAAwBD,UAAxB;;QAEA,IAAIlB,IAAI,CAACoB,QAAT,EAAmB;UACjBJ,eAAe,GAAG,qBAAMhB,IAAI,CAACmB,QAAL,GAAgB,CAAtB,EAAyBE,GAAzB,CAA6BC,MAA7B,CAAlB;QACD;;QAED,IAAMC,IAAI,GAAG,uBAAQP,eAAR,EAAyB,mBAAYD,MAAZ,CAAzB,CAAb;;QAEA,IAAIQ,IAAJ,EAAU;UACR,IAAMC,WAAW,GAAG,EAApB;UACAR,eAAe,CAACS,OAAhB,CAAwB,UAACC,KAAD,EAAW;YACjC,IAAMC,SAAS,GAAGZ,MAAM,CAACW,KAAD,CAAxB;;YACA,IAAIC,SAAJ,EAAe;cACbH,WAAW,CAACI,IAAZ,OAAAJ,WAAW,mCAASG,SAAT,EAAX;YACD;UACF,CALD;UAOA7C,OAAO,CAAC0C,WAAD,CAAP;;UACA,MAAI,CAACK,aAAL,CAAmB,MAAnB,EAAyBf,SAAzB;QACD;MACF,CAvBD;;MAwBA,MAAI,CAACvC,KAAL,CAAWuD,OAAX,CAAmB;QACjBC,OAAO,EAAEC,2BADQ;QAEjBvB,QAAQ,EAARA,QAFiB;QAGjBwB,MAAM,EAAE,MAHS;QAIjBC,WAAW,EAAE,kBAJI;QAKjBC,IAAI;UAAG/B,SAAS,EAATA;QAAH,GAAiBM,MAAjB;MALa,CAAnB;IAOD,CAhCM,CAAP;EAiCD,CA3J4B;;EA6J7B;AACF;AACA;AACA;AACA;AACA;EACE0B,YAnK6B,wBAmKhB5B,OAnKgB,EAmKc;IACzC,IAAO6B,EAAP,GAAa7B,OAAb,CAAO6B,EAAP;IAEA,OAAO,KAAK9B,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,uBAAgEF,EAAhE;IAFW,CAAd,CAAP;EAID,CA1K4B;;EA4K7B;AACF;AACA;AACA;AACA;AACA;EACEG,MAlL6B,kBAkLtBhC,OAlLsB,EAkLE;IAC7B,IAAOiC,GAAP,GAAcjC,OAAd,CAAOiC,GAAP;IAEA,OAAO,KAAKlC,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,gBAFW;MAGnB7B,MAAM,EAAE;QACNgC,YAAY,EAAED;MADR;IAHW,CAAd,CAAP;EAOD,CA5L4B;;EA8L7B;AACF;AACA;AACA;AACA;AACA;EACEE,aApM6B,yBAoMfnC,OApMe,EAoMgB;IAC3C,IAAOoC,MAAP,GAAiBpC,OAAjB,CAAOoC,MAAP;IAEA,OAAO,KAAKrC,QAAL,CAAc;MACnBI,QAAQ,EAAE,uBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,YAFW;MAGnB7B,MAAM,EAAE;QACNgC,YAAY,EAAEE;MADR;IAHW,CAAd,CAAP;EAOD,CA9M4B;;EAgN7B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,MAxN6B,kBAwNtBrC,OAxNsB,EAwNE;IAC7B,IACEsC,cADF,GAEItC,OAFJ,CACEsC,cADF;IAAA,IACkBC,UADlB,GAEIvC,OAFJ,CACkBuC,UADlB;IAAA,IAC8BC,WAD9B,GAEIxC,OAFJ,CAC8BwC,WAD9B;IAIA,OAAO,KAAKzC,QAAL,CAAc;MACnBI,QAAQ,EAAE,mBADS;MAEnBF,QAAQ,0BAAmB,KAAKlC,KAAL,CAAWQ,QAAX,CAAoBuD,MAApB,CAA2BC,KAA9C,cAFW;MAGnB7B,MAAM,EAAE;QACNsC,WAAW,EAAXA,WADM;QAEND,UAAU,EAAVA,UAFM;QAGND,cAAc,EAAdA;MAHM;IAHW,CAAd,CAAP;EASD,CAtO4B;EAAA;AAAA,CAAnB,CAAZ;;eA0Oe7E,G"}

package/dist/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+_Object$defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _dss.default;
+  }
+});
+
+var _webexCore = require("@webex/webex-core");
+
+var _dss = _interopRequireDefault(require("./dss"));
+
+(0, _webexCore.registerInternalPlugin)('dss', _dss.default);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["registerInternalPlugin","DSS"],"sources":["index.ts"],"sourcesContent":["import {registerInternalPlugin} from '@webex/webex-core';\n\nimport DSS from './dss';\n\nregisterInternalPlugin('dss', DSS);\n\nexport {default} from './dss';\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;;AAEA;;AAEA,IAAAA,iCAAA,EAAuB,KAAvB,EAA8BC,YAA9B"}

package/dist/types.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports.SearchType = void 0;
+var SearchType;
+exports.SearchType = SearchType;
+
+(function (SearchType) {
+  SearchType["PERSON"] = "PERSON";
+  SearchType["CALLING_SERVICE"] = "CALLING_SERVICE";
+  SearchType["EXTERNAL_CALLING"] = "EXTERNAL_CALLING";
+  SearchType["ROOM"] = "ROOM";
+  SearchType["ROBOT"] = "ROBOT";
+})(SearchType || (exports.SearchType = SearchType = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["SearchType"],"sources":["types.ts"],"sourcesContent":["export interface LookupDetailOptions {\n  id: string;\n}\n\nexport interface LookupOptions {\n  ids: string[];\n}\n\nexport interface LookupByEmailOptions {\n  emails: string[];\n}\n\nexport enum SearchType {\n  PERSON = 'PERSON', \n  CALLING_SERVICE = 'CALLING_SERVICE',\n  EXTERNAL_CALLING = 'EXTERNAL_CALLING',\n  ROOM = 'ROOM',\n  ROBOT = 'ROBOT'\n}\n\nexport interface SearchOptions {\n  requestedTypes: SearchType[],\n  resultSize: number,\n  queryString: string,\n}\n"],"mappings":";;;;;;;;;IAYYA,U;;;WAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;EAAAA,U;GAAAA,U,0BAAAA,U"}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@webex/internal-plugin-dss",
+  "version": "2.22.0",
+  "description": "",
+  "license": "MIT",
+  "author": "Colin Read <coread@cisco.com>",
+  "main": "dist/index.js",
+  "devMain": "src/index.ts",
+  "repository": "https://github.com/webex/webex-js-sdk/tree/master/packages/node_modules/@webex/internal-plugin-dss",
+  "engines": {
+    "node": ">=8"
+  },
+  "browserify": {
+    "transform": [
+      "envify"
+    ]
+  },
+  "dependencies": {
+    "@babel/runtime-corejs2": "^7.14.8",
+    "@webex/webex-core": "2.22.0",
+    "lodash": "^4.17.21",
+    "uuid": "^3.3.2",
+    "@webex/internal-plugin-mercury": "2.22.0",
+    "envify": "^4.1.0"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,14 @@
+export const DSS_REGISTERED = 'dss:registered';
+export const DSS_UNREGISTERED = 'dss:unregistered';
+export const DSS_LOOKUP_MERCURY_EVENT = 'event:directory.lookup';
+export const DSS_SEARCH_MERCURY_EVENT = 'event:directory.search';
+export const DSS_LOOKUP_RESULT = 'dss:lookup.result';
+export const DSS_RESULT = 'dss:result';
+export const DSS_SERVICE_NAME = 'directorySearch';
+export const SEARCH_TYPES = {
+  PERSON: 'PERSON',
+  CALLING_SERVICE: 'CALLING_SERVICE',
+  EXTERNAL_CALLING: 'EXTERNAL_CALLING',
+  ROOM: 'ROOM',
+  ROBOT: 'ROBOT',
+};

package/src/dss.ts

@@ -0,0 +1,255 @@
+/* eslint-disable no-underscore-dangle */
+/*!
+ * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.
+ */
+import uuid from 'uuid';
+import {WebexPlugin} from '@webex/webex-core';
+import '@webex/internal-plugin-mercury';
+import {range, isEqual, get} from 'lodash';
+import type {SearchOptions, LookupDetailOptions, LookupOptions, LookupByEmailOptions} from './types';
+
+import {
+  DSS_REGISTERED,
+  DSS_UNREGISTERED,
+  DSS_LOOKUP_MERCURY_EVENT,
+  DSS_LOOKUP_RESULT,
+  DSS_SERVICE_NAME,
+  DSS_SEARCH_MERCURY_EVENT,
+  DSS_RESULT,
+} from './constants';
+
+const DSS = WebexPlugin.extend({
+  namespace: 'DSS',
+
+  /**
+   * registered value indicating events registration is successful
+   * @instance
+   * @type {Boolean}
+   * @memberof DSS
+   */
+  registered: false,
+
+  /**
+   * Explicitly sets up the DSS plugin by connecting to mercury, and listening for DSS events.
+   * @returns {Promise}
+   * @public
+   * @memberof DSS
+   */
+  register() {
+    if (!this.webex.canAuthorize) {
+      this.logger.error('DSS->register#ERROR, Unable to register, SDK cannot authorize');
+
+      return Promise.reject(new Error('SDK cannot authorize'));
+    }
+
+    if (this.registered) {
+      this.logger.info('dss->register#INFO, DSS plugin already registered');
+
+      return Promise.resolve();
+    }
+
+    return this.webex.internal.mercury.connect()
+      .then(() => {
+        this.listenForEvents();
+        this.trigger(DSS_REGISTERED);
+        this.registered = true;
+      })
+      .catch((error) => {
+        this.logger.error(`DSS->register#ERROR, Unable to register, ${error.message}`);
+
+        return Promise.reject(error);
+      });
+  },
+
+  /**
+   * Explicitly tears down the DSS plugin by disconnecting from mercury, and stops listening to DSS events
+   * @returns {Promise}
+   * @public
+   * @memberof DSS
+   */
+  unregister() {
+    if (!this.registered) {
+      this.logger.info('DSS->unregister#INFO, DSS plugin already unregistered');
+
+      return Promise.resolve();
+    }
+
+    this.stopListeningForEvents();
+
+    return this.webex.internal.mercury.disconnect()
+      .then(() => {
+        this.trigger(DSS_UNREGISTERED);
+        this.registered = false;
+      });
+  },
+
+  /**
+   * registers for DSS events through mercury
+   * @returns {undefined}
+   * @private
+   */
+  listenForEvents() {
+    this.webex.internal.mercury.on(DSS_LOOKUP_MERCURY_EVENT, (envelope) => {
+      this._handleEvent(envelope.data);
+    });
+    this.webex.internal.mercury.on(DSS_SEARCH_MERCURY_EVENT, (envelope) => {
+      this._handleEvent(envelope.data);
+    });
+  },
+
+  /**
+   * unregisteres all the DSS events from mercury
+   * @returns {undefined}
+   * @private
+   */
+  stopListeningForEvents() {
+    this.webex.internal.mercury.off(DSS_LOOKUP_MERCURY_EVENT);
+    this.webex.internal.mercury.off(DSS_SEARCH_MERCURY_EVENT);
+  },
+
+  /**
+   * @param {UUID} requestId the id of the request
+   * @returns {string}
+   */
+  _getResultEventName(requestId) {
+    return `${DSS_RESULT}${requestId}`;
+  },
+
+  /**
+   * @param {Object} data the event data
+   * @returns {undefined}
+   */
+  _handleEvent(data) {
+    this.trigger(this._getResultEventName(data.requestId), data);
+    this.trigger(DSS_LOOKUP_RESULT, data);
+  },
+
+  /**
+    * Makes the request to the directory service
+    * @param {Object} options
+    * @param {string} options.resource the URL to query
+    * @param {string} options.params additional params for the body of the request
+    * @param {string} options.dataPath to path to get the data in the result object
+    * @returns {Promise} Resolves with an array of entities found
+  */
+  _request(options) {
+    const {resource, params, dataPath} = options;
+
+    const requestId = uuid.v4();
+    const eventName = this._getResultEventName(requestId);
+    const result = {};
+    let expectedSeqNums;
+
+    return new Promise((resolve) => {
+      this.listenTo(this, eventName, (data) => {
+        const resultData = get(data, dataPath);
+
+        result[data.sequence] = resultData;
+
+        if (data.finished) {
+          expectedSeqNums = range(data.sequence + 1).map(String);
+        }
+
+        const done = isEqual(expectedSeqNums, Object.keys(result));
+
+        if (done) {
+          const resultArray = [];
+          expectedSeqNums.forEach((index) => {
+            const seqResult = result[index];
+            if (seqResult) {
+              resultArray.push(...seqResult);
+            }
+          })
+
+          resolve(resultArray);
+          this.stopListening(this, eventName);
+        }
+      });
+      this.webex.request({
+        service: DSS_SERVICE_NAME,
+        resource,
+        method: 'POST',
+        contentType: 'application/json',
+        body: {requestId, ...params}
+      });
+    });
+  },
+
+  /**
+   * Retrieves detailed information about an entity
+   * @param {Object} options
+   * @param {UUID} options.id the id of the entity to lookup
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  lookupDetail(options: LookupDetailOptions) {
+    const {id} = options;
+
+    return this._request({
+      dataPath: 'lookupResult.entities',
+      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identity/${id}/detail`
+    });
+  },
+
+  /**
+   * Retrieves basic information about a list entities within an organization
+   * @param {Object} options
+   * @param {UUID} options.ids the id of the entity to lookup
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  lookup(options: LookupOptions) {
+    const {ids} = options;
+
+    return this._request({
+      dataPath: 'lookupResult.entities',
+      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/identities`,
+      params: {
+        lookupValues: ids,
+      }
+    });
+  },
+
+  /**
+   * Retrieves basic information about a list entities within an organization
+   * @param {Object} options
+   * @param {UUID} options.emails the emails of the entities to lookup
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  lookupByEmail(options: LookupByEmailOptions) {
+    const {emails} = options;
+
+    return this._request({
+      dataPath: 'lookupResult.entities',
+      resource: `/lookup/orgid/${this.webex.internal.device.orgId}/emails`,
+      params: {
+        lookupValues: emails,
+      }
+    });
+  },
+
+  /**
+   * Search for information about entities
+   * @param {Object} options
+   * @param {SearchType[]} options.requestedTypes an array of search types from: PERSON, CALLING_SERVICE, EXTERNAL_CALLING, ROOM, ROBOT
+   * @param {string[]} options.queryString A query string that will be transformed into a Directory search filter query. It is used to search the following fields: username, givenName, familyName, displayName and email
+   * @param {number} options.resultSize The maximum number of results returned from each provider
+   * @returns {Promise} Resolves with an array of entities found
+   */
+  search(options: SearchOptions) {
+    const {
+      requestedTypes, resultSize, queryString
+    } = options;
+
+    return this._request({
+      dataPath: 'directoryEntities',
+      resource: `/search/orgid/${this.webex.internal.device.orgId}/entities`,
+      params: {
+        queryString,
+        resultSize,
+        requestedTypes
+      }
+    });
+  }
+
+});
+
+export default DSS;

package/src/index.ts

@@ -0,0 +1,7 @@
+import {registerInternalPlugin} from '@webex/webex-core';
+
+import DSS from './dss';
+
+registerInternalPlugin('dss', DSS);
+
+export {default} from './dss';

package/src/types.ts

@@ -0,0 +1,25 @@
+export interface LookupDetailOptions {
+  id: string;
+}
+
+export interface LookupOptions {
+  ids: string[];
+}
+
+export interface LookupByEmailOptions {
+  emails: string[];
+}
+
+export enum SearchType {
+  PERSON = 'PERSON', 
+  CALLING_SERVICE = 'CALLING_SERVICE',
+  EXTERNAL_CALLING = 'EXTERNAL_CALLING',
+  ROOM = 'ROOM',
+  ROBOT = 'ROBOT'
+}
+
+export interface SearchOptions {
+  requestedTypes: SearchType[],
+  resultSize: number,
+  queryString: string,
+}

package/test/unit/spec/dss.ts

@@ -0,0 +1,363 @@
+/*!
+ * Copyright (c) 2015-2022 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import { assert } from "@webex/test-helper-chai";
+import DSS from "@webex/internal-plugin-dss";
+import MockWebex from "@webex/test-helper-mock-webex";
+import sinon from "sinon";
+import { expect } from "chai";
+import { set } from "lodash";
+import uuid from "uuid";
+
+describe("plugin-dss", () => {
+  describe("DSS", () => {
+    let webex;
+    let uuidStub;
+    let mercuryCallbacks;
+
+    beforeEach(() => {
+      webex = new MockWebex({
+        canAuthorize: false,
+        children: {
+          dss: DSS,
+        },
+      });
+
+      uuidStub = sinon.stub(uuid, "v4").returns("randomid");
+
+      webex.canAuthorize = true;
+      webex.internal.device.orgId = "userOrgId";
+
+      mercuryCallbacks = {};
+
+      webex.internal.mercury = {
+        connect: sinon.stub().returns(Promise.resolve()),
+        disconnect: sinon.stub().returns(Promise.resolve()),
+        on: sinon.stub().callsFake((event, callback) => {
+          mercuryCallbacks[event] = callback;
+        }),
+        off: sinon.spy(),
+      };
+    });
+
+    afterEach(() => {
+      uuidStub.restore();
+    });
+
+    describe("#register()", () => {
+      it("registers correctly", async () => {
+        await webex.internal.dss.register();
+
+        assert.callCount(webex.internal.mercury.on, 2);
+
+        const firstCallArgs = webex.internal.mercury.on.getCall(0).args;
+        expect(firstCallArgs[0]).to.equal("event:directory.lookup");
+        expect(firstCallArgs[1]).to.be.a("function");
+
+        const secondCallArgs = webex.internal.mercury.on.getCall(1).args;
+        expect(secondCallArgs[0]).to.equal("event:directory.search");
+        expect(secondCallArgs[1]).to.be.a("function");
+
+        assert.equal(webex.internal.dss.registered, true);
+      });
+
+      it("rejects when it cannot authorize", async () => {
+        webex.canAuthorize = false;
+        await expect(webex.internal.dss.register()).to.be.rejectedWith(
+          Error,
+          "SDK cannot authorize"
+        );
+        assert.equal(webex.internal.dss.registered, false);
+      });
+    });
+
+    describe("#unregister()", () => {
+      it("unregisters correctly", async () => {
+        webex.internal.dss.registered = true;
+        await webex.internal.dss.unregister();
+
+        assert.callCount(webex.internal.mercury.off, 2);
+
+        const firstCallArgs = webex.internal.mercury.off.getCall(0).args;
+        expect(firstCallArgs[0]).to.equal("event:directory.lookup");
+
+        const secondCallArgs = webex.internal.mercury.off.getCall(1).args;
+        expect(secondCallArgs[0]).to.equal("event:directory.search");
+
+        assert.equal(webex.internal.dss.registered, false);
+      });
+
+      it("handles unregister when it is not registered", async () => {
+        const result = await webex.internal.dss.unregister();
+        await expect(result).equal(undefined);
+        assert.equal(webex.internal.dss.registered, false);
+      });
+    });
+
+    const createData = (requestId, sequence, finished, dataPath) => {
+      const data = {
+        requestId,
+        sequence,
+      };
+      if (finished) {
+        (data as any).finished = finished;
+      }
+      set(data, dataPath, [`data${sequence}`]);
+      return { data };
+    };
+
+    const testRequest = async ({
+      method,
+      resource,
+      params,
+      bodyParams,
+      dataPath,
+      event,
+    }) => {
+      webex.request = sinon.stub();
+
+      await webex.internal.dss.register();
+
+      const promise = webex.internal.dss[method](params);
+
+      const requestId = "randomid";
+
+      expect(webex.request.getCall(0).args).to.deep.equal([
+        {
+          service: "directorySearch",
+          body: {
+            requestId,
+            ...bodyParams,
+          },
+          contentType: "application/json",
+          method: "POST",
+          resource,
+        },
+      ]);
+
+      mercuryCallbacks[event](createData(requestId, 1, false, dataPath));
+      mercuryCallbacks[event](createData(requestId, 2, true, dataPath));
+      mercuryCallbacks[event](createData(requestId, 0, false, dataPath));
+
+      const result = await promise;
+      expect(result).to.deep.equal(["data0", "data1", "data2"]);
+    };
+
+    describe("#lookupDetail", () => {
+      it("calls _request correctly", async () => {
+        webex.internal.device.orgId = "userOrgId";
+        webex.internal.dss._request = sinon
+          .stub()
+          .returns(Promise.resolve("some return value"));
+
+        const result = await webex.internal.dss.lookupDetail({ id: "test id" });
+        expect(webex.internal.dss._request.getCall(0).args).to.deep.equal([
+          {
+            dataPath: "lookupResult.entities",
+            resource: '/lookup/orgid/userOrgId/identity/test id/detail',
+          },
+        ]);
+        expect(result).to.equal("some return value");
+      });
+
+      it("works correctly", async () => {
+        await testRequest({
+          method: "lookupDetail",
+          dataPath: "lookupResult.entities",
+          event: "event:directory.lookup",
+          resource: '/lookup/orgid/userOrgId/identity/test id/detail',
+          params: {
+            id: "test id",
+          },
+          bodyParams: {},
+        });
+      });
+    });
+
+    describe("#lookup", () => {
+      it("calls _request correctly", async () => {
+        webex.internal.device.orgId = "userOrgId";
+        webex.internal.dss._request = sinon
+          .stub()
+          .returns(Promise.resolve("some return value"));
+
+        const result = await webex.internal.dss.lookup({ ids: ["id1", "id2"] });
+        expect(webex.internal.dss._request.getCall(0).args).to.deep.equal([
+          {
+            dataPath: "lookupResult.entities",
+            resource: '/lookup/orgid/userOrgId/identities',
+            params: {
+              lookupValues: ["id1", "id2"],
+            },
+          },
+        ]);
+        expect(result).to.equal("some return value");
+      });
+
+      it("works correctly", async () => {
+        await testRequest({
+          method: "lookup",
+          dataPath: "lookupResult.entities",
+          event: "event:directory.lookup",
+          resource: '/lookup/orgid/userOrgId/identities',
+          params: {
+            ids: ["id1", "id2"],
+          },
+          bodyParams: {
+            lookupValues: ["id1", "id2"],
+          },
+        });
+      });
+    });
+
+    describe("#lookupByEmail", () => {
+      it("calls _request correctly", async () => {
+        webex.internal.device.orgId = "userOrgId";
+        webex.internal.dss._request = sinon
+          .stub()
+          .returns(Promise.resolve("some return value"));
+
+        const result = await webex.internal.dss.lookupByEmail({
+          emails: ["email1", "email2"],
+        });
+        expect(webex.internal.dss._request.getCall(0).args).to.deep.equal([
+          {
+            dataPath: "lookupResult.entities",
+            resource: '/lookup/orgid/userOrgId/emails',
+            params: {
+              lookupValues: ["email1", "email2"],
+            },
+          },
+        ]);
+        expect(result).to.equal("some return value");
+      });
+
+      it("works correctly", async () => {
+        await testRequest({
+          method: "lookupByEmail",
+          dataPath: "lookupResult.entities",
+          event: "event:directory.lookup",
+          resource: '/lookup/orgid/userOrgId/emails',
+          params: {
+            emails: ["email1", "email2"],
+          },
+          bodyParams: {
+            lookupValues: ["email1", "email2"],
+          },
+        });
+      });
+    });
+
+    describe("#search", () => {
+      it("calls _request correctly", async () => {
+        webex.internal.device.orgId = "userOrgId";
+        webex.internal.dss._request = sinon
+          .stub()
+          .returns(Promise.resolve("some return value"));
+
+        const result = await webex.internal.dss.search({
+          requestedTypes: ["PERSON", "ROBOT"],
+          resultSize: 100,
+          queryString: "query",
+        });
+        expect(webex.internal.dss._request.getCall(0).args).to.deep.equal([
+          {
+            dataPath: "directoryEntities",
+            resource: '/search/orgid/userOrgId/entities',
+            params: {
+              queryString: "query",
+              resultSize: 100,
+              requestedTypes: ["PERSON", "ROBOT"],
+            },
+          },
+        ]);
+        expect(result).to.equal("some return value");
+      });
+
+      it("works correctly", async () => {
+        await testRequest({
+          method: "search",
+          event: "event:directory.search",
+          dataPath: "directoryEntities",
+          resource: '/search/orgid/userOrgId/entities',
+          params: {
+            requestedTypes: ["PERSON", "ROBOT"],
+            resultSize: 100,
+            queryString: "query",
+          },
+          bodyParams: {
+            requestedTypes: ["PERSON", "ROBOT"],
+            resultSize: 100,
+            queryString: "query",
+          },
+        });
+      });
+    });
+
+    describe("#_request", () => {
+      it("handles a request correctly", async () => {
+        webex.request = sinon.stub();
+        uuid.v4.returns("randomid");
+        const promise = webex.internal.dss._request({
+          resource: "/search/orgid/userOrgId/entities",
+          params: { some: "param" },
+          dataPath: "a.b.c",
+        });
+
+        expect(webex.request.getCall(0).args).to.deep.equal([
+          {
+            service: "directorySearch",
+            body: {
+              requestId: "randomid",
+              some: "param",
+            },
+            contentType: "application/json",
+            method: "POST",
+            resource: "/search/orgid/userOrgId/entities",
+          },
+        ]);
+
+        webex.internal.dss.trigger(
+          webex.internal.dss._getResultEventName("randomid"),
+          {
+            sequence: 1,
+            a: {
+              b: {
+                c: ["data1"],
+              },
+            },
+          }
+        );
+
+        webex.internal.dss.trigger(
+          webex.internal.dss._getResultEventName("randomid"),
+          {
+            sequence: 2,
+            finished: true,
+            a: {
+              b: {
+                c: ["data2"],
+              },
+            },
+          }
+        );
+
+        webex.internal.dss.trigger(
+          webex.internal.dss._getResultEventName("randomid"),
+          {
+            sequence: 0,
+            a: {
+              b: {
+                c: ["data0"],
+              },
+            },
+          }
+        );
+
+        const result = await promise;
+        expect(result).to.deep.equal(["data0", "data1", "data2"]);
+      });
+    });
+  });
+});