@elderbyte/ngx-starter 14.12.0-beta6 → 14.12.0

package/lib/common/i18n/entity/impl/i18n-base.d.ts

@@ -0,0 +1,6 @@
+import { Localized } from '../localized';
+import { LanguageTag } from '../language-tag';
+export declare abstract class I18nBase implements Localized {
+    locale: LanguageTag;
+    protected constructor(locale: LanguageTag);
+}

package/lib/common/i18n/entity/impl/i18n-text.d.ts

@@ -0,0 +1,11 @@
+import { LanguageTag } from '../language-tag';
+import { I18nBase } from './i18n-base';
+/**
+ * Represents a text in a specific locale.
+ */
+export declare class I18nText extends I18nBase {
+    text: string;
+    private static readonly localisationPicker;
+    static findBestText(choices: I18nText[], desired: LanguageTag): string | undefined;
+    constructor(locale: LanguageTag, text: string);
+}

package/lib/common/i18n/entity/language-tag.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents IETF Language Tags, consisting of
+ * ISO Language Codes (639-1 and 693-2) and IETF language types.
+ * https://datahub.io/core/language-codes#resource-ietf-language-tags
+ */
+export declare type LanguageTag = string;
+export declare class KnownLocaleType {
+    readonly ENGLISH: LanguageTag;
+    readonly en_US: LanguageTag;
+    readonly FRENCH: LanguageTag;
+    readonly fr_FR: LanguageTag;
+    readonly GERMAN: LanguageTag;
+    readonly de_DE: LanguageTag;
+    readonly de_CH: LanguageTag;
+}

package/lib/common/i18n/entity/locale.d.ts

@@ -0,0 +1,8 @@
+import { LanguageTag } from './language-tag';
+export declare class Locale {
+    readonly language: string;
+    readonly country?: string;
+    readonly variant?: string;
+    static parse(tag: LanguageTag): Locale;
+    constructor(language: string, country?: string, variant?: string);
+}

package/lib/common/i18n/entity/localisation-picker.d.ts

@@ -0,0 +1,14 @@
+import { LanguageTag } from './language-tag';
+import { Localized } from './localized';
+export interface LocalisationPicker {
+    /**
+     * Returns the best match of the given choices for the given desired language tag.
+     * @param choices
+     * @param desired
+     */
+    findBest<T extends Localized>(choices: T[], desired: LanguageTag): T | undefined;
+}
+export declare class SimpleLocalisationPicker implements LocalisationPicker {
+    static readonly Instance: LocalisationPicker;
+    findBest<T extends Localized>(choices: T[], desiredTag: LanguageTag): T | undefined;
+}

package/lib/common/i18n/entity/localized.d.ts

@@ -0,0 +1,10 @@
+import { LanguageTag } from './language-tag';
+/**
+ * Represents a localized item.
+ */
+export interface Localized {
+    /**
+     * The locale type code of this localized item.
+     */
+    readonly locale: LanguageTag;
+}

package/lib/common/i18n/entity/public_api.d.ts

@@ -0,0 +1,5 @@
+export * from './language-tag';
+export * from './localized';
+export * from './localisation-picker';
+export * from './impl/i18n-base';
+export * from './impl/i18n-text';

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

@@ -0,0 +1 @@
+export * from './entity/public_api';

package/lib/common/json-map.d.ts

@@ -0,0 +1,7 @@
+export declare type JsonMap<T> = {
+    [name in string | number]: T;
+};
+export declare class JsonMapUtil {
+    static toJsonMap<T>(esMap: Map<string | number, T>): JsonMap<T>;
+    static toMap<T, ID = string | number>(jsonMap: JsonMap<T>, toIdFn?: ((key: string | number) => ID)): Map<ID, T>;
+}

package/lib/common/objects.d.ts

@@ -0,0 +1,19 @@
+export declare class Objects {
+    private static readonly logger;
+    /**
+     * Checks if the given value is non null / nun undefined
+     */
+    static nonNull(value: any): boolean;
+    /**
+     * Checks if the given value is null or undefined
+     */
+    static isNull(value: any): boolean;
+    /**
+     * Creates a copy of the object data.
+     */
+    static cloneData<T>(src: T): T;
+    /**
+     * Checks if the two given objects have the same data
+     */
+    static dataEquals<T>(a: T, b: T): boolean;
+}

package/lib/common/public_api.d.ts

