@adtrackify/at-service-common 5.0.0 → 5.0.2

package/dist/cjs/clients/internal-api/destinations-client.d.ts

@@ -1,34 +1,34 @@
-import { ApiResponse } from '../../types/api-response.js';
-import { GenericHttpClient } from '../generic/http-client.js';
-import { DESTINATION_TYPE, DESTINATION, Destination } from '@adtrackify/at-tracking-event-types';
-export interface GetDestinationsResponseData {
-    destinations: Destination[];
-    [key: string]: any;
-}
-export interface CreateDestinationResponseData {
-    destination: Destination;
-    [key: string]: any;
-}
-export interface DeleteDestinationResponseData {
-    destination: Destination;
-    [key: string]: any;
-}
-export declare class DestinationsClient {
-    BASE_API_URL: string;
-    DESTINATIONS_API_KEY: string;
-    client: GenericHttpClient;
-    SERVICE_API_ROOT_URL: string;
-    constructor(baseApiUrl: string, destinationsApiKey: string);
-    getHeaders: () => {
-        'x-api-key': string;
-    } | {
-        'x-api-key'?: undefined;
-    };
-    createDestination: (createDestinationRequest: any) => Promise<ApiResponse<CreateDestinationResponseData>>;
-    updateDestination: (destinationId: string, body: any) => Promise<ApiResponse<CreateDestinationResponseData>>;
-    getPixelDestinations: (pixelId: string) => Promise<ApiResponse<GetDestinationsResponseData>>;
-    getAllDestinationByDestinationType: (destinationType: DESTINATION_TYPE, start: string) => Promise<ApiResponse<GetDestinationsResponseData>>;
-    deleteDestination: (destinationId: string, accountId: string, pixelId: string) => Promise<ApiResponse<DeleteDestinationResponseData>>;
-    uninstallShopifyAppDestinationPrivate: (accountId: string, pixelId: string) => Promise<ApiResponse<DeleteDestinationResponseData>>;
-    getDestinationsByDestination: (destinationKey: DESTINATION) => Promise<ApiResponse<Destination[]>>;
-}
+import { ApiResponse } from '../../types/api-response.js';
+import { GenericHttpClient } from '../generic/http-client.js';
+import { DESTINATION_TYPE, DESTINATION, Destination } from '@adtrackify/at-tracking-event-types';
+export interface GetDestinationsResponseData {
+    destinations: Destination[];
+    [key: string]: any;
+}
+export interface CreateDestinationResponseData {
+    destination: Destination;
+    [key: string]: any;
+}
+export interface DeleteDestinationResponseData {
+    destination: Destination;
+    [key: string]: any;
+}
+export declare class DestinationsClient {
+    BASE_API_URL: string;
+    DESTINATIONS_API_KEY: string;
+    client: GenericHttpClient;
+    SERVICE_API_ROOT_URL: string;
+    constructor(baseApiUrl: string, destinationsApiKey: string);
+    getHeaders: () => {
+        'x-api-key': string;
+    } | {
+        'x-api-key'?: undefined;
+    };
+    createDestination: (createDestinationRequest: any) => Promise<ApiResponse<CreateDestinationResponseData>>;
+    updateDestination: (destinationId: string, body: any) => Promise<ApiResponse<CreateDestinationResponseData>>;
+    getPixelDestinations: (pixelId: string) => Promise<ApiResponse<GetDestinationsResponseData>>;
+    getAllDestinationByDestinationType: (destinationType: DESTINATION_TYPE, start: string) => Promise<ApiResponse<GetDestinationsResponseData>>;
+    deleteDestination: (destinationId: string, accountId: string, pixelId: string) => Promise<ApiResponse<DeleteDestinationResponseData>>;
+    uninstallShopifyAppDestinationPrivate: (accountId: string, pixelId: string) => Promise<ApiResponse<DeleteDestinationResponseData>>;
+    getDestinationsByDestination: (destinationKey: DESTINATION) => Promise<ApiResponse<Destination[]>>;
+}

