@mhubcloud/tms_core 3.5.1 → 3.6.0-beta.1

package/src/publishers/googleAds.ts

@@ -1,193 +0,0 @@
-import { Logger } from '@azure/functions';
-import * as utils from './../utils/utils';
-import { EventToLog } from '../types/EventToLog';
-import { TypeSafeObject } from '../types/UtilTypes';
-
-interface GoogleAdsPlatformPublisher {
-  source: string;
-  publish: (
-    log: Logger,
-    config: GoogleAdsConfig,
-    data: TypeSafeObject,
-    event: EventToLog,
-  ) => Promise<void>;
-  getToken: (config: GoogleAdsConfig) => Promise<TokenCache>;
-}
-
-interface GoogleAdsData {
-  gclid?: string;
-  wbraid?: string;
-  gbraid?: string;
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  user_identifiers?: Record<string, unknown>[];
-  conversionAction?: string;
-  [x: string]: unknown;
-}
-
-interface GoogleAdsConfig extends TypeSafeObject {
-  client: {
-    id: string;
-    secret: string;
-    developerToken: string;
-  };
-  refreshToken: string;
-  customerId: string;
-  conversionId: string;
-}
-
-interface GoogleAdsResponse {
-  partialFailureError?: {
-    message: string;
-  };
-  error?: {
-    message: string;
-  };
-}
-
-interface TokenCache {
-  token: string;
-  createdAt: number;
-}
-
-interface TokenResponse {
-  // eslint-disable-next-line @typescript-eslint/naming-convention
-  access_token: string;
-}
-
-type TokenPromise = Promise<TokenCache> | null;
-
-let tokenCache: TokenCache | null;
-let tokenPromise: TokenPromise;
-
-export const googleAds: GoogleAdsPlatformPublisher = {
-  source: 'GoogleAds',
-  /**
-   *Publishes data to Google Ads
-   * @param log Azure Function context.log
-   * @param config Publisher configuration
-   * @param data Data in publisher-friendly format to be published
-   * @param event Event for which the function is triggered
-   */
-  async publish(log, config, data, event) {
-    if (
-      !(data as GoogleAdsData).gclid &&
-      !(data as GoogleAdsData).wbraid &&
-      !(data as GoogleAdsData).gbraid &&
-      !(data as GoogleAdsData).user_identifiers
-    ) {
-      utils.logMessage(1, `Excluded ${event.event} due to lack of identifiers`);
-      return;
-    }
-
-    const tokenData = await this.getToken(config);
-
-    data.conversionAction = `customers/${config.customerId}/conversionActions/${config.conversionId}`;
-
-    const body = {
-      conversions: [data],
-      partialFailure: true,
-      validateOnly: false,
-      debugEnabled: false,
-    };
-
-    const requestOptions = {
-      method: 'POST',
-      headers: {
-        // eslint-disable-next-line @typescript-eslint/naming-convention
-        Authorization: `Bearer ${tokenData.token}`,
-        // eslint-disable-next-line @typescript-eslint/naming-convention
-        'developer-token': config.client.developerToken,
-      },
-      body: JSON.stringify(body),
-    };
-
-    const baseUrl = `https://googleads.googleapis.com/v20/customers/${config.customerId}:uploadClickConversions`;
-
-    const response = await fetch(baseUrl, requestOptions);
-    const responseJson: GoogleAdsResponse = await response.json();
-
-    const knownErrors = [
-      'The imported event has a conversion_date_time that precedes the click. Make sure your conversion_date_time is correct and try again.',
-      "The click ID or call is associated with an Ads account you don't have access to. Make sure you import conversions for accounts managed by your manager account.",
-      "The imported event can't be recorded because its click occurred before this conversion's click-through window. Make sure you import the most recent data.",
-      'The imported event includes an order ID that was previously recorded, so the event was not processed.',
-      'The imported event could not be attributed to a click. This may be because the event did not come from a Google Ads campaign.',
-      "The imported event can't be recorded because its click occurred before this conversion's click-through window. Make sure you import the most recent data.",
-    ];
-
-    let status = 0;
-    let error;
-
-    if (responseJson.partialFailureError) {
-      status = 500;
-      utils.logMessage(1, responseJson.partialFailureError.message);
-      const trimmedMessage =
-        responseJson.partialFailureError.message.split('., at')[0] ?? '';
-      if (!knownErrors.includes(trimmedMessage)) {
-        error = responseJson.partialFailureError.message;
-      }
-    } else if (responseJson.error) {
-      status = 500;
-      error = responseJson.error.message;
-    } else {
-      status = 200;
-    }
-
-    utils.logEvent(
-      this.source,
-      event.event,
-      event.region,
-      status,
-      requestOptions.body,
-      event.id,
-    );
-
-    if (error) {
-      throw new Error(error);
-    }
-  },
-
-  async getToken(config: GoogleAdsConfig) {
-    if (tokenCache && tokenCache.createdAt + 3500 * 1000 > Date.now()) {
-      return tokenCache;
-    }
-
-    if (!tokenPromise) {
-      tokenPromise = (async () => {
-        const tokenResponse = await fetch(
-          `https://oauth2.googleapis.com/token`,
-          {
-            method: 'POST',
-            headers: {
-              // eslint-disable-next-line @typescript-eslint/naming-convention
-              'Content-Type': 'application/x-www-form-urlencoded',
-            },
-            body: new URLSearchParams({
-              // eslint-disable-next-line @typescript-eslint/naming-convention
-              client_id: config.client.id,
-              // eslint-disable-next-line @typescript-eslint/naming-convention
-              client_secret: config.client.secret,
-              // eslint-disable-next-line @typescript-eslint/naming-convention
-              refreshToken: config.refreshToken,
-              // eslint-disable-next-line @typescript-eslint/naming-convention
-              grant_type: 'refresh_token',
-            }),
-          },
-        );
-
-        if (!tokenResponse.ok) {
-          throw new Error('Access token fetch failed');
-        }
-
-        const parsedTokenResponse: TokenResponse = await tokenResponse.json();
-        const createdAt = Date.now();
-
-        tokenCache = { token: parsedTokenResponse.access_token, createdAt };
-        tokenPromise = null;
-        return tokenCache;
-      })();
-    }
-
-    return tokenPromise;
-  },
-};

