@zealicsolutions/web-ui 1.0.133 → 1.0.135

package/dist/esm/containers/types/moleculeTypes.d.ts

@@ -0,0 +1,596 @@
+import { AlertMoleculeProps, BadgeMoleculeProps, BasicTextFieldProps, BinaryRadioButtonsProps, ButtonProps, CheckboxProps, ChecklistItem, ChecklistProps, ChipMoleculeProps, DateCalendarProps, DatePickerMoleculeProps, DividerProps, ImageProps, LinkProps, RatingMoleculeProps, SelectMoleculeProps, SliderMoleculeProps, StepperProps, TextProps, VideoProps } from 'molecules';
+/**
+ * [ NEW MOLECULE: 2 ] Import new molecule props from the molecule index
+ *
+ *  */
+import { Dispatch, SetStateAction } from 'react';
+import { UseFormReturn } from 'react-hook-form';
+import type { AnyObject, Nullable, StrictUnion } from 'typescript';
+import { MaskConfig } from '../../components/Input/helpers';
+import { AccordionProps } from '../../molecules/Accordion/Accordion';
+import { AvatarMoleculeProps } from '../../molecules/Avatar/Avatar';
+import { DrawerProps } from '../../molecules/Drawer/types';
+import { EmailInputFieldProps } from '../../molecules/EmailInputField/EmailInputField';
+import { MenuProps } from '../../molecules/Menu/Menu';
+import { NumericInputFieldProps } from '../../molecules/NumericInputField/NumericInputField';
+import { PhoneNumberInputFieldProps } from '../../molecules/PhoneNumberInputField/PhoneNumberInputField';
+import { SpeedDialItem, SpeedDialProps } from '../../molecules/SpeedDial/types';
+import { TabsProps } from '../../molecules/Tabs/Tabs';
+import { AccordionItemDTO, ChecklistItemDTO, DividerItemDTO, ImageItemDTO, MenuItemDTO, RichTextItemDTO, StepperItemDTO, TabsItemDTO, TextItemDTO } from './moleculeItemTypes';
+import { ConditionConfig, ContainerComponentProps, MetadataType } from './types';
+export type ActionTypes = 'link' | 'popup' | 'drawer' | 'download' | 'submit' | 'reset' | 'destroy' | 'navigate_to_create_form' | 'navigate_to_edit_form' | 'navigate_to_prepopulate_form' | 'navigate_to_organism_with_rwo_context' | 'navigate_to_page_with_rwo_context';
+export type DataModelFieldFormatCodeTypes = 'date' | 'email' | 'string' | 'integer' | 'boolean' | 'numeric' | 'zip_code' | 'phone_number';
+export type DataModelFieldFormatValueTypes = 'any' | 'text' | 'email' | 'integer' | 'numerical' | 'us_zip_code' | 'phone_number' | 'month_year_date' | 'day_month_year_date' | 'month_day_year_date' | 'year_month_day_date';
+export type DownloadFile = {
+    url: string;
+    name: string;
+};
+type LinkAction = LinkProperties;
+type PopupDrawerAction = ContainerComponentProps;
+type DownloadAction = DownloadFile;
+type SubmitAction = AnyObject;
+type CancelAction = AnyObject;
+type ResetAction = AnyObject;
+type DestroyAction = AnyObject;
+type Action = {
+    type: ActionTypes;
+} & Partial<{
+    link: LinkAction;
+    popup: PopupDrawerAction;
+    drawer: PopupDrawerAction;
+    download: DownloadAction;
+    submit: SubmitAction;
+    cancel: CancelAction;
+    reset: ResetAction;
+    destroy: DestroyAction;
+    logout: AnyObject;
+    targetFormId: string;
+    fieldMap: Array<{
+        source: string;
+        destination: string;
+    }>;
+}>;
+export type FormStateType = 'default' | 'success' | 'error' | 'format_error' | 'field_error' | 'open_dropdown' | 'match_error';
+export type ImageProperties = {
+    attributeType?: 'image';
+    propertyType?: 'image';
+    imageSource?: string;
+    imageFile?: {
+        id?: string;
+        name?: string;
+        url?: string;
+    };
+};
+export interface TextProperties {
+    id?: string;
+    text?: string;
+    isRichText?: boolean;
+    attributeType?: 'text';
+    propertyType?: 'text';
+    required?: boolean;
+    showRichTextToolbar?: boolean;
+}
+export interface VideoProperties {
+    attributeType?: 'video';
+    propertyType?: 'video';
+    videoSource?: string;
+    videoFile?: {
+        id?: string;
+        name?: string;
+        url?: string;
+    };
+    required?: boolean;
+}
+export interface ActionProperties {
+    attributeType?: 'action';
+    propertyType?: 'action';
+    action: Action;
+    required?: boolean;
+}
+export interface LinkProperties {
+    id?: string;
+    attributeType?: 'link';
+    propertyType?: 'link';
+    type: 'internalLink' | 'externalLink' | 'external_link' | 'internal_link';
+    internalLink?: Nullable<string>;
+    externalLink?: Nullable<string>;
+    name?: string;
+    required?: boolean;
+}
+export interface BooleanProperties {
+    attributeType: 'boolean';
+    value: boolean;
+}
+export type DataModelFieldFormat = {
+    id: string;
+    label: string;
+    value: DataModelFieldFormatValueTypes;
+    code: DataModelFieldFormatCodeTypes;
+    config: MaskConfig;
+};
+export type DataConnectionValues = {
+    dataFieldName: string;
+    dataModelFieldId: string;
+    defaultValue?: string;
+    entitySubtypeId?: string;
+    entitySubtypeName?: string;
+    format: DataModelFieldFormat;
+};
+export interface ConditionConfigProperties {
+    id: string;
+    attributeType: 'condition_config';
+    conditionConfig: ConditionConfig;
+}
+export interface ColorProperties {
+    attributeType: 'color';
+    color: string;
+}
+export interface ChecklistProperties {
+    checklist: {
+        attributeType: 'checklist';
+        items: ChecklistItem[];
+    };
+}
+export interface StateProperties {
+    attributeType: 'state';
+    value: number | string | boolean;
+}
+export type DataCaptureProperties = {
+    dataCaptureName: string;
+    isConfigurable?: boolean;
+    sourceDataModelFieldId: string;
+    predefinedValue?: string;
+};
+export type ObjectStateProperties = {
+    attributeType: 'object_state';
+    pmiObjectId: string | null;
+};
+export interface DateProperties {
+    attributeType: 'date';
+    value: Date | string | null;
+}
+export type StepperItemTypes = 'stepper_item';
+export type ChecklistItemTypes = 'checklist_item';
+export type AccordionItemTypes = 'accordion_item';
+export type MenuItemTypes = 'menu_item';
+export type TabsItemTypes = 'tabs_item';
+export type DrawerItemTypes = 'menu_item' | 'divider_item' | 'text_item' | 'rich_text_item' | 'image_item';
+export type SpeedDialItemTypes = 'speed_dial_action_item';
+export type MoleculeItemTypes = StepperItemTypes | ChecklistItemTypes | AccordionItemTypes | MenuItemTypes | TabsItemTypes | DrawerItemTypes | SpeedDialItemTypes;
+export type DataCaptureMoleculeTypes = 'basic_text_field' | 'email_input_field' | 'phone_number_input_field' | 'numeric_input_field' | 'currency_input_field' | 'select' | 'date_picker' | 'time_picker' | 'date_calendar' | 'rating' | 'switch' | 'slider' | 'checkbox' | 'checkbox_display' | 'binary_radio_buttons' | 'binary_radio_buttons_display' | 'consent' | 'signup_password_fields' | 'visit';
+export type DataDisplayMoleculeTypes = 'simple_text' | 'text' | 'basic_text_display_field' | 'email_display_field' | 'phone_number_display_field' | 'numeric_display_field' | 'currency_display_field' | 'select_display_field' | 'rating_display_field' | 'switch_display_field' | 'slider_display_field' | 'date_display_field' | 'time_picker_display' | 'date_calendar_display' | 'alert' | 'badge' | 'chip' | 'link' | 'avatar';
+export type ComplexMoleculeTypes = 'stepper' | 'checklist' | 'accordion' | 'menu' | 'drawer' | 'tabs' | 'speed_dial' | 'divider';
+export type SimpleMoleculeTypes = 'button' | 'video' | 'image';
+export type MoleculeTypes = DataCaptureMoleculeTypes | DataDisplayMoleculeTypes | ComplexMoleculeTypes | SimpleMoleculeTypes;
+/**
+ * [ NEW MOLECULE: 3 ] Second Step is to add the new molecule name to this list, in snake case format
+ *
+ *  */
+export interface BaseMoleculeType {
+    id: string;
+    name: string;
+    type: MoleculeTypes;
+    instance: 'molecule';
+    metadata: MetadataType;
+    moleculeLibraryId: string;
+    organismLibraryMoleculeId: string;
+}
+export interface TextMoleculeType extends BaseMoleculeType {
+    type: 'text';
+    properties: Partial<{
+        text: TextProperties;
+    }>;
+    config: {
+        props?: TextProps;
+    };
+}
+export interface SimpleTextMoleculeType extends BaseMoleculeType {
+    type: 'simple_text';
+    properties: Partial<{
+        text: TextProperties;
+    }>;
+    config: {
+        props?: TextProps;
+    };
+}
+export interface ConsentFieldMoleculeType extends BaseMoleculeType {
+    type: 'consent';
+    properties: Partial<{
+        consent: Partial<{
+            attributeType: 'consent';
+            consent: ConsentType;
+            required: BooleanProperties;
+            dataCaptureName: string;
+            predefinedValue: string;
+        }>;
+        conditionConfig: ConditionConfigProperties;
+    }>;
+    config: {
+        props: Partial<{
+            state: 'field_error';
+        }>;
+    };
+}
+export interface PasswordSetupMoleculeType extends BaseMoleculeType {
+    type: 'signup_password_fields';
+    properties: Partial<{
+        text: TextProperties;
+        subText: TextProperties;
+        placeholderText: TextProperties;
+        subPlaceholderText: TextProperties;
+        validationText: TextProperties;
+    }>;
+    config: {
+        props: {
+            state?: FormStateType;
+            dataCaptureName: string;
+        } & BasicTextFieldProps;
+    };
+}
+export interface StepperMoleculeType extends BaseMoleculeType {
+    type: 'stepper';
+    config: {
+        props: Omit<StepperProps, 'items'>;
+    };
+    children: StepperItemDTO[];
+    organismMoleculeLibraryId: string;
+}
+export interface ChecklistsMoleculeType extends BaseMoleculeType {
+    type: 'checklist';
+    config: {
+        props: Omit<ChecklistProps, 'items'>;
+    };
+    children: ChecklistItemDTO[];
+}
+export interface AccordionMoleculeType extends BaseMoleculeType {
+    type: 'accordion';
+    config: {
+        props: Omit<AccordionProps, 'items'>;
+    };
+    children: AccordionItemDTO[];
+}
+export interface MenuMoleculeType extends BaseMoleculeType {
+    type: 'menu';
+    config: {
+        props: Omit<MenuProps, 'items'>;
+    };
+    properties: {
+        text: TextProperties;
+        disabled: BooleanProperties;
+    };
+    children: MenuItemDTO[];
+}
+export interface TabsMoleculeType extends BaseMoleculeType {
+    type: 'tabs';
+    config: {
+        props: Omit<TabsProps, 'items'>;
+    };
+    children: TabsItemDTO[];
+}
+export interface DividerMoleculeType extends BaseMoleculeType {
+    type: 'divider';
+    config: {
+        props: DividerProps;
+    };
+}
+export interface LinkMoleculeType extends BaseMoleculeType {
+    type: 'link';
+    config: {
+        props: LinkProps;
+    };
+    properties: {
+        text: TextProperties;
+        link: LinkProperties;
+    };
+}
+export interface VideoMoleculeType extends BaseMoleculeType {
+    type: 'video';
+    config: {
+        props: VideoProps;
+    };
+    properties: {
+        video: VideoProperties;
+        coverImage: ImageProperties;
+    };
+}
+export interface ImageMoleculeType extends BaseMoleculeType {
+    type: 'image';
+    config: {
+        props: ImageProps;
+    };
+    properties: {
+        image: ImageProperties;
+        link: LinkProperties;
+    };
+}
+export interface ButtonMoleculeType extends BaseMoleculeType {
+    type: 'button';
+    config: {
+        props: ButtonProps;
+    };
+    properties: {
+        text: TextProperties;
+        action: ActionProperties;
+    };
+}
+export interface ChipMoleculeType extends BaseMoleculeType {
+    type: 'chip';
+    config: {
+        props: ChipMoleculeProps;
+    };
+    properties: {
+        text: TextProperties;
+    };
+}
+export interface BadgeMoleculeType extends BaseMoleculeType {
+    type: 'badge';
+    config: {
+        props: BadgeMoleculeProps;
+    };
+    properties: {
+        text: TextProperties;
+    };
+}
+export interface AlertMoleculeType extends BaseMoleculeType {
+    type: 'alert';
+    config: {
+        props: AlertMoleculeProps;
+    };
+    properties: {
+        text: TextProperties;
+        subText: TextProperties;
+    };
+}
+export interface BasicTextFieldMoleculeType extends BaseMoleculeType {
+    type: 'basic_text_field' | 'basic_text_display_field';
+    config: {
+        props: BasicTextFieldProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface RatingMoleculeType extends BaseMoleculeType {
+    type: 'rating' | 'rating_display_field';
+    config: {
+        props: RatingMoleculeProps;
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface SwitchMoleculeType extends BaseMoleculeType {
+    type: 'switch' | 'switch_display_field';
+    config: {
+        props: AlertMoleculeProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        subText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface SliderMoleculeType extends BaseMoleculeType {
+    type: 'slider' | 'slider_display_field';
+    config: {
+        props: SliderMoleculeProps;
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface SelectMoleculeType extends BaseMoleculeType {
+    type: 'select' | 'select_display_field';
+    config: {
+        props: SelectMoleculeProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface DatePickerMoleculeType extends BaseMoleculeType {
+    type: 'date_picker' | 'date_display_field';
+    config: {
+        props: DatePickerMoleculeProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface TimePickerMoleculeType extends BaseMoleculeType {
+    type: 'time_picker' | 'time_picker_display';
+    config: {
+        props?: Record<string, unknown>;
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface EmailInputFieldMoleculeType extends BaseMoleculeType {
+    type: 'email_input_field' | 'email_display_field';
+    config: {
+        props: EmailInputFieldProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface PhoneNumberInputFieldMoleculeType extends BaseMoleculeType {
+    type: 'phone_number_input_field' | 'phone_number_display_field';
+    config: {
+        props: PhoneNumberInputFieldProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface NumericInputFieldMoleculeType extends BaseMoleculeType {
+    type: 'numeric_input_field' | 'numeric_display_field';
+    config: {
+        props: NumericInputFieldProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface CurrencyInputFieldMoleculeType extends BaseMoleculeType {
+    type: 'currency_input_field' | 'currency_display_field';
+    config: {
+        props: NumericInputFieldProps & {
+            dataCaptureName?: string;
+        };
+    };
+    properties: {
+        text: TextProperties;
+        placeholderText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface AvatarMoleculeType extends BaseMoleculeType {
+    type: 'avatar';
+    config: {
+        props: Omit<AvatarMoleculeProps, 'sourceDataModelField' | 'configurationItemInfo'>;
+    };
+    properties: {
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface VisitMoleculeType extends BaseMoleculeType {
+    type: 'visit';
+    config: {
+        props: Omit<VisitMoleculeProps, 'configurationItemInfo'>;
+    };
+    properties: {
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface DateCalendarMoleculeType extends BaseMoleculeType {
+    type: 'date_calendar' | 'date_calendar_display';
+    config: {
+        props: DateCalendarProps;
+    };
+    properties: {
+        required?: BooleanProperties;
+        requiredErrorText?: TextProperties;
+        validationErrorText?: TextProperties;
+        dataCapture?: DataCaptureProperties;
+    };
+}
+export interface DrawerMoleculeType extends BaseMoleculeType {
+    type: 'drawer';
+    config: {
+        props: Omit<DrawerProps, 'items' | 'configurationItemInfo' | 'onInternalNavigation' | 'moleculeId'>;
+    };
+    properties: {
+        text: TextProperties;
+        disabled: BooleanProperties;
+    };
+    children: (MenuItemDTO | DividerItemDTO | TextItemDTO | RichTextItemDTO | ImageItemDTO)[];
+}
+export interface SpeedDialMoleculeType extends BaseMoleculeType {
+    type: 'speed_dial';
+    config: {
+        props: Omit<SpeedDialProps, 'items' | 'configurationItemInfo' | 'isConfigurationMode' | 'selectedConfigurationItemId' | 'onInternalNavigation'>;
+    };
+    properties: {};
+    children: SpeedDialItem[];
+}
+export interface CheckboxMoleculeType extends BaseMoleculeType {
+    type: 'checkbox' | 'checkbox_display';
+    config: {
+        props: CheckboxProps;
+    };
+    properties: {
+        label: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export interface BinaryRadioButtonsMoleculeType extends BaseMoleculeType {
+    type: 'binary_radio_buttons' | 'binary_radio_buttons_display';
+    config: {
+        props: BinaryRadioButtonsProps;
+    };
+    properties: {
+        confirmText: TextProperties;
+        rejectText: TextProperties;
+        requiredErrorText: TextProperties;
+        validationErrorText: TextProperties;
+        required: BooleanProperties;
+        dataCapture: DataCaptureProperties;
+    };
+}
+export type Molecule = StrictUnion<SimpleTextMoleculeType | TextMoleculeType | ConsentFieldMoleculeType | PasswordSetupMoleculeType | StepperMoleculeType | ChecklistsMoleculeType | AccordionMoleculeType | MenuMoleculeType | DrawerMoleculeType | TabsMoleculeType | DividerMoleculeType | LinkMoleculeType | VideoMoleculeType | ImageMoleculeType | ButtonMoleculeType | ChipMoleculeType | BadgeMoleculeType | AlertMoleculeType | BasicTextFieldMoleculeType | RatingMoleculeType | SwitchMoleculeType | SliderMoleculeType | SelectMoleculeType | DatePickerMoleculeType | TimePickerMoleculeType | EmailInputFieldMoleculeType | PhoneNumberInputFieldMoleculeType | NumericInputFieldMoleculeType | CurrencyInputFieldMoleculeType | AvatarMoleculeType | VisitMoleculeType | DateCalendarMoleculeType | SpeedDialMoleculeType | CheckboxMoleculeType | BinaryRadioButtonsMoleculeType> & Partial<{
+    form: UseFormReturn<Record<string, unknown>>;
+    formData: AnyObject;
+    setFormData: Dispatch<SetStateAction<AnyObject>>;
+}>;
+export type ConsentType = Record<string, unknown>;
+export type VisitMoleculeProps = Record<string, unknown>;
+export {};