@adtrackify/at-tracking-event-types 4.17.0 → 4.17.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,6 @@
1
1
  import { Subscription } from '../subscriptions/subscription-types.js';
2
2
  import { ACCOUNT_STATUS, ACCOUNT_STATUS_DETAIL, ACCOUNT_CANCELLED_BY, ACCOUNT_SUBSCRIPTION_TYPE, PIXEL_STATUS, FEATURE_FLAG, BUSINESS_TYPE, BUSINESS_USER_ROLE, BUSINESS_PLATFORM, REFERRAL_SOURCE } from './account-enums.js';
3
+ import type { PixelEventConfig } from '../destinations/custom-event-mapping.js';
3
4
  export interface Account {
4
5
  id: string;
5
6
  accountName: string;
@@ -34,6 +35,7 @@ export interface Pixel {
34
35
  name: string;
35
36
  status: PIXEL_STATUS;
36
37
  disablingOn?: string;
38
+ eventConfig?: PixelEventConfig;
37
39
  createdAt: string;
38
40
  updatedAt: string;
39
41
  }
@@ -0,0 +1,71 @@
1
+ import { TRACKING_EVENT_NAME } from '../../event/base/event-name-enum.js';
2
+ export declare enum CONDITION_OPERATOR {
3
+ EQUALS = "equals",
4
+ NOT_EQUALS = "not_equals",
5
+ GREATER_THAN = "greater_than",
6
+ LESS_THAN = "less_than",
7
+ GREATER_THAN_OR_EQUALS = "greater_than_or_equals",
8
+ LESS_THAN_OR_EQUALS = "less_than_or_equals",
9
+ CONTAINS = "contains",
10
+ NOT_CONTAINS = "not_contains",
11
+ STARTS_WITH = "starts_with",
12
+ ENDS_WITH = "ends_with",
13
+ IN = "in",
14
+ NOT_IN = "not_in",
15
+ EXISTS = "exists",
16
+ NOT_EXISTS = "not_exists",
17
+ ARRAY_INCLUDES = "array_includes",
18
+ ARRAY_INCLUDES_ALL = "array_includes_all",
19
+ ARRAY_INCLUDES_ANY = "array_includes_any"
20
+ }
21
+ export interface EventCondition {
22
+ id: string;
23
+ field: string;
24
+ operator: CONDITION_OPERATOR;
25
+ value: string | number | boolean | string[];
26
+ }
27
+ export interface CustomEventMapping {
28
+ id: string;
29
+ name: string;
30
+ sourceEventName: TRACKING_EVENT_NAME;
31
+ destinationEventName: string;
32
+ enabled: boolean;
33
+ conditions: EventCondition[];
34
+ priority: number;
35
+ createdAt?: string;
36
+ updatedAt?: string;
37
+ }
38
+ export interface PixelEventConfig {
39
+ customEventMappings?: CustomEventMapping[];
40
+ }
41
+ export interface DestinationEventConfig {
42
+ customEventMappings?: CustomEventMapping[];
43
+ disabledGlobalMappings?: string[];
44
+ }
45
+ export declare enum CONDITION_FIELD_TYPE {
46
+ STRING = "string",
47
+ NUMBER = "number",
48
+ BOOLEAN = "boolean",
49
+ ARRAY = "array",
50
+ CSV_STRING = "csv_string",
51
+ DATE = "date"
52
+ }
53
+ export declare enum CONDITION_FIELD_CATEGORY {
54
+ VALUE = "value",
55
+ ITEMS = "items",
56
+ TAGS = "tags",
57
+ CUSTOMER = "customer",
58
+ CONTEXT = "context"
59
+ }
60
+ export interface ConditionFieldDefinition {
61
+ path: string;
62
+ label: string;
63
+ type: CONDITION_FIELD_TYPE;
64
+ description?: string;
65
+ supportedOperators: CONDITION_OPERATOR[];
66
+ category: CONDITION_FIELD_CATEGORY;
67
+ }
68
+ export interface ConditionFieldCatalog {
69
+ sourceEventName: TRACKING_EVENT_NAME;
70
+ fields: ConditionFieldDefinition[];
71
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CONDITION_FIELD_CATEGORY = exports.CONDITION_FIELD_TYPE = exports.CONDITION_OPERATOR = void 0;
4
+ var CONDITION_OPERATOR;
5
+ (function (CONDITION_OPERATOR) {
6
+ CONDITION_OPERATOR["EQUALS"] = "equals";
7
+ CONDITION_OPERATOR["NOT_EQUALS"] = "not_equals";
8
+ CONDITION_OPERATOR["GREATER_THAN"] = "greater_than";
9
+ CONDITION_OPERATOR["LESS_THAN"] = "less_than";
10
+ CONDITION_OPERATOR["GREATER_THAN_OR_EQUALS"] = "greater_than_or_equals";
11
+ CONDITION_OPERATOR["LESS_THAN_OR_EQUALS"] = "less_than_or_equals";
12
+ CONDITION_OPERATOR["CONTAINS"] = "contains";
13
+ CONDITION_OPERATOR["NOT_CONTAINS"] = "not_contains";
14
+ CONDITION_OPERATOR["STARTS_WITH"] = "starts_with";
15
+ CONDITION_OPERATOR["ENDS_WITH"] = "ends_with";
16
+ CONDITION_OPERATOR["IN"] = "in";
17
+ CONDITION_OPERATOR["NOT_IN"] = "not_in";
18
+ CONDITION_OPERATOR["EXISTS"] = "exists";
19
+ CONDITION_OPERATOR["NOT_EXISTS"] = "not_exists";
20
+ CONDITION_OPERATOR["ARRAY_INCLUDES"] = "array_includes";
21
+ CONDITION_OPERATOR["ARRAY_INCLUDES_ALL"] = "array_includes_all";
22
+ CONDITION_OPERATOR["ARRAY_INCLUDES_ANY"] = "array_includes_any";
23
+ })(CONDITION_OPERATOR = exports.CONDITION_OPERATOR || (exports.CONDITION_OPERATOR = {}));
24
+ var CONDITION_FIELD_TYPE;
25
+ (function (CONDITION_FIELD_TYPE) {
26
+ CONDITION_FIELD_TYPE["STRING"] = "string";
27
+ CONDITION_FIELD_TYPE["NUMBER"] = "number";
28
+ CONDITION_FIELD_TYPE["BOOLEAN"] = "boolean";
29
+ CONDITION_FIELD_TYPE["ARRAY"] = "array";
30
+ CONDITION_FIELD_TYPE["CSV_STRING"] = "csv_string";
31
+ CONDITION_FIELD_TYPE["DATE"] = "date";
32
+ })(CONDITION_FIELD_TYPE = exports.CONDITION_FIELD_TYPE || (exports.CONDITION_FIELD_TYPE = {}));
33
+ var CONDITION_FIELD_CATEGORY;
34
+ (function (CONDITION_FIELD_CATEGORY) {
35
+ CONDITION_FIELD_CATEGORY["VALUE"] = "value";
36
+ CONDITION_FIELD_CATEGORY["ITEMS"] = "items";
37
+ CONDITION_FIELD_CATEGORY["TAGS"] = "tags";
38
+ CONDITION_FIELD_CATEGORY["CUSTOMER"] = "customer";
39
+ CONDITION_FIELD_CATEGORY["CONTEXT"] = "context";
40
+ })(CONDITION_FIELD_CATEGORY = exports.CONDITION_FIELD_CATEGORY || (exports.CONDITION_FIELD_CATEGORY = {}));
41
+ //# sourceMappingURL=custom-event-mapping.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom-event-mapping.js","sourceRoot":"","sources":["../../../../../src/types/api/destinations/custom-event-mapping.ts"],"names":[],"mappings":";;;AAaA,IAAY,kBA6BX;AA7BD,WAAY,kBAAkB;IAE5B,uCAAiB,CAAA;IACjB,+CAAyB,CAAA;IAGzB,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,uEAAiD,CAAA;IACjD,iEAA2C,CAAA;IAG3C,2CAAqB,CAAA;IACrB,mDAA6B,CAAA;IAC7B,iDAA2B,CAAA;IAC3B,6CAAuB,CAAA;IAGvB,+BAAS,CAAA;IACT,uCAAiB,CAAA;IAGjB,uCAAiB,CAAA;IACjB,+CAAyB,CAAA;IAGzB,uDAAiC,CAAA;IACjC,+DAAyC,CAAA;IACzC,+DAAyC,CAAA;AAC3C,CAAC,EA7BW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QA6B7B;AAmED,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,uCAAe,CAAA;IACf,iDAAyB,CAAA;IACzB,qCAAa,CAAA;AACf,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B;AAED,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,2CAAe,CAAA;IACf,2CAAe,CAAA;IACf,yCAAa,CAAA;IACb,iDAAqB,CAAA;IACrB,+CAAmB,CAAA;AACrB,CAAC,EANW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAMnC"}
@@ -3,6 +3,7 @@ import { EmqHealthStatus } from '../emq/emq-health.js';
3
3
  import { DESTINATION, DESTINATION_TYPE, EVENT_TRIGGER_CONDITION } from './destination-enums.js';
4
4
  import type { DestinationHealthStatus } from '../health/health-status.js';
5
5
  import type { ForwardingHealthStatus } from '../health/forwarding-health.js';
6
+ import type { DestinationEventConfig } from './custom-event-mapping.js';
6
7
  export interface Destination {
7
8
  id: string;
8
9
  accountId: string;
@@ -29,6 +30,7 @@ export interface UserDestinationConfiguration {
29
30
  events?: EventConfiguration[];
30
31
  trigger?: DestinationTriggerConfiguration;
31
32
  forwarding?: ForwardingConfiguration;
33
+ eventConfig?: DestinationEventConfig;
32
34
  }
33
35
  export interface DestinationTriggerConfiguration {
34
36
  shopify?: ShopifyTriggerConfiguration;
@@ -4,3 +4,4 @@ export * from './destination-catalog.js';
4
4
  export * from './third-party-destination-configs.js';
5
5
  export * from './third-party-integration-configs.js';
6
6
  export * from './third-party-contact-acquisition-configs.js';
7
+ export * from './custom-event-mapping.js';
@@ -20,4 +20,5 @@ __exportStar(require("./destination-catalog.js"), exports);
20
20
  __exportStar(require("./third-party-destination-configs.js"), exports);
21
21
  __exportStar(require("./third-party-integration-configs.js"), exports);
22
22
  __exportStar(require("./third-party-contact-acquisition-configs.js"), exports);
23
+ __exportStar(require("./custom-event-mapping.js"), exports);
23
24
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/api/destinations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAKA,yDAAuC;AACvC,oDAAkC;AAClC,2DAAyC;AACzC,uEAAqD;AACrD,uEAAqD;AACrD,+EAA6D"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/api/destinations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAKA,yDAAuC;AACvC,oDAAkC;AAClC,2DAAyC;AACzC,uEAAqD;AACrD,uEAAqD;AACrD,+EAA6D;AAC7D,4DAA0C"}
@@ -1,5 +1,6 @@
1
1
  import { Subscription } from '../subscriptions/subscription-types.js';
2
2
  import { ACCOUNT_STATUS, ACCOUNT_STATUS_DETAIL, ACCOUNT_CANCELLED_BY, ACCOUNT_SUBSCRIPTION_TYPE, PIXEL_STATUS, FEATURE_FLAG, BUSINESS_TYPE, BUSINESS_USER_ROLE, BUSINESS_PLATFORM, REFERRAL_SOURCE } from './account-enums.js';
3
+ import type { PixelEventConfig } from '../destinations/custom-event-mapping.js';
3
4
  export interface Account {
4
5
  id: string;
5
6
  accountName: string;
@@ -34,6 +35,7 @@ export interface Pixel {
34
35
  name: string;
35
36
  status: PIXEL_STATUS;
36
37
  disablingOn?: string;
38
+ eventConfig?: PixelEventConfig;
37
39
  createdAt: string;
38
40
  updatedAt: string;
39
41
  }
@@ -0,0 +1,71 @@
1
+ import { TRACKING_EVENT_NAME } from '../../event/base/event-name-enum.js';
2
+ export declare enum CONDITION_OPERATOR {
3
+ EQUALS = "equals",
4
+ NOT_EQUALS = "not_equals",
5
+ GREATER_THAN = "greater_than",
6
+ LESS_THAN = "less_than",
7
+ GREATER_THAN_OR_EQUALS = "greater_than_or_equals",
8
+ LESS_THAN_OR_EQUALS = "less_than_or_equals",
9
+ CONTAINS = "contains",
10
+ NOT_CONTAINS = "not_contains",
11
+ STARTS_WITH = "starts_with",
12
+ ENDS_WITH = "ends_with",
13
+ IN = "in",
14
+ NOT_IN = "not_in",
15
+ EXISTS = "exists",
16
+ NOT_EXISTS = "not_exists",
17
+ ARRAY_INCLUDES = "array_includes",
18
+ ARRAY_INCLUDES_ALL = "array_includes_all",
19
+ ARRAY_INCLUDES_ANY = "array_includes_any"
20
+ }
21
+ export interface EventCondition {
22
+ id: string;
23
+ field: string;
24
+ operator: CONDITION_OPERATOR;
25
+ value: string | number | boolean | string[];
26
+ }
27
+ export interface CustomEventMapping {
28
+ id: string;
29
+ name: string;
30
+ sourceEventName: TRACKING_EVENT_NAME;
31
+ destinationEventName: string;
32
+ enabled: boolean;
33
+ conditions: EventCondition[];
34
+ priority: number;
35
+ createdAt?: string;
36
+ updatedAt?: string;
37
+ }
38
+ export interface PixelEventConfig {
39
+ customEventMappings?: CustomEventMapping[];
40
+ }
41
+ export interface DestinationEventConfig {
42
+ customEventMappings?: CustomEventMapping[];
43
+ disabledGlobalMappings?: string[];
44
+ }
45
+ export declare enum CONDITION_FIELD_TYPE {
46
+ STRING = "string",
47
+ NUMBER = "number",
48
+ BOOLEAN = "boolean",
49
+ ARRAY = "array",
50
+ CSV_STRING = "csv_string",
51
+ DATE = "date"
52
+ }
53
+ export declare enum CONDITION_FIELD_CATEGORY {
54
+ VALUE = "value",
55
+ ITEMS = "items",
56
+ TAGS = "tags",
57
+ CUSTOMER = "customer",
58
+ CONTEXT = "context"
59
+ }
60
+ export interface ConditionFieldDefinition {
61
+ path: string;
62
+ label: string;
63
+ type: CONDITION_FIELD_TYPE;
64
+ description?: string;
65
+ supportedOperators: CONDITION_OPERATOR[];
66
+ category: CONDITION_FIELD_CATEGORY;
67
+ }
68
+ export interface ConditionFieldCatalog {
69
+ sourceEventName: TRACKING_EVENT_NAME;
70
+ fields: ConditionFieldDefinition[];
71
+ }
@@ -0,0 +1,38 @@
1
+ export var CONDITION_OPERATOR;
2
+ (function (CONDITION_OPERATOR) {
3
+ CONDITION_OPERATOR["EQUALS"] = "equals";
4
+ CONDITION_OPERATOR["NOT_EQUALS"] = "not_equals";
5
+ CONDITION_OPERATOR["GREATER_THAN"] = "greater_than";
6
+ CONDITION_OPERATOR["LESS_THAN"] = "less_than";
7
+ CONDITION_OPERATOR["GREATER_THAN_OR_EQUALS"] = "greater_than_or_equals";
8
+ CONDITION_OPERATOR["LESS_THAN_OR_EQUALS"] = "less_than_or_equals";
9
+ CONDITION_OPERATOR["CONTAINS"] = "contains";
10
+ CONDITION_OPERATOR["NOT_CONTAINS"] = "not_contains";
11
+ CONDITION_OPERATOR["STARTS_WITH"] = "starts_with";
12
+ CONDITION_OPERATOR["ENDS_WITH"] = "ends_with";
13
+ CONDITION_OPERATOR["IN"] = "in";
14
+ CONDITION_OPERATOR["NOT_IN"] = "not_in";
15
+ CONDITION_OPERATOR["EXISTS"] = "exists";
16
+ CONDITION_OPERATOR["NOT_EXISTS"] = "not_exists";
17
+ CONDITION_OPERATOR["ARRAY_INCLUDES"] = "array_includes";
18
+ CONDITION_OPERATOR["ARRAY_INCLUDES_ALL"] = "array_includes_all";
19
+ CONDITION_OPERATOR["ARRAY_INCLUDES_ANY"] = "array_includes_any";
20
+ })(CONDITION_OPERATOR || (CONDITION_OPERATOR = {}));
21
+ export var CONDITION_FIELD_TYPE;
22
+ (function (CONDITION_FIELD_TYPE) {
23
+ CONDITION_FIELD_TYPE["STRING"] = "string";
24
+ CONDITION_FIELD_TYPE["NUMBER"] = "number";
25
+ CONDITION_FIELD_TYPE["BOOLEAN"] = "boolean";
26
+ CONDITION_FIELD_TYPE["ARRAY"] = "array";
27
+ CONDITION_FIELD_TYPE["CSV_STRING"] = "csv_string";
28
+ CONDITION_FIELD_TYPE["DATE"] = "date";
29
+ })(CONDITION_FIELD_TYPE || (CONDITION_FIELD_TYPE = {}));
30
+ export var CONDITION_FIELD_CATEGORY;
31
+ (function (CONDITION_FIELD_CATEGORY) {
32
+ CONDITION_FIELD_CATEGORY["VALUE"] = "value";
33
+ CONDITION_FIELD_CATEGORY["ITEMS"] = "items";
34
+ CONDITION_FIELD_CATEGORY["TAGS"] = "tags";
35
+ CONDITION_FIELD_CATEGORY["CUSTOMER"] = "customer";
36
+ CONDITION_FIELD_CATEGORY["CONTEXT"] = "context";
37
+ })(CONDITION_FIELD_CATEGORY || (CONDITION_FIELD_CATEGORY = {}));
38
+ //# sourceMappingURL=custom-event-mapping.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom-event-mapping.js","sourceRoot":"","sources":["../../../../../src/types/api/destinations/custom-event-mapping.ts"],"names":[],"mappings":"AAaA,MAAM,CAAN,IAAY,kBA6BX;AA7BD,WAAY,kBAAkB;IAE5B,uCAAiB,CAAA;IACjB,+CAAyB,CAAA;IAGzB,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,uEAAiD,CAAA;IACjD,iEAA2C,CAAA;IAG3C,2CAAqB,CAAA;IACrB,mDAA6B,CAAA;IAC7B,iDAA2B,CAAA;IAC3B,6CAAuB,CAAA;IAGvB,+BAAS,CAAA;IACT,uCAAiB,CAAA;IAGjB,uCAAiB,CAAA;IACjB,+CAAyB,CAAA;IAGzB,uDAAiC,CAAA;IACjC,+DAAyC,CAAA;IACzC,+DAAyC,CAAA;AAC3C,CAAC,EA7BW,kBAAkB,KAAlB,kBAAkB,QA6B7B;AAmED,MAAM,CAAN,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC9B,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,uCAAe,CAAA;IACf,iDAAyB,CAAA;IACzB,qCAAa,CAAA;AACf,CAAC,EAPW,oBAAoB,KAApB,oBAAoB,QAO/B;AAED,MAAM,CAAN,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,2CAAe,CAAA;IACf,2CAAe,CAAA;IACf,yCAAa,CAAA;IACb,iDAAqB,CAAA;IACrB,+CAAmB,CAAA;AACrB,CAAC,EANW,wBAAwB,KAAxB,wBAAwB,QAMnC"}
@@ -3,6 +3,7 @@ import { EmqHealthStatus } from '../emq/emq-health.js';
3
3
  import { DESTINATION, DESTINATION_TYPE, EVENT_TRIGGER_CONDITION } from './destination-enums.js';
4
4
  import type { DestinationHealthStatus } from '../health/health-status.js';
5
5
  import type { ForwardingHealthStatus } from '../health/forwarding-health.js';
6
+ import type { DestinationEventConfig } from './custom-event-mapping.js';
6
7
  export interface Destination {
7
8
  id: string;
8
9
  accountId: string;
@@ -29,6 +30,7 @@ export interface UserDestinationConfiguration {
29
30
  events?: EventConfiguration[];
30
31
  trigger?: DestinationTriggerConfiguration;
31
32
  forwarding?: ForwardingConfiguration;
33
+ eventConfig?: DestinationEventConfig;
32
34
  }
33
35
  export interface DestinationTriggerConfiguration {
34
36
  shopify?: ShopifyTriggerConfiguration;
@@ -4,3 +4,4 @@ export * from './destination-catalog.js';
4
4
  export * from './third-party-destination-configs.js';
5
5
  export * from './third-party-integration-configs.js';
6
6
  export * from './third-party-contact-acquisition-configs.js';
7
+ export * from './custom-event-mapping.js';
@@ -4,4 +4,5 @@ export * from './destination-catalog.js';
4
4
  export * from './third-party-destination-configs.js';
5
5
  export * from './third-party-integration-configs.js';
6
6
  export * from './third-party-contact-acquisition-configs.js';
7
+ export * from './custom-event-mapping.js';
7
8
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/api/destinations/index.ts"],"names":[],"mappings":"AAKA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sCAAsC,CAAC;AACrD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8CAA8C,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/api/destinations/index.ts"],"names":[],"mappings":"AAKA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sCAAsC,CAAC;AACrD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2BAA2B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adtrackify/at-tracking-event-types",
3
- "version": "4.17.0",
3
+ "version": "4.17.2",
4
4
  "description": "",
5
5
  "files": [
6
6
  "dist/*"