ts-procedures 5.7.0 → 5.7.1

package/src/client/types.ts

@@ -0,0 +1,103 @@
+// ── Adapter ──────────────────────────────────────────────
+
+export interface ClientAdapter {
+  request(config: AdapterRequest): Promise<AdapterResponse>
+  stream(config: AdapterRequest): Promise<AdapterStreamResponse>
+}
+
+export interface AdapterRequest {
+  url: string
+  method: string
+  headers?: Record<string, string>
+  body?: unknown
+  signal?: AbortSignal
+}
+
+export interface AdapterResponse {
+  status: number
+  headers: Record<string, string>
+  body: unknown
+}
+
+export interface AdapterStreamResponse {
+  status: number
+  headers: Record<string, string>
+  body: AsyncIterable<unknown>
+}
+
+// ── Hooks ────────────────────────────────────────────────
+
+export interface ClientHooks {
+  onBeforeRequest?(context: BeforeRequestContext): BeforeRequestContext | Promise<BeforeRequestContext>
+  onAfterResponse?(context: AfterResponseContext): void | Promise<void>
+  onError?(context: ErrorContext): void | Promise<void>
+}
+
+export interface BeforeRequestContext {
+  procedureName: string
+  scope: string
+  request: AdapterRequest
+}
+
+export interface AfterResponseContext {
+  procedureName: string
+  scope: string
+  request: AdapterRequest
+  response: AdapterResponse
+}
+
+export interface ErrorContext {
+  procedureName: string
+  scope: string
+  request: AdapterRequest
+  error: unknown
+}
+
+// ── Descriptors ──────────────────────────────────────────
+
+export interface CallDescriptor {
+  name: string
+  scope: string
+  path: string
+  method: string
+  kind: 'rpc' | 'api' | 'stream'
+  params: unknown
+}
+
+export interface StreamDescriptor extends CallDescriptor {
+  kind: 'stream'
+  streamMode: 'sse' | 'text'
+}
+
+// ── TypedStream ──────────────────────────────────────────
+
+export interface TypedStream<TYield, TReturn = void> extends AsyncIterable<TYield> {
+  /**
+   * Resolves when the stream completes with the final return value.
+   * Rejects if the stream errors before completing.
+   * Note: iteration must begin (via for-await) for this promise to settle,
+   * since resolution depends on the async generator running to completion.
+   */
+  result: Promise<TReturn>
+}
+
+// ── Client Instance ──────────────────────────────────────
+
+export type ProcedureCallOptions = ClientHooks
+
+export interface ClientInstance {
+  basePath: string
+  adapter: ClientAdapter
+  hooks: ClientHooks
+  call<TResponse>(descriptor: CallDescriptor, options?: ProcedureCallOptions): Promise<TResponse>
+  stream<TYield, TReturn>(descriptor: StreamDescriptor, options?: ProcedureCallOptions): TypedStream<TYield, TReturn>
+}
+
+// ── createClient Config ──────────────────────────────────
+
+export interface CreateClientConfig<TScopes> {
+  adapter: ClientAdapter
+  basePath: string
+  scopes: (client: ClientInstance) => TScopes
+  hooks?: ClientHooks
+}