@envoy/envoy-integrations-sdk 2.0.1-beta.5 → 2.0.2

package/dist/sdk/handlers.d.ts

@@ -0,0 +1,125 @@
+/// <reference types="qs" />
+import { RequestHandler, Request, Response } from 'express';
+import { EnvoyEntryEventRequest, EnvoyEventRequest, EnvoyInviteEventRequest, EnvoyLocationEventRequest, EnvoyMigrationRouteRequest, EnvoyNotificationEventRequest, EnvoyOptionsRouteRequest, EnvoyRemoteValueRouteRequest, EnvoySelectedValuesRouteRequest, EnvoyValidationRouteRequest } from './EnvoyRequest';
+import EnvoyResponse, { EnvoyOptionsRouteResponse, EnvoyRemoteValueRouteResponse, EnvoySelectedValuesRouteResponse } from './EnvoyResponse';
+declare type SomeObject = Record<string, unknown>;
+declare type Result = Promise<void> | void;
+/**
+ * Handle an entry event, such as `entry_sign_in`.
+ * @category Handler
+ */
+export declare type EntryEventHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyEntryEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
+/**
+ * Handle an invite event, such as `invite_created`.
+ * @category Handler
+ */
+export declare type InviteEventHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyInviteEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
+/**
+ * Handle an location event, such as `location_capacity_updated`.
+ * @category Handler
+ */
+export declare type LocationEventHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyLocationEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
+/**
+ * Handle an notification event.
+ * @category Handler
+ */
+export declare type NotificationEventHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyNotificationEventRequest<Config> & Additions, res: EnvoyResponse) => Result;
+/**
+ * Handle a `plugin_uninstalled` event for cleaning up.
+ * @category Handler
+ */
+export declare type PluginUninstalledEventHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyEventRequest<'plugin_uninstalled', never, Config> & Additions, res: EnvoyResponse) => Result;
+/**
+ * Handle a "migration" route.
+ * @category Handler
+ */
+export declare type MigrationRouteHandler<OldConfig = SomeObject, NewConfig = SomeObject, Additions = SomeObject> = (req: EnvoyMigrationRouteRequest<OldConfig> & Additions, res: EnvoyResponse<NewConfig>) => Result;
+/**
+ * Handle an "options" route.
+ * @category Handler
+ */
+export declare type OptionsRouteHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyOptionsRouteRequest<Config> & Additions, res: EnvoyOptionsRouteResponse) => Result;
+/**
+ * Handle a "remote value" route.
+ * @category Handler
+ */
+export declare type RemoteValueRouteHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoyRemoteValueRouteRequest<Config> & Additions, res: EnvoyRemoteValueRouteResponse) => Result;
+/**
+ * Handle a "selected values" route.
+ * @category Handler
+ */
+export declare type SelectedValuesRouteHandler<Config = SomeObject, Additions = SomeObject> = (req: EnvoySelectedValuesRouteRequest<Config> & Additions, res: EnvoySelectedValuesRouteResponse) => Result;
+/**
+ * Handle a "validation" route.
+ * @category Handler
+ */
+export declare type ValidationRouteHandler<Config = SomeObject, Payload = SomeObject, Additions = SomeObject> = (req: EnvoyValidationRouteRequest<Payload, Config> & Additions, res: EnvoyResponse<Partial<Config>>) => Result;
+/**
+ * Wraps any express.js-based handlers
+ * to catch Promise-based errors.
+ *
+ * @category Handler
+ */
+export declare function asyncHandler<Req extends Request, Res extends Response>(handler: (req: Req, res: Res) => Result): RequestHandler;
+/**
+ * Handler for entry events.
+ *
+ * @category Handler
+ */
+export declare function entryEventHandler<Config = SomeObject, Additions = SomeObject>(handler: EntryEventHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for invite events.
+ *
+ * @category Handler
+ */
+export declare function inviteEventHandler<Config = SomeObject, Additions = SomeObject>(handler: InviteEventHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for location events.
+ *
+ * @category Handler
+ */
+export declare function locationEventHandler<Config = SomeObject, Additions = SomeObject>(handler: LocationEventHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for a migration route.
+ *
+ * @category Handler
+ */
+export declare function migrationRouteHandler<OldConfig, NewConfig, Additions = SomeObject>(handler: MigrationRouteHandler<OldConfig, NewConfig, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for notification events.
+ *
+ * @category Handler
+ */
+export declare function notificationEventHandler<Config = SomeObject, Additions = SomeObject>(handler: NotificationEventHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for options URL routes.
+ *
+ * @category Handler
+ */
+export declare function optionsRouteHandler<Config = SomeObject, Additions = SomeObject>(handler: OptionsRouteHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for `plugin_uninstalled` events.
+ *
+ * @category Handler
+ */
+export declare function pluginUninstalledEventHandler<Config = SomeObject, Additions = SomeObject>(handler: PluginUninstalledEventHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for remote value URL routes.
+ *
+ * @category Handler
+ */
+export declare function remoteValueRouteHandler<Config = SomeObject, Additions = SomeObject>(handler: RemoteValueRouteHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for selected values URL routes.
+ *
+ * @category Handler
+ */
+export declare function selectedValuesRouteHandler<Config = SomeObject, Additions = SomeObject>(handler: SelectedValuesRouteHandler<Config, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+/**
+ * Handler for validation URL routes.
+ *
+ * @category Handler
+ */
+export declare function validationRouteHandler<Config = SomeObject, Payload = SomeObject, Additions = SomeObject>(handler: ValidationRouteHandler<Config, Payload, Additions>): RequestHandler<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>;
+export {};
+//# sourceMappingURL=handlers.d.ts.map

package/dist/sdk/handlers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handlers.d.ts","sourceRoot":"","sources":["../../src/sdk/handlers.ts"],"names":[],"mappings":";AAAA,OAAO,EAEL,cAAc,EACd,OAAO,EACP,QAAQ,EACT,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,6BAA6B,EAC7B,wBAAwB,EACxB,4BAA4B,EAC5B,+BAA+B,EAC/B,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,aAAa,EAAE,EACpB,yBAAyB,EACzB,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,iBAAiB,CAAC;AAEzB,aAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1C,aAAK,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEnC;;;GAGG;AACH,oBAAY,iBAAiB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACvE,CAAC,GAAG,EAAE,sBAAsB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAElF;;;GAGG;AACH,oBAAY,kBAAkB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACxE,CAAC,GAAG,EAAE,uBAAuB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAEnF;;;GAGG;AACH,oBAAY,oBAAoB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC1E,CAAC,GAAG,EAAE,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAErF;;;GAGG;AACH,oBAAY,wBAAwB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC9E,CAAC,GAAG,EAAE,6BAA6B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAEzF;;;GAGG;AACH,oBAAY,6BAA6B,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACnF,CAAC,GAAG,EAAE,iBAAiB,CAAC,oBAAoB,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,KAAK,MAAM,CAAC;AAE1G;;;GAGG;AACH,oBAAY,qBAAqB,CAAC,SAAS,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACtG,CAAC,GAAG,EAAE,0BAA0B,CAAC,SAAS,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,SAAS,CAAC,KAAK,MAAM,CAAC;AAEpG;;;GAGG;AACH,oBAAY,mBAAmB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IACzE,CAAC,GAAG,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,yBAAyB,KAAK,MAAM,CAAC;AAEhG;;;GAGG;AACH,oBAAY,uBAAuB,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAC7E,CAAC,GAAG,EAAE,4BAA4B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,6BAA6B,KAAK,MAAM,CAAC;AAExG;;;GAGG;AACH,oBAAY,0BAA0B,CAAC,MAAM,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAChF,CAAC,GAAG,EAAE,+BAA+B,CAAC,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,gCAAgC,KAAK,MAAM,CAAC;AAE9G;;;GAGG;AACH,oBAAY,sBAAsB,CAAC,MAAM,GAAG,UAAU,EAAE,OAAO,GAAG,UAAU,EAAE,SAAS,GAAG,UAAU,IAClG,CAAC,GAAG,EAAE,2BAA2B,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,MAAM,CAAC;AAEjH;;;;;GAKG;AAEH,wBAAgB,YAAY,CAAC,GAAG,SAAS,OAAO,EAAE,GAAG,SAAS,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,MAAM,GAAG,cAAc,CAM/H;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEhD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,kBAAkB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEjD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,oBAAoB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEnD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EACT,SAAS,EACT,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC,8HAElE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEvD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,mBAAmB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAElD;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,6BAA6B,CAAC,MAAM,EAAE,SAAS,CAAC,8HAE5D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEtD;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,GAAG,UAAU,EACnB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,0BAA0B,CAAC,MAAM,EAAE,SAAS,CAAC,8HAEzD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,GAAG,UAAU,EACnB,OAAO,GAAG,UAAU,EACpB,SAAS,GAAG,UAAU,EACpB,OAAO,EAAE,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,8HAE9D"}

package/dist/sdk/handlers.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validationRouteHandler = exports.selectedValuesRouteHandler = exports.remoteValueRouteHandler = exports.pluginUninstalledEventHandler = exports.optionsRouteHandler = exports.notificationEventHandler = exports.migrationRouteHandler = exports.locationEventHandler = exports.inviteEventHandler = exports.entryEventHandler = exports.asyncHandler = void 0;
+/**
+ * Wraps any express.js-based handlers
+ * to catch Promise-based errors.
+ *
+ * @category Handler
+ */
+// eslint-disable-next-line max-len
+function asyncHandler(handler) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    return function (req, res, next) {
+        void Promise.resolve().then(function () { return handler(req, res); }).catch(next);
+    };
+}
+exports.asyncHandler = asyncHandler;
+/**
+ * Handler for entry events.
+ *
+ * @category Handler
+ */
+function entryEventHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.entryEventHandler = entryEventHandler;
+/**
+ * Handler for invite events.
+ *
+ * @category Handler
+ */
+function inviteEventHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.inviteEventHandler = inviteEventHandler;
+/**
+ * Handler for location events.
+ *
+ * @category Handler
+ */
+function locationEventHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.locationEventHandler = locationEventHandler;
+/**
+ * Handler for a migration route.
+ *
+ * @category Handler
+ */
+function migrationRouteHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.migrationRouteHandler = migrationRouteHandler;
+/**
+ * Handler for notification events.
+ *
+ * @category Handler
+ */
+function notificationEventHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.notificationEventHandler = notificationEventHandler;
+/**
+ * Handler for options URL routes.
+ *
+ * @category Handler
+ */
+function optionsRouteHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.optionsRouteHandler = optionsRouteHandler;
+/**
+ * Handler for `plugin_uninstalled` events.
+ *
+ * @category Handler
+ */
+function pluginUninstalledEventHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.pluginUninstalledEventHandler = pluginUninstalledEventHandler;
+/**
+ * Handler for remote value URL routes.
+ *
+ * @category Handler
+ */
+function remoteValueRouteHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.remoteValueRouteHandler = remoteValueRouteHandler;
+/**
+ * Handler for selected values URL routes.
+ *
+ * @category Handler
+ */
+function selectedValuesRouteHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.selectedValuesRouteHandler = selectedValuesRouteHandler;
+/**
+ * Handler for validation URL routes.
+ *
+ * @category Handler
+ */
+function validationRouteHandler(handler) {
+    return asyncHandler(handler);
+}
+exports.validationRouteHandler = validationRouteHandler;

package/dist/sdk/loggers.d.ts

@@ -0,0 +1,6 @@
+import { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
+declare function envoyAxiosRequestLogger(config: AxiosRequestConfig): AxiosRequestConfig<any>;
+declare function envoyAxiosResponseLogger(response: AxiosResponse): AxiosResponse<any, any>;
+declare function envoyAxiosErrorLogger(error: AxiosError): void;
+export { envoyAxiosRequestLogger, envoyAxiosResponseLogger, envoyAxiosErrorLogger };
+//# sourceMappingURL=loggers.d.ts.map

package/dist/sdk/loggers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggers.d.ts","sourceRoot":"","sources":["../../src/sdk/loggers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAItE,iBAAS,uBAAuB,CAAC,MAAM,EAAE,kBAAkB,2BAkD1D;AAED,iBAAS,wBAAwB,CAAC,QAAQ,EAAE,aAAa,2BAoDxD;AAED,iBAAS,qBAAqB,CAAC,KAAK,EAAE,UAAU,QAoD/C;AAED,OAAO,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/sdk/loggers.js

@@ -0,0 +1,161 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.envoyAxiosErrorLogger = exports.envoyAxiosResponseLogger = exports.envoyAxiosRequestLogger = void 0;
+var chalk_1 = __importDefault(require("chalk"));
+var util_1 = __importDefault(require("util"));
+function envoyAxiosRequestLogger(config) {
+    var log = console.log;
+    log('---------------- Axios Request ----------------\n');
+    if (config === null || config === void 0 ? void 0 : config.method) {
+        var boldMethodText = chalk_1.default.bold('Method:');
+        var method = config.method.toUpperCase();
+        switch (method) {
+            case 'GET':
+                log(boldMethodText + " " + chalk_1.default.green(method) + "\n");
+                break;
+            case 'PUT':
+                log(boldMethodText + " " + chalk_1.default.yellow(method) + "\n");
+                break;
+            case 'PATCH':
+                log(boldMethodText + " " + chalk_1.default.yellow(method) + "\n");
+                break;
+            case 'POST':
+                log(boldMethodText + " " + chalk_1.default.blue(method) + "\n");
+                break;
+            case 'DELETE':
+                log(boldMethodText + " " + chalk_1.default.red(method) + "\n");
+                break;
+            default:
+                log(boldMethodText + " " + method + "\n");
+                break;
+        }
+        ;
+    }
+    if ((config === null || config === void 0 ? void 0 : config.baseURL) && (config === null || config === void 0 ? void 0 : config.url)) {
+        log(chalk_1.default.bold('URL') + ": " + config.baseURL + "/" + config.url + "\n");
+    }
+    if (config === null || config === void 0 ? void 0 : config.headers) {
+        log(chalk_1.default.bold('Headers:') + " " + util_1.default.inspect(config === null || config === void 0 ? void 0 : config.headers) + "\n");
+    }
+    if (config === null || config === void 0 ? void 0 : config.auth) {
+        log(chalk_1.default.bold('Auth:') + " " + util_1.default.inspect(config === null || config === void 0 ? void 0 : config.auth) + "\n");
+    }
+    if (config === null || config === void 0 ? void 0 : config.params) {
+        log(chalk_1.default.bold('Params:') + " " + util_1.default.inspect(config === null || config === void 0 ? void 0 : config.params) + "\n");
+    }
+    if (config === null || config === void 0 ? void 0 : config.data) {
+        log(chalk_1.default.bold('Request Data:') + " " + util_1.default.inspect(config === null || config === void 0 ? void 0 : config.data) + "\n");
+    }
+    log('------------ End Of Axios Request ------------\n');
+    return config;
+}
+exports.envoyAxiosRequestLogger = envoyAxiosRequestLogger;
+function envoyAxiosResponseLogger(response) {
+    var _a, _b, _c;
+    var log = console.log;
+    log('---------------- Axios Response ----------------\n');
+    if ((_a = response === null || response === void 0 ? void 0 : response.request) === null || _a === void 0 ? void 0 : _a.method) {
+        var boldMethodText = chalk_1.default.bold('Method:');
+        var method = response.request.method;
+        switch (method) {
+            case 'GET':
+                log(boldMethodText + " " + chalk_1.default.green(method) + "\n");
+                break;
+            case 'PUT':
+                log(boldMethodText + " " + chalk_1.default.yellow(method) + "\n");
+                break;
+            case 'PATCH':
+                log(boldMethodText + " " + chalk_1.default.yellow(method) + "\n");
+                break;
+            case 'POST':
+                log(boldMethodText + " " + chalk_1.default.blue(method) + "\n");
+                break;
+            case 'DELETE':
+                log(boldMethodText + " " + chalk_1.default.red(method) + "\n");
+                break;
+            default:
+                log(boldMethodText + " " + method + "\n");
+                break;
+        }
+        ;
+    }
+    if (((_b = response === null || response === void 0 ? void 0 : response.request) === null || _b === void 0 ? void 0 : _b.baseURL) && ((_c = response === null || response === void 0 ? void 0 : response.request) === null || _c === void 0 ? void 0 : _c.url)) {
+        log(chalk_1.default.bold('Request URL') + ": " + response.request.baseURL + "/" + response.request.url + "\n");
+    }
+    if ((response === null || response === void 0 ? void 0 : response.status) && (response === null || response === void 0 ? void 0 : response.statusText)) {
+        var boldStatusTitle = chalk_1.default.bold('Status:');
+        var boldStatusTextTitle = chalk_1.default.bold('Status Text:');
+        var status_1 = response.status;
+        var statusText = response.statusText;
+        if (199 < status_1 && status_1 < 300) {
+            log(boldStatusTitle + " " + chalk_1.default.green(status_1) + "\n");
+            log(boldStatusTextTitle + " " + chalk_1.default.green(statusText) + "\n");
+        }
+        else {
+            log(boldStatusTitle + " " + chalk_1.default.red(status_1) + "\n");
+            log(boldStatusTextTitle + " " + chalk_1.default.red(statusText) + "\n");
+        }
+    }
+    if (response === null || response === void 0 ? void 0 : response.data) {
+        log(chalk_1.default.bold('Response Data:') + " " + util_1.default.inspect(response === null || response === void 0 ? void 0 : response.data) + "\n");
+    }
+    log('------------ End Of Axios Response ------------\n');
+    return response;
+}
+exports.envoyAxiosResponseLogger = envoyAxiosResponseLogger;
+function envoyAxiosErrorLogger(error) {
+    var _a, _b, _c, _d, _e, _f;
+    var log = console.log;
+    log('---------------- Axios Error ----------------\n');
+    if ((_a = error === null || error === void 0 ? void 0 : error.request) === null || _a === void 0 ? void 0 : _a.method) {
+        var boldMethodText = chalk_1.default.bold('Method:');
+        var method = error.request.method;
+        switch (method) {
+            case 'GET':
+                log(boldMethodText + " " + chalk_1.default.green(method) + "\n");
+                break;
+            case 'PUT':
+                log(boldMethodText + " " + chalk_1.default.yellow(method) + "\n");
+                break;
+            case 'PATCH':
+                log(boldMethodText + " " + chalk_1.default.yellow(method) + "\n");
+                break;
+            case 'POST':
+                log(boldMethodText + " " + chalk_1.default.blue(method) + "\n");
+                break;
+            case 'DELETE':
+                log(boldMethodText + " " + chalk_1.default.red(method) + "\n");
+                break;
+            default:
+                log(boldMethodText + " " + method + "\n");
+                break;
+        }
+        ;
+    }
+    if (((_b = error === null || error === void 0 ? void 0 : error.request) === null || _b === void 0 ? void 0 : _b.baseURL) && ((_c = error === null || error === void 0 ? void 0 : error.request) === null || _c === void 0 ? void 0 : _c.url)) {
+        log(chalk_1.default.bold('Request URL') + ": " + error.request.baseURL + "/" + error.request.url + "\n");
+    }
+    if (((_d = error === null || error === void 0 ? void 0 : error.response) === null || _d === void 0 ? void 0 : _d.status) && ((_e = error === null || error === void 0 ? void 0 : error.response) === null || _e === void 0 ? void 0 : _e.statusText)) {
+        var boldStatusTitle = chalk_1.default.bold('Status:');
+        var boldStatusTextTitle = chalk_1.default.bold('Status Text:');
+        var status_2 = error.response.status;
+        var statusText = error.response.statusText;
+        if (199 < status_2 && status_2 < 300) {
+            log(boldStatusTitle + " " + chalk_1.default.green(status_2) + "\n");
+            log(boldStatusTextTitle + " " + chalk_1.default.green(statusText) + "\n");
+        }
+        else {
+            log(boldStatusTitle + " " + chalk_1.default.red(status_2) + "\n");
+            log(boldStatusTextTitle + " " + chalk_1.default.red(statusText) + "\n");
+        }
+    }
+    if ((_f = error.response) === null || _f === void 0 ? void 0 : _f.data) {
+        log(chalk_1.default.bold('Response Data:') + " " + util_1.default.inspect(error.response.data) + "\n");
+    }
+    log('------------ End Of Axios Error ------------\n');
+    throw error;
+}
+exports.envoyAxiosErrorLogger = envoyAxiosErrorLogger;

package/dist/sdk/middleware.d.ts

@@ -0,0 +1,19 @@
+import { ErrorRequestHandler, RequestHandler } from 'express';
+import { EnvoySignatureVerifierOptions } from '../util/EnvoySignatureVerifier';
+/**
+ * Sets up an {@link EnvoyPluginSDK} object in the path `req.envoy`.
+ * Modifies the `res` object to include Envoy's helpers, per {@link EnvoyResponse}.
+ *
+ * Also verifies that the request is coming from Envoy,
+ * as well as managing the plugin access token lifecycle.
+ *
+ * @category Middleware
+ */
+export declare function envoyMiddleware(options?: EnvoySignatureVerifierOptions): RequestHandler;
+/**
+ * Catches errors and sets the proper status code.
+ *
+ * @category Middleware
+ */
+export declare function errorMiddleware(onError?: (err: Error) => void): ErrorRequestHandler;
+//# sourceMappingURL=middleware.d.ts.map

package/dist/sdk/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../src/sdk/middleware.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,mBAAmB,EACnB,cAAc,EACf,MAAM,SAAS,CAAC;AAGjB,OAA+B,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAOvG;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,6BAA6B,GAAG,cAAc,CAyDvF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,GAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAe,GAAG,mBAAmB,CAU7F"}

package/dist/sdk/middleware.js

@@ -0,0 +1,159 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorMiddleware = exports.envoyMiddleware = void 0;
+var body_parser_1 = __importDefault(require("body-parser"));
+var HttpStatus_1 = __importDefault(require("../internal/HttpStatus"));
+var EnvoySignatureVerifier_1 = __importDefault(require("../util/EnvoySignatureVerifier"));
+var EnvoyRequest_1 = require("./EnvoyRequest");
+var EnvoyPluginSDK_1 = __importDefault(require("./EnvoyPluginSDK"));
+var EnvoyPluginAPI_1 = __importDefault(require("./EnvoyPluginAPI"));
+/**
+ * Sets up an {@link EnvoyPluginSDK} object in the path `req.envoy`.
+ * Modifies the `res` object to include Envoy's helpers, per {@link EnvoyResponse}.
+ *
+ * Also verifies that the request is coming from Envoy,
+ * as well as managing the plugin access token lifecycle.
+ *
+ * @category Middleware
+ */
+function envoyMiddleware(options) {
+    var _this = this;
+    var signatureVerifier = new EnvoySignatureVerifier_1.default(options);
+    var verify = function (req, res, rawBody) {
+        req[EnvoyRequest_1.VERIFIED] = signatureVerifier.verify(req, rawBody);
+    };
+    var json = body_parser_1.default.json({ verify: verify });
+    var accessToken = null;
+    var threshold = 0;
+    return function (req, res, next) {
+        json(req, res, function (err) { return __awaiter(_this, void 0, void 0, function () {
+            var now, _a, rawAccessToken, expiresIn, envoyRequest, envoyResponse_1, error_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        if (err) {
+                            return [2 /*return*/, next(err)];
+                        }
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 4, , 5]);
+                        now = Date.now();
+                        if (!(now > threshold)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, EnvoyPluginAPI_1.default.loginAsPlugin()];
+                    case 2:
+                        _a = _b.sent(), rawAccessToken = _a.access_token, expiresIn = _a.expires_in;
+                        accessToken = rawAccessToken;
+                        threshold = now + (expiresIn * 1000) - (1000 * 60 * 10);
+                        _b.label = 3;
+                    case 3:
+                        envoyRequest = req;
+                        envoyResponse_1 = res;
+                        envoyRequest.envoy = new EnvoyPluginSDK_1.default(envoyRequest.body, envoyRequest[EnvoyRequest_1.VERIFIED], accessToken);
+                        /**
+                         * Respond with "ongoing" for long jobs.
+                         */
+                        envoyResponse_1.sendOngoing = function (message, debugInfo) {
+                            if (message === void 0) { message = ''; }
+                            if (debugInfo === void 0) { debugInfo = {}; }
+                            envoyResponse_1.statusCode = HttpStatus_1.default.ONGOING;
+                            envoyResponse_1.setHeader('Content-Type', 'application/json');
+                            envoyResponse_1.end(JSON.stringify({ message: message, debugInfo: debugInfo }));
+                        };
+                        /**
+                         * Respond with "ignored" if no action will be performed.
+                         */
+                        envoyResponse_1.sendIgnored = function (message, debugInfo) {
+                            if (message === void 0) { message = ''; }
+                            if (debugInfo === void 0) { debugInfo = {}; }
+                            var attachments = [];
+                            for (var _i = 2; _i < arguments.length; _i++) {
+                                attachments[_i - 2] = arguments[_i];
+                            }
+                            envoyResponse_1.statusCode = HttpStatus_1.default.IGNORED;
+                            envoyResponse_1.setHeader('Content-Type', 'application/json');
+                            envoyResponse_1.end(JSON.stringify({ message: message, debugInfo: debugInfo, attachments: attachments }));
+                        };
+                        /**
+                         * Respond with "failed" in case of errors.
+                         */
+                        envoyResponse_1.sendFailed = function (message, debugInfo) {
+                            if (message === void 0) { message = ''; }
+                            if (debugInfo === void 0) { debugInfo = {}; }
+                            var attachments = [];
+                            for (var _i = 2; _i < arguments.length; _i++) {
+                                attachments[_i - 2] = arguments[_i];
+                            }
+                            envoyResponse_1.statusCode = HttpStatus_1.default.FAILED;
+                            envoyResponse_1.setHeader('Content-Type', 'application/json');
+                            envoyResponse_1.end(JSON.stringify({ message: message, debugInfo: debugInfo, attachments: attachments }));
+                        };
+                        next();
+                        return [3 /*break*/, 5];
+                    case 4:
+                        error_1 = _b.sent();
+                        next(error_1);
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
+                }
+            });
+        }); });
+    };
+}
+exports.envoyMiddleware = envoyMiddleware;
+/**
+ * Catches errors and sets the proper status code.
+ *
+ * @category Middleware
+ */
+function errorMiddleware(onError) {
+    if (onError === void 0) { onError = function () { }; }
+    return function (err, req, res, next) {
+        onError(err);
+        if (res.headersSent) {
+            return next(err);
+        }
+        res.statusCode = HttpStatus_1.default.UNEXPECTED_FAILURE;
+        res.setHeader('Content-Type', 'application/json');
+        res.end(JSON.stringify({ message: err.message }));
+    };
+}
+exports.errorMiddleware = errorMiddleware;

package/dist/util/EnvoyJWT.d.ts

@@ -0,0 +1,17 @@
+import { Algorithm, VerifyOptions } from 'jsonwebtoken';
+export declare type EnvoyJWTAlgorithm = Algorithm;
+export declare type EnvoyJWTDecodeOptions = VerifyOptions;
+/**
+ * Helper to encode and decode JWTs.
+ *
+ * @category Helper
+ * @category Request Object
+ */
+export default class EnvoyJWT {
+    private secret;
+    private algorithm;
+    constructor(secret?: string, algorithm?: EnvoyJWTAlgorithm);
+    encode(subject: string | number | null, expiresIn: string | number | null, payload?: Record<string, unknown>): string;
+    decode(token: string, options?: EnvoyJWTDecodeOptions): Record<string, unknown>;
+}
+//# sourceMappingURL=EnvoyJWT.d.ts.map

package/dist/util/EnvoyJWT.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvoyJWT.d.ts","sourceRoot":"","sources":["../../src/util/EnvoyJWT.ts"],"names":[],"mappings":"AAAA,OAAY,EAAe,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG1E,oBAAY,iBAAiB,GAAG,SAAS,CAAC;AAC1C,oBAAY,qBAAqB,GAAG,aAAa,CAAC;AAClD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,SAAS,CAAY;gBAEjB,MAAM,SAAY,EAAE,SAAS,GAAE,iBAA2B;IAQtE,MAAM,CACJ,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAC/B,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EACjC,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACpC,MAAM;IAaT,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CASpF"}