@ovh-ux/ovh-at-internet 0.1.0 → 0.18.1

package/dist/types/ovh-at-internet.d.ts

@@ -0,0 +1,29 @@
+import { OvhAtInternetConfig } from './config';
+import { LegacyTrackingData, GenericTrackingData, ImpressionTrackingData } from './track';
+export default class OvhAtInternet extends OvhAtInternetConfig {
+    private tag;
+    private trackQueue;
+    private afterSendEventHook;
+    getGenericTrackingData(data: LegacyTrackingData): GenericTrackingData;
+    getImpressionTrackingData(data: LegacyTrackingData): ImpressionTrackingData;
+    canTrack(): boolean;
+    clearTrackQueue(): void;
+    processTrackQueue(): void;
+    shouldUsePianoAnalytics(): boolean;
+    shouldUseMixCommander(): boolean;
+    initTag(withConsent: boolean): Promise<void>;
+    initVisitorId(): Promise<void>;
+    init(withConsent: boolean): Promise<void>;
+    onConsentModalDisplay(): void;
+    onUserConsentFromModal(consent: boolean): Promise<void>;
+    sendEvent(type: string, data: any): void;
+    trackMVTest(data: LegacyTrackingData): void;
+    trackPage(data: LegacyTrackingData): void;
+    trackMixCommanderS3(data: LegacyTrackingData): void;
+    trackClick(data: LegacyTrackingData): void;
+    trackEvent(data: LegacyTrackingData): void;
+    trackImpression(data: LegacyTrackingData): void;
+    trackClickImpression({ click: data }: {
+        click: LegacyTrackingData;
+    }): void;
+}

package/dist/types/track.d.ts

@@ -0,0 +1,73 @@
+export type TrackType = 'trackPage' | 'trackClick' | 'trackEvent' | 'trackImpression' | 'trackClickImpression' | 'trackMVTest' | 'trackMixCommanderS3';
+export interface LegacyTrackingData {
+    name: string;
+    chapter1?: string;
+    chapter2?: string;
+    chapter3?: string;
+    level2?: string;
+    page?: any;
+    [key: string]: any;
+}
+export interface PciProjectModeParams {
+    isDiscoveryProject?: boolean;
+    projectId?: string;
+}
+export interface TrackImpressionData {
+    campaignId: string;
+    creation: string;
+    format?: string;
+    generalPlacement?: string;
+    detailedPlacement?: string;
+    variant?: string;
+    advertiserId?: string;
+    url?: string;
+}
+export interface TrackClickImpressionData {
+    click: TrackImpressionData;
+}
+export interface GenericTrackingData {
+    country: string;
+    website?: string;
+    referrer?: string;
+    full_url: string;
+    site_name_1: string;
+    user_agent: string;
+    currency: string;
+    event?: string;
+    residential_country?: string;
+    user_id: string;
+    user_category: string;
+    site_level2: string;
+    page_category?: string;
+    complete_page_name?: string;
+    page_theme?: string;
+    pci_project_mode?: string;
+}
+export interface PageTrackingData extends GenericTrackingData {
+    page: string;
+    page_chapter1: string;
+    page_chapter2: string;
+    page_chapter3: string;
+}
+export interface ClickTrackingData extends GenericTrackingData, PageTrackingData {
+    click: string;
+    click_chapter1: string;
+    click_chapter2: string;
+    click_chapter3: string;
+}
+export interface ImpressionTrackingData extends GenericTrackingData {
+    onsitead_type: string;
+    onsitead_campaign: string;
+    onsitead_creation: string;
+    onsitead_variant: string;
+    onsitead_format: string;
+    onsitead_general_placement: string;
+    onsitead_detailed_placement: string;
+    onsitead_advertiser: string;
+    onsitead_url: string;
+}
+export type TrackingData = PageTrackingData | ClickTrackingData;
+export interface IOvhAtInternetTrack {
+    type: TrackType;
+    data: LegacyTrackingData;
+}

package/dist/types/utils.d.ts

@@ -0,0 +1 @@
+export declare function debug(...args: any[]): void;

package/dist/utils.js

@@ -0,0 +1,8 @@
+export function debug(...args) {
+    var _a;
+    if (!window.test &&
+        ((_a = window.localStorage) === null || _a === void 0 ? void 0 : _a.getItem('MANAGER_TRACKING_DEBUG'))) {
+        console.debug(...args);
+    }
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,KAAK,CAAC,GAAG,IAAW;;IAClC,IAAI,CAAC,MAAM,CAAC,IAAI;SACd,MAAA,MAAM,CAAC,YAAY,0CAAE,OAAO,CAAC,wBAAwB,CAAC,CAAA,EAAE,CAAC;QACzD,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;IACzB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ovh-ux/ovh-at-internet",
-  "version": "0.1.0",
+  "version": "0.18.1",
   "description": "ATInternet tracking library for OVHcloud.",
   "keywords": [
     "at-internet",
@@ -19,7 +19,7 @@
   "sideEffects": false,
   "main": "dist/index.js",
   "module": "dist/index.js",
-  "types": "./types",
+  "types": "./dist/types/index.d.ts",
   "files": [
     "dist",
     "types"
@@ -34,9 +34,13 @@
     "start:watch": "lerna exec --stream --parallel --scope='@ovh-ux/manager-config' --include-dependencies -- yarn run dev:watch"
   },
   "dependencies": {
-    "@ovh-ux/manager-config": "^5.0.0 || ^6.0.0",
-    "@types/lodash-es": "^4.17.5",
     "lodash-es": "^4.17.15"
   },
-  "devDependencies": {}
-}
+  "devDependencies": {
+    "@ovh-ux/manager-config": "^8.0.2",
+    "@types/lodash-es": "^4.17.5"
+  },
+  "peerDependencies": {
+    "@ovh-ux/manager-config": "^8.0.1"
+  }
+}

