@segment/analytics-browser-actions-tiktok-pixel 1.46.0 → 1.47.0

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 (53) hide show
  1. package/dist/cjs/common_fields.js +82 -0
  2. package/dist/cjs/common_fields.js.map +1 -1
  3. package/dist/cjs/{reportWebEvent/formatter.d.ts → formatter.d.ts} +2 -0
  4. package/dist/cjs/{reportWebEvent/formatter.js → formatter.js} +13 -1
  5. package/dist/cjs/formatter.js.map +1 -0
  6. package/dist/cjs/identify/generated-types.d.ts +30 -0
  7. package/dist/cjs/identify/generated-types.js +3 -0
  8. package/dist/cjs/identify/generated-types.js.map +1 -0
  9. package/dist/cjs/identify/index.d.ts +6 -0
  10. package/dist/cjs/identify/index.js +55 -0
  11. package/dist/cjs/identify/index.js.map +1 -0
  12. package/dist/cjs/index.js +3 -1
  13. package/dist/cjs/index.js.map +1 -1
  14. package/dist/cjs/init-script.js +1 -1
  15. package/dist/cjs/init-script.js.map +1 -1
  16. package/dist/cjs/reportWebEvent/generated-types.d.ts +8 -0
  17. package/dist/cjs/reportWebEvent/index.js +10 -4
  18. package/dist/cjs/reportWebEvent/index.js.map +1 -1
  19. package/dist/cjs/types.d.ts +8 -1
  20. package/dist/esm/common_fields.js +82 -0
  21. package/dist/esm/common_fields.js.map +1 -1
  22. package/dist/esm/{reportWebEvent/formatter.d.ts → formatter.d.ts} +2 -0
  23. package/dist/esm/{reportWebEvent/formatter.js → formatter.js} +10 -0
  24. package/dist/esm/formatter.js.map +1 -0
  25. package/dist/esm/identify/generated-types.d.ts +30 -0
  26. package/dist/esm/identify/generated-types.js +2 -0
  27. package/dist/esm/identify/generated-types.js.map +1 -0
  28. package/dist/esm/identify/index.d.ts +6 -0
  29. package/dist/esm/identify/index.js +53 -0
  30. package/dist/esm/identify/index.js.map +1 -0
  31. package/dist/esm/index.js +3 -1
  32. package/dist/esm/index.js.map +1 -1
  33. package/dist/esm/init-script.js +1 -1
  34. package/dist/esm/init-script.js.map +1 -1
  35. package/dist/esm/reportWebEvent/generated-types.d.ts +8 -0
  36. package/dist/esm/reportWebEvent/index.js +10 -4
  37. package/dist/esm/reportWebEvent/index.js.map +1 -1
  38. package/dist/esm/types.d.ts +8 -1
  39. package/dist/tsconfig.tsbuildinfo +1 -1
  40. package/package.json +4 -4
  41. package/src/common_fields.ts +84 -0
  42. package/src/{reportWebEvent/formatter.ts → formatter.ts} +14 -4
  43. package/src/identify/__tests__/index.test.ts +110 -0
  44. package/src/identify/generated-types.ts +110 -0
  45. package/src/identify/index.ts +60 -0
  46. package/src/index.ts +4 -1
  47. package/src/init-script.ts +1 -1
  48. package/src/reportWebEvent/__tests__/index.test.ts +142 -5
  49. package/src/reportWebEvent/generated-types.ts +29 -0
  50. package/src/reportWebEvent/index.ts +10 -4
  51. package/src/types.ts +14 -1
  52. package/dist/cjs/reportWebEvent/formatter.js.map +0 -1
  53. package/dist/esm/reportWebEvent/formatter.js.map +0 -1
@@ -1,7 +1,7 @@
1
1
  import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
2
2
  import type { Settings } from '../generated-types'
3
3
  import type { Payload } from './generated-types'
