@energycap/components 0.41.0 → 0.41.1-ECAP-27592-angular-17.20241220-1140

package/lib/controls/radio-button/radio-button.component.d.ts

@@ -1,53 +1,53 @@
-import { AfterViewInit, ElementRef, OnInit } from '@angular/core';
-import { ValidationMessageService } from '../../core/validation-message.service';
-import { FormGroupHelper } from '../../shared/form-group.helper';
-import { FormControlBase } from '../form-control-base';
-import { RadioButtonOption } from './radio-button-option';
-import * as i0 from "@angular/core";
-/**
- * Row displays options horizontally, column displays options vertically
- */
-export type RadioButtonDirection = "row" | "column";
-/**
- * Radio is the default button style, toggle will style as a toggle switch
- */
-export type RadioButtonType = "radio" | "toggle";
-export declare class RadioButtonComponent extends FormControlBase implements AfterViewInit, OnInit {
-    protected validationMessageService: ValidationMessageService;
-    protected formGroupHelper: FormGroupHelper;
-    /**
-     * Display the radio button options as a default set of radio button inputs or
-     * as a toggle switch
-     * @default 'radio'
-     */
-    type?: RadioButtonType;
-    /**
-     * One or more options to display
-     */
-    options: RadioButtonOption[];
-    /**
-     * If there is more than one option, display them in a row or column.
-     * @default 'row'
-     */
-    direction?: RadioButtonDirection;
-    /**
-    * The name of the radio input element used to group radio elements
-    * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/radio
-    */
-    name: string;
-    /**
-     * An array of classnames that will be passed into ngClass
-     */
-    currentClasses: string[];
-    /**
-     * Reference to the first input found with the radioInput reference variable.  All radio
-     * inputs for this component will be tagged with this ref variable, but only the first found
-     * will be selected as the inputElement for autofocus
-     */
-    protected inputElement: ElementRef;
-    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper);
-    ngOnInit(): void;
-    ngAfterViewInit(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RadioButtonComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<RadioButtonComponent, "ec-radiobutton", never, { "type": "type"; "options": "options"; "direction": "direction"; "name": "name"; }, {}, never, never, false, never>;
-}
+import { AfterViewInit, ElementRef, OnInit } from '@angular/core';
+import { ValidationMessageService } from '../../core/validation-message.service';
+import { FormGroupHelper } from '../../shared/form-group.helper';
+import { FormControlBase } from '../form-control-base';
+import { RadioButtonOption } from './radio-button-option';
+import * as i0 from "@angular/core";
+/**
+ * Row displays options horizontally, column displays options vertically
+ */
+export type RadioButtonDirection = "row" | "column";
+/**
+ * Radio is the default button style, toggle will style as a toggle switch
+ */
+export type RadioButtonType = "radio" | "toggle";
+export declare class RadioButtonComponent extends FormControlBase implements AfterViewInit, OnInit {
+    protected validationMessageService: ValidationMessageService;
+    protected formGroupHelper: FormGroupHelper;
+    /**
+     * Display the radio button options as a default set of radio button inputs or
+     * as a toggle switch
+     * @default 'radio'
+     */
+    type?: RadioButtonType;
+    /**
+     * One or more options to display
+     */
+    options: RadioButtonOption[];
+    /**
+     * If there is more than one option, display them in a row or column.
+     * @default 'row'
+     */
+    direction?: RadioButtonDirection;
+    /**
+    * The name of the radio input element used to group radio elements
+    * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/radio
+    */
+    name: string;
+    /**
+     * An array of classnames that will be passed into ngClass
+     */
+    currentClasses: string[];
+    /**
+     * Reference to the first input found with the radioInput reference variable.  All radio
+     * inputs for this component will be tagged with this ref variable, but only the first found
+     * will be selected as the inputElement for autofocus
+     */
+    protected inputElement: ElementRef;
+    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper);
+    ngOnInit(): void;
+    ngAfterViewInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RadioButtonComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<RadioButtonComponent, "ec-radiobutton", never, { "type": { "alias": "type"; "required": false; }; "options": { "alias": "options"; "required": false; }; "direction": { "alias": "direction"; "required": false; }; "name": { "alias": "name"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/controls/select/select.component.d.ts

@@ -1,44 +1,44 @@
-import { AfterViewInit, ElementRef, SimpleChanges } from '@angular/core';
-import { ValidationMessageService } from '../../core/validation-message.service';
-import { FormGroupHelper } from '../../shared/form-group.helper';
-import { FormControlBase } from '../form-control-base';
-import { MenuItem } from '../menu/menu.component';
-import * as i0 from "@angular/core";
-export declare class SelectComponent extends FormControlBase implements AfterViewInit {
-    protected validationMessageService: ValidationMessageService;
-    protected formGroupHelper: FormGroupHelper;
-    private el;
-    /**
-     * When the component is not required, defines the label for an additional first option that sets the control to null
-     */
-    placeholder: string;
-    /**
-     * When the component is not required, an additional option is added with a value of null.
-     */
-    options: MenuItem[];
-    /**
-     * Select a default option automatically during initialization and when options change. Default: `true`.
-     * * If formModel has a value
-     *   * Make no change if the current value exists in options
-     *   * Otherwise, set value to the first option if control is required, or null if optional and emit event
-     * * If formModel has no value
-     *   * Set value to first option if control is required and emit eventSet to false to manually manage form state.
-     *
-     * Set to false to opt out of automatic state management
-     */
-    autoDefault: boolean;
-    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper, el: ElementRef);
-    ngOnChanges(changes: SimpleChanges): void;
-    ngAfterViewInit(): void;
-    private focus;
-    /**
-     * If formModel has a value
-     *  * Make no change if the current value exists in options
-     *  * Otherwise, set value to the first option if control is required, or null if optional and emit event
-     * If formModel has no value
-     *  * Set value to first option if control is required and emit event
-     */
-    private onOptionsChange;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SelectComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SelectComponent, "ec-select", never, { "placeholder": "placeholder"; "options": "options"; "autoDefault": "autoDefault"; }, {}, never, never, false, never>;
-}
+import { AfterViewInit, ElementRef, SimpleChanges } from '@angular/core';
+import { ValidationMessageService } from '../../core/validation-message.service';
+import { FormGroupHelper } from '../../shared/form-group.helper';
+import { FormControlBase } from '../form-control-base';
+import { MenuItem } from '../menu/menu.component';
+import * as i0 from "@angular/core";
+export declare class SelectComponent extends FormControlBase implements AfterViewInit {
+    protected validationMessageService: ValidationMessageService;
+    protected formGroupHelper: FormGroupHelper;
+    private el;
+    /**
+     * When the component is not required, defines the label for an additional first option that sets the control to null
+     */
+    placeholder: string;
+    /**
+     * When the component is not required, an additional option is added with a value of null.
+     */
+    options: MenuItem[];
+    /**
+     * Select a default option automatically during initialization and when options change. Default: `true`.
+     * * If formModel has a value
+     *   * Make no change if the current value exists in options
+     *   * Otherwise, set value to the first option if control is required, or null if optional and emit event
+     * * If formModel has no value
+     *   * Set value to first option if control is required and emit eventSet to false to manually manage form state.
+     *
+     * Set to false to opt out of automatic state management
+     */
+    autoDefault: boolean;
+    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper, el: ElementRef);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngAfterViewInit(): void;
+    private focus;
+    /**
+     * If formModel has a value
+     *  * Make no change if the current value exists in options
+     *  * Otherwise, set value to the first option if control is required, or null if optional and emit event
+     * If formModel has no value
+     *  * Set value to first option if control is required and emit event
+     */
+    private onOptionsChange;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SelectComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SelectComponent, "ec-select", never, { "placeholder": { "alias": "placeholder"; "required": false; }; "options": { "alias": "options"; "required": false; }; "autoDefault": { "alias": "autoDefault"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/controls/tabs/tabs.component.d.ts

@@ -1,30 +1,30 @@
-import { NavItem } from '../navigation/nav-item';
-import { NavGroup } from '../navigation/nav-group';
-import * as i0 from "@angular/core";
-export interface Tab extends NavItem {
-    url: string;
-    tabs?: Tab[];
-    hide?: Array<(...args: any[]) => boolean>;
-}
-/**
- * Component to display navigation tabs
- */
-export declare class TabsComponent {
-    /** The id of the tabs component, will be used as a prefix for each individual tab */
-    id: string;
-    /** The tabindex of the tabs component, will be applied to each individual tab */
-    tabindex: number;
-    /** Display tabs in the default style or as pills */
-    tabStyle: 'tabs' | 'pills';
-    /** The tabs group */
-    tabs: NavGroup;
-    constructor();
-    /**
-     * Set the selected tab to the one the user clicked on pressed enter
-     * when focused. If the event was a keypress.enter and the tab
-     * has a link, navigate to that link.
-     */
-    selectTab(event: Event, tab: NavItem): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TabsComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TabsComponent, "ec-tabs", never, { "id": "id"; "tabindex": "tabindex"; "tabStyle": "tabStyle"; "tabs": "tabGroup"; }, {}, never, never, false, never>;
-}
+import { NavItem } from '../navigation/nav-item';
+import { NavGroup } from '../navigation/nav-group';
+import * as i0 from "@angular/core";
+export interface Tab extends NavItem {
+    url: string;
+    tabs?: Tab[];
+    hide?: Array<(...args: any[]) => boolean>;
+}
+/**
+ * Component to display navigation tabs
+ */
+export declare class TabsComponent {
+    /** The id of the tabs component, will be used as a prefix for each individual tab */
+    id: string;
+    /** The tabindex of the tabs component, will be applied to each individual tab */
+    tabindex: number;
+    /** Display tabs in the default style or as pills */
+    tabStyle: 'tabs' | 'pills';
+    /** The tabs group */
+    tabs: NavGroup;
+    constructor();
+    /**
+     * Set the selected tab to the one the user clicked on pressed enter
+     * when focused. If the event was a keypress.enter and the tab
+     * has a link, navigate to that link.
+     */
+    selectTab(event: Event, tab: NavItem): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TabsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TabsComponent, "ec-tabs", never, { "id": { "alias": "id"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "tabStyle": { "alias": "tabStyle"; "required": false; }; "tabs": { "alias": "tabGroup"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/controls/textbox/textbox.component.d.ts

@@ -1,107 +1,107 @@
-import { FormGroupHelper } from '../../shared/form-group.helper';
-import { ElementRef, AfterViewInit, OnInit, OnChanges, SimpleChanges } from '@angular/core';
-import { TranslateService } from "@ngx-translate/core";
-import { FormControlBase } from "../form-control-base";
-import { ValidationMessageService } from "../../core/validation-message.service";
-import { ValidatorFn } from '@angular/forms';
-import * as i0 from "@angular/core";
-/**
- * The type of textbox where text is input[type="text"], multi_line is a
- * textarea, email is input[type="email"], url is input[type="url"], and password
- * is an input[type="password"]
- *
- * If the type is url or tel a regex pattern is automatically added to the form validators.  No other pattern validators
- * may be used for this input, having more than one will cause issues.
- *
- * If the type is email an email validator is automatically added to the form validators.
- * */
-export type TextboxType = "text" | "multi_line" | "email" | "url" | "password" | "tel";
-/** Type for advanced validation of textbox form controls, if in the future
- *  we want more handling we will need to update this type.
- */
-export type TextboxValidatorParameters = {
-    required?: boolean;
-    minLength?: number;
-    maxLength?: number;
-    unique?: boolean;
-    valid?: boolean;
-    pattern?: RegExp;
-};
-/** Advanced validation for textbox form controls */
-export declare const textboxValidation: (validatorParams: TextboxValidatorParameters) => ValidatorFn;
-export declare const phoneNumberValidationPattern: string;
-export declare const urlValidationPattern: string;
-export declare class TextboxComponent extends FormControlBase implements OnInit, AfterViewInit, OnChanges {
-    protected validationMessageService: ValidationMessageService;
-    protected formGroupHelper: FormGroupHelper;
-    protected translate: TranslateService;
-    /**
-     * Set the value of the input's autocomplete attribute
-     */
-    autocomplete?: string;
-    /**
-     * The textbox type
-     */
-    type?: TextboxType;
-    /**
-     * The value of the textbox input's placeholder
-     */
-    placeholder?: string;
-    /**
-     * The maximum number of characters allowed in the input
-     *
-     * This is for adding the attribute on the element to get the browser functionality
-     * from the input.  If you need the form to be validated before submission, apply the
-     * maxLength validator to the form control.
-     */
-    maxlength?: number;
-    /**
-     * The minimum number of characters allowed in the input
-     *
-     * This is for adding the attribute on the element to get the browser functionality
-     * from the input.  If you need the form to be validated before submission, apply the
-     * minLength validator to the form control.
-     */
-    minlength?: number;
-    /**
-     * The value of the rows attribute for a textarea. Only applies to multi-line type
-     */
-    rows?: number;
-    /**
-     * If set to true, we will select all text within the input if
-     * autofocus is also set to true
-     */
-    selectOnAutofocus?: boolean;
-    /**
-     * If set to true, we will upper case on focus out
-     */
-    upperCase: boolean;
-    /**
-     * Validation pattern for the input. This is determined on the input type specified
-     */
-    validationPattern: string;
-    protected inputElement: ElementRef;
-    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper, translate: TranslateService);
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * The angular onInit lifecycle hook
-     */
-    ngOnInit(): void;
-    /**
-     * The angular afterViewInit lifecycle hook
-     */
-    ngAfterViewInit(): void;
-    /**
-     * Function to set focus on an input programmatically after the page
-     * had been rendered.  The highlight text flag will select the text
-     * within the input if passed in and true
-     */
-    setFocus(highlightText?: boolean): void;
-    /**
-  * Focus out event handler
-  * will upper case and trim value if upperCase is true (this is what we do on the apis)
-  */
-    focusOutEvent(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TextboxComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<TextboxComponent, "ec-textbox", never, { "autocomplete": "autocomplete"; "type": "type"; "placeholder": "placeholder"; "maxlength": "maxlength"; "minlength": "minlength"; "rows": "rows"; "selectOnAutofocus": "selectOnAutofocus"; "upperCase": "upperCase"; }, {}, never, never, false, never>;
-}
+import { FormGroupHelper } from '../../shared/form-group.helper';
+import { ElementRef, AfterViewInit, OnInit, OnChanges, SimpleChanges } from '@angular/core';
+import { TranslateService } from "@ngx-translate/core";
+import { FormControlBase } from "../form-control-base";
+import { ValidationMessageService } from "../../core/validation-message.service";
+import { ValidatorFn } from '@angular/forms';
+import * as i0 from "@angular/core";
+/**
+ * The type of textbox where text is input[type="text"], multi_line is a
+ * textarea, email is input[type="email"], url is input[type="url"], and password
+ * is an input[type="password"]
+ *
+ * If the type is url or tel a regex pattern is automatically added to the form validators.  No other pattern validators
+ * may be used for this input, having more than one will cause issues.
+ *
+ * If the type is email an email validator is automatically added to the form validators.
+ * */
+export type TextboxType = "text" | "multi_line" | "email" | "url" | "password" | "tel";
+/** Type for advanced validation of textbox form controls, if in the future
+ *  we want more handling we will need to update this type.
+ */
+export type TextboxValidatorParameters = {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+    unique?: boolean;
+    valid?: boolean;
+    pattern?: RegExp;
+};
+/** Advanced validation for textbox form controls */
+export declare const textboxValidation: (validatorParams: TextboxValidatorParameters) => ValidatorFn;
+export declare const phoneNumberValidationPattern: string;
+export declare const urlValidationPattern: string;
+export declare class TextboxComponent extends FormControlBase implements OnInit, AfterViewInit, OnChanges {
+    protected validationMessageService: ValidationMessageService;
+    protected formGroupHelper: FormGroupHelper;
+    protected translate: TranslateService;
+    /**
+     * Set the value of the input's autocomplete attribute
+     */
+    autocomplete?: string;
+    /**
+     * The textbox type
+     */
+    type?: TextboxType;
+    /**
+     * The value of the textbox input's placeholder
+     */
+    placeholder?: string;
+    /**
+     * The maximum number of characters allowed in the input
+     *
+     * This is for adding the attribute on the element to get the browser functionality
+     * from the input.  If you need the form to be validated before submission, apply the
+     * maxLength validator to the form control.
+     */
+    maxlength?: number;
+    /**
+     * The minimum number of characters allowed in the input
+     *
+     * This is for adding the attribute on the element to get the browser functionality
+     * from the input.  If you need the form to be validated before submission, apply the
+     * minLength validator to the form control.
+     */
+    minlength?: number;
+    /**
+     * The value of the rows attribute for a textarea. Only applies to multi-line type
+     */
+    rows?: number;
+    /**
+     * If set to true, we will select all text within the input if
+     * autofocus is also set to true
+     */
+    selectOnAutofocus?: boolean;
+    /**
+     * If set to true, we will upper case on focus out
+     */
+    upperCase: boolean;
+    /**
+     * Validation pattern for the input. This is determined on the input type specified
+     */
+    validationPattern: string;
+    protected inputElement: ElementRef;
+    constructor(validationMessageService: ValidationMessageService, formGroupHelper: FormGroupHelper, translate: TranslateService);
+    ngOnChanges(changes: SimpleChanges): void;
+    /**
+     * The angular onInit lifecycle hook
+     */
+    ngOnInit(): void;
+    /**
+     * The angular afterViewInit lifecycle hook
+     */
+    ngAfterViewInit(): void;
+    /**
+     * Function to set focus on an input programmatically after the page
+     * had been rendered.  The highlight text flag will select the text
+     * within the input if passed in and true
+     */
+    setFocus(highlightText?: boolean): void;
+    /**
+  * Focus out event handler
+  * will upper case and trim value if upperCase is true (this is what we do on the apis)
+  */
+    focusOutEvent(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TextboxComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<TextboxComponent, "ec-textbox", never, { "autocomplete": { "alias": "autocomplete"; "required": false; }; "type": { "alias": "type"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "maxlength": { "alias": "maxlength"; "required": false; }; "minlength": { "alias": "minlength"; "required": false; }; "rows": { "alias": "rows"; "required": false; }; "selectOnAutofocus": { "alias": "selectOnAutofocus"; "required": false; }; "upperCase": { "alias": "upperCase"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/core/cache.service.d.ts

@@ -1,33 +1,33 @@
-import * as i0 from "@angular/core";
-export declare class CacheService {
-    private localStorageAvailable;
-    private sessionStorageAvailable;
-    constructor();
-    /**Return true if the requested cache allows the user to round-trip data in the current environment.
-     * Security settings can prevent it and the app may need to know if "not found" means "never set" or "not supported"
-     */
-    isCacheAvailable(sessionOnly?: boolean): boolean;
-    /**
-     * Retrieve an item from cache
-     */
-    getItem<T>(key: string, sessionOnly?: boolean): T | null;
-    /**
-     * Retrieves all keys from cache
-     */
-    keys(sessionOnly?: boolean): Array<string>;
-    /**
-     * Removes an item from the cache
-     */
-    removeItem(key: string, sessionOnly?: boolean): void;
-    /**
-     * Persists an item to cache
-     */
-    setItem(key: string, value: object, sessionOnly?: boolean): void;
-    /**Returns the local or session storage to use for backing the given cache request.
-     * If the browser does not support the requested storage the result will be null.
-     * This can happen if the user is in Firefox for example with the setting dom.storage.enabled = false
-    */
-    private getStorage;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CacheService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<CacheService>;
-}
+import * as i0 from "@angular/core";
+export declare class CacheService {
+    private localStorageAvailable;
+    private sessionStorageAvailable;
+    constructor();
+    /**Return true if the requested cache allows the user to round-trip data in the current environment.
+     * Security settings can prevent it and the app may need to know if "not found" means "never set" or "not supported"
+     */
+    isCacheAvailable(sessionOnly?: boolean): boolean;
+    /**
+     * Retrieve an item from cache
+     */
+    getItem<T>(key: string, sessionOnly?: boolean): T | null;
+    /**
+     * Retrieves all keys from cache
+     */
+    keys(sessionOnly?: boolean): Array<string>;
+    /**
+     * Removes an item from the cache
+     */
+    removeItem(key: string, sessionOnly?: boolean): void;
+    /**
+     * Persists an item to cache
+     */
+    setItem(key: string, value: object, sessionOnly?: boolean): void;
+    /**Returns the local or session storage to use for backing the given cache request.
+     * If the browser does not support the requested storage the result will be null.
+     * This can happen if the user is in Firefox for example with the setting dom.storage.enabled = false
+    */
+    private getStorage;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CacheService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CacheService>;
+}

package/lib/core/custom-validators.d.ts

@@ -1,20 +1,20 @@
-import { ValidatorFn } from '@angular/forms';
-export declare class CustomValidators {
-    /**
-     * Tests the control using Angular's required validator, except returns
-     * an error map that triggers the plural 'are required' validation message
-     * instead of 'is required'
-     *
-     * @returns An error map with the `requiredPlural` property
-     * if the validation check fails, otherwise `null`.
-     */
-    static requiredPlural: ValidatorFn;
-    /**
-     * Returns a validation error if the control's value is not valid JSON.
-     */
-    static json: ValidatorFn;
-    /**
-     * Returns a validation error if the control's value is not a valid domain.
-     */
-    static domain: ValidatorFn;
-}
+import { ValidatorFn } from '@angular/forms';
+export declare class CustomValidators {
+    /**
+     * Tests the control using Angular's required validator, except returns
+     * an error map that triggers the plural 'are required' validation message
+     * instead of 'is required'
+     *
+     * @returns An error map with the `requiredPlural` property
+     * if the validation check fails, otherwise `null`.
+     */
+    static requiredPlural: ValidatorFn;
+    /**
+     * Returns a validation error if the control's value is not valid JSON.
+     */
+    static json: ValidatorFn;
+    /**
+     * Returns a validation error if the control's value is not a valid domain.
+     */
+    static domain: ValidatorFn;
+}