drop support for array in AuthnMethod config param

Author: mt-gdiniz

src/__tests__/helper.test.ts

@@ -1,7 +1,6 @@
 import { constructScopes, getIsTabValue, mergeConfigs, generateConfigs } from '../helper';
 import packageJson from '../../package.json';
 import { AuthAction, AuthnMethod, ConfigsOptions } from '../typings';
-import { stringify } from 'qs';
 
 describe('helper', () => {
   test('constuctScopes', () => {
@@ -133,45 +132,27 @@ describe('helper', () => {
       );
     });
 
-    test('with authnMethod parameter as an array', () => {
-      const configPayload: ConfigsOptions = {
-        authnMethod: ['sso', 'passwordless']
-      };
-
-      expect(generateConfigs(configPayload)).toBe(
-        `sdk_platform=js&sdk_version=${packageJson.version}&authn_method%5B%5D=sso&authn_method%5B%5D=passwordless`
-      );
-    });
-
     test('query encoding should make sure config params are also encoded', () => {
       const configPayload: ConfigsOptions = {
         email: 'email&!@#(*)-304should be_encoded',
         backTo: 'backTo #!@with []special= chars',
         authAction: 'signup',
         showAuthToggle: true,
         showRememberMe: true,
-        authnMethod: ['sso', 'passwordless']
+        authnMethod: 'sso'
       };
 
       expect(generateConfigs(configPayload)).toBe(
-        `sdk_platform=js&sdk_version=${packageJson.version}&email=email%26%21%40%23%28%2A%29-304should%20be_encoded&back_to=backTo%20%23%21%40with%20%5B%5Dspecial%3D%20chars&auth_action=signup&show_auth_toggle=true&show_remember_me=true&authn_method%5B%5D=sso&authn_method%5B%5D=passwordless`
+        `sdk_platform=js&sdk_version=${packageJson.version}&email=email%26%21%40%23%28%2A%29-304should%20be_encoded&back_to=backTo%20%23%21%40with%20%5B%5Dspecial%3D%20chars&auth_action=signup&show_auth_toggle=true&show_remember_me=true&authn_method=sso`
       );
     });
 
-    test('Should filter out invalid authnMethod from array and authAction values', () => {
+    test('Should raise an error when passing an array in authnMethod', () => {
       const configPayload: ConfigsOptions = {
-        email: 'email',
-        backTo: 'backTo',
-        authAction: 'invalid-value' as AuthAction,
-        showAuthToggle: true,
-        showRememberMe: true,
-        authnMethod: ['oh-not-valid', 'sso'] as AuthnMethod[]
+        authnMethod: ['oh-not-valid', 'should raise'] as unknown as AuthnMethod
       };
 
-      expect(generateConfigs(configPayload)).toBe(
-        `sdk_platform=js&sdk_version=${packageJson.version}&email=email&back_to=backTo&show_auth_toggle=true` +
-          `&show_remember_me=true&authn_method=sso`
-      );
+      expect(() => generateConfigs(configPayload)).toThrow(TypeError);
     });
 
     test('Should reject invalid authnMethod from config', () => {

src/helper.ts

@@ -72,7 +72,7 @@ export function mergeConfigs(
 }
 
 export function generateConfigs(configs: ConfigsOptions = {}): string {
-  const snakeCaseConfigs: { [key: string]: string | AuthAction | boolean | AuthnMethod[] | undefined } = {};
+  const snakeCaseConfigs: { [key: string]: string | AuthAction | boolean | undefined } = {};
 
   const configKeys = [
     'email',
@@ -101,34 +101,20 @@ export function generateConfigs(configs: ConfigsOptions = {}): string {
     }
   }
 
-  return stringify(
-    {
-      sdk_platform: 'js',
-      sdk_version: __VERSION__,
-      ...snakeCaseConfigs
-    },
-    { indices: false, arrayFormat: 'brackets' }
-  );
+  return stringify({
+    sdk_platform: 'js',
+    sdk_version: __VERSION__,
+    ...snakeCaseConfigs
+  });
 }
 
-function isAuthnMethod(x: unknown): x is AuthnMethod | AuthnMethod[] {
-  if (Array.isArray(x)) {
-    return (
-      x.length > 0 &&
-      x.every((el: AuthnMethod) => {
-        return supportedAuthnMethod.includes(el);
-      })
-    );
-  }
-
+function isAuthnMethod(x: unknown): x is AuthnMethod {
   return supportedAuthnMethod.includes(x as AuthnMethod);
 }
 
-function parseAuthnMethod(x: unknown): AuthnMethod[] | AuthnMethod | undefined {
+function parseAuthnMethod(x: unknown): AuthnMethod | undefined {
   if (Array.isArray(x)) {
-    let filtered_x = x.filter((el: AuthnMethod) => supportedAuthnMethod.includes(el));
-
-    filtered_x.length == 1 ? (x = filtered_x.toString()) : (x = filtered_x);
+    throw new TypeError('Array is not allowed for authnMethod');
   }
 
   return isAuthnMethod(x) ? x : undefined;

src/typings.ts

@@ -22,7 +22,7 @@ export interface ConfigsOptions extends PrivateConfigsOptions {
   showRememberMe?: boolean;
   isNewTab?: boolean;
   forceLogout?: boolean;
-  authnMethod?: AuthnMethod | AuthnMethod[];
+  authnMethod?: AuthnMethod;
 }
 
 export type ServicesListType = {