empathai-core 0.1.8 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +32 -5
  2. package/package.json +5 -4
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # empathai-core
1
+ # @empathai/core
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/empathai-core.svg)](https://www.npmjs.com/package/empathai-core)
4
4
  [![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
@@ -13,13 +13,40 @@
13
13
  `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.
14
14
  It is intentionally **privacy-first** — no camera/mic required.
15
15
 
16
+ > **EmpathAI Core** is a privacy-first, non-intrusive **emotion signal engine** for web applications.
17
+ It detects user emotional states in real time using **behavioral signals** such as mouse movement and typing patterns.
18
+
19
+ ⚠️ This package is **NOT a recommendation engine** and **NOT an ML model**.
20
+ It is a **foundational signal layer** designed to be consumed by higher-level systems (AI, analytics, UX, decision engines).
21
+
22
+ ---
23
+
24
+ ## ✨ What EmpathAI Core Does
25
+
26
+ - Captures **non-intrusive user behavior signals**
27
+ - Infers **basic emotional states** (deterministic v1)
28
+ - Emits **structured emotion data** with confidence & timestamp
29
+ - Works entirely **on the client**
30
+ - Stores **no personal data**
31
+ - Safe for **BFSI / SaaS / FinTech / enterprise / privacy-sensitive environments**
32
+
16
33
  ---
17
34
 
18
- ## Install
35
+ ## 🚫 What EmpathAI Core Does NOT Do
36
+
37
+ - ❌ No camera access
38
+ - ❌ No microphone access
39
+ - ❌ No personal data collection
40
+ - ❌ No emotion prediction via ML (yet)
41
+ - ❌ No recommendations or decisions
42
+
43
+ EmpathAI Core provides **signals**, not decisions.
44
+
45
+ ---
46
+
47
+ ## 📦 Installation
19
48
 
20
49
  ```bash
21
- # npm
22
50
  npm install empathai-core
23
-
24
- # pnpm
51
+ # or
25
52
  pnpm add empathai-core
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "empathai-core",
3
- "version": "0.1.8",
3
+ "version": "0.2.0",
4
4
  "description": "Non-intrusive behavior-based emotion detection SDK (keyboard & mouse) — EmpathAI core.",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -31,10 +31,11 @@
31
31
  "react": "^17 || ^18 || ^19"
32
32
  },
33
33
  "devDependencies": {
34
- "typescript": "^5.4.5",
35
- "vitest": "^0.34.0",
34
+ "@types/node": "^20.0.0",
36
35
  "eslint": "^8.0.0",
37
- "@types/node": "^20.0.0"
36
+ "jsdom": "^24.1.3",
37
+ "typescript": "^5.4.5",
38
+ "vitest": "^1.6.1"
38
39
  },
39
40
  "publishConfig": {
40
41
  "access": "public"