[fix] Screener Job Attachments (#102)

Zmatarasso · web-flow · commit f6758f99a0e8 · 2025-12-05T10:55:08.000-05:00
* update attachment name

* update version

* add back spreader

* Force label to be 'Screener Details'
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@envoy/envoy-integrations-sdk",
-  "version": "2.4.2",
+  "version": "2.4.3",
   "description": "SDK for building Envoy integrations.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
diff --git a/src/sdk/EnvoyPluginJobAttachment.ts b/src/sdk/EnvoyPluginJobAttachment.ts
@@ -52,7 +52,7 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt
  * @category Attachment
  */
 export interface EnvoyPluginScreenerJobAttachment extends EnvoyPluginJSONJobAttachment {
-  label: string;
+  label: 'Screener Details';
   value: ScreenerDetails;
 }
 
diff --git a/src/sdk/EnvoyResponse.ts b/src/sdk/EnvoyResponse.ts
@@ -29,7 +29,7 @@ export default interface EnvoyResponse<Body = unknown> extends Response {
   /**
    * Marks the job as "failed". The message will be communicated to the Envoy Dashboard user.
    */
-  sendFailedScreen: (message: string, debugInfo?: unknown, attachments?: EnvoyPluginScreenerJobAttachment) => void;
+  sendFailedScreen: (message: string, debugInfo?: unknown, ...attachments: Array<EnvoyPluginScreenerJobAttachment>) => void;
 }
 
 /**
diff --git a/src/sdk/middleware.ts b/src/sdk/middleware.ts
@@ -84,7 +84,7 @@ export function envoyMiddleware(options?: EnvoySignatureVerifierOptions): Reques
         envoyResponse.sendFailedScreen = (
           message = '',
           debugInfo: unknown = {},
-          attachments?: EnvoyPluginScreenerJobAttachment,
+          ...attachments: Array<EnvoyPluginScreenerJobAttachment>
         ) => {
           envoyResponse.statusCode = HttpStatus.FAILED;
           envoyResponse.setHeader('Content-Type', 'application/json');

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@envoy/envoy-integrations-sdk",`
`3`		`- "version": "2.4.2",`
	`3`	`+ "version": "2.4.3",`
`4`	`4`	`"description": "SDK for building Envoy integrations.",`
`5`	`5`	`"main": "dist/index.js",`
`6`	`6`	`"types": "dist/index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ export interface EnvoyPluginCredentialJobAttachment extends EnvoyPluginTextJobAt`
`52`	`52`	`* @category Attachment`
`53`	`53`	`*/`
`54`	`54`	`export interface EnvoyPluginScreenerJobAttachment extends EnvoyPluginJSONJobAttachment {`
`55`		`- label: string;`
	`55`	`+ label: 'Screener Details';`
`56`	`56`	`value: ScreenerDetails;`
`57`	`57`	`}`
`58`	`58`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ export default interface EnvoyResponse<Body = unknown> extends Response {`
`29`	`29`	`/**`
`30`	`30`	`* Marks the job as "failed". The message will be communicated to the Envoy Dashboard user.`
`31`	`31`	`*/`
`32`		`- sendFailedScreen: (message: string, debugInfo?: unknown, attachments?: EnvoyPluginScreenerJobAttachment) => void;`
	`32`	`+ sendFailedScreen: (message: string, debugInfo?: unknown, ...attachments: Array<EnvoyPluginScreenerJobAttachment>) => void;`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/**`