react-native-aes-lite 1.0.8 → 1.0.9

package/README.md

@@ -1,18 +1,209 @@
 
-# react-native-aes-lite
+# 📦 react-native-aes-lite  
 
-## Install
+[![npm version](https://img.shields.io/npm/v/react-native-aes-lite.svg?color=blue)](https://www.npmjs.com/package/react-native-aes-lite)
+[![platforms](https://img.shields.io/badge/platform-react%20native%20%7C%20expo-green)]()
+[![license](https://img.shields.io/npm/l/react-native-aes-lite.svg)]()
+[![typescript](https://img.shields.io/badge/types-yes-blue)]()
 
-## npm i react-native-aes-lite
+Lightweight AES encryption/decryption utility for React Native and Expo. No native modules, no linking — just pure JavaScript.
 
+---
+
+## 📖 Overview  
+
+react-native-aes-lite provides simple AES block-based text encryption and decryption using a 128-bit key. It is ideal for app-side data scrambling, offline encoding, demos, and educational use.  
+
+✔ Encrypt text → hex  
+✔ Decrypt hex → text  
+✔ Generate AES keys  
+✔ Works offline  
+✔ No native dependencies  
+✔ React Native CLI support  
+✔ Expo app support  
+✔ Expo web support  
+
+---
+
+## 🚨 Security Warning  
+
+This library is not suitable for securing sensitive data.  
+
+It does not implement:  
+
+- IV / salt  
+- AES-GCM  
+- AES-CBC  
+- key derivation  
+- authenticated encryption  
+- secure storage
+
+If you need production-grade crypto → use a native AES solution.
+
+---
+
+## 📦 Install  
+
+```sh
+npm install react-native-aes-lite
+```
+
+or  
+
+```sh
+yarn add react-native-aes-lite
+```
+
+---
+
+## 🚀 Usage  
 
-## Usage
 ```js
 import { AES, generateKey } from "react-native-aes-lite";
 
 const aes = new AES();
 const key = generateKey("hex", { length: 16 });
-const encrypted = aes.encrypt("hello", key);
+
+const encrypted = aes.encrypt("hello world", key);
+console.log("Encrypted:", encrypted);
+
 const decrypted = aes.decrypt(encrypted, key);
+console.log("Decrypted:", decrypted);
+```
+
+Example output:  
+
+```
+Encrypted: f52066d59d6c581c3918e652efe8cb45
+Decrypted: hello world
+```
+
+---
+
+## 🔑 Key Generation  
+
+```js
+const key = generateKey("hex", { length: 16 });
+```
+
+Formats supported:  
+- hex (recommended)
+- base64
+- ascii
+
+Key lengths:  
+- 16 bytes (AES-128)  
+- 24 bytes (AES-192)  
+- 32 bytes (AES-256)  
+
+---
+
+## 📘 API Reference  
+
+### class AES
+
+```ts
+new AES()
+encrypt(text: string, key: string): string
+decrypt(cipherHex: string, key: string): string
+```
+
+### generateKey(format?, options?)
+
+```ts
+generateKey(
+  format?: "hex" | "base64" | "ascii",
+  options?: { length?: number; readable?: boolean }
+): string
+```
+
+---
+
+## 📌 Example: Saving encrypted text  
+
+```js
+const aes = new AES();
+const key = generateKey("hex");
+
+const token = "USER_SESSION_XYZ";
+const encrypted = aes.encrypt(token, key);
+
+await AsyncStorage.setItem("token", encrypted);
+
+const stored = await AsyncStorage.getItem("token");
+const decrypted = aes.decrypt(stored, key);
+```
+
+---
+
+## ⚡ Performance Notes  
+
+AES operations are synchronous.  
+Works best for short strings.  
+
+| Device | Speed |
+|--------|-------|
+| New iOS / Android | fast |
+| Mid-range phones  | good |
+| Old hardware      | slower |
+
+Not recommended for large blobs.  
+
+---
+
+## 🧭 Roadmap  
+
+Planned:  
+- AES-256 support  
+- Async API  
+- CBC mode  
+- IV generation  
+- UTF-8 optimization  
+- bundle size reduction  
+
+Not planned:  
+- secure storage  
+- authenticated encryption  
+- native rewrite  
+
+---
+
+## 🧩 Platform Support  
+
+| Platform          | Status |
+|------------------|--------|
+| React Native CLI | ✅ |
+| Expo app         | ✅ |
+| Expo web         | ✅ |
+| Expo Snack       | ❌ (npm modules unsupported) |
+| TypeScript       | ⚠ static warnings may appear |
+
+---
+
+## ⚠ Expo Snack  
+
+Expo Snack does not support npm installation, so this package cannot run inside Snack. Use Expo locally instead:
+
+```sh
+expo start
+```
+
+---
+
+## 🐞 Troubleshooting  
+
+### Error: AES is not a constructor
+Use default import fallback:  
+
+```js
+import aesKit from "react-native-aes-lite";
+const { AES } = aesKit;
+```
+
+### TS2305 — generateKey missing
+Ensure latest version is installed.
 
+---
 
+## 📜 License  
+MIT © 2025 Ammachi  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-aes-lite",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "AES encryption for React Native + Expo Web",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",