@@ -0,0 +1,18 @@
+export * from './format/public_api';
+export * from './time/public_api';
+export * from './data/public_api';
+export * from './forms/public_api';
+export * from './utils/public_api';
+export * from './selection/public_api';
+export * from './http/public_api';
+export * from './i18n/public_api';
+export * from './enums/public_api';
+export * from './errors/public_api';
+export * from './csv/public_api';
+export * from './async/public_api';
+export * from './url/public_api';
+export * from './json-map';
+export * from './objects';
+export * from './sets';
+export * from './suggestion-provider';
+export * from './reactive-map';

package/lib/common/reactive-map.d.ts

@@ -0,0 +1,40 @@
+import { Observable } from 'rxjs';
+export declare class ReactiveMap<TKey, TValue> implements Map<TKey, TValue> {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly _map;
+    readonly map$: Observable<Map<TKey, TValue>>;
+    readonly values$: Observable<TValue[]>;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(initialValue?: Map<TKey, TValue>);
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get size(): number;
+    clear(): void;
+    set(key: TKey, value: TValue): this;
+    delete(key: TKey): boolean;
+    get(key: TKey): TValue | undefined;
+    has(key: TKey): boolean;
+    get [Symbol.toStringTag](): string;
+    get [Symbol.iterator](): () => IterableIterator<[TKey, TValue]>;
+    entries(): IterableIterator<[TKey, TValue]>;
+    forEach(callbackfn: (value: TValue, key: TKey, map: Map<TKey, TValue>) => void, thisArg?: any): void;
+    keys(): IterableIterator<TKey>;
+    values(): IterableIterator<TValue>;
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private modify;
+}

package/lib/common/selection/selection-model.d.ts

@@ -0,0 +1,82 @@
+import { Observable } from 'rxjs';
+export declare type KeyGetterFn<T> = ((item: T) => any);
+/**
+ * Provides a model of a selection.
+ * Supports single and multi selection.
+ *
+ * Supports custom selection equality (default by object value)
+ */
+export declare class SelectionModel<T> {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly log;
+    private _multiple;
+    private readonly _selectionMap;
+    private readonly _selection;
+    private _keyGetterFn;
+    private _selectableEvaluatorFn;
+    static readonly FallbackKeyGetterFn: (a: any) => any;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Creates a new SelectionModel
+     *
+     * @param multiple Support multi selection?
+     * @param initial the initial selection
+     * @param keyGetter value identity - default to value object equality
+     * @param selectableEvaluatorFn function to evaluate if the element in question is selectable
+     */
+    constructor(multiple?: boolean, initial?: T[], keyGetter?: KeyGetterFn<T>, selectableEvaluatorFn?: ((item: T) => boolean));
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get changed(): Observable<T[]>;
+    get selection(): Observable<T[]>;
+    get selectionSnapshot(): T[];
+    set selectableEvaluatorFn(fn: (item: T) => boolean);
+    set keyGetterFn(fn: KeyGetterFn<T>);
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Evaluates if the given item is selectable based on the initially set 'selectable' function.
+     * If no function has been set (or function is null), all items are selectable by default.
+     */
+    isSelectable(item: T): boolean;
+    clear(): void;
+    replaceSelection(newSelection: T[]): void;
+    select(values: T[]): void;
+    deselect(values: T[]): void;
+    deselectIds(ids: any[]): void;
+    toggle(value: T): void;
+    isSelected(value: T): boolean;
+    observeSelection(value: T): Observable<boolean>;
+    get count(): number;
+    get isEmpty(): boolean;
+    get hasValue(): boolean;
+    get hasSingleValue(): boolean;
+    get hasMultipleValues(): boolean;
+    get isMultipleSelection(): boolean;
+    set isMultipleSelection(multiple: boolean);
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private selectionChanged;
+    private selectInternal;
+    private ensureSelectedMulti;
+    private isExclusiveSelected;
+    private isAlreadySelected;
+    private ensureSelectedSingle;
+}

package/lib/common/sets.d.ts

@@ -0,0 +1,20 @@
+export declare class Sets {
+    /**
+     * Compares the content of two sets for equality in O(n).
+     * @param as
+     * @param bs
+     */
+    static equals<T>(as: Set<T>, bs: Set<T>): boolean;
+    /**
+     * Checks if the two given arrays have the same content.
+     * They are handled as "Sets" and order of the items is not relevant for the check.
+     *
+     * @param idsA
+     * @param idsB
+     */
+    static equalContent<T>(idsA: T[], idsB: T[]): boolean;
+    /**
+     * Checks if the given set contains every given element
+     */
+    static containsEvery<T>(set: Set<T>, elements: T[]): boolean;
+}

