@apia/components 4.0.16 → 4.0.17

package/dist/index.d.ts

@@ -1,15 +1,15 @@
 import * as React$1 from 'react';
-import React__default, { ReactNode, Ref, RefObject, ChangeEventHandler, MouseEvent as MouseEvent$1, KeyboardEvent, FC, FunctionComponent, ForwardedRef, ComponentType, ReactElement } from 'react';
+import React__default, { ReactNode, Ref, RefObject, DetailedHTMLProps, TextareaHTMLAttributes, ChangeEventHandler, MouseEvent as MouseEvent$1, KeyboardEvent, FC, PropsWithChildren, FunctionComponent, ForwardedRef, ComponentType, ReactElement } from 'react';
 import * as _apia_util from '@apia/util';
 import { IOnFocusConfiguration, TFocusRetriever, TId as TId$1, EventEmitter, StatefulEmitter, TModify, TApiaFilter, TApiaFilterValue } from '@apia/util';
 import { BoxProps, TPalette, ThemeUIStyleObject, IconButtonProps, ButtonProps, ThemeUICSSObject, InputProps, SelectProps } from '@apia/theme';
 import { TIconName, TIconType } from '@apia/icons';
+import { MenuItemProps, ControlledMenuProps } from '@szhsin/react-menu';
+export { ControlledMenuProps, MenuItemProps } from '@szhsin/react-menu';
 import { Args } from 'react-cool-portal';
 import * as _apia_notifications from '@apia/notifications';
 import { TNotificationId, INotification, TDispatchedNotification, TNotificationSelector } from '@apia/notifications';
 export { INotification, TDispatchedNotification } from '@apia/notifications';
-import { MenuItemProps, ControlledMenuProps } from '@szhsin/react-menu';
-export { ControlledMenuProps, MenuItemProps } from '@szhsin/react-menu';
 
 type TModalSize = 'editGrid' | 'sm' | 'md' | 'md-fixed' | 'lg' | 'lg-fixed' | 'xl' | 'xl-fixed' | 'xxl' | 'xxxl' | 'xxxl-fixed' | 'flex' | 'cal' | 'finder' | 'fileModal';
 type TApiaButtonType = 'primary' | 'primary-sm' | 'secondary' | 'light-secondary' | 'secondary-sm' | 'danger' | 'danger-sm' | 'outline' | 'outline-sm' | 'warning' | 'warning-sm' | 'link';
