@trigger.dev/react-hooks 0.0.0-chat-prerelease-20260401205942

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +1 -0
  3. package/dist/commonjs/contexts.d.ts +4 -0
  4. package/dist/commonjs/contexts.js +10 -0
  5. package/dist/commonjs/contexts.js.map +1 -0
  6. package/dist/commonjs/hooks/useApiClient.d.ts +41 -0
  7. package/dist/commonjs/hooks/useApiClient.js +44 -0
  8. package/dist/commonjs/hooks/useApiClient.js.map +1 -0
  9. package/dist/commonjs/hooks/useInputStreamSend.d.ts +26 -0
  10. package/dist/commonjs/hooks/useInputStreamSend.js +45 -0
  11. package/dist/commonjs/hooks/useInputStreamSend.js.map +1 -0
  12. package/dist/commonjs/hooks/useRealtime.d.ts +294 -0
  13. package/dist/commonjs/hooks/useRealtime.js +549 -0
  14. package/dist/commonjs/hooks/useRealtime.js.map +1 -0
  15. package/dist/commonjs/hooks/useRun.d.ts +22 -0
  16. package/dist/commonjs/hooks/useRun.js +40 -0
  17. package/dist/commonjs/hooks/useRun.js.map +1 -0
  18. package/dist/commonjs/hooks/useTaskTrigger.d.ts +107 -0
  19. package/dist/commonjs/hooks/useTaskTrigger.js +138 -0
  20. package/dist/commonjs/hooks/useTaskTrigger.js.map +1 -0
  21. package/dist/commonjs/hooks/useWaitToken.d.ts +35 -0
  22. package/dist/commonjs/hooks/useWaitToken.js +52 -0
  23. package/dist/commonjs/hooks/useWaitToken.js.map +1 -0
  24. package/dist/commonjs/index.d.ts +7 -0
  25. package/dist/commonjs/index.js +24 -0
  26. package/dist/commonjs/index.js.map +1 -0
  27. package/dist/commonjs/package.json +3 -0
  28. package/dist/commonjs/utils/createContextAndHook.d.ts +15 -0
  29. package/dist/commonjs/utils/createContextAndHook.js +39 -0
  30. package/dist/commonjs/utils/createContextAndHook.js.map +1 -0
  31. package/dist/commonjs/utils/throttle.d.ts +6 -0
  32. package/dist/commonjs/utils/throttle.js +50 -0
  33. package/dist/commonjs/utils/throttle.js.map +1 -0
  34. package/dist/commonjs/utils/trigger-swr.d.ts +19 -0
  35. package/dist/commonjs/utils/trigger-swr.js +28 -0
  36. package/dist/commonjs/utils/trigger-swr.js.map +1 -0
  37. package/dist/esm/contexts.d.ts +4 -0
  38. package/dist/esm/contexts.js +5 -0
  39. package/dist/esm/contexts.js.map +1 -0
  40. package/dist/esm/hooks/useApiClient.d.ts +41 -0
  41. package/dist/esm/hooks/useApiClient.js +41 -0
  42. package/dist/esm/hooks/useApiClient.js.map +1 -0
  43. package/dist/esm/hooks/useInputStreamSend.d.ts +26 -0
  44. package/dist/esm/hooks/useInputStreamSend.js +39 -0
  45. package/dist/esm/hooks/useInputStreamSend.js.map +1 -0
  46. package/dist/esm/hooks/useRealtime.d.ts +294 -0
  47. package/dist/esm/hooks/useRealtime.js +542 -0
  48. package/dist/esm/hooks/useRealtime.js.map +1 -0
  49. package/dist/esm/hooks/useRun.d.ts +22 -0
  50. package/dist/esm/hooks/useRun.js +37 -0
  51. package/dist/esm/hooks/useRun.js.map +1 -0
  52. package/dist/esm/hooks/useTaskTrigger.d.ts +107 -0
  53. package/dist/esm/hooks/useTaskTrigger.js +130 -0
  54. package/dist/esm/hooks/useTaskTrigger.js.map +1 -0
  55. package/dist/esm/hooks/useWaitToken.d.ts +35 -0
  56. package/dist/esm/hooks/useWaitToken.js +46 -0
  57. package/dist/esm/hooks/useWaitToken.js.map +1 -0
  58. package/dist/esm/index.d.ts +7 -0
  59. package/dist/esm/index.js +8 -0
  60. package/dist/esm/index.js.map +1 -0
  61. package/dist/esm/package.json +3 -0
  62. package/dist/esm/utils/createContextAndHook.d.ts +15 -0
  63. package/dist/esm/utils/createContextAndHook.js +31 -0
  64. package/dist/esm/utils/createContextAndHook.js.map +1 -0
  65. package/dist/esm/utils/throttle.d.ts +6 -0
  66. package/dist/esm/utils/throttle.js +47 -0
  67. package/dist/esm/utils/throttle.js.map +1 -0
  68. package/dist/esm/utils/trigger-swr.d.ts +19 -0
  69. package/dist/esm/utils/trigger-swr.js +6 -0
  70. package/dist/esm/utils/trigger-swr.js.map +1 -0
  71. package/package.json +75 -0
