Fireberry SDK

A lightweight TypeScript SDK for integrating with the Fireberry platform, providing seamless communication for embedded applications. Built with modern TypeScript and designed for optimal developer experience.

Features

• 📝 Full CRUD Operations: Create, Query (Read), Update, Delete operations for business objects
• 🔍 Advanced Querying: Flexible querying with field selection, filtering, and pagination
• ⚡ TypeScript First: Full type safety with comprehensive TypeScript definitions
• 🎯 Context Awareness: Automatic context detection and management
• 🚀 Promise-based API: Modern async/await support for all operations

Installation

npm install @fireberry/sdk@latest

Quick Start

Basic Usage

import FireberryClientSDK from '@fireberry/sdk/client';

// Create a new instance
const client = new FireberryClientSDK();

// Initialize context
await client.initializeContext();

// Access the API through the api getter
const api = client.api;

// Get current context information (If not initialized first context will return null)
const context = client.context;

CRUD Operations

const objectType = 1;

// Query records with advanced filtering
const results = await api.query(objectType, {
  fields: 'id,name,createdOn,ownerName',
  query: 'name LIKE "test%" AND ownerName = "John"',
  page_size: 20,
  page_number: 1,
});

// Create a new record
const newRecord = await api.create(objectType, {
  name: 'New Business Record',
  description: 'Detailed description of the record',
  status: 'active',
});

// Update an existing record
const updatedRecord = await api.update(objectType, 'recordId123', {
  name: 'Updated Record Name',
  status: 'completed',
});

// Delete a record
const deleteRecord = await api.delete(objectType, 'recordId123');

System Methods

Control UI elements in the Fireberry platform using the system API.

Badge Notifications

Display notification badges to alert users about important information or status updates.

// Show a badge with a number and type
await client.system.badge.show({
  number: 5,
  badgeType: 'info', // 'success' | 'warning' | 'error' | 'info'
});

// Hide the badge
await client.system.badge.hide();

Badge Types:

• success — Green badge for positive notifications
• warning — Yellow badge for warnings
• error — Red badge for errors or critical alerts
• info — Blue badge for informational messages

Callbar

Display a callbar interface with call information and related records.

// Show callbar with call information
await client.system.callbar.show({
  callInfo: {
    number: 1234567890,
    status: 'Talking', // 'Talking' | 'Ringing' | 'Missed' | 'Dialing'
  },
  objectConfigs: [
    {
      objectType: '1',
      order: 1,
      fields: [{ name: 'accountname' }, { name: 'email' }],
    },
  ],
  placement: 'bottom-end', // 'bottom-start' | 'bottom-end'
});

// Hide the callbar
await client.system.callbar.hide();

Toasts

Display temporary notification messages to provide feedback to users about actions, status updates, or important information.

// Show a toast notification
await client.system.toast.show({
  content: 'Record saved successfully!',
  toastType: 'success', // 'success' | 'warning' | 'error' | 'info'
  placement: 'top-end', // 'top-left' | 'top-center' | 'top-right' | 'top-start' | 'top-end' | 'bottom-left' | 'bottom-center' | 'bottom-right' | 'bottom-start' | 'bottom-end'
  withCloseButton: true, // Optional: adds a close button
  autoDismissTimeout: 5000, // Optional: auto-dismiss after 5 seconds (in milliseconds)
});

// Hide the toast manually
await client.system.toast.hide();

Toast Types:

• success — Green toast for successful operations
• warning — Yellow toast for warnings or cautions
• error — Red toast for errors or failures
• info — Blue toast for informational messages

Placement Options:

• top-left — Top left corner (absolute)
• top-center — Top center
• top-right — Top right corner (absolute)
• top-start — Top start (left in LTR, right in RTL)
• top-end — Top end (right in LTR, left in RTL)
• bottom-left — Bottom left corner (absolute)
• bottom-center — Bottom center
• bottom-right — Bottom right corner (absolute)
• bottom-start — Bottom start (left in LTR, right in RTL)
• bottom-end — Bottom end (right in LTR, left in RTL)

Optional Parameters:

• withCloseButton — When true, displays an X button to manually dismiss the toast
• autoDismissTimeout — Time in milliseconds before the toast automatically disappears. If not provided, the toast remains visible until manually dismissed

Browser Support

• Modern browsers with ES6+ support
• Iframe communication support required
• TypeScript 4.0+ for development

License

MIT

Maintainers

• Johnny Marelly ([email protected]) - Project maintenance and enhancements

Support

For questions, issues, or contributions, please contact the maintainers or open an issue in the project repository.