@elderbyte/ngx-starter 14.12.0-beta6 → 14.12.0

package/lib/common/forms/form-field-base.component.d.ts

@@ -0,0 +1,74 @@
+import { AbstractControl, ValidationErrors, Validator } from '@angular/forms';
+import { ValueAccessorBase } from './value-accessor-base';
+import { ThemePalette } from '@angular/material/core';
+import { FloatLabelType, MatFormFieldAppearance } from '@angular/material/form-field';
+import * as i0 from "@angular/core";
+export declare abstract class FormFieldBaseComponent<T> extends ValueAccessorBase<T> implements Validator {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Control name.
+     */
+    name: string;
+    label: string;
+    appearance: MatFormFieldAppearance;
+    /**
+     * Whether the label should always float ('always'), never float ('never')
+     * or float as the user types ('auto'). Defaults to 'auto'.
+     */
+    floatLabel: FloatLabelType;
+    color: ThemePalette;
+    placeholder: string;
+    hint: string;
+    private _showHint;
+    /**
+     * Icon displayed as form field prefix.
+     */
+    icon: string;
+    showIcon: boolean;
+    private _readonly;
+    private _disabled;
+    private _required;
+    /**
+     * Minimum number allowed.
+     */
+    min: string | number;
+    /**
+     * Maximum number allowed.
+     */
+    max: string | number;
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get isLocked(): boolean;
+    get showHint(): boolean;
+    set showHint(value: boolean);
+    get required(): boolean;
+    set required(value: boolean);
+    get disabled(): boolean;
+    set disabled(value: boolean);
+    get readonly(): boolean;
+    /**
+     * If true, control will not show selection dialog.
+     */
+    set readonly(value: boolean);
+    /***************************************************************************
+     *                                                                         *
+     * ControlValueAccessor API                                                *
+     *                                                                         *
+     **************************************************************************/
+    protected writeToControl(value: T): void;
+    /***************************************************************************
+     *                                                                         *
+     * Validator API                                                           *
+     *                                                                         *
+     **************************************************************************/
+    validate(c: AbstractControl): ValidationErrors | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FormFieldBaseComponent<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<FormFieldBaseComponent<any>, never, never, { "name": "name"; "label": "label"; "appearance": "appearance"; "floatLabel": "floatLabel"; "color": "color"; "placeholder": "placeholder"; "hint": "hint"; "icon": "icon"; "showIcon": "showIcon"; "min": "min"; "max": "max"; "showHint": "showHint"; "required": "required"; "disabled": "disabled"; "readonly": "readonly"; }, {}, never, never, false>;
+}

package/lib/common/forms/multi-model-base.component.d.ts

@@ -0,0 +1,23 @@
+import { QueryList } from '@angular/core';
+import { FormFieldBaseComponent } from './form-field-base.component';
+import { AbstractControl, NgModel, ValidationErrors } from '@angular/forms';
+import * as i0 from "@angular/core";
+/**
+ * Base Component which uses 0..n ngModels for validation.
+ */
+export declare abstract class MultiModelBaseComponent<T> extends FormFieldBaseComponent<T> {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    models: QueryList<NgModel>;
+    /***************************************************************************
+     *                                                                         *
+     * Validator API                                                           *
+     *                                                                         *
+     **************************************************************************/
+    validate(c: AbstractControl): ValidationErrors | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MultiModelBaseComponent<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<MultiModelBaseComponent<any>, never, never, {}, {}, never, never, false>;
+}

package/lib/common/forms/public_api.d.ts

@@ -0,0 +1,11 @@
+export * from './view-providers';
+export * from './elder-entity-value-accessor';
+export * from './elder-multi-entity-value-accessor';
+export * from './template-composite-control';
+export * from './value-accessor-base';
+export * from './form-field-base.component';
+export * from './elder-form-field-control-base.directive';
+export * from './multi-model-base.component';
+export * from './elder-from-field-base';
+export * from './elder-from-field-entity-base';
+export * from './elder-from-field-multi-entity-base';

package/lib/common/forms/template-composite-control.d.ts

