@piiano/forms/dist/module/options.d.ts

Piiano Forms SDK

import type { FormInitOptions, ViewInitOptions } from './common/models';
export type ProtectedViewOptions = ViewInitOptions & {
    hooks?: ProtectedViewHooks;
};
export type ProtectedFormOptions<T extends ResultType> = Omit<FormInitOptions, 'strategy'> & {
    strategy?: Strategy<T>;
    hooks?: Hooks<T>;
};
export type ControlFormOptions<T extends ResultType> = Pick<FormInitOptions, 'globalVaultIdentifiers' | 'collection' | 'tenantId' | 'reason' | 'vaultURL' | 'apiKey'> & {
    strategy?: Strategy<T>;
    /**
     * After the vault tokenize/encrypt the form fields on form submission, this option will re-trigger the original form submit event handler with the tokenized/encrypted values.
     * This option will manipulate the form inputs, to hold the tokenized/encrypted values, while still displaying the original values.
     */
    replayOriginalEvents?: boolean;
    hooks?: Hooks<T>;
};
export type ResultType = 'object' | 'fields';
export type Result<T extends ResultType> = T extends 'object' ? string : Record<string, string>;
export type Strategy<T extends ResultType> = Exclude<`${'tokenize' | 'store' | 'encrypt'}-${T}`, 'store-fields'>;
export type SubmitOptions<T extends ResultType> = Pick<FormInitOptions, 'globalVaultIdentifiers' | 'collection' | 'tenantId' | 'reason' | 'expiration' | 'storeObject'> & {
    strategy?: Strategy<T>;
};
export type ViewIframeOptions = Omit<ProtectedViewOptions, 'hooks'>;
export type IframeOptions<T extends ResultType> = Omit<ProtectedFormOptions<T>, 'hooks'>;
export type Hooks<T extends ResultType> = ErrorHook & {
    onSubmit?: (result: Result<T>) => void;
};
export type ErrorHook = {
    onError?: (error: Error) => void;
};
export type ProtectedViewHooks = ErrorHook & {
    onClick?: (event: {
        path: string;
    }) => void;
    onMouseEnter?: (event: {
        path: string;
        x: number;
        y: number;
    }) => void;
    onMouseLeave?: (event: {
        path: string;
    }) => void;
};