@macroui/event-tracker 1.3.0

package/dist/types.test-d.ts

@@ -0,0 +1,103 @@
+/**
+ * 公共 API 类型测试（tsd）
+ * 验证公开类型签名稳定
+ */
+
+import { expectType, expectAssignable, expectNotAssignable } from 'tsd';
+import { EventTracker } from './types/index.js';
+import type { TrackerConfig, EventData, Callback, SendType, StorageType, ServerURL, StageName, HookName, Plugin, InstallContext, StageInterceptor, Lifecycle, SDKError } from './types/index.js';
+import type { SignedIdentity } from './types/core/signed-identity.js';
+
+// ============ EventTracker ============
+expectType<EventTracker>(new EventTracker());
+expectAssignable<{ track: Function }>(new EventTracker());
+expectNotAssignable<EventTracker>({});
+
+// ============ TrackerConfig ============
+const cfg: TrackerConfig = {
+  app_id: 'demo',
+  server_url: 'https://api.test/sa',
+  send_type: 'image',
+  storage_type: 'memory',
+  debug: 1,
+};
+expectAssignable<TrackerConfig>(cfg);
+expectAssignable<TrackerConfig>({ app_id: 'a', server_url: 'https://x' });
+
+const single: ServerURL = 'https://api.test';
+const multi: ServerURL = ['https://a.test', 'https://b.test'];
+expectAssignable<ServerURL>(single);
+expectAssignable<ServerURL>(multi);
+
+// ============ EventData ============
+const ev: EventData = {
+  type: 'track',
+  event: 'demo',
+  time: Date.now(),
+  distinct_id: 'd',
+  properties: { x: 1 },
+};
+expectAssignable<EventData>(ev);
+expectAssignable<EventData>({
+  type: 'profile_set',
+  time: 1,
+  distinct_id: 'd',
+  properties: { name: 'Alice' },
+});
+
+// ============ Callback ============
+const cb: Callback = (err: Error | null) => { void err; };
+expectAssignable<Callback>(cb);
+
+// ============ SendType / StorageType ============
+const st: SendType = 'beacon';
+expectAssignable<SendType>(st);
+const sto: StorageType = 'localStorage';
+expectAssignable<StorageType>(sto);
+
+// ============ StageName / HookName ============
+expectAssignable<StageName>('buildDataStage');
+expectAssignable<StageName>('businessStage');
+expectAssignable<StageName>('sendDataStage');
+expectAssignable<HookName>('sdkReady');
+expectAssignable<HookName>('sdkAfterInitPara');
+
+// ============ Plugin / InstallContext ============
+const plugin: Plugin = {
+  name: 'demo',
+  install(ctx: InstallContext) {
+    expectAssignable<TrackerConfig>(ctx.config);
+    expectAssignable<EventTracker>(ctx.sdk);
+  },
+};
+expectAssignable<Plugin>(plugin);
+
+// ============ StageInterceptor ============
+const interceptor: StageInterceptor<unknown> = {
+  name: 'demo',
+  priority: 10,
+  entry(ctx: { data: unknown; meta: any; cancellationToken: any; owner?: unknown }) {
+    expectAssignable<unknown>(ctx.data);
+    return undefined;
+  },
+};
+expectAssignable<StageInterceptor<unknown>>(interceptor);
+
+// ============ Lifecycle（type-only） ============
+expectAssignable<Lifecycle>({} as Lifecycle);
+
+// ============ Errors ============
+expectAssignable<SDKError>({} as SDKError);
+
+// ============ SignedIdentity ============
+const si: SignedIdentity = {
+  sign: (v: string) => v,
+  verify: (v: string, sig: string) => v === sig,
+  encode: (v: string) => v,
+  decode: (v: string) => v,
+  signAsync: async (v: string) => v,
+  verifyAsync: async (v: string, s: string) => v === s,
+  encodeAsync: async (v: string) => v,
+  decodeAsync: async (v: string) => v,
+};
+expectAssignable<SignedIdentity>(si);

package/package.json

