@zshannon/streamstore 0.22.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +93 -0
- package/dist/cjs/accessTokens.d.ts +51 -0
- package/dist/cjs/accessTokens.d.ts.map +1 -0
- package/dist/cjs/accessTokens.js +127 -0
- package/dist/cjs/accessTokens.js.map +1 -0
- package/dist/cjs/auth/biscuit.d.ts +42 -0
- package/dist/cjs/auth/biscuit.d.ts.map +1 -0
- package/dist/cjs/auth/biscuit.js +72 -0
- package/dist/cjs/auth/biscuit.js.map +1 -0
- package/dist/cjs/auth/index.d.ts +5 -0
- package/dist/cjs/auth/index.d.ts.map +1 -0
- package/dist/cjs/auth/index.js +14 -0
- package/dist/cjs/auth/index.js.map +1 -0
- package/dist/cjs/auth/pki-auth.d.ts +60 -0
- package/dist/cjs/auth/pki-auth.d.ts.map +1 -0
- package/dist/cjs/auth/pki-auth.js +102 -0
- package/dist/cjs/auth/pki-auth.js.map +1 -0
- package/dist/cjs/auth/sign.d.ts +39 -0
- package/dist/cjs/auth/sign.d.ts.map +1 -0
- package/dist/cjs/auth/sign.js +128 -0
- package/dist/cjs/auth/sign.js.map +1 -0
- package/dist/cjs/auth/signing-key.d.ts +42 -0
- package/dist/cjs/auth/signing-key.d.ts.map +1 -0
- package/dist/cjs/auth/signing-key.js +66 -0
- package/dist/cjs/auth/signing-key.js.map +1 -0
- package/dist/cjs/basin.d.ts +33 -0
- package/dist/cjs/basin.d.ts.map +1 -0
- package/dist/cjs/basin.js +54 -0
- package/dist/cjs/basin.js.map +1 -0
- package/dist/cjs/basins.d.ts +62 -0
- package/dist/cjs/basins.d.ts.map +1 -0
- package/dist/cjs/basins.js +201 -0
- package/dist/cjs/basins.js.map +1 -0
- package/dist/cjs/batch-transform.d.ts +60 -0
- package/dist/cjs/batch-transform.d.ts.map +1 -0
- package/dist/cjs/batch-transform.js +171 -0
- package/dist/cjs/batch-transform.js.map +1 -0
- package/dist/cjs/common.d.ts +156 -0
- package/dist/cjs/common.d.ts.map +1 -0
- package/dist/cjs/common.js +54 -0
- package/dist/cjs/common.js.map +1 -0
- package/dist/cjs/endpoints.d.ts +63 -0
- package/dist/cjs/endpoints.d.ts.map +1 -0
- package/dist/cjs/endpoints.js +120 -0
- package/dist/cjs/endpoints.js.map +1 -0
- package/dist/cjs/error.d.ts +119 -0
- package/dist/cjs/error.d.ts.map +1 -0
- package/dist/cjs/error.js +373 -0
- package/dist/cjs/error.js.map +1 -0
- package/dist/cjs/generated/client/client.gen.d.ts +3 -0
- package/dist/cjs/generated/client/client.gen.d.ts.map +1 -0
- package/dist/cjs/generated/client/client.gen.js +209 -0
- package/dist/cjs/generated/client/client.gen.js.map +1 -0
- package/dist/cjs/generated/client/index.d.ts +9 -0
- package/dist/cjs/generated/client/index.d.ts.map +1 -0
- package/dist/cjs/generated/client/index.js +18 -0
- package/dist/cjs/generated/client/index.js.map +1 -0
- package/dist/cjs/generated/client/types.gen.d.ts +125 -0
- package/dist/cjs/generated/client/types.gen.d.ts.map +1 -0
- package/dist/cjs/generated/client/types.gen.js +4 -0
- package/dist/cjs/generated/client/types.gen.js.map +1 -0
- package/dist/cjs/generated/client/utils.gen.d.ts +34 -0
- package/dist/cjs/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/cjs/generated/client/utils.gen.js +243 -0
- package/dist/cjs/generated/client/utils.gen.js.map +1 -0
- package/dist/cjs/generated/client.gen.d.ts +13 -0
- package/dist/cjs/generated/client.gen.d.ts.map +1 -0
- package/dist/cjs/generated/client.gen.js +9 -0
- package/dist/cjs/generated/client.gen.js.map +1 -0
- package/dist/cjs/generated/core/auth.gen.d.ts +19 -0
- package/dist/cjs/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/auth.gen.js +19 -0
- package/dist/cjs/generated/core/auth.gen.js.map +1 -0
- package/dist/cjs/generated/core/bodySerializer.gen.d.ts +26 -0
- package/dist/cjs/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/bodySerializer.gen.js +61 -0
- package/dist/cjs/generated/core/bodySerializer.gen.js.map +1 -0
- package/dist/cjs/generated/core/params.gen.d.ts +44 -0
- package/dist/cjs/generated/core/params.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/params.gen.js +105 -0
- package/dist/cjs/generated/core/params.gen.js.map +1 -0
- package/dist/cjs/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/cjs/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/pathSerializer.gen.js +124 -0
- package/dist/cjs/generated/core/pathSerializer.gen.js.map +1 -0
- package/dist/cjs/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/cjs/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/queryKeySerializer.gen.js +106 -0
- package/dist/cjs/generated/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/cjs/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/cjs/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/serverSentEvents.gen.js +140 -0
- package/dist/cjs/generated/core/serverSentEvents.gen.js.map +1 -0
- package/dist/cjs/generated/core/types.gen.d.ts +79 -0
- package/dist/cjs/generated/core/types.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/types.gen.js +4 -0
- package/dist/cjs/generated/core/types.gen.js.map +1 -0
- package/dist/cjs/generated/core/utils.gen.d.ts +20 -0
- package/dist/cjs/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/cjs/generated/core/utils.gen.js +94 -0
- package/dist/cjs/generated/core/utils.gen.js.map +1 -0
- package/dist/cjs/generated/index.d.ts +3 -0
- package/dist/cjs/generated/index.d.ts.map +1 -0
- package/dist/cjs/generated/index.js +19 -0
- package/dist/cjs/generated/index.js.map +1 -0
- package/dist/cjs/generated/proto/s2.d.ts +250 -0
- package/dist/cjs/generated/proto/s2.d.ts.map +1 -0
- package/dist/cjs/generated/proto/s2.js +426 -0
- package/dist/cjs/generated/proto/s2.js.map +1 -0
- package/dist/cjs/generated/sdk.gen.d.ts +100 -0
- package/dist/cjs/generated/sdk.gen.d.ts.map +1 -0
- package/dist/cjs/generated/sdk.gen.js +374 -0
- package/dist/cjs/generated/sdk.gen.js.map +1 -0
- package/dist/cjs/generated/types.gen.d.ts +1064 -0
- package/dist/cjs/generated/types.gen.d.ts.map +1 -0
- package/dist/cjs/generated/types.gen.js +4 -0
- package/dist/cjs/generated/types.gen.js.map +1 -0
- package/dist/cjs/index.d.ts +42 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +81 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/internal/case-transform.d.ts +59 -0
- package/dist/cjs/internal/case-transform.d.ts.map +1 -0
- package/dist/cjs/internal/case-transform.js +80 -0
- package/dist/cjs/internal/case-transform.js.map +1 -0
- package/dist/cjs/internal/mappers.d.ts +51 -0
- package/dist/cjs/internal/mappers.d.ts.map +1 -0
- package/dist/cjs/internal/mappers.js +225 -0
- package/dist/cjs/internal/mappers.js.map +1 -0
- package/dist/cjs/internal/sdk-types.d.ts +127 -0
- package/dist/cjs/internal/sdk-types.d.ts.map +1 -0
- package/dist/cjs/internal/sdk-types.js +9 -0
- package/dist/cjs/internal/sdk-types.js.map +1 -0
- package/dist/cjs/lib/base64.d.ts +12 -0
- package/dist/cjs/lib/base64.d.ts.map +1 -0
- package/dist/cjs/lib/base64.js +172 -0
- package/dist/cjs/lib/base64.js.map +1 -0
- package/dist/cjs/lib/event-stream.d.ts +26 -0
- package/dist/cjs/lib/event-stream.d.ts.map +1 -0
- package/dist/cjs/lib/event-stream.js +154 -0
- package/dist/cjs/lib/event-stream.js.map +1 -0
- package/dist/cjs/lib/paginate.d.ts +61 -0
- package/dist/cjs/lib/paginate.d.ts.map +1 -0
- package/dist/cjs/lib/paginate.js +51 -0
- package/dist/cjs/lib/paginate.js.map +1 -0
- package/dist/cjs/lib/redacted.d.ts +17 -0
- package/dist/cjs/lib/redacted.d.ts.map +1 -0
- package/dist/cjs/lib/redacted.js +34 -0
- package/dist/cjs/lib/redacted.js.map +1 -0
- package/dist/cjs/lib/result.d.ts +57 -0
- package/dist/cjs/lib/result.d.ts.map +1 -0
- package/dist/cjs/lib/result.js +43 -0
- package/dist/cjs/lib/result.js.map +1 -0
- package/dist/cjs/lib/retry.d.ts +167 -0
- package/dist/cjs/lib/retry.d.ts.map +1 -0
- package/dist/cjs/lib/retry.js +1011 -0
- package/dist/cjs/lib/retry.js.map +1 -0
- package/dist/cjs/lib/stream/factory.d.ts +14 -0
- package/dist/cjs/lib/stream/factory.d.ts.map +1 -0
- package/dist/cjs/lib/stream/factory.js +35 -0
- package/dist/cjs/lib/stream/factory.js.map +1 -0
- package/dist/cjs/lib/stream/runtime.d.ts +27 -0
- package/dist/cjs/lib/stream/runtime.d.ts.map +1 -0
- package/dist/cjs/lib/stream/runtime.js +70 -0
- package/dist/cjs/lib/stream/runtime.js.map +1 -0
- package/dist/cjs/lib/stream/transport/fetch/index.d.ts +64 -0
- package/dist/cjs/lib/stream/transport/fetch/index.d.ts.map +1 -0
- package/dist/cjs/lib/stream/transport/fetch/index.js +462 -0
- package/dist/cjs/lib/stream/transport/fetch/index.js.map +1 -0
- package/dist/cjs/lib/stream/transport/fetch/shared.d.ts +11 -0
- package/dist/cjs/lib/stream/transport/fetch/shared.d.ts.map +1 -0
- package/dist/cjs/lib/stream/transport/fetch/shared.js +118 -0
- package/dist/cjs/lib/stream/transport/fetch/shared.js.map +1 -0
- package/dist/cjs/lib/stream/transport/proto.d.ts +9 -0
- package/dist/cjs/lib/stream/transport/proto.d.ts.map +1 -0
- package/dist/cjs/lib/stream/transport/proto.js +118 -0
- package/dist/cjs/lib/stream/transport/proto.js.map +1 -0
- package/dist/cjs/lib/stream/transport/s2s/framing.d.ts +47 -0
- package/dist/cjs/lib/stream/transport/s2s/framing.d.ts.map +1 -0
- package/dist/cjs/lib/stream/transport/s2s/framing.js +123 -0
- package/dist/cjs/lib/stream/transport/s2s/framing.js.map +1 -0
- package/dist/cjs/lib/stream/transport/s2s/index.d.ts +24 -0
- package/dist/cjs/lib/stream/transport/s2s/index.d.ts.map +1 -0
- package/dist/cjs/lib/stream/transport/s2s/index.js +823 -0
- package/dist/cjs/lib/stream/transport/s2s/index.js.map +1 -0
- package/dist/cjs/lib/stream/types.d.ts +199 -0
- package/dist/cjs/lib/stream/types.d.ts.map +1 -0
- package/dist/cjs/lib/stream/types.js +21 -0
- package/dist/cjs/lib/stream/types.js.map +1 -0
- package/dist/cjs/metrics.d.ts +46 -0
- package/dist/cjs/metrics.d.ts.map +1 -0
- package/dist/cjs/metrics.js +127 -0
- package/dist/cjs/metrics.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/producer.d.ts +82 -0
- package/dist/cjs/producer.d.ts.map +1 -0
- package/dist/cjs/producer.js +305 -0
- package/dist/cjs/producer.js.map +1 -0
- package/dist/cjs/s2.d.ts +41 -0
- package/dist/cjs/s2.d.ts.map +1 -0
- package/dist/cjs/s2.js +119 -0
- package/dist/cjs/s2.js.map +1 -0
- package/dist/cjs/stream.d.ts +78 -0
- package/dist/cjs/stream.d.ts.map +1 -0
- package/dist/cjs/stream.js +176 -0
- package/dist/cjs/stream.js.map +1 -0
- package/dist/cjs/streams.d.ts +61 -0
- package/dist/cjs/streams.d.ts.map +1 -0
- package/dist/cjs/streams.js +201 -0
- package/dist/cjs/streams.js.map +1 -0
- package/dist/cjs/types.d.ts +633 -0
- package/dist/cjs/types.d.ts.map +1 -0
- package/dist/cjs/types.js +129 -0
- package/dist/cjs/types.js.map +1 -0
- package/dist/cjs/utils.d.ts +25 -0
- package/dist/cjs/utils.d.ts.map +1 -0
- package/dist/cjs/utils.js +108 -0
- package/dist/cjs/utils.js.map +1 -0
- package/dist/cjs/version.d.ts +8 -0
- package/dist/cjs/version.d.ts.map +1 -0
- package/dist/cjs/version.js +11 -0
- package/dist/cjs/version.js.map +1 -0
- package/dist/esm/accessTokens.d.ts +51 -0
- package/dist/esm/accessTokens.d.ts.map +1 -0
- package/dist/esm/accessTokens.js +123 -0
- package/dist/esm/accessTokens.js.map +1 -0
- package/dist/esm/auth/biscuit.d.ts +42 -0
- package/dist/esm/auth/biscuit.d.ts.map +1 -0
- package/dist/esm/auth/biscuit.js +68 -0
- package/dist/esm/auth/biscuit.js.map +1 -0
- package/dist/esm/auth/index.d.ts +5 -0
- package/dist/esm/auth/index.d.ts.map +1 -0
- package/dist/esm/auth/index.js +5 -0
- package/dist/esm/auth/index.js.map +1 -0
- package/dist/esm/auth/pki-auth.d.ts +60 -0
- package/dist/esm/auth/pki-auth.d.ts.map +1 -0
- package/dist/esm/auth/pki-auth.js +99 -0
- package/dist/esm/auth/pki-auth.js.map +1 -0
- package/dist/esm/auth/sign.d.ts +39 -0
- package/dist/esm/auth/sign.d.ts.map +1 -0
- package/dist/esm/auth/sign.js +125 -0
- package/dist/esm/auth/sign.js.map +1 -0
- package/dist/esm/auth/signing-key.d.ts +42 -0
- package/dist/esm/auth/signing-key.d.ts.map +1 -0
- package/dist/esm/auth/signing-key.js +62 -0
- package/dist/esm/auth/signing-key.js.map +1 -0
- package/dist/esm/basin.d.ts +33 -0
- package/dist/esm/basin.d.ts.map +1 -0
- package/dist/esm/basin.js +50 -0
- package/dist/esm/basin.js.map +1 -0
- package/dist/esm/basins.d.ts +62 -0
- package/dist/esm/basins.d.ts.map +1 -0
- package/dist/esm/basins.js +197 -0
- package/dist/esm/basins.js.map +1 -0
- package/dist/esm/batch-transform.d.ts +60 -0
- package/dist/esm/batch-transform.d.ts.map +1 -0
- package/dist/esm/batch-transform.js +167 -0
- package/dist/esm/batch-transform.js.map +1 -0
- package/dist/esm/common.d.ts +156 -0
- package/dist/esm/common.d.ts.map +1 -0
- package/dist/esm/common.js +49 -0
- package/dist/esm/common.js.map +1 -0
- package/dist/esm/endpoints.d.ts +63 -0
- package/dist/esm/endpoints.d.ts.map +1 -0
- package/dist/esm/endpoints.js +115 -0
- package/dist/esm/endpoints.js.map +1 -0
- package/dist/esm/error.d.ts +119 -0
- package/dist/esm/error.d.ts.map +1 -0
- package/dist/esm/error.js +358 -0
- package/dist/esm/error.js.map +1 -0
- package/dist/esm/generated/client/client.gen.d.ts +3 -0
- package/dist/esm/generated/client/client.gen.d.ts.map +1 -0
- package/dist/esm/generated/client/client.gen.js +205 -0
- package/dist/esm/generated/client/client.gen.js.map +1 -0
- package/dist/esm/generated/client/index.d.ts +9 -0
- package/dist/esm/generated/client/index.d.ts.map +1 -0
- package/dist/esm/generated/client/index.js +7 -0
- package/dist/esm/generated/client/index.js.map +1 -0
- package/dist/esm/generated/client/types.gen.d.ts +125 -0
- package/dist/esm/generated/client/types.gen.d.ts.map +1 -0
- package/dist/esm/generated/client/types.gen.js +3 -0
- package/dist/esm/generated/client/types.gen.js.map +1 -0
- package/dist/esm/generated/client/utils.gen.d.ts +34 -0
- package/dist/esm/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/esm/generated/client/utils.gen.js +232 -0
- package/dist/esm/generated/client/utils.gen.js.map +1 -0
- package/dist/esm/generated/client.gen.d.ts +13 -0
- package/dist/esm/generated/client.gen.d.ts.map +1 -0
- package/dist/esm/generated/client.gen.js +6 -0
- package/dist/esm/generated/client.gen.js.map +1 -0
- package/dist/esm/generated/core/auth.gen.d.ts +19 -0
- package/dist/esm/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/auth.gen.js +15 -0
- package/dist/esm/generated/core/auth.gen.js.map +1 -0
- package/dist/esm/generated/core/bodySerializer.gen.d.ts +26 -0
- package/dist/esm/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/bodySerializer.gen.js +58 -0
- package/dist/esm/generated/core/bodySerializer.gen.js.map +1 -0
- package/dist/esm/generated/core/params.gen.d.ts +44 -0
- package/dist/esm/generated/core/params.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/params.gen.js +101 -0
- package/dist/esm/generated/core/params.gen.js.map +1 -0
- package/dist/esm/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/esm/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/pathSerializer.gen.js +115 -0
- package/dist/esm/generated/core/pathSerializer.gen.js.map +1 -0
- package/dist/esm/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/esm/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/queryKeySerializer.gen.js +100 -0
- package/dist/esm/generated/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/esm/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/esm/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/serverSentEvents.gen.js +136 -0
- package/dist/esm/generated/core/serverSentEvents.gen.js.map +1 -0
- package/dist/esm/generated/core/types.gen.d.ts +79 -0
- package/dist/esm/generated/core/types.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/types.gen.js +3 -0
- package/dist/esm/generated/core/types.gen.js.map +1 -0
- package/dist/esm/generated/core/utils.gen.d.ts +20 -0
- package/dist/esm/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/esm/generated/core/utils.gen.js +88 -0
- package/dist/esm/generated/core/utils.gen.js.map +1 -0
- package/dist/esm/generated/index.d.ts +3 -0
- package/dist/esm/generated/index.d.ts.map +1 -0
- package/dist/esm/generated/index.js +3 -0
- package/dist/esm/generated/index.js.map +1 -0
- package/dist/esm/generated/proto/s2.d.ts +250 -0
- package/dist/esm/generated/proto/s2.d.ts.map +1 -0
- package/dist/esm/generated/proto/s2.js +423 -0
- package/dist/esm/generated/proto/s2.js.map +1 -0
- package/dist/esm/generated/sdk.gen.d.ts +100 -0
- package/dist/esm/generated/sdk.gen.d.ts.map +1 -0
- package/dist/esm/generated/sdk.gen.js +350 -0
- package/dist/esm/generated/sdk.gen.js.map +1 -0
- package/dist/esm/generated/types.gen.d.ts +1064 -0
- package/dist/esm/generated/types.gen.d.ts.map +1 -0
- package/dist/esm/generated/types.gen.js +3 -0
- package/dist/esm/generated/types.gen.js.map +1 -0
- package/dist/esm/index.d.ts +42 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +47 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/internal/case-transform.d.ts +59 -0
- package/dist/esm/internal/case-transform.d.ts.map +1 -0
- package/dist/esm/internal/case-transform.js +76 -0
- package/dist/esm/internal/case-transform.js.map +1 -0
- package/dist/esm/internal/mappers.d.ts +51 -0
- package/dist/esm/internal/mappers.d.ts.map +1 -0
- package/dist/esm/internal/mappers.js +218 -0
- package/dist/esm/internal/mappers.js.map +1 -0
- package/dist/esm/internal/sdk-types.d.ts +127 -0
- package/dist/esm/internal/sdk-types.d.ts.map +1 -0
- package/dist/esm/internal/sdk-types.js +8 -0
- package/dist/esm/internal/sdk-types.js.map +1 -0
- package/dist/esm/lib/base64.d.ts +12 -0
- package/dist/esm/lib/base64.d.ts.map +1 -0
- package/dist/esm/lib/base64.js +165 -0
- package/dist/esm/lib/base64.js.map +1 -0
- package/dist/esm/lib/event-stream.d.ts +26 -0
- package/dist/esm/lib/event-stream.d.ts.map +1 -0
- package/dist/esm/lib/event-stream.js +150 -0
- package/dist/esm/lib/event-stream.js.map +1 -0
- package/dist/esm/lib/paginate.d.ts +61 -0
- package/dist/esm/lib/paginate.d.ts.map +1 -0
- package/dist/esm/lib/paginate.js +48 -0
- package/dist/esm/lib/paginate.js.map +1 -0
- package/dist/esm/lib/redacted.d.ts +17 -0
- package/dist/esm/lib/redacted.d.ts.map +1 -0
- package/dist/esm/lib/redacted.js +28 -0
- package/dist/esm/lib/redacted.js.map +1 -0
- package/dist/esm/lib/result.d.ts +57 -0
- package/dist/esm/lib/result.d.ts.map +1 -0
- package/dist/esm/lib/result.js +37 -0
- package/dist/esm/lib/result.js.map +1 -0
- package/dist/esm/lib/retry.d.ts +167 -0
- package/dist/esm/lib/retry.d.ts.map +1 -0
- package/dist/esm/lib/retry.js +1003 -0
- package/dist/esm/lib/retry.js.map +1 -0
- package/dist/esm/lib/stream/factory.d.ts +14 -0
- package/dist/esm/lib/stream/factory.d.ts.map +1 -0
- package/dist/esm/lib/stream/factory.js +32 -0
- package/dist/esm/lib/stream/factory.js.map +1 -0
- package/dist/esm/lib/stream/runtime.d.ts +27 -0
- package/dist/esm/lib/stream/runtime.d.ts.map +1 -0
- package/dist/esm/lib/stream/runtime.js +71 -0
- package/dist/esm/lib/stream/runtime.js.map +1 -0
- package/dist/esm/lib/stream/transport/fetch/index.d.ts +64 -0
- package/dist/esm/lib/stream/transport/fetch/index.d.ts.map +1 -0
- package/dist/esm/lib/stream/transport/fetch/index.js +456 -0
- package/dist/esm/lib/stream/transport/fetch/index.js.map +1 -0
- package/dist/esm/lib/stream/transport/fetch/shared.d.ts +11 -0
- package/dist/esm/lib/stream/transport/fetch/shared.d.ts.map +1 -0
- package/dist/esm/lib/stream/transport/fetch/shared.js +114 -0
- package/dist/esm/lib/stream/transport/fetch/shared.js.map +1 -0
- package/dist/esm/lib/stream/transport/proto.d.ts +9 -0
- package/dist/esm/lib/stream/transport/proto.d.ts.map +1 -0
- package/dist/esm/lib/stream/transport/proto.js +110 -0
- package/dist/esm/lib/stream/transport/proto.js.map +1 -0
- package/dist/esm/lib/stream/transport/s2s/framing.d.ts +47 -0
- package/dist/esm/lib/stream/transport/s2s/framing.d.ts.map +1 -0
- package/dist/esm/lib/stream/transport/s2s/framing.js +118 -0
- package/dist/esm/lib/stream/transport/s2s/framing.js.map +1 -0
- package/dist/esm/lib/stream/transport/s2s/index.d.ts +24 -0
- package/dist/esm/lib/stream/transport/s2s/index.d.ts.map +1 -0
- package/dist/esm/lib/stream/transport/s2s/index.js +819 -0
- package/dist/esm/lib/stream/transport/s2s/index.js.map +1 -0
- package/dist/esm/lib/stream/types.d.ts +199 -0
- package/dist/esm/lib/stream/types.d.ts.map +1 -0
- package/dist/esm/lib/stream/types.js +18 -0
- package/dist/esm/lib/stream/types.js.map +1 -0
- package/dist/esm/metrics.d.ts +46 -0
- package/dist/esm/metrics.d.ts.map +1 -0
- package/dist/esm/metrics.js +122 -0
- package/dist/esm/metrics.js.map +1 -0
- package/dist/esm/producer.d.ts +82 -0
- package/dist/esm/producer.d.ts.map +1 -0
- package/dist/esm/producer.js +300 -0
- package/dist/esm/producer.js.map +1 -0
- package/dist/esm/s2.d.ts +41 -0
- package/dist/esm/s2.d.ts.map +1 -0
- package/dist/esm/s2.js +115 -0
- package/dist/esm/s2.js.map +1 -0
- package/dist/esm/stream.d.ts +78 -0
- package/dist/esm/stream.d.ts.map +1 -0
- package/dist/esm/stream.js +172 -0
- package/dist/esm/stream.js.map +1 -0
- package/dist/esm/streams.d.ts +61 -0
- package/dist/esm/streams.d.ts.map +1 -0
- package/dist/esm/streams.js +197 -0
- package/dist/esm/streams.js.map +1 -0
- package/dist/esm/types.d.ts +633 -0
- package/dist/esm/types.d.ts.map +1 -0
- package/dist/esm/types.js +126 -0
- package/dist/esm/types.js.map +1 -0
- package/dist/esm/utils.d.ts +25 -0
- package/dist/esm/utils.d.ts.map +1 -0
- package/dist/esm/utils.js +103 -0
- package/dist/esm/utils.js.map +1 -0
- package/dist/esm/version.d.ts +8 -0
- package/dist/esm/version.d.ts.map +1 -0
- package/dist/esm/version.js +8 -0
- package/dist/esm/version.js.map +1 -0
- package/package.json +47 -0
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
import { withS2Data } from "./error.js";
|
|
2
|
+
import { createBasin, deleteBasin, getBasinConfig, listBasins, reconfigureBasin, } from "./generated/index.js";
|
|
3
|
+
import { toCamelCase, toSnakeCase } from "./internal/case-transform.js";
|
|
4
|
+
import { randomToken } from "./lib/base64.js";
|
|
5
|
+
import { paginate } from "./lib/paginate.js";
|
|
6
|
+
import { withRetries } from "./lib/retry.js";
|
|
7
|
+
/** Convert SDK RetentionPolicy (ageSecs) to API RetentionPolicy (age). */
|
|
8
|
+
function toAPIRetentionPolicy(policy) {
|
|
9
|
+
if (policy === null)
|
|
10
|
+
return null;
|
|
11
|
+
if (policy === undefined)
|
|
12
|
+
return undefined;
|
|
13
|
+
if ("ageSecs" in policy) {
|
|
14
|
+
return { age: Math.floor(policy.ageSecs) };
|
|
15
|
+
}
|
|
16
|
+
return policy; // { infinite: ... } passes through
|
|
17
|
+
}
|
|
18
|
+
/** Convert API RetentionPolicy (age) to SDK RetentionPolicy (ageSecs). */
|
|
19
|
+
function toSDKRetentionPolicy(policy) {
|
|
20
|
+
if (policy === null)
|
|
21
|
+
return null;
|
|
22
|
+
if (policy === undefined)
|
|
23
|
+
return undefined;
|
|
24
|
+
if ("age" in policy) {
|
|
25
|
+
return { ageSecs: policy.age };
|
|
26
|
+
}
|
|
27
|
+
return policy; // { infinite: ... } passes through
|
|
28
|
+
}
|
|
29
|
+
/** Convert SDK StreamConfig to API format (handles retentionPolicy.ageSecs → age). */
|
|
30
|
+
function toAPIStreamConfig(config) {
|
|
31
|
+
if (config === null || config === undefined)
|
|
32
|
+
return config;
|
|
33
|
+
return {
|
|
34
|
+
...config,
|
|
35
|
+
deleteOnEmpty: config.deleteOnEmpty
|
|
36
|
+
? {
|
|
37
|
+
...config.deleteOnEmpty,
|
|
38
|
+
minAgeSecs: config.deleteOnEmpty.minAgeSecs === undefined
|
|
39
|
+
? undefined
|
|
40
|
+
: Math.max(0, Math.floor(config.deleteOnEmpty.minAgeSecs)),
|
|
41
|
+
}
|
|
42
|
+
: config.deleteOnEmpty,
|
|
43
|
+
retentionPolicy: toAPIRetentionPolicy(config.retentionPolicy),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
/** Convert API StreamConfig to SDK format (handles retentionPolicy.age → ageSecs). */
|
|
47
|
+
function toSDKStreamConfig(config) {
|
|
48
|
+
if (config === null || config === undefined)
|
|
49
|
+
return config;
|
|
50
|
+
return {
|
|
51
|
+
...config,
|
|
52
|
+
retentionPolicy: toSDKRetentionPolicy(config?.retentionPolicy),
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
/** Convert SDK BasinConfig to API format. */
|
|
56
|
+
function toAPIBasinConfig(config) {
|
|
57
|
+
if (config === null || config === undefined)
|
|
58
|
+
return config;
|
|
59
|
+
return {
|
|
60
|
+
...config,
|
|
61
|
+
defaultStreamConfig: toAPIStreamConfig(config.defaultStreamConfig),
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
/** Convert API BasinConfig to SDK format. */
|
|
65
|
+
function toSDKBasinConfig(config) {
|
|
66
|
+
return {
|
|
67
|
+
...config,
|
|
68
|
+
defaultStreamConfig: toSDKStreamConfig(config?.defaultStreamConfig),
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Account-scoped helper for listing, creating, deleting, and reconfiguring basins.
|
|
73
|
+
*
|
|
74
|
+
* Retrieve this via {@link S2.basins}. Each method retries according to the client-level retry config.
|
|
75
|
+
*/
|
|
76
|
+
export class S2Basins {
|
|
77
|
+
client;
|
|
78
|
+
retryConfig;
|
|
79
|
+
constructor(client, retryConfig) {
|
|
80
|
+
this.client = client;
|
|
81
|
+
this.retryConfig = retryConfig;
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* List basins.
|
|
85
|
+
*
|
|
86
|
+
* @param args.prefix Return basins whose names start with the given prefix
|
|
87
|
+
* @param args.startAfter Name to start after (for pagination)
|
|
88
|
+
* @param args.limit Max results (up to 1000)
|
|
89
|
+
*/
|
|
90
|
+
async list(args, options) {
|
|
91
|
+
const response = await withRetries(this.retryConfig, async () => {
|
|
92
|
+
return await withS2Data(() => listBasins({
|
|
93
|
+
client: this.client,
|
|
94
|
+
query: toSnakeCase(args),
|
|
95
|
+
...options,
|
|
96
|
+
}));
|
|
97
|
+
});
|
|
98
|
+
return toCamelCase(response);
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* List all basins with automatic pagination.
|
|
102
|
+
* Returns a lazy async iterable that fetches pages as needed.
|
|
103
|
+
*
|
|
104
|
+
* @param args - Optional options: `prefix` to filter by name prefix, `limit` for max results per page, `includeDeleted` to include basins pending deletion
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* for await (const basin of s2.basins.listAll({ prefix: "my-" })) {
|
|
109
|
+
* console.log(basin.name);
|
|
110
|
+
* }
|
|
111
|
+
* ```
|
|
112
|
+
*/
|
|
113
|
+
listAll(args, options) {
|
|
114
|
+
const { includeDeleted, ...listArgs } = args ?? {};
|
|
115
|
+
return paginate((a) => this.list(a, options).then((r) => ({
|
|
116
|
+
items: r.basins.filter((b) => includeDeleted || b.state !== "deleting"),
|
|
117
|
+
hasMore: r.hasMore,
|
|
118
|
+
})), listArgs, (basin) => basin.name);
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Create a basin.
|
|
122
|
+
*
|
|
123
|
+
* @param args.basin Globally unique basin name (8-48 chars, lowercase letters, numbers, hyphens; cannot begin or end with a hyphen)
|
|
124
|
+
* @param args.config Optional basin configuration (e.g. defaultStreamConfig)
|
|
125
|
+
* @param args.scope Basin scope
|
|
126
|
+
*/
|
|
127
|
+
async create(args, options) {
|
|
128
|
+
const requestToken = randomToken();
|
|
129
|
+
// Convert SDK config to API format (ageSecs → age)
|
|
130
|
+
const apiArgs = {
|
|
131
|
+
...args,
|
|
132
|
+
config: toAPIBasinConfig(args.config),
|
|
133
|
+
};
|
|
134
|
+
const response = await withRetries(this.retryConfig, async () => {
|
|
135
|
+
return await withS2Data(() => createBasin({
|
|
136
|
+
client: this.client,
|
|
137
|
+
body: toSnakeCase(apiArgs),
|
|
138
|
+
headers: { "s2-request-token": requestToken },
|
|
139
|
+
...options,
|
|
140
|
+
}));
|
|
141
|
+
});
|
|
142
|
+
return toCamelCase(response);
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Get basin configuration.
|
|
146
|
+
*
|
|
147
|
+
* @param args.basin Basin name
|
|
148
|
+
*/
|
|
149
|
+
async getConfig(args, options) {
|
|
150
|
+
const response = await withRetries(this.retryConfig, async () => {
|
|
151
|
+
return await withS2Data(() => getBasinConfig({
|
|
152
|
+
client: this.client,
|
|
153
|
+
path: args,
|
|
154
|
+
...options,
|
|
155
|
+
}));
|
|
156
|
+
});
|
|
157
|
+
// Convert API format to SDK (age → ageSecs)
|
|
158
|
+
return toSDKBasinConfig(toCamelCase(response));
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* Delete a basin.
|
|
162
|
+
*
|
|
163
|
+
* @param args.basin Basin name
|
|
164
|
+
*/
|
|
165
|
+
async delete(args, options) {
|
|
166
|
+
await withRetries(this.retryConfig, async () => {
|
|
167
|
+
return await withS2Data(() => deleteBasin({
|
|
168
|
+
client: this.client,
|
|
169
|
+
path: args,
|
|
170
|
+
...options,
|
|
171
|
+
}));
|
|
172
|
+
});
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* Reconfigure a basin.
|
|
176
|
+
*
|
|
177
|
+
* @param args Configuration for the basin to reconfigure (including basin name and fields to change)
|
|
178
|
+
*/
|
|
179
|
+
async reconfigure(args, options) {
|
|
180
|
+
// Convert SDK config to API format (ageSecs → age)
|
|
181
|
+
const apiArgs = {
|
|
182
|
+
...args,
|
|
183
|
+
defaultStreamConfig: toAPIStreamConfig(args.defaultStreamConfig),
|
|
184
|
+
};
|
|
185
|
+
const response = await withRetries(this.retryConfig, async () => {
|
|
186
|
+
return await withS2Data(() => reconfigureBasin({
|
|
187
|
+
client: this.client,
|
|
188
|
+
path: args,
|
|
189
|
+
body: toSnakeCase(apiArgs),
|
|
190
|
+
...options,
|
|
191
|
+
}));
|
|
192
|
+
});
|
|
193
|
+
// Convert API format to SDK (age → ageSecs)
|
|
194
|
+
return toSDKBasinConfig(toCamelCase(response));
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
//# sourceMappingURL=basins.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"basins.js","sourceRoot":"","sources":["../../src/basins.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,OAAO,EACN,WAAW,EACX,WAAW,EACX,cAAc,EACd,UAAU,EACV,gBAAgB,GAChB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,0EAA0E;AAC1E,SAAS,oBAAoB,CAC5B,MAAgD;IAEhD,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACjC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,IAAI,SAAS,IAAI,MAAM,EAAE,CAAC;QACzB,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IAC5C,CAAC;IACD,OAAO,MAAM,CAAC,CAAC,mCAAmC;AACnD,CAAC;AAED,0EAA0E;AAC1E,SAAS,oBAAoB,CAC5B,MAA8C;IAE9C,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACjC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;QACrB,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;IAChC,CAAC;IACD,OAAO,MAAM,CAAC,CAAC,mCAAmC;AACnD,CAAC;AAED,sFAAsF;AACtF,SAAS,iBAAiB,CAAC,MAA6C;IACvE,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAC3D,OAAO;QACN,GAAG,MAAM;QACT,aAAa,EAAE,MAAM,CAAC,aAAa;YAClC,CAAC,CAAC;gBACA,GAAG,MAAM,CAAC,aAAa;gBACvB,UAAU,EACT,MAAM,CAAC,aAAa,CAAC,UAAU,KAAK,SAAS;oBAC5C,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;aAC5D;YACF,CAAC,CAAC,MAAM,CAAC,aAAa;QACvB,eAAe,EAAE,oBAAoB,CAAC,MAAM,CAAC,eAAe,CAAC;KAC7D,CAAC;AACH,CAAC;AAED,sFAAsF;AACtF,SAAS,iBAAiB,CAAC,MAAW;IACrC,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAC3D,OAAO;QACN,GAAG,MAAM;QACT,eAAe,EAAE,oBAAoB,CAAC,MAAM,EAAE,eAAe,CAAC;KAC9D,CAAC;AACH,CAAC;AAED,6CAA6C;AAC7C,SAAS,gBAAgB,CAAC,MAA4C;IACrE,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,MAAM,CAAC;IAC3D,OAAO;QACN,GAAG,MAAM;QACT,mBAAmB,EAAE,iBAAiB,CAAC,MAAM,CAAC,mBAAmB,CAAC;KAClE,CAAC;AACH,CAAC;AAED,6CAA6C;AAC7C,SAAS,gBAAgB,CAAC,MAAW;IACpC,OAAO;QACN,GAAG,MAAM;QACT,mBAAmB,EAAE,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,CAAC;KACnE,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,QAAQ;IACH,MAAM,CAAS;IACf,WAAW,CAAc;IAE1C,YAAY,MAAc,EAAE,WAAwB;QACnD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI,CAChB,IAA4B,EAC5B,OAA0B;QAE1B,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC/D,OAAO,MAAM,UAAU,CAAC,GAAG,EAAE,CAC5B,UAAU,CAAC;gBACV,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC;gBACxB,GAAG,OAAO;aACV,CAAC,CACF,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,WAAW,CAA2B,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,OAAO,CACb,IAA+B,EAC/B,OAA0B;QAE1B,MAAM,EAAE,cAAc,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC;QACnD,OAAO,QAAQ,CACd,CAAC,CAAC,EAAE,EAAE,CACL,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAClC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CACrB,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,IAAI,CAAC,CAAC,KAAK,KAAK,UAAU,CAC/C;YACD,OAAO,EAAE,CAAC,CAAC,OAAO;SAClB,CAAC,CAAC,EACJ,QAAQ,EACR,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CACrB,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAClB,IAA4B,EAC5B,OAA0B;QAE1B,MAAM,YAAY,GAAG,WAAW,EAAE,CAAC;QACnC,mDAAmD;QACnD,MAAM,OAAO,GAAG;YACf,GAAG,IAAI;YACP,MAAM,EAAE,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC;SACrC,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC/D,OAAO,MAAM,UAAU,CAAC,GAAG,EAAE,CAC5B,WAAW,CAAC;gBACX,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;gBAC1B,OAAO,EAAE,EAAE,kBAAkB,EAAE,YAAY,EAAE;gBAC7C,GAAG,OAAO;aACV,CAAC,CACF,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,WAAW,CAA4B,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACrB,IAA+B,EAC/B,OAA0B;QAE1B,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC/D,OAAO,MAAM,UAAU,CAAC,GAAG,EAAE,CAC5B,cAAc,CAAC;gBACd,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,IAAI;gBACV,GAAG,OAAO;aACV,CAAC,CACF,CAAC;QACH,CAAC,CAAC,CAAC;QACH,4CAA4C;QAC5C,OAAO,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAClB,IAA4B,EAC5B,OAA0B;QAE1B,MAAM,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC9C,OAAO,MAAM,UAAU,CAAC,GAAG,EAAE,CAC5B,WAAW,CAAC;gBACX,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,IAAI;gBACV,GAAG,OAAO;aACV,CAAC,CACF,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW,CACvB,IAAiC,EACjC,OAA0B;QAE1B,mDAAmD;QACnD,MAAM,OAAO,GAAG;YACf,GAAG,IAAI;YACP,mBAAmB,EAAE,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC;SAChE,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC/D,OAAO,MAAM,UAAU,CAAC,GAAG,EAAE,CAC5B,gBAAgB,CAAC;gBAChB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC;gBAC1B,GAAG,OAAO;aACV,CAAC,CACF,CAAC;QACH,CAAC,CAAC,CAAC;QACH,4CAA4C;QAC5C,OAAO,gBAAgB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChD,CAAC;CACD"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { AppendInput, type AppendRecord } from "./types.js";
|
|
2
|
+
export interface BatchTransformOptions {
|
|
3
|
+
/** Duration in milliseconds to wait before flushing a batch (default: 5ms) */
|
|
4
|
+
lingerDurationMillis?: number;
|
|
5
|
+
/** Maximum number of records in a batch (default: 1000, max: 1000) */
|
|
6
|
+
maxBatchRecords?: number;
|
|
7
|
+
/** Maximum batch size in metered bytes (default: 1 MiB, max: 1 MiB) */
|
|
8
|
+
maxBatchBytes?: number;
|
|
9
|
+
/** Optional fencing token to enforce (remains static across batches) */
|
|
10
|
+
fencingToken?: string;
|
|
11
|
+
/** Optional sequence number to match for first batch (auto-increments for subsequent batches) */
|
|
12
|
+
matchSeqNum?: number;
|
|
13
|
+
}
|
|
14
|
+
/** Batch output type with optional fencing token and matchSeqNum */
|
|
15
|
+
export type BatchOutput = AppendInput;
|
|
16
|
+
/**
|
|
17
|
+
* A TransformStream that batches AppendRecords based on time, record count, and byte size.
|
|
18
|
+
*
|
|
19
|
+
* Input: AppendRecord (individual records)
|
|
20
|
+
* Output: { records: AppendRecord[], fencingToken?: string, matchSeqNum?: number }
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```typescript
|
|
24
|
+
* const batcher = new BatchTransform<"string">({
|
|
25
|
+
* lingerDurationMillis: 20,
|
|
26
|
+
* maxBatchRecords: 100,
|
|
27
|
+
* maxBatchBytes: 256 * 1024,
|
|
28
|
+
* matchSeqNum: 0 // Optional: auto-increments per batch
|
|
29
|
+
* });
|
|
30
|
+
*
|
|
31
|
+
* // Pipe through the batcher and session to get acks
|
|
32
|
+
* readable.pipeThrough(batcher).pipeThrough(session).pipeTo(writable);
|
|
33
|
+
*
|
|
34
|
+
* // Or use manually
|
|
35
|
+
* const writer = batcher.writable.getWriter();
|
|
36
|
+
* writer.write(AppendRecord.string({ body: "foo" }));
|
|
37
|
+
* await writer.close();
|
|
38
|
+
*
|
|
39
|
+
* for await (const batch of batcher.readable) {
|
|
40
|
+
* console.log(`Got batch of ${batch.records.length} records`);
|
|
41
|
+
* }
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
export declare class BatchTransform extends TransformStream<AppendRecord, BatchOutput> {
|
|
45
|
+
private currentBatch;
|
|
46
|
+
private currentBatchSize;
|
|
47
|
+
private lingerTimer;
|
|
48
|
+
private controller;
|
|
49
|
+
private readonly maxBatchRecords;
|
|
50
|
+
private readonly maxBatchBytes;
|
|
51
|
+
private readonly lingerDuration;
|
|
52
|
+
private readonly fencingToken?;
|
|
53
|
+
private nextMatchSeqNum?;
|
|
54
|
+
constructor(args?: BatchTransformOptions);
|
|
55
|
+
private handleRecord;
|
|
56
|
+
private flush;
|
|
57
|
+
private startLingerTimer;
|
|
58
|
+
private cancelLingerTimer;
|
|
59
|
+
}
|
|
60
|
+
//# sourceMappingURL=batch-transform.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"batch-transform.d.ts","sourceRoot":"","sources":["../../src/batch-transform.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAG5D,MAAM,WAAW,qBAAqB;IACrC,8EAA8E;IAC9E,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,sEAAsE;IACtE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iGAAiG;IACjG,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,oEAAoE;AACpE,MAAM,MAAM,WAAW,GAAG,WAAW,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,cAAe,SAAQ,eAAe,CAAC,YAAY,EAAE,WAAW,CAAC;IAC7E,OAAO,CAAC,YAAY,CAAsB;IAC1C,OAAO,CAAC,gBAAgB,CAAa;IACrC,OAAO,CAAC,WAAW,CAA8C;IACjE,OAAO,CAAC,UAAU,CACZ;IACN,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAS;IACvC,OAAO,CAAC,eAAe,CAAC,CAAS;gBAErB,IAAI,CAAC,EAAE,qBAAqB;IAyDxC,OAAO,CAAC,YAAY;IA4CpB,OAAO,CAAC,KAAK;IA2Bb,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,iBAAiB;CAMzB"}
|
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
import { S2Error } from "./error.js";
|
|
2
|
+
import { AppendInput } from "./types.js";
|
|
3
|
+
import { meteredBytes } from "./utils.js";
|
|
4
|
+
/**
|
|
5
|
+
* A TransformStream that batches AppendRecords based on time, record count, and byte size.
|
|
6
|
+
*
|
|
7
|
+
* Input: AppendRecord (individual records)
|
|
8
|
+
* Output: { records: AppendRecord[], fencingToken?: string, matchSeqNum?: number }
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```typescript
|
|
12
|
+
* const batcher = new BatchTransform<"string">({
|
|
13
|
+
* lingerDurationMillis: 20,
|
|
14
|
+
* maxBatchRecords: 100,
|
|
15
|
+
* maxBatchBytes: 256 * 1024,
|
|
16
|
+
* matchSeqNum: 0 // Optional: auto-increments per batch
|
|
17
|
+
* });
|
|
18
|
+
*
|
|
19
|
+
* // Pipe through the batcher and session to get acks
|
|
20
|
+
* readable.pipeThrough(batcher).pipeThrough(session).pipeTo(writable);
|
|
21
|
+
*
|
|
22
|
+
* // Or use manually
|
|
23
|
+
* const writer = batcher.writable.getWriter();
|
|
24
|
+
* writer.write(AppendRecord.string({ body: "foo" }));
|
|
25
|
+
* await writer.close();
|
|
26
|
+
*
|
|
27
|
+
* for await (const batch of batcher.readable) {
|
|
28
|
+
* console.log(`Got batch of ${batch.records.length} records`);
|
|
29
|
+
* }
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
export class BatchTransform extends TransformStream {
|
|
33
|
+
currentBatch = [];
|
|
34
|
+
currentBatchSize = 0;
|
|
35
|
+
lingerTimer = null;
|
|
36
|
+
controller = null;
|
|
37
|
+
maxBatchRecords;
|
|
38
|
+
maxBatchBytes;
|
|
39
|
+
lingerDuration;
|
|
40
|
+
fencingToken;
|
|
41
|
+
nextMatchSeqNum;
|
|
42
|
+
constructor(args) {
|
|
43
|
+
let controller;
|
|
44
|
+
super({
|
|
45
|
+
start: (c) => {
|
|
46
|
+
controller = c;
|
|
47
|
+
},
|
|
48
|
+
transform: (chunk, c) => {
|
|
49
|
+
// Store controller reference on first transform
|
|
50
|
+
if (!this.controller) {
|
|
51
|
+
this.controller = c;
|
|
52
|
+
}
|
|
53
|
+
this.handleRecord(chunk);
|
|
54
|
+
},
|
|
55
|
+
flush: () => {
|
|
56
|
+
this.flush();
|
|
57
|
+
},
|
|
58
|
+
});
|
|
59
|
+
// Validate configuration
|
|
60
|
+
if (args?.maxBatchRecords !== undefined) {
|
|
61
|
+
if (args.maxBatchRecords < 1 || args.maxBatchRecords > 1000) {
|
|
62
|
+
throw new S2Error({
|
|
63
|
+
message: `maxBatchRecords must be between 1 and 1000 (inclusive); got ${args.maxBatchRecords}`,
|
|
64
|
+
status: 400,
|
|
65
|
+
origin: "sdk",
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
if (args?.maxBatchBytes !== undefined) {
|
|
70
|
+
const max = 1024 * 1024;
|
|
71
|
+
if (args.maxBatchBytes < 1 || args.maxBatchBytes > max) {
|
|
72
|
+
throw new S2Error({
|
|
73
|
+
message: `maxBatchBytes must be between 1 and ${max} (1 MiB) bytes (inclusive); got ${args.maxBatchBytes}`,
|
|
74
|
+
status: 400,
|
|
75
|
+
origin: "sdk",
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
if (args?.lingerDurationMillis !== undefined) {
|
|
80
|
+
if (args.lingerDurationMillis < 0) {
|
|
81
|
+
throw new S2Error({
|
|
82
|
+
message: `lingerDurationMillis must be >= 0; got ${args.lingerDurationMillis}`,
|
|
83
|
+
status: 400,
|
|
84
|
+
origin: "sdk",
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
// Apply defaults
|
|
89
|
+
this.maxBatchRecords = args?.maxBatchRecords ?? 1000;
|
|
90
|
+
this.maxBatchBytes = args?.maxBatchBytes ?? 1024 * 1024;
|
|
91
|
+
this.lingerDuration = args?.lingerDurationMillis ?? 5;
|
|
92
|
+
this.fencingToken = args?.fencingToken;
|
|
93
|
+
this.nextMatchSeqNum = args?.matchSeqNum;
|
|
94
|
+
}
|
|
95
|
+
handleRecord(record) {
|
|
96
|
+
const recordSize = meteredBytes(record);
|
|
97
|
+
// Reject individual records that exceed the max batch size
|
|
98
|
+
if (recordSize > this.maxBatchBytes) {
|
|
99
|
+
throw new S2Error({
|
|
100
|
+
message: `Record size ${recordSize} bytes exceeds maximum batch size of ${this.maxBatchBytes} bytes`,
|
|
101
|
+
status: 400,
|
|
102
|
+
origin: "sdk",
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
// Start linger timer on first record added to an empty batch
|
|
106
|
+
if (this.currentBatch.length === 0 && this.lingerDuration > 0) {
|
|
107
|
+
this.startLingerTimer();
|
|
108
|
+
}
|
|
109
|
+
// Check if adding this record would exceed limits
|
|
110
|
+
const wouldExceedRecords = this.currentBatch.length + 1 > this.maxBatchRecords;
|
|
111
|
+
const wouldExceedBytes = this.currentBatchSize + recordSize > this.maxBatchBytes;
|
|
112
|
+
if (wouldExceedRecords || wouldExceedBytes) {
|
|
113
|
+
this.flush();
|
|
114
|
+
// Restart linger timer for new batch
|
|
115
|
+
if (this.lingerDuration > 0) {
|
|
116
|
+
this.startLingerTimer();
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
// Add record to current batch
|
|
120
|
+
this.currentBatch.push(record);
|
|
121
|
+
this.currentBatchSize += recordSize;
|
|
122
|
+
// Check if we've now reached the limits
|
|
123
|
+
const nowExceedsRecords = this.currentBatch.length >= this.maxBatchRecords;
|
|
124
|
+
const nowExceedsBytes = this.currentBatchSize >= this.maxBatchBytes;
|
|
125
|
+
if (nowExceedsRecords || nowExceedsBytes) {
|
|
126
|
+
this.flush();
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
flush() {
|
|
130
|
+
this.cancelLingerTimer();
|
|
131
|
+
if (this.currentBatch.length === 0) {
|
|
132
|
+
return;
|
|
133
|
+
}
|
|
134
|
+
// Auto-increment matchSeqNum for next batch
|
|
135
|
+
const matchSeqNum = this.nextMatchSeqNum;
|
|
136
|
+
if (this.nextMatchSeqNum !== undefined) {
|
|
137
|
+
this.nextMatchSeqNum += this.currentBatch.length;
|
|
138
|
+
}
|
|
139
|
+
// Emit the batch downstream with optional fencing token and matchSeqNum
|
|
140
|
+
if (this.controller) {
|
|
141
|
+
const batch = AppendInput.create([...this.currentBatch], {
|
|
142
|
+
fencingToken: this.fencingToken,
|
|
143
|
+
matchSeqNum,
|
|
144
|
+
});
|
|
145
|
+
this.controller.enqueue(batch);
|
|
146
|
+
}
|
|
147
|
+
// Reset batch
|
|
148
|
+
this.currentBatch = [];
|
|
149
|
+
this.currentBatchSize = 0;
|
|
150
|
+
}
|
|
151
|
+
startLingerTimer() {
|
|
152
|
+
this.cancelLingerTimer();
|
|
153
|
+
this.lingerTimer = setTimeout(() => {
|
|
154
|
+
this.lingerTimer = null;
|
|
155
|
+
if (this.currentBatch.length > 0) {
|
|
156
|
+
this.flush();
|
|
157
|
+
}
|
|
158
|
+
}, this.lingerDuration);
|
|
159
|
+
}
|
|
160
|
+
cancelLingerTimer() {
|
|
161
|
+
if (this.lingerTimer) {
|
|
162
|
+
clearTimeout(this.lingerTimer);
|
|
163
|
+
this.lingerTimer = null;
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
//# sourceMappingURL=batch-transform.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"batch-transform.js","sourceRoot":"","sources":["../../src/batch-transform.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,WAAW,EAAqB,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAkB1C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,cAAe,SAAQ,eAA0C;IACrE,YAAY,GAAmB,EAAE,CAAC;IAClC,gBAAgB,GAAW,CAAC,CAAC;IAC7B,WAAW,GAAyC,IAAI,CAAC;IACzD,UAAU,GACjB,IAAI,CAAC;IACW,eAAe,CAAS;IACxB,aAAa,CAAS;IACtB,cAAc,CAAS;IACvB,YAAY,CAAU;IAC/B,eAAe,CAAU;IAEjC,YAAY,IAA4B;QACvC,IAAI,UAAyD,CAAC;QAE9D,KAAK,CAAC;YACL,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE;gBACZ,UAAU,GAAG,CAAC,CAAC;YAChB,CAAC;YACD,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBACvB,gDAAgD;gBAChD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;oBACtB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;gBACrB,CAAC;gBACD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC1B,CAAC;YACD,KAAK,EAAE,GAAG,EAAE;gBACX,IAAI,CAAC,KAAK,EAAE,CAAC;YACd,CAAC;SACD,CAAC,CAAC;QAEH,yBAAyB;QACzB,IAAI,IAAI,EAAE,eAAe,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,IAAI,CAAC,eAAe,GAAG,CAAC,IAAI,IAAI,CAAC,eAAe,GAAG,IAAI,EAAE,CAAC;gBAC7D,MAAM,IAAI,OAAO,CAAC;oBACjB,OAAO,EAAE,+DAA+D,IAAI,CAAC,eAAe,EAAE;oBAC9F,MAAM,EAAE,GAAG;oBACX,MAAM,EAAE,KAAK;iBACb,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QACD,IAAI,IAAI,EAAE,aAAa,KAAK,SAAS,EAAE,CAAC;YACvC,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;YACxB,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC;gBACxD,MAAM,IAAI,OAAO,CAAC;oBACjB,OAAO,EAAE,uCAAuC,GAAG,mCAAmC,IAAI,CAAC,aAAa,EAAE;oBAC1G,MAAM,EAAE,GAAG;oBACX,MAAM,EAAE,KAAK;iBACb,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QACD,IAAI,IAAI,EAAE,oBAAoB,KAAK,SAAS,EAAE,CAAC;YAC9C,IAAI,IAAI,CAAC,oBAAoB,GAAG,CAAC,EAAE,CAAC;gBACnC,MAAM,IAAI,OAAO,CAAC;oBACjB,OAAO,EAAE,0CAA0C,IAAI,CAAC,oBAAoB,EAAE;oBAC9E,MAAM,EAAE,GAAG;oBACX,MAAM,EAAE,KAAK;iBACb,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,iBAAiB;QACjB,IAAI,CAAC,eAAe,GAAG,IAAI,EAAE,eAAe,IAAI,IAAI,CAAC;QACrD,IAAI,CAAC,aAAa,GAAG,IAAI,EAAE,aAAa,IAAI,IAAI,GAAG,IAAI,CAAC;QACxD,IAAI,CAAC,cAAc,GAAG,IAAI,EAAE,oBAAoB,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,YAAY,CAAC;QACvC,IAAI,CAAC,eAAe,GAAG,IAAI,EAAE,WAAW,CAAC;IAC1C,CAAC;IAEO,YAAY,CAAC,MAAoB;QACxC,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;QAExC,2DAA2D;QAC3D,IAAI,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,MAAM,IAAI,OAAO,CAAC;gBACjB,OAAO,EAAE,eAAe,UAAU,wCAAwC,IAAI,CAAC,aAAa,QAAQ;gBACpG,MAAM,EAAE,GAAG;gBACX,MAAM,EAAE,KAAK;aACb,CAAC,CAAC;QACJ,CAAC;QAED,6DAA6D;QAC7D,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;YAC/D,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACzB,CAAC;QAED,kDAAkD;QAClD,MAAM,kBAAkB,GACvB,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACrD,MAAM,gBAAgB,GACrB,IAAI,CAAC,gBAAgB,GAAG,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC;QAEzD,IAAI,kBAAkB,IAAI,gBAAgB,EAAE,CAAC;YAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,qCAAqC;YACrC,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC;gBAC7B,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACzB,CAAC;QACF,CAAC;QAED,8BAA8B;QAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,CAAC,gBAAgB,IAAI,UAAU,CAAC;QAEpC,wCAAwC;QACxC,MAAM,iBAAiB,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,eAAe,CAAC;QAC3E,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,aAAa,CAAC;QAEpE,IAAI,iBAAiB,IAAI,eAAe,EAAE,CAAC;YAC1C,IAAI,CAAC,KAAK,EAAE,CAAC;QACd,CAAC;IACF,CAAC;IAEO,KAAK;QACZ,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEzB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,OAAO;QACR,CAAC;QAED,4CAA4C;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC;QACzC,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACxC,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;QAClD,CAAC;QAED,wEAAwE;QACxE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE;gBACxD,YAAY,EAAE,IAAI,CAAC,YAAY;gBAC/B,WAAW;aACX,CAAC,CAAC;YACH,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QAED,cAAc;QACd,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;QACvB,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEO,gBAAgB;QACvB,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAEzB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE;YAClC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;YACxB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,KAAK,EAAE,CAAC;YACd,CAAC;QACF,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACzB,CAAC;IAEO,iBAAiB;QACxB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACzB,CAAC;IACF,CAAC;CACD"}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import type { PkiAuthContext } from "./auth/pki-auth.js";
|
|
2
|
+
import { S2Endpoints, type S2EndpointsInit } from "./endpoints.js";
|
|
3
|
+
import type { Client } from "./generated/client/types.gen.js";
|
|
4
|
+
/**
|
|
5
|
+
* Policy for retrying append operations.
|
|
6
|
+
*
|
|
7
|
+
* - `all`: Retry all append operations, including those that may have side effects (default)
|
|
8
|
+
* - `noSideEffects`: Only retry append operations that are guaranteed to have no side effects
|
|
9
|
+
*/
|
|
10
|
+
export type AppendRetryPolicy = "all" | "noSideEffects";
|
|
11
|
+
/**
|
|
12
|
+
* Auth provider that abstracts token-based and PKI-based authentication.
|
|
13
|
+
*/
|
|
14
|
+
export type AuthProvider = {
|
|
15
|
+
type: "token";
|
|
16
|
+
token: string;
|
|
17
|
+
} | {
|
|
18
|
+
type: "pki";
|
|
19
|
+
context: PkiAuthContext;
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Retry configuration for handling transient failures.
|
|
23
|
+
*/
|
|
24
|
+
export type RetryConfig = {
|
|
25
|
+
/**
|
|
26
|
+
* Total number of attempts, including the initial try.
|
|
27
|
+
* Must be >= 1. A value of 1 means no retries.
|
|
28
|
+
* @default 3
|
|
29
|
+
*/
|
|
30
|
+
maxAttempts?: number;
|
|
31
|
+
/**
|
|
32
|
+
* Minimum delay in milliseconds for exponential backoff.
|
|
33
|
+
* The first retry will have a delay in the range [minBaseDelayMillis, 2*minBaseDelayMillis).
|
|
34
|
+
* @default 100
|
|
35
|
+
*/
|
|
36
|
+
minBaseDelayMillis?: number;
|
|
37
|
+
/**
|
|
38
|
+
* Maximum base delay in milliseconds for exponential backoff.
|
|
39
|
+
* Once the exponential backoff reaches this value, it stays capped here.
|
|
40
|
+
* Note: actual delay with jitter can be up to 2*maxBaseDelayMillis.
|
|
41
|
+
* @default 1000
|
|
42
|
+
*/
|
|
43
|
+
maxBaseDelayMillis?: number;
|
|
44
|
+
/**
|
|
45
|
+
* Policy for retrying append operations.
|
|
46
|
+
* @default "all"
|
|
47
|
+
*/
|
|
48
|
+
appendRetryPolicy?: AppendRetryPolicy;
|
|
49
|
+
/**
|
|
50
|
+
* Maximum time in milliseconds to wait for an append ack before considering
|
|
51
|
+
* the attempt timed out and applying retry logic.
|
|
52
|
+
*
|
|
53
|
+
* Used by retrying append sessions. When unset, defaults to 5000ms.
|
|
54
|
+
*
|
|
55
|
+
* @deprecated Use `requestTimeoutMillis` on {@link S2ClientOptions} instead.
|
|
56
|
+
*/
|
|
57
|
+
requestTimeoutMillis?: number;
|
|
58
|
+
/**
|
|
59
|
+
* Maximum time in milliseconds to wait for connection establishment.
|
|
60
|
+
* This is a "fail fast" timeout that aborts slow connections early.
|
|
61
|
+
* Connection time counts toward requestTimeoutMillis.
|
|
62
|
+
*
|
|
63
|
+
* Only applies to S2S (HTTP/2) transport when establishing new connections.
|
|
64
|
+
* Reused pooled connections are not subject to this timeout.
|
|
65
|
+
*
|
|
66
|
+
* @default 3000
|
|
67
|
+
* @deprecated Use `connectionTimeoutMillis` on {@link S2ClientOptions} instead.
|
|
68
|
+
*/
|
|
69
|
+
connectionTimeoutMillis?: number;
|
|
70
|
+
};
|
|
71
|
+
export type S2EnvironmentConfig = Partial<S2ClientOptions>;
|
|
72
|
+
export declare class S2Environment {
|
|
73
|
+
static parse(): S2EnvironmentConfig;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Configuration for constructing the top-level `S2` client.
|
|
77
|
+
*
|
|
78
|
+
* Provide one of:
|
|
79
|
+
* - `accessToken` for Bearer token auth (legacy)
|
|
80
|
+
* - `rootKey` for PKI bootstrap mode (limited to admin operations)
|
|
81
|
+
* - `authContext` for PKI proper auth (full access)
|
|
82
|
+
*/
|
|
83
|
+
export type S2ClientOptions = {
|
|
84
|
+
/**
|
|
85
|
+
* Access token used for HTTP Bearer authentication.
|
|
86
|
+
* Typically obtained via your S2 account or created using `s2.accessTokens.issue`.
|
|
87
|
+
*
|
|
88
|
+
* Mutually exclusive with `rootKey` and `authContext`.
|
|
89
|
+
*/
|
|
90
|
+
accessToken?: string;
|
|
91
|
+
/**
|
|
92
|
+
* P256 private key as base58-encoded 32 bytes for PKI bootstrap mode.
|
|
93
|
+
* When provided, the SDK generates short-lived Biscuit tokens on-the-fly
|
|
94
|
+
* and signs all requests with RFC 9421 HTTP message signatures.
|
|
95
|
+
*
|
|
96
|
+
* Bootstrap mode is limited to admin operations (list basins, issue tokens).
|
|
97
|
+
* For full access including stream operations, use `authContext` instead.
|
|
98
|
+
*
|
|
99
|
+
* Mutually exclusive with `accessToken` and `authContext`.
|
|
100
|
+
*/
|
|
101
|
+
rootKey?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Pre-created PKI auth context for proper auth mode.
|
|
104
|
+
* Create with `createPkiAuth({ token, signingKey })`.
|
|
105
|
+
*
|
|
106
|
+
* This is the recommended mode for full access to all operations including streams.
|
|
107
|
+
*
|
|
108
|
+
* Mutually exclusive with `accessToken` and `rootKey`.
|
|
109
|
+
*/
|
|
110
|
+
authContext?: PkiAuthContext;
|
|
111
|
+
/**
|
|
112
|
+
* Endpoint configuration for the S2 environment.
|
|
113
|
+
*
|
|
114
|
+
* Defaults to AWS (`aws.s2.dev` and `{basin}.b.aws.s2.dev`) with the API base path inferred as `/v1`.
|
|
115
|
+
*/
|
|
116
|
+
endpoints?: S2Endpoints | S2EndpointsInit;
|
|
117
|
+
/**
|
|
118
|
+
* Maximum time in milliseconds to wait for an append ack before considering
|
|
119
|
+
* the attempt timed out and applying retry logic.
|
|
120
|
+
*
|
|
121
|
+
* Used by retrying append sessions. When unset, defaults to 5000ms.
|
|
122
|
+
*/
|
|
123
|
+
requestTimeoutMillis?: number;
|
|
124
|
+
/**
|
|
125
|
+
* Maximum time in milliseconds to wait for connection establishment.
|
|
126
|
+
* This is a "fail fast" timeout that aborts slow connections early.
|
|
127
|
+
* Connection time counts toward requestTimeoutMillis.
|
|
128
|
+
*
|
|
129
|
+
* Only applies to S2S (HTTP/2) transport when establishing new connections.
|
|
130
|
+
* Reused pooled connections are not subject to this timeout.
|
|
131
|
+
*
|
|
132
|
+
* @default 3000
|
|
133
|
+
*/
|
|
134
|
+
connectionTimeoutMillis?: number;
|
|
135
|
+
/**
|
|
136
|
+
* Retry configuration for handling transient failures.
|
|
137
|
+
* Applies to management operations (basins, streams, tokens) and stream operations (read, append).
|
|
138
|
+
* @default { maxAttempts: 3, minBaseDelayMillis: 100, maxBaseDelayMillis: 1000, appendRetryPolicy: "all" }
|
|
139
|
+
*/
|
|
140
|
+
retry?: RetryConfig;
|
|
141
|
+
};
|
|
142
|
+
/**
|
|
143
|
+
* Per-request options that apply to all SDK operations.
|
|
144
|
+
*/
|
|
145
|
+
export type S2RequestOptions = {
|
|
146
|
+
/**
|
|
147
|
+
* Optional abort signal to cancel the underlying HTTP request.
|
|
148
|
+
*/
|
|
149
|
+
signal?: AbortSignal;
|
|
150
|
+
};
|
|
151
|
+
/**
|
|
152
|
+
* Creates a client configured with the given auth provider.
|
|
153
|
+
* Adds request interceptor for PKI signing when using PKI auth.
|
|
154
|
+
*/
|
|
155
|
+
export declare function createAuthenticatedClient(baseUrl: string, authProvider: AuthProvider, headers: Record<string, string>): Client;
|
|
156
|
+
//# sourceMappingURL=common.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,eAAe,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,YAAY,GACrB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,cAAc,CAAA;CAAE,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAEtC;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AAE3D,qBAAa,aAAa;WACX,KAAK,IAAI,mBAAmB;CAyB1C;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,WAAW,GAAG,eAAe,CAAC;IAC1C;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;;;OASG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,yBAAyB,CACxC,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,YAAY,EAC1B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC7B,MAAM,CAsBR"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { S2Endpoints } from "./endpoints.js";
|
|
2
|
+
import { createClient, createConfig } from "./generated/client/index.js";
|
|
3
|
+
export class S2Environment {
|
|
4
|
+
static parse() {
|
|
5
|
+
const config = {};
|
|
6
|
+
const token = process.env.S2_ACCESS_TOKEN;
|
|
7
|
+
if (token) {
|
|
8
|
+
config.accessToken = token;
|
|
9
|
+
}
|
|
10
|
+
const rootKey = process.env.S2_ROOT_KEY;
|
|
11
|
+
if (rootKey) {
|
|
12
|
+
config.rootKey = rootKey;
|
|
13
|
+
}
|
|
14
|
+
const accountEndpoint = process.env.S2_ACCOUNT_ENDPOINT;
|
|
15
|
+
const basinEndpoint = process.env.S2_BASIN_ENDPOINT;
|
|
16
|
+
if (accountEndpoint || basinEndpoint) {
|
|
17
|
+
const endpointsInit = {
|
|
18
|
+
account: accountEndpoint || undefined,
|
|
19
|
+
basin: basinEndpoint || undefined,
|
|
20
|
+
};
|
|
21
|
+
config.endpoints = new S2Endpoints(endpointsInit);
|
|
22
|
+
}
|
|
23
|
+
return config;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Creates a client configured with the given auth provider.
|
|
28
|
+
* Adds request interceptor for PKI signing when using PKI auth.
|
|
29
|
+
*/
|
|
30
|
+
export function createAuthenticatedClient(baseUrl, authProvider, headers) {
|
|
31
|
+
const client = createClient(createConfig({
|
|
32
|
+
baseUrl,
|
|
33
|
+
auth: async () => {
|
|
34
|
+
if (authProvider.type === "pki") {
|
|
35
|
+
return authProvider.context.getToken();
|
|
36
|
+
}
|
|
37
|
+
return authProvider.token;
|
|
38
|
+
},
|
|
39
|
+
headers,
|
|
40
|
+
}));
|
|
41
|
+
if (authProvider.type === "pki") {
|
|
42
|
+
const pkiContext = authProvider.context;
|
|
43
|
+
client.interceptors.request.use(async (request) => {
|
|
44
|
+
return pkiContext.signRequest(request);
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
return client;
|
|
48
|
+
}
|
|
49
|
+
//# sourceMappingURL=common.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/common.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAwB,MAAM,gBAAgB,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AA4EzE,MAAM,OAAO,aAAa;IAClB,MAAM,CAAC,KAAK;QAClB,MAAM,MAAM,GAAwB,EAAE,CAAC;QAEvC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC;QAC1C,IAAI,KAAK,EAAE,CAAC;YACX,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC;QAC5B,CAAC;QAED,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;QACxC,IAAI,OAAO,EAAE,CAAC;YACb,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;QAC1B,CAAC;QAED,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACxD,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QACpD,IAAI,eAAe,IAAI,aAAa,EAAE,CAAC;YACtC,MAAM,aAAa,GAAoB;gBACtC,OAAO,EAAE,eAAe,IAAI,SAAS;gBACrC,KAAK,EAAE,aAAa,IAAI,SAAS;aACjC,CAAC;YACF,MAAM,CAAC,SAAS,GAAG,IAAI,WAAW,CAAC,aAAa,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AAgFD;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CACxC,OAAe,EACf,YAA0B,EAC1B,OAA+B;IAE/B,MAAM,MAAM,GAAG,YAAY,CAC1B,YAAY,CAAC;QACZ,OAAO;QACP,IAAI,EAAE,KAAK,IAAI,EAAE;YAChB,IAAI,YAAY,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACjC,OAAO,YAAY,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YACxC,CAAC;YACD,OAAO,YAAY,CAAC,KAAK,CAAC;QAC3B,CAAC;QACD,OAAO;KACP,CAAC,CACF,CAAC;IAEF,IAAI,YAAY,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC;QACxC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjD,OAAO,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AACf,CAAC"}
|