Skip to main content

Overview

The Suada Angular SDK provides a seamless way to integrate Suada’s AI capabilities into your Angular applications. Built specifically for Angular 17+, it offers components, services, and utilities that follow Angular best practices and conventions.

Prerequisites

  • Angular 17.3.0 or higher
  • Node.js 18.0.0 or higher
  • A Suada API key
  • npm or yarn package manager

Installation

Install the Suada Angular SDK and its peer dependencies:

Quick Start

Here’s a basic example to get you started:

Authentication

Setting up your API Key

We recommend storing your API key in environment files:
Then use it in your module:

Core Components

Chat Component

A pre-built chat interface component:

Props

Events

Integration Components

Integration Button

Handle OAuth flows for third-party services:

Integration List

Display and manage integrated services:

Services

SuadaService

The main service for interacting with Suada:

IntegrationService

Manage third-party integrations:

Error Handling

The SDK provides typed errors for better error handling:

Best Practices

Security

  • Store API keys in environment files
  • Use privacy mode for sensitive data
  • Implement proper error handling
  • Secure OAuth callback endpoints

Performance

  • Reuse service instances
  • Implement proper unsubscribe patterns
  • Handle component lifecycle properly
  • Consider implementing caching

Development

  • Use TypeScript strict mode
  • Follow Angular style guide
  • Write unit tests
  • Keep dependencies updated

FAQ

How do I handle environment-specific configuration?

Use Angular’s environment files and configure the module accordingly:

How do I customize the chat component theme?

You can override the default styles using CSS variables:

Can I use the SDK with SSR (Server-Side Rendering)?

Yes, the SDK is compatible with Angular Universal. Just ensure you handle the window object appropriately:

How do I implement retry logic?

The SDK includes built-in retry logic, but you can customize it:

How can I debug the SDK?

Enable debug mode in your environment configuration:

Support & Resources

Documentation

Support