@s2-dev/streamstore 0.10.0 → 0.11.0

package/src/index.extras.ts

@@ -1,521 +0,0 @@
-import { accountDeleteBasin } from "./funcs/accountDeleteBasin.js";
-import {
-    AppendOutput,
-    BasinConfig,
-    BasinInfo,
-    CheckTailResponse,
-    CreateBasinRequest,
-    CreateStreamRequest,
-    Message,
-    Output,
-    ReadResponse,
-    SequencedRecord,
-    SequencedRecordBatch,
-    StreamConfig,
-    StreamInfo,
-} from "./models/components/index.js";
-import { NotFoundError, RetryableError } from "./models/errors/index.js";
-import {
-    GetBasinConfigRequest,
-    ListBasinsRequest,
-    ListBasinsResponse,
-    ListStreamsRequest,
-    ListStreamsResponse,
-    ReconfigureBasinRequest,
-    CreateBasinRequest as CreateBasinRequestInner,
-    CreateStreamRequest as CreateStreamRequestInner,
-    ReadRequest as ReadRequestInner,
-    AppendRequest as AppendRequestInner,
-} from "./models/operations/index.js";
-import { PageIterator } from "./types/index.js";
-
-import { Stream as InnerStream, ReadAcceptEnum } from "./sdk/stream.js";
-import { Basin as InnerBasin } from "./sdk/basin.js";
-import { Account as InnerAccount } from "./sdk/account.js";
-
-import { v4 as uuidv4 } from "uuid";
-import { basinDeleteStream } from "./funcs/basinDeleteStream.js";
-import { EventStream } from "./lib/event-streams.js";
-import { ClientKind, S2Cloud, S2Endpoints } from "./endpoints.js";
-import { HTTPClient } from "./lib/http.js";
-
-export type ReadRequest = Omit<ReadRequestInner, "stream">;
-export type AppendRequest = Omit<AppendRequestInner, "stream">;
-export type {
-    GetBasinConfigRequest,
-    ListBasinsRequest,
-    ListBasinsResponse,
-    ListStreamsRequest,
-    ListStreamsResponse,
-    ReconfigureBasinRequest,
-} from "./models/operations/index.js";
-export type {
-    BasinConfig,
-    BasinInfo,
-    CheckTailResponse,
-    CreateBasinRequest,
-    CreateStreamRequest,
-    Output,
-    ReadResponse,
-    StreamConfig,
-    StreamInfo,
-} from "./models/components/index.js";
-
-export * from "./endpoints.js";
-
-export type S2ClientConfig = {
-    authToken?: string;
-    userAgent?: string;
-    requestTimeout?: number;
-    endpoints?: S2Endpoints;
-    appedRetryPolicy?: AppendRetryPolicy;
-    maxRetries?: number;
-    initialBackoffMs?: number;
-    maxBackoffMs?: number;
-    httpClient?: HTTPClient;
-};
-
-/**
- * Override the client level configuration for a specific operation.
- *
- * @remarks
- * Only `authToken` can be overridden for now.
- */
-export type S2OperationConfig = {
-    authToken?: string;
-};
-
-/**
- * Retry policy for appends.
- */
-export enum AppendRetryPolicy {
-    /**
-     * Retry all eligible failures encountered during an append.
-     * This could result in append batches being duplicated on the stream.
-     */
-    All,
-    /**
-     * Retry only failures with no side effects.
-     * Will not attempt to retry failures where it cannot be concluded whether an append may become durable, in order to prevent duplicates.
-     */
-    NoSideEffects,
-}
-
-const defaultS2ClientConfig: S2ClientConfig = {
-    requestTimeout: 3000,
-    endpoints: S2Endpoints.forCloud(S2Cloud.Aws),
-    appedRetryPolicy: AppendRetryPolicy.All,
-    httpClient: new HTTPClient({
-        fetcher: async (request) => fetch(request),
-    }),
-};
-
-
-export class S2Client {
-    private config: S2ClientConfig;
-    private _account?: S2Account;
-
-    get account(): S2Account {
-        return (this._account ??= new S2Account(this.config));
-    }
-
-    private _basin?: S2Basin;
-    basin(basinName: string): S2Basin {
-        return (this._basin ??= new S2Basin(basinName, this.config));
-    }
-
-    constructor(config?: S2ClientConfig) {
-        this.config = { ...defaultS2ClientConfig, ...config };
-    }
-}
-
-class S2Account {
-    private _account: InnerAccount;
-    private config: S2ClientConfig;
-    private readonly accountURLSuffx = "/v1alpha";
-
-    constructor(config: S2ClientConfig) {
-        config.httpClient?.addHook("beforeRequest", (request) => {
-            if (config.userAgent !== undefined) {
-                request.headers.set("user-agent", config.userAgent ?? "s2-sdk-typescript");
-            }
-        });
-        this._account = new InnerAccount({
-            ...(config.authToken !== undefined && { bearerAuth: config.authToken }),
-            ...(config.requestTimeout !== undefined && { timeoutMs: config.requestTimeout }),
-            ...(config.httpClient !== undefined && { httpClient: config.httpClient }),
-        });
-        this.config = config;
-    }
-
-    get URL(): string {
-        return `https://${ClientKind.toAuthority({ kind: "Account" }, this.config.endpoints ?? S2Endpoints.forCloud(S2Cloud.Aws))}${this.accountURLSuffx}`;
-    }
-
-    basin(basinName: string): S2Basin {
-        return new S2Basin(basinName, this.config);
-    }
-
-    private overrideConfig(config?: S2OperationConfig) {
-        this.config.httpClient?.addHook("beforeRequest", (request) => {
-            if (config?.authToken !== undefined) {
-                request.headers.set("Authorization", `Bearer ${config.authToken}`);
-            }
-        });
-    }
-
-    async listBasins(
-        request?: ListBasinsRequest,
-        opConfig?: S2OperationConfig,
-    ): Promise<PageIterator<ListBasinsResponse, { cursor: string }>> {
-        this.overrideConfig(opConfig);
-        return retryWithExponentialBackoff(
-            () => this._account.listBasins(request ?? {}, {
-                serverURL: this.URL,
-            }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-
-    async getBasinConfig(basin: string, opConfig?: S2OperationConfig): Promise<BasinConfig> {
-        this.overrideConfig(opConfig);
-        const _request: GetBasinConfigRequest = { basin };
-        return retryWithExponentialBackoff(
-            () => this._account.getBasinConfig(_request, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-
-    async createBasin(basin: string, request?: CreateBasinRequest, opConfig?: S2OperationConfig): Promise<BasinInfo> {
-        this.overrideConfig(opConfig);
-        const _request: CreateBasinRequestInner = {
-            basin,
-            s2RequestToken: genS2RequestToken(),
-            createBasinRequest: request ?? {},
-        };
-        return retryWithExponentialBackoff(
-            () => this._account.createBasin(_request, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-
-    async deleteBasin(basin: string, if_exists?: boolean, opConfig?: S2OperationConfig): Promise<void> {
-        this.overrideConfig(opConfig);
-        const response = await retryWithExponentialBackoff(
-            () => accountDeleteBasin(this._account, { basin }, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-        if (if_exists && response.error instanceof NotFoundError) return;
-        if (response.error) throw new Error(response.error.message);
-        return;
-    }
-
-    async reconfigureBasin(basin: string, config: BasinConfig, opConfig?: S2OperationConfig): Promise<BasinConfig> {
-        this.overrideConfig(opConfig);
-        const _request: ReconfigureBasinRequest = { basin, basinConfig: config };
-        return retryWithExponentialBackoff(
-            () => this._account.reconfigureBasin(_request, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-}
-
-class S2Basin {
-    private _basin: InnerBasin;
-    private _stream!: Stream;
-    private basinName: string;
-    private config: S2ClientConfig;
-    private clientKind: ClientKind;
-    private readonly basinURLSuffx = "/v1alpha";
-
-    private get URL(): string {
-        return `https://${ClientKind.toAuthority(this.clientKind, this.config.endpoints ?? S2Endpoints.forCloud(S2Cloud.Aws))}${this.basinURLSuffx}`;
-    }
-
-    constructor(basinName: string, config: S2ClientConfig) {
-        config.httpClient?.addHook("beforeRequest", (request) => {
-            if (config.userAgent !== undefined) {
-                request.headers.set("user-agent", config.userAgent ?? "s2-sdk-typescript");
-            }
-            if (config.endpoints?.basin?.kind === "Direct") {
-                request.headers.set("s2-basin", basinName);
-            }
-        });
-        this._basin = new InnerBasin({
-            ...(config.authToken !== undefined && { bearerAuth: config.authToken }),
-            ...(config.requestTimeout !== undefined && { timeoutMs: config.requestTimeout }),
-            ...(config.httpClient !== undefined && { httpClient: config.httpClient }),
-        });
-        this.config = config;
-        this.clientKind = { kind: "Basin" as const, basin: basinName };
-        this.basinName = basinName;
-    }
-
-    stream(streamName: string): Stream {
-        return (this._stream ??= new Stream(this.basinName, streamName, this.config));
-    }
-
-    private overrideConfig(config?: S2OperationConfig) {
-        this.config.httpClient?.addHook("beforeRequest", (request) => {
-            if (config?.authToken !== undefined) {
-                request.headers.set("Authorization", `Bearer ${config.authToken}`);
-            }
-        });
-    }
-
-    async listStreams(
-        request?: ListStreamsRequest,
-        opConfig?: S2OperationConfig,
-    ): Promise<PageIterator<ListStreamsResponse, { cursor: string }>> {
-        this.overrideConfig(opConfig);
-        return retryWithExponentialBackoff(
-            () => this._basin.listStreams(request ?? {}, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-
-    async getStreamConfig(
-        stream: string,
-        opConfig?: S2OperationConfig
-    ): Promise<StreamConfig> {
-        this.overrideConfig(opConfig);
-        return retryWithExponentialBackoff(
-            () => this._basin.getStreamConfig({ stream }, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-
-    async createStream(stream: string, request?: CreateStreamRequest, opConfig?: S2OperationConfig): Promise<StreamInfo> {
-        this.overrideConfig(opConfig);
-        const _request: CreateStreamRequestInner = {
-            stream,
-            s2RequestToken: genS2RequestToken(),
-            createStreamRequest: request ?? {},
-        };
-        return retryWithExponentialBackoff(
-            () => this._basin.createStream(_request, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-
-    async deleteStream(stream: string, if_exists?: boolean, opConfig?: S2OperationConfig): Promise<void> {
-        this.overrideConfig(opConfig);
-        const response = await retryWithExponentialBackoff(
-            () => basinDeleteStream(this._basin, { stream }, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-        if (if_exists && response instanceof NotFoundError) return;
-        if (response.error) throw new Error(response.error.message);
-        return;
-    }
-
-    async reconfigureStream(stream: string, config: StreamConfig, opConfig?: S2OperationConfig): Promise<StreamConfig> {
-        this.overrideConfig(opConfig);
-        return retryWithExponentialBackoff(
-            () => this._basin.reconfigureStream({ stream, streamConfig: config }, { serverURL: this.URL }),
-            this.config.maxRetries,
-            this.config.initialBackoffMs,
-            this.config.maxBackoffMs
-        );
-    }
-}
-
-class Stream {
-    private _stream: InnerStream;
-    private streamName: string;
-    private config: S2ClientConfig;
-    private clientKind: ClientKind;
-    private readonly basinURLSuffx = "/v1alpha";
-
-    private get basinURL(): string {
-        return `https://${ClientKind.toAuthority(this.clientKind, this.config.endpoints ?? S2Endpoints.forCloud(S2Cloud.Aws))}${this.basinURLSuffx}`;
-    }
-
-    private overrideConfig(config?: S2OperationConfig) {
-        this.config.httpClient?.addHook("beforeRequest", (request) => {
-            if (config?.authToken !== undefined) {
-                request.headers.set("Authorization", `Bearer ${config.authToken}`);
-            }
-        });
-    }
-
-    constructor(basinName: string, streamName: string, config: S2ClientConfig) {
-        this.config = config;
-        this.clientKind = { kind: "Basin" as const, basin: basinName };
-        this.streamName = streamName;
-        config.httpClient?.addHook("beforeRequest", (request) => {
-            if (config.userAgent !== undefined) {
-                request.headers.set("user-agent", config.userAgent ?? "s2-sdk-typescript");
-            }
-            if (config.endpoints?.basin?.kind === "Direct") {
-                request.headers.set("s2-basin", basinName);
-            }
-        });
-        this._stream = new InnerStream({
-            ...(config.authToken !== undefined && { bearerAuth: config.authToken }),
-            ...(config.requestTimeout !== undefined && { timeoutMs: config.requestTimeout }),
-            ...(config.httpClient !== undefined && { httpClient: config.httpClient })
-        });
-    }
-
-    async checkTail(opConfig?: S2OperationConfig): Promise<CheckTailResponse> {
-        this.overrideConfig(opConfig);
-        return (
-            await this._stream.checkTail({ stream: this.streamName }, { serverURL: this.basinURL })
-        );
-    }
-
-    async append(request: AppendRequest, opConfig?: S2OperationConfig): Promise<AppendOutput> {
-        this.overrideConfig(opConfig);
-        switch (this.config.appedRetryPolicy) {
-            case AppendRetryPolicy.All:
-            case undefined:
-                return retryWithExponentialBackoff(
-                    () => this._stream.append({ ...request, stream: this.streamName }, { serverURL: this.basinURL }),
-                    this.config.maxRetries,
-                    this.config.initialBackoffMs,
-                    this.config.maxBackoffMs
-                );
-            case AppendRetryPolicy.NoSideEffects:
-                return (
-                    await this._stream.append({ ...request, stream: this.streamName }, {
-                        serverURL: this.basinURL,
-                    })
-                );
-            default:
-                throw new Error("Invalid AppendRetryPolicy");
-        }
-    }
-
-    async read(request: ReadRequest, opConfig?: S2OperationConfig): Promise<Output> {
-        this.overrideConfig(opConfig);
-        return (
-            await this._stream.read({ ...request, stream: this.streamName }, { serverURL: this.basinURL }) as Output
-        );
-    }
-
-    async *readStream(request: ReadRequest, opConfig?: S2OperationConfig): AsyncGenerator<ReadResponse, void, undefined> {
-        this.overrideConfig(opConfig);
-        let currentRequest: ReadRequest = { ...request };
-        let initialBackoffMs = this.config.initialBackoffMs ?? 100;
-        const maxBackoffMs = 5000;
-        const maxRetries = this.config.maxRetries ?? 5;
-        let retryCount = 0;
-
-        while (true) {
-            let stream: EventStream<ReadResponse> | undefined;
-            try {
-                const response = await this._stream.read(
-                    { ...currentRequest, stream: this.streamName },
-                    {
-                        serverURL: this.basinURL,
-                        timeoutMs: -1, // disable only for streaming
-                        acceptHeaderOverride: ReadAcceptEnum.textEventStream
-                    }
-                );
-                stream = response as EventStream<ReadResponse>;
-                if (!stream) return;
-
-                for await (const event of stream) {
-                    yield event;
-
-                    if (event.event === 'message') {
-                        const output = event as Message;
-                        if ('batch' in output.data) {
-                            const batch = output.data.batch;
-                            if (batch.records && batch.records.length > 0) {
-                                const lastRecord = batch.records[batch.records.length - 1];
-                                if (lastRecord) {
-                                    currentRequest = { ...currentRequest, startSeqNum: lastRecord.seqNum + 1 };
-                                }
-                            }
-                            if (currentRequest.limit) {
-                                if (currentRequest.limit.count != null) {
-                                    currentRequest.limit.count = Math.max(0, currentRequest.limit.count - batch.records.length);
-                                }
-                                if (currentRequest.limit.bytes != null) {
-                                    currentRequest.limit.bytes = Math.max(0, currentRequest.limit.bytes - meteredBatchSize(batch));
-                                }
-                            }
-                        }
-                    }
-                }
-                return;
-            } catch (error) {
-                if (error instanceof RetryableError) {
-                    if (retryCount >= maxRetries) {
-                        throw error;
-                    }
-                    retryCount++;
-                    await new Promise(resolve => setTimeout(resolve, initialBackoffMs));
-                    initialBackoffMs = Math.min(initialBackoffMs * 2, maxBackoffMs);
-                } else {
-                    throw error;
-                }
-            }
-        }
-    }
-}
-
-function meteredRecordSize(batch: SequencedRecord): number {
-    const fixed = 8 + (2 * batch.headers.length);
-    const headerSize = batch.headers.reduce((acc, header) => acc + header.name.length + header.value.length, 0);
-    const bodySize = batch.body.length;
-
-    return fixed + headerSize + bodySize;
-}
-
-function meteredBatchSize(batch: SequencedRecordBatch): number {
-    return batch.records.reduce((acc, record) => acc + meteredRecordSize(record), 0);
-}
-
-export function genS2RequestToken(): string {
-    return uuidv4().replace(/-/g, "");
-}
-
-async function retryWithExponentialBackoff<T>(
-    operation: () => Promise<T>,
-    maxAttempts: number = 5,
-    initialBackoffMs: number = 100,
-    maxBackoffMs: number = 5000
-): Promise<T> {
-    let attempt = 0;
-
-    while (attempt < maxAttempts) {
-        try {
-            return await operation();
-        } catch (error) {
-            if (error instanceof RetryableError) {
-                attempt++;
-                if (attempt >= maxAttempts) throw error;
-
-                const jitter = Math.random() * 0.3 + 0.85;
-                const delayMs = Math.min(initialBackoffMs * Math.pow(2, attempt) * jitter, maxBackoffMs);
-
-                await new Promise(resolve => setTimeout(resolve, delayMs));
-            } else {
-                throw error;
-            }
-        }
-    }
-
-    throw new Error("Max retry attempts reached");
-}