4
- import { formatPhone, handleArrayInput } from './formatter'
4
+ import { formatPhone, handleArrayInput, formatString, formatAddress } from '../formatter'
5
5
  import { TikTokPixel } from '../types'
6
6
  import { commonFields } from '../common_fields'
7
7
 
@@ -14,16 +14,22 @@ const action: BrowserActionDefinition<Settings, TikTokPixel, Payload> = {
14
14
  fields: {
15
15
  ...commonFields
16
16
  },
17
- perform: (ttq, { payload }) => {
17
+ perform: (ttq, { payload, settings }) => {
18
18
  if (payload.email || payload.phone_number || payload.external_id) {
19
19
  ttq.identify({
20
20
  email: handleArrayInput(payload.email),
21
21
  phone_number: formatPhone(handleArrayInput(payload.phone_number)),
22
- external_id: handleArrayInput(payload.external_id)
22
+ external_id: handleArrayInput(payload.external_id),
23
+ first_name: formatString(payload.first_name),
24
+ last_name: formatString(payload.last_name),
25
+ city: formatAddress(payload.address?.city),
26
+ state: formatAddress(payload.address?.state),
27
+ country: formatAddress(payload.address?.country),
28
+ zip_code: formatString(payload.address?.zip_code)
23
29
  })
24
30
  }
25
31
 
26
- ttq.track(
32
+ ttq.instance(settings.pixelCode).track(
27
33
  payload.event,
28
34
  {
29
35
  contents: payload.contents ? payload.contents : [],
package/src/types.ts CHANGED
@@ -1,13 +1,26 @@
1
1
  export interface TikTokPixel {
2
2
  page: () => void
3
+ instance: (pixel_code: string) => TikTokPixel
3
4
  identify: ({
4
5
  email,
5
6
  phone_number,
6
- external_id
7
+ external_id,
8
+ first_name,
9
+ last_name,
10
+ city,
11
+ state,
12
+ country,
13
+ zip_code
7
14
  }: {
8
15
  email: string | undefined
9
16
  phone_number: string | undefined
10
17
  external_id: string | undefined
18
+ first_name: string | undefined
19
+ last_name: string | undefined
20
+ city: string | undefined
21
+ state: string | undefined
22
+ country: string | undefined
23
+ zip_code: string | undefined
11
24
  }) => void
12
25
  track: (
13
26
  event: string,
@@ -1 +0,0 @@
1
- {"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/reportWebEvent/formatter.ts"],"names":[],"mappings":";;;AAKA,SAAgB,WAAW,CAAC,KAAyB;IACnD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAE5B,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAClD,IAAI,cAAc,KAAK,IAAI,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;KAC/D;IAED,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;IAEvD,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAChD,OAAO,cAAc,CAAA;AACvB,CAAC;AAZD,kCAYC;AAED,SAAgB,gBAAgB,CAAC,YAA2C;IAC1E,IAAG,OAAO,YAAY,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAA;IACxD,IAAG,OAAO,YAAY,KAAK,WAAW;QAAE,OAAO,EAAE,CAAA;IACjD,IAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAC;QAC7B,OAAO,YAAY,CAAC,MAAM,GAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,EAAE,CAAA;KACnD;IACD,OAAO,EAAE,CAAA;AACX,CAAC;AAPD,4CAOC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/reportWebEvent/formatter.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,WAAW,CAAC,KAAyB;IACnD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAE5B,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAClD,IAAI,cAAc,KAAK,IAAI,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;KAC/D;IAED,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;IAEvD,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAChD,OAAO,cAAc,CAAA;AACvB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,YAA2C;IAC1E,IAAG,OAAO,YAAY,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAA;IACxD,IAAG,OAAO,YAAY,KAAK,WAAW;QAAE,OAAO,EAAE,CAAA;IACjD,IAAG,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAC;QAC7B,OAAO,YAAY,CAAC,MAAM,GAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA,CAAC,CAAC,EAAE,CAAA;KACnD;IACD,OAAO,EAAE,CAAA;AACX,CAAC"}