@visitor-analytics-sdk/plugins 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,47 @@
+# @visitor-analytics-sdk/plugins
+
+Plugin manager for the visitor-analytics SDK — install/uninstall lifecycle, collector registration, and event bus integration.
+
+```bash
+npm install @visitor-analytics-sdk/plugins
+```
+
+## Usage
+
+```ts
+import { PluginManager } from "@visitor-analytics-sdk/plugins";
+import { EventBus } from "@visitor-analytics-sdk/utils";
+
+const eventBus = new EventBus();
+const pluginManager = new PluginManager(eventBus);
+```
+
+## Writing a plugin
+
+```ts
+import type { Plugin, PluginContext } from "@visitor-analytics-sdk/core";
+
+class MyPlugin implements Plugin {
+  readonly name = "my-plugin";
+  readonly version = "1.0.0";
+  readonly description = "Adds custom data to analytics";
+
+  install(ctx: PluginContext): void {
+    ctx.addCollector({
+      name: "my-collector",
+      category: "custom",
+      version: "1.0.0",
+      enabled: true,
+      collect: async () => ({ /* custom data */ }),
+    });
+  }
+
+  uninstall(ctx: PluginContext): void {
+    ctx.removeCollector("my-collector");
+  }
+}
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { EventBus, Plugin, PluginContext, Collector } from '@visitor-analytics-sdk/core';
+import { Plugin, PluginContext, Collector } from '@visitor-analytics-sdk/core';
+import { EventBus } from '@visitor-analytics-sdk/utils';
 
 declare class PluginManager {
     private readonly installedPlugins;

package/dist/index.js

@@ -62,7 +62,5 @@ function createPluginContext(addCollector, removeCollector, eventBus, getConfig)
     getConfig
   };
 }
-export {
-  PluginManager,
-  createPluginContext
-};
+
+export { PluginManager, createPluginContext };

package/package.json

@@ -1,10 +1,29 @@
 {
   "name": "@visitor-analytics-sdk/plugins",
-  "version": "1.0.0",
+  "description": "Plugin manager for the visitor-analytics SDK — install/uninstall lifecycle, collector registration, and event bus integration.",
+  "license": "MIT",
+  "keywords": [
+    "visitor-analytics",
+    "plugins",
+    "plugin-system",
+    "extensibility"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/instax-dutta/visitor-analytics.git"
+  },
+  "homepage": "https://github.com/instax-dutta/visitor-analytics#readme",
+  "bugs": {
+    "url": "https://github.com/instax-dutta/visitor-analytics/issues"
+  },
+  "version": "1.0.1",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -15,10 +34,11 @@
     "dist"
   ],
   "dependencies": {
-    "@visitor-analytics-sdk/core": "1.0.0"
+    "@visitor-analytics-sdk/utils": "1.0.1",
+    "@visitor-analytics-sdk/core": "1.0.1"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts",
+    "build": "tsup src/index.ts --format esm --dts --treeshake",
     "typecheck": "tsc --noEmit"
   }
 }