fix: update the shape of goalData for tracking revenue

convertcom · Jun 3, 2024 · f54356f · f54356f
1 parent da8a2c9
commit f54356f
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 12 deletions.
diff --git a/packages/data/src/data-manager.ts b/packages/data/src/data-manager.ts
@@ -35,6 +35,7 @@ import {
   VisitorTrackingEvents,
   ConversionEvent,
   ConfigGoal,
+  GoalData,
   VisitorSegments,
   ConfigSegment,
   BucketingAttributes,
@@ -49,7 +50,6 @@ import {
   ERROR_MESSAGES,
   MESSAGES,
   RuleError,
-  GoalDataKey,
   SegmentsKeys,
   SystemEvents,
   ConversionSettingKey
@@ -913,15 +913,15 @@ export class DataManager implements DataManagerInterface {
    * @param {string} visitorId
    * @param {string} goalId
    * @param {Record<string, any>=} goalRule An object of key-value pairs that are used for goal matching
-   * @param {Array<Record<GoalDataKey, number>>} goalData An array of object of key-value pairs
+   * @param {Array<GoalData>} goalData An array of object of key-value pairs
    * @param {VisitorSegments} segments
    * @param {Record<ConversionSettingKey, number | string | boolean>} conversionSetting An object of key-value pairs that are used for tracking settings
    */
   convert(
     visitorId: string,
     goalId: string,
     goalRule?: Record<string, any>,
-    goalData?: Array<Record<GoalDataKey, number>>,
+    goalData?: Array<GoalData>,
     segments?: VisitorSegments,
     conversionSetting?: Record<ConversionSettingKey, number | string | boolean>
   ): RuleError | boolean {

diff --git a/packages/data/src/interfaces/data-manager.ts b/packages/data/src/interfaces/data-manager.ts
@@ -13,13 +13,13 @@ import {
   VisitorSegments,
   ConfigExperience,
   BucketingAttributes,
-  LocationAttributes
+  LocationAttributes,
+  GoalData
 } from '@convertcom/js-sdk-types';
 import {DataStoreManagerInterface} from './data-store-manager';
 import {
   BucketingError,
   ConversionSettingKey,
-  GoalDataKey,
   RuleError
 } from '@convertcom/js-sdk-enums';
 
@@ -56,7 +56,7 @@ export interface DataManagerInterface {
     visitorId: string,
     goalId: string,
     goalRule?: Record<string, any>,
-    goalData?: Array<Record<GoalDataKey, number>>,
+    goalData?: Array<GoalData>,
     segments?: VisitorSegments,
     conversionSetting?: Record<ConversionSettingKey, number | string | boolean>
   ): RuleError | boolean;

diff --git a/packages/js-sdk/README.md b/packages/js-sdk/README.md
@@ -461,9 +461,16 @@ convertSDK.onReady().then(() => {
     },
     conversionData: [
       {
-        amount: 10.3,
-        productsCount: 2,
-        transactionId: 'transaction-unique-id'
+        key: 'amount',
+        value: 10.3
+      },
+      {
+        key: 'productsCount',
+        value: 2
+      },
+      {
+        key: 'transactionId',
+        value: 'transaction-unique-id'
       }
     ],
     conversionSetting: {

diff --git a/packages/js-sdk/index.ts b/packages/js-sdk/index.ts
@@ -149,6 +149,7 @@ export {
   BucketedVariation,
   BucketingAttributes,
   ConversionAttributes,
+  LocationAttributes,
   Entity,
   IdentityField,
   SegmentsAttributes,
@@ -161,6 +162,7 @@ export {
   ConfigGoal,
   ConfigAudience,
   ConfigLocation,
+  GoalData,
   RequireAtLeastOne,
   VisitorTrackingEvents,
   Path

diff --git a/packages/js-sdk/src/context.ts b/packages/js-sdk/src/context.ts
@@ -375,7 +375,7 @@ export class Context implements ContextInterface {
    * @param {string} goalKey A goal key
    * @param {ConversionAttributes=} attributes An object that specifies attributes for the visitor
    * @param {Record<string, any>=} attributes.ruleData An object of key-value pairs that are used for goal matching
-   * @param {Array<Record<GoalDataKey, number>>=} attributes.conversionData An array of key-value pairs that are used for transaction data
+   * @param {Array<GoalData>=} attributes.conversionData An array of key-value pairs that are used for transaction data
    * @param {Record<ConversionSettingKey, number | string | boolean>} attributes.conversionSetting An object of key-value pairs that are used for tracking settings
    * @return {RuleError}
    */

diff --git a/packages/types/index.ts b/packages/types/index.ts
@@ -13,6 +13,7 @@ export * from './src/BucketingHash';
 export * from './src/Config';
 export * from './src/ConversionAttributes';
 export * from './src/Entity';
+export * from './src/GoalData';
 export * from './src/IndentityField';
 export * from './src/Integration';
 export * from './src/LocationAttributes';

diff --git a/packages/types/src/ConversionAttributes.ts b/packages/types/src/ConversionAttributes.ts
@@ -5,10 +5,11 @@
  * License Apache-2.0
  */
 
-import {ConversionSettingKey, GoalDataKey} from '@convertcom/js-sdk-enums';
+import {ConversionSettingKey} from '@convertcom/js-sdk-enums';
+import {GoalData} from './GoalData';
 
 export type ConversionAttributes = {
   ruleData?: Record<string, any>;
-  conversionData?: Array<Record<GoalDataKey, number>>;
+  conversionData?: Array<GoalData>;
   conversionSetting?: Record<ConversionSettingKey, number | string | boolean>;
 };
diff --git a/packages/types/src/GoalData.ts b/packages/types/src/GoalData.ts
@@ -0,0 +1,13 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+
+import {GoalDataKey} from '@convertcom/js-sdk-enums';
+
+export type GoalData = {
+  key: GoalDataKey;
+  value: number | string;
+};