@s2-dev/streamstore 0.14.0 → 0.15.1

package/docs/sdks/basins/README.md

@@ -31,7 +31,6 @@ async function run() {
   const result = await s2.basins.listBasins({});
 
   for await (const page of result) {
-    // Handle the page
     console.log(page);
   }
 }
@@ -55,17 +54,14 @@ const s2 = new S2Core({
 
 async function run() {
   const res = await basinsListBasins(s2, {});
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  for await (const page of result) {
-    // Handle the page
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
     console.log(page);
   }
+  } else {
+    console.log("basinsListBasins failed:", res.error);
+  }
 }
 
 run();
@@ -109,7 +105,6 @@ async function run() {
     basin: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -134,15 +129,12 @@ async function run() {
   const res = await basinsCreateBasin(s2, {
     basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("basinsCreateBasin failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -186,7 +178,6 @@ async function run() {
     basin: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -211,15 +202,12 @@ async function run() {
   const res = await basinsGetBasinConfig(s2, {
     basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("basinsGetBasinConfig failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -263,7 +251,6 @@ async function run() {
     basin: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -288,15 +275,12 @@ async function run() {
   const res = await basinsCreateOrReconfigureBasin(s2, {
     basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("basinsCreateOrReconfigureBasin failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -364,14 +348,12 @@ async function run() {
   const res = await basinsDeleteBasin(s2, {
     basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("basinsDeleteBasin failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -416,7 +398,6 @@ async function run() {
     basinReconfiguration: {},
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -442,15 +423,12 @@ async function run() {
     basin: "<value>",
     basinReconfiguration: {},
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("basinsReconfigureBasin failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/metrics/README.md

@@ -0,0 +1,235 @@
+# Metrics
+(*metrics*)
+
+## Overview
+
+Usage metrics and data.
+
+### Available Operations
+
+* [accountMetrics](#accountmetrics) - Get account level metrics.
+* [basinMetrics](#basinmetrics) - Get metrics for a basin.
+* [streamMetrics](#streammetrics) - Get metrics for a stream.
+
+## accountMetrics
+
+Get account level metrics.
+
+### Example Usage
+
+```typescript
+import { S2 } from "@s2-dev/streamstore";
+
+const s2 = new S2({
+  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await s2.metrics.accountMetrics({
+    set: "account_ops",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { S2Core } from "@s2-dev/streamstore/core.js";
+import { metricsAccountMetrics } from "@s2-dev/streamstore/funcs/metricsAccountMetrics.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 metricsAccountMetrics(s2, {
+    set: "account_ops",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("metricsAccountMetrics failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountMetricsRequest](../../models/operations/accountmetricsrequest.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.                                                                                                               |
+
+### Response
+
+**Promise\<[components.MetricSetResponse](../../models/components/metricsetresponse.md)\>**
+
+### Errors
+
+| Error Type           | Status Code          | Content Type         |
+| -------------------- | -------------------- | -------------------- |
+| errors.ErrorResponse | 400, 403             | application/json     |
+| errors.APIError      | 4XX, 5XX             | \*/\*                |
+
+## basinMetrics
+
+Get metrics for a basin.
+
+### Example Usage
+
+```typescript
+import { S2 } from "@s2-dev/streamstore";
+
+const s2 = new S2({
+  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await s2.metrics.basinMetrics({
+    set: "storage",
+    basin: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { S2Core } from "@s2-dev/streamstore/core.js";
+import { metricsBasinMetrics } from "@s2-dev/streamstore/funcs/metricsBasinMetrics.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 metricsBasinMetrics(s2, {
+    set: "storage",
+    basin: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("metricsBasinMetrics failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.BasinMetricsRequest](../../models/operations/basinmetricsrequest.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.                                                                                                               |
+
+### Response
+
+**Promise\<[components.MetricSetResponse](../../models/components/metricsetresponse.md)\>**
+
+### Errors
+
+| Error Type           | Status Code          | Content Type         |
+| -------------------- | -------------------- | -------------------- |
+| errors.ErrorResponse | 400, 403             | application/json     |
+| errors.APIError      | 4XX, 5XX             | \*/\*                |
+
+## streamMetrics
+
+Get metrics for a stream.
+
+### Example Usage
+
+```typescript
+import { S2 } from "@s2-dev/streamstore";
+
+const s2 = new S2({
+  accessToken: process.env["S2_ACCESS_TOKEN"] ?? "",
+});
+
+async function run() {
+  const result = await s2.metrics.streamMetrics({
+    basin: "<value>",
+    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 { metricsStreamMetrics } from "@s2-dev/streamstore/funcs/metricsStreamMetrics.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 metricsStreamMetrics(s2, {
+    basin: "<value>",
+    stream: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("metricsStreamMetrics failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.StreamMetricsRequest](../../models/operations/streammetricsrequest.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.                                                                                                               |
+
+### Response
+
+**Promise\<[components.MetricSetResponse](../../models/components/metricsetresponse.md)\>**
+
+### Errors
+
+| Error Type           | Status Code          | Content Type         |
+| -------------------- | -------------------- | -------------------- |
+| errors.ErrorResponse | 400, 403             | application/json     |
+| errors.APIError      | 4XX, 5XX             | \*/\*                |

package/docs/sdks/records/README.md

@@ -58,17 +58,15 @@ async function run() {
     stream: "<value>",
     s2Basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  for await (const event of result) {
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const event of result) {
     // Handle the event
     console.log(event);
   }
+  } else {
+    console.log("recordsRead failed:", res.error);
+  }
 }
 
 run();
@@ -122,7 +120,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -154,15 +151,12 @@ async function run() {
       ],
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("recordsAppend failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -211,7 +205,6 @@ async function run() {
     s2Basin: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -237,15 +230,12 @@ async function run() {
     stream: "<value>",
     s2Basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("recordsCheckTail failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/streams/README.md

@@ -33,7 +33,6 @@ async function run() {
   });
 
   for await (const page of result) {
-    // Handle the page
     console.log(page);
   }
 }
@@ -59,17 +58,14 @@ async function run() {
   const res = await streamsListStreams(s2, {
     s2Basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  for await (const page of result) {
-    // Handle the page
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
     console.log(page);
   }
+  } else {
+    console.log("streamsListStreams failed:", res.error);
+  }
 }
 
 run();
@@ -117,7 +113,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -145,15 +140,12 @@ async function run() {
       stream: "<value>",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("streamsCreateStream failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -199,7 +191,6 @@ async function run() {
     s2Basin: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -225,15 +216,12 @@ async function run() {
     stream: "<value>",
     s2Basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("streamsGetStreamConfig failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -279,7 +267,6 @@ async function run() {
     s2Basin: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -305,15 +292,12 @@ async function run() {
     stream: "<value>",
     s2Basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("streamsCreateOrReconfigureStream failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -384,14 +368,12 @@ async function run() {
     stream: "<value>",
     s2Basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("streamsDeleteStream failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -438,7 +420,6 @@ async function run() {
     streamReconfiguration: {},
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -465,15 +446,12 @@ async function run() {
     s2Basin: "<value>",
     streamReconfiguration: {},
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("streamsReconfigureStream failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@s2-dev/streamstore",
-  "version": "0.14.0",
+  "version": "0.15.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@s2-dev/streamstore",
-  "version": "0.14.0",
+  "version": "0.15.1",
   "author": "Speakeasy",
   "type": "module",
   "bin": {