@j3-enterprises/co-pals

Embeddable chat widget for Co-Pals AI assistants.

Installation

npm install @j3-enterprises/co-pals

Usage

JavaScript/TypeScript

import CoPals from '@j3-enterprises/co-pals';

CoPals.init({
  embedSecret: 'your-embed-secret-here',
  apiUrl: 'https://app.co-pals.com',
  position: 'bottom-right' // or 'bottom-left'
});

HTML (via CDN)

<script src="https://unpkg.com/@j3-enterprises/co-pals@latest/dist/index.global.js"></script>
<script>
  CoPals.init({
    embedSecret: 'your-embed-secret-here',
    apiUrl: 'https://app.co-pals.com',
    position: 'bottom-right'
  });
</script>

Configuration

| Option | Type | Required | Default | Description | |--------|------|----------|---------|-------------| | embedSecret | string | Yes | - | Your PAL's embed secret from Co-Pals dashboard | | apiUrl | string | Yes | - | Co-Pals API URL (e.g., https://app.co-pals.com) | | position | 'bottom-right' \| 'bottom-left' | No | 'bottom-right' | Widget position on page |

Getting Your Embed Secret

1. Log in to Co-Pals
2. Navigate to Dashboard → PALs
3. Select the PAL you want to embed
4. Go to the Embed tab
5. Copy your embed secret

Features

• 🎨 Beautiful, responsive chat interface
• 💬 Real-time streaming responses
• 📱 Mobile-friendly design
• 🎯 Easy integration with any website
• 🔒 Secure authentication via embed secret
• 🎨 Customizable positioning

Browser Support

• Chrome/Edge (latest)
• Firefox (latest)
• Safari (latest)
• Mobile browsers (iOS Safari, Chrome Mobile)

License

MIT