@coji/durably-react 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { Durably, JobDefinition, Run } from '@coji/durably';
+import { Durably, JobDefinition } from '@coji/durably';
 import { ReactNode } from 'react';
-import { R as RunStatus, L as LogEntry, P as Progress } from './types-BDUvsa8u.js';
-export { D as DurablyEvent } from './types-BDUvsa8u.js';
+import { R as RunStatus, L as LogEntry, P as Progress, T as TypedRun } from './types-DY4Y6ggJ.js';
+export { D as DurablyEvent } from './types-DY4Y6ggJ.js';
 
 interface DurablyContextValue {
     durably: Durably;
@@ -223,11 +223,11 @@ interface UseRunsOptions {
      */
     realtime?: boolean;
 }
-interface UseRunsResult {
+interface UseRunsResult<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: Run[];
+    runs: TypedRun<TInput, TOutput>[];
     /**
      * Current page (0-indexed)
      */
@@ -260,25 +260,37 @@ interface UseRunsResult {
 /**
  * Hook for listing runs with pagination and real-time updates.
  *
- * @example
+ * @example With generic type parameter (dashboard with multiple job types)
  * ```tsx
+ * type DashboardRun = TypedRun<ImportInput, ImportOutput> | TypedRun<SyncInput, SyncOutput>
+ *
  * function Dashboard() {
- *   const { runs, page, hasMore, nextPage, prevPage, isLoading } = useRuns({
- *     pageSize: 20,
- *   })
+ *   const { runs } = useRuns<DashboardRun>({ pageSize: 10 })
+ *   // runs are typed as DashboardRun[]
+ * }
+ * ```
  *
- *   return (
- *     <div>
- *       {runs.map(run => (
- *         <div key={run.id}>{run.jobName}: {run.status}</div>
- *       ))}
- *       <button onClick={prevPage} disabled={page === 0}>Prev</button>
- *       <button onClick={nextPage} disabled={!hasMore}>Next</button>
- *     </div>
- *   )
+ * @example With JobDefinition (single job, auto-filters by jobName)
+ * ```tsx
+ * const myJob = defineJob({ name: 'my-job', ... })
+ *
+ * function Dashboard() {
+ *   const { runs } = useRuns(myJob)
+ *   // runs[0].output is typed!
+ *   return <div>{runs[0]?.output?.someField}</div>
+ * }
+ * ```
+ *
+ * @example With options only (untyped)
+ * ```tsx
+ * function Dashboard() {
+ *   const { runs } = useRuns({ pageSize: 20 })
+ *   // runs[0].output is unknown
  * }
  * ```
  */
+declare function useRuns<TRun extends TypedRun<Record<string, unknown>, Record<string, unknown> | undefined>>(options?: UseRunsOptions): UseRunsResult<TRun extends TypedRun<infer I, infer _O> ? I : Record<string, unknown>, TRun extends TypedRun<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<UseRunsOptions, 'jobName'>): UseRunsResult<TInput, TOutput>;
 declare function useRuns(options?: UseRunsOptions): UseRunsResult;
 
-export { DurablyProvider, type DurablyProviderProps, LogEntry, Progress, RunStatus, type UseJobLogsOptions, type UseJobLogsResult, type UseJobOptions, type UseJobResult, type UseJobRunOptions, type UseJobRunResult, type UseRunsOptions, type UseRunsResult, useDurably, useJob, useJobLogs, useJobRun, useRuns };
+export { DurablyProvider, type DurablyProviderProps, LogEntry, Progress, RunStatus, TypedRun, type UseJobLogsOptions, type UseJobLogsResult, type UseJobOptions, type UseJobResult, type UseJobRunOptions, type UseJobRunResult, type UseRunsOptions, type UseRunsResult, useDurably, useJob, useJobLogs, useJobRun, useRuns };