@natoora-libs/core 0.0.41 → 0.0.42

package/dist/components/index.d.cts

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import { ReactNode, ComponentType, FC, ComponentProps } from 'react';
+import { ReactNode, ComponentType, FC, ComponentProps, SVGProps } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { RefetchOptions, RefetchQueryFilters, QueryObserverResult, UseMutateAsyncFunction } from 'react-query';
 import { Control, ControllerRenderProps, ControllerFieldState, UseFormTrigger, UseFormReturn, FieldValues } from 'react-hook-form';
-import { UseMutateAsyncFunction } from 'react-query';
 import { MenuProps, Typography } from '@mui/material';
 import { DateRangePickerShape } from 'react-dates';
 
@@ -38,6 +38,93 @@ interface IAppLabel {
 }
 declare const AppLabel: ({ appName }: IAppLabel) => react_jsx_runtime.JSX.Element;
 
+/**
+ * Base type for autocomplete options. Requires an id and name property.
+ */
+type DefaultOption = {
+    id: number;
+    name: string;
+};
+interface AutocompleteProps<Option = DefaultOption> {
+    /**
+     * The currently selected value in the autocomplete.
+     * Can be undefined if no value is selected.
+     */
+    value?: Option;
+    /**
+     * The initial value to display in the autocomplete when first rendered.
+     */
+    defaultValue?: Option;
+    /**
+     * An array of options to display in the dropdown list.
+     */
+    options?: Option[];
+    /**
+     * The minimum number of characters required in the input
+     * before triggering a search. Defaults to 3.
+     */
+    minInputLength?: number;
+    /**
+     * A boolean indicating whether the component is currently fetching data.
+     * When true, displays a loading spinner.
+     */
+    isFetching?: boolean;
+    /**
+     * The label text displayed above the input field.
+     */
+    inputLabel?: string;
+    /**
+     * Helper text displayed below the input field.
+     */
+    helperText?: string;
+    /**
+     * The data-testid attribute used for testing purposes.
+     */
+    'data-testid'?: string;
+    /**
+     * A boolean indicating whether the autocomplete is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * A boolean indicating whether the field can receive empty (null) values.
+     * This allows the field to be cleared and grants behavior control for null values.
+     */
+    allowEmpty?: boolean;
+    /**
+     * A function to fetch options from an API or other data source.
+     * Returns a Promise with QueryObserverResult.
+     */
+    fetchOptions?: <TPageData>(options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined) => Promise<QueryObserverResult<any, unknown>>;
+    /**
+     * Callback function called when the input loses focus.
+     * Receives the current selected value as an argument.
+     */
+    submitOnBlur?: (value: Option) => void;
+    /**
+     * Callback function called when the selected value changes.
+     * Receives the new selected value or null as an argument.
+     */
+    onChange: (value: Option | null) => void;
+    /**
+     * The current value of the search input field.
+     */
+    searchInputValue: string;
+    /**
+     * State setter function for updating the search input value.
+     */
+    setSearchInputValue: React.Dispatch<React.SetStateAction<string>>;
+    /**
+     * Optional function to customize how options are displayed in the dropdown.
+     * If not provided, defaults to using the option's name property.
+     */
+    getOptionLabel?: ((option: Option) => string) | undefined;
+    error?: boolean;
+    disableClearable?: boolean;
+}
+declare const _default$n: <Option extends any>(props: AutocompleteProps<Option> & {
+    ref?: React.Ref<any>;
+}) => React.JSX.Element;
+
 interface BackHeaderProps {
     appName: string;
     onGoBackClick?: () => void;
@@ -72,7 +159,7 @@ interface IExtendedButton {
     subcopy?: string;
     tooltip?: string;
     component?: React.ElementType;
-    type?: 'add' | 'apps' | 'childCare' | 'delete' | 'edit' | 'importExport' | 'notes' | 'print' | 'save' | 'upload' | 'refresh' | 'download' | 'publish';
+    type?: 'add' | 'apps' | 'childCare' | 'delete' | 'edit' | 'importExport' | 'notes' | 'print' | 'save' | 'upload' | 'refresh' | 'download' | 'publish' | 'compare';
     variant?: 'contained' | 'outlined' | 'text';
     copyColor?: string;
 }
@@ -996,4 +1083,8 @@ type UserBustProps = {
 };
 declare const _default: React.MemoExoticComponent<({ user, avatarProps, typographyProps }: UserBustProps) => react_jsx_runtime.JSX.Element>;
 
-export { AlertDialog, AlertDialogFullScreen, AppLabel, BackHeader, BottomBar, _default$m as BoxButton, CompanyLogo, ConfirmationDialog, ControlledCheckbox, ControlledNumberInput, ControlledNumericField, ControlledSelectWithArray, ControlledSelectWithObject, ControlledValidTextInput, DataGrid, Date, _default$e as DeleteSubstitutionDialogContent, _default$d as DeleteUserDialogContent, _default$l as ExtendedButton, FileCard, _default$k as FilledButton, _default$j as FilledButtonLg, _default$c as FilledLabel, FilterGroupSelector, FilterSimpleSelector, _default$b as FixedFooter, Header, _default$i as ImageButton, _default$a as LeftDrawer, VirtualizedList as List, Loading, LocationsSectionInfo, Notes, Numpad, _default$9 as NumpadInput, NumpadPlus, _default$h as OutlinedButton, _default$g as OutlinedButtonLg, PaginationForTable as Pagination, PhoneInput, _default$f as Pin, ActionButton as PinnedApp, PlusMinusInput, ProductBust, ProductImage, RenderAvatar, RenderContentList, RoundButton, RowProductCard, ScrollableDialog, SearchAndFilterHeader, _default$8 as SearchAndFilterHeaderForTable, _default$7 as SearchWithFilters, _default$6 as SearchWithFiltersForTable, SectionName, SmartSelect, _default$3 as SmartTableHeader, SquareButton, _default$5 as SquareLabel, _default$4 as Switch, Table, TableDesktop, TableEmptyResult, _default$2 as TableHeader, TableLoading, TextDivider, _default$1 as TheToolbar, ThemedDateRangePicker, ToastMessage, TwoButtonDialog, UploadButton, _default as UserBust, icons };
+declare const SvgIconCompare: (props: SVGProps<SVGSVGElement>) => react_jsx_runtime.JSX.Element;
+
+declare const SvgIconChart: (props: SVGProps<SVGSVGElement>) => react_jsx_runtime.JSX.Element;
+
+export { AlertDialog, AlertDialogFullScreen, AppLabel, _default$n as Autocomplete, BackHeader, BottomBar, _default$m as BoxButton, CompanyLogo, ConfirmationDialog, ControlledCheckbox, ControlledNumberInput, ControlledNumericField, ControlledSelectWithArray, ControlledSelectWithObject, ControlledValidTextInput, DataGrid, Date, _default$e as DeleteSubstitutionDialogContent, _default$d as DeleteUserDialogContent, _default$l as ExtendedButton, FileCard, _default$k as FilledButton, _default$j as FilledButtonLg, _default$c as FilledLabel, FilterGroupSelector, FilterSimpleSelector, _default$b as FixedFooter, Header, SvgIconChart as IconChart, SvgIconCompare as IconCompare, _default$i as ImageButton, _default$a as LeftDrawer, VirtualizedList as List, Loading, LocationsSectionInfo, Notes, Numpad, _default$9 as NumpadInput, NumpadPlus, _default$h as OutlinedButton, _default$g as OutlinedButtonLg, PaginationForTable as Pagination, PhoneInput, _default$f as Pin, ActionButton as PinnedApp, PlusMinusInput, ProductBust, ProductImage, RenderAvatar, RenderContentList, RoundButton, RowProductCard, ScrollableDialog, SearchAndFilterHeader, _default$8 as SearchAndFilterHeaderForTable, _default$7 as SearchWithFilters, _default$6 as SearchWithFiltersForTable, SectionName, SmartSelect, _default$3 as SmartTableHeader, SquareButton, _default$5 as SquareLabel, _default$4 as Switch, Table, TableDesktop, TableEmptyResult, _default$2 as TableHeader, TableLoading, TextDivider, _default$1 as TheToolbar, ThemedDateRangePicker, ToastMessage, TwoButtonDialog, UploadButton, _default as UserBust, icons };

package/dist/components/index.d.ts

@@ -1,8 +1,8 @@
 import * as React from 'react';
-import { ReactNode, ComponentType, FC, ComponentProps } from 'react';
+import { ReactNode, ComponentType, FC, ComponentProps, SVGProps } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import { RefetchOptions, RefetchQueryFilters, QueryObserverResult, UseMutateAsyncFunction } from 'react-query';
 import { Control, ControllerRenderProps, ControllerFieldState, UseFormTrigger, UseFormReturn, FieldValues } from 'react-hook-form';
-import { UseMutateAsyncFunction } from 'react-query';
 import { MenuProps, Typography } from '@mui/material';
 import { DateRangePickerShape } from 'react-dates';
 
@@ -38,6 +38,93 @@ interface IAppLabel {
 }
 declare const AppLabel: ({ appName }: IAppLabel) => react_jsx_runtime.JSX.Element;
 
+/**
+ * Base type for autocomplete options. Requires an id and name property.
+ */
+type DefaultOption = {
+    id: number;
+    name: string;
+};
+interface AutocompleteProps<Option = DefaultOption> {
+    /**
+     * The currently selected value in the autocomplete.
+     * Can be undefined if no value is selected.
+     */
+    value?: Option;
+    /**
+     * The initial value to display in the autocomplete when first rendered.
+     */
+    defaultValue?: Option;
+    /**
+     * An array of options to display in the dropdown list.
+     */
+    options?: Option[];
+    /**
+     * The minimum number of characters required in the input
+     * before triggering a search. Defaults to 3.
+     */
+    minInputLength?: number;
+    /**
+     * A boolean indicating whether the component is currently fetching data.
+     * When true, displays a loading spinner.
+     */
+    isFetching?: boolean;
+    /**
+     * The label text displayed above the input field.
+     */
+    inputLabel?: string;
+    /**
+     * Helper text displayed below the input field.
+     */
+    helperText?: string;
+    /**
+     * The data-testid attribute used for testing purposes.
+     */
+    'data-testid'?: string;
+    /**
+     * A boolean indicating whether the autocomplete is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * A boolean indicating whether the field can receive empty (null) values.
+     * This allows the field to be cleared and grants behavior control for null values.
+     */
+    allowEmpty?: boolean;
+    /**
+     * A function to fetch options from an API or other data source.
+     * Returns a Promise with QueryObserverResult.
+     */
+    fetchOptions?: <TPageData>(options?: (RefetchOptions & RefetchQueryFilters<TPageData>) | undefined) => Promise<QueryObserverResult<any, unknown>>;
+    /**
+     * Callback function called when the input loses focus.
+     * Receives the current selected value as an argument.
+     */
+    submitOnBlur?: (value: Option) => void;
+    /**
+     * Callback function called when the selected value changes.
+     * Receives the new selected value or null as an argument.
+     */
+    onChange: (value: Option | null) => void;
+    /**
+     * The current value of the search input field.
+     */
+    searchInputValue: string;
+    /**
+     * State setter function for updating the search input value.
+     */
+    setSearchInputValue: React.Dispatch<React.SetStateAction<string>>;
+    /**
+     * Optional function to customize how options are displayed in the dropdown.
+     * If not provided, defaults to using the option's name property.
+     */
+    getOptionLabel?: ((option: Option) => string) | undefined;
+    error?: boolean;
+    disableClearable?: boolean;
+}
+declare const _default$n: <Option extends any>(props: AutocompleteProps<Option> & {
+    ref?: React.Ref<any>;
+}) => React.JSX.Element;
+
 interface BackHeaderProps {
     appName: string;
     onGoBackClick?: () => void;
@@ -72,7 +159,7 @@ interface IExtendedButton {
     subcopy?: string;
     tooltip?: string;
     component?: React.ElementType;
-    type?: 'add' | 'apps' | 'childCare' | 'delete' | 'edit' | 'importExport' | 'notes' | 'print' | 'save' | 'upload' | 'refresh' | 'download' | 'publish';
+    type?: 'add' | 'apps' | 'childCare' | 'delete' | 'edit' | 'importExport' | 'notes' | 'print' | 'save' | 'upload' | 'refresh' | 'download' | 'publish' | 'compare';
     variant?: 'contained' | 'outlined' | 'text';
     copyColor?: string;
 }
@@ -996,4 +1083,8 @@ type UserBustProps = {
 };
 declare const _default: React.MemoExoticComponent<({ user, avatarProps, typographyProps }: UserBustProps) => react_jsx_runtime.JSX.Element>;
 
-export { AlertDialog, AlertDialogFullScreen, AppLabel, BackHeader, BottomBar, _default$m as BoxButton, CompanyLogo, ConfirmationDialog, ControlledCheckbox, ControlledNumberInput, ControlledNumericField, ControlledSelectWithArray, ControlledSelectWithObject, ControlledValidTextInput, DataGrid, Date, _default$e as DeleteSubstitutionDialogContent, _default$d as DeleteUserDialogContent, _default$l as ExtendedButton, FileCard, _default$k as FilledButton, _default$j as FilledButtonLg, _default$c as FilledLabel, FilterGroupSelector, FilterSimpleSelector, _default$b as FixedFooter, Header, _default$i as ImageButton, _default$a as LeftDrawer, VirtualizedList as List, Loading, LocationsSectionInfo, Notes, Numpad, _default$9 as NumpadInput, NumpadPlus, _default$h as OutlinedButton, _default$g as OutlinedButtonLg, PaginationForTable as Pagination, PhoneInput, _default$f as Pin, ActionButton as PinnedApp, PlusMinusInput, ProductBust, ProductImage, RenderAvatar, RenderContentList, RoundButton, RowProductCard, ScrollableDialog, SearchAndFilterHeader, _default$8 as SearchAndFilterHeaderForTable, _default$7 as SearchWithFilters, _default$6 as SearchWithFiltersForTable, SectionName, SmartSelect, _default$3 as SmartTableHeader, SquareButton, _default$5 as SquareLabel, _default$4 as Switch, Table, TableDesktop, TableEmptyResult, _default$2 as TableHeader, TableLoading, TextDivider, _default$1 as TheToolbar, ThemedDateRangePicker, ToastMessage, TwoButtonDialog, UploadButton, _default as UserBust, icons };
+declare const SvgIconCompare: (props: SVGProps<SVGSVGElement>) => react_jsx_runtime.JSX.Element;
+
+declare const SvgIconChart: (props: SVGProps<SVGSVGElement>) => react_jsx_runtime.JSX.Element;
+
+export { AlertDialog, AlertDialogFullScreen, AppLabel, _default$n as Autocomplete, BackHeader, BottomBar, _default$m as BoxButton, CompanyLogo, ConfirmationDialog, ControlledCheckbox, ControlledNumberInput, ControlledNumericField, ControlledSelectWithArray, ControlledSelectWithObject, ControlledValidTextInput, DataGrid, Date, _default$e as DeleteSubstitutionDialogContent, _default$d as DeleteUserDialogContent, _default$l as ExtendedButton, FileCard, _default$k as FilledButton, _default$j as FilledButtonLg, _default$c as FilledLabel, FilterGroupSelector, FilterSimpleSelector, _default$b as FixedFooter, Header, SvgIconChart as IconChart, SvgIconCompare as IconCompare, _default$i as ImageButton, _default$a as LeftDrawer, VirtualizedList as List, Loading, LocationsSectionInfo, Notes, Numpad, _default$9 as NumpadInput, NumpadPlus, _default$h as OutlinedButton, _default$g as OutlinedButtonLg, PaginationForTable as Pagination, PhoneInput, _default$f as Pin, ActionButton as PinnedApp, PlusMinusInput, ProductBust, ProductImage, RenderAvatar, RenderContentList, RoundButton, RowProductCard, ScrollableDialog, SearchAndFilterHeader, _default$8 as SearchAndFilterHeaderForTable, _default$7 as SearchWithFilters, _default$6 as SearchWithFiltersForTable, SectionName, SmartSelect, _default$3 as SmartTableHeader, SquareButton, _default$5 as SquareLabel, _default$4 as Switch, Table, TableDesktop, TableEmptyResult, _default$2 as TableHeader, TableLoading, TextDivider, _default$1 as TheToolbar, ThemedDateRangePicker, ToastMessage, TwoButtonDialog, UploadButton, _default as UserBust, icons };