@anduril-industries/lattice-sdk

中文文档

5.4.0发布于 2026/10/31See LICENSETypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 5446

文档目录27 节

Table of Contents
Documentation
Requirements
Installation
Support
Reference
Usage
Environments
Authentication
Request and Response Types
Exception Handling
Streaming Response
File Uploads
Metadata
Binary Response
Pagination
Advanced
Subpackage Exports
Additional Headers
Additional Query String Parameters
Retries
Timeouts
Aborting Requests
Access Raw Response Data
Logging
Custom Fetch
Runtime Compatibility

Lattice SDK TypeScript Library

The Lattice SDK TypeScript library provides convenient access to the Lattice SDK APIs from TypeScript.

Documentation
Requirements
Installation
Support
Reference
Usage
Environments
Authentication
Request and Response Types
Exception Handling
Streaming Response
File Uploads
Binary Response
Pagination
Advanced

Documentation

API reference documentation is available here.

Requirements

To use the SDK please ensure you have the following installed:

NodeJS

Installation

npm i -s @anduril-industries/lattice-sdk

Support

For support with this library, please reach out to your Anduril representative.

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

import { LatticeClient } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" });
await client.entities.longPollEntityEvents({
    sessionToken: "sessionToken"
});

Environments

This SDK allows you to configure different environments for API requests.

import { LatticeClient, LatticeEnvironment } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({
    environment: LatticeEnvironment.Default,
});

Authentication

The SDK supports OAuth authentication with two options:

Option 1: OAuth Client Credentials Flow

Use this when you want the SDK to automatically handle OAuth token retrieval and refreshing:

import { LatticeClient } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({
    clientId: "YOUR_CLIENT_ID",
    clientSecret: "YOUR_CLIENT_SECRET",
    ...
});

Option 2: Token Override

Use this when you already have a valid bearer token and want to skip the OAuth flow:

import { LatticeClient } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({
    token: "my-pre-generated-bearer-token",
    ...
});

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace:

import { Lattice } from "@anduril-industries/lattice-sdk";

const request: Lattice.GetEntityRequest = {
    ...
};

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

import { LatticeError } from "@anduril-industries/lattice-sdk";

try {
    await client.entities.longPollEntityEvents(...);
} catch (err) {
    if (err instanceof LatticeError) {
        console.log(err.statusCode);
        console.log(err.message);
        console.log(err.body);
        console.log(err.rawResponse);
    }
}

Streaming Response

Some endpoints return streaming responses instead of returning the full response at once. The SDK uses async iterators, so you can consume the responses using a for await...of loop.

import { LatticeClient } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" });
const response = await client.entities.streamEntities();
for await (const item of response) {
    console.log(item);
}

File Uploads

You can upload files using the client:

import { createReadStream } from "fs";

await client.objects.uploadObject(createReadStream("path/to/file"), ...);
await client.objects.uploadObject(new ReadableStream(), ...);
await client.objects.uploadObject(Buffer.from('binary data'), ...);
await client.objects.uploadObject(new Blob(['binary data'], { type: 'audio/mpeg' }), ...);
await client.objects.uploadObject(new File(['binary data'], 'file.mp3'), ...);
await client.objects.uploadObject(new ArrayBuffer(8), ...);
await client.objects.uploadObject(new Uint8Array([0, 1, 2]), ...);

The client accepts a variety of types for file upload parameters:

Stream types: fs.ReadStream, stream.Readable, and ReadableStream
Buffered types: Buffer, Blob, File, ArrayBuffer, ArrayBufferView, and Uint8Array

Metadata

You can configure metadata when uploading a file:

const file: Uploadable.WithMetadata = {
    data: createReadStream("path/to/file"),
    filename: "my-file",       // optional
    contentType: "audio/mpeg", // optional
    contentLength: 1949,       // optional
};

Alternatively, you can upload a file directly from a file path:

const file : Uploadable.FromPath = {
    path: "path/to/file",
    filename: "my-file",        // optional
    contentType: "audio/mpeg",  // optional
    contentLength: 1949,        // optional
};

