@devtron-labs/devtron-fe-common-lib 0.5.0-beta-9 → 0.5.0-beta-10

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;

package/dist/Shared/Services/app.types.d.ts

@@ -99,12 +99,23 @@ export declare enum AppEnvDeploymentConfigType {
     PREVIOUS_DEPLOYMENTS = "PreviousDeployments",
     DEFAULT_VERSION = "DefaultVersion"
 }
+export declare enum DraftState {
+    Init = 1,
+    Discarded = 2,
+    Published = 3,
+    AwaitApproval = 4
+}
+export declare enum DraftAction {
+    Add = 1,
+    Update = 2,
+    Delete = 3
+}
 export interface DraftMetadataDTO {
     appId: number;
     envId: number;
     resource: number;
     resourceName: string;
-    action: number;
+    action: DraftAction;
     data: string;
     userComment: string;
     changeProposed: boolean;
@@ -113,31 +124,44 @@ export interface DraftMetadataDTO {
     };
     draftId: number;
     draftVersionId: number;
-    draftState: number;
+    draftState: DraftState;
     approvers: string[];
     canApprove: boolean;
     commentsCount: number;
     dataEncrypted: boolean;
     isAppAdmin: boolean;
 }
+export declare enum CMSecretExternalType {
+    Internal = "",
+    KubernetesConfigMap = "KubernetesConfigMap",
+    KubernetesSecret = "KubernetesSecret",
+    AWSSecretsManager = "AWSSecretsManager",
+    AWSSystemManager = "AWSSystemManager",
+    HashiCorpVault = "HashiCorpVault",
+    ESO_GoogleSecretsManager = "ESO_GoogleSecretsManager",
+    ESO_AWSSecretsManager = "ESO_AWSSecretsManager",
+    ESO_AzureSecretsManager = "ESO_AzureSecretsManager",
+    ESO_HashiCorpVault = "ESO_HashiCorpVault"
+}
 export interface ConfigDatum {
     name: string;
     type: string;
     external: boolean;
-    data: Record<string, string>;
-    defaultData: Record<string, string>;
+    data: Record<string, any>;
+    defaultData: Record<string, any>;
     global: boolean;
-    externalType: string;
-    esoSecretData: {};
-    defaultESOSecretData: {};
-    secretData: Record<string, string>;
-    defaultSecretData: Record<string, string>;
+    externalType: CMSecretExternalType;
+    esoSecretData: Record<string, any>;
+    defaultESOSecretData: Record<string, any>;
+    secretData: Record<string, any>[];
+    defaultSecretData: Record<string, any>[];
     roleARN: string;
     subPath: boolean;
     filePermission: string;
     overridden: boolean;
-    mountPath?: string;
-    defaultMountPath?: string;
+    mountPath: string;
+    defaultMountPath: string;
+    esoSubPath: string[];
 }
 export interface ConfigMapSecretDataConfigDatumDTO extends ConfigDatum {
     draftMetadata: DraftMetadataDTO;
@@ -197,17 +221,6 @@ export interface TemplateListDTO {
     status?: string;
     pipelineId?: number;
 }
-export interface ManifestTemplateDTO {
-    data: string;
-    resolvedData: string;
-    variableSnapshot: null;
-}
-export declare enum DraftState {
-    Init = 1,
-    Discarded = 2,
-    Published = 3,
-    AwaitApproval = 4
-}
 export declare enum EnvResourceType {
     ConfigMap = "configmap",
     Secret = "secrets",

package/dist/Shared/constants.d.ts

@@ -1,5 +1,5 @@
 import { OptionType } from '../Common/Types';
-import { CDMaterialSidebarType } from './types';
+import { CDMaterialSidebarType, ConfigKeysWithLockType, ConfigurationType } from './types';
 export declare const ARTIFACT_STATUS: {
     PROGRESSING: string;
     DEGRADED: string;
@@ -411,3 +411,5 @@ export declare enum SelectAllGroupedResourceIdentifiers {
 }
 export declare const CD_MATERIAL_SIDEBAR_TABS: OptionType<CDMaterialSidebarType, CDMaterialSidebarType>[];
 export declare const TRIGGER_STATUS_PROGRESSING: string[];
+export declare const CONFIGURATION_TYPE_VALUES: ConfigurationType[];
+export declare const DEFAULT_LOCKED_KEYS_CONFIG: Readonly<ConfigKeysWithLockType>;

package/dist/Shared/types.d.ts

@@ -104,7 +104,6 @@ export interface Node {
     port: number;
     canBeHibernated: boolean;
     isHibernated: boolean;
-    hasDrift?: boolean;
 }
 export interface iNodes extends Array<iNode> {
 }
@@ -573,6 +572,18 @@ export type BaseFilterQueryParams<T> = {
      */
     showAll?: boolean;
 } & SortingParams<T>;
+export declare enum ConfigurationType {
+    GUI = "GUI",
+    YAML = "YAML"
+}
+export interface BaseURLParams {
+    appId: string;
+    envId: string;
+}
+export interface ConfigKeysWithLockType {
+    config: string[];
+    allowed: boolean;
+}
 export type DataAttributes = Record<`data-${string}`, unknown>;
 export interface RuntimeParamsListItemType extends KeyValueListType {
     id: number;