package/dist/cjs/clients/internal-api/destinations-client.js

@@ -1,80 +1,80 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DestinationsClient = void 0;
-const index_js_1 = require("../../index.js");
-const http_client_js_1 = require("../generic/http-client.js");
-const client = (0, http_client_js_1.axiosHttpService)({
-    headers: {
-        'Content-Type': 'application/json',
-    },
-});
-class DestinationsClient {
-    BASE_API_URL;
-    DESTINATIONS_API_KEY;
-    client;
-    SERVICE_API_ROOT_URL;
-    constructor(baseApiUrl, destinationsApiKey) {
-        this.BASE_API_URL = baseApiUrl;
-        this.DESTINATIONS_API_KEY = destinationsApiKey;
-        this.SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/destinations`;
-        this.client = client;
-    }
-    getHeaders = () => {
-        if (this.DESTINATIONS_API_KEY) {
-            return {
-                'x-api-key': this.DESTINATIONS_API_KEY,
-            };
-        }
-        return {};
-    };
-    createDestination = async (createDestinationRequest) => {
-        const response = await client.post(`${this.SERVICE_API_ROOT_URL}/admin`, createDestinationRequest, {
-            headers: this.getHeaders(),
-        });
-        index_js_1.Logger.debug('createDestinationResponse', { response });
-        return response;
-    };
-    updateDestination = async (destinationId, body) => {
-        const response = await client.patch(`${this.SERVICE_API_ROOT_URL}/${destinationId}/private`, body, {
-            headers: this.getHeaders(),
-        });
-        index_js_1.Logger.debug('updateDestinationResponse', { response });
-        return response;
-    };
-    getPixelDestinations = async (pixelId) => {
-        const response = await client.get(`${this.SERVICE_API_ROOT_URL}?pixelId=${pixelId}`, {
-            headers: this.getHeaders(),
-        });
-        index_js_1.Logger.debug('getPixelResponse', { response });
-        return response;
-    };
-    getAllDestinationByDestinationType = async (destinationType, start) => {
-        const response = await client.get(`${this.SERVICE_API_ROOT_URL}/list?destinationType=${destinationType}&start=${start}`, { headers: this.getHeaders() });
-        index_js_1.Logger.debug('getAllDestinationByDestinationType', { response });
-        return response;
-    };
-    deleteDestination = async (destinationId, accountId, pixelId) => {
-        const response = await client.delete(`${this.SERVICE_API_ROOT_URL}/${destinationId}/private`, {
-            headers: this.getHeaders(),
-            data: { id: destinationId, accountId, pixelId },
-        });
-        index_js_1.Logger.debug('deleteDestinationResponse', { response });
-        return response;
-    };
-    uninstallShopifyAppDestinationPrivate = async (accountId, pixelId) => {
-        const response = await client.post(`${this.SERVICE_API_ROOT_URL}/shopify-app/uninstall/private`, { accountId, pixelId }, {
-            headers: this.getHeaders(),
-        });
-        index_js_1.Logger.debug('uninstallShopifyAppDestinationPrivateResponse', { response });
-        return response;
-    };
-    getDestinationsByDestination = async (destinationKey) => {
-        const response = await client.get(`${this.SERVICE_API_ROOT_URL}/by-destination?destination=${destinationKey}`, {
-            headers: this.getHeaders(),
-        });
-        index_js_1.Logger.debug('getDestinationsByDestination', { response, destinationKey });
-        return response;
-    };
-}
-exports.DestinationsClient = DestinationsClient;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DestinationsClient = void 0;
+const index_js_1 = require("../../index.js");
+const http_client_js_1 = require("../generic/http-client.js");
+const client = (0, http_client_js_1.axiosHttpService)({
+    headers: {
+        'Content-Type': 'application/json',
+    },
+});
+class DestinationsClient {
+    BASE_API_URL;
+    DESTINATIONS_API_KEY;
+    client;
+    SERVICE_API_ROOT_URL;
+    constructor(baseApiUrl, destinationsApiKey) {
+        this.BASE_API_URL = baseApiUrl;
+        this.DESTINATIONS_API_KEY = destinationsApiKey;
+        this.SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/destinations`;
+        this.client = client;
+    }
+    getHeaders = () => {
+        if (this.DESTINATIONS_API_KEY) {
+            return {
+                'x-api-key': this.DESTINATIONS_API_KEY,
+            };
+        }
+        return {};
+    };
+    createDestination = async (createDestinationRequest) => {
+        const response = await client.post(`${this.SERVICE_API_ROOT_URL}/admin`, createDestinationRequest, {
+            headers: this.getHeaders(),
+        });
+        index_js_1.Logger.debug('createDestinationResponse', { response });
+        return response;
+    };
+    updateDestination = async (destinationId, body) => {
+        const response = await client.patch(`${this.SERVICE_API_ROOT_URL}/${destinationId}/private`, body, {
+            headers: this.getHeaders(),
+        });
+        index_js_1.Logger.debug('updateDestinationResponse', { response });
+        return response;
+    };
+    getPixelDestinations = async (pixelId) => {
+        const response = await client.get(`${this.SERVICE_API_ROOT_URL}?pixelId=${pixelId}`, {
+            headers: this.getHeaders(),
+        });
+        index_js_1.Logger.debug('getPixelResponse', { response });
+        return response;
+    };
+    getAllDestinationByDestinationType = async (destinationType, start) => {
+        const response = await client.get(`${this.SERVICE_API_ROOT_URL}/list?destinationType=${destinationType}&start=${start}`, { headers: this.getHeaders() });
+        index_js_1.Logger.debug('getAllDestinationByDestinationType', { response });
+        return response;
+    };
+    deleteDestination = async (destinationId, accountId, pixelId) => {
+        const response = await client.delete(`${this.SERVICE_API_ROOT_URL}/${destinationId}/private`, {
+            headers: this.getHeaders(),
+            data: { id: destinationId, accountId, pixelId },
+        });
+        index_js_1.Logger.debug('deleteDestinationResponse', { response });
+        return response;
+    };
+    uninstallShopifyAppDestinationPrivate = async (accountId, pixelId) => {
+        const response = await client.post(`${this.SERVICE_API_ROOT_URL}/shopify-app/uninstall/private`, { accountId, pixelId }, {
+            headers: this.getHeaders(),
+        });
+        index_js_1.Logger.debug('uninstallShopifyAppDestinationPrivateResponse', { response });
+        return response;
+    };
+    getDestinationsByDestination = async (destinationKey) => {
+        const response = await client.get(`${this.SERVICE_API_ROOT_URL}/by-destination?destination=${destinationKey}`, {
+            headers: this.getHeaders(),
+        });
+        index_js_1.Logger.debug('getDestinationsByDestination', { response, destinationKey });
+        return response;
+    };
+}
+exports.DestinationsClient = DestinationsClient;
 //# sourceMappingURL=destinations-client.js.map