package/src/publishers/googleAnalytics4.ts

@@ -1,60 +0,0 @@
-import * as utils from './../utils/utils';
-import {
-  PlatformPublisher,
-  PlatformRequestOptions,
-} from '../types/PlatformPublisher';
-import { TypeSafeObject } from '../types/UtilTypes';
-
-export const googleAnalytics4: PlatformPublisher = {
-  source: 'GoogleAnalytics4',
-  /**
-   * Publishes data to Google Analytics
-   * @param log zure Function context.log
-   * @param config Publisher configuration
-   * @param data Data in publisher-friendly format to be published
-   * @param event Event for which the function is triggered
-   */
-  async publish(log, config, data, event) {
-    if (config.trackingId) {
-      const ga4Data = utils.removeUndefined(data) as TypeSafeObject;
-      ga4Data.v = 2;
-      ga4Data.seg = 1;
-      ga4Data.gcs = 111;
-      ga4Data.tid = config.trackingId;
-
-      let payload = '';
-
-      for (const property in ga4Data) {
-        if (Object.prototype.hasOwnProperty.call(ga4Data, property)) {
-          if (payload) {
-            payload += '&';
-          }
-          payload += encodeURI(property) + '=' + encodeURI(ga4Data[property]);
-        }
-      }
-
-      const requestOptions: PlatformRequestOptions = {
-        method: 'POST',
-        headers: {
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          'User-Agent': 'mHub Cloud',
-        },
-      };
-
-      const baseUrl = 'https://www.google-analytics.com/g/collect';
-
-      const query = `?${payload}`;
-
-      await utils.handlePlatformRequest({
-        source: this.source,
-        baseUrl,
-        query,
-        requestOptions,
-        event,
-        logger: log,
-      });
-    } else {
-      throw new Error('Invalid config for platform ' + this.source);
-    }
-  },
-};

package/src/publishers/piano.ts

@@ -1,71 +0,0 @@
-import * as utils from './../utils/utils';
-import {
-  PlatformPublisher,
-  PlatformRequestOptions,
-} from '../types/PlatformPublisher';
-
-interface Aux {
-  visitorId: string;
-  ref: string;
-  userAgent?: string;
-  referer?: string;
-  forwardedFor?: string;
-}
-
-interface PianoData {
-  aux: Aux;
-}
-
-export const piano: PlatformPublisher = {
-  source: 'Piano',
-  /**
-   * Publishes data to Piano
-   * @param log zure Function context.log
-   * @param config Publisher configuration
-   * @param data Data in publisher-friendly format to be published
-   * @param event Event for which the function is triggered
-   */
-  async publish(log, config, data, event) {
-    if (
-      typeof config.siteId === 'string' &&
-      typeof config.collectionDomain === 'string'
-    ) {
-      const pianoData = utils.removeUndefined(data) as PianoData;
-      let query = '';
-      // https://developers.atinternet-solutions.com/piano-analytics-tagging-en/event-tagging-piano-analytics-en/events-pattern-en/#post-request_5
-      // https://<collection-domain>/<path>?s=<site-id>&idclient=<visitor-id>&ref=<previous-url>
-      query = '?s=' + encodeURI(config.siteId);
-      query += '&idclient=' + encodeURI(pianoData.aux.visitorId);
-      query += '&ref=' + encodeURI(pianoData.aux.ref);
-
-      const requestOptions: PlatformRequestOptions = {
-        method: 'POST',
-      };
-
-      requestOptions.headers = {};
-
-      if (pianoData.aux.userAgent) {
-        requestOptions.headers['User-Agent'] = pianoData.aux.userAgent;
-      }
-      if (pianoData.aux.referer) {
-        requestOptions.headers.Referer = pianoData.aux.referer;
-      }
-      if (pianoData.aux.forwardedFor) {
-        requestOptions.headers['X-Forwarded-For'] = pianoData.aux.forwardedFor;
-      }
-
-      const baseUrl = `https://${config.collectionDomain}/`;
-
-      await utils.handlePlatformRequest({
-        source: this.source,
-        baseUrl,
-        query,
-        requestOptions,
-        event,
-        logger: log,
-      });
-    } else {
-      throw new Error('Invalid config for platform ' + this.source);
-    }
-  },
-};

