@sumaris-net/ngx-components 18.12.6 → 18.12.7

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sumaris-net/ngx-components",
   "description": "SUMARiS Angular components",
-  "version": "18.12.6",
+  "version": "18.12.7",
   "author": "contact@e-is.pro",
   "license": "AGPL-3.0",
   "readmeFilename": "README.md",

package/src/app/core/form/form.utils.d.ts

@@ -1,7 +1,7 @@
 import { AbstractControl } from '@angular/forms';
 import { filterNumberInput, selectInputContent, selectInputContentFromEvent } from '../../shared/inputs';
 import { WaitForOptions } from '../../shared/observables';
-import { addValueInArray, clearValueInArray, copyEntity2Form, disableAndClearControl, disableAndClearControls, disableControl, disableControls, enableControl, enableControls, filterFormErrors, filterFormErrorsByPath, filterFormErrorsByPrefix, getControlFromPath, getFormErrors, getFormValueFromEntity, logFormErrors, markAllAsTouched, markAsUntouched, removeValueInArray, resizeArray, setControlEnabled, setControlsEnabled, updateValueAndValidity, waitIdle, waitWhilePending } from '../../shared/forms';
+import { addValueInArray, clearValueInArray, copyEntity2Form, disableAndClearControl, disableAndClearControls, disableControl, disableControls, enableControl, enableControls, filterFormErrors, filterFormErrorsByPath, filterFormErrorsByPrefix, getControlFromPath, getFormErrors, getFormValueFromEntity, logFormErrors, markAllAsTouched, markAsUntouched, removeValueInArray, resizeArray, setControlEnabled, setControlsEnabled, setFormErrors, updateValueAndValidity, waitIdle, waitWhilePending } from '../../shared/forms';
 export declare type IAppFormGetter = () => IAppForm;
 export declare interface OnReady {
     ngOnReady(): any;
@@ -207,7 +207,15 @@ export declare class AppFormProvider<F extends IAppForm = IAppForm> implements I
 export declare class AppFormUtils {
     static copyEntity2Form: typeof copyEntity2Form;
     static getFormValueFromEntity: typeof getFormValueFromEntity;
-    static logFormErrors: typeof logFormErrors;
+    /**
+     * Retrieves a control from the provided form/control structure using a dot-separated path.
+     *
+     * @param {AbstractControl} form - The root form group, form array, or control to start searching from.
+     * @param {string} path - The dot-separated path specifying the control. For example, 'groupName.controlName' or 'arrayName.0.controlName'.
+     * @param {boolean} [strict=true] - If true, throws an error if the full path cannot be resolved; if false, returns the last valid control encountered.
+     * @return {AbstractControl} - The control at the specified path or the closest valid control if strict mode is disabled.
+     * @throws {Error} - Throws an error if the path cannot be resolved and strict mode is enabled.
+     */
     static getControlFromPath: typeof getControlFromPath;
     static filterNumberInput: typeof filterNumberInput;
     static enableControls: typeof enableControls;
@@ -234,7 +242,6 @@ export declare class AppFormUtils {
     static waitWhilePending: typeof waitWhilePending;
     static waitIdle: typeof waitIdle;
     static updateValueAndValidity: typeof updateValueAndValidity;
-    static getFormErrors: typeof getFormErrors;
     static isForm(object: any): object is IAppForm;
     static canSave(object: any): object is IAppForm & CanSave;
     static addValueInArray: typeof addValueInArray;
@@ -245,9 +252,29 @@ export declare class AppFormUtils {
     static isControlHasInput: typeof isControlHasInput;
     static setCalculatedValue: typeof setCalculatedValue;
     static resetCalculatedValue: typeof resetCalculatedValue;
+    static logFormErrors: typeof logFormErrors;
     static filterErrorsByPrefix: typeof filterFormErrorsByPrefix;
     static filterErrorsByPath: typeof filterFormErrorsByPath;
     static filterErrors: typeof filterFormErrors;
+    /**
+     * Retrieves all validation errors from a given form control, including its child controls if it is a form group or array.
+     *
+     * @param {AbstractControl} control - The form control to retrieve errors from. This can be a form group, a form array, or a simple form control.
+     * @param {Object} [opts] - Optional configurations for error retrieval.
+     * @param {string} [opts.controlName] - The name or path of the control being processed, used for structuring error keys in the result.
+     * @param {FormErrors} [opts.result] - The object to which errors will be added, allowing for aggregation and persistence between calls.
+     * @param {boolean} [opts.recursive=true] - Whether to recursively collect errors from child controls within a form group or array. Defaults to true.
+     * @return {FormErrors} The collected errors as a key-value object where keys represent control names or paths and values represent their respective errors. Returns `undefined` if the provided control is valid and has no errors.
+     */
+    static getFormErrors: typeof getFormErrors;
+    /**
+     * Sets form errors on an AbstractControl, including nested controls within form groups or arrays.
+     *
+     * @param {AbstractControl} control - The form control, form group, or form array to apply the errors to.
+     * @param {FormErrors} errors - An object representing the errors to be set on the control or its children.
+     * @return {void} Does not return a value.
+     */
+    static setFormErrors: typeof setFormErrors;
 }
 export declare function isControlHasInput(controls: {
     [key: string]: AbstractControl;

package/src/app/core/install/install-upgrade-card.component.d.ts

@@ -46,7 +46,7 @@ export declare class AppInstallUpgradeCard implements OnInit, OnDestroy {
     download(event: Event, link: InstallAppLink): Promise<void>;
     openFile(event: Event, link: InstallAppLink): Promise<void>;
     tryOnline(): Promise<void>;
-    getPlatformName(platform: 'android' | 'ios' | 'electron'): "" | "desktop" | "Android" | "iOS";
+    getPlatformName(platform: 'android' | 'ios' | 'electron'): "" | "Android" | "iOS" | "desktop";
     asLink(value: any): InstallAppLink;
     private checkNeedInstallOrUpdate;
     private getCompatibleInstallLinks;

package/src/app/shared/forms.d.ts

@@ -27,12 +27,31 @@ export declare function getFormValueFromEntity(entity: any | undefined, form: Un
  */
 export declare function adaptValueToControl(source: any | undefined, control: AbstractControl, path?: string): any;
 export declare function logFormErrors(control: AbstractControl, logPrefix?: string, path?: string): void;
+/**
+ * Retrieves all validation errors from a given form control, including its child controls if it is a form group or array.
+ *
+ * @param {AbstractControl} control - The form control to retrieve errors from. This can be a form group, a form array, or a simple form control.
+ * @param {Object} [opts] - Optional configurations for error retrieval.
+ * @param {string} [opts.controlName] - The name or path of the control being processed, used for structuring error keys in the result.
+ * @param {FormErrors} [opts.result] - The object to which errors will be added, allowing for aggregation and persistence between calls.
+ * @param {boolean} [opts.recursive=true] - Whether to recursively collect errors from child controls within a form group or array. Defaults to true.
+ * @return {FormErrors} The collected errors as a key-value object where keys represent control names or paths and values represent their respective errors. Returns `undefined` if the provided control is valid and has no errors.
+ */
 export declare function getFormErrors(control: AbstractControl, opts?: {
     controlName?: string;
     result?: FormErrors;
     recursive?: boolean;
 }): FormErrors;
-export declare function getControlFromPath(form: UntypedFormGroup, path: string): AbstractControl;
+/**
+ * Retrieves a control from the provided form/control structure using a dot-separated path.
+ *
+ * @param {AbstractControl} form - The root form group, form array, or control to start searching from.
+ * @param {string} path - The dot-separated path specifying the control. For example, 'groupName.controlName' or 'arrayName.0.controlName'.
+ * @param {boolean} [strict=true] - If true, throws an error if the full path cannot be resolved; if false, returns the last valid control encountered.
+ * @return {AbstractControl} - The control at the specified path or the closest valid control if strict mode is disabled.
+ * @throws {Error} - Throws an error if the path cannot be resolved and strict mode is enabled.
+ */
+export declare function getControlFromPath(form: AbstractControl, path: string, strict?: boolean): AbstractControl;
 export declare function disableControls(form: UntypedFormGroup, paths: string[], opts?: {
     onlySelf?: boolean;
     emitEvent?: boolean;
@@ -53,6 +72,14 @@ export declare function setControlsEnabled(form: UntypedFormGroup, enabled: bool
     emitEvent?: boolean;
     required?: boolean;
 }): void;
+/**
+ * Sets form errors on an AbstractControl, including nested controls within form groups or arrays.
+ *
+ * @param {AbstractControl} control - The form control, form group, or form array to apply the errors to.
+ * @param {FormErrors} errors - An object representing the errors to be set on the control or its children.
+ * @return {void} Does not return a value.
+ */
+export declare function setFormErrors(control: AbstractControl, errors: FormErrors): void;
 export declare function enableControl(control: AbstractControl, opts?: {
     onlySelf?: boolean;
     emitEvent?: boolean;

package/src/assets/manifest.json

@@ -2,7 +2,7 @@
   "name": "ngx-sumaris-components",
   "short_name": "ngx-sumaris-components",
   "manifest_version": 1,
-  "version": "18.12.6",
+  "version": "18.12.7",
   "default_locale": "fr",
   "description": "Angular components for building beautiful and responsive Apps",
   "icons": [{