Merge pull request #9 from hcodes/user_params

Add userParams method

Author: hcodes

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v2.0.0
+- Переименован метод `.userVars()` на `.params`.
+- Добавлен метод `.userParams()`.
+
 # v1.3.0
 Добавлен проброс размера окна браузера и прочие технические параметры.
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Denis Seleznev
+Copyright (c) 2021 Denis Seleznev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

dist/index.common.js

@@ -99,8 +99,8 @@ function sendData(counterId, queryParams) {
     }
 }
 
-function hitExt(params) {
-    var browserInfo = params.browserInfo, counterId = params.counterId, pageParams = params.pageParams, userVars = params.userVars;
+function hitExt(hitExtParams) {
+    var browserInfo = hitExtParams.browserInfo, counterId = hitExtParams.counterId, pageParams = hitExtParams.pageParams, params = hitExtParams.params;
     var data = {
         'browser-info': getBrowserInfo(browserInfo, pageParams.title),
         rn: getRandom(),
@@ -112,8 +112,8 @@ function hitExt(params) {
     if (pageParams.referrer) {
         data['page-ref'] = prepareUrl(pageParams.referrer);
     }
-    if (userVars) {
-        data['site-info'] = JSON.stringify(userVars);
+    if (params) {
+        data['site-info'] = JSON.stringify(params);
     }
     sendData(counterId, data);
 }
@@ -135,7 +135,7 @@ function hitExt(params) {
  *     myParam: 'value'
  * });
  */
-function hit(counterId, hitParams, userVars) {
+function hit(counterId, hitParams, params) {
     var referrer = hitParams && hitParams.referrer !== undefined ?
         hitParams.referrer :
         getReferrer();
@@ -153,7 +153,7 @@ function hit(counterId, hitParams, userVars) {
             title: title,
             url: url
         },
-        userVars: userVars
+        params: params
     });
 }
 /**
@@ -166,7 +166,7 @@ function hit(counterId, hitParams, userVars) {
  * @example
  * reachGoal('123456', 'goalName');
 */
-function reachGoal(counterId, name, userVars) {
+function reachGoal(counterId, name, params) {
     var referrer;
     var url;
     if (name) {
@@ -181,7 +181,7 @@ function reachGoal(counterId, name, userVars) {
         browserInfo: { ar: true },
         counterId: counterId,
         pageParams: { referrer: referrer, url: url },
-        userVars: userVars
+        params: params,
     });
 }
 /**
@@ -242,15 +242,36 @@ function file(counterId, file, title) {
  * @param data - Параметры визитов.
  *
  * @example
- * userVars('123456', { myParam: 'value' });
+ * params('123456', { myParam: 'value' });
+ */
+function params(counterId, data) {
+    if (data) {
+        hitExt({
+            browserInfo: { ar: true, pa: true },
+            counterId: counterId,
+            pageParams: {},
+            params: data
+        });
+    }
+}
+/**
+ * Параметры посетителей сайта.
+ *
+ * @param counterId - Номер счётчика.
+ * @param data - Параметры.
+ *
+ * @example
+ * userParams('123456', { myParam: 'value', UserID: 123 });
  */
-function userVars(counterId, data) {
+function userParams(counterId, data) {
     if (data) {
         hitExt({
             browserInfo: { ar: true, pa: true },
             counterId: counterId,
             pageParams: {},
-            userVars: data
+            params: {
+                __ymu: data,
+            }
         });
     }
 }
@@ -273,5 +294,6 @@ exports.file = file;
 exports.hit = hit;
 exports.hitExt = hitExt;
 exports.notBounce = notBounce;
+exports.params = params;
 exports.reachGoal = reachGoal;
-exports.userVars = userVars;
+exports.userParams = userParams;

dist/index.esm.js

@@ -95,8 +95,8 @@ function sendData(counterId, queryParams) {
     }
 }
 
-function hitExt(params) {
-    var browserInfo = params.browserInfo, counterId = params.counterId, pageParams = params.pageParams, userVars = params.userVars;
+function hitExt(hitExtParams) {
+    var browserInfo = hitExtParams.browserInfo, counterId = hitExtParams.counterId, pageParams = hitExtParams.pageParams, params = hitExtParams.params;
     var data = {
         'browser-info': getBrowserInfo(browserInfo, pageParams.title),
         rn: getRandom(),
@@ -108,8 +108,8 @@ function hitExt(params) {
     if (pageParams.referrer) {
         data['page-ref'] = prepareUrl(pageParams.referrer);
     }
-    if (userVars) {
-        data['site-info'] = JSON.stringify(userVars);
+    if (params) {
+        data['site-info'] = JSON.stringify(params);
     }
     sendData(counterId, data);
 }
@@ -131,7 +131,7 @@ function hitExt(params) {
  *     myParam: 'value'
  * });
  */
-function hit(counterId, hitParams, userVars) {
+function hit(counterId, hitParams, params) {
     var referrer = hitParams && hitParams.referrer !== undefined ?
         hitParams.referrer :
         getReferrer();
@@ -149,7 +149,7 @@ function hit(counterId, hitParams, userVars) {
             title: title,
             url: url
         },
-        userVars: userVars
+        params: params
     });
 }
 /**
@@ -162,7 +162,7 @@ function hit(counterId, hitParams, userVars) {
  * @example
  * reachGoal('123456', 'goalName');
 */
-function reachGoal(counterId, name, userVars) {
+function reachGoal(counterId, name, params) {
     var referrer;
     var url;
     if (name) {
@@ -177,7 +177,7 @@ function reachGoal(counterId, name, userVars) {
         browserInfo: { ar: true },
         counterId: counterId,
         pageParams: { referrer: referrer, url: url },
-        userVars: userVars
+        params: params,
     });
 }
 /**
@@ -238,15 +238,36 @@ function file(counterId, file, title) {
  * @param data - Параметры визитов.
  *
  * @example
- * userVars('123456', { myParam: 'value' });
+ * params('123456', { myParam: 'value' });
+ */
+function params(counterId, data) {
+    if (data) {
+        hitExt({
+            browserInfo: { ar: true, pa: true },
+            counterId: counterId,
+            pageParams: {},
+            params: data
+        });
+    }
+}
+/**
+ * Параметры посетителей сайта.
+ *
+ * @param counterId - Номер счётчика.
+ * @param data - Параметры.
+ *
+ * @example
+ * userParams('123456', { myParam: 'value', UserID: 123 });
  */
-function userVars(counterId, data) {
+function userParams(counterId, data) {
     if (data) {
         hitExt({
             browserInfo: { ar: true, pa: true },
             counterId: counterId,
             pageParams: {},
-            userVars: data
+            params: {
+                __ymu: data,
+            }
         });
     }
 }
@@ -264,4 +285,4 @@ function notBounce(counterId) {
     });
 }
 
-export { extLink, file, hit, hitExt, notBounce, reachGoal, userVars };
+export { extLink, file, hit, hitExt, notBounce, params, reachGoal, userParams };

manual-test/index.html

@@ -1 +1,9 @@
-<script src="./manual-test.js"></script>
+<html>
+<head>
+    <meta charset="utf-8" />
+    <title>Lyam test</title>
+</head>
+<body>
+    <script src="./manual-test.js"></script>
+</body>
+</html>

manual-test/manual-test.ts

@@ -1,4 +1,4 @@
-import { hit, reachGoal } from '../src/index';
+import { hit, reachGoal, params, extLink, userParams, file } from '../src/index';
 
 const counterId = '55669909';
 
@@ -9,3 +9,11 @@ hit(counterId, {
 }, { myHitParam: 456 });
 
 reachGoal(counterId, 'notificationClick', { myGoalParam: 123 });
+
+file(counterId, 'https://mysite.com/file.zip')
+
+extLink(counterId, 'https://yandex.ru');
+
+params(counterId, { myParam: 1});
+
+userParams(counterId, { myParam: 'value', UserID: 123 });