@elderbyte/ngx-starter 14.12.0-beta6 → 14.12.0

package/lib/common/data/http-params-builder.d.ts

@@ -0,0 +1,45 @@
+import { HttpParams } from '@angular/common/http';
+import { Filter } from './filters/filter';
+import { Sort } from './sort';
+import { Pageable } from './page';
+import { TokenChunkRequest } from './token-chunk-request';
+export declare class HttpParamsBuilder {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private params;
+    /***************************************************************************
+     *                                                                         *
+     * Static Builder                                                          *
+     *                                                                         *
+     **************************************************************************/
+    static start(params?: HttpParams): HttpParamsBuilder;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(params?: HttpParams);
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    appendFilters(filters?: Filter[]): this;
+    appendFilter(...filters: Filter[]): this;
+    appendSorts(sorts?: Sort[]): this;
+    appendSort(...sorts: Sort[]): this;
+    appendPageable(pageable?: Pageable): this;
+    appendContinuationRequest(tokenChunkRequest?: TokenChunkRequest): this;
+    /**
+     * Turns an object into query-params.
+     *
+     * @param obj The object of which all properties should be applied to this param builder
+     */
+    appendObject(obj: any): this;
+    append(key: string, value: string): this;
+    set(key: string, value: string): this;
+    build(): HttpParams;
+}

package/lib/common/data/page.d.ts

@@ -0,0 +1,41 @@
+import { Sort } from './sort';
+export declare class Page<T> {
+    content: T[];
+    totalElements: number;
+    totalPages: number;
+    last: boolean;
+    size: number;
+    number: number;
+    sort: any;
+    first: boolean;
+    numberOfElements: number;
+    static hasNext(page: Page<any>): boolean;
+    static nextPageable(page: Page<any>, sorts?: Sort[]): Pageable;
+    static fromPage<TS>(data: TS[], total: number, pageable: Pageable): Page<TS>;
+    static from<TS>(data: TS[]): Page<TS>;
+}
+export declare class PageRequest {
+    /**
+     * index Page number (zero based index)
+     */
+    readonly index: number;
+    /**
+     * size The page size
+     */
+    readonly size: number;
+    constructor(
+    /**
+     * index Page number (zero based index)
+     */
+    index: number, 
+    /**
+     * size The page size
+     */
+    size: number);
+}
+export declare class Pageable {
+    readonly page: number;
+    readonly size: number;
+    readonly sorts: Sort[];
+    constructor(page: number, size: number, sorts?: Sort[]);
+}

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

@@ -0,0 +1,11 @@
+export * from './filters/filter';
+export * from './filters/filter-context';
+export * from './sort';
+export * from './page';
+export * from './entity-set-patch';
+export * from './http-params-builder';
+export * from './field-comparator';
+export * from './continuable-listing';
+export * from './token-chunk-request';
+export * from './data-context/public_api';
+export * from './datasource/public_api';

package/lib/common/data/required-filter-evaluator.d.ts

@@ -0,0 +1,46 @@
+import { Filter } from './filters/filter';
+import { Observable } from 'rxjs';
+import { FilterContext } from './filters/filter-context';
+export declare class RequiredFilterContextChangedEvent {
+    readonly requiredFilters: Array<string[]>;
+    readonly currentFilters: Filter[];
+    readonly isValid: boolean;
+    constructor(requiredFilters: Array<string[]>, currentFilters: Filter[], isValid: boolean);
+}
+export declare class RequiredFilterEvaluator {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly _filterContext;
+    private readonly _requiredFilters;
+    readonly context$: Observable<RequiredFilterContextChangedEvent>;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    constructor(filterContext: FilterContext, requiredFilters?: Array<string[]>);
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get filterContext(): FilterContext;
+    get requiredFilters$(): Observable<Array<string[]>>;
+    get requiredFilters(): Array<string[]>;
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private createEvent;
+    private allRequiredFiltersPresent;
+    private hasAllFilters;
+}

package/lib/common/data/sort-context.d.ts

