@agient/chatbot 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Agient.
+
+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.

package/README.md

@@ -1,9 +1,86 @@
 <p align="center">
   <a href="#">
-    <img src=".github/assets/hi.gif" width="150" height="150" />
+    <img src="assets/hi.gif" width="150" height="150" />
   </a>
 </p>
 
 # @agient/chatbot
 
-Create AI chatbot assitstants with minimal setup. Implement tool that will allow your chatbots to perform actions or fetch data from your website
+<div align="center">
+
+**Create AI chatbot assistants with minimal setup. Implement tools that will allow your chatbots to perform actions and fetch data from your website.**
+
+</div>
+
+## 📦 Installation
+
+**using [npm](https://npmjs.com)**
+
+```shell
+npm i @agient/chatbot
+```
+
+**using [yarn](https://yarnpkg.com)**
+
+```shell
+yarn add @agient/chatbot
+```
+
+**using [pnpm](https://pnpm.io)**
+
+```shell
+pnpm add @agient/chatbot
+```
+
+**using [bun](https://bun.sh)**
+
+```shell
+bun i @agient/chatbot
+```
+
+## 🚀 Quick Start
+
+Heading to [agient.dev](https://agient.dev) and create your own chatbot project. Once you've created your project, you'll receive an API key that you'll need to initialize the chatbot in your application.
+
+```typescript
+import { createAgient } from '@agient/chatbot';
+
+// Initialize the chatbot with your API key
+const agient = createAgient('your-api-key');
+
+agient.on('getWeather', async args => {
+  return 'The weather is currently sunny and 75°F';
+});
+```
+
+## ⚙️ Configuration Options
+
+The `createAgient` function accepts the following options:
+
+```typescript
+interface AgientOptions {
+  /**
+   * Whether to automatically start the chat widget when initialized.
+   * If false, the widget will need to be manually started.
+   * @default true
+   */
+  autoStart?: boolean;
+}
+```
+
+### 🔨 Tool Handling
+
+The chatbot supports custom tools that can be implemented to perform specific actions.
+Tools must first be registered inside your chatbot at https://agient.dev. Then you can implement them by their names.
+Here's how to implement a tool:
+
+```typescript
+import { createAgient } from '@agient/chatbot';
+
+const agient = createAgient('your-api-key');
+
+agient.on('incrementCounter', async ({ by }) => {
+  const newCount = await incrementCounter(by);
+  return `The counter is now ${newCount}`;
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,90 @@
+/**
+ * The main instance interface returned by {@link createAgient}.
+ * Provides methods to interact with the chat widget.
+ *
+ * @template Tools - The type of tools available to the chatbot
+ *
+ * @example
+ * ```typescript
+ * const agient = createAgient('api-key');
+ *
+ * // Register a handler for the 'incrementCounter' tool
+ * agient.on('incrementCounter', async ({ by }) => {
+ *   const newCount = await incrementCounter(by);
+ *   return `The counter is now ${newCount}`;
+ * });
+ * ```
+ */
+export declare type AgientInstance<Tools extends ToolsMap> = {
+    /**
+     * Registers a handler for a specific tool.
+     * @param event - The name of the tool to handle
+     * @param fn - The handler function that processes the tool's arguments and returns a response
+     */
+    on: <Tool extends ToolKeys<Tools>>(event: Tool, fn: (args: Tools[Tool]) => string | Promise<string>) => void;
+};
+
+/**
+ * Configuration options for the Agient chat widget.
+ */
+export declare interface AgientOptions {
+    /**
+     * Whether to automatically start the chat widget when initialized.
+     * If false, the widget will need to be manually started.
+     * @default true
+     */
+    autoStart?: boolean;
+}
+
+/**
+ * Creates a new Agient instance for embedding the chat widget into your application.
+ *
+ * @param apiKey - Your Agient API key for authentication
+ * @param options - Configuration options for the widget instance. See {@link AgientOptions} for available options.
+ * @returns An {@link AgientInstance} that provides methods to interact with the widget.
+ *
+ * @example
+ * ```typescript
+ * const agient = createAgient('your-api-key', {
+ *   autoStart: true
+ * });
+ *
+ * agient.on('message', async (args) => {
+ *   // Handle incoming messages
+ *   return 'Response message';
+ * });
+ * ```
+ */
+export declare const createAgient: <Tools extends ToolsMap = DefaultToolsMap>(apiKey: string, options?: AgientOptions) => AgientInstance<Tools>;
+
+/**
+ * Default tools map that allows any argument types.
+ * Used when no specific tool types are provided.
+ */
+export declare type DefaultToolsMap = {
+    [key: string]: Record<string, any>;
+};
+
+/**
+ * Represents a valid argument type that can be passed to or returned from a tool.
+ * This includes primitive types, arrays, and objects.
+ */
+export declare type ToolAgrument = string | number | boolean | null | Array<ToolAgrument> | {
+    [key: string]: ToolAgrument;
+};
+
+/**
+ * Extracts the available tool names from a {@link ToolsMap}.
+ * @template Tools - The tools map type to extract keys from
+ */
+export declare type ToolKeys<Tools extends ToolsMap> = keyof Tools & (string | symbol);
+
+/**
+ * Maps tool names to their argument types.
+ * Each tool is defined as a record of string keys to {@link ToolAgrument} values.
+ */
+export declare type ToolsMap = {
+    [key: string]: Record<string, ToolAgrument>;
+};
+
+export { }