@@ -0,0 +1,64 @@
+import { ValueAccessorBase } from './value-accessor-base';
+import { AbstractControl, UntypedFormGroup, NgForm, ValidationErrors, Validator } from '@angular/forms';
+import { OnDestroy, Provider } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare function buildFormIntegrationProviders(component: any): Provider[];
+/**
+ * Provides the ability to expose a (sub) form as a control with validation support.
+ * What this means is that a sub form consisting of multiple controls can be nested in a parent form
+ * and propagate its validation state up to it.
+ *
+ * How to use:
+ *
+ * 1. The sub form must extend from this class.
+ * 2. The sub form must be wrapped in a html form and expose the #form variable: <form #form="ngForm" >
+ * 3. Must register the NG_VALUE_ACCESSOR +  NG_VALIDATORS providers. (use buildFormIntegrationProviders(MyComponent)
+ *
+ * @deprecated Deprecated in favor of: viewProviders: [ViewProviders.ParentControlContainer]
+ */
+export declare abstract class TemplateCompositeControl<T> extends ValueAccessorBase<T> implements Validator, OnDestroy {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private _sub;
+    private _group;
+    private _disabled;
+    private _validatorChanged;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    ngOnDestroy(): void;
+    /***************************************************************************
+     *                                                                         *
+     * ControlValueAccessor implementation                                     *
+     *                                                                         *
+     **************************************************************************/
+    validate(c: AbstractControl): ValidationErrors | any;
+    registerOnValidatorChange(fn: () => void): void;
+    /***************************************************************************
+     *                                                                         *
+     * Disabled support                                                        *
+     *                                                                         *
+     **************************************************************************/
+    set disabled(isDisabled: boolean);
+    get disabled(): boolean;
+    setDisabledState(isDisabled: boolean): void;
+    /***************************************************************************
+     *                                                                         *
+     * API for subclasses                                                      *
+     *                                                                         *
+     **************************************************************************/
+    set ngForm(form: NgForm);
+    protected set group(group: UntypedFormGroup);
+    protected get group(): UntypedFormGroup;
+    protected onValueChanged(value: T): void;
+    protected emitValidatorChange(): void;
+    protected writeToControl(value: T): void;
+    private unsubscribeAll;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TemplateCompositeControl<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<TemplateCompositeControl<any>, never, never, { "disabled": "disabled"; }, {}, never, never, false>;
+}

package/lib/common/forms/value-accessor-base.d.ts

@@ -0,0 +1,98 @@
+import { ControlValueAccessor } from '@angular/forms';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Manages the control value event handlers
+ */
+export declare abstract class ValueAccessorBase<T> implements ControlValueAccessor {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly _value$;
+    private _changed;
+    private _touched;
+    private readonly _valueUpdateSub;
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Emits the updated value.
+     * In contrast to the valueChange, this event is only
+     * fired when a control explicitly writes a value to the model.
+     */
+    get valueUpdated(): Observable<T>;
+    /**
+     * Get a value change event every time the value is changed,
+     * except the initial value which is skipped.
+     */
+    get valueChange(): Observable<T>;
+    /**
+     * Gets the current value as observable stream.
+     */
+    get value$(): Observable<T>;
+    /**
+     * Get the current value snapshot bound to this control
+     */
+    get value(): T;
+    /**
+     * Set the current value bound to this control
+     * @param value
+     */
+    set value(value: T);
+    /***************************************************************************
+     *                                                                         *
+     * Public Api                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Update the model value.
+     * Sub Classes (Custom Controls) should use this method to change the value.
+     *
+     * @param value
+     */
+    updateValue(value: T): void;
+    /***************************************************************************
+     *                                                                         *
+     * ControlValueAccessor implementation                                     *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * @description
+     * Writes a new value to the element.
+     *
+     * This method is called by the forms API to write to the view when programmatic
+     * changes from model to view are requested.
+     *
+     * @param value The new value for the element
+     * @param ignoreDuplicate Duplicate values are not emitted if true (default)
+     */
+    writeValue(value: T): void;
+    registerOnChange(fn: (value: T) => void): void;
+    registerOnTouched(fn: () => void): void;
+    /***************************************************************************
+     *                                                                         *
+     * API for subclasses                                                      *
+     *                                                                         *
+     **************************************************************************/
+    protected writeValueInternal(value: T): void;
+    /**
+     * Checks if two values are equal to reduce change events in case nothing has changed.
+     * Subclasses should overwrite this method, when the value is not a primitive object and reference equality is not suitable.
+     *
+     * The default implementation checks only reference equality for objects.
+     *
+     * @param a
+     * @param b
+     */
+    protected valuesEquals(a: T, b: T): boolean;
+    protected onValueChanged(value: T): void;
+    protected emitOnTouch(): void;
+    protected emitOnChanged(value: T): void;
+    protected abstract writeToControl(value: T): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ValueAccessorBase<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ValueAccessorBase<any>, never, never, { "value": "value"; }, { "valueUpdated": "valueUpdated"; "valueChange": "valueChange"; }, never, never, false>;
+}

