@webex/webex-core 1.154.2 → 1.155.0

package/dist/interceptors/webex-user-agent.js

@@ -79,16 +79,23 @@ var WebexUserAgentInterceptor = /*#__PURE__*/function (_Interceptor) {
      * @returns {Object}
      */
     function onRequest(options) {
+      var _this$webex$config, _this$webex;
+
       options.headers = options.headers || {};
 
-      var _ref = this.webex && this.webex.config ? this.webex.config : {},
+      var _ref = (_this$webex$config = (_this$webex = this.webex) === null || _this$webex === void 0 ? void 0 : _this$webex.config) !== null && _this$webex$config !== void 0 ? _this$webex$config : {},
           appName = _ref.appName,
-          appVersion = _ref.appVersion;
+          appVersion = _ref.appVersion,
+          appPlatform = _ref.appPlatform;
+
+      var sparkUserAgent = "".concat(strings.get(this));
 
-      var sparkUserAgent = strings.get(this);
+      if (appName) {
+        sparkUserAgent += " ".concat(appName, "/").concat(appVersion !== null && appVersion !== void 0 ? appVersion : '0.0');
+      }
 
-      if (appName && appVersion) {
-        sparkUserAgent = "".concat(appName, "/").concat(appVersion, " ").concat(strings.get(this));
+      if (appPlatform) {
+        sparkUserAgent += " ".concat(appPlatform);
       }
 
       if (options.uri && options.uri.includes('https://idbroker')) {

package/dist/interceptors/webex-user-agent.js.map

@@ -1 +1 @@
-{"version":3,"sources":["webex-user-agent.js"],"names":["strings","WebexUserAgentInterceptor","options","libName","libVersion","set","inBrowser","headers","webex","config","appName","appVersion","sparkUserAgent","get","uri","includes","credentials","samlUrl","tokenUrl","authorizeUrl","Interceptor"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;;;;;AAGA,IAAMA,OAAO,GAAG,sBAAhB;AAEA;AACA;AACA;;IACqBC,yB;;;;;AACnB;AACF;AACA;AACA;AACA;AACA;AACE,uCAA0B;AAAA;;AAAA,QAAdC,OAAc,uEAAJ,EAAI;AAAA;AACxB,QAAMC,OAAO,GAAG,mBAAID,OAAJ,EAAa,aAAb,EAA4B,KAA5B,IAAqC,OAArC,GAA+C,cAA/D;AACA,QAAME,UAAU,GAAG,mBAAIF,OAAJ,EAAa,eAAb,EAA8B,aAA9B,CAAnB;AAEA,8BAAMA,OAAN;AACAF,IAAAA,OAAO,CAACK,GAAR,wDAAqBF,OAArB,cAAgCC,UAAhC,eAA+CE,oBAAY,KAAZ,GAAoB,MAAnE;AALwB;AAMzB;AAED;AACF;AACA;;;;;;AAKE;AACF;AACA;AACA;AACA;AACE,uBAAUJ,OAAV,EAAmB;AACjBA,MAAAA,OAAO,CAACK,OAAR,GAAkBL,OAAO,CAACK,OAAR,IAAmB,EAArC;;AACA,iBAA+B,KAAKC,KAAL,IAAc,KAAKA,KAAL,CAAWC,MAA1B,GAAoC,KAAKD,KAAL,CAAWC,MAA/C,GAAwD,EAAtF;AAAA,UAAOC,OAAP,QAAOA,OAAP;AAAA,UAAgBC,UAAhB,QAAgBA,UAAhB;;AACA,UAAIC,cAAc,GAAGZ,OAAO,CAACa,GAAR,CAAY,IAAZ,CAArB;;AAEA,UAAIH,OAAO,IAAIC,UAAf,EAA2B;AACzBC,QAAAA,cAAc,aAAMF,OAAN,cAAiBC,UAAjB,cAA+BX,OAAO,CAACa,GAAR,CAAY,IAAZ,CAA/B,CAAd;AACD;;AAED,UAAIX,OAAO,CAACY,GAAR,IAAeZ,OAAO,CAACY,GAAR,CAAYC,QAAZ,CAAqB,kBAArB,CAAnB,EAA6D;AAC3D,eAAOb,OAAP;AACD;;AAED,UAAIA,OAAO,CAACY,GAAR,KAAgBZ,OAAO,CAACY,GAAR,CAAYC,QAAZ,CAAqB,KAAKP,KAAL,CAAWC,MAAX,CAAkBO,WAAlB,CAA8BC,OAAnD,KAA+Df,OAAO,CAACY,GAAR,CAAYC,QAAZ,CAAqB,KAAKP,KAAL,CAAWC,MAAX,CAAkBO,WAAlB,CAA8BE,QAAnD,CAA/D,IAA+HhB,OAAO,CAACY,GAAR,CAAYC,QAAZ,CAAqB,KAAKP,KAAL,CAAWC,MAAX,CAAkBO,WAAlB,CAA8BG,YAAnD,CAA/I,CAAJ,EAAsN;AACpN,eAAOjB,OAAP;AACD;;AAED,UAAI,sBAAsBA,OAAO,CAACK,OAAlC,EAA2C;AACzC,YAAI,CAACL,OAAO,CAACK,OAAR,CAAgB,kBAAhB,CAAL,EAA0C;AACxC,uCAAuBL,OAAO,CAACK,OAA/B,EAAwC,kBAAxC;AACD;;AAED,eAAOL,OAAP;AACD;;AAEDA,MAAAA,OAAO,CAACK,OAAR,CAAgB,kBAAhB,IAAsCK,cAAtC;AAEA,aAAOV,OAAP;AACD;;;WArCD,kBAAgB;AACd,aAAO,IAAID,yBAAJ,CAA8B;AAACO,QAAAA,KAAK,EAAE;AAAR,OAA9B,CAAP;AACD;;;EApBoDY,qB","sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {inBrowser} from '@webex/common';\nimport {Interceptor} from '@webex/http-core';\nimport {get} from 'lodash';\n\nconst strings = new WeakMap();\n\n/**\n * @class\n */\nexport default class WebexUserAgentInterceptor extends Interceptor {\n  /**\n   * @param {Object} [options={}]\n   * @param {WebexCore} [options.webex]\n   * @private\n   * @returns {WebexUserAgentInterceptor}\n   */\n  constructor(options = {}) {\n    const libName = get(options, 'webex.webex', false) ? 'webex' : 'webex-js-sdk';\n    const libVersion = get(options, 'webex.version', 'development');\n\n    super(options);\n    strings.set(this, `${libName}/${libVersion} (${inBrowser ? 'web' : 'node'})`);\n  }\n\n  /**\n   * @returns {WebexUserAgentInterceptor}\n   */\n  static create() {\n    return new WebexUserAgentInterceptor({webex: this});\n  }\n\n  /**\n   * @see Interceptor#onRequest\n   * @param {Object} options\n   * @returns {Object}\n   */\n  onRequest(options) {\n    options.headers = options.headers || {};\n    const {appName, appVersion} = (this.webex && this.webex.config) ? this.webex.config : {};\n    let sparkUserAgent = strings.get(this);\n\n    if (appName && appVersion) {\n      sparkUserAgent = `${appName}/${appVersion} ${strings.get(this)}`;\n    }\n\n    if (options.uri && options.uri.includes('https://idbroker')) {\n      return options;\n    }\n\n    if (options.uri && (options.uri.includes(this.webex.config.credentials.samlUrl) || options.uri.includes(this.webex.config.credentials.tokenUrl) || options.uri.includes(this.webex.config.credentials.authorizeUrl))) {\n      return options;\n    }\n\n    if ('spark-user-agent' in options.headers) {\n      if (!options.headers['spark-user-agent']) {\n        Reflect.deleteProperty(options.headers, 'spark-user-agent');\n      }\n\n      return options;\n    }\n\n    options.headers['spark-user-agent'] = sparkUserAgent;\n\n    return options;\n  }\n}\n"]}
+{"version":3,"sources":["webex-user-agent.js"],"names":["strings","WebexUserAgentInterceptor","options","libName","libVersion","set","inBrowser","headers","webex","config","appName","appVersion","appPlatform","sparkUserAgent","get","uri","includes","credentials","samlUrl","tokenUrl","authorizeUrl","Interceptor"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA;;AACA;;;;;;AAGA,IAAMA,OAAO,GAAG,sBAAhB;AAEA;AACA;AACA;;IACqBC,yB;;;;;AACnB;AACF;AACA;AACA;AACA;AACA;AACE,uCAA0B;AAAA;;AAAA,QAAdC,OAAc,uEAAJ,EAAI;AAAA;AACxB,QAAMC,OAAO,GAAG,mBAAID,OAAJ,EAAa,aAAb,EAA4B,KAA5B,IAAqC,OAArC,GAA+C,cAA/D;AACA,QAAME,UAAU,GAAG,mBAAIF,OAAJ,EAAa,eAAb,EAA8B,aAA9B,CAAnB;AAEA,8BAAMA,OAAN;AACAF,IAAAA,OAAO,CAACK,GAAR,wDAAqBF,OAArB,cAAgCC,UAAhC,eAA+CE,oBAAY,KAAZ,GAAoB,MAAnE;AALwB;AAMzB;AAED;AACF;AACA;;;;;;AAKE;AACF;AACA;AACA;AACA;AACE,uBAAUJ,OAAV,EAAmB;AAAA;;AACjBA,MAAAA,OAAO,CAACK,OAAR,GAAkBL,OAAO,CAACK,OAAR,IAAmB,EAArC;;AACA,sDAII,KAAKC,KAJT,gDAII,YAAYC,MAJhB,mEAI0B,EAJ1B;AAAA,UACEC,OADF,QACEA,OADF;AAAA,UAEEC,UAFF,QAEEA,UAFF;AAAA,UAGEC,WAHF,QAGEA,WAHF;;AAKA,UAAIC,cAAc,aAAMb,OAAO,CAACc,GAAR,CAAY,IAAZ,CAAN,CAAlB;;AAEA,UAAIJ,OAAJ,EAAa;AACXG,QAAAA,cAAc,eAAQH,OAAR,cAAmBC,UAAnB,aAAmBA,UAAnB,cAAmBA,UAAnB,GAAiC,KAAjC,CAAd;AACD;;AAED,UAAIC,WAAJ,EAAiB;AACfC,QAAAA,cAAc,eAAQD,WAAR,CAAd;AACD;;AAED,UAAIV,OAAO,CAACa,GAAR,IAAeb,OAAO,CAACa,GAAR,CAAYC,QAAZ,CAAqB,kBAArB,CAAnB,EAA6D;AAC3D,eAAOd,OAAP;AACD;;AAED,UACEA,OAAO,CAACa,GAAR,KAEEb,OAAO,CAACa,GAAR,CAAYC,QAAZ,CAAqB,KAAKR,KAAL,CAAWC,MAAX,CAAkBQ,WAAlB,CAA8BC,OAAnD,KACAhB,OAAO,CAACa,GAAR,CAAYC,QAAZ,CAAqB,KAAKR,KAAL,CAAWC,MAAX,CAAkBQ,WAAlB,CAA8BE,QAAnD,CADA,IAEAjB,OAAO,CAACa,GAAR,CAAYC,QAAZ,CAAqB,KAAKR,KAAL,CAAWC,MAAX,CAAkBQ,WAAlB,CAA8BG,YAAnD,CAJF,CADF,EAOE;AACA,eAAOlB,OAAP;AACD;;AAED,UAAI,sBAAsBA,OAAO,CAACK,OAAlC,EAA2C;AACzC,YAAI,CAACL,OAAO,CAACK,OAAR,CAAgB,kBAAhB,CAAL,EAA0C;AACxC,uCAAuBL,OAAO,CAACK,OAA/B,EAAwC,kBAAxC;AACD;;AAED,eAAOL,OAAP;AACD;;AAEDA,MAAAA,OAAO,CAACK,OAAR,CAAgB,kBAAhB,IAAsCM,cAAtC;AAEA,aAAOX,OAAP;AACD;;;WApDD,kBAAgB;AACd,aAAO,IAAID,yBAAJ,CAA8B;AAACO,QAAAA,KAAK,EAAE;AAAR,OAA9B,CAAP;AACD;;;EApBoDa,qB","sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {inBrowser} from '@webex/common';\nimport {Interceptor} from '@webex/http-core';\nimport {get} from 'lodash';\n\nconst strings = new WeakMap();\n\n/**\n * @class\n */\nexport default class WebexUserAgentInterceptor extends Interceptor {\n  /**\n   * @param {Object} [options={}]\n   * @param {WebexCore} [options.webex]\n   * @private\n   * @returns {WebexUserAgentInterceptor}\n   */\n  constructor(options = {}) {\n    const libName = get(options, 'webex.webex', false) ? 'webex' : 'webex-js-sdk';\n    const libVersion = get(options, 'webex.version', 'development');\n\n    super(options);\n    strings.set(this, `${libName}/${libVersion} (${inBrowser ? 'web' : 'node'})`);\n  }\n\n  /**\n   * @returns {WebexUserAgentInterceptor}\n   */\n  static create() {\n    return new WebexUserAgentInterceptor({webex: this});\n  }\n\n  /**\n   * @see Interceptor#onRequest\n   * @param {Object} options\n   * @returns {Object}\n   */\n  onRequest(options) {\n    options.headers = options.headers || {};\n    const {\n      appName,\n      appVersion,\n      appPlatform\n    } = this.webex?.config ?? {};\n    let sparkUserAgent = `${strings.get(this)}`;\n\n    if (appName) {\n      sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;\n    }\n\n    if (appPlatform) {\n      sparkUserAgent += ` ${appPlatform}`;\n    }\n\n    if (options.uri && options.uri.includes('https://idbroker')) {\n      return options;\n    }\n\n    if (\n      options.uri &&\n      (\n        options.uri.includes(this.webex.config.credentials.samlUrl) ||\n        options.uri.includes(this.webex.config.credentials.tokenUrl) ||\n        options.uri.includes(this.webex.config.credentials.authorizeUrl)\n      )\n    ) {\n      return options;\n    }\n\n    if ('spark-user-agent' in options.headers) {\n      if (!options.headers['spark-user-agent']) {\n        Reflect.deleteProperty(options.headers, 'spark-user-agent');\n      }\n\n      return options;\n    }\n\n    options.headers['spark-user-agent'] = sparkUserAgent;\n\n    return options;\n  }\n}\n"]}

package/dist/lib/batcher.js

@@ -329,7 +329,7 @@ var Batcher = _webexPlugin.default.extend({
   fingerprintResponse: function fingerprintResponse(item) {
     throw new Error('fingerprintResponse() must be implemented');
   },
-  version: "1.154.2"
+  version: "1.155.0"
 });
 
 var _default2 = Batcher;

package/dist/lib/credentials/credentials.js

@@ -590,7 +590,7 @@ var Credentials = _webexPlugin.default.extend((_dec = (0, _common.oneFlight)({
       this.refresh();
     }
   },
-  version: "1.154.2"
+  version: "1.155.0"
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "getUserToken", [_dec, _dec2], (0, _getOwnPropertyDescriptor.default)(_obj, "getUserToken"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "initialize", [_dec3], (0, _getOwnPropertyDescriptor.default)(_obj, "initialize"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "invalidate", [_common.oneFlight, _dec4], (0, _getOwnPropertyDescriptor.default)(_obj, "invalidate"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "refresh", [_common.oneFlight, _dec5, _dec6], (0, _getOwnPropertyDescriptor.default)(_obj, "refresh"), _obj)), _obj)));
 
 var _default = Credentials;

package/dist/lib/credentials/token.js

@@ -605,7 +605,7 @@ var Token = _webexPlugin.default.extend((_dec = (0, _common.oneFlight)({
       return res.body;
     });
   },
-  version: "1.154.2"
+  version: "1.155.0"
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "downscope", [_dec], (0, _getOwnPropertyDescriptor.default)(_obj, "downscope"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "refresh", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "refresh"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "revoke", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "revoke"), _obj)), _obj)));
 
 var _default = Token;

package/dist/lib/services/services.js

@@ -1036,7 +1036,7 @@ var Services = _webexPlugin.default.extend({
       }
     });
   },
-  version: "1.154.2"
+  version: "1.155.0"
 });
 /* eslint-enable no-underscore-dangle */
 

