Merge pull request #6 from s2-streamstore/speakeasy-sdk-regen-1738369233

chore: 🐝 Update SDK - Generate 0.2.6
s2-streamstore · Feb 1, 2025 · dd6721f · dd6721f
2 parents 187174e + 2b6fa43
commit dd6721f
Show file tree

Hide file tree

Showing 19 changed files with 678 additions and 2,551 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+/.eslintcache
 /models
 /models/errors
 /types

diff --git a/.npmignore b/.npmignore
@@ -7,7 +7,7 @@
 !/**/*.json
 !/**/*.map
 
-/.eslintrc.js
+/eslint.config.mjs
 /cjs
 /.tshy
 /.tshy-*

diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,20 +1,20 @@
 lockVersion: 2.0.0
 id: 2d20490e-9921-47d5-9711-d3c4b91c8cfa
 management:
-  docChecksum: 7dc3525c89a194b31c5af7e00bc39000
+  docChecksum: 24649fada58afae630307af3fabf3506
   docVersion: 1.0.0
-  speakeasyVersion: 1.477.2
-  generationVersion: 2.497.8
-  releaseVersion: 0.2.5
-  configChecksum: a3c0799f215296cda0f2b1ca71a3b263
+  speakeasyVersion: 1.481.1
+  generationVersion: 2.500.5
+  releaseVersion: 0.2.6
+  configChecksum: ccdf8003f6cccf53fe8a8c63f21f9494
   repoURL: https://github.com/s2-streamstore/s2-sdk-typescript.git
   installationURL: https://github.com/s2-streamstore/s2-sdk-typescript
   published: true
 features:
   typescript:
     acceptHeaders: 2.81.2
     additionalDependencies: 0.1.0
-    core: 3.18.19
+    core: 3.18.22
     defaultEnabledRetries: 0.1.0
     devContainers: 2.90.0
     enumUnions: 0.1.0
@@ -35,7 +35,6 @@ generatedFiles:
   - .devcontainer/README.md
   - .devcontainer/devcontainer.json
   - .devcontainer/setup.sh
-  - .eslintrc.cjs
   - .gitattributes
   - .npmignore
   - FUNCTIONS.md
@@ -98,6 +97,7 @@ generatedFiles:
   - docs/sdks/basin/README.md
   - docs/sdks/s2/README.md
   - docs/sdks/stream/README.md
+  - eslint.config.mjs
   - jsr.json
   - package.json
   - src/core.ts

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -16,7 +16,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: true
 typescript:
-  version: 0.2.5
+  version: 0.2.6
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,20 +1,21 @@
-speakeasyVersion: 1.477.2
+speakeasyVersion: 1.481.1
 sources:
     S2 API:
         sourceNamespace: s-2-api
-        sourceRevisionDigest: sha256:64c5f51eefa2e22cb205d6a808a0d2886f3b32343ba02cdd4b03b153e7c98eab
-        sourceBlobDigest: sha256:5df6a26e7b4537d883f917648f272c11dddd982a38384050fb1828e9bb7f4297
+        sourceRevisionDigest: sha256:cd6d5fcac99c6cdc42d3fded99beb796fcddf815f6f9f9b40aec337c873b0415
+        sourceBlobDigest: sha256:384c14a4d9c4a6009d9ad150b3ba8a87c23cfb88bcda001e3511f3c37815cd8f
         tags:
             - latest
+            - speakeasy-sdk-regen-1738369233
             - 1.0.0
 targets:
     streamstore:
         source: S2 API
         sourceNamespace: s-2-api
