@envoy/envoy-integrations-sdk 2.4.1-beta.1 → 2.4.2

package/dist/base/EnvoyAPI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EnvoyAPI.d.ts","sourceRoot":"","sources":["../../src/base/EnvoyAPI.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,WAAW,MAAM,8BAA8B,CAAC;AAIvD,UAAU,qBAAsB,SAAQ,WAAW;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AASD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,gCAWX;IAEH;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,iDAW3B;gBAEU,WAAW,EAAE,MAAM;CA2BhC"}
+{"version":3,"file":"EnvoyAPI.d.ts","sourceRoot":"","sources":["../../src/base/EnvoyAPI.ts"],"names":[],"mappings":"AACA,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,WAAW,MAAM,8BAA8B,CAAC;AAKvD,UAAU,qBAAsB,SAAQ,WAAW;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AASD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B;;OAEG;IACH,QAAQ,CAAC,KAAK,gCAWX;IAEH;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,iDAW3B;gBAEU,WAAW,EAAE,MAAM;CA2BhC"}

package/dist/base/EnvoyAPI.js

@@ -43,6 +43,7 @@ var qs_1 = __importDefault(require("qs"));
 var dataloader_1 = __importDefault(require("dataloader"));
 var constants_1 = require("../constants");
 var axiosConstructor_1 = require("../util/axiosConstructor");
