@messaia/cdk 17.1.0-rc15 → 17.1.0-rc16

package/lib/form-validators/domain/disable-provider.d.ts

@@ -1,15 +1,69 @@
 import { AbstractControl, FormGroup } from "@angular/forms";
+/**
+ * Provides functionality for disabling form controls based on decorator configuration.
+ */
 export declare class DisableProvider {
     private decoratorType;
     private entityObject;
+    /**
+     * Initializes a new instance of the DisableProvider class.
+     * @param decoratorType The type of decorator.
+     * @param entityObject The entity object associated with the decorator.
+     */
     constructor(decoratorType: string, entityObject: {
         [key: string]: any;
     });
+    /**
+     * Gets the name of the form group associated with the provided form control.
+     * @param currentFormGroup The current form group.
+     * @returns The name of the form group.
+     */
     getFormGroupName(currentFormGroup: FormGroup): string;
+    /**
+     * Processes disabling based on zero arguments.
+     * @param control The form control.
+     * @param columnName The name of the column.
+     * @returns An array of disabled columns.
+     */
     zeroArgumentProcess(control: AbstractControl, columnName: string): any[];
+    /**
+     * Gets the disabled columns for the provided form group.
+     * @param formGroup The form group.
+     * @param columnName The name of the column.
+     * @param isRoot Indicates whether the form group is the root form group.
+     * @param pathName The path name.
+     * @returns An array of disabled columns.
+     */
     private getDisabledColumns;
+    /**
+     * Gets the change detection columns for the provided instance container.
+     * @param instanceContainer The instance container.
+     * @param columnName The name of the column.
+     * @param isRoot Indicates whether the form group is the root form group.
+     * @param pathName The path name.
+     * @returns An array of change detection columns.
+     */
     private getChangeDetectionColumns;
+    /**
+     * Gets the top control path based on the form control and column name.
+     * @param control The form control.
+     * @param columnName The name of the column.
+     * @returns The top control path.
+     */
     private topControlPath;
+    /**
+     * Retrieves the disabled expressions for child controls within the provided form group.
+     * @param formGroup The form group.
+     * @param columnName The name of the column.
+     * @param path The path for the controls.
+     * @returns An array of disabled expressions for child controls.
+     */
     childControlDisabledExpression(formGroup: FormGroup, columnName: string, path?: string): any[];
+    /**
+     * Processes disabling based on one argument.
+     * @param control The form control or form group.
+     * @param columnName The name of the column.
+     * @returns An array of disabled columns.
+     */
     oneArgumentProcess(control: AbstractControl | FormGroup, columnName: string): any[];
 }

package/lib/form-validators/domain/element-processor/decimal.provider.d.ts

@@ -3,15 +3,50 @@ import * as i0 from "@angular/core";
 export declare class DecimalProvider {
     private decimalPipe;
     private localeId;
+    /**
+     * Decimal separator
+     */
     private decimalSeperator;
+    /**
+     * Group separator
+     */
     private groupSeperator;
+    /**
+     * Optional variable for custom decimal symbol
+     */
     private allowDecimalSymbol?;
+    /**
+     * Flag indicating whether configuration is set
+     */
+    private isSetConfig;
+    /**
+     * Constructor for DecimalProvider
+     * @param decimalPipe DecimalPipe
+     * @param localeId LOCALE_ID
+     */
     constructor(decimalPipe: DecimalPipe, localeId: string);
+    /**
+     * Replaces the decimal and group separators in the value.
+     * @param value The value to replace separators in.
+     * @returns The value with replaced separators.
+     */
     replacer(value: any): any;
+    /**
+     * Transforms a value into a formatted decimal string.
+     * @param value The value to transform.
+     * @param digitsInfo The number of digits after the decimal point.
+     * @param persistZero Whether to persist zero after decimal digits.
+     * @returns The formatted decimal string.
+     */
     transFormDecimal(value: any, digitsInfo: string, persistZero: boolean): string | null;
+    /**
+     * Sets the decimal and group symbols in the ReactiveFormConfig.
+     */
     private setSymbolInConfig;
+    /**
+     * Binds configuration settings from ReactiveFormConfig.json.
+     */
     bindConfig(): void;
-    private isSetConfig;
     static ɵfac: i0.ɵɵFactoryDeclaration<DecimalProvider, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DecimalProvider>;
 }

package/lib/form-validators/domain/form-data.d.ts

