@mcp-fe/react-event-tracker 0.0.14 → 0.0.16

package/LICENSE

@@ -0,0 +1,203 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (which shall not include communications that are solely about
+      and bear an appropriate legal notice).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based upon (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control
+      systems, and issue tracking systems that are managed by, or on behalf
+      of, the Licensor for the purpose of discussing and improving the Work,
+      but excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to use, reproduce, modify, merge, publish,
+      distribute, sublicense, and/or sell copies of the Work, and to
+      permit persons to whom the Work is furnished to do so, subject to
+      the following conditions:
+
+      The above copyright notice and this permission notice shall be
+      included in all copies or substantial portions of the Work.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright notice to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. You may choose to offer, and to
+      charge a fee for, warranty, support, indemnity or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may act only on Your own behalf and on
+      Your sole responsibility, not on behalf of any other Contributor, and
+      only if You agree to indemnify, defend, and hold each Contributor
+      harmless for any liability incurred by, or claims asserted against,
+      such Contributor by reason of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same page as the copyright notice for easier identification within
+      third-party archives.
+
+   Copyright 2026 [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,7 +1,300 @@
-# react-event-tracker
+# @mcp-fe/react-event-tracker
 
-This library was generated with [Nx](https://nx.dev).
+React integration for the MCP-FE (Model Context Protocol - Frontend Edge) ecosystem. This library provides React hooks that automatically track user interactions and navigation events, making them available to AI agents through the MCP protocol.
 
-## Running unit tests
+## Overview
+
+`@mcp-fe/react-event-tracker` is a React-specific integration layer that simplifies the process of tracking user interactions in React applications. It works in conjunction with [`@mcp-fe/mcp-worker`](../mcp-worker/README.md) to provide a complete MCP-FE solution for React apps.
+
+### Key Features
+
+- **Automatic Navigation Tracking**: Tracks route changes in React Router and TanStack Router applications
+- **User Interaction Tracking**: Automatically tracks clicks, input changes, and other user interactions
+- **Zero Configuration**: Works out-of-the-box with minimal setup
+- **Authentication Support**: Built-in support for setting authentication tokens
+- **Framework Agnostic Core**: Built on top of [`@mcp-fe/event-tracker`](../event-tracker/README.md)
+
+## Installation
+
+```bash
+npm install @mcp-fe/react-event-tracker @mcp-fe/mcp-worker
+# or
+pnpm add @mcp-fe/react-event-tracker @mcp-fe/mcp-worker
+# or
+yarn add @mcp-fe/react-event-tracker @mcp-fe/mcp-worker
+```
+
+### Peer Dependencies
+
+This package requires the following peer dependencies:
+
+- React >=19.0.0
+- React DOM >=19.0.0
+- React Router DOM >=6.0.0 (for React Router integration)
+- TanStack Router >=1.0.0 (for TanStack Router integration)
+
+## Setup
+
+Before using the React hooks, you need to:
+
+1. **Copy worker files** to your public directory from `@mcp-fe/mcp-worker`
+2. **Set up the MCP proxy server** (see [`@mcp-fe/mcp-worker` documentation](../mcp-worker/README.md))
+
+## Usage
+
+### React Router Integration
+
+For applications using React Router, use the `useReactRouterEventTracker` hook:
+
+```typescript
+import React, { useEffect } from 'react';
+import { BrowserRouter, Routes, Route } from 'react-router-dom';
+import { useReactRouterEventTracker } from '@mcp-fe/react-event-tracker';
+
+function App() {
+  const { setAuthToken } = useReactRouterEventTracker({
+    backendWsUrl: 'ws://localhost:3001'
+  });
+
+  // Set authentication token when available
+  useEffect(() => {
+    const token = localStorage.getItem('authToken');
+    if (token) {
+      setAuthToken(token);
+    }
+  }, [setAuthToken]);
+
+  return (
+    <BrowserRouter>
+      <Routes>
+        <Route path="/" element={<HomePage />} />
+        <Route path="/about" element={<AboutPage />} />
+        {/* Your other routes */}
+      </Routes>
+    </BrowserRouter>
+  );
+}
+
+function HomePage() {
+  return (
+    <div>
+      <h1>Welcome!</h1>
+      <button onClick={() => alert('Clicked!')}>
+        Click me (this click will be tracked)
+      </button>
+      <input 
+        placeholder="Type here (input changes will be tracked)" 
+        onChange={(e) => console.log(e.target.value)}
+      />
+    </div>
+  );
+}
+```
+
+### TanStack Router Integration
+
+For applications using TanStack Router, use the `useTanstackRouterEventTracker` hook:
+
+```typescript
+import React, { useEffect } from 'react';
+import { useTanstackRouterEventTracker } from '@mcp-fe/react-event-tracker';
+
+function App() {
+  const { setAuthToken } = useTanstackRouterEventTracker({
+    backendWsUrl: 'ws://localhost:3001'
+  });
+
+  useEffect(() => {
+    const token = localStorage.getItem('authToken');
+    if (token) {
+      setAuthToken(token);
+    }
+  }, [setAuthToken]);
+
+  return (
+    <div>
+      {/* Your TanStack Router setup */}
+      <h1>My TanStack Router App</h1>
+      {/* Components and interactions will be automatically tracked */}
+    </div>
+  );
+}
+```
+
+## Configuration Options
+
+Both hooks accept optional configuration parameters:
+
+```typescript
+interface WorkerClientInitOptions {
+  backendWsUrl?: string;        // WebSocket URL of your MCP proxy server
+  workerPath?: string;          // Custom path to worker files
+  fallbackToServiceWorker?: boolean; // Enable ServiceWorker fallback
+}
+```
+
+### Example with custom configuration:
+
+```typescript
+const { setAuthToken } = useReactRouterEventTracker({
+  backendWsUrl: 'wss://my-mcp-server.com/ws',
+  workerPath: '/workers',
+  fallbackToServiceWorker: true
+});
+```
+
+## What Gets Tracked
+
+The React event tracker automatically captures:
+
+### Navigation Events
+- Route changes (from previous route to current route)
+- Page loads and refreshes
+
+### User Interactions
+- **Clicks**: Element tag, ID, class, text content (first 100 chars)
+- **Input Changes**: Input/textarea changes (debounced by 1 second)
+- **Form Interactions**: Button clicks, link clicks
+
+### Event Data Structure
+
+Each tracked event includes:
+
+```typescript
+interface UserEventData {
+  type: 'navigation' | 'click' | 'input' | 'custom';
+  path?: string;           // Current page path
+  from?: string;           // Previous route (navigation only)
+  to?: string;             // Current route (navigation only)
+  element?: string;        // Element tag name
+  elementId?: string;      // Element ID attribute
+  elementClass?: string;   // Element class attribute
+  elementText?: string;    // Element text content
+  metadata?: Record<string, unknown>; // Additional data
+  timestamp: number;       // Event timestamp
+}
+```
+
+## Authentication
+
+To associate tracked events with specific users, set an authentication token:
+
+```typescript
+const { setAuthToken } = useReactRouterEventTracker();
+
+// When user logs in
+const handleLogin = async (credentials) => {
+  const response = await login(credentials);
+  const token = response.token;
+  
+  // Store token for your app
+  localStorage.setItem('authToken', token);
+  
+  // Set token for MCP tracking
+  setAuthToken(token);
+};
+
+// When user logs out
+const handleLogout = () => {
+  localStorage.removeItem('authToken');
+  setAuthToken(''); // Clear the token
+};
+```
+
+## Integration with MCP Agents
+
+Once events are being tracked, AI agents can query them through the MCP protocol:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "method": "tools/call",
+  "params": {
+    "name": "get_user_events",
+    "arguments": {
+      "type": "click",
+      "limit": 10
+    }
+  }
+}
+```
+
+This enables AI agents to:
+- Debug user interface issues
+- Provide context-aware customer support
+- Analyze user behavior patterns
+- Guide users through complex workflows
+
+## Advanced Usage
+
+### Custom Event Tracking
+
+You can also track custom events alongside the automatic tracking:
+
+```typescript
+import { trackEvent } from '@mcp-fe/event-tracker';
+
+// Track a custom business event
+await trackEvent({
+  type: 'custom',
+  metadata: {
+    eventName: 'purchase_completed',
+    orderId: '12345',
+    amount: 99.99
+  }
+});
+```
+
+### Connection Status Monitoring
+
+Monitor the connection status to the MCP proxy server:
+
+```typescript
+import { getConnectionStatus, onConnectionStatus } from '@mcp-fe/event-tracker';
+
+// Check current status
+const isConnected = await getConnectionStatus();
+
+// Listen for status changes
+onConnectionStatus((connected) => {
+  console.log('MCP connection:', connected ? 'Connected' : 'Disconnected');
+});
+```
+
+## Requirements
+
+- **MCP Worker**: This package requires [`@mcp-fe/mcp-worker`](../mcp-worker/README.md) to be properly set up
+- **MCP Proxy Server**: You need a running MCP proxy server to collect the events
+- **Public Worker Files**: Worker files must be accessible from your web server's public directory
+
+## Troubleshooting
+
+### Events Not Being Tracked
+
+1. **Check worker initialization**: Ensure `@mcp-fe/mcp-worker` files are in your public directory
+2. **Verify proxy connection**: Check that your MCP proxy server is running and accessible
+3. **Check browser console**: Look for initialization errors or connection issues
+
+### Navigation Not Tracked
+
+1. **Router integration**: Ensure you're using the correct hook for your router (React Router vs TanStack Router)
+2. **Hook placement**: Make sure the hook is called within the router context
+
+### Authentication Issues
+
+1. **Token format**: Ensure your authentication token is in the expected format
+2. **Timing**: Set the auth token after both the tracker and your authentication system are initialized
+
+## Examples
+
+Check out the example application in the `apps/mcp-fe` directory for a complete working implementation.
+
+## Related Packages
+
+- [`@mcp-fe/mcp-worker`](../mcp-worker/README.md): Core MCP worker implementation
+- [`@mcp-fe/event-tracker`](../event-tracker/README.md): Framework-agnostic event tracking library
+
+## License
+
+Licensed under the Apache License, Version 2.0. See the [LICENSE](../../LICENSE) file for details.
 
-Run `nx test react-event-tracker` to execute the unit tests via [Vitest](https://vitest.dev/).

package/index.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Copyright 2026 MCP-FE Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export * from './hooks/useTanstackRouterEventTracker';
 export * from './hooks/useReactRouterEventTracker';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../libs/react-event-tracker/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../libs/react-event-tracker/src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,uCAAuC,CAAC;AACtD,cAAc,oCAAoC,CAAC"}

package/package.json

@@ -1,6 +1,13 @@
 {
   "name": "@mcp-fe/react-event-tracker",
-  "version": "0.0.14",
+  "version": "0.0.16",
+  "license": "Apache-2.0",
+  "homepage": "https://mcp-fe.ai",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mcp-fe/mcp-fe.git",
+    "directory": "libs/react-event-tracker"
+  },
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
@@ -11,7 +18,7 @@
     }
   },
   "dependencies": {
-    "@mcp-fe/event-tracker": "0.0.14"
+    "@mcp-fe/event-tracker": "0.0.16"
   },
   "peerDependencies": {
     "react": ">=19.0.0",