@mhubcloud/tms_core 3.5.0 → 3.6.0-beta.0

package/tests/Facebook.js

@@ -1,128 +0,0 @@
-const localSettings = require('../local.settings.json').Values;
-process.env = { ...process.env, ...localSettings };
-const publisher = require('../dist/index.js').publisher.Facebook;
-const defaultPublisher = require('../dist/index.js').DefaultPublisher;
-const utils = require('../dist/index.js').utils;
-const testUtils = require('../dist/index.js').testUtils;
-
-describe('test Facebook publisher', function () {
-  it('purchase', async function () {
-    var serviceBusMessage = {
-      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: Date.now(),
-      ads: [],
-    };
-    await test(serviceBusMessage);
-  });
-});
-
-/**
- * Test function
- * @param [object] object obsahující nastavení testovací parametry
- */
-async function test(serviceBusMessage) {
-  await defaultPublisher(
-    testUtils.context,
-    serviceBusMessage,
-    'Facebook',
-    publisher,
-    trigger,
-  );
-}
-
-// eslint-disable-next-line @typescript-eslint/require-await
-async function trigger(data) {
-  const publishers = [];
-  let publisher;
-
-  // Dummy config, replace with your own
-  const config = {
-    id: process.env.Publisher_Facebook_PixelId,
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    access_token: process.env.Publisher_Facebook_AccessToken,
-  };
-
-  switch (data.event?.code) {
-    case 'purchase':
-      publisher = new FBPurchasePublisher(config);
-      publishers.push(publisher);
-      break;
-  }
-  return publishers;
-}
-
-class FBPurchasePublisher extends utils.EventPublisherBase {
-  /**
-   * Maps `purchase` event data to Facebook payload
-   * @param {Object} data `purchase` event data
-   * @returns {Object} Data mapped from incoming Service Bus message to platform payload
-   */
-  map(data) {
-    return {
-      event_name: 'Purchase', // Constant
-      event_time: Math.floor(data.enqueuedAt / 1000), // convert to seconds
-      action_source: 'website', // Constant
-      event_id: data.id, // e.g. OBJ1248035
-      event_source_url: data.location, // e.g. https://eshop.com/checkoutSuccess
-      opt_out: false, // Constant
-      user_data: {
-        client_user_agent: data.session?.userAgent, // e.g. Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit
-        fbc:
-          utils.extractAdCode(
-            data,
-            'facebook',
-            'fbclid',
-            (ad) => `fb.1.${ad.visitAt}.${ad.code}`,
-          ) || undefined, // e.g. fb.1.1623142020900.IwAR3CoXSdAr4nXyoVGo5H72wAiP8BrgPays0hhH1UgxnW_8D7rDhuHgjvvw0_aem_AXjjss7KoC0VSnBGvyUAkPip4VaZV6qytiIx5s8FQrAy5yzamZNRSC_xaCXEeJ8ecyphjuyQ2zbDAMoaIVayYAHxZgFH8TJsMzysJAIikY0How
-        fbp: data.identity?.facebook?.id, // e.g. fb.1.1609144040877.1929163682
-        client_ip_address: data.session?.ip, // e.g. 31.30.171.18
-        em: utils.encodeEmail(data.user?.email),
-      },
-      custom_data: {
-        currency: data.currencyCode, // e.g. EUR
-        value: data.revenue, // e.g. 142.52
-        contents: data.products.map((pr) => ({
-          id: pr.id, // e.g. PRDCT1248035
-          quantity: pr.quantity, // e.g. 1
-          item_price: pr.price, // e.g. 109
-        })),
-        content_type: 'product', // Constant
-        order_id: data.id, // e.g. OBJ1248035
-        content_category: 'Purchase', // Constant
-      },
-    };
-  }
-}

package/tests/GoogleAds.js

