@softheon/armature 19.23.2 → 21.0.0

package/lib/forms/components/sof-select/sof-select.component.d.ts

@@ -1,239 +0,0 @@
-import { EventEmitter, ElementRef, OnInit, WritableSignal, Signal, ChangeDetectorRef, AfterViewInit, NgZone, OnDestroy } from '@angular/core';
-import { ControlValueAccessor, FormControl, NgControl, ValidationErrors, Validator } from '@angular/forms';
-import { TranslateService } from '@ngx-translate/core';
-import * as i0 from "@angular/core";
-/**
- * @description
- * - This component can be used as a single select or multi-select.
- * - Can be used with a reactive formControlName.
- * - Can be used with [(ngModal)] binding.
- * - Can be used without a form using the (selectionChange) output event.
- */
-export declare class SofSelectComponent implements ControlValueAccessor, Validator, OnInit, AfterViewInit, OnDestroy {
-    private _ngControl;
-    private _host;
-    private _cdr;
-    private _zone;
-    private _translate;
-    /**
-     * Unique id for testing
-     * @note
-     * this value will be used to prefix the id of the select trigger & each option by index -
-     * ```
-     * // trigger
-     * <button [id]="id + '-select-trigger'">
-     * // options
-     * <li [id]="id + '-select-option-' + index">
-     * ...
-     * ```
-    */
-    id: string;
-    /** Select options */
-    set options(value: Array<SelectOption>);
-    /** Select options local signal */
-    private _options;
-    /** Readonly select options signal */
-    readOptions: Signal<Array<SelectOption>>;
-    /** The select's label / placeholder */
-    label: string;
-    /** Optional helper text */
-    helpText?: string;
-    /**
-     * Is multi-select ?
-     * @default false
-    */
-    multiple?: boolean;
-    /**
-     * Show select all option (if multiple only)
-     * @default false
-    */
-    showSelectAll?: boolean;
-    /**
-     * Is disabled ?
-     * @default false
-     * @note a Form control marked as disabled will also set this if not directly passed
-    */
-    isDisabled?: boolean;
-    /**
-     * Component width
-     * @type `'full' | 'fixed'`
-     * @default `'fixed'``
-     * @description
-     * - 'fixed' = width: 300px;
-     * - 'full' = width: 100%;
-    */
-    width?: 'full' | 'fixed';
-    /**
-     * Should the select have a white background ?
-     * @description
-     * By default the select will have a background of $surface-color-level-one-light (#FAFAFA);\
-     * In the case that the page or container background is the same or darker set this to true
-     * to have the select use a white background.
-     * @default false
-    */
-    useWhiteBackground?: boolean;
-    /**
-     * Error Messages ( Forms only )
-     * @default required: 'armature.select.errors.required'
-     * @example
-     * ```
-     * this.errorMessages = {
-     *   required: 'armature.select.errors.required',
-     *   minSelected: 'armature.select.errors.min-selected'
-     * };
-     *
-     * form = this.fb.group({
-     *   fruits: [[], [Validators.required, minSelectedValidator(2)]]
-     * });
-     *
-     * ...
-     * export function minSelectedValidator(min: number) {
-     *  return (control: AbstractControl): ValidationErrors | null => {
-     *    const value = control.value;
-     *    if (Array.isArray(value) && value.length < min) {
-     *      return { minSelected: { required: min, actual: value.length } };
-     *    }
-     *    return null;
-     *  };
-     *}
-     * ```
-    */
-    errorMessages?: Record<string, string>;
-    /** Selection change output if no form control */
-    selectionChange: EventEmitter<string | string[]>;
-    /** Selection list element ref */
-    listboxRef: ElementRef<HTMLUListElement>;
-    /** Validation errors */
-    private _errors;
-    /** Current validation error */
-    errorMessage: Signal<string>;
-    /** Is expanded ? */
-    expanded: WritableSignal<boolean>;
-    /** Active selection index */
-    activeIndex: number;
-    /** Selected item / item's values */
-    selected: WritableSignal<Array<string> | string | null>;
-    /** Keyboard typeahead buffer */
-    private _typeaheadBuffer;
-    /** Typeahead timeout */
-    private _typeaheadTimeout;
-    /** onChange form control method */
-    private _onChange;
-    /** onTouched form control method */
-    private _onTouched;
-    /** Is the form control have required validator ? */
-    isRequired: WritableSignal<boolean>;
-    /** Destroy ref to unsubscribe */
-    private _destroyRef;
-    /** Options input as Map */
-    private readonly _valueToLabelMap;
-    /**
-     * The selected item label
-     * @note for single select
-    */
-    selectedLabelSingle: Signal<string>;
-    /**
-     * The selected item's [item's label's]
-     * @note for multi select
-    */
-    selectedLabelsMultiple: Signal<Array<string>>;
-    /**
-     * The selected item's [item's label's] visible chips
-     * @note for multi select chip container
-    */
-    visibleChips: WritableSignal<Array<string>>;
-    /** The number of hidden chips */
-    hiddenChipsCount: WritableSignal<number>;
-    /** Multi Selection chip list container element ref */
-    multiChipContainer: ElementRef<HTMLElement>;
-    /** The resize observer */
-    private _resizeObserver;
-    /** Are all items selected ? (multiple select) */
-    isAllSelected: Signal<boolean>;
-    /** Is the option selected ? */
-    isSelected: (optionValue: string) => Signal<boolean>;
-    /** The form control name */
-    controlName: string;
-    /** The derived form control */
-    get derivedFormControl(): FormControl;
-    /**
-     * Constructor.
-     * @param control The ng control
-    */
-    constructor(_ngControl: NgControl, _host: ElementRef, _cdr: ChangeDetectorRef, _zone: NgZone, _translate: TranslateService);
-    /** Component init */
-    ngOnInit(): void;
-    /** After dom renders */
-    ngAfterViewInit(): void;
-    /** Component destroy */
-    ngOnDestroy(): void;
-    /** Toggle the select panel open/close */
-    togglePanel(): void;
-    /** Closes the select panel */
-    closePanel(): void;
-    /**
-     * Option click event
-     * @param option the option or all
-    */
-    onOptionClick(option: SelectOption | 'ALL'): void;
-    /** Update the form or emit the selection change */
-    private _propagateValue;
-    /** Updates the visible chips */
-    updateVisibleChips(): void;
-    /** Remove chip */
-    removeChip(label: string): void;
-    /** Close the panel if clicked outside */
-    onDocumentClick(event: Event): void;
-    /**
-     * Keyboard support
-     * @param event keyboard event
-     * @description
-     * #### When focused on the select trigger
-     * - the enter key or down arrow will open the panel;
-     * #### When the panel is open
-     * - escape key will close the panel;
-     * - up/down arrows cycle through the options;
-     * - enter or space key will select/deselect the option;
-    */
-    handleKeydown(event: KeyboardEvent): void;
-    /**
-     * Typeahead search
-     * @param char
-     * @description Will focus on the option if the key char matches
-    */
-    private _handleTypeahead;
-    /** Scrolls to the active option index */
-    private _scrollIntoView;
-    /**
-     * Triggered when the form control value is set outside the component
-     * @param value
-    */
-    writeValue(value: string | Array<string> | null | undefined): void;
-    /**
-     * Triggered when the form control is changed
-     * @param fn The callback function.
-    */
-    registerOnChange(fn: any): void;
-    /**
-     * Triggered when the form control is touched
-     * @param fn The callback function.
-    */
-    registerOnTouched(fn: any): void;
-    /** Called by the forms API when the control status changes to or from 'DISABLED' */
-    setDisabledState(isDisabled: boolean): void;
-    /** Runs the form control validator */
-    validate(): ValidationErrors | null;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SofSelectComponent, [{ optional: true; host: true; self: true; }, null, null, null, null]>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SofSelectComponent, "sof-select", never, { "id": { "alias": "id"; "required": true; }; "options": { "alias": "options"; "required": true; }; "label": { "alias": "label"; "required": true; }; "helpText": { "alias": "helpText"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "showSelectAll": { "alias": "showSelectAll"; "required": false; }; "isDisabled": { "alias": "isDisabled"; "required": false; }; "width": { "alias": "width"; "required": false; }; "useWhiteBackground": { "alias": "useWhiteBackground"; "required": false; }; "errorMessages": { "alias": "errorMessages"; "required": false; }; }, { "selectionChange": "selectionChange"; }, never, never, true, never>;
-}
-/**
- * Select option interface
- * @property value: string, the value of the option
- * @property label: string, the label for the option
- * @optional isDisabled?: boolean, is the option disabled
-*/
-export interface SelectOption {
-    value: string;
-    label: string;
-    isDisabled?: boolean;
-}

package/lib/forms/directives/alphanumeric/alphanumeric.directive.d.ts

@@ -1,31 +0,0 @@
-import { ElementRef } from '@angular/core';
-import * as i0 from "@angular/core";
-/**
- * The alphanumeric directive
- */
-export declare class AlphaNumericDirective {
-    private el;
-    /** The array of allowed keys */
-    private allowedKeys;
-    /** Whether or not the entered value is a letter */
-    private isLetter;
-    /** Whether or not the entered value is a number */
-    private isNumber;
-    /**
-     * Constructs the directive
-     * @param el The element
-     */
-    constructor(el: ElementRef);
-    /**
-     * Only allows alphanumeric inputs
-     * @param event Key Event
-     */
-    onKeyDown(event: KeyboardEvent): void;
-    /**
-     * Prevent copy pasted inputs
-     * @param event the event
-     */
-    blockPaste(event: KeyboardEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AlphaNumericDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<AlphaNumericDirective, "[alphanumeric]", never, {}, {}, never, never, false, never>;
-}

package/lib/forms/directives/date-input-filter/date-input-filter.directive.d.ts

@@ -1,7 +0,0 @@
-import * as i0 from "@angular/core";
-/** @note this restricts the user input to numbers [0-9] and forward slash (/) */
-export declare class DateInputFilterDirective {
-    onInput(event: any): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DateInputFilterDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<DateInputFilterDirective, "[sofArDateInputFilter]", never, {}, {}, never, never, false, never>;
-}

package/lib/forms/directives/input-trim/input-trim.directive.d.ts

@@ -1,58 +0,0 @@
-import { ElementRef, Renderer2 } from "@angular/core";
-import { ControlValueAccessor } from "@angular/forms";
-import * as i0 from "@angular/core";
-export declare class InputTrimDirective implements ControlValueAccessor {
-    private get _type();
-    trim: string;
-    /**
-     * Keep the value of input element in a cache.
-     * @type {string}
-     * @private
-     */
-    private _value;
-    private _sourceRenderer;
-    private _sourceElementRef;
-    /**
-     * Updates the value on the blur event.
-     */
-    onBlur(event: string, value: string): void;
-    /**
-     * Updates the value on the input event.
-     */
-    onInput(event: string, value: string): void;
-    onChange: (_: any) => void;
-    onTouched: () => void;
-    /**
-     * Constructs the directive
-     * @param renderer The renderer
-     * @param ElementRef The elementRef
-     * @param compositionMode The composition mode
-     */
-    constructor(renderer: Renderer2, elementRef: ElementRef, compositionMode: boolean);
-    registerOnChange(fn: (_: any) => void): void;
-    registerOnTouched(fn: () => void): void;
-    /**
-     * Writes a new value to the element based on the type of input element.
-     * @param value new value
-     */
-    writeValue(value: any): void;
-    /**
-     * Sets state disabled.
-     * @param isDisabled boolean value for state
-     */
-    setDisabledState(isDisabled: boolean): void;
-    /**
-     * Writes the cursor position
-     * @param cursorPosition the cursor current position
-     * @param hasTypedSymbol
-     */
-    private setCursorPointer;
-    /**
-     * Trims an input value, and sets it to the model and element.
-     * @param value input value
-     * @param event input event
-     */
-    private updateValue;
-    static ɵfac: i0.ɵɵFactoryDeclaration<InputTrimDirective, [null, null, { optional: true; }]>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<InputTrimDirective, "input[trim], textarea[trim]", never, { "trim": { "alias": "trim"; "required": false; }; }, {}, never, never, false, never>;
-}

package/lib/forms/directives/letters-characters/letters-characters.directive.d.ts

@@ -1,27 +0,0 @@
-import { ElementRef } from '@angular/core';
-import * as i0 from "@angular/core";
-/**
- * The letters and special characters directive
- */
-export declare class LettersCharactersDirective {
-    private el;
-    /** True if letters and special characters allowed */
-    sofArLettersAndSpecialCharacters: boolean;
-    /**
-     * Constructs the directive
-     * @param el The element
-     */
-    constructor(el: ElementRef);
-    /**
-     * Only allows letter and special character inputs
-     * @param event Key Event
-     */
-    onKeyDown(event: any): void;
-    /**
-     * Allow user to copy and paste letters except special characters
-     * @param event the event
-     */
-    allowPaste(event: ClipboardEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LettersCharactersDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<LettersCharactersDirective, "[sofArLettersAndSpecialCharacters]", never, { "sofArLettersAndSpecialCharacters": { "alias": "sofArLettersAndSpecialCharacters"; "required": false; }; }, {}, never, never, false, never>;
-}

package/lib/forms/directives/letters-only/letters-only.directive.d.ts

@@ -1,27 +0,0 @@
-import { ElementRef } from '@angular/core';
-import * as i0 from "@angular/core";
-/**
- * The letters only directive
- */
-export declare class LettersOnlyDirective {
-    private el;
-    /** True if only letters allowed */
-    sofArLettersOnly: boolean;
-    /**
-     * Constructs the directive
-     * @param el The element
-     */
-    constructor(el: ElementRef);
-    /**
-     * Only allows letter inputs
-     * @param event Key Event
-     */
-    onKeyDown(event: any): void;
-    /**
-     * Allow user to copy and paste letters except special characters
-     * @param event the event
-     */
-    allowPaste(event: ClipboardEvent): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LettersOnlyDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<LettersOnlyDirective, "[sofArLettersOnly]", never, { "sofArLettersOnly": { "alias": "sofArLettersOnly"; "required": false; }; }, {}, never, never, false, never>;
-}

package/lib/forms/directives/numbers-only/numbers-only.directive.d.ts

@@ -1,22 +0,0 @@
-import { ElementRef } from '@angular/core';
-import * as i0 from "@angular/core";
-/**
- * Numbers only directive
- */
-export declare class NumbersOnlyDirective {
-    private el;
-    /** True if only numbers allowed */
-    sofArNumbersOnly: boolean;
-    /**
-     * Constructs the directive
-     * @param el The element
-     */
-    constructor(el: ElementRef);
-    /**
-     * Only allows number inputs
-     * @param event Key Event
-     */
-    onKeyDown(event: any): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NumbersOnlyDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NumbersOnlyDirective, "[sofArNumbersOnly]", never, { "sofArNumbersOnly": { "alias": "sofArNumbersOnly"; "required": false; }; }, {}, never, never, false, never>;
-}

package/lib/forms/forms-api.d.ts

@@ -1,16 +0,0 @@
-/** Public API surface for the forms */
-export * from './forms.module';
-export * from './models/address';
-export * from './models/county';
-export * from './models/enums/states';
-export * from './models/constants';
-export * from './directives/letters-characters/letters-characters.directive';
-export * from './directives/letters-only/letters-only.directive';
-export * from './directives/numbers-only/numbers-only.directive';
-export * from './directives/alphanumeric/alphanumeric.directive';
-export * from './directives/input-trim/input-trim.directive';
-export * from './directives/date-input-filter/date-input-filter.directive';
-export * from './components/sof-address/sof-address.component';
-export * from './components/sof-select/sof-select.component';
-export * from './services/alert.service';
-export * from './pipes/phone-format.pipe';

package/lib/forms/forms.module.d.ts

@@ -1,22 +0,0 @@
-import * as i0 from "@angular/core";
-import * as i1 from "./components/sof-address/sof-address.component";
-import * as i2 from "./directives/letters-characters/letters-characters.directive";
-import * as i3 from "./directives/letters-only/letters-only.directive";
-import * as i4 from "./directives/numbers-only/numbers-only.directive";
-import * as i5 from "./directives/alphanumeric/alphanumeric.directive";
-import * as i6 from "./directives/input-trim/input-trim.directive";
-import * as i7 from "./directives/date-input-filter/date-input-filter.directive";
-import * as i8 from "./pipes/phone-format.pipe";
-import * as i9 from "@angular/common";
-import * as i10 from "@ngbracket/ngx-layout";
-import * as i11 from "@angular/forms";
-import * as i12 from "@angular/material/input";
-import * as i13 from "@angular/material/form-field";
-import * as i14 from "@angular/material/select";
-import * as i15 from "@angular/material/snack-bar";
-/** Armature forms module */
-export declare class FormsModule {
-    static ɵfac: i0.ɵɵFactoryDeclaration<FormsModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<FormsModule, [typeof i1.SofAddressComponent, typeof i2.LettersCharactersDirective, typeof i3.LettersOnlyDirective, typeof i4.NumbersOnlyDirective, typeof i5.AlphaNumericDirective, typeof i6.InputTrimDirective, typeof i7.DateInputFilterDirective, typeof i8.PhoneFormatPipe], [typeof i9.CommonModule, typeof i10.FlexLayoutModule, typeof i11.ReactiveFormsModule, typeof i12.MatInputModule, typeof i13.MatFormFieldModule, typeof i14.MatSelectModule, typeof i15.MatSnackBarModule], [typeof i1.SofAddressComponent, typeof i2.LettersCharactersDirective, typeof i3.LettersOnlyDirective, typeof i4.NumbersOnlyDirective, typeof i5.AlphaNumericDirective, typeof i6.InputTrimDirective, typeof i7.DateInputFilterDirective, typeof i8.PhoneFormatPipe]>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<FormsModule>;
-}

package/lib/forms/models/address.d.ts

@@ -1,14 +0,0 @@
-import { County } from './county';
-/**
- * Address model
- */
-export interface Address {
-    /** Street 1 */
-    street1?: string;
-    /** Street 2 */
-    street2?: string;
-    /** The city */
-    city?: string;
-    /** County */
-    county?: County;
-}

package/lib/forms/models/constants.d.ts

@@ -1,9 +0,0 @@
-/** The validation key constants */
-export declare class ValidationKeys {
-    static required: string;
-    static minLength: string;
-    static maxLength: string;
-    static pattern: string;
-    static maskError: string;
-    static email: string;
-}

package/lib/forms/models/county.d.ts

@@ -1,13 +0,0 @@
-/**
- * County model
- */
-export interface County {
-    /** ZIP Code */
-    zipCode?: string;
-    /** FIPS Code */
-    fipsCode?: string;
-    /** State county is located in */
-    state?: string;
-    /** Name of the county */
-    name?: string;
-}

package/lib/forms/models/enums/states.d.ts

@@ -1,64 +0,0 @@
-/**
- * The States enum
- */
-export declare enum States {
-    AL = "Alabama",
-    AK = "Alaska",
-    AS = "American Samoa",
-    AZ = "Arizona",
-    AR = "Arkansas",
-    CA = "California",
-    CO = "Colorado",
-    CT = "Connecticut",
-    DE = "Delaware",
-    DC = "District of Columbia",
-    FL = "Florida",
-    FM = "Micronesia",
-    GA = "Georgia",
-    GU = "Guam",
-    HI = "Hawaii",
-    ID = "Idaho",
-    IL = "Illinois",
-    IN = "Indiana",
-    IA = "Iowa",
-    KS = "Kansas",
-    KY = "Kentucky",
-    LA = "Louisiana",
-    ME = "Maine",
-    MD = "Maryland",
-    MA = "Massachusetts",
-    MH = "Marshall Islands",
-    MI = "Michigan",
-    MN = "Minnesota",
-    MP = "Northern Mariana Islands",
-    MS = "Mississippi",
-    MO = "Missouri",
-    MT = "Montana",
-    NE = "Nebraska",
-    NV = "Nevada",
-    NH = "New Hampshire",
-    NJ = "New Jersey",
-    NM = "New Mexico",
-    NY = "New York",
-    NC = "North Carolina",
-    ND = "North Dakota",
-    OH = "Ohio",
-    OK = "Oklahoma",
-    OR = "Oregon",
-    PA = "Pennsylvania",
-    PR = "Puerto Rico",
-    PW = "Palau",
-    RI = "Rhode Island",
-    SC = "South Carolina",
-    SD = "South Dakota",
-    TN = "Tennessee",
-    TX = "Texas",
-    UT = "Utah",
-    VT = "Vermont",
-    VA = "Virginia",
-    VI = "Virgin Islands",
-    WA = "Washington",
-    WV = "West Virginia",
-    WI = "Wisconsin",
-    WY = "Wyoming"
-}

package/lib/forms/pipes/phone-format.pipe.d.ts

@@ -1,10 +0,0 @@
-import { PipeTransform } from '@angular/core';
-import * as i0 from "@angular/core";
-/**
- * A pipe that takes a simple string phone number and formats it
- */
-export declare class PhoneFormatPipe implements PipeTransform {
-    transform(phoneNumber: string): string;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PhoneFormatPipe, never>;
-    static ɵpipe: i0.ɵɵPipeDeclaration<PhoneFormatPipe, "sofArPhone", false>;
-}

package/lib/forms/services/alert.service.d.ts

@@ -1,60 +0,0 @@
-import { ElementRef } from '@angular/core';
-import { AbstractControl, FormGroup } from '@angular/forms';
-import { MatSnackBar } from '@angular/material/snack-bar';
-import { TranslateService } from '@ngx-translate/core';
-import * as i0 from "@angular/core";
-/**
- * Service to handle error alerts
- */
-export declare class AlertService {
-    snackBar: MatSnackBar;
-    private translateService;
-    /** the translation ket for close text */
-    readonly closeTextKey: string;
-    /**
-     * The constructor
-     * @param snackBar the angular material snackbar
-     * @param translateService the translate service
-     */
-    constructor(snackBar: MatSnackBar, translateService: TranslateService);
-    /**
-     * Opens a generic snack bar alert
-     * @param detailsTextKey text to show in the alert
-     * @param durationLength how long the alert should be shown before it fades
-     */
-    openCustomSnackBarAlert(detailsTextKey: string, params?: any, durationLength?: number): void;
-    /**
-     * Opens an alert with a the specific form validation error
-     * @param form the form to validate
-     * @param el the element reference from the forms page, used to set focus on invalid form
-     * @param durationLength how long the alert should be shown before it fades
-     */
-    openFormInvalidSnackBarAlert(form: FormGroup, el: ElementRef, durationLength?: number): void;
-    /**
-     * Iterates through a form (form group/form array) recursively to get the individual form control that is invalid
-     * @param form the form to validate
-     * @param el the element reference from the forms page, used to set focus on invalid form
-     * @param durationLength how long the alert should be shown before it fades
-     */
-    getWhatIsNotFilledOut(form: FormGroup, el: ElementRef, durationLength: number): string;
-    /**
-     * Gets the error message based on the form control that is invalid
-     * @param control the invalid form control
-     * @param field the field name that is invalid
-     * @param el the element reference from the forms page, used to set focus on invalid form
-     * @param durationLength how long the alert should be shown before it fades
-     */
-    getErrorMessage(control: AbstractControl, field: string, el: ElementRef, durationLength: number): string;
-    /**
-     * Formats the form control name to readable text to display to the user in an error alert
-     * @param field The field
-     */
-    getFieldFormattedText(field: string): string;
-    /**
-     * Sets focus to the first invalid form control element
-     * @param el Element to focus on
-     */
-    setFocusToFormControl(el: ElementRef): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AlertService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AlertService>;
-}