inngest 0.4.0-beta.2 → 0.4.0-beta.3

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.
@@ -7,6 +7,22 @@ import { InngestFunction } from "./InngestFunction";
7
7
  *
8
8
  * To provide event typing, make sure to pass in your generated event types as
9
9
  * the first generic.
10
+ *
11
+ * @example
12
+ *
13
+ * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
14
+ *
15
+ * // or to provide custom events too
16
+ * const inngest = new Inngest<
17
+ * Events & {
18
+ * "demo/event.blah": {
19
+ * name: "demo/event.blah";
20
+ * data: {
21
+ * bar: boolean;
22
+ * };
23
+ * };
24
+ * }
25
+ * >("My App", process.env.INNGEST_API_KEY);
10
26
  */
11
27
  export declare class Inngest<Events extends Record<string, InngestT.EventPayload>> {
12
28
  #private;
@@ -33,6 +49,29 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
33
49
  * @link https://npm.im/axios
34
50
  */
35
51
  private readonly client;
52
+ /**
53
+ * A client used to interact with the Inngest API by sending or reacting to
54
+ * events.
55
+ *
56
+ * To provide event typing, make sure to pass in your generated event types as
57
+ * the first generic.
58
+ *
59
+ * @example
60
+ *
61
+ * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
62
+ *
63
+ * // or to provide custom events too
64
+ * const inngest = new Inngest<
65
+ * Events & {
66
+ * "demo/event.blah": {
67
+ * name: "demo/event.blah";
68
+ * data: {
69
+ * bar: boolean;
70
+ * };
71
+ * };
72
+ * }
73
+ * >("My App", process.env.INNGEST_API_KEY);
74
+ */
36
75
  constructor(
37
76
  /**
38
77
  * The name of this instance, most commonly the name of the application it
@@ -44,14 +83,55 @@ export declare class Inngest<Events extends Record<string, InngestT.EventPayload
44
83
  */
45
84
  eventKey: string, { inngestBaseUrl }?: InngestT.ClientOptions);
46
85
  /**
47
- * Send event(s) to Inngest
86
+ * Send one or many events to Inngest. Takes a known event from this Inngest
87
+ * instance based on the given `name`.
88
+ *
89
+ * Returns a promise that will resolve if the event(s) were sent successfully,
90
+ * else throws with an error explaining what went wrong.
91
+ *
92
+ * If you wish to send an event with custom types (i.e. one that hasn't been
93
+ * generated), make sure to add it when creating your Inngest instance, like
94
+ * so:
95
+ *
96
+ * @example
97
+ *
98
+ * const inngest = new Inngest<Events & {
99
+ * "my/event": {
100
+ * name: "my/event";
101
+ * data: { bar: string; };
102
+ * }
103
+ * }>("My App", "API_KEY");
48
104
  */
49
- send<Event extends keyof Events>(name: Event, payload: Omit<Events[Event], "name"> | Omit<Events[Event], "name">[]): Promise<boolean>;
105
+ send<Event extends keyof Events>(name: Event, payload: Omit<Events[Event], "name"> | Omit<Events[Event], "name">[]): Promise<void>;
50
106
  /**
51
107
  * Given an event to listen to, run the given function when that event is
52
108
  * seen.
53
109
  */
54
- createFunction<Event extends keyof Events, Fn extends InngestT.StepFn<Events[Event], string, "step">>(name: string, event: Event, fn: Fn): InngestFunction<Events>;
55
- createFunction<Event extends keyof Events, Fn extends InngestT.StepFn<Events[Event], string, "step">>(opts: InngestT.FunctionOptions, event: Event, fn: Fn): InngestFunction<Events>;
110
+ createFunction<Event extends keyof Events, Fn extends InngestT.StepFn<Events[Event], string, "step">>(
111
+ /**
112
+ * The name of this function as it will appear in the Inngst Cloud UI.
113
+ */
114
+ name: string,
115
+ /**
116
+ * The event to listen for.
117
+ */
118
+ event: Event,
119
+ /**
120
+ * The function to run when the event is received.
121
+ */
122
+ fn: Fn): InngestFunction<Events>;
123
+ createFunction<Event extends keyof Events, Fn extends InngestT.StepFn<Events[Event], string, "step">>(
124
+ /**
125
+ * Options for this Inngest function - useful for defining a custom ID.
126
+ */
127
+ opts: InngestT.FunctionOptions,
128
+ /**
129
+ * The event to listen for.
130
+ */
131
+ event: Event,
132
+ /**
133
+ * The function to run when the event is received.
134
+ */
135
+ fn: Fn): InngestFunction<Events>;
56
136
  }