The metadata is used to set the Content-Length, Content-Type, and Content-Disposition headers. If not provided, the client will attempt to determine them automatically. For example, fs.ReadStream has a path property which the SDK uses to retrieve the file size from the filesystem without loading it into memory.

Binary Response

You can consume binary data from endpoints using the BinaryResponse type which lets you choose how to consume the data:

const response = await client.objects.getObject(...);
const stream: ReadableStream<Uint8Array> = response.stream();
// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
// const blob: Blob = response.blob();
// const bytes: Uint8Array = response.bytes();
// You can only use the response body once, so you must choose one of the above methods.
// If you want to check if the response body has been used, you can use the following property.
const bodyUsed = response.bodyUsed;

Save binary response to a file

Node.js

ReadableStream (most-efficient)

import { createWriteStream } from 'fs';
import { Readable } from 'stream';
import { pipeline } from 'stream/promises';

const response = await client.objects.getObject(...);

const stream = response.stream();
const nodeStream = Readable.fromWeb(stream);
const writeStream = createWriteStream('path/to/file');

await pipeline(nodeStream, writeStream);

ArrayBuffer

import { writeFile } from 'fs/promises';

const response = await client.objects.getObject(...);

const arrayBuffer = await response.arrayBuffer();
await writeFile('path/to/file', Buffer.from(arrayBuffer));

Blob

import { writeFile } from 'fs/promises';

const response = await client.objects.getObject(...);

const blob = await response.blob();
const arrayBuffer = await blob.arrayBuffer();
await writeFile('output.bin', Buffer.from(arrayBuffer));

Bytes (UIntArray8)

import { writeFile } from 'fs/promises';

const response = await client.objects.getObject(...);

const bytes = await response.bytes();
await writeFile('path/to/file', bytes);

Bun

ReadableStream (most-efficient)

const response = await client.objects.getObject(...);

const stream = response.stream();
await Bun.write('path/to/file', stream);

ArrayBuffer

const response = await client.objects.getObject(...);

const arrayBuffer = await response.arrayBuffer();
await Bun.write('path/to/file', arrayBuffer);

Blob

const response = await client.objects.getObject(...);

const blob = await response.blob();
await Bun.write('path/to/file', blob);

Bytes (UIntArray8)

const response = await client.objects.getObject(...);

const bytes = await response.bytes();
await Bun.write('path/to/file', bytes);

Deno

ReadableStream (most-efficient)

const response = await client.objects.getObject(...);

const stream = response.stream();
const file = await Deno.open('path/to/file', { write: true, create: true });
await stream.pipeTo(file.writable);

ArrayBuffer

const response = await client.objects.getObject(...);

const arrayBuffer = await response.arrayBuffer();
await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));

Blob

const response = await client.objects.getObject(...);

const blob = await response.blob();
const arrayBuffer = await blob.arrayBuffer();
await Deno.writeFile('path/to/file', new Uint8Array(arrayBuffer));

Bytes (UIntArray8)

const response = await client.objects.getObject(...);

const bytes = await response.bytes();
await Deno.writeFile('path/to/file', bytes);

Browser

Blob (most-efficient)

const response = await client.objects.getObject(...);

const blob = await response.blob();
const url = URL.createObjectURL(blob);

// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);

ReadableStream

const response = await client.objects.getObject(...);

const stream = response.stream();
const reader = stream.getReader();
const chunks = [];

while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  chunks.push(value);
}

const blob = new Blob(chunks);
const url = URL.createObjectURL(blob);

// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);

ArrayBuffer

const response = await client.objects.getObject(...);

const arrayBuffer = await response.arrayBuffer();
const blob = new Blob([arrayBuffer]);
const url = URL.createObjectURL(blob);

// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);

Bytes (UIntArray8)

const response = await client.objects.getObject(...);

const bytes = await response.bytes();
const blob = new Blob([bytes]);
const url = URL.createObjectURL(blob);

// trigger download
const a = document.createElement('a');
a.href = url;
a.download = 'filename';
a.click();
URL.revokeObjectURL(url);

Convert binary response to text

ReadableStream

const response = await client.objects.getObject(...);

const stream = response.stream();
const text = await new Response(stream).text();

