@phantomstudios/ft-lib 0.3.0-rc4 → 0.3.0-rc6
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/lib/FTTracking/index.d.ts +2 -0
- package/lib/FTTracking/index.d.ts.map +1 -1
- package/lib/FTTracking/index.js +3 -1
- package/lib/FTTracking/index.js.map +1 -1
- package/lib/oTracker/index.js +1 -1
- package/lib/oTracker/index.js.map +1 -1
- package/lib/utils/yupValidator.d.ts +1 -1
- package/lib/utils/yupValidator.d.ts.map +1 -1
- package/lib/utils/yupValidator.js +11 -4
- package/lib/utils/yupValidator.js.map +1 -1
- package/package.json +1 -1
- package/src/FTTracking/index.ts +5 -1
- package/src/oTracker/index.ts +1 -1
- package/src/utils/yupValidator.ts +11 -4
|
@@ -6,6 +6,7 @@ export interface TrackingOptions {
|
|
|
6
6
|
scrollTrackerSelector?: string;
|
|
7
7
|
isCustomGTMEvent?: boolean;
|
|
8
8
|
sendGTMPageViewYN?: boolean;
|
|
9
|
+
disableAppFormatTransform?: boolean;
|
|
9
10
|
}
|
|
10
11
|
export declare class FTTracking {
|
|
11
12
|
private _config;
|
|
@@ -13,6 +14,7 @@ export declare class FTTracking {
|
|
|
13
14
|
oTracker: oTracker;
|
|
14
15
|
gaTracker: gaTracker;
|
|
15
16
|
scrollTracker: ScrollTracker;
|
|
17
|
+
disableAppFormatTransform: boolean;
|
|
16
18
|
oEvent: (detail: OrigamiEventType) => void;
|
|
17
19
|
gaEvent: (category: string, action: string, label: string) => void;
|
|
18
20
|
gtmEvent: (category: string, action: string, label: string) => void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FTTracking/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,eAAe;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FTTracking/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAEL,UAAU,EACV,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAE/B,MAAM,WAAW,eAAe;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC;AAQD,qBAAa,UAAU;IACrB,OAAO,CAAC,OAAO,CAAa;IAC5B,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,SAAS,CAAC;IACrB,aAAa,EAAE,aAAa,CAAC;IAC7B,yBAAyB,EAAE,OAAO,CAAC;IACnC,MAAM,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAC3C,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACnE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;gBAExD,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,eAAe;IAuBzD,IAAI,MAAM,CAAC,CAAC,EAAE,UAAU,EAGvB;IACD,IAAI,MAAM,IAJI,UAAU,CAMvB;IAEM,WAAW,CAAC,MAAM,EAAE,UAAU;CAYtC"}
|
package/lib/FTTracking/index.js
CHANGED
|
@@ -27,6 +27,8 @@ var FTTracking = /** @class */ (function () {
|
|
|
27
27
|
this.options = __assign(__assign({}, DEFAULT_OPTIONS), options);
|
|
28
28
|
this.oTracker = new oTracker_1.oTracker(config, this.options);
|
|
29
29
|
this.gaTracker = new gaTracker_1.gaTracker(this.options);
|
|
30
|
+
this.disableAppFormatTransform =
|
|
31
|
+
this.options.disableAppFormatTransform || false;
|
|
30
32
|
this.oEvent = this.oTracker.eventDispatcher;
|
|
31
33
|
this.gaEvent = this.options.isCustomGTMEvent
|
|
32
34
|
? this.gaTracker.GTMEventDispatcher
|
|
@@ -53,7 +55,7 @@ var FTTracking = /** @class */ (function () {
|
|
|
53
55
|
});
|
|
54
56
|
FTTracking.prototype.newPageView = function (config) {
|
|
55
57
|
//Update passed config to otracker,send pageview events and reset scrollTracker
|
|
56
|
-
(0, yupValidator_1.validateConfig)(config);
|
|
58
|
+
(0, yupValidator_1.validateConfig)(config, this.disableAppFormatTransform);
|
|
57
59
|
this.oTracker.config = config;
|
|
58
60
|
this.oTracker.broadcastPageView();
|
|
59
61
|
this.oTracker.broadcastBrandedContent();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/FTTracking/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAAmD;AACnD,0CAAyC;AACzC,wCAAuC;AACvC,0CAAgD;AAChD,sDAI+B;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/FTTracking/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAAmD;AACnD,0CAAyC;AACzC,wCAAuC;AACvC,0CAAgD;AAChD,sDAI+B;AAS/B,IAAM,eAAe,GAAG;IACtB,qBAAqB,EAAE,mBAAmB;IAC1C,gBAAgB,EAAE,IAAI;IACtB,iBAAiB,EAAE,IAAI;CACxB,CAAC;AAEF;IAWE,oBAAY,MAAkB,EAAE,OAAyB;QACvD,IAAI,CAAC,OAAO,yBAAQ,eAAe,GAAK,OAAO,CAAE,CAAC;QAClD,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,CAAC,yBAAyB;YAC5B,IAAI,CAAC,OAAO,CAAC,yBAAyB,IAAI,KAAK,CAAC;QAElD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB;YAC1C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB;YACnC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,mBAAmB,CAAC;QACvC,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QAEtB,yBAAyB;QACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;QAE7B,IAAI,CAAC,aAAa,GAAG,IAAI,sBAAa,CAAC,IAAI,CAAC,CAAC;QAE7C,+CAA+C;QAC/C,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE;YAC9B,IAAI,+BAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC;IACD,sBAAI,8BAAM;aAIV;YACE,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;aAND,UAAW,CAAa;YACtB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;YACjB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,CAAC;;;OAAA;IAKM,gCAAW,GAAlB,UAAmB,MAAkB;QACnC,+EAA+E;QAC/E,IAAA,6BAAc,EAAC,MAAM,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QAC9B,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EAAE,CAAC;QACxC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE;YAClC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SACvE;QACD,mDAAmD;IACrD,CAAC;IACH,iBAAC;AAAD,CAAC,AAtDD,IAsDC;AAtDY,gCAAU"}
|
package/lib/oTracker/index.js
CHANGED
|
@@ -25,7 +25,7 @@ The config object is read from the server-rendered o-tracking-data element
|
|
|
25
25
|
var oTracker = /** @class */ (function () {
|
|
26
26
|
function oTracker(config, options) {
|
|
27
27
|
this._config = (0, yupValidator_1.parseConfig)(config);
|
|
28
|
-
(0, yupValidator_1.validateConfig)(this._config);
|
|
28
|
+
(0, yupValidator_1.validateConfig)(this._config, options.disableAppFormatTransform || false);
|
|
29
29
|
this._config.source_id = o_tracking_1.default.getRootID();
|
|
30
30
|
this.options = options;
|
|
31
31
|
//init config data
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/oTracker/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAAoD;AAGpD,4CAAsD;AACtD,+DAAyC;AACzC,sDAM+B;AAE/B;;EAEE;AACF;IAIE,kBAAY,MAAkB,EAAE,OAAwB;QACtD,IAAI,CAAC,OAAO,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;QACnC,IAAA,6BAAc,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/oTracker/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAAoD;AAGpD,4CAAsD;AACtD,+DAAyC;AACzC,sDAM+B;AAE/B;;EAEE;AACF;IAIE,kBAAY,MAAkB,EAAE,OAAwB;QACtD,IAAI,CAAC,OAAO,GAAG,IAAA,0BAAW,EAAC,MAAM,CAAC,CAAC;QACnC,IAAA,6BAAc,EAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,yBAAyB,IAAI,KAAK,CAAC,CAAC;QACzE,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,oBAAS,CAAC,SAAS,EAAE,CAAC;QAC/C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,kBAAkB;QAClB,IAAM,UAAU,GAAG;YACjB,MAAM,EAAE,iCAAiC;YACzC,OAAO,eACF,IAAI,CAAC,OAAO,CAChB;YACD,IAAI,EAAE;gBACJ,UAAU,EAAE,IAAA,4BAAkB,EAAC,mBAAmB,CAAC;aACpD;SACF,CAAC;QACF,oBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE3B,iBAAiB;QACjB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAExB,8BAA8B;QAC9B,kLAAkL;QAClL,gBAAgB;QAChB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAED,sBAAI,4BAAM;aAGV;YACE,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;aALD,UAAW,CAAa;YACtB,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;QACnB,CAAC;;;OAAA;IAKM,kCAAe,GAAtB,UAAuB,MAAwB;QAC7C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE;YAClE,IAAA,mCAAoB,EAAC,MAAM,CAAC,CAAC;YAC7B,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;YAC7B,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YACrC,QAAQ,CAAC,IAAI,CAAC,aAAa,CACzB,IAAI,WAAW,CAAC,iBAAiB,EAAE,EAAE,MAAM,QAAA,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAC9D,CAAC;SACH;aAAM;YACL,MAAM,oBAAoB,CAAC;SAC5B;IACH,CAAC;IAEM,oCAAiB,GAAxB;QACE,oBAAS,CAAC,IAAI,CAAC;YACb,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG;YACpB,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;YAC5B,KAAK,EAAE,QAAQ,CAAC,KAAK;SACtB,CAAC,CAAC;IACL,CAAC;IAEM,0CAAuB,GAA9B;QACE,QAAQ,CAAC,IAAI,CAAC,aAAa,CACzB,IAAI,WAAW,CAAC,iBAAiB,EAAE;YACjC,MAAM,wBACD,IAAI,CAAC,MAAM,KACd,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,gBAAgB,GAC3B;YACD,OAAO,EAAE,IAAI;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAED,mCAAgB,GAAhB;QAAA,iBA+BC;QA9BC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,UAAC,KAAK;YAC5C,IAAM,gBAAgB,GAAG,KAAK;iBAC3B,YAAY,EAAE;iBACd,IAAI,CACH,UAAC,GAAG;gBACF,OAAA,GAAG,YAAY,WAAW;oBAC1B,GAAG,CAAC,YAAY;oBAChB,GAAG,CAAC,YAAY,CAAC,cAAc,CAAC;YAFhC,CAEgC,CACnC,CAAC;YACJ,IAAI,gBAAgB,IAAI,gBAAgB,YAAY,WAAW,EAAE;gBAC/D,IAAM,IAAI,GAAG,gBAAgB,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;gBAC3D,IAAM,QAAM,GAAG,EAAE,CAAC;gBACV,IAAA,KAAK,GAAK,IAAA,kBAAQ,EAAC,gBAAgB,CAAC,MAA/B,CAAgC;gBAE7C,IAAI,IAAI,EAAE;oBACR,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,UAAC,IAAI;wBAC3B,IAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAC3B,MAAM;wBACN,aAAa;wBACb,QAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;oBACxB,CAAC,CAAC,CAAC;oBAEH,MAAM;oBACN,aAAa;oBACb,QAAM,CAAC,aAAa,GAAG,KAAK,CAAC;iBAC9B;gBAED,KAAI,CAAC,eAAe,CAAC,QAA0B,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IACH,eAAC;AAAD,CAAC,AAzGD,IAyGC;AAzGY,4BAAQ"}
|
|
@@ -70,7 +70,7 @@ declare const origamiEventSchema: import("yup").ObjectSchema<{
|
|
|
70
70
|
export type ConfigType = InferType<typeof configSchema>;
|
|
71
71
|
export type OrigamiEventType = InferType<typeof origamiEventSchema>;
|
|
72
72
|
export declare const parseConfig: (config: ConfigType) => ConfigType;
|
|
73
|
-
export declare const validateConfig: (config: ConfigType) => ValidationError[] | undefined;
|
|
73
|
+
export declare const validateConfig: (config: ConfigType, disableAppFormatTransform: boolean) => ValidationError[] | undefined;
|
|
74
74
|
export declare const validateOrigamiEvent: (config: OrigamiEventType) => ValidationError[] | undefined;
|
|
75
75
|
export {};
|
|
76
76
|
//# sourceMappingURL=yupValidator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"yupValidator.d.ts","sourceRoot":"","sources":["../../src/utils/yupValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,SAAS,EACT,eAAe,EAChB,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"yupValidator.d.ts","sourceRoot":"","sources":["../../src/utils/yupValidator.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,SAAS,EACT,eAAe,EAChB,MAAM,KAAK,CAAC;AAwBb,QAAA,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAwDhB,CAAC;AAEH,QAAA,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;MAkCtB,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAEpE,eAAO,MAAM,WAAW,WAAY,UAAU,KAAG,UAmBhD,CAAC;AAEF,eAAO,MAAM,cAAc,WACjB,UAAU,6BACS,OAAO,KACjC,eAAe,EAAE,GAAG,SAatB,CAAC;AAEF,eAAO,MAAM,oBAAoB,WACvB,gBAAgB,KACvB,eAAe,EAAE,GAAG,SAatB,CAAC"}
|
|
@@ -2,8 +2,12 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.validateOrigamiEvent = exports.validateConfig = exports.parseConfig = void 0;
|
|
4
4
|
var yup_1 = require("yup");
|
|
5
|
+
var disableAppFormatTransformValue = false;
|
|
5
6
|
//transform passed values to first character uppercase and replace spaces with underscores
|
|
6
|
-
var unifyValuesTransform = function (value) {
|
|
7
|
+
var unifyValuesTransform = function (value, ifTransform) {
|
|
8
|
+
if (ifTransform === void 0) { ifTransform = true; }
|
|
9
|
+
if (!ifTransform)
|
|
10
|
+
return value;
|
|
7
11
|
return (value.trim().charAt(0).toUpperCase() +
|
|
8
12
|
value.trim().slice(1).toLowerCase().replace(/ /g, "_").replace(/-/g, "_"));
|
|
9
13
|
};
|
|
@@ -38,7 +42,9 @@ var configSchema = (0, yup_1.object)({
|
|
|
38
42
|
app: (0, yup_1.string)()
|
|
39
43
|
.required()
|
|
40
44
|
.defined()
|
|
41
|
-
.transform(
|
|
45
|
+
.transform(function (value) {
|
|
46
|
+
return unifyValuesTransform(value, disableAppFormatTransformValue);
|
|
47
|
+
})
|
|
42
48
|
.oneOf([
|
|
43
49
|
"Stream",
|
|
44
50
|
"Article",
|
|
@@ -57,7 +63,7 @@ var configSchema = (0, yup_1.object)({
|
|
|
57
63
|
"case-studies",
|
|
58
64
|
"markets",
|
|
59
65
|
"news-and-insights",
|
|
60
|
-
"
|
|
66
|
+
"other",
|
|
61
67
|
]),
|
|
62
68
|
publishDate: (0, yup_1.string)().nullable().default(""),
|
|
63
69
|
isBranded: (0, yup_1.boolean)().defined(),
|
|
@@ -127,8 +133,9 @@ var parseConfig = function (config) {
|
|
|
127
133
|
}
|
|
128
134
|
};
|
|
129
135
|
exports.parseConfig = parseConfig;
|
|
130
|
-
var validateConfig = function (config) {
|
|
136
|
+
var validateConfig = function (config, disableAppFormatTransform) {
|
|
131
137
|
var _a;
|
|
138
|
+
disableAppFormatTransformValue = disableAppFormatTransform;
|
|
132
139
|
try {
|
|
133
140
|
configSchema.validateSync(config, {
|
|
134
141
|
strict: false,
|
|
@@ -1 +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;
|
|
1
|
+
{"version":3,"file":"yupValidator.js","sourceRoot":"","sources":["../../src/utils/yupValidator.ts"],"names":[],"mappings":";;;AAAA,2BAQa;AAEb,IAAI,8BAA8B,GAAG,KAAK,CAAC;AAE3C,0FAA0F;AAC1F,IAAM,oBAAoB,GAAG,UAAC,KAAa,EAAE,WAAkB;IAAlB,4BAAA,EAAA,kBAAkB;IAC7D,IAAI,CAAC,WAAW;QAAE,OAAO,KAAK,CAAC;IAC/B,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,KAAK,CAAC,CAAC,WAAW,EAAE,mBAAmB,CAAC,CAAC;IAC3D,GAAG,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE;IACxB,OAAO,EAAE,IAAA,YAAM,GAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAC1E,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,UAAC,KAAK;QACf,OAAA,oBAAoB,CAAC,KAAK,EAAE,8BAA8B,CAAC;IAA3D,CAA2D,CAC5D;SACA,KAAK,CAAC;QACL,QAAQ;QACR,SAAS;QACT,kBAAkB;QAClB,mBAAmB;QACnB,OAAO;QACP,oBAAoB;QACpB,OAAO;QACP,aAAa;QACb,yBAAyB;QACzB,aAAa;QACb,WAAW;QACX,cAAc;QACd,aAAa;QACb,UAAU;QACV,cAAc;QACd,SAAS;QACT,mBAAmB;QACnB,OAAO;KACR,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,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;AAKI,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,EAClB,yBAAkC;;IAElC,8BAA8B,GAAG,yBAAyB,CAAC;IAC3D,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;AAhBW,QAAA,cAAc,kBAgBzB;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"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@phantomstudios/ft-lib",
|
|
3
3
|
"description": "A collection of Javascript UI & tracking utils for FT sites",
|
|
4
|
-
"version": "0.3.0-
|
|
4
|
+
"version": "0.3.0-rc6",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
7
7
|
"homepage": "https://github.com/phantomstudios/ft-lib#readme",
|
package/src/FTTracking/index.ts
CHANGED
|
@@ -12,6 +12,7 @@ export interface TrackingOptions {
|
|
|
12
12
|
scrollTrackerSelector?: string;
|
|
13
13
|
isCustomGTMEvent?: boolean;
|
|
14
14
|
sendGTMPageViewYN?: boolean;
|
|
15
|
+
disableAppFormatTransform?: boolean;
|
|
15
16
|
}
|
|
16
17
|
|
|
17
18
|
const DEFAULT_OPTIONS = {
|
|
@@ -26,6 +27,7 @@ export class FTTracking {
|
|
|
26
27
|
oTracker: oTracker;
|
|
27
28
|
gaTracker: gaTracker;
|
|
28
29
|
scrollTracker: ScrollTracker;
|
|
30
|
+
disableAppFormatTransform: boolean;
|
|
29
31
|
oEvent: (detail: OrigamiEventType) => void;
|
|
30
32
|
gaEvent: (category: string, action: string, label: string) => void;
|
|
31
33
|
gtmEvent: (category: string, action: string, label: string) => void;
|
|
@@ -34,6 +36,8 @@ export class FTTracking {
|
|
|
34
36
|
this.options = { ...DEFAULT_OPTIONS, ...options };
|
|
35
37
|
this.oTracker = new oTracker(config, this.options);
|
|
36
38
|
this.gaTracker = new gaTracker(this.options);
|
|
39
|
+
this.disableAppFormatTransform =
|
|
40
|
+
this.options.disableAppFormatTransform || false;
|
|
37
41
|
|
|
38
42
|
this.oEvent = this.oTracker.eventDispatcher;
|
|
39
43
|
this.gaEvent = this.options.isCustomGTMEvent
|
|
@@ -61,7 +65,7 @@ export class FTTracking {
|
|
|
61
65
|
|
|
62
66
|
public newPageView(config: ConfigType) {
|
|
63
67
|
//Update passed config to otracker,send pageview events and reset scrollTracker
|
|
64
|
-
validateConfig(config);
|
|
68
|
+
validateConfig(config, this.disableAppFormatTransform);
|
|
65
69
|
this.oTracker.config = config;
|
|
66
70
|
this.oTracker.broadcastPageView();
|
|
67
71
|
this.oTracker.broadcastBrandedContent();
|
package/src/oTracker/index.ts
CHANGED
|
@@ -20,7 +20,7 @@ export class oTracker {
|
|
|
20
20
|
|
|
21
21
|
constructor(config: ConfigType, options: TrackingOptions) {
|
|
22
22
|
this._config = parseConfig(config);
|
|
23
|
-
validateConfig(this._config);
|
|
23
|
+
validateConfig(this._config, options.disableAppFormatTransform || false);
|
|
24
24
|
this._config.source_id = oTracking.getRootID();
|
|
25
25
|
this.options = options;
|
|
26
26
|
|
|
@@ -8,8 +8,11 @@ import {
|
|
|
8
8
|
ValidationError,
|
|
9
9
|
} from "yup";
|
|
10
10
|
|
|
11
|
+
let disableAppFormatTransformValue = false;
|
|
12
|
+
|
|
11
13
|
//transform passed values to first character uppercase and replace spaces with underscores
|
|
12
|
-
const unifyValuesTransform = (value: string) => {
|
|
14
|
+
const unifyValuesTransform = (value: string, ifTransform = true) => {
|
|
15
|
+
if (!ifTransform) return value;
|
|
13
16
|
return (
|
|
14
17
|
value.trim().charAt(0).toUpperCase() +
|
|
15
18
|
value.trim().slice(1).toLowerCase().replace(/ /g, "_").replace(/-/g, "_")
|
|
@@ -50,7 +53,9 @@ const configSchema = object({
|
|
|
50
53
|
app: string()
|
|
51
54
|
.required()
|
|
52
55
|
.defined()
|
|
53
|
-
.transform(
|
|
56
|
+
.transform((value) =>
|
|
57
|
+
unifyValuesTransform(value, disableAppFormatTransformValue)
|
|
58
|
+
)
|
|
54
59
|
.oneOf([
|
|
55
60
|
"Stream",
|
|
56
61
|
"Article",
|
|
@@ -69,7 +74,7 @@ const configSchema = object({
|
|
|
69
74
|
"case-studies",
|
|
70
75
|
"markets",
|
|
71
76
|
"news-and-insights",
|
|
72
|
-
"
|
|
77
|
+
"other",
|
|
73
78
|
]),
|
|
74
79
|
publishDate: string().nullable().default(""),
|
|
75
80
|
isBranded: boolean().defined(),
|
|
@@ -144,8 +149,10 @@ export const parseConfig = (config: ConfigType): ConfigType => {
|
|
|
144
149
|
};
|
|
145
150
|
|
|
146
151
|
export const validateConfig = (
|
|
147
|
-
config: ConfigType
|
|
152
|
+
config: ConfigType,
|
|
153
|
+
disableAppFormatTransform: boolean
|
|
148
154
|
): ValidationError[] | undefined => {
|
|
155
|
+
disableAppFormatTransformValue = disableAppFormatTransform;
|
|
149
156
|
try {
|
|
150
157
|
configSchema.validateSync(config, {
|
|
151
158
|
strict: false,
|