@webex/common 3.12.0-next.2 → 3.12.0-next.3

package/dist/index.js

@@ -104,6 +104,12 @@ _Object$defineProperty(exports, "createEventEnvelope", {
     return _eventEnvelope.createEventEnvelope;
   }
 });
+_Object$defineProperty(exports, "decodeState", {
+  enumerable: true,
+  get: function get() {
+    return _oauthState.decodeState;
+  }
+});
 _Object$defineProperty(exports, "deconstructHydraId", {
   enumerable: true,
   get: function get() {
@@ -122,6 +128,12 @@ _Object$defineProperty(exports, "deviceType", {
     return _constants.deviceType;
   }
 });
+_Object$defineProperty(exports, "encodeState", {
+  enumerable: true,
+  get: function get() {
+    return _oauthState.encodeState;
+  }
+});
 _Object$defineProperty(exports, "ensureMyIdIsAvailable", {
   enumerable: true,
   get: function get() {
@@ -239,6 +251,7 @@ var _makeStateDatatype = _interopRequireDefault(require("./make-state-datatype")
 var _templateContainer = _interopRequireDefault(require("./template-container"));
 var _oneFlight = _interopRequireDefault(require("./one-flight"));
 var _patterns = _interopRequireDefault(require("./patterns"));
+var _oauthState = require("./oauth-state");
 var _events = require("./events");
 var _eventEnvelope = require("./event-envelope");
 var _resolveWith = _interopRequireDefault(require("./resolve-with"));

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_base","_interopRequireDefault","require","_isBuffer","_cappedDebounce","_checkRequired","_defer","_makeStateDatatype","_templateContainer","_oneFlight","_patterns","_events","_eventEnvelope","_resolveWith","_retry","_tap","_whileInFlight","_exception","_deprecated","_inBrowser","_constants","_browserDetection","_interopRequireWildcard","_uuidUtils","e","t","_WeakMap","r","n","__esModule","o","i","f","__proto__","default","_typeof","has","get","set","_t","hasOwnProperty","call","_Object$defineProperty","_Object$getOwnPropertyDescriptor"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nexport {default as base64} from './base64';\nexport {default as isBuffer} from './isBuffer';\nexport {default as cappedDebounce} from './capped-debounce';\nexport {default as checkRequired} from './check-required';\nexport {default as Defer} from './defer';\nexport {default as makeStateDataType} from './make-state-datatype';\nexport {default as make} from './template-container';\nexport {default as oneFlight} from './one-flight';\nexport {default as patterns} from './patterns';\n\nexport {proxyEvents, transferEvents} from './events';\nexport {createEventEnvelope, ensureMyIdIsAvailable} from './event-envelope';\nexport {default as resolveWith} from './resolve-with';\nexport {default as retry} from './retry';\nexport {default as tap} from './tap';\nexport {default as whileInFlight} from './while-in-flight';\nexport {default as Exception} from './exception';\nexport {default as deprecated} from './deprecated';\nexport {default as inBrowser} from './in-browser';\nexport {\n  deviceType,\n  hydraTypes,\n  SDK_EVENT,\n  INTERNAL_US_CLUSTER_NAME,\n  INTERNAL_US_INTEGRATION_CLUSTER_NAME,\n} from './constants';\n\nexport {default as BrowserDetection, getBrowserSerial} from './browser-detection';\nexport {\n  buildHydraMembershipId,\n  buildHydraMessageId,\n  buildHydraOrgId,\n  buildHydraPersonId,\n  buildHydraRoomId,\n  getHydraRoomType,\n  getHydraClusterString,\n  getHydraFiles,\n  constructHydraId,\n  deconstructHydraId,\n} from './uuid-utils';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,IAAAA,KAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,SAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,eAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,cAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,MAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,kBAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,kBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,UAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,SAAA,GAAAT,sBAAA,CAAAC,OAAA;AAEA,IAAAS,OAAA,GAAAT,OAAA;AACA,IAAAU,cAAA,GAAAV,OAAA;AACA,IAAAW,YAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,MAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,IAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,cAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,UAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,WAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,UAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,UAAA,GAAAlB,OAAA;AAQA,IAAAmB,iBAAA,GAAAC,uBAAA,CAAApB,OAAA;AACA,IAAAqB,UAAA,GAAArB,OAAA;AAWsB,SAAAoB,wBAAAE,CAAA,EAAAC,CAAA,6BAAAC,QAAA,MAAAC,CAAA,OAAAD,QAAA,IAAAE,CAAA,OAAAF,QAAA,YAAAJ,uBAAA,YAAAA,wBAAAE,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAC,OAAA,EAAAV,CAAA,iBAAAA,CAAA,gBAAAW,OAAA,CAAAX,CAAA,0BAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAM,GAAA,CAAAZ,CAAA,UAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,GAAAM,CAAA,CAAAQ,GAAA,CAAAd,CAAA,EAAAQ,CAAA,cAAAO,EAAA,IAAAf,CAAA,gBAAAe,EAAA,OAAAC,cAAA,CAAAC,IAAA,CAAAjB,CAAA,EAAAe,EAAA,OAAAR,CAAA,IAAAD,CAAA,GAAAY,sBAAA,KAAAC,gCAAA,CAAAnB,CAAA,EAAAe,EAAA,OAAAR,CAAA,CAAAM,GAAA,IAAAN,CAAA,CAAAO,GAAA,IAAAR,CAAA,CAAAE,CAAA,EAAAO,EAAA,EAAAR,CAAA,IAAAC,CAAA,CAAAO,EAAA,IAAAf,CAAA,CAAAe,EAAA,WAAAP,CAAA,KAAAR,CAAA,EAAAC,CAAA","ignoreList":[]}
+{"version":3,"names":["_base","_interopRequireDefault","require","_isBuffer","_cappedDebounce","_checkRequired","_defer","_makeStateDatatype","_templateContainer","_oneFlight","_patterns","_oauthState","_events","_eventEnvelope","_resolveWith","_retry","_tap","_whileInFlight","_exception","_deprecated","_inBrowser","_constants","_browserDetection","_interopRequireWildcard","_uuidUtils","e","t","_WeakMap","r","n","__esModule","o","i","f","__proto__","default","_typeof","has","get","set","_t","hasOwnProperty","call","_Object$defineProperty","_Object$getOwnPropertyDescriptor"],"sources":["index.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nexport {default as base64} from './base64';\nexport {default as isBuffer} from './isBuffer';\nexport {default as cappedDebounce} from './capped-debounce';\nexport {default as checkRequired} from './check-required';\nexport {default as Defer} from './defer';\nexport {default as makeStateDataType} from './make-state-datatype';\nexport {default as make} from './template-container';\nexport {default as oneFlight} from './one-flight';\nexport {default as patterns} from './patterns';\n\nexport {encodeState, decodeState} from './oauth-state';\nexport {proxyEvents, transferEvents} from './events';\nexport {createEventEnvelope, ensureMyIdIsAvailable} from './event-envelope';\nexport {default as resolveWith} from './resolve-with';\nexport {default as retry} from './retry';\nexport {default as tap} from './tap';\nexport {default as whileInFlight} from './while-in-flight';\nexport {default as Exception} from './exception';\nexport {default as deprecated} from './deprecated';\nexport {default as inBrowser} from './in-browser';\nexport {\n  deviceType,\n  hydraTypes,\n  SDK_EVENT,\n  INTERNAL_US_CLUSTER_NAME,\n  INTERNAL_US_INTEGRATION_CLUSTER_NAME,\n} from './constants';\n\nexport {default as BrowserDetection, getBrowserSerial} from './browser-detection';\nexport {\n  buildHydraMembershipId,\n  buildHydraMessageId,\n  buildHydraOrgId,\n  buildHydraPersonId,\n  buildHydraRoomId,\n  getHydraRoomType,\n  getHydraClusterString,\n  getHydraFiles,\n  constructHydraId,\n  deconstructHydraId,\n} from './uuid-utils';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,IAAAA,KAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,SAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,eAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,cAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,MAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,kBAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,kBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,UAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,SAAA,GAAAT,sBAAA,CAAAC,OAAA;AAEA,IAAAS,WAAA,GAAAT,OAAA;AACA,IAAAU,OAAA,GAAAV,OAAA;AACA,IAAAW,cAAA,GAAAX,OAAA;AACA,IAAAY,YAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,MAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,IAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,cAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,UAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,WAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,UAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,UAAA,GAAAnB,OAAA;AAQA,IAAAoB,iBAAA,GAAAC,uBAAA,CAAArB,OAAA;AACA,IAAAsB,UAAA,GAAAtB,OAAA;AAWsB,SAAAqB,wBAAAE,CAAA,EAAAC,CAAA,6BAAAC,QAAA,MAAAC,CAAA,OAAAD,QAAA,IAAAE,CAAA,OAAAF,QAAA,YAAAJ,uBAAA,YAAAA,wBAAAE,CAAA,EAAAC,CAAA,SAAAA,CAAA,IAAAD,CAAA,IAAAA,CAAA,CAAAK,UAAA,SAAAL,CAAA,MAAAM,CAAA,EAAAC,CAAA,EAAAC,CAAA,KAAAC,SAAA,QAAAC,OAAA,EAAAV,CAAA,iBAAAA,CAAA,gBAAAW,OAAA,CAAAX,CAAA,0BAAAA,CAAA,SAAAQ,CAAA,MAAAF,CAAA,GAAAL,CAAA,GAAAG,CAAA,GAAAD,CAAA,QAAAG,CAAA,CAAAM,GAAA,CAAAZ,CAAA,UAAAM,CAAA,CAAAO,GAAA,CAAAb,CAAA,GAAAM,CAAA,CAAAQ,GAAA,CAAAd,CAAA,EAAAQ,CAAA,cAAAO,EAAA,IAAAf,CAAA,gBAAAe,EAAA,OAAAC,cAAA,CAAAC,IAAA,CAAAjB,CAAA,EAAAe,EAAA,OAAAR,CAAA,IAAAD,CAAA,GAAAY,sBAAA,KAAAC,gCAAA,CAAAnB,CAAA,EAAAe,EAAA,OAAAR,CAAA,CAAAM,GAAA,IAAAN,CAAA,CAAAO,GAAA,IAAAR,CAAA,CAAAE,CAAA,EAAAO,EAAA,EAAAR,CAAA,IAAAC,CAAA,CAAAO,EAAA,IAAAf,CAAA,CAAAe,EAAA,WAAAP,CAAA,KAAAR,CAAA,EAAAC,CAAA","ignoreList":[]}

package/dist/oauth-state.js

@@ -0,0 +1,35 @@
+"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
+});
+exports.decodeState = decodeState;
+exports.encodeState = encodeState;
+var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/json/stringify"));
+var _base = require("./base64");
+/*!
+ * Copyright (c) 2015-2024 Cisco Systems, Inc. See LICENSE file.
+ */
+
+/**
+ * Encodes a state object for transport through OAuth redirect query strings.
+ * Serializes as JSON and encodes as base64url. Pairs with `decodeState`.
+ * @param {Object} state
+ * @returns {string}
+ */
+function encodeState(state) {
+  return (0, _base.toBase64Url)((0, _stringify.default)(state));
+}
+
+/**
+ * Decodes a base64url-encoded state string back into the original object.
+ * Pairs with `encodeState`. Throws if the input is not valid base64url JSON.
+ * @param {string} encoded
+ * @returns {Object}
+ */
+function decodeState(encoded) {
+  return JSON.parse((0, _base.fromBase64url)(encoded));
+}
+//# sourceMappingURL=oauth-state.js.map

package/dist/oauth-state.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_base","require","encodeState","state","toBase64Url","_stringify","default","decodeState","encoded","JSON","parse","fromBase64url"],"sources":["oauth-state.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2024 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {fromBase64url, toBase64Url} from './base64';\n\n/**\n * Encodes a state object for transport through OAuth redirect query strings.\n * Serializes as JSON and encodes as base64url. Pairs with `decodeState`.\n * @param {Object} state\n * @returns {string}\n */\nexport function encodeState(state) {\n  return toBase64Url(JSON.stringify(state));\n}\n\n/**\n * Decodes a base64url-encoded state string back into the original object.\n * Pairs with `encodeState`. Throws if the input is not valid base64url JSON.\n * @param {string} encoded\n * @returns {Object}\n */\nexport function decodeState(encoded) {\n  return JSON.parse(fromBase64url(encoded));\n}\n"],"mappings":";;;;;;;;;;AAIA,IAAAA,KAAA,GAAAC,OAAA;AAJA;AACA;AACA;;AAIA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,WAAWA,CAACC,KAAK,EAAE;EACjC,OAAO,IAAAC,iBAAW,EAAC,IAAAC,UAAA,CAAAC,OAAA,EAAeH,KAAK,CAAC,CAAC;AAC3C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACO,SAASI,WAAWA,CAACC,OAAO,EAAE;EACnC,OAAOC,IAAI,CAACC,KAAK,CAAC,IAAAC,mBAAa,EAACH,OAAO,CAAC,CAAC;AAC3C","ignoreList":[]}

package/package.json

@@ -29,10 +29,10 @@
     "@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.12.0-next.2",
-    "@webex/test-helper-mocha": "3.12.0-next.2",
-    "@webex/test-helper-mock-webex": "3.12.0-next.2",
-    "@webex/test-helper-test-users": "3.12.0-next.2",
+    "@webex/test-helper-chai": "3.12.0-next.3",
+    "@webex/test-helper-mocha": "3.12.0-next.3",
+    "@webex/test-helper-mock-webex": "3.12.0-next.3",
+    "@webex/test-helper-test-users": "3.12.0-next.3",
     "ampersand-state": "^5.0.3",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
@@ -55,5 +55,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner jest"
   },
-  "version": "3.12.0-next.2"
+  "version": "3.12.0-next.3"
 }

package/src/index.js

@@ -12,6 +12,7 @@ export {default as make} from './template-container';
 export {default as oneFlight} from './one-flight';
 export {default as patterns} from './patterns';
 
+export {encodeState, decodeState} from './oauth-state';
 export {proxyEvents, transferEvents} from './events';
 export {createEventEnvelope, ensureMyIdIsAvailable} from './event-envelope';
 export {default as resolveWith} from './resolve-with';

package/src/oauth-state.js

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) 2015-2024 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {fromBase64url, toBase64Url} from './base64';
+
+/**
+ * Encodes a state object for transport through OAuth redirect query strings.
+ * Serializes as JSON and encodes as base64url. Pairs with `decodeState`.
+ * @param {Object} state
+ * @returns {string}
+ */
+export function encodeState(state) {
+  return toBase64Url(JSON.stringify(state));
+}
+
+/**
+ * Decodes a base64url-encoded state string back into the original object.
+ * Pairs with `encodeState`. Throws if the input is not valid base64url JSON.
+ * @param {string} encoded
+ * @returns {Object}
+ */
+export function decodeState(encoded) {
+  return JSON.parse(fromBase64url(encoded));
+}

package/test/unit/spec/oauth-state.js

@@ -0,0 +1,69 @@
+/*!
+ * Copyright (c) 2015-2024 Cisco Systems, Inc. See LICENSE file.
+ */
+
+import {assert} from '@webex/test-helper-chai';
+import {decodeState, encodeState} from '@webex/common';
+
+describe('oauth-state', () => {
+  describe('encodeState() / decodeState()', () => {
+    it('encodeState produces the expected base64url string', () => {
+      const encoded = encodeState({csrf_token: 'abc'});
+
+      assert.equal(encoded, 'eyJjc3JmX3Rva2VuIjoiYWJjIn0');
+      assert.notInclude(encoded, '+');
+      assert.notInclude(encoded, '/');
+      assert.notInclude(encoded, '=');
+    });
+
+    it('encodeState produces the expected base64url string for an empty object', () => {
+      const encoded = encodeState({});
+
+      assert.equal(encoded, 'e30');
+      assert.notInclude(encoded, '+');
+      assert.notInclude(encoded, '/');
+      assert.notInclude(encoded, '=');
+    });
+
+    it('decodeState parses a known base64url string', () => {
+      assert.deepEqual(decodeState('eyJjc3JmX3Rva2VuIjoiYWJjIn0'), {csrf_token: 'abc'});
+    });
+
+    it('decodeState parses an empty-object encoding', () => {
+      assert.deepEqual(decodeState('e30'), {});
+    });
+
+    it('round-trips a typical state object', () => {
+      const state = {csrf_token: 'abc123', provider: 'google', returnURL: '/app'};
+      const encoded = encodeState(state);
+
+      assert.notInclude(encoded, '+');
+      assert.notInclude(encoded, '/');
+      assert.notInclude(encoded, '=');
+      assert.deepEqual(decodeState(encoded), state);
+    });
+
+    it('round-trips an empty object', () => {
+      const encoded = encodeState({});
+
+      assert.notInclude(encoded, '+');
+      assert.notInclude(encoded, '/');
+      assert.notInclude(encoded, '=');
+      assert.deepEqual(decodeState(encoded), {});
+    });
+
+    it('produces a url-safe encoding (no +, /, or = padding)', () => {
+      // Inputs chosen so the resulting bytes would include +, / and padding under
+      // standard base64.
+      const encoded = encodeState({a: '???>>>'});
+
+      assert.notInclude(encoded, '+');
+      assert.notInclude(encoded, '/');
+      assert.notInclude(encoded, '=');
+    });
+
+    it('throws when decoding invalid input', () => {
+      assert.throws(() => decodeState('not-valid-base64-json'));
+    });
+  });
+});