57
137
  //# sourceMappingURL=Inngest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Inngest.d.ts","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;;;GAMG;AACH,qBAAa,OAAO,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC;;IACvE;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC;;OAEG;IACH,SAAgB,cAAc,EAAE,GAAG,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAM;IAEpC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;;IAGrC;;;OAGG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,EAChB,EAAE,cAAkC,EAAE,GAAE,QAAQ,CAAC,aAAkB;IA4DrE;;OAEG;IACU,IAAI,CAAC,KAAK,SAAS,MAAM,MAAM,EAC1C,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,EAAE,GACnE,OAAO,CAAC,OAAO,CAAC;IAanB;;;OAGG;IACI,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,EAAE,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EACzD,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,GAAG,eAAe,CAAC,MAAM,CAAC;IACvD,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,EAAE,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAEzD,IAAI,EAAE,QAAQ,CAAC,eAAe,EAC9B,KAAK,EAAE,KAAK,EACZ,EAAE,EAAE,EAAE,GACL,eAAe,CAAC,MAAM,CAAC;CAiB3B"}
1
+ {"version":3,"file":"Inngest.d.ts","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,OAAO,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC;;IACvE;;;OAGG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC;;OAEG;IACH,SAAgB,cAAc,EAAE,GAAG,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAM;IAEpC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;;;;;;;;;;;;;;;;;;;;OAsBG;;IAED;;;OAGG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,EAChB,EAAE,cAAkC,EAAE,GAAE,QAAQ,CAAC,aAAkB;IA+DrE;;;;;;;;;;;;;;;;;;;OAmBG;IACU,IAAI,CAAC,KAAK,SAAS,MAAM,MAAM,EAC1C,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,EAAE,GACnE,OAAO,CAAC,IAAI,CAAC;IAahB;;;OAGG;IACI,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,EAAE,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;IAEzD;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,EAAE,EAAE,EAAE,GACL,eAAe,CAAC,MAAM,CAAC;IACnB,cAAc,CACnB,KAAK,SAAS,MAAM,MAAM,EAC1B,EAAE,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;IAEzD;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC,eAAe;IAE9B;;OAEG;IACH,KAAK,EAAE,KAAK;IAEZ;;OAEG;IACH,EAAE,EAAE,EAAE,GACL,eAAe,CAAC,MAAM,CAAC;CAiB3B"}
@@ -11,6 +11,7 @@ var _Inngest_instances, _Inngest_getResponseError;
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
12
  exports.Inngest = void 0;
13
13
  const axios_1 = __importDefault(require("axios"));
14
+ const version_1 = require("../version");
14
15
  const InngestFunction_1 = require("./InngestFunction");
15
16
  const InngestStep_1 = require("./InngestStep");
16
17
  /**
@@ -19,8 +20,47 @@ const InngestStep_1 = require("./InngestStep");
19
20
  *
20
21
  * To provide event typing, make sure to pass in your generated event types as
21
22
  * the first generic.
23
+ *
24
+ * @example
25
+ *
26
+ * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
27
+ *
28
+ * // or to provide custom events too
29
+ * const inngest = new Inngest<
30
+ * Events & {
31
+ * "demo/event.blah": {
32
+ * name: "demo/event.blah";
33
+ * data: {
34
+ * bar: boolean;
35
+ * };
36
+ * };
37
+ * }
38
+ * >("My App", process.env.INNGEST_API_KEY);
22
39
  */
