@vnejs/plugins.platform.metric 0.0.3 → 0.0.5

package/dist/index.d.ts

@@ -0,0 +1 @@
+import "@vnejs/plugins.platform.metric.contract";

package/dist/index.js

@@ -0,0 +1,5 @@
+import "@vnejs/plugins.platform.metric.contract";
+import { regPlugin } from "@vnejs/shared";
+import { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/plugins.platform.metric.contract";
+import { YaMetrika } from "./modules/yandex.js";
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS }, [YaMetrika]);

package/dist/modules/yandex.d.ts

@@ -0,0 +1,13 @@
+import { Module } from "@vnejs/module";
+import type { MetricPluginConstants, MetricPluginEvents, MetricPluginParams, MetricPluginSettings } from "../types.js";
+import type { MetricSavePayload, MetricStackPayload } from "../utils/metric.js";
+export declare class YaMetrika extends Module<MetricPluginEvents, MetricPluginConstants, MetricPluginSettings, MetricPluginParams> {
+    name: string;
+    subscribe: () => void;
+    init: () => void;
+    onStack: ({ action, label }?: MetricStackPayload) => void | undefined;
+    onSave: ({ key }?: MetricSavePayload) => void | undefined;
+    onLoad: ({ key }?: MetricSavePayload) => void | undefined;
+    onParams: (params: Record<string, unknown>) => void | undefined;
+    onReachGoal: (target: string) => void | undefined;
+}

package/dist/modules/yandex.js

@@ -0,0 +1,20 @@
+import { Module } from "@vnejs/module";
+import { initYandexMetrika } from "../utils/metric.js";
+export class YaMetrika extends Module {
+    name = "ya-metrika";
+    subscribe = () => {
+        if (!this.PARAMS.METRIC.YA_COUNTER_ID)
+            return;
+        this.on(this.EVENTS.STACK.EMIT, this.onStack);
+        this.on(this.EVENTS.SAVE.CREATE, this.onSave);
+        this.on(this.EVENTS.SAVE.LOAD, this.onLoad);
+        this.on(this.EVENTS.METRIC.METRIC_GOAL, this.onReachGoal);
+        this.on(this.EVENTS.METRIC.METRIC_PARAMS, this.onParams);
+    };
+    init = () => initYandexMetrika(this.PARAMS.METRIC.YA_COUNTER_ID);
+    onStack = ({ action, label } = {}) => this.onParams({ VNE_STACK: { action, label } });
+    onSave = ({ key } = {}) => this.onParams({ VNE_SAVE: { key } });
+    onLoad = ({ key } = {}) => this.onParams({ VNE_LOAD: { key } });
+    onParams = (params) => window.ym?.(this.PARAMS.METRIC.YA_COUNTER_ID, "params", params);
+    onReachGoal = (target) => window.ym?.(this.PARAMS.METRIC.YA_COUNTER_ID, "reachGoal", target);
+}

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as StackPluginName, SubscribeEvents as StackSubscribeEvents } from "@vnejs/plugins.core.stack.contract";
+import type { PluginName, Params, SubscribeEvents } from "@vnejs/plugins.platform.metric.contract";
+import type { PluginName as SavePluginName, SubscribeEvents as SaveSubscribeEvents } from "@vnejs/plugins.save.contract";
+export type MetricPluginEvents = VnePluginEventsMapRegistry & Record<PluginName, SubscribeEvents> & Record<StackPluginName, StackSubscribeEvents> & Record<SavePluginName, SaveSubscribeEvents>;
+export type MetricPluginConstants = VnePluginConstantsMapRegistry;
+export type MetricPluginSettings = VnePluginSettingsMapRegistry;
+export type MetricPluginParams = VnePluginParamsMapRegistry & Record<PluginName, Params>;

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/metric.d.ts

@@ -0,0 +1,18 @@
+export type MetricStackPayload = {
+    action?: string;
+    label?: string;
+};
+export type MetricSavePayload = {
+    key?: string;
+};
+export type YmFunction = ((counterId: number, method: string, ...args: unknown[]) => void) & {
+    a?: unknown[][];
+    l?: number;
+};
+export declare const YANDEX_METRIKA_INIT_OPTIONS: {
+    readonly defer: true;
+    readonly clickmap: true;
+    readonly trackLinks: true;
+    readonly accurateTrackBounce: true;
+};
+export declare const initYandexMetrika: (counterId: number) => void;

package/dist/utils/metric.js

@@ -0,0 +1,31 @@
+const TAG_SRC = "https://mc.yandex.ru/metrika/tag.js";
+export const YANDEX_METRIKA_INIT_OPTIONS = {
+    defer: true,
+    clickmap: true,
+    trackLinks: true,
+    accurateTrackBounce: true,
+};
+const ensureYmLoader = () => {
+    window.ym =
+        window.ym ||
+            function (...args) {
+                const ym = window.ym;
+                ym.a = ym.a || [];
+                ym.a.push(args);
+            };
+    if (Array.from(document.scripts).some((script) => script.src === TAG_SRC))
+        return;
+    window.ym.l = Date.now();
+    const script = document.createElement("script");
+    const firstScript = document.getElementsByTagName("script")[0];
+    script.async = true;
+    script.src = TAG_SRC;
+    firstScript?.parentNode?.insertBefore(script, firstScript);
+};
+export const initYandexMetrika = (counterId) => {
+    if (!counterId)
+        return;
+    ensureYmLoader();
+    window.ym?.(counterId, "init", YANDEX_METRIKA_INIT_OPTIONS);
+    window.ym?.(counterId, "hit", window.location.href);
+};