+var errorHandling_1 = require("../util/errorHandling");
 /**
  * Sometimes envoy-web will give us back some relationship data
  * with the "type" set to the relationships name instead of the actual model's name.
@@ -108,7 +109,7 @@ var EnvoyAPI = /** @class */ (function () {
             var _a = response.data, modelOrModels = _a.data, included = _a.included;
             (included || []).concat(modelOrModels).forEach(function (model) {
                 if (!model) {
-                    throw new Error('The data you are looking for may not exist.');
+                    throw new Error(errorHandling_1.EMPTY_STORAGE_ERROR_MESSAGE);
                 }
                 _this.dataLoader.prime({ type: model.type, id: model.id }, model);
                 var alias = TYPE_ALIASES.get(model.type);

package/dist/index.d.ts

@@ -50,5 +50,6 @@ export * from './sdk/loggers';
 export * from './sdk/middleware';
 export * from './util/EnvoySignatureVerifier';
 export * from './util/axiosConstructor';
+export * from './util/errorHandling';
 export { EntryPayload, InvitePayload, EnvoyJWT, EnvoyMeta, EnvoyPluginJob, EnvoyPluginJobMock, EnvoyPluginSDK, EnvoyPluginStorage, EnvoyPluginStoragePipeline, EnvoyPluginStoragePipelineMock, EnvoyRequest, EnvoyResponse, EnvoySignatureVerifier, EnvoyStorageItem, EnvoyPluginAPI, EnvoyUserAPI, EnvoyValidationRouteResponseBody, JSONAPIData, JSONAPIResponse, HttpStatus, entryEventBodyFactory, eventBodyFactory, inviteEventBodyFactory, routeBodyFactory, };
 //# 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":"AAAA,OAAO,aAAa,CAAC;AAErB,OAAO,0BAA0B,MAAM,mCAAmC,CAAC;AAE3E,OAAO,qBAAqB,MAAM,mCAAmC,CAAC;AACtE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AACxE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAE5D,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAE/C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,8BAA8B,MAAM,wCAAwC,CAAC;AAEpF,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,aAAa,MAAM,0BAA0B,CAAC;AAErD,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,kBAAkB,MAAM,0BAA0B,CAAC;AAC1D,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,gCAAgC,MAAM,wCAAwC,CAAC;AAEtF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,sBAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,WAAW,MAAM,6BAA6B,CAAC;AACtD,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAE9D,cAAc,mCAAmC,CAAC;AAClD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oCAAoC,CAAC;AACnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AAEzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AAEjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AAExC,OAAO,EACL,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,SAAS,EACT,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,8BAA8B,EAC9B,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,gCAAgC,EAChC,WAAW,EACX,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,GACjB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,CAAC;AAErB,OAAO,0BAA0B,MAAM,mCAAmC,CAAC;AAE3E,OAAO,qBAAqB,MAAM,mCAAmC,CAAC;AACtE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAC5D,OAAO,sBAAsB,MAAM,oCAAoC,CAAC;AACxE,OAAO,gBAAgB,MAAM,8BAA8B,CAAC;AAE5D,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAE/C,OAAO,kBAAkB,MAAM,4BAA4B,CAAC;AAC5D,OAAO,8BAA8B,MAAM,wCAAwC,CAAC;AAEpF,OAAO,YAAY,MAAM,yBAAyB,CAAC;AACnD,OAAO,aAAa,MAAM,0BAA0B,CAAC;AAErD,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,kBAAkB,MAAM,0BAA0B,CAAC;AAC1D,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,gBAAgB,MAAM,wBAAwB,CAAC;AACtD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,gCAAgC,MAAM,wCAAwC,CAAC;AAEtF,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AACvC,OAAO,sBAAsB,MAAM,+BAA+B,CAAC;AACnE,OAAO,WAAW,MAAM,6BAA6B,CAAC;AACtD,OAAO,eAAe,MAAM,iCAAiC,CAAC;AAE9D,cAAc,mCAAmC,CAAC;AAClD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oCAAoC,CAAC;AACnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,8BAA8B,CAAC;AAE7C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,0BAA0B,CAAC;AAEzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AAEjC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AAErC,OAAO,EACL,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,SAAS,EACT,cAAc,EACd,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,0BAA0B,EAC1B,8BAA8B,EAC9B,YAAY,EACZ,aAAa,EACb,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,gCAAgC,EAChC,WAAW,EACX,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,GACjB,CAAC"}

package/dist/index.js

@@ -72,3 +72,4 @@ __exportStar(require("./sdk/loggers"), exports);
 __exportStar(require("./sdk/middleware"), exports);
 __exportStar(require("./util/EnvoySignatureVerifier"), exports);
 __exportStar(require("./util/axiosConstructor"), exports);
+__exportStar(require("./util/errorHandling"), exports);

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, attachments?: 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,WAAW,CAAC,EAAE,gCAAgC,KAAK,IAAI,CAAC;CAClH;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

@@ -1,14 +1,5 @@
 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}.
@@ -18,7 +9,7 @@ export interface EnvoyMiddlewareOptions extends Partial<EnvoySignatureVerifierOp
  *
  * @category Middleware
  */
-export declare function envoyMiddleware(options?: EnvoyMiddlewareOptions): RequestHandler;
+export declare function envoyMiddleware(options?: EnvoySignatureVerifierOptions): 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;;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"}
+{"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

@@ -66,34 +66,25 @@ 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, hasCustomCredentials, _a, rawAccessToken, expiresIn, _b, envoyRequest, envoyResponse_1, error_1;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            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)];
                         }
-                        _c.label = 1;
+                        _b.label = 1;
                     case 1:
-                        _c.trys.push([1, 7, , 8]);
+                        _b.trys.push([1, 4, , 5]);
                         now = Date.now();
-                        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)];
+                        if (!(now > threshold)) return [3 /*break*/, 3];
+                        return [4 /*yield*/, EnvoyPluginAPI_1.default.loginAsPlugin()];
                     case 2:
-                        _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;
+                        _a = _b.sent(), rawAccessToken = _a.access_token, expiresIn = _a.expires_in;
                         accessToken = rawAccessToken;
                         threshold = now + expiresIn * 1000 - 1000 * 60 * 10;
-                        _c.label = 6;
-                    case 6:
+                        _b.label = 3;
+                    case 3:
                         envoyRequest = req;
                         envoyResponse_1 = res;
                         envoyRequest.envoy = new EnvoyPluginSDK_1.default(envoyRequest.body, envoyRequest[EnvoyRequest_1.VERIFIED], accessToken);
