Option to exclude params from request

runtime/config-params.ts

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

runtime/params.spec.ts

@@ -40,6 +40,23 @@ describe('SkyAppRuntimeConfigParams', () => {
     expect(params.getUrl('https://mysite.com?c=d')).toEqual('https://mysite.com?c=d&a1=b');
   });
 
+  it('should exclude certain parameters from being added to a url\'s querystring', () => {
+    const params: SkyAppRuntimeConfigParams = new SkyAppRuntimeConfigParams(
+      '?a1=b&b2=c3&z4=y',
+      {
+        'a1': true,
+        'b2': {
+          required: true
+        },
+        'z4': {
+          excludeFromRequests: true
+        }
+      }
+    );
+
+    expect(params.getUrl('https://mysite.com?c=d')).toEqual('https://mysite.com?c=d&a1=b&b2=c3');
+  });
+
   it('should not add a current param if the url already has it', () => {
     const params: SkyAppRuntimeConfigParams = new SkyAppRuntimeConfigParams(
       '?a1=b',

runtime/params.ts

@@ -20,11 +20,17 @@ function getUrlSearchParams(url: string): URLSearchParams {
 }
 
 export class SkyAppRuntimeConfigParams {
+
   private params: { [key: string]: string } = {};
+
   private defaultParamValues: { [key: string]: string } = {};
+
   private requiredParams: string[] = [];
+
   private encodedParams: string[] = [];
 
+  private excludeFromRequestsParams: string[] = [];
+
   constructor(
     url: string,
     configParams: SkyuxConfigParams
@@ -63,6 +69,10 @@ export class SkyAppRuntimeConfigParams {
               this.params[paramName] = paramValue;
               this.defaultParamValues[paramName] = paramValue;
             }
+
+            if (configParam.excludeFromRequests) {
+              this.excludeFromRequestsParams.push(paramName);
+            }
           }
         }
       }
@@ -178,7 +188,10 @@ export class SkyAppRuntimeConfigParams {
     let joined: string[] = [];
 
     this.getAllKeys().forEach(key => {
-      if (!urlSearchParams.has(key)) {
+      if (
+        this.excludeFromRequestsParams.indexOf(key) === -1 &&
+        !urlSearchParams.has(key)
+      ) {
         joined.push(`${key}=${encodeURIComponent(this.get(key, true))}`);
       }
     });

skyuxconfig-schema.json

@@ -191,7 +191,32 @@
       "type": [
         "array",
         "object"
-      ]
+      ],
+      "items": {
+        "type": "string"
+      },
+      "patternProperties": {
+        "^.*$": {
+          "type": [
+            "boolean",
+            "object"
+          ],
+          "properties": {
+            "required": {
+              "description": "Indicates the parameter must be supplied to the application in order to function.",
+              "type": "boolean"
+            },
+            "value": {
+              "description": "The default value of the parameter. This value may be overridden at runtime by the query string or other future sources of parameter values."
+            },
+            "excludeFromRequests": {
+              "description": "Indicates whether the parameter should be excluded from the parameters automatically added to the query string of URLs requested with SkyAuthHttp.",
+              "type": "boolean",
+              "default": true
+            }
+          }
+        }
+      }
     },
     "plugins": {
       "description": "Specifies plugins to expand on existing SKY UX Builder functionality and create new functionality.",

skyuxconfig.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "./skyuxconfig-schema.json",
   "mode": "advanced",
   "host": {
     "url": "https://host.nxt.blackbaud.com"