@webex/plugin-authorization-browser 3.8.0 → 3.8.1-next.2

package/package.json

@@ -24,23 +24,23 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-appid": "3.8.0",
-    "@webex/test-helper-automation": "3.8.0",
-    "@webex/test-helper-chai": "3.8.0",
-    "@webex/test-helper-mocha": "3.8.0",
-    "@webex/test-helper-mock-webex": "3.8.0",
-    "@webex/test-helper-test-users": "3.8.0",
+    "@webex/test-helper-appid": "3.8.1-next.2",
+    "@webex/test-helper-automation": "3.8.1-next.2",
+    "@webex/test-helper-chai": "3.8.1-next.2",
+    "@webex/test-helper-mocha": "3.8.1-next.2",
+    "@webex/test-helper-mock-webex": "3.8.1-next.2",
+    "@webex/test-helper-test-users": "3.8.1-next.2",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.0",
-    "@webex/internal-plugin-device": "3.8.0",
-    "@webex/plugin-authorization-node": "3.8.0",
-    "@webex/storage-adapter-local-storage": "3.8.0",
-    "@webex/storage-adapter-spec": "3.8.0",
-    "@webex/webex-core": "3.8.0",
+    "@webex/common": "3.8.1-next.2",
+    "@webex/internal-plugin-device": "3.8.1-next.2",
+    "@webex/plugin-authorization-node": "3.8.1-next.2",
+    "@webex/storage-adapter-local-storage": "3.8.1-next.2",
+    "@webex/storage-adapter-spec": "3.8.1-next.2",
+    "@webex/webex-core": "3.8.1-next.2",
     "jsonwebtoken": "^9.0.2",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
@@ -54,5 +54,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner jest"
   },
-  "version": "3.8.0"
+  "version": "3.8.1-next.2"
 }

package/src/authorization.js

