@envoy/envoy-integrations-sdk 2.4.0 → 2.4.1

package/dist/sdk/EnvoyPluginJob.d.ts

@@ -33,9 +33,9 @@ export default class EnvoyPluginJob {
      */
     ignore(message: string, reason: string): Promise<void>;
     /**
-     * Reports that the job is ignored.
+     * Reports that the job is failed.
      *
-     * Instead of calling this directly, you can return a 400 response from the job's event handler,
+     * Instead of calling this directly, you can return a 412 response from the job's event handler,
      * using {@link EnvoyRequest.sendFailed}.
      */
     fail(message: string, reason: string): Promise<void>;

package/dist/sdk/EnvoyPluginJob.js

@@ -74,9 +74,9 @@ var EnvoyPluginJob = /** @class */ (function () {
         return this.execute('ignored', message, reason);
     };
     /**
-     * Reports that the job is ignored.
+     * Reports that the job is failed.
      *
-     * Instead of calling this directly, you can return a 400 response from the job's event handler,
+     * Instead of calling this directly, you can return a 412 response from the job's event handler,
      * using {@link EnvoyRequest.sendFailed}.
      */
     EnvoyPluginJob.prototype.fail = function (message, reason) {

package/dist/sdk/EnvoyPluginJobAttachment.d.ts

@@ -8,6 +8,16 @@ export interface EnvoyPluginTextJobAttachment {
     label: string;
     value: string;
 }
+/**
+ * Display some JSON data in Envoy's dashboard.
+ *
+ * @category Attachment
+ */
+export interface EnvoyPluginJSONJobAttachment {
+    type: 'json';
+    label: string;
+    value: unknown;
+}
 /**
  * Display a link in Envoy's dashboard.
  *
@@ -31,6 +41,44 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt
         link: string;
     };
 }
+/**
+ * Display a screener report in Envoy's dashboard,
+ * and allow for approval or rejection.
+ *
+ * @category Attachment
+ */
+export interface EnvoyPluginScreenerJobAttachment extends EnvoyPluginJSONJobAttachment {
+    label: string;
+    value: ScreenerDetails;
+}
+/**
+ * Screener report definitions
+ */
+export interface ScreenerDetails {
+    input: {
+        fields: ScreenerInputField[];
+    };
+    matches: ScreenerMatch[];
+}
+export interface ScreenerMatch {
+    headers: ScreenerMatchHeaders;
+    'visible-fields-count': number;
+    fields: ScreenerMatchField[];
+}
+export interface ScreenerMatchHeaders {
+    name: string;
+    value: string;
+}
+export interface ScreenerMatchField {
+    name: string;
+    value: string;
+    type: 'text' | 'image';
+}
+export interface ScreenerInputField {
+    name: string;
+    value: string;
+    type: 'text' | 'image';
+}
 /**
  * Attachments to jobs, which will be displayed in the Envoy dashboard.
  * Some attachments like `credential_image` can show up in other places,
@@ -38,6 +86,6 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt
  *
  * @category Attachment
  */
-declare type EnvoyPluginJobAttachment = EnvoyPluginTextJobAttachment | EnvoyPluginLinkJobAttachment | EnvoyPluginCredentialJobAttachment;
+declare type EnvoyPluginJobAttachment = EnvoyPluginTextJobAttachment | EnvoyPluginLinkJobAttachment | EnvoyPluginCredentialJobAttachment | EnvoyPluginScreenerJobAttachment;
 export default EnvoyPluginJobAttachment;
 //# sourceMappingURL=EnvoyPluginJobAttachment.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"EnvoyPluginJobAttachment.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyPluginJobAttachment.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,kCAAmC,SAAQ,4BAA4B;IACtF,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,IAAI,EAAE,IAAI,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;;;;GAMG;AACH,aAAK,wBAAwB,GACzB,4BAA4B,GAC5B,4BAA4B,GAC5B,kCAAkC,CAAC;AAEvC,eAAe,wBAAwB,CAAC"}
+{"version":3,"file":"EnvoyPluginJobAttachment.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyPluginJobAttachment.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,kCAAmC,SAAQ,4BAA4B;IACtF,IAAI,EAAE,kBAAkB,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,IAAI,EAAE,IAAI,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,gCAAiC,SAAQ,4BAA4B;IACpF,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,eAAe,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE;QACL,MAAM,EAAE,kBAAkB,EAAE,CAAC;KAC9B,CAAA;IACD,OAAO,EAAE,aAAa,EAAE,CAAC;CAC1B;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,oBAAoB,CAAC;IAC9B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,MAAM,EAAE,kBAAkB,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;GAMG;AACH,aAAK,wBAAwB,GACzB,4BAA4B,GAC5B,4BAA4B,GAC5B,kCAAkC,GAClC,gCAAgC,CAAC;AAErC,eAAe,wBAAwB,CAAC"}

package/dist/sdk/EnvoyResponse.d.ts

@@ -1,5 +1,5 @@
 import { Response } from 'express';
-import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
+import EnvoyPluginJobAttachment, { EnvoyPluginScreenerJobAttachment } from './EnvoyPluginJobAttachment';
 import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody';
 import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody';
 import EnvoyRemoteValueRouteResponseBody from '../internal/EnvoyRemoteValueRouteResponseBody';
@@ -24,6 +24,10 @@ export default interface EnvoyResponse<Body = unknown> extends Response {
      * Marks the job as "failed". The message will be communicated to the Envoy Dashboard user.
      */
     sendFailed: (message: string, debugInfo?: unknown, ...attachments: Array<EnvoyPluginJobAttachment>) => void;
+    /**
+     * Marks the job as "failed". The message will be communicated to the Envoy Dashboard user.
+     */
+    sendFailedScreen: (message: string, debugInfo?: unknown, attachment?: EnvoyPluginScreenerJobAttachment) => void;
 }
 /**
  * Use to type your `res` object in Envoy "options URL" route handlers.

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

@@ -1 +1 @@
-{"version":3,"file":"EnvoyResponse.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAClE,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAC9F,OAAO,gCAAgC,MAAM,oCAAoC,CAAC;AAElF;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC,IAAI,GAAG,OAAO,CAAE,SAAQ,QAAQ;IACrE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;IAC5B;;;;OAIG;IACH,WAAW,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;IAE7G;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;CAC7G;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC;AAErF;;;GAGG;AACH,oBAAY,6BAA6B,GAAG,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE7F;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,aAAa,CAAC,oCAAoC,CAAC,CAAC;AAEnG;;;;;GAKG;AACH,oBAAY,4BAA4B,CAAC,MAAM,IAAI,aAAa,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC,CAAC"}
+{"version":3,"file":"EnvoyResponse.d.ts","sourceRoot":"","sources":["../../src/sdk/EnvoyResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,wBAAwB,EAAE,EAAE,gCAAgC,EAAE,MAAM,4BAA4B,CAAC;AACxG,OAAO,6BAA6B,MAAM,2CAA2C,CAAC;AACtF,OAAO,oCAAoC,MAAM,kDAAkD,CAAC;AACpG,OAAO,iCAAiC,MAAM,+CAA+C,CAAC;AAC9F,OAAO,gCAAgC,MAAM,oCAAoC,CAAC;AAElF;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC,IAAI,GAAG,OAAO,CAAE,SAAQ,QAAQ;IACrE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC;IAC5B;;;;OAIG;IACH,WAAW,EAAE,CAAC,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;IAE7G;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,KAAK,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;IAC5G;;OAEG;IACH,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,gCAAgC,KAAK,IAAI,CAAC;CACjH;AAED;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,aAAa,CAAC,6BAA6B,CAAC,CAAC;AAErF;;;GAGG;AACH,oBAAY,6BAA6B,GAAG,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAE7F;;;GAGG;AACH,oBAAY,gCAAgC,GAAG,aAAa,CAAC,oCAAoC,CAAC,CAAC;AAEnG;;;;;GAKG;AACH,oBAAY,4BAA4B,CAAC,MAAM,IAAI,aAAa,CAAC,gCAAgC,CAAC,MAAM,CAAC,CAAC,CAAC"}

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;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,CAAC,EAAE,6BAA6B,GAAG,cAAc,CA8EvF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,OAAO,GAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAe,GAAG,mBAAmB,CAU7F"}

package/dist/sdk/middleware.js

@@ -126,6 +126,16 @@ function envoyMiddleware(options) {
                             envoyResponse_1.setHeader('Content-Type', 'application/json');
                             envoyResponse_1.end(JSON.stringify({ message: message, debugInfo: debugInfo, attachments: attachments }));
                         };
+                        /**
+                         * Respond with "failed" for screener in case of screener matches.
+                         */
+                        envoyResponse_1.sendFailedScreen = function (message, debugInfo, attachment) {
+                            if (message === void 0) { message = ''; }
+                            if (debugInfo === void 0) { debugInfo = {}; }
+                            envoyResponse_1.statusCode = HttpStatus_1.default.FAILED;
+                            envoyResponse_1.setHeader('Content-Type', 'application/json');
+                            envoyResponse_1.end(JSON.stringify({ message: message, debugInfo: debugInfo, attachment: attachment }));
+                        };
                         next();
                         return [3 /*break*/, 5];
                     case 4:

package/package.json

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

package/src/sdk/EnvoyPluginJob.ts

@@ -70,9 +70,9 @@ export default class EnvoyPluginJob {
   }
 
   /**
-   * Reports that the job is ignored.
+   * Reports that the job is failed.
    *
-   * Instead of calling this directly, you can return a 400 response from the job's event handler,
+   * Instead of calling this directly, you can return a 412 response from the job's event handler,
    * using {@link EnvoyRequest.sendFailed}.
    */
   fail(message: string, reason: string): Promise<void> {

package/src/sdk/EnvoyPluginJobAttachment.ts

@@ -9,6 +9,17 @@ export interface EnvoyPluginTextJobAttachment {
   value: string;
 }
 
+/**
+ * Display some JSON data in Envoy's dashboard.
+ *
+ * @category Attachment
+ */
+export interface EnvoyPluginJSONJobAttachment {
+  type: 'json';
+  label: string;
+  value: unknown;
+}
+
 /**
  * Display a link in Envoy's dashboard.
  *
@@ -34,6 +45,50 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt
   };
 }
 
+/**
+ * Display a screener report in Envoy's dashboard,
+ * and allow for approval or rejection.
+ *
+ * @category Attachment
+ */
+export interface EnvoyPluginScreenerJobAttachment extends EnvoyPluginJSONJobAttachment {
+  label: string;
+  value: ScreenerDetails;
+}
+
+/**
+ * Screener report definitions
+ */
+export interface ScreenerDetails {
+  input: {
+    fields: ScreenerInputField[];
+  }
+  matches: ScreenerMatch[];
+}
+
+export interface ScreenerMatch {
+  headers: ScreenerMatchHeaders;
+  'visible-fields-count': number;
+  fields: ScreenerMatchField[];
+}
+
+export interface ScreenerMatchHeaders {
+  name: string; // ex: Tags
+  value: string; // ex: Content
+}
+
+export interface ScreenerMatchField {
+  name: string;
+  value: string;
+  type: 'text' | 'image';
+}
+
+export interface ScreenerInputField {
+  name: string;
+  value: string;
+  type: 'text' | 'image';
+}
+
 /**
  * Attachments to jobs, which will be displayed in the Envoy dashboard.
  * Some attachments like `credential_image` can show up in other places,
@@ -44,6 +99,7 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt
 type EnvoyPluginJobAttachment =
   | EnvoyPluginTextJobAttachment
   | EnvoyPluginLinkJobAttachment
-  | EnvoyPluginCredentialJobAttachment;
+  | EnvoyPluginCredentialJobAttachment
+  | EnvoyPluginScreenerJobAttachment;
 
 export default EnvoyPluginJobAttachment;

package/src/sdk/EnvoyResponse.ts

@@ -1,5 +1,5 @@
 import { Response } from 'express';
-import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
+import EnvoyPluginJobAttachment, { EnvoyPluginScreenerJobAttachment } from './EnvoyPluginJobAttachment';
 import EnvoyOptionsRouteResponseBody from '../internal/EnvoyOptionsRouteResponseBody';
 import EnvoySelectedValuesRouteResponseBody from '../internal/EnvoySelectedValuesRouteResponseBody';
 import EnvoyRemoteValueRouteResponseBody from '../internal/EnvoyRemoteValueRouteResponseBody';
@@ -26,6 +26,10 @@ export default interface EnvoyResponse<Body = unknown> extends Response {
    * Marks the job as "failed". The message will be communicated to the Envoy Dashboard user.
    */
   sendFailed: (message: string, debugInfo?: unknown, ...attachments: Array<EnvoyPluginJobAttachment>) => void;
+  /**
+   * Marks the job as "failed". The message will be communicated to the Envoy Dashboard user.
+   */
+  sendFailedScreen: (message: string, debugInfo?: unknown, attachment?: EnvoyPluginScreenerJobAttachment) => void;
 }
 
 /**

package/src/sdk/middleware.ts

@@ -5,7 +5,7 @@ import HttpStatus from '../internal/HttpStatus';
 import EnvoySignatureVerifier, { EnvoySignatureVerifierOptions } from '../util/EnvoySignatureVerifier';
 import EnvoyRequest, { VERIFIED, VerifiedRequest } from './EnvoyRequest';
 import EnvoyResponse from './EnvoyResponse';
-import EnvoyPluginJobAttachment from './EnvoyPluginJobAttachment';
+import EnvoyPluginJobAttachment, { EnvoyPluginScreenerJobAttachment } from './EnvoyPluginJobAttachment';
 import EnvoyPluginSDK from './EnvoyPluginSDK';
 import EnvoyPluginAPI from './EnvoyPluginAPI';
 
@@ -77,6 +77,19 @@ export function envoyMiddleware(options?: EnvoySignatureVerifierOptions): Reques
           envoyResponse.setHeader('Content-Type', 'application/json');
           envoyResponse.end(JSON.stringify({ message, debugInfo, attachments }));
         };
+
+        /**
+         * Respond with "failed" for screener in case of screener matches.
+         */
+        envoyResponse.sendFailedScreen = (
+          message = '',
+          debugInfo: unknown = {},
+          attachment?: EnvoyPluginScreenerJobAttachment,
+        ) => {
+          envoyResponse.statusCode = HttpStatus.FAILED;
+          envoyResponse.setHeader('Content-Type', 'application/json');
+          envoyResponse.end(JSON.stringify({ message, debugInfo, attachment }));
+        };
         next();
       } catch (error) {
         next(error);