package/package.json

@@ -1,17 +1,44 @@
 {
   "name": "@vnejs/plugins.platform.metric",
-  "version": "0.0.3",
-  "main": "index.js",
+  "version": "0.0.5",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "tsconfig.json"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "npx @vnejs/monorepo package",
     "publish:major:plugin": "npm run publish:major",
     "publish:minor:plugin": "npm run publish:minor",
     "publish:patch:plugin": "npm run publish:patch",
-    "publish:major": "npm version major && npm publish --access public",
-    "publish:minor": "npm version minor && npm publish --access public",
-    "publish:patch": "npm version patch && npm publish --access public"
+    "publish:major": "npx @vnejs/monorepo publish major --access public",
+    "publish:minor": "npx @vnejs/monorepo publish minor --access public",
+    "publish:patch": "npx @vnejs/monorepo publish patch --access public"
   },
   "author": "",
   "license": "ISC",
-  "description": ""
+  "dependencies": {
+    "@vnejs/plugins.platform.metric.contract": "~0.0.1"
+  },
+  "peerDependencies": {
+    "@vnejs/module": "~0.0.1",
+    "@vnejs/plugins.core.stack.contract": "~0.0.1",
+    "@vnejs/plugins.save.contract": "~0.0.1",
+    "@vnejs/shared": "~0.0.9"
+  },
+  "devDependencies": {
+    "@vnejs/configs.ts-common": "~0.0.1"
+  }
 }

package/src/global.d.ts

@@ -0,0 +1,6 @@
+interface Window {
+  ym?: ((counterId: number, method: string, ...args: unknown[]) => void) & {
+    a?: unknown[][];
+    l?: number;
+  };
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import "@vnejs/plugins.platform.metric.contract";
+
+import { regPlugin } from "@vnejs/shared";
+import { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/plugins.platform.metric.contract";
+
+import { YaMetrika } from "./modules/yandex.js";
+
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS }, [YaMetrika]);

package/src/modules/yandex.ts

@@ -0,0 +1,30 @@
+import { Module } from "@vnejs/module";
+
+import type { MetricPluginConstants, MetricPluginEvents, MetricPluginParams, MetricPluginSettings } from "../types.js";
+import type { MetricSavePayload, MetricStackPayload } from "../utils/metric.js";
+import { initYandexMetrika } from "../utils/metric.js";
+
+export class YaMetrika extends Module<MetricPluginEvents, MetricPluginConstants, MetricPluginSettings, MetricPluginParams> {
+  name = "ya-metrika";
+
+  subscribe = () => {
+    if (!this.PARAMS.METRIC.YA_COUNTER_ID) return;
+
+    this.on(this.EVENTS.STACK.EMIT, this.onStack);
+
+    this.on(this.EVENTS.SAVE.CREATE, this.onSave);
+    this.on(this.EVENTS.SAVE.LOAD, this.onLoad);
+
+    this.on(this.EVENTS.METRIC.METRIC_GOAL, this.onReachGoal);
+    this.on(this.EVENTS.METRIC.METRIC_PARAMS, this.onParams);
+  };
+
+  init = () => initYandexMetrika(this.PARAMS.METRIC.YA_COUNTER_ID);
+
+  onStack = ({ action, label }: MetricStackPayload = {}) => this.onParams({ VNE_STACK: { action, label } });
+  onSave = ({ key }: MetricSavePayload = {}) => this.onParams({ VNE_SAVE: { key } });
+  onLoad = ({ key }: MetricSavePayload = {}) => this.onParams({ VNE_LOAD: { key } });
+
+  onParams = (params: Record<string, unknown>) => window.ym?.(this.PARAMS.METRIC.YA_COUNTER_ID, "params", params);
+  onReachGoal = (target: string) => window.ym?.(this.PARAMS.METRIC.YA_COUNTER_ID, "reachGoal", target);
+}

package/src/types.ts

@@ -0,0 +1,15 @@
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+import type { PluginName as StackPluginName, SubscribeEvents as StackSubscribeEvents } from "@vnejs/plugins.core.stack.contract";
+import type { PluginName, Params, SubscribeEvents } from "@vnejs/plugins.platform.metric.contract";
+import type { PluginName as SavePluginName, SubscribeEvents as SaveSubscribeEvents } from "@vnejs/plugins.save.contract";
+
+export type MetricPluginEvents = VnePluginEventsMapRegistry &
+  Record<PluginName, SubscribeEvents> &
+  Record<StackPluginName, StackSubscribeEvents> &
+  Record<SavePluginName, SaveSubscribeEvents>;
+
+export type MetricPluginConstants = VnePluginConstantsMapRegistry;
+
+export type MetricPluginSettings = VnePluginSettingsMapRegistry;
+
+export type MetricPluginParams = VnePluginParamsMapRegistry & Record<PluginName, Params>;

