@s2-dev/streamstore 0.15.0 → 0.15.2

package/FUNCTIONS.md

@@ -21,7 +21,6 @@ specific category of applications.
 ```typescript
 import { S2Core } from "@s2-dev/streamstore/core.js";
 import { accessTokensListAccessTokens } from "@s2-dev/streamstore/funcs/accessTokensListAccessTokens.js";
-import { SDKValidationError } from "@s2-dev/streamstore/models/errors/sdkvalidationerror.js";
 
 // Use `S2Core` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -31,28 +30,12 @@ const s2 = new S2Core({
 
 async function run() {
   const res = await accessTokensListAccessTokens(s2, {});
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("accessTokensListAccessTokens failed:", res.error);
   }
-
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/README.md

@@ -1,6 +1,6 @@
 # streamstore
 
-Developer-friendly & type-safe Typescript SDK specifically catered to leverage *streamstore* API.
+Developer-friendly & type-safe TypeScript SDK specifically catered to leverage *streamstore* API.
 
 <div align="left">
     <a href="https://www.speakeasy.com/?utm_source=streamstore&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
@@ -181,7 +181,6 @@ const s2 = new S2({
 async function run() {
   const result = await s2.accessTokens.listAccessTokens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -212,7 +211,6 @@ const s2 = new S2({
 async function run() {
   const result = await s2.accessTokens.listAccessTokens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -237,20 +235,20 @@ run();
 
 * [listBasins](docs/sdks/basins/README.md#listbasins) - List basins.
 * [createBasin](docs/sdks/basins/README.md#createbasin) - Create a basin.
-* [getBasinConfig](docs/sdks/basins/README.md#getbasinconfig) - Get basin config.
+* [getBasinConfig](docs/sdks/basins/README.md#getbasinconfig) - Get basin configuration.
 * [createOrReconfigureBasin](docs/sdks/basins/README.md#createorreconfigurebasin) - Create or reconfigure a basin.
 * [deleteBasin](docs/sdks/basins/README.md#deletebasin) - Delete a basin.
 * [reconfigureBasin](docs/sdks/basins/README.md#reconfigurebasin) - Reconfigure a basin.
 
 ### [metrics](docs/sdks/metrics/README.md)
 
-* [accountMetrics](docs/sdks/metrics/README.md#accountmetrics) - Get account level metrics.
-* [basinMetrics](docs/sdks/metrics/README.md#basinmetrics) - Get metrics for a basin.
-* [streamMetrics](docs/sdks/metrics/README.md#streammetrics) - Get metrics for a stream.
+* [accountMetrics](docs/sdks/metrics/README.md#accountmetrics) - Account-level metrics.
+* [basinMetrics](docs/sdks/metrics/README.md#basinmetrics) - Basin-level metrics.
+* [streamMetrics](docs/sdks/metrics/README.md#streammetrics) - Stream-level metrics.
 
 ### [records](docs/sdks/records/README.md)
 
-* [read](docs/sdks/records/README.md#read) - Retrieve records.
+* [read](docs/sdks/records/README.md#read) - Read records.
 * [append](docs/sdks/records/README.md#append) - Append records.
 * [checkTail](docs/sdks/records/README.md#checktail) - Check the tail.
 
@@ -288,15 +286,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`basinsCreateBasin`](docs/sdks/basins/README.md#createbasin) - Create a basin.
 - [`basinsCreateOrReconfigureBasin`](docs/sdks/basins/README.md#createorreconfigurebasin) - Create or reconfigure a basin.
 - [`basinsDeleteBasin`](docs/sdks/basins/README.md#deletebasin) - Delete a basin.
-- [`basinsGetBasinConfig`](docs/sdks/basins/README.md#getbasinconfig) - Get basin config.
+- [`basinsGetBasinConfig`](docs/sdks/basins/README.md#getbasinconfig) - Get basin configuration.
 - [`basinsListBasins`](docs/sdks/basins/README.md#listbasins) - List basins.
 - [`basinsReconfigureBasin`](docs/sdks/basins/README.md#reconfigurebasin) - Reconfigure a basin.
-- [`metricsAccountMetrics`](docs/sdks/metrics/README.md#accountmetrics) - Get account level metrics.
-- [`metricsBasinMetrics`](docs/sdks/metrics/README.md#basinmetrics) - Get metrics for a basin.
-- [`metricsStreamMetrics`](docs/sdks/metrics/README.md#streammetrics) - Get metrics for a stream.
+- [`metricsAccountMetrics`](docs/sdks/metrics/README.md#accountmetrics) - Account-level metrics.
+- [`metricsBasinMetrics`](docs/sdks/metrics/README.md#basinmetrics) - Basin-level metrics.
+- [`metricsStreamMetrics`](docs/sdks/metrics/README.md#streammetrics) - Stream-level metrics.
 - [`recordsAppend`](docs/sdks/records/README.md#append) - Append records.
 - [`recordsCheckTail`](docs/sdks/records/README.md#checktail) - Check the tail.
-- [`recordsRead`](docs/sdks/records/README.md#read) - Retrieve records.
+- [`recordsRead`](docs/sdks/records/README.md#read) - Read records.
 - [`streamsCreateOrReconfigureStream`](docs/sdks/streams/README.md#createorreconfigurestream) - Create or reconfigure a stream.
 - [`streamsCreateStream`](docs/sdks/streams/README.md#createstream) - Create a stream.
 - [`streamsDeleteStream`](docs/sdks/streams/README.md#deletestream) - Delete a stream.
@@ -366,7 +364,6 @@ async function run() {
   const result = await s2.basins.listBasins({});
 
   for await (const page of result) {
-    // Handle the page
     console.log(page);
   }
 }
@@ -403,7 +400,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -432,7 +428,6 @@ const s2 = new S2({
 async function run() {
   const result = await s2.accessTokens.listAccessTokens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -444,51 +439,43 @@ run();
 <!-- Start Error Handling [errors] -->
 ## 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 `listAccessTokens` method may throw the following errors:
+[`S2Error`](./src/models/errors/s2error.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| 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`.
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
+### Example
 ```typescript
 import { S2 } from "@s2-dev/streamstore";
-import {
-  ErrorResponse,
-  SDKValidationError,
-} from "@s2-dev/streamstore/models/errors";
+import * as errors from "@s2-dev/streamstore/models/errors";
 
 const s2 = new S2({
   accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
 });
 
 async function run() {
-  let result;
   try {
-    result = await s2.accessTokens.listAccessTokens({});
+    const result = await s2.accessTokens.listAccessTokens({});
 
-    // Handle the result
     console.log(result);
-  } 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;
-      }
-      default: {
-        // Other errors such as network errors, see HTTPClientErrors for more details
-        throw err;
+  } catch (error) {
+    // The base class for HTTP error responses
+    if (error instanceof errors.S2Error) {
+      console.log(error.message);
+      console.log(error.statusCode);
+      console.log(error.body);
+      console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.ErrorResponse) {
+        console.log(error.data$.code); // string
+        console.log(error.data$.message); // string
       }
     }
   }
@@ -498,17 +485,32 @@ 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.
+### Error Classes
+**Primary errors:**
+* [`S2Error`](./src/models/errors/s2error.ts): The base class for HTTP error responses.
+  * [`ErrorResponse`](docs/models/errors/errorresponse.md): .
+
+<details><summary>Less common errors (9)</summary>
 
-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:
+<br />
+
+**Network errors:**
+* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
+* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
+* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
+* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
+* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
+
+
+**Inherit from [`S2Error`](./src/models/errors/s2error.ts)**:
+* [`FencingToken`](docs/models/errors/fencingtoken.md): Fencing token did not match. The expected fencing token is returned. Status code `412`. Applicable to 1 of 21 methods.*
+* [`SeqNum`](docs/models/errors/seqnum.md): Sequence number did not match the tail of the stream. The expected next sequence number is returned. Status code `412`. Applicable to 1 of 21 methods.*
+* [`TailResponse`](docs/models/errors/tailresponse.md): . Status code `416`. Applicable to 1 of 21 methods.*
+* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
+
+</details>
 
-| 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                     |
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -528,7 +530,6 @@ const s2 = new S2({
 async function run() {
   const result = await s2.accessTokens.listAccessTokens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -554,7 +555,6 @@ async function run() {
   });
 
   for await (const page of result) {
-    // Handle the page
     console.log(page);
   }
 }
@@ -647,4 +647,4 @@ 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. 
 
-### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=streamstore&utm_campaign=typescript)
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=streamstore&utm_campaign=)