package/lib/common/forms/view-providers.d.ts

@@ -0,0 +1,23 @@
+import { Provider } from '@angular/core';
+import { ControlContainer } from '@angular/forms';
+export declare function proxyControlContainer(container: ControlContainer): ControlContainer;
+/**
+ * Allows to register templated forms (ngModels) with a parent form / control container.
+ * @example
+ * ```ts
+ *   @Component({
+ *    providers: buildFormIntegrationProviders(ElderIntervalInputComponent),
+ *    viewProviders: [ViewProviders.ParentControlContainer]
+ *   })
+ * ```
+ *
+ */
+export declare class ViewProviders {
+    /**
+     * This view provider plugs the parent ControlContainer (usually an FormControl)
+     * into this components context.
+     *
+     * All ngModels will register with the parent ControlContainer if available.
+     */
+    static readonly ParentControlContainer: Provider;
+}

package/lib/common/http/http-client-builder.service.d.ts

@@ -0,0 +1,6 @@
+import * as i0 from "@angular/core";
+export declare class HttpClientBuilder {
+    constructor();
+    static ɵfac: i0.ɵɵFactoryDeclaration<HttpClientBuilder, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<HttpClientBuilder>;
+}

package/lib/common/http/http-client-pristine.d.ts

@@ -0,0 +1,10 @@
+import { HttpBackend, HttpClient } from '@angular/common/http';
+import * as i0 from "@angular/core";
+/**
+ * A HttpClient without any interceptors
+ */
+export declare class HttpClientPristine extends HttpClient {
+    constructor(backend: HttpBackend);
+    static ɵfac: i0.ɵɵFactoryDeclaration<HttpClientPristine, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<HttpClientPristine>;
+}

package/lib/common/http/public_api.d.ts

@@ -0,0 +1,4 @@
+export * from './transfer/public_api';
+export * from './upload/file-upload-client';
+export * from './http-client-pristine';
+export * from './http-client-builder.service';

package/lib/common/http/transfer/data-transfer-factory.d.ts

@@ -0,0 +1,70 @@
+import { HttpDataTransfer } from './http-data-transfer';
+import { HttpClient, HttpHeaders, HttpParams, HttpRequest } from '@angular/common/http';
+import * as i0 from "@angular/core";
+/**
+ * Responsible for building HttpDataTransfer jobs.
+ */
+export declare class DataTransferFactory {
+    private http;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(http: HttpClient);
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Creates a new progress tracking upload job from the given File.
+     *
+     * @param requestMethod  The HTTP method (usually POST or PUT)
+     * @param endpointUrl The url to send the request to
+     * @param file The file to construct the Form Data form
+     * @param options (Optional) Additional headers or query params
+     */
+    buildFileUpload(requestMethod: 'POST' | 'PUT' | 'PATCH', endpointUrl: string, file: File, options?: {
+        headers?: HttpHeaders;
+        params?: HttpParams;
+    }): HttpDataTransfer;
+    /**
+     * Creates a new progress tracking upload job from the given File.
+     *
+     * @param requestMethod  The HTTP method (usually POST or PUT)
+     * @param endpointUrl The url to send the request to
+     * @param formFile The file to construct the Form Data form
+     * @param formName The file name of the Form Data
+     * @param options (Optional) Additional headers or query params
+     */
+    buildFileFormDataUpload(requestMethod: 'POST' | 'PUT' | 'PATCH', endpointUrl: string, formFile: File, formName?: string, options?: {
+        headers?: HttpHeaders;
+        params?: HttpParams;
+    }): HttpDataTransfer;
+    /**
+     * Creates a new progress tracking upload job from the given Form Data.
+     *
+     * @param requestMethod The HTTP method (usually POST or PUT)
+     * @param endpointUrl The url to send the request to
+     * @param formData The Form Data
+     * @param options (Optional) Additional headers or query params
+     * @param name
+     * @param size
+     */
+    buildFormDataUpload(requestMethod: 'POST' | 'PUT' | 'PATCH', endpointUrl: string, formData: FormData, options?: {
+        headers?: HttpHeaders;
+        params?: HttpParams;
+    }, name?: string, size?: number): HttpDataTransfer;
+    /**
+     * Creates a new progress tracking upload job from a low level
+     * http request.
+     *
+     * @param request The upload http request
+     * @param name The data transfer name
+     * @param size The data transfer  size
+     */
+    buildOfRequest(request: HttpRequest<{}>, name: string, size: number): HttpDataTransfer;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DataTransferFactory, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<DataTransferFactory>;
+}