@@ -113,13 +113,26 @@ const Authorization = WebexPlugin.extend({
     return ret;
   },
 
-  /**
-   * Kicks off an oauth flow
-   * @instance
-   * @memberof AuthorizationBrowser
-   * @param {Object} options
-   * @returns {Promise}
-   */
+/**
+ * Initiates the OAuth flow for user authentication.
+ * This function determines the type of OAuth flow to use based on the client type configuration.
+ * If the client is configured as "confidential", it will initiate the Authorization Code Grant flow;
+ * otherwise, it will initiate the Implicit Grant flow.
+ *
+ * @instance
+ * @memberof AuthorizationBrowser
+ * @param {Object} options - The options to configure the OAuth flow.
+ * @param {Object} [options.state] - An optional state object that can be used to include additional
+ * information such as security tokens. A CSRF token will be automatically generated and added to
+ * this state object.
+ * @param {boolean|Object} [options.separateWindow] - Determines if the login should open in a separate window.
+ * This can be a boolean or an object specifying window features:
+ *   - If `true`, a new window with default dimensions is opened.
+ *   - If an object, custom window features can be specified (e.g., `{width: 800, height: 600}`).
+ * @returns {Promise<void>} - A promise that resolves when the appropriate OAuth flow has been initiated.
+ * The promise does not necessarily indicate the completion of the login process.
+ * @throws {Error} - Throws an error if there are issues initiating the OAuth flow.
+ */
   initiateLogin(options = {}) {
     options.state = options.state || {};
     options.state.csrf_token = this._generateSecurityToken();
@@ -134,20 +147,52 @@ const Authorization = WebexPlugin.extend({
   },
 
   @whileInFlight('isAuthorizing')
-  /**
-   * Kicks off the Authorization Code grant flow. Typically called via
-   * {@link AuthorizationBrowser#initiateLogin}
-   * @instance
-   * @memberof AuthorizationBrowser
-   * @param {Object} options
-   * @returns {Promise}
-   */
+/**
+ * Initiates the Implicit Grant flow for authorization.
+ * This function constructs the login URL and either opens it in a new
+ * window or in the current window based on the provided options.
+ * Typically called via {@link AuthorizationBrowser#initiateLogin}.
+ *
+ * @instance
+ * @memberof AuthorizationBrowser
+ * @param {Object} options - The options to configure the login flow.
+ * @param {Object} [options.separateWindow] - Determines if the login should open in a separate window.
+ * This can be a boolean or an object specifying window features:
+ *   - If `true`, a new window with default dimensions is opened.
+ *   - If an object, custom window features can be specified (e.g., `{width: 800, height: 600}`).
+ * @returns {Promise<void>} - A promise that resolves immediately after initiating the login flow.
+ * This promise does not indicate the completion of the login process.
+ * @throws {Error} - Throws an error if the login URL cannot be constructed or if window opening fails.
+ */
   initiateImplicitGrant(options) {
+
     this.logger.info('authorization: initiating implicit grant flow');
-    this.webex.getWindow().location = this.webex.credentials.buildLoginUrl(
+    const loginUrl = this.webex.credentials.buildLoginUrl(
       Object.assign({response_type: 'token'}, options)
     );
 
+    if (options?.separateWindow) {
+      // Default window settings
+      const defaultWindowSettings = {
+        width: 600,
+        height: 800
+      };
+
+      // Merge user provided settings with defaults
+      const windowSettings = Object.assign(
+        defaultWindowSettings, 
+        typeof options.separateWindow === 'object' ? options.separateWindow : {}
+      );
+      // Convert settings object to window.open features string
+      const windowFeatures = Object.entries(windowSettings)
+        .map(([key, value]) => `${key}=${value}`)
+        .join(',');
+      this.webex.getWindow().open(loginUrl, '_blank', windowFeatures);
+    } else {
+      // Default behavior - open in same window
+      this.webex.getWindow().location = loginUrl;
+    }
+
     return Promise.resolve();
   },
 

package/test/unit/spec/authorization.js

@@ -408,6 +408,65 @@ describe('plugin-authorization-browser', () => {
           assert.include(webex.getWindow().location, 'response_type=token');
         });
       });
+
+      it('redirects to the login page in the same window by default', () => {
+        const webex = makeWebexCore();
+
+        return webex.authorization.initiateImplicitGrant().then(() => {
+          assert.isDefined(webex.getWindow().location);
+          assert.isUndefined(webex.getWindow().open);
+        });
+      });
+
+      it('opens login page in a new window when separateWindow is true', () => {
+        const webex = makeWebexCore();
+        webex.getWindow().open = sinon.spy();
+
+        return webex.authorization.initiateImplicitGrant({ separateWindow: true }).then(() => {
+          assert.called(webex.getWindow().open);
+          const openCall = webex.getWindow().open.getCall(0);
+          assert.equal(openCall.args[1], '_blank');
+          assert.equal(openCall.args[2], 'width=600,height=800');
+        });
+      });
+
+      it('opens login page in a new window with custom dimensions', () => {
+        const webex = makeWebexCore();
+        webex.getWindow().open = sinon.spy();
+
+        const customWindow = {
+          width: 800,
+          height: 600,
+          menubar: 'no',
+          toolbar: 'no'
+        };
+
+        return webex.authorization.initiateImplicitGrant({ 
+          separateWindow: customWindow 
+        }).then(() => {
+          assert.called(webex.getWindow().open);
+          const openCall = webex.getWindow().open.getCall(0);
+          assert.equal(openCall.args[1], '_blank');
+          assert.equal(
+            openCall.args[2], 
+            'width=800,height=600,menubar=no,toolbar=no'
+          );
+        });
+      });
+
+      it('preserves other options when using separateWindow', () => {
+        const webex = makeWebexCore();
+        webex.getWindow().open = sinon.spy();
+
+        return webex.authorization.initiateImplicitGrant({ 
+          separateWindow: true,
+          state: {}
+        }).then(() => {
+          assert.called(webex.getWindow().open);
+          const url = webex.getWindow().open.getCall(0).args[0];
+          assert.include(url, "https://idbrokerbts.webex.com/idb/oauth2/v1/authorize?response_type=token&separateWindow=true&client_id=fake&redirect_uri=http%3A%2F%2Fexample.com&scope=scope%3Aone");
+        });
+      });
     });
 
     describe('#initiateAuthorizationCodeGrant()', () => {