Limrun TypeScript API Library

This library provides convenient access to the Limrun REST API from server-side TypeScript or JavaScript.

The REST API documentation can be found on lim.run. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

npm install @limrun/api

Usage

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

import Limrun from '@limrun/api';

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

const androidInstance = await client.androidInstances.create();

console.log(androidInstance.metadata);

Request & Response types

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

import Limrun from '@limrun/api';

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

const androidInstance: Limrun.AndroidInstance = await client.androidInstances.create();

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

Workload permissions

An instance's role controls which resources its workload can access. Set spec.role.permissions when creating an Xcode, Gradle, iOS, or Android instance:

spec: {
  role: {
    permissions: ['asset:name/releases/app.apk:upload'],
  },
}

Permission strings follow resource:target:verb. Assets are the first supported resource type. The role is a general workload authorization policy; it is separate from build settings and upload destinations.

The creator must have authority to delegate every permission in the list. Permissions are fixed at creation and cannot be added by a later build request. Use role: { permissions: [] } when a workload needs no resource access. Omitting role retains the organization's compatibility default. The SDK sends the permission list as supplied and does not infer grants from later operations.

Asset upload example

Grant access at creation, then pass a concrete upload.target when building:

const instance = await client.gradleInstances.create({
  wait: true,
  spec: {
    role: {
      permissions: [
        'asset:name/releases/app.apk:create',
        'asset:name/releases/app.apk:upload',
        'asset:name/releases/app.apk:update',
      ],
    },
  },
});
const gradle = await client.gradleInstances.createClient({ instance });
await gradle.sync('./android-app', { watch: false });
await gradle.gradlebuild({ upload: { target: 'name/releases/app.apk' } });

Xcode uses the same upload options: xcode.xcodebuild(undefined, { upload: { target: 'name/releases/app.ipa' } }). Grant the corresponding .ipa permissions when creating that Xcode instance. create permits creating a missing named asset, upload permits writing its contents, and update permits applying metadata and the default expiry. An existing asset ID can replace name/... in both the permissions and target.

Permissions may use * and ? in name patterns, such as asset:name/releases/app-*.apk:upload. Assigning any pattern requires the caller to have asset:*:<verb> or broader authority for that verb. Upload targets are always concrete names or IDs. Names are literal, including slashes and colons; do not percent-encode them.

An existing signed URL still works with upload: { signedUploadUrl: 'https://storage.example/upload' } and needs no asset grants on the workload. Fetch download URLs through client.assets with the caller's read permission after the upload completes. See the Xcode example for a complete build and download flow.

Disk snapshots

Pass spec.snapshot when creating an Xcode instance to restore a saved workspace and publish the next successful build when the instance terminates:

const instance = await client.xcodeInstances.create({
  wait: true,
  spec: { snapshot: { key: 'myapp-main' } },
});
const { snapshot } = await client.xcodeInstances.followSnapshot(instance.metadata.id);

Check snapshot.restore.phase before syncing and building. Use getSnapshot to read the current state and bindSnapshotKey to set a publication key once on an instance already prepared for snapshots. A save watcher uses followSnapshot with side: 'save'; subscribe before deleting the instance. See the disk snapshot guide for the full lifecycle.

Existing spec.cache, getCache, bindCacheKey, followCache, and cache-named types remain supported. Snapshot methods expose the saved key as save.snapshotKey; legacy methods keep save.cacheKey.

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 androidInstance = await client.androidInstances.create().catch(async (err) => {
  if (err instanceof Limrun.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 Limrun({
  maxRetries: 0, // default is 2
});

// Or, configure per-request:
await client.androidInstances.create({
  maxRetries: 5,
});

Timeouts

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

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

// Override per-request:
await client.androidInstances.create({
  timeout: 5 * 1000,
});

On timeout, an APIConnectionTimeoutError is thrown.

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

Auto-pagination

List methods in the Limrun API are paginated. You can use the for await … of syntax to iterate through items across all pages:

async function fetchAllAndroidInstances(params) {
  const allAndroidInstances = [];
  // Automatically fetches more pages as needed.
  for await (const androidInstance of client.androidInstances.list()) {
    allAndroidInstances.push(androidInstance);
  }
  return allAndroidInstances;
}

Alternatively, you can request a single page at a time:

let page = await client.androidInstances.list();
for (const androidInstance of page.items) {
  console.log(androidInstance);
}

// Convenience methods are provided for manually paginating:
while (page.hasNextPage()) {
  page = await page.getNextPage();
  // ...
}

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 Limrun();

const response = await client.androidInstances.create().asResponse();
console.log(response.headers.get('X-My-Header'));
console.log(response.statusText); // access the underlying Response object

const { data: androidInstance, response: raw } = await client.androidInstances
  .create()
  .withResponse();
console.log(raw.headers.get('X-My-Header'));
console.log(androidInstance.metadata);

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 LIMRUN_LOG environment variable
2. Using the logLevel client option (overrides the environment variable if set)

import Limrun from '@limrun/api';

const client = new Limrun({
  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 Limrun from '@limrun/api';
import pino from 'pino';

const logger = pino();

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

Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.get, client.post, and other HTTP verbs. Options on the client, such as retries, will be respected when making these requests.

await client.post('/some/path', {
  body: { some_prop: 'foo' },
  query: { some_query_arg: 'bar' },
});

Undocumented request params

To make requests using undocumented parameters, you may use // @ts-expect-error on the undocumented parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you send will be sent as-is.

client.androidInstances.create({
  // ...
  // @ts-expect-error baz is not yet public
  baz: 'undocumented option',
});

For requests with the GET verb, any extra params will be in the query, all other requests will send the extra param in the body.

If you want to explicitly send an extra argument, you can do so with the query, body, and headers request options.

Undocumented response properties

To access undocumented response properties, you may access the response object with // @ts-expect-error on the response object, or cast the response object to the requisite type. Like the request params, we do not validate or strip extra properties from the response from the API.

Customizing the fetch client

By default, this library expects a global fetch function is defined.

If you want to use a different fetch function, you can either polyfill the global:

import fetch from 'my-fetch';

globalThis.fetch = fetch;

Or pass it to the client:

import Limrun from '@limrun/api';
import fetch from 'my-fetch';

const client = new Limrun({ fetch });

Fetch options

If you want to set custom fetch options without overriding the fetch function, you can provide a fetchOptions object when instantiating the client or making a request. (Request-specific options override client options.)

import Limrun from '@limrun/api';

const client = new Limrun({
  fetchOptions: {
    // `RequestInit` options
  },
});

Configuring proxies

To modify proxy behavior, you can provide custom fetchOptions that add runtime-specific proxy options to requests:

Node [docs]

import Limrun from '@limrun/api';
import * as undici from 'undici';

const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
const client = new Limrun({
  fetchOptions: {
    dispatcher: proxyAgent,
  },
});

Bun [docs]

import Limrun from '@limrun/api';

const client = new Limrun({
  fetchOptions: {
    proxy: 'http://localhost:8888',
  },
});

Deno [docs]

import Limrun from 'npm:@limrun/api';

const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const client = new Limrun({
  fetchOptions: {
    client: httpClient,
  },
});

Frequently Asked Questions

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.