@adtrackify/at-tracking-event-types 1.1.35 → 1.2.1

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.
Files changed (160) hide show
  1. package/dist/cjs/index.d.ts +1 -0
  2. package/dist/cjs/index.js +18 -0
  3. package/dist/cjs/index.js.map +1 -0
  4. package/{src/types/adtrackify-event-bus-event.ts → dist/cjs/types/adtrackify-event-bus-event.d.ts} +25 -29
  5. package/dist/cjs/types/adtrackify-event-bus-event.js +3 -0
  6. package/dist/cjs/types/adtrackify-event-bus-event.js.map +1 -0
  7. package/dist/cjs/types/adtrackify-event-types.d.ts +6 -0
  8. package/dist/cjs/types/adtrackify-event-types.js +11 -0
  9. package/dist/cjs/types/adtrackify-event-types.js.map +1 -0
  10. package/dist/cjs/types/adtrackify-standard-events.d.ts +21 -0
  11. package/dist/cjs/types/adtrackify-standard-events.js +26 -0
  12. package/dist/cjs/types/adtrackify-standard-events.js.map +1 -0
  13. package/dist/cjs/types/api/account.d.ts +27 -0
  14. package/dist/cjs/types/api/account.js +10 -0
  15. package/dist/cjs/types/api/account.js.map +1 -0
  16. package/dist/cjs/types/api/destinations/destination-catalog.d.ts +23 -0
  17. package/dist/cjs/types/api/destinations/destination-catalog.js +3 -0
  18. package/dist/cjs/types/api/destinations/destination-catalog.js.map +1 -0
  19. package/dist/cjs/types/api/destinations/destinations.d.ts +55 -0
  20. package/dist/cjs/types/api/destinations/destinations.js +17 -0
  21. package/dist/cjs/types/api/destinations/destinations.js.map +1 -0
  22. package/{src/types/api/destinations/third-party-destination-configs.ts → dist/cjs/types/api/destinations/third-party-destination-configs.d.ts} +49 -65
  23. package/dist/cjs/types/api/destinations/third-party-destination-configs.js +10 -0
  24. package/dist/cjs/types/api/destinations/third-party-destination-configs.js.map +1 -0
  25. package/{src/types/api/index.ts → dist/cjs/types/api/index.d.ts} +8 -8
  26. package/dist/cjs/types/api/index.js +25 -0
  27. package/dist/cjs/types/api/index.js.map +1 -0
  28. package/dist/cjs/types/api/query.d.ts +97 -0
  29. package/dist/cjs/types/api/query.js +70 -0
  30. package/dist/cjs/types/api/query.js.map +1 -0
  31. package/dist/cjs/types/api/shopify-app-install.d.ts +46 -0
  32. package/dist/cjs/types/api/shopify-app-install.js +22 -0
  33. package/dist/cjs/types/api/shopify-app-install.js.map +1 -0
  34. package/dist/cjs/types/api/subscription.d.ts +60 -0
  35. package/dist/cjs/types/api/subscription.js +32 -0
  36. package/dist/cjs/types/api/subscription.js.map +1 -0
  37. package/dist/cjs/types/api/user.d.ts +13 -0
  38. package/dist/cjs/types/api/user.js +3 -0
  39. package/dist/cjs/types/api/user.js.map +1 -0
  40. package/dist/cjs/types/common/address.d.ts +15 -0
  41. package/dist/cjs/types/common/address.js +3 -0
  42. package/dist/cjs/types/common/address.js.map +1 -0
  43. package/{src/types/common/index.ts → dist/cjs/types/common/index.d.ts} +2 -2
  44. package/dist/cjs/types/common/index.js +19 -0
  45. package/dist/cjs/types/common/index.js.map +1 -0
  46. package/dist/cjs/types/common/logger.d.ts +25 -0
  47. package/dist/cjs/types/common/logger.js +19 -0
  48. package/dist/cjs/types/common/logger.js.map +1 -0
  49. package/{src/types/index.ts → dist/cjs/types/index.d.ts} +8 -8
  50. package/dist/cjs/types/index.js +25 -0
  51. package/dist/cjs/types/index.js.map +1 -0
  52. package/dist/cjs/types/third-party-event-configuration-types.d.ts +9 -0
  53. package/dist/cjs/types/third-party-event-configuration-types.js +3 -0
  54. package/dist/cjs/types/third-party-event-configuration-types.js.map +1 -0
  55. package/{src/types/tracking-events/index.ts → dist/cjs/types/tracking-events/index.d.ts} +0 -1
  56. package/dist/cjs/types/tracking-events/index.js +20 -0
  57. package/dist/cjs/types/tracking-events/index.js.map +1 -0
  58. package/dist/cjs/types/tracking-events/tracking-event-context.d.ts +132 -0
  59. package/dist/cjs/types/tracking-events/tracking-event-context.js +3 -0
  60. package/dist/cjs/types/tracking-events/tracking-event-context.js.map +1 -0
  61. package/dist/cjs/types/tracking-events/tracking-event-identity.d.ts +18 -0
  62. package/dist/cjs/types/tracking-events/tracking-event-identity.js +3 -0
  63. package/dist/cjs/types/tracking-events/tracking-event-identity.js.map +1 -0
  64. package/dist/cjs/types/tracking-events/tracking-event-type.d.ts +88 -0
  65. package/dist/cjs/types/tracking-events/tracking-event-type.js +64 -0
  66. package/dist/cjs/types/tracking-events/tracking-event-type.js.map +1 -0
  67. package/dist/esm/index.d.ts +1 -0
  68. package/dist/esm/index.js +2 -0
  69. package/dist/esm/index.js.map +1 -0
  70. package/dist/esm/types/adtrackify-event-bus-event.d.ts +25 -0
  71. package/dist/esm/types/adtrackify-event-bus-event.js +2 -0
  72. package/dist/esm/types/adtrackify-event-bus-event.js.map +1 -0
  73. package/dist/esm/types/adtrackify-event-types.d.ts +6 -0
  74. package/dist/esm/types/adtrackify-event-types.js +8 -0
  75. package/dist/esm/types/adtrackify-event-types.js.map +1 -0
  76. package/dist/esm/types/adtrackify-standard-events.d.ts +21 -0
  77. package/dist/esm/types/adtrackify-standard-events.js +23 -0
  78. package/dist/esm/types/adtrackify-standard-events.js.map +1 -0
  79. package/dist/esm/types/api/account.d.ts +27 -0
  80. package/dist/esm/types/api/account.js +7 -0
  81. package/dist/esm/types/api/account.js.map +1 -0
  82. package/dist/esm/types/api/destinations/destination-catalog.d.ts +23 -0
  83. package/dist/esm/types/api/destinations/destination-catalog.js +2 -0
  84. package/dist/esm/types/api/destinations/destination-catalog.js.map +1 -0
  85. package/dist/esm/types/api/destinations/destinations.d.ts +55 -0
  86. package/dist/esm/types/api/destinations/destinations.js +14 -0
  87. package/dist/esm/types/api/destinations/destinations.js.map +1 -0
  88. package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts +49 -0
  89. package/dist/esm/types/api/destinations/third-party-destination-configs.js +7 -0
  90. package/dist/esm/types/api/destinations/third-party-destination-configs.js.map +1 -0
  91. package/dist/esm/types/api/index.d.ts +8 -0
  92. package/dist/esm/types/api/index.js +9 -0
  93. package/dist/esm/types/api/index.js.map +1 -0
  94. package/dist/esm/types/api/query.d.ts +97 -0
  95. package/dist/esm/types/api/query.js +67 -0
  96. package/dist/esm/types/api/query.js.map +1 -0
  97. package/dist/esm/types/api/shopify-app-install.d.ts +46 -0
  98. package/dist/esm/types/api/shopify-app-install.js +19 -0
  99. package/dist/esm/types/api/shopify-app-install.js.map +1 -0
  100. package/dist/esm/types/api/subscription.d.ts +60 -0
  101. package/dist/esm/types/api/subscription.js +29 -0
  102. package/dist/esm/types/api/subscription.js.map +1 -0
  103. package/dist/esm/types/api/user.d.ts +13 -0
  104. package/dist/esm/types/api/user.js +2 -0
  105. package/dist/esm/types/api/user.js.map +1 -0
  106. package/dist/esm/types/common/address.d.ts +15 -0
  107. package/dist/esm/types/common/address.js +2 -0
  108. package/dist/esm/types/common/address.js.map +1 -0
  109. package/dist/esm/types/common/index.d.ts +2 -0
  110. package/dist/esm/types/common/index.js +3 -0
  111. package/dist/esm/types/common/index.js.map +1 -0
  112. package/dist/esm/types/common/logger.d.ts +25 -0
  113. package/dist/esm/types/common/logger.js +16 -0
  114. package/dist/esm/types/common/logger.js.map +1 -0
  115. package/dist/esm/types/index.d.ts +8 -0
  116. package/dist/esm/types/index.js +9 -0
  117. package/dist/esm/types/index.js.map +1 -0
  118. package/dist/esm/types/third-party-event-configuration-types.d.ts +9 -0
  119. package/dist/esm/types/third-party-event-configuration-types.js +2 -0
  120. package/dist/esm/types/third-party-event-configuration-types.js.map +1 -0
  121. package/dist/esm/types/tracking-events/index.d.ts +3 -0
  122. package/dist/esm/types/tracking-events/index.js +4 -0
  123. package/dist/esm/types/tracking-events/index.js.map +1 -0
  124. package/dist/esm/types/tracking-events/tracking-event-context.d.ts +132 -0
  125. package/dist/esm/types/tracking-events/tracking-event-context.js +2 -0
  126. package/dist/esm/types/tracking-events/tracking-event-context.js.map +1 -0
  127. package/dist/esm/types/tracking-events/tracking-event-identity.d.ts +18 -0
  128. package/dist/esm/types/tracking-events/tracking-event-identity.js +2 -0
  129. package/dist/esm/types/tracking-events/tracking-event-identity.js.map +1 -0
  130. package/dist/esm/types/tracking-events/tracking-event-type.d.ts +88 -0
  131. package/dist/esm/types/tracking-events/tracking-event-type.js +61 -0
  132. package/dist/esm/types/tracking-events/tracking-event-type.js.map +1 -0
  133. package/package.json +16 -8
  134. package/.editorconfig +0 -14
  135. package/.eslintrc.json +0 -33
  136. package/.husky/pre-push +0 -4
  137. package/bitbucket-pipelines.yml +0 -20
  138. package/build.js +0 -27
  139. package/dist/index.d.ts +0 -801
  140. package/dist/index.js +0 -2
  141. package/dist/index.js.map +0 -7
  142. package/env.yml +0 -9
  143. package/src/index.ts +0 -1
  144. package/src/types/adtrackify-event-types.ts +0 -6
  145. package/src/types/adtrackify-standard-events.ts +0 -31
  146. package/src/types/api/account.ts +0 -31
  147. package/src/types/api/destinations/destination-catalog.ts +0 -24
  148. package/src/types/api/destinations/destinations.ts +0 -65
  149. package/src/types/api/query.ts +0 -105
  150. package/src/types/api/shopify-app-install.ts +0 -50
  151. package/src/types/api/subscription.ts +0 -65
  152. package/src/types/api/user.ts +0 -14
  153. package/src/types/common/address.ts +0 -16
  154. package/src/types/common/logger.ts +0 -28
  155. package/src/types/third-party-event-configuration-types.ts +0 -10
  156. package/src/types/tracking-events/tracking-event-context.ts +0 -139
  157. package/src/types/tracking-events/tracking-event-identity.ts +0 -20
  158. package/src/types/tracking-events/tracking-event-type.ts +0 -154
  159. package/tsconfig.json +0 -34
  160. package/tsconfig.tsbuildinfo +0 -1
