@aptos-labs/ai-chatbot-client

@aptos-labs/ai-chatbot-client

A React-based chatbot interface for the Aptos Developer Assistant API. This package provides a customizable chat interface component that can be integrated into any React application.

Installation

npm install @aptos-labs/ai-chatbot-client
# or
yarn add @aptos-labs/ai-chatbot-client
# or
pnpm add @aptos-labs/ai-chatbot-client

Usage

import { ChatInterface } from '@aptos-labs/ai-chatbot-client';

function App() {
  return (
    <ChatInterface
      apiUrl="https://your-api-url"
      // Add other props as needed
    />
  );
}

Development

Prerequisites

• Node.js 16+
• pnpm 9+

Setup

• Install dependencies:

pnpm install

• Build the package:

pnpm build

Release Process

This package uses Changesets for version management and releases.

Prerequisites for Publishing

To publish new versions of this package, you need:

• Access to the @aptos-labs organization on npm
• Proper authentication set up with npm
• Membership in the Aptos Labs GitHub organization

If you don't have these permissions, please contact the Aptos Labs team to get the necessary access.

Making a Release

• Make your code changes

• Create a changeset:

pnpm changeset

This will prompt you to:

• Select the packages that have changed
• Choose the type of version bump (patch, minor, or major)
• Write a description of the changes

• Build the package:

pnpm build

• Update versions:

pnpm changeset version

• Publish:

pnpm changeset publish

Versioning

The package follows semantic versioning (MAJOR.MINOR.PATCH):

• MAJOR: Breaking changes
• MINOR: New features (backwards compatible)
• PATCH: Bug fixes (backwards compatible)

Contributing

• Fork the repository
• Create your feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -m 'Add some amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Open a Pull Request

License

Apache-2.0 © Aptos Labs