@voltx/ui 0.2.0 → 0.4.1

package/README.md

@@ -0,0 +1,108 @@
+<p align="center">
+  <strong>@voltx/ui</strong><br/>
+  <em>React hooks for AI-powered interfaces — useChat, useAgent</em>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@voltx/ui"><img src="https://img.shields.io/npm/v/@voltx/ui?color=blue" alt="npm" /></a>
+  <a href="https://www.npmjs.com/package/@voltx/ui"><img src="https://img.shields.io/npm/dm/@voltx/ui" alt="downloads" /></a>
+  <a href="https://github.com/codewithshail/voltx/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@voltx/ui" alt="license" /></a>
+</p>
+
+---
+
+React hooks for building AI chat interfaces. Part of the [VoltX](https://github.com/codewithshail/voltx) framework.
+
+## Installation
+
+```bash
+npm install @voltx/ui
+```
+
+> Requires `react` as a peer dependency.
+
+## useChat
+
+Full-featured chat hook with message management, loading states, and error handling.
+
+```tsx
+import { useChat } from "@voltx/ui";
+
+function ChatPage() {
+  const { messages, input, setInput, sendMessage, isLoading, error, reset } = useChat({
+    api: "/api/chat",
+  });
+
+  return (
+    <div>
+      {messages.map((msg) => (
+        <div key={msg.id}>
+          <strong>{msg.role}:</strong> {msg.content}
+        </div>
+      ))}
+
+      <form onSubmit={(e) => { e.preventDefault(); sendMessage(); }}>
+        <input value={input} onChange={(e) => setInput(e.target.value)} />
+        <button type="submit" disabled={isLoading}>Send</button>
+      </form>
+    </div>
+  );
+}
+```
+
+### Options
+
+```ts
+useChat({
+  api: "/api/chat",              // API endpoint (default: "/api/chat")
+  initialMessages: [],           // Pre-populate messages
+  onResponse: (res) => {},       // Called when response is received
+  onError: (err) => {},          // Called on error
+});
+```
+
+### Return Value
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `messages` | `ChatMessage[]` | All messages in the conversation |
+| `input` | `string` | Current input value |
+| `setInput` | `function` | Update input value |
+| `sendMessage` | `function` | Send a message |
+| `isLoading` | `boolean` | Whether a request is in progress |
+| `error` | `Error \| null` | Last error |
+| `reset` | `function` | Clear all messages |
+
+## useAgent
+
+Hook for interacting with VoltX agents.
+
+```tsx
+import { useAgent } from "@voltx/ui";
+
+function AgentPage() {
+  const { run, isRunning, error } = useAgent({
+    api: "/api/agent",
+    agentName: "assistant",
+  });
+
+  const handleRun = async () => {
+    const result = await run("What's the weather in Tokyo?");
+    console.log(result);
+  };
+
+  return (
+    <button onClick={handleRun} disabled={isRunning}>
+      {isRunning ? "Thinking..." : "Ask Agent"}
+    </button>
+  );
+}
+```
+
+## Part of VoltX
+
+This package is part of the [VoltX](https://github.com/codewithshail/voltx) framework. See the [monorepo](https://github.com/codewithshail/voltx) for full documentation.
+
+## License
+
+[MIT](https://github.com/codewithshail/voltx/blob/main/LICENSE) — Made by the [Promptly AI Team](https://buymeacoffee.com/promptlyai)

package/dist/index.d.mts

@@ -35,6 +35,6 @@ interface UseAgentReturn {
     error: Error | null;
 }
 declare function useAgent(options: UseAgentOptions): UseAgentReturn;
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.4.1";
 
 export { type ChatMessage, type UseAgentOptions, type UseAgentReturn, type UseChatOptions, type UseChatReturn, VERSION, useAgent, useChat };

package/dist/index.d.ts

@@ -35,6 +35,6 @@ interface UseAgentReturn {
     error: Error | null;
 }
 declare function useAgent(options: UseAgentOptions): UseAgentReturn;
-declare const VERSION = "0.1.0";
+declare const VERSION = "0.4.1";
 
 export { type ChatMessage, type UseAgentOptions, type UseAgentReturn, type UseChatOptions, type UseChatReturn, VERSION, useAgent, useChat };

package/dist/index.js

@@ -130,7 +130,7 @@ function useAgent(options) {
   );
   return { run, isRunning, error };
 }
-var VERSION = "0.1.0";
+var VERSION = "0.4.1";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   VERSION,

package/dist/index.mjs

@@ -104,7 +104,7 @@ function useAgent(options) {
   );
   return { run, isRunning, error };
 }
-var VERSION = "0.1.0";
+var VERSION = "0.4.1";
 export {
   VERSION,
   useAgent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voltx/ui",
-  "version": "0.2.0",
+  "version": "0.4.1",
   "description": "VoltX React hooks — useRAG, useAgent, useChat, useCompletion",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -13,6 +13,11 @@
       "require": "./dist/index.js"
     }
   },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --external react",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --external react --watch",
+    "clean": "rm -rf dist"
+  },
   "peerDependencies": {
     "react": ">=18.0.0"
   },
@@ -22,9 +27,7 @@
     "tsup": "^8.0.0",
     "typescript": "^5.7.0"
   },
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,18 +36,5 @@
   },
   "homepage": "https://voltx.co.in",
   "bugs": "https://github.com/codewithshail/voltx/issues",
-  "keywords": [
-    "voltx",
-    "react",
-    "hooks",
-    "useChat",
-    "useAgent",
-    "ai",
-    "ui"
-  ],
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts --external react",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --external react --watch",
-    "clean": "rm -rf dist"
-  }
-}
+  "keywords": ["voltx", "react", "hooks", "useChat", "useAgent", "ai", "ui"]
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Promptly AI Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software 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 Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.