gd-ui-library 1.0.23 → 1.0.25

package/dist/index.d.mts

@@ -2,6 +2,7 @@ import { ClassValue } from 'clsx';
 import React, { ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { AxiosRequestConfig } from 'axios';
+import { CountryCode } from 'libphonenumber-js';
 
 declare function cn(...inputs: ClassValue[]): string;
 
@@ -933,23 +934,136 @@ interface ResourceService<T, ID = string | number> {
 }
 declare function createResourceService<T, ID = string | number>(baseUrl: string): ResourceService<T, ID>;
 
-type ValidatorFunction = (value: any) => string | undefined;
-declare const validateSlug: ValidatorFunction;
-
-declare const validateEmail: ValidatorFunction;
-
-declare const validateImage: ValidatorFunction;
-
-declare const validateLongDescription: ValidatorFunction;
+type ValidatorFunction = (value: any) => string | undefined | Promise<string | undefined>;
+interface BaseOptions {
+    required?: boolean;
+    fieldName?: string;
+    message?: string;
+}
 
-declare const validateName: ValidatorFunction;
+interface EmailOptions {
+    required?: boolean;
+    allowPlus?: boolean;
+    allowSubdomains?: boolean;
+    allowIp?: boolean;
+    maxLength?: number;
+    domain?: string;
+    disposableCheck?: boolean;
+    fieldName?: string;
+}
+declare const validateEmail: (options?: EmailOptions) => ValidatorFunction;
 
-declare const validatePassword: ValidatorFunction;
+interface ImageOptions {
+    required?: boolean;
+    maxSize?: number;
+    minSize?: number;
+    allowedTypes?: string[];
+    allowedExtensions?: string[];
+    maxWidth?: number;
+    maxHeight?: number;
+    minWidth?: number;
+    minHeight?: number;
+    aspectRatio?: number;
+    fieldName?: string;
+    validateUrlStatus?: boolean;
+}
+declare const validateImage: (options?: ImageOptions) => ValidatorFunction;
+
+interface LongDescriptionOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    trim?: boolean;
+    allowHtml?: boolean;
+    allowLineBreaks?: boolean;
+    countWords?: boolean;
+    fieldName?: string;
+}
+declare const validateLongDescription: (options?: LongDescriptionOptions) => ValidatorFunction;
 
-declare const validateRequired: ValidatorFunction;
+interface NameOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    allowNumbers?: boolean;
+    allowDots?: boolean;
+    allowUnicode?: boolean;
+    allowMultipleSpaces?: boolean;
+    allowMultipleHyphens?: boolean;
+    trim?: boolean;
+    fieldName?: string;
+    capitalize?: 'none' | 'words' | 'first';
+}
+declare const validateName: (options?: NameOptions) => ValidatorFunction;
+
+interface PasswordOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    requireUppercase?: boolean;
+    requireLowercase?: boolean;
+    requireNumbers?: boolean;
+    requireSpecial?: boolean;
+    checkCommon?: boolean;
+    checkBreached?: boolean;
+    allowSpaces?: boolean;
+    minStrength?: 0 | 1 | 2 | 3 | 4;
+    fieldName?: string;
+}
+declare const validatePassword: (options?: PasswordOptions) => ValidatorFunction;
+
+interface PhoneOptions {
+    required?: boolean;
+    defaultCountry?: CountryCode;
+    fieldName?: string;
+    strict?: boolean;
+}
+declare const validatePhone: (options?: PhoneOptions) => ValidatorFunction;
+
+interface RequiredOptions {
+    message?: string;
+    trim?: boolean;
+    allowEmptyString?: boolean;
+    allowZero?: boolean;
+    allowFalse?: boolean;
+    allowEmptyArray?: boolean;
+    allowEmptyObject?: boolean;
+    minArrayLength?: number;
+    minObjectKeys?: number;
+    fieldName?: string;
+}
+declare const validateRequired: (options?: RequiredOptions) => ValidatorFunction;
+
+interface ShortDescriptionOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    trim?: boolean;
+    allowHtml?: boolean;
+}
+declare const validateShortDescription: (options?: ShortDescriptionOptions) => ValidatorFunction;
 