ArrayBuffer

const response = await client.objects.getObject(...);

const arrayBuffer = await response.arrayBuffer();
const text = new TextDecoder().decode(arrayBuffer);

Blob

const response = await client.objects.getObject(...);

const blob = await response.blob();
const text = await blob.text();

Bytes (UIntArray8)

const response = await client.objects.getObject(...);

const bytes = await response.bytes();
const text = new TextDecoder().decode(bytes);

Pagination

List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:

import { LatticeClient } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" });
const pageableResponse = await client.objects.listObjects();
for await (const item of pageableResponse) {
    console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.objects.listObjects();
while (page.hasNextPage()) {
    page = await page.getNextPage();
}

// You can also access the underlying response
const response = page.response;

Advanced

Subpackage Exports

This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.

import { EntitiesClient } from '@anduril-industries/lattice-sdk/entities';

const client = new EntitiesClient({...});

Additional Headers

If you would like to send additional headers as part of the request, use the headers request option.

import { LatticeClient } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({
    ...
    headers: {
        'X-Custom-Header': 'custom value'
    }
});

const response = await client.entities.longPollEntityEvents(..., {
    headers: {
        'X-Custom-Header': 'custom value'
    }
});

Additional Query String Parameters

If you would like to send additional query string parameters as part of the request, use the queryParams request option.

const response = await client.entities.longPollEntityEvents(..., {
    queryParams: {
        'customQueryParamKey': 'custom query param value'
    }
});

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

408 (Timeout)
429 (Too Many Requests)
5XX (All server errors, including 500)

recommended: retries on

408 (Timeout)
429 (Too Many Requests)
502 (Bad Gateway)
503 (Service Unavailable)
504 (Gateway Timeout)

Use the maxRetries request option to configure this behavior.

const response = await client.entities.longPollEntityEvents(..., {
    maxRetries: 0 // override maxRetries at the request level
});

Timeouts

The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.

const response = await client.entities.longPollEntityEvents(..., {
    timeoutInSeconds: 30 // override timeout to 30s
});

Aborting Requests

The SDK allows users to abort requests at any point by passing in an abort signal.

const controller = new AbortController();
const response = await client.entities.longPollEntityEvents(..., {
    abortSignal: controller.signal
});
controller.abort(); // aborts the request

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .withRawResponse() method. The .withRawResponse() method returns a promise that results to an object with a data and a rawResponse property.

const { data, rawResponse } = await client.entities.longPollEntityEvents(...).withRawResponse();

console.log(data);
console.log(rawResponse.headers['X-My-Header']);

Logging

The SDK supports logging. You can configure the logger by passing in a logging object to the client options.

import { LatticeClient, logging } from "@anduril-industries/lattice-sdk";

const client = new LatticeClient({
    ...
    logging: {
        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
        silent: false, // defaults to true, set to false to enable logging
    }
});

The logging object can have the following properties:

level: The log level to use. Defaults to logging.LogLevel.Info.
logger: The logger to use. Defaults to a logging.ConsoleLogger.
silent: Whether to silence the logger. Defaults to true.

The level property can be one of the following values:

logging.LogLevel.Debug
logging.LogLevel.Info
logging.LogLevel.Warn
logging.LogLevel.Error

To provide a custom logger, you can pass in an object that implements the logging.ILogger interface.

Custom logger examples

Here's an example using the popular winston logging library.

import winston from 'winston';

const winstonLogger = winston.createLogger({...});

const logger: logging.ILogger = {
    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
    info: (msg, ...args) => winstonLogger.info(msg, ...args),
    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
    error: (msg, ...args) => winstonLogger.error(msg, ...args),
};

Here's an example using the popular pino logging library.

import pino from 'pino';

const pinoLogger = pino({...});

const logger: logging.ILogger = {
  debug: (msg, ...args) => pinoLogger.debug(args, msg),
  info: (msg, ...args) => pinoLogger.info(args, msg),
  warn: (msg, ...args) => pinoLogger.warn(args, msg),
  error: (msg, ...args) => pinoLogger.error(args, msg),
};

Custom Fetch

The SDK provides a low-level fetch method for making custom HTTP requests while still benefiting from SDK-level configuration like authentication, retries, timeouts, and logging. This is useful for calling API endpoints not yet supported in the SDK.

const response = await client.fetch("/v1/custom/endpoint", {
    method: "GET",
}, {
    timeoutInSeconds: 30,
    maxRetries: 3,
    headers: {
        "X-Custom-Header": "custom-value",
    },
});

const data = await response.json();

Runtime Compatibility

The SDK works in the following runtimes:

Node.js 18+
Vercel
Cloudflare Workers
Deno v1.25+
Bun 1.0+
React Native

版本与发布记录

@anduril-industries/lattice-sdk 共发布 62 个版本，首次发布于 2024/12/03；过去 12 个月发布了 41 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本	发布日期	距今
`5.4.0`latest	2026/10/31	8 天前
`5.3.0`	2026/10/28	11 天前
`5.2.1`	2026/10/17	22 天前
`5.2.0`	2026/10/08	1 个月前
`5.1.0`	2026/09/17	1 个月前
`5.0.0`	2026/09/09	1 个月前

其他发布通道：backport → 4.19.0。

关于 @anduril-industries/lattice-sdk 的常见问题

如何安装 @anduril-industries/lattice-sdk？

在项目目录运行 npm install @anduril-industries/lattice-sdk，或使用 pnpm add / yarn add / bun add。

@anduril-industries/lattice-sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@anduril-industries/lattice-sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require() 都可以使用，打包工具会自动选择合适的版本。

@anduril-industries/lattice-sdk 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js >=18.0.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@anduril-industries/lattice-sdk 可以商用吗？

@anduril-industries/lattice-sdk 使用 See LICENSE 许可。声明的许可为 See LICENSE，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

@anduril-industries/lattice-sdk 的下载量有多少？

根据 npm 官方下载统计，@anduril-industries/lattice-sdk 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,446 次，日均约 182 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@anduril-industries/lattice-sdk 还在维护吗？

最新版本 5.4.0 发布于 2026/10/31（8 天前）；至今共发布 62 个版本，其中过去 12 个月发布了 41 个；首次发布于 2024/12/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

npm install @anduril-industries/lattice-sdk

pnpmpnpm add @anduril-industries/lattice-sdk
yarnyarn add @anduril-industries/lattice-sdk
bunbun add @anduril-industries/lattice-sdk

在你的项目目录中运行此命令。

近 30 天下载

5,446

约 5446 次日均 182 次

统计周期 2026/10/06 – 2026/11/04
数据来自 npm 官方下载统计，1 天前更新

最新版本5.4.0发布于 8 天前

开源许可See LICENSE其他许可

包体积1.4 MB1,524 个文件 · 解压后

运行依赖0 个零依赖

模块格式ESM + CJS无副作用，可 tree-shake

TypeScript自带类型

Node.js>=18.0.0

发布版本62 个近 12 个月 41 个

首次发布2024/12/031.9 年前

元数据更新2026/10/31

每一个软件包背后，
都有分享与创造的人。

@anduril-industries/lattice-sdk

Lattice SDK TypeScript Library

Table of Contents

Documentation

Requirements

Installation

Support

Reference

Usage

Environments

Authentication

Request and Response Types

Exception Handling

Streaming Response

File Uploads

Metadata

Binary Response

Pagination

Advanced

Subpackage Exports

Additional Headers

Additional Query String Parameters

Retries

Timeouts

Aborting Requests

Access Raw Response Data

Logging

Custom Fetch

Runtime Compatibility

版本与发布记录

关于 @anduril-industries/lattice-sdk 的常见问题

如何安装 @anduril-industries/lattice-sdk？

@anduril-industries/lattice-sdk 支持 TypeScript 吗？

@anduril-industries/lattice-sdk 支持 ESM 还是 CommonJS？

@anduril-industries/lattice-sdk 需要什么版本的 Node.js？

@anduril-industries/lattice-sdk 可以商用吗？

@anduril-industries/lattice-sdk 的下载量有多少？

@anduril-industries/lattice-sdk 还在维护吗？