/* eslint-disable @typescript-eslint/naming-convention */ /* eslint-disable import/no-cycle */ import { ExecutionError, ICredentialDataDecryptedObject, ICredentialsDecrypted, ICredentialsEncrypted, IDataObject, IDeferredPromise, IExecuteResponsePromiseData, IRun, IRunData, IRunExecutionData, ITaskData, ITelemetrySettings, IWorkflowBase as IWorkflowBaseWorkflow, Workflow, WorkflowExecuteMode, } from 'n8n-workflow'; import { WorkflowExecute } from 'n8n-core'; // eslint-disable-next-line import/no-extraneous-dependencies import * as PCancelable from 'p-cancelable'; import { Repository } from 'typeorm'; import { ChildProcess } from 'child_process'; import { Url } from 'url'; import { Request } from 'express'; import { WorkflowEntity } from './databases/entities/WorkflowEntity'; import { TagEntity } from './databases/entities/TagEntity'; import { Role } from './databases/entities/Role'; import { User } from './databases/entities/User'; import { SharedCredentials } from './databases/entities/SharedCredentials'; import { SharedWorkflow } from './databases/entities/SharedWorkflow'; import { Settings } from './databases/entities/Settings'; export interface IActivationError { time: number; error: { message: string; }; } export interface IBullJobData { executionId: string; loadStaticData: boolean; } export interface IBullJobResponse { success: boolean; } export interface IBullWebhookResponse { executionId: string; response: IExecuteResponsePromiseData; } export interface ICustomRequest extends Request { parsedUrl: Url | undefined; } export interface ICredentialsTypeData { [key: string]: { className: string; sourcePath: string; }; } export interface ICredentialsOverwrite { [key: string]: ICredentialDataDecryptedObject; } export interface IDatabaseCollections { Credentials: Repository | null; Execution: Repository | null; Workflow: Repository | null; Webhook: Repository | null; Tag: Repository | null; Role: Repository | null; User: Repository | null; SharedCredentials: Repository | null; SharedWorkflow: Repository | null; Settings: Repository | null; } export interface IWebhookDb { workflowId: number | string; webhookPath: string; method: string; node: string; webhookId?: string; pathLength?: number; } // ---------------------------------- // settings // ---------------------------------- export interface ISettingsDb { key: string; value: string | boolean | IDataObject | number; loadOnStartup: boolean; } // ---------------------------------- // tags // ---------------------------------- export interface ITagDb { id: number; name: string; createdAt: Date; updatedAt: Date; } export type UsageCount = { usageCount: number; }; export type ITagWithCountDb = ITagDb & UsageCount; // ---------------------------------- // workflows // ---------------------------------- export interface IWorkflowBase extends IWorkflowBaseWorkflow { id?: number | string; } // Almost identical to editor-ui.Interfaces.ts export interface IWorkflowDb extends IWorkflowBase { id: number | string; tags: ITagDb[]; } export interface IWorkflowResponse extends IWorkflowBase { id: string; } // ---------------------------------- // credentials // ---------------------------------- export interface ICredentialsBase { createdAt: Date; updatedAt: Date; } export interface ICredentialsDb extends ICredentialsBase, ICredentialsEncrypted { id: number | string; name: string; } export interface ICredentialsResponse extends ICredentialsDb { id: string; } export interface ICredentialsDecryptedDb extends ICredentialsBase, ICredentialsDecrypted { id: number | string; } export interface ICredentialsDecryptedResponse extends ICredentialsDecryptedDb { id: string; } export type DatabaseType = 'mariadb' | 'postgresdb' | 'mysqldb' | 'sqlite'; export type SaveExecutionDataType = 'all' | 'none'; export interface IExecutionBase { id?: number | string; mode: WorkflowExecuteMode; startedAt: Date; stoppedAt?: Date; // empty value means execution is still running workflowId?: string; // To be able to filter executions easily // finished: boolean; retryOf?: number | string; // If it is a retry, the id of the execution it is a retry of. retrySuccessId?: number | string; // If it failed and a retry did succeed. The id of the successful retry. } // Data in regular format with references export interface IExecutionDb extends IExecutionBase { data: IRunExecutionData; waitTill?: Date; workflowData?: IWorkflowBase; } export interface IExecutionPushResponse { executionId?: string; waitingForWebhook?: boolean; } export interface IExecutionResponse extends IExecutionBase { id: string; data: IRunExecutionData; retryOf?: string; retrySuccessId?: string; waitTill?: Date; workflowData: IWorkflowBase; } // Flatted data to save memory when saving in database or transfering // via REST API export interface IExecutionFlatted extends IExecutionBase { data: string; workflowData: IWorkflowBase; } export interface IExecutionFlattedDb extends IExecutionBase { id: number | string; data: string; waitTill?: Date | null; workflowData: IWorkflowBase; } export interface IExecutionFlattedResponse extends IExecutionFlatted { id: string; retryOf?: string; } export interface IExecutionsListResponse { count: number; // results: IExecutionShortResponse[]; results: IExecutionsSummary[]; estimated: boolean; } export interface IExecutionsStopData { finished?: boolean; mode: WorkflowExecuteMode; startedAt: Date; stoppedAt?: Date; } export interface IExecutionsSummary { id: string; finished?: boolean; mode: WorkflowExecuteMode; retryOf?: string; retrySuccessId?: string; waitTill?: Date; startedAt: Date; stoppedAt?: Date; workflowId: string; workflowName?: string; } export interface IExecutionsCurrentSummary { id: string; retryOf?: string; startedAt: Date; mode: WorkflowExecuteMode; workflowId: string; } export interface IExecutionDeleteFilter { deleteBefore?: Date; filters?: IDataObject; ids?: string[]; } export interface IExecutingWorkflowData { executionData: IWorkflowExecutionDataProcess; process?: ChildProcess; startedAt: Date; postExecutePromises: Array>; responsePromise?: IDeferredPromise; workflowExecution?: PCancelable; } export interface IExternalHooks { credentials?: { create?: Array<{ (this: IExternalHooksFunctions, credentialsData: ICredentialsEncrypted): Promise; }>; delete?: Array<{ (this: IExternalHooksFunctions, credentialId: string): Promise }>; update?: Array<{ (this: IExternalHooksFunctions, credentialsData: ICredentialsDb): Promise; }>; }; workflow?: { activate?: Array<{ (this: IExternalHooksFunctions, workflowData: IWorkflowDb): Promise }>; create?: Array<{ (this: IExternalHooksFunctions, workflowData: IWorkflowBase): Promise }>; delete?: Array<{ (this: IExternalHooksFunctions, workflowId: string): Promise }>; execute?: Array<{ ( this: IExternalHooksFunctions, workflowData: IWorkflowDb, mode: WorkflowExecuteMode, ): Promise; }>; update?: Array<{ (this: IExternalHooksFunctions, workflowData: IWorkflowDb): Promise }>; }; } export interface IExternalHooksFileData { [key: string]: { // eslint-disable-next-line @typescript-eslint/no-explicit-any [key: string]: Array<(...args: any[]) => Promise>; }; } export interface IExternalHooksFunctions { dbCollections: IDatabaseCollections; } export interface IExternalHooksClass { init(): Promise; // eslint-disable-next-line @typescript-eslint/no-explicit-any run(hookName: string, hookParameters?: any[]): Promise; } export interface IDiagnosticInfo { versionCli: string; databaseType: DatabaseType; notificationsEnabled: boolean; disableProductionWebhooksOnMainProcess: boolean; basicAuthActive: boolean; systemInfo: { os: { type?: string; version?: string; }; memory?: number; cpus: { count?: number; model?: string; speed?: number; }; }; executionVariables: { [key: string]: string | number | undefined; }; deploymentType: string; binaryDataMode: string; n8n_multi_user_allowed: boolean; smtp_set_up: boolean; } export interface ITelemetryUserDeletionData { user_id: string; target_user_old_status: 'active' | 'invited'; migration_strategy?: 'transfer_data' | 'delete_data'; target_user_id?: string; migration_user_id?: string; } export interface IInternalHooksClass { onN8nStop(): Promise; onServerStarted( diagnosticInfo: IDiagnosticInfo, firstWorkflowCreatedAt?: Date, ): Promise; onPersonalizationSurveySubmitted(userId: string, answers: Record): Promise; onWorkflowCreated(userId: string, workflow: IWorkflowBase): Promise; onWorkflowDeleted(userId: string, workflowId: string): Promise; onWorkflowSaved(userId: string, workflow: IWorkflowBase): Promise; onWorkflowPostExecute( executionId: string, workflow: IWorkflowBase, runData?: IRun, userId?: string, ): Promise; onUserDeletion(userId: string, userDeletionData: ITelemetryUserDeletionData): Promise; onUserInvite(userInviteData: { user_id: string; target_user_id: string[] }): Promise; onUserReinvite(userReinviteData: { user_id: string; target_user_id: string }): Promise; onUserUpdate(userUpdateData: { user_id: string; fields_changed: string[] }): Promise; onUserInviteEmailClick(userInviteClickData: { user_id: string }): Promise; onUserPasswordResetEmailClick(userPasswordResetData: { user_id: string }): Promise; onUserTransactionalEmail(userTransactionalEmailData: { user_id: string; message_type: 'Reset password' | 'New user invite' | 'Resend invite'; }): Promise; onUserPasswordResetRequestClick(userPasswordResetData: { user_id: string }): Promise; onInstanceOwnerSetup(instanceOwnerSetupData: { user_id: string }): Promise; onUserSignup(userSignupData: { user_id: string }): Promise; } export interface IN8nConfig { database: IN8nConfigDatabase; endpoints: IN8nConfigEndpoints; executions: IN8nConfigExecutions; generic: IN8nConfigGeneric; host: string; nodes: IN8nConfigNodes; port: number; protocol: 'http' | 'https'; } export interface IN8nConfigDatabase { type: DatabaseType; postgresdb: { host: string; password: string; port: number; user: string; }; } export interface IN8nConfigEndpoints { rest: string; webhook: string; webhookTest: string; } // eslint-disable-next-line import/export export interface IN8nConfigExecutions { saveDataOnError: SaveExecutionDataType; saveDataOnSuccess: SaveExecutionDataType; saveDataManualExecutions: boolean; } // eslint-disable-next-line import/export export interface IN8nConfigExecutions { saveDataOnError: SaveExecutionDataType; saveDataOnSuccess: SaveExecutionDataType; saveDataManualExecutions: boolean; } export interface IN8nConfigGeneric { timezone: string; } export interface IN8nConfigNodes { errorTriggerType: string; exclude: string[]; } export interface IVersionNotificationSettings { enabled: boolean; endpoint: string; infoUrl: string; } export interface IN8nUISettings { endpointWebhook: string; endpointWebhookTest: string; saveDataErrorExecution: string; saveDataSuccessExecution: string; saveManualExecutions: boolean; executionTimeout: number; maxExecutionTimeout: number; oauthCallbackUrls: { oauth1: string; oauth2: string; }; timezone: string; urlBaseWebhook: string; urlBaseEditor: string; versionCli: string; n8nMetadata?: { [key: string]: string | number | undefined; }; versionNotifications: IVersionNotificationSettings; instanceId: string; telemetry: ITelemetrySettings; personalizationSurveyEnabled: boolean; defaultLocale: string; userManagement: IUserManagementSettings; workflowTagsDisabled: boolean; logLevel: 'info' | 'debug' | 'warn' | 'error' | 'verbose'; hiringBannerEnabled: boolean; templates: { enabled: boolean; host: string; }; } export interface IPersonalizationSurveyAnswers { codingSkill: string | null; companyIndustry: string[]; companySize: string | null; otherCompanyIndustry: string | null; otherWorkArea: string | null; workArea: string[] | string | null; } export interface IUserManagementSettings { enabled: boolean; showSetupOnFirstLoad?: boolean; smtpSetup: boolean; } export interface IPackageVersions { cli: string; } export type IPushDataType = IPushData['type']; export type IPushData = | PushDataExecutionFinished | PushDataExecutionStarted | PushDataExecuteAfter | PushDataExecuteBefore | PushDataConsoleMessage | PushDataTestWebhook; type PushDataExecutionFinished = { data: IPushDataExecutionFinished; type: 'executionFinished'; }; type PushDataExecutionStarted = { data: IPushDataExecutionStarted; type: 'executionStarted'; }; type PushDataExecuteAfter = { data: IPushDataNodeExecuteAfter; type: 'nodeExecuteAfter'; }; type PushDataExecuteBefore = { data: IPushDataNodeExecuteBefore; type: 'nodeExecuteBefore'; }; type PushDataConsoleMessage = { data: IPushDataConsoleMessage; type: 'sendConsoleMessage'; }; type PushDataTestWebhook = { data: IPushDataTestWebhook; type: 'testWebhookDeleted' | 'testWebhookReceived'; }; export interface IPushDataExecutionFinished { data: IRun; executionId: string; retryOf?: string; } export interface IPushDataExecutionStarted { executionId: string; mode: WorkflowExecuteMode; startedAt: Date; retryOf?: string; workflowId: string; workflowName?: string; } export interface IPushDataNodeExecuteAfter { data: ITaskData; executionId: string; nodeName: string; } export interface IPushDataNodeExecuteBefore { executionId: string; nodeName: string; } export interface IPushDataTestWebhook { executionId: string; workflowId: string; } export interface IPushDataConsoleMessage { source: string; message: string; } export interface IResponseCallbackData { data?: IDataObject | IDataObject[]; headers?: object; noWebhookResponse?: boolean; responseCode?: number; } export interface ITransferNodeTypes { [key: string]: { className: string; sourcePath: string; }; } export interface IWorkflowErrorData { [key: string]: IDataObject | string | number | ExecutionError; execution: { id?: string; error: ExecutionError; lastNodeExecuted: string; mode: WorkflowExecuteMode; }; workflow: { id?: string; name: string; }; } export interface IProcessMessageDataHook { hook: string; // eslint-disable-next-line @typescript-eslint/no-explicit-any parameters: any[]; } export interface IWorkflowExecutionDataProcess { destinationNode?: string; executionMode: WorkflowExecuteMode; executionData?: IRunExecutionData; runData?: IRunData; retryOf?: number | string; sessionId?: string; startNodes?: string[]; workflowData: IWorkflowBase; userId: string; } export interface IWorkflowExecutionDataProcessWithExecution extends IWorkflowExecutionDataProcess { credentialsOverwrite: ICredentialsOverwrite; credentialsTypeData: ICredentialsTypeData; executionId: string; nodeTypeData: ITransferNodeTypes; userId: string; } export interface IWorkflowExecuteProcess { startedAt: Date; workflow: Workflow; workflowExecute: WorkflowExecute; } export type WhereClause = Record;