@@ -0,0 +1,42 @@
+import { Observable } from 'rxjs';
+import { Sort, SortDirection } from './sort';
+export declare class SortContext {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly _sorts;
+    /***************************************************************************
+     *                                                                         *
+     * Read API                                                                *
+     *                                                                         *
+     **************************************************************************/
+    get sorts(): Observable<Sort[]>;
+    get sortsSnapshot(): Sort[];
+    findSortDirection(prop: string): SortDirection | undefined;
+    findSort(prop: string): Sort | undefined;
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * This method updatees / adds the given sort, leaving
+     * existing ones untouched.
+     * @param updatedSort
+     */
+    updateSort(updatedSort?: Sort): void;
+    /**
+     * This method updates / adds the given filters, leaving
+     * existing ones untouched.
+     * @param updatedSorts
+     */
+    updateSorts(updatedSorts?: Sort[]): void;
+    /**
+     * Replace all existing filters with the given new ones.
+     * @param newSorts
+     */
+    replaceSorts(newSorts?: Sort[]): void;
+    clear(): void;
+}

package/lib/common/data/sort.d.ts

@@ -0,0 +1,8 @@
+export declare type SortDirection = 'asc' | 'desc' | '';
+export declare class Sort {
+    readonly prop: string | undefined;
+    readonly dir: SortDirection;
+    static NONE: Sort;
+    constructor(prop: string | undefined, dir: SortDirection);
+    equals(other: Sort): boolean;
+}

package/lib/common/data/token-chunk-request.d.ts

@@ -0,0 +1,8 @@
+import { Sort } from './sort';
+import { Filter } from './filters/filter';
+export declare class TokenChunkRequest {
+    readonly nextContinuationToken: string | null | undefined;
+    readonly filters: Filter[];
+    readonly sorts: Sort[];
+    constructor(nextContinuationToken: string | null | undefined, filters: Filter[], sorts: Sort[]);
+}

package/lib/common/enums/elder-enum-translation.service.d.ts

@@ -0,0 +1,52 @@
+import { TranslateService } from '@ngx-translate/core';
+import { Observable } from 'rxjs';
+import { IDataSource } from '../data/datasource/data-source';
+import * as i0 from "@angular/core";
+export declare class TranslatedEnumValue {
+    value: string;
+    displayValue: string;
+    constructor(value: string, displayValue: string);
+}
+export declare class ElderEnumTranslationService {
+    private translateService;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(translateService: TranslateService);
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Translates the given Enum class. Loads translations of given translationPrefix
+     * and creates for each enum value a TranslatedEnumValue.
+     *
+     * @param enumClass enum to translate
+     * @param translationPrefix prefix to load translations
+     * @param sort if true, data will be sorted by translations
+     * @param asc if true, data will be sorted in ascending order
+     */
+    translate(enumClass: any, translationPrefix: string, sort?: boolean, asc?: boolean): Observable<TranslatedEnumValue[]>;
+    /**
+     * Translates the given element. Loads the translation
+     * and creates a TranslatedEnumValue.
+     *
+     * @param translationPrefix prefix to load translation
+     * @param enumKey key of the translation to load
+     */
+    translateOne(translationPrefix: string, enumKey: string): Observable<TranslatedEnumValue>;
+    /**
+     * Creates a data source of translations of the given enum class.
+     *
+     * @param enumClass enum to translate
+     * @param translationPrefix prefix to load translations
+     * @param sort if true, data will be sorted by translations
+     * @param asc if true, data will be sorted in ascending order
+     */
+    enumDateSource(enumClass: any, translationPrefix: string, sort?: boolean, asc?: boolean): IDataSource<TranslatedEnumValue>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderEnumTranslationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ElderEnumTranslationService>;
+}

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

@@ -0,0 +1 @@
+export * from './elder-enum-translation.service';

package/lib/common/errors/exception-detail.d.ts