package/src/utils/metric.ts

@@ -0,0 +1,51 @@
+export type MetricStackPayload = {
+  action?: string;
+  label?: string;
+};
+
+export type MetricSavePayload = {
+  key?: string;
+};
+
+export type YmFunction = ((counterId: number, method: string, ...args: unknown[]) => void) & {
+  a?: unknown[][];
+  l?: number;
+};
+
+const TAG_SRC = "https://mc.yandex.ru/metrika/tag.js";
+
+export const YANDEX_METRIKA_INIT_OPTIONS = {
+  defer: true,
+  clickmap: true,
+  trackLinks: true,
+  accurateTrackBounce: true,
+} as const;
+
+const ensureYmLoader = () => {
+  window.ym =
+    window.ym ||
+    function (...args: unknown[]) {
+      const ym = window.ym as YmFunction;
+      ym.a = ym.a || [];
+      ym.a.push(args);
+    };
+
+  if (Array.from(document.scripts).some((script) => script.src === TAG_SRC)) return;
+
+  (window.ym as YmFunction).l = Date.now();
+
+  const script = document.createElement("script");
+  const firstScript = document.getElementsByTagName("script")[0];
+  script.async = true;
+  script.src = TAG_SRC;
+  firstScript?.parentNode?.insertBefore(script, firstScript);
+};
+
+export const initYandexMetrika = (counterId: number) => {
+  if (!counterId) return;
+
+  ensureYmLoader();
+
+  window.ym?.(counterId, "init", YANDEX_METRIKA_INIT_OPTIONS);
+  window.ym?.(counterId, "hit", window.location.href);
+};

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@vnejs/configs.ts-common/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"],
+  "exclude": ["dist", "node_modules"]
+}

package/const/events.js

@@ -1,4 +0,0 @@
-export const SUBSCRIBE_EVENTS = {
-  METRIC_GOAL: "vne.metric.goal",
-  METRIC_PARAMS: "vne.metric.params",
-};

package/const/params.js

@@ -1 +0,0 @@
-export const YA_COUNTER_ID = 0;

package/index.js

@@ -1,9 +0,0 @@
-import { regPlugin } from "@vnejs/shared";
-
-import * as constants from "./const/const";
-import { SUBSCRIBE_EVENTS } from "./const/events";
-import * as params from "./const/params";
-
-import { YaMetrika } from "./modules/yandex";
-
-regPlugin("METRIC", { constants, events: SUBSCRIBE_EVENTS, params }, [YaMetrika]);

package/modules/yandex.js

@@ -1,46 +0,0 @@
-import { Module } from "@vnejs/module";
-
-export class YaMetrika extends Module {
-  name = "ya-metrika";
-
-  subscribe = () => {
-    if (!this.PARAMS.METRIC.YA_COUNTER_ID) return;
-
-    this.on(this.EVENTS.STACK.EMIT, this.onStack);
-
-    this.on(this.EVENTS.SAVE.CREATE, this.onSave);
-    this.on(this.EVENTS.SAVE.LOAD, this.onLoad);
-
-    this.on(this.EVENTS.METRIC.METRIC_GOAL, this.onReachGoal);
-    this.on(this.EVENTS.METRIC.METRIC_PARAMS, this.onParams);
-  };
-  init = () =>
-    new Promise((resolve) => {
-      if (!this.PARAMS.METRIC.YA_COUNTER_ID) return resolve();
-
-      (function (m, e, t, r, i, k, a) {
-        m[i] =
-          m[i] ||
-          function () {
-            (m[i].a = m[i].a || []).push(arguments);
-          };
-        m[i].l = 1 * new Date();
-        for (var j = 0; j < document.scripts.length; j++) {
-          if (document.scripts[j].src === r) {
-            return;
-          }
-        }
-        (k = e.createElement(t)), (a = e.getElementsByTagName(t)[0]), (k.async = 1), (k.src = r), a.parentNode.insertBefore(k, a);
-      })(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
-
-      window.ym(this.PARAMS.METRIC.YA_COUNTER_ID, "init", { clickmap: true, trackLinks: true, accurateTrackBounce: true });
-      resolve();
-    });
-
-  onStack = ({ action, label }) => this.onParams({ VNE_STACK: { action, label } });
-  onSave = ({ key }) => this.onParams({ VNE_SAVE: { key } });
-  onLoad = ({ key }) => this.onParams({ VNE_LOAD: { key } });
-
-  onParams = (params) => window.ym(this.PARAMS.METRIC.YA_COUNTER_ID, "params", params);
-  onReachGoal = (target) => window.ym(this.PARAMS.METRIC.YA_COUNTER_ID, "reachGoal", target);
-}