@energycap/components 0.41.1-ECAP-26841-date-input-features.20250108-1149 → 0.42.1

package/lib/controls/file-upload/file-upload.component.d.ts

@@ -1,124 +1,124 @@
-import { ElementRef, OnChanges, OnInit, SimpleChanges } from '@angular/core';
-import { AsyncValidatorFn, FormControl, FormGroup, ValidatorFn } from '@angular/forms';
-import { ValidationMessageService } from '../../core/validation-message.service';
-import { FormGroupHelper } from '../../shared/form-group.helper';
-import { FormControlBase } from '../form-control-base';
-import * as i0 from "@angular/core";
-export type FileType = 'zip' | 'excel' | 'custom';
-export type FileOutput = 'raw' | 'base64';
-export declare const FileTypeExtensions: {
-    zip: string[];
-    excel: string[];
-};
-export type FileUploadFormGroup = {
-    file: FormControl<File | null>;
-    name: FormControl<string | null>;
-    base64FileString: FormControl<string | null>;
-    uploadResult: FormControl<any>;
-};
-export type InvalidFileError = {
-    invalidFile: true;
-};
-export type FileValidatorCallback = (file: File | null | undefined, base64: string | null | undefined) => Promise<InvalidFileError | null>;
-export declare class FileUploadComponent extends FormControlBase implements OnInit, OnChanges {
-    protected validationMessageService: ValidationMessageService;
-    protected formGroupHelper: FormGroupHelper;
-    static getFormModel(validators: ValidatorFn[], disabled?: boolean, 
-    /** Any validators required to make sure the selected file is valid. It is recommended that you use `FileUploadComponent.getFileValidator` to help construct the validator(s). NOTE: This currently only works when multiSelect is false. */
-    fileValidators?: AsyncValidatorFn | AsyncValidatorFn[]): FormGroup<FileUploadFormGroup>;
-    /**
-     * Helper function that returns an async validator to be used with the file upload control.
-     * This is useful for when the file needs to be validated before it can be uploaded.
-     *
-     * @param callback The callback function that will be called to validate the file. Parameters for the callback are the file and the base64 string for the file.
-     * base64 is null if the fileOutput input on the FileUploadComponent is set to raw. Using fileOutput set to base64 is recommended for images.
-     */
-    static getFileValidator(callback: FileValidatorCallback): AsyncValidatorFn;
-    formModel: FormGroup<FileUploadFormGroup>;
-    /**
-     * The value of the textbox input's placeholder
-     */
-    placeholder?: string;
-    /** Common extensions for a file browsing dialog
-     *  Note: Edge does not support the accept attribute on file inputs, therefor all file types
-     *        will be shown.  Firefox and Chrome both support this feature.
-     */
-    fileType?: FileType | undefined;
-    /**
-     * File output, determines which properties are supplied on the formModel
-     */
-    fileOutput?: FileOutput;
-    /** If fileType is set to custom set the acceptable file types based on the custom array */
-    customExtensions?: Array<string> | undefined;
-    /**
-     * Optional callback supported if the hosting page needs to process the file before
-     * setting the formModel with the file information. If the promise resolves it will continue
-     * and set the file name and contents to the formModel, otherwise on failure it'll do nothing.
-     */
-    onFileSelected?: (file: File) => Promise<any>;
-    /**
-     * Optional callback supported for when the hosting page needs to process multiple files
-     * We simply map the FileList to an array of File objects and pass that array to the
-     * callback and let the hosting page handle the processing
-     */
-    onMultipleFilesSelected?: (files: File[]) => Promise<any>;
-    /**
-     * Optional display type that controls whether the file input textbox is displayed or
-     * simply a button the user clicks to launch the OS file storage dialog.
-     * Default: file
-     */
-    displayType?: 'file' | 'button';
-    /**
-     * When display type is set to button this property will control the button label
-     */
-    buttonLabel?: string;
-    /**
-     * When display type is set to button this property will control the button type
-     */
-    buttonType?: string;
-    /**
-     * Optional property to control whether the user can select multiple files
-     */
-    multiSelect?: boolean;
-    /**
-     * When true, the onFileSelected callback will not be called if the form is invalid.
-     * This is useful when the file needs to be validated before it can be uploaded.
-     * For server-side validation, leave this as false and use the onFileSelected callback
-     * to upload the file and handle any errors thrown by the API.
-     */
-    validateBeforeUpload: boolean;
-    fileInput?: ElementRef;
-    /** Property bound to the file input to filter what file types are shown in the dialog */
-    fileTypeAccept: string | undefined;
-    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper);
-    ngOnChanges(changes: SimpleChanges): void;
-    ngOnInit(): void;
-    fileChange(files: FileList): Promise<void>;
-    /**
-     * Checks the file type and updates the file type accept property. This is what determines the file
-     * type choices that the user will be limited to in the file browse dialog
-     */
-    private updateFileTypeAccept;
-    /**
-     * Take a file that was selected by the user and process/patch our form model
-     * If the host component requires an action to occur with the file prior to the patch it will call
-     * and wait for it to return.
-     * @param file
-     * @param base64FileString Optional: Will have a value provided if the fileOutput is set to base64
-     */
-    private processFile;
-    /** Patches the form with the selected file in order to trigger control validation */
-    private validateFile;
-    /**
-     * Based on the fileOutput return whether this component is expected to deliver a base64 output
-     * @returns
-     */
-    private isBase64FileOutput;
-    /** Maps the files to an array of File objects and sends them along
-     * to the derived onMultipleFileSelected method in the hosting component
-     */
-    private handleMultipleFiles;
-    private readFile;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FileUploadComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FileUploadComponent, "ec-file-upload", never, { "formModel": "formModel"; "placeholder": "placeholder"; "fileType": "fileType"; "fileOutput": "fileOutput"; "customExtensions": "customExtensions"; "onFileSelected": "onFileSelected"; "onMultipleFilesSelected": "onMultipleFilesSelected"; "displayType": "displayType"; "buttonLabel": "buttonLabel"; "buttonType": "buttonType"; "multiSelect": "multiSelect"; "validateBeforeUpload": "validateBeforeUpload"; }, {}, never, never, false, never>;
-}
+import { ElementRef, OnChanges, OnInit, SimpleChanges } from '@angular/core';
+import { AsyncValidatorFn, FormControl, FormGroup, ValidatorFn } from '@angular/forms';
+import { ValidationMessageService } from '../../core/validation-message.service';
+import { FormGroupHelper } from '../../shared/form-group.helper';
+import { FormControlBase } from '../form-control-base';
+import * as i0 from "@angular/core";
+export type FileType = 'zip' | 'excel' | 'custom';
+export type FileOutput = 'raw' | 'base64';
+export declare const FileTypeExtensions: {
+    zip: string[];
+    excel: string[];
+};
+export type FileUploadFormGroup = {
+    file: FormControl<File | null>;
+    name: FormControl<string | null>;
+    base64FileString: FormControl<string | null>;
+    uploadResult: FormControl<any>;
+};
+export type InvalidFileError = {
+    invalidFile: true;
+};
+export type FileValidatorCallback = (file: File | null | undefined, base64: string | null | undefined) => Promise<InvalidFileError | null>;
+export declare class FileUploadComponent extends FormControlBase implements OnInit, OnChanges {
+    protected validationMessageService: ValidationMessageService;
+    protected formGroupHelper: FormGroupHelper;
+    static getFormModel(validators: ValidatorFn[], disabled?: boolean, 
+    /** Any validators required to make sure the selected file is valid. It is recommended that you use `FileUploadComponent.getFileValidator` to help construct the validator(s). NOTE: This currently only works when multiSelect is false. */
+    fileValidators?: AsyncValidatorFn | AsyncValidatorFn[]): FormGroup<FileUploadFormGroup>;
+    /**
+     * Helper function that returns an async validator to be used with the file upload control.
+     * This is useful for when the file needs to be validated before it can be uploaded.
+     *
+     * @param callback The callback function that will be called to validate the file. Parameters for the callback are the file and the base64 string for the file.
+     * base64 is null if the fileOutput input on the FileUploadComponent is set to raw. Using fileOutput set to base64 is recommended for images.
+     */
+    static getFileValidator(callback: FileValidatorCallback): AsyncValidatorFn;
+    formModel: FormGroup<FileUploadFormGroup>;
+    /**
+     * The value of the textbox input's placeholder
+     */
+    placeholder?: string;
+    /** Common extensions for a file browsing dialog
+     *  Note: Edge does not support the accept attribute on file inputs, therefor all file types
+     *        will be shown.  Firefox and Chrome both support this feature.
+     */
+    fileType?: FileType | undefined;
+    /**
+     * File output, determines which properties are supplied on the formModel
+     */
+    fileOutput?: FileOutput;
+    /** If fileType is set to custom set the acceptable file types based on the custom array */
+    customExtensions?: Array<string> | undefined;
+    /**
+     * Optional callback supported if the hosting page needs to process the file before
+     * setting the formModel with the file information. If the promise resolves it will continue
+     * and set the file name and contents to the formModel, otherwise on failure it'll do nothing.
+     */
+    onFileSelected?: (file: File) => Promise<any>;
+    /**
+     * Optional callback supported for when the hosting page needs to process multiple files
+     * We simply map the FileList to an array of File objects and pass that array to the
+     * callback and let the hosting page handle the processing
+     */
+    onMultipleFilesSelected?: (files: File[]) => Promise<any>;
+    /**
+     * Optional display type that controls whether the file input textbox is displayed or
+     * simply a button the user clicks to launch the OS file storage dialog.
+     * Default: file
+     */
+    displayType?: 'file' | 'button';
+    /**
+     * When display type is set to button this property will control the button label
+     */
+    buttonLabel?: string;
+    /**
+     * When display type is set to button this property will control the button type
+     */
+    buttonType?: string;
+    /**
+     * Optional property to control whether the user can select multiple files
+     */
+    multiSelect?: boolean;
+    /**
+     * When true, the onFileSelected callback will not be called if the form is invalid.
+     * This is useful when the file needs to be validated before it can be uploaded.
+     * For server-side validation, leave this as false and use the onFileSelected callback
+     * to upload the file and handle any errors thrown by the API.
+     */
+    validateBeforeUpload: boolean;
+    fileInput?: ElementRef;
+    /** Property bound to the file input to filter what file types are shown in the dialog */
+    fileTypeAccept: string | undefined;
+    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnInit(): void;
+    fileChange(files: FileList): Promise<void>;
+    /**
+     * Checks the file type and updates the file type accept property. This is what determines the file
+     * type choices that the user will be limited to in the file browse dialog
+     */
+    private updateFileTypeAccept;
+    /**
+     * Take a file that was selected by the user and process/patch our form model
+     * If the host component requires an action to occur with the file prior to the patch it will call
+     * and wait for it to return.
+     * @param file
+     * @param base64FileString Optional: Will have a value provided if the fileOutput is set to base64
+     */
+    private processFile;
+    /** Patches the form with the selected file in order to trigger control validation */
+    private validateFile;
+    /**
+     * Based on the fileOutput return whether this component is expected to deliver a base64 output
+     * @returns
+     */
+    private isBase64FileOutput;
+    /** Maps the files to an array of File objects and sends them along
+     * to the derived onMultipleFileSelected method in the hosting component
+     */
+    private handleMultipleFiles;
+    private readFile;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FileUploadComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FileUploadComponent, "ec-file-upload", never, { "formModel": { "alias": "formModel"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "fileType": { "alias": "fileType"; "required": false; }; "fileOutput": { "alias": "fileOutput"; "required": false; }; "customExtensions": { "alias": "customExtensions"; "required": false; }; "onFileSelected": { "alias": "onFileSelected"; "required": false; }; "onMultipleFilesSelected": { "alias": "onMultipleFilesSelected"; "required": false; }; "displayType": { "alias": "displayType"; "required": false; }; "buttonLabel": { "alias": "buttonLabel"; "required": false; }; "buttonType": { "alias": "buttonType"; "required": false; }; "multiSelect": { "alias": "multiSelect"; "required": false; }; "validateBeforeUpload": { "alias": "validateBeforeUpload"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/controls/form-control/form-control.component.d.ts

@@ -1,28 +1,28 @@
-import { AfterViewInit, ElementRef, EventEmitter } from '@angular/core';
-import { AbstractControl } from '@angular/forms';
-import * as i0 from "@angular/core";
-export declare class FormControlComponent implements AfterViewInit {
-    private el;
-    formControlDirective?: AbstractControl;
-    id: string;
-    icon?: string;
-    actionIcon?: string;
-    showClear: boolean;
-    formModelInput?: AbstractControl;
-    autofocus: boolean;
-    pending: boolean;
-    required: boolean;
-    readonly: boolean;
-    get empty(): boolean;
-    get invalid(): boolean;
-    get disabled(): boolean;
-    actionClicked: EventEmitter<Event>;
-    private get _formModel();
-    constructor(el: ElementRef);
-    ngAfterViewInit(): void;
-    onClick(): void;
-    focus(): void;
-    clear(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormControlComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormControlComponent, "ec-form-control", never, { "id": "id"; "icon": "icon"; "actionIcon": "actionIcon"; "showClear": "showClear"; "formModelInput": "formModel"; "autofocus": "autofocus"; "pending": "pending"; "required": "required"; "readonly": "readonly"; }, { "actionClicked": "actionClicked"; }, ["formControlDirective"], ["*"], false, never>;
-}
+import { AfterViewInit, ElementRef, EventEmitter } from '@angular/core';
+import { AbstractControl } from '@angular/forms';
+import * as i0 from "@angular/core";
+export declare class FormControlComponent implements AfterViewInit {
+    private el;
+    formControlDirective?: AbstractControl;
+    id: string;
+    icon?: string;
+    actionIcon?: string;
+    showClear: boolean;
+    formModelInput?: AbstractControl;
+    autofocus: boolean;
+    pending: boolean;
+    required: boolean;
+    readonly: boolean;
+    get empty(): boolean;
+    get invalid(): boolean;
+    get disabled(): boolean;
+    actionClicked: EventEmitter<Event>;
+    private get _formModel();
+    constructor(el: ElementRef);
+    ngAfterViewInit(): void;
+    onClick(): void;
+    focus(): void;
+    clear(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormControlComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormControlComponent, "ec-form-control", never, { "id": { "alias": "id"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "actionIcon": { "alias": "actionIcon"; "required": false; }; "showClear": { "alias": "showClear"; "required": false; }; "formModelInput": { "alias": "formModel"; "required": false; }; "autofocus": { "alias": "autofocus"; "required": false; }; "pending": { "alias": "pending"; "required": false; }; "required": { "alias": "required"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "actionClicked": "actionClicked"; }, ["formControlDirective"], ["*"], false, never>;
+}

package/lib/controls/form-control-base.d.ts

@@ -1,110 +1,110 @@
-import { OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core';
-import { AbstractControl } from "@angular/forms";
-import { Subject } from "rxjs";
-import { ValidationMessageService } from "../core/validation-message.service";
-import { FormGroupHelper } from '../shared/form-group.helper';
-import { PopoverContentPosition } from './popover/popover.component';
-import * as i0 from "@angular/core";
-export type ControlLabelPosition = "top" | "bottom" | "left";
-/**
- * Base class for Reactive Form Controls, containing ECI-specific shared properties
- */
-export declare abstract class FormControlBase implements OnInit, OnDestroy, OnChanges {
-    protected validationMessageService: ValidationMessageService;
-    protected formGroupHelper: FormGroupHelper;
-    /**
-     * If true, will focus the control's input when the view is intialized
-     */
-    autofocus?: boolean;
-    /**
-     * UI-oriented form model that retains the states and values of the HTML controls on screen.
-     * Can be a {@link FormControl} or a {@link FormGroup}
-     */
-    formModel: AbstractControl;
-    /**
-     * The form control label
-     */
-    label?: string;
-    /**
-     * The position of the form control label (top|bottom)
-     */
-    labelPosition?: ControlLabelPosition;
-    /**
-     * The id of the component. We use this to identify a control on focus events and help.
-     */
-    id: string;
-    /**
-     * The pending status of the control, can be used to tell the user the control is
-     * awaiting data via a spinner or animation
-     */
-    pending?: boolean;
-    /**
-     * Whether the input is a required field or not
-     * @todo: Sometime in the future Angular makes it sound like this will be handled via the Reactive form When that happens this property can be removed
-     */
-    required?: boolean;
-    /**
-     * The tabindex of the control
-     */
-    tabindex?: number;
-    /**
-     * Disable the control and display the value
-     */
-    readonly?: boolean;
-    /**
-     * Conditionally show a tooltip on the form control's input.
-     */
-    tooltip?: string;
-    /**
-     * Conditionally show a help popover next to the controls label.
-     */
-    helpPopover?: string;
-    /**
-     * When a help popover is present, allows the popover to be positioned in different locations.
-     */
-    helpPopoverPosition?: PopoverContentPosition;
-    /**
-     * All current validation errors
-     */
-    validationErrors: string;
-    /**
-     * The id of the form controls input, getnerated from the components id.
-     */
-    inputId: string;
-    /**
-     * Notifies component subscriptions that component is destroyed.
-     * Use with `takeUntil()` when subscribing to complete subscriptions
-     * automatically.
-     *
-     * See:
-     * [RxJs]{@link http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#instance-method-takeUntil}
-     * [and this]{@link https://medium.com/@benlesh/rxjs-dont-unsubscribe-6753ed4fda87}
-     * [and this]{@link https://netbasal.com/when-to-unsubscribe-in-angular-d61c6b21bad3}
-     * [and this]{@link http://brianflove.com/2016/12/11/anguar-2-unsubscribe-observables/}
-     */
-    protected componentDestroyed: Subject<void>;
-    /**
-     * Creates an instance of FormControlBase.
-     */
-    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper);
-    /**
-     * Angular onChange lifecyle hook
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * Angular onInit lifecycle hook.
-     */
-    ngOnInit(): void;
-    /**
-     * Angular onDestroy lifecyle hook.
-     * Unsubscribe from any observables
-     */
-    ngOnDestroy(): void;
-    /**
-     * Function that subscribes to the formModel's valueChanges Observable
-     * to take any erros and translate them
-     */
-    protected translateValidationMessages(data?: any): Promise<void>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormControlBase, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<FormControlBase, never, never, { "autofocus": "autofocus"; "formModel": "formModel"; "label": "label"; "labelPosition": "labelPosition"; "id": "id"; "pending": "pending"; "required": "required"; "tabindex": "tabindex"; "readonly": "readonly"; "tooltip": "tooltip"; "helpPopover": "helpPopover"; "helpPopoverPosition": "helpPopoverPosition"; }, {}, never, never, false, never>;
-}
+import { OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core';
+import { AbstractControl } from "@angular/forms";
+import { Subject } from "rxjs";
+import { ValidationMessageService } from "../core/validation-message.service";
+import { FormGroupHelper } from '../shared/form-group.helper';
+import { PopoverContentPosition } from './popover/popover.component';
+import * as i0 from "@angular/core";
+export type ControlLabelPosition = "top" | "bottom" | "left";
+/**
+ * Base class for Reactive Form Controls, containing ECI-specific shared properties
+ */
+export declare abstract class FormControlBase implements OnInit, OnDestroy, OnChanges {
+    protected validationMessageService: ValidationMessageService;
+    protected formGroupHelper: FormGroupHelper;
+    /**
+     * If true, will focus the control's input when the view is intialized
+     */
+    autofocus?: boolean;
+    /**
+     * UI-oriented form model that retains the states and values of the HTML controls on screen.
+     * Can be a {@link FormControl} or a {@link FormGroup}
+     */
+    formModel: AbstractControl;
+    /**
+     * The form control label
+     */
+    label?: string;
+    /**
+     * The position of the form control label (top|bottom)
+     */
+    labelPosition?: ControlLabelPosition;
+    /**
+     * The id of the component. We use this to identify a control on focus events and help.
+     */
+    id: string;
+    /**
+     * The pending status of the control, can be used to tell the user the control is
+     * awaiting data via a spinner or animation
+     */
+    pending?: boolean;
+    /**
+     * Whether the input is a required field or not
+     * @todo: Sometime in the future Angular makes it sound like this will be handled via the Reactive form When that happens this property can be removed
+     */
+    required?: boolean;
+    /**
+     * The tabindex of the control
+     */
+    tabindex?: number;
+    /**
+     * Disable the control and display the value
+     */
+    readonly?: boolean;
+    /**
+     * Conditionally show a tooltip on the form control's input.
+     */
+    tooltip?: string;
+    /**
+     * Conditionally show a help popover next to the controls label.
+     */
+    helpPopover?: string;
+    /**
+     * When a help popover is present, allows the popover to be positioned in different locations.
+     */
+    helpPopoverPosition?: PopoverContentPosition;
+    /**
+     * All current validation errors
+     */
+    validationErrors: string;
+    /**
+     * The id of the form controls input, getnerated from the components id.
+     */
+    inputId: string;
+    /**
+     * Notifies component subscriptions that component is destroyed.
+     * Use with `takeUntil()` when subscribing to complete subscriptions
+     * automatically.
+     *
+     * See:
+     * [RxJs]{@link http://reactivex.io/rxjs/class/es6/Observable.js~Observable.html#instance-method-takeUntil}
+     * [and this]{@link https://medium.com/@benlesh/rxjs-dont-unsubscribe-6753ed4fda87}
+     * [and this]{@link https://netbasal.com/when-to-unsubscribe-in-angular-d61c6b21bad3}
+     * [and this]{@link http://brianflove.com/2016/12/11/anguar-2-unsubscribe-observables/}
+     */
+    protected componentDestroyed: Subject<void>;
+    /**
+     * Creates an instance of FormControlBase.
+     */
+    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper);
+    /**
+     * Angular onChange lifecyle hook
+     */
+    ngOnChanges(changes: SimpleChanges): void;
+    /**
+     * Angular onInit lifecycle hook.
+     */
+    ngOnInit(): void;
+    /**
+     * Angular onDestroy lifecyle hook.
+     * Unsubscribe from any observables
+     */
+    ngOnDestroy(): void;
+    /**
+     * Function that subscribes to the formModel's valueChanges Observable
+     * to take any erros and translate them
+     */
+    protected translateValidationMessages(data?: any): Promise<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormControlBase, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<FormControlBase, never, never, { "autofocus": { "alias": "autofocus"; "required": false; }; "formModel": { "alias": "formModel"; "required": false; }; "label": { "alias": "label"; "required": false; }; "labelPosition": { "alias": "labelPosition"; "required": false; }; "id": { "alias": "id"; "required": false; }; "pending": { "alias": "pending"; "required": false; }; "required": { "alias": "required"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "tooltip": { "alias": "tooltip"; "required": false; }; "helpPopover": { "alias": "helpPopover"; "required": false; }; "helpPopoverPosition": { "alias": "helpPopoverPosition"; "required": false; }; }, {}, never, never, false, never>;
+}