@restless-stream/core 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,361 @@
+type StreamSnippetLanguage = 'javascript' | 'python' | 'java' | 'ruby' | 'php' | 'csharp' | 'go' | 'rust';
+type StreamApiKeyLocation = 'header' | 'urlParam';
+interface StreamSnippetOptions {
+    language?: StreamSnippetLanguage;
+    includeAllLanguages?: boolean;
+    apiKeyLocation?: StreamApiKeyLocation;
+}
+interface StreamConnectionSnippetsInput extends StreamSnippetOptions {
+    streamId?: string;
+    websocketUrl?: string;
+    sseUrl?: string;
+}
+interface StreamSnippetLanguageOption {
+    label: string;
+    value: string;
+}
+interface StreamSnippetSet {
+    curl: string;
+    wget: string;
+    sse: string;
+    websocket: string;
+}
+interface StreamSnippetPayload {
+    availableLanguages: StreamSnippetLanguageOption[];
+    selectedLanguage: string;
+    selectedSnippets: StreamSnippetSet;
+    snippetsByLanguage?: Record<string, StreamSnippetSet>;
+}
+interface StreamRuntimeUrls {
+    sseUrl: string;
+    websocketUrl: string;
+}
+interface ConnectionSnippetsResponse {
+    runtime: StreamRuntimeUrls;
+    snippets: StreamSnippetPayload;
+}
+
+interface DirectSetupInput extends StreamSnippetOptions {
+    method: HTTPMethod;
+    url: string;
+    headers?: JsonObject;
+    body?: JsonObject;
+    payloadMode?: StreamPayloadMode;
+    jqFilter?: string;
+    pollingInterval?: number;
+    pollingStrategies?: PollingStrategy[];
+}
+interface DirectCommandSet {
+    curl: string;
+    wget: string;
+}
+interface DirectSetupResponse {
+    commands: {
+        header: DirectCommandSet;
+        urlParam: DirectCommandSet;
+    };
+    runtime: {
+        auth: {
+            apiKeyLocation: StreamApiKeyLocation;
+            headerExample: string;
+        };
+        directSseUrl: string;
+        directWebsocketUrl: string;
+    };
+    snippets: StreamSnippetPayload;
+    streamConfig: {
+        targetUrl: string;
+        method: HTTPMethod;
+        headers?: JsonObject | null;
+        body?: JsonObject | null;
+        jqFilter?: string | null;
+        payloadMode?: StreamPayloadMode | null;
+        pollingInterval?: number | null;
+        pollingStrategies?: PollingStrategy[] | null;
+    };
+}
+interface DirectSessionInput {
+    dedupeKey: string;
+    method: HTTPMethod;
+    url: string;
+    headers?: JsonObject;
+    body?: JsonObject;
+    payloadMode?: StreamPayloadMode;
+    jqFilter?: string;
+    pollingInterval?: number;
+    pollingStrategies?: PollingStrategy[];
+}
+interface DirectSessionResponse {
+    sessionId: string;
+    wsUrl: string;
+    sseUrl: string;
+    expiresAt: string;
+    created: boolean;
+    dedupeKey: string;
+}
+interface DirectRuntimeUrlInput {
+    url: string;
+    method?: HTTPMethod;
+    headers?: JsonObject;
+    body?: JsonObject;
+    jqFilter?: string;
+    pollingInterval?: number;
+    pollingStrategies?: PollingStrategy[];
+    payloadMode?: StreamPayloadMode;
+    apiKey?: string;
+}
+
+type StreamStatus = 'ACTIVE' | 'INACTIVE';
+type StreamPayloadMode = 'FULL_DATA' | 'JSON_PATCH';
+interface PollingStrategy {
+    startTime: string;
+    endTime: string;
+    intervalSeconds: number;
+}
+interface PaginationInfo {
+    hasNextPage: boolean;
+}
+interface Stream {
+    id: string;
+    businessId: string;
+    name: string;
+    description?: string | null;
+    status: StreamStatus;
+    method: HTTPMethod;
+    url: string;
+    headers?: JsonObject | null;
+    body?: JsonObject | null;
+    payloadMode: StreamPayloadMode;
+    jqFilter?: string | null;
+    hmacSignatureEnabled: boolean;
+    pollingInterval: number;
+    pollingStrategies?: PollingStrategy[] | null;
+    createdAt: string;
+    updatedAt: string;
+    wsUrl: string;
+    sseUrl: string;
+}
+interface StreamsResponse {
+    streams: Stream[];
+    paginationInfo: PaginationInfo;
+}
+interface BaseActionResponse {
+    id: string;
+    affected: boolean;
+}
+interface StreamCreditUsageChargeTypeBreakdown {
+    chargeType: string;
+    creditsUsed: number;
+}
+interface DailyStreamCreditUsage {
+    date: string;
+    creditsUsed: number;
+    chargeTypeBreakdown: StreamCreditUsageChargeTypeBreakdown[];
+}
+interface StreamCreditUsageStats {
+    totalBurnedLastWeek: number;
+    totalBurnedLastMonth: number;
+    dailyUsage: DailyStreamCreditUsage[];
+}
+interface StreamWriteInput {
+    name: string;
+    description: string;
+    status: StreamStatus;
+    method: HTTPMethod;
+    url: string;
+    apiKey?: string;
+    headers?: JsonObject | null;
+    body?: JsonObject | null;
+    payloadMode: StreamPayloadMode;
+    jqFilter?: string | null;
+    hmacSignatureEnabled?: boolean | null;
+    pollingInterval: number;
+    pollingStrategies?: PollingStrategy[] | null;
+}
+interface StreamUpdateInput {
+    apiKey?: string;
+    name?: string;
+    description?: string | null;
+    status?: StreamStatus;
+    method?: HTTPMethod;
+    url?: string;
+    headers?: JsonObject | null;
+    body?: JsonObject | null;
+    payloadMode?: StreamPayloadMode;
+    jqFilter?: string | null;
+    hmacSignatureEnabled?: boolean | null;
+    pollingInterval?: number;
+    pollingStrategies?: PollingStrategy[] | null;
+}
+interface ListStreamsInput {
+    limit?: number;
+    offset?: number;
+}
+
+type RuntimeIdentifier = {
+    streamId: string;
+    sessionId?: never;
+} | {
+    sessionId: string;
+    streamId?: never;
+};
+interface RuntimeUrlOptions {
+    cursor?: number | string;
+    since?: number | string;
+}
+interface StreamEventMeta {
+    timestamp: string;
+    attempt_id: string;
+    status?: number;
+    latency_ms: number;
+    payload_mode_fallback?: StreamPayloadMode;
+}
+interface StreamUpdateEvent<TData = unknown> {
+    type: 'update';
+    meta: StreamEventMeta;
+    data: TData;
+    signature?: string;
+}
+interface StreamErrorEvent {
+    type: 'error';
+    meta?: Partial<StreamEventMeta>;
+    error: {
+        code: string;
+        message: string;
+    };
+}
+type StreamEvent<TData = unknown> = StreamUpdateEvent<TData> | StreamErrorEvent;
+interface SseMessage<TData = unknown> {
+    id?: string;
+    event?: string;
+    retry?: number;
+    data: string;
+    parsed?: TData;
+}
+interface SseIterableOptions {
+    url: string;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+    reconnect?: boolean;
+    reconnectDelayMs?: number;
+    maxReconnectDelayMs?: number;
+    cursor?: number | string;
+    since?: number | string;
+    fetch?: typeof fetch;
+}
+interface SubscribeSseOptions extends Omit<SseIterableOptions, 'fetch' | 'headers' | 'url'> {
+    sseUrl: string;
+    headers?: Record<string, string>;
+    allowApiKeyInUrl?: boolean;
+}
+interface DirectSubscribeSseOptions extends Omit<SubscribeSseOptions, 'sseUrl'>, RuntimeUrlOptions {
+}
+interface DirectSubscribeWebSocketOptions extends Omit<WebSocketIterableOptions, 'url'>, RuntimeUrlOptions {
+}
+interface WebSocketIterableOptions {
+    url: string;
+    protocols?: string | string[];
+    signal?: AbortSignal;
+    WebSocket?: WebSocketConstructor;
+}
+type WebSocketConstructor = new (url: string | URL, protocols?: string | string[]) => WebSocketLike;
+interface WebSocketLike {
+    readonly readyState: number;
+    onopen: ((event: Event) => void) | null;
+    onmessage: ((event: MessageEvent) => void) | null;
+    onerror: ((event: Event) => void) | null;
+    onclose: ((event: CloseEvent) => void) | null;
+    close(code?: number, reason?: string): void;
+}
+type DirectRuntimeOptionsInput = DirectRuntimeUrlInput;
+
+type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type JsonObject = Record<string, unknown>;
+
+interface RestlessClientOptions {
+    apiBaseUrl?: string;
+    streamBaseUrl?: string;
+    apiKey?: string;
+    fetch?: typeof fetch;
+    headers?: Record<string, string>;
+}
+type RestlessClientConfig = RestlessClientOptions;
+type RestlessStreamEvent<TData = unknown> = StreamEvent<TData>;
+
+interface RestlessClient {
+    readonly apiBaseUrl: string;
+    readonly streamBaseUrl: string;
+    readonly apiKey: string | undefined;
+    streams: RestlessStreamsClient;
+    direct: RestlessDirectClient;
+    urls: RestlessUrlBuilder;
+    listStreams(input?: ListStreamsInput): Promise<StreamsResponse>;
+    getStream(id: string): Promise<Stream>;
+    createStream(input: StreamWriteInput): Promise<Stream>;
+    updateStream(id: string, input: StreamUpdateInput): Promise<Stream>;
+    startStream(id: string): Promise<Stream>;
+    stopStream(id: string): Promise<Stream>;
+    deleteStream(id: string): Promise<BaseActionResponse>;
+    validateApiKey(apiKey?: string): Promise<BaseActionResponse>;
+    creditUsageStats(id: string): Promise<StreamCreditUsageStats>;
+    connectionSnippets(input: StreamConnectionSnippetsInput): Promise<ConnectionSnippetsResponse>;
+    runtimeHeaders(apiKey?: string): Record<string, string>;
+    sse<TData = StreamEvent>(url: string, options?: Omit<SseIterableOptions, 'url' | 'headers' | 'fetch'>): AsyncIterable<SseMessage<TData>>;
+    subscribeSse<TData = unknown>(options: SubscribeSseOptions): AsyncIterable<StreamEvent<TData>>;
+    websocket<TData = StreamEvent>(url: string, options?: Omit<WebSocketIterableOptions, 'url'>): AsyncIterable<TData | string>;
+    subscribeWebSocket<TData = StreamEvent>(url: string, options?: Omit<WebSocketIterableOptions, 'url'>): AsyncIterable<TData | string>;
+}
+interface RestlessStreamsClient {
+    list(input?: ListStreamsInput): Promise<StreamsResponse>;
+    get(id: string): Promise<Stream>;
+    create(input: StreamWriteInput): Promise<Stream>;
+    update(id: string, input: StreamUpdateInput): Promise<Stream>;
+    start(id: string): Promise<Stream>;
+    stop(id: string): Promise<Stream>;
+    delete(id: string): Promise<BaseActionResponse>;
+    validateApiKey(apiKey?: string): Promise<BaseActionResponse>;
+    creditUsageStats(id: string): Promise<StreamCreditUsageStats>;
+    connectionSnippets(input: StreamConnectionSnippetsInput): Promise<ConnectionSnippetsResponse>;
+    subscribeSse<TData = unknown>(options: SubscribeSseOptions): AsyncIterable<StreamEvent<TData>>;
+    subscribeWebSocket<TData = StreamEvent>(url: string, options?: Omit<WebSocketIterableOptions, 'url'>): AsyncIterable<TData | string>;
+}
+interface RestlessDirectClient {
+    setup(input: DirectSetupInput): Promise<DirectSetupResponse>;
+    createSession(input: DirectSessionInput): Promise<DirectSessionResponse>;
+    subscribeSse<TData = unknown>(input: DirectRuntimeUrlInput, options?: DirectSubscribeSseOptions): AsyncIterable<StreamEvent<TData>>;
+    subscribeWebSocket<TData = StreamEvent>(input: DirectRuntimeUrlInput, options?: DirectSubscribeWebSocketOptions): AsyncIterable<TData | string>;
+}
+interface RestlessUrlBuilder {
+    sse(identifier: RuntimeIdentifier, options?: RuntimeUrlOptions): string;
+    websocket(identifier: RuntimeIdentifier, options?: RuntimeUrlOptions): string;
+    directSse(input: DirectRuntimeUrlInput, options?: RuntimeUrlOptions): string;
+    directWebSocket(input: DirectRuntimeUrlInput, options?: RuntimeUrlOptions): string;
+}
+
+declare const DEFAULT_API_BASE_URL = "https://api.restlessapi.stream";
+declare const DEFAULT_STREAM_BASE_URL = "https://stream.restlessapi.stream";
+declare const createRestlessClient: (options?: RestlessClientOptions) => RestlessClient;
+
+declare class RestlessApiError extends Error {
+    readonly status: number;
+    readonly statusText: string;
+    readonly body: unknown;
+    readonly headers: Headers;
+    constructor(response: Response, body: unknown, message?: string);
+}
+
+declare function streamSse<TData = unknown>(options: SseIterableOptions): AsyncIterable<SseMessage<TData>>;
+declare function parseSseStream<TData = unknown>(body: ReadableStream<Uint8Array>): AsyncIterable<SseMessage<TData>>;
+
+declare function streamWebSocket<TData = unknown>(options: WebSocketIterableOptions): AsyncIterable<TData | string>;
+
+declare const normalizeBaseUrl: (baseUrl: string) => string;
+declare const toWebSocketStreamUrl: (sseUrl: string) => string;
+declare const buildSseUrl: (baseUrl: string | undefined, identifier: RuntimeIdentifier, options?: RuntimeUrlOptions) => string;
+declare const buildWebSocketUrl: (baseUrl: string | undefined, identifier: RuntimeIdentifier, options?: RuntimeUrlOptions) => string;
+declare const buildDirectSseUrl: (baseUrl: string | undefined, input: DirectRuntimeUrlInput, options?: RuntimeUrlOptions) => string;
+declare const buildDirectWebSocketUrl: (baseUrl: string | undefined, input: DirectRuntimeUrlInput, options?: RuntimeUrlOptions) => string;
+declare const appendDirectQueryParams: (params: URLSearchParams, input: DirectRuntimeUrlInput) => void;
+declare const withRuntimeCursor: (url: string, options: RuntimeUrlOptions) => string;
+
+export { type BaseActionResponse, type ConnectionSnippetsResponse, DEFAULT_API_BASE_URL, DEFAULT_STREAM_BASE_URL, type DailyStreamCreditUsage, type DirectCommandSet, type DirectRuntimeOptionsInput, type DirectRuntimeUrlInput, type DirectSessionInput, type DirectSessionResponse, type DirectSetupInput, type DirectSetupResponse, type DirectSubscribeSseOptions, type DirectSubscribeWebSocketOptions, type HTTPMethod, type JsonObject, type ListStreamsInput, type PaginationInfo, type PollingStrategy, RestlessApiError, type RestlessClient, type RestlessClientConfig, type RestlessClientOptions, type RestlessDirectClient, type RestlessStreamEvent, type RestlessStreamsClient, type RestlessUrlBuilder, type RuntimeIdentifier, type RuntimeUrlOptions, type SseIterableOptions, type SseMessage, type Stream, type StreamApiKeyLocation, type StreamConnectionSnippetsInput, type StreamCreditUsageChargeTypeBreakdown, type StreamCreditUsageStats, type StreamErrorEvent, type StreamEvent, type StreamEventMeta, type StreamPayloadMode, type StreamRuntimeUrls, type StreamSnippetLanguage, type StreamSnippetLanguageOption, type StreamSnippetOptions, type StreamSnippetPayload, type StreamSnippetSet, type StreamStatus, type StreamUpdateEvent, type StreamUpdateInput, type StreamWriteInput, type StreamsResponse, type SubscribeSseOptions, type WebSocketConstructor, type WebSocketIterableOptions, type WebSocketLike, appendDirectQueryParams, buildDirectSseUrl, buildDirectWebSocketUrl, buildSseUrl, buildWebSocketUrl, createRestlessClient, normalizeBaseUrl, parseSseStream, streamSse, streamWebSocket, toWebSocketStreamUrl, withRuntimeCursor };