@@ -1,130 +0,0 @@
-const localSettings = require('../local.settings.json').Values;
-process.env = { ...process.env, ...localSettings };
-const publisher = require('../dist/index.js').publisher.GoogleAds;
-const defaultPublisher = require('../dist/index.js').DefaultPublisher;
-const utils = require('../dist/index.js').utils;
-const testUtils = require('../dist/index.js').testUtils;
-
-describe('test GoogleAds publisher', function () {
-  it('purchase', async function () {
-    const serviceBusMessage = {
-      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: [
-        {
-          adPlatform: 'googleads',
-          adCodes: {
-            gclid: 'mhubcloud',
-            gcl_src: 'aw.ds',
-          },
-          visitAt: 1727173492000,
-        },
-      ],
-    };
-    await test(serviceBusMessage);
-  });
-});
-
-/**
- * Test function
- * @param [object] object obsahující nastavení testovací parametry
- */
-async function test(serviceBusMessage) {
-  await defaultPublisher(
-    testUtils.context,
-    serviceBusMessage,
-    'GoogleAds',
-    publisher,
-    trigger,
-  );
-}
-
-// eslint-disable-next-line @typescript-eslint/require-await
-async function trigger(data) {
-  const publishers = [];
-  let publisher;
-
-  // Dummy config, replace with your own
-  const config = {
-    client: {
-      id: process.env.Publisher_GoogleAds_ClientID,
-      secret: process.env.Publisher_GoogleAds_ClientSecret,
-      developerToken: process.env.Publisher_GoogleAds_DeveloperToken,
-    },
-    refreshToken:
-      // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-      process.env.Publisher_GoogleAds_RefreshToken,
-    customerId:
-      // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
-      process.env.Publisher_GoogleAds_CustomerID,
-    conversionId: process.env.Publisher_GoogleAds_ConversionID_purchase,
-  };
-
-  switch (data.event?.code) {
-    case 'purchase':
-      publisher = new GoogleAdsPurchasePublisher(config);
-      publishers.push(publisher);
-      break;
-  }
-
-  return publishers;
-}
-
-class GoogleAdsPurchasePublisher extends utils.EventPublisherBase {
-  /**
-   * Maps `purchase` event data to GoogleAds payload
-   * @param {Object} data `purchase` event data
-   * @returns {Object} Data mapped from incoming Service Bus message to platform payload
-   */
-  map(data) {
-    const dateTime = new Date(data.enqueuedAt);
-    const dateString =
-      dateTime.toISOString().replace('T', ' ').split('.')[0] + '+00:00';
-    const gclid = utils.extractAdCode(data, 'googleads', 'gclid')?.code;
-    const wbraid = utils.extractAdCode(data, 'googleads', 'wbraid')?.code;
-    const gbraid = utils.extractAdCode(data, 'googleads', 'gbraid')?.code;
-
-    return {
-      gclid: gclid,
-      wbraid: gclid || gbraid ? undefined : wbraid,
-      gbraid: gclid || wbraid ? undefined : gbraid,
-      orderId: data.event.id,
-      conversionDateTime: dateString,
-      currencyCode: data.currencyCode, // e.g. EUR
-      conversionValue: data.value ? data.value : 0.01, // e.g. 142.52
-    };
-  }
-}

package/tests/GoogleAnalytics4.js

