@hostwebhook/node 1.4.2 → 1.5.0

package/dist/index.d.mts

@@ -140,6 +140,30 @@ declare function createNestGuard(secret: string, options?: VerifyOptions): {
  */
 declare function fastifyHook(secret: string, options?: VerifyOptions): (req: ExpressRequest, reply: ExpressResponse, done: NextFn) => void;
 
+/**
+ * Supported file event types for `sendWithFiles`.
+ * Each type corresponds to a File Transform operation in the pipeline.
+ * New types are added here as new operations are supported.
+ */
+declare const FileEventType: {
+    readonly PDF_UPLOAD: "pdf_upload";
+    readonly CSV_UPLOAD: "csv_upload";
+    readonly IMAGE_RESIZE: "image_resize";
+    readonly IMAGE_COMPRESS: "image_compress";
+};
+/** Union of all supported file event types. */
+type FileEventType = typeof FileEventType[keyof typeof FileEventType];
+/**
+ * Payload for `sendWithFiles`. Enforces a valid `eventType` from `FileEventType`.
+ */
+interface FilePayload extends Record<string, unknown> {
+    /** The file processing operation to perform. Must be a supported `FileEventType`. */
+    eventType: FileEventType;
+    /** Original file name (for logging and downstream nodes). */
+    fileName?: string;
+    /** File size in bytes (for logging). */
+    fileSize?: number;
+}
 /** Static secret signature — sends the secret as-is in a header (no HMAC). */
 interface StaticSignature {
     type: 'static';
@@ -345,7 +369,7 @@ declare class HostWebhook {
      * );
      * ```
      */
-    sendWithFiles(tokenOrPayload: string | Record<string, unknown>, payloadOrFiles: Record<string, unknown> | Record<string, {
+    sendWithFiles(tokenOrPayload: string | FilePayload, payloadOrFiles: FilePayload | Record<string, {
         data: Buffer | Blob | Uint8Array;
         fileName: string;
         mimeType: string;
@@ -408,4 +432,4 @@ declare class PipelineStream {
  */
 declare function send(config: HostWebhookConfig, payload: Record<string, unknown>, options?: SendOptions): Promise<SendResult>;
 
-export { HostWebhook, type HostWebhookConfig, type PipelineStep, SendError, type SendOptions, type SendResult, type StaticSignature, VerificationError, type VerifyOptions, type WebhookHeaders, createNestGuard, expressMiddleware, fastifyHook, parseHeaders, send, verify };
+export { FileEventType, type FilePayload, HostWebhook, type HostWebhookConfig, type PipelineStep, SendError, type SendOptions, type SendResult, type StaticSignature, VerificationError, type VerifyOptions, type WebhookHeaders, createNestGuard, expressMiddleware, fastifyHook, parseHeaders, send, verify };

package/dist/index.d.ts

@@ -140,6 +140,30 @@ declare function createNestGuard(secret: string, options?: VerifyOptions): {
  */
 declare function fastifyHook(secret: string, options?: VerifyOptions): (req: ExpressRequest, reply: ExpressResponse, done: NextFn) => void;
 
+/**
+ * Supported file event types for `sendWithFiles`.
+ * Each type corresponds to a File Transform operation in the pipeline.
+ * New types are added here as new operations are supported.
+ */
+declare const FileEventType: {
+    readonly PDF_UPLOAD: "pdf_upload";
+    readonly CSV_UPLOAD: "csv_upload";
+    readonly IMAGE_RESIZE: "image_resize";
+    readonly IMAGE_COMPRESS: "image_compress";
+};
+/** Union of all supported file event types. */
+type FileEventType = typeof FileEventType[keyof typeof FileEventType];
+/**
+ * Payload for `sendWithFiles`. Enforces a valid `eventType` from `FileEventType`.
+ */
+interface FilePayload extends Record<string, unknown> {
+    /** The file processing operation to perform. Must be a supported `FileEventType`. */
+    eventType: FileEventType;
+    /** Original file name (for logging and downstream nodes). */
+    fileName?: string;
+    /** File size in bytes (for logging). */
+    fileSize?: number;
+}
 /** Static secret signature — sends the secret as-is in a header (no HMAC). */
 interface StaticSignature {
     type: 'static';
@@ -345,7 +369,7 @@ declare class HostWebhook {
      * );
      * ```
      */
-    sendWithFiles(tokenOrPayload: string | Record<string, unknown>, payloadOrFiles: Record<string, unknown> | Record<string, {
+    sendWithFiles(tokenOrPayload: string | FilePayload, payloadOrFiles: FilePayload | Record<string, {
         data: Buffer | Blob | Uint8Array;
         fileName: string;
         mimeType: string;
@@ -408,4 +432,4 @@ declare class PipelineStream {
  */
 declare function send(config: HostWebhookConfig, payload: Record<string, unknown>, options?: SendOptions): Promise<SendResult>;
 
-export { HostWebhook, type HostWebhookConfig, type PipelineStep, SendError, type SendOptions, type SendResult, type StaticSignature, VerificationError, type VerifyOptions, type WebhookHeaders, createNestGuard, expressMiddleware, fastifyHook, parseHeaders, send, verify };
+export { FileEventType, type FilePayload, HostWebhook, type HostWebhookConfig, type PipelineStep, SendError, type SendOptions, type SendResult, type StaticSignature, VerificationError, type VerifyOptions, type WebhookHeaders, createNestGuard, expressMiddleware, fastifyHook, parseHeaders, send, verify };

package/dist/index.js

@@ -28,6 +28,7 @@ var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "acce
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  FileEventType: () => FileEventType,
   HostWebhook: () => HostWebhook,
   SendError: () => SendError,
   VerificationError: () => VerificationError,
@@ -195,6 +196,12 @@ function fastifyHook(secret, options) {
 var import_crypto2 = require("crypto");
 
 // src/send-types.ts
+var FileEventType = {
+  PDF_UPLOAD: "pdf_upload",
+  CSV_UPLOAD: "csv_upload",
+  IMAGE_RESIZE: "image_resize",
+  IMAGE_COMPRESS: "image_compress"
+};
 var SendError = class extends Error {
   constructor(message, statusCode, responseBody) {
     super(message);
@@ -647,6 +654,7 @@ async function send(config, payload, options) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  FileEventType,
   HostWebhook,
   SendError,
   VerificationError,

package/dist/index.mjs

@@ -162,6 +162,12 @@ function fastifyHook(secret, options) {
 import { createHmac as createHmac2 } from "crypto";
 
 // src/send-types.ts
+var FileEventType = {
+  PDF_UPLOAD: "pdf_upload",
+  CSV_UPLOAD: "csv_upload",
+  IMAGE_RESIZE: "image_resize",
+  IMAGE_COMPRESS: "image_compress"
+};
 var SendError = class extends Error {
   constructor(message, statusCode, responseBody) {
     super(message);
@@ -613,6 +619,7 @@ async function send(config, payload, options) {
   return client.send(payload, options);
 }
 export {
+  FileEventType,
   HostWebhook,
   SendError,
   VerificationError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hostwebhook/node",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Official HostWebhook SDK — verify signatures, parse headers, and send webhooks",
   "main": "dist/index.js",
   "module": "dist/index.mjs",