@starcite/sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,555 @@
+import { z } from 'zod';
+
+/**
+ * Request payload for creating a session.
+ */
+declare const CreateSessionInputSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    id?: string | undefined;
+    title?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    id?: string | undefined;
+    title?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+}>;
+/**
+ * Inferred TypeScript type for {@link CreateSessionInputSchema}.
+ */
+type CreateSessionInput = z.infer<typeof CreateSessionInputSchema>;
+/**
+ * Session record returned by the Starcite API.
+ */
+declare const SessionRecordSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    last_seq: z.ZodNumber;
+    created_at: z.ZodString;
+    updated_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    metadata: Record<string, unknown>;
+    last_seq: number;
+    created_at: string;
+    updated_at: string;
+    title?: string | null | undefined;
+}, {
+    id: string;
+    metadata: Record<string, unknown>;
+    last_seq: number;
+    created_at: string;
+    updated_at: string;
+    title?: string | null | undefined;
+}>;
+/**
+ * Inferred TypeScript type for {@link SessionRecordSchema}.
+ */
+type SessionRecord = z.infer<typeof SessionRecordSchema>;
+/**
+ * Session item returned by the list endpoint.
+ */
+declare const SessionListItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    created_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    metadata: Record<string, unknown>;
+    created_at: string;
+    title?: string | null | undefined;
+}, {
+    id: string;
+    metadata: Record<string, unknown>;
+    created_at: string;
+    title?: string | null | undefined;
+}>;
+/**
+ * Inferred TypeScript type for {@link SessionListItemSchema}.
+ */
+type SessionListItem = z.infer<typeof SessionListItemSchema>;
+/**
+ * Paginated session list response.
+ */
+declare const SessionListPageSchema: z.ZodObject<{
+    sessions: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        created_at: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        metadata: Record<string, unknown>;
+        created_at: string;
+        title?: string | null | undefined;
+    }, {
+        id: string;
+        metadata: Record<string, unknown>;
+        created_at: string;
+        title?: string | null | undefined;
+    }>, "many">;
+    next_cursor: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    sessions: {
+        id: string;
+        metadata: Record<string, unknown>;
+        created_at: string;
+        title?: string | null | undefined;
+    }[];
+    next_cursor: string | null;
+}, {
+    sessions: {
+        id: string;
+        metadata: Record<string, unknown>;
+        created_at: string;
+        title?: string | null | undefined;
+    }[];
+    next_cursor: string | null;
+}>;
+/**
+ * Inferred TypeScript type for {@link SessionListPageSchema}.
+ */
+type SessionListPage = z.infer<typeof SessionListPageSchema>;
+/**
+ * Low-level request payload for appending an event to a session.
+ */
+declare const AppendEventRequestSchema: z.ZodObject<{
+    type: z.ZodString;
+    payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    actor: z.ZodString;
+    producer_id: z.ZodString;
+    producer_seq: z.ZodNumber;
+    source: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    refs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    idempotency_key: z.ZodOptional<z.ZodString>;
+    expected_seq: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    payload: Record<string, unknown>;
+    actor: string;
+    producer_id: string;
+    producer_seq: number;
+    metadata?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    idempotency_key?: string | undefined;
+    expected_seq?: number | undefined;
+}, {
+    type: string;
+    payload: Record<string, unknown>;
+    actor: string;
+    producer_id: string;
+    producer_seq: number;
+    metadata?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    idempotency_key?: string | undefined;
+    expected_seq?: number | undefined;
+}>;
+/**
+ * Inferred TypeScript type for {@link AppendEventRequestSchema}.
+ */
+type AppendEventRequest = z.infer<typeof AppendEventRequestSchema>;
+/**
+ * API response returned after appending an event.
+ */
+declare const AppendEventResponseSchema: z.ZodObject<{
+    seq: z.ZodNumber;
+    last_seq: z.ZodNumber;
+    deduped: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    last_seq: number;
+    seq: number;
+    deduped: boolean;
+}, {
+    last_seq: number;
+    seq: number;
+    deduped: boolean;
+}>;
+/**
+ * Inferred TypeScript type for {@link AppendEventResponseSchema}.
+ */
+type AppendEventResponse = z.infer<typeof AppendEventResponseSchema>;
+/**
+ * Raw event frame shape emitted by the Starcite tail stream.
+ */
+declare const TailEventSchema: z.ZodObject<{
+    seq: z.ZodNumber;
+    type: z.ZodString;
+    payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    actor: z.ZodString;
+    producer_id: z.ZodString;
+    producer_seq: z.ZodNumber;
+    source: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    refs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    idempotency_key: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    inserted_at: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    payload: Record<string, unknown>;
+    actor: string;
+    producer_id: string;
+    producer_seq: number;
+    seq: number;
+    metadata?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    idempotency_key?: string | null | undefined;
+    inserted_at?: string | undefined;
+}, {
+    type: string;
+    payload: Record<string, unknown>;
+    actor: string;
+    producer_id: string;
+    producer_seq: number;
+    seq: number;
+    metadata?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    idempotency_key?: string | null | undefined;
+    inserted_at?: string | undefined;
+}>;
+/**
+ * Inferred TypeScript type for {@link TailEventSchema}.
+ */
+type TailEvent = z.infer<typeof TailEventSchema>;
+/**
+ * Convenience tail event shape with SDK-derived fields (`agent`, `text`).
+ */
+declare const SessionEventInternalSchema: z.ZodObject<{
+    seq: z.ZodNumber;
+    type: z.ZodString;
+    payload: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    actor: z.ZodString;
+    producer_id: z.ZodString;
+    producer_seq: z.ZodNumber;
+    source: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    refs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    idempotency_key: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    inserted_at: z.ZodOptional<z.ZodString>;
+} & {
+    agent: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    payload: Record<string, unknown>;
+    actor: string;
+    producer_id: string;
+    producer_seq: number;
+    seq: number;
+    metadata?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    idempotency_key?: string | null | undefined;
+    inserted_at?: string | undefined;
+    agent?: string | undefined;
+    text?: string | undefined;
+}, {
+    type: string;
+    payload: Record<string, unknown>;
+    actor: string;
+    producer_id: string;
+    producer_seq: number;
+    seq: number;
+    metadata?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    idempotency_key?: string | null | undefined;
+    inserted_at?: string | undefined;
+    agent?: string | undefined;
+    text?: string | undefined;
+}>;
+/**
+ * Inferred TypeScript type for the SDK-level enriched tail event.
+ */
+type SessionEvent = z.infer<typeof SessionEventInternalSchema>;
+/**
+ * High-level `session.append()` input.
+ *
+ * You must provide producer identity (`producerId`, `producerSeq`) and either
+ * `text` or `payload`.
+ */
+declare const SessionAppendInputSchema: z.ZodEffects<z.ZodObject<{
+    agent: z.ZodString;
+    producerId: z.ZodString;
+    producerSeq: z.ZodNumber;
+    text: z.ZodOptional<z.ZodString>;
+    payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    type: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    refs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    idempotencyKey: z.ZodOptional<z.ZodString>;
+    expectedSeq: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    agent: string;
+    producerId: string;
+    producerSeq: number;
+    type?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    payload?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    text?: string | undefined;
+    idempotencyKey?: string | undefined;
+    expectedSeq?: number | undefined;
+}, {
+    agent: string;
+    producerId: string;
+    producerSeq: number;
+    type?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    payload?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    text?: string | undefined;
+    idempotencyKey?: string | undefined;
+    expectedSeq?: number | undefined;
+}>, {
+    agent: string;
+    producerId: string;
+    producerSeq: number;
+    type?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    payload?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    text?: string | undefined;
+    idempotencyKey?: string | undefined;
+    expectedSeq?: number | undefined;
+}, {
+    agent: string;
+    producerId: string;
+    producerSeq: number;
+    type?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
+    payload?: Record<string, unknown> | undefined;
+    source?: string | undefined;
+    refs?: Record<string, unknown> | undefined;
+    text?: string | undefined;
+    idempotencyKey?: string | undefined;
+    expectedSeq?: number | undefined;
+}>;
+/**
+ * Inferred TypeScript type for {@link SessionAppendInputSchema}.
+ */
+type SessionAppendInput = z.infer<typeof SessionAppendInputSchema>;
+/**
+ * Options for streaming events from a session.
+ */
+interface SessionTailOptions {
+    /**
+     * Starting cursor (inclusive) in the event stream.
+     */
+    cursor?: number;
+    /**
+     * Optional filter for `agent:<name>` events.
+     */
+    agent?: string;
+    /**
+     * Optional abort signal to close the stream.
+     */
+    signal?: AbortSignal;
+}
+/**
+ * Options for listing sessions.
+ */
+interface SessionListOptions {
+    /**
+     * Maximum rows to return. Must be a positive integer.
+     */
+    limit?: number;
+    /**
+     * Optional cursor from the previous response.
+     */
+    cursor?: string;
+    /**
+     * Optional flat metadata exact-match filters.
+     */
+    metadata?: Record<string, string>;
+}
+/**
+ * Minimal WebSocket contract required by the SDK.
+ */
+interface StarciteWebSocket {
+    addEventListener(type: string, listener: (event: unknown) => void): void;
+    removeEventListener(type: string, listener: (event: unknown) => void): void;
+    close(code?: number, reason?: string): void;
+}
+/**
+ * Factory used to create the WebSocket connection for `tail`.
+ */
+interface StarciteWebSocketConnectOptions {
+    /**
+     * Headers to include with the WebSocket handshake request.
+     */
+    headers?: HeadersInit;
+}
+/**
+ * Factory used to create the WebSocket connection for `tail`.
+ */
+type StarciteWebSocketFactory = (url: string, options?: StarciteWebSocketConnectOptions) => StarciteWebSocket;
+/**
+ * Client construction options.
+ */
+interface StarciteClientOptions {
+    /**
+     * Base API URL. Defaults to `process.env.STARCITE_BASE_URL` or `http://localhost:4000`.
+     */
+    baseUrl?: string;
+    /**
+     * Custom fetch implementation for non-standard runtimes.
+     */
+    fetch?: typeof fetch;
+    /**
+     * Headers applied to every HTTP request.
+     */
+    headers?: HeadersInit;
+    /**
+     * Service key / JWT token. When set, the SDK automatically sends
+     * `Authorization: Bearer <token>` for HTTP requests and WebSocket upgrades.
+     */
+    apiKey?: string;
+    /**
+     * Custom WebSocket factory for non-browser runtimes.
+     */
+    websocketFactory?: StarciteWebSocketFactory;
+}
+/**
+ * Error payload shape returned by non-2xx API responses.
+ */
+declare const StarciteErrorPayloadSchema: z.ZodObject<{
+    error: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodUnknown, z.objectOutputType<{
+    error: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.ZodUnknown, "strip">, z.objectInputType<{
+    error: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+}, z.ZodUnknown, "strip">>;
+/**
+ * Inferred TypeScript type for {@link StarciteErrorPayloadSchema}.
+ */
+type StarciteErrorPayload = z.infer<typeof StarciteErrorPayloadSchema>;
+
+/**
+ * Normalizes a Starcite base URL to the `/v1` API root used by this SDK.
+ */
+declare function normalizeBaseUrl(baseUrl: string): string;
+/**
+ * Session-scoped helper for append and tail operations.
+ */
+declare class StarciteSession {
+    /** Session identifier. */
+    readonly id: string;
+    /** Optional session record captured at creation time. */
+    readonly record?: SessionRecord;
+    private readonly client;
+    constructor(client: StarciteClient, id: string, record?: SessionRecord);
+    /**
+     * Appends a high-level agent event to this session.
+     *
+     * Automatically prefixes `agent` as `agent:<name>` when needed.
+     */
+    append(input: SessionAppendInput): Promise<AppendEventResponse>;
+    /**
+     * Appends a raw event payload as-is.
+     */
+    appendRaw(input: AppendEventRequest): Promise<AppendEventResponse>;
+    /**
+     * Streams transformed session events with SDK convenience fields (`agent`, `text`).
+     */
+    tail(options?: SessionTailOptions): AsyncIterable<SessionEvent>;
+    /**
+     * Streams raw tail events returned by the API.
+     */
+    tailRaw(options?: SessionTailOptions): AsyncIterable<TailEvent>;
+}
+/**
+ * Starcite API client for HTTP and WebSocket session operations.
+ */
+declare class StarciteClient {
+    /** Normalized API base URL ending with `/v1`. */
+    readonly baseUrl: string;
+    private readonly websocketBaseUrl;
+    private readonly fetchFn;
+    private readonly headers;
+    private readonly websocketFactory;
+    /**
+     * Creates a new client instance.
+     */
+    constructor(options?: StarciteClientOptions);
+    /**
+     * Returns a session helper bound to an existing session id.
+     */
+    session(sessionId: string, record?: SessionRecord): StarciteSession;
+    /**
+     * Creates a new session and returns a bound `StarciteSession` helper.
+     */
+    create(input?: CreateSessionInput): Promise<StarciteSession>;
+    /**
+     * Creates a new session and returns the raw session record.
+     */
+    createSession(input?: CreateSessionInput): Promise<SessionRecord>;
+    /**
+     * Lists sessions from the archive-backed catalog.
+     */
+    listSessions(options?: SessionListOptions): Promise<SessionListPage>;
+    /**
+     * Appends a raw event payload to a specific session.
+     */
+    appendEvent(sessionId: string, input: AppendEventRequest): Promise<AppendEventResponse>;
+    /**
+     * Opens a WebSocket tail stream and yields raw events.
+     */
+    tailRawEvents(sessionId: string, options?: SessionTailOptions): AsyncGenerator<TailEvent>;
+    /**
+     * Opens a WebSocket tail stream and yields transformed session events.
+     */
+    tailEvents(sessionId: string, options?: SessionTailOptions): AsyncGenerator<SessionEvent>;
+    private request;
+}
+
+/**
+ * Base error type for SDK-level failures.
+ */
+declare class StarciteError extends Error {
+    constructor(message: string);
+}
+/**
+ * Thrown when the Starcite API responds with a non-2xx status code.
+ */
+declare class StarciteApiError extends StarciteError {
+    /** HTTP status code returned by the API. */
+    readonly status: number;
+    /** Stable API error code (or synthesized `http_<status>` fallback). */
+    readonly code: string;
+    /** Parsed API error payload when available. */
+    readonly payload: StarciteErrorPayload | null;
+    constructor(message: string, status: number, code: string, payload: StarciteErrorPayload | null);
+}
+/**
+ * Thrown when the SDK cannot reach Starcite or receives invalid transport payloads.
+ */
+declare class StarciteConnectionError extends StarciteError {
+    constructor(message: string);
+}
+
+/**
+ * Creates a new {@link StarciteClient} instance.
+ */
+declare function createStarciteClient(options?: StarciteClientOptions): StarciteClient;
+/**
+ * Default singleton client using environment/default configuration.
+ */
+declare const starcite: StarciteClient;
+
+export { type AppendEventRequest, type AppendEventResponse, type CreateSessionInput, type SessionAppendInput, type SessionEvent, type SessionListItem, type SessionListOptions, type SessionListPage, type SessionRecord, type SessionTailOptions, StarciteApiError, StarciteClient, type StarciteClientOptions, StarciteConnectionError, StarciteError, type StarciteErrorPayload, StarciteSession, type StarciteWebSocket, type StarciteWebSocketConnectOptions, type StarciteWebSocketFactory, type TailEvent, createStarciteClient, normalizeBaseUrl, starcite };