23
40
  class Inngest {
41
+ /**
42
+ * A client used to interact with the Inngest API by sending or reacting to
43
+ * events.
44
+ *
45
+ * To provide event typing, make sure to pass in your generated event types as
46
+ * the first generic.
47
+ *
48
+ * @example
49
+ *
50
+ * const inngest = new Inngest<Events>("My App", process.env.INNGEST_API_KEY);
51
+ *
52
+ * // or to provide custom events too
53
+ * const inngest = new Inngest<
54
+ * Events & {
55
+ * "demo/event.blah": {
56
+ * name: "demo/event.blah";
57
+ * data: {
58
+ * bar: boolean;
59
+ * };
60
+ * };
61
+ * }
62
+ * >("My App", process.env.INNGEST_API_KEY);
63
+ */
24
64
  constructor(
25
65
  /**
26
66
  * The name of this instance, most commonly the name of the application it
@@ -46,19 +86,36 @@ class Inngest {
46
86
  timeout: 0,
47
87
  headers: {
48
88
  "Content-Type": "application/json",
49
- "User-Agent": "InngestJS 0.1.0",
89
+ "User-Agent": `InngestJS v${version_1.version}`,
50
90
  },
51
91
  validateStatus: () => true,
52
92
  maxRedirects: 0,
53
93
  });
54
94
  }
55
95
  /**
56
- * Send event(s) to Inngest
96
+ * Send one or many events to Inngest. Takes a known event from this Inngest
97
+ * instance based on the given `name`.
98
+ *
99
+ * Returns a promise that will resolve if the event(s) were sent successfully,
100
+ * else throws with an error explaining what went wrong.
101
+ *
102
+ * If you wish to send an event with custom types (i.e. one that hasn't been
103
+ * generated), make sure to add it when creating your Inngest instance, like
104
+ * so:
105
+ *
106
+ * @example
107
+ *
108
+ * const inngest = new Inngest<Events & {
109
+ * "my/event": {
110
+ * name: "my/event";
111
+ * data: { bar: string; };
112
+ * }
113
+ * }>("My App", "API_KEY");
57
114
  */
58
115
  async send(name, payload) {
59
116
  const response = await this.client.post(this.inngestApiUrl.href, Object.assign(Object.assign({}, payload), { name }));
60
117
  if (response.status >= 200 && response.status < 300) {
61
- return true;
118
+ return;
62
119
  }
63
120
  throw __classPrivateFieldGet(this, _Inngest_instances, "m", _Inngest_getResponseError).call(this, response);
64
121
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Inngest.js","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA4D;AAE5D,uDAAoD;AACpD,+CAA4C;AAE5C;;;;;;GAMG;AACH,MAAa,OAAO;IA6BlB;IACE;;;OAGG;IACH,IAAY;IAEZ;;OAEG;IACH,QAAgB,EAChB,EAAE,cAAc,GAAG,iBAAiB,KAA6B,EAAE;;QAEnE,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QAED,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;SACH;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAExE,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,iBAAiB;aAChC;YACD,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;YAC1B,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;IAkCD;;OAEG;IACI,KAAK,CAAC,IAAI,CACf,IAAW,EACX,OAAoE;QAEpE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,kCAC1D,OAAO,KACV,IAAI,IACJ,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;YACnD,OAAO,IAAI,CAAC;SACb;QAED,MAAM,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,EAAmB,QAAQ,CAAC,CAAC;IACzC,CAAC;IAkBM,cAAc,CAInB,UAA6C,EAC7C,KAAY,EACZ,EAAM;QAEN,OAAO,IAAI,iCAAe,CACxB,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,EAClE,KAAK,EACL;YACE,IAAI,EAAE,IAAI,yBAAW,CAAC,EAAE,CAAC;SAC1B,CACF,CAAC;IACJ,CAAC;CACF;AAvJD,0BAuJC;mGAnFmB,QAAuB;IACvC,IAAI,YAAY,GAAG,eAAe,CAAC;IACnC,QAAQ,QAAQ,CAAC,MAAM,EAAE;QACvB,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,8BAA8B,CAAC;YAC9C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,WAAW,CAAC;YAC3B,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,MAAM;QACR,KAAK,GAAG,CAAC;QACT,KAAK,GAAG;YACN,YAAY,GAAG,6BAA6B,CAAC;YAC7C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,yBAAyB,CAAC;YACzC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,uBAAuB,CAAC;YACvC,MAAM;KACT;IACD,OAAO,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC,CAAC;AAC5E,CAAC"}
1
+ {"version":3,"file":"Inngest.js","sourceRoot":"","sources":["../../src/components/Inngest.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,kDAA4D;AAE5D,wCAAqC;AACrC,uDAAoD;AACpD,+CAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,OAAO;IA6BlB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH;IACE;;;OAGG;IACH,IAAY;IAEZ;;OAEG;IACH,QAAgB,EAChB,EAAE,cAAc,GAAG,iBAAiB,KAA6B,EAAE;;QAEnE,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;SACzE;QAED,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;SACH;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAExE,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,cAAc,iBAAO,EAAE;aACtC;YACD,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;YAC1B,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;IAqCD;;;;;;;;;;;;;;;;;;;OAmBG;IACI,KAAK,CAAC,IAAI,CACf,IAAW,EACX,OAAoE;QAEpE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,kCAC1D,OAAO,KACV,IAAI,IACJ,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;YACnD,OAAO;SACR;QAED,MAAM,uBAAA,IAAI,qDAAkB,MAAtB,IAAI,EAAmB,QAAQ,CAAC,CAAC;IACzC,CAAC;IA4CM,cAAc,CAInB,UAA6C,EAC7C,KAAY,EACZ,EAAM;QAEN,OAAO,IAAI,iCAAe,CACxB,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,EAClE,KAAK,EACL;YACE,IAAI,EAAE,IAAI,yBAAW,CAAC,EAAE,CAAC;SAC1B,CACF,CAAC;IACJ,CAAC;CACF;AA5ND,0BA4NC;mGA9HmB,QAAuB;IACvC,IAAI,YAAY,GAAG,eAAe,CAAC;IACnC,QAAQ,QAAQ,CAAC,MAAM,EAAE;QACvB,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,8BAA8B,CAAC;YAC9C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,WAAW,CAAC;YAC3B,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,qBAAqB,CAAC;YACrC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,MAAM;QACR,KAAK,GAAG,CAAC;QACT,KAAK,GAAG;YACN,YAAY,GAAG,6BAA6B,CAAC;YAC7C,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,yBAAyB,CAAC;YACzC,MAAM;QACR,KAAK,GAAG;YACN,YAAY,GAAG,uBAAuB,CAAC;YACvC,MAAM;KACT;IACD,OAAO,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC,CAAC;AAC5E,CAAC"}
@@ -1,7 +1,7 @@
1
1
  /// <reference types="node" />
2
2
  import { Inngest } from "../components/Inngest";
3
3
  import { InngestFunction } from "../components/InngestFunction";
4
- import { ClientOptions, EventPayload, FunctionConfig, RegisterPingResponse, StepRunResponse } from "../types";
4
+ import { EventPayload, FunctionConfig, RegisterOptions, RegisterPingResponse, StepRunResponse } from "../types";
5
5
  /**
6
6
  * A handler for registering Inngest functions. This type should be used
7
7
  * whenever a handler for a new framework is being added to enforce that the
@@ -19,7 +19,7 @@ nameOrInngest: string | Inngest<any>,
19
19
  *
20
20
  * @link TODO
21
21
  */
22
- signingKey: string, functions: InngestFunction<any>[], opts?: ClientOptions) => any;
22
+ signingKey: string, functions: InngestFunction<any>[], opts?: RegisterOptions) => any;
23
23
  /**
24
24
  * Register any declared functions with Inngest, making them available to be
25
25
  * triggered by events.
@@ -29,7 +29,7 @@ signingKey: string, functions: InngestFunction<any>[], opts?: ClientOptions) =>
29
29
  *
30
30
  * @link TODO
31
31
  */
32
- export declare const register: <Events extends Record<string, EventPayload>>(...args: [nameOrInngest: string | Inngest<Events>, signingKey: string, functions: InngestFunction<Events>[], opts?: ClientOptions | undefined] | [commHandler: InngestCommHandler]) => any;
32
+ export declare const register: <Events extends Record<string, EventPayload>>(...args: [nameOrInngest: string | Inngest<Events>, signingKey: string, functions: InngestFunction<Events>[], opts?: RegisterOptions | undefined] | [commHandler: InngestCommHandler]) => any;
33
33
  /**
34
34
  * TODO Instead of `createHandler`, expose `createRequest` and `handleResponse`
35
35
  *
@@ -44,13 +44,11 @@ export declare const register: <Events extends Record<string, EventPayload>>(...
44
44
  * `handleResponse()`
45
45
  * The input is a `StepResponse`, and output can be anything needed for the
46
46
  * platform
47
+ *
48
+ * This needs to also account for the ability to validate signatures etc.
47
49
  */
48
50
  export declare class InngestCommHandler {
49
51
  name: string;
50
- /**
51
- * Base URL for Inngest Cloud.
52
- */
53
- private readonly inngestBaseUrl;
54
52
  /**
55
53
  * The URL of the Inngest function registration endpoint.
56
54
  */
@@ -68,7 +66,7 @@ export declare class InngestCommHandler {
68
66
  * used to find and register functions when interacting with Inngest Cloud.
69
67
  */
70
68
  private readonly fns;
71
- constructor(nameOrInngest: string | Inngest<any>, signingKey: string, functions: InngestFunction<any>[], { inngestBaseUrl }?: ClientOptions);
69
+ constructor(nameOrInngest: string | Inngest<any>, signingKey: string, functions: InngestFunction<any>[], { inngestRegisterUrl }?: RegisterOptions);
72
70
  createHandler(): any;
73
71
  protected runStep(functionId: string, stepId: string, data: any): Promise<StepRunResponse>;
74
72
  protected configs(url: URL): FunctionConfig[];
@@ -1 +1 @@
1
- {"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../src/handlers/default.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EACL,aAAa,EACb,YAAY,EACZ,cAAc,EACd,oBAAoB,EACpB,eAAe,EAChB,MAAM,UAAU,CAAC;AAGlB;;;;GAIG;AACH,oBAAY,eAAe,GAAG;AAC5B;;;GAGG;AACH,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;AAEpC;;;;;GAKG;AACH,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,IAAI,CAAC,EAAE,aAAa,KACjB,GAAG,CAAC;AAET;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,0OAkBpB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,kBAAkB;IACtB,IAAI,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAM;IAErC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAM;IAEzC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAa;IACrD,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA4C;gBAG9D,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,EACpC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,EAAE,cAAc,EAAE,GAAE,aAAkB;IA0CjC,aAAa,IAAI,GAAG;cAgDX,OAAO,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,eAAe,CAAC;IA8B3B,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc,EAAE;cAI7B,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BjD,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,oBAAoB;IAW9C,SAAS,CAAC,iBAAiB,IAAI,OAAO;IAItC,SAAS,CAAC,YAAY,IAAI,MAAM;CAGjC"}
1
+ {"version":3,"file":"default.d.ts","sourceRoot":"","sources":["../../src/handlers/default.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAEhE,OAAO,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,oBAAoB,EACpB,eAAe,EAChB,MAAM,UAAU,CAAC;AAGlB;;;;GAIG;AACH,oBAAY,eAAe,GAAG;AAC5B;;;GAGG;AACH,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;AAEpC;;;;;GAKG;AACH,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,IAAI,CAAC,EAAE,eAAe,KACnB,GAAG,CAAC;AAET;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,4OAkBpB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,kBAAkB;IACtB,IAAI,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAM;IAEzC,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAa;IACrD,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA4C;gBAG9D,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,EACpC,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,eAAe,CAAC,GAAG,CAAC,EAAE,EACjC,EAAE,kBAAkB,EAAE,GAAE,eAAoB;IAsCvC,aAAa,IAAI,GAAG;cAgDX,OAAO,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,eAAe,CAAC;IA8B3B,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,GAAG,cAAc,EAAE;cAI7B,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BjD,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,oBAAoB;IAW9C,SAAS,CAAC,iBAAiB,IAAI,OAAO;IAItC,SAAS,CAAC,YAAY,IAAI,MAAM;CAGjC"}
@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.InngestCommHandler = exports.register = void 0;
7
7
  const axios_1 = __importDefault(require("axios"));
8
8
  const zod_1 = require("zod");
9
- const Inngest_1 = require("../components/Inngest");
10
9
  const consts_1 = require("../helpers/consts");
11
10
  const version_1 = require("../version");
12
11
  /**
@@ -41,9 +40,11 @@ exports.register = register;
41
40
  * `handleResponse()`
42
41
  * The input is a `StepResponse`, and output can be anything needed for the
43
42
  * platform
43
+ *
44
+ * This needs to also account for the ability to validate signatures etc.
44
45
  */
45
46
  class InngestCommHandler {
46
- constructor(nameOrInngest, signingKey, functions, { inngestBaseUrl } = {}) {
47
+ constructor(nameOrInngest, signingKey, functions, { inngestRegisterUrl } = {}) {
47
48
  this.frameworkName = "default";
48
49
  /**
49
50
  * A private collection of functions that have been registered. This map is
@@ -58,11 +59,7 @@ class InngestCommHandler {
58
59
  }
59
60
  return Object.assign(Object.assign({}, acc), { [fn.id]: fn });
60
61
  }, {});
61
- this.inngestBaseUrl = new URL(inngestBaseUrl ||
62
- (nameOrInngest instanceof Inngest_1.Inngest
63
- ? nameOrInngest.inngestBaseUrl.href
64
- : "https://inn.gs/"));
65
- this.inngestRegisterUrl = new URL("x/register", this.inngestBaseUrl);
62
+ this.inngestRegisterUrl = new URL(inngestRegisterUrl || "https://api.inngest.com/fn/register");
66
63
  this.signingKey = signingKey;
67
64
  this.client = axios_1.default.create({
68
65
  timeout: 0,
@@ -1 +1 @@
1
- {"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/handlers/default.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiE;AAEjE,6BAAwB;AACxB,mDAAgD;AAEhD,8CAA2D;AAQ3D,wCAAqC;AAyBrC;;;;;;;;GAQG;AACI,MAAM,QAAQ,GAAG,CACtB,GAAG,IAOkC,EACrC,EAAE;IACF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;KAChC;IAED,MAAM,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC;IACpD,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAE7E,OAAO,OAAO,CAAC,aAAa,EAAE,CAAC;AACjC,CAAC,CAAC;AAlBW,QAAA,QAAQ,YAkBnB;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAa,kBAAkB;IA6B7B,YACE,aAAoC,EACpC,UAAkB,EAClB,SAAiC,EACjC,EAAE,cAAc,KAAoB,EAAE;QApBrB,kBAAa,GAAW,SAAS,CAAC;QAUrD;;;WAGG;QACc,QAAG,GAAyC,EAAE,CAAC;QAQ9D,IAAI,CAAC,IAAI;YACP,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC;QAEzE,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,MAAM,CACzB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;YACV,IAAI,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;gBACd,MAAM,IAAI,KAAK,CACb,0BAA0B,EAAE,CAAC,EAAE,kFAAkF,CAClH,CAAC;aACH;YAED,uCACK,GAAG,KACN,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,IACX;QACJ,CAAC,EACD,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAC3B,cAAc;YACZ,CAAC,aAAa,YAAY,iBAAO;gBAC/B,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI;gBACnC,CAAC,CAAC,iBAAiB,CAAC,CACzB,CAAC;QAEF,IAAI,CAAC,kBAAkB,GAAG,IAAI,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,cAAc,iBAAO,EAAE;aACtC;YACD,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;YAC1B,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;IAEM,aAAa;QAClB,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;YAC3C,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;YAElD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;YAEtD,QAAQ,GAAG,CAAC,MAAM,EAAE;gBAClB,KAAK,KAAK;oBACR,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;oBACpC,0BAA0B;oBAC1B,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAC5B,OAAO,KAAK,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBAElC,KAAK,KAAK;oBACR,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;oBACpC,yDAAyD;oBACzD,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,MAAM;oBAChC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAClC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO;oBAC5B,OAAO,KAAK,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEhC,KAAK,MAAM;oBACT,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;oBACrC,2DAA2D;oBAC3D,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAC;yBACvB,MAAM,CAAC;wBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;wBACvB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;qBAC1B,CAAC;yBACD,KAAK,CAAC;wBACL,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,kBAAS,CAAC;wBAC1B,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,oBAAW,CAAC;qBAC/B,CAAC,CAAC;oBAEL,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;oBAE3D,IAAI,OAAO,CAAC,MAAM,KAAK,GAAG,EAAE;wBAC1B,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;qBAC5D;oBAED,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAE5D;oBACE,OAAO,KAAK,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aACnC;QACH,CAAC,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,OAAO,CACrB,UAAkB,EAClB,MAAc,EACd,IAAS;QAET,OAAO,CAAC,GAAG,CACT,oBAAoB,EACpB,MAAM,EACN,aAAa,EACb,UAAU,EACV,WAAW,EACX,IAAI,CACL,CAAC;QAEF,IAAI;YACF,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAChC,IAAI,CAAC,EAAE,EAAE;gBACP,MAAM,IAAI,KAAK,CAAC,oCAAoC,UAAU,GAAG,CAAC,CAAC;aACpE;YAED,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAE/C,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,IAAI;aACL,CAAC;SACH;QAAC,OAAO,GAAQ,EAAE;YACjB,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,OAAO;aAChC,CAAC;SACH;IACH,CAAC;IAES,OAAO,CAAC,GAAQ;QACxB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACnE,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,GAAQ;QAC/B,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,GAAG,CAAC,IAAI;YACb,IAAI,EAAE,MAAM;SACb,CAAC;QAEF,MAAM,MAAM,GAAuB;YACjC,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,CAAC,UAAU,EAAE;aAC3C;SACF,CAAC;QAEF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAChC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAC5B,IAAI,EACJ,MAAM,CACP,CAAC;QAEF,OAAO,CAAC,GAAG,CACT,sBAAsB,EACtB,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAC5B,OAAO,EACP,IAAI,EACJ,KAAK,EACL,MAAM,EACN,eAAe,EACf,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,IAAI,CACT,CAAC;IACJ,CAAC;IAES,IAAI,CAAC,GAAQ;QACrB,OAAO;YACL,UAAU,EAAE,MAAM;YAClB,SAAS,EAAE,IAAI,CAAC,aAAa;YAC7B,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAC5B,GAAG,EAAE,OAAO,iBAAO,EAAE;YACrB,CAAC,EAAE,KAAK;SACT,CAAC;IACJ,CAAC;IAES,iBAAiB;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAES,YAAY;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAlND,gDAkNC"}
1
+ {"version":3,"file":"default.js","sourceRoot":"","sources":["../../src/handlers/default.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiE;AAEjE,6BAAwB;AAGxB,8CAA2D;AAQ3D,wCAAqC;AAyBrC;;;;;;;;GAQG;AACI,MAAM,QAAQ,GAAG,CACtB,GAAG,IAOkC,EACrC,EAAE;IACF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;QACrB,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;KAChC;IAED,MAAM,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC;IACpD,MAAM,OAAO,GAAG,IAAI,kBAAkB,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAE7E,OAAO,OAAO,CAAC,aAAa,EAAE,CAAC;AACjC,CAAC,CAAC;AAlBW,QAAA,QAAQ,YAkBnB;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,kBAAkB;IAwB7B,YACE,aAAoC,EACpC,UAAkB,EAClB,SAAiC,EACjC,EAAE,kBAAkB,KAAsB,EAAE;QApB3B,kBAAa,GAAW,SAAS,CAAC;QAUrD;;;WAGG;QACc,QAAG,GAAyC,EAAE,CAAC;QAQ9D,IAAI,CAAC,IAAI;YACP,OAAO,aAAa,KAAK,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC;QAEzE,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC,MAAM,CACzB,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;YACV,IAAI,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE;gBACd,MAAM,IAAI,KAAK,CACb,0BAA0B,EAAE,CAAC,EAAE,kFAAkF,CAClH,CAAC;aACH;YAED,uCACK,GAAG,KACN,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,IACX;QACJ,CAAC,EACD,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,kBAAkB,GAAG,IAAI,GAAG,CAC/B,kBAAkB,IAAI,qCAAqC,CAC5D,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,CAAC;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,YAAY,EAAE,cAAc,iBAAO,EAAE;aACtC;YACD,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;YAC1B,YAAY,EAAE,CAAC;SAChB,CAAC,CAAC;IACL,CAAC;IAEM,aAAa;QAClB,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;YAC3C,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;YAElD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;YAEtD,QAAQ,GAAG,CAAC,MAAM,EAAE;gBAClB,KAAK,KAAK;oBACR,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;oBACpC,0BAA0B;oBAC1B,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAC5B,OAAO,KAAK,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;gBAElC,KAAK,KAAK;oBACR,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;oBACpC,yDAAyD;oBACzD,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,MAAM;oBAChC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBAClC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO;oBAC5B,OAAO,KAAK,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAEhC,KAAK,MAAM;oBACT,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;oBACrC,2DAA2D;oBAC3D,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAC;yBACvB,MAAM,CAAC;wBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;wBACvB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;qBAC1B,CAAC;yBACD,KAAK,CAAC;wBACL,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,kBAAS,CAAC;wBAC1B,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,oBAAW,CAAC;qBAC/B,CAAC,CAAC;oBAEL,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;oBAE3D,IAAI,OAAO,CAAC,MAAM,KAAK,GAAG,EAAE;wBAC1B,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;qBAC5D;oBAED,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBAE5D;oBACE,OAAO,KAAK,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aACnC;QACH,CAAC,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,OAAO,CACrB,UAAkB,EAClB,MAAc,EACd,IAAS;QAET,OAAO,CAAC,GAAG,CACT,oBAAoB,EACpB,MAAM,EACN,aAAa,EACb,UAAU,EACV,WAAW,EACX,IAAI,CACL,CAAC;QAEF,IAAI;YACF,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAChC,IAAI,CAAC,EAAE,EAAE;gBACP,MAAM,IAAI,KAAK,CAAC,oCAAoC,UAAU,GAAG,CAAC,CAAC;aACpE;YAED,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAE/C,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,IAAI;aACL,CAAC;SACH;QAAC,OAAO,GAAQ,EAAE;YACjB,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,KAAK,EAAE,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,OAAO;aAChC,CAAC;SACH;IACH,CAAC;IAES,OAAO,CAAC,GAAQ;QACxB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACnE,CAAC;IAES,KAAK,CAAC,QAAQ,CAAC,GAAQ;QAC/B,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,GAAG,CAAC,IAAI;YACb,IAAI,EAAE,MAAM;SACb,CAAC;QAEF,MAAM,MAAM,GAAuB;YACjC,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,IAAI,CAAC,UAAU,EAAE;aAC3C;SACF,CAAC;QAEF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAChC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAC5B,IAAI,EACJ,MAAM,CACP,CAAC;QAEF,OAAO,CAAC,GAAG,CACT,sBAAsB,EACtB,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAC5B,OAAO,EACP,IAAI,EACJ,KAAK,EACL,MAAM,EACN,eAAe,EACf,GAAG,CAAC,MAAM,EACV,GAAG,CAAC,IAAI,CACT,CAAC;IACJ,CAAC;IAES,IAAI,CAAC,GAAQ;QACrB,OAAO;YACL,UAAU,EAAE,MAAM;YAClB,SAAS,EAAE,IAAI,CAAC,aAAa;YAC7B,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;YAC5B,GAAG,EAAE,OAAO,iBAAO,EAAE;YACrB,CAAC,EAAE,KAAK;SACT,CAAC;IACJ,CAAC;IAES,iBAAiB;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAES,YAAY;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAzMD,gDAyMC"}
package/dist/types.d.ts CHANGED
@@ -1,4 +1,8 @@
1
1
  import { InngestStep } from "./components/InngestStep";
2
+ /**
3
+ * The shape of a step function, taking in event, step, and ctx data, and
4
+ * outputting anything.
5
+ */
2
6
  export declare type StepFn<Event, FnId, StepId> = (arg: {
3
7
  event: Event;
4
8
  steps: {};
@@ -7,6 +11,11 @@ export declare type StepFn<Event, FnId, StepId> = (arg: {
7
11
  step_id: StepId;
8
12
  };
9
13
  }) => any;
14
+ /**
15
+ * The shape of a single event's payload. It should be extended to enforce
16
+ * adherence to given events and not used as a method of creating them (i.e. as
17
+ * a generic).
18
+ */
10
19
  export interface EventPayload {
11
20
  /**
12
21
  * A unique identifier for the event
@@ -33,6 +42,10 @@ export interface EventPayload {
33
42
  * Your user's phone number
34
43
  */
35
44
  phone?: string;
45
+ /**
46
+ * The user block can contain arbitrary data that you can use within your
47
+ * own handlers too.
48
+ */
36
49
  [key: string]: any;
37
50
  };
38
51
  /**
@@ -41,7 +54,9 @@ export interface EventPayload {
41
54
  */
42
55
  v?: string;
43
56
  /**
44
- * An integer representing the milliseconds since the unix epoch at which this event occurred.
57
+ * An integer representing the milliseconds since the unix epoch at which this
58
+ * event occurred.
59
+ *
45
60
  * Defaults to the current time.
46
61
  * (optional)
47
62
  */
@@ -87,7 +102,7 @@ export declare type Step<Context = any> = (
87
102
  */
88
103
  context: Context) => Promise<Response> | Response;
89
104
  /**
90
- * A set of options for configuring the Inngest client
105
+ * A set of options for configuring the Inngest client.
91
106
  */
92
107
  export interface ClientOptions {
93
108
  /**
@@ -96,14 +111,53 @@ export interface ClientOptions {
96
111
  */
97
112
  inngestBaseUrl?: string;
98
113
  }
114
+ /**
115
+ * A set of options for configuring the registration of Inngest functions.
116
+ */
117
+ export interface RegisterOptions {
118
+ /**
119
+ * The URL used to register functions with Inngest.
120
+ * Defaults to https://api.inngest.com/fn/register
121
+ */
122
+ inngestRegisterUrl?: string;
123
+ }
99
124
  /**
100
125
  * A set of options for configuring an Inngest function.
101
126
  */
102
127
  export interface FunctionOptions {
128
+ /**
129
+ * An optional unique ID used to identify the function. This is used
130
+ * internally for versioning and referring to your function, so should not
131
+ * change between deployments.
132
+ *
133
+ * By default, this is a slugified version of the given `name`, e.g.
134
+ * `"My FN :)"` would be slugified to `"my-fn"`.
135
+ *
136
+ * If you are not specifying an ID and get a warning about duplicate
137
+ * functions, make sure to explicitly set an ID for the duplicate or change
138
+ * the name.
139
+ */
103
140
  id?: string;
141
+ /**
142
+ * A name for the function as it will appear in the Inngest Cloud UI.
143
+ *
144
+ * This is used to create a slugified ID for the function too, e.g.
145
+ * `"My FN :)"` would create a slugified ID of `"my-fn"`.
146
+ *
147
+ * If you are not specifying an ID and get a warning about duplicate
148
+ * functions, make sure to explicitly set an ID for the duplicate or change
149
+ * the name.
150
+ */
104
151
  name: string;
105
152
  }
153
+ /**
154
+ * A shortcut type for a collection of Inngest steps.
155
+ */
106
156
  export declare type Steps = Record<string, InngestStep<any[], any>>;
157
+ /**
158
+ * Expected responses to be used within an `InngestCommHandler` in order to
159
+ * appropriately respond to Inngest.
160
+ */
107
161
  export declare type StepRunResponse = {
108
162
  status: 500;
109
163
  error?: string;
@@ -111,6 +165,10 @@ export declare type StepRunResponse = {
111
165
  status: 200;
112
166
  body?: any;
113
167
  };
168
+ /**
169
+ * The response to send to Inngest when pushing function config either directly
170
+ * or when pinged by Inngest Cloud.
171
+ */
114
172
  export interface RegisterPingResponse {
115
173
  /**
116
174
  * Response version, allowing Inngest to change any top-level field.
@@ -141,6 +199,10 @@ export interface RegisterPingResponse {
141
199
  */
142
200
  functions: FunctionConfig[];
143
201
  }
202
+ /**
203
+ * A block representing an individual function being registered to Inngest
204
+ * Cloud.
205
+ */
144
206
  export interface FunctionConfig {
145
207
  name: string;
146
208
  id: string;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,oBAAY,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC,GAAG,EAAE;IAC9C,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,EAAE,CAAC;IACV,GAAG,EAAE;QAAE,KAAK,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CACvC,KAAK,GAAG,CAAC;AAEV,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;IAEV;;;OAGG;IACH,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IACX;;;;OAIG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,oBAAY,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI;AAChC;;;GAGG;AACH,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;AAE5D,oBAAY,eAAe,GACvB;IACE,MAAM,EAAE,GAAG,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,MAAM,EAAE,GAAG,CAAC;IACZ,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,CAAC;AAEN,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,CAAC,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAEzB;;;OAGG;IACH,GAAG,EAAE,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,EAAE,GAAG,IAAI,MAAM,IAAI,MAAM,EAAE,EAAE,CAAC;IAEvE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,CACN;QACE,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAC;KACd,CACJ,EAAE,CAAC;IACJ,KAAK,EAAE,MAAM,CACX,MAAM,EACN;QACE,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC;YACb,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;KACH,CACF,CAAC;CACH"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD;;;GAGG;AACH,oBAAY,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC,GAAG,EAAE;IAC9C,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,EAAE,CAAC;IACV,GAAG,EAAE;QAAE,KAAK,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CACvC,KAAK,GAAG,CAAC;AAEV;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;IAEV;;;OAGG;IACH,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IAEF;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;;;;;OAMG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,oBAAY,IAAI,CAAC,OAAO,GAAG,GAAG,IAAI;AAChC;;;GAGG;AACH,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,oBAAY,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;AAE5D;;;GAGG;AACH,oBAAY,eAAe,GACvB;IACE,MAAM,EAAE,GAAG,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GACD;IACE,MAAM,EAAE,GAAG,CAAC;IACZ,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,CAAC;AAEN;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,CAAC,EAAE,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;IAEzB;;;OAGG;IACH,GAAG,EAAE,OAAO,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,EAAE,GAAG,IAAI,MAAM,IAAI,MAAM,EAAE,EAAE,CAAC;IAEvE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,CACN;QACE,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GACD;QACE,IAAI,EAAE,MAAM,CAAC;KACd,CACJ,EAAE,CAAC;IACJ,KAAK,EAAE,MAAM,CACX,MAAM,EACN;QACE,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC;YACb,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;KACH,CACF,CAAC;CACH"}
package/dist/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const version = "0.4.0-beta.2";
1
+ export declare const version = "0.4.0-beta.3";
2
2
  //# sourceMappingURL=version.d.ts.map
package/dist/version.js CHANGED
@@ -2,5 +2,5 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.version = void 0;
4
4
  // Generated by genversion.
5
- exports.version = "0.4.0-beta.2";
5
+ exports.version = "0.4.0-beta.3";
6
6
  //# sourceMappingURL=version.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "inngest",
3
- "version": "0.4.0-beta.2",
3
+ "version": "0.4.0-beta.3",
4
4
  "description": "Official SDK for Inngest.com",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -26,9 +26,6 @@
26
26
  "files": [
27
27
  "dist"
28
28
  ],
29
- "engines": {
30
- "node": ">=14.0.0"
31
- },
32
29
  "prettier": {
33
30
  "tabWidth": 2,
34
31
  "useTabs": false,