package/dist/cjs/clients/internal-api/event-collector-client.d.ts

@@ -1,122 +1,122 @@
-import { TrackingEventData } from '@adtrackify/at-tracking-event-types';
-import { ApiResponse } from '../../types/api-response.js';
-export interface EventStatusResponseData {
-    found?: boolean;
-}
-export interface CreateServerEventAddress {
-    email?: string;
-    phone?: string;
-    firstName?: string;
-    lastName?: string;
-    company?: string;
-    address1?: string;
-    address2?: string;
-    city?: string;
-    province?: string;
-    provinceCode?: string;
-    country?: string;
-    countryCode?: string;
-    zip?: string;
-}
-export interface CreateServerEventUserProperties {
-    emails?: string[];
-    phones?: string[];
-    userIds?: string[];
-    genders?: string[];
-    dobs?: string[];
-    addresses?: CreateServerEventAddress[];
-    shopifyYIds?: string[];
-}
-export interface CreateServerEventPage {
-    host?: string;
-    path?: string;
-    referrer?: string;
-    search?: string;
-    title?: string;
-    url?: string;
-    qsp?: Record<string, unknown>;
-}
-export interface CreateServerEventCampaign {
-    name?: string;
-    campaign?: string;
-    source?: string;
-    medium?: string;
-    term?: string;
-    content?: string;
-}
-export interface CreateServerEventClick {
-    fbc?: string;
-    fbp?: string;
-    fbclid?: string;
-    gclid?: string;
-    gbraid?: string;
-    wbraid?: string;
-    ttclid?: string;
-    ttp?: string;
-    snapchatSCCid?: string;
-    snapchatSCCookie?: string;
-    pinterestEpik?: string;
-    liFatId?: string;
-    msclkid?: string;
-    kx?: string;
-    klaviyoCid?: string;
-    sendlaneCid?: string;
-    omnisendCid?: string;
-    redditCid?: string;
-    redditUuid?: string;
-    applovinAxwrt?: string;
-    aleid?: string;
-    tblci?: string;
-    obclid?: string;
-    nbclid?: string;
-}
-export interface CreateServerEventViewport {
-    viewportWidth?: number;
-    viewportHeight?: number;
-    pageHeight?: number;
-    devicePixelRatio?: number;
-}
-export interface CreateServerEvent {
-    name: string;
-    eventId?: string;
-    identityId?: string;
-    userProperties?: CreateServerEventUserProperties;
-    eventProperties?: TrackingEventData;
-    ipAddress?: string;
-    userAgent?: string;
-    sessionId?: string;
-    locale?: string;
-    timezone?: string;
-    page?: CreateServerEventPage;
-    campaign?: CreateServerEventCampaign;
-    click?: CreateServerEventClick;
-    viewport?: CreateServerEventViewport;
-}
-export interface CreateServerEventsParams {
-    baseApiUrl: string;
-    apiKey: string;
-    pixelId: string;
-    events: CreateServerEvent[];
-}
-export interface CreateServerEventsResult {
-    ok: boolean;
-    eventsIngested?: number;
-    errorMessage?: string;
-}
-export declare class EventCollectorClient {
-    BASE_API_URL: string;
-    EVENT_COLLECTOR_API_KEY: string;
-    client: any;
-    constructor(baseApiUrl: string, apiKey: string);
-    getConfig: () => {
-        baseURL: string;
-        headers: {
-            common: {
-                'x-api-key': string;
-            };
-        };
-    };
-    getClient: () => any;
-    getEventStatus: (pixelId: string, eventId: string) => Promise<ApiResponse<EventStatusResponseData>>;
-    createEvents: (params: CreateServerEventsParams) => Promise<CreateServerEventsResult>;
-}
+import { TrackingEventData } from '@adtrackify/at-tracking-event-types';
+import { ApiResponse } from '../../types/api-response.js';
+export interface EventStatusResponseData {
+    found?: boolean;
+}
+export interface CreateServerEventAddress {
+    email?: string;
+    phone?: string;
+    firstName?: string;
+    lastName?: string;
+    company?: string;
+    address1?: string;
+    address2?: string;
+    city?: string;
+    province?: string;
+    provinceCode?: string;
+    country?: string;
+    countryCode?: string;
+    zip?: string;
+}
+export interface CreateServerEventUserProperties {
+    emails?: string[];
+    phones?: string[];
+    userIds?: string[];
+    genders?: string[];
+    dobs?: string[];
+    addresses?: CreateServerEventAddress[];
+    shopifyYIds?: string[];
+}
+export interface CreateServerEventPage {
+    host?: string;
+    path?: string;
+    referrer?: string;
+    search?: string;
+    title?: string;
+    url?: string;
+    qsp?: Record<string, unknown>;
+}
+export interface CreateServerEventCampaign {
+    name?: string;
+    campaign?: string;
+    source?: string;
+    medium?: string;
+    term?: string;
+    content?: string;
+}
+export interface CreateServerEventClick {
+    fbc?: string;
+    fbp?: string;
+    fbclid?: string;
+    gclid?: string;
+    gbraid?: string;
+    wbraid?: string;
+    ttclid?: string;
+    ttp?: string;
+    snapchatSCCid?: string;
+    snapchatSCCookie?: string;
+    pinterestEpik?: string;
+    liFatId?: string;
+    msclkid?: string;
+    kx?: string;
+    klaviyoCid?: string;
+    sendlaneCid?: string;
+    omnisendCid?: string;
+    redditCid?: string;
+    redditUuid?: string;
+    applovinAxwrt?: string;
+    aleid?: string;
+    tblci?: string;
+    obclid?: string;
+    nbclid?: string;
+}
+export interface CreateServerEventViewport {
+    viewportWidth?: number;
+    viewportHeight?: number;
+    pageHeight?: number;
+    devicePixelRatio?: number;
+}
+export interface CreateServerEvent {
+    name: string;
+    eventId?: string;
+    identityId?: string;
+    userProperties?: CreateServerEventUserProperties;
+    eventProperties?: TrackingEventData;
+    ipAddress?: string;
+    userAgent?: string;
+    sessionId?: string;
+    locale?: string;
+    timezone?: string;
+    page?: CreateServerEventPage;
+    campaign?: CreateServerEventCampaign;
+    click?: CreateServerEventClick;
+    viewport?: CreateServerEventViewport;
+}
+export interface CreateServerEventsParams {
+    baseApiUrl: string;
+    apiKey: string;
+    pixelId: string;
+    events: CreateServerEvent[];
+}
+export interface CreateServerEventsResult {
+    ok: boolean;
+    eventsIngested?: number;
+    errorMessage?: string;
+}
+export declare class EventCollectorClient {
+    BASE_API_URL: string;
+    EVENT_COLLECTOR_API_KEY: string;
+    client: any;
+    constructor(baseApiUrl: string, apiKey: string);
+    getConfig: () => {
+        baseURL: string;
+        headers: {
+            common: {
+                'x-api-key': string;
+            };
+        };
+    };
+    getClient: () => any;
+    getEventStatus: (pixelId: string, eventId: string) => Promise<ApiResponse<EventStatusResponseData>>;
+    createEvents: (params: CreateServerEventsParams) => Promise<CreateServerEventsResult>;
+}

