@envoy/envoy-integrations-sdk 2.3.6 → 2.4.0-beta.2

package/dist/sdk/loggers.d.ts

@@ -1,6 +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 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

@@ -1 +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"}
+{"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,+BAoDxD;AAED,iBAAS,qBAAqB,CAAC,KAAK,EAAE,UAAU,QAoD/C;AAED,OAAO,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/sdk/middleware.d.ts

@@ -1,5 +1,14 @@
 import { ErrorRequestHandler, RequestHandler } from 'express';
 import { EnvoySignatureVerifierOptions } from '../util/EnvoySignatureVerifier';
+/**
+ * Options for configuring the Envoy middleware.
+ */
+export interface EnvoyMiddlewareOptions extends Partial<EnvoySignatureVerifierOptions> {
+    /** Optional custom client ID to use for API authentication instead of environment variable */
+    customClientId?: string;
+    /** Optional custom client secret to use for API authentication instead of environment variable */
+    customClientSecret?: string;
+}
 /**
  * Sets up an {@link EnvoyPluginSDK} object in the path `req.envoy`.
  * Modifies the `res` object to include Envoy's helpers, per {@link EnvoyResponse}.
@@ -9,7 +18,7 @@ import { EnvoySignatureVerifierOptions } from '../util/EnvoySignatureVerifier';
  *
  * @category Middleware
  */
-export declare function envoyMiddleware(options?: EnvoySignatureVerifierOptions): RequestHandler;
+export declare function envoyMiddleware(options?: EnvoyMiddlewareOptions): RequestHandler;
 /**
  * Catches errors and sets the proper status code.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../src/sdk/middleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,mBAAmB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG/F,OAA+B,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAOvG;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,6BAA6B,GAAG,cAAc,CAiEvF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,GAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAe,GAAG,mBAAmB,CAU7F"}
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../src/sdk/middleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,mBAAmB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAG/F,OAA+B,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAOvG;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,OAAO,CAAC,6BAA6B,CAAC;IACpF,8FAA8F;IAC9F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kGAAkG;IAClG,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAoEhF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,GAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAe,GAAG,mBAAmB,CAU7F"}

package/dist/sdk/middleware.js

@@ -66,25 +66,34 @@ function envoyMiddleware(options) {
     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) {
+            var now, hasCustomCredentials, _a, rawAccessToken, expiresIn, _b, envoyRequest, envoyResponse_1, error_1;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (err) {
                             return [2 /*return*/, next(err)];
                         }
-                        _b.label = 1;
+                        _c.label = 1;
                     case 1:
-                        _b.trys.push([1, 4, , 5]);
+                        _c.trys.push([1, 7, , 8]);
                         now = Date.now();
-                        if (!(now > threshold)) return [3 /*break*/, 3];
-                        return [4 /*yield*/, EnvoyPluginAPI_1.default.loginAsPlugin()];
+                        if (!(now > threshold)) return [3 /*break*/, 6];
+                        hasCustomCredentials = (options === null || options === void 0 ? void 0 : options.customClientId) && (options === null || options === void 0 ? void 0 : options.customClientSecret);
+                        if (!hasCustomCredentials) return [3 /*break*/, 3];
+                        return [4 /*yield*/, EnvoyPluginAPI_1.default.loginAsPlugin(options === null || options === void 0 ? void 0 : options.customClientId, options === null || options === void 0 ? void 0 : options.customClientSecret)];
                     case 2:
-                        _a = _b.sent(), rawAccessToken = _a.access_token, expiresIn = _a.expires_in;
+                        _b = _c.sent();
+                        return [3 /*break*/, 5];
+                    case 3: return [4 /*yield*/, EnvoyPluginAPI_1.default.loginAsPlugin()];
+                    case 4:
+                        _b = _c.sent();
+                        _c.label = 5;
+                    case 5:
+                        _a = _b, rawAccessToken = _a.access_token, expiresIn = _a.expires_in;
                         accessToken = rawAccessToken;
                         threshold = now + expiresIn * 1000 - 1000 * 60 * 10;
-                        _b.label = 3;
-                    case 3:
+                        _c.label = 6;
+                    case 6:
                         envoyRequest = req;
                         envoyResponse_1 = res;
                         envoyRequest.envoy = new EnvoyPluginSDK_1.default(envoyRequest.body, envoyRequest[EnvoyRequest_1.VERIFIED], accessToken);
@@ -127,12 +136,12 @@ function envoyMiddleware(options) {
                             envoyResponse_1.end(JSON.stringify({ message: message, debugInfo: debugInfo, attachments: attachments }));
                         };
                         next();
-                        return [3 /*break*/, 5];
-                    case 4:
-                        error_1 = _b.sent();
+                        return [3 /*break*/, 8];
+                    case 7:
+                        error_1 = _c.sent();
                         next(error_1);
-                        return [3 /*break*/, 5];
-                    case 5: return [2 /*return*/];
+                        return [3 /*break*/, 8];
+                    case 8: return [2 /*return*/];
                 }
             });
         }); });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "2.3.6",
+  "version": "2.4.0-beta.2",
   "description": "SDK for building Envoy integrations.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/sdk/middleware.ts

@@ -9,6 +9,16 @@ import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
 import EnvoyPluginSDK from './EnvoyPluginSDK';
 import EnvoyPluginAPI from './EnvoyPluginAPI';
 
+/**
+ * Options for configuring the Envoy middleware.
+ */
+export interface EnvoyMiddlewareOptions extends Partial<EnvoySignatureVerifierOptions> {
+  /** Optional custom client ID to use for API authentication instead of environment variable */
+  customClientId?: string;
+  /** Optional custom client secret to use for API authentication instead of environment variable */
+  customClientSecret?: string;
+}
+
 /**
  * Sets up an {@link EnvoyPluginSDK} object in the path `req.envoy`.
  * Modifies the `res` object to include Envoy's helpers, per {@link EnvoyResponse}.
@@ -18,8 +28,8 @@ import EnvoyPluginAPI from './EnvoyPluginAPI';
  *
  * @category Middleware
  */
-export function envoyMiddleware(options?: EnvoySignatureVerifierOptions): RequestHandler {
-  const signatureVerifier = new EnvoySignatureVerifier(options);
+export function envoyMiddleware(options?: EnvoyMiddlewareOptions): RequestHandler {
+  const signatureVerifier = new EnvoySignatureVerifier(options as EnvoySignatureVerifierOptions);
   const verify = (req: VerifiedRequest, res: Response, rawBody: Buffer) => {
     req[VERIFIED] = signatureVerifier.verify(req, rawBody);
   };
@@ -35,7 +45,10 @@ export function envoyMiddleware(options?: EnvoySignatureVerifierOptions): Reques
       try {
         const now = Date.now();
         if (now > threshold) {
-          const { access_token: rawAccessToken, expires_in: expiresIn } = await EnvoyPluginAPI.loginAsPlugin();
+          const hasCustomCredentials = options?.customClientId && options?.customClientSecret;
+          const { access_token: rawAccessToken, expires_in: expiresIn } = hasCustomCredentials
+            ? await EnvoyPluginAPI.loginAsPlugin(options?.customClientId, options?.customClientSecret)
+            : await EnvoyPluginAPI.loginAsPlugin();
           accessToken = rawAccessToken;
           threshold = now + expiresIn * 1000 - 1000 * 60 * 10;
         }