Firesync Client

Official Node.js client library for Firesync Connector API.

Installation

npm install firesync-connector-client

Usage

const { createClient } = require('firesync-client');

const client = createClient({
  appId: 'your-app-id',
  authToken: 'your-auth-token'
});

// SELECT example
const products = await client.select('products')
  .columns('id', 'name', 'price')
  .where([{ left: 'price', operator: '>', right: 100 }])
  .orderBy('name')
  .execute();

// INSERT example
await client.insert('products')
  .columns('name', 'price')
  .values('New Product', 199.99)
  .execute();

// UPDATE example
await client.update('products')
  .set([{ column: 'price', value: 149.99 }])
  .where([{ left: 'id', operator: '=', right: 1 }])
  .execute();

// DELETE example
await client.delete('products')
  .where([{ left: 'id', operator: '=', right: 1 }])
  .execute();

API Reference

createClient(config)

• config.baseURL (required): Your Firesync API base URL
• config.appId (required): Your application ID
• config.authToken (required): Your authorization token
• config.timeout (optional): Request timeout in milliseconds (default: 30000)

Query Methods

All query methods return a QueryBuilder instance that can be chained:

• .select(table)
• .insert(table)
• .update(table)
• .delete(table)
• .truncate(table)
• .drop(table)

Query Builder Methods

• .columns(...columns): Specify columns to select/insert
• .values(...values): Specify values for insert
• .where(conditions): Add WHERE conditions (array of objects)
• .orderBy(...fields): Add ORDER BY clauses
• .page(num): Set page number for pagination
• .pageSize(size): Set page size for pagination
• .set(updates): Add SET clauses for update (array of objects)
• .execute(): Execute the query

Error Handling

All errors thrown by the client will be instances of Error. API errors will include the status code and message from the server.

Services

Service: https://firesync.app