empathai-core 0.1.7 → 0.2.0

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License
+
+Copyright (c) 2025 Mrityunjoy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+...
+
+[full MIT text — paste standard MIT license content here, including year and author]

package/README.md

@@ -1,36 +1,52 @@
 # @empathai/core
 
-> Progressive, multimodal emotion detection SDK for real-time web applications. Built for developers who want apps to **feel** the user.
+[![npm version](https://img.shields.io/npm/v/empathai-core.svg)](https://www.npmjs.com/package/empathai-core)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![GitHub](https://img.shields.io/github/last-commit/Pikxul/empathai?style=flat-square)](https://github.com/Pikxul/empathai)
 
-![npm](https://img.shields.io/npm/v/empathai-core?color=crimson&style=flat-square)
-![license](https://img.shields.io/npm/l/empathai-core?style=flat-square)
-![GitHub last commit](https://img.shields.io/github/last-commit/pikxul/empathai?style=flat-square)
+**EmpathAI Core** — lightweight, non-intrusive emotion detection for web apps (keyboard + mouse).
 
 ---
 
-## 🔮 What is EmpathAI?
+## What it does
 
-**EmpathAI** is an open-source SDK that enables web applications to detect and respond to **user emotions** in real time using **non-intrusive behavior signals** — such as typing speed, mouse movement, and interaction patterns.
+`empathai-core` analyzes user interaction signals (mouse movement, typing rhythm, clicks) and returns inferred emotional states (e.g. `focused`, `frustrated`, `bored`, `neutral`) together with a basic confidence score.  
+It is intentionally **privacy-first** — no camera/mic required.
 
-The `@empathai/core` package provides the core hook and engine for capturing and analyzing this behavior in **React apps**. Future modules (`@empathai/analytics`, `@empathai/chatbot`, `@empathai/enterprise`) will plug into this core.
+> **EmpathAI Core** is a privacy-first, non-intrusive **emotion signal engine** for web applications.  
+It detects user emotional states in real time using **behavioral signals** such as mouse movement and typing patterns.
+
+⚠️ This package is **NOT a recommendation engine** and **NOT an ML model**.  
+It is a **foundational signal layer** designed to be consumed by higher-level systems (AI, analytics, UX, decision engines).
 
 ---
 
-## 🚀 Features
+## ✨ What EmpathAI Core Does
 
-- 🧠 Passive emotion tracking (no camera or mic required)
-- ⚛️ Built-in React hook (`useEmpathAI`)
-- 🌗 Works out of the box, extensible with plugins
-- 📦 Lightweight and production-ready
-- 🧩 Open source, extensible SDK architecture
+- Captures **non-intrusive user behavior signals**
+- Infers **basic emotional states** (deterministic v1)
+- Emits **structured emotion data** with confidence & timestamp
+- Works entirely **on the client**
+- Stores **no personal data**
+- Safe for **BFSI / SaaS / FinTech / enterprise / privacy-sensitive environments**
+
+---
+
+## 🚫 What EmpathAI Core Does NOT Do
+
+- ❌ No camera access  
+- ❌ No microphone access  
+- ❌ No personal data collection  
+- ❌ No emotion prediction via ML (yet)  
+- ❌ No recommendations or decisions  
+
+EmpathAI Core provides **signals**, not decisions.
 
 ---
 
 ## 📦 Installation
 
 ```bash
-# With npm
 npm install empathai-core
-
-# With pnpm
+# or
 pnpm add empathai-core

package/package.json

@@ -1,42 +1,50 @@
 {
   "name": "empathai-core",
-  "version": "0.1.7",
-  "description": "Progressive, multimodal emotion detection SDK for real-time apps",
+  "version": "0.2.0",
+  "description": "Non-intrusive behavior-based emotion detection SDK (keyboard & mouse) — EmpathAI core.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist",
     "README.md",
-    "CONTRIBUTING.md"
+    "LICENSE"
   ],
   "keywords": [
     "emotion",
     "ai",
     "sdk",
     "empathai",
-    "user behavior",
+    "user-behavior",
     "multimodal"
   ],
-  "author": "Mrityunjoy",
+  "author": "Mrityunjoy (Piklu)",
   "license": "MIT",
-  "private": false,
   "repository": {
     "type": "git",
-    "url": "https://github.com/pikxul/empathai"
+    "url": "https://github.com/Pikxul/empathai"
   },
-  "dependencies": {
-    "react": "^19.1.1"
+  "bugs": {
+    "url": "https://github.com/Pikxul/empathai/issues"
+  },
+  "homepage": "https://github.com/Pikxul/empathai",
+  "peerDependencies": {
+    "react": "^17 || ^18 || ^19"
   },
   "devDependencies": {
-    "@types/react": "^19.1.8",
+    "@types/node": "^20.0.0",
+    "eslint": "^8.0.0",
+    "jsdom": "^24.1.3",
     "typescript": "^5.4.5",
-    "eslint": "^8.0.0"
+    "vitest": "^1.6.1"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
+    "test": "vitest",
     "check-types": "tsc --noEmit",
-    "lint": "eslint ./src --ext .ts,.tsx",
-    "test": "echo \"No tests yet, coming soon!\" && exit 0"
+    "lint": "eslint ./src --ext .ts,.tsx"
   }
 }

package/CONTRIBUTING.md

@@ -1,31 +0,0 @@
-# Contributing to EmpathAI
-
-Thanks for your interest in contributing! 🎉
-
-## How to Contribute
-
-1. Fork this repo and clone it locally.
-2. Run `pnpm install` to set up dependencies.
-3. Create a new branch: `git checkout -b feature/my-new-feature`.
-4. Make your changes, commit them.
-5. Push to your fork and open a Pull Request.
-
-## Code Guidelines
-
-- Use TypeScript.
-- Keep things modular under `packages/core/src`.
-- Follow existing naming conventions.
-- Use `pnpm build` before pushing.
-
-## Issues and Discussions
-
-- Use **Issues** to report bugs or suggest features.
-- Open a **Discussion** for questions or brainstorming.
-
-## Community
-
-Join us on [GitHub Discussions](https://github.com/pikxul/empathai/discussions) *(Enable this tab in your repo settings)*
-
----
-
-Let's build emotion-aware apps together 💜