@s2-dev/streamstore 0.15.12 → 0.16.0

package/docs/sdks/streams/README.md

@@ -1,485 +0,0 @@
-# Streams
-(*streams*)
-
-## Overview
-
-Manage streams
-
-### Available Operations
-
-* [listStreams](#liststreams) - List streams.
-* [createStream](#createstream) - Create a stream.
-* [getStreamConfig](#getstreamconfig) - Get stream configuration.
-* [createOrReconfigureStream](#createorreconfigurestream) - Create or reconfigure a stream.
-* [deleteStream](#deletestream) - Delete a stream.
-* [reconfigureStream](#reconfigurestream) - Reconfigure a stream.
-
-## listStreams
-
-List streams.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list_streams" method="get" path="/streams" -->
-```typescript
-import { S2 } from "@s2-dev/streamstore";
-
-const s2 = new S2({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await s2.streams.listStreams({
-    s2Basin: "<value>",
-  });
-
-  for await (const page of result) {
-    console.log(page);
-  }
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { S2Core } from "@s2-dev/streamstore/core.js";
-import { streamsListStreams } from "@s2-dev/streamstore/funcs/streamsListStreams.js";
-
-// Use `S2Core` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const s2 = new S2Core({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const res = await streamsListStreams(s2, {
-    s2Basin: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("streamsListStreams failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListStreamsRequest](../../models/operations/liststreamsrequest.md)                                                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-| `options.serverURL`                                                                                                                                                            | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | An optional server URL to use.                                                                                                                                                 |
-
-### Response
-
-**Promise\<[operations.ListStreamsResponse](../../models/operations/liststreamsresponse.md)\>**
-
-### Errors
-
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 400, 403, 404        | application/json     |
-| errors.APIError      | 4XX, 5XX             | \*/\*                |
-
-## createStream
-
-Create a stream.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="create_stream" method="post" path="/streams" -->
-```typescript
-import { S2 } from "@s2-dev/streamstore";
-
-const s2 = new S2({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await s2.streams.createStream({
-    s2Basin: "<value>",
-    createStreamRequest: {
-      stream: "<value>",
-    },
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { S2Core } from "@s2-dev/streamstore/core.js";
-import { streamsCreateStream } from "@s2-dev/streamstore/funcs/streamsCreateStream.js";
-
-// Use `S2Core` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const s2 = new S2Core({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const res = await streamsCreateStream(s2, {
-    s2Basin: "<value>",
-    createStreamRequest: {
-      stream: "<value>",
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("streamsCreateStream failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateStreamRequest](../../models/operations/createstreamrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-| `options.serverURL`                                                                                                                                                            | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | An optional server URL to use.                                                                                                                                                 |
-
-### Response
-
-**Promise\<[components.StreamInfo](../../models/components/streaminfo.md)\>**
-
-### Errors
-
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 400, 403, 404, 409   | application/json     |
-| errors.APIError      | 4XX, 5XX             | \*/\*                |
-
-## getStreamConfig
-
-Get stream configuration.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get_stream_config" method="get" path="/streams/{stream}" -->
-```typescript
-import { S2 } from "@s2-dev/streamstore";
-
-const s2 = new S2({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await s2.streams.getStreamConfig({
-    stream: "<value>",
-    s2Basin: "<value>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { S2Core } from "@s2-dev/streamstore/core.js";
-import { streamsGetStreamConfig } from "@s2-dev/streamstore/funcs/streamsGetStreamConfig.js";
-
-// Use `S2Core` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const s2 = new S2Core({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const res = await streamsGetStreamConfig(s2, {
-    stream: "<value>",
-    s2Basin: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("streamsGetStreamConfig failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetStreamConfigRequest](../../models/operations/getstreamconfigrequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-| `options.serverURL`                                                                                                                                                            | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | An optional server URL to use.                                                                                                                                                 |
-
-### Response
-
-**Promise\<[components.StreamConfig](../../models/components/streamconfig.md)\>**
-
-### Errors
-
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 400, 403, 404, 409   | application/json     |
-| errors.APIError      | 4XX, 5XX             | \*/\*                |
-
-## createOrReconfigureStream
-
-Create or reconfigure a stream.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="create_or_reconfigure_stream" method="put" path="/streams/{stream}" -->
-```typescript
-import { S2 } from "@s2-dev/streamstore";
-
-const s2 = new S2({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await s2.streams.createOrReconfigureStream({
-    stream: "<value>",
-    s2Basin: "<value>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { S2Core } from "@s2-dev/streamstore/core.js";
-import { streamsCreateOrReconfigureStream } from "@s2-dev/streamstore/funcs/streamsCreateOrReconfigureStream.js";
-
-// Use `S2Core` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const s2 = new S2Core({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const res = await streamsCreateOrReconfigureStream(s2, {
-    stream: "<value>",
-    s2Basin: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("streamsCreateOrReconfigureStream failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateOrReconfigureStreamRequest](../../models/operations/createorreconfigurestreamrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-| `options.serverURL`                                                                                                                                                            | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | An optional server URL to use.                                                                                                                                                 |
-
-### Response
-
-**Promise\<[components.StreamInfo](../../models/components/streaminfo.md)\>**
-
-### Errors
-
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 400, 403, 404, 409   | application/json     |
-| errors.APIError      | 4XX, 5XX             | \*/\*                |
-
-## deleteStream
-
-Delete a stream.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="delete_stream" method="delete" path="/streams/{stream}" -->
-```typescript
-import { S2 } from "@s2-dev/streamstore";
-
-const s2 = new S2({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  await s2.streams.deleteStream({
-    stream: "<value>",
-    s2Basin: "<value>",
-  });
-
-
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { S2Core } from "@s2-dev/streamstore/core.js";
-import { streamsDeleteStream } from "@s2-dev/streamstore/funcs/streamsDeleteStream.js";
-
-// Use `S2Core` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const s2 = new S2Core({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const res = await streamsDeleteStream(s2, {
-    stream: "<value>",
-    s2Basin: "<value>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    
-  } else {
-    console.log("streamsDeleteStream failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DeleteStreamRequest](../../models/operations/deletestreamrequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-| `options.serverURL`                                                                                                                                                            | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | An optional server URL to use.                                                                                                                                                 |
-
-### Response
-
-**Promise\<void\>**
-
-### Errors
-
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 400, 403, 404        | application/json     |
-| errors.APIError      | 4XX, 5XX             | \*/\*                |
-
-## reconfigureStream
-
-Reconfigure a stream.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="reconfigure_stream" method="patch" path="/streams/{stream}" -->
-```typescript
-import { S2 } from "@s2-dev/streamstore";
-
-const s2 = new S2({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await s2.streams.reconfigureStream({
-    stream: "<value>",
-    s2Basin: "<value>",
-    streamReconfiguration: {},
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { S2Core } from "@s2-dev/streamstore/core.js";
-import { streamsReconfigureStream } from "@s2-dev/streamstore/funcs/streamsReconfigureStream.js";
-
-// Use `S2Core` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const s2 = new S2Core({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const res = await streamsReconfigureStream(s2, {
-    stream: "<value>",
-    s2Basin: "<value>",
-    streamReconfiguration: {},
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("streamsReconfigureStream failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ReconfigureStreamRequest](../../models/operations/reconfigurestreamrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-| `options.serverURL`                                                                                                                                                            | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | An optional server URL to use.                                                                                                                                                 |
-
-### Response
-
-**Promise\<[components.StreamConfig](../../models/components/streamconfig.md)\>**
-
-### Errors
-
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 400, 403, 404, 409   | application/json     |
-| errors.APIError      | 4XX, 5XX             | \*/\*                |

package/examples/README.md

@@ -1,31 +0,0 @@
-# @s2-dev/streamstore Examples
-
-This directory contains example scripts demonstrating how to use the @s2-dev/streamstore SDK.
-
-## Prerequisites
-
-- Node.js (v18 or higher)
-- npm
-
-## Setup
-
-1. Copy `.env.template` to `.env`:
-   ```bash
-   cp .env.template .env
-   ```
-
-2. Edit `.env` and add your actual credentials (API keys, tokens, etc.)
-
-## Running the Examples
-
-To run an example file from the examples directory:
-
-```bash
-npm run build && npx tsx example.ts
-```
-
-## Creating new examples
-
-Duplicate an existing example file, they won't be overwritten by the generation process.
-
-

package/examples/accessTokensListAccessTokens.example.ts

@@ -1,26 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import dotenv from "dotenv";
-dotenv.config();
-/**
- * Example usage of the @s2-dev/streamstore SDK
- *
- * To run this example from the examples directory:
- * npm run build && npx tsx accessTokensListAccessTokens.example.ts
- */
-
-import { S2 } from "@s2-dev/streamstore";
-
-const s2 = new S2({
-  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
-});
-
-async function main() {
-  const result = await s2.accessTokens.listAccessTokens({});
-
-  console.log(result);
-}
-
-main().catch(console.error);