react-crud-mui 0.0.1-beta.1 → 0.0.1-beta.3

package/dist/components/{settings-provider/SettingsProvider.d.ts → crud-mui-provider/CrudMuiProvider.d.ts}

@@ -1,9 +1,9 @@
 import { PropsWithChildren } from 'react';
 import { Settings } from './settings';
-export type SettingsProviderProps = Partial<Settings>;
+export type CrudMuiProviderProps = Partial<Settings>;
 /**
  * All Providers needed for @arkas/ui components.This is client component obviously
  * @description Respectively Antd ConfigProvider => Emotion themeProvider => App =>
  */
-declare function SettingsProvider({ children, validationOptions, ...rest }: PropsWithChildren<SettingsProviderProps>): import("react/jsx-runtime").JSX.Element;
-export default SettingsProvider;
+declare function CrudMuiProvider({ children, validationOptions, ...rest }: PropsWithChildren<CrudMuiProviderProps>): import("react/jsx-runtime").JSX.Element;
+export default CrudMuiProvider;

package/dist/components/{settings-provider → crud-mui-provider}/settings.d.ts

@@ -1,4 +1,3 @@
-import { RawAxiosRequestHeaders } from 'axios';
 import { ValidationOptions } from '../form/hooks/useForm';
 import { ThemeSettings } from '../theme';
 export interface CommonHotKeys {
@@ -25,7 +24,6 @@ export interface CommonHotKeys {
     tabchangePrev: string;
 }
 export type Settings = {
-    requestCommonHeaders?: RawAxiosRequestHeaders;
     enableDevTool?: boolean;
     appTitle?: string;
     uniqueIdParamName: string;

package/dist/components/detail-page/hooks/useDetailPageModal.d.ts

@@ -425,7 +425,7 @@ declare function useDetailPageModal<TModel extends FieldValues>({ models, unique
     readonly showHeader?: boolean;
     readonly disableShortCuts?: boolean;
     readonly selectedTabIndex?: number;
-    readonly onTabChanged?: (index: number) => void;
+    readonly onTabChanged?: (selected: import('../../page/components/DefaultTabs').TabChangedPayload) => void;
     readonly onTabs?: (props: import('../../page/components/DefaultTabs').DefaultTabsProps) => import('react').ReactNode;
     readonly enableClose?: boolean;
     readonly enableCopy?: boolean;

package/dist/components/form/Field.d.ts

@@ -12,6 +12,7 @@ import { default as FormMoneyInput } from './controls/FormMoneyInput';
 import { default as FormNumberInput } from './controls/FormNumberInput';
 import { default as FormPhoneInput } from './controls/FormPhoneInput';
 import { default as FormRadioGroup } from './controls/FormRadioGroup';
+import { default as FormSearchInput } from './controls/FormSearchInput';
 import { default as FormSelect } from './controls/FormSelect';
 import { default as FormSwitch } from './controls/FormSwitch';
 export type ControlCommonProps<TFieldValues extends FieldValues = FieldValues> = {
@@ -34,6 +35,7 @@ export type FieldProps<TFieldValues extends FieldValues = FieldValues> = Omit<Us
 declare function Field<TFieldValues extends FieldValues = FieldValues>({ children, control, defaultValue, disabled: fieldDisabled, name, render, rules, shouldUnregister, formControlProps, }: FieldProps<TFieldValues>): string | number | boolean | Iterable<ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
 declare namespace Field {
     var Input: typeof FormInput;
+    var Search: typeof FormSearchInput;
     var NumberInput: typeof FormNumberInput;
     var MoneyInput: typeof FormMoneyInput;
     var PhoneInput: typeof FormPhoneInput;

package/dist/components/form/controls/FormSearchInput.d.ts

@@ -0,0 +1,7 @@
+import { FieldValues } from 'react-hook-form';
+import { SearchInputProps } from '../../search-input/SearchInput';
+import { ControlCommonProps } from '../Field';
+export interface FormInputProps<TFieldValues extends FieldValues = FieldValues> extends Omit<SearchInputProps, 'name' | 'onSearch'>, ControlCommonProps<TFieldValues> {
+}
+declare function FormSearchInput<TFieldValues extends FieldValues = FieldValues>({ name, fieldProps, ...inputProps }: FormInputProps<TFieldValues>): import("react/jsx-runtime").JSX.Element;
+export default FormSearchInput;

package/dist/components/i18n/hooks/useLangWatch.d.ts

@@ -0,0 +1,5 @@
+interface UseLangChangeCallback {
+    (lng: string): void;
+}
+declare function useLangWatch(callBack: UseLangChangeCallback): void;
+export default useLangWatch;

package/dist/components/i18n/resources/en.json.d.ts

@@ -46,6 +46,7 @@ declare const _default: {
     "uniqueconstraint": "Unique check constraint on '{{fields}}' fields",
     "leave": "Leave",
     "finish": "Finish",
+    "search": "Search...",
     "listpage.createnewitem": "Create new item",
     "listpage.extrafilter.columnOptions": "Table columns options",
     "listpage.listbuttons.callout.search.title": "Search failed",

package/dist/components/i18n/resources/tr.json.d.ts

@@ -47,6 +47,7 @@ declare const _default: {
     "uniqueconstraint": "'{{fields}}' alanlarında benzersiz alan kısıtı mevcut",
     "leave": "Ayrıl",
     "finish": "Son",
+    "search": "Ara...",
     "listpage.createnewitem": "Yeni kayıt yarat",
     "listpage.extrafilter.columnOptions": "Liste kolon ayarları",
     "listpage.listbuttons.callout.search.title": "Arama başarısız",

package/dist/components/labels/MailFormat.d.ts

@@ -0,0 +1,7 @@
+import { BoxProps } from '@mui/material';
+interface MailLabelProps extends BoxProps {
+    value?: string;
+    showIcon?: boolean;
+}
+declare function MailFormat({ value: email, showIcon, ...rest }: MailLabelProps): import("react/jsx-runtime").JSX.Element;
+export default MailFormat;

package/dist/components/labels/PhoneFormat.d.ts

@@ -0,0 +1,8 @@
+import { BoxProps } from '@mui/material';
+interface PhoneLabelProps extends BoxProps {
+    value?: string;
+    showIcon?: boolean;
+}
+export declare const formatPhoneNumber: (phoneNumber: string) => string;
+declare function PhoneFormat({ value: phoneNumber, showIcon, ...rest }: PhoneLabelProps): import("react/jsx-runtime").JSX.Element | null;
+export default PhoneFormat;

package/dist/components/labels/index.d.ts

@@ -1,10 +1,14 @@
 import { default as CurrencyFormat } from './CurrencyFormat';
 import { default as DateFormat } from './DateFormat';
+import { default as MailFormat } from './MailFormat';
 import { default as NumberFormat } from './NumberFormat';
+import { default as PhoneFormat } from './PhoneFormat';
 import * as React from 'react';
 declare const Labels: React.FunctionComponent & {
     DateFormat: typeof DateFormat;
     CurrencyFormat: typeof CurrencyFormat;
     NumberFormat: typeof NumberFormat;
+    PhoneFormat: typeof PhoneFormat;
+    MailFormat: typeof MailFormat;
 };
 export default Labels;

package/dist/components/list-page/constants.d.ts

@@ -1,6 +1,6 @@
 export declare const LISTPAGE_FORM_NAME = "listpage-filter-form";
 export declare const EXTRA_FILTER_FORM_GROUP = "extra-filter-group";
-export declare const INITIAL_PAGEINDEX = 0;
+export declare const DEFAULT_PAGEINDEX = 0;
 export declare const DEFAULT_PAGESIZE = 25;
 export declare const MAX_PAGE_SIZE = 999;
 export declare const SCROLL_ELEMENT_NAME = "scroll-to-list";

package/dist/components/list-page/hooks/useListPage.d.ts

@@ -1,9 +1,8 @@
 import { default as React } from 'react';
 import { FieldValues } from 'react-hook-form';
 import { ListPageProps } from '../pages/ListPage';
-import { ListPageModel } from '../pages/ListPageFilter';
 export type ListPageContextType<TModel extends FieldValues> = {
-    data?: ListPageModel<TModel>;
+    data?: TModel[];
     /**
      * Clear all form controls in filter
      */

package/dist/components/list-page/hooks/useURLSearchFilter.d.ts

@@ -1,11 +1,19 @@
-export interface UseURLSearchFilterOptions<TFilter> {
-    enableQueryStringFilter?: boolean | FilterSource<TFilter>;
-    params?: URLSearchParams;
-}
-export type AdvancedFilterSource = {
-    type: 'number' | 'string' | 'date';
-    isArray?: boolean;
+import { FieldValues } from 'react-hook-form';
+import { default as qs } from 'qs';
+import { ListPageMeta } from '../pages/ListPageFilter';
+declare function useURLSearchFilter<TFilter extends FieldValues>(): {
+    getFiltersInQS: () => {
+        filter: {
+            [key: string]: string | string[] | qs.ParsedQs | qs.ParsedQs[] | undefined;
+        };
+        meta: {
+            pagination: {
+                pageIndex: number;
+                pageSize: number;
+            };
+            sorting: string | string[] | qs.ParsedQs | qs.ParsedQs[];
+        };
+    };
+    setFiltersInQS: (filter: TFilter, _meta: ListPageMeta) => void;
 };
-export type FilterSource<TFilter> = Partial<Record<keyof TFilter, boolean | AdvancedFilterSource>>;
-declare function useURLSearchFilter<TFilter>({ enableQueryStringFilter, params, }: UseURLSearchFilterOptions<TFilter>): () => TFilter | undefined;
 export default useURLSearchFilter;

package/dist/components/list-page/pages/ListPage.d.ts

@@ -1,5 +1,5 @@
 import { FieldValues } from 'react-hook-form';
-import { ListPageFilter } from './ListPageFilter';
+import { ListPageMeta } from './ListPageFilter';
 import { ListPageFormProps } from './ListPageForm';
 import { default as ListPageModal } from './ListPageModal';
 import { default as ListPageRoute } from './ListPageRoute';
@@ -8,7 +8,7 @@ export interface ListPageProps<TModel extends FieldValues, TFilter extends Field
     /**
      * Data fetcher function with given filter
      */
-    onNeedData?: (filter: ListPageFilter<TFilter> | undefined) => void;
+    onNeedData?: (filter: TFilter, _meta: ListPageMeta) => void;
 }
 declare function ListPage<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>(props: ListPageProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
 declare namespace ListPage {

package/dist/components/list-page/pages/ListPageContent.d.ts

@@ -9,7 +9,6 @@ import { TableColumn, TableProps } from '../../table/Table';
 import { ServerError } from '../../utils';
 import { ListPageCommandsProps } from '../components/ListPageCommands';
 import { ListPageHeaderProps } from '../components/ListPageHeader';
-import { ListPageModel } from './ListPageFilter';
 export type ListPageWrapperLayoutProps = {
     content: ReactNode;
     pageContent: ReactNode;
@@ -93,7 +92,11 @@ export interface ListPageContentProps<TModel extends FieldValues, TDetailPageMod
     /**
      * Datasource
      */
-    data?: ListPageModel<TModel>;
+    data?: TModel[];
+    /**
+     * Total data row count of paging
+     */
+    dataCount?: number;
     /**
      * Custom list region component
      */
@@ -128,5 +131,5 @@ export interface ListPageContentProps<TModel extends FieldValues, TDetailPageMod
      */
     onDelete?: (model: TModel) => void;
 }
-declare function ListPageContent<TModel extends FieldValues, TDetailPageModel extends FieldValues = FieldValues>({ activeSegmentIndex, actionCommandsProps, alerts, autoSearch, columns, createCommandLabel, data, detailPage: EmbededDetailPageComponent, disabled, disableShortCuts, enableActionCommands, enableClear, enableCreateItem, enableExport, enableSearch, error, filterContent, hotkeyScopes, list: ListComponent, loading, onClear, onClose, onCommands, onCreateItem, onDelete, onExcelExport, onExtraCommands, onHeader, onSearch, onTabChanged, tableProps, onWrapperLayout, showHeader, ...pageProps }: ListPageContentProps<TModel, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
+declare function ListPageContent<TModel extends FieldValues, TDetailPageModel extends FieldValues = FieldValues>({ activeSegmentIndex, actionCommandsProps, alerts, autoSearch, columns, createCommandLabel, data, dataCount, detailPage: EmbededDetailPageComponent, disabled, disableShortCuts, enableActionCommands, enableClear, enableCreateItem, enableExport, enableSearch, error, filterContent, hotkeyScopes, list: ListComponent, loading, onClear, onClose, onCommands, onCreateItem, onDelete, onExcelExport, onExtraCommands, onHeader, onSearch, onTabChanged, tableProps, onWrapperLayout, showHeader, ...pageProps }: ListPageContentProps<TModel, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
 export default ListPageContent;

package/dist/components/list-page/pages/ListPageFilter.d.ts

@@ -1,24 +1,13 @@
 import { DeepPartial, FieldValues } from 'react-hook-form';
 import { TableState } from '@tanstack/react-table';
 import { UseFormReturn } from '../../form/hooks/useForm';
+import { TabChangedPayload } from '../../page/components/DefaultTabs';
 import { TableProps } from '../../table/Table';
 import { ListPageContentProps } from './ListPageContent';
-export interface PagingListModel<TModel> {
-    data: TModel[];
-    dataCount: number;
-}
-export type ListPageModel<TModel> = PagingListModel<TModel>;
-export type ListPageMeta = Pick<TableState, 'pagination' | 'sorting' | 'columnFilters'> & {
-    segmentIndex: number;
+export type ListPageMeta = Pick<TableState, 'pagination' | 'sorting' | 'columnFilters'> & TabChangedPayload & {
     reason: SearchReason;
 };
 export type SearchReason = 'search' | 'sorting' | 'pagination' | 'init' | 'clear' | 'export' | 'tabChanged' | 'columnfilter';
-export type ListPageFilter<TFilter extends FieldValues> = TFilter & {
-    _meta?: ListPageMeta;
-};
-export type NeedDataPayload<TFilter extends FieldValues> = {
-    filter: ListPageFilter<TFilter>;
-};
 export interface ListPageFilterProps<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues> extends Omit<ListPageContentProps<TModel, TDetailPageModel>, 'onSearch' | 'onExcelExport' | 'tableProps' | 'onTabChanged'> {
     /**
      * Table states as partial for providing extra props to table
@@ -31,7 +20,7 @@ export interface ListPageFilterProps<TModel extends FieldValues, TFilter extends
     /**
      * Form filter values change event
      */
-    onChange?: (filter: TFilter, meta?: DeepPartial<ListPageMeta>) => void;
+    onChange?: (filter: TFilter, meta: DeepPartial<ListPageMeta>) => void;
     /**
      * Default index of tab
      */
@@ -40,6 +29,10 @@ export interface ListPageFilterProps<TModel extends FieldValues, TFilter extends
      * Meta data of listpage
      */
     meta: ListPageMeta;
+    /**
+     * Meta data of listpage
+     */
+    defaultMeta?: DeepPartial<ListPageMeta>;
 }
 declare function ListPageFilter<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>(props: ListPageFilterProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
 export default ListPageFilter;

package/dist/components/list-page/pages/ListPageForm.d.ts

@@ -2,14 +2,14 @@ import { FieldValues } from 'react-hook-form';
 import { z } from 'zod';
 import { UseFormOptions, UseFormReturn, ValidationOptions } from '../../form/hooks/useForm';
 import { DeepNullable } from '../../utils';
-import { ListPageFilterProps, ListPageFilter as ListPageFilterType } from './ListPageFilter';
+import { ListPageFilterProps } from './ListPageFilter';
 export interface ListPageFormProps<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues> extends Omit<ListPageFilterProps<TModel, TFilter, TDetailPageModel>, 'form'>, Partial<Pick<UseFormOptions<TFilter>, 'schema'>> {
     form?: UseFormReturn<TFilter>;
     schema?: z.ZodType<Partial<TFilter>>;
     /**
      * External filter criteries
      */
-    defaultFilter?: ListPageFilterType<TFilter>;
+    defaultFilter?: Partial<TFilter>;
     /**
      * Default form fields values
      */

package/dist/components/list-page/pages/ListPageRoute.d.ts

@@ -1,9 +1,8 @@
 import { FieldValues } from 'react-hook-form';
 import { UseSegmentParamsOptions } from '../../detail-page/hooks/useSegmentParams';
-import { UseURLSearchFilterOptions } from '../hooks/useURLSearchFilter';
 import { ListPageProps } from './ListPage';
 export interface ListPageRouteProps<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues> extends ListPageProps<TModel, TFilter, TDetailPageModel>, Omit<UseSegmentParamsOptions, 'paths' | 'enableSegmentRouting'> {
-    enableQueryStringFilter?: UseURLSearchFilterOptions<TFilter>['enableQueryStringFilter'];
+    enableQueryStringFilter?: boolean;
 }
-declare function ListPageRoute<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>({ enableQueryStringFilter, enableNestedSegments, fallbackSegmentIndex, defaultFilter, tabs, onNeedData, ...listPageProps }: ListPageRouteProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
+declare function ListPageRoute<TModel extends FieldValues, TFilter extends FieldValues = FieldValues, TDetailPageModel extends FieldValues = FieldValues>({ enableQueryStringFilter, enableNestedSegments, fallbackSegmentIndex, defaultFilter, tabs, onNeedData, defaultMeta, ...listPageProps }: ListPageRouteProps<TModel, TFilter, TDetailPageModel>): import("react/jsx-runtime").JSX.Element;
 export default ListPageRoute;

package/dist/components/misc/removeFalsy.d.ts

@@ -0,0 +1,3 @@
+import { RecordType } from '../utils';
+declare function removeFalsy<T extends RecordType>(value: T): T;
+export default removeFalsy;

package/dist/components/page/Page.d.ts

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import { HeaderProps } from '../header/Header';
 import { default as DefaultLayout, PageLayoutProps } from './components/DefaultLayout';
-import { default as DefaultTabs, DefaultTabsProps, TabPane } from './components/DefaultTabs';
+import { default as DefaultTabs, DefaultTabsProps, TabChangedPayload, TabPane } from './components/DefaultTabs';
 import { default as PageContent } from './components/PageContent';
 import { default as PageDivider } from './components/PageDivider';
 import { PaddingSize } from './components/PageProvider';
@@ -22,7 +22,7 @@ export interface PageProps extends Omit<HeaderProps, 'rightContent'> {
     disableShortCuts?: boolean;
     tabs?: TabPane[];
     selectedTabIndex?: number;
-    onTabChanged?: (index: number) => void;
+    onTabChanged?: (selected: TabChangedPayload) => void;
     onTabs?: (props: DefaultTabsProps) => ReactNode;
 }
 export declare const PagePadding: Record<PaddingSize, number>;

package/dist/components/page/components/DefaultTabs.d.ts

@@ -7,5 +7,9 @@ export type TabPane = Omit<TabProps, 'children' | 'key'> & {
 export interface DefaultTabsProps extends TabsProps {
     tabs: TabPane[];
 }
+export type TabChangedPayload = {
+    selectedTabIndex: number;
+    selectedTabValue: string;
+};
 declare function DefaultTabs({ tabs, ...tabsProps }: DefaultTabsProps): import("react/jsx-runtime").JSX.Element;
 export default DefaultTabs;

package/dist/components/table/Table.d.ts

@@ -28,7 +28,7 @@ export type TableColumn<D extends object = object> = {
     icon?: ReactNode;
     export?: boolean;
 } & ColumnDef<D>;
-export interface TableProps<TData extends FieldValues> extends Omit<TableOptions<TData>, 'getCoreRowModel' | 'columns'>, Partial<Pick<EmptyTextProps, 'emptyText' | 'showEmptyImage'>>, Pick<MuiTableProps, 'size' | 'stickyHeader' | 'sx'> {
+export interface TableProps<TData extends FieldValues> extends Omit<TableOptions<TData>, 'getCoreRowModel' | 'columns'>, Partial<Pick<EmptyTextProps, 'emptyText' | 'showEmptyImage' | 'emptyImageUrl'>>, Pick<MuiTableProps, 'size' | 'stickyHeader' | 'sx'> {
     autoFocus?: boolean;
     bordered?: boolean;
     columns: TableColumn<TData>[];

package/dist/components/table/components/EmptyText.d.ts

@@ -3,6 +3,7 @@ import { BoxProps } from '@mui/material';
 export interface EmptyTextProps extends BoxProps {
     emptyText: React.ReactNode;
     showEmptyImage?: boolean;
+    emptyImageUrl?: string;
 }
-declare function EmptyText({ emptyText, showEmptyImage, children, ...boxProps }: PropsWithChildren<EmptyTextProps>): import("react/jsx-runtime").JSX.Element;
+declare function EmptyText({ emptyText, showEmptyImage, children, emptyImageUrl, ...boxProps }: PropsWithChildren<EmptyTextProps>): import("react/jsx-runtime").JSX.Element;
 export default EmptyText;

package/dist/components/theme/index.d.ts

@@ -1,6 +1,8 @@
+import { ThemeOptions } from '@mui/material/styles/createTheme';
 export type ThemeSettings = {
     theme: string;
     direction: 'ltr' | 'rtl';
     responsiveFontSizes?: boolean;
+    themeOptions?: ThemeOptions;
 };
 export declare const createCustomTheme: (settings: ThemeSettings) => import('@mui/material').Theme;

package/dist/components/theme/provider/ThemeProvider.d.ts

@@ -1,4 +1,4 @@
 import { PropsWithChildren } from 'react';
 import { ThemeSettings } from '..';
-declare function ThemeProvider({ theme, direction, responsiveFontSizes, children, }: PropsWithChildren<ThemeSettings>): import("react/jsx-runtime").JSX.Element;
+declare function ThemeProvider({ theme, themeOptions, direction, responsiveFontSizes, children, }: PropsWithChildren<ThemeSettings>): import("react/jsx-runtime").JSX.Element;
 export default ThemeProvider;