@@ -44,6 +44,7 @@ type TModal = {
      * que como un modal
      */
     draggable?: boolean;
+    dragBounded?: boolean;
     children?: React__default.ReactNode;
     className?: string;
     id?: string;
@@ -129,6 +130,7 @@ declare const Modal: React__default.ForwardRefExoticComponent<{
      * que como un modal
      */
     draggable?: boolean | undefined;
+    dragBounded?: boolean | undefined;
     children?: React__default.ReactNode;
     className?: string | undefined;
     id?: string | undefined;
@@ -199,7 +201,7 @@ declare const Modal: React__default.ForwardRefExoticComponent<{
     variant?: string | undefined;
 } & Pick<IDialogHeader, "hideCloseButton"> & React__default.RefAttributes<HTMLDivElement>>;
 
-type TOpenModal = Pick<TModal, 'NavBar' | 'Portal' | 'children' | 'className' | 'hideCloseButton' | 'initialFocusGetter' | 'initialFocusConfiguration' | 'maxWidth' | 'noHeader' | 'onExited' | 'shouldCloseOnEsc' | 'shouldCloseOnOverlayClick' | 'size' | 'stretch' | 'title' | 'variant' | 'draggable' | 'onClose' | 'onDragStart' | 'defaultPosition'> & {
+type TOpenModal = Pick<TModal, 'NavBar' | 'Portal' | 'children' | 'className' | 'hideCloseButton' | 'initialFocusGetter' | 'initialFocusConfiguration' | 'maxWidth' | 'noHeader' | 'onExited' | 'shouldCloseOnEsc' | 'shouldCloseOnOverlayClick' | 'size' | 'stretch' | 'title' | 'variant' | 'draggable' | 'onClose' | 'onDragStart' | 'defaultPosition' | 'dragBounded'> & {
     id?: string;
     children?: React__default.ReactNode;
     confirmProps?: Omit<IConfirm, 'onConfirmOk' | 'onConfirmCancel' | 'children'>;
@@ -229,16 +231,49 @@ type TOpenModal = Pick<TModal, 'NavBar' | 'Portal' | 'children' | 'className' |
 };
 
 declare class ApiaUtilModalHandler {
-    private id;
     close: () => void;
-    constructor(id: string, close: () => void);
+    constructor(close: () => void);
 }
 declare class ApiaUtilModals {
     #private;
+    private overlays;
     constructor();
     close(id: string): void;
     open(props: TOpenModal): ApiaUtilModalHandler;
-    Component: () => React$1.JSX.Element;
+    /**
+     * The overlay method allows to append an element to the array of overlays, which will be rendered after any existent modal.
+     *
+     * This way, it's possible to add a completelly custom modal with no style, nor any custom behavior added by this controller.
+     *
+     * @example
+     *
+     *  const portal = createPortal(
+      <iframe
+        style={{
+          position: 'fixed',
+          inset: 0,
+        }}
+        src={makeApiaUrl({
+          action: 'editGrid',
+          frmName: grid.getProperty('gridForm'),
+          frmParent: grid.getForm().definition.frmParent,
+          portalFormMode: false,
+          editionMode: true,
+          react: true,
+          index,
+          preventAsXmlParameter: true,
+          ajaxUrl: 'apia.execution.FormAction.run',
+        })}
+      />,
+      document.getElementById('AppModals') as HTMLElement,
+    );
+  
+    ApiaUtil.instance.modals.overlay(portal);
+     */
+    overlay(o: ReactNode): () => void;
+    Component: (() => React$1.JSX.Element) & {
+        displayName: string;
+    };
 }
 
 declare class ApiaUtilNotifications {
@@ -264,7 +299,7 @@ declare class Tab<TabType extends TTab = TTab> {
      * El parámetro force evita que se muestre cartel de confirmación al usuario cuando puede haber pérdida de datos.
      */
     close(force?: boolean): Promise<boolean>;
-    open(): void;
+    open(closeOthers?: boolean): void;
     toggle(isShown?: boolean): void;
 }
 declare class TabsController<TabType extends TTab = TTab> {
@@ -853,6 +888,12 @@ type AutocompleteCmpProps = {
 };
 declare const Autocomplete: (props: AutocompleteCmpProps) => React$1.JSX.Element | null;
 
+declare const AutogrowTextarea: ((props: DetailedHTMLProps<TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement> & {
+    error?: boolean;
+}) => React$1.JSX.Element) & {
+    displayName: string;
+};
+
 interface IBaseButton {
     text?: string;
     children?: string;
@@ -1231,6 +1272,113 @@ interface ILabelBox {
 type TLabelBox = ILabelBox & BoxProps;
 declare const LabelBox: ({ className, label, tooltip, closeTooltip, onClose, ...props }: TLabelBox) => React__default.JSX.Element;
 
+type TMessageType = 'user' | 'system' | 'warning' | 'error' | 'information' | 'response' | 'multipleChoice' | 'customMessage';
+interface IAttachment {
+    name: string;
+    id: string;
+    base64: string;
+    description?: string;
+}
+type TChatControllerState = {
+    isLoading: boolean;
+    canRecord: boolean;
+    canAttach: boolean;
+    canAddUserMessage: boolean;
+    canAddSystemMessage: boolean;
+    maxAttachmentsSize: number;
+    messages: ChatMessage[];
+    currentMessage: ChatMessage;
+};
+interface MessageCallbackProps {
+    message: ChatMessage;
+}
+type MessageSubmitCallback = (props: MessageCallbackProps) => unknown;
+
+declare class ChatMessage {
+    message: ReactNode;
+    messageType: TMessageType;
+    attachments: IAttachment[];
+    reference: ReactNode;
+    id: number;
+    constructor(message?: ReactNode, messageType?: TMessageType, attachments?: IAttachment[], reference?: ReactNode);
+    clone: () => ChatMessage;
+    removeAttachment(attachment: IAttachment): void;
+    addAttachmentDescription(attachment: IAttachment, description: string): void;
+}
+
+interface AutoscrollContainerProps {
+    /** How close (in px) to the bottom you have to be *when scrolling down*
+     * for auto-scroll to kick back in. */
+    threshold?: number;
+    className?: string;
+}
+declare const AutoscrollContainer: React__default.FC<PropsWithChildren<AutoscrollContainerProps>>;
+
+declare class ChatController<T extends Record<string, unknown> = Record<string, unknown>> {
+    private onMessageSubmit;
+    private additionalOptions?;
+    currentIndex: number;
+    state: TChatControllerState & T;
+    private internalAudioRecorder;
+    private internalCameraRecorder;
+    private maxId;
+    audioRecorder: {
+        cancelOnStop: boolean;
+        start: () => void;
+        stop: () => Promise<void>;
+        record: number;
+        state: _apia_util.AudioRecorderState;
+    };
+    constructor(props: Partial<TChatControllerState & T>, onMessageSubmit: MessageSubmitCallback, additionalOptions?: TMenuItem[] | undefined);
+    removeMessage(idx: number): void;
+    addMessage(message: ChatMessage): void;
+    clearHistory(): void;
+    clearMessage(): void;
+    removeAttachment(attachment: IAttachment): void;
+    private handleSubmit;
+    private isForHistory;
+    private canGoNext;
+    private canGoPrev;
+    nextMessage(): void;
+    prevMessage(): void;
+    protected getAdditionalProps(): Partial<MessageCallbackProps>;
+    History: (() => React$1.JSX.Element) & {
+        displayName: string;
+    };
+    Attachments: (() => React$1.JSX.Element) & {
+        displayName: string;
+    };
+    TextArea: (() => React$1.JSX.Element) & {
+        displayName: string;
+    };
+    Renderer: () => React$1.JSX.Element;
+}
+
+declare class FloatingChatController extends ChatController<{
+    isWindowOpen: boolean;
+}> {
+    private modalTitle;
+    constructor(props: {
+        props: Partial<TChatControllerState & {
+            isWindowOpen: boolean;
+        }>;
+        onMessageSubmit: MessageSubmitCallback;
+        modalTitle?: string;
+        additionalOptions?: TMenuItem[];
+    });
+    getModalTitle(): string | undefined;
+    setModalTitle(title: string): void;
+    open(): void;
+    Window: (() => React$1.JSX.Element | null) & {
+        displayName: string;
+    };
+}
+
+declare function getBase64FromFile(f: File): Promise<string>;
+declare function getBase64FromBlob(b: Blob): Promise<string>;
+declare function getFileExtension(name: string): string | undefined;
+declare function isImage(base64: string): boolean;
+
 declare const ContainerWithHeader: ({ title, children, footerChildren, onClose, additionalButtons, }: {
     title: string;
     children: ReactNode;
@@ -1378,7 +1526,7 @@ declare const ProgressBar: FC<IProgressBar>;
 
 declare const LoaderSpinner: ((props: {
     className?: string | undefined;
-}) => React__default.JSX.Element) & {
+}) => React$1.JSX.Element) & {
     displayName: string;
 };
 
@@ -1803,6 +1951,29 @@ declare const SortableList: ((props: {
     displayName: string;
 };
 
+declare const FileCard: React$1.ForwardRefExoticComponent<{
+    name: string;
+    iconsSize?: "sm" | "md" | "lg" | "xl" | undefined;
+    additionalButtons?: TIconButton[] | undefined;
+    className?: string | undefined;
+    sx?: ThemeUIStyleObject | undefined;
+    width?: string | undefined;
+    handleClose?: ((f: string) => void) | undefined;
+    onDoubleClick?: (() => void) | undefined;
+    onClick?: ((e: React.MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefined;
+} & React$1.RefAttributes<unknown>>;
+
+declare const Dropzone: ({ sx, className, messageError, progress, defaultLabel, draggingLabel, onClick, onChange, }: {
+    sx?: ThemeUIStyleObject | undefined;
+    className?: string | undefined;
+    messageError?: string | undefined;
+    progress?: number | undefined;
+    defaultLabel?: string | undefined;
+    draggingLabel?: string | undefined;
+    onClick?: ((e: MouseEvent$1) => void) | undefined;
+    onChange?: ((e: File[]) => any) | undefined;
+}) => React__default.JSX.Element;
+
 declare class TableParameter extends Parameter<ITableParameterProps> {
     constructor(params: ITableParameterProps);
 }
@@ -1918,7 +2089,6 @@ interface IFilterCondition {
     op: TFilterOp;
 }
 interface IParameter {
-    component?: string;
     description: string;
     name: string;
     possibleValues?: ParameterPossibleValue | ParameterPossibleValue[];
@@ -1954,7 +2124,10 @@ declare class Parameter<T extends IParameter = IParameter> implements ParameterO
     state: T & {
         validationError?: string;
     };
-    constructor(params: T);
+    component?: string;
+    constructor(params: T & {
+        component?: string;
+    });
     clear(): void;
     getValues(): string[];
     private removeEmptyValues;
@@ -1965,13 +2138,14 @@ declare class Parameter<T extends IParameter = IParameter> implements ParameterO
     asPayloadElement(): string[] | null;
     includes(value: string): boolean;
     validate(): boolean;
+    setComponent(component?: string): void;
 }
 
 declare const ParameterRender: (({ index, omitLabel, parameter, }: {
     index: number;
     omitLabel?: boolean | undefined;
     parameter: Parameter;
-}) => string | React$1.JSX.Element | null) & {
+}) => React$1.JSX.Element | null) & {
     displayName: string;
 };
 
@@ -2186,5 +2360,5 @@ declare class Templater {
     parseString(content: string, options?: IAlterDefaultOptions): string | JSX.Element | JSX.Element[];
 }
 
-export { Accordion, AccordionContext, AccordionItem, AccordionItemButton, AccordionItemContent, AccordionItemContext, AlertModal, ApiaFilter, ApiaUtil, ApiaUtilModalHandler, ApiaUtilTooltip, AutoEllipsis, Autocomplete, type AutocompleteCmpProps, AutocompleteController, type AutocompleteOption, type AutocompleteProps, BaseButton, CalendarModal, Captcha, Checkbox, CollapsiblePanel, Confirm, ConfirmModal, ContainerWithHeader, DateInput, DefaultAccordionItemButton, DefaultIconRenderer, DefaultTabsLabelRenderer, DialogButtonBar, FieldErrorMessage, FieldLabel, FilterConditionDTO, FilterDTO, FiltersStore, type IAccordionItemButton, type IAccordionItemProps, type IAccordionProps, type IAlert, type IApiaFilter, type ICalendarModal, type IConfirm, type IDialogButtonBar, type IDialogHeader, type IField, type IFieldErrorMessage, type IFilterCondition, type IFilterDTOState, type IFilterValue, type IIconInput, type IOverlay, type IParameter, type IParametersGroup, type IRequiredMark, type IResponsiveComponent, type ISimpleButton, type ITableParameterProps, IconButton, IconInput, IconsList, LabelBox, LinearLoader, ListSkeletonLoader, Listbox, ListboxItem, LoaderSpinner, Modal, NumberInput, Overlay, Parameter, type ParameterObject, type ParameterPossibleValue, ParameterRender, type ParameterRenderer, type ParameterRendererProps, type ParameterType, Parameters, type ParametersDefinition, ParametersGroup, type ParametersGroupRenderer, ParametersStore, ParametersTable, type Payload, ProgressBar, RequiredMark, ScreenLocker, SimpleButton, SortableList, SortableListItem, type TAccordionHandler, type TAccordionItemButton, type TApiaButtonType, type TApiaIconButton, type TCheckbox, type TCssProps, type TDateProps, type TFieldLabel, type TFilterOp, type TFilterPayload, type TFilterType, type TFilterValue, type TFilterValueType, type TGetTabsController, type TIcon, type TIconButton, type TIconRenderer, type TIconSize, type TIconsList, type TListbox, type TMenuItem, type TModal, type TModalSize, type TNumberInput, type TNumberInputChangeEvent, type TOnClickNode, type TOnConfirmSelection, type TOnSelectionChange, type TOpenModal, type TParameterType, type TSubmenu, type TTab, type TTabLabelRenderer as TTabRenderer, type TToolbarIconButton as TToolDefinition, type TTooltip, type TUseModalConfiguration, type TVisualizationType, Tab, Tabs, TabsContent, TabsController, TabsList, Templater, Toolbar, ToolbarController, ToolbarIconButton, ToolbarInput, ToolbarSelect, ToolbarSeparator, ToolbarTextButton, UnstyledSortableList, WaiTypeAhead, getFieldErrorStyles, getFieldTouchedStyles, importComponent, isParametersGroup, makeResponsiveComponent, parseNumberInputValueToNumber, parseNumberValueToNumberInput, useAccordionContext, useModal, useModalContext, useOtherTagButton, useTabsContext };
+export { Accordion, AccordionContext, AccordionItem, AccordionItemButton, AccordionItemContent, AccordionItemContext, AlertModal, ApiaFilter, ApiaUtil, ApiaUtilModalHandler, ApiaUtilTooltip, AutoEllipsis, Autocomplete, type AutocompleteCmpProps, AutocompleteController, type AutocompleteOption, type AutocompleteProps, AutogrowTextarea, AutoscrollContainer, BaseButton, CalendarModal, Captcha, ChatController, ChatMessage, Checkbox, CollapsiblePanel, Confirm, ConfirmModal, ContainerWithHeader, DateInput, DefaultAccordionItemButton, DefaultIconRenderer, DefaultTabsLabelRenderer, DialogButtonBar, Dropzone, FieldErrorMessage, FieldLabel, FileCard, FilterConditionDTO, FilterDTO, FiltersStore, FloatingChatController, type IAccordionItemButton, type IAccordionItemProps, type IAccordionProps, type IAlert, type IApiaFilter, type IAttachment, type ICalendarModal, type IConfirm, type IDialogButtonBar, type IDialogHeader, type IField, type IFieldErrorMessage, type IFilterCondition, type IFilterDTOState, type IFilterValue, type IIconInput, type IOverlay, type IParameter, type IParametersGroup, type IRequiredMark, type IResponsiveComponent, type ISimpleButton, type ITableParameterProps, IconButton, IconInput, IconsList, LabelBox, LinearLoader, ListSkeletonLoader, Listbox, ListboxItem, LoaderSpinner, type MessageCallbackProps, type MessageSubmitCallback, Modal, NumberInput, Overlay, Parameter, type ParameterObject, type ParameterPossibleValue, ParameterRender, type ParameterRenderer, type ParameterRendererProps, type ParameterType, Parameters, type ParametersDefinition, ParametersGroup, type ParametersGroupRenderer, ParametersStore, ParametersTable, type Payload, ProgressBar, RequiredMark, ScreenLocker, SimpleButton, SortableList, SortableListItem, type TAccordionHandler, type TAccordionItemButton, type TApiaButtonType, type TApiaIconButton, type TChatControllerState, type TCheckbox, type TCssProps, type TDateProps, type TFieldLabel, type TFilterOp, type TFilterPayload, type TFilterType, type TFilterValue, type TFilterValueType, type TGetTabsController, type TIcon, type TIconButton, type TIconRenderer, type TIconSize, type TIconsList, type TListbox, type TMenuItem, type TMessageType, type TModal, type TModalSize, type TNumberInput, type TNumberInputChangeEvent, type TOnClickNode, type TOnConfirmSelection, type TOnSelectionChange, type TOpenModal, type TParameterType, type TSubmenu, type TTab, type TTabLabelRenderer as TTabRenderer, type TToolbarIconButton as TToolDefinition, type TTooltip, type TUseModalConfiguration, type TVisualizationType, Tab, Tabs, TabsContent, TabsController, TabsList, Templater, Toolbar, ToolbarController, ToolbarIconButton, ToolbarInput, ToolbarSelect, ToolbarSeparator, ToolbarTextButton, UnstyledSortableList, WaiTypeAhead, getBase64FromBlob, getBase64FromFile, getFieldErrorStyles, getFieldTouchedStyles, getFileExtension, importComponent, isImage, isParametersGroup, makeResponsiveComponent, parseNumberInputValueToNumber, parseNumberValueToNumberInput, useAccordionContext, useModal, useModalContext, useOtherTagButton, useTabsContext };
 //# sourceMappingURL=index.d.ts.map