@@ -0,0 +1,218 @@
+{
+  "name": "@macroui/event-tracker",
+  "version": "1.3.0",
+  "description": "A self-developed web event tracking SDK, inspired by Sensors Analytics. Supports image/beacon/ajax/batch send, full auto-tracking, WebView bridge, and pluggable encryption.",
+  "keywords": [
+    "analytics",
+    "tracking",
+    "sdk",
+    "macroui",
+    "event",
+    "埋点"
+  ],
+  "author": "macroui",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/event-tracker.cjs",
+  "module": "./dist/event-tracker.mjs",
+  "browser": "./dist/event-tracker.min.js",
+  "types": "./dist/types/index.d.ts",
+  "tsd": {
+    "directory": "dist",
+    "files": [
+      "types.test-d.ts"
+    ],
+    "typings": [
+      "types/index.d.ts",
+      "core/errors.d.ts",
+      "core/lifecycle.d.ts",
+      "core/signed-identity.d.ts"
+    ]
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/event-tracker.mjs",
+      "require": "./dist/event-tracker.cjs",
+      "browser": "./dist/event-tracker.min.js",
+      "default": "./dist/event-tracker.cjs"
+    },
+    "./plugin/encrypt": {
+      "types": "./dist/types/plugin/encrypt.d.ts",
+      "import": "./dist/plugin/encrypt.mjs",
+      "require": "./dist/plugin/encrypt.cjs"
+    },
+    "./plugin/auto-track": {
+      "types": "./dist/types/plugin/auto-track.d.ts",
+      "import": "./dist/plugin/auto-track.mjs",
+      "require": "./dist/plugin/auto-track.cjs"
+    },
+    "./plugin/webview-bridge": {
+      "types": "./dist/types/plugin/webview-bridge.d.ts",
+      "import": "./dist/plugin/webview-bridge.mjs",
+      "require": "./dist/plugin/webview-bridge.cjs"
+    },
+    "./plugin/pageload": {
+      "types": "./dist/types/plugin/pageload.d.ts",
+      "import": "./dist/plugin/pageload.mjs",
+      "require": "./dist/plugin/pageload.cjs"
+    },
+    "./plugin/pageleave": {
+      "types": "./dist/types/plugin/pageleave.d.ts",
+      "import": "./dist/plugin/pageleave.mjs",
+      "require": "./dist/plugin/pageleave.cjs"
+    },
+    "./plugin/exposure": {
+      "types": "./dist/types/plugin/exposure.d.ts",
+      "import": "./dist/plugin/exposure.mjs",
+      "require": "./dist/plugin/exposure.cjs"
+    },
+    "./plugin/session-event": {
+      "types": "./dist/types/plugin/session-event.d.ts",
+      "import": "./dist/plugin/session-event.mjs",
+      "require": "./dist/plugin/session-event.cjs"
+    },
+    "./plugin/debug-sender": {
+      "types": "./dist/types/plugin/debug-sender.d.ts",
+      "import": "./dist/plugin/debug-sender.mjs",
+      "require": "./dist/plugin/debug-sender.cjs"
+    },
+    "./plugin/indexeddb-sender": {
+      "types": "./dist/types/plugin/indexeddb-sender.d.ts",
+      "import": "./dist/plugin/indexeddb-sender.mjs",
+      "require": "./dist/plugin/indexeddb-sender.cjs"
+    },
+    "./plugin/otel-bridge": {
+      "types": "./dist/types/plugin/otel-bridge.d.ts",
+      "import": "./dist/plugin/otel-bridge.mjs",
+      "require": "./dist/plugin/otel-bridge.cjs"
+    },
+    "./plugin/experiment": {
+      "types": "./dist/types/plugin/experiment.d.ts",
+      "import": "./dist/plugin/experiment.mjs",
+      "require": "./dist/plugin/experiment.cjs"
+    },
+    "./plugin/predictive-batcher": {
+      "types": "./dist/types/plugin/predictive-batcher.d.ts",
+      "import": "./dist/plugin/predictive-batcher.mjs",
+      "require": "./dist/plugin/predictive-batcher.cjs"
+    },
+    "./plugin/otel-exporter": {
+      "types": "./dist/types/plugin/otel-exporter.d.ts",
+      "import": "./dist/plugin/otel-exporter.mjs",
+      "require": "./dist/plugin/otel-exporter.cjs"
+    },
+    "./plugin/pii-detector": {
+      "types": "./dist/types/plugin/pii-detector.d.ts",
+      "import": "./dist/plugin/pii-detector.mjs",
+      "require": "./dist/plugin/pii-detector.cjs"
+    },
+    "./plugin/privacy": {
+      "types": "./dist/types/plugin/privacy.d.ts",
+      "import": "./dist/plugin/privacy.mjs",
+      "require": "./dist/plugin/privacy.cjs"
+    },
+    "./plugin/cross-domain": {
+      "types": "./dist/types/plugin/cross-domain.d.ts",
+      "import": "./dist/plugin/cross-domain.mjs",
+      "require": "./dist/plugin/cross-domain.cjs"
+    },
+    "./plugin/schema-registry": {
+      "types": "./dist/types/plugin/schema-registry.d.ts",
+      "import": "./dist/plugin/schema-registry.mjs",
+      "require": "./dist/plugin/schema-registry.cjs"
+    },
+    "./plugin/rate-limiter": {
+      "types": "./dist/types/plugin/rate-limiter.d.ts",
+      "import": "./dist/plugin/rate-limiter.mjs",
+      "require": "./dist/plugin/rate-limiter.cjs"
+    },
+    "./plugin/csp-compliant": {
+      "types": "./dist/types/plugin/csp-compliant.d.ts",
+      "import": "./dist/plugin/csp-compliant.mjs",
+      "require": "./dist/plugin/csp-compliant.cjs"
+    },
+    "./plugin/audience-sync": {
+      "types": "./dist/types/plugin/audience-sync.d.ts",
+      "import": "./dist/plugin/audience-sync.mjs",
+      "require": "./dist/plugin/audience-sync.cjs"
+    },
+    "./edge": {
+      "types": "./dist/types/edge/index.d.ts",
+      "import": "./dist/edge/index.mjs",
+      "require": "./dist/edge/index.cjs"
+    },
+    "./federation": {
+      "import": "./dist/federation.mjs",
+      "require": "./dist/federation.cjs"
+    },
+    "./stats": {
+      "types": "./dist/types/stats.d.ts",
+      "import": "./dist/stats.mjs",
+      "require": "./dist/stats.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "bin"
+  ],
+  "bin": {
+    "event-tracker": "./bin/event-tracker.mjs",
+    "event-tracker-suggest": "./bin/event-tracker-suggest.mjs"
+  },
+  "scripts": {
+    "build:js": "rollup -c rollup.config.mjs",
+    "build:dts": "tsc -p tsconfig.dts.json",
+    "build": "npm run build:js && npm run build:dts",
+    "dev": "rollup -c rollup.config.mjs -w",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:cov": "vitest run --coverage",
+    "test:bench": "vitest run test/bench.test.ts",
+    "test:types": "tsc -p tsconfig.dts.json && cp src/types.test-d.ts dist/types.test-d.ts && tsd",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint 'src/**/*.ts' 'test/**/*.ts'",
+    "lint:fix": "eslint 'src/**/*.ts' 'test/**/*.ts' --fix",
+    "format": "prettier --write 'src/**/*.{ts,md}' 'test/**/*.ts' '*.md'",
+    "format:check": "prettier --check 'src/**/*.{ts,md}' 'test/**/*.ts' '*.md'",
+    "typedoc": "typedoc --options typedoc.json",
+    "visualize": "ANALYZE=1 rollup -c rollup.config.mjs",
+    "prepare": "husky",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^21.2.0",
+    "@commitlint/config-conventional": "^21.2.0",
+    "@rollup/plugin-commonjs": "^28.0.1",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^12.1.1",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.1",
+    "@typescript-eslint/eslint-plugin": "^8.63.0",
+    "@typescript-eslint/parser": "^8.63.0",
+    "@vitest/coverage-v8": "^2.1.5",
+    "ajv": "^8.17.1",
+    "commitlint": "^19.8.1",
+    "eslint": "^9.39.4",
+    "fast-check": "^3.23.2",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^30.4.1",
+    "prettier": "^3.9.4",
+    "rollup": "^4.28.0",
+    "rollup-plugin-visualizer": "^5.13.1",
+    "ts-jest": "^29.2.5",
+    "tsd": "^0.31.2",
+    "tslib": "^2.8.1",
+    "typedoc": "^0.27.6",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.5"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "sideEffects": false
+}