package/lib/common/http/transfer/data-transfer-progress-aggregate.d.ts

@@ -0,0 +1,27 @@
+import { DataTransferState } from './data-transfer-state';
+export declare class DataTransferProgressAggregate {
+    readonly doneBytesAgg: number;
+    readonly bytesPerSecAgg: number;
+    readonly totalBytesAgg: number;
+    readonly inTransfer: number;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    static Empty: DataTransferProgressAggregate;
+    readonly percentDone: number;
+    readonly bps: string;
+    /***************************************************************************
+     *                                                                         *
+     * Static builder                                                          *
+     *                                                                         *
+     **************************************************************************/
+    static aggregate(states: DataTransferState[]): DataTransferProgressAggregate;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(doneBytesAgg: number, bytesPerSecAgg: number, totalBytesAgg: number, inTransfer: number);
+}

package/lib/common/http/transfer/data-transfer-progress.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Represents the current transfer progress
+ * Immutable.
+ */
+export declare class DataTransferProgress {
+    readonly doneBytes: number;
+    readonly bytesPerSec: number;
+    readonly avgBytesPerSec: number;
+    readonly totalBytes?: number;
+    readonly percentDone?: number;
+    static none(totalBytes?: number): DataTransferProgress;
+    constructor(doneBytes: number, bytesPerSec: number, avgBytesPerSec: number, totalBytes?: number, percentDone?: number);
+}

package/lib/common/http/transfer/data-transfer-state.d.ts

@@ -0,0 +1,52 @@
+import { DataTransferStatus } from './data-transfer-status';
+import { DataTransferProgress } from './data-transfer-progress';
+import { HttpErrorResponse } from '@angular/common/http';
+/**
+ * Represents a snapshot of the current state.
+ * Immutable.
+ */
+export declare class DataTransferState {
+    /**
+     * status The current status
+     */
+    readonly status: DataTransferStatus;
+    /**
+     * progress The current progress
+     */
+    readonly progress: DataTransferProgress;
+    /**
+     * error The error response if there was one
+     */
+    readonly error: HttpErrorResponse | null;
+    /***************************************************************************
+     *                                                                         *
+     * Static Builder                                                          *
+     *                                                                         *
+     **************************************************************************/
+    static pending(totalBytes?: number): DataTransferState;
+    static started(totalBytes?: number): DataTransferState;
+    static transferring(progress: DataTransferProgress): DataTransferState;
+    static completed(progress: DataTransferProgress): DataTransferState;
+    static failed(err: HttpErrorResponse, progress?: DataTransferProgress): DataTransferState;
+    static aborted(progress?: DataTransferProgress): DataTransferState;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    private constructor();
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get isPending(): boolean;
+    get isTransferring(): boolean;
+    get hasFailed(): boolean;
+    get isAborted(): boolean;
+    get isCompleted(): boolean;
+    /**
+     * Checks if the data transfer is over, either sucessfully or error / abort.
+     */
+    get isDone(): boolean;
+}

package/lib/common/http/transfer/data-transfer-status.d.ts

