inngest 0.1.0-beta1.0 → 0.3.0

package/README.md

@@ -4,6 +4,8 @@
 npm install inngest
 ```
 
+👋 _**Have a question or feature request? [Join our Discord](https://www.inngest.com/discord)!**_
+
 ## Usage
 
 ```js
@@ -14,6 +16,7 @@ const { Inngest } = require("inngest");
 
 const inngest = new Inngest(process.env.INNGEST_SOURCE_API_KEY);
 
+// Send a single event
 await inngest.send({
   name: "user.signup",
   data: {
@@ -24,4 +27,16 @@ await inngest.send({
     email: user.email,
   },
 });
+
+// Send events in bulk
+const events = ["+12125551234", "+13135555678"].map(phoneNumber => ({
+  name: "sms.response.requested",
+  data: {
+    message: "Are you available for work today? (y/n)"
+  },
+  user: {
+    phone: phoneNumber
+  }
+}});
+await inngest.send(events);
 ```

package/dist/index.d.ts

@@ -1,3 +1,42 @@
+/**
+ * An HTTP-like, standardised response format that allows Inngest to help
+ * orchestrate steps and retries.
+ */
+export interface InngestResponse {
+    /**
+     * A step response must contain an HTTP status code.
+     *
+     * A `2xx` response indicates success; this is not a failure and no retry is
+     * necessary.
+     *
+     * A `4xx` response indicates a bad request; this step will not be retried as
+     * it is deemed irrecoverable. Examples of this might be an event with
+     * insufficient data or concerning a user that no longer exists.
+     *
+     * A `5xx` status indicates a temporary internal error; this will be retried
+     * according to the step and function's retry policy (3 times, by default).
+     *
+     * @link https://www.inngest.com/docs/functions/function-input-and-output#response-format
+     * @link https://www.inngest.com/docs/functions/retries
+     */
+    status: number;
+    /**
+     * The output of the function - the `body` - can be any arbitrary
+     * JSON-compatible data. It is then usable by any future steps.
+     *
+     * @link https://www.inngest.com/docs/functions/function-input-and-output#response-format
+     */
+    body?: any;
+}
+/**
+ * A single step within a function.
+ */
+export declare type InngestStep<Context = any> = (
+/**
+ * The context for this step, including the triggering event and any previous
+ * step output.
+ */
+context: Context) => Promise<InngestResponse> | InngestResponse;
 /**
  * The event payload structure for sending data to Inngest
  */
@@ -73,10 +112,11 @@ declare class Inngest {
      * @param apiKey - An API Key for the Inngest Source API
      */
     constructor(apiKey: string, { inngestApiUrl }?: InngestClientOptions);
+    private getResponseError;
     /**
-     * Send an event to Inngest
+     * Send event(s) to Inngest
      */
-    send(payload: EventPayload): Promise<boolean>;
+    send(payload: EventPayload | EventPayload[]): Promise<boolean>;
 }
 export { Inngest };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF;;;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;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,cAAM,OAAO;IACX;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;IAEvB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAS;IAE9B;;OAEG;IACH,OAAO,CAAC,WAAW,CAAqB;IAExC;;OAEG;gBAED,MAAM,EAAE,MAAM,EACd,EAAE,aAAmC,EAAE,GAAE,oBAAyB;IAgBpE;;OAEG;IACU,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;CAyC3D;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;;;;;OAeG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,oBAAY,WAAW,CAAC,OAAO,GAAG,GAAG,IAAI;AACvC;;;GAGG;AACH,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF;;;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;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,cAAM,OAAO;IACX;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;IAEvB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAS;IAE9B;;OAEG;IACH,OAAO,CAAC,WAAW,CAAqB;IAExC;;OAEG;gBAED,MAAM,EAAE,MAAM,EACd,EAAE,aAAmC,EAAE,GAAE,oBAAyB;IAgBpE,OAAO,CAAC,gBAAgB;IAgCxB;;OAEG;IACU,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAW5E;AAED,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/index.js

@@ -4,8 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Inngest = void 0;
-const url_1 = require("url");
 const axios_1 = __importDefault(require("axios"));
+const url_1 = require("url");
 /**
  * A client for the Inngest Source API
  */
@@ -26,14 +26,7 @@ class Inngest {
             maxRedirects: 0,
         };
     }
-    /**
-     * Send an event to Inngest
-     */
-    async send(payload) {
-        const response = await axios_1.default.post(this.inngestApiUrl, payload, this.axiosConfig);
-        if (response.status >= 200 && response.status < 300) {
-            return true;
-        }
+    getResponseError(response) {
         let errorMessage = "Unknown error";
         switch (response.status) {
             case 401:
@@ -62,7 +55,17 @@ class Inngest {
                 errorMessage = "Internal server error";
                 break;
         }
-        throw new Error(`Inngest API Error: ${response.status} ${errorMessage}`);
+        return new Error(`Inngest API Error: ${response.status} ${errorMessage}`);
+    }
+    /**
+     * Send event(s) to Inngest
+     */
+    async send(payload) {
+        const response = await axios_1.default.post(this.inngestApiUrl, payload, this.axiosConfig);
+        if (response.status >= 200 && response.status < 300) {
+            return true;
+        }
+        throw this.getResponseError(response);
     }
 }
 exports.Inngest = Inngest;

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,6BAA0B;AAE1B,kDAAkD;AA2DlD;;GAEG;AACH,MAAM,OAAO;IAgBX;;OAEG;IACH,YACE,MAAc,EACd,EAAE,aAAa,GAAG,mBAAmB,KAA2B,EAAE;QAElE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,IAAI,SAAG,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEpE,IAAI,CAAC,WAAW,GAAG;YACjB,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;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAAC,OAAqB;QACrC,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,IAAI,CAAC,aAAa,EAClB,OAAO,EACP,IAAI,CAAC,WAAW,CACjB,CAAC;QACF,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;YACnD,OAAO,IAAI,CAAC;SACb;QAED,IAAI,YAAY,GAAG,eAAe,CAAC;QACnC,QAAQ,QAAQ,CAAC,MAAM,EAAE;YACvB,KAAK,GAAG;gBACN,YAAY,GAAG,mBAAmB,CAAC;gBACnC,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,8BAA8B,CAAC;gBAC9C,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,WAAW,CAAC;gBAC3B,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,mBAAmB,CAAC;gBACnC,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClD,MAAM;YACR,KAAK,GAAG,CAAC;YACT,KAAK,GAAG;gBACN,YAAY,GAAG,6BAA6B,CAAC;gBAC7C,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,yBAAyB,CAAC;gBACzC,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,uBAAuB,CAAC;gBACvC,MAAM;SACT;QAED,MAAM,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAEQ,0BAAO"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiE;AACjE,6BAA0B;AAsG1B;;GAEG;AACH,MAAM,OAAO;IAgBX;;OAEG;IACH,YACE,MAAc,EACd,EAAE,aAAa,GAAG,mBAAmB,KAA2B,EAAE;QAElE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,IAAI,SAAG,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEpE,IAAI,CAAC,WAAW,GAAG;YACjB,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;IACJ,CAAC;IAEO,gBAAgB,CAAC,QAAuB;QAC9C,IAAI,YAAY,GAAG,eAAe,CAAC;QACnC,QAAQ,QAAQ,CAAC,MAAM,EAAE;YACvB,KAAK,GAAG;gBACN,YAAY,GAAG,mBAAmB,CAAC;gBACnC,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,8BAA8B,CAAC;gBAC9C,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,WAAW,CAAC;gBAC3B,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,mBAAmB,CAAC;gBACnC,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClD,MAAM;YACR,KAAK,GAAG,CAAC;YACT,KAAK,GAAG;gBACN,YAAY,GAAG,6BAA6B,CAAC;gBAC7C,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,yBAAyB,CAAC;gBACzC,MAAM;YACR,KAAK,GAAG;gBACN,YAAY,GAAG,uBAAuB,CAAC;gBACvC,MAAM;SACT;QACD,OAAO,IAAI,KAAK,CAAC,sBAAsB,QAAQ,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CAAC,OAAsC;QACtD,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,IAAI,CAC/B,IAAI,CAAC,aAAa,EAClB,OAAO,EACP,IAAI,CAAC,WAAW,CACjB,CAAC;QACF,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;YACnD,OAAO,IAAI,CAAC;SACb;QACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;CACF;AAEQ,0BAAO"}

package/dist/init.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=init.d.ts.map

package/dist/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":""}

package/dist/init.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+/**
+ * Init initializes the context for running the function.  This calls
+ * start() when
+ */
+async function init() {
+    const [, , fnPath, rawContext] = process.argv;
+    // We pass the event in as an argument to the node function.  Running
+    // npx ts-node "./foo.bar" means we have 2 arguments prior to the event.
+    // We'll also be adding stdin and lambda compatibility soon.
+    const context = JSON.parse(rawContext);
+    if (!context) {
+        throw new Error("unable to parse context");
+    }
+    // Import this asynchronously, such that any top-level
+    // errors in user code are caught.
+    const { run } = (await Promise.resolve().then(() => __importStar(require(path_1.default.join(process.cwd(), fnPath)))));
+    const result = await run(context);
+    /**
+     * We could also validate the response format (status code required) here and
+     * throw an error if it's not there?
+     */
+    return result;
+}
+init()
+    .then((body) => {
+    if (typeof body === "string") {
+        console.log(JSON.stringify({ body }));
+        return;
+    }
+    console.log(JSON.stringify(body));
+})
+    .catch((e) => {
+    // TODO: Log error and stack trace.
+    console.log(JSON.stringify({
+        error: e.stack || e.message,
+        status: 500,
+    }));
+    process.exit(1);
+});
+//# sourceMappingURL=init.js.map

package/dist/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,gDAAwB;AAGxB;;;GAGG;AACH,KAAK,UAAU,IAAI;IACjB,MAAM,CAAC,EAAE,AAAD,EAAG,MAAM,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAE9C,qEAAqE;IACrE,wEAAwE;IACxE,4DAA4D;IAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEvC,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;KAC5C;IAED,sDAAsD;IACtD,kCAAkC;IAClC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,wDACf,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,GACjC,CAEA,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC;IAElC;;;OAGG;IACH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,IAAI,EAAE;KACH,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;IACb,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QACtC,OAAO;KACR;IACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AACpC,CAAC,CAAC;KACD,KAAK,CAAC,CAAC,CAAQ,EAAE,EAAE;IAClB,mCAAmC;IACnC,OAAO,CAAC,GAAG,CACT,IAAI,CAAC,SAAS,CAAC;QACb,KAAK,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO;QAC3B,MAAM,EAAE,GAAG;KACZ,CAAC,CACH,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "inngest",
-  "version": "0.1.0-beta1.0",
+  "version": "0.3.0",
   "description": "Official SDK for Inngest.com",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "bin": {
+    "inngest-init": "./dist/init.js"
+  },
   "scripts": {
     "build": "yarn run clean && tsc",
     "test": "jest",
     "clean": "rm -rf ./dist",
+    "prepare": "yarn run test && yarn run build",
     "release": "yarn run np"
   },
   "homepage": "https://github.com/inngest/inngest-js#readme",
@@ -15,7 +22,7 @@
     "type": "git",
     "url": "git+https://github.com/inngest/inngest-js.git"
   },
-  "author": "Dan Farrelly <daniel.j.farrelly@gmail.com>",
+  "author": "Dan Farrelly <dan@inngest.com>",
   "license": "GPL-3.0",
   "private": false,
   "files": [