package/types/config.d.ts

@@ -1,69 +0,0 @@
-import { CountryCode } from '@ovh-ux/manager-config/types/locale/country-code.enum';
-export declare type levelKey<Num extends number> = `level${Num}`;
-declare type chapterKey<Num extends number> = `chapter${Num}`;
-export interface PageData {
-    name: string;
-    [key: levelKey<number>]: string;
-    [key: chapterKey<number>]: string;
-    visitorId?: number | string;
-    customObject?: Record<string, unknown>;
-    customVars: Record<string, unknown>;
-}
-export interface ClickData extends PageData {
-    type: 'action' | 'navigation' | 'download' | 'exit';
-}
-export interface MVTestingData {
-    test: string;
-    waveId: number;
-    creation: string;
-}
-export interface MVTestingVariables {
-    variable: string;
-    version: string;
-}
-export interface OrderData extends PageData {
-    page?: string;
-    price?: number;
-    priceTaxFree?: number;
-    orderId?: number;
-    quantity?: number;
-    status?: number;
-    countryCode?: CountryCode;
-    currencyCode?: CountryCode;
-}
-export interface ImpressionData extends PageData {
-    campaignId: string;
-    creation: string;
-    variant: string;
-    format: string;
-    generalPlacement: string;
-    detailedPlacement: string;
-    advertiserId: string;
-    url: string;
-}
-export interface ImpressionDataClick extends ImpressionData {
-    click: unknown;
-}
-export interface EventData extends PageData {
-    page: string;
-    event: Event;
-}
-export declare class OvhAtInternetConfig {
-    protected defaults: PageData;
-    protected defaultsPromise: Promise<PageData>;
-    protected enabled: boolean;
-    protected debug: boolean;
-    protected region: string;
-    isDefaultSet(): boolean;
-    setDefaults(def: PageData): PageData;
-    getDefaults(): PageData;
-    setDefaultsPromise(promise: Promise<PageData>): void;
-    getDefaultsPromise(): Promise<PageData>;
-    isEnabled(): boolean;
-    setEnabled(state: boolean): void;
-    setDebug(state: boolean): void;
-    isDebugActive(): boolean;
-    getRegion(): string;
-    setRegion(region: string): void;
-}
-export {};

package/types/constants.d.ts

@@ -1,12 +0,0 @@
-export interface IAtInternetCustomVar {
-    path: Record<string, string>;
-    format: string;
-}
-export declare type AtInternetCustomVars = {
-    [key in string]: IAtInternetCustomVar;
-};
-export declare const AT_INTERNET_CUSTOM_VARS: AtInternetCustomVars;
-declare const _default: {
-    AT_INTERNET_CUSTOM_VARS: AtInternetCustomVars;
-};
-export default _default;

package/types/ovh-at-internet.d.ts

@@ -1,23 +0,0 @@
-import { OvhAtInternetConfig, PageData, OrderData, ClickData, ImpressionData, ImpressionDataClick, EventData, MVTestingData } from './config';
-import { ATInternetTagOptions } from '.';
-export default class OvhAtInternet extends OvhAtInternetConfig {
-    private atinternetTag;
-    private trackQueue;
-    private logDebugInfos;
-    private updateData;
-    private updateCustomVars;
-    private getCustomVarsWithDefaults;
-    isTagAvailable(): boolean;
-    clearTrackQueue(): void;
-    processTrackQueue(): void;
-    initTag(): void;
-    getTag(): ATInternetTagOptions;
-    init(): void;
-    trackMVTest(mvData: MVTestingData): void;
-    trackPage(pageDataParam: PageData): void;
-    trackClick(clickDataParam: ClickData): void;
-    trackOrder(orderDataParam: OrderData): void;
-    trackEvent(eventDataParam: EventData): void;
-    trackImpression(impressionDataParam: ImpressionData): void;
-    trackClickImpression(impressionDataParam: ImpressionDataClick): void;
-}

package/types/track.d.ts

@@ -1,7 +0,0 @@
-import { MVTestingData, PageData } from './config';
-export declare type TrackType = 'trackPage' | 'trackClick' | 'trackOrder' | 'trackEvent' | 'trackImpression' | 'trackClickImpression' | 'trackMVTest';
-export declare type AtInternetTrackData<T> = T extends PageData ? T : MVTestingData;
-export interface IOvhAtInternetTrack<T> {
-    type: TrackType;
-    data: AtInternetTrackData<T>;
-}