@landform.io/sdk 0.1.2

package/dist/index-DoRZImTl.d.ts

@@ -0,0 +1,590 @@
+interface FormContent {
+    schemaVersion: number;
+    welcomeScreens: WelcomeScreen[];
+    fields: FormField[];
+    thankYouScreens: ThankYouScreen[];
+    branching: FieldBranching[];
+    logic: LogicRule[];
+    variables: FormVariables;
+    hiddenFields: HiddenField[];
+}
+interface WelcomeScreen {
+    ref: string;
+    title: string;
+    properties: {
+        description?: string;
+        buttonText?: string;
+        showButton: boolean;
+    };
+    attachment?: Attachment;
+    layout?: Layout;
+    position?: Position;
+}
+interface ThankYouScreen {
+    ref: string;
+    title: string;
+    properties: {
+        description?: string;
+        showButton?: boolean;
+        buttonText?: string;
+        buttonMode?: "reload" | "redirect" | "default";
+        redirectUrl?: string;
+        shareIcons?: boolean;
+    };
+    attachment?: Attachment;
+    layout?: Layout;
+    position?: Position;
+}
+type FieldType = "short_text" | "long_text" | "email" | "phone_number" | "number" | "date" | "dropdown" | "multiple_choice" | "picture_choice" | "ranking" | "rating" | "opinion_scale" | "yes_no" | "legal" | "file_upload" | "payment" | "contact_info" | "group" | "matrix" | "statement" | "website" | "nps" | "address" | "slider" | "signature";
+interface FormFieldBase {
+    ref: string;
+    type: FieldType;
+    title: string;
+    description?: string;
+    validations: FieldValidations;
+    attachment?: Attachment;
+    layout?: Layout;
+    position?: Position;
+}
+interface FieldValidations {
+    required?: boolean;
+    maxLength?: number;
+    minLength?: number;
+    minValue?: number;
+    maxValue?: number;
+    minSelection?: number;
+    maxSelection?: number;
+}
+interface Choice {
+    ref: string;
+    label: string;
+    attachment?: Attachment;
+}
+interface ChoiceFieldProperties {
+    choices: Choice[];
+    allowMultipleSelection?: boolean;
+    allowOtherChoice?: boolean;
+    randomize?: boolean;
+    verticalAlignment?: boolean;
+    showLabels?: boolean;
+    supersized?: boolean;
+}
+interface MultipleChoiceField extends FormFieldBase {
+    type: "multiple_choice";
+    properties: ChoiceFieldProperties;
+}
+interface PictureChoiceField extends FormFieldBase {
+    type: "picture_choice";
+    properties: ChoiceFieldProperties;
+}
+interface DropdownField extends FormFieldBase {
+    type: "dropdown";
+    properties: {
+        choices: Choice[];
+        alphabeticalOrder?: boolean;
+    };
+}
+interface RankingField extends FormFieldBase {
+    type: "ranking";
+    properties: {
+        choices: Choice[];
+    };
+}
+interface RatingField extends FormFieldBase {
+    type: "rating";
+    properties: {
+        steps: number;
+        shape: "star" | "heart" | "thumbsup" | "trophy" | "crown";
+    };
+}
+interface OpinionScaleField extends FormFieldBase {
+    type: "opinion_scale";
+    properties: {
+        steps: number;
+        startAtOne: boolean;
+        labels: {
+            left?: string;
+            center?: string;
+            right?: string;
+        };
+    };
+}
+interface NPSField extends FormFieldBase {
+    type: "nps";
+    properties: {
+        labels: {
+            left?: string;
+            right?: string;
+        };
+    };
+}
+interface ShortTextField extends FormFieldBase {
+    type: "short_text";
+    properties: {
+        placeholder?: string;
+    };
+}
+interface LongTextField extends FormFieldBase {
+    type: "long_text";
+    properties: {
+        placeholder?: string;
+    };
+}
+interface EmailField extends FormFieldBase {
+    type: "email";
+    properties: {
+        placeholder?: string;
+    };
+}
+interface PhoneNumberField extends FormFieldBase {
+    type: "phone_number";
+    properties: {
+        defaultCountryCode?: string;
+    };
+}
+interface WebsiteField extends FormFieldBase {
+    type: "website";
+    properties: {
+        placeholder?: string;
+    };
+}
+interface NumberField extends FormFieldBase {
+    type: "number";
+    properties: {
+        placeholder?: string;
+    };
+}
+interface DateField extends FormFieldBase {
+    type: "date";
+    properties: {
+        structure: "DDMMYYYY" | "MMDDYYYY" | "YYYYMMDD";
+        separator: "/" | "-" | ".";
+    };
+}
+interface YesNoField extends FormFieldBase {
+    type: "yes_no";
+    properties: Record<string, never>;
+}
+interface LegalField extends FormFieldBase {
+    type: "legal";
+    properties: {
+        description: string;
+    };
+}
+interface StatementField extends FormFieldBase {
+    type: "statement";
+    properties: {
+        buttonText: string;
+        hideMarks?: boolean;
+    };
+}
+interface FileUploadField extends FormFieldBase {
+    type: "file_upload";
+    properties: {
+        allowedFileTypes?: string[];
+        maxFileSizeMB?: number;
+        maxFiles?: number;
+    };
+}
+interface ContactInfoField extends FormFieldBase {
+    type: "contact_info";
+    properties: {
+        subfields: {
+            firstName: boolean;
+            lastName: boolean;
+            email: boolean;
+            phoneNumber: boolean;
+            company: boolean;
+        };
+    };
+}
+interface PaymentField extends FormFieldBase {
+    type: "payment";
+    properties: {
+        currency: "USD" | "EUR" | "GBP" | "CAD" | "AUD" | "BRL" | "CHF" | "DKK" | "MXN" | "NOK" | "SEK";
+        price: {
+            type: "fixed" | "variable";
+            value?: number;
+            variableRef?: string;
+        };
+        buttonText?: string;
+        emailReceipts?: boolean;
+    };
+}
+interface GroupField extends FormFieldBase {
+    type: "group";
+    properties: {
+        fields: FormField[];
+        buttonText?: string;
+    };
+}
+interface MatrixField extends FormFieldBase {
+    type: "matrix";
+    properties: {
+        rows: {
+            ref: string;
+            label: string;
+        }[];
+        columns: {
+            ref: string;
+            label: string;
+        }[];
+        allowMultiplePerRow?: boolean;
+    };
+}
+interface AddressField extends FormFieldBase {
+    type: "address";
+    properties: {
+        placeholder?: string;
+        showSecondLine?: boolean;
+        showCountry?: boolean;
+        defaultCountry?: string;
+        autocomplete?: boolean;
+    };
+}
+interface SliderField extends FormFieldBase {
+    type: "slider";
+    properties: {
+        min: number;
+        max: number;
+        step: number;
+        defaultValue?: number;
+        showValue?: boolean;
+        showMinMaxLabels?: boolean;
+        unit?: string;
+        unitPosition?: "prefix" | "suffix";
+    };
+}
+interface SignatureField extends FormFieldBase {
+    type: "signature";
+    properties: {
+        width?: number;
+        height?: number;
+        strokeColor?: string;
+        strokeWidth?: number;
+        backgroundColor?: string;
+        showClearButton?: boolean;
+        showTypedSignature?: boolean;
+    };
+}
+type FormField = ShortTextField | LongTextField | EmailField | PhoneNumberField | NumberField | DateField | DropdownField | MultipleChoiceField | PictureChoiceField | RankingField | RatingField | OpinionScaleField | NPSField | YesNoField | LegalField | StatementField | FileUploadField | ContactInfoField | PaymentField | GroupField | MatrixField | WebsiteField | AddressField | SliderField | SignatureField;
+interface SubPage {
+    id: string;
+    triggerChoiceRefs: string[];
+    field: FormField;
+}
+interface FieldBranching {
+    fieldRef: string;
+    subPages: SubPage[];
+}
+interface LogicRule {
+    ref: string;
+    type: "field" | "hidden";
+    actions: LogicAction[];
+}
+interface LogicAction {
+    action: "jump" | "add" | "subtract" | "multiply" | "divide" | "set";
+    condition: LogicCondition;
+    details: LogicActionDetails;
+}
+interface LogicCondition {
+    op: ConditionOperator;
+    vars: LogicVariable[];
+}
+type ConditionOperator = "always" | "equal" | "not_equal" | "lower_than" | "lower_equal_than" | "greater_than" | "greater_equal_than" | "is" | "is_not" | "begins_with" | "ends_with" | "contains" | "not_contains" | "earlier_than" | "later_than" | "earlier_than_or_on" | "later_than_or_on" | "and" | "or";
+interface LogicVariable {
+    type: "field" | "hidden" | "variable" | "constant" | "choice" | "end";
+    value: string | number | boolean;
+}
+interface LogicActionDetails {
+    to?: {
+        type: "field" | "thankyou" | "outcome";
+        value: string;
+    };
+    target?: {
+        type: "variable";
+        value: string;
+    };
+    value?: {
+        type: "constant" | "variable" | "field";
+        value: string | number;
+    };
+}
+interface FormVariables {
+    score?: number;
+    price?: number;
+    custom?: Record<string, {
+        type: "number" | "string";
+        defaultValue: number | string;
+    }>;
+}
+interface HiddenField {
+    ref: string;
+    type: "hidden";
+    defaultValue?: string;
+}
+interface Attachment {
+    type: "image" | "video";
+    href: string;
+    scale?: number;
+    properties?: {
+        description?: string;
+    };
+}
+interface Layout {
+    type: "split" | "wallpaper" | "float" | "stack";
+    placement?: "left" | "right";
+    viewportOverrides?: {
+        small?: Layout;
+        large?: Layout;
+    };
+}
+interface Position {
+    x: number;
+    y: number;
+}
+interface FontConfig {
+    family: string;
+    size: string;
+    weight: string;
+    lineHeight: string;
+    letterSpacing?: string;
+}
+interface ThemeColors {
+    primary: string;
+    secondary: string;
+    accent: string;
+    background: string;
+    surfaceBackground: string;
+    inputBackground: string;
+    inputBorder: string;
+    questionText: string;
+    answerText: string;
+    placeholderText: string;
+    buttonBackground: string;
+    buttonText: string;
+    buttonHoverBackground: string;
+    selectedBackground: string;
+    selectedBorder: string;
+    errorColor: string;
+    successColor: string;
+    progressBackground: string;
+    progressFill: string;
+}
+interface ThemeTypography {
+    questionFont: FontConfig;
+    answerFont: FontConfig;
+    buttonFont: FontConfig;
+}
+interface ThemeSpacing {
+    questionGap: string;
+    optionGap: string;
+    containerPadding: string;
+}
+interface ThemeBorders {
+    inputBorderWidth: string;
+    inputBorderStyle: "solid" | "dashed" | "none";
+    radius: "none" | "small" | "medium" | "large" | "full";
+}
+interface ThemeAnimations {
+    transitionDuration: string;
+    transitionEasing: string;
+    enableAnimations: boolean;
+}
+interface ThemeBackground {
+    type: "solid" | "gradient" | "image" | "video";
+    value: string;
+    overlay?: string;
+    position?: string;
+}
+interface ThemeProgressBar {
+    enabled: boolean;
+    style: "bar" | "segmented" | "dots" | "percentage";
+    position: "top" | "bottom";
+}
+interface ThemeBranding {
+    showPoweredBy: boolean;
+    brandName?: string;
+    logoUrl?: string;
+    logoPosition?: "top-left" | "top-right" | "bottom";
+    faviconUrl?: string;
+}
+interface ThemeCustomJS {
+    enabled: boolean;
+    code: string;
+    executeOn: ("load" | "submit" | "navigation" | "fieldChange")[];
+}
+/**
+ * Component style variants for templates
+ * These control the visual structure/layout of form components
+ */
+interface ThemeComponentVariants {
+    /** Choice/option rendering style */
+    choiceStyle?: "default" | "card" | "minimal";
+    /** Navigation layout style */
+    navigationLayout?: "floating" | "bottom-bar" | "inline";
+    /** Header layout style */
+    headerLayout?: "none" | "centered-logo" | "left-logo";
+    /** Progress style override */
+    progressStyle?: "bar" | "dots" | "segments" | "percentage" | "fraction";
+    /** Choice layout - single column or grid */
+    choiceLayout?: "single-column" | "two-column" | "auto-grid";
+    /** Choice indicator icon type */
+    choiceIndicator?: "checkmark" | "arrow" | "radio" | "none";
+    /** Navigation visibility control */
+    navigationVisibility?: "always" | "hidden" | "auto-advance";
+    /** Main container max width (e.g., "600px") */
+    containerMaxWidth?: string;
+    /** Choice container max width (e.g., "375px") */
+    choiceContainerMaxWidth?: string;
+}
+interface FormTheme {
+    id?: string;
+    name?: string;
+    description?: string;
+    author?: string;
+    version?: string;
+    isPublic?: boolean;
+    colors: ThemeColors;
+    typography: ThemeTypography;
+    spacing: ThemeSpacing;
+    borders: ThemeBorders;
+    animations: ThemeAnimations;
+    background: ThemeBackground;
+    progressBar: ThemeProgressBar;
+    branding: ThemeBranding;
+    customCSS?: string;
+    customJS?: ThemeCustomJS;
+    componentVariants?: ThemeComponentVariants;
+}
+interface FormSettings {
+    isPublic: boolean;
+    showProgressBar: boolean;
+    showTimeToComplete: boolean;
+    showQuestionNumber: boolean;
+    showKeyHintOnChoices: boolean;
+    hideNavigation: boolean;
+    autosaveProgress: boolean;
+    language: string;
+    systemMessages?: {
+        confirmButtonText?: string;
+        pressEnterText?: string;
+        multipleSelectionHint?: string;
+        dropdownInstruction?: string;
+        dropdownInstructionTouch?: string;
+        requiredText?: string;
+    };
+    showCookieConsent: boolean;
+    captchaEnabled: boolean;
+    duplicatePrevention?: "cookie" | "cookie_ip";
+    googleAnalyticsId?: string;
+    facebookPixelId?: string;
+    googleTagManagerId?: string;
+    meta: {
+        title?: string;
+        description?: string;
+        imageUrl?: string;
+        allowIndexing: boolean;
+    };
+    redirectAfterSubmitUrl?: string;
+    emailNotifications: {
+        enabled: boolean;
+        recipients: string[];
+        includeAnswers: boolean;
+    };
+    scheduling?: {
+        startsAt?: string;
+        endsAt?: string;
+        closedMessage?: string;
+    };
+    responseLimit?: {
+        max: number;
+        limitReachedMessage?: string;
+    };
+}
+type ResponseAnswers = Record<string, FieldAnswer>;
+type FieldAnswer = string | number | boolean | string[] | Record<string, boolean> | AddressValue | SignatureValue | ContactInfoAnswer | FileUploadAnswer;
+interface AddressValue {
+    line1?: string;
+    line2?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+}
+interface SignatureValue {
+    type: "drawn" | "typed";
+    data: string;
+}
+interface ContactInfoAnswer {
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phoneNumber?: string;
+    company?: string;
+}
+interface FileUploadAnswer {
+    files: {
+        id: string;
+        filename: string;
+        url: string;
+        size: number;
+        mimeType: string;
+    }[];
+}
+interface ResponseOutcome {
+    screenRef: string;
+    label?: string;
+    score?: number;
+    variables: Record<string, number | string>;
+}
+interface ResponseMetadata {
+    userAgent?: string;
+    ipAddress?: string;
+    referrer?: string;
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmTerm?: string;
+    utmContent?: string;
+    deviceType?: "desktop" | "mobile" | "tablet";
+    browser?: string;
+    os?: string;
+    country?: string;
+    city?: string;
+}
+interface FormData {
+    projectId: string;
+    content: FormContent;
+    theme: FormTheme;
+    settings: FormSettings;
+}
+interface FormState {
+    responseId: string | null;
+    sessionId: string;
+    currentIndex: number;
+    answers: ResponseAnswers;
+    isStarted: boolean;
+    isCompleted: boolean;
+    isSubmitting: boolean;
+    errors: Record<string, string>;
+}
+interface FieldState {
+    value: FieldAnswer | undefined;
+    error: string | null;
+    touched: boolean;
+    isValid: boolean;
+}
+type ScreenItem = {
+    type: "welcome";
+    screen: WelcomeScreen;
+} | {
+    type: "field";
+    field: FormField;
+    index: number;
+} | {
+    type: "thankYou";
+    screen: ThankYouScreen;
+};
+
+export type { ThemeCustomJS as $, AddressField as A, Layout as B, Choice as C, DropdownField as D, EmailField as E, FormContent as F, GroupField as G, HiddenField as H, Position as I, FontConfig as J, ThemeTypography as K, LongTextField as L, MultipleChoiceField as M, NPSField as N, OpinionScaleField as O, PictureChoiceField as P, ThemeSpacing as Q, RankingField as R, ShortTextField as S, ThemeColors as T, ThemeBorders as U, ThemeAnimations as V, WebsiteField as W, ThemeBackground as X, YesNoField as Y, ThemeProgressBar as Z, ThemeBranding as _, FieldType as a, ThemeComponentVariants as a0, FormTheme as a1, FormSettings as a2, ResponseAnswers as a3, FieldAnswer as a4, AddressValue as a5, SignatureValue as a6, ContactInfoAnswer as a7, FileUploadAnswer as a8, ResponseOutcome as a9, ResponseMetadata as aa, FormData as ab, FormState as ac, FieldState as ad, ScreenItem as ae, WelcomeScreen as af, ThankYouScreen as ag, NumberField as ah, FormFieldBase as b, FieldValidations as c, ChoiceFieldProperties as d, RatingField as e, PhoneNumberField as f, DateField as g, LegalField as h, StatementField as i, FileUploadField as j, ContactInfoField as k, PaymentField as l, MatrixField as m, SliderField as n, SignatureField as o, FormField as p, SubPage as q, FieldBranching as r, LogicRule as s, LogicAction as t, LogicCondition as u, ConditionOperator as v, LogicVariable as w, LogicActionDetails as x, FormVariables as y, Attachment as z };