@alexsab-ru/scripts 0.14.0 → 0.15.0

package/lib/campaign/persist-campaign-data.js

@@ -0,0 +1,162 @@
+import { getCookie, setCookie } from '../cookie';
+
+/**
+ * Persist Campaign Data - сохраняет данные кампании в cookies и/или dataLayer
+ * @param {Object} options - Настройки функции
+ * @param {boolean} options.storeInCookie - Сохранять ли данные в cookies
+ * @param {boolean} options.pushToDataLayer - Отправлять ли данные в dataLayer
+ * @param {string[]} options.triggerParameters - Параметры URL, которые триггерят сохранение
+ * @param {string} options.urlCookieName - Имя cookie для URL кампании
+ * @param {string} options.referrerCookieName - Имя cookie для referrer
+ * @param {string} options.dataLayerName - Имя массива dataLayer
+ * @param {string} options.dataLayerKey - Ключ в dataLayer для оригинального URL
+ * @param {number} options.cookieExpireDays - Дни жизни cookie (по умолчанию session cookie)
+ * @returns {boolean} - true если операция прошла успешно
+ */
+export function persistCampaignData(options = {}) {
+    const defaultOptions = {
+        storeInCookie: true,
+        pushToDataLayer: true,
+        triggerParameters: ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'utm_id', 'gclid', 'yclid', 'ysclid'],
+        urlCookieName: '__gtm_campaign_url',
+        referrerCookieName: '__gtm_referrer',
+        dataLayerName: 'dataLayer',
+        dataLayerKey: 'originalLocation',
+        cookieExpireDays: null // session cookie by default
+    };
+
+    const config = { ...defaultOptions, ...options };
+    let success = true;
+
+    try {
+        // Получаем текущий URL и его параметры
+        const currentUrl = window.location.href;
+        const urlParams = new URLSearchParams(window.location.search);
+        const currentHost = window.location.hostname;
+        const referrer = document.referrer;
+
+        if (config.storeInCookie) {
+            // Проверяем, есть ли в URL параметры кампании
+            const hasCampaignParams = config.triggerParameters.some(param => 
+                urlParams.has(param)
+            );
+
+            if (hasCampaignParams) {
+                // Сохраняем URL с параметрами кампании
+                const cookieOptions = {};
+                if (config.cookieExpireDays) {
+                    cookieOptions.expires = config.cookieExpireDays * 24 * 60 * 60; // в секундах
+                }
+                
+                setCookie(config.urlCookieName, currentUrl, cookieOptions);
+            }
+
+            // Проверяем referrer - если домен отличается, сохраняем его
+            if (referrer) {
+                try {
+                    const referrerUrl = new URL(referrer);
+                    const referrerHost = referrerUrl.hostname;
+                    
+                    if (referrerHost !== currentHost && !referrerHost.includes(currentHost)) {
+                        const cookieOptions = {};
+                        if (config.cookieExpireDays) {
+                            cookieOptions.expires = config.cookieExpireDays * 24 * 60 * 60;
+                        }
+                        
+                        setCookie(config.referrerCookieName, referrer, cookieOptions);
+                    }
+                } catch (e) {
+                    console.warn('Invalid referrer URL:', referrer);
+                }
+            }
+        }
+
+        if (config.pushToDataLayer) {
+            // Отправляем оригинальный URL в dataLayer
+            if (typeof window !== 'undefined') {
+                // Создаем dataLayer если его нет
+                window[config.dataLayerName] = window[config.dataLayerName] || [];
+                
+                const dataLayerEvent = {
+                    event: 'originalLocation',
+                    [config.dataLayerKey]: currentUrl
+                };
+
+                window[config.dataLayerName].push(dataLayerEvent);
+            }
+        }
+
+    } catch (error) {
+        console.error('Error in persistCampaignData:', error);
+        success = false;
+    }
+
+    return success;
+}
+
+/**
+ * Получает сохраненные данные кампании из cookies
+ * @param {Object} options - Настройки
+ * @param {string} options.urlCookieName - Имя cookie для URL кампании
+ * @param {string} options.referrerCookieName - Имя cookie для referrer
+ * @returns {Object} - Объект с данными кампании
+ */
+export function getCampaignData(options = {}) {
+    const config = {
+        urlCookieName: '__gtm_campaign_url',
+        referrerCookieName: '__gtm_referrer',
+        ...options
+    };
+
+    return {
+        campaignUrl: getCookie(config.urlCookieName),
+        referrer: getCookie(config.referrerCookieName)
+    };
+}
+
+/**
+ * Извлекает UTM параметры из URL или сохраненных данных кампании
+ * @param {string} url - URL для анализа (по умолчанию текущий URL)
+ * @returns {Object} - Объект с UTM параметрами
+ */
+export function extractUtmParameters(url = null) {
+    const targetUrl = url || window.location.href;
+    const urlObj = new URL(targetUrl);
+    const params = urlObj.searchParams;
+
+    return {
+        utm_source: params.get('utm_source'),
+        utm_medium: params.get('utm_medium'),
+        utm_campaign: params.get('utm_campaign'),
+        utm_term: params.get('utm_term'),
+        utm_content: params.get('utm_content'),
+        utm_id: params.get('utm_id'),
+        gclid: params.get('gclid'),
+        yclid: params.get('yclid'),
+        ysclid: params.get('ysclid')
+    };
+}
+
+/**
+ * Автоматическая инициализация при загрузке страницы
+ * @param {Object} options - Настройки для persistCampaignData
+ */
+export function initPersistCampaignData(options = {}) {
+    if (typeof window !== 'undefined') {
+        if (document.readyState === 'loading') {
+            document.addEventListener('DOMContentLoaded', () => {
+                persistCampaignData(options);
+            });
+        } else {
+            persistCampaignData(options);
+        }
+    }
+}
+
+// Экспорт по умолчанию для удобства
+export default {
+    persistCampaignData,
+    getCampaignData,
+    extractUtmParameters,
+    initPersistCampaignData
+};

