@trigger.dev/react-hooks 0.0.0-prerelease-20241119135607
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.
- package/LICENSE +201 -0
- package/README.md +1 -0
- package/dist/commonjs/contexts.d.ts +4 -0
- package/dist/commonjs/contexts.js +10 -0
- package/dist/commonjs/contexts.js.map +1 -0
- package/dist/commonjs/hooks/useApiClient.d.ts +33 -0
- package/dist/commonjs/hooks/useApiClient.js +40 -0
- package/dist/commonjs/hooks/useApiClient.js.map +1 -0
- package/dist/commonjs/hooks/useRealtime.d.ts +100 -0
- package/dist/commonjs/hooks/useRealtime.js +387 -0
- package/dist/commonjs/hooks/useRealtime.js.map +1 -0
- package/dist/commonjs/hooks/useRun.d.ts +22 -0
- package/dist/commonjs/hooks/useRun.js +35 -0
- package/dist/commonjs/hooks/useRun.js.map +1 -0
- package/dist/commonjs/hooks/useTaskTrigger.d.ts +101 -0
- package/dist/commonjs/hooks/useTaskTrigger.js +134 -0
- package/dist/commonjs/hooks/useTaskTrigger.js.map +1 -0
- package/dist/commonjs/index.d.ts +5 -0
- package/dist/commonjs/index.js +22 -0
- package/dist/commonjs/index.js.map +1 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/commonjs/utils/createContextAndHook.d.ts +15 -0
- package/dist/commonjs/utils/createContextAndHook.js +39 -0
- package/dist/commonjs/utils/createContextAndHook.js.map +1 -0
- package/dist/commonjs/utils/throttle.d.ts +6 -0
- package/dist/commonjs/utils/throttle.js +50 -0
- package/dist/commonjs/utils/throttle.js.map +1 -0
- package/dist/commonjs/utils/trigger-swr.d.ts +7 -0
- package/dist/commonjs/utils/trigger-swr.js +28 -0
- package/dist/commonjs/utils/trigger-swr.js.map +1 -0
- package/dist/esm/contexts.d.ts +4 -0
- package/dist/esm/contexts.js +5 -0
- package/dist/esm/contexts.js.map +1 -0
- package/dist/esm/hooks/useApiClient.d.ts +33 -0
- package/dist/esm/hooks/useApiClient.js +37 -0
- package/dist/esm/hooks/useApiClient.js.map +1 -0
- package/dist/esm/hooks/useRealtime.d.ts +100 -0
- package/dist/esm/hooks/useRealtime.js +381 -0
- package/dist/esm/hooks/useRealtime.js.map +1 -0
- package/dist/esm/hooks/useRun.d.ts +22 -0
- package/dist/esm/hooks/useRun.js +32 -0
- package/dist/esm/hooks/useRun.js.map +1 -0
- package/dist/esm/hooks/useTaskTrigger.d.ts +101 -0
- package/dist/esm/hooks/useTaskTrigger.js +126 -0
- package/dist/esm/hooks/useTaskTrigger.js.map +1 -0
- package/dist/esm/index.d.ts +5 -0
- package/dist/esm/index.js +6 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/utils/createContextAndHook.d.ts +15 -0
- package/dist/esm/utils/createContextAndHook.js +31 -0
- package/dist/esm/utils/createContextAndHook.js.map +1 -0
- package/dist/esm/utils/throttle.d.ts +6 -0
- package/dist/esm/utils/throttle.js +47 -0
- package/dist/esm/utils/throttle.js.map +1 -0
- package/dist/esm/utils/trigger-swr.d.ts +7 -0
- package/dist/esm/utils/trigger-swr.js +6 -0
- package/dist/esm/utils/trigger-swr.js.map +1 -0
- package/package.json +77 -0
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
"use strict";
|
|
3
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
4
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
5
|
+
};
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
exports.useTaskTrigger = useTaskTrigger;
|
|
8
|
+
exports.useRealtimeTaskTriggerWithStreams = useRealtimeTaskTriggerWithStreams;
|
|
9
|
+
exports.useRealtimeTaskTrigger = useRealtimeTaskTrigger;
|
|
10
|
+
const v3_1 = require("@trigger.dev/core/v3");
|
|
11
|
+
const mutation_1 = __importDefault(require("swr/mutation"));
|
|
12
|
+
const useApiClient_js_1 = require("./useApiClient.js");
|
|
13
|
+
const useRealtime_js_1 = require("./useRealtime.js");
|
|
14
|
+
/**
|
|
15
|
+
* Hook to trigger a task and manage its initial execution state.
|
|
16
|
+
*
|
|
17
|
+
* @template TTask - The type of the task
|
|
18
|
+
* @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
|
|
19
|
+
* @param {UseTaskTriggerOptions} [options] - Configuration options for the task trigger
|
|
20
|
+
* @returns {TriggerInstance<TTask>} An object containing the submit function, loading state, handle, and any errors
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* ```ts
|
|
24
|
+
* import type { myTask } from './path/to/task';
|
|
25
|
+
* const { submit, isLoading, handle, error } = useTaskTrigger<typeof myTask>('my-task-id');
|
|
26
|
+
*
|
|
27
|
+
* // Submit the task with payload
|
|
28
|
+
* submit({ foo: 'bar' });
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
function useTaskTrigger(id, options) {
|
|
32
|
+
const apiClient = (0, useApiClient_js_1.useApiClient)(options);
|
|
33
|
+
async function triggerTask(id, { arg: { payload, options }, }) {
|
|
34
|
+
const payloadPacket = await (0, v3_1.stringifyIO)(payload);
|
|
35
|
+
const handle = await apiClient.triggerTask(id, {
|
|
36
|
+
payload: payloadPacket.data,
|
|
37
|
+
options: {
|
|
38
|
+
queue: options?.queue,
|
|
39
|
+
concurrencyKey: options?.concurrencyKey,
|
|
40
|
+
payloadType: payloadPacket.dataType,
|
|
41
|
+
idempotencyKey: await (0, v3_1.makeIdempotencyKey)(options?.idempotencyKey),
|
|
42
|
+
delay: options?.delay,
|
|
43
|
+
ttl: options?.ttl,
|
|
44
|
+
tags: options?.tags,
|
|
45
|
+
maxAttempts: options?.maxAttempts,
|
|
46
|
+
metadata: options?.metadata,
|
|
47
|
+
maxDuration: options?.maxDuration,
|
|
48
|
+
},
|
|
49
|
+
});
|
|
50
|
+
return { ...handle, taskIdentifier: id };
|
|
51
|
+
}
|
|
52
|
+
const mutation = (0, mutation_1.default)(id, triggerTask);
|
|
53
|
+
return {
|
|
54
|
+
submit: (payload) => {
|
|
55
|
+
// trigger the task with the given payload
|
|
56
|
+
mutation.trigger({ payload });
|
|
57
|
+
},
|
|
58
|
+
isLoading: mutation.isMutating,
|
|
59
|
+
handle: mutation.data,
|
|
60
|
+
error: mutation.error,
|
|
61
|
+
};
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* Hook to trigger a task and subscribe to its realtime updates including stream data.
|
|
65
|
+
*
|
|
66
|
+
* @template TTask - The type of the task
|
|
67
|
+
* @template TStreams - The type of the streams data
|
|
68
|
+
* @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
|
|
69
|
+
* @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
|
|
70
|
+
* @returns {RealtimeTriggerInstanceWithStreams<TTask, TStreams>} An object containing the submit function, loading state,
|
|
71
|
+
* handle, run state, streams data, and error handling
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* ```ts
|
|
75
|
+
* import type { myTask } from './path/to/task';
|
|
76
|
+
* const { submit, run, streams, error } = useRealtimeTaskTriggerWithStreams<
|
|
77
|
+
* typeof myTask,
|
|
78
|
+
* { output: string }
|
|
79
|
+
* >('my-task-id');
|
|
80
|
+
*
|
|
81
|
+
* // Submit and monitor the task with streams
|
|
82
|
+
* submit({ foo: 'bar' });
|
|
83
|
+
* ```
|
|
84
|
+
*/
|
|
85
|
+
function useRealtimeTaskTriggerWithStreams(id, options) {
|
|
86
|
+
const triggerInstance = useTaskTrigger(id, options);
|
|
87
|
+
const realtimeInstance = (0, useRealtime_js_1.useRealtimeRunWithStreams)(triggerInstance.handle?.id, {
|
|
88
|
+
...options,
|
|
89
|
+
id: triggerInstance.handle?.id,
|
|
90
|
+
accessToken: triggerInstance.handle?.publicAccessToken ?? options?.accessToken,
|
|
91
|
+
});
|
|
92
|
+
return {
|
|
93
|
+
...realtimeInstance,
|
|
94
|
+
...triggerInstance,
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Hook to trigger a task and subscribe to its realtime updates.
|
|
99
|
+
*
|
|
100
|
+
* @template TTask - The type of the task
|
|
101
|
+
* @param {TaskIdentifier<TTask>} id - The identifier of the task to trigger
|
|
102
|
+
* @param {UseRealtimeTaskTriggerOptions} [options] - Configuration options for the task trigger and realtime updates
|
|
103
|
+
* @returns {RealtimeTriggerInstance<TTask>} An object containing the submit function, loading state,
|
|
104
|
+
* handle, run state, and error handling
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* import type { myTask } from './path/to/task';
|
|
109
|
+
* const { submit, run, error, stop } = useRealtimeTaskTrigger<typeof myTask>('my-task-id');
|
|
110
|
+
*
|
|
111
|
+
* // Submit and monitor the task
|
|
112
|
+
* submit({ foo: 'bar' });
|
|
113
|
+
*
|
|
114
|
+
* // Stop monitoring when needed
|
|
115
|
+
* stop();
|
|
116
|
+
* ```
|
|
117
|
+
*/
|
|
118
|
+
function useRealtimeTaskTrigger(id, options) {
|
|
119
|
+
const triggerInstance = useTaskTrigger(id, options);
|
|
120
|
+
const realtimeInstance = (0, useRealtime_js_1.useRealtimeRun)(triggerInstance.handle?.id, {
|
|
121
|
+
...options,
|
|
122
|
+
id: triggerInstance.handle?.id,
|
|
123
|
+
accessToken: triggerInstance.handle?.publicAccessToken ?? options?.accessToken,
|
|
124
|
+
});
|
|
125
|
+
return {
|
|
126
|
+
submit: triggerInstance.submit,
|
|
127
|
+
isLoading: triggerInstance.isLoading,
|
|
128
|
+
handle: triggerInstance.handle,
|
|
129
|
+
run: realtimeInstance.run,
|
|
130
|
+
error: realtimeInstance.error ?? triggerInstance.error,
|
|
131
|
+
stop: realtimeInstance.stop,
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
//# sourceMappingURL=useTaskTrigger.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useTaskTrigger.js","sourceRoot":"","sources":["../../../src/hooks/useTaskTrigger.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;AAwDb,wCA4CC;AA2CD,8EAkBC;AA8BD,wDAmBC;AAhND,6CAS8B;AAC9B,4DAA0C;AAC1C,uDAAsE;AACtE,qDAK0B;AAoB1B;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,cAAc,CAC5B,EAAyB,EACzB,OAA+B;IAE/B,MAAM,SAAS,GAAG,IAAA,8BAAY,EAAC,OAAO,CAAC,CAAC;IAExC,KAAK,UAAU,WAAW,CACxB,EAAU,EACV,EACE,GAAG,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAC0C;QAErE,MAAM,aAAa,GAAG,MAAM,IAAA,gBAAW,EAAC,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;gBACrB,cAAc,EAAE,OAAO,EAAE,cAAc;gBACvC,WAAW,EAAE,aAAa,CAAC,QAAQ;gBACnC,cAAc,EAAE,MAAM,IAAA,uBAAkB,EAAC,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;aAClC;SACF,CAAC,CAAC;QAEH,OAAO,EAAE,GAAG,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;IAC3C,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,kBAAc,EAAC,EAAY,EAAE,WAAW,CAAC,CAAC;IAE3D,OAAO;QACL,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE;YAClB,0CAA0C;YAC1C,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAChC,CAAC;QACD,SAAS,EAAE,QAAQ,CAAC,UAAU;QAC9B,MAAM,EAAE,QAAQ,CAAC,IAAgD;QACjE,KAAK,EAAE,QAAQ,CAAC,KAAK;KACtB,CAAC;AACJ,CAAC;AAqBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,iCAAiC,CAI/C,EAAyB,EACzB,OAAuC;IAEvC,MAAM,eAAe,GAAG,cAAc,CAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,IAAA,0CAAyB,EAAkB,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,SAAgB,sBAAsB,CACpC,EAAyB,EACzB,OAAuC;IAEvC,MAAM,eAAe,GAAG,cAAc,CAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,IAAA,+BAAc,EAAQ,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,22 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./contexts.js"), exports);
|
|
18
|
+
__exportStar(require("./hooks/useApiClient.js"), exports);
|
|
19
|
+
__exportStar(require("./hooks/useRun.js"), exports);
|
|
20
|
+
__exportStar(require("./hooks/useRealtime.js"), exports);
|
|
21
|
+
__exportStar(require("./hooks/useTaskTrigger.js"), exports);
|
|
22
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0DAAwC;AACxC,oDAAkC;AAClC,yDAAuC;AACvC,4DAA0C"}
|
|
@@ -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,39 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
"use strict";
|
|
3
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
4
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
5
|
+
};
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
exports.createContextAndHook = void 0;
|
|
8
|
+
exports.assertContextExists = assertContextExists;
|
|
9
|
+
const react_1 = __importDefault(require("react"));
|
|
10
|
+
function assertContextExists(contextVal, msgOrCtx) {
|
|
11
|
+
if (!contextVal) {
|
|
12
|
+
throw typeof msgOrCtx === "string"
|
|
13
|
+
? new Error(msgOrCtx)
|
|
14
|
+
: new Error(`${msgOrCtx.displayName} not found`);
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Creates and returns a Context and two hooks that return the context value.
|
|
19
|
+
* The Context type is derived from the type passed in by the user.
|
|
20
|
+
* The first hook returned guarantees that the context exists so the returned value is always CtxValue
|
|
21
|
+
* The second hook makes no guarantees, so the returned value can be CtxValue | undefined
|
|
22
|
+
*/
|
|
23
|
+
const createContextAndHook = (displayName, options) => {
|
|
24
|
+
const { assertCtxFn = assertContextExists } = options || {};
|
|
25
|
+
const Ctx = react_1.default.createContext(undefined);
|
|
26
|
+
Ctx.displayName = displayName;
|
|
27
|
+
const useCtx = () => {
|
|
28
|
+
const ctx = react_1.default.useContext(Ctx);
|
|
29
|
+
assertCtxFn(ctx, `${displayName} not found`);
|
|
30
|
+
return ctx;
|
|
31
|
+
};
|
|
32
|
+
const useCtxWithoutGuarantee = () => {
|
|
33
|
+
const ctx = react_1.default.useContext(Ctx);
|
|
34
|
+
return ctx ? ctx : {};
|
|
35
|
+
};
|
|
36
|
+
return [Ctx, useCtx, useCtxWithoutGuarantee];
|
|
37
|
+
};
|
|
38
|
+
exports.createContextAndHook = createContextAndHook;
|
|
39
|
+
//# sourceMappingURL=createContextAndHook.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createContextAndHook.js","sourceRoot":"","sources":["../../../src/utils/createContextAndHook.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;;;;;;;AAGb,kDASC;AAXD,kDAA0B;AAE1B,SAAgB,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;AACI,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,eAAK,CAAC,aAAa,CAAqB,SAAS,CAAC,CAAC;IAC/D,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;IAE9B,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,MAAM,GAAG,GAAG,eAAK,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,eAAK,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;AApBW,QAAA,oBAAoB,wBAoB/B"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.createThrottledQueue = createThrottledQueue;
|
|
4
|
+
function createThrottledQueue(onFlush, throttleInMs) {
|
|
5
|
+
let queue = [];
|
|
6
|
+
let lastFlushTime = 0;
|
|
7
|
+
let flushPromise = null;
|
|
8
|
+
const scheduleFlush = async () => {
|
|
9
|
+
// If no throttle specified or there's already a flush in progress, return
|
|
10
|
+
if (!throttleInMs) {
|
|
11
|
+
// Immediately flush when no throttling is specified
|
|
12
|
+
const itemsToFlush = [...queue];
|
|
13
|
+
queue = [];
|
|
14
|
+
await onFlush(itemsToFlush);
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
if (queue.length === 0 || flushPromise)
|
|
18
|
+
return;
|
|
19
|
+
const now = Date.now();
|
|
20
|
+
const timeUntilNextFlush = Math.max(0, lastFlushTime + throttleInMs - now);
|
|
21
|
+
if (timeUntilNextFlush === 0) {
|
|
22
|
+
const itemsToFlush = [...queue];
|
|
23
|
+
queue = [];
|
|
24
|
+
lastFlushTime = now;
|
|
25
|
+
flushPromise = onFlush(itemsToFlush).finally(() => {
|
|
26
|
+
flushPromise = null;
|
|
27
|
+
// Check if more items accumulated during flush
|
|
28
|
+
scheduleFlush();
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
else {
|
|
32
|
+
setTimeout(scheduleFlush, timeUntilNextFlush);
|
|
33
|
+
}
|
|
34
|
+
};
|
|
35
|
+
return {
|
|
36
|
+
add: (item) => {
|
|
37
|
+
queue.push(item);
|
|
38
|
+
scheduleFlush();
|
|
39
|
+
},
|
|
40
|
+
flush: async () => {
|
|
41
|
+
if (queue.length === 0)
|
|
42
|
+
return;
|
|
43
|
+
const itemsToFlush = [...queue];
|
|
44
|
+
queue = [];
|
|
45
|
+
await onFlush(itemsToFlush);
|
|
46
|
+
},
|
|
47
|
+
isEmpty: () => queue.length === 0,
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
//# sourceMappingURL=throttle.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"throttle.js","sourceRoot":"","sources":["../../../src/utils/throttle.ts"],"names":[],"mappings":";;AAOA,oDAkDC;AAlDD,SAAgB,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,28 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
"use strict";
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
15
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
16
|
+
};
|
|
17
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
18
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
19
|
+
};
|
|
20
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
21
|
+
exports.SWRConfig = exports.useSWR = void 0;
|
|
22
|
+
// eslint-disable-next-line import/export
|
|
23
|
+
__exportStar(require("swr"), exports);
|
|
24
|
+
// eslint-disable-next-line import/export
|
|
25
|
+
var swr_1 = require("swr");
|
|
26
|
+
Object.defineProperty(exports, "useSWR", { enumerable: true, get: function () { return __importDefault(swr_1).default; } });
|
|
27
|
+
Object.defineProperty(exports, "SWRConfig", { enumerable: true, get: function () { return swr_1.SWRConfig; } });
|
|
28
|
+
//# 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;;;;;;;;;;;;;;;;;;;;;AACb,yCAAyC;AACzC,sCAAoB;AACpB,yCAAyC;AACzC,2BAAmD;AAA1C,8GAAA,OAAO,OAAU;AAAE,gGAAA,SAAS,OAAA"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import React from "react";
|
|
2
|
+
import type { ApiClientConfiguration } from "@trigger.dev/core/v3";
|
|
3
|
+
declare const TriggerAuthContext: React.Context<ApiClientConfiguration | undefined>, useTriggerAuthContext: () => ApiClientConfiguration, useTriggerAuthContextOptional: () => ApiClientConfiguration | Partial<ApiClientConfiguration>;
|
|
4
|
+
export { TriggerAuthContext, useTriggerAuthContext, useTriggerAuthContextOptional };
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { createContextAndHook } from "./utils/createContextAndHook.js";
|
|
3
|
+
const [TriggerAuthContext, useTriggerAuthContext, useTriggerAuthContextOptional] = createContextAndHook("TriggerAuthContext");
|
|
4
|
+
export { TriggerAuthContext, useTriggerAuthContext, useTriggerAuthContextOptional };
|
|
5
|
+
//# sourceMappingURL=contexts.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contexts.js","sourceRoot":"","sources":["../../src/contexts.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAGb,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAGvE,MAAM,CAAC,kBAAkB,EAAE,qBAAqB,EAAE,6BAA6B,CAAC,GAC9E,oBAAoB,CAAyB,oBAAoB,CAAC,CAAC;AAErE,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { ApiClient, ApiRequestOptions } from "@trigger.dev/core/v3";
|
|
2
|
+
/**
|
|
3
|
+
* Configuration options for creating an API client instance.
|
|
4
|
+
*/
|
|
5
|
+
export type UseApiClientOptions = {
|
|
6
|
+
/** Optional access token for authentication */
|
|
7
|
+
accessToken?: string;
|
|
8
|
+
/** Optional base URL for the API endpoints */
|
|
9
|
+
baseURL?: string;
|
|
10
|
+
/** Optional additional request configuration */
|
|
11
|
+
requestOptions?: ApiRequestOptions;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Hook to create an API client instance using authentication context or provided options.
|
|
15
|
+
*
|
|
16
|
+
* @param {UseApiClientOptions} [options] - Configuration options for the API client
|
|
17
|
+
* @returns {ApiClient} An initialized API client instance
|
|
18
|
+
* @throws {Error} When no access token is available in either context or options
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* ```ts
|
|
22
|
+
* // Using context authentication
|
|
23
|
+
* const apiClient = useApiClient();
|
|
24
|
+
*
|
|
25
|
+
* // Using custom options
|
|
26
|
+
* const apiClient = useApiClient({
|
|
27
|
+
* accessToken: "your-access-token",
|
|
28
|
+
* baseURL: "https://api.my-trigger.com",
|
|
29
|
+
* requestOptions: { retry: { maxAttempts: 10 } }
|
|
30
|
+
* });
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
export declare function useApiClient(options?: UseApiClientOptions): ApiClient;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { ApiClient } from "@trigger.dev/core/v3";
|
|
3
|
+
import { useTriggerAuthContextOptional } from "../contexts.js";
|
|
4
|
+
/**
|
|
5
|
+
* Hook to create an API client instance using authentication context or provided options.
|
|
6
|
+
*
|
|
7
|
+
* @param {UseApiClientOptions} [options] - Configuration options for the API client
|
|
8
|
+
* @returns {ApiClient} An initialized API client instance
|
|
9
|
+
* @throws {Error} When no access token is available in either context or options
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* // Using context authentication
|
|
14
|
+
* const apiClient = useApiClient();
|
|
15
|
+
*
|
|
16
|
+
* // Using custom options
|
|
17
|
+
* const apiClient = useApiClient({
|
|
18
|
+
* accessToken: "your-access-token",
|
|
19
|
+
* baseURL: "https://api.my-trigger.com",
|
|
20
|
+
* requestOptions: { retry: { maxAttempts: 10 } }
|
|
21
|
+
* });
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
export function useApiClient(options) {
|
|
25
|
+
const auth = useTriggerAuthContextOptional();
|
|
26
|
+
const baseUrl = options?.baseURL ?? auth?.baseURL ?? "https://api.trigger.dev";
|
|
27
|
+
const accessToken = options?.accessToken ?? auth?.accessToken;
|
|
28
|
+
if (!accessToken) {
|
|
29
|
+
throw new Error("Missing accessToken in TriggerAuthContext or useApiClient options");
|
|
30
|
+
}
|
|
31
|
+
const requestOptions = {
|
|
32
|
+
...auth?.requestOptions,
|
|
33
|
+
...options?.requestOptions,
|
|
34
|
+
};
|
|
35
|
+
return new ApiClient(baseUrl, accessToken, requestOptions);
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=useApiClient.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useApiClient.js","sourceRoot":"","sources":["../../../src/hooks/useApiClient.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,SAAS,EAAqB,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,6BAA6B,EAAE,MAAM,gBAAgB,CAAC;AAc/D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,YAAY,CAAC,OAA6B;IACxD,MAAM,IAAI,GAAG,6BAA6B,EAAE,CAAC;IAE7C,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,IAAI,EAAE,OAAO,IAAI,yBAAyB,CAAC;IAC/E,MAAM,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,IAAI,EAAE,WAAW,CAAC;IAE9D,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,cAAc,GAAsB;QACxC,GAAG,IAAI,EAAE,cAAc;QACvB,GAAG,OAAO,EAAE,cAAc;KAC3B,CAAC;IAEF,OAAO,IAAI,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;AAC7D,CAAC"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { AnyTask, RealtimeRun } from "@trigger.dev/core/v3";
|
|
2
|
+
import { UseApiClientOptions } from "./useApiClient.js";
|
|
3
|
+
export type UseRealtimeRunOptions = UseApiClientOptions & {
|
|
4
|
+
id?: string;
|
|
5
|
+
enabled?: boolean;
|
|
6
|
+
experimental_throttleInMs?: number;
|
|
7
|
+
};
|
|
8
|
+
export type UseRealtimeRunInstance<TTask extends AnyTask = AnyTask> = {
|
|
9
|
+
run: RealtimeRun<TTask> | undefined;
|
|
10
|
+
error: Error | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* Abort the current request immediately.
|
|
13
|
+
*/
|
|
14
|
+
stop: () => void;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Hook to subscribe to realtime updates of a task run.
|
|
18
|
+
*
|
|
19
|
+
* @template TTask - The type of the task
|
|
20
|
+
* @param {string} [runId] - The unique identifier of the run to subscribe to
|
|
21
|
+
* @param {UseRealtimeRunOptions} [options] - Configuration options for the subscription
|
|
22
|
+
* @returns {UseRealtimeRunInstance<TTask>} An object containing the current state of the run, error handling, and control methods
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```ts
|
|
26
|
+
* import type { myTask } from './path/to/task';
|
|
27
|
+
* const { run, error } = useRealtimeRun<typeof myTask>('run-id-123');
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
export declare function useRealtimeRun<TTask extends AnyTask>(runId?: string, options?: UseRealtimeRunOptions): UseRealtimeRunInstance<TTask>;
|
|
31
|
+
export type StreamResults<TStreams extends Record<string, any>> = {
|
|
32
|
+
[K in keyof TStreams]: Array<TStreams[K]>;
|
|
33
|
+
};
|
|
34
|
+
export type UseRealtimeRunWithStreamsInstance<TTask extends AnyTask = AnyTask, TStreams extends Record<string, any> = Record<string, any>> = {
|
|
35
|
+
run: RealtimeRun<TTask> | undefined;
|
|
36
|
+
streams: StreamResults<TStreams>;
|
|
37
|
+
error: Error | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* Abort the current request immediately, keep the generated tokens if any.
|
|
40
|
+
*/
|
|
41
|
+
stop: () => void;
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Hook to subscribe to realtime updates of a task run with associated data streams.
|
|
45
|
+
*
|
|
46
|
+
* @template TTask - The type of the task
|
|
47
|
+
* @template TStreams - The type of the streams data
|
|
48
|
+
* @param {string} [runId] - The unique identifier of the run to subscribe to
|
|
49
|
+
* @param {UseRealtimeRunOptions} [options] - Configuration options for the subscription
|
|
50
|
+
* @returns {UseRealtimeRunWithStreamsInstance<TTask, TStreams>} An object containing the current state of the run, streams data, and error handling
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```ts
|
|
54
|
+
* import type { myTask } from './path/to/task';
|
|
55
|
+
* const { run, streams, error } = useRealtimeRunWithStreams<typeof myTask, {
|
|
56
|
+
* output: string;
|
|
57
|
+
* }>('run-id-123');
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
export declare function useRealtimeRunWithStreams<TTask extends AnyTask = AnyTask, TStreams extends Record<string, any> = Record<string, any>>(runId?: string, options?: UseRealtimeRunOptions): UseRealtimeRunWithStreamsInstance<TTask, TStreams>;
|
|
61
|
+
export type UseRealtimeRunsInstance<TTask extends AnyTask = AnyTask> = {
|
|
62
|
+
runs: RealtimeRun<TTask>[];
|
|
63
|
+
error: Error | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* Abort the current request immediately.
|
|
66
|
+
*/
|
|
67
|
+
stop: () => void;
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Hook to subscribe to realtime updates of task runs filtered by tag(s).
|
|
71
|
+
*
|
|
72
|
+
* @template TTask - The type of the task
|
|
73
|
+
* @param {string | string[]} tag - The tag or array of tags to filter runs by
|
|
74
|
+
* @param {UseRealtimeRunOptions} [options] - Configuration options for the subscription
|
|
75
|
+
* @returns {UseRealtimeRunsInstance<TTask>} An object containing the current state of the runs and any error encountered
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* import type { myTask } from './path/to/task';
|
|
80
|
+
* const { runs, error } = useRealtimeRunsWithTag<typeof myTask>('my-tag');
|
|
81
|
+
* // Or with multiple tags
|
|
82
|
+
* const { runs, error } = useRealtimeRunsWithTag<typeof myTask>(['tag1', 'tag2']);
|
|
83
|
+
* ```
|
|
84
|
+
*/
|
|
85
|
+
export declare function useRealtimeRunsWithTag<TTask extends AnyTask>(tag: string | string[], options?: UseRealtimeRunOptions): UseRealtimeRunsInstance<TTask>;
|
|
86
|
+
/**
|
|
87
|
+
* Hook to subscribe to realtime updates of a batch of task runs.
|
|
88
|
+
*
|
|
89
|
+
* @template TTask - The type of the task
|
|
90
|
+
* @param {string} batchId - The unique identifier of the batch to subscribe to
|
|
91
|
+
* @param {UseRealtimeRunOptions} [options] - Configuration options for the subscription
|
|
92
|
+
* @returns {UseRealtimeRunsInstance<TTask>} An object containing the current state of the runs, error handling, and control methods
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* import type { myTask } from './path/to/task';
|
|
97
|
+
* const { runs, error } = useRealtimeBatch<typeof myTask>('batch-id-123');
|
|
98
|
+
* ```
|
|
99
|
+
*/
|
|
100
|
+
export declare function useRealtimeBatch<TTask extends AnyTask>(batchId: string, options?: UseRealtimeRunOptions): UseRealtimeRunsInstance<TTask>;
|