package/dist/plugins/logger.js

@@ -70,7 +70,7 @@ var Logger = _webexPlugin.default.extend({
   info: wrapConsoleMethod('info'),
   debug: wrapConsoleMethod('debug'),
   trace: wrapConsoleMethod('trace'),
-  version: "1.154.2"
+  version: "1.155.0"
 });
 
 (0, _webexCore.registerPlugin)('logger', Logger);

package/dist/webex-core.js

@@ -159,7 +159,7 @@ var MAX_FILE_SIZE_IN_MB = 2048;
  */
 
 var WebexCore = _ampersandState.default.extend((_obj = {
-  version: "1.154.2",
+  version: "1.155.0",
   children: {
     internal: _webexInternalCore.default
   },
@@ -757,7 +757,7 @@ var WebexCore = _ampersandState.default.extend((_obj = {
   }
 }, ((0, _applyDecoratedDescriptor2.default)(_obj, "_uploadPhaseUpload", [_common.retry], (0, _getOwnPropertyDescriptor.default)(_obj, "_uploadPhaseUpload"), _obj)), _obj));
 
-WebexCore.version = "1.154.2";
+WebexCore.version = "1.155.0";
 (0, _webexInternalCorePluginMixin.default)(_webexInternalCore.default, _config.default, interceptors);
 (0, _webexCorePluginMixin.default)(WebexCore, _config.default, interceptors);
 var _default = WebexCore;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/webex-core",
-  "version": "1.154.2",
+  "version": "1.155.0",
   "description": "Plugin handling for Cisco Webex",
   "license": "MIT",
   "contributors": [
@@ -28,15 +28,15 @@
     "@babel/runtime-corejs2": "^7.14.8",
     "lodash": "^4.17.21",
     "ampersand-state": "^5.0.3",
-    "@webex/common": "1.154.2",
+    "@webex/common": "1.155.0",
     "ampersand-events": "^2.0.2",
-    "@webex/http-core": "1.154.2",
+    "@webex/http-core": "1.155.0",
     "uuid": "^3.3.2",
     "jsonwebtoken": "^8.5.1",
-    "@webex/common-timers": "1.154.2",
+    "@webex/common-timers": "1.155.0",
     "ampersand-collection": "^2.0.2",
     "crypto-js": "^4.1.1",
-    "@webex/webex-core": "1.154.2",
+    "@webex/webex-core": "1.155.0",
     "core-decorators": "^0.20.0",
     "envify": "^4.1.0"
   }

package/src/interceptors/webex-user-agent.js

@@ -40,18 +40,33 @@ export default class WebexUserAgentInterceptor extends Interceptor {
    */
   onRequest(options) {
     options.headers = options.headers || {};
-    const {appName, appVersion} = (this.webex && this.webex.config) ? this.webex.config : {};
-    let sparkUserAgent = strings.get(this);
+    const {
+      appName,
+      appVersion,
+      appPlatform
+    } = this.webex?.config ?? {};
+    let sparkUserAgent = `${strings.get(this)}`;
 
-    if (appName && appVersion) {
-      sparkUserAgent = `${appName}/${appVersion} ${strings.get(this)}`;
+    if (appName) {
+      sparkUserAgent += ` ${appName}/${appVersion ?? '0.0'}`;
+    }
+
+    if (appPlatform) {
+      sparkUserAgent += ` ${appPlatform}`;
     }
 
     if (options.uri && options.uri.includes('https://idbroker')) {
       return options;
     }
 
-    if (options.uri && (options.uri.includes(this.webex.config.credentials.samlUrl) || options.uri.includes(this.webex.config.credentials.tokenUrl) || options.uri.includes(this.webex.config.credentials.authorizeUrl))) {
+    if (
+      options.uri &&
+      (
+        options.uri.includes(this.webex.config.credentials.samlUrl) ||
+        options.uri.includes(this.webex.config.credentials.tokenUrl) ||
+        options.uri.includes(this.webex.config.credentials.authorizeUrl)
+      )
+    ) {
       return options;
     }
 

package/test/unit/spec/interceptors/webex-user-agent.js

@@ -54,7 +54,28 @@ describe('webex-core', () => {
 
           assert.property(options, 'headers');
           assert.property(options.headers, 'spark-user-agent');
-          assert.equal(options.headers['spark-user-agent'], `sample/1.0.0 webex-js-sdk/${pkg.version} (${typeof window === 'undefined' ? 'node' : 'web'})`);
+          assert.equal(options.headers['spark-user-agent'], `webex-js-sdk/${pkg.version} (${typeof window === 'undefined' ? 'node' : 'web'}) sample/1.0.0`);
+        });
+
+        it('adds a spark-user-agent header using appName/appVersion + appPlatform from config', () => {
+          const interceptor = Reflect.apply(WebexUserAgentInterceptor.create, {
+            version: pkg.version,
+            config: {
+              appName: 'sample',
+              appVersion: '1.0.0',
+              appPlatform: 'custom-label/1.0.0'
+            }
+          }, []);
+
+          const options = {
+            headers: {}
+          };
+
+          interceptor.onRequest(options);
+
+          assert.property(options, 'headers');
+          assert.property(options.headers, 'spark-user-agent');
+          assert.equal(options.headers['spark-user-agent'], `webex-js-sdk/${pkg.version} (${typeof window === 'undefined' ? 'node' : 'web'}) sample/1.0.0 custom-label/1.0.0`);
         });
 
         describe('when consumed by the webex package', () => {