package/lib/common/suggestion-provider.d.ts

@@ -0,0 +1,13 @@
+import { Observable } from 'rxjs';
+export interface ISuggestionProvider<T> {
+    /**
+     * Loads all suggestions, filtered by the given filter string.
+     */
+    loadSuggestions(filter: string | null): Observable<T[]>;
+}
+export declare class SuggestionProvider<T> implements ISuggestionProvider<T> {
+    private provider;
+    static build<T>(provider: (filter: string) => Observable<T[]>): ISuggestionProvider<T>;
+    constructor(provider: (filter: string) => Observable<T[]>);
+    loadSuggestions(filter: string): Observable<T[]>;
+}

package/lib/common/templates/template-slot-manager.d.ts

@@ -0,0 +1,70 @@
+import { TemplateRef } from '@angular/core';
+import { Observable } from 'rxjs';
+/**
+ * Manages templates for different slots.
+ * Supports global fallback templates for slots (default templates)
+ */
+export declare class TemplateSlotManager<TSlot> {
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly logger;
+    /** Default templates (App Level) */
+    private readonly _defaultSlotTemplates;
+    /** Custom templates (Component Level) */
+    private readonly _slotTemplates;
+    private readonly _activeSlotTemplates;
+    /**
+     * Key: A synonym slot name
+     * Value: The primary slot the synonym is resolving to
+     */
+    private readonly _slotSynonyms;
+    /***************************************************************************
+     *                                                                         *
+     * Constructors                                                            *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Create a new Template Slot Manager.
+     * @param slotDefinitions Slot definitions, supporting synonyms
+     */
+    constructor(slotDefinitions: Array<TSlot | TSlot[]>);
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    /**
+     * Returns an observable which emits the current active template for the given slot
+     * over time.
+     */
+    activeSlotTemplate(slot: TSlot): Observable<TemplateRef<any>>;
+    /**
+     * Registers the given template for the given slot.
+     *
+     * @param slot at which template should be placed
+     * @param template to set at slot
+     * @param isDefault if the given template should be used as global default
+     */
+    registerSlotTemplate(slot: TSlot, template: TemplateRef<any>, isDefault?: boolean): void;
+    /**
+     * Deregister the given template from the toolbar.
+     *
+     * @param template to deregister
+     * @param slot if set, the template will only be deregistered if it was registered at this slot (optional)
+     */
+    deregisterSlotTemplate(template: TemplateRef<any>, slot?: TSlot): void;
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private initSlot;
+    private registerSlotSynonyms;
+    private resolveSlot;
+    private removeSlotTemplate;
+    private updateActiveSlotTemplate;
+    private findActiveTemplate;
+}

package/lib/common/time/date-util.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Represents an ISO-8601 date string.
+ * https://en.wikipedia.org/wiki/ISO_8601#Dates
+ */
+import { Instant } from '@js-joda/core';
+export declare type IsoDateStr = string;
+export declare class DateUtil {
+    static readonly IsoDateDelimiter = "-";
+    static readonly IsoTimeDelimiter = ":";
+    static readonly DateTimeSeparator = "T";
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    static instantToDate(instant: Instant): Date;
+    /**
+     * Returns the given Date as ISO formatted local date string.
+     *
+     * YYYY-MM-DD
+     *
+     * @param date
+     */
+    static toLocalDateIso(date: Date): string;
+    /**
+     * Returns the given Date as ISO formatted local date-time string.
+     *
+     * YYYY-MM-DDTHH:mm:ss.sss
+     *
+     * @param date
+     */
+    static toLocalDateTimeIso(date: Date): string;
+    /**
+     * Checks if the given DateTime is represents the start of the day.
+     *
+     * @param dateTime DateTime to check
+     */
+    static isStartOfDay(date: Date): boolean;
+    /**
+     * Sets the given Date to the start of its day by setting its time to 0.
+     *
+     * @param localDate Date to set to start of day
+     */
+    static startOfDay(localDate: Date): Date;
+    static plusDays(date: Date, days: number): Date;
+    /***************************************************************************
+     *                                                                         *
+     * private Methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private static dateString;
+    private static timeString;
+    private static format;
+}