@aerostack/sdk-node

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @aerostack/sdk-node API.

[!IMPORTANT]

Summary

Aerostack API: Aerostack Platform API - Unified access to database, authentication, caching, queues, storage, and AI services.

Table of Contents

• @aerostack/sdk-node
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • File uploads
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
  • Backend Service Integration
• Development
  • Maturity
  • Contributions

SDK Installation

[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET>

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.database.dbQuery({
    xSDKVersion: "0.1.0",
    requestBody: {
      sql: "SELECT * FROM users WHERE active = ?",
      params: [
        true,
      ],
    },
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ------ | ------- | | apiKeyAuth | apiKey | API key |

To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.database.dbQuery({
    xSDKVersion: "0.1.0",
    requestBody: {
      sql: "SELECT * FROM users WHERE active = ?",
      params: [
        true,
      ],
    },
  });

  console.log(result);
}

run();

Available Resources and Operations

Ai

• aiChat - Generate AI chat completion

Ai.Search

• ingest - Ingest content into managed search index
• query - Search managed index
• delete - Delete item by ID
• deleteByType - Delete all items of a type
• listTypes - List distinct types and counts
• configure - Update search configuration

Authentication

• authSignup - Sign up new user
• authSignin - Sign in user

Cache

• cacheGet - Get cached value
• cacheSet - Set cached value

Database

• dbQuery - Execute SQL query

Gateway.Billing

• gatewayBillingLog - Log Gateway usage

Queue

• queueEnqueue - Add job to queue

Services

• servicesInvoke - Invoke another service

Storage

• storageUpload - Upload file to storage

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• aiAIChat - Generate AI chat completion
• aiSearchConfigure - Update search configuration
• aiSearchDelete - Delete item by ID
• aiSearchDeleteByType - Delete all items of a type
• aiSearchIngest - Ingest content into managed search index
• aiSearchListTypes - List distinct types and counts
• aiSearchQuery - Search managed index
• authenticationAuthSignin - Sign in user
• authenticationAuthSignup - Sign up new user
• cacheCacheGet - Get cached value
• cacheCacheSet - Set cached value
• databaseDbQuery - Execute SQL query
• gatewayBillingGatewayBillingLog - Log Gateway usage
• queueQueueEnqueue - Add job to queue
• servicesServicesInvoke - Invoke another service
• storageStorageUpload - Upload file to storage

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { SDK } from "@aerostack/sdk-node";
import { openAsBlob } from "node:fs";

const sdk = new SDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.storage.storageUpload({
    file: await openAsBlob("example.file"),
    key: "avatars/user-123.jpg",
    contentType: "image/jpeg",
  });

  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.database.dbQuery({
    xSDKVersion: "0.1.0",
    requestBody: {
      sql: "SELECT * FROM users WHERE active = ?",
      params: [
        true,
      ],
    },
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.database.dbQuery({
    xSDKVersion: "0.1.0",
    requestBody: {
      sql: "SELECT * FROM users WHERE active = ?",
      params: [
        true,
      ],
    },
  });

  console.log(result);
}

run();

Error Handling

SDKBaseError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { SDK } from "@aerostack/sdk-node";
import * as errors from "@aerostack/sdk-node/sdk/models/errors";

const sdk = new SDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  try {
    const result = await sdk.database.dbQuery({
      xSDKVersion: "0.1.0",
      requestBody: {
        sql: "SELECT * FROM users WHERE active = ?",
        params: [
          true,
        ],
      },
    });

    console.log(result);
  } catch (error) {
    if (error instanceof errors.SDKBaseError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• SDKBaseError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from SDKBaseError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Description | | --- | ----------------------------- | ----------------- | | 0 | https://api.aerostack.dev/v1 | Production | | 1 | http://localhost:8787/v1 | Local Development |

Example

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({
  serverIdx: 0,
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.database.dbQuery({
    xSDKVersion: "0.1.0",
    requestBody: {
      sql: "SELECT * FROM users WHERE active = ?",
      params: [
        true,
      ],
    },
  });

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({
  serverURL: "http://localhost:8787/v1",
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.database.dbQuery({
    xSDKVersion: "0.1.0",
    requestBody: {
      sql: "SELECT * FROM users WHERE active = ?",
      params: [
        true,
      ],
    },
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { SDK } from "@aerostack/sdk-node";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@aerostack/sdk-node/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new SDK({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({ debugLogger: console });

Backend Service Integration

SDK Type: HTTP Client (API Calls)

This SDK is an HTTP client that makes API calls to the Aerostack backend. It's ideal for:

✅ Use cases:

• Calling Aerostack Auth/E-commerce APIs from backend services (Node.js, Express, Nest.js)
• Integrating Aerostack features into existing applications
• Building API wrappers and middleware

❌ Not for:

• Direct access to Cloudflare bindings (D1, KV, Queue, R2) - use @aerostack/sdk Server SDK instead

Backend Wrapper Pattern

If you're building a Cloudflare Worker that needs both API calls AND direct binding access, use both SDKs:

// In a Cloudflare Worker
import { AerostackServer } from '@aerostack/sdk'; // For DB/Queue/Storage bindings
import { SDK as NodeSDK } from '@aerostack/node'; // For Auth/API calls

export default {
  async fetch(request: Request, env: Env) {
    // Direct bindings (fast, no HTTP overhead)
    const server = new AerostackServer(env);
    
    // HTTP API client (for Auth, etc.)
    const client = new NodeSDK({
      apiKeyAuth: env.AEROSTACK_API_KEY,
      serverURL: 'https://api.aerostack.dev/v1'
    });

    // Use both together
    const authResult = await client.authentication.authSignin({
      email: "[email protected]",
      password: "password"
    });

    await server.db.query(
      'INSERT INTO audit_logs (user_id, action) VALUES (?, ?)',
      [authResult.user.id, 'login']
    );

    return Response.json(authResult);
  }
};

For non-Worker backends (Node.js, Vercel, etc.), you only need this SDK.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.