inngest 1.1.0 → 1.2.0
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/README.md +1 -1
- package/components/InngestStepTools.d.ts +18 -2
- package/components/InngestStepTools.d.ts.map +1 -1
- package/components/InngestStepTools.js +41 -4
- package/components/InngestStepTools.js.map +1 -1
- package/landing.d.ts +1 -1
- package/landing.d.ts.map +1 -1
- package/landing.js +1 -1
- package/landing.js.map +1 -1
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/README.md
CHANGED
|
@@ -121,7 +121,7 @@ inngest.send("app/user.signup", {
|
|
|
121
121
|
|
|
122
122
|
- **Fully serverless:** Run background jobs, scheduled functions, and build event-driven systems without any servers, state, or setup
|
|
123
123
|
- **Works with your framework**: Works with [Next.js, Redwood, Express, Cloudflare Pages, Nuxt, Fresh (Deno), and Remix](https://www.inngest.com/docs/sdk/serve?ref=github-inngest-js-readme)
|
|
124
|
-
- **Deploy anywhere**: Keep [deploying to your existing platform](https://www.inngest.com/docs/deploy?ref=github-inngest-js-readme): Vercel, Netlify,
|
|
124
|
+
- **Deploy anywhere**: Keep [deploying to your existing platform](https://www.inngest.com/docs/deploy?ref=github-inngest-js-readme): Vercel, Netlify, Cloudflare, Deno, Digital Ocean, etc.
|
|
125
125
|
- **Use your existing code:** Write functions within your current project and repo
|
|
126
126
|
- **Fully typed**: Event schemas, versioning, and governance out of the box
|
|
127
127
|
- **Observable**: A full UI for managing and inspecting your functions
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Jsonify } from "type-fest";
|
|
2
|
-
import type { ObjectPaths, PartialK, SingleOrArray } from "../helpers/types";
|
|
2
|
+
import type { ObjectPaths, PartialK, SendEventPayload, SingleOrArray } from "../helpers/types";
|
|
3
3
|
import { EventPayload, HashedOp, StepOpCode } from "../types";
|
|
4
4
|
import { Inngest } from "./Inngest";
|
|
5
5
|
export interface TickOp extends HashedOp {
|
|
@@ -25,11 +25,27 @@ export declare const createStepTools: <Events extends Record<string, EventPayloa
|
|
|
25
25
|
* @example
|
|
26
26
|
* ```ts
|
|
27
27
|
* await step.sendEvent("app/user.created", { data: { id: 123 } });
|
|
28
|
+
*
|
|
29
|
+
* await step.sendEvent({ name: "app/user.created", data: { id: 123 } });
|
|
30
|
+
*
|
|
31
|
+
* await step.sendEvent([
|
|
32
|
+
* {
|
|
33
|
+
* name: "app/user.created",
|
|
34
|
+
* data: { id: 123 },
|
|
35
|
+
* },
|
|
36
|
+
* {
|
|
37
|
+
* name: "app/user.feed.created",
|
|
38
|
+
* data: { id: 123 },
|
|
39
|
+
* },
|
|
40
|
+
* ]);
|
|
28
41
|
* ```
|
|
29
42
|
*
|
|
30
43
|
* Returns a promise that will resolve once the event has been sent.
|
|
31
44
|
*/
|
|
32
|
-
sendEvent:
|
|
45
|
+
sendEvent: {
|
|
46
|
+
<Payload extends SendEventPayload<Events>>(payload: Payload): Promise<void>;
|
|
47
|
+
<Event_1 extends keyof Events & string>(name: Event_1, payload: SingleOrArray<PartialK<Omit<Events[Event_1], "v" | "name">, "ts">>): Promise<void>;
|
|
48
|
+
};
|
|
33
49
|
/**
|
|
34
50
|
* Wait for a particular event to be received before continuing. When the
|
|
35
51
|
* event is received, it will be returned.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InngestStepTools.d.ts","sourceRoot":"","sources":["../../src/components/InngestStepTools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"InngestStepTools.d.ts","sourceRoot":"","sources":["../../src/components/InngestStepTools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,KAAK,EACV,WAAW,EACX,QAAQ,EACR,gBAAgB,EAChB,aAAa,EAEd,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAM,UAAU,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,WAAW,MAAO,SAAQ,QAAQ;IACtC,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;IACjD,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe;IAyKxB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;;sEAIE,QAAQ,IAAI,CAAC;6IAMb,QAAQ,IAAI,CAAC;;IA8ClB;;;;;;;;OAQG;;;;;;IA6DH;;;;;;;;;;;OAWG;0BAEgB,GAAG,QAMZ,MAAM;IA+BhB;;;;;;;;;OASG;kBAMO,MAAM,GAAG,MAAM,KAClB,QAAQ,IAAI,CAAC;IAYpB;;;;;OAKG;uBAMO,IAAI,GAAG,MAAM,KAChB,QAAQ,IAAI,CAAC;;IAjZpB;;OAEG;iBACU,OAAO,MAAM,EAAE,MAAM,CAAC;IAEnC;;;OAGG;aACM,OAAO,MAAM,EAAE,MAAM,CAAC;IAE/B;;;;;;;;OAQG;kBACW,OAAO,MAAM,EAAE,MAAM,CAAC;IAEpC;;;OAGG;eACQ,MAAM,GAAG,SAAS;IAE7B;;;OAGG;6BACqB,GAAG,EAAE,KAAK,GAAG;IAErC;;;;;;;OAOG;kBACW,OAAO;IAErB;;;OAGG;WACI,MAAM,IAAI;EA6XpB,CAAC;AAEF;;;GAGG;AACH,UAAU,gBAAgB,CACxB,eAAe,SAAS,YAAY,EACpC,aAAa,SAAS,YAAY;IAElC;;;;;;;;;OASG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;IAElE;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,UAAU,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IACjC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAMF;;GAEG;AACH,eAAO,MAAM,UAAU;mBAPD,UAAU,KAAG,MAAM;CAOH,CAAC"}
|
|
@@ -113,17 +113,54 @@ const createStepTools = (client) => {
|
|
|
113
113
|
* @example
|
|
114
114
|
* ```ts
|
|
115
115
|
* await step.sendEvent("app/user.created", { data: { id: 123 } });
|
|
116
|
+
*
|
|
117
|
+
* await step.sendEvent({ name: "app/user.created", data: { id: 123 } });
|
|
118
|
+
*
|
|
119
|
+
* await step.sendEvent([
|
|
120
|
+
* {
|
|
121
|
+
* name: "app/user.created",
|
|
122
|
+
* data: { id: 123 },
|
|
123
|
+
* },
|
|
124
|
+
* {
|
|
125
|
+
* name: "app/user.feed.created",
|
|
126
|
+
* data: { id: 123 },
|
|
127
|
+
* },
|
|
128
|
+
* ]);
|
|
116
129
|
* ```
|
|
117
130
|
*
|
|
118
131
|
* Returns a promise that will resolve once the event has been sent.
|
|
119
132
|
*/
|
|
120
|
-
sendEvent: createTool((
|
|
133
|
+
sendEvent: createTool((nameOrPayload, maybePayload) => {
|
|
134
|
+
var _a;
|
|
135
|
+
let payloads;
|
|
136
|
+
if (typeof nameOrPayload === "string") {
|
|
137
|
+
/**
|
|
138
|
+
* Add our payloads and ensure they all have a name.
|
|
139
|
+
*/
|
|
140
|
+
payloads = (Array.isArray(maybePayload)
|
|
141
|
+
? maybePayload
|
|
142
|
+
: maybePayload
|
|
143
|
+
? [maybePayload]
|
|
144
|
+
: []).map((payload) => (Object.assign(Object.assign({}, payload), { name: nameOrPayload })));
|
|
145
|
+
}
|
|
146
|
+
else {
|
|
147
|
+
/**
|
|
148
|
+
* Grab our payloads straight from the args.
|
|
149
|
+
*/
|
|
150
|
+
payloads = (Array.isArray(nameOrPayload)
|
|
151
|
+
? nameOrPayload
|
|
152
|
+
: nameOrPayload
|
|
153
|
+
? [nameOrPayload]
|
|
154
|
+
: []);
|
|
155
|
+
}
|
|
121
156
|
return {
|
|
122
157
|
op: types_1.StepOpCode.StepPlanned,
|
|
123
|
-
name,
|
|
158
|
+
name: ((_a = payloads[0]) === null || _a === void 0 ? void 0 : _a.name) || "sendEvent",
|
|
124
159
|
};
|
|
125
|
-
}, (
|
|
126
|
-
return client.send(
|
|
160
|
+
}, (nameOrPayload, maybePayload) => {
|
|
161
|
+
return client.send(nameOrPayload,
|
|
162
|
+
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
163
|
+
maybePayload);
|
|
127
164
|
}),
|
|
128
165
|
/**
|
|
129
166
|
* Wait for a particular event to be received before continuing. When the
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"InngestStepTools.js","sourceRoot":"","sources":["../../src/components/InngestStepTools.ts"],"names":[],"mappings":";;;;;;AAAA,qCAA+B;AAC/B,gGAAqD;AAErD,gDAA6C;
|
|
1
|
+
{"version":3,"file":"InngestStepTools.js","sourceRoot":"","sources":["../../src/components/InngestStepTools.ts"],"names":[],"mappings":";;;;;;AAAA,qCAA+B;AAC/B,gGAAqD;AAErD,gDAA6C;AAQ7C,oCAAkE;AAUlE;;;;;;;GAOG;AACI,MAAM,eAAe,GAAG,CAI7B,MAAuB,EACvB,EAAE;IACF,MAAM,KAAK,GAkDP;QACF,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,YAAY,EAAE,EAAE;QAChB,SAAS,EAAE,SAAS;QACpB,YAAY,EAAE,KAAK;QACnB,KAAK,EAAE,GAAG,EAAE;YACV,KAAK,CAAC,YAAY,GAAG,EAAE,CAAC;YACxB,KAAK,CAAC,WAAW,mCAAQ,KAAK,CAAC,WAAW,GAAK,KAAK,CAAC,OAAO,CAAE,CAAC;QACjE,CAAC;KACF,CAAC;IAEF,+BAA+B;IAC/B,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC;IAElC;;;;OAIG;IACH,MAAM,MAAM,GAAG;IACb;;;OAGG;IACH,EAAM,EACI,EAAE;;QACZ,MAAM,GAAG,GAAG;YACV,MAAM,EAAE,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,EAAE,mCAAI,IAAI;YACnC,EAAE,EAAE,EAAE,CAAC,EAAE;YACT,IAAI,EAAE,EAAE,CAAC,IAAI;YACb,mEAAmE;YACnE,IAAI,EAAE,MAAA,EAAE,CAAC,IAAI,mCAAI,IAAI;SACtB,CAAC;QAEF,MAAM,aAAa,GAAG,kBAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAE/C,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC;YAC5C,CAAC,MAAA,KAAK,CAAC,YAAY,CAAC,aAAa,CAAC,mCAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEjD,uCACK,EAAE,KACL,EAAE,EAAE,kBAAU,CAAC,QAAQ,iBAAG,GAAG,IAAK,GAAG,EAAG,IACxC;IACJ,CAAC,CAAC;IAEF;;;;;OAKG;IACH,MAAM,UAAU,GAAG;IACjB;;;;;;;;OAQG;IACH,OAK+B;IAE/B;;;;;;;;;;;;;;;;OAgBG;IACH,EAAoC,EACjC,EAAE;QACL,OAAO,CAAC,CAAC,GAAG,IAAmB,EAAgB,EAAE;YAC/C,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;YAE1B,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YAEtC,OAAO,IAAI,OAAO,CAAM,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC1C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,iDACjB,IAAI,GAEJ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,KACxC,OAAO;oBACP,MAAM,EACN,SAAS,EAAE,KAAK,GACjB,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAM,CAAC;IACV,CAAC,CAAC;IAEF;;;;;OAKG;IACH,MAAM,KAAK,GAAG;QACZ;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,EAAE,UAAU,CAWnB,CAAC,aAAa,EAAE,YAAY,EAAE,EAAE;;YAC9B,IAAI,QAA2B,CAAC;YAEhC,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE;gBACrC;;mBAEG;gBACH,QAAQ,GAAG,CACT,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC;oBACzB,CAAC,CAAC,YAAY;oBACd,CAAC,CAAC,YAAY;wBACd,CAAC,CAAC,CAAC,YAAY,CAAC;wBAChB,CAAC,CAAC,EAAE,CACP,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCACd,OAAO,KACV,IAAI,EAAE,aAAa,IACnB,CAAoB,CAAC;aACxB;iBAAM;gBACL;;mBAEG;gBACH,QAAQ,GAAG,CACT,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;oBAC1B,CAAC,CAAC,aAAa;oBACf,CAAC,CAAC,aAAa;wBACf,CAAC,CAAC,CAAC,aAAa,CAAC;wBACjB,CAAC,CAAC,EAAE,CACY,CAAC;aACtB;YAED,OAAO;gBACL,EAAE,EAAE,kBAAU,CAAC,WAAW;gBAC1B,IAAI,EAAE,CAAA,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,IAAI,KAAI,WAAW;aACvC,CAAC;QACJ,CAAC,EACD,CAAC,aAAa,EAAE,YAAY,EAAE,EAAE;YAC9B,OAAO,MAAM,CAAC,IAAI,CAChB,aAAoB;YACpB,iEAAiE;YACjE,YAA8B,CAC/B,CAAC;QACJ,CAAC,CACF;QAED;;;;;;;;WAQG;QACH,YAAY,EAAE,UAAU,CA6BtB;QACE;;WAEG;QACH,KAAK;QAEL;;WAEG;QACH,IAAyC,EACzC,EAAE;YACF,MAAM,SAAS,GAAqC;gBAClD,OAAO,EAAE,IAAA,iBAAO,EAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;aACjE,CAAC;YAEF,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;gBAC5B,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,EAAE;oBACf,SAAS,CAAC,EAAE,GAAG,SAAS,IAAI,CAAC,KAAK,aAAa,IAAI,CAAC,KAAK,EAAE,CAAC;iBAC7D;qBAAM,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,EAAE;oBACnB,SAAS,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;iBACxB;aACF;YAED,OAAO;gBACL,EAAE,EAAE,kBAAU,CAAC,YAAY;gBAC3B,IAAI,EAAE,KAAe;gBACrB,IAAI,EAAE,SAAS;aAChB,CAAC;QACJ,CAAC,CACF;QAED;;;;;;;;;;;WAWG;QACH,GAAG,EAAE,UAAU,CA4Bb,CAAC,IAAI,EAAE,EAAE;YACP,OAAO;gBACL,EAAE,EAAE,kBAAU,CAAC,WAAW;gBAC1B,IAAI;aACL,CAAC;QACJ,CAAC;QACD,+DAA+D;QAC/D,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAChB;QAED;;;;;;;;;WASG;QACH,KAAK,EAAE,UAAU,CAOf,CAAC,IAAI,EAAE,EAAE;YACT;;;eAGG;YACH,OAAO;gBACL,EAAE,EAAE,kBAAU,CAAC,KAAK;gBACpB,IAAI,EAAE,IAAA,iBAAO,EAAC,IAAI,CAAC;aACpB,CAAC;QACJ,CAAC,CAAC;QAEF;;;;;WAKG;QACH,UAAU,EAAE,UAAU,CAOpB,CAAC,IAAI,EAAE,EAAE;YACT,MAAM,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAE9D;;;eAGG;YACH,IAAI;gBACF,OAAO;oBACL,EAAE,EAAE,kBAAU,CAAC,KAAK;oBACpB,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE;iBACzB,CAAC;aACH;YAAC,OAAO,GAAG,EAAE;gBACZ;;;mBAGG;gBACH,OAAO,CAAC,IAAI,CAAC,mDAAmD,EAAE,GAAG,CAAC,CAAC;gBAEvE,MAAM,IAAI,KAAK,CACb,qDAAqD,IAAI,CAAC,QAAQ,EAAE,EAAE,CACvE,CAAC;aACH;QACH,CAAC,CAAC;KACH,CAAC;IAEF,OAAO,CAAC,KAAK,EAAE,KAAK,CAAiC,CAAC;AACxD,CAAC,CAAC;AApbW,QAAA,eAAe,mBAob1B;AAyEF,MAAM,QAAQ,GAAG,CAAC,EAAc,EAAU,EAAE;IAC1C,OAAO,IAAA,cAAI,GAAE,CAAC,MAAM,CAAC,IAAA,sCAAS,EAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF;;GAEG;AACU,QAAA,UAAU,GAAG,EAAE,QAAQ,EAAE,CAAC"}
|