Actual TypeScript SDK

The generated TypeScript SDK for the Actual API.

This repository is generated from the canonical OpenAPI contract in Rika-Labs/actual. Do not edit generated source directly.

Summary

Actual API: Actual coordinates requests toward verified physical outcomes. Availability in this contract is authoritative.

Table of Contents

• Actual TypeScript SDK
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging

SDK Installation

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

NPM

npm add @rikalabs/actual

PNPM

pnpm add @rikalabs/actual

Bun

bun add @rikalabs/actual

Yarn

yarn add @rikalabs/actual

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 { Actual } from "@rikalabs/actual";

const actual = new Actual();

async function run() {
  const result = await actual.waitlist.joinWaitlist({
    email: "Dante21@gmail.com",
    source: "landing",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Waitlist

• joinWaitlist - Join the early-access waitlist

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.

Available standalone functions

• waitlistJoinWaitlist - Join the early-access waitlist

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 { Actual } from "@rikalabs/actual";

const actual = new Actual();

async function run() {
  const result = await actual.waitlist.joinWaitlist({
    email: "Dante21@gmail.com",
    source: "landing",
  }, {
    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 { Actual } from "@rikalabs/actual";

const actual = new Actual({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await actual.waitlist.joinWaitlist({
    email: "Dante21@gmail.com",
    source: "landing",
  });

  console.log(result);
}

run();

Error Handling

ActualError 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
error.data$		Optional. Some errors may contain structured data. See Error Classes.

Example

import { Actual } from "@rikalabs/actual";
import * as errors from "@rikalabs/actual/models/errors";

const actual = new Actual();

async function run() {
  try {
    const result = await actual.waitlist.joinWaitlist({
      email: "Dante21@gmail.com",
      source: "landing",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ActualError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.InvalidJsonResponseError) {
        console.log(error.data$.error); // models.InvalidJsonResponseErrorUnion
      }
    }
  }
}

run();

Error Classes

Primary errors:

• ActualError: The base class for HTTP error responses.
  • InvalidJsonResponseError: InvalidJsonResponse. Status code 400.
  • InvalidEmailResponseError: InvalidEmailResponse. Status code 422.
  • WaitlistUnavailableResponseError: WaitlistUnavailableResponse. Status code 503.

Less common errors (6)

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 ActualError:

• 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

Override Server URL Per-Client

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

import { Actual } from "@rikalabs/actual";

const actual = new Actual({
  serverURL: "https://api.askactual.com",
});

async function run() {
  const result = await actual.waitlist.joinWaitlist({
    email: "Dante21@gmail.com",
    source: "landing",
  });

  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 { Actual } from "@rikalabs/actual";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@rikalabs/actual/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 Actual({ 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 { Actual } from "@rikalabs/actual";

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

You can also enable a default debug logger by setting an environment variable ACTUAL_DEBUG to true.