Developer-friendly & type-safe Typescript SDK specifically catered to leverage streamstore API.
S2 API: Serverless API for streaming data backed by object storage.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @s2-dev/streamstorepnpm add @s2-dev/streamstorebun add @s2-dev/streamstoreyarn add @s2-dev/streamstore zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.For supported JavaScript runtimes, please consult RUNTIMES.md.
The S2Client class provides a lot of convenience over the generated methods and is the recommended way to interact with the SDK. If you need finer control over the internal functions, you may use Generated functions
or Standalone functions.
import { ReadRequest, S2Client } from "@s2-dev/streamstore";
const s2 = new S2Client({ authToken: "<AUTH_TOKEN>" });
async function run() {
await s2.account.createBasin("my-favorite-basin");
await s2.account.basin("my-favorite-basin").stream("test").append({ appendInput: { records: [{ body: "hello" }] } });
}
run();- Using
S2Endpoints
const endpoints = new S2Endpoints(
"aws.s2.dev",
{
kind: BasinEndpointKind.Direct,
authority: "aws.s2.dev"
}
);
const s2 = new S2Client({ authToken: "<AUTH_TOKEN>", endpoints });
async function run() {
const allStreams = await s2.account.basin("my-favorite-basin").listStreams();
for await (const stream of allStreams) {
console.log(basin);
}
}
run();- Override Client level Auth token
const s2 = new S2Client({ authToken: "<AUTH_TOKEN>"});
async function run() {
const refreshedToken = await fetchToken();
await s2.account.deleteBasin("my-favorite-basin", { authToken: refreshedToken });
}
run();- Set custom user-agent
const s2 = new S2Client({ authToken: "<AUTH_TOKEN>", userAgent: "say-cheese" });
async function run() {
const config = await s2.account.getBasinConfig("mehul-test");
console.log(config);
}
run();- List Basins
const s2 = new S2Client({ authToken: "<AUTH_TOKEN>" });
async function run() {
const allBasins = await s2.account.listBasins();
for await (const basin of allBasins) {
console.log(basin);
}
}
run();import { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.account.listBasins({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
bearerAuth |
http | HTTP Bearer | S2_BEARER_AUTH |
To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:
import { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.account.listBasins({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();Available methods
- listBasins - List basins.
- getBasinConfig - Get basin configuration.
- createBasin - Create a new basin.
- deleteBasin - Delete a basin.
- reconfigureBasin - Update basin configuration.
- listStreams - List Streams.
- getStreamConfig - Get stream configuration.
- createStream - Create a stream.
- deleteStream - Delete a stream.
- reconfigureStream - Update stream configuration.
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
accountCreateBasin- Create a new basin.accountDeleteBasin- Delete a basin.accountGetBasinConfig- Get basin configuration.accountListBasins- List basins.accountReconfigureBasin- Update basin configuration.basinCreateStream- Create a stream.basinDeleteStream- Delete a stream.basinGetStreamConfig- Get stream configuration.basinListStreams- List Streams.basinReconfigureStream- Update stream configuration.streamAppend- Append records.streamCheckTail- Check the tail.streamRead- Retrieve records.
Server-sent events are used to stream content from certain
operations. These operations will expose the stream as an async iterable that
can be consumed using a for await...of loop. The loop will
terminate when the server no longer has any events to send and closes the
underlying connection.
import { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.stream.read({
stream: "<value>",
});
for await (const event of result) {
// Handle the event
console.log(event);
}
}
run();Some of the endpoints in this SDK support pagination. To use pagination, you
make your SDK calls as usual, but the returned response object will also be an
async iterable that can be consumed using the for await...of
syntax.
Here's an example of one such pagination call:
import { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.account.listBasins({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();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 { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.account.listBasins({}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
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 { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.account.listBasins({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the listBasins method may throw the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.ErrorResponse | 400, 401 | application/json |
| errors.RetryableError | 499 | application/json |
| errors.RetryableError | 500, 503, 504 | application/json |
| errors.APIError | 4XX, 5XX | */* |
If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.
import { S2 } from "@s2-dev/streamstore";
import {
ErrorResponse,
RetryableError,
SDKValidationError,
} from "@s2-dev/streamstore/models/errors";
const s2 = new S2({
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
let result;
try {
result = await s2.account.listBasins({});
for await (const page of result) {
// Handle the page
console.log(page);
}
} catch (err) {
switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): {
// Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof ErrorResponse): {
// Handle err.data$: ErrorResponseData
console.error(err);
return;
}
case (err instanceof RetryableError): {
// Handle err.data$: RetryableErrorData
console.error(err);
return;
}
case (err instanceof RetryableError): {
// Handle err.data$: RetryableErrorData
console.error(err);
return;
}
default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err;
}
}
}
}
run();Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:
| HTTP Client Error | Description |
|---|---|
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
serverURL: "https://aws.s2.dev/v1alpha",
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.account.listBasins({});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
import { S2 } from "@s2-dev/streamstore";
const s2 = new S2({
bearerAuth: process.env["S2_BEARER_AUTH"] ?? "",
});
async function run() {
const result = await s2.basin.listStreams({}, {
serverURL: "https://my-favorite-basin.b.aws.s2.dev/v1alpha",
});
for await (const page of result) {
// Handle the page
console.log(page);
}
}
run();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 { S2 } from "@s2-dev/streamstore";
import { HTTPClient } from "@s2-dev/streamstore/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 S2({ httpClient });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 { S2 } from "@s2-dev/streamstore";
const sdk = new S2({ debugLogger: console });You can also enable a default debug logger by setting an environment variable S2_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.