@remoteoss/remote-flows 1.55.0 → 1.56.0

package/dist/remoteFlows-XC0Ss0fy.d.ts

@@ -1,554 +0,0 @@
-import { PropsWithChildren, ReactNode } from 'react';
-import { AnySchema } from 'yup';
-import { a1 as HelpCenterArticle } from './types.gen-ClcXnZQX.js';
-import { ControllerRenderProps, FieldValues, ControllerFieldState } from 'react-hook-form';
-
-type ThemeProviderProps = PropsWithChildren<{
-    theme?: Partial<{
-        colors: ThemeColors;
-        spacing: string;
-        borderRadius: string;
-        font: ThemeFont;
-    }>;
-}>;
-type ThemeColors = Partial<{
-    borderInput: string;
-    primaryBackground: string;
-    primaryForeground: string;
-    accentBackground: string;
-    accentForeground: string;
-    danger: string;
-    warningBackground: string;
-    warningBorder: string;
-}>;
-type ThemeFont = {
-    fontSizeBase: string;
-};
-
-type BaseTypes = 'text' | 'number' | 'email' | 'select' | 'multi-select' | 'radio' | 'date' | 'checkbox' | 'textarea' | 'money' | 'file' | 'countries' | 'hidden' | 'work-schedule' | 'tel' | 'time';
-type SupportedTypes = BaseTypes | 'fieldset' | 'fieldset-flat';
-
-type Environment = 'local' | 'partners' | 'production' | 'sandbox' | 'staging';
-declare const ENVIRONMENTS: Record<Environment, string>;
-
-type ColumnDef<T = $TSFixMe> = {
-    id: keyof T;
-    label: React.ReactNode;
-    className?: string;
-    cellClassName?: string;
-    render?: (value: $TSFixMe, row: T, index: number) => React.ReactNode;
-};
-
-type FieldFileDataProps = FieldDataProps & {
-    accept?: string;
-    multiple?: boolean;
-    maxFileSize?: number;
-};
-
-type DailySchedule = {
-    day: string;
-    start_time: string;
-    end_time: string;
-    hours: number;
-    break_duration_minutes: string;
-    checked: boolean;
-};
-
-/**
- * Props for custom field components.
- * All custom field components receive these three props from React Hook Form's Controller.
- */
-type FieldComponentProps = {
-    /**
-     * Field prop from React Hook Form's Controller component.
-     * Contains field state and methods for registration.
-     * You must bind these props to your HTML elements to ensure proper form state management.
-     * @see https://react-hook-form.com/docs/usecontroller/controller
-     */
-    field: ControllerRenderProps<FieldValues, string>;
-    /**
-     * Field state prop from React Hook Form's Controller component.
-     * Contains information about the field's state, such as errors, touched status, etc.
-     * @see https://react-hook-form.com/docs/usecontroller/controller
-     */
-    fieldState: ControllerFieldState;
-    /**
-     * Metadata derived from JSON schema parsing that provides additional context and validation rules for the field.
-     * Contains properties defined in the original JSON schema such as type, format, constraints, etc.
-     */
-    fieldData: FieldDataProps;
-};
-type HelpCenterDataProps = {
-    /**
-     * The call to action text for the help center.
-     */
-    callToAction: string;
-    /**
-     * The Zendesk ID of the help center article.
-     */
-    id: number;
-    /**
-     * The HTML content of the help center article.
-     */
-    content: string;
-    /**
-     * The title of the help center article.
-     */
-    title: string;
-};
-/**
- * Base type for field metadata passed to custom field components.
- * Extends JSFField with optional metadata for extensibility.
- */
-type FieldDataProps = Partial<JSFField> & {
-    metadata?: Record<string, unknown>;
-    meta?: {
-        helpCenter?: HelpCenterDataProps;
-    };
-    /**
-     * Optional node the SDK asks the field to render after the description and its help center
-     * link. Only some fields provide it: the salary field uses it for the currency conversion
-     * toggle when the flow enables the 'split_salary_description' feature. If your custom
-     * component doesn't render it, the toggle won't be available to your users.
-     */
-    descriptionSuffix?: React.ReactNode;
-    /**
-     * Optional HTML transformer function passed from RemoteFlows context.
-     * Use this in custom field components to transform HTML descriptions into React components.
-     * @example
-     * ```tsx
-     * const CustomInput = ({ fieldData }: FieldComponentProps) => {
-     *   const renderDescription = (desc: string) => {
-     *     if (fieldData.transformHtml) {
-     *       return fieldData.transformHtml(desc);
-     *     }
-     *     return <div>{desc}</div>;
-     *   };
-     *   return (
-     *     <div>
-     *       <input />
-     *       {fieldData.description && renderDescription(fieldData.description)}
-     *     </div>
-     *   );
-     * };
-     * ```
-     */
-    transformHtml?: (html: string) => React.ReactNode;
-};
-/**
- * Props for a custom `inputType: file` component.
- *
- * `field.value` is typed as `File[]` for convenience, but for a field that already has a
- * previously uploaded file (e.g. loaded from a `GET` response), an entry can be an
- * {@link UploadedFileReference} instead of a real `File` — it only has `name` (and `id`), not
- * `size`/`type`/any `Blob` method. Check `instanceof File` before relying on anything beyond
- * `.name`.
- */
-type FileComponentProps = FieldComponentProps & {
-    fieldData: FieldFileDataProps;
-};
-/**
- * Reference to a file already uploaded, as returned by the API on `GET` for `inputType: file`
- * fields. Sent back unchanged on the next submit to keep the file instead of re-uploading it.
- *
- * A custom `inputType: file` component (see {@link FileComponentProps}) can receive one of these
- * in place of a real `File` for a field that already had a file attached — it carries no binary
- * content and doesn't implement the `Blob`/`File` interface.
- */
-type UploadedFileReference = {
-    name: string;
-    id: string;
-    sub_type?: string | null;
-};
-type FieldCountryDataProps = Omit<FieldDataProps, 'meta'> & {
-    $meta: {
-        regions: Record<string, string[]>;
-        subregions: Record<string, string[]>;
-    };
-};
-type CountryComponentProps = FieldComponentProps & {
-    fieldData: FieldCountryDataProps;
-};
-type DatePickerDataProps = Omit<FieldDataProps, 'meta'> & {
-    minDate?: string;
-    maxDate?: string;
-};
-type DatePickerComponentProps = FieldComponentProps & {
-    fieldData: DatePickerDataProps;
-};
-type TextFieldDataProps = FieldDataProps & {
-    includeErrorMessage?: boolean;
-};
-type TextFieldComponentProps = FieldComponentProps & {
-    fieldData: TextFieldDataProps;
-};
-type WorkScheduleDataProps = FieldDataProps & {
-    onSubmit: (data: DailySchedule[]) => void;
-    currentSchedule: DailySchedule[];
-    defaultFormattedValue: {
-        workHoursSummary: string[];
-        breakSummary: string[];
-        totalWorkHours: number;
-    };
-};
-type WorkScheduleComponentProps = FieldComponentProps & {
-    fieldData: WorkScheduleDataProps;
-};
-/**
- * Props for custom statement components.
- */
-type StatementComponentProps = {
-    data: {
-        title?: string;
-        description: string;
-        severity: 'warning' | 'error' | 'success' | 'info' | undefined;
-    };
-};
-/**
- * Data passed to custom forced value components.
- * Forced value fields display a non-editable value that is automatically set on the form
- * (via `const`), typically rendered as informational text (e.g. a statement-like description).
- *
- * `title` and `description` are already resolved (statement overrides falling back to
- * label/description) and sanitized where applicable, so custom components don't need to
- * reimplement that fallback logic themselves.
- */
-type ForcedValueDataProps = FieldDataProps & {
-    value: string;
-    title?: string;
-};
-/**
- * Props for custom forced value components.
- */
-type ForcedValueComponentProps = {
-    fieldData: ForcedValueDataProps;
-};
-type PricingPlanDataProps = Omit<Partial<JSFField>, 'options'> & {
-    metadata?: Record<string, unknown>;
-    meta?: {
-        helpCenter?: HelpCenterDataProps;
-    };
-    options: {
-        value: string;
-        label: string;
-        description: string;
-        meta: {
-            features: string[];
-            price: {
-                amount: number;
-                currencyCode: string;
-            };
-        };
-        disabled: boolean;
-    }[];
-};
-type PricingPlanComponentProps = Omit<FieldComponentProps, 'fieldData'> & {
-    fieldData: PricingPlanDataProps;
-};
-type TelFieldDataProps = Omit<FieldDataProps, 'options'> & {
-    options: {
-        value: string;
-        label: string;
-        meta: {
-            countryCode: string;
-        };
-        pattern: string;
-    }[];
-    currentCountry?: {
-        name: string;
-        dialCode: string;
-        pattern: string;
-        areaCodes?: string[];
-    };
-    nationalPhoneNumber?: string;
-    onChangeCountryCode?: (newCountry: {
-        name: string;
-        dialCode: string;
-        pattern: string;
-        areaCodes?: string[];
-    }) => void;
-    onChangePhoneNumber?: (event: React.ChangeEvent<HTMLInputElement>) => void;
-};
-type TelFieldComponentProps = Omit<FieldComponentProps, 'fieldData'> & {
-    fieldData: TelFieldDataProps;
-};
-type RadioGroupDataProps = Omit<FieldDataProps, 'options'> & {
-    options?: Array<{
-        value: string;
-        label: string;
-        description?: string;
-        disabled?: boolean;
-        recommended?: boolean;
-        nested_field?: string;
-        meta?: Record<string, unknown>;
-    }>;
-};
-type RadioGroupComponentProps = Omit<FieldComponentProps, 'fieldData'> & {
-    fieldData: RadioGroupDataProps;
-};
-type TimeFieldDataProps = FieldDataProps & {
-    onChange?: (event: React.ChangeEvent<HTMLInputElement>) => void;
-};
-type TimeFieldComponentProps = FieldComponentProps & {
-    fieldData: TimeFieldDataProps;
-};
-
-type AuthResponse = {
-    accessToken: string;
-    expiresIn: number;
-};
-type JSFFields = Record<string, unknown>[];
-type JSFFieldset = {
-    [x: string]: {
-        propertiesByName: string[];
-        title: string;
-    };
-};
-type JSFField = {
-    computedAttributes: Record<string, unknown>;
-    description: ReactNode;
-    errorMessage: Record<string, string>;
-    inputType: BaseTypes;
-    isVisible: boolean;
-    jsonType: string;
-    label: string;
-    name: string;
-    required: boolean;
-    schema: AnySchema;
-    scopedJsonSchema: Record<string, unknown>;
-    type: string;
-    options?: Array<{
-        value: string;
-        label: string;
-        description?: string;
-        disabled?: boolean;
-        meta?: Record<string, unknown>;
-    }>;
-    defaultValue?: string | number;
-    minDate?: string;
-    maxDate?: string;
-    maxLength?: number;
-    multiple?: boolean;
-    meta?: Record<string, unknown>;
-};
-/**
- * Props passed to custom Component when using jsfModify with x-jsf-presentation.
- * Used when overriding field rendering via the Component prop in jsfModify options.
- */
-type JSFCustomComponentProps = JSFField & {
-    setValue: (value: unknown) => void;
-    value: string;
-};
-type TableComponentProps<T = $TSFixMe> = {
-    ref: React.ForwardedRef<HTMLTableElement>;
-    data: T[] | undefined;
-    columns: ColumnDef<T>[];
-    className?: string;
-    headerRowClassName?: string;
-    bodyRowClassName?: string | ((row: T, index: number) => string);
-};
-/**
- * Props for custom button components.
- */
-type ButtonComponentProps = {
-    /**
-     * The form ID that the button should be associated with.
-     */
-    form?: string;
-    /**
-     * The children content of the button.
-     */
-    children?: React.ReactNode;
-} & React.ButtonHTMLAttributes<HTMLButtonElement> & Record<string, unknown>;
-type ZendeskDrawerComponentProps = {
-    open: boolean;
-    onClose: () => void;
-    data?: HelpCenterArticle;
-    isLoading: boolean;
-    error: Error | null;
-    zendeskURL: string;
-    Trigger: React.ReactElement;
-};
-/**
- * Props for custom Zendesk trigger button components.
- */
-type ZendeskTriggerButtonComponentProps = {
-    /**
-     * The Zendesk ID for the help article
-     */
-    zendeskId: number;
-    /**
-     * The class name for the button
-     */
-    className?: string;
-    /**
-     * The callback function to be called when the button is clicked
-     */
-    onClick?: (zendeskId: number) => void;
-    /**
-     * The children to be rendered inside the button
-     */
-    children?: React.ReactNode;
-    /**
-     * Whether to open the help article in a new tab
-     */
-    external?: boolean;
-} & Record<string, unknown>;
-type DrawerComponentProps = {
-    open: boolean;
-    onOpenChange: (open: boolean) => void;
-    title: React.ReactNode;
-    trigger: React.ReactElement;
-    children?: React.ReactNode;
-    direction?: 'left' | 'right' | 'bottom' | 'top';
-    className?: string;
-};
-type FieldSetToggleComponentProps = {
-    isExpanded: boolean;
-    onToggle: () => void;
-    'aria-expanded': boolean;
-    'aria-controls': string;
-    'aria-label': string;
-    className?: string;
-    children?: React.ReactNode;
-};
-type PDFPreviewComponentProps = {
-    base64Data: string;
-    fileName?: string;
-};
-type FieldComponentTypes = Exclude<BaseTypes, 'file' | 'countries' | 'text' | 'work-schedule' | 'hidden' | 'money' | 'date' | 'tel' | 'time' | 'radio'>;
-type Components = {
-    [K in FieldComponentTypes]?: React.ComponentType<FieldComponentProps>;
-} & {
-    text?: React.ComponentType<TextFieldComponentProps>;
-    file?: React.ComponentType<FileComponentProps>;
-    date?: React.ComponentType<DatePickerComponentProps>;
-    countries?: React.ComponentType<CountryComponentProps>;
-    statement?: React.ComponentType<StatementComponentProps>;
-    forcedValue?: React.ComponentType<ForcedValueComponentProps>;
-    button?: React.ComponentType<ButtonComponentProps>;
-    fieldsetToggle?: React.ComponentType<FieldSetToggleComponentProps>;
-    zendeskDrawer?: React.ComponentType<ZendeskDrawerComponentProps>;
-    zendeskTriggerButton?: React.ComponentType<ZendeskTriggerButtonComponentProps>;
-    drawer?: React.ComponentType<DrawerComponentProps>;
-    table?: React.ComponentType<TableComponentProps>;
-    'work-schedule'?: React.ComponentType<WorkScheduleComponentProps>;
-    pdfViewer?: React.ComponentType<PDFPreviewComponentProps>;
-    tel?: React.ComponentType<TelFieldComponentProps>;
-    time?: React.ComponentType<TimeFieldComponentProps>;
-    radio?: React.ComponentType<RadioGroupComponentProps>;
-};
-type RemoteFlowsSDKProps = Omit<ThemeProviderProps, 'children'> & {
-    /**
-     * Function to authenticate the user and obtain an access token.
-     * Optional when using cookie-based authentication (via the `credentials` prop).
-     * When provided, bearer token authentication will be used.
-     * @returns A promise that resolves to an object containing the access token and its expiration time.
-     */
-    auth?: () => Promise<AuthResponse>;
-    /**
-     * Components to override the default field components used in the SDK.
-     */
-    components?: Components;
-    /**
-     * Environment to use for API calls.
-     * If not provided, the SDK will use production environment.
-     */
-    environment?: keyof typeof ENVIRONMENTS;
-    proxy?: {
-        /**
-         * URL of the proxy server to use for API calls.
-         */
-        url: string;
-        /**
-         * Headers to include in the API requests.
-         */
-        headers?: {
-            [key: string]: string;
-        };
-    };
-    /**
-     * Error boundary configuration.
-     */
-    errorBoundary?: {
-        /**
-         * If true, re-throws errors to parent error boundary.
-         * If false, shows fallback UI to prevent crashes.
-         * @default false
-         */
-        useParentErrorBoundary?: boolean;
-        /**
-         * Custom fallback UI to show when an error occurs.
-         * fallback only works when rethrow is false.
-         * If not provided, shows default error message.
-         */
-        fallback?: ReactNode | ((error: Error) => ReactNode);
-    };
-    /**
-     * Debug mode to enable logging of telemetry errors to the console.
-     * @default false
-     */
-    debug?: boolean;
-    /**
-     * Credentials mode for fetch requests.
-     * If not provided, credentials will not be included in requests.
-     * Set to 'include' to include credentials (cookies, authorization headers) in cross-origin requests.
-     * Set to 'same-origin' to only include credentials for same-origin requests.
-     * @default undefined (credentials not included)
-     */
-    credentials?: RequestCredentials;
-    /**
-     * Optional function to transform HTML strings into React components.
-     * Allows partners to replace specific HTML patterns (e.g., <details data-component="Accordion">)
-     * with custom React components.
-     *
-     * @param htmlContent - The raw HTML string to transform (unsanitized)
-     * @returns React elements or the original HTML
-     *
-     * @remarks
-     * Security: This function receives UNSANITIZED HTML. If you're using html-react-parser,
-     * note that it does NOT sanitize HTML by default. You are responsible for sanitizing
-     * untrusted HTML before parsing. Consider using DOMPurify or sanitize-html.
-     *
-     * @example
-     * ```tsx
-     * import parse, { domToReact } from 'html-react-parser';
-     * import DOMPurify from 'dompurify';
-     *
-     * function transformHtmlToComponents(htmlContent: string) {
-     *   // Sanitize first (recommended)
-     *   const clean = DOMPurify.sanitize(htmlContent);
-     *   return parse(clean, parseOptions);
-     * }
-     * ```
-     */
-    transformHtmlToComponents?: (htmlContent: string) => ReactNode;
-};
-type $TSFixMe = any;
-declare global {
-    interface Window {
-        RemoteFlowsSDK?: {
-            version: string;
-        };
-    }
-}
-type MetaValues = {
-    label?: string;
-    prettyValue?: string | boolean;
-    inputType?: string;
-    desiredCurrency?: string;
-};
-/**
- * Meta is a record of field names and their values.
- * @deprecated Use NestedMeta instead.
- */
-type Meta = Record<string, MetaValues>;
-/**
- * NestedMeta is a record of field names and their values.
- * This is used to retrieve the label for a field from the meta data.
- */
-interface NestedMeta {
-    [key: string]: MetaValues | NestedMeta;
-}
-
-export type { $TSFixMe as $, ButtonComponentProps as B, Components as C, DatePickerComponentProps as D, FieldComponentProps as F, JSFFields as J, Meta as M, NestedMeta as N, PDFPreviewComponentProps as P, RemoteFlowsSDKProps as R, SupportedTypes as S, TelFieldComponentProps as T, UploadedFileReference as U, WorkScheduleComponentProps as W, ZendeskDrawerComponentProps as Z, JSFCustomComponentProps as a, JSFFieldset as b, JSFField as c, CountryComponentProps as d, DrawerComponentProps as e, FieldSetToggleComponentProps as f, FileComponentProps as g, ForcedValueComponentProps as h, MetaValues as i, PricingPlanComponentProps as j, PricingPlanDataProps as k, RadioGroupComponentProps as l, StatementComponentProps as m, TextFieldComponentProps as n, TimeFieldComponentProps as o, ZendeskTriggerButtonComponentProps as p };