@coji/durably-react 0.9.0 → 0.11.0

package/dist/client.d.ts

@@ -1,515 +0,0 @@
-import { R as RunStatus, L as LogEntry, P as Progress, I as InferInput, a as InferOutput, b as TypedClientRun } from './types-xrRs7jov.js';
-import { JobDefinition, ClientRun } from '@coji/durably';
-export { ClientRun } from '@coji/durably';
-
-interface UseJobClientOptions {
-    /**
-     * API endpoint URL (e.g., '/api/durably')
-     */
-    api: string;
-    /**
-     * Job name to trigger
-     */
-    jobName: string;
-    /**
-     * Initial Run ID to subscribe to (for reconnection scenarios)
-     * When provided, the hook will immediately start subscribing to this run
-     */
-    initialRunId?: string;
-    /**
-     * Automatically resume tracking a running/pending job on mount
-     * @default true
-     */
-    autoResume?: boolean;
-    /**
-     * Automatically switch to tracking the latest triggered job
-     * @default true
-     */
-    followLatest?: boolean;
-}
-interface UseJobClientResult<TInput, TOutput> {
-    /**
-     * Whether the hook is ready (always true for client mode)
-     */
-    /**
-     * Trigger the job with the given input
-     */
-    trigger: (input: TInput) => Promise<{
-        runId: string;
-    }>;
-    /**
-     * Trigger and wait for completion
-     */
-    triggerAndWait: (input: TInput) => Promise<{
-        runId: string;
-        output: TOutput;
-    }>;
-    /**
-     * Current run status
-     */
-    status: RunStatus | null;
-    /**
-     * Output from completed run
-     */
-    output: TOutput | null;
-    /**
-     * Error message from failed run
-     */
-    error: string | null;
-    /**
-     * Logs collected during execution
-     */
-    logs: LogEntry[];
-    /**
-     * Current progress
-     */
-    progress: Progress | null;
-    /**
-     * Whether a run is currently running
-     */
-    isRunning: boolean;
-    /**
-     * Whether a run is pending
-     */
-    isPending: boolean;
-    /**
-     * Whether the run completed successfully
-     */
-    isCompleted: boolean;
-    /**
-     * Whether the run failed
-     */
-    isFailed: boolean;
-    /**
-     * Whether the run was cancelled
-     */
-    isCancelled: boolean;
-    /**
-     * Current run ID
-     */
-    currentRunId: string | null;
-    /**
-     * Reset all state
-     */
-    reset: () => void;
-}
-/**
- * Hook for triggering and subscribing to jobs via server API.
- * Uses fetch for triggering and EventSource for SSE subscription.
- */
-declare function useJob<TInput extends Record<string, unknown> = Record<string, unknown>, TOutput extends Record<string, unknown> = Record<string, unknown>>(options: UseJobClientOptions): UseJobClientResult<TInput, TOutput>;
-
-interface UseJobLogsClientOptions {
-    /**
-     * API endpoint URL (e.g., '/api/durably')
-     */
-    api: string;
-    /**
-     * The run ID to subscribe to logs for
-     */
-    runId: string | null;
-    /**
-     * Maximum number of logs to keep (default: unlimited)
-     */
-    maxLogs?: number;
-}
-interface UseJobLogsClientResult {
-    /**
-     * Whether the hook is ready (always true for client mode)
-     */
-    /**
-     * Logs collected during execution
-     */
-    logs: LogEntry[];
-    /**
-     * Clear all logs
-     */
-    clearLogs: () => void;
-}
-/**
- * Hook for subscribing to logs from a run via server API.
- * Uses EventSource for SSE subscription.
- */
-declare function useJobLogs(options: UseJobLogsClientOptions): UseJobLogsClientResult;
-
-interface UseJobRunClientOptions {
-    /**
-     * API endpoint URL (e.g., '/api/durably')
-     */
-    api: string;
-    /**
-     * The run ID to subscribe to
-     */
-    runId: string | null;
-    /**
-     * Callback when run starts (transitions to pending/running)
-     */
-    onStart?: () => void;
-    /**
-     * Callback when run completes successfully
-     */
-    onComplete?: () => void;
-    /**
-     * Callback when run fails
-     */
-    onFail?: () => void;
-}
-interface UseJobRunClientResult<TOutput = unknown> {
-    /**
-     * Whether the hook is ready (always true for client mode)
-     */
-    /**
-     * Current run status
-     */
-    status: RunStatus | null;
-    /**
-     * Output from completed run
-     */
-    output: TOutput | null;
-    /**
-     * Error message from failed run
-     */
-    error: string | null;
-    /**
-     * Logs collected during execution
-     */
-    logs: LogEntry[];
-    /**
-     * Current progress
-     */
-    progress: Progress | null;
-    /**
-     * Whether a run is currently running
-     */
-    isRunning: boolean;
-    /**
-     * Whether a run is pending
-     */
-    isPending: boolean;
-    /**
-     * Whether the run completed successfully
-     */
-    isCompleted: boolean;
-    /**
-     * Whether the run failed
-     */
-    isFailed: boolean;
-    /**
-     * Whether the run was cancelled
-     */
-    isCancelled: boolean;
-}
-/**
- * Hook for subscribing to an existing run via server API.
- * Uses EventSource for SSE subscription.
- */
-declare function useJobRun<TOutput = unknown>(options: UseJobRunClientOptions): UseJobRunClientResult<TOutput>;
-
-/**
- * Type-safe hooks for a specific job
- */
-interface JobClient<TInput, TOutput> {
-    /**
-     * Hook for triggering and monitoring the job
-     */
-    useJob: () => UseJobClientResult<TInput, TOutput>;
-    /**
-     * Hook for subscribing to an existing run by ID
-     */
-    useRun: (runId: string | null) => UseJobRunClientResult<TOutput>;
-    /**
-     * Hook for subscribing to logs from a run
-     */
-    useLogs: (runId: string | null, options?: {
-        maxLogs?: number;
-    }) => UseJobLogsClientResult;
-}
-/**
- * Options for createDurablyClient
- */
-interface CreateDurablyClientOptions {
-    /**
-     * API endpoint URL (e.g., '/api/durably')
-     */
-    api: string;
-}
-/**
- * A type-safe client with hooks for each registered job
- */
-type DurablyClient<TJobs extends Record<string, unknown>> = {
-    [K in keyof TJobs]: JobClient<InferInput<TJobs[K]>, InferOutput<TJobs[K]>>;
-};
-/**
- * Create a type-safe Durably client with hooks for all registered jobs.
- *
- * @example
- * ```tsx
- * // Server: register jobs
- * // app/lib/durably.server.ts
- * export const jobs = durably.register({
- *   importCsv: importCsvJob,
- *   syncUsers: syncUsersJob,
- * })
- *
- * // Client: create typed client
- * // app/lib/durably.client.ts
- * import type { jobs } from '~/lib/durably.server'
- * import { createDurablyClient } from '@coji/durably-react/client'
- *
- * export const durably = createDurablyClient<typeof jobs>({
- *   api: '/api/durably',
- * })
- *
- * // In your component - fully type-safe with autocomplete
- * function CsvImporter() {
- *   const { trigger, output, isRunning } = durably.importCsv.useJob()
- *
- *   return (
- *     <button onClick={() => trigger({ rows: [...] })}>
- *       Import
- *     </button>
- *   )
- * }
- * ```
- */
-declare function createDurablyClient<TJobs extends Record<string, unknown>>(options: CreateDurablyClientOptions): DurablyClient<TJobs>;
-
-/**
- * Options for createJobHooks
- */
-interface CreateJobHooksOptions {
-    /**
-     * API endpoint URL (e.g., '/api/durably')
-     */
-    api: string;
-    /**
-     * Job name (must match the server-side job name)
-     */
-    jobName: string;
-}
-/**
- * Type-safe hooks for a specific job
- */
-interface JobHooks<TInput, TOutput> {
-    /**
-     * Hook for triggering and monitoring the job
-     */
-    useJob: () => UseJobClientResult<TInput, TOutput>;
-    /**
-     * Hook for subscribing to an existing run by ID
-     */
-    useRun: (runId: string | null) => UseJobRunClientResult<TOutput>;
-    /**
-     * Hook for subscribing to logs from a run
-     */
-    useLogs: (runId: string | null, options?: {
-        maxLogs?: number;
-    }) => UseJobLogsClientResult;
-}
-/**
- * Create type-safe hooks for a specific job.
- *
- * @example
- * ```tsx
- * // Import job type from server (type-only import is safe)
- * import type { importCsvJob } from '~/lib/durably.server'
- * import { createJobHooks } from '@coji/durably-react/client'
- *
- * const importCsv = createJobHooks<typeof importCsvJob>({
- *   api: '/api/durably',
- *   jobName: 'import-csv',
- * })
- *
- * // In your component - fully type-safe
- * function CsvImporter() {
- *   const { trigger, output, progress, isRunning } = importCsv.useJob()
- *
- *   return (
- *     <button onClick={() => trigger({ rows: [...] })}>
- *       Import
- *     </button>
- *   )
- * }
- * ```
- */
-declare function createJobHooks<TJob extends JobDefinition<string, any, any>>(options: CreateJobHooksOptions): JobHooks<InferInput<TJob>, InferOutput<TJob>>;
-
-interface UseRunsClientOptions {
-    /**
-     * API endpoint URL (e.g., '/api/durably')
-     */
-    api: string;
-    /**
-     * Filter by job name
-     */
-    jobName?: string;
-    /**
-     * Filter by status
-     */
-    status?: RunStatus;
-    /**
-     * Filter by labels (all specified labels must match)
-     */
-    labels?: Record<string, string>;
-    /**
-     * Number of runs per page
-     * @default 10
-     */
-    pageSize?: number;
-    /**
-     * Subscribe to real-time updates via SSE (first page only)
-     * @default true
-     */
-    realtime?: boolean;
-}
-interface UseRunsClientResult<TInput extends Record<string, unknown> = Record<string, unknown>, TOutput extends Record<string, unknown> | undefined = Record<string, unknown> | undefined> {
-    /**
-     * List of runs for the current page
-     */
-    runs: TypedClientRun<TInput, TOutput>[];
-    /**
-     * Current page (0-indexed)
-     */
-    page: number;
-    /**
-     * Whether there are more pages
-     */
-    hasMore: boolean;
-    /**
-     * Whether data is being loaded
-     */
-    isLoading: boolean;
-    /**
-     * Error message if fetch failed
-     */
-    error: string | null;
-    /**
-     * Go to the next page
-     */
-    nextPage: () => void;
-    /**
-     * Go to the previous page
-     */
-    prevPage: () => void;
-    /**
-     * Go to a specific page
-     */
-    goToPage: (page: number) => void;
-    /**
-     * Refresh the current page
-     */
-    refresh: () => Promise<void>;
-}
-/**
- * Hook for listing runs via server API with pagination.
- * First page (page 0) automatically subscribes to SSE for real-time updates.
- * Other pages are static and require manual refresh.
- *
- * @example With generic type parameter (dashboard with multiple job types)
- * ```tsx
- * type DashboardRun = TypedClientRun<ImportInput, ImportOutput> | TypedClientRun<SyncInput, SyncOutput>
- *
- * function Dashboard() {
- *   const { runs } = useRuns<DashboardRun>({ api: '/api/durably', pageSize: 10 })
- *   // runs are typed as DashboardRun[]
- * }
- * ```
- *
- * @example With JobDefinition (single job, auto-filters by jobName)
- * ```tsx
- * const myJob = defineJob({ name: 'my-job', ... })
- *
- * function RunHistory() {
- *   const { runs } = useRuns(myJob, { api: '/api/durably' })
- *   // runs[0].output is typed!
- *   return <div>{runs[0]?.output?.someField}</div>
- * }
- * ```
- *
- * @example With options only (untyped)
- * ```tsx
- * function RunHistory() {
- *   const { runs } = useRuns({ api: '/api/durably', pageSize: 10 })
- *   // runs[0].output is unknown
- * }
- * ```
- */
-declare function useRuns<TRun extends TypedClientRun<Record<string, unknown>, Record<string, unknown> | undefined>>(options: UseRunsClientOptions): UseRunsClientResult<TRun extends TypedClientRun<infer I, infer _O> ? I : Record<string, unknown>, TRun extends TypedClientRun<infer _I, infer O> ? O : Record<string, unknown>>;
-declare function useRuns<TName extends string, TInput extends Record<string, unknown>, TOutput extends Record<string, unknown> | undefined>(jobDefinition: JobDefinition<TName, TInput, TOutput>, options: Omit<UseRunsClientOptions, 'jobName'>): UseRunsClientResult<TInput, TOutput>;
-declare function useRuns(options: UseRunsClientOptions): UseRunsClientResult;
-
-/**
- * Step record returned from the server API
- */
-interface StepRecord {
-    name: string;
-    status: 'completed' | 'failed' | 'cancelled';
-    output: unknown;
-}
-interface UseRunActionsClientOptions {
-    /**
-     * API endpoint URL (e.g., '/api/durably')
-     */
-    api: string;
-}
-interface UseRunActionsClientResult {
-    /**
-     * Retry a failed or cancelled run
-     */
-    retry: (runId: string) => Promise<void>;
-    /**
-     * Cancel a pending or running run
-     */
-    cancel: (runId: string) => Promise<void>;
-    /**
-     * Delete a run (only completed, failed, or cancelled runs)
-     */
-    deleteRun: (runId: string) => Promise<void>;
-    /**
-     * Get a single run by ID
-     */
-    getRun: (runId: string) => Promise<ClientRun | null>;
-    /**
-     * Get steps for a run
-     */
-    getSteps: (runId: string) => Promise<StepRecord[]>;
-    /**
-     * Whether an action is in progress
-     */
-    isLoading: boolean;
-    /**
-     * Error message from last action
-     */
-    error: string | null;
-}
-/**
- * Hook for run actions (retry, cancel) via server API.
- *
- * @example
- * ```tsx
- * function RunActions({ runId, status }: { runId: string; status: string }) {
- *   const { retry, cancel, isLoading, error } = useRunActions({
- *     api: '/api/durably',
- *   })
- *
- *   return (
- *     <div>
- *       {status === 'failed' && (
- *         <button onClick={() => retry(runId)} disabled={isLoading}>
- *           Retry
- *         </button>
- *       )}
- *       {(status === 'pending' || status === 'running') && (
- *         <button onClick={() => cancel(runId)} disabled={isLoading}>
- *           Cancel
- *         </button>
- *       )}
- *       {error && <span className="error">{error}</span>}
- *     </div>
- *   )
- * }
- * ```
- */
-declare function useRunActions(options: UseRunActionsClientOptions): UseRunActionsClientResult;
-
-export { type CreateDurablyClientOptions, type CreateJobHooksOptions, type DurablyClient, type JobClient, type JobHooks, LogEntry, Progress, RunStatus, type StepRecord, TypedClientRun, type UseJobClientOptions, type UseJobClientResult, type UseJobLogsClientOptions, type UseJobLogsClientResult, type UseJobRunClientOptions, type UseJobRunClientResult, type UseRunActionsClientOptions, type UseRunActionsClientResult, type UseRunsClientOptions, type UseRunsClientResult, createDurablyClient, createJobHooks, useJob, useJobLogs, useJobRun, useRunActions, useRuns };