@s2-dev/streamstore 0.12.0 → 0.13.1

package/README.md

@@ -22,8 +22,7 @@ S2 API: Serverless API for streaming data backed by object storage.
 <!-- $toc-max-depth=2 -->
 * [streamstore](#streamstore)
   * [SDK Installation](#sdk-installation)
-  * [Requirements](#requirements)
-  * [SDK Recommended Usage](#sdk-recommended-usage)
+  * [Requirements](#requirements)  
   * [SDK Example Usage](#sdk-example-usage)
   * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations)
@@ -167,85 +166,6 @@ npx -y --package @s2-dev/streamstore -- mcp start --help
 For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- End Requirements [requirements] -->
 
-## 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: "<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();
-```
-### Examples
-
-- Using `S2Endpoints`
-
-```typescript
-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
-
-```typescript
-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
-
-```typescript
-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
-
-```typescript
-  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();
-```
-
 <!-- Start SDK Example Usage [usage] -->
 ## SDK Example Usage
 
@@ -397,6 +317,7 @@ const s2 = new S2({
 async function run() {
   const result = await s2.records.read({
     stream: "<value>",
+    s2Basin: "<value>",
   });
 
   for await (const event of result) {
@@ -516,12 +437,10 @@ 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 `listAccessTokens` method may throw the following errors:
 
-| Error Type            | Status Code   | Content Type     |
-| --------------------- | ------------- | ---------------- |
-| errors.ErrorResponse  | 400, 403      | application/json |
-| errors.RetryableError | 499           | application/json |
-| errors.RetryableError | 500, 503, 504 | application/json |
-| errors.APIError       | 4XX, 5XX      | \*/\*            |
+| Error Type           | Status Code | Content Type     |
+| -------------------- | ----------- | ---------------- |
+| errors.ErrorResponse | 400, 403    | 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`.
 
@@ -529,7 +448,6 @@ If the method throws an error and it is not captured by the known errors, it wil
 import { S2 } from "@s2-dev/streamstore";
 import {
   ErrorResponse,
-  RetryableError,
   SDKValidationError,
 } from "@s2-dev/streamstore/models/errors";
 
@@ -559,16 +477,6 @@ async function run() {
         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;
@@ -630,7 +538,9 @@ const s2 = new S2({
 });
 
 async function run() {
-  const result = await s2.streams.listStreams({}, {
+  const result = await s2.streams.listStreams({
+    s2Basin: "<value>",
+  }, {
     serverURL: "https://.b.aws.s2.dev/v1",
   });