-        sourceRevisionDigest: sha256:64c5f51eefa2e22cb205d6a808a0d2886f3b32343ba02cdd4b03b153e7c98eab
-        sourceBlobDigest: sha256:5df6a26e7b4537d883f917648f272c11dddd982a38384050fb1828e9bb7f4297
+        sourceRevisionDigest: sha256:cd6d5fcac99c6cdc42d3fded99beb796fcddf815f6f9f9b40aec337c873b0415
+        sourceBlobDigest: sha256:384c14a4d9c4a6009d9ad150b3ba8a87c23cfb88bcda001e3511f3c37815cd8f
         codeSamplesNamespace: s-2-api-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:a771dadd8971d9c2016e7f767f21adbc2d0c684257c0b183796edb36f6481aa0
+        codeSamplesRevisionDigest: sha256:b2016bd7a33020a2ea1f80ac0ad30b771dece0f38cad14ddbf48b5c4db708775
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -166,8 +166,8 @@ run();
 
 ### [stream](docs/sdks/stream/README.md)
 
-* [read](docs/sdks/stream/README.md#read) - Retrieve a batch of records.
-* [append](docs/sdks/stream/README.md#append) - Append a batch of records.
+* [read](docs/sdks/stream/README.md#read) - Retrieve records.
+* [append](docs/sdks/stream/README.md#append) - Append records.
 * [checkTail](docs/sdks/stream/README.md#checktail) - Check the tail.
 
 </details>
@@ -198,9 +198,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`basinGetStreamConfig`](docs/sdks/basin/README.md#getstreamconfig) - Get stream configuration.
 - [`basinListStreams`](docs/sdks/basin/README.md#liststreams) - List Streams.
 - [`basinReconfigureStream`](docs/sdks/basin/README.md#reconfigurestream) - Update stream configuration.
-- [`streamAppend`](docs/sdks/stream/README.md#append) - Append a batch of records.
+- [`streamAppend`](docs/sdks/stream/README.md#append) - Append records.
 - [`streamCheckTail`](docs/sdks/stream/README.md#checktail) - Check the tail.
-- [`streamRead`](docs/sdks/stream/README.md#read) - Retrieve a batch of records.
+- [`streamRead`](docs/sdks/stream/README.md#read) - Retrieve records.
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->

diff --git a/RELEASES.md b/RELEASES.md
@@ -38,4 +38,14 @@ Based on:
 - OpenAPI Doc  
 - Speakeasy CLI 1.477.0 (2.497.0) https://github.com/speakeasy-api/speakeasy
 ### Generated
-- [typescript v0.2.2] .
+- [typescript v0.2.2] .
+
+## 2025-02-01 00:20:19
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.481.1 (2.500.5) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.6] .
+### Releases
+- [NPM v0.2.6] https://www.npmjs.com/package/@s2-dev/streamstore/v/0.2.6 - .
diff --git a/docs/sdks/stream/README.md b/docs/sdks/stream/README.md
@@ -7,13 +7,13 @@ Operate on an S2 stream
 
 ### Available Operations
 
-* [read](#read) - Retrieve a batch of records.
-* [append](#append) - Append a batch of records.
+* [read](#read) - Retrieve records.
+* [append](#append) - Append records.
 * [checkTail](#checktail) - Check the tail.
 
 ## read
 
-Retrieve a batch of records.
+Retrieve a batch of records, or set `Accept: text/event-stream` to stream using server-sent events.
 
 ### Example Usage
 
@@ -96,7 +96,7 @@ run();
 
 ## append
 
-Append a batch of records.
+Append a batch of records to a stream.
 
 ### Example Usage
 
@@ -189,7 +189,7 @@ run();
 
 ## checkTail
 
-Check the tail.
+Check the sequence number that will be assigned to the next record on a stream.
 
 ### Example Usage
 

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,21 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+  { files: ["**/*.{js,mjs,cjs,ts}"] },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      "no-constant-condition": "off",
+      // Handled by typescript compiler
+      "@typescript-eslint/no-unused-vars": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-empty-object-type": "off",
+      "@typescript-eslint/no-namespace": "off",
+    },
+  },
+];
diff --git a/jsr.json b/jsr.json
@@ -2,7 +2,7 @@
 
 {
   "name": "@s2-dev/streamstore",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",