@phantomstudios/ft-lib - npm Package Compare versions

Comparing version 0.3.0-rc5 to 0.3.0-rc6

lib/FTTracking/index.d.ts

@@ -9,2 +9,3 @@ import { gaTracker } from "../gaTracker";
     sendGTMPageViewYN?: boolean;
+    disableAppFormatTransform?: boolean;
 }
@@ -17,2 +18,3 @@ export declare class FTTracking {
     scrollTracker: ScrollTracker;
+    disableAppFormatTransform: boolean;
     oEvent: (detail: OrigamiEventType) => void;
@@ -19,0 +21,0 @@ gaEvent: (category: string, action: string, label: string) => void;

lib/FTTracking/index.js

@@ -30,2 +30,4 @@ "use strict";
         this.gaTracker = new gaTracker_1.gaTracker(this.options);
+        this.disableAppFormatTransform =
+            this.options.disableAppFormatTransform || false;
         this.oEvent = this.oTracker.eventDispatcher;
@@ -57,3 +59,3 @@ this.gaEvent = this.options.isCustomGTMEvent
         //Update passed config to otracker,send pageview events and reset scrollTracker
-        (0, yupValidator_1.validateConfig)(config);
+        (0, yupValidator_1.validateConfig)(config, this.disableAppFormatTransform);
         this.oTracker.config = config;
@@ -60,0 +62,0 @@ this.oTracker.broadcastPageView();

lib/oTracker/index.js

@@ -28,3 +28,3 @@ "use strict";
         this._config = (0, yupValidator_1.parseConfig)(config);
-        (0, yupValidator_1.validateConfig)(this._config);
+        (0, yupValidator_1.validateConfig)(this._config, options.disableAppFormatTransform || false);
         this._config.source_id = o_tracking_1.default.getRootID();
@@ -31,0 +31,0 @@ this.options = options;

lib/utils/yupValidator.d.ts

@@ -73,5 +73,5 @@ import { InferType, ValidationError } from "yup";
 export declare const parseConfig: (config: ConfigType) => ConfigType;
-export declare const validateConfig: (config: ConfigType) => ValidationError[] | undefined;
+export declare const validateConfig: (config: ConfigType, disableAppFormatTransform: boolean) => ValidationError[] | undefined;
 export declare const validateOrigamiEvent: (config: OrigamiEventType) => ValidationError[] | undefined;
 export {};
 //# sourceMappingURL=yupValidator.d.ts.map

lib/utils/yupValidator.js

@@ -5,4 +5,8 @@ "use strict";
 var yup_1 = require("yup");
+var disableAppFormatTransformValue = false;
 //transform passed values to first character uppercase and replace spaces with underscores
-var unifyValuesTransform = function (value) {
+var unifyValuesTransform = function (value, ifTransform) {
+    if (ifTransform === void 0) { ifTransform = true; }
+    if (!ifTransform)
+        return value;
     return (value.trim().charAt(0).toUpperCase() +
@@ -42,3 +46,5 @@ value.trim().slice(1).toLowerCase().replace(/ /g, "_").replace(/-/g, "_"));
         .defined()
-        .transform(unifyValuesTransform)
+        .transform(function (value) {
+        return unifyValuesTransform(value, disableAppFormatTransformValue);
+    })
         .oneOf([
@@ -55,10 +61,10 @@ "Stream",
         "Photo_essay",
-        "Home_page",
-        "Capabilities",
-        "My_products",
-        "Audience",
-        "Case_studies",
-        "Markets",
-        "News_and_insights",
-        "Other",
+        "home-page",
+        "capabilities",
+        "my-products",
+        "audience",
+        "case-studies",
+        "markets",
+        "news-and-insights",
+        "other",
     ]),
@@ -133,4 +139,5 @@ publishDate: (0, yup_1.string)().nullable().default(""),
 exports.parseConfig = parseConfig;
-var validateConfig = function (config) {
+var validateConfig = function (config, disableAppFormatTransform) {
     var _a;
+    disableAppFormatTransformValue = disableAppFormatTransform;
     try {
@@ -137,0 +144,0 @@ configSchema.validateSync(config, {

package.json

 {
   "name": "@phantomstudios/ft-lib",
   "description": "A collection of Javascript UI & tracking utils for FT sites",
-  "version": "0.3.0-rc5",
+  "version": "0.3.0-rc6",
   "main": "lib/index.js",
@@ -6,0 +6,0 @@ "types": "lib/index.d.ts",

src/FTTracking/index.ts

@@ -15,2 +15,3 @@ import { consentMonitor } from "../consentMonitor";
   sendGTMPageViewYN?: boolean;
+  disableAppFormatTransform?: boolean;
 }
@@ -30,2 +31,3 @@
   scrollTracker: ScrollTracker;
+  disableAppFormatTransform: boolean;
   oEvent: (detail: OrigamiEventType) => void;
@@ -39,2 +41,4 @@ gaEvent: (category: string, action: string, label: string) => void;
     this.gaTracker = new gaTracker(this.options);
+    this.disableAppFormatTransform =
+      this.options.disableAppFormatTransform || false;
 
@@ -67,3 +71,3 @@ this.oEvent = this.oTracker.eventDispatcher;
     //Update passed config to otracker,send pageview events and reset scrollTracker
-    validateConfig(config);
+    validateConfig(config, this.disableAppFormatTransform);
     this.oTracker.config = config;
@@ -70,0 +74,0 @@ this.oTracker.broadcastPageView();

src/oTracker/index.ts

@@ -23,3 +23,3 @@ import oTracking from "@financial-times/o-tracking";
     this._config = parseConfig(config);
-    validateConfig(this._config);
+    validateConfig(this._config, options.disableAppFormatTransform || false);
     this._config.source_id = oTracking.getRootID();
@@ -26,0 +26,0 @@ this.options = options;

src/utils/yupValidator.ts

@@ -11,4 +11,7 @@ import {
 
+let disableAppFormatTransformValue = false;
+
 //transform passed values to first character uppercase and replace spaces with underscores
-const unifyValuesTransform = (value: string) => {
+const unifyValuesTransform = (value: string, ifTransform = true) => {
+  if (!ifTransform) return value;
   return (
@@ -54,3 +57,5 @@ value.trim().charAt(0).toUpperCase() +
     .defined()
-    .transform(unifyValuesTransform)
+    .transform((value) =>
+      unifyValuesTransform(value, disableAppFormatTransformValue)
+    )
     .oneOf([
@@ -67,10 +72,10 @@ "Stream",
       "Photo_essay",
-      "Home_page",
-      "Capabilities",
-      "My_products",
-      "Audience",
-      "Case_studies",
-      "Markets",
-      "News_and_insights",
-      "Other",
+      "home-page",
+      "capabilities",
+      "my-products",
+      "audience",
+      "case-studies",
+      "markets",
+      "news-and-insights",
+      "other",
     ]),
@@ -150,4 +155,6 @@ publishDate: string().nullable().default(""),
 export const validateConfig = (
-  config: ConfigType
+  config: ConfigType,
+  disableAppFormatTransform: boolean
 ): ValidationError[] | undefined => {
+  disableAppFormatTransformValue = disableAppFormatTransform;
   try {
@@ -154,0 +161,0 @@ configSchema.validateSync(config, {

No alert changes

Improved metrics

Total package byte prevSize

222202

0.7%

Lines of code

3757

0.56%

No dependency changes