SDK

bun add @dnax/[email protected]

import { Rest } from '@dnax/sdk';

const api = new Rest({
  server: 'http://localhost:5000',
  tenant: 'v1',
});

const users = await api.find('users');

const api = new Rest(options: RestClientOptions);

const api = new Rest({
  server: 'https://api.example.com',
  tenant: 'v1',
  headers: {
    'X-Custom-Header': 'value',
  },
  token: {
    persist: true,
    storageKey: 'my_app_token',
  },
});

const { token, data } = await api.login('users', {
  email: '[email protected]',
  password: 'secret',
});

await api.logout('users');

const token = api.getToken(); // string | undefined

api.clearToken();

api.setHeader('X-Custom', 'value');
api.setHeader('X-Custom', undefined); // removes it

const users = await api.find('users', {
  $match: { activated: true },
  $sort: { createdAt: -1 },
  $limit: 20,
});

const user = await api.findOne('users', '64f1a2b3c4d5e6f7a8b9c0d1');

const newUser = await api.insertOne('users', {
  name: 'Jane Doe',
  email: '[email protected]',
});
// newUser._id is available

const products = await api.insertMany('products', [
  { name: 'Widget A', price: 9.99 },
  { name: 'Widget B', price: 14.99 },
]);

await api.updateOne('users', '64f1a2b3c4d5e6f7a8b9c0d1', {
  $set: { name: 'Jane Smith' },
});

await api.updateMany('users', ['id1', 'id2', 'id3'], {
  $set: { activated: true },
});

await api.deleteOne('users', '64f1a2b3c4d5e6f7a8b9c0d1');

await api.deleteMany('users', ['id1', 'id2', 'id3']);

const stats = await api.aggregate('orders', [
  { $match: { status: 'completed' } },
  { $group: { _id: '$customerId', total: { $sum: '$amount' } } },
  { $sort: { total: -1 } },
]);

const result = await api.runAction('orders', 'processOrder', {
  orderId: '64f1a2b3c4d5e6f7a8b9c0d1',
});

const report = await api.runService('analytics', 'generateReport', {
  from: '2025-01-01',
  to: '2025-12-31',
});

type RestRequestOptions = {
  headers?: Record<string, string>;
  signal?: AbortSignal;
  query?: RestQueryOptions;
  cleanDeep?: boolean;
};

const controller = new AbortController();

api.find('users', {}, { signal: controller.signal });

setTimeout(() => controller.abort(), 5000);

await api.insertOne('users', {
  name: 'Jane',
  nickname: null,
  tags: [],
  meta: {},
}, { cleanDeep: true });
// Body sent: { name: 'Jane' }

try {
  await api.findOne('users', 'invalid-id');
} catch (err) {
  console.log(err.message); // "Document not found"
  console.log(err.status);  // 404
  console.log(err.code);    // "DOCUMENT_NOT_FOUND"
  console.log(err.meta);    // additional info from server
}

import { Rest } from '@dnax/sdk';

const api = new Rest({
  server: 'http://localhost:5000',
  tenant: 'v1',
});

// Login
const { token } = await api.login('users', {
  email: '[email protected]',
  password: 'secret',
});

// Create
const product = await api.insertOne('products', {
  name: 'T-Shirt',
  price: 29.99,
  category: 'clothing',
});

// Read
const products = await api.find('products', {
  $match: { category: 'clothing' },
  $sort: { price: 1 },
  $limit: 10,
});

// Update
await api.updateOne('products', product._id, {
  $set: { price: 24.99 },
});

// Delete
await api.deleteOne('products', product._id);

// Custom action
await api.runAction('orders', 'processOrder', { orderId: '...' });

// Aggregate
const stats = await api.aggregate('orders', [
  { $group: { _id: '$status', count: { $sum: 1 } } },
]);

// Logout
await api.logout('users');