@prass/botpress-native/README.md

A simple and powerful SDK for integrating Botpress Chat API with React Native,

# Botpress Native SDK for React Native

A simple and powerful SDK for integrating [Botpress Chat API](https://botpress.com/reference/introduction) with React Native. This package allows seamless interaction with the Botpress Chat API without manually handling HTTP requests.

## Installation

```sh
# Using npm
npm install botpress-native

# Using yarn
yarn add botpress-native

# Using bun
bun add botpress-native
```

## Usage

### Initialize the SDK

```ts
import { Botpress } from "botpress-native";

const botpress = new Botpress("your-webhook-id", "your-user-key");
```

📌 **Note:** `user-key` can be `null` when creating a user. After user creation, you will receive the `user-key` in the response. All other methods require a valid `user-key`.

### Create a User

```ts
const user = await botpress.createUser({
  id: "user-123",
  name: "John Doe",
  pictureUrl: "https://example.com/picture.jpg",
  profile: "string within 1000 characters",
});
console.log(user); // `user-key` will be included in the response
```

### Send a Message

```ts
const message = await botpress.createMessage({
  conversationId: "conv_123",
  payload: { type: "text", text: "Hello, world!" },
});
console.log("Message created:", message);
```

### Listen to Conversations

```ts
const listener = await botpress.listenConversations({
  id: "conv_123",
  autoReconnect: true,
});

listener.on("message", (data) => console.log("New message:", data));
listener.on("error", (err) => console.error("Stream error:", err));
listener.on("close", () => console.log("Stream closed"));

// To stop listening:
listener.stop();
```

## Features

- Simple user creation and management
- Send and receive messages
- Real-time conversation streaming
- Fully compatible with React Native

## More Information

For raw API queries, refer to the official [Botpress Chat API documentation](https://botpress.com/reference/introduction).

---

📌 **Note:** This is a short documentation for now. A detailed guide will be published soon.

## License

This project is licensed under the **MIT License**. See the [LICENSE.md](LICENSE.md) file for details. This means you are free to use, modify, and distribute the package with minimal restrictions.

## Contributors

Contributions are welcome! If you'd like to contribute, please open an issue or submit a pull request on [GitHub](https://github.com/PRASSamin/botpress-native).