Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | 10x 10x 10x 10x 10x 10x 10x 10x 19x 19x 19x 19x 19x 68x 68x 68x 68x 24x 24x 24x 24x 24x | import { CrudOperationKeys, FieldProperties, RenderingError } from '@decaf-ts/ui-decorators';
import { KeyValue, PossibleInputTypes } from './types';
import { CrudOperations, InternalError, OperationKeys } from '@decaf-ts/db-decorators';
import { ControlValueAccessor, FormControl, FormGroup } from '@angular/forms';
import { ElementRef, inject } from '@angular/core';
import { NgxFormService } from './NgxFormService';
import { sf } from '@decaf-ts/decorator-validation';
import { TranslateService } from '@ngx-translate/core';
import { EventConstants } from './constants';
/**
* @class NgxCrudFormField
* @implements {FieldProperties}
* @implements {ControlValueAccessor}
* @summary Abstract class representing a CRUD form field for Angular applications
* @description This class provides the base implementation for CRUD form fields in Angular,
* implementing both CrudFormField and ControlValueAccessor interfaces.
*/
export abstract class NgxCrudFormField implements ControlValueAccessor, FieldProperties {
/**
* @summary Reference to the component's element
* @description ElementRef representing the component's native element
*/
component!: ElementRef;
/**
* @summary Current CRUD operation
* @description Represents the current CRUD operation being performed
*/
operation!: CrudOperations;
/**
* @summary Form group for the field
* @description Angular FormGroup instance for the field
*/
formGroup!: FormGroup | undefined;
formControl!: FormControl;
name!: string;
path!: string;
childOf?: string;
type!: PossibleInputTypes;
disabled?: boolean;
uid?: string;
page!: number;
// Validation
format?: string;
hidden?: boolean | CrudOperationKeys[];
max?: number | Date;
maxlength?: number;
min?: number | Date;
minlength?: number;
pattern?: string | undefined;
readonly?: boolean;
required?: boolean;
step?: number;
equals?: string;
different?: string;
lessThan?: string;
lessThanOrEqual?: string;
greaterThan?: string;
greaterThanOrEqual?: string;
value!: string | number | Date;
multiple!: boolean;
protected translateService = inject(TranslateService);
private validationErrorEventDispateched: boolean = false;
/**
* @summary Parent HTML element
* @description Reference to the parent HTML element of the field
*/
protected parent?: HTMLElement;
// protected constructor() {}
/**
* @summary String formatting function
* @description Provides access to the sf function for error message formatting
* @prop {function(string, ...string): string} sf - String formatting function
*/
sf = sf;
/**
* @summary Change callback function
* @description Function called when the field value changes
* @property {function(): unknown} onChange - onChange event handler
*/
// eslint-disable-next-line @typescript-eslint/no-empty-function
onChange: () => unknown = () => {};
/**
* @summary Touch callback function
* @description Function called when the field is touched
* @property {function(): unknown} onTouch - onTouch event handler
*/
// eslint-disable-next-line @typescript-eslint/no-empty-function
onTouch: () => unknown = () => {};
/**
* @summary Write value to the field
* @description Sets the value of the field
* @param {string} obj - The value to be set
*/
writeValue(obj: string): void {
this.value = obj;
}
/**
* @summary Register change callback
* @description Registers a function to be called when the field value changes
* @param {function(): unknown} fn - The function to be called on change
*/
registerOnChange(fn: () => unknown): void {
this.onChange = fn;
}
/**
* @summary Register touch callback
* @description Registers a function to be called when the field is touched
* @param {function(): unknown} fn - The function to be called on touch
*/
registerOnTouched(fn: () => unknown): void {
this.onTouch = fn;
}
/**
* @summary Set disabled state
* @description Sets the disabled state of the field
* @param {boolean} isDisabled - Whether the field should be disabled
*/
setDisabledState?(isDisabled: boolean): void {
this.disabled = isDisabled;
}
/**
* @summary After view initialization logic
* @description Performs necessary setup after the view has been initialized
* @returns {HTMLElement} The parent element of the field
*/
afterViewInit(): HTMLElement {
let parent: HTMLElement;
switch (this.operation) {
case OperationKeys.READ:
case OperationKeys.DELETE:
return this.component.nativeElement.parentElement;
case OperationKeys.CREATE:
case OperationKeys.UPDATE:
try {
parent = NgxFormService.getParentEl(this.component.nativeElement, 'div');
} catch (e: unknown) {
throw new RenderingError(`Unable to retrieve parent form element for the ${this.operation}: ${e instanceof Error ? e.message : e}`);
}
// NgxFormService.register(parent.id, this.formGroup, this as AngularFieldDefinition);
return parent;
default:
throw new InternalError(`Invalid operation: ${this.operation}`);
}
}
/**
* @summary Cleanup on component destruction
* @description Unregisters the field when the component is destroyed
*/
onDestroy(): void {
Iif(this.formGroup)
NgxFormService.unregister(this.formGroup);
}
/**
* @summary Get field errors
* @description Retrieves all errors associated with the field
* @returns {string|void} An array of error objects
*/
getErrors(parent: HTMLElement): string | void {
const formControl = this.formControl;
if(formControl) {
const accordionComponent = parent.closest('ngx-decaf-fieldset')?.querySelector('ion-accordion-group');
if((!formControl.pristine || formControl.touched) && !formControl.valid) {
const errors: Record<string, string>[] = Object.keys(formControl.errors ?? {}).map(key => ({
key: key,
message: key,
}));
if(errors.length) {
Iif(accordionComponent && !this.validationErrorEventDispateched) {
const validationErrorEvent = new CustomEvent(EventConstants.VALIDATION_ERROR, {
detail: {fieldName: this.name, hasErrors: true},
bubbles: true
});
accordionComponent.dispatchEvent(validationErrorEvent);
this.validationErrorEventDispateched = true;
}
}
for(const error of errors)
return `* ${this.sf(this.translateService.instant(`errors.${error?.['message']}`), (this as KeyValue)[error?.['key']] ?? "")}`;
}
}
}
}
|