feat: append retries

Author: infiniteregrets

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 2d20490e-9921-47d5-9711-d3c4b91c8cfa
 management:
-  docChecksum: bbcb28d2548a56b38ad64847eb7a88d2
+  docChecksum: 9e7339e5177c40c4866ea6111dc794d6
   docVersion: 1.0.0
-  speakeasyVersion: 1.487.0
+  speakeasyVersion: 1.487.1
   generationVersion: 2.506.0
-  releaseVersion: 0.3.9
-  configChecksum: 2df4142ae1198abc894789b95b9611b9
+  releaseVersion: 0.3.13
+  configChecksum: a2cdc39cee0d581da5f5c6a903782e39
   repoURL: https://github.com/s2-streamstore/s2-sdk-typescript.git
   installationURL: https://github.com/s2-streamstore/s2-sdk-typescript
   published: true
@@ -58,7 +58,6 @@ generatedFiles:
   - docs/models/components/firstseqnum.md
   - docs/models/components/formatoption.md
   - docs/models/components/header.md
-  - docs/models/components/httpmetadata.md
   - docs/models/components/listbasinsresponse.md
   - docs/models/components/liststreamsresponse.md
   - docs/models/components/nextseqnum.md
@@ -75,22 +74,15 @@ generatedFiles:
   - docs/models/components/streaminfo.md
   - docs/models/errors/errorresponse.md
   - docs/models/errors/notfounderror.md
+  - docs/models/errors/retryableerror.md
   - docs/models/operations/appendrequest.md
-  - docs/models/operations/appendresponse.md
   - docs/models/operations/checktailrequest.md
-  - docs/models/operations/checktailresponse.md
   - docs/models/operations/createbasinrequest.md
-  - docs/models/operations/createbasinresponse.md
   - docs/models/operations/createstreamrequest.md
-  - docs/models/operations/createstreamresponse.md
   - docs/models/operations/deletebasinrequest.md
-  - docs/models/operations/deletebasinresponse.md
   - docs/models/operations/deletestreamrequest.md
-  - docs/models/operations/deletestreamresponse.md
   - docs/models/operations/getbasinconfigrequest.md
-  - docs/models/operations/getbasinconfigresponse.md
   - docs/models/operations/getstreamconfigrequest.md
-  - docs/models/operations/getstreamconfigresponse.md
   - docs/models/operations/headers2format.md
   - docs/models/operations/limit.md
   - docs/models/operations/listbasinsrequest.md
@@ -100,9 +92,7 @@ generatedFiles:
   - docs/models/operations/readrequest.md
   - docs/models/operations/readresponse.md
   - docs/models/operations/reconfigurebasinrequest.md
-  - docs/models/operations/reconfigurebasinresponse.md
   - docs/models/operations/reconfigurestreamrequest.md
-  - docs/models/operations/reconfigurestreamresponse.md
   - docs/models/operations/s2format.md
   - docs/sdks/account/README.md
   - docs/sdks/basin/README.md
@@ -158,7 +148,6 @@ generatedFiles:
   - src/models/components/createstreamrequest.ts
   - src/models/components/formatoption.ts
   - src/models/components/header.ts
-  - src/models/components/httpmetadata.ts
   - src/models/components/index.ts
   - src/models/components/listbasinsresponse.ts
   - src/models/components/liststreamsresponse.ts
@@ -176,6 +165,7 @@ generatedFiles:
   - src/models/errors/httpclienterrors.ts
   - src/models/errors/index.ts
   - src/models/errors/notfounderror.ts
+  - src/models/errors/retryableerror.ts
   - src/models/errors/sdkvalidationerror.ts
   - src/models/operations/append.ts
   - src/models/operations/checktail.ts
@@ -215,6 +205,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   get_basin_config:
     speakeasy-default-get-basin-config:
       parameters:
@@ -227,6 +219,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   create_basin:
     speakeasy-default-create-basin:
       parameters:
@@ -242,6 +236,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   delete_basin:
     speakeasy-default-delete-basin:
       parameters:
@@ -254,6 +250,8 @@ examples:
           application/json: {"error": "<value>"}
         "404":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   list_streams:
     speakeasy-default-list-streams:
       responses:
@@ -263,6 +261,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   get_stream_config:
     speakeasy-default-get-stream-config:
       parameters:
@@ -275,6 +275,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   create_stream:
     speakeasy-default-create-stream:
       parameters:
@@ -290,6 +292,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   delete_stream:
     speakeasy-default-delete-stream:
       parameters:
@@ -302,6 +306,8 @@ examples:
           application/json: {"error": "<value>"}
         "404":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   read:
     speakeasy-default-read:
       parameters:
@@ -316,6 +322,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   append:
     speakeasy-default-append:
       parameters:
@@ -331,6 +339,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   check_tail:
     speakeasy-default-check-tail:
       parameters:
@@ -343,6 +353,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   reconfigure_basin:
     speakeasy-default-reconfigure-basin:
       parameters:
@@ -357,6 +369,8 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
   reconfigure_stream:
     speakeasy-default-reconfigure-stream:
       parameters:
@@ -371,5 +385,7 @@ examples:
           application/json: {"error": "<value>"}
         "500":
           application/json: {"error": "<value>"}
+        "499":
+          application/json: {"error": "<value>"}
 examplesVersion: 1.0.0
 generatedTests: {}

.speakeasy/gen.yaml

@@ -16,7 +16,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: true
 typescript:
-  version: 0.3.9
+  version: 0.3.13
   additionalDependencies:
     dependencies:
       uuid: ^9.0.1
