@raindrop-ai/query

Official TypeScript SDK for the Raindrop Query API.

Summary

Raindrop Query API (Beta): API for querying Signals, Events, Users, and Conversations data.

Table of Contents

• @raindrop-ai/query
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Support

SDK Installation

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

NPM

npm add @raindrop-ai/query

PNPM

pnpm add @raindrop-ai/query

Bun

bun add @raindrop-ai/query

Yarn

yarn add @raindrop-ai/query

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 { RaindropQuery } from "@raindrop-ai/query";

const raindropQuery = new RaindropQuery({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await raindropQuery.signals.list({});

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | -------- | ---- | ----------- | | apiKey | http | HTTP Bearer |

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

import { RaindropQuery } from "@raindrop-ai/query";

const raindropQuery = new RaindropQuery({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await raindropQuery.signals.list({});

  console.log(result);
}

run();

Available Resources and Operations

Conversations

• list - List conversations
• get - Get conversation details

Events

• list - List events
• search - Search events (GET)
• count - Count events
• timeseries - Get event timeseries
• facets - Get event facets
• get - Get event details

SignalGroups

• list - List all signal groups
• get - Get signal group details
• listSignals - List signals in group

Signals

• list - List all signals
• get - Get signal details

Users

• list - List users
• get - Get user details

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.

• conversationsGet - Get conversation details
• conversationsList - List conversations
• eventsCount - Count events
• eventsFacets - Get event facets
• eventsGet - Get event details
• eventsList - List events
• eventsSearch - Search events (GET)
• eventsTimeseries - Get event timeseries
• signalGroupsGet - Get signal group details
• signalGroupsList - List all signal groups
• signalGroupsListSignals - List signals in group
• signalsGet - Get signal details
• signalsList - List all signals
• usersGet - Get user details
• usersList - List users

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 { RaindropQuery } from "@raindrop-ai/query";

const raindropQuery = new RaindropQuery({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await raindropQuery.signals.list({}, {
    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 { RaindropQuery } from "@raindrop-ai/query";

const raindropQuery = new RaindropQuery({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await raindropQuery.signals.list({});

  console.log(result);
}

run();

Error Handling

RaindropQueryError 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 { RaindropQuery } from "@raindrop-ai/query";
import * as errors from "@raindrop-ai/query/models/errors";

const raindropQuery = new RaindropQuery({
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  try {
    const result = await raindropQuery.signals.list({});

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.RaindropQueryError) {
      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.SignalsListUnauthorizedError) {
        console.log(error.data$.error); // operations.SignalsListError
      }
    }
  }
}

run();

Error Classes

Primary error:

• RaindropQueryError: 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 RaindropQueryError:

• EventsSearchBadRequestError: Invalid request (e.g., date range exceeds maximum). Status code 400. Applicable to 1 of 15 methods.*
• EventsFacetsBadRequestError: Invalid field name. Status code 400. Applicable to 1 of 15 methods.*
• SignalsListUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 15 methods.*
• SignalGroupsListUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 15 methods.*
• EventsListUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 15 methods.*
• UsersListUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 15 methods.*
• ConversationsListUnauthorizedError: Unauthorized. Status code 401. Applicable to 1 of 15 methods.*
• SignalsGetNotFoundError: Signal not found. Status code 404. Applicable to 1 of 15 methods.*
• SignalGroupsGetNotFoundError: Signal group not found. Status code 404. Applicable to 1 of 15 methods.*
• SignalGroupsListSignalsNotFoundError: Signal group not found. Status code 404. Applicable to 1 of 15 methods.*
• EventsGetNotFoundError: Event not found. Status code 404. Applicable to 1 of 15 methods.*
• UsersGetNotFoundError: User not found. Status code 404. Applicable to 1 of 15 methods.*
• ConversationsGetNotFoundError: Conversation not found. Status code 404. Applicable to 1 of 15 methods.*
• 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.

* Check the method documentation to see if the error is applicable.

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 { RaindropQuery } from "@raindrop-ai/query";

const raindropQuery = new RaindropQuery({
  serverURL: "https://query.raindrop.ai",
  apiKey: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await raindropQuery.signals.list({});

  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 use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { RaindropQuery } from "@raindrop-ai/query";
import { HTTPClient } from "@raindrop-ai/query/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 RaindropQuery({ 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 { RaindropQuery } from "@raindrop-ai/query";

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

Development

Maturity

This SDK is in beta. We recommend pinning to a specific version.

Support

For questions or issues, contact [email protected]