@phantomstudios/ft-lib 0.2.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.
- package/.babelrc +6 -0
- package/.eslintrc +58 -0
- package/.github/CODEOWNERS +1 -0
- package/.github/workflows/pr.yml +31 -0
- package/.github/workflows/release.yml +44 -0
- package/.nvmrc +1 -0
- package/.prettierignore +5 -0
- package/CODE_OF_CONDUCT.md +76 -0
- package/CONTRIBUTING.md +48 -0
- package/LICENSE +21 -0
- package/README.md +158 -0
- package/SUPPORT.md +4 -0
- package/jest.config.js +24 -0
- package/lib/FTTracking/index.d.ts +24 -0
- package/lib/FTTracking/index.d.ts.map +1 -0
- package/lib/FTTracking/index.js +69 -0
- package/lib/FTTracking/index.js.map +1 -0
- package/lib/consentMonitor/index.d.ts +19 -0
- package/lib/consentMonitor/index.d.ts.map +1 -0
- package/lib/consentMonitor/index.js +117 -0
- package/lib/consentMonitor/index.js.map +1 -0
- package/lib/gaTracker/index.d.ts +13 -0
- package/lib/gaTracker/index.d.ts.map +1 -0
- package/lib/gaTracker/index.js +120 -0
- package/lib/gaTracker/index.js.map +1 -0
- package/lib/index.d.ts +9 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +18 -0
- package/lib/index.js.map +1 -0
- package/lib/oTracker/index.d.ts +14 -0
- package/lib/oTracker/index.d.ts.map +1 -0
- package/lib/oTracker/index.js +114 -0
- package/lib/oTracker/index.js.map +1 -0
- package/lib/permutiveVideoUtils/index.d.ts +12 -0
- package/lib/permutiveVideoUtils/index.d.ts.map +1 -0
- package/lib/permutiveVideoUtils/index.js +59 -0
- package/lib/permutiveVideoUtils/index.js.map +1 -0
- package/lib/reactPlayerTracking/index.d.ts +30 -0
- package/lib/reactPlayerTracking/index.d.ts.map +1 -0
- package/lib/reactPlayerTracking/index.js +85 -0
- package/lib/reactPlayerTracking/index.js.map +1 -0
- package/lib/utils/attention.d.ts +20 -0
- package/lib/utils/attention.d.ts.map +1 -0
- package/lib/utils/attention.js +142 -0
- package/lib/utils/attention.js.map +1 -0
- package/lib/utils/cookies.d.ts +2 -0
- package/lib/utils/cookies.d.ts.map +1 -0
- package/lib/utils/cookies.js +14 -0
- package/lib/utils/cookies.js.map +1 -0
- package/lib/utils/getTrace.d.ts +6 -0
- package/lib/utils/getTrace.d.ts.map +1 -0
- package/lib/utils/getTrace.js +109 -0
- package/lib/utils/getTrace.js.map +1 -0
- package/lib/utils/intersectionObserverPolyfill.d.ts +1 -0
- package/lib/utils/intersectionObserverPolyfill.d.ts.map +1 -0
- package/lib/utils/intersectionObserverPolyfill.js +421 -0
- package/lib/utils/intersectionObserverPolyfill.js.map +1 -0
- package/lib/utils/scroll.d.ts +18 -0
- package/lib/utils/scroll.d.ts.map +1 -0
- package/lib/utils/scroll.js +75 -0
- package/lib/utils/scroll.js.map +1 -0
- package/lib/utils/yupValidator.d.ts +87 -0
- package/lib/utils/yupValidator.d.ts.map +1 -0
- package/lib/utils/yupValidator.js +189 -0
- package/lib/utils/yupValidator.js.map +1 -0
- package/lib/ytIframeTracking/index.d.ts +27 -0
- package/lib/ytIframeTracking/index.d.ts.map +1 -0
- package/lib/ytIframeTracking/index.js +165 -0
- package/lib/ytIframeTracking/index.js.map +1 -0
- package/package.json +75 -0
- package/src/FTTracking/index.ts +74 -0
- package/src/consentMonitor/index.ts +120 -0
- package/src/gaTracker/index.ts +136 -0
- package/src/index.ts +12 -0
- package/src/oTracker/index.ts +122 -0
- package/src/permutiveVideoUtils/index.ts +53 -0
- package/src/reactPlayerTracking/index.ts +105 -0
- package/src/types.d.ts +33 -0
- package/src/utils/attention.js +138 -0
- package/src/utils/cookies.js +9 -0
- package/src/utils/getTrace.js +122 -0
- package/src/utils/intersectionObserverPolyfill.js +470 -0
- package/src/utils/scroll.ts +94 -0
- package/src/utils/yupValidator.ts +205 -0
- package/src/ytIframeTracking/index.ts +210 -0
- package/test/index.test.tsx +63 -0
- package/tsconfig.json +26 -0
- package/tsconfig.test.json +6 -0
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.validateOrigamiEvent = exports.validateGTMCustomEvent = exports.validateConfig = exports.parseConfig = void 0;
|
|
4
|
+
var yup_1 = require("yup");
|
|
5
|
+
//transform passed values to first character uppercase and replace spaces with underscores
|
|
6
|
+
var unifyValuesTransform = function (value) {
|
|
7
|
+
return (value.trim().charAt(0).toUpperCase() +
|
|
8
|
+
value.trim().slice(1).toLowerCase().replace(/ /g, "_").replace(/-/g, "_"));
|
|
9
|
+
};
|
|
10
|
+
//replace legacy 'AlphaGrid'..
|
|
11
|
+
var authorTransform = function (value) {
|
|
12
|
+
if (value.toLowerCase() === "alphagrid") {
|
|
13
|
+
return "Alpha_Grid";
|
|
14
|
+
}
|
|
15
|
+
return (value.trim().charAt(0).toUpperCase() +
|
|
16
|
+
value.trim().slice(1).toLowerCase().replace(/ /g, "_").replace(/-/g, "_"));
|
|
17
|
+
};
|
|
18
|
+
var configSchema = (0, yup_1.object)({
|
|
19
|
+
product: (0, yup_1.string)().equals(["paid-post"]),
|
|
20
|
+
url: (0, yup_1.string)().required(),
|
|
21
|
+
feature: (0, yup_1.string)().required().oneOf(["channel", "microsite"]),
|
|
22
|
+
author: (0, yup_1.string)().defined().default("").transform(authorTransform),
|
|
23
|
+
sponsor: (0, yup_1.string)().defined().default(""),
|
|
24
|
+
articleName: (0, yup_1.string)().defined().default(""),
|
|
25
|
+
videoName: (0, yup_1.string)().defined().default(""),
|
|
26
|
+
videoType: (0, yup_1.string)()
|
|
27
|
+
.optional()
|
|
28
|
+
.default("")
|
|
29
|
+
.transform(unifyValuesTransform)
|
|
30
|
+
.oneOf(["Feature", "Case_study", "Interview", "Animation", ""]),
|
|
31
|
+
hasVideo: (0, yup_1.boolean)().optional().nullable(),
|
|
32
|
+
primaryTopic: (0, yup_1.string)().defined().default("").transform(unifyValuesTransform),
|
|
33
|
+
secondaryTopic: (0, yup_1.string)()
|
|
34
|
+
.defined()
|
|
35
|
+
.default("")
|
|
36
|
+
.transform(unifyValuesTransform),
|
|
37
|
+
advertiserIndustry: (0, yup_1.string)().defined().default(""),
|
|
38
|
+
app: (0, yup_1.string)()
|
|
39
|
+
.required()
|
|
40
|
+
.defined()
|
|
41
|
+
.transform(unifyValuesTransform)
|
|
42
|
+
.oneOf([
|
|
43
|
+
"Stream",
|
|
44
|
+
"Article",
|
|
45
|
+
"Animated_article",
|
|
46
|
+
"Immersive_article",
|
|
47
|
+
"Video",
|
|
48
|
+
"Article_with_video",
|
|
49
|
+
"Audio",
|
|
50
|
+
"Infographic",
|
|
51
|
+
"Interactive_infographic",
|
|
52
|
+
"Photo_essay",
|
|
53
|
+
]),
|
|
54
|
+
publishDate: (0, yup_1.string)().nullable().default(""),
|
|
55
|
+
isBranded: (0, yup_1.boolean)().defined(),
|
|
56
|
+
contentType: (0, yup_1.string)().defined().default("").transform(unifyValuesTransform),
|
|
57
|
+
campaign: (0, yup_1.string)().defined().default(""),
|
|
58
|
+
server: (0, yup_1.string)().equals(["https://spoor-api.ft.com/px.gif"]),
|
|
59
|
+
title: (0, yup_1.string)().defined().default(""),
|
|
60
|
+
adbook_campaign_id: (0, yup_1.string)().optional().default(""),
|
|
61
|
+
source_id: (0, yup_1.string)().optional(),
|
|
62
|
+
wordCount: (0, yup_1.number)().optional(),
|
|
63
|
+
commercial_product: (0, yup_1.string)().optional().default("ft"),
|
|
64
|
+
});
|
|
65
|
+
var gtmCustomEventSchema = (0, yup_1.object)({
|
|
66
|
+
category: (0, yup_1.string)()
|
|
67
|
+
.required()
|
|
68
|
+
.oneOf([
|
|
69
|
+
"Internal click",
|
|
70
|
+
"External click",
|
|
71
|
+
"Video",
|
|
72
|
+
"Video:fallback",
|
|
73
|
+
"Audio",
|
|
74
|
+
"Scroll",
|
|
75
|
+
"Share",
|
|
76
|
+
"Form",
|
|
77
|
+
"Header",
|
|
78
|
+
"Footer",
|
|
79
|
+
]),
|
|
80
|
+
action: (0, yup_1.string)().required(),
|
|
81
|
+
label: (0, yup_1.string)().required(),
|
|
82
|
+
});
|
|
83
|
+
var origamiEventSchema = (0, yup_1.object)({
|
|
84
|
+
category: (0, yup_1.string)()
|
|
85
|
+
.required()
|
|
86
|
+
.oneOf([
|
|
87
|
+
"page",
|
|
88
|
+
"video",
|
|
89
|
+
"audio",
|
|
90
|
+
"cta",
|
|
91
|
+
"scroll",
|
|
92
|
+
"brandedContent",
|
|
93
|
+
"internal click",
|
|
94
|
+
"external click",
|
|
95
|
+
"share",
|
|
96
|
+
"channel",
|
|
97
|
+
]),
|
|
98
|
+
action: (0, yup_1.string)().required(),
|
|
99
|
+
app: (0, yup_1.string)().nullable().notRequired(),
|
|
100
|
+
product: (0, yup_1.string)().nullable().notRequired(),
|
|
101
|
+
source: (0, yup_1.string)().nullable().notRequired(),
|
|
102
|
+
meta: (0, yup_1.mixed)().nullable().notRequired(),
|
|
103
|
+
duration: (0, yup_1.number)()
|
|
104
|
+
.nullable()
|
|
105
|
+
.notRequired()
|
|
106
|
+
.when("category", {
|
|
107
|
+
is: "video" || "audio",
|
|
108
|
+
then: function () { return (0, yup_1.number)().required(); },
|
|
109
|
+
}),
|
|
110
|
+
progress: (0, yup_1.number)()
|
|
111
|
+
.nullable()
|
|
112
|
+
.notRequired()
|
|
113
|
+
.when("category", {
|
|
114
|
+
is: "video" || "audio",
|
|
115
|
+
then: function () { return (0, yup_1.number)().required(); },
|
|
116
|
+
}),
|
|
117
|
+
});
|
|
118
|
+
var parseConfig = function (config) {
|
|
119
|
+
var _a;
|
|
120
|
+
try {
|
|
121
|
+
//Replace app value based on deprecated hasVideo field and then remove hasVideo
|
|
122
|
+
if (config.hasVideo && config.app.toLowerCase() === "article") {
|
|
123
|
+
config.app === "Article_with_video";
|
|
124
|
+
}
|
|
125
|
+
delete config.hasVideo;
|
|
126
|
+
//Parse wordCount as number if not already
|
|
127
|
+
if (config.wordCount) {
|
|
128
|
+
config.wordCount = Number(config.wordCount);
|
|
129
|
+
}
|
|
130
|
+
return configSchema.cast(config);
|
|
131
|
+
}
|
|
132
|
+
catch (err) {
|
|
133
|
+
(_a = err.errors) === null || _a === void 0 ? void 0 : _a.map(function (err) {
|
|
134
|
+
console.error("FTTracker - config cast error: " + err);
|
|
135
|
+
});
|
|
136
|
+
return config;
|
|
137
|
+
}
|
|
138
|
+
};
|
|
139
|
+
exports.parseConfig = parseConfig;
|
|
140
|
+
var validateConfig = function (config) {
|
|
141
|
+
var _a;
|
|
142
|
+
try {
|
|
143
|
+
configSchema.validateSync(config, {
|
|
144
|
+
strict: false,
|
|
145
|
+
abortEarly: false,
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
catch (err) {
|
|
149
|
+
(_a = err.errors) === null || _a === void 0 ? void 0 : _a.map(function (err) {
|
|
150
|
+
console.error("FTTracker - config validation error: " + err);
|
|
151
|
+
});
|
|
152
|
+
}
|
|
153
|
+
return undefined;
|
|
154
|
+
};
|
|
155
|
+
exports.validateConfig = validateConfig;
|
|
156
|
+
var validateGTMCustomEvent = function (event) {
|
|
157
|
+
var _a;
|
|
158
|
+
try {
|
|
159
|
+
gtmCustomEventSchema.validateSync(event, {
|
|
160
|
+
strict: true,
|
|
161
|
+
abortEarly: false,
|
|
162
|
+
});
|
|
163
|
+
}
|
|
164
|
+
catch (err) {
|
|
165
|
+
(_a = err.errors) === null || _a === void 0 ? void 0 : _a.map(function (err) {
|
|
166
|
+
console.error("FTTracker - GTM custom event validation error: " + err);
|
|
167
|
+
});
|
|
168
|
+
}
|
|
169
|
+
return undefined;
|
|
170
|
+
};
|
|
171
|
+
exports.validateGTMCustomEvent = validateGTMCustomEvent;
|
|
172
|
+
var validateOrigamiEvent = function (config) {
|
|
173
|
+
var _a;
|
|
174
|
+
try {
|
|
175
|
+
var parsedConfig = origamiEventSchema.cast(config);
|
|
176
|
+
origamiEventSchema.validateSync(parsedConfig, {
|
|
177
|
+
strict: true,
|
|
178
|
+
abortEarly: false,
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
catch (err) {
|
|
182
|
+
(_a = err.errors) === null || _a === void 0 ? void 0 : _a.map(function (err) {
|
|
183
|
+
console.error("FTTracker - Origami event validation error: " + err);
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
return undefined;
|
|
187
|
+
};
|
|
188
|
+
exports.validateOrigamiEvent = validateOrigamiEvent;
|
|
189
|
+
//# sourceMappingURL=yupValidator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"yupValidator.js","sourceRoot":"","sources":["../../src/utils/yupValidator.ts"],"names":[],"mappings":";;;AAAA,2BAQa;AAEb,0FAA0F;AAC1F,IAAM,oBAAoB,GAAG,UAAC,KAAa;IACzC,OAAO,CACL,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;QACpC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC;AAEF,8BAA8B;AAC9B,IAAM,eAAe,GAAG,UAAC,KAAa;IACpC,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW,EAAE;QACvC,OAAO,YAAY,CAAC;KACrB;IACD,OAAO,CACL,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;QACpC,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAC1E,CAAC;AACJ,CAAC,CAAC;AAEF,IAAM,YAAY,GAAG,IAAA,YAAM,EAAC;IAC1B,OAAO,EAAE,IAAA,YAAM,GAAE,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC;IACvC,GAAG,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE;IACxB,OAAO,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAC5D,MAAM,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC;IACjE,OAAO,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACvC,WAAW,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC3C,SAAS,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACzC,SAAS,EAAE,IAAA,YAAM,GAAE;SAChB,QAAQ,EAAE;SACV,OAAO,CAAC,EAAE,CAAC;SACX,SAAS,CAAC,oBAAoB,CAAC;SAC/B,KAAK,CAAC,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,CAAC,CAAC;IACjE,QAAQ,EAAE,IAAA,aAAO,GAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACzC,YAAY,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC;IAC5E,cAAc,EAAE,IAAA,YAAM,GAAE;SACrB,OAAO,EAAE;SACT,OAAO,CAAC,EAAE,CAAC;SACX,SAAS,CAAC,oBAAoB,CAAC;IAClC,kBAAkB,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAClD,GAAG,EAAE,IAAA,YAAM,GAAE;SACV,QAAQ,EAAE;SACV,OAAO,EAAE;SACT,SAAS,CAAC,oBAAoB,CAAC;SAC/B,KAAK,CAAC;QACL,QAAQ;QACR,SAAS;QACT,kBAAkB;QAClB,mBAAmB;QACnB,OAAO;QACP,oBAAoB;QACpB,OAAO;QACP,aAAa;QACb,yBAAyB;QACzB,aAAa;KACd,CAAC;IACJ,WAAW,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5C,SAAS,EAAE,IAAA,aAAO,GAAE,CAAC,OAAO,EAAE;IAC9B,WAAW,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC;IAC3E,QAAQ,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACxC,MAAM,EAAE,IAAA,YAAM,GAAE,CAAC,MAAM,CAAC,CAAC,iCAAiC,CAAC,CAAC;IAC5D,KAAK,EAAE,IAAA,YAAM,GAAE,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACrC,kBAAkB,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnD,SAAS,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE;IAC9B,SAAS,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE;IAC9B,kBAAkB,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;CACtD,CAAC,CAAC;AAEH,IAAM,oBAAoB,GAAG,IAAA,YAAM,EAAC;IAClC,QAAQ,EAAE,IAAA,YAAM,GAAE;SACf,QAAQ,EAAE;SACV,KAAK,CAAC;QACL,gBAAgB;QAChB,gBAAgB;QAChB,OAAO;QACP,gBAAgB;QAChB,OAAO;QACP,QAAQ;QACR,OAAO;QACP,MAAM;QACN,QAAQ;QACR,QAAQ;KACT,CAAC;IACJ,MAAM,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAEH,IAAM,kBAAkB,GAAG,IAAA,YAAM,EAAC;IAChC,QAAQ,EAAE,IAAA,YAAM,GAAE;SACf,QAAQ,EAAE;SACV,KAAK,CAAC;QACL,MAAM;QACN,OAAO;QACP,OAAO;QACP,KAAK;QACL,QAAQ;QACR,gBAAgB;QAChB,gBAAgB;QAChB,gBAAgB;QAChB,OAAO;QACP,SAAS;KACV,CAAC;IACJ,MAAM,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE;IAC3B,GAAG,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE;IACtC,OAAO,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE;IAC1C,MAAM,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE;IACzC,IAAI,EAAE,IAAA,WAAK,GAAE,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE;IACtC,QAAQ,EAAE,IAAA,YAAM,GAAE;SACf,QAAQ,EAAE;SACV,WAAW,EAAE;SACb,IAAI,CAAC,UAAU,EAAE;QAChB,EAAE,EAAE,OAAO,IAAI,OAAO;QACtB,IAAI,EAAE,cAAM,OAAA,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,EAAnB,CAAmB;KAChC,CAAC;IACJ,QAAQ,EAAE,IAAA,YAAM,GAAE;SACf,QAAQ,EAAE;SACV,WAAW,EAAE;SACb,IAAI,CAAC,UAAU,EAAE;QAChB,EAAE,EAAE,OAAO,IAAI,OAAO;QACtB,IAAI,EAAE,cAAM,OAAA,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,EAAnB,CAAmB;KAChC,CAAC;CACL,CAAC,CAAC;AAMI,IAAM,WAAW,GAAG,UAAC,MAAkB;;IAC5C,IAAI;QACF,+EAA+E;QAC/E,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,SAAS,EAAE;YAC7D,MAAM,CAAC,GAAG,KAAK,oBAAoB,CAAC;SACrC;QAED,OAAO,MAAM,CAAC,QAAQ,CAAC;QACvB,0CAA0C;QAC1C,IAAI,MAAM,CAAC,SAAS,EAAE;YACpB,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;SAC7C;QACD,OAAO,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAClC;IAAC,OAAO,GAAQ,EAAE;QACjB,MAAA,GAAG,CAAC,MAAM,0CAAE,GAAG,CAAC,UAAC,GAAU;YACzB,OAAO,CAAC,KAAK,CAAC,iCAAiC,GAAG,GAAG,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;KACf;AACH,CAAC,CAAC;AAnBW,QAAA,WAAW,eAmBtB;AAEK,IAAM,cAAc,GAAG,UAC5B,MAAkB;;IAElB,IAAI;QACF,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;KACJ;IAAC,OAAO,GAAQ,EAAE;QACjB,MAAA,GAAG,CAAC,MAAM,0CAAE,GAAG,CAAC,UAAC,GAAoB;YACnC,OAAO,CAAC,KAAK,CAAC,uCAAuC,GAAG,GAAG,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAdW,QAAA,cAAc,kBAczB;AAEK,IAAM,sBAAsB,GAAG,UACpC,KAAyB;;IAEzB,IAAI;QACF,oBAAoB,CAAC,YAAY,CAAC,KAAK,EAAE;YACvC,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;KACJ;IAAC,OAAO,GAAQ,EAAE;QACjB,MAAA,GAAG,CAAC,MAAM,0CAAE,GAAG,CAAC,UAAC,GAAoB;YACnC,OAAO,CAAC,KAAK,CAAC,iDAAiD,GAAG,GAAG,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAdW,QAAA,sBAAsB,0BAcjC;AAEK,IAAM,oBAAoB,GAAG,UAClC,MAAwB;;IAExB,IAAI;QACF,IAAM,YAAY,GAAG,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrD,kBAAkB,CAAC,YAAY,CAAC,YAAY,EAAE;YAC5C,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,KAAK;SAClB,CAAC,CAAC;KACJ;IAAC,OAAO,GAAQ,EAAE;QACjB,MAAA,GAAG,CAAC,MAAM,0CAAE,GAAG,CAAC,UAAC,GAAoB;YACnC,OAAO,CAAC,KAAK,CAAC,8CAA8C,GAAG,GAAG,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;KACJ;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAfW,QAAA,oBAAoB,wBAe/B"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/// <reference types="youtube" />
|
|
2
|
+
import { FTTracking } from "../FTTracking";
|
|
3
|
+
import { permutiveVideoUtils } from "../permutiveVideoUtils";
|
|
4
|
+
export declare class ytIframeTracking {
|
|
5
|
+
FTTracker: FTTracking;
|
|
6
|
+
progressMilestones: number[];
|
|
7
|
+
permutiveUtils: permutiveVideoUtils;
|
|
8
|
+
videoProgressInterval: number;
|
|
9
|
+
videoTitle: string;
|
|
10
|
+
videoUrl: string | undefined;
|
|
11
|
+
constructor(FTTracker: FTTracking, videoTitle?: string, videoUrl?: string);
|
|
12
|
+
progressPercentage: (duration: number, currentTime: number) => number;
|
|
13
|
+
emitProgressEvents: (progress: number, duration: number, isYoutube: boolean) => void;
|
|
14
|
+
oVideoEventHandler(videoEl: HTMLVideoElement): void;
|
|
15
|
+
ytIframeEventHandler(event: YT.PlayerEvent): void;
|
|
16
|
+
ytPlayTracking(player: YT.Player): void;
|
|
17
|
+
pausedTracking(currentTime: number, duration: number): void;
|
|
18
|
+
endedTracking(currentTime: number, duration: number): void;
|
|
19
|
+
/*** Below events only used for FT-Channels videoJS and Origami players - remove if no longer needed ***/
|
|
20
|
+
/*** videojs and origami player event only ***/
|
|
21
|
+
playTracking(currentTime: number, duration: number): void;
|
|
22
|
+
/*** videojs and origami player event only ***/
|
|
23
|
+
progressTracking(currentTime: number, duration: number): void;
|
|
24
|
+
/*** videojs and origami player event only ***/
|
|
25
|
+
seekedTracking(currentTime: number, duration: number): void;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ytIframeTracking/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAG7D,qBAAa,gBAAgB;IAC3B,SAAS,EAAE,UAAU,CAAC;IACtB,kBAAkB,WAAmB;IACrC,cAAc,EAAE,mBAAmB,CAAC;IACpC,qBAAqB,SAAK;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;gBAEjB,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAWzE,kBAAkB,aAAc,MAAM,eAAe,MAAM,YACH;IAExD,kBAAkB,aACN,MAAM,YACN,MAAM,aACL,OAAO,UAkBlB;IAGK,kBAAkB,CAAC,OAAO,EAAE,gBAAgB;IAoB5C,oBAAoB,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW;IA4BjD,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM;IA8BhC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAepD,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAuBnD,yGAAyG;IAEzG,gDAAgD;IAChD,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAiBlD,gDAAgD;IAChD,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAWtD,gDAAgD;IAChD,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAUrD"}
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ytIframeTracking = void 0;
|
|
4
|
+
var permutiveVideoUtils_1 = require("../permutiveVideoUtils");
|
|
5
|
+
var ytIframeTracking = /** @class */ (function () {
|
|
6
|
+
function ytIframeTracking(FTTracker, videoTitle, videoUrl) {
|
|
7
|
+
var _this = this;
|
|
8
|
+
this.progressMilestones = [1, 25, 50, 75];
|
|
9
|
+
this.videoProgressInterval = 0;
|
|
10
|
+
this.progressPercentage = function (duration, currentTime) {
|
|
11
|
+
return parseInt(((currentTime / duration) * 100).toFixed(2));
|
|
12
|
+
};
|
|
13
|
+
this.emitProgressEvents = function (progress, duration, isYoutube) {
|
|
14
|
+
while (progress >= _this.progressMilestones[0]) {
|
|
15
|
+
_this.FTTracker.gaEvent("Video".concat(window.isOvideoPlayer ? ":fallback" : ""), "".concat(_this.progressMilestones[0], "% watched"), _this.videoTitle);
|
|
16
|
+
if (isYoutube) {
|
|
17
|
+
_this.FTTracker.oEvent({
|
|
18
|
+
category: "video",
|
|
19
|
+
action: "progress",
|
|
20
|
+
duration: duration,
|
|
21
|
+
progress: progress,
|
|
22
|
+
});
|
|
23
|
+
}
|
|
24
|
+
_this.progressMilestones.shift();
|
|
25
|
+
}
|
|
26
|
+
};
|
|
27
|
+
this.FTTracker = FTTracker;
|
|
28
|
+
this.videoTitle =
|
|
29
|
+
videoTitle || window.gtmCategory || window.location.pathname; //reverted fix for channels - use window.gtmCategory to maintain the original label style
|
|
30
|
+
this.videoUrl = videoUrl;
|
|
31
|
+
this.permutiveUtils = new permutiveVideoUtils_1.permutiveVideoUtils(this.FTTracker.config.campaign, this.videoTitle);
|
|
32
|
+
}
|
|
33
|
+
//Fallback oVideo implemented only on channels - uses shared events so added here for now.
|
|
34
|
+
ytIframeTracking.prototype.oVideoEventHandler = function (videoEl) {
|
|
35
|
+
var _this = this;
|
|
36
|
+
window.isOvideoPlayer = true;
|
|
37
|
+
this.permutiveUtils.videoId = videoEl.getAttribute("src");
|
|
38
|
+
videoEl.addEventListener("play", function () {
|
|
39
|
+
_this.playTracking(videoEl.currentTime, videoEl.duration);
|
|
40
|
+
});
|
|
41
|
+
videoEl.addEventListener("progress", function () {
|
|
42
|
+
_this.progressTracking(videoEl.currentTime, videoEl.duration);
|
|
43
|
+
});
|
|
44
|
+
videoEl.addEventListener("seeked", function () {
|
|
45
|
+
_this.seekedTracking(videoEl.currentTime, videoEl.duration);
|
|
46
|
+
});
|
|
47
|
+
videoEl.addEventListener("pause", function () {
|
|
48
|
+
_this.pausedTracking(videoEl.currentTime, videoEl.duration);
|
|
49
|
+
});
|
|
50
|
+
videoEl.addEventListener("ended", function () {
|
|
51
|
+
_this.endedTracking(videoEl.currentTime, videoEl.duration);
|
|
52
|
+
});
|
|
53
|
+
};
|
|
54
|
+
ytIframeTracking.prototype.ytIframeEventHandler = function (event) {
|
|
55
|
+
var _this = this;
|
|
56
|
+
var player = event.target;
|
|
57
|
+
if (!this.videoUrl) {
|
|
58
|
+
this.videoUrl = player.getVideoUrl();
|
|
59
|
+
}
|
|
60
|
+
this.permutiveUtils.videoId = this.videoUrl;
|
|
61
|
+
//player.playerInfo.videoUrl
|
|
62
|
+
switch (player.getPlayerState()) {
|
|
63
|
+
case YT.PlayerState.ENDED:
|
|
64
|
+
this.endedTracking(player.getCurrentTime(), player.getDuration());
|
|
65
|
+
break;
|
|
66
|
+
case YT.PlayerState.PLAYING:
|
|
67
|
+
this.ytPlayTracking(player);
|
|
68
|
+
break;
|
|
69
|
+
case YT.PlayerState.PAUSED:
|
|
70
|
+
//test if still pause after 1 second, otherwise its a seek
|
|
71
|
+
setTimeout(function () {
|
|
72
|
+
if (player.getPlayerState() == YT.PlayerState.PAUSED) {
|
|
73
|
+
_this.pausedTracking(player.getCurrentTime(), player.getDuration());
|
|
74
|
+
}
|
|
75
|
+
}, 1000);
|
|
76
|
+
break;
|
|
77
|
+
}
|
|
78
|
+
};
|
|
79
|
+
ytIframeTracking.prototype.ytPlayTracking = function (player) {
|
|
80
|
+
var _this = this;
|
|
81
|
+
this.videoProgressInterval = window.setInterval(function () {
|
|
82
|
+
var currentTime = player.getCurrentTime();
|
|
83
|
+
var duration = player.getDuration();
|
|
84
|
+
_this.permutiveUtils.emitPermutiveProgressEvent(duration - 1, currentTime, _this.videoProgressInterval);
|
|
85
|
+
var progress = _this.progressPercentage(duration, currentTime);
|
|
86
|
+
_this.emitProgressEvents(progress, duration, true);
|
|
87
|
+
}, 1000);
|
|
88
|
+
var currentTime = player.getCurrentTime();
|
|
89
|
+
var duration = player.getDuration();
|
|
90
|
+
var progress = this.progressPercentage(duration, currentTime);
|
|
91
|
+
if (progress < 100) {
|
|
92
|
+
this.FTTracker.gaEvent("Video".concat(window.isOvideoPlayer ? ":fallback" : ""), "playing", this.videoTitle);
|
|
93
|
+
this.FTTracker.oEvent({
|
|
94
|
+
category: "video",
|
|
95
|
+
action: "playing",
|
|
96
|
+
duration: duration,
|
|
97
|
+
progress: progress,
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
};
|
|
101
|
+
ytIframeTracking.prototype.pausedTracking = function (currentTime, duration) {
|
|
102
|
+
var progress = this.progressPercentage(duration, currentTime);
|
|
103
|
+
this.FTTracker.gaEvent("Video".concat(window.isOvideoPlayer ? ":fallback" : ""), "pause", "".concat(this.videoTitle));
|
|
104
|
+
this.FTTracker.oEvent({
|
|
105
|
+
category: "video",
|
|
106
|
+
action: "pause",
|
|
107
|
+
duration: duration,
|
|
108
|
+
progress: progress,
|
|
109
|
+
});
|
|
110
|
+
};
|
|
111
|
+
ytIframeTracking.prototype.endedTracking = function (currentTime, duration) {
|
|
112
|
+
var progress = this.progressPercentage(duration, currentTime);
|
|
113
|
+
this.FTTracker.gaEvent("Video".concat(window.isOvideoPlayer ? ":fallback" : ""), "100% watched", "".concat(this.videoTitle));
|
|
114
|
+
this.FTTracker.oEvent({
|
|
115
|
+
category: "video",
|
|
116
|
+
action: "ended",
|
|
117
|
+
duration: duration,
|
|
118
|
+
progress: progress,
|
|
119
|
+
});
|
|
120
|
+
//force a 100% event on end
|
|
121
|
+
if (this.permutiveUtils.remainingProgress.length > 0) {
|
|
122
|
+
this.permutiveUtils.emitPermutiveProgressEvent(currentTime, currentTime, this.videoProgressInterval);
|
|
123
|
+
}
|
|
124
|
+
};
|
|
125
|
+
/*** Below events only used for FT-Channels videoJS and Origami players - remove if no longer needed ***/
|
|
126
|
+
/*** videojs and origami player event only ***/
|
|
127
|
+
ytIframeTracking.prototype.playTracking = function (currentTime, duration) {
|
|
128
|
+
var _this = this;
|
|
129
|
+
this.videoProgressInterval = window.setInterval(function () {
|
|
130
|
+
_this.permutiveUtils.emitPermutiveProgressEvent(duration - 1, currentTime, _this.videoProgressInterval);
|
|
131
|
+
}, 1000);
|
|
132
|
+
var progress = this.progressPercentage(duration, currentTime);
|
|
133
|
+
this.FTTracker.oEvent({
|
|
134
|
+
category: "video",
|
|
135
|
+
action: "playing",
|
|
136
|
+
duration: duration,
|
|
137
|
+
progress: progress,
|
|
138
|
+
});
|
|
139
|
+
};
|
|
140
|
+
/*** videojs and origami player event only ***/
|
|
141
|
+
ytIframeTracking.prototype.progressTracking = function (currentTime, duration) {
|
|
142
|
+
var progress = this.progressPercentage(duration, currentTime);
|
|
143
|
+
this.emitProgressEvents(progress, duration, false);
|
|
144
|
+
this.FTTracker.oEvent({
|
|
145
|
+
category: "video",
|
|
146
|
+
action: "progress",
|
|
147
|
+
duration: duration,
|
|
148
|
+
progress: progress,
|
|
149
|
+
});
|
|
150
|
+
};
|
|
151
|
+
/*** videojs and origami player event only ***/
|
|
152
|
+
ytIframeTracking.prototype.seekedTracking = function (currentTime, duration) {
|
|
153
|
+
var progress = this.progressPercentage(duration, currentTime);
|
|
154
|
+
this.emitProgressEvents(progress, duration, false);
|
|
155
|
+
this.FTTracker.oEvent({
|
|
156
|
+
category: "video",
|
|
157
|
+
action: "seek",
|
|
158
|
+
duration: duration,
|
|
159
|
+
progress: progress,
|
|
160
|
+
});
|
|
161
|
+
};
|
|
162
|
+
return ytIframeTracking;
|
|
163
|
+
}());
|
|
164
|
+
exports.ytIframeTracking = ytIframeTracking;
|
|
165
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/ytIframeTracking/index.ts"],"names":[],"mappings":";;;AACA,8DAA6D;AAG7D;IAQE,0BAAY,SAAqB,EAAE,UAAmB,EAAE,QAAiB;QAAzE,iBASC;QAfD,uBAAkB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAErC,0BAAqB,GAAG,CAAC,CAAC;QAe1B,uBAAkB,GAAG,UAAC,QAAgB,EAAE,WAAmB;YACzD,OAAA,QAAQ,CAAC,CAAC,CAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAArD,CAAqD,CAAC;QAExD,uBAAkB,GAAG,UACnB,QAAgB,EAChB,QAAgB,EAChB,SAAkB;YAElB,OAAO,QAAQ,IAAI,KAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE;gBAC7C,KAAI,CAAC,SAAS,CAAC,OAAO,CACpB,eAAQ,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAE,EAClD,UAAG,KAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,cAAW,EACxC,KAAI,CAAC,UAAU,CAChB,CAAC;gBACF,IAAI,SAAS,EAAE;oBACb,KAAI,CAAC,SAAS,CAAC,MAAM,CAAC;wBACpB,QAAQ,EAAE,OAAO;wBACjB,MAAM,EAAE,UAAU;wBAClB,QAAQ,EAAE,QAAQ;wBAClB,QAAQ,UAAA;qBACW,CAAC,CAAC;iBACxB;gBACD,KAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;aACjC;QACH,CAAC,CAAC;QAlCA,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU;YACb,UAAU,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,yFAAyF;QACzJ,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,yCAAmB,CAC3C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAC9B,IAAI,CAAC,UAAU,CAChB,CAAC;IACJ,CAAC;IA4BD,0FAA0F;IACnF,6CAAkB,GAAzB,UAA0B,OAAyB;QAAnD,iBAkBC;QAjBC,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,KAAK,CAAW,CAAC;QACpE,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC/B,KAAI,CAAC,YAAY,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE;YACnC,KAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,gBAAgB,CAAC,QAAQ,EAAE;YACjC,KAAI,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE;YAChC,KAAI,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,gBAAgB,CAAC,OAAO,EAAE;YAChC,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,+CAAoB,GAA3B,UAA4B,KAAqB;QAAjD,iBA0BC;QAzBC,IAAM,MAAM,GAAG,KAAK,CAAC,MAAmB,CAAC;QAEzC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;SACtC;QACD,IAAI,CAAC,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC5C,4BAA4B;QAE5B,QAAQ,MAAM,CAAC,cAAc,EAAE,EAAE;YAC/B,KAAK,EAAE,CAAC,WAAW,CAAC,KAAK;gBACvB,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;gBAClE,MAAM;YACR,KAAK,EAAE,CAAC,WAAW,CAAC,OAAO;gBACzB,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;gBAC5B,MAAM;YACR,KAAK,EAAE,CAAC,WAAW,CAAC,MAAM;gBACxB,0DAA0D;gBAC1D,UAAU,CAAC;oBACT,IAAI,MAAM,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE;wBACpD,KAAI,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;qBACpE;gBACH,CAAC,EAAE,IAAI,CAAC,CAAC;gBAET,MAAM;SACT;IACH,CAAC;IAED,yCAAc,GAAd,UAAe,MAAiB;QAAhC,iBA4BC;QA3BC,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,WAAW,CAAC;YAC9C,IAAM,WAAW,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;YAC5C,IAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;YACtC,KAAI,CAAC,cAAc,CAAC,0BAA0B,CAC5C,QAAQ,GAAG,CAAC,EACZ,WAAW,EACX,KAAI,CAAC,qBAAqB,CAC3B,CAAC;YACF,IAAM,QAAQ,GAAG,KAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YAChE,KAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC,EAAE,IAAI,CAAC,CAAC;QACT,IAAM,WAAW,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;QAC5C,IAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QACtC,IAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChE,IAAI,QAAQ,GAAG,GAAG,EAAE;YAClB,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,eAAQ,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAE,EAClD,SAAS,EACT,IAAI,CAAC,UAAU,CAChB,CAAC;YACF,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;gBACpB,QAAQ,EAAE,OAAO;gBACjB,MAAM,EAAE,SAAS;gBACjB,QAAQ,EAAE,QAAQ;gBAClB,QAAQ,UAAA;aACW,CAAC,CAAC;SACxB;IACH,CAAC;IAED,yCAAc,GAAd,UAAe,WAAmB,EAAE,QAAgB;QAClD,IAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,eAAQ,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAE,EAClD,OAAO,EACP,UAAG,IAAI,CAAC,UAAU,CAAE,CACrB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACpB,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,QAAQ;YAClB,QAAQ,UAAA;SACW,CAAC,CAAC;IACzB,CAAC;IAED,wCAAa,GAAb,UAAc,WAAmB,EAAE,QAAgB;QACjD,IAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS,CAAC,OAAO,CACpB,eAAQ,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAE,EAClD,cAAc,EACd,UAAG,IAAI,CAAC,UAAU,CAAE,CACrB,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACpB,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,OAAO;YACf,QAAQ,EAAE,QAAQ;YAClB,QAAQ,UAAA;SACW,CAAC,CAAC;QACvB,2BAA2B;QAC3B,IAAI,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YACpD,IAAI,CAAC,cAAc,CAAC,0BAA0B,CAC5C,WAAW,EACX,WAAW,EACX,IAAI,CAAC,qBAAqB,CAC3B,CAAC;SACH;IACH,CAAC;IAED,yGAAyG;IAEzG,gDAAgD;IAChD,uCAAY,GAAZ,UAAa,WAAmB,EAAE,QAAgB;QAAlD,iBAeC;QAdC,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC,WAAW,CAAC;YAC9C,KAAI,CAAC,cAAc,CAAC,0BAA0B,CAC5C,QAAQ,GAAG,CAAC,EACZ,WAAW,EACX,KAAI,CAAC,qBAAqB,CAC3B,CAAC;QACJ,CAAC,EAAE,IAAI,CAAC,CAAC;QACT,IAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACpB,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,QAAQ;YAClB,QAAQ,UAAA;SACW,CAAC,CAAC;IACzB,CAAC;IAED,gDAAgD;IAChD,2CAAgB,GAAhB,UAAiB,WAAmB,EAAE,QAAgB;QACpD,IAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACpB,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,UAAU;YAClB,QAAQ,EAAE,QAAQ;YAClB,QAAQ,UAAA;SACW,CAAC,CAAC;IACzB,CAAC;IAED,gDAAgD;IAChD,yCAAc,GAAd,UAAe,WAAmB,EAAE,QAAgB;QAClD,IAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;YACpB,QAAQ,EAAE,OAAO;YACjB,MAAM,EAAE,MAAM;YACd,QAAQ,EAAE,QAAQ;YAClB,QAAQ,UAAA;SACW,CAAC,CAAC;IACzB,CAAC;IACH,uBAAC;AAAD,CAAC,AA7MD,IA6MC;AA7MY,4CAAgB"}
|
package/package.json
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@phantomstudios/ft-lib",
|
|
3
|
+
"description": "A collection of Javascript UI & tracking utils for FT sites",
|
|
4
|
+
"version": "0.2.0",
|
|
5
|
+
"main": "lib/index.js",
|
|
6
|
+
"types": "lib/index.d.ts",
|
|
7
|
+
"homepage": "https://github.com/phantomstudios/ft-lib#readme",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "https://github.com/phantomstudios/ft-lib.git"
|
|
11
|
+
},
|
|
12
|
+
"bugs": {
|
|
13
|
+
"url": "https://github.com/phantomstudios/ft-lib/issues"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"FT",
|
|
17
|
+
"tracking",
|
|
18
|
+
"Permutive"
|
|
19
|
+
],
|
|
20
|
+
"scripts": {
|
|
21
|
+
"build": "tsc",
|
|
22
|
+
"build:types": "tsc --emitDeclarationOnly",
|
|
23
|
+
"prepublishOnly": "npm run build",
|
|
24
|
+
"test": "jest --verbose",
|
|
25
|
+
"test:watch": "jest --verbose --watch",
|
|
26
|
+
"coverage": "jest --coverage",
|
|
27
|
+
"lint": "NODE_ENV=test npm-run-all --parallel lint:*",
|
|
28
|
+
"lint:js": "eslint \"src/**/*.{js,jsx,ts,tsx}\"",
|
|
29
|
+
"lint:format": "prettier \"**/*.{md,html,yaml,yml}\" --check",
|
|
30
|
+
"lint:type-check": "tsc --noEmit",
|
|
31
|
+
"fix": "npm-run-all --sequential fix:*",
|
|
32
|
+
"fix:js": "eslint \"src/**/*.{js,jsx,ts,tsx}\" --fix",
|
|
33
|
+
"fix:format": "prettier \"**/*.{md,html,yaml,yml}\" --write",
|
|
34
|
+
"depcheck": "npx npm-check --update"
|
|
35
|
+
},
|
|
36
|
+
"author": "Dhia Shakiry (dhia@phntms.com)",
|
|
37
|
+
"license": "MIT",
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@babel/preset-env": "^7.14.2",
|
|
40
|
+
"@babel/preset-typescript": "^7.13.0",
|
|
41
|
+
"@types/debug": "^4.1.7",
|
|
42
|
+
"@types/jest": "^26.0.23",
|
|
43
|
+
"@types/react": "^17.0.6",
|
|
44
|
+
"@types/youtube": "^0.0.46",
|
|
45
|
+
"@types/yup": "^0.32.0",
|
|
46
|
+
"@typescript-eslint/eslint-plugin": "^4.24.0",
|
|
47
|
+
"@typescript-eslint/parser": "^4.24.0",
|
|
48
|
+
"babel-eslint": "^10.1.0",
|
|
49
|
+
"babel-jest": "^26.0.1",
|
|
50
|
+
"browser-env": "^3.2.6",
|
|
51
|
+
"debug": "^4.3.2",
|
|
52
|
+
"eslint": "^7.26.0",
|
|
53
|
+
"eslint-config-prettier": "^8.3.0",
|
|
54
|
+
"eslint-plugin-import": "^2.23.3",
|
|
55
|
+
"eslint-plugin-prettier": "^3.4.0",
|
|
56
|
+
"eslint-plugin-react": "^7.23.2",
|
|
57
|
+
"eslint-plugin-react-hooks": "^4.2.0",
|
|
58
|
+
"jest": "^26.0.1",
|
|
59
|
+
"npm-run-all": "^4.1.5",
|
|
60
|
+
"prettier": "^2.3.0",
|
|
61
|
+
"react": "^17.0.2",
|
|
62
|
+
"react-dom": "^17.0.2",
|
|
63
|
+
"react-test-renderer": "^17.0.2",
|
|
64
|
+
"set-value": ">=4.0.1",
|
|
65
|
+
"ts-jest": "^26.5.6",
|
|
66
|
+
"typescript": "^4.2.4"
|
|
67
|
+
},
|
|
68
|
+
"dependencies": {
|
|
69
|
+
"yup": "^1.0.2"
|
|
70
|
+
},
|
|
71
|
+
"peerDependencies": {
|
|
72
|
+
"@financial-times/o-tracking": "^3.1.4",
|
|
73
|
+
"@financial-times/o-viewport": "^4.0.5"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
import { consentMonitor } from "../consentMonitor";
|
|
2
|
+
import { gaTracker } from "../gaTracker";
|
|
3
|
+
import { oTracker } from "../oTracker";
|
|
4
|
+
import { ScrollTracker } from "../utils/scroll";
|
|
5
|
+
import {
|
|
6
|
+
validateConfig,
|
|
7
|
+
ConfigType,
|
|
8
|
+
OrigamiEventType,
|
|
9
|
+
} from "../utils/yupValidator";
|
|
10
|
+
|
|
11
|
+
export interface TrackingOptions {
|
|
12
|
+
scrollTrackerSelector?: string;
|
|
13
|
+
isCustomGTMEvent?: boolean;
|
|
14
|
+
sendGTMPageViewYN?: boolean;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
const DEFAULT_OPTIONS = {
|
|
18
|
+
scrollTrackerSelector: "#o_tracker_scroll",
|
|
19
|
+
isCustomGTMEvent: true,
|
|
20
|
+
sendGTMPageViewYN: true,
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export class FTTracking {
|
|
24
|
+
private _config: ConfigType;
|
|
25
|
+
options: TrackingOptions;
|
|
26
|
+
oTracker: oTracker;
|
|
27
|
+
gaTracker: gaTracker;
|
|
28
|
+
scrollTracker: ScrollTracker;
|
|
29
|
+
oEvent: (detail: OrigamiEventType) => void;
|
|
30
|
+
gaEvent: (category: string, action: string, label: string) => void;
|
|
31
|
+
gtmEvent: (category: string, action: string, label: string) => void;
|
|
32
|
+
|
|
33
|
+
constructor(config: ConfigType, options?: TrackingOptions) {
|
|
34
|
+
this.options = { ...DEFAULT_OPTIONS, ...options };
|
|
35
|
+
this.oTracker = new oTracker(config, this.options);
|
|
36
|
+
this.gaTracker = new gaTracker(this.options);
|
|
37
|
+
|
|
38
|
+
this.oEvent = this.oTracker.eventDispatcher;
|
|
39
|
+
this.gaEvent = this.options.isCustomGTMEvent
|
|
40
|
+
? this.gaTracker.GTMEventDispatcher
|
|
41
|
+
: this.gaTracker.GtagEventDispatcher;
|
|
42
|
+
this._config = config;
|
|
43
|
+
|
|
44
|
+
//backwards compatibility
|
|
45
|
+
this.gtmEvent = this.gaEvent;
|
|
46
|
+
|
|
47
|
+
this.scrollTracker = new ScrollTracker(this);
|
|
48
|
+
|
|
49
|
+
//cookie consent monitor for permutive tracking
|
|
50
|
+
window.addEventListener("load", () => {
|
|
51
|
+
new consentMonitor(window.location.hostname, [".app", "preview"]);
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
set config(c: ConfigType) {
|
|
55
|
+
this._config = c;
|
|
56
|
+
this.oTracker.config = c;
|
|
57
|
+
}
|
|
58
|
+
get config() {
|
|
59
|
+
return this._config;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
public newPageView(config: ConfigType) {
|
|
63
|
+
//Update passed config to otracker,send pageview events and reset scrollTracker
|
|
64
|
+
validateConfig(config);
|
|
65
|
+
this.oTracker.config = config;
|
|
66
|
+
this.oTracker.broadcastPageView();
|
|
67
|
+
this.oTracker.broadcastBrandedContent();
|
|
68
|
+
this.scrollTracker.reset();
|
|
69
|
+
if (this.options.sendGTMPageViewYN) {
|
|
70
|
+
this.gaTracker.GTMVirtualPageView(this.config.url, this.config.title);
|
|
71
|
+
}
|
|
72
|
+
//ga pageview event required for sites without GTM?
|
|
73
|
+
}
|
|
74
|
+
}
|