@@ -1,10 +1,31 @@
 import { FormDataConfig } from '../models/interface/form-data-config';
 export declare class FormDataProvider {
+    /**
+     * Converts a JavaScript object to FormData.
+     * @param jObject The JavaScript object to convert.
+     * @param options Additional options for the conversion.
+     * @returns The converted FormData object.
+     */
     convertToFormData(jObject: {
         [key: string]: any;
     }, options?: FormDataConfig): FormData;
+    /**
+     * Recursively converts a JavaScript object to FormData.
+     * @param jObject The JavaScript object to convert.
+     * @param currentFormData The current FormData object (used for recursive calls).
+     * @param parentKey The parent key (used for recursive calls).
+     * @param options Additional options for the conversion.
+     * @returns The converted FormData object.
+     */
     convertFormData(jObject: {
         [key: string]: any;
     }, currentFormData?: FormData, parentKey?: string, options?: FormDataConfig): FormData;
+    /**
+     * Binds non-object values to FormData.
+     * @param value The value to bind.
+     * @param formData The FormData object.
+     * @param propName The property name.
+     * @param options Additional options for the conversion.
+     */
     nonObjectValueBind(value: any, formData: FormData, propName: string, options?: FormDataConfig): void;
 }

package/lib/form-validators/models/control-info.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Interface for control information
+ */
+export interface ControlInfo {
+    /**
+     * Conditional expressions for control
+     */
+    conditionalExpressions?: {
+        [key: string]: Function;
+    };
+    /**
+     * Change detection configuration for control
+     */
+    changeDetection?: {
+        [key: string]: string[];
+    };
+    /**
+     * Control properties
+     */
+    controlProp: {
+        [key: string]: {
+            [key: string]: boolean;
+        };
+    };
+}

package/lib/form-validators/models/data-sanitizer.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface for data sanitizer
+ */
+export interface DataSanitizer {
+    /**
+     * Name of the sanitizer
+     */
+    name: string;
+    /**
+     * Configuration for the sanitizer
+     */
+    config: any;
+}

package/lib/form-validators/models/decorator-configuration.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Interface for configuring decorators
+ */
+export interface DecoratorConfiguration {
+    /**
+     * Type of annotation
+     */
+    annotationType: string;
+    /**
+     * Name of the property
+     */
+    propertyName: string;
+    /**
+     * Index of the property
+     */
+    propertyIndex: number;
+    /**
+     * Target object
+     */
+    target?: any;
+    /**
+     * Constructor function for the property
+     */
+    propertyConstructor?: any;
+    /**
+     * Additional configuration
+     */
+    config?: any;
+    /**
+     * Indicates if the operation is asynchronous
+     */
+    isAsync: boolean;
+    /**
+     * Indicates if it's a validator
+     */
+    isValidator?: boolean;
+}

package/lib/form-validators/models/form-builder-configuration.d.ts