@@ -1,99 +0,0 @@
-const localSettings = require('../local.settings.json').Values;
-process.env = { ...process.env, ...localSettings };
-const publisher = require('../dist/index.js').publisher.GoogleAnalytics4;
-const defaultPublisher = require('../dist/index.js').DefaultPublisher;
-const utils = require('../dist/index.js').utils;
-const testUtils = require('../dist/index.js').testUtils;
-
-describe('test GoogleAnalytics4 publisher', function () {
-  it('purchase', async function () {
-    var serviceBusMessage = {
-      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/purchase',
-      id: '20162351',
-      revenue: 440,
-      products: [
-        {
-          id: 'Car',
-          price: 440,
-          quantity: 1,
-        },
-      ],
-      enqueuedAt: 1657003409370,
-      ads: [],
-    };
-    await test(serviceBusMessage);
-  });
-});
-
-/**
- * Test function
- * @param [object] object obsahující nastavení testovací parametry
- */
-async function test(serviceBusMessage) {
-  await defaultPublisher(
-    testUtils.context,
-    serviceBusMessage,
-    'GoogleAnalytics4',
-    publisher,
-    trigger,
-  );
-}
-
-// eslint-disable-next-line @typescript-eslint/require-await
-async function trigger(data) {
-  const publishers = [];
-  const config = { trackingId: 'G-289495622' };
-
-  if (data.event?.code === 'pageview') {
-    const publisher = GAPageviewPublisher;
-    publisher.register(publishers, config);
-  }
-
-  return publishers;
-}
-
-class GAPageviewPublisher extends utils.EventPublisherBase {
-  /**
-   * Maps `pageview` event data to GA payload
-   */
-  map(data) {
-    return {
-      // mandatory for all events
-      cid: '456', // client id
-      en: 'eventMhubCloud', // event name
-
-      // mandatory for pageview
-      dl: '/', // URL
-
-      // optional
-      // ul : "en-us",
-      // sr: "1536x864", //screan resolution
-      // dr: "ccc", //refferer
-      // dt: "xx" //page title
-    };
-  }
-}

package/tests/Piano.js

@@ -1,120 +0,0 @@
-const localSettings = require('../local.settings.json').Values;
-process.env = { ...process.env, ...localSettings };
-const publisher = require('../dist/index.js').publisher.Piano;
-const defaultPublisher = require('../dist/index.js').DefaultPublisher;
-const utils = require('../dist/index.js').utils;
-const testUtils = require('../dist/index.js').testUtils;
-
-describe('test Piano publisher', function () {
-  it('purchase', async function () {
-    var serviceBusMessage = {
-      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(serviceBusMessage);
-  });
-});
-
-/**
- * Test function
- * @param [object] object obsahující nastavení testovací parametry
- */
-async function test(serviceBusMessage) {
-  await defaultPublisher(
-    testUtils.context,
-    serviceBusMessage,
-    'Piano',
-    publisher,
-    trigger,
-  );
-}
-
-// eslint-disable-next-line @typescript-eslint/require-await
-async 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;
-}
-
-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 incoming Service Bus 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,
-      },
-    };
-  }
-}

package/tests/UniversalAnalytics.js

@@ -1,107 +0,0 @@
-const localSettings = require('../local.settings.json').Values;
-process.env = { ...process.env, ...localSettings };
-const publisher = require('../dist/index.js').publisher.UniversalAnalytics;
-const defaultPublisher = require('../dist/index.js').DefaultPublisher;
-const utils = require('../dist/index.js').utils;
-const testUtils = require('../dist/index.js').testUtils;
-
-describe('test UniversalAnalytics publisher', function () {
-  it('pageview', async function () {
-    var serviceBusMessage = {
-      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(serviceBusMessage);
-  });
-});
-
-/**
- * Test function
- * @param [object] object obsahující nastavení testovací parametry
- */
-async function test(serviceBusMessage) {
-  await defaultPublisher(
-    testUtils.context,
-    serviceBusMessage,
-    'UniversalAnalytics',
-    publisher,
-    trigger,
-  );
-}
-
-// eslint-disable-next-line @typescript-eslint/require-await
-async function trigger(data) {
-  const publishers = [];
-  const config = { trackingId: 'UA-xxxxxxx-yy' };
-
-  if (data.event?.code === 'pageview') {
-    const publisher = GAPageviewPublisher;
-    publisher.register(publishers, config);
-  }
-
-  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
-
-    // 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,
-    };
-  }
-}

package/tsconfig.eslint.json

@@ -1,43 +0,0 @@
-{
-  "$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

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