package/dist/index.d.ts DELETED
@@ -1,801 +0,0 @@
1
- declare module '@adtrackify/at-tracking-event-types/index' {
2
- export * from '@adtrackify/at-tracking-event-types/types/index';
3
-
4
- }
5
- declare module '@adtrackify/at-tracking-event-types/types/adtrackify-event-bus-event' {
6
- import { LogEvent, MetricEvent, TrackingEvent } from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-type';
7
- export interface AdtrackifyEventBusEvent {
8
- eventId: string;
9
- eventType: string;
10
- eventTime: string;
11
- eventData?: object;
12
- }
13
- export interface AdtrackifyEventBusTrackingEvent extends AdtrackifyEventBusEvent {
14
- eventData: {
15
- trackingEvent: TrackingEvent;
16
- pixelId: string;
17
- };
18
- }
19
- export interface AdtrackifyEventBusMetricEvent extends AdtrackifyEventBusEvent {
20
- eventData: {
21
- metricEvent: MetricEvent;
22
- pixelId: string;
23
- };
24
- }
25
- export interface AdtrackifyEventBusLogEvent extends AdtrackifyEventBusEvent {
26
- eventData: {
27
- logEvent: LogEvent;
28
- pixelId: string;
29
- };
30
- }
31
-
32
- }
33
- declare module '@adtrackify/at-tracking-event-types/types/adtrackify-event-types' {
34
- export enum ADTRACKIFY_EVENT_TYPE {
35
- TRACKING = "tracking",
36
- METRIC = "metric",
37
- IDENTIFY = "identify",
38
- LOG = "log"
39
- }
40
-
41
- }
42
- declare module '@adtrackify/at-tracking-event-types/types/adtrackify-standard-events' {
43
- export enum ADTRACKIFY_STANDARD_EVENT {
44
- ADD_PAYMENT_INFO = "add_payment_info",
45
- ADD_SHIPPING_INFO = "add_shipping_info",
46
- ADD_TO_CART = "add_to_cart",
47
- ADD_TO_WISHLIST = "add_to_wishlist",
48
- INITIATE_CHECKOUT = "initiate_checkout",
49
- LEAD = "lead",
50
- LOGIN = "login",
51
- PAGE_VIEW = "page_view",
52
- PURCHASE = "purchase",
53
- REFUND = "refund",
54
- SEARCH = "search",
55
- SIGN_UP = "sign_up",
56
- VIEW_CART = "view_cart",
57
- VIEW_CONTENT = "view_content",
58
- SELECT_SHIPPING_METHOD = "select_shipping_method",
59
- VIRTUALIZED_VIEWED_PAYMENT_FORM = "virtualized_viewd_payment_form",
60
- METRIC = "metric",
61
- WEB_VITAL = "web_vital",
62
- LOG = "log"
63
- }
64
-
65
- }
66
- declare module '@adtrackify/at-tracking-event-types/types/api/account' {
67
- import { Subscription } from '@adtrackify/at-tracking-event-types/types/api/subscription';
68
- export interface Account {
69
- id: string;
70
- accountName: string;
71
- companyName?: string;
72
- accountStatus: ACCOUNT_STATUS;
73
- primaryEmail: string;
74
- publicApiKey?: string;
75
- subscriptionId?: string;
76
- pixels?: Pixel[];
77
- subscription?: Subscription;
78
- ownerId?: string;
79
- createdAt: string;
80
- updatedAt: string;
81
- }
82
- export interface Pixel {
83
- id: string;
84
- accountId: string;
85
- name: string;
86
- createdAt: string;
87
- updatedAt: string;
88
- }
89
- export enum ACCOUNT_STATUS {
90
- PENDING = "pending",
91
- ACTIVE = "active",
92
- INACTIVE = "inactive"
93
- }
94
-
95
- }
96
- declare module '@adtrackify/at-tracking-event-types/types/api/destinations/destination-catalog' {
97
- export interface DestinationCatalogItem {
98
- id: string;
99
- active: boolean;
100
- destinationKey: string;
101
- destinationType: string;
102
- displayName?: string;
103
- shortName?: string;
104
- description?: string;
105
- url: string;
106
- fields?: DestinationCatalogFields[];
107
- createdAt: string;
108
- updatedAt: string;
109
- }
110
- export interface DestinationCatalogFields {
111
- component_type: string;
112
- name: string;
113
- description: string;
114
- label: string;
115
- type: string;
116
- required: boolean;
117
- values?: any[];
118
- order: number;
119
- }
120
-
121
- }
122
- declare module '@adtrackify/at-tracking-event-types/types/api/destinations/destinations' {
123
- export interface Destination {
124
- id: string;
125
- accountId: string;
126
- pixelId: string;
127
- destination: string;
128
- displayName?: string;
129
- enabled: boolean;
130
- configuration?: UserDestinationConfiguration;
131
- createdAt: string;
132
- updatedAt: string;
133
- }
134
- export enum DESTINATIONS {
135
- FACEBOOK = "facebook",
136
- TIKTOK = "tiktok",
137
- GOOGLE_ADS = "googleAds",
138
- GOOGLE_ANALYTICS_4 = "googleAnalytics4",
139
- HUBSPOT = "hubspot",
140
- WEBHOOK = "webhook",
141
- CUSTOM_HTML = "customHTML",
142
- SNAPCHAT = "snapchat",
143
- TWITTER = "twitter",
144
- REDDIT = "reddit"
145
- }
146
- export interface UserDestinationConfiguration {
147
- [key: string]: any;
148
- eventBlacklist?: string[];
149
- events?: EventConfiguration[];
150
- trigger?: DestinationTriggerConfiguration;
151
- }
152
- export interface DestinationTriggerConfiguration {
153
- shopify?: ShopifyTriggerConfiguration;
154
- exludeDomains?: string[];
155
- excludePages?: string[];
156
- domains?: string[];
157
- pages?: string[];
158
- }
159
- export interface ShopifyTriggerConfiguration {
160
- enabled: boolean;
161
- collections?: string[];
162
- tags?: string[];
163
- }
164
- export interface EventConfiguration {
165
- sourceEventName: string;
166
- exclude?: boolean;
167
- sample: EventSampleConfiguration;
168
- transformations?: EventTransformation[];
169
- }
170
- export interface EventTransformation {
171
- transformationEventName: string;
172
- enabled: boolean;
173
- }
174
- export interface EventSampleConfiguration {
175
- enabled: boolean;
176
- rate: number;
177
- }
178
-
179
- }
180
- declare module '@adtrackify/at-tracking-event-types/types/api/destinations/third-party-destination-configs' {
181
- import { Destination, UserDestinationConfiguration } from '@adtrackify/at-tracking-event-types/types/api/destinations/destinations';
182
- export interface AdTrackifyFacebookDestination extends Destination {
183
- configuration: FacebookPixelConfiguration;
184
- }
185
- export interface AdTrackifyTikTokDestination extends Destination {
186
- configuration: TiktokPixelConfiguration;
187
- }
188
- export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
189
- configuration: GoogleAnalytics4Configuration;
190
- }
191
- export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
192
- apiAccessToken?: string;
193
- enableConversionAPI: boolean;
194
- pixelId: string;
195
- }
196
- export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
197
- apiAccessToken?: string;
198
- enableConversionAPI: boolean;
199
- pixelId: string;
200
- }
201
- export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
202
- apiSecret: string;
203
- measurementId: string;
204
- }
205
- export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
206
- pixelId: string;
207
- conversionID: string;
208
- }
209
- export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
210
- hubspotId: string;
211
- }
212
- export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
213
- snapchatPixelId: string;
214
- }
215
- export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
216
- twitterPixelId: string;
217
- }
218
- export interface WebhookConfiguration extends UserDestinationConfiguration {
219
- webhookUrl: string;
220
- }
221
- export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
222
- html: string;
223
- location: CustomHTMLLocation;
224
- }
225
- export enum CustomHTMLLocation {
226
- HEADER = "header",
227
- FOOTER = "footer",
228
- BODY = "body"
229
- }
230
-
231
- }
232
- declare module '@adtrackify/at-tracking-event-types/types/api/index' {
233
- export * from '@adtrackify/at-tracking-event-types/types/api/account';
234
- export * from '@adtrackify/at-tracking-event-types/types/api/destinations/destinations';
235
- export * from '@adtrackify/at-tracking-event-types/types/api/destinations/destination-catalog';
236
- export * from '@adtrackify/at-tracking-event-types/types/api/destinations/third-party-destination-configs';
237
- export * from '@adtrackify/at-tracking-event-types/types/api/shopify-app-install';
238
- export * from '@adtrackify/at-tracking-event-types/types/api/subscription';
239
- export * from '@adtrackify/at-tracking-event-types/types/api/user';
240
- export * from '@adtrackify/at-tracking-event-types/types/api/query';
241
-
242
- }
243
- declare module '@adtrackify/at-tracking-event-types/types/api/query' {
244
- export interface DateRange {
245
- start: string;
246
- end: string;
247
- }
248
- export enum GRANULARITY {
249
- SECOND = "second",
250
- MINUTE = "minute",
251
- HOUR = "hour",
252
- DAY = "day",
253
- WEEK = "week",
254
- MONTH = "month",
255
- QUARTER = "quarter",
256
- YEAR = "year"
257
- }
258
- export enum MEASURE {
259
- TRACKED_PAGE_VIEWS = "tracked.page_views",
260
- TRACKED_VIEW_CONTENTS = "tracked.view_contents",
261
- TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
262
- TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
263
- TRACKED_PURCHASES = "tracked.purchases",
264
- TRACKED_REVENUE = "tracked.revenue",
265
- TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
266
- TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
267
- TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
268
- TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
269
- TRACKED_UNIQUE_VISITORS = "tracked.visitors",
270
- SHOPIFY_CUSTOMERS = "shopify.customers",
271
- SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
272
- SHOPIFY_RETURNS = "shopify.returns",
273
- SHOPIFY_RETURN_REVENUE = "shopify.return_revenue",
274
- SHOPIFY_RETURN_RATE = "shopify.return_rate",
275
- SHOPIFY_REFUNDS = "shopify.refunds",
276
- SHOPIFY_REFUND_REVENUE = "shopify.refunds_revenue",
277
- SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
278
- SHOPIFY_ORDERS = "shopify.orders",
279
- SHOPIFY_REVENUE = "shopify.revenue",
280
- SHOPIFY_AOV = "shopify.average_order_value",
281
- SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
282
- SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
283
- SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
284
- SITE_TTFB = "site.ttfb",
285
- SITE_FCP = "site.fcp",
286
- SITE_LCP = "site.lcp",
287
- SITE_TIME_ON_SITE = "site.time_on_site"
288
- }
289
- export interface Query {
290
- pixelId: string;
291
- measures: MEASURE[];
292
- dateRange: DateRange;
293
- compareDateRange?: DateRange;
294
- granularity?: GRANULARITY;
295
- dimensions?: DIMENSION[];
296
- filters?: any[];
297
- }
298
- export interface MeasureDataRow {
299
- [key: string]: number | string;
300
- 'dt': string;
301
- }
302
- export interface MeasureData {
303
- primaryAvg: number;
304
- compareAvg: number;
305
- primarySum: number;
306
- compareSum: number;
307
- percentDiff: number;
308
- primary?: MeasureDataRow[];
309
- compare?: MeasureDataRow[];
310
- }
311
- export interface MeasureResult {
312
- measure: MEASURE;
313
- granularity: GRANULARITY;
314
- dateRange: DateRange;
315
- compareDateRange?: DateRange;
316
- success: boolean;
317
- data: MeasureData;
318
- }
319
- export enum DIMENSION {
320
- REFERRER = "referrer",
321
- COUNTRY = "country",
322
- POSTAL_CODE = "postal_code",
323
- PROVINCE = "province",
324
- DEVICE_MODEL = "device_model",
325
- DEVICE_VENDOR = "device_vendor",
326
- DEVICE_TYPE = "device_type",
327
- BROWSER = "browser",
328
- BROWSER_VERSION = "browser_version",
329
- OS = "OS",
330
- PAGE_PATH = "path",
331
- PAGE_TITLE = "title",
332
- QUERY_STRING = "query",
333
- UTM_SOURCE = "utm_source",
334
- UTM_MEDIUM = "utm_medium",
335
- UTM_TERM = "utm_term",
336
- UTM_CONTENT = "utm_content",
337
- ADBLOCK_DETECTED = "adblock_detected",
338
- TIMEZONE = "timezone",
339
- LOCALE = "locale"
340
- }
341
-
342
- }
343
- declare module '@adtrackify/at-tracking-event-types/types/api/shopify-app-install' {
344
- export interface ShopifyAppInstall {
345
- shopifyAppInstallId: string;
346
- shop: string;
347
- accessToken?: string;
348
- appStatus?: string;
349
- appSubscriptionStatus?: ShopifyAppSubscriptionStatus;
350
- code?: string;
351
- hmac?: string;
352
- host?: string;
353
- installRequest?: ShopifyInstallRequest;
354
- isAppEnabled?: boolean;
355
- pixelId?: string;
356
- shopInfo?: any;
357
- state?: string;
358
- timestamp?: number;
359
- createdAt: string;
360
- updatedAt: string;
361
- }
362
- export enum ShopifyAppInstallStatus {
363
- STARTED = "started",
364
- COMPLETED = "completed",
365
- UNINSTALLED = "uninstalled",
366
- FAILED = "failed",
367
- NONE = "none"
368
- }
369
- export enum ShopifyAppSubscriptionStatus {
370
- ACTIVE = "active",
371
- CANCELLED = "cancelled",
372
- DECLINED = "declined",
373
- EXPIRED = "expired",
374
- FROZEN = "frozen",
375
- PENDING = "pending",
376
- NOT_SUBMITTED = "na"
377
- }
378
- export interface ShopifyInstallRequest {
379
- shop?: string;
380
- session?: string;
381
- hmac?: string;
382
- host?: string;
383
- nonce?: string;
384
- timestamp?: string;
385
- status?: string;
386
- }
387
- export interface ShopifyStoreInfo {
388
- [key: string]: any;
389
- }
390
-
391
- }
392
- declare module '@adtrackify/at-tracking-event-types/types/api/subscription' {
393
- export interface Subscription {
394
- id: string;
395
- accountId?: string;
396
- shopifyAppInstallId?: string;
397
- shopifyDomain?: string;
398
- stripeCustomerId?: string;
399
- stripeSubscriptionId?: string;
400
- stripeCompletedCheckoutSession?: any;
401
- shopifyChargeId?: string;
402
- subscriptionPlan?: SubscriptionPlan;
403
- status?: SUBSCRIPTION_STATUS;
404
- paymentStatus?: PAYMENT_STATUS;
405
- paymentGateway?: PAYMENT_GATEWAY;
406
- createdAt: string;
407
- updatedAt: string;
408
- }
409
- export interface SubscriptionPlan {
410
- id: number;
411
- planName: string;
412
- displayName: string;
413
- description: string;
414
- sku: string;
415
- price: string;
416
- displayPrice: string;
417
- billingFrequency: PLAN_BILLING_FREQUENCY;
418
- trialLengthDays?: number;
419
- trialRequiresCreditCard?: boolean;
420
- planDesc?: string[];
421
- unitPriceText?: string;
422
- isHighlighted?: boolean;
423
- isBanner?: boolean;
424
- bannerText?: string;
425
- bannerColor?: string;
426
- stripePriceId?: string;
427
- stripeProductId?: string;
428
- }
429
- export enum PLAN_BILLING_FREQUENCY {
430
- MONTHLY = "monthly",
431
- YEARLY = "yearly"
432
- }
433
- export enum PAYMENT_STATUS {
434
- CURRENT = "current",
435
- PAST_DUE = "past_due",
436
- CANCELLED = "cancelled",
437
- FAILED = "failed"
438
- }
439
- export enum SUBSCRIPTION_STATUS {
440
- ACTIVE = "active",
441
- CANCELLED = "cancelled",
442
- DECLINED = "declined",
443
- EXPIRED = "expired",
444
- FROZEN = "frozen",
445
- PENDING = "pending",
446
- NOT_SUBMITTED = "na"
447
- }
448
- export enum PAYMENT_GATEWAY {
449
- STRIPE = "stripe",
450
- PAYPAL = "paypal",
451
- SHOPIFY = "shopify"
452
- }
453
-
454
- }
455
- declare module '@adtrackify/at-tracking-event-types/types/api/user' {
456
- export interface User {
457
- id: string;
458
- sub: string;
459
- userId: string;
460
- Username: string;
461
- UserLastModifiedDate: string;
462
- Enabled: boolean;
463
- UserStatus: string;
464
- email: string;
465
- email_verified: string;
466
- name: string;
467
- family_name: string;
468
- }
469
-
470
- }
471
- declare module '@adtrackify/at-tracking-event-types/types/common/address' {
472
- export interface AddressInfo {
473
- email?: string;
474
- phone?: string;
475
- firstName?: string;
476
- lastName?: string;
477
- company?: string;
478
- address1?: string;
479
- address2?: string;
480
- city?: string;
481
- province?: string;
482
- provinceCode?: string;
483
- country?: string;
484
- countryCode?: string;
485
- zip?: string;
486
- }
487
-
488
- }
489
- declare module '@adtrackify/at-tracking-event-types/types/common/index' {
490
- export * from '@adtrackify/at-tracking-event-types/types/common/address';
491
- export * from '@adtrackify/at-tracking-event-types/types/common/logger';
492
-
493
- }
494
- declare module '@adtrackify/at-tracking-event-types/types/common/logger' {
495
- export interface LogContext {
496
- [x: string]: LogContextValue;
497
- }
498
- export type LogContextValue = string | number | boolean | LogContext | LogContextArray | undefined | null;
499
- export interface LogContextArray extends Array<LogContextValue> {
500
- }
501
- export enum LogLevel {
502
- debug = "debug",
503
- error = "error",
504
- info = "info",
505
- trace = "trace",
506
- warn = "warn"
507
- }
508
- export const LogLevelId: {
509
- trace: number;
510
- debug: number;
511
- info: number;
512
- warn: number;
513
- error: number;
514
- };
515
- export interface LogMessage {
516
- message: string;
517
- logLevel: LogLevel;
518
- context?: LogContext;
519
- }
520
-
521
- }
522
- declare module '@adtrackify/at-tracking-event-types/types/index' {
523
- export * from '@adtrackify/at-tracking-event-types/types/api/index';
524
- export * from '@adtrackify/at-tracking-event-types/types/common/index';
525
- export * from '@adtrackify/at-tracking-event-types/types/adtrackify-standard-events';
526
- export * from '@adtrackify/at-tracking-event-types/types/third-party-event-configuration-types';
527
- export * from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-type';
528
- export * from '@adtrackify/at-tracking-event-types/types/adtrackify-event-bus-event';
529
- export * from '@adtrackify/at-tracking-event-types/types/tracking-events/index';
530
- export * from '@adtrackify/at-tracking-event-types/types/adtrackify-event-types';
531
-
532
- }
533
- declare module '@adtrackify/at-tracking-event-types/types/third-party-event-configuration-types' {
534
- export interface DestinationConfiguration {
535
- eventConfigurations: DestinationEventSpecificConfiguration[];
536
- }
537
- export interface DestinationEventSpecificConfiguration {
538
- enabled: boolean;
539
- sourceEventName: string;
540
- destinationEventName?: string;
541
- excludeEvent?: boolean;
542
- }
543
-
544
- }
545
- declare module '@adtrackify/at-tracking-event-types/types/tracking-events/index' {
546
- export * from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-type';
547
- export * from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-context';
548
- export * from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-identity';
549
-
550
- }
551
- declare module '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-context' {
552
- import { TrackingEventIdentity } from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-identity';
553
- import { IResult } from 'ua-parser-js';
554
- export interface TrackingEventContext {
555
- externalId?: string;
556
- identity: TrackingEventIdentity;
557
- properties?: TrackingEventContextProperties;
558
- }
559
- export interface TrackingEventContextProperties {
560
- click?: AdClickInfo;
561
- campaign?: CampaignInfo;
562
- page?: PageInfo;
563
- device?: DeviceInfo;
564
- locale?: string;
565
- timezone?: string;
566
- userAgent?: string;
567
- ipAddress?: string;
568
- ipv6Address?: string;
569
- sessionId?: string;
570
- shopify?: ShopifyInfo;
571
- adBlockDetected?: boolean;
572
- enrichment?: Enrichment;
573
- }
574
- export interface IPDataResponse {
575
- ip: string;
576
- is_eu: boolean;
577
- city?: string;
578
- region?: string;
579
- region_code?: string;
580
- country_name: string;
581
- country_code: string;
582
- continent_name: string;
583
- continent_code: string;
584
- latitude: number;
585
- longitude: number;
586
- postal?: string;
587
- calling_code: string;
588
- flag: string;
589
- emoji_flag: string;
590
- emoji_unicode: string;
591
- asn: {
592
- asn: string;
593
- name: string;
594
- domain: string;
595
- route: string;
596
- type: string;
597
- };
598
- company?: {
599
- name: string;
600
- domain: string;
601
- network: string;
602
- type: string;
603
- };
604
- carrier?: {
605
- name: string;
606
- mcc: string;
607
- mnc: string;
608
- };
609
- languages: {
610
- name: string;
611
- native: string;
612
- }[];
613
- currency: {
614
- name: string;
615
- code: string;
616
- symbol: string;
617
- native: string;
618
- plural: string;
619
- };
620
- time_zone: {
621
- name: string;
622
- abbr: string;
623
- offset: string;
624
- is_dst: boolean;
625
- current_time: string;
626
- };
627
- threat: {
628
- is_tor: boolean;
629
- is_proxy: boolean;
630
- is_anonymous: boolean;
631
- is_known_attacker: boolean;
632
- is_known_abuser: boolean;
633
- is_threat: boolean;
634
- is_bogon: boolean;
635
- };
636
- }
637
- export interface Enrichment {
638
- refrMedium?: string;
639
- refrSource?: string;
640
- refrTerm?: string;
641
- mktCampaign?: string;
642
- mktSource?: string;
643
- mktMedium?: string;
644
- mktTerm?: string;
645
- mktContent?: string;
646
- mktClickParam?: string;
647
- mktClickId?: string;
648
- mktClickNetwork?: string;
649
- isMobile?: boolean;
650
- isWirelessCarrier?: boolean;
651
- ipLookupResponse?: IPDataResponse;
652
- }
653
- export interface AdClickInfo {
654
- fbp?: string;
655
- fbc?: string;
656
- fbclid?: string;
657
- gclid?: string;
658
- gbraid?: string;
659
- wbraid?: string;
660
- ttclid?: string;
661
- ttp?: string;
662
- }
663
- export interface CampaignInfo {
664
- name?: string;
665
- campaign?: string;
666
- source?: string;
667
- medium?: string;
668
- term?: string;
669
- content?: string;
670
- }
671
- export interface PageInfo {
672
- path?: string;
673
- referrer?: string;
674
- search?: string;
675
- title?: string;
676
- url?: string;
677
- qsp?: any;
678
- }
679
- export interface ShopifyInfo {
680
- collections?: string[];
681
- tags?: string[];
682
- }
683
- export type DeviceInfo = IResult;
684
-
685
- }
686
- declare module '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-identity' {
687
- import { AddressInfo } from '@adtrackify/at-tracking-event-types/types/common/address';
688
- export interface TrackingEventIdentity {
689
- identityId?: string;
690
- anonymousId?: string;
691
- traits?: TrackingEventIdentityTraits;
692
- }
693
- export interface TrackingEventIdentityTraits {
694
- [key: string]: any;
695
- userId?: string | null;
696
- gender?: string | null;
697
- dob?: string | null;
698
- phone?: string | null;
699
- id?: string | null;
700
- firstName?: string | null;
701
- lastName?: string | null;
702
- email?: string | null;
703
- addresses?: AddressInfo[];
704
- }
705
-
706
- }
707
- declare module '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-type' {
708
- import { ADTRACKIFY_STANDARD_EVENT } from '@adtrackify/at-tracking-event-types/types/adtrackify-standard-events';
709
- import { ADTRACKIFY_EVENT_TYPE } from '@adtrackify/at-tracking-event-types/types/adtrackify-event-types';
710
- import { AddressInfo } from '@adtrackify/at-tracking-event-types/types/common/address';
711
- import { TrackingEventContext } from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-context';
712
- import { TrackingEventIdentity } from '@adtrackify/at-tracking-event-types/types/tracking-events/tracking-event-identity';
713
- import { LogMessage } from '@adtrackify/at-tracking-event-types/types/common/logger';
714
- export interface Event {
715
- id: string;
716
- type: ADTRACKIFY_EVENT_TYPE;
717
- name: ADTRACKIFY_STANDARD_EVENT;
718
- pixelId: string;
719
- sentAtEpoch?: number;
720
- collectedAtEpoch?: number;
721
- collectedAt?: string;
722
- version: string;
723
- context?: TrackingEventContext;
724
- }
725
- export interface TrackingEvent extends Event {
726
- identity?: TrackingEventIdentity;
727
- data?: TrackingEventData;
728
- testCode?: string;
729
- }
730
- export interface MetricEvent extends Event {
731
- data: MetricEventData;
732
- }
733
- export interface LogEvent extends Event {
734
- data: LogEventData;
735
- }
736
- export interface TrackingEventData {
737
- [key: string]: any;
738
- firstName?: string;
739
- lastName?: string;
740
- email?: string;
741
- phone?: string;
742
- addresses?: AddressInfo[];
743
- cartId?: string;
744
- transactionId?: string;
745
- orderId?: string;
746
- orderName?: string;
747
- affiliation?: string;
748
- currency?: string;
749
- price?: number;
750
- subtotalPrice?: number;
751
- value?: number;
752
- tax?: number;
753
- shipping?: number;
754
- coupon?: string;
755
- paymentType?: string;
756
- shippingTier?: string;
757
- creativeName?: string;
758
- creativeSlot?: string;
759
- locationId?: string;
760
- promotionId?: string;
761
- promotionName?: string;
762
- items?: GenericContent[];
763
- }
764
- export interface GenericContent {
765
- [key: string]: any;
766
- content_type?: string;
767
- id?: string;
768
- name?: string;
769
- sku?: string;
770
- brand?: string;
771
- variant?: string;
772
- coupon?: string;
773
- currency?: string;
774
- discount?: number;
775
- index?: number;
776
- value?: number;
777
- price?: number;
778
- quantity?: number;
779
- url?: string;
780
- locationId?: string;
781
- imageUrl?: string;
782
- category?: string;
783
- category2?: string;
784
- category3?: string;
785
- category4?: string;
786
- category5?: string;
787
- }
788
- export interface LogEventData extends LogMessage {
789
- }
790
- export interface MetricEventData {
791
- [key: string]: any;
792
- name: string;
793
- value: number;
794
- }
795
- export const Currencies: string[];
796
-
797
- }
798
- declare module '@adtrackify/at-tracking-event-types' {
799
- import main = require('@adtrackify/at-tracking-event-types/src/index');
800
- export = main;
801
- }