@mhubcloud/tms_core 1.7.6 → 2.0.0-beta.1

package/tests/Piano.js

@@ -1,114 +1,127 @@
-const publisher = require("../index.js").publisher.Piano;
-const defaultPublisher = require("../index.js").DefaultPublisher;
-const utils = require("../index.js").utils;
+const publisher = require('../dist/index.js').publisher.Piano;
+const defaultPublisher = require('../dist/index.js').DefaultPublisher;
+const utils = require('../dist/index.js').utils;
 var assert = require('assert');
+const testUtils = require('./testUtils');
 
 describe('test Piano publisher', function () {
-    it('purchase', async function () {
-        var eventHubMessages = [
-            {
-                "currencyCode": "CZK",
-                "event": {
-                  "region": "MAIN",
-                  "id": "115169112-4870.1657003407533",
-                  "code": "purchase"
-                },
-                "session": {
-                  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
-                  "ip": "89.177.126.237",
-                  "referrer": "https://crossmasters.com/"
-                },
-                "referrer": "https://crossmasters.com/",
-                "permissions": [],
-                "identity": {
-                  "piano": {
-                    "id": "1657003393413.319297501"
-                  }
-                },
-                "publisher": {
-                  "code": "mhubcloud.com",
-                  "tm": "GTM-N7K9L4X",
-                  "tmv": "494"
-                },
-                "$schema": "/mhub/purchase",
-                "id": "20162351",
-                "revenue": 440,
-                "products": [
-                  {
-                    "id": "Car",
-                    "price": 440,
-                    "quantity": 1
-                  }
-                ],
-                "enqueuedAt": 1657003409370,
-                "ads": []
-              }
-        ];
-        await test(eventHubMessages);
-    });
-})
+  it('purchase', async function () {
+    var eventHubMessages = [
+      {
+        currencyCode: 'CZK',
+        event: {
+          region: 'MAIN',
+          id: '115169112-4870.1657003407533',
+          code: 'purchase',
+        },
+        session: {
+          userAgent:
+            'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36',
+          ip: '89.177.126.237',
+          referrer: 'https://crossmasters.com/',
+        },
+        referrer: 'https://crossmasters.com/',
+        permissions: [],
+        identity: {
+          piano: {
+            id: '1657003393413.319297501',
+          },
+        },
+        publisher: {
+          code: 'mhubcloud.com',
+          tm: 'GTM-N7K9L4X',
+          tmv: '494',
+        },
+        $schema: '/mhub/purchase',
+        id: '20162351',
+        revenue: 440,
+        products: [
+          {
+            id: 'Car',
+            price: 440,
+            quantity: 1,
+          },
+        ],
+        enqueuedAt: 1657003409370,
+        ads: [],
+      },
+    ];
+    await test(eventHubMessages);
+  });
+});
 
 /**
  * Test function
  * @param [object] object obsahující nastavení testovací parametry
  */
 async function test(eventHubMessages) {
-    try{
-        await defaultPublisher(console, eventHubMessages, "Piano", publisher, trigger);
-    }catch(err){
-        assert.equal(err.toString(), "FetchError: request to https://xxxxx.xiti.com/?s=12345&idclient=1657003393413.319297501&ref=https://crossmasters.com/ failed, reason: getaddrinfo ENOTFOUND xxxxx.xiti.com");
-    }
+  try {
+    await defaultPublisher(
+      testUtils.context,
+      eventHubMessages,
+      'Piano',
+      publisher,
+      trigger,
+    );
+  } catch (err) {
+    assert.equal(
+      err.toString(),
+      'FetchError: request to https://xxxxx.xiti.com/?s=12345&idclient=1657003393413.319297501&ref=https://crossmasters.com/ failed, reason: getaddrinfo ENOTFOUND xxxxx.xiti.com',
+    );
+  }
 }
 
 function trigger(data) {
-    const publishers = [];
-    const config = {
-        collectionDomain: "xxxxx.xiti.com", //Secured collection domain
-        siteId: "12345" //site-id
-    }
-    
-    if (data.event.code === "purchase") {
-        const publisher = PianoPurchasePublisher;
-        publisher.register(publishers, config);
-    }
-    return publishers;
-};
+  const publishers = [];
+  const config = {
+    collectionDomain: 'xxxxx.xiti.com', // Secured collection domain
+    siteId: '12345', // site-id
+  };
+
+  if (data.event.code === 'purchase') {
+    const publisher = PianoPurchasePublisher;
+    publisher.register(publishers, config);
+  }
+  return publishers;
+}
 
 class PianoPurchasePublisher extends utils.EventPublisherBase {
-    /**
-     * Converts input data to publishing payload data understood by the publisher
-     * @param {Object} data `purchase` event data
-     * @returns {Object} Data mapped from incomming Event Hub message to platform payload
-     */
-    map(data) {
-        return {
-            pianoData: { //This willbe sent to Piano as payload
-                events: [
-                    {
-                        name: "purchase",
-                        data: {
-                            event_collection_platform: "api",
-                            event_collection_version: 2,
-                            event_time_ts: Math.floor(data.enqueuedAt / 1000), // convert to seconds
-                            event_id: data.id,
-                            event_source_url: data.location
-                            //https://developers.atinternet-solutions.com/piano-analytics-tagging-en/event-tagging-piano-analytics-en/events-pattern-en/#common-contextual-properties_9
-                            //Any properties can go here (name must be [a-z][a-z_0-9]+; prohibited names m_…, visit_…, events)
-                            //There are some specifically understood properties
-                            //Type of property if not obvious from JSON can be forcec by prefix: 's:' string, 'n:' integer, 'f:' float, 'd:' date, 'b:' boolean, 'a:s:' array of strings, 'a:n:' array of integers, 'a:f:' array of floats
-                            //or by suffix '_date', '_utc', '_ts' date in RFC 3339 format (YYYY-MM-DDTHH:mm:ssZ); '_timestamp' - timestamp in seconds
-                        }
-                    }
-                ]
+  /**
+   * Converts input data to publishing payload data understood by the publisher
+   * @param {Object} data `purchase` event data
+   * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+   */
+  map(data) {
+    return {
+      pianoData: {
+        // This willbe sent to Piano as payload
+        events: [
+          {
+            name: 'purchase',
+            data: {
+              event_collection_platform: 'api',
+              event_collection_version: 2,
+              event_time_ts: Math.floor(data.enqueuedAt / 1000), // convert to seconds
+              event_id: data.id,
+              event_source_url: data.location,
+              // https://developers.atinternet-solutions.com/piano-analytics-tagging-en/event-tagging-piano-analytics-en/events-pattern-en/#common-contextual-properties_9
+              // Any properties can go here (name must be [a-z][a-z_0-9]+; prohibited names m_…, visit_…, events)
+              // There are some specifically understood properties
+              // Type of property if not obvious from JSON can be forcec by prefix: 's:' string, 'n:' integer, 'f:' float, 'd:' date, 'b:' boolean, 'a:s:' array of strings, 'a:n:' array of integers, 'a:f:' array of floats
+              // or by suffix '_date', '_utc', '_ts' date in RFC 3339 format (YYYY-MM-DDTHH:mm:ssZ); '_timestamp' - timestamp in seconds
             },
-            aux: { //Additional data understood by Piano publisher and passed specificaly (in headers and query string)
-                visitorId: data.identity?.piano?.id, //Mandatory idclient=<visitor-id>
-                ref: data.referrer, //Mandatory ref=<previous-url>
-                //Optional:
-                userAgent: data.session?.userAgent,
-                referer: data.session?.referrer,
-                forwardedFor: data.session?.ip,
-            }
-        };
-    }
-};
+          },
+        ],
+      },
+      aux: {
+        // Additional data understood by Piano publisher and passed specificaly (in headers and query string)
+        visitorId: data.identity?.piano?.id, // Mandatory idclient=<visitor-id>
+        ref: data.referrer, // Mandatory ref=<previous-url>
+        // Optional:
+        userAgent: data.session?.userAgent,
+        referer: data.session?.referrer,
+        forwardedFor: data.session?.ip,
+      },
+    };
+  }
+}