@@ -7,24 +7,57 @@ import { PropValidationConfig } from "./prop-validation-config";
  */
 export declare class FormBuilderConfiguration {
     constructor(formBuilderConfiguration?: FormBuilderConfiguration);
+    /**
+     * Map of generic entities used in the configuration.
+     */
     genericEntities?: {
         [key: string]: Function;
     };
+    /**
+     * Array of generic validation functions to be applied to all form controls.
+     */
     applyAllProps?: ValidatorFn[];
+    /**
+     * Array of property names to be excluded from form generation.
+     */
     excludeProps?: string[];
+    /**
+     * Array of property names to be included in form generation.
+     */
     includeProps?: string[];
+    /**
+     * Array of property names to be ignored if their values are undefined during form generation.
+     */
     ignoreUndefinedProps?: string[];
+    /**
+     * Map of property configurations using PropConfig for specific form controls.
+     */
     propsConfig?: {
         [key: string]: PropConfig;
     };
+    /**
+     * Map of dynamic validations for specific properties.
+     */
     dynamicValidation?: {
         [key: string]: PropValidationConfig;
     };
+    /**
+     * Name of the property holding dynamic validation configuration.
+     */
     dynamicValidationConfigurationPropertyName?: string;
+    /**
+     * Configuration for auto-instantiating classes when constructing form groups.
+     */
     autoInstanceConfig?: AutoInstanceConfig;
+    /**
+     * Map of abstract control options specifying when to update the control (change, blur, submit).
+     */
     abstractControlOptions?: {
         [key: string]: 'change' | 'blur' | 'submit';
     };
+    /**
+     * Map of base abstract control options for specific form controls.
+     */
     baseAbstractControlOptions?: {
         [key: string]: AbstractControlOptions;
     };

package/lib/form-validators/models/instance-container.d.ts

@@ -0,0 +1,47 @@
+import { ControlInfo } from "./control-info";
+import { DataSanitizer } from "./data-sanitizer";
+import { DecoratorConfiguration } from "./decorator-configuration";
+import { PropertyInfo } from "./property-info";
+/**
+ * Interface for instance container
+ */
+export interface InstanceContainer {
+    /**
+     * Instance object
+     */
+    instance: any;
+    /**
+     * Array of property annotations
+     */
+    propertyAnnotations: DecoratorConfiguration[];
+    /**
+     * Array of properties
+     */
+    properties?: PropertyInfo[];
+    /**
+     * Conditional validation properties
+     */
+    conditionalValidationProps?: {
+        [key: string]: string[];
+    };
+    /**
+     * Conditional object properties
+     */
+    conditionalObjectProps?: {
+        [key: string]: any;
+    };
+    /**
+     * Non-validation decorators
+     */
+    nonValidationDecorators?: {
+        disabled: ControlInfo;
+        error: ControlInfo;
+        elementClass: ControlInfo;
+    };
+    /**
+     * Sanitizers for data
+     */
+    sanitizers?: {
+        [key: string]: DataSanitizer[];
+    };
+}

package/lib/form-validators/models/password-validation.model.d.ts

@@ -1,20 +1,74 @@
+/**
+ * Interface defining password validation criteria
+ */
 export interface PasswordValidation {
+    /**
+     * Should contain at least one digit
+     */
     digit?: boolean;
+    /**
+     * Should contain at least one alphabet character
+     */
     alphabet?: boolean;
+    /**
+     * Should contain a specific string
+     */
     contains?: string;
+    /**
+     * Should contain at least one lowercase letter
+     */
     lowerCase?: boolean;
+    /**
+     * Should contain at least one uppercase letter
+     */
     upperCase?: boolean;
+    /**
+     * Should contain at least one special character
+     */
     specialCharacter?: boolean;
+    /**
+     * Minimum length of the password
+     */
     minLength?: number;
+    /**
+     * Maximum length of the password
+     */
     maxLength?: number;
 }
+/**
+ * Interface defining custom error messages for password validation
+ */
 export interface PasswordValidationMessage {
+    /**
+     * Custom error message for digit requirement
+     */
     digit?: string;
+    /**
+     * Custom error message for alphabet requirement
+     */
     alphabet?: string;
+    /**
+     * Custom error message for specific string requirement
+     */
     contains?: string;
+    /**
+     * Custom error message for lowercase letter requirement
+     */
     lowerCase?: string;
+    /**
+     * Custom error message for uppercase letter requirement
+     */
     upperCase?: string;
+    /**
+     * Custom error message for special character requirement
+     */
     specialCharacter?: string;
+    /**
+     * Custom error message for minimum length requirement
+     */
     minLength?: string;
+    /**
+     * Custom error message for maximum length requirement
+     */
     maxLength?: string;
 }

package/lib/form-validators/models/prop-validation-config.d.ts

@@ -22,56 +22,212 @@ import { RangeConfig } from "./config/range-config";
 import { RelationalOperatorConfig } from "./config/relational-operator-config";
 import { SizeConfig } from "./config/size-config";
 import { TimeConfig } from "./config/time-config";
+/**
+ * Configuration for property validation
+ */
 export interface PropValidationConfig {
+    /**
+     * Configuration for allOf validation
+     */
     allOf?: ArrayConfig;
+    /**
+     * Configuration for choice validation
+     */
     choice?: ChoiceConfig;
+    /**
+     * Configuration for required validation
+     */
     required?: BaseConfig | boolean;
+    /**
+     * Configuration for credit card validation
+     */
     creditCard?: CreditCardConfig;
+    /**
+     * Configuration for different validation
+     */
     different?: DifferentConfig;
+    /**
+     * Configuration for even validation
+     */
     even?: BaseConfig | boolean;
+    /**
+     * Configuration for factor validation
+     */
     factor?: FactorConfig;
+    /**
+     * Configuration for greater than or equal to validation
+     */
     greaterThanEqualTo?: RelationalOperatorConfig;
+    /**
+     * Configuration for greater than validation
+     */
     greaterThan?: RelationalOperatorConfig;
+    /**
+     * Configuration for hexadecimal color validation
+     */
     hexColor?: HexColorConfig | boolean;
+    /**
+     * Configuration for JSON validation
+     */
     json?: DefaultConfig;
+    /**
+     * Configuration for leap year validation
+     */
     leapYear?: BaseConfig | boolean;
+    /**
+     * Configuration for less than or equal to validation
+     */
     lessThanEqualTo?: RelationalOperatorConfig;
+    /**
+     * Configuration for less than validation
+     */
     lessThan?: RelationalOperatorConfig;
+    /**
+     * Configuration for MAC address validation
+     */
     mac?: BaseConfig | boolean;
+    /**
+     * Configuration for noneOf validation
+     */
     noneOf?: ArrayConfig;
+    /**
+     * Configuration for numeric validation
+     */
     numeric?: NumericConfig | boolean;
+    /**
+     * Configuration for odd validation
+     */
     odd?: BaseConfig | boolean;
+    /**
+     * Configuration for oneOf validation
+     */
     oneOf?: ArrayConfig;
+    /**
+     * Configuration for password validation
+     */
     password?: PasswordConfig;
+    /**
+     * Configuration for time validation
+     */
     time?: TimeConfig | boolean;
+    /**
+     * Configuration for URL validation
+     */
     url?: DefaultConfig | boolean;
+    /**
+     * Configuration for minimum length validation
+     */
     minLength?: NumberConfig;
+    /**
+     * Configuration for maximum length validation
+     */
     maxLength?: NumberConfig;
+    /**
+     * Configuration for pattern validation
+     */
     pattern?: PatternConfig;
+    /**
+     * Configuration for comparison validation
+     */
     compare?: CompareConfig;
+    /**
+     * Configuration for contains validation
+     */
     contains?: DefaultConfig;
+    /**
+     * Configuration for alpha validation
+     */
     alpha?: AlphaConfig | boolean;
+    /**
+     * Configuration for digit validation
+     */
     digit?: DigitConfig | boolean;
+    /**
+     * Configuration for alphaNumeric validation
+     */
     alphaNumeric?: AlphaConfig | boolean;
+    /**
+     * Configuration for email validation
+     */
     email?: EmailConfig | boolean;
+    /**
+     * Configuration for lowercase validation
+     */
     lowerCase?: MessageConfig | boolean;
+    /**
+     * Configuration for maximum date validation
+     */
     maxDate?: MaxDateConfig;
+    /**
+     * Configuration for maximum number validation
+     */
     maxNumber?: NumberConfig;
+    /**
+     * Configuration for minimum date validation
+     */
     minDate?: MinDateConfig;
+    /**
+     * Configuration for minimum number validation
+     */
     minNumber?: NumberConfig;
+    /**
+     * Configuration for uppercase validation
+     */
     upperCase?: MessageConfig | boolean;
+    /**
+     * Configuration for range validation
+     */
     range?: RangeConfig;
+    /**
+     * Custom validator function
+     */
     custom?: ValidatorFn;
+    /**
+     * Configuration for ASCII validation
+     */
     ascii?: BaseConfig | boolean;
+    /**
+     * Configuration for data URI validation
+     */
     dataUri?: BaseConfig | boolean;
+    /**
+     * Configuration for port validation
+     */
     port?: BaseConfig | boolean;
+    /**
+     * Configuration for latitude-longitude validation
+     */
     latLong?: BaseConfig | boolean;
+    /**
+     * Configuration for file extension validation
+     */
     extension?: ExtensionConfig;
+    /**
+     * Configuration for file size validation
+     */
     fileSize?: SizeConfig;
+    /**
+     * Configuration for ends with validation
+     */
     endsWith?: DefaultConfig;
+    /**
+     * Configuration for starts with validation
+     */
     startsWith?: DefaultConfig | boolean;
+    /**
+     * Configuration for prime number validation
+     */
     primeNumber?: BaseConfig | boolean;
+    /**
+     * Configuration for latitude validation
+     */
     latitude?: BaseConfig | boolean;
+    /**
+     * Configuration for longitude validation
+     */
     longitude?: BaseConfig | boolean;
+    /**
+     * Configuration for asynchronous validators
+     */
     async?: AsyncValidatorFn[];
 }

package/lib/form-validators/models/property-info.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Interface for property information
+ */
+export interface PropertyInfo {
+    /**
+     * Name of the property
+     */
+    name: string;
+    /**
+     * Type of the property
+     */
+    propertyType: string;
+    /**
+     * Entity information
+     */
+    entity?: any;
+    /**
+     * Data property name
+     */
+    dataPropertyName?: string;
+    /**
+     * Default value of the property
+     */
+    defaultValue?: any;
+    /**
+     * Ignore function for the property
+     */
+    ignore?: (x: any) => boolean;
+    /**
+     * Indicates if it's a primary key
+     */
+    isPrimaryKey?: boolean;
+    /**
+     * Entity provider function
+     */
+    entityProvider?: Function;
+    /**
+     * Array configuration for the property
+     */
+    arrayConfig?: {
+        allowMaxIndex?: number;
+        messageKey?: string;
+        createBlank?: boolean;
+    };
+    /**
+     * Update timing for the property
+     */
+    updateOn?: 'change' | 'blur' | 'submit';
+}