https://github.com/s2-streamstore/s2-sdk-typescript
S2 Typescript SDK
https://github.com/s2-streamstore/s2-sdk-typescript
Last synced: about 1 month ago
JSON representation
S2 Typescript SDK
- Host: GitHub
- URL: https://github.com/s2-streamstore/s2-sdk-typescript
- Owner: s2-streamstore
- Created: 2025-01-15T15:59:43.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-31T07:49:42.000Z (about 2 months ago)
- Last Synced: 2025-04-12T01:06:15.841Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 368 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# streamstore
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *streamstore* API.
## Summary
S2 API: Serverless API for streaming data backed by object storage.
## Table of Contents
* [streamstore](#streamstore)
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Recommended Usage](#sdk-recommended-usage)
* [SDK Example Usage](#sdk-example-usage)
* [Authentication](#authentication)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Server-sent event streaming](#server-sent-event-streaming)
* [Pagination](#pagination)
* [Retries](#retries)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
## SDK Installation
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
### NPM
```bash
npm add @s2-dev/streamstore
```
### PNPM
```bash
pnpm add @s2-dev/streamstore
```
### Bun
```bash
bun add @s2-dev/streamstore
```
### Yarn
```bash
yarn add @s2-dev/streamstore zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
```
> [!NOTE]
> This package is published with CommonJS and ES Modules (ESM) support.
### Model Context Protocol (MCP) Server
This SDK is also an installable MCP server where the various SDK methods are
exposed as tools that can be invoked by AI applications.
> Node.js v20 or greater is required to run the MCP server from npm.
Claude installation steps
Add the following server definition to your `claude_desktop_config.json` file:
```json
{
"mcpServers": {
"S2": {
"command": "npx",
"args": [
"-y", "--package", "@s2-dev/streamstore",
"--",
"mcp", "start",
"--bearer-auth", "..."
]
}
}
}
```
Cursor installation steps
Create a `.cursor/mcp.json` file in your project root with the following content:
```json
{
"mcpServers": {
"S2": {
"command": "npx",
"args": [
"-y", "--package", "@s2-dev/streamstore",
"--",
"mcp", "start",
"--bearer-auth", "..."
]
}
}
}
```
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
```bash
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server
```
If the repo is a private repo you must add your Github PAT to download a release `-H "Authorization: Bearer {GITHUB_PAT}"`.
```json
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}
```
For a full list of server arguments, run:
```sh
npx -y --package @s2-dev/streamstore -- mcp start --help
```
## Requirements
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
## SDK Recommended Usage
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](#available-resources-and-operations)
or [Standalone functions](#standalone-functions).
```typescript
import { ReadRequest, S2Client } from "@s2-dev/streamstore";
const s2 = new S2Client({ authToken: "" });
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();
```
### Examples
- Using `S2Endpoints`
```typescript
const endpoints = new S2Endpoints(
"aws.s2.dev",
{
kind: BasinEndpointKind.Direct,
authority: "aws.s2.dev"
}
);
const s2 = new S2Client({ authToken: "", 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
```typescript
const s2 = new S2Client({ authToken: ""});
async function run() {
const refreshedToken = await fetchToken();
await s2.account.deleteBasin("my-favorite-basin", { authToken: refreshedToken });
}
run();
```
- Set custom user-agent
```typescript
const s2 = new S2Client({ authToken: "", userAgent: "say-cheese" });
async function run() {
const config = await s2.account.getBasinConfig("mehul-test");
console.log(config);
}
run();
```
- List Basins
```typescript
const s2 = new S2Client({ authToken: "" });
async function run() {
const allBasins = await s2.account.listBasins();
for await (const basin of allBasins) {
console.log(basin);
}
}
run();
```
## SDK Example Usage
### Example
```typescript
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();
```
## Authentication
### Per-Client Security Schemes
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:
```typescript
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 Resources and Operations
Available methods
### [account](docs/sdks/account/README.md)
* [listBasins](docs/sdks/account/README.md#listbasins) - List basins.
* [getBasinConfig](docs/sdks/account/README.md#getbasinconfig) - Get basin configuration.
* [createBasin](docs/sdks/account/README.md#createbasin) - Create a new basin.
* [deleteBasin](docs/sdks/account/README.md#deletebasin) - Delete a basin.
* [reconfigureBasin](docs/sdks/account/README.md#reconfigurebasin) - Update basin configuration.
### [basin](docs/sdks/basin/README.md)
* [listStreams](docs/sdks/basin/README.md#liststreams) - List Streams.
* [getStreamConfig](docs/sdks/basin/README.md#getstreamconfig) - Get stream configuration.
* [createStream](docs/sdks/basin/README.md#createstream) - Create a stream.
* [deleteStream](docs/sdks/basin/README.md#deletestream) - Delete a stream.
* [reconfigureStream](docs/sdks/basin/README.md#reconfigurestream) - Update stream configuration.
### [stream](docs/sdks/stream/README.md)
* [read](docs/sdks/stream/README.md#read) - Retrieve records.
* [append](docs/sdks/stream/README.md#append) - Append records.
* [checkTail](docs/sdks/stream/README.md#checktail) - Check the tail.
## 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](./FUNCTIONS.md).
Available standalone functions
- [`accountCreateBasin`](docs/sdks/account/README.md#createbasin) - Create a new basin.
- [`accountDeleteBasin`](docs/sdks/account/README.md#deletebasin) - Delete a basin.
- [`accountGetBasinConfig`](docs/sdks/account/README.md#getbasinconfig) - Get basin configuration.
- [`accountListBasins`](docs/sdks/account/README.md#listbasins) - List basins.
- [`accountReconfigureBasin`](docs/sdks/account/README.md#reconfigurebasin) - Update basin configuration.
- [`basinCreateStream`](docs/sdks/basin/README.md#createstream) - Create a stream.
- [`basinDeleteStream`](docs/sdks/basin/README.md#deletestream) - Delete a stream.
- [`basinGetStreamConfig`](docs/sdks/basin/README.md#getstreamconfig) - Get stream configuration.
- [`basinListStreams`](docs/sdks/basin/README.md#liststreams) - List Streams.
- [`basinReconfigureStream`](docs/sdks/basin/README.md#reconfigurestream) - Update stream configuration.
- [`streamAppend`](docs/sdks/stream/README.md#append) - Append records.
- [`streamCheckTail`](docs/sdks/stream/README.md#checktail) - Check the tail.
- [`streamRead`](docs/sdks/stream/README.md#read) - Retrieve records.
## Server-sent event streaming
[Server-sent events][mdn-sse] 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`][mdn-for-await-of] loop. The loop will
terminate when the server no longer has any events to send and closes the
underlying connection.
```typescript
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: "",
});
for await (const event of result) {
// Handle the event
console.log(event);
}
}
run();
```
[mdn-sse]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
[mdn-for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
## Pagination
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`][for-await-of]
syntax.
[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
Here's an example of one such pagination call:
```typescript
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();
```
## 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:
```typescript
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:
```typescript
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();
```
## Error Handling
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`.
```typescript
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 |
## 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:
```typescript
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();
```
### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```typescript
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();
```
## Custom HTTP Client
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/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:
```typescript
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 });
```
## 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.
```typescript
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.
# Development
## Maturity
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.
## Contributions
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.
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=streamstore&utm_campaign=typescript)