package/tests/UniversalAnalytics.js

@@ -1,94 +1,107 @@
-const publisher = require("../index.js").publisher.UniversalAnalytics;
-const defaultPublisher = require("../index.js").DefaultPublisher;
-const utils = require("../index.js").utils;
+const publisher = require('../dist/index.js').publisher.UniversalAnalytics;
+const defaultPublisher = require('../dist/index.js').DefaultPublisher;
+const utils = require('../dist/index.js').utils;
 var assert = require('assert');
+const testUtils = require('./testUtils');
 
 describe('test UniversalAnalytics publisher', function () {
-    it('pageview', async function () {
-        var eventHubMessages = [
-            {
-                "currencyCode": "CZK",
-                "event": {
-                  "region": "MAIN",
-                  "id": "115169112-4870.1657003407533",
-                  "code": "pageview"
-                },
-                "session": {
-                  "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36",
-                  "ip": "89.177.126.237",
-                  "referrer": "https://crossmasters.com/"
-                },
-                "referrer": "https://crossmasters.com/",
-                "permissions": [],
-                "identity": {
-                  "piano": {
-                    "id": "1657003393413.319297501"
-                  }
-                },
-                "publisher": {
-                  "code": "mhubcloud.com",
-                  "tm": "GTM-N7K9L4X",
-                  "tmv": "494"
-                },
-                "$schema": "/mhub/pageview",
-                "enqueuedAt": 1657003409370,
-                "ads": []
-              }
-        ];
-        await test(eventHubMessages);
-    });
-})
+  it('pageview', async function () {
+    var eventHubMessages = [
+      {
+        currencyCode: 'CZK',
+        event: {
+          region: 'MAIN',
+          id: '115169112-4870.1657003407533',
+          code: 'pageview',
+        },
+        session: {
+          userAgent:
+            'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36',
+          ip: '89.177.126.237',
+          referrer: 'https://crossmasters.com/',
+        },
+        referrer: 'https://crossmasters.com/',
+        permissions: [],
+        identity: {
+          piano: {
+            id: '1657003393413.319297501',
+          },
+        },
+        publisher: {
+          code: 'mhubcloud.com',
+          tm: 'GTM-N7K9L4X',
+          tmv: '494',
+        },
+        $schema: '/mhub/pageview',
+        enqueuedAt: 1657003409370,
+        ads: [],
+      },
+    ];
+    await test(eventHubMessages);
+  });
+});
 
 /**
  * Test function
  * @param [object] object obsahující nastavení testovací parametry
  */
 async function test(eventHubMessages) {
-    await defaultPublisher(console, eventHubMessages, "UniversalAnalytics", publisher, trigger);
+  await defaultPublisher(
+    testUtils.context,
+    eventHubMessages,
+    'UniversalAnalytics',
+    publisher,
+    trigger,
+  );
 }
 
 function trigger(data) {
-    const publishers = [];
-    const config = {trackingId: "UA-xxxxxxx-yy"};
+  const publishers = [];
+  const config = { trackingId: 'UA-xxxxxxx-yy' };
 
-    if (data.event?.code === "pageview") {
-        const publisher = GAPageviewPublisher;
-        publisher.register(publishers, config);
-    }
+  if (data.event?.code === 'pageview') {
+    const publisher = GAPageviewPublisher;
+    publisher.register(publishers, config);
+  }
 
-    return publishers;
-};
+  return publishers;
+}
 
 class GAPageviewPublisher extends utils.EventPublisherBase {
-    /**
-     * Maps `pageview` event data to GA payload
-     */
-    map(data) {
-        /** @type {AdCodeInfo} */
-        let gclid = utils.extractAdCode(data, "googleads", "gclid");
-        /** @type {AdCodeInfo} */
-        let referrer = utils.extractAdCode(data, "referrerPlatform", "referrer");
-        /** @type {Ad} */
-        let utm = utils.extractAdCode(data, "googleAnalytics", "utm_source", (_, data) => data.adCodes ? data : null); //Only supports new format
+  /**
+   * Maps `pageview` event data to GA payload
+   */
+  map(data) {
+    /** @type {AdCodeInfo} */
+    let gclid = utils.extractAdCode(data, 'googleads', 'gclid');
+    /** @type {AdCodeInfo} */
+    let referrer = utils.extractAdCode(data, 'referrerPlatform', 'referrer');
+    /** @type {Ad} */
+    let utm = utils.extractAdCode(
+      data,
+      'googleAnalytics',
+      'utm_source',
+      (_, data) => (data.adCodes ? data : null),
+    ); // Only supports new format
+
+    // https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#event
+    // https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#dr
+    return {
+      // mandatory for all events
+      t: 'pageview',
+      cid: '456', // TODO
 
-        //https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#event
-        //https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#dr
-        return {
-            //mandatory for all events
-            t : "pageview",
-            cid: "456", //TODO
-            
-            //mandatory for pageview
-            dp: "/",
-            
-            //Traffic Sources - optional 
-            //TODO not tested
-            cn: utm?.adCodes?.utm_campaign,
-            cs: utm?.adCodes?.utm_source,
-            cm: utm?.adCodes?.utm_medium,
-            cc: utm?.adCodes?.utm_content,
-            gclid: gclid?.code,
-            dr: referrer?.code
-        };
-    }
-};
+      // mandatory for pageview
+      dp: '/',
+
+      // Traffic Sources - optional
+      // TODO not tested
+      cn: utm?.adCodes?.utm_campaign,
+      cs: utm?.adCodes?.utm_source,
+      cm: utm?.adCodes?.utm_medium,
+      cc: utm?.adCodes?.utm_content,
+      gclid: gclid?.code,
+      dr: referrer?.code,
+    };
+  }
+}

