Javascript API for integrating 3rd-party apps with PureCloud. 

Javascript API for integrating 3rd-party apps with Genesys Cloud

purecloud

purecloud-client-app-sdk

Javascript API for integrating 3rd-party apps with PureCloud

* This software comprises other FOSS software.

* Attribution and license information can be found at https://github.com/MyPureCloud/client-app-sdk/blob/master/README.md

function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }

var _classCallCheck = _interopDefault(require('@babel/runtime/helpers/classCallCheck'));

var _createClass = _interopDefault(require('@babel/runtime/helpers/createClass'));

var _defineProperty = _interopDefault(require('@babel/runtime/helpers/defineProperty'));

var queryString = require('query-string');

var _slicedToArray = _interopDefault(require('@babel/runtime/helpers/slicedToArray'));

var _extends = _interopDefault(require('@babel/runtime/helpers/extends'));

var _typeof = _interopDefault(require('@babel/runtime/helpers/typeof'));

var _get = _interopDefault(require('@babel/runtime/helpers/get'));

var _inherits = _interopDefault(require('@babel/runtime/helpers/inherits'));

var _possibleConstructorReturn = _interopDefault(require('@babel/runtime/helpers/possibleConstructorReturn'));

var _getPrototypeOf = _interopDefault(require('@babel/runtime/helpers/getPrototypeOf'));

function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }

function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }

var DEFAULT_PC_ENV_TLD = 'mypurecloud.com';

var PC_ENV_TLDS = ['mypurecloud.com', 'mypurecloud.com.au', 'mypurecloud.ie', 'mypurecloud.jp', 'mypurecloud.de', 'usw2.pure.cloud', 'euw2.pure.cloud', 'cac1.pure.cloud', 'apne2.pure.cloud'].concat([]);

