n8n/packages/nodes-base/nodes/Form/interfaces.ts

import type { GenericValue } from 'n8n-workflow';

export type FormField = {
	id: string;
	errorId: string;
	label: string;
	placeholder?: string;
	inputRequired: 'form-required' | '';
	type?: 'text' | 'number' | 'date' | 'email';
	defaultValue: GenericValue;

	isInput?: boolean;
	isTextarea?: boolean;

	isSelect?: boolean;
	selectOptions?: string[];

	isMultiSelect?: boolean;
	radioSelect?: 'radio';
	exactSelectedOptions?: number;
	minSelectedOptions?: number;
	maxSelectedOptions?: number;
	multiSelectOptions?: Array<{ id: string; label: string }>;

	isFileInput?: boolean;
	acceptFileTypes?: string;
	multipleFiles?: 'multiple' | '';

	isHtml?: boolean;
	html?: string;

	isHidden?: boolean;
	hiddenName?: string;
	hiddenValue?: GenericValue;
};

export type FormTriggerData = {
	testRun: boolean;
	formTitle: string;
	formDescription?: string;
	formDescriptionMetadata?: string;
	formSubmittedHeader?: string;
	formSubmittedText?: string;
	redirectUrl?: string;
	n8nWebsiteLink: string;
	formFields: FormField[];
	useResponseData?: boolean;
	appendAttribution?: boolean;
	buttonLabel?: string;
	dangerousCustomCss?: string;
	authToken?: string;
	// True when this form is rendered inside the hosting-shell iframe: the submit
	// button starts disabled (the shell enables it once the submitter's required
	// credentials are connected). Enforcement is server-side on POST regardless.
	shellInner?: boolean;
	// Only a form that identifies its submitter can be refused by the submit-time
	// credential gate, so this is what decides whether the handling for that
	// rejection is rendered at all. Deliberately broader than the gate's own
	// condition: on a real `n8nUserAuth` GET the submitter is redirected to the
	// OAuth2 provider, which would make the client branch untestable without
	// Keycloak and a license.
	hasAuthenticatedSubmitter?: boolean;
	// Set only when this render sits inside the n8n hosting shell's frame: the path
	// prefix whose pages the form may ask the shell to navigate to, instead of
	// navigating itself (a navigation the sandboxed document starts itself is
	// treated as cross-site and loses the form's auth cookie). Absent everywhere
	// else — including a form embedded on someone else's site — which leaves the
	// form navigating itself, as it always has.
	hostNavigationPath?: string;
};

export const FORM_TRIGGER_AUTHENTICATION_PROPERTY = 'authentication';