@@ -0,0 +1,5 @@
+export interface ExceptionDetail {
+    readonly title: string;
+    readonly detail: string;
+    readonly stacktrace: string;
+}

package/lib/common/errors/standard-error-detail.d.ts

@@ -0,0 +1,22 @@
+export interface IStandardErrorDetail {
+    /**
+     * Detail message that describes the error
+     */
+    message: string;
+    /**
+     * The request uri that caused the error
+     */
+    request: string;
+    /**
+     * The Exception Type
+     */
+    type: string;
+    /**
+     * The Http Error Code
+     */
+    status: number;
+    /**
+     * The Http Error Name / Description
+     */
+    error: string;
+}

package/lib/common/format/bytes-format.d.ts

@@ -0,0 +1,4 @@
+export declare class BytesFormat {
+    private static units;
+    static format(bytes: number, precision?: number): string;
+}

package/lib/common/format/bytes-per-second-format.d.ts

@@ -0,0 +1,5 @@
+export declare class BytesPerSecondFormat {
+    static formatBytesPerSecond(bytesPerSecond: number, precision?: number): string;
+    static formatAsBitsPerSecond(bytesPerSecond: number, precision?: number): string;
+    private static format;
+}

package/lib/common/forms/elder-entity-value-accessor.d.ts

@@ -0,0 +1,42 @@
+import { Observable } from 'rxjs';
+/**
+ * Represents a control which is backed by entities (along  values).
+ *
+ * The core idea is that a control tracks an id as value, but it will
+ * also side load the corresponding entity from a datasource.
+ */
+export interface IElderEntityValueAccessor<TEntity, TId, TValue> {
+    /**
+     * Gets or sets the entity
+     */
+    entity: TEntity;
+    /**
+     * Gets or sets the entity id
+     */
+    entityId: TId;
+    /**
+     * Emits when the entity id has changed.
+     */
+    entityIdChange: Observable<TId>;
+    /**
+     * Emits when the entity has changed.
+     */
+    entityChange: Observable<TEntity>;
+    /**
+     * Update the control value by the given entity
+     * and emit a value-updated event which simulates
+     * a user action.
+     * @param entity
+     */
+    updateValueByEntity(entity: TEntity): void;
+    /**
+     * Convert an entity to a value for this control.
+     * @param entity
+     */
+    entityToValue(entity: TEntity): TValue;
+}
+export declare class ElderEntityValueAccessorUtil {
+    static entity$<TEntity>(vac: IElderEntityValueAccessor<TEntity, any, any>): Observable<TEntity>;
+    static entityId$<TId>(vac: IElderEntityValueAccessor<any, TId, any>): Observable<TId>;
+}
+export declare function isElderEntityValueAccessor(object: any): object is IElderEntityValueAccessor<any, any, any>;

package/lib/common/forms/elder-form-field-control-base.directive.d.ts

