@vnejs/plugins.platform.metric 0.1.1 → 0.1.3

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/modules/yandex.d.ts

@@ -1,5 +1,5 @@
 import { ModuleCore } from "@vnejs/module.core";
-import type { StackEmitPayload } from "@vnejs/plugins.core.stack.contract";
+import type { StackEmitPayload } from "@vnejs/contracts.core.stack";
 import type { MetricPluginConstants, MetricPluginEvents, MetricPluginParams, MetricPluginSettings } from "../types.js";
 export declare class YaMetrika extends ModuleCore<MetricPluginEvents, MetricPluginConstants, MetricPluginSettings, MetricPluginParams> {
     name: string;

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import type { ModuleCoreConstants, ModuleCoreEvents, ModuleCoreParams, ModuleCoreSettings } from "@vnejs/module.core";
-import type { PluginName, Params, SubscribeEvents } from "@vnejs/plugins.platform.metric.contract";
+import type { PluginName, Params, SubscribeEvents } from "@vnejs/contracts.platform.metric";
 export type MetricPluginEvents = ModuleCoreEvents & Record<PluginName, SubscribeEvents>;
 export type MetricPluginConstants = ModuleCoreConstants;
 export type MetricPluginSettings = ModuleCoreSettings;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/plugins.platform.metric",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "tsconfig.json"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "npx @vnejs/monorepo test",
     "build": "npx @vnejs/monorepo package",
     "publish:major:plugin": "npm run publish:major",
     "publish:minor:plugin": "npm run publish:minor",
@@ -30,14 +30,17 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@vnejs/plugins.platform.metric.contract": "~0.1.0"
+    "@vnejs/contracts.platform.metric": "~0.1.0"
   },
   "peerDependencies": {
     "@vnejs/module.core": "~0.1.0",
-    "@vnejs/plugins.core.stack.contract": "~0.1.0",
+    "@vnejs/contracts.core.stack": "~0.1.0",
     "@vnejs/shared": "~0.1.0"
   },
   "devDependencies": {
-    "@vnejs/configs.ts-common": "~0.1.0"
+    "@vnejs/configs.ts-common": "~0.1.0",
+    "@vnejs/configs.vitest": "~0.1.0",
+    "@vnejs/contracts.core.stack": "~0.1.0",
+    "@vnejs/test-utils": "~0.1.0"
   }
 }

package/src/index.ts

@@ -1,7 +1,7 @@
-import "@vnejs/plugins.platform.metric.contract";
+import "@vnejs/contracts.platform.metric";
 
 import { regPlugin } from "@vnejs/shared";