package/lib/campaign/types.d.ts

@@ -0,0 +1,290 @@
+// TypeScript определения для persist-campaign-data
+
+/**
+ * Настройки для функции persistCampaignData
+ */
+export interface PersistCampaignDataOptions {
+    /**
+     * Сохранять ли данные в cookies браузера
+     * @default true
+     */
+    storeInCookie?: boolean;
+
+    /**
+     * Отправлять ли данные в dataLayer
+     * @default true
+     */
+    pushToDataLayer?: boolean;
+
+    /**
+     * Параметры URL, которые триггерят сохранение данных кампании
+     * @default ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'utm_id', 'gclid', 'yclid', 'ysclid']
+     */
+    triggerParameters?: string[];
+
+    /**
+     * Имя cookie для сохранения URL кампании
+     * @default '__gtm_campaign_url'
+     */
+    urlCookieName?: string;
+
+    /**
+     * Имя cookie для сохранения referrer
+     * @default '__gtm_referrer'
+     */
+    referrerCookieName?: string;
+
+    /**
+     * Имя массива dataLayer
+     * @default 'dataLayer'
+     */
+    dataLayerName?: string;
+
+    /**
+     * Ключ в dataLayer для оригинального URL
+     * @default 'originalLocation'
+     */
+    dataLayerKey?: string;
+
+    /**
+     * Количество дней жизни cookie. Если null - session cookie
+     * @default null
+     */
+    cookieExpireDays?: number | null;
+}
+
+/**
+ * Настройки для функции getCampaignData
+ */
+export interface GetCampaignDataOptions {
+    /**
+     * Имя cookie для URL кампании
+     * @default '__gtm_campaign_url'
+     */
+    urlCookieName?: string;
+
+    /**
+     * Имя cookie для referrer
+     * @default '__gtm_referrer'
+     */
+    referrerCookieName?: string;
+}
+
+/**
+ * Результат функции getCampaignData
+ */
+export interface CampaignData {
+    /**
+     * URL кампании из cookie
+     */
+    campaignUrl?: string;
+
+    /**
+     * Referrer из cookie
+     */
+    referrer?: string;
+}
+
+/**
+ * UTM параметры извлеченные из URL
+ */
+export interface UtmParameters {
+    /**
+     * Источник трафика
+     */
+    utm_source: string | null;
+
+    /**
+     * Канал/медиум
+     */
+    utm_medium: string | null;
+
+    /**
+     * Название кампании
+     */
+    utm_campaign: string | null;
+
+    /**
+     * Ключевое слово
+     */
+    utm_term: string | null;
+
+    /**
+     * Контент/вариация
+     */
+    utm_content: string | null;
+
+    /**
+     * ID кампании
+     */
+    utm_id: string | null;
+
+    /**
+     * Google Click ID
+     */
+    gclid: string | null;
+
+    /**
+     * Yandex Click ID
+     */
+    yclid: string | null;
+
+    /**
+     * Yandex Search Click ID
+     */
+    ysclid: string | null;
+}
+
+/**
+ * Событие dataLayer для оригинального URL
+ */
+export interface OriginalLocationEvent {
+    /**
+     * Название события
+     */
+    event: 'originalLocation';
+
+    /**
+     * Оригинальный URL страницы
+     */
+    [key: string]: string;
+}
+
+/**
+ * Расширение глобального объекта Window для dataLayer
+ */
+declare global {
+    interface Window {
+        /**
+         * Массив dataLayer для Google Tag Manager
+         */
+        dataLayer?: any[];
+
+        /**
+         * Флаг для предотвращения повторной инициализации в SPA
+         */
+        campaignDataPersisted?: boolean;
+
+        /**
+         * Кастомный dataLayer с произвольным именем
+         */
+        [key: string]: any;
+    }
+}
+
+/**
+ * Сохраняет данные рекламной кампании в cookies и/или dataLayer
+ * @param options - Настройки функции
+ * @returns true если операция прошла успешно, false в случае ошибки
+ */
+export function persistCampaignData(options?: PersistCampaignDataOptions): boolean;
+
+/**
+ * Получает сохраненные данные кампании из cookies
+ * @param options - Настройки для получения данных
+ * @returns Объект с данными кампании из cookies
+ */
+export function getCampaignData(options?: GetCampaignDataOptions): CampaignData;
+
+/**
+ * Извлекает UTM параметры из URL
+ * @param url - URL для анализа. Если не указан, используется текущий URL
+ * @returns Объект с UTM параметрами
+ */
+export function extractUtmParameters(url?: string): UtmParameters;
+
+/**
+ * Автоматическая инициализация при загрузке страницы
+ * Выполняет persistCampaignData когда DOM готов
+ * @param options - Настройки для persistCampaignData
+ */
+export function initPersistCampaignData(options?: PersistCampaignDataOptions): void;
+
+/**
+ * Объект с экспортированными функциями по умолчанию
+ */
+declare const _default: {
+    persistCampaignData: typeof persistCampaignData;
+    getCampaignData: typeof getCampaignData;
+    extractUtmParameters: typeof extractUtmParameters;
+    initPersistCampaignData: typeof initPersistCampaignData;
+};
+
+export default _default;
+
+/**
+ * Типы для интеграции с популярными фреймворками
+ */
+
+/**
+ * React Hook для использования persist campaign data
+ */
+export interface UsePersistCampaignData {
+    /**
+     * Данные кампании из cookies
+     */
+    campaignData: CampaignData;
+
+    /**
+     * UTM параметры из текущего URL
+     */
+    utmParameters: UtmParameters;
+
+    /**
+     * Функция для принудительного обновления данных
+     */
+    refresh: () => void;
+
+    /**
+     * Статус инициализации
+     */
+    isInitialized: boolean;
+}
+
+/**
+ * Vue.js композабл для persist campaign data
+ */
+export interface VuePersistCampaignData {
+    /**
+     * Реактивные данные кампании
+     */
+    campaignData: Ref<CampaignData>;
+
+    /**
+     * Реактивные UTM параметры
+     */
+    utmParameters: Ref<UtmParameters>;
+
+    /**
+     * Функция инициализации
+     */
+    init: (options?: PersistCampaignDataOptions) => void;
+
+    /**
+     * Статус готовности
+     */
+    isReady: Ref<boolean>;
+}
+
+/**
+ * Next.js типы для серверного рендеринга
+ */
+export interface NextJsPersistCampaignData {
+    /**
+     * Серверные props с данными кампании
+     */
+    campaignData?: CampaignData;
+
+    /**
+     * UTM параметры из серверного запроса
+     */
+    utmParameters?: UtmParameters;
+}
+
+// Для совместимости с CommonJS
+export = {
+    persistCampaignData,
+    getCampaignData,
+    extractUtmParameters,
+    initPersistCampaignData
+};

package/lib/nobounce/index.js

@@ -0,0 +1,5 @@
+// NoBounce module exports
+export * from './nobounce';
+
+// Re-export default
+export { default } from './nobounce';