import type { IExecutionBase } from '@n8n/db'; import type { IWorkflowBase, JsonObject } from 'n8n-workflow'; import { EventMessageTypeNames } from 'n8n-workflow'; import type { EventNamesWorkflowType } from '.'; import { AbstractEventMessage, isEventMessageOptionsWithType } from './abstract-event-message'; import type { AbstractEventMessageOptions } from './abstract-event-message-options'; import type { AbstractEventPayload } from './abstract-event-payload'; // -------------------------------------- // EventMessage class for Workflow events // -------------------------------------- export interface EventPayloadWorkflow extends AbstractEventPayload { msg?: string; workflowData?: IWorkflowBase; executionId?: IExecutionBase['id']; workflowId?: IWorkflowBase['id']; } export interface EventMessageWorkflowOptions extends AbstractEventMessageOptions { eventName: EventNamesWorkflowType; payload?: EventPayloadWorkflow | undefined; } export class EventMessageWorkflow extends AbstractEventMessage { readonly __type = EventMessageTypeNames.workflow; eventName: EventNamesWorkflowType; payload: EventPayloadWorkflow; constructor(options: EventMessageWorkflowOptions) { super(options); if (options.payload) this.setPayload(options.payload); if (options.anonymize) { this.anonymize(); } } setPayload(payload: EventPayloadWorkflow): this { this.payload = payload; return this; } deserialize(data: JsonObject): this { if (isEventMessageOptionsWithType(data, this.__type)) { this.setOptionsOrDefault(data); if (data.payload) this.setPayload(data.payload as EventPayloadWorkflow); } return this; } }