-declare const validateShortDescription: ValidatorFunction;
+interface SlugOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    allowNumbers?: boolean;
+    allowUnderscores?: boolean;
+    allowDots?: boolean;
+    separator?: string;
+    fieldName?: string;
+}
+declare const validateSlug: (options?: SlugOptions) => ValidatorFunction;
 
-declare const validateUrl: ValidatorFunction;
+interface UrlOptions {
+    required?: boolean;
+    protocols?: string[];
+    allowLocalhost?: boolean;
+    allowIp?: boolean;
+    allowPrivateIp?: boolean;
+    requireTld?: boolean;
+    fieldName?: string;
+}
+declare const validateUrl: (options?: UrlOptions) => ValidatorFunction;
 
-export { Accordion, Alert, type ApiConfig, ApiService, type ApiState, AutoComplete, Avatar, Badge, Banner, Breadcrumb, Button, Calendar, type CalendarEvent, CalendarWithEvents, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, type CartItem, Chart, type ChartDataset, type ChartType, Checkbox, Chip, ClickAwayListener, CodeEditor, ColorPicker, Container, type CropArea, DatePicker, DebouncedInput, Dialog, Drawer, Dropdown, type DropdownItem, type DropdownProps, EmailComposer, EmptyState, type FileItem, FileManager, FileUpload, type FilterGroup, type FilterOption, Footer, FormBuilder, type FormField, type FormFieldType, GanttChart, type GanttTask, Grid, Hero, IconSelect, type IconSelectProps, ImageCrop, type ImageCropHandle, type ImageCropProps, InfiniteScroll, Input, InputGroup, Kanban, LazyLoad, List, ListItem, MasonryGrid, Navbar, OTPInput, Pagination, Popover, Portal, ProductFilter, ProgressBar, Radio, Rating, type ResourceService, RichTextEditor, Section, Select, ShoppingCart, Sidebar, type SidebarItem, type SidebarProps, Skeleton, Slider, Spinner, SplitPane, Stack, Statistic, StatusIndicator, Stepper, Table, Tabs, Textarea, TimePicker, Timeline, type ToastOptions, type ToastVariant, Toaster, Toggle, Tooltip, Transition, TreeView, type ValidatorFunction, VirtualScroll, api, clearCache, cn, createResourceService, queryCache, toast, useApi, useMutation, useQuery, validateEmail, validateImage, validateLongDescription, validateName, validatePassword, validateRequired, validateShortDescription, validateSlug, validateUrl };
+export { Accordion, Alert, type ApiConfig, ApiService, type ApiState, AutoComplete, Avatar, Badge, Banner, type BaseOptions, Breadcrumb, Button, Calendar, type CalendarEvent, CalendarWithEvents, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, type CartItem, Chart, type ChartDataset, type ChartType, Checkbox, Chip, ClickAwayListener, CodeEditor, ColorPicker, Container, type CropArea, DatePicker, DebouncedInput, Dialog, Drawer, Dropdown, type DropdownItem, type DropdownProps, EmailComposer, type EmailOptions, EmptyState, type FileItem, FileManager, FileUpload, type FilterGroup, type FilterOption, Footer, FormBuilder, type FormField, type FormFieldType, GanttChart, type GanttTask, Grid, Hero, IconSelect, type IconSelectProps, ImageCrop, type ImageCropHandle, type ImageCropProps, type ImageOptions, InfiniteScroll, Input, InputGroup, Kanban, LazyLoad, List, ListItem, type LongDescriptionOptions, MasonryGrid, type NameOptions, Navbar, OTPInput, Pagination, type PasswordOptions, type PhoneOptions, Popover, Portal, ProductFilter, ProgressBar, Radio, Rating, type RequiredOptions, type ResourceService, RichTextEditor, Section, Select, ShoppingCart, type ShortDescriptionOptions, Sidebar, type SidebarItem, type SidebarProps, Skeleton, Slider, type SlugOptions, Spinner, SplitPane, Stack, Statistic, StatusIndicator, Stepper, Table, Tabs, Textarea, TimePicker, Timeline, type ToastOptions, type ToastVariant, Toaster, Toggle, Tooltip, Transition, TreeView, type UrlOptions, type ValidatorFunction, VirtualScroll, api, clearCache, cn, createResourceService, queryCache, toast, useApi, useMutation, useQuery, validateEmail, validateImage, validateLongDescription, validateName, validatePassword, validatePhone, validateRequired, validateShortDescription, validateSlug, validateUrl };

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { ClassValue } from 'clsx';
 import React, { ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { AxiosRequestConfig } from 'axios';
+import { CountryCode } from 'libphonenumber-js';
 
 declare function cn(...inputs: ClassValue[]): string;
 
@@ -933,23 +934,136 @@ interface ResourceService<T, ID = string | number> {
 }
 declare function createResourceService<T, ID = string | number>(baseUrl: string): ResourceService<T, ID>;
 
-type ValidatorFunction = (value: any) => string | undefined;
-declare const validateSlug: ValidatorFunction;
-
-declare const validateEmail: ValidatorFunction;
-
-declare const validateImage: ValidatorFunction;
-
-declare const validateLongDescription: ValidatorFunction;
+type ValidatorFunction = (value: any) => string | undefined | Promise<string | undefined>;
+interface BaseOptions {
+    required?: boolean;
+    fieldName?: string;
+    message?: string;
+}
 
-declare const validateName: ValidatorFunction;
+interface EmailOptions {
+    required?: boolean;
+    allowPlus?: boolean;
+    allowSubdomains?: boolean;
+    allowIp?: boolean;
+    maxLength?: number;
+    domain?: string;
+    disposableCheck?: boolean;
+    fieldName?: string;
+}
+declare const validateEmail: (options?: EmailOptions) => ValidatorFunction;
 
-declare const validatePassword: ValidatorFunction;
+interface ImageOptions {
+    required?: boolean;
+    maxSize?: number;
+    minSize?: number;
+    allowedTypes?: string[];
+    allowedExtensions?: string[];
+    maxWidth?: number;
+    maxHeight?: number;
+    minWidth?: number;
+    minHeight?: number;
+    aspectRatio?: number;
+    fieldName?: string;
+    validateUrlStatus?: boolean;
+}
+declare const validateImage: (options?: ImageOptions) => ValidatorFunction;
+
+interface LongDescriptionOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    trim?: boolean;
+    allowHtml?: boolean;
+    allowLineBreaks?: boolean;
+    countWords?: boolean;
+    fieldName?: string;
+}
+declare const validateLongDescription: (options?: LongDescriptionOptions) => ValidatorFunction;
 