@@ -0,0 +1,103 @@
+import { MatFormFieldControl } from '@angular/material/form-field';
+import { ValueAccessorBase } from './value-accessor-base';
+import { Observable, Subject } from 'rxjs';
+import { AbstractControlDirective, NgControl } from '@angular/forms';
+import { ElementRef, OnDestroy } from '@angular/core';
+import { BooleanInput } from '@angular/cdk/coercion';
+import { FocusMonitor } from '@angular/cdk/a11y';
+import { TranslateService } from '@ngx-translate/core';
+import * as i0 from "@angular/core";
+/**
+ * Base for custom material form field controls.
+ * https://material.angular.io/guide/creating-a-custom-form-field-control
+ *
+ * Implementors must provide the MatFormFieldControl:
+ * providers: [{provide: MatFormFieldControl, useExisting: MyCoolInput}]
+ */
+export declare abstract class ElderFormFieldControlBase<T> extends ValueAccessorBase<T> implements MatFormFieldControl<T>, OnDestroy {
+    private readonly hostRef;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private static nextId;
+    private readonly _focusMonitor;
+    private readonly _translate;
+    private _placeholder;
+    private _disabled;
+    private _required;
+    private _readonly;
+    private _focused;
+    private readonly stateChangePusher$;
+    protected readonly destroy$: Subject<void>;
+    readonly id: string;
+    readonly ngControl: NgControl | AbstractControlDirective | null;
+    readonly controlType: string;
+    readonly autofilled: boolean;
+    readonly userAriaDescribedBy: string;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(hostRef: ElementRef, controlType: string, focusMonitor: FocusMonitor, translateService: TranslateService, ngControl?: NgControl);
+    /***************************************************************************
+     *                                                                         *
+     * Life Cycle                                                              *
+     *                                                                         *
+     **************************************************************************/
+    private initFocusMonitor;
+    ngOnDestroy(): void;
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    set placeholder(value: string);
+    get placeholder(): string;
+    set required(value: BooleanInput);
+    get required(): boolean;
+    set disabled(value: BooleanInput);
+    get disabled(): boolean;
+    set readonly(value: BooleanInput);
+    get readonly(): boolean;
+    get isLocked(): boolean;
+    get stateChanges(): Observable<void>;
+    get errorState(): boolean;
+    get empty(): boolean;
+    get shouldLabelFloat(): boolean;
+    get focused(): boolean;
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    onContainerClick(event: MouseEvent): void;
+    setDescribedByIds(ids: string[]): void;
+    /***************************************************************************
+     *                                                                         *
+     * Abstract API                                                            *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Focus this control.
+     * @param options
+     */
+    abstract focus(options?: FocusOptions): void;
+    /**
+     * Blur this control.
+     */
+    abstract blur(): void;
+    /***************************************************************************
+     *                                                                         *
+     * Internal API                                                            *
+     *                                                                         *
+     **************************************************************************/
+    protected emitStateChange(): void;
+    protected writeToControl(value: T): void;
+    protected onFocusInternal(): void;
+    protected onBlurInternal(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderFormFieldControlBase<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ElderFormFieldControlBase<any>, never, never, { "placeholder": "placeholder"; "required": "required"; "disabled": "disabled"; "readonly": "readonly"; }, {}, never, never, false>;
+}

package/lib/common/forms/elder-from-field-base.d.ts

@@ -0,0 +1,52 @@
+import { OnInit } from '@angular/core';
+import { BehaviorSubject, Observable } from 'rxjs';
+import { MatFormField, MatFormFieldControl } from '@angular/material/form-field';
+import * as i0 from "@angular/core";
+export declare type ElderApplyControlFn<TControl> = (ctrl: TControl) => void;
+export declare abstract class ElderFromFieldBase<TValue, TControl extends MatFormFieldControl<TValue>> implements OnInit {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    protected readonly _logger: import("@elderbyte/ts-logger").Logger;
+    protected readonly formFieldControl$: BehaviorSubject<TControl>;
+    matFormField: MatFormField;
+    private readonly _value$;
+    private readonly _controlActionQueue;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    protected constructor();
+    /***************************************************************************
+     *                                                                         *
+     * Life Cycle                                                              *
+     *                                                                         *
+     **************************************************************************/
+    ngOnInit(): void;
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    set formFieldControl(ctrl: TControl);
+    get formFieldControl(): TControl;
+    get value$(): Observable<TValue>;
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    applyToControl(applyFn: (ctrl: TControl) => void): void;
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private executeQueuedActions;
+    private controlValue$;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderFromFieldBase<any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ElderFromFieldBase<any, any>, never, never, {}, {}, ["formFieldControl"], never, false>;
+}

package/lib/common/forms/elder-from-field-entity-base.d.ts

@@ -0,0 +1,31 @@
+import { ElderFromFieldBase } from './elder-from-field-base';
+import { Observable } from 'rxjs';
+import { IElderEntityValueAccessor } from './elder-entity-value-accessor';
+import { MatFormFieldControl } from '@angular/material/form-field';
+import * as i0 from "@angular/core";
+export declare abstract class ElderFromFieldEntityBase<TEntity, TId, TControl extends MatFormFieldControl<TEntity | TId>> extends ElderFromFieldBase<TEntity | TId, TControl> {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly _entityAccessor$;
+    private readonly _entity$;
+    private readonly _entityId$;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    protected constructor();
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get entityAccessor$(): Observable<IElderEntityValueAccessor<TEntity, TId, TEntity | TId>>;
+    get entity$(): Observable<TEntity>;
+    get entityId$(): Observable<TId>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderFromFieldEntityBase<any, any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ElderFromFieldEntityBase<any, any, any>, never, never, {}, {}, never, never, false>;
+}

package/lib/common/forms/elder-from-field-multi-entity-base.d.ts

@@ -0,0 +1,35 @@
+import { ElderFromFieldBase } from './elder-from-field-base';
+import { Observable } from 'rxjs';
+import { MatFormFieldControl } from '@angular/material/form-field';
+import { IElderMultiEntityValueAccessor } from './elder-multi-entity-value-accessor';
+import * as i0 from "@angular/core";
+export declare abstract class ElderFromFieldMultiEntityBase<TEntity, TId, TValue, TControl extends MatFormFieldControl<TValue[]>> extends ElderFromFieldBase<TValue[], TControl> {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly _entitiesAccessor$;
+    private readonly _entities$;
+    private readonly _entityIds$;
+    private readonly _entitiesUpdated$;
+    private readonly _entityIdsUpdated$;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    protected constructor();
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get entitiesAccessor$(): Observable<IElderMultiEntityValueAccessor<TEntity, TId, TValue>>;
+    get entities$(): Observable<TEntity[]>;
+    get entityIds$(): Observable<TId[]>;
+    get entitiesUpdated$(): Observable<TEntity[]>;
+    get entityIdsUpdated$(): Observable<TId[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ElderFromFieldMultiEntityBase<any, any, any, any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<ElderFromFieldMultiEntityBase<any, any, any, any>, never, never, {}, {}, never, never, false>;
+}

package/lib/common/forms/elder-multi-entity-value-accessor.d.ts

@@ -0,0 +1,52 @@
+import { Observable } from 'rxjs';
+/**
+ * Represents a control which is backed by entities (along  values).
+ *
+ * The core idea is that a control tracks an id as value, but it will
+ * also side load the corresponding entity from a datasource.
+ */
+export interface IElderMultiEntityValueAccessor<TEntity, TId, TValue> {
+    /**
+     * Gets or sets the entity
+     */
+    entities: TEntity[];
+    /**
+     * Gets or sets the entity id
+     */
+    entityIds: TId[];
+    /**
+     * Emits when the entity id has changed.
+     */
+    readonly entityIdsChange: Observable<TId[]>;
+    /**
+     * Emits when the entity has changed.
+     */
+    readonly entitiesChange: Observable<TEntity[]>;
+    /**
+     * Similar to entity-id change, but emits only when the user
+     * has updated the value.
+     */
+    readonly entityIdsUpdated: Observable<TId[]>;
+    /**
+     * Similar to entity change, but emits only when the user
+     * has updated the value.
+     */
+    readonly entitiesUpdated: Observable<TEntity[]>;
+    /**
+     * Update the control value by the given entity
+     * and emit a value-updated event which simulates
+     * a user action.
+     * @param entity
+     */
+    updateValueByEntities(entity: TEntity[]): void;
+    /**
+     * Convert an entity to a value for this control.
+     * @param entity
+     */
+    entityToValue(entity: TEntity): TValue;
+}
+export declare class ElderMultiEntityValueAccessorUtil {
+    static entities$<TEntity>(vac: IElderMultiEntityValueAccessor<TEntity, any, any>): Observable<TEntity[]>;
+    static entityIds$<TId>(vac: IElderMultiEntityValueAccessor<any, TId, any>): Observable<TId[]>;
+}
+export declare function isElderMultiEntityValueAccessor(object: any): object is IElderMultiEntityValueAccessor<any, any, any>;