package/src/publishers/universalAnalytics.ts

@@ -1,63 +0,0 @@
-import * as utils from './../utils/utils';
-import {
-  PlatformPublisher,
-  PlatformRequestOptions,
-} from '../types/PlatformPublisher';
-import { TypeSafeObject } from '../types/UtilTypes';
-
-export const universalAnalytics: PlatformPublisher = {
-  source: 'UniversalAnalytics',
-  /**
-   * Publishes data to UniversalAnalytics
-   * @param log zure Function context.log
-   * @param config Publisher configuration
-   * @param data Data in publisher-friendly format to be published
-   * @param event Event for which the function is triggered
-   */
-  async publish(log, config, data, event) {
-    if (config.trackingId) {
-      const uaData = utils.removeUndefined(data) as TypeSafeObject;
-      uaData.v = 1;
-      uaData.tid = config.trackingId;
-
-      let payload = '';
-
-      for (const property in uaData) {
-        if (Object.prototype.hasOwnProperty.call(uaData, property)) {
-          if (payload) {
-            payload += '&';
-          }
-          if (uaData[property]) {
-            payload +=
-              encodeURI(property) + '=' + encodeURI(uaData[property] ?? '');
-          }
-        }
-      }
-
-      const requestOptions: PlatformRequestOptions = {
-        method: 'POST',
-        body: payload,
-        headers: {
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          'Content-Type': 'application/x-www-form-urlencoded',
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          'User-Agent': 'mHub Cloud',
-        },
-      };
-      const baseUrl = 'https://www.google-analytics.com/collect';
-
-      const query = `?${payload}`;
-
-      await utils.handlePlatformRequest({
-        source: this.source,
-        baseUrl,
-        query,
-        requestOptions,
-        event,
-        logger: log,
-      });
-    } else {
-      throw new Error('Invalid config for platform ' + this.source);
-    }
-  },
-};

package/src/types/EventPublisher.ts

@@ -1,13 +0,0 @@
-import { Logger } from '@azure/functions';
-import { ServiceBusMessage } from './ServiceBusMessage';
-
-export interface EventPublisherBaseClass {
-  config: Record<string, unknown>;
-}
-
-export interface EventPublisher extends EventPublisherBaseClass {
-  map: (
-    data: ServiceBusMessage,
-    log: Logger,
-  ) => Promise<Record<string, unknown>>;
-}

package/src/types/EventToLog.ts

@@ -1,5 +0,0 @@
-export interface EventToLog {
-  event: string;
-  region: string;
-  id: string;
-}

package/src/types/PlatformPublisher.ts

@@ -1,20 +0,0 @@
-import { HttpMethod, Logger } from '@azure/functions';
-import { EventToLog } from './EventToLog';
-import { TypeSafeObject } from './UtilTypes';
-
-export interface PlatformPublisher {
-  source: string; // ! ADDED
-  publish: (
-    log: Logger,
-    config: TypeSafeObject,
-    data: TypeSafeObject | unknown[],
-    event: EventToLog,
-  ) => Promise<void>;
-  // ! REMOVED parse and validate
-}
-
-export interface PlatformRequestOptions {
-  method: HttpMethod | undefined;
-  body?: any | undefined;
-  headers?: Record<string, string>;
-}

package/src/types/ServiceBusMessage.ts

@@ -1,10 +0,0 @@
-export interface ServiceBusMessage {
-  enqueuedAt: number;
-  event: {
-    code: string;
-    name?: string;
-    region: string;
-  };
-  messageId: string;
-  [x: string]: unknown;
-}

package/src/types/UtilTypes.ts

@@ -1 +0,0 @@
-export type TypeSafeObject = Record<string, unknown>;

package/src/types/global.d.ts

@@ -1,3 +0,0 @@
-declare namespace globalThis {
-  function it(): unknown;
-}

package/src/utils/testUtils.ts

@@ -1,18 +0,0 @@
-interface LogFunction {
-  (str: string): void;
-  warn: (str: string) => void;
-}
-// TODO tohle by se mělo dát spíš do nějakých obecných types asi
-interface Context {
-  log: LogFunction;
-}
-
-const context: Context = {} as Context;
-context.log = function log(str: string) {
-  console.log(str);
-} as LogFunction;
-context.log.warn = function warn(str: string) {
-  console.warn(str);
-};
-
-export { context };