@@ -0,0 +1,22 @@
+export declare enum DataTransferStatus {
+    /**
+     * This data transfer is prepared but has not yet started.
+     */
+    Pending = "Pending",
+    /**
+     * This data transfer is currently in progress
+     */
+    Transferring = "Transferring",
+    /**
+     * This data transfer is completed
+     */
+    Completed = "Completed",
+    /**
+     * This data transfer failed.
+     */
+    Failed = "Failed",
+    /**
+     * This data transfer was aborted.
+     */
+    Aborted = "Aborted"
+}

package/lib/common/http/transfer/http-data-transfer.d.ts

@@ -0,0 +1,96 @@
+import { Observable } from 'rxjs';
+import { HttpEvent } from '@angular/common/http';
+import { DataTransferState } from './data-transfer-state';
+/**
+ * Represents a Http data transfer, either a download or upload.
+ */
+export declare class HttpDataTransfer {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private logger;
+    private readonly _state;
+    private readonly _httpRequest;
+    private readonly abort$;
+    private readonly _name;
+    private _startTimeMs;
+    private _endTimeMs;
+    private _currTimeMs;
+    private _prevTimeMs;
+    private _oldBytes;
+    /***************************************************************************
+     *                                                                         *
+     * Static Builder                                                          *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Creates a new HttpDataTransfer from a HttpClient HttpRequest.
+     * @param httpRequest
+     * @param name Name of this transfer
+     * @param totalBytes The total expected bytes
+     */
+    static fromRequest(httpRequest: Observable<HttpEvent<any>>, name?: string, totalBytes?: number): HttpDataTransfer;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Creates a new HttpDataTransfer
+     * @param httpRequest The http request.
+     * @param name The name of this transfer (usually the file name)
+     * @param totalBytes The total bytes of the transfer. (If not set, will be auto discovered if possible)
+     */
+    private constructor();
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Starts the data transfer
+     */
+    start(): Observable<HttpEvent<any>>;
+    /**
+     * Aborts the data transfer
+     */
+    abort(): void;
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Awaits until this transfer is done and closes the observable.
+     *
+     * If successful, emits true. Observable is closed.
+     * If aborted, emits false. Observable is closed.
+     * If failed, throws error. Observable is closed.
+     */
+    get done$(): Observable<boolean>;
+    /**
+     * Get the state of this data transfer over time.
+     * Unsubscribe after use.
+     */
+    get state$(): Observable<DataTransferState>;
+    /**
+     * Get a snapshot of the current state of this data transfer
+     */
+    get stateSnapshot(): DataTransferState;
+    get name(): string;
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private onStart;
+    private onProgress;
+    private onComplete;
+    private onError;
+    private finally;
+    private emitState;
+    private transferProgressFromResponse;
+    private transferProgress;
+}

package/lib/common/http/transfer/public_api.d.ts

@@ -0,0 +1,6 @@
+export * from './data-transfer-status';
+export * from './data-transfer-state';
+export * from './data-transfer-progress';
+export * from './data-transfer-progress-aggregate';
+export * from './data-transfer-factory';
+export * from './http-data-transfer';

package/lib/common/http/upload/file-upload-client.d.ts

@@ -0,0 +1,38 @@
+import { HttpClient } from '@angular/common/http';
+import { HttpDataTransfer } from '../transfer/http-data-transfer';
+import { ElderDataTransferService } from '../../../components/data-transfer/elder-data-transfer.service';
+export interface IFileUploadClient {
+    uploadFiles(files: Set<File>): Map<File, HttpDataTransfer>;
+    uploadFile(file: File): HttpDataTransfer;
+}
+export declare class FileUploadClient implements IFileUploadClient {
+    private http;
+    private transferManager;
+    protected readonly endpointUrl: string;
+    private requestMethod;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly dataTransferFactory;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(http: HttpClient, transferManager: ElderDataTransferService, endpointUrl: string, requestMethod: 'POST' | 'PUT' | 'PATCH');
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    uploadFiles(files: Set<File>): Map<File, HttpDataTransfer>;
+    uploadFile(file: File): HttpDataTransfer;
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private createUploadTransfer;
+}