feat: add generic consent management fields in initially onboarded destinations config

package.json

@@ -32,7 +32,8 @@
     "update:schema:source": "python3 scripts/schemaGenerator.py source -update -name ",
     "check:schema:destination:all": "python3 scripts/schemaGenerator.py destination -all",
     "check:schema:destination": "python3 scripts/schemaGenerator.py destination -name ",
-    "update:schema:destination": "python3 scripts/schemaGenerator.py destination -update -name "
+    "update:schema:destination": "python3 scripts/schemaGenerator.py destination -update -name ",
+    "deploy:db:local": "python3 scripts/deployToDB.py http://localhost:5050"
   },
   "devDependencies": {
     "@babel/core": "^7.21.3",

scripts/schemaGenerator.py

@@ -121,7 +121,7 @@ def is_field_present_in_default_config(field, dbConfig, schema_field_name):
     return False
 
 def generate_schema_for_default_checkbox(field, dbConfig, schema_field_name):
-    """Creates an schema object of defaultCheckbox.
+    """Creates a schema object of defaultCheckbox.
 
     Args:
         field (object): Individual field in ui-config.
@@ -144,7 +144,7 @@ def generate_schema_for_default_checkbox(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_checkbox(field, dbConfig, schema_field_name):
-    """Creates an schema object of checkbox.
+    """Creates a schema object of checkbox.
 
     Args:
         field (object): Individual field in ui-config.
@@ -173,7 +173,7 @@ def generate_schema_for_checkbox(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_textinput(field, dbConfig, schema_field_name):
-    """Creates an schema object of textinput.
+    """Creates a schema object of textinput.
 
     Args:
         field (object): Individual field in ui-config.
@@ -204,7 +204,7 @@ def generate_schema_for_textinput(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_textarea_input(field, dbConfig, schema_field_name):
-    """Creates an schema object of textareaInput.
+    """Creates a schema object of textareaInput.
 
     Args:
         field (object): Individual field in ui-config.
@@ -222,7 +222,7 @@ def generate_schema_for_textarea_input(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_single_select(field, dbConfig, schema_field_name):
-    """Creates an schema object of singleSelect.
+    """Creates a schema object of singleSelect.
 
     Args:
         field (object): Individual field in ui-config.
@@ -269,7 +269,7 @@ def generate_schema_for_single_select(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_dynamic_custom_form(field, dbConfig, schema_field_name):
-    """Creates an schema object of dynamicCustomForm.
+    """Creates a schema object of dynamicCustomForm.
 
     Args:
         field (object): Individual field in ui-config.
@@ -285,21 +285,39 @@ def generate_schema_for_dynamic_custom_form(field, dbConfig, schema_field_name):
     dynamicCustomFormItemObj = {}
     dynamicCustomFormItemObj["type"] = FieldTypeEnum.OBJECT.value
     dynamicCustomFormItemObj["properties"] = {}
-    for customField in field["customFields"]:
-        customeFieldSchemaObj = uiTypetoSchemaFn.get(customField["type"])(customField, dbConfig, schema_field_name)
+    allOfSchemaObj = {}
+
+    # For old schema types customFields contains the children, for v2 its is rowFields
+    customFieldsKey = "customFields"
+    if "rowFields" in field:
+        customFieldsKey = "rowFields"
+
+    allOfSchemaObj = generate_schema_for_dynamic_custom_form_allOf(field[customFieldsKey], dbConfig, schema_field_name)
+
+    for customField in field[customFieldsKey]:
+        customFieldSchemaObj = uiTypetoSchemaFn.get(customField["type"])(customField, dbConfig, schema_field_name)
         isCustomFieldDependentOnSource = is_dest_field_dependent_on_source(customField, dbConfig, schema_field_name)
-        if 'pattern' not in customeFieldSchemaObj and not isCustomFieldDependentOnSource and customeFieldSchemaObj["type"]==FieldTypeEnum.STRING.value:
-            customeFieldSchemaObj["pattern"] = generalize_regex_pattern(customField)
+
+        if "preRequisites" in customField:
+            continue
+
+        if 'pattern' not in customFieldSchemaObj and not isCustomFieldDependentOnSource and customFieldSchemaObj["type"] == FieldTypeEnum.STRING.value:
+            customFieldSchemaObj["pattern"] = generalize_regex_pattern(customField)
+
         # If the custom field is source dependent, we remove the source keys as it's not required inside custom fields, rather they need to be moved to top.
         if isCustomFieldDependentOnSource:
             for sourceType in dbConfig["supportedSourceTypes"]:
                 if sourceType in dbConfig["destConfig"] and field[schema_field_name] in dbConfig["destConfig"][sourceType]:
-                    customeFieldSchemaObj = customeFieldSchemaObj["properties"][sourceType]
+                    customFieldSchemaObj = customFieldSchemaObj["properties"][sourceType]
                     break
-        dynamicCustomFormItemObj["properties"][customField[schema_field_name]] =  customeFieldSchemaObj
+        dynamicCustomFormItemObj["properties"][customField[schema_field_name]] = customFieldSchemaObj
+
+    if allOfSchemaObj:
+        dynamicCustomFormItemObj['allOf'] = allOfSchemaObj
 
     dynamicCustomFormObj["items"] = dynamicCustomFormItemObj
     isSourceDependent = is_dest_field_dependent_on_source(field, dbConfig, schema_field_name)
+
     # If the field is source dependent, new schema object is created by setting the fields inside the source.
     if isSourceDependent:
         newDynamicCustomFormObj = {"type": FieldTypeEnum.OBJECT.value}
@@ -308,11 +326,62 @@ def generate_schema_for_dynamic_custom_form(field, dbConfig, schema_field_name):
             if sourceType in dbConfig["destConfig"] and field[schema_field_name] in dbConfig["destConfig"][sourceType]:
                 newDynamicCustomFormObj["properties"][sourceType] = dynamicCustomFormObj
         dynamicCustomFormObj = newDynamicCustomFormObj
+
     return dynamicCustomFormObj
 
 
+
+def generate_schema_for_dynamic_custom_form_allOf(customFields, dbConfig, schema_field_name):
+    """Creates the allOf structure of schema, empty if not required.
+    - Finds the list of unique preRequisites.
+    - For each unique preRequisites, the properties are found by matching the current preRequisites.
+    - preRequisites becomes if block and corresponding properties become then block.
+
+    Args:
+        customFields (collection): child fields from file content of ui-config.json.
+        dbConfig (object): Configurations of db-config.json.
+        schema_field_name (string): Specifies which key has the field's name in schema.
+            For old schema types, it is 'value' else 'configKey'.
+
+    Returns:
+        object: allOf object of schema
+    """
+    allOfItemList = []
+    preRequisitesList = []
+
+    for field in customFields:
+        if "preRequisites" not in field:
+            continue
+        isPresent = False
+        for preRequisites in preRequisitesList:
+            if compare_pre_requisite_fields(preRequisites, field["preRequisites"]["fields"], True):
+                isPresent = True
+                break
+        if not isPresent:
+            preRequisitesList.append(field["preRequisites"]["fields"])
+
+    for preRequisites in preRequisitesList:
+        ifObj = generate_if_object(preRequisites, True)
+        thenObj = {"properties": {}, "required": []}
+        allOfItemObj = {"if": ifObj}
+
+        for field in customFields:
+            if "preRequisites" not in field:
+                continue
+            if compare_pre_requisite_fields(field["preRequisites"]["fields"], preRequisites, True):
+                thenObj["properties"][field[schema_field_name]] = uiTypetoSchemaFn.get(field["type"])(field, dbConfig, schema_field_name)
+                if "required" in field and field["required"] == True:
+                    thenObj["required"].append(field[schema_field_name])
+        allOfItemObj["then"] = thenObj
+        allOfItemList.append(allOfItemObj)
+
+    # Calling anyOf to check if two conditions can be grouped as anyOf.
+    allOfItemList = generate_schema_for_anyOf(allOfItemList, schema_field_name)
+    return allOfItemList
+
+
 def generate_schema_for_dynamic_form(field, dbConfig, schema_field_name):
-    """Creates an schema object of dynamicForm.
+    """Creates a schema object of dynamicForm.
 
     Args:
         field (object): Individual field in ui-config.
@@ -363,7 +432,7 @@ def generate_key(forFieldWithTo):
 
 
 def generate_schema_for_dynamic_select_form(field, dbConfig, schema_field_name):
-    """Creates an schema object of dynamicSelectForm.
+    """Creates a schema object of dynamicSelectForm.
 
     Args:
         field (object): Individual field in ui-config.
@@ -377,7 +446,7 @@ def generate_schema_for_dynamic_select_form(field, dbConfig, schema_field_name):
     return generate_schema_for_dynamic_form(field, dbConfig, schema_field_name)
 
 def generate_schema_for_mapping(field, dbConfig, schema_field_name):
-    """Creates an schema object of mapping.
+    """Creates a schema object of mapping.
 
     Args:
         field (object): Individual field in ui-config.
@@ -392,7 +461,7 @@ def generate_schema_for_mapping(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_tag_input(field, dbConfig, schema_field_name):
-    """Creates an schema object of tagInput.
+    """Creates a schema object of tagInput.
 
     Args:
         field (object): Individual field in ui-config.
@@ -428,7 +497,7 @@ def generate_schema_for_tag_input(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_time_range_picker(field, dbConfig, schema_field_name):
-    """Creates an schema object of timeRangePicker.
+    """Creates a schema object of timeRangePicker.
 
     Args:
         field (object): Individual field in ui-config.
@@ -451,7 +520,7 @@ def generate_schema_for_time_range_picker(field, dbConfig, schema_field_name):
 
 
 def generate_schema_for_time_picker(field, dbConfig, schema_field_name):
-    """Creates an schema object of timePicker.
+    """Creates a schema object of timePicker.
 
     Args:
         field (object): Individual field in ui-config.
@@ -466,26 +535,35 @@ def generate_schema_for_time_picker(field, dbConfig, schema_field_name):
         "type": FieldTypeEnum.STRING.value
     }
 
-def compare_pre_requisite_fields(fieldA, fieldB):
-    """Compares two preRequisiteFields fieldA and fieldB for each property and checks if there "selectedValue" match. 
+
+def compare_pre_requisite_fields(fieldA, fieldB, isV2 = False):
+    """Compares two preRequisiteFields fieldA and fieldB for each property and checks if their value matches.
 
     Args:
-        fieldA (list or object): contains two properties, 'name' and 'selectedValue'.
-        fieldB (list or object):
+        fieldA (list or object): contains two properties representing 'name' and 'selectedValue'.
+        fieldB (list or object): contains two properties representing 'name' and 'selectedValue'.
+        isV2 (bool): determines if new property names should be used
 
     Returns:
         boolean: If all the properties have the same 'name' and 'selectedValue', then it returns True else False.
-    """    
+    """
+    valueKey = 'selectedValue'
+    nameKey = 'name'
+
+    if isV2:
+        valueKey = 'value'
+        nameKey = 'configKey'
+
     if type(fieldA) != type(fieldB):
         return False
     elif type(fieldA) == list:
         if len(fieldA) != len(fieldB):
             return False
         for i in range(0, len(fieldA)):
-            if fieldA[i]['name'] != fieldB[i]['name'] or fieldA[i]['selectedValue'] != fieldB[i]['selectedValue']:
+            if fieldA[i][nameKey] != fieldB[i][nameKey] or fieldA[i][valueKey] != fieldB[i][valueKey]:
                 return False
     else:
-        if fieldA['name'] != fieldB['name'] or fieldA['selectedValue'] != fieldB['selectedValue']:
+        if fieldA[nameKey] != fieldB[nameKey] or fieldA[valueKey] != fieldB[valueKey]:
                 return False
     return True
 
@@ -514,27 +592,35 @@ def get_unique_pre_requisite_fields(uiConfig):
     return preRequisiteFieldsList
 
 
-def generate_if_object(preRequisiteField):
+def generate_if_object(preRequisiteField, isV2 = False):
     """Creates an if object for the given preRequisiteField. The preRequisiteField becomes an if condition in the schema.
 
     Args:
         preRequisiteField (list or object): contains two properties, 'name' and 'selectedValue'.
+        isV2 (bool): if it should use the v2 or the legacy property key names
 
     Returns:
         object: if block for given preRequisiteField.
-    """    
+    """
     ifObj = {"properties": {}, "required": []}
+    valueKey = 'selectedValue'
+    nameKey = 'name'
+
+    if isV2:
+        valueKey = 'value'
+        nameKey = 'configKey'
+
     if type(preRequisiteField) == list:
         for field in preRequisiteField:
-            ifObj["properties"][field["name"]] = {
-                "const": field["selectedValue"]
+            ifObj["properties"][field[nameKey]] = {
+                "const": field[valueKey]
             }
-            ifObj["required"].append(field["name"])
+            ifObj["required"].append(field[nameKey])
     else:
-        ifObj["properties"][preRequisiteField["name"]] = {
-            "const": preRequisiteField["selectedValue"]
+        ifObj["properties"][preRequisiteField[nameKey]] = {
+            "const": preRequisiteField[valueKey]
         }
-        ifObj["required"].append(preRequisiteField["name"])
+        ifObj["required"].append(preRequisiteField[nameKey])
     return ifObj
 
 

src/configurations/destinations/customerio/db-config.json

@@ -15,6 +15,7 @@
       "whitelistedEvents",
       "oneTrustCookieCategories",
       "ketchConsentPurposes",
+      "consentManagement",
       "eventFilteringOption",
       "sendPageNameInSDK",
       "dataUseInApp"
@@ -46,7 +47,11 @@
         "oneTrustCookieCategories",
         "ketchConsentPurposes"
       ],
-      "web": ["dataUseInApp", "useNativeSDK", "sendPageNameInSDK"]
+      "web": ["dataUseInApp", "useNativeSDK", "sendPageNameInSDK", "consentManagement"],
+      "android": ["consentManagement"],
+      "ios": ["consentManagement"],
+      "flutter": ["consentManagement"],
+      "reactnative": ["consentManagement"]
     },
     "secretKeys": []
   }