From 1ee6186879cd5771176dd7f51c72ff6eb0a3b9f9 Mon Sep 17 00:00:00 2001 From: Abhishek Pandey <64667840+1abhishekpandey@users.noreply.github.com> Date: Wed, 25 Oct 2023 12:32:18 +0530 Subject: [PATCH 1/2] feat: add new comscore destination (#1009) --- .../destinations/comscore/db-config.json | 37 +++++ .../destinations/comscore/metadata.json | 0 .../destinations/comscore/schema.json | 82 ++++++++++ .../destinations/comscore/ui-config.json | 149 ++++++++++++++++++ 4 files changed, 268 insertions(+) create mode 100644 src/configurations/destinations/comscore/db-config.json create mode 100644 src/configurations/destinations/comscore/metadata.json create mode 100644 src/configurations/destinations/comscore/schema.json create mode 100644 src/configurations/destinations/comscore/ui-config.json diff --git a/src/configurations/destinations/comscore/db-config.json b/src/configurations/destinations/comscore/db-config.json new file mode 100644 index 000000000..76783c726 --- /dev/null +++ b/src/configurations/destinations/comscore/db-config.json @@ -0,0 +1,37 @@ +{ + "name": "COMSCORE", + "displayName": "Comscore", + "config": { + "transformAt": "processor", + "transformAtV1": "processor", + "includeKeys": [ + "publisherId", + "appName", + "foregroundAndBackground", + "autoUpdateInterval", + "foregroundOnly", + "blacklistedEvents", + "whitelistedEvents", + "eventFilteringOption", + "oneTrustCookieCategories" + ], + "excludeKeys": [ ], + "supportedSourceTypes": [ "android", "ios" ], + "destConfig": { + "defaultConfig": [ + "publisherId", + "appName", + "foregroundAndBackground", + "autoUpdateInterval", + "foregroundOnly", + "blacklistedEvents", + "whitelistedEvents", + "eventFilteringOption", + "oneTrustCookieCategories" + ], + "android": [ "useNativeSDK" ], + "ios": [ "useNativeSDK" ] + }, + "secretKeys": [ "publisherId" ] + } +} diff --git a/src/configurations/destinations/comscore/metadata.json b/src/configurations/destinations/comscore/metadata.json new file mode 100644 index 000000000..e69de29bb diff --git a/src/configurations/destinations/comscore/schema.json b/src/configurations/destinations/comscore/schema.json new file mode 100644 index 000000000..b520be7d8 --- /dev/null +++ b/src/configurations/destinations/comscore/schema.json @@ -0,0 +1,82 @@ +{ + "configSchema": { + "$schema": "http://json-schema.org/draft-07/schema#", + "required": [ + "publisherId" + ], + "type": "object", + "properties": { + "publisherId": { + "type": "string", + "pattern": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(.{0,100})$" + }, + "appName": { + "type": "string" + }, + "foregroundOnly": { + "type": "boolean", + "default": true + }, + "foregroundAndBackground": { + "type": "boolean", + "default": false + }, + "autoUpdateInterval": { + "type": "string" + }, + "useNativeSDK": { + "type": "object", + "properties": { + "web": { + "type": "boolean" + } + } + }, + "eventFilteringOption": { + "type": "string", + "enum": [ + "disable", + "whitelistedEvents", + "blacklistedEvents" + ], + "default": "disable" + }, + "whitelistedEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventName": { + "type": "string", + "pattern": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(.{0,100})$" + } + } + } + }, + "blacklistedEvents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventName": { + "type": "string", + "pattern": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(.{0,100})$" + } + } + } + }, + "oneTrustCookieCategories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "oneTrustCookieCategory": { + "type": "string", + "pattern": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(.{0,100})$" + } + } + } + } + } + } +} diff --git a/src/configurations/destinations/comscore/ui-config.json b/src/configurations/destinations/comscore/ui-config.json new file mode 100644 index 000000000..61567b7b4 --- /dev/null +++ b/src/configurations/destinations/comscore/ui-config.json @@ -0,0 +1,149 @@ +{ + "uiConfig": [ + { + "title": "Connection Settings", + "fields": [ + { + "type": "textInput", + "label": "Publisher Id", + "value": "publisherId", + "regex": "^(.{0,100})$", + "regexErrorMessage": "Invalid Publisher Id value", + "required": true, + "placeholder": "1234567", + "secret": true, + "footerNote": "Publisher ID is commonly referred as Client Id/ C2 Value." + } + ] + }, + { + "fields": [ + { + "type": "textInput", + "label": "App Name", + "value": "appName", + "placeholder": "News Magazine", + "footerNote": "This parameter will be included in the payloads to specify the source app for the tags and data." + } + ] + }, + { + "fields": [ + { + "type": "checkbox", + "label": "Only Auto Update when app in foreground.", + "value": "foregroundOnly", + "default": true, + "footerNote": "This setting update usage times only when the application is in the foreground. This is the default mode." + } + ] + }, + { + "fields": [ + { + "type": "checkbox", + "label": "Auto Update when app is in foreground and background.", + "value": "foregroundAndBackground", + "default": false, + "footerNote": "This setting update usage times when the application is in the foreground and background." + } + ] + }, + { + "fields": [ + { + "type": "textInput", + "label": "Auto Update Interval", + "value": "autoUpdateInterval", + "placeholder": "60", + "footerNote": "If Auto Update is enabled, this sets how many seconds in between auto updates." + } + ] + }, + { + "title": "Native SDK", + "fields": [ + { + "type": "defaultCheckbox", + "label": "Use device-mode to send events", + "value": "useNativeSDK", + "default": true + } + ] + }, + { + "title": "Client-side Events Filtering", + "sectionNote": "Applicable only for device-mode integrations. If enabled, it works only with either allowlisted or denylisted events", + "fields": [ + { + "type": "singleSelect", + "value": "eventFilteringOption", + "required": false, + "options": [ + { + "name": "Disable", + "value": "disable" + }, + { + "name": "Allowlist", + "value": "whitelistedEvents" + }, + { + "name": "Denylist", + "value": "blacklistedEvents" + } + ], + "defaultOption": { + "name": "Disable", + "value": "disable" + } + }, + { + "type": "dynamicCustomForm", + "value": "whitelistedEvents", + "label": "Allowlist", + "customFields": [ + { + "type": "textInput", + "value": "eventName", + "required": false, + "placeholder": "e.g: Anonymous Page Visit" + } + ] + }, + { + "type": "dynamicCustomForm", + "value": "blacklistedEvents", + "label": "Denylist", + "customFields": [ + { + "type": "textInput", + "value": "eventName", + "required": false, + "placeholder": "e.g: Credit Card Added" + } + ] + } + ] + }, + { + "title": "Consent Settings", + "fields": [ + { + "type": "dynamicCustomForm", + "value": "oneTrustCookieCategories", + "label": "OneTrust Cookie Categories", + "customFields": [ + { + "type": "textInput", + "placeholder": "Marketing", + "value": "oneTrustCookieCategory", + "label": "Category Name/ID", + "required": false + } + ] + } + ] + } + ] +} From 3864941b37c7b865254162d223d4a4ce2cda3b7b Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 25 Oct 2023 07:09:05 +0000 Subject: [PATCH 2/2] chore(release): 1.56.0 --- CHANGELOG.md | 7 +++++++ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f7b0e6163..d699e7372 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [1.56.0](https://github.com/rudderlabs/rudder-config-schema/compare/v1.55.2...v1.56.0) (2023-10-25) + + +### Features + +* add new comscore destination ([#1009](https://github.com/rudderlabs/rudder-config-schema/issues/1009)) ([1ee6186](https://github.com/rudderlabs/rudder-config-schema/commit/1ee6186879cd5771176dd7f51c72ff6eb0a3b9f9)) + ### [1.55.2](https://github.com/rudderlabs/rudder-config-schema/compare/v1.55.1...v1.55.2) (2023-10-19) ### [1.55.1](https://github.com/rudderlabs/rudder-config-schema/compare/v1.55.0...v1.55.1) (2023-10-16) diff --git a/package-lock.json b/package-lock.json index f9b2cfadb..564ba5f1c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "rudder-config-schema", - "version": "1.55.2", + "version": "1.56.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "rudder-config-schema", - "version": "1.55.2", + "version": "1.56.0", "license": "MIT", "dependencies": { "ajv": "^8.12.0", diff --git a/package.json b/package.json index de214beb3..56721f6a9 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "rudder-config-schema", - "version": "1.55.2", + "version": "1.56.0", "description": "", "main": "src/index.ts", "private": true,