RC > Config params as an object; always decode URL params

runtime/auth-http.spec.ts

@@ -31,11 +31,11 @@ describe('SkyAuthHttp', () => {
         provide: SkyAppConfig,
         useValue: {
           runtime: {
-            params: new SkyAppRuntimeConfigParams(url, [
-              'envid',
-              'leid',
-              'svcid'
-            ])
+            params: new SkyAppRuntimeConfigParams(url, {
+              'envid': true,
+              'leid': true,
+              'svcid': true
+            })
           }
         }
       }

runtime/bootstrapper.spec.ts

@@ -29,7 +29,7 @@ describe('bootstrapper', () => {
 
       SkyAppBootstrapper.config = {
         auth: true,
-        params: []
+        params: {}
       };
 
       SkyAppBootstrapper.processBootstrapConfig().then(() => {
@@ -65,7 +65,7 @@ describe('bootstrapper', () => {
 
   it('should immediately resolve if SkyAppConfig.config.skyux.auth is not set', (done) => {
     SkyAppBootstrapper.config = {
-      params: []
+      params: {}
     };
 
     SkyAppBootstrapper.processBootstrapConfig().then(done);
@@ -77,7 +77,7 @@ describe('bootstrapper', () => {
 
     SkyAppBootstrapper.config = {
       auth: true,
-      params: []
+      params: {}
     };
 
     SkyAppBootstrapper.processBootstrapConfig().then(() => {

runtime/config-params.ts

@@ -1 +1,6 @@
-export type SkyuxConfigParams = string[] | { [key: string]: boolean | { value?: any; required?: boolean } };
+export type SkyuxConfigParams = {
+  [key: string]: boolean | {
+    value?: any;
+    required?: boolean
+  }
+};

runtime/params.spec.ts

@@ -2,10 +2,10 @@ import { SkyAppRuntimeConfigParams } from './params';
 
 describe('SkyAppRuntimeConfigParams', () => {
 
-  const allowed = [
-    'a1',
-    'a3'
-  ];
+  const allowed = {
+    'a1': true,
+    'a3': true
+  };
 
   it('should parse allowed params from a url', () => {
     const params: SkyAppRuntimeConfigParams = new SkyAppRuntimeConfigParams(
@@ -153,7 +153,7 @@ describe('SkyAppRuntimeConfigParams', () => {
     });
   });
 
-  it('should allow values to be decoded when retrieved from the query string', () => {
+  it('should decode values when retrieved from the query string', () => {
     const params = new SkyAppRuntimeConfigParams(
       '?a=%2F',
       {
@@ -164,14 +164,8 @@ describe('SkyAppRuntimeConfigParams', () => {
       }
     );
 
-    // Preserves previous behavior of not encoding values from the query string.
-    expect(params.get('a')).toBe('%2F');
-    expect(params.get('b')).toBe('%2F');
-
-    // The second parameter tells the get() method to decode the parameter if it's from the
-    // query string.
-    expect(params.get('a', true)).toBe('/');
-    expect(params.get('b', true)).toBe('%2F');
+    expect(params.get('a')).toBe('/');
+    expect(params.get('b')).toBe('/');
   });
 
   it('should allow queryparam values to be required', () => {
@@ -256,5 +250,4 @@ describe('SkyAppRuntimeConfigParams', () => {
 
     expect(params.getAllKeys()).toEqual([]);
   });
-
 });

runtime/params.ts

@@ -29,40 +29,28 @@ export class SkyAppRuntimeConfigParams {
     url: string,
     configParams: SkyuxConfigParams
   ) {
-    let allowed: string[];
-
-    // The default params value in Builder's skyuxconfig.json has been changed
-    // from an array to an object to support more metadata about each parameter,
-    // including the parameter's default value and possible future properties
-    // like required. Check for an array first to maintain backwards compatibility
-    // with the previous default value and any consumers who may be overriding the
-    // value until we release builder 2.0.
-    if (Array.isArray(configParams)) {
-      allowed = configParams;
-    } else {
-      allowed = [];
-
-      for (const paramName of Object.keys(configParams)) {
-        const configParam = configParams[paramName];
-
-        // The config param could be present but be set to false/undefined indicating
-        // an override of the default parameter.
-        if (configParam) {
-          allowed.push(paramName);
-
-          // A boolean value may be present to simply indicate that a parameter is allowed.
-          // If the type is object, look for additional config properties.
-          if (typeof configParam === 'object') {
-            const paramValue = configParam.value;
-
-            if (configParam.required) {
-              this.requiredParams.push(paramName);
-            }
-
-            if (paramValue) {
-              this.params[paramName] = paramValue;
-              this.defaultParamValues[paramName] = paramValue;
-            }
+    let allowed: string[] = [];
+
+    for (const paramName of Object.keys(configParams)) {
+      const configParam = configParams[paramName];
+
+      // The config param could be present but be set to false/undefined indicating
+      // an override of the default parameter.
+      if (configParam) {
+        allowed.push(paramName);
+
+        // A boolean value may be present to simply indicate that a parameter is allowed.
+        // If the type is object, look for additional config properties.
+        if (typeof configParam === 'object') {
+          const paramValue = configParam.value;
+
+          if (configParam.required) {
+            this.requiredParams.push(paramName);
+          }
+
+          if (paramValue) {
+            this.params[paramName] = paramValue;
+            this.defaultParamValues[paramName] = paramValue;
           }
         }
       }
@@ -122,20 +110,11 @@ export class SkyAppRuntimeConfigParams {
    * Returns the value of the requested param.
    * @name get
    * @param {string} key The parameter's key.
-   * @param {boolean} urlDecode A flag indicating whether the value should be URL-decoded.
-   * Specify true when you anticipate the value of the parameter coming from the page's URL.
    * @returns {string}
    */
-  public get(key: string, urlDecode?: boolean): string {
+  public get(key: string): string {
     if (this.has(key)) {
-      let val = this.params[key];
-
-      // This should be changed to always decode encoded params in skyux-builder 2.0.
-      if (urlDecode && this.encodedParams.indexOf(key) >= 0) {
-        val = decodeURIComponent(val);
-      }
-
-      return val;
+      return decodeURIComponent(this.params[key]);
     }
   }
 
@@ -179,7 +158,7 @@ export class SkyAppRuntimeConfigParams {
 
     this.getAllKeys().forEach(key => {
       if (!urlSearchParams.has(key)) {
-        joined.push(`${key}=${encodeURIComponent(this.get(key, true))}`);
+        joined.push(`${key}=${encodeURIComponent(this.get(key))}`);
       }
     });