Anagrama TypeScript SDK

The official TypeScript/JavaScript SDK for the Anagrama API.

Installation

npm install @anagramagames/sdk

Usage

The full API of this library can be found in api.md.

import Anagrama from '@anagramagames/sdk';

const client = new Anagrama({
  apiKey: process.env['ANAGRAMA_API_KEY'], // This is the default and can be omitted
});

const response = await client.words.getRandom({
  count: 3,
  maxLength: 8,
  minLength: 5,
});

console.log(response.count);

Request & Response types

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

import Anagrama from '@anagramagames/sdk';

const client = new Anagrama({
  apiKey: process.env['ANAGRAMA_API_KEY'], // This is the default and can be omitted
});

const params: Anagrama.WordGetRandomParams = {
  count: 3,
  maxLength: 8,
  minLength: 5,
};
const response: Anagrama.WordGetRandomResponse = await client.words.getRandom(params);

Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.

Handling errors

When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of APIError will be thrown:

const response = await client.words
  .getRandom({
    count: 3,
    maxLength: 8,
    minLength: 5,
  })
  .catch(async (err) => {
    if (err instanceof Anagrama.APIError) {
      console.log(err.status); // 400
      console.log(err.name); // BadRequestError
      console.log(err.headers); // {server: 'nginx', ...}
    } else {
      throw err;
    }
  });

Error codes are as follows:

| Status Code | Error Type | | ----------- | -------------------------- | | 400 | BadRequestError | | 401 | AuthenticationError | | 403 | PermissionDeniedError | | 404 | NotFoundError | | 422 | UnprocessableEntityError | | 429 | RateLimitError | | >=500 | InternalServerError | | N/A | APIConnectionError |

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried by default.

You can use the maxRetries option to configure or disable this:

// Configure the default for all requests:
const client = new Anagrama({
  maxRetries: 0, // default is 2
});

// Or, configure per-request:
await client.words.getRandom({
  count: 3,
  maxLength: 8,
  minLength: 5,
}, {
  maxRetries: 5,
});

Timeouts

Requests time out after 1 minute by default. You can configure this with a timeout option:

// Configure the default for all requests:
const client = new Anagrama({
  timeout: 20 * 1000, // 20 seconds (default is 1 minute)
});

// Override per-request:
await client.words.getRandom({
  count: 3,
  maxLength: 8,
  minLength: 5,
}, {
  timeout: 5 * 1000,
});

On timeout, an APIConnectionTimeoutError is thrown.

Note that requests which time out will be retried twice by default.

Advanced Usage

Accessing raw Response data (e.g., headers)

The "raw" Response returned by fetch() can be accessed through the .asResponse() method on the APIPromise type that all methods return. This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.

You can also use the .withResponse() method to get the raw Response along with the parsed data. Unlike .asResponse() this method consumes the body, returning once it is parsed.

const client = new Anagrama();

const response = await client.words
  .getRandom({
    count: 3,
    maxLength: 8,
    minLength: 5,
  })
  .asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object

const { data: response, response: raw } = await client.words
  .getRandom({
    count: 3,
    maxLength: 8,
    minLength: 5,
  })
  .withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(response.count);

Logging

[!IMPORTANT] All log messages are intended for debugging only. The format and content of log messages may change between releases.

Log levels

The log level can be configured in two ways:

1. Via the ANAGRAMA_LOG environment variable
2. Using the logLevel client option (overrides the environment variable if set)

import Anagrama from '@anagramagames/sdk';

const client = new Anagrama({
  logLevel: 'debug', // Show all log messages
});

Available log levels, from most to least verbose:

• 'debug' - Show debug messages, info, warnings, and errors
• 'info' - Show info messages, warnings, and errors
• 'warn' - Show warnings and errors (default)
• 'error' - Show only errors
• 'off' - Disable all logging

At the 'debug' level, all HTTP requests and responses are logged, including headers and bodies. Some authentication-related headers are redacted, but sensitive data in request and response bodies may still be visible.

Custom logger

By default, this library logs to globalThis.console. You can also provide a custom logger. Most logging libraries are supported, including pino, winston, bunyan, consola, signale, and @std/log. If your logger doesn't work, please open an issue.

When providing a custom logger, the logLevel option still controls which messages are emitted, messages below the configured level will not be sent to your logger.

import Anagrama from '@anagramagames/sdk';
import pino from 'pino';

const logger = pino();

const client = new Anagrama({
  logger: logger.child({ name: 'Anagrama' }),
  logLevel: 'debug', // Send all messages to pino, allowing it to filter
});

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Requirements

TypeScript >= 4.9 is supported.

The following runtimes are supported:

• Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)
• Node.js 20 LTS or later (non-EOL) versions.
• Deno v1.28.0 or higher.
• Bun 1.0 or later.
• Cloudflare Workers.
• Vercel Edge Runtime.
• Jest 28 or greater with the "node" environment ("jsdom" is not supported at this time).
• Nitro v2.6 or greater.

Note that React Native is not supported at this time.

If you are interested in other runtime environments, please open or upvote an issue on GitHub.

Contributing

See the contributing documentation.