@@ -135,13 +126,23 @@ 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, attachments) {
+                            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, attachments: attachments }));
+                        };
                         next();
-                        return [3 /*break*/, 8];
-                    case 7:
-                        error_1 = _c.sent();
+                        return [3 /*break*/, 5];
+                    case 4:
+                        error_1 = _b.sent();
                         next(error_1);
-                        return [3 /*break*/, 8];
-                    case 8: return [2 /*return*/];
+                        return [3 /*break*/, 5];
+                    case 5: return [2 /*return*/];
                 }
             });
         }); });

package/dist/util/errorHandling.d.ts

@@ -1,2 +1,15 @@
+/**
+ * Error message indicating missing data, used to detect missing storage items.
+ * Added in https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/v2.3.1/src/base/EnvoyAPI.ts#L79
+ */
+export declare const EMPTY_STORAGE_ERROR_MESSAGE = "The data you are looking for may not exist";
 export declare function ensureError(value: unknown): Error;
+/**
+ * Check whether an error is due to an item not existing in Envoy.
+ * Certain Envoy operations (notably storage ones) throw an error when an item does not exist, though
+ * non-existence may be expected. Currently, the best way to identify this case is the error message.
+ * @param error - The error to check.
+ * @returns True if the error is likely due to a missing storage item, false otherwise.
+ */
+export declare function isEmptyStorageError(error: Error): boolean;
 //# sourceMappingURL=errorHandling.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"errorHandling.d.ts","sourceRoot":"","sources":["../../src/util/errorHandling.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAcjD"}
