Add response_hint to login URL and type ui_options as string or array…

… of string Details: https://nodejs.org/api/querystring.html#querystring_querystring_stringify_obj_sep_eq_options
ringcentral · May 27, 2020 · 30d7582 · 30d7582
1 parent 5659f76
commit 30d7582
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 2 deletions.
diff --git a/sdk/src/platform/Platform-spec.ts b/sdk/src/platform/Platform-spec.ts
@@ -508,6 +508,26 @@ describe('RingCentral.platform.Platform', () => {
                         usePKCE: true,
                     }),
                 ).to.throw('PKCE only works with Authrization Code Flow');
+
+                expect(
+                    platform.loginUrl({
+                        implicit: false,
+                        uiOptions: ['foo', 'bar'],
+                        responseHint: ['baz', 'quux'],
+                    }),
+                ).to.equal(
+                    'http://whatever/restapi/oauth/authorize?response_type=code&redirect_uri=http%3A%2F%2Ffoo&client_id=whatever&state=&brand_id=&display=&prompt=&ui_options=foo&ui_options=bar&ui_locales=&localeId=&response_hint=baz&response_hint=quux',
+                );
+
+                expect(
+                    platform.loginUrl({
+                        implicit: false,
+                        uiOptions: 'foo',
+                        responseHint: 'bar',
+                    }),
+                ).to.equal(
+                    'http://whatever/restapi/oauth/authorize?response_type=code&redirect_uri=http%3A%2F%2Ffoo&client_id=whatever&state=&brand_id=&display=&prompt=&ui_options=foo&ui_locales=&localeId=&response_hint=bar',
+                );
             }),
         );
     });

diff --git a/sdk/src/platform/Platform.ts b/sdk/src/platform/Platform.ts
@@ -173,6 +173,7 @@ export default class Platform extends EventEmitter {
         uiLocales,
         localeId,
         usePKCE,
+        responseHint,
     }: LoginUrlOptions = {}) {
         let query: AuthorizationQuery = {
             response_type: implicit ? 'token' : 'code',
@@ -186,6 +187,9 @@ export default class Platform extends EventEmitter {
             ui_locales: uiLocales,
             localeId,
         };
+        if (responseHint) {
+            query.response_hint = responseHint;
+        }
         if (usePKCE && implicit) {
             throw new Error('PKCE only works with Authrization Code Flow');
         }
@@ -646,10 +650,11 @@ export interface LoginUrlOptions {
     display?: LoginUrlDisplay | string;
     prompt?: LoginUrlPrompt | string;
     implicit?: boolean;
-    uiOptions?: string;
+    uiOptions?: string | string[];
     uiLocales?: string;
     localeId?: string;
     usePKCE?: boolean;
+    responseHint?: string | string[];
 }
 
 export enum LoginUrlPrompt {
@@ -682,13 +687,14 @@ export interface LoginWindowOptions {
 
 export interface AuthorizationQuery {
     response_type: 'token' | 'code';
+    response_hint?: string | string[];
     redirect_uri: string;
     client_id: string;
     state?: string;
     brand_id?: string;
     display?: LoginUrlDisplay | string;
     prompt?: LoginUrlPrompt | string;
-    ui_options?: string;
+    ui_options?: string | string[];
     ui_locales?: string;
     localeId?: string;
     code_challenge?: string;