@devtron-labs/devtron-fe-common-lib 0.5.3 → 0.5.4

package/dist/Common/Constants.d.ts

@@ -5,6 +5,7 @@ export declare const DOCUMENTATION_HOME_PAGE = "https://docs.devtron.ai";
 export declare const DOCUMENTATION_VERSION = "/v/v0.7";
 export declare const DISCORD_LINK = "https://discord.devtron.ai/";
 export declare const DOCUMENTATION: {
+    APP_METRICS: string;
     APP_TAGS: string;
     APP_OVERVIEW_TAGS: string;
     BLOB_STORAGE: string;
@@ -48,6 +49,7 @@ export declare const URLS: {
 export declare const ROUTES: {
     APP: string;
     APP_ARTIFACT_PROMOTE_MATERIAL: string;
+    APP_TEMPLATE_DATA: string;
     PROJECT_LIST_MIN: string;
     USER_CHECK_ROLE: string;
     IMAGE_TAGGING: string;
@@ -250,6 +252,7 @@ export declare const API_STATUS_CODES: {
     PERMISSION_DENIED: number;
     NOT_FOUND: number;
     EXPECTATION_FAILED: number;
+    LOCKED: number;
 };
 export declare enum SERVER_MODE {
     EA_ONLY = "EA_ONLY",

package/dist/Common/Types.d.ts

@@ -661,6 +661,8 @@ export interface AppEnvironment {
     isProtected?: boolean;
     pipelineId?: number;
     latestCdWorkflowRunnerId?: number;
+    commits?: string[];
+    ciArtifactId?: number;
 }
 export interface Strategy {
     deploymentTemplate: string;
@@ -779,12 +781,6 @@ export interface CiPipeline {
     isOffendingMandatoryPlugin?: boolean;
     pipelineType?: string;
 }
-export interface DeploymentChartVersionType {
-    chartRefId: number;
-    chartVersion: string;
-    chartType: string;
-    type: number;
-}
 export interface ChartVersionAndTypeSelectorProps {
     setSelectedChartRefId: React.Dispatch<React.SetStateAction<number>>;
 }

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/DeploymentTemplate/DTApplicationMetricsFormField.d.ts

@@ -0,0 +1,3 @@
+import { DTApplicationMetricsFormFieldProps } from './types';
+declare const DTApplicationMetricsFormField: ({ showApplicationMetrics, isLoading, selectedChart, isDisabled, toggleAppMetrics, isAppMetricsEnabled, onlyShowCurrentStatus, parsingError, restoreLastSavedYAML, }: DTApplicationMetricsFormFieldProps) => JSX.Element;
+export default DTApplicationMetricsFormField;

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/DeploymentTemplate/constants.d.ts

@@ -0,0 +1,2 @@
+import { GetResolvedDeploymentTemplateReturnType } from './types';
+export declare const GET_RESOLVED_DEPLOYMENT_TEMPLATE_EMPTY_RESPONSE: GetResolvedDeploymentTemplateReturnType;

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/DeploymentTemplate/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export * from './service';
+export { default as DTApplicationMetricsFormField } from './DTApplicationMetricsFormField';
+export { GET_RESOLVED_DEPLOYMENT_TEMPLATE_EMPTY_RESPONSE } from './constants';

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/DeploymentTemplate/service.d.ts

@@ -0,0 +1,4 @@
+import { ResponseType } from '../../../../../../Common/Types';
+import { GetDeploymentManifestProps, GetResolvedDeploymentTemplateProps, GetResolvedDeploymentTemplateReturnType, ResolvedDeploymentTemplateDTO } from './types';
+export declare const getDeploymentManifest: (params: GetDeploymentManifestProps, abortSignal?: AbortSignal) => Promise<ResponseType<ResolvedDeploymentTemplateDTO>>;
+export declare const getResolvedDeploymentTemplate: (params: GetResolvedDeploymentTemplateProps, signal?: AbortSignal) => Promise<GetResolvedDeploymentTemplateReturnType>;

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/DeploymentTemplate/types.d.ts

@@ -0,0 +1,171 @@
+import { DraftMetadataDTO, TemplateListType } from '../../../../../../Shared/Services';
+import { OverrideMergeStrategyType } from '../types';
+export type DeploymentChartOptionkind = 'base' | 'env' | 'chartVersion' | 'deployment';
+export interface DeploymentChartVersionType {
+    id: number | string;
+    version: string;
+    /**
+     * BEWARE: This field may or may not exist, not sure why it was there in first place
+     */
+    chartRefId?: number;
+    type: number;
+    deploymentTemplateHistoryId: number;
+    pipelineId: number;
+    environmentId: number;
+    name: string;
+    description?: string;
+    isAppMetricsSupported: boolean;
+    userUploaded?: boolean;
+}
+export interface DeploymentChartOptionType extends DeploymentChartVersionType {
+    value: string | number;
+    label: string;
+    kind?: DeploymentChartOptionkind;
+}
+export interface ChartMetadataType {
+    chartDescription: string;
+}
+export interface GetResolvedDeploymentTemplateReturnType {
+    resolvedData: string;
+    data: string;
+    areVariablesPresent: boolean;
+}
+export declare enum ValuesAndManifestFlagDTO {
+    DEPLOYMENT_TEMPLATE = 1,
+    MANIFEST = 2
+}
+type GetResolvedDeploymentTemplateCustomValuesPayloadType = {
+    /**
+     * String to be resolved
+     */
+    values: string;
+    type?: never;
+    deploymentTemplateHistoryId?: never;
+    pipelineId?: never;
+};
+type GetHistoricResolvedDeploymentTemplatePayloadType = {
+    values?: never;
+    type: TemplateListType;
+    deploymentTemplateHistoryId: number;
+    pipelineId: number;
+};
+type GetDeploymentTemplateAndManifestBasePayload = {
+    appId: number;
+    /**
+     * EnvId for the given VALUE
+     */
+    envId?: number;
+    chartRefId: number;
+} & (GetHistoricResolvedDeploymentTemplatePayloadType | GetResolvedDeploymentTemplateCustomValuesPayloadType);
+export type GetResolvedDeploymentTemplatePayloadType = {
+    valuesAndManifestFlag: ValuesAndManifestFlagDTO.DEPLOYMENT_TEMPLATE;
+} & GetDeploymentTemplateAndManifestBasePayload;
+export type GetResolvedDeploymentTemplateProps = GetResolvedDeploymentTemplatePayloadType;
+export type GetDeploymentManifestProps = GetDeploymentTemplateAndManifestBasePayload;
+export type GetDeploymentManifestPayloadType = {
+    valuesAndManifestFlag: ValuesAndManifestFlagDTO.MANIFEST;
+} & GetDeploymentTemplateAndManifestBasePayload;
+export interface ResolvedDeploymentTemplateDTO {
+    /**
+     * Template with encoded variables
+     */
+    data: string;
+    /**
+     * Template with resolved variables
+     */
+    resolvedData: string;
+    variableSnapshot: Record<string, string>;
+}
+export interface ManifestTemplateDTO extends Pick<ResolvedDeploymentTemplateDTO, 'data'> {
+}
+interface DeploymentTemplateChartConfigType {
+    id: number;
+    /**
+     * Not consumed on UI just need to send in payload while update
+     */
+    refChartTemplate: string;
+    /**
+     * Not consumed on UI just need to send in payload while update
+     */
+    refChartTemplateVersion: string;
+    chartRefId: number;
+    readme: string;
+}
+export interface SelectedChartDetailsType {
+    selectedChartRefId: number;
+    selectedChart: DeploymentChartVersionType;
+}
+interface EnvironmentConfigType {
+    id: number;
+    status: number;
+    manualReviewed: boolean;
+    active: boolean;
+    namespace: string;
+}
+interface BaseDeploymentTemplateConfigState {
+    chartConfig: DeploymentTemplateChartConfigType;
+    isOverridden?: never;
+    environmentConfig?: never;
+    mergeStrategy?: never;
+}
+interface EnvironmentOverrideDeploymentTemplateConfigState {
+    chartConfig?: never;
+    isOverridden: boolean;
+    environmentConfig: EnvironmentConfigType;
+    mergeStrategy: OverrideMergeStrategyType;
+}
+export interface DeploymentTemplateConfigCommonState extends SelectedChartDetailsType {
+    /**
+     * The first ever state of the deployment template
+     */
+    originalTemplate: Record<string, string>;
+    isAppMetricsEnabled: boolean;
+    readme: string;
+    schema: Record<string, string>;
+    guiSchema: string;
+    latestDraft?: DraftMetadataDTO;
+    editorTemplate: string;
+    editorTemplateWithoutLockedKeys: string;
+}
+export type DeploymentTemplateConfigState = DeploymentTemplateConfigCommonState & (BaseDeploymentTemplateConfigState | EnvironmentOverrideDeploymentTemplateConfigState);
+type DTApplicationMetricsReadOnlyProps = {
+    isLoading?: never;
+    selectedChart?: never;
+    isDisabled?: never;
+    toggleAppMetrics?: never;
+    /**
+     * @default - false
+     * If true, would only text depicting the information whether the application metrics is enabled or not
+     */
+    onlyShowCurrentStatus: true;
+    parsingError?: never;
+    restoreLastSavedYAML?: never;
+};
+type DTApplicationMetricsParseErrorProps = {
+    parsingError: string;
+    restoreLastSavedYAML: () => void;
+} | {
+    parsingError?: never;
+    restoreLastSavedYAML?: never;
+};
+type DTApplicationMetricsActionProps = {
+    isLoading: boolean;
+    selectedChart: DeploymentChartVersionType;
+    isDisabled: boolean;
+    toggleAppMetrics: () => void;
+    onlyShowCurrentStatus?: false;
+} & DTApplicationMetricsParseErrorProps;
+export type DTApplicationMetricsFormFieldProps = {
+    isAppMetricsEnabled: boolean;
+    showApplicationMetrics: boolean;
+} & (DTApplicationMetricsActionProps | DTApplicationMetricsReadOnlyProps);
+export declare enum CompareFromApprovalOptionsValuesType {
+    APPROVAL_PENDING = 1,
+    VALUES_FROM_DRAFT = 2
+}
+export declare enum DryRunEditorMode {
+    APPROVAL_PENDING = "approvalPending",
+    VALUES_FROM_DRAFT = "valuesFromDraft",
+    PUBLISHED_VALUES = "publishedValues"
+}
+export {};

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/OverrideStrategyTippyContent.d.ts

@@ -0,0 +1,2 @@
+declare const OverrideStrategyTippyContent: () => JSX.Element;
+export default OverrideStrategyTippyContent;

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/constants.d.ts

@@ -0,0 +1,5 @@
+import { ConfigHeaderTabType } from './types';
+export declare const CONFIG_HEADER_TAB_VALUES: {
+    BASE_DEPLOYMENT_TEMPLATE: ConfigHeaderTabType[];
+    OVERRIDE: ConfigHeaderTabType[];
+};

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/index.d.ts

@@ -0,0 +1,5 @@
+export * from './DeploymentTemplate';
+export * from './types';
+export * from './constants';
+export { default as OverrideStrategyTippyContent } from './OverrideStrategyTippyContent';
+export { getDeploymentStageTitle } from './utils';

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/types.d.ts

@@ -0,0 +1,27 @@
+import { ReactNode, SyntheticEvent } from 'react';
+export declare enum ConfigHeaderTabType {
+    VALUES = "values",
+    INHERITED = "inherited",
+    DRY_RUN = "dryRun"
+}
+export declare enum ProtectConfigTabsType {
+    PUBLISHED = "published",
+    COMPARE = "compare",
+    EDIT_DRAFT = "editDraft"
+}
+export declare enum OverrideMergeStrategyType {
+    PATCH = "patch",
+    REPLACE = "replace"
+}
+export interface ConfigToolbarPopupMenuConfigType {
+    text: string;
+    onClick: (event: SyntheticEvent) => void;
+    dataTestId: string;
+    disabled?: boolean;
+    icon?: ReactNode | null;
+    variant?: 'default' | 'negative';
+}
+export declare enum ConfigToolbarPopupNodeType {
+    DISCARD_DRAFT = "discardDraft",
+    EDIT_HISTORY = "editHistory"
+}

package/dist/Pages/Applications/DevtronApps/Details/AppConfigurations/utils.d.ts

@@ -0,0 +1,2 @@
+import { DeploymentStageType } from '../../../../../Shared/constants';
+export declare const getDeploymentStageTitle: (stage: DeploymentStageType) => "-" | "deployment" | "pre-deployment" | "post-deployment";

package/dist/Pages/{CDPipeline → Applications/DevtronApps/Details/CDPipeline}/types.d.ts

@@ -1,7 +1,7 @@
-import { BuildStageType, FormType } from '../../Common/CIPipeline.Types';
-import { DeploymentAppTypes, UserApprovalConfigType } from '../../Common/Types';
-import { DeploymentStrategy } from '../../Shared/Components';
-import { EnvListMinDTO } from '../../Shared/types';
+import { BuildStageType, FormType } from '../../../../../Common/CIPipeline.Types';
+import { DeploymentAppTypes, UserApprovalConfigType } from '../../../../../Common/Types';
+import { DeploymentStrategy } from '../../../../../Shared/Components';
+import { EnvListMinDTO } from '../../../../../Shared/types';
 interface ConfigSecretType {
     label: string;
     value: string;

package/dist/Pages/{App → Applications/DevtronApps/Details}/index.d.ts

@@ -1 +1,2 @@
 export * from './AppConfigurations';
+export * from './CDPipeline';

package/dist/Pages/Applications/DevtronApps/index.d.ts

@@ -0,0 +1 @@
+export * from './Details';

package/dist/Pages/Applications/index.d.ts

@@ -0,0 +1 @@
+export * from './DevtronApps';

package/dist/Pages/index.d.ts

@@ -1,4 +1,3 @@
 export * from './GlobalConfigurations';
 export * from './ResourceBrowser';
-export * from './CDPipeline';
-export * from './App';
+export * from './Applications';

package/dist/Shared/Components/Button/Button.component.d.ts

@@ -63,5 +63,5 @@ import { ButtonProps } from './types';
  * <Button icon={<ICCube />} ariaLabel="Label" />
  * ```
  */
-declare const Button: ({ dataTestId, text, variant, size, style, startIcon, endIcon, disabled, isLoading, showTooltip, tooltipProps, icon, ariaLabel, showAriaLabelInTippy, ...props }: ButtonProps) => JSX.Element;
+declare const Button: ({ dataTestId, text, variant, size, style, startIcon, endIcon, disabled, isLoading, showTooltip, tooltipProps, icon, ariaLabel, showAriaLabelInTippy, fullWidth, ...props }: ButtonProps) => JSX.Element;
 export default Button;

package/dist/Shared/Components/Button/types.d.ts

@@ -74,6 +74,12 @@ export type ButtonProps = ({
      * @default false
      */
     disabled?: boolean;
+    /**
+     * Determines if the button should expand to fill the full width of its container.
+     *
+     * @default false
+     */
+    fullWidth?: boolean;
 } & ({
     /**
      * If true, the tooltip is shown for the button

package/dist/Shared/Components/DeploymentConfigDiff/DeploymentConfigDiff.component.d.ts

@@ -1,2 +1,2 @@
 import { DeploymentConfigDiffProps } from './DeploymentConfigDiff.types';
-export declare const DeploymentConfigDiff: ({ isLoading, configList, collapsibleNavList, navList, goBackURL, navHeading, navHelpText, isNavHelpTextShowingError, tabConfig, showDetailedDiffState, hideDiffState, renderedInDrawer, ...resProps }: DeploymentConfigDiffProps) => JSX.Element;
+export declare const DeploymentConfigDiff: ({ isLoading, configList, collapsibleNavList, navList, goBackURL, navHeading, navHelpText, isNavHelpTextShowingError, tabConfig, errorConfig, showDetailedDiffState, hideDiffState, renderedInDrawer, ...resProps }: DeploymentConfigDiffProps) => JSX.Element;

package/dist/Shared/Components/DeploymentConfigDiff/DeploymentConfigDiff.types.d.ts

@@ -1,5 +1,6 @@
 import { SortingOrder } from '../../../Common/Constants';
-import { AppEnvDeploymentConfigDTO, ConfigMapSecretDataConfigDatumDTO, DeploymentTemplateDTO, EnvResourceType, ManifestTemplateDTO } from '../../Services';
+import { AppEnvDeploymentConfigDTO, ConfigMapSecretDataConfigDatumDTO, DeploymentTemplateDTO, EnvResourceType } from '../../Services';
+import { ManifestTemplateDTO } from '../../../Pages/Applications';
 import { DeploymentHistoryDetail } from '../CICDHistory';
 import { CollapsibleListConfig, CollapsibleListItem } from '../CollapsibleList';
 import { SelectPickerProps } from '../SelectPicker';
@@ -37,6 +38,7 @@ export type DeploymentConfigDiffSelectPickerProps = {
     selectPickerProps: SelectPickerProps;
 };
 export interface DeploymentConfigDiffNavigationItem extends Pick<CollapsibleListItem, 'href' | 'title' | 'onClick'> {
+    Icon?: React.FunctionComponent<React.SVGProps<SVGSVGElement>>;
     diffState: DeploymentConfigListItem['diffState'];
 }
 export interface DeploymentConfigDiffNavigationCollapsibleItem extends Pick<CollapsibleListConfig, 'id' | 'header' | 'noItemsText'> {
@@ -83,7 +85,7 @@ export interface DeploymentConfigDiffProps {
     };
     renderedInDrawer?: boolean;
 }
-export interface DeploymentConfigDiffNavigationProps extends Pick<DeploymentConfigDiffProps, 'isLoading' | 'navList' | 'collapsibleNavList' | 'goBackURL' | 'navHeading' | 'navHelpText' | 'isNavHelpTextShowingError' | 'tabConfig' | 'showDetailedDiffState' | 'hideDiffState'> {
+export interface DeploymentConfigDiffNavigationProps extends Pick<DeploymentConfigDiffProps, 'isLoading' | 'navList' | 'collapsibleNavList' | 'goBackURL' | 'navHeading' | 'navHelpText' | 'tabConfig' | 'errorConfig' | 'isNavHelpTextShowingError' | 'showDetailedDiffState' | 'hideDiffState'> {
 }
 export interface DeploymentConfigDiffMainProps extends Pick<DeploymentConfigDiffProps, 'isLoading' | 'errorConfig' | 'headerText' | 'configList' | 'scrollIntoViewId' | 'selectorsConfig' | 'sortingConfig' | 'scopeVariablesConfig' | 'showDetailedDiffState' | 'hideDiffState'> {
 }

package/dist/Shared/Components/DeploymentConfigDiff/DeploymentConfigDiffNavigation.d.ts

@@ -1,2 +1,2 @@
 import { DeploymentConfigDiffNavigationProps } from './DeploymentConfigDiff.types';
-export declare const DeploymentConfigDiffNavigation: ({ isLoading, collapsibleNavList, navList, goBackURL, navHeading, navHelpText, isNavHelpTextShowingError, tabConfig, showDetailedDiffState, hideDiffState, }: DeploymentConfigDiffNavigationProps) => JSX.Element;
+export declare const DeploymentConfigDiffNavigation: ({ isLoading, collapsibleNavList, navList, goBackURL, navHeading, navHelpText, isNavHelpTextShowingError, tabConfig, errorConfig, showDetailedDiffState, hideDiffState, }: DeploymentConfigDiffNavigationProps) => JSX.Element;

package/dist/Shared/Components/InvalidYAMLTippy/InvalidYAMLTippyWrapper.d.ts

@@ -0,0 +1,3 @@
+import { InvalidYAMLTippyWrapperProps } from './types';
+declare const InvalidYAMLTippyWrapper: ({ parsingError, restoreLastSavedYAML, children }: InvalidYAMLTippyWrapperProps) => JSX.Element;
+export default InvalidYAMLTippyWrapper;

package/dist/Shared/Components/InvalidYAMLTippy/constants.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_INVALID_YAML_ERROR = "The provided YAML is invalid. Please provide valid YAML.";

package/dist/Shared/Components/InvalidYAMLTippy/index.d.ts

@@ -0,0 +1,2 @@
+export { default as InvalidYAMLTippyWrapper } from './InvalidYAMLTippyWrapper';
+export { getInvalidTippyContent } from './utils';

package/dist/Shared/Components/InvalidYAMLTippy/types.d.ts

@@ -0,0 +1,6 @@
+import { TooltipProps } from '@Common/Tooltip/types';
+export interface InvalidYAMLTippyWrapperProps {
+    parsingError: string;
+    restoreLastSavedYAML?: () => void;
+    children: TooltipProps['children'];
+}

package/dist/Shared/Components/InvalidYAMLTippy/utils.d.ts

@@ -0,0 +1,2 @@
+import { InvalidYAMLTippyWrapperProps } from './types';
+export declare const getInvalidTippyContent: ({ parsingError, restoreLastSavedYAML, }: Pick<InvalidYAMLTippyWrapperProps, "parsingError" | "restoreLastSavedYAML">) => JSX.Element;

package/dist/Shared/Components/SelectPicker/constants.d.ts

@@ -0,0 +1,5 @@
+import { CSSProperties } from 'react';
+import { SelectPickerProps } from './type';
+export declare const SELECT_PICKER_FONT_SIZE_MAP: Record<SelectPickerProps['size'], CSSProperties['fontSize']>;
+export declare const SELECT_PICKER_ICON_SIZE_MAP: Record<SelectPickerProps['size'], Pick<CSSProperties, 'width' | 'height'>>;
+export declare const SELECT_PICKER_CONTROL_SIZE_MAP: Record<SelectPickerProps['size'], CSSProperties['minHeight']>;

package/dist/Shared/Components/SelectPicker/type.d.ts

@@ -79,11 +79,11 @@ export type SelectPickerProps<OptionValue = number | string, IsMulti extends boo
      */
     customSelectedOptionsCount?: number;
     /**
-     * Height of the dropdown
+     * Size of select
      *
      * @default 'ComponentSizeType.medium'
      */
-    size?: Extract<ComponentSizeType, ComponentSizeType.medium | ComponentSizeType.large>;
+    size?: Extract<ComponentSizeType, ComponentSizeType.medium | ComponentSizeType.large | ComponentSizeType.small>;
     /**
      * Content to be shown in a tippy when disabled
      */

package/dist/Shared/Components/TabGroup/TabGroup.types.d.ts

@@ -1,6 +1,7 @@
 import { LinkProps, NavLinkProps } from 'react-router-dom';
 import { ComponentSizeType } from '../../constants';
 import { DataAttributes } from '../../types';
+import { TooltipProps } from '@Common/Tooltip/types';
 type TabComponentProps<TabTypeProps> = TabTypeProps & DataAttributes;
 type ConditionalTabType = {
     /**
@@ -56,6 +57,13 @@ type ConditionalTabType = {
      */
     active?: never | false;
 };
+type TabTooltipProps = {
+    shouldWrapTooltip: boolean;
+    tooltipProps: TooltipProps;
+} | {
+    shouldWrapTooltip?: never;
+    tooltipProps?: never;
+};
 export type TabProps = {
     /**
      * Unique identifier for the tab.
@@ -97,7 +105,7 @@ export type TabProps = {
      * Disables the tab, preventing interaction and indicating an inactive state.
      */
     disabled?: boolean;
-} & ConditionalTabType;
+} & ConditionalTabType & TabTooltipProps;
 export interface TabGroupProps {
     /**
      * Array of tabs to be rendered.

package/dist/Shared/Components/index.d.ts

@@ -40,3 +40,4 @@ export * from './EditImageFormField';
 export * from './Collapse';
 export * from './Security';
 export * from './Button';
+export * from './InvalidYAMLTippy';

package/dist/Shared/Hooks/useForm/useForm.d.ts

@@ -1,5 +1,5 @@
-import { ChangeEvent, FormEvent } from 'react';
-import { UseFormSubmitHandler, UseFormValidations } from './useForm.types';
+import { BaseSyntheticEvent, ChangeEvent } from 'react';
+import { UseFormSubmitHandler, UseFormValidations, UseFormErrorHandler } from './useForm.types';
 /**
  * A custom hook to manage form state, validation, and submission handling.
  *
@@ -16,20 +16,19 @@ export declare const useForm: <T extends Record<keyof T, any> = {}>(options?: {
      * - 'onBlur': Validation occurs when the input loses focus.
      *  @default 'onChange'
      */
-    validationMode?: "onChange" | "onBlur";
+    validationMode?: "onChange" | "onBlur" | "onSubmit";
 }) => {
     /** The current form data. */
     data: T;
     /** An object containing validation errors for each form field. */
-    errors: Partial<Record<keyof T, string | string[]>>;
-    /**
-     * Registers form input fields with onChange, onBlur and onFocus handlers.
-     *
-     * @param name - The key of the form field to register.
-     * @param sanitizeFn - An optional function to sanitize the input value.
-     * @returns An object containing form field `name`, `onChange`, `onBlur` and `onFocus` event handlers.
-     */
-    register: <V extends unknown = string, S extends unknown = unknown>(name: keyof T, sanitizeFn?: (value: V) => S, registerOptions?: {
+    errors: Partial<Record<keyof T, string[]>>;
+    register: <Value extends unknown, SFnReturnType extends unknown, CustomComponent extends boolean>(name: keyof T, registerOptions?: {
+        /**
+         * A function to sanitize the input value.
+         * @param value The input value.
+         * @returns The sanitized value.
+         */
+        sanitizeFn?: (value: CustomComponent extends true ? Value : string) => SFnReturnType;
         /**
          * Prevents the input value from being trimmed.
          *
@@ -39,26 +38,30 @@ export declare const useForm: <T extends Record<keyof T, any> = {}>(options?: {
          * @default false - By default, the input will be trimmed.
          */
         noTrim?: boolean;
+        /** A boolean flag indicating if the input is a custom component. */
+        isCustomComponent?: CustomComponent;
     }) => {
-        onChange: (e: ChangeEvent<HTMLInputElement>) => void;
+        onChange: (e: CustomComponent extends true ? Value : ChangeEvent<HTMLInputElement>) => void;
         onBlur: () => void;
         onFocus: () => void;
         name: keyof T;
     };
-    /**
-     * Handles form submission, validates all form fields, and calls the provided `onValid` function if valid.
-     *
-     * @param onValid - A function to handle valid form data on submission.
-     * @returns The event handler for form submission.
-     */
-    handleSubmit: (onValid: UseFormSubmitHandler<T>) => (e: FormEvent<HTMLFormElement>) => void;
-    /**
-     * Manually triggers validation for specific form fields.
-     *
-     * @param name - The key(s) of the form field(s) to validate.
-     * @returns The validation error(s), if any.
-     */
+    handleSubmit: (onValid: UseFormSubmitHandler<T>, onError?: UseFormErrorHandler<T>) => (e?: BaseSyntheticEvent) => Promise<void>;
     trigger: (name: keyof T | (keyof T)[]) => (string | string[]) | (string | string[])[];
+    setValue: (name: keyof T, value: T[keyof T], valueOptions?: {
+        /** A boolean indicating whether to mark the field as dirty after setting the value. */
+        shouldDirty?: boolean;
+        /** A boolean indicating whether to mark the field as touched after setting the value. */
+        shouldTouch?: boolean;
+    }) => void;
+    reset: (formData: T, resetOptions?: {
+        /** A boolean indicating whether to retain the current dirty state of the form fields. */
+        keepDirty?: boolean;
+        /** A boolean indicating whether to retain the current touched state of the form fields. */
+        keepTouched?: boolean;
+        /** A boolean indicating whether to retain the current error state of the form fields. */
+        keepErrors?: boolean;
+    }) => void;
     /** An object representing additional form state. */
     formState: {
         /** An object indicating which fields have been touched (interacted with). */

package/dist/Shared/Hooks/useForm/useForm.types.d.ts

@@ -1,4 +1,4 @@
-import { FormEvent } from 'react';
+import { BaseSyntheticEvent } from 'react';
 /**
  * Describes the "required" validation rule.
  * It can be a simple boolean or an object containing a boolean value and an error message.
@@ -24,10 +24,10 @@ type ValidationPattern = {
  * If validation fails, an error message is provided.
  */
 type ValidationCustom = {
-    isValid: (value: string) => boolean;
+    isValid: (value: any) => boolean;
     message: string;
 } | {
-    isValid: (value: string) => boolean;
+    isValid: (value: any) => boolean;
     message: string;
 }[];
 /**
@@ -41,9 +41,9 @@ export interface UseFormValidation {
 }
 /**
  * Represents the structure for form validation errors.
- * Maps each field to an error message or an array of error messages.
+ * Maps each field to an array of error messages.
  */
-export type UseFormErrors<T> = Partial<Record<keyof T, string | string[]>>;
+export type UseFormErrors<T> = Partial<Record<keyof T, string[]>>;
 /**
  * Represents the fields that have been modified ("dirty") in the form.
  * Maps each field to a boolean value indicating whether it has been changed.
@@ -58,12 +58,19 @@ export type TouchedFields<T> = Partial<Record<keyof T, boolean>>;
  * Defines the structure for form validations.
  * Maps each form field to its corresponding validation rules.
  */
-export type UseFormValidations<T extends {}> = Partial<Record<keyof T, UseFormValidation>>;
+export type UseFormValidations<T extends {}> = ((formData: T) => Partial<Record<keyof T, UseFormValidation>>) | Partial<Record<keyof T, UseFormValidation>>;
 /**
  * Describes the function signature for handling form submission.
  *
  * @param data - The form data collected during submission.
- * @param e - The form event, optionally passed when the form is submitted.
+ * @param e - The event, optionally passed when `handleSubmit` is called.
  */
-export type UseFormSubmitHandler<T extends {}> = (data: T, e?: FormEvent<HTMLFormElement>) => void;
+export type UseFormSubmitHandler<T extends {}> = (data: T, e?: BaseSyntheticEvent) => void;
+/**
+ * A type defining the function signature for handling form validation errors.
+ *
+ * @param errors - An object containing the validation errors for form fields.
+ * @param e - The event, optionally passed when `handleSubmit` is called.
+ */
+export type UseFormErrorHandler<T extends {}> = (errors: UseFormErrors<T>, e?: BaseSyntheticEvent) => void;
 export {};

package/dist/Shared/Hooks/useForm/useForm.utils.d.ts

@@ -7,4 +7,4 @@ import { UseFormValidation } from './useForm.types';
  * @param validation - The validation rules for the form field.
  * @returns Returns error message(s) or null if valid.
  */
-export declare const checkValidation: <T extends Record<keyof T, any> = {}>(value: T[keyof T], validation: UseFormValidation) => string | string[] | null;
+export declare const checkValidation: <T extends Record<keyof T, any> = {}>(value: T[keyof T], validation: UseFormValidation) => string[] | null;