@s2-dev/streamstore 0.15.0 → 0.15.2

package/dist/esm/sdk/metrics.js

@@ -8,19 +8,19 @@ import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
 export class Metrics extends ClientSDK {
     /**
-     * Get account level metrics.
+     * Account-level metrics.
      */
     async accountMetrics(request, options) {
         return unwrapAsync(metricsAccountMetrics(this, request, options));
     }
     /**
-     * Get metrics for a basin.
+     * Basin-level metrics.
      */
     async basinMetrics(request, options) {
         return unwrapAsync(metricsBasinMetrics(this, request, options));
     }
     /**
-     * Get metrics for a stream.
+     * Stream-level metrics.
      */
     async streamMetrics(request, options) {
         return unwrapAsync(metricsStreamMetrics(this, request, options));

package/dist/esm/sdk/records.d.ts

@@ -5,26 +5,17 @@ import * as operations from "../models/operations/index.js";
 export { ReadAcceptEnum } from "../funcs/recordsRead.js";
 export declare class Records extends ClientSDK {
     /**
-     * Retrieve records.
-     *
-     * @remarks
-     * Retrieve a batch of records, or set `Accept: text/event-stream` to stream using server-sent events.
+     * Read records.
      */
     read(request: operations.ReadRequest, options?: RequestOptions & {
         acceptHeaderOverride?: ReadAcceptEnum;
     }): Promise<operations.ReadResponse>;
     /**
      * Append records.
-     *
-     * @remarks
-     * Append a batch of records to a stream.
      */
     append(request: operations.AppendRequest, options?: RequestOptions): Promise<components.AppendAck>;
     /**
      * Check the tail.
-     *
-     * @remarks
-     * Check the tail of a stream.
      */
     checkTail(request: operations.CheckTailRequest, options?: RequestOptions): Promise<components.TailResponse>;
 }

package/dist/esm/sdk/records.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../../../src/sdk/records.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAe,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;;;;OAKG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,WAAW,EAC/B,OAAO,CAAC,EAAE,cAAc,GAAG;QAAE,oBAAoB,CAAC,EAAE,cAAc,CAAA;KAAE,GACnE,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;IAQnC;;;;;OAKG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC;IAQhC;;;;;OAKG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,gBAAgB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;CAOpC"}
+{"version":3,"file":"records.d.ts","sourceRoot":"","sources":["../../../src/sdk/records.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,cAAc,EAAe,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,qBAAa,OAAQ,SAAQ,SAAS;IACpC;;OAEG;IACG,IAAI,CACR,OAAO,EAAE,UAAU,CAAC,WAAW,EAC/B,OAAO,CAAC,EAAE,cAAc,GAAG;QAAE,oBAAoB,CAAC,EAAE,cAAc,CAAA;KAAE,GACnE,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;IAQnC;;OAEG;IACG,MAAM,CACV,OAAO,EAAE,UAAU,CAAC,aAAa,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC;IAQhC;;OAEG;IACG,SAAS,CACb,OAAO,EAAE,UAAU,CAAC,gBAAgB,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;CAOpC"}

package/dist/esm/sdk/records.js

@@ -9,28 +9,19 @@ import { unwrapAsync } from "../types/fp.js";
 export { ReadAcceptEnum } from "../funcs/recordsRead.js";
 export class Records extends ClientSDK {
     /**
-     * Retrieve records.
-     *
-     * @remarks
-     * Retrieve a batch of records, or set `Accept: text/event-stream` to stream using server-sent events.
+     * Read records.
      */
     async read(request, options) {
         return unwrapAsync(recordsRead(this, request, options));
     }
     /**
      * Append records.
-     *
-     * @remarks
-     * Append a batch of records to a stream.
      */
     async append(request, options) {
         return unwrapAsync(recordsAppend(this, request, options));
     }
     /**
      * Check the tail.
-     *
-     * @remarks
-     * Check the tail of a stream.
      */
     async checkTail(request, options) {
         return unwrapAsync(recordsCheckTail(this, request, options));

package/dist/esm/sdk/records.js.map

@@ -1 +1 @@
-{"version":3,"file":"records.js","sourceRoot":"","sources":["../../../src/sdk/records.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAkB,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,MAAM,OAAO,OAAQ,SAAQ,SAAS;IACpC;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,OAA+B,EAC/B,OAAoE;QAEpE,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,OAAoC,EACpC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"records.js","sourceRoot":"","sources":["../../../src/sdk/records.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAkB,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAG3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,MAAM,OAAO,OAAQ,SAAQ,SAAS;IACpC;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,OAA+B,EAC/B,OAAoE;QAEpE,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,OAAiC,EACjC,OAAwB;QAExB,OAAO,WAAW,CAAC,aAAa,CAC9B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,OAAoC,EACpC,OAAwB;QAExB,OAAO,WAAW,CAAC,gBAAgB,CACjC,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/esm/types/constdatetime.js

@@ -5,6 +5,6 @@ import * as z from "zod";
 export function constDateTime(val) {
     return z.custom((v) => {
         return (typeof v === "string" && new Date(v).getTime() === new Date(val).getTime());
-    }, `Value must be equivelant to ${val}`);
+    }, `Value must be equivalent to ${val}`);
 }
 //# sourceMappingURL=constdatetime.js.map

package/docs/sdks/accesstokens/README.md

@@ -27,7 +27,6 @@ const s2 = new S2({
 async function run() {
   const result = await s2.accessTokens.listAccessTokens({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,15 +49,12 @@ const s2 = new S2Core({
 
 async function run() {
   const res = await accessTokensListAccessTokens(s2, {});
-
-  if (!res.ok) {
-    throw 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();
@@ -103,7 +99,6 @@ async function run() {
     scope: {},
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -129,15 +124,12 @@ async function run() {
     id: "<id>",
     scope: {},
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("accessTokensIssueAccessToken failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -205,14 +197,12 @@ async function run() {
   const res = await accessTokensRevokeAccessToken(s2, {
     id: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("accessTokensRevokeAccessToken failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();

package/docs/sdks/basins/README.md

@@ -9,7 +9,7 @@ Manage basins
 
 * [listBasins](#listbasins) - List basins.
 * [createBasin](#createbasin) - Create a basin.
-* [getBasinConfig](#getbasinconfig) - Get basin config.
+* [getBasinConfig](#getbasinconfig) - Get basin configuration.
 * [createOrReconfigureBasin](#createorreconfigurebasin) - Create or reconfigure a basin.
 * [deleteBasin](#deletebasin) - Delete a basin.
 * [reconfigureBasin](#reconfigurebasin) - Reconfigure a basin.
@@ -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();
@@ -170,7 +162,7 @@ run();
 
 ## getBasinConfig
 
-Get basin config.
+Get basin configuration.
 
 ### Example Usage
 
@@ -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

@@ -7,13 +7,13 @@ 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](#accountmetrics) - Account-level metrics.
+* [basinMetrics](#basinmetrics) - Basin-level metrics.
+* [streamMetrics](#streammetrics) - Stream-level metrics.
 
 ## accountMetrics
 
-Get account level metrics.
+Account-level metrics.
 
 ### Example Usage
 
@@ -26,10 +26,9 @@ const s2 = new S2({
 
 async function run() {
   const result = await s2.metrics.accountMetrics({
-    set: "account_ops",
+    set: "account-ops",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -52,17 +51,14 @@ const s2 = new S2Core({
 
 async function run() {
   const res = await metricsAccountMetrics(s2, {
-    set: "account_ops",
+    set: "account-ops",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("metricsAccountMetrics failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -90,7 +86,7 @@ run();
 
 ## basinMetrics
 
-Get metrics for a basin.
+Basin-level metrics.
 
 ### Example Usage
 
@@ -107,7 +103,6 @@ async function run() {
     basin: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -133,15 +128,12 @@ async function run() {
     set: "storage",
     basin: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("metricsBasinMetrics failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -169,7 +161,7 @@ run();
 
 ## streamMetrics
 
-Get metrics for a stream.
+Stream-level metrics.
 
 ### Example Usage
 
@@ -186,7 +178,6 @@ async function run() {
     stream: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -212,15 +203,12 @@ async function run() {
     basin: "<value>",
     stream: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("metricsStreamMetrics failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/records/README.md

@@ -7,13 +7,13 @@ Manage records
 
 ### Available Operations
 
-* [read](#read) - Retrieve records.
+* [read](#read) - Read records.
 * [append](#append) - Append records.
 * [checkTail](#checktail) - Check the tail.
 
 ## read
 
-Retrieve a batch of records, or set `Accept: text/event-stream` to stream using server-sent events.
+Read records.
 
 ### Example Usage
 
@@ -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();
@@ -99,7 +97,7 @@ run();
 
 ## append
 
-Append a batch of records to a stream.
+Append records.
 
 ### Example Usage
 
@@ -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();
@@ -194,7 +188,7 @@ run();
 
 ## checkTail
 
-Check the tail of a stream.
+Check the tail.
 
 ### Example Usage
 
@@ -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();