-declare const validateRequired: ValidatorFunction;
+interface NameOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    allowNumbers?: boolean;
+    allowDots?: boolean;
+    allowUnicode?: boolean;
+    allowMultipleSpaces?: boolean;
+    allowMultipleHyphens?: boolean;
+    trim?: boolean;
+    fieldName?: string;
+    capitalize?: 'none' | 'words' | 'first';
+}
+declare const validateName: (options?: NameOptions) => ValidatorFunction;
+
+interface PasswordOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    requireUppercase?: boolean;
+    requireLowercase?: boolean;
+    requireNumbers?: boolean;
+    requireSpecial?: boolean;
+    checkCommon?: boolean;
+    checkBreached?: boolean;
+    allowSpaces?: boolean;
+    minStrength?: 0 | 1 | 2 | 3 | 4;
+    fieldName?: string;
+}
+declare const validatePassword: (options?: PasswordOptions) => ValidatorFunction;
+
+interface PhoneOptions {
+    required?: boolean;
+    defaultCountry?: CountryCode;
+    fieldName?: string;
+    strict?: boolean;
+}
+declare const validatePhone: (options?: PhoneOptions) => ValidatorFunction;
+
+interface RequiredOptions {
+    message?: string;
+    trim?: boolean;
+    allowEmptyString?: boolean;
+    allowZero?: boolean;
+    allowFalse?: boolean;
+    allowEmptyArray?: boolean;
+    allowEmptyObject?: boolean;
+    minArrayLength?: number;
+    minObjectKeys?: number;
+    fieldName?: string;
+}
+declare const validateRequired: (options?: RequiredOptions) => ValidatorFunction;
+
+interface ShortDescriptionOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    trim?: boolean;
+    allowHtml?: boolean;
+}
+declare const validateShortDescription: (options?: ShortDescriptionOptions) => ValidatorFunction;
 
-declare const validateShortDescription: ValidatorFunction;
+interface SlugOptions {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    allowNumbers?: boolean;
+    allowUnderscores?: boolean;
+    allowDots?: boolean;
+    separator?: string;
+    fieldName?: string;
+}
+declare const validateSlug: (options?: SlugOptions) => ValidatorFunction;
 