-import { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/plugins.platform.metric.contract";
+import { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.platform.metric";
 
 import { YaMetrika } from "./modules/yandex.js";
 

package/src/modules/yandex.ts

@@ -1,5 +1,5 @@
 import { ModuleCore } from "@vnejs/module.core";
-import type { StackEmitPayload } from "@vnejs/plugins.core.stack.contract";
+import type { StackEmitPayload } from "@vnejs/contracts.core.stack";
 
 import type { MetricPluginConstants, MetricPluginEvents, MetricPluginParams, MetricPluginSettings } from "../types.js";
 import { initYandexMetrika } from "../utils/metric.js";

package/src/tests/setup.ts

@@ -0,0 +1,22 @@
+import { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.platform.metric";
+import { createTestModule as baseCreateTestModule, registerCoreVne, registerVnePlugin, stubSilentEvent } from "@vnejs/test-utils";
+
+export const METRIC_COUNTER_ID = 123456;
+
+export const registerMetricPluginVne = (counterId = METRIC_COUNTER_ID) => {
+  registerCoreVne();
+  registerVnePlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: { ...PARAMS, YA_COUNTER_ID: counterId } });
+};
+
+export const createMetricTestModule = <T extends Parameters<typeof baseCreateTestModule>[0]>(
+  ModuleClass: T,
+  options: Parameters<typeof baseCreateTestModule>[1] = {},
+) => {
+  const result = baseCreateTestModule(ModuleClass, options);
+
+  stubSilentEvent(result.observer, SUBSCRIBE_EVENTS.GOAL);
+
+  return result;
+};
+
+export { SUBSCRIBE_EVENTS, PLUGIN_NAME, PARAMS };

package/src/tests/yandex.test.ts

@@ -0,0 +1,64 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+import { SUBSCRIBE_EVENTS as STACK_EVENTS } from "@vnejs/contracts.core.stack";
+
+import { YaMetrika } from "../modules/yandex.js";
+import { createMetricTestModule, METRIC_COUNTER_ID, registerMetricPluginVne, SUBSCRIBE_EVENTS } from "./setup.js";
+
+vi.mock("../utils/metric.js", () => ({
+  initYandexMetrika: vi.fn(),
+}));
+
+describe("YaMetrika", () => {
+  const ym = vi.fn();
+
+  beforeEach(() => {
+    registerMetricPluginVne();
+    window.ym = ym;
+    ym.mockClear();
+  });
+
+  it("init initializes yandex metrika when counter id is configured", async () => {
+    const { module } = createMetricTestModule(YaMetrika);
+    const { initYandexMetrika } = await import("../utils/metric.js");
+
+    await (module as YaMetrika).init();
+
+    expect(initYandexMetrika).toHaveBeenCalledExactlyOnceWith(METRIC_COUNTER_ID);
+  });
+
+  it("GOAL sends reachGoal to ym", async () => {
+    const { observer } = createMetricTestModule(YaMetrika);
+
+    await observer.emit(SUBSCRIBE_EVENTS.GOAL, "purchase");
+
+    expect(ym).toHaveBeenCalledExactlyOnceWith(METRIC_COUNTER_ID, "reachGoal", "purchase");
+  });
+
+  it("PARAMS sends params to ym", async () => {
+    const { observer } = createMetricTestModule(YaMetrika);
+
+    await observer.emit(SUBSCRIBE_EVENTS.PARAMS, { chapter: 1 });
+
+    expect(ym).toHaveBeenCalledExactlyOnceWith(METRIC_COUNTER_ID, "params", { chapter: 1 });
+  });
+
+  it("STACK.EMIT forwards stack label and args as metric params", async () => {
+    const { observer } = createMetricTestModule(YaMetrika);
+
+    await observer.emit(STACK_EVENTS.EMIT, { label: "main", args: { step: 2 } });
+
+    expect(ym).toHaveBeenCalledExactlyOnceWith(METRIC_COUNTER_ID, "params", { VNE_STACK: { label: "main", args: { step: 2 } } });
+  });
+
+  it("does not subscribe when counter id is missing", async () => {
+    registerMetricPluginVne(0);
+
+    const { observer } = createMetricTestModule(YaMetrika);
+
+    await observer.emit(SUBSCRIBE_EVENTS.GOAL, "purchase");
+    await observer.emit(STACK_EVENTS.EMIT, { label: "main" });
+
+    expect(ym).not.toHaveBeenCalled();
+  });
+});

package/src/types.ts

@@ -1,5 +1,5 @@
 import type { ModuleCoreConstants, ModuleCoreEvents, ModuleCoreParams, ModuleCoreSettings } from "@vnejs/module.core";
-import type { PluginName, Params, SubscribeEvents } from "@vnejs/plugins.platform.metric.contract";
+import type { PluginName, Params, SubscribeEvents } from "@vnejs/contracts.platform.metric";
 
 export type MetricPluginEvents = ModuleCoreEvents & Record<PluginName, SubscribeEvents>;
 

package/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "dist"
   },
   "include": ["src/**/*.ts", "src/**/*.d.ts"],
-  "exclude": ["dist", "node_modules"]
+  "exclude": ["dist", "node_modules", "src/tests"]
 }