var PC_ENVS = PC_ENV_TLDS.map(function (tld) {

    pcAppOrigin: "https://apps.".concat(tld)

var _PC_ENVS$filter = PC_ENVS.filter(function (env) {

  return env.pcEnvTld === DEFAULT_PC_ENV_TLD;

    _PC_ENVS$filter2 = _slicedToArray(_PC_ENVS$filter, 1),

    DEFAULT_PC_ENV = _PC_ENVS$filter2[0];

   * Attempts to locate a PC environment corresponding to the provided search params

   * @param pcEnvTld A string representing the PureCloud environment top-level domain to search for

   * @param lenient When true, trims leading/trailing whitespace, ignores leading '.', and ignores trailing '/'.

   * @returns A PureCloud environment object if found; null otherwise.

  lookupPcEnv: function lookupPcEnv(pcEnvTld) {

    var lenient = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;

    if (pcEnvTld && typeof pcEnvTld === 'string') {

        if (toSearch.indexOf('.') === 0) {

          toSearch = toSearch.substring(1);

        if (toSearch.indexOf('/') === toSearch.length - 1) {

          toSearch = toSearch.substring(0, toSearch.length - 1);

      var _iterator = _createForOfIteratorHelper(PC_ENVS),

        for (_iterator.s(); !(_step = _iterator.n()).done;) {

          if (env.pcEnvTld === toSearch) return env;

   * Posts the provided msg to the specified origin and parent window when invoked within the

   * expected environment (e.g. a frame hosted within PureCloud).

   * @param msg - The payload to send as a postMessage

      agentName: cfg.protocolAgentName || "purecloud-client-app-sdk",

      agentVersion: cfg.protocolAgentVersion || "2.0.0-beta.1"

      agentVersion: cfg.protocolAgentVersion || "2.0.0-beta.2"

   * Sends the message to purecloud augmenting with environmental details such as

   * target env origin and version info.  Accessible by extenders.

    value: function sendMsgToPc(actionName, msgPayload) {

      this._commsUtils.postMsgToPc(this.buildSdkMsgPayload(actionName, msgPayload), this._targetPcOrigin);

     * Constructs a payload tailored for the PureCloud Client Apps SDK.  Can be

     * overridden by extenders, but should not be invoked externally.

     * @param actionName - The name of the client-app action to invoke

     * @param msgPayload - Action-specific payload data

     * @returns A postMessage payload for the Client Apps SDK

    value: function buildSdkMsgPayload(actionName, msgPayload) {

      var result = {}; // Clone the payload

      if (msgPayload && _typeof(msgPayload) === 'object') {

        result = JSON.parse(JSON.stringify(msgPayload));

      result.protocol = this._protocolDetails.name;

      result.protocolAgentName = this._protocolDetails.agentName;

      result.protocolAgentVersion = this._protocolDetails.agentVersion;

     * Adds the specified listener to messages sent from the host PureCloud appliation

     * @param eventType - The name of the purecloudEventType in the message; case and leading/trailing space sensitive

     * @param listener - The listener function to invoke when a message of the specified eventType

     *   is received.  Message data will be passed

     * @param options - Options for the invocation of the listener; null/undefined will use defaults

    value: function addMsgListener(eventType, listener) {

      var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};

      if (!eventType || typeof eventType !== 'string' || eventType.trim().length === 0) {

        throw new Error('Invalid eventType provided to addMsgListener');

      if (!listener || typeof listener !== 'function') {

        throw new Error('Invalid listener provided to addMsgListener');

        options: this._buildNormalizedListenerOptions(options)

      var listenerCfgs = this._msgListenerCfgs[eventType];

        this._msgListenerCfgs[eventType] = listenerCfgs;

      } else if (listenerCfgs.length > 0) {

        listenerCfgs.forEach(function (currListenerCfg) {

          if (_this._isDuplicateListenerCfg(currListenerCfg, proposedListenerCfg)) {

        listenerCfgs.push(proposedListenerCfg);

        if (this._getListenerCount() === 1) {

          // This is the addition of the only active listener, start listening

      return "purecloud-client-app-sdk".concat("v", "2.0.0-beta.1");

      return "purecloud-client-app-sdk".concat("v", "2.0.0-beta.2");

      return window && window.location ? window.location.search : null;

  "description": "Javascript API for integrating 3rd-party apps with PureCloud",

  "browser": "dist/purecloud-client-app-sdk.js",

    "tsc": "tsc --project tsconfig.json --noEmit",

    "tsc:build": "tsc --project tsconfig.build.json",

    "examples": "node scripts/build-examples.js",

    "start": "rollup --config dev.rollup.config.js --watch",

    "rollup": "rollup --config rollup.config.js",

    "docs": "ts-node scripts/build-docs.ts",

    "pretest": "npm run lint && npm run tsc",

    "test": "karma start --single-run --browsers PhantomJS",

    "publish-examples": "ts-node scripts/publish-examples.ts",

    "name": "Genesys Telecommunications Laboratories, Inc.",

    "url": "https://developer.mypurecloud.com"

  "homepage": "https://github.com/MyPureCloud/client-app-sdk",

    "url": "https://github.com/MyPureCloud/client-app-sdk/issues"

    "url": "https://github.com/MyPureCloud/client-app-sdk.git"

    "@babel/plugin-proposal-class-properties": "^7.10.1",

    "@babel/plugin-transform-object-assign": "^7.10.3",

    "@babel/plugin-transform-runtime": "^7.10.1",

    "@babel/preset-typescript": "^7.10.1",

    "@rollup/plugin-commonjs": "^13.0.0",

    "@rollup/plugin-node-resolve": "^8.0.1",

    "@types/child-process-promise": "^2.2.1",

    "@typescript-eslint/eslint-plugin": "^3.2.0",

    "@typescript-eslint/parser": "^3.2.0",

    "eslint-config-standard": "^11.0.0-beta.0",

    "karma-phantomjs-launcher": "^1.0.0",

    "karma-rollup-preprocessor": "^7.0.5",

    "purecloud-api-sdk-common": "git://github.com/MyPureCloud/purecloud_api_sdk_common.git",

		@@ -192,3 +192,3 @@ 'use strict';
		agentName: cfg.protocolAgentName \|\| "purecloud-client-app-sdk",
		agentVersion: cfg.protocolAgentVersion \|\| "2.0.0-beta.1"
		agentVersion: cfg.protocolAgentVersion \|\| "2.0.0-beta.2"
		};
		@@ -1594,3 +1594,3 @@ }
		value: function about() {
		return "purecloud-client-app-sdk".concat("v", "2.0.0-beta.1");
		return "purecloud-client-app-sdk".concat("v", "2.0.0-beta.2");
		}
		@@ -1611,3 +1611,3 @@ /**
		get: function get() {
		return "2.0.0-beta.1";
		return "2.0.0-beta.2";
		}
		@@ -1614,0 +1614,0 @@ }]);

		{
		"name": "purecloud-client-app-sdk",
		"version": "2.0.0-beta.1",
		"version": "2.0.0-beta.2",
		"description": "Javascript API for integrating 3rd-party apps with PureCloud",
		@@ -5,0 +5,0 @@ "main": "dist/main.js",