package/dist/cjs/clients/internal-api/event-collector-client.js

@@ -1,79 +1,79 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventCollectorClient = void 0;
-const logging_helper_js_1 = require("../../helpers/logging-helper.js");
-const index_js_1 = require("../generic/index.js");
-class EventCollectorClient {
-    BASE_API_URL;
-    EVENT_COLLECTOR_API_KEY;
-    client;
-    constructor(baseApiUrl, apiKey) {
-        this.BASE_API_URL = baseApiUrl;
-        this.EVENT_COLLECTOR_API_KEY = apiKey;
-    }
-    getConfig = () => {
-        const SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/tr`;
-        return {
-            baseURL: SERVICE_API_ROOT_URL,
-            headers: {
-                common: {
-                    'x-api-key': this.EVENT_COLLECTOR_API_KEY,
-                },
-            },
-        };
-    };
-    getClient = () => {
-        this.client = this.client ?? (0, index_js_1.axiosHttpService)(this.getConfig());
-        return this.client;
-    };
-    getEventStatus = async (pixelId, eventId) => {
-        const client = this.getClient();
-        const response = await client.get('/e', { params: { eid: eventId, pid: pixelId } });
-        logging_helper_js_1.Logger.debug('getEventStatus', { response });
-        return response;
-    };
-    createEvents = async (params) => {
-        const { baseApiUrl, apiKey, pixelId, events } = params;
-        const eventCount = events.length;
-        try {
-            const client = (0, index_js_1.axiosHttpService)({
-                baseURL: `${baseApiUrl}/tr`,
-                headers: {
-                    common: {
-                        'x-api-key': apiKey,
-                        'x-pixel-id': pixelId,
-                        'Content-Type': 'application/json',
-                    },
-                },
-                timeout: 5000,
-            });
-            const response = (await client.post('/api/events', { events }));
-            if (response.status < 200 || response.status >= 300) {
-                const errorMessage = response.data?.message ?? `HTTP ${response.status}`;
-                logging_helper_js_1.Logger.warn('EventCollectorClient.createEvents: non-success response', {
-                    pixelId,
-                    eventCount,
-                    status: response.status,
-                    errorMessage,
-                });
-                return { ok: false, errorMessage };
-            }
-            return {
-                ok: true,
-                eventsIngested: response.data?.eventsIngested,
-            };
-        }
-        catch (error) {
-            const errorMessage = error instanceof Error ? error.message : String(error);
-            logging_helper_js_1.Logger.warn('EventCollectorClient.createEvents: failed', {
-                error,
-                errorMessage,
-                pixelId,
-                eventCount,
-            });
-            return { ok: false, errorMessage };
-        }
-    };
-}
-exports.EventCollectorClient = EventCollectorClient;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventCollectorClient = void 0;
+const logging_helper_js_1 = require("../../helpers/logging-helper.js");
+const index_js_1 = require("../generic/index.js");
+class EventCollectorClient {
+    BASE_API_URL;
+    EVENT_COLLECTOR_API_KEY;
+    client;
+    constructor(baseApiUrl, apiKey) {
+        this.BASE_API_URL = baseApiUrl;
+        this.EVENT_COLLECTOR_API_KEY = apiKey;
+    }
+    getConfig = () => {
+        const SERVICE_API_ROOT_URL = `${this.BASE_API_URL}/tr`;
+        return {
+            baseURL: SERVICE_API_ROOT_URL,
+            headers: {
+                common: {
+                    'x-api-key': this.EVENT_COLLECTOR_API_KEY,
+                },
+            },
+        };
+    };
+    getClient = () => {
+        this.client = this.client ?? (0, index_js_1.axiosHttpService)(this.getConfig());
+        return this.client;
+    };
+    getEventStatus = async (pixelId, eventId) => {
+        const client = this.getClient();
+        const response = await client.get('/e', { params: { eid: eventId, pid: pixelId } });
+        logging_helper_js_1.Logger.debug('getEventStatus', { response });
+        return response;
+    };
+    createEvents = async (params) => {
+        const { baseApiUrl, apiKey, pixelId, events } = params;
+        const eventCount = events.length;
+        try {
+            const client = (0, index_js_1.axiosHttpService)({
+                baseURL: `${baseApiUrl}/tr`,
+                headers: {
+                    common: {
+                        'x-api-key': apiKey,
+                        'x-pixel-id': pixelId,
+                        'Content-Type': 'application/json',
+                    },
+                },
+                timeout: 5000,
+            });
+            const response = (await client.post('/api/events', { events }));
+            if (response.status < 200 || response.status >= 300) {
+                const errorMessage = response.data?.message ?? `HTTP ${response.status}`;
+                logging_helper_js_1.Logger.warn('EventCollectorClient.createEvents: non-success response', {
+                    pixelId,
+                    eventCount,
+                    status: response.status,
+                    errorMessage,
+                });
+                return { ok: false, errorMessage };
+            }
+            return {
+                ok: true,
+                eventsIngested: response.data?.eventsIngested,
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            logging_helper_js_1.Logger.warn('EventCollectorClient.createEvents: failed', {
+                error,
+                errorMessage,
+                pixelId,
+                eventCount,
+            });
+            return { ok: false, errorMessage };
+        }
+    };
+}
+exports.EventCollectorClient = EventCollectorClient;
 //# sourceMappingURL=event-collector-client.js.map