@@ -48,6 +48,6 @@ typescript:
   moduleFormat: commonjs
   outputModelSuffix: output
   packageName: '@s2-dev/streamstore'
-  responseFormat: envelope-http
+  responseFormat: flat
   templateVersion: v2
   useIndexModules: true

.speakeasy/workflow.lock

@@ -1,20 +1,20 @@
-speakeasyVersion: 1.487.0
+speakeasyVersion: 1.487.1
 sources:
     S2 API:
         sourceNamespace: s-2-api
-        sourceRevisionDigest: sha256:d03ee4e15b5b1ab905c13df4f9f09d9add26b87a0e23eacd68ae64a999c7b37b
-        sourceBlobDigest: sha256:eda67f586b78ceb1300a3662669e008175f0667b68ff804d4de23fcab20998d1
+        sourceRevisionDigest: sha256:bd08c3ccd5d5347310d96e50095603fed7338051f50fd6a653219163e2bed605
+        sourceBlobDigest: sha256:1916df0ae96a183ac624477f5f040a1414053315f7d583bf3638d7ec5fd1c040
         tags:
             - latest
             - 1.0.0
 targets:
     streamstore:
         source: S2 API
         sourceNamespace: s-2-api
-        sourceRevisionDigest: sha256:d03ee4e15b5b1ab905c13df4f9f09d9add26b87a0e23eacd68ae64a999c7b37b
-        sourceBlobDigest: sha256:eda67f586b78ceb1300a3662669e008175f0667b68ff804d4de23fcab20998d1
+        sourceRevisionDigest: sha256:bd08c3ccd5d5347310d96e50095603fed7338051f50fd6a653219163e2bed605
+        sourceBlobDigest: sha256:1916df0ae96a183ac624477f5f040a1414053315f7d583bf3638d7ec5fd1c040
         codeSamplesNamespace: s-2-api-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:2fdd955e5e57b6d282f7b6c9254454745e1430ba10fb78cfcde38d37d57a43d2
+        codeSamplesRevisionDigest: sha256:ae55ab81c7e9a2650b87f14d6138db98c7f3a77bf8b4731237cfdf92af078d5d
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

README.md

@@ -242,11 +242,7 @@ async function run() {
     stream: "<value>",
   });
 
-  if (result.readResponse == null) {
-    throw new Error("failed to create stream: received null value");
-  }
-
-  for await (const event of result.readResponse) {
+  for await (const event of result) {
     // Handle the event
     console.log(event);
   }
@@ -367,18 +363,20 @@ 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 `listBasins` method may throw the following errors:
 
-| Error Type           | Status Code | Content Type     |
-| -------------------- | ----------- | ---------------- |
-| errors.ErrorResponse | 400, 401    | application/json |
-| errors.ErrorResponse | 500         | application/json |
-| errors.APIError      | 4XX, 5XX    | \*/\*            |
+| Error Type            | Status Code   | Content Type     |
+| --------------------- | ------------- | ---------------- |
+| errors.ErrorResponse  | 400, 401      | application/json |
+| errors.RetryableError | 499           | application/json |
+| errors.RetryableError | 500, 503, 504 | 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`.
 
 ```typescript
 import { S2 } from "@s2-dev/streamstore";
 import {
   ErrorResponse,
+  RetryableError,
   SDKValidationError,
 } from "@s2-dev/streamstore/models/errors";
 
@@ -410,8 +408,13 @@ async function run() {
         console.error(err);
         return;
       }
-      case (err instanceof ErrorResponse): {
-        // Handle err.data$: ErrorResponseData
+      case (err instanceof RetryableError): {
+        // Handle err.data$: RetryableErrorData
+        console.error(err);
+        return;
+      }
+      case (err instanceof RetryableError): {
+        // Handle err.data$: RetryableErrorData
         console.error(err);
         return;
       }

docs/models/components/age.md

@@ -9,7 +9,7 @@ If set to 0, the stream will have infinite retention.
 import { Age } from "@s2-dev/streamstore/models/components";
 
 let value: Age = {
-  age: 97,
+  age: 57,
 };
 ```
 

docs/models/components/appendoutput.md

@@ -8,9 +8,9 @@ Output from append response.
 import { AppendOutput } from "@s2-dev/streamstore/models/components";
 
 let value: AppendOutput = {
-  endSeqNum: 639921,
-  nextSeqNum: 143353,
-  startSeqNum: 944669,
+  endSeqNum: 414662,
+  nextSeqNum: 264555,
+  startSeqNum: 774234,
 };
 ```
 

docs/models/components/basininfo.md

@@ -11,7 +11,7 @@ let value: BasinInfo = {
   cell: "<value>",
   name: "<value>",
   scope: "<value>",
-  state: "active",
+  state: "deleting",
 };
 ```
 

docs/models/components/basinstate.md

@@ -7,7 +7,7 @@ Current state of the basin.
 ```typescript
 import { BasinState } from "@s2-dev/streamstore/models/components";
 
-let value: BasinState = "creating";
+let value: BasinState = "active";
 ```
 
 ## Values

docs/models/components/checktailresponse.md

@@ -8,7 +8,7 @@ Check tail response.
 import { CheckTailResponse } from "@s2-dev/streamstore/models/components";
 
 let value: CheckTailResponse = {
-  nextSeqNum: 521848,
+  nextSeqNum: 456150,
 };
 ```
 

docs/models/components/formatoption.md

@@ -5,7 +5,7 @@
 ```typescript
 import { FormatOption } from "@s2-dev/streamstore/models/components";
 
-let value: FormatOption = "json";
+let value: FormatOption = "json-binsafe";
 ```
 
 ## Values