API Reference

class FormComposer<TElements, TLayouts, TSteppers, TActions> {
	constructor(elementRegistry?: ElementRegistry);
 
	addElement<T>(registration: ElementRegistration<T>): FormComposer<...>;
	addLayout<T>(registration: LayoutRegistration<T>): FormComposer<...>;
	addStepper<T>(registration: StepperRegistration<T>): FormComposer<...>;
	addAction<T>(registration: BuilderActionRegistration<T>): FormComposer<...>;
 
	clone(): FormComposer<...>;
	build(): FormEngine<...>;
}

class FormEngine<TElements, TLayouts, TSteppers, TActions> {
	// Elements
	getElement(id: string): ElementRegistration | undefined;
	getAllElements(): ElementRegistration[];
	hasElement(id: string): boolean;
 
	// Layouts
	getLayout(id: string): LayoutRegistration | undefined;
	getAllLayouts(): LayoutRegistration[];
	hasLayout(id: string): boolean;
 
	// Steppers
	getStepper(id: string): StepperRegistration | undefined;
	getAllSteppers(): StepperRegistration[];
	hasStepper(id: string): boolean;
 
	// Actions
	getAction(type: string): BuilderActionRegistration | undefined;
	getAllActions(): BuilderActionRegistration[];
	hasAction(type: string): boolean;
 
	// Schema
	getFormConfigSchema(): z.ZodType<FormConfig>;
	generateJSONSchemaCollection(opts?: { target?: string }): object;
	generateFormConfigSchema(opts?: { target?: string }): object;
 
	// Utilities
	getSummary(): EngineSummary;
	toComposer(): FormComposer<...>;
}

interface ElementRegistration<TConfig> {
	$type: string;
	schema: z.ZodType<TConfig>;
	metadata: ElementMetadata;
	render: (props: ElementRenderProps<TConfig>) => unknown;
}

interface LayoutRegistration<TConfig> {
	$type: string;
	schema: z.ZodType<TConfig>;
	metadata: ComponentMetadata;
	render: (props: LayoutRenderProps<TConfig>) => unknown;
}

interface StepperRegistration<TConfig> {
	$type: string;
	schema: z.ZodType<TConfig>;
	metadata: ComponentMetadata;
	render: (props: StepperRenderProps<TConfig>) => unknown;
}

interface BuilderActionRegistration<TConfig> {
	$type: string;
	schema: z.ZodType<TConfig>;
	metadata: ActionMetadata<BuilderActionTrigger>;
	execute: (context: BuilderActionExecutionContext) => Promise<BuilderActionExecutionResult>;
}

interface ElementMetadata extends ComponentMetadata {
	category: 'input' | 'content' | 'decoration' | 'interactive';
}

interface ActionMetadata<TTrigger> {
	name: string;
	description?: string;
	icon?: string;
	defaultTriggers?: readonly TTrigger[];
}

class GDPRConsent {
	static isLocalStorageAvailable(): boolean;
	static getConsent(): { granted: boolean; version: string; timestamp: string } | null;
	static hasConsent(): boolean;
	static grantConsent(): void;
	static revokeConsent(): void;
	static needsConsentUpdate(): boolean;
	static saveDraft(formId: string, data: Record<string, any>): boolean;
	static loadDraft(formId: string): Record<string, any> | null;
	static clearDraft(formId: string): void;
}

class GTMTracker {
	static isAvailable(): boolean;
	static push(event: string, data?: Record<string, any>): void;
	static pushFormEvent(
		eventType: 'form_mount' | 'form_step_complete' | 'form_submit' | 'form_abandon',
		formData?: Record<string, any>,
		metadata?: Record<string, any>
	): void;
	static initialize(containerId: string): void;
}