+{"version":3,"file":"errorHandling.d.ts","sourceRoot":"","sources":["../../src/util/errorHandling.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,2BAA2B,+CAA+C,CAAC;AAExF,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAcjD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAMzD"}

package/dist/util/errorHandling.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureError = void 0;
+exports.isEmptyStorageError = exports.ensureError = exports.EMPTY_STORAGE_ERROR_MESSAGE = void 0;
+/**
+ * Error message indicating missing data, used to detect missing storage items.
+ * Added in https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/v2.3.1/src/base/EnvoyAPI.ts#L79
+ */
+exports.EMPTY_STORAGE_ERROR_MESSAGE = 'The data you are looking for may not exist';
 function ensureError(value) {
     if (value instanceof Error) {
         return value;
@@ -16,3 +21,17 @@ function ensureError(value) {
     return error;
 }
 exports.ensureError = ensureError;
+/**
+ * Check whether an error is due to an item not existing in Envoy.
+ * Certain Envoy operations (notably storage ones) throw an error when an item does not exist, though
+ * non-existence may be expected. Currently, the best way to identify this case is the error message.
+ * @param error - The error to check.
+ * @returns True if the error is likely due to a missing storage item, false otherwise.
+ */
+function isEmptyStorageError(error) {
+    if (error.message.includes(exports.EMPTY_STORAGE_ERROR_MESSAGE)) {
+        return true;
+    }
+    return false;
+}
+exports.isEmptyStorageError = isEmptyStorageError;

package/package.json

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

package/src/base/EnvoyAPI.ts

@@ -3,6 +3,7 @@ import DataLoader from 'dataloader';
 import JSONAPIData from '../util/json-api/JSONAPIData';
 import { envoyBaseURL } from '../constants';
 import { createAxiosClient } from '../util/axiosConstructor';
+import { EMPTY_STORAGE_ERROR_MESSAGE } from '../util/errorHandling';
 
 interface EnvoyWebDataLoaderKey extends JSONAPIData {
   include?: string;
@@ -72,7 +73,7 @@ export default class EnvoyAPI {
 
         (included || []).concat(modelOrModels).forEach((model: JSONAPIData) => {
           if (!model) {
-            throw new Error('The data you are looking for may not exist.');
+            throw new Error(EMPTY_STORAGE_ERROR_MESSAGE);
           }
           this.dataLoader.prime({ type: model.type, id: model.id }, model);
           const alias = TYPE_ALIASES.get(model.type);

package/src/index.ts

@@ -61,6 +61,7 @@ export * from './sdk/middleware';
 
 export * from './util/EnvoySignatureVerifier';
 export * from './util/axiosConstructor';
+export * from './util/errorHandling';
 
 export {
   EntryPayload,

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, attachments?: EnvoyPluginScreenerJobAttachment) => void;
 }
 
 /**

package/src/sdk/middleware.ts

@@ -5,20 +5,10 @@ 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';
 
-/**
- * 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}.
@@ -28,8 +18,8 @@ export interface EnvoyMiddlewareOptions extends Partial<EnvoySignatureVerifierOp
  *
  * @category Middleware
  */
-export function envoyMiddleware(options?: EnvoyMiddlewareOptions): RequestHandler {
-  const signatureVerifier = new EnvoySignatureVerifier(options as EnvoySignatureVerifierOptions);
+export function envoyMiddleware(options?: EnvoySignatureVerifierOptions): RequestHandler {
+  const signatureVerifier = new EnvoySignatureVerifier(options);
   const verify = (req: VerifiedRequest, res: Response, rawBody: Buffer) => {
     req[VERIFIED] = signatureVerifier.verify(req, rawBody);
   };
@@ -45,10 +35,7 @@ export function envoyMiddleware(options?: EnvoyMiddlewareOptions): RequestHandle
       try {
         const now = Date.now();
         if (now > threshold) {
-          const hasCustomCredentials = options?.customClientId && options?.customClientSecret;
-          const { access_token: rawAccessToken, expires_in: expiresIn } = hasCustomCredentials
-            ? await EnvoyPluginAPI.loginAsPlugin(options?.customClientId, options?.customClientSecret)
-            : await EnvoyPluginAPI.loginAsPlugin();
+          const { access_token: rawAccessToken, expires_in: expiresIn } = await EnvoyPluginAPI.loginAsPlugin();
           accessToken = rawAccessToken;
           threshold = now + expiresIn * 1000 - 1000 * 60 * 10;
         }
@@ -90,6 +77,19 @@ export function envoyMiddleware(options?: EnvoyMiddlewareOptions): RequestHandle
           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 = {},
+          attachments?: EnvoyPluginScreenerJobAttachment,
+        ) => {
+          envoyResponse.statusCode = HttpStatus.FAILED;
+          envoyResponse.setHeader('Content-Type', 'application/json');
+          envoyResponse.end(JSON.stringify({ message, debugInfo, attachments }));
+        };
         next();
       } catch (error) {
         next(error);

package/src/util/errorHandling.ts

@@ -1,3 +1,9 @@
+/**
+ * Error message indicating missing data, used to detect missing storage items.
+ * Added in https://github.com/envoy/envoy-integrations-sdk-nodejs/blob/v2.3.1/src/base/EnvoyAPI.ts#L79
+ */
+export const EMPTY_STORAGE_ERROR_MESSAGE = 'The data you are looking for may not exist';
+
 export function ensureError(value: unknown): Error {
   if (value instanceof Error) {
     return value;
@@ -13,3 +19,18 @@ export function ensureError(value: unknown): Error {
   const error = new Error(`This value was thrown as is, not through an Error: ${stringified}`);
   return error;
 }
+
+/**
+ * Check whether an error is due to an item not existing in Envoy.
+ * Certain Envoy operations (notably storage ones) throw an error when an item does not exist, though
+ * non-existence may be expected. Currently, the best way to identify this case is the error message.
+ * @param error - The error to check.
+ * @returns True if the error is likely due to a missing storage item, false otherwise.
+ */
+export function isEmptyStorageError(error: Error): boolean {
+  if (error.message.includes(EMPTY_STORAGE_ERROR_MESSAGE)) {
+    return true;
+  }
+
+  return false;
+}