package/tests/testUtils.js

@@ -0,0 +1,7 @@
+const context = {}
+context.log = function log(str) { console.log(str) }
+context.log.warn = function warn(str) {console.warn(str) }
+
+module.exports = {
+  context: context
+}

package/tsconfig.eslint.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Default",
+  "extends": "@tsconfig/recommended/tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "checkJs": false,
+    "composite": false,
+    "declaration": true,
+    "declarationDir": "./types",
+    "declarationMap": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "noEmit": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "preserveWatchOutput": true,
+    "removeComments": true,
+    "resolveJsonModule": true,
+    "sourceMap": true,
+    "strictNullChecks": true,
+    "useDefineForClassFields": true,
+    "useUnknownInCatchVariables": true,
+    "strict": true,
+    "outDir": "dist"
+  },
+  "include": [
+    ".eslintrc.cjs",
+    "**/*"
+    // "build_scripts/post-build.mjs"
+  ],
+  "exclude": [
+    "node_modules",
+    "build",
+    "dist"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "extends": "./tsconfig.eslint.json",
+  "compilerOptions": {
+    "lib": [
+      "es2021"
+    ],
+    "module": "commonjs",
+    "target": "es2021",
+    "moduleResolution": "node",
+    "experimentalDecorators": true,
+    "types": [
+      "node"
+    ]
+  },
+  "include": [
+    "**/*.ts",
+    "tsconfig.eslint.json"
+  ],
+  "exclude": [
+    "node_modules",
+    "build",
+    "dist",
+    "tests",
+    "js"
+  ]
+}