@@ -0,0 +1,107 @@
1
+ import { type AnyTask, type TaskIdentifier, type TaskPayload, InferRunTypes, RunHandleFromTypes, type TriggerOptions, type RealtimeRunSkipColumns } from "@trigger.dev/core/v3";
2
+ import { UseApiClientOptions } from "./useApiClient.js";
3
+ import { UseRealtimeRunInstance, UseRealtimeRunWithStreamsInstance } from "./useRealtime.js";
4
+ /**
5
+ * Base interface for task trigger instances.
6
+ *
7
+ * @template TTask - The type of the task
8
+ */
9
+ export interface TriggerInstance<TTask extends AnyTask> {
10
+ /** Function to submit the task with a payload */
11
+ submit: (payload: TaskPayload<TTask>, options?: TriggerOptions) => void;
12
+ /** Whether the task is currently being submitted */
13
+ isLoading: boolean;
14
+ /** The handle returned after successful task submission */
15
+ handle?: RunHandleFromTypes<InferRunTypes<TTask>>;
16
+ /** Any error that occurred during submission */
17
+ error?: Error;
18
+ }
19
+ export type UseTaskTriggerOptions = UseApiClientOptions;
20
+ /**
21
+ * Hook to trigger a task and manage its initial execution state.
22
+ *
23
+ * @template TTask - The type of the task
24
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
25
+ * @param {UseTaskTriggerOptions} [options] - Configuration options for the task trigger
26
+ * @returns {TriggerInstance<TTask>} An object containing the submit function, loading state, handle, and any errors
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * import type { myTask } from './path/to/task';
31
+ * const { submit, isLoading, handle, error } = useTaskTrigger<typeof myTask>('my-task-id');
32
+ *
33
+ * // Submit the task with payload
34
+ * submit({ foo: 'bar' });
35
+ * ```
36
+ */
37
+ export declare function useTaskTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, options?: UseTaskTriggerOptions): TriggerInstance<TTask>;
38
+ /**
39
+ * Configuration options for task triggers with realtime updates.
40
+ */
41
+ export type UseRealtimeTaskTriggerOptions = UseTaskTriggerOptions & {
42
+ /** Whether the realtime subscription is enabled */
43
+ enabled?: boolean;
44
+ /** Optional throttle time in milliseconds for stream updates */
45
+ experimental_throttleInMs?: number;
46
+ /**
47
+ * Skip columns from the subscription.
48
+ *
49
+ * @default []
50
+ */
51
+ skipColumns?: RealtimeRunSkipColumns;
52
+ };
53
+ export type RealtimeTriggerInstanceWithStreams<TTask extends AnyTask, TStreams extends Record<string, any> = Record<string, any>> = UseRealtimeRunWithStreamsInstance<TTask, TStreams> & {
54
+ submit: (payload: TaskPayload<TTask>, options?: TriggerOptions) => void;
55
+ isLoading: boolean;
56
+ handle?: RunHandleFromTypes<InferRunTypes<TTask>>;
57
+ };
58
+ /**
59
+ * Hook to trigger a task and subscribe to its realtime updates including stream data.
60
+ *
61
+ * @template TTask - The type of the task
62
+ * @template TStreams - The type of the streams data
63
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
64
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
65
+ * @returns {RealtimeTriggerInstanceWithStreams<TTask, TStreams>} An object containing the submit function, loading state,
66
+ * handle, run state, streams data, and error handling
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * import type { myTask } from './path/to/task';
71
+ * const { submit, run, streams, error } = useRealtimeTaskTriggerWithStreams<
72
+ * typeof myTask,
73
+ * { output: string }
74
+ * >('my-task-id');
75
+ *
76
+ * // Submit and monitor the task with streams
77
+ * submit({ foo: 'bar' });
78
+ * ```
79
+ */
80
+ export declare function useRealtimeTaskTriggerWithStreams<TTask extends AnyTask, TStreams extends Record<string, any> = Record<string, any>>(id: TaskIdentifier<TTask>, options?: UseRealtimeTaskTriggerOptions): RealtimeTriggerInstanceWithStreams<TTask, TStreams>;
81
+ export type RealtimeTriggerInstance<TTask extends AnyTask> = UseRealtimeRunInstance<TTask> & {
82
+ submit: (payload: TaskPayload<TTask>, options?: TriggerOptions) => void;
83
+ isLoading: boolean;
84
+ handle?: RunHandleFromTypes<InferRunTypes<TTask>>;
85
+ };
86
+ /**
87
+ * Hook to trigger a task and subscribe to its realtime updates.
88
+ *
89
+ * @template TTask - The type of the task
90
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
91
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
92
+ * @returns {RealtimeTriggerInstance<TTask>} An object containing the submit function, loading state,
93
+ * handle, run state, and error handling
94
+ *
95
+ * @example
96
+ * ```ts
97
+ * import type { myTask } from './path/to/task';
98
+ * const { submit, run, error, stop } = useRealtimeTaskTrigger<typeof myTask>('my-task-id');
99
+ *
100
+ * // Submit and monitor the task
101
+ * submit({ foo: 'bar' });
102
+ *
103
+ * // Stop monitoring when needed
104
+ * stop();
105
+ * ```
106
+ */
107
+ export declare function useRealtimeTaskTrigger<TTask extends AnyTask>(id: TaskIdentifier<TTask>, options?: UseRealtimeTaskTriggerOptions): RealtimeTriggerInstance<TTask>;
@@ -0,0 +1,130 @@
1
+ "use client";
2
+ import { makeIdempotencyKey, stringifyIO, } from "@trigger.dev/core/v3";
3
+ import useSWRMutation from "swr/mutation";
4
+ import { useApiClient } from "./useApiClient.js";
5
+ import { useRealtimeRun, useRealtimeRunWithStreams, } from "./useRealtime.js";
6
+ /**
7
+ * Hook to trigger a task and manage its initial execution state.
8
+ *
9
+ * @template TTask - The type of the task
10
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
11
+ * @param {UseTaskTriggerOptions} [options] - Configuration options for the task trigger
12
+ * @returns {TriggerInstance<TTask>} An object containing the submit function, loading state, handle, and any errors
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * import type { myTask } from './path/to/task';
17
+ * const { submit, isLoading, handle, error } = useTaskTrigger<typeof myTask>('my-task-id');
18
+ *
19
+ * // Submit the task with payload
20
+ * submit({ foo: 'bar' });
21
+ * ```
22
+ */
23
+ export function useTaskTrigger(id, options) {
24
+ const apiClient = useApiClient(options);
25
+ async function triggerTask(id, { arg: { payload, options }, }) {
26
+ if (!apiClient) {
27
+ throw new Error("Could not trigger task in useTaskTrigger: Missing access token");
28
+ }
29
+ const payloadPacket = await stringifyIO(payload);
30
+ const handle = await apiClient.triggerTask(id, {
31
+ payload: payloadPacket.data,
32
+ options: {
33
+ queue: options?.queue ? { name: options.queue } : undefined,
34
+ concurrencyKey: options?.concurrencyKey,
35
+ payloadType: payloadPacket.dataType,
36
+ idempotencyKey: await makeIdempotencyKey(options?.idempotencyKey),
37
+ delay: options?.delay,
38
+ ttl: options?.ttl,
39
+ tags: options?.tags,
40
+ maxAttempts: options?.maxAttempts,
41
+ metadata: options?.metadata,
42
+ maxDuration: options?.maxDuration,
43
+ lockToVersion: options?.version,
44
+ },
45
+ });
46
+ return { ...handle, taskIdentifier: id };
47
+ }
48
+ const mutation = useSWRMutation(id, triggerTask);
49
+ return {
50
+ submit: (payload, options) => {
51
+ // trigger the task with the given payload
52
+ mutation.trigger({ payload, options });
53
+ },
54
+ isLoading: mutation.isMutating,
55
+ handle: mutation.data,
56
+ error: mutation.error,
57
+ };
58
+ }
59
+ /**
60
+ * Hook to trigger a task and subscribe to its realtime updates including stream data.
61
+ *
62
+ * @template TTask - The type of the task
63
+ * @template TStreams - The type of the streams data
64
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
65
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
66
+ * @returns {RealtimeTriggerInstanceWithStreams<TTask, TStreams>} An object containing the submit function, loading state,
67
+ * handle, run state, streams data, and error handling
68
+ *
69
+ * @example
70
+ * ```ts
71
+ * import type { myTask } from './path/to/task';
72
+ * const { submit, run, streams, error } = useRealtimeTaskTriggerWithStreams<
73
+ * typeof myTask,
74
+ * { output: string }
75
+ * >('my-task-id');
76
+ *
77
+ * // Submit and monitor the task with streams
78
+ * submit({ foo: 'bar' });
79
+ * ```
80
+ */
81
+ export function useRealtimeTaskTriggerWithStreams(id, options) {
82
+ const triggerInstance = useTaskTrigger(id, options);
83
+ const realtimeInstance = useRealtimeRunWithStreams(triggerInstance.handle?.id, {
84
+ ...options,
85
+ id: triggerInstance.handle?.id,
86
+ accessToken: triggerInstance.handle?.publicAccessToken ?? options?.accessToken,
87
+ });
88
+ return {
89
+ ...realtimeInstance,
90
+ ...triggerInstance,
91
+ };
92
+ }
93
+ /**
94
+ * Hook to trigger a task and subscribe to its realtime updates.
95
+ *
96
+ * @template TTask - The type of the task
97
+ * @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
98
+ * @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
99
+ * @returns {RealtimeTriggerInstance<TTask>} An object containing the submit function, loading state,
100
+ * handle, run state, and error handling
101
+ *
102
+ * @example
103
+ * ```ts
104
+ * import type { myTask } from './path/to/task';
105
+ * const { submit, run, error, stop } = useRealtimeTaskTrigger<typeof myTask>('my-task-id');
106
+ *
107
+ * // Submit and monitor the task
108
+ * submit({ foo: 'bar' });
109
+ *
110
+ * // Stop monitoring when needed
111
+ * stop();
112
+ * ```
113
+ */
114
+ export function useRealtimeTaskTrigger(id, options) {
115
+ const triggerInstance = useTaskTrigger(id, options);
116
+ const realtimeInstance = useRealtimeRun(triggerInstance.handle?.id, {
117
+ ...options,
118
+ id: triggerInstance.handle?.id,
119
+ accessToken: triggerInstance.handle?.publicAccessToken ?? options?.accessToken,
120
+ });
121
+ return {
122
+ submit: triggerInstance.submit,
123
+ isLoading: triggerInstance.isLoading,
124
+ handle: triggerInstance.handle,
125
+ run: realtimeInstance.run,
126
+ error: realtimeInstance.error ?? triggerInstance.error,
127
+ stop: realtimeInstance.stop,
128
+ };
129
+ }
130
+ //# sourceMappingURL=useTaskTrigger.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useTaskTrigger.js","sourceRoot":"","sources":["../../../src/hooks/useTaskTrigger.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAKL,kBAAkB,EAElB,WAAW,GAGZ,MAAM,sBAAsB,CAAC;AAC9B,OAAO,cAAc,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAuB,MAAM,mBAAmB,CAAC;AACtE,OAAO,EACL,cAAc,EAEd,yBAAyB,GAE1B,MAAM,kBAAkB,CAAC;AAoB1B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAC5B,EAAyB,EACzB,OAA+B;IAE/B,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAExC,KAAK,UAAU,WAAW,CACxB,EAAU,EACV,EACE,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAC0C;QAErE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;QAED,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,OAAO,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,EAAE,EAAE;YAC7C,OAAO,EAAE,aAAa,CAAC,IAAI;YAC3B,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS;gBAC3D,cAAc,EAAE,OAAO,EAAE,cAAc;gBACvC,WAAW,EAAE,aAAa,CAAC,QAAQ;gBACnC,cAAc,EAAE,MAAM,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC;gBACjE,KAAK,EAAE,OAAO,EAAE,KAAK;gBACrB,GAAG,EAAE,OAAO,EAAE,GAAG;gBACjB,IAAI,EAAE,OAAO,EAAE,IAAI;gBACnB,WAAW,EAAE,OAAO,EAAE,WAAW;gBACjC,QAAQ,EAAE,OAAO,EAAE,QAAQ;gBAC3B,WAAW,EAAE,OAAO,EAAE,WAAW;gBACjC,aAAa,EAAE,OAAO,EAAE,OAAO;aAChC;SACF,CAAC,CAAC;QAEH,OAAO,EAAE,GAAG,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,EAAY,EAAE,WAAW,CAAC,CAAC;IAE3D,OAAO;QACL,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE;YAC3B,0CAA0C;YAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QACzC,CAAC;QACD,SAAS,EAAE,QAAQ,CAAC,UAAU;QAC9B,MAAM,EAAE,QAAQ,CAAC,IAAgD;QACjE,KAAK,EAAE,QAAQ,CAAC,KAAK;KACtB,CAAC;AACJ,CAAC;AA4BD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,iCAAiC,CAI/C,EAAyB,EACzB,OAAuC;IAEvC,MAAM,eAAe,GAAG,cAAc,CAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,yBAAyB,CAAkB,eAAe,CAAC,MAAM,EAAE,EAAE,EAAE;QAC9F,GAAG,OAAO;QACV,EAAE,EAAE,eAAe,CAAC,MAAM,EAAE,EAAE;QAC9B,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,iBAAiB,IAAI,OAAO,EAAE,WAAW;KAC/E,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,gBAAgB;QACnB,GAAG,eAAe;KACnB,CAAC;AACJ,CAAC;AAQD;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,UAAU,sBAAsB,CACpC,EAAyB,EACzB,OAAuC;IAEvC,MAAM,eAAe,GAAG,cAAc,CAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,cAAc,CAAQ,eAAe,CAAC,MAAM,EAAE,EAAE,EAAE;QACzE,GAAG,OAAO;QACV,EAAE,EAAE,eAAe,CAAC,MAAM,EAAE,EAAE;QAC9B,WAAW,EAAE,eAAe,CAAC,MAAM,EAAE,iBAAiB,IAAI,OAAO,EAAE,WAAW;KAC/E,CAAC,CAAC;IAEH,OAAO;QACL,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,SAAS,EAAE,eAAe,CAAC,SAAS;QACpC,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,GAAG,EAAE,gBAAgB,CAAC,GAAG;QACzB,KAAK,EAAE,gBAAgB,CAAC,KAAK,IAAI,eAAe,CAAC,KAAK;QACtD,IAAI,EAAE,gBAAgB,CAAC,IAAI;KAC5B,CAAC;AACJ,CAAC"}
@@ -0,0 +1,35 @@
1
+ import { UseApiClientOptions } from "./useApiClient.js";
2
+ /**
3
+ * Base interface for task trigger instances.
4
+ *
5
+ * @template TOutput - The type of the output
6
+ */
7
+ export interface WaitTokenInstance<TOutput> {
8
+ /** Function to complete the waitpoint with an output */
9
+ complete: (output: TOutput) => void;
10
+ /** Whether the waitpoint is currently being completed */
11
+ isLoading: boolean;
12
+ /** Whether the waitpoint has been completed */
13
+ isCompleted: boolean;
14
+ /** Any error that occurred during completion */
15
+ error?: Error;
16
+ /** Whether the waitpoint is ready to be completed */
17
+ isReady: boolean;
18
+ }
19
+ /**
20
+ * Hook to complete a waitpoint and manage its completion state.
21
+ *
22
+ * @template TOutput - The type of the output
23
+ * @param {string} waitpointId - The identifier of the waitpoint to complete
24
+ * @returns {WaitTokenInstance<TOutput>} An object containing the complete function, loading state, isCompleted, and any errors
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * import type { myTask } from './path/to/task';
29
+ * const { complete, isLoading, isCompleted, error } = useWaitToken('waitpoint-id');
30
+ *
31
+ * // Complete the waitpoint with an output
32
+ * complete({ foo: 'bar' });
33
+ * ```
34
+ */
35
+ export declare function useWaitToken<TOutput>(waitpointId?: string, options?: UseApiClientOptions): WaitTokenInstance<TOutput>;
@@ -0,0 +1,46 @@
1
+ "use client";
2
+ import useSWRMutation from "swr/mutation";
3
+ import { useApiClient } from "./useApiClient.js";
4
+ /**
5
+ * Hook to complete a waitpoint and manage its completion state.
6
+ *
7
+ * @template TOutput - The type of the output
8
+ * @param {string} waitpointId - The identifier of the waitpoint to complete
9
+ * @returns {WaitTokenInstance<TOutput>} An object containing the complete function, loading state, isCompleted, and any errors
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * import type { myTask } from './path/to/task';
14
+ * const { complete, isLoading, isCompleted, error } = useWaitToken('waitpoint-id');
15
+ *
16
+ * // Complete the waitpoint with an output
17
+ * complete({ foo: 'bar' });
18
+ * ```
19
+ */
20
+ export function useWaitToken(waitpointId, options) {
21
+ const apiClient = useApiClient(options);
22
+ async function completeWaitpoint(id, { arg: { output } }) {
23
+ if (!apiClient) {
24
+ throw new Error("Could not complete waitpoint in useWaitToken: Missing access token");
25
+ }
26
+ if (!waitpointId) {
27
+ throw new Error("Could not complete waitpoint in useWaitToken: Missing waitpoint ID");
28
+ }
29
+ const result = await apiClient.completeWaitpointToken(waitpointId, {
30
+ data: output,
31
+ });
32
+ return result;
33
+ }
34
+ const mutation = useSWRMutation(waitpointId, completeWaitpoint);
35
+ return {
36
+ complete: (output) => {
37
+ // trigger the task with the given payload
38
+ mutation.trigger({ output });
39
+ },
40
+ isLoading: mutation.isMutating,
41
+ isCompleted: !!mutation.data?.success,
42
+ isReady: !!waitpointId,
43
+ error: mutation.error,
44
+ };
45
+ }
46
+ //# sourceMappingURL=useWaitToken.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useWaitToken.js","sourceRoot":"","sources":["../../../src/hooks/useWaitToken.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,cAAc,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAuB,MAAM,mBAAmB,CAAC;AAoBtE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,YAAY,CAC1B,WAAoB,EACpB,OAA6B;IAE7B,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAExC,KAAK,UAAU,iBAAiB,CAAC,EAAU,EAAE,EAAE,GAAG,EAAE,EAAE,MAAM,EAAE,EAAgC;QAC5F,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACxF,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,sBAAsB,CAAC,WAAW,EAAE;YACjE,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;IAEhE,OAAO;QACL,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE;YACnB,0CAA0C;YAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/B,CAAC;QACD,SAAS,EAAE,QAAQ,CAAC,UAAU;QAC9B,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO;QACrC,OAAO,EAAE,CAAC,CAAC,WAAW;QACtB,KAAK,EAAE,QAAQ,CAAC,KAAK;KACtB,CAAC;AACJ,CAAC"}
@@ -0,0 +1,7 @@
1
+ export * from "./contexts.js";
2
+ export * from "./hooks/useApiClient.js";
3
+ export * from "./hooks/useRun.js";
4
+ export * from "./hooks/useRealtime.js";
5
+ export * from "./hooks/useTaskTrigger.js";
6
+ export * from "./hooks/useWaitToken.js";
7
+ export * from "./hooks/useInputStreamSend.js";
@@ -0,0 +1,8 @@
1
+ export * from "./contexts.js";
2
+ export * from "./hooks/useApiClient.js";
3
+ export * from "./hooks/useRun.js";
4
+ export * from "./hooks/useRealtime.js";
5
+ export * from "./hooks/useTaskTrigger.js";
6
+ export * from "./hooks/useWaitToken.js";
7
+ export * from "./hooks/useInputStreamSend.js";
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC"}
@@ -0,0 +1,3 @@
1
+ {
2
+ "type": "module"
3
+ }
@@ -0,0 +1,15 @@
1
+ import React from "react";
2
+ export declare function assertContextExists(contextVal: unknown, msgOrCtx: string | React.Context<any>): asserts contextVal;
3
+ type Options = {
4
+ assertCtxFn?: (v: unknown, msg: string) => void;
5
+ };
6
+ type ContextOf<T> = React.Context<T | undefined>;
7
+ type UseCtxFn<T> = () => T;
8
+ /**
9
+ * Creates and returns a Context and two hooks that return the context value.
10
+ * The Context type is derived from the type passed in by the user.
11
+ * The first hook returned guarantees that the context exists so the returned value is always CtxValue
12
+ * The second hook makes no guarantees, so the returned value can be CtxValue | undefined
13
+ */
14
+ export declare const createContextAndHook: <CtxVal>(displayName: string, options?: Options) => [ContextOf<CtxVal>, UseCtxFn<CtxVal>, UseCtxFn<CtxVal | Partial<CtxVal>>];
15
+ export {};
@@ -0,0 +1,31 @@
1
+ "use client";
2
+ import React from "react";
3
+ export function assertContextExists(contextVal, msgOrCtx) {
4
+ if (!contextVal) {
5
+ throw typeof msgOrCtx === "string"
6
+ ? new Error(msgOrCtx)
7
+ : new Error(`${msgOrCtx.displayName} not found`);
8
+ }
9
+ }
10
+ /**
11
+ * Creates and returns a Context and two hooks that return the context value.
12
+ * The Context type is derived from the type passed in by the user.
13
+ * The first hook returned guarantees that the context exists so the returned value is always CtxValue
14
+ * The second hook makes no guarantees, so the returned value can be CtxValue | undefined
15
+ */
16
+ export const createContextAndHook = (displayName, options) => {
17
+ const { assertCtxFn = assertContextExists } = options || {};
18
+ const Ctx = React.createContext(undefined);
19
+ Ctx.displayName = displayName;
20
+ const useCtx = () => {
21
+ const ctx = React.useContext(Ctx);
22
+ assertCtxFn(ctx, `${displayName} not found`);
23
+ return ctx;
24
+ };
25
+ const useCtxWithoutGuarantee = () => {
26
+ const ctx = React.useContext(Ctx);
27
+ return ctx ? ctx : {};
28
+ };
29
+ return [Ctx, useCtx, useCtxWithoutGuarantee];
30
+ };
31
+ //# sourceMappingURL=createContextAndHook.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createContextAndHook.js","sourceRoot":"","sources":["../../../src/utils/createContextAndHook.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,UAAU,mBAAmB,CACjC,UAAmB,EACnB,QAAqC;IAErC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,OAAO,QAAQ,KAAK,QAAQ;YAChC,CAAC,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC;YACrB,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,YAAY,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAMD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,WAAmB,EACnB,OAAiB,EAC0D,EAAE;IAC7E,MAAM,EAAE,WAAW,GAAG,mBAAmB,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAC5D,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;IAC/D,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;IAE9B,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,YAAY,CAAC,CAAC;QAC7C,OAAO,GAAa,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,sBAAsB,GAAG,GAAG,EAAE;QAClC,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACxB,CAAC,CAAC;IAEF,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,sBAAsB,CAAC,CAAC;AAC/C,CAAC,CAAC"}
@@ -0,0 +1,6 @@
1
+ export type ThrottledQueue<T> = {
2
+ add: (item: T) => void;
3
+ flush: () => Promise<void>;
4
+ isEmpty: () => boolean;
5
+ };
6
+ export declare function createThrottledQueue<T>(onFlush: (items: T[]) => Promise<void>, throttleInMs?: number): ThrottledQueue<T>;
@@ -0,0 +1,47 @@
1
+ export function createThrottledQueue(onFlush, throttleInMs) {
2
+ let queue = [];
3
+ let lastFlushTime = 0;
4
+ let flushPromise = null;
5
+ const scheduleFlush = async () => {
6
+ // If no throttle specified or there's already a flush in progress, return
7
+ if (!throttleInMs) {
8
+ // Immediately flush when no throttling is specified
9
+ const itemsToFlush = [...queue];
10
+ queue = [];
11
+ await onFlush(itemsToFlush);
12
+ return;
13
+ }
14
+ if (queue.length === 0 || flushPromise)
15
+ return;
16
+ const now = Date.now();
17
+ const timeUntilNextFlush = Math.max(0, lastFlushTime + throttleInMs - now);
18
+ if (timeUntilNextFlush === 0) {
19
+ const itemsToFlush = [...queue];
20
+ queue = [];
21
+ lastFlushTime = now;
22
+ flushPromise = onFlush(itemsToFlush).finally(() => {
23
+ flushPromise = null;
24
+ // Check if more items accumulated during flush
25
+ scheduleFlush();
26
+ });
27
+ }
28
+ else {
29
+ setTimeout(scheduleFlush, timeUntilNextFlush);
30
+ }
31
+ };
32
+ return {
33
+ add: (item) => {
34
+ queue.push(item);
35
+ scheduleFlush();
36
+ },
37
+ flush: async () => {
38
+ if (queue.length === 0)
39
+ return;
40
+ const itemsToFlush = [...queue];
41
+ queue = [];
42
+ await onFlush(itemsToFlush);
43
+ },
44
+ isEmpty: () => queue.length === 0,
45
+ };
46
+ }
47
+ //# sourceMappingURL=throttle.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"throttle.js","sourceRoot":"","sources":["../../../src/utils/throttle.ts"],"names":[],"mappings":"AAOA,MAAM,UAAU,oBAAoB,CAClC,OAAsC,EACtC,YAAqB;IAErB,IAAI,KAAK,GAAQ,EAAE,CAAC;IACpB,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,YAAY,GAAyB,IAAI,CAAC;IAE9C,MAAM,aAAa,GAAG,KAAK,IAAI,EAAE;QAC/B,0EAA0E;QAC1E,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,oDAAoD;YACpD,MAAM,YAAY,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;YAChC,KAAK,GAAG,EAAE,CAAC;YACX,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY;YAAE,OAAO;QAE/C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,GAAG,YAAY,GAAG,GAAG,CAAC,CAAC;QAE3E,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,YAAY,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;YAChC,KAAK,GAAG,EAAE,CAAC;YACX,aAAa,GAAG,GAAG,CAAC;YACpB,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;gBAChD,YAAY,GAAG,IAAI,CAAC;gBACpB,+CAA+C;gBAC/C,aAAa,EAAE,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;QAChD,CAAC;IACH,CAAC,CAAC;IAEF,OAAO;QACL,GAAG,EAAE,CAAC,IAAO,EAAE,EAAE;YACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,aAAa,EAAE,CAAC;QAClB,CAAC;QACD,KAAK,EAAE,KAAK,IAAI,EAAE;YAChB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YAC/B,MAAM,YAAY,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;YAChC,KAAK,GAAG,EAAE,CAAC;YACX,MAAM,OAAO,CAAC,YAAY,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;KAClC,CAAC;AACJ,CAAC"}
@@ -0,0 +1,19 @@
1
+ import { ApiRequestOptions } from "@trigger.dev/core/v3";
2
+ export * from "swr";
3
+ export { default as useSWR, SWRConfig } from "swr";
4
+ export type CommonTriggerHookOptions = {
5
+ /**
6
+ * Poll for updates at the specified interval (in milliseconds). Polling is not recommended for most use-cases. Use the Realtime hooks instead.
7
+ */
8
+ refreshInterval?: number;
9
+ /** Revalidate the data when the browser regains a network connection. */
10
+ revalidateOnReconnect?: boolean;
11
+ /** Revalidate the data when the window regains focus. */
12
+ revalidateOnFocus?: boolean;
13
+ /** Optional access token for authentication */
14
+ accessToken?: string;
15
+ /** Optional base URL for the API endpoints */
16
+ baseURL?: string;
17
+ /** Optional additional request configuration */
18
+ requestOptions?: ApiRequestOptions;
19
+ };
@@ -0,0 +1,6 @@
1
+ "use client";
2
+ // eslint-disable-next-line import/export
3
+ export * from "swr";
4
+ // eslint-disable-next-line import/export
5
+ export { default as useSWR, SWRConfig } from "swr";
6
+ //# sourceMappingURL=trigger-swr.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"trigger-swr.js","sourceRoot":"","sources":["../../../src/utils/trigger-swr.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAIb,yCAAyC;AACzC,cAAc,KAAK,CAAC;AACpB,yCAAyC;AACzC,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC"}
package/package.json ADDED
@@ -0,0 +1,75 @@
1
+ {
2
+ "name": "@trigger.dev/react-hooks",
3
+ "version": "0.0.0-chat-prerelease-20260401205942",
4
+ "description": "trigger.dev react hooks",
5
+ "license": "MIT",
6
+ "publishConfig": {
7
+ "access": "public"
8
+ },
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "https://github.com/triggerdotdev/trigger.dev",
12
+ "directory": "packages/react-hooks"
13
+ },
14
+ "type": "module",
15
+ "files": [
16
+ "dist"
17
+ ],
18
+ "tshy": {
19
+ "selfLink": false,
20
+ "main": true,
21
+ "module": true,
22
+ "project": "./tsconfig.json",
23
+ "exports": {
24
+ "./package.json": "./package.json",
25
+ ".": "./src/index.ts"
26
+ },
27
+ "sourceDialects": [
28
+ "@triggerdotdev/source"
29
+ ]
30
+ },
31
+ "dependencies": {
32
+ "@trigger.dev/core": "0.0.0-chat-prerelease-20260401205942",
33
+ "swr": "^2.2.5"
34
+ },
35
+ "devDependencies": {
36
+ "@arethetypeswrong/cli": "^0.15.4",
37
+ "@types/react": "*",
38
+ "@types/react-dom": "*",
39
+ "rimraf": "^3.0.2",
40
+ "tshy": "^3.0.2",
41
+ "tsx": "4.17.0"
42
+ },
43
+ "peerDependencies": {
44
+ "react": "^18.0 || ^19.0 || ^19.0.0-rc",
45
+ "react-dom": "^18.0 || ^19.0 || ^19.0.0-rc"
46
+ },
47
+ "engines": {
48
+ "node": ">=18.20.0"
49
+ },
50
+ "exports": {
51
+ "./package.json": "./package.json",
52
+ ".": {
53
+ "import": {
54
+ "@triggerdotdev/source": "./src/index.ts",
55
+ "types": "./dist/esm/index.d.ts",
56
+ "default": "./dist/esm/index.js"
57
+ },
58
+ "require": {
59
+ "types": "./dist/commonjs/index.d.ts",
60
+ "default": "./dist/commonjs/index.js"
61
+ }
62
+ }
63
+ },
64
+ "main": "./dist/commonjs/index.js",
65
+ "types": "./dist/commonjs/index.d.ts",
66
+ "module": "./dist/esm/index.js",
67
+ "scripts": {
68
+ "clean": "rimraf dist .tshy .tshy-build .turbo",
69
+ "build": "tshy && pnpm run update-version",
70
+ "dev": "tshy --watch",
71
+ "typecheck": "tsc --noEmit",
72
+ "update-version": "tsx ../../scripts/updateVersion.ts",
73
+ "check-exports": "attw --pack ."
74
+ }
75
+ }