-declare const validateUrl: ValidatorFunction;
+interface UrlOptions {
+    required?: boolean;
+    protocols?: string[];
+    allowLocalhost?: boolean;
+    allowIp?: boolean;
+    allowPrivateIp?: boolean;
+    requireTld?: boolean;
+    fieldName?: string;
+}
+declare const validateUrl: (options?: UrlOptions) => ValidatorFunction;
 
-export { Accordion, Alert, type ApiConfig, ApiService, type ApiState, AutoComplete, Avatar, Badge, Banner, Breadcrumb, Button, Calendar, type CalendarEvent, CalendarWithEvents, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, type CartItem, Chart, type ChartDataset, type ChartType, Checkbox, Chip, ClickAwayListener, CodeEditor, ColorPicker, Container, type CropArea, DatePicker, DebouncedInput, Dialog, Drawer, Dropdown, type DropdownItem, type DropdownProps, EmailComposer, EmptyState, type FileItem, FileManager, FileUpload, type FilterGroup, type FilterOption, Footer, FormBuilder, type FormField, type FormFieldType, GanttChart, type GanttTask, Grid, Hero, IconSelect, type IconSelectProps, ImageCrop, type ImageCropHandle, type ImageCropProps, InfiniteScroll, Input, InputGroup, Kanban, LazyLoad, List, ListItem, MasonryGrid, Navbar, OTPInput, Pagination, Popover, Portal, ProductFilter, ProgressBar, Radio, Rating, type ResourceService, RichTextEditor, Section, Select, ShoppingCart, Sidebar, type SidebarItem, type SidebarProps, Skeleton, Slider, Spinner, SplitPane, Stack, Statistic, StatusIndicator, Stepper, Table, Tabs, Textarea, TimePicker, Timeline, type ToastOptions, type ToastVariant, Toaster, Toggle, Tooltip, Transition, TreeView, type ValidatorFunction, VirtualScroll, api, clearCache, cn, createResourceService, queryCache, toast, useApi, useMutation, useQuery, validateEmail, validateImage, validateLongDescription, validateName, validatePassword, validateRequired, validateShortDescription, validateSlug, validateUrl };
+export { Accordion, Alert, type ApiConfig, ApiService, type ApiState, AutoComplete, Avatar, Badge, Banner, type BaseOptions, Breadcrumb, Button, Calendar, type CalendarEvent, CalendarWithEvents, Card, CardContent, CardDescription, CardFooter, CardHeader, CardTitle, Carousel, type CartItem, Chart, type ChartDataset, type ChartType, Checkbox, Chip, ClickAwayListener, CodeEditor, ColorPicker, Container, type CropArea, DatePicker, DebouncedInput, Dialog, Drawer, Dropdown, type DropdownItem, type DropdownProps, EmailComposer, type EmailOptions, EmptyState, type FileItem, FileManager, FileUpload, type FilterGroup, type FilterOption, Footer, FormBuilder, type FormField, type FormFieldType, GanttChart, type GanttTask, Grid, Hero, IconSelect, type IconSelectProps, ImageCrop, type ImageCropHandle, type ImageCropProps, type ImageOptions, InfiniteScroll, Input, InputGroup, Kanban, LazyLoad, List, ListItem, type LongDescriptionOptions, MasonryGrid, type NameOptions, Navbar, OTPInput, Pagination, type PasswordOptions, type PhoneOptions, Popover, Portal, ProductFilter, ProgressBar, Radio, Rating, type RequiredOptions, type ResourceService, RichTextEditor, Section, Select, ShoppingCart, type ShortDescriptionOptions, Sidebar, type SidebarItem, type SidebarProps, Skeleton, Slider, type SlugOptions, Spinner, SplitPane, Stack, Statistic, StatusIndicator, Stepper, Table, Tabs, Textarea, TimePicker, Timeline, type ToastOptions, type ToastVariant, Toaster, Toggle, Tooltip, Transition, TreeView, type UrlOptions, type ValidatorFunction, VirtualScroll, api, clearCache, cn, createResourceService, queryCache, toast, useApi, useMutation, useQuery, validateEmail, validateImage, validateLongDescription, validateName, validatePassword, validatePhone, validateRequired, validateShortDescription, validateSlug, validateUrl };