@elderbyte/ngx-starter 19.19.0 → 20.0.0-beta.1

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

@@ -1,122 +0,0 @@
-import { Sort } from '../sort';
-import { IDataContext, IDataContextActivePage, IDataContextContinuable } from './data-context';
-import { IDataSource } from '../datasource/data-source';
-import { AutoStartSpec } from './data-context-auto-starter';
-/**
- * Provides the ability to build a IDataContext<T>.
- */
-export declare class DataContextBuilder<T> {
-    /***************************************************************************
-     *                                                                         *
-     * Fields                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    private readonly logger;
-    private _indexFn?;
-    private _localApply?;
-    private _localSort?;
-    private _skipLocalSort;
-    private _pageSize;
-    private _reloadOnLocalChanges;
-    private _activePaged;
-    private _autoStartSpec?;
-    /***************************************************************************
-     *                                                                         *
-     * Static                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    /**
-     * Creates a new DataContextBuilder.
-     * @returns A new DataContextBuilder for the given data type.
-     */
-    static start<T>(): DataContextBuilder<T>;
-    /***************************************************************************
-     *                                                                         *
-     * Constructor                                                             *
-     *                                                                         *
-     **************************************************************************/
-    constructor();
-    /***************************************************************************
-     *                                                                         *
-     * Public API                                                              *
-     *                                                                         *
-     **************************************************************************/
-    /**
-     * Optional index function where each element will be indexed by.
-     * If you have configured this, you can use the findByIndex(key) on the data-context.
-     */
-    indexBy(indexFn?: (item: T) => any): this;
-    /**
-     * The desired size of a page/chunk when loading data.
-     * Note that continuable apis might just take this as a wish or even completely ignore this param.
-     */
-    pageSize(size: number): this;
-    /**
-     * Sort the data context locally.
-     *
-     * Note that this might be a costly operation when there are a lot of elements present.
-     * Prefer server side sorting if possible.
-     */
-    localSort(localSort?: (data: T[], sorts: Sort[]) => T[]): this;
-    /**
-     * Enable active paging (in contrast to the infinite load) in the data context.
-     * Only supported if the underlying datasource supports pagination.
-     */
-    activePaged(): this;
-    /**
-     * For each element which is added to the datacontext, apply the given function.
-     */
-    localApply(localApply: (data: T[]) => T[]): this;
-    /**
-     * On a local change event, automatically reload data in the data-context.
-     * This means whenever there was an modify operation on the rest client,
-     * such as Update, Delete or Create, the data will be reloaded.
-     */
-    reloadOnLocalChanges(): this;
-    autoStartAsap(sort?: Sort[]): this;
-    autoStartOnFilters(filters: Array<string[]>, sort?: Sort[]): this;
-    autoStartOnFiltersAll(filters: string[], sort?: Sort[]): this;
-    autoStartOnFiltersAny(filters: string[], sort?: Sort[]): this;
-    autoStartOn(spec: AutoStartSpec): this;
-    /***************************************************************************
-     *                                                                         *
-     * DataSource Builder                                                      *
-     *                                                                         *
-     **************************************************************************/
-    /**
-     * Build a new DataContext from the given DataSource.
-     *
-     * Common DataSources are RestClient, LocalListDataSource and DelegateDataSource.
-     *
-     * @param ds
-     */
-    build(ds: IDataSource<T>): IDataContext<T>;
-    /***************************************************************************
-     *                                                                         *
-     * Local Data Builder                                                      *
-     *                                                                         *
-     **************************************************************************/
-    buildLocal(items: T[], idProperty?: string): IDataContext<T>;
-    buildLocalActivePaged(items: T[], idProperty?: string): IDataContextActivePage<T>;
-    private localListSource;
-    /***************************************************************************
-     *                                                                         *
-     * Empty Data Builder                                                      *
-     *                                                                         *
-     **************************************************************************/
-    buildEmpty(): IDataContext<T>;
-    buildEmptyContinuable(): IDataContextContinuable<T>;
-    buildEmptyActivePaged(): IDataContextActivePage<T>;
-    /***************************************************************************
-     *                                                                         *
-     * Private methods                                                         *
-     *                                                                         *
-     **************************************************************************/
-    private buildFromSource;
-    private fromListSource;
-    private fromPageSource;
-    private fromContinuationSource;
-    private fromActivePageSource;
-    private setupDataContextAutoReload;
-    private setupDataContextAutoStart;
-}

package/lib/common/data/data-context/data-context-continuable-base.d.ts

@@ -1,44 +0,0 @@
-import { DataContextBase } from './data-context-base';
-import { Sort } from '../sort';
-import { Filter } from '../filters/filter';
-import { Observable } from 'rxjs';
-import { IDataContextContinuable } from './data-context';
-import { IDataSource } from '../datasource/data-source';
-/**
- * Extends a simple flat list data-context with infinite-scroll pagination support.
- *
- */
-export declare abstract class DataContextContinuableBase<T> extends DataContextBase<T> implements IDataContextContinuable<T> {
-    /***************************************************************************
-     *                                                                         *
-     * Fields                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    private readonly cblogger;
-    private readonly _chunkSize$;
-    /***************************************************************************
-     *                                                                         *
-     * Constructors                                                            *
-     *                                                                         *
-     **************************************************************************/
-    protected constructor(dataSource: IDataSource<T>, chunkSize: number, indexFn: (item: T) => any, localApply: (data: T[]) => T[], localSort: (data: T[], sorts: Sort[]) => T[]);
-    /***************************************************************************
-     *                                                                         *
-     * Public API                                                              *
-     *                                                                         *
-     **************************************************************************/
-    loadAll(sorts?: Sort[], filters?: Filter[]): void;
-    get chunkSize$(): Observable<number>;
-    get chunkSize(): number | undefined;
-    set chunkSize(size: number);
-    /***************************************************************************
-     *                                                                         *
-     * Private Methods                                                         *
-     *                                                                         *
-     **************************************************************************/
-    protected updateChunkSize(newSize: number, reloadOnChange: boolean): void;
-    private loadAllRec;
-    abstract loadMore(): Observable<any>;
-    abstract get hasMoreDataSnapshot(): boolean;
-    abstract get hasMoreData(): Observable<boolean>;
-}

package/lib/common/data/data-context/data-context-continuable-paged.d.ts

@@ -1,57 +0,0 @@
-import { Observable } from 'rxjs';
-import { DataContextContinuableBase } from './data-context-continuable-base';
-import { Sort } from '../sort';
-import { IPagedDataSource } from '../datasource/data-source';
-/**
- * Extends a simple flat list data-context with infinite-scroll pagination support.
- *
- */
-export declare class DataContextContinuablePaged<T> extends DataContextContinuableBase<T> {
-    /***************************************************************************
-     *                                                                         *
-     * Fields                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    private readonly logger;
-    private _pageCache;
-    private _latestPage;
-    private readonly _hasMoreData;
-    /***************************************************************************
-     *                                                                         *
-     * Constructors                                                            *
-     *                                                                         *
-     **************************************************************************/
-    constructor(dataSource: IPagedDataSource<T>, pageSize: number, indexFn: (item: T) => any, localApply: (data: T[]) => T[], localSort: (data: T[], sorts: Sort[]) => T[]);
-    /***************************************************************************
-     *                                                                         *
-     * Properties                                                              *
-     *                                                                         *
-     **************************************************************************/
-    get dataSource(): IPagedDataSource<T>;
-    /***************************************************************************
-     *                                                                         *
-     * Public API                                                              *
-     *                                                                         *
-     **************************************************************************/
-    /**
-     * Load the next chunk of data.
-     * Useful for infinite scroll like data flows.
-     *
-     */
-    loadMore(): Observable<any>;
-    get hasMoreData(): Observable<boolean>;
-    get hasMoreDataSnapshot(): boolean;
-    /***************************************************************************
-     *                                                                         *
-     * Private Methods                                                         *
-     *                                                                         *
-     **************************************************************************/
-    private checkHasMoreData;
-    protected reloadInternal(): Observable<any>;
-    protected clearAll(silent?: boolean): void;
-    private fetchPage;
-    /**
-     * Load the data from the given page into the current data context
-     */
-    private populatePageData;
-}

package/lib/common/data/data-context/data-context-continuable-token.d.ts

@@ -1,50 +0,0 @@
-import { DataContextContinuableBase } from './data-context-continuable-base';
-import { Observable } from 'rxjs';
-import { Sort } from '../sort';
-import { IContinuableDataSource } from '../datasource/data-source';
-export declare class DataContextContinuableToken<T> extends DataContextContinuableBase<T> {
-    /***************************************************************************
-     *                                                                         *
-     * Fields                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    private readonly logger;
-    private readonly _hasMoreData;
-    private readonly _chunkCache;
-    private _expectedChunkToken?;
-    /***************************************************************************
-     *                                                                         *
-     * Constructor                                                             *
-     *                                                                         *
-     **************************************************************************/
-    constructor(dataSource: IContinuableDataSource<T>, chunkSize: number, indexFn: (item: T) => any, localApply: (data: T[]) => T[], localSort: (data: T[], sorts: Sort[]) => T[]);
-    /***************************************************************************
-     *                                                                         *
-     * Properties                                                              *
-     *                                                                         *
-     **************************************************************************/
-    get dataSource(): IContinuableDataSource<T>;
-    /***************************************************************************
-     *                                                                         *
-     * Public API                                                              *
-     *                                                                         *
-     **************************************************************************/
-    get hasMoreDataSnapshot(): boolean;
-    get hasMoreData(): Observable<boolean>;
-    loadMore(): Observable<any>;
-    /***************************************************************************
-     *                                                                         *
-     * Protect API                                                             *
-     *                                                                         *
-     **************************************************************************/
-    protected clearAll(silent?: boolean): void;
-    protected reloadInternal(): Observable<any>;
-    private fetchNextChunk;
-    private onChunkFetched;
-    private onChunkFetchError;
-    /**
-     * Load the data from the given page into the current data context
-     */
-    private populateChunkData;
-    private areTokenEqual;
-}

package/lib/common/data/data-context/data-context-life-cycle-binding.d.ts

@@ -1,33 +0,0 @@
-import { Subscription, Unsubscribable } from 'rxjs';
-import { IDataContext } from './data-context';
-/**
- * Allows making any kind of subscription which will be automatically unsubscribed
- * upon data context closing/cleanup.
- */
-export declare abstract class DataContextLifeCycleBinding implements Unsubscribable {
-    protected readonly _dataContext: IDataContext<any>;
-    /***************************************************************************
-     *                                                                         *
-     * Fields                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    protected _subscription: Subscription;
-    /***************************************************************************
-     *                                                                         *
-     * Constructor                                                             *
-     *                                                                         *
-     **************************************************************************/
-    protected constructor(_dataContext: IDataContext<any>);
-    /***************************************************************************
-     *                                                                         *
-     * Public API                                                              *
-     *                                                                         *
-     **************************************************************************/
-    unsubscribe(): void;
-    /***************************************************************************
-     *                                                                         *
-     * Protected                                                               *
-     *                                                                         *
-     **************************************************************************/
-    protected abstract subscribe(): void;
-}

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

@@ -1,30 +0,0 @@
-import { DataContextBase } from './data-context-base';
-import { Sort } from '../sort';
-import { Observable } from 'rxjs';
-import { IListDataSource } from '../datasource/data-source';
-export declare class DataContextSimple<T> extends DataContextBase<T> {
-    /***************************************************************************
-     *                                                                         *
-     * Fields                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    private readonly log;
-    /***************************************************************************
-     *                                                                         *
-     * Constructor                                                             *
-     *                                                                         *
-     **************************************************************************/
-    constructor(dataSource: IListDataSource<T>, indexFn: (item: T) => any, localApply: (data: T[]) => T[], localSort: (data: T[], sorts: Sort[]) => T[]);
-    /***************************************************************************
-     *                                                                         *
-     * Properties                                                              *
-     *                                                                         *
-     **************************************************************************/
-    get dataSource(): IListDataSource<T>;
-    /***************************************************************************
-     *                                                                         *
-     * Private methods                                                         *
-     *                                                                         *
-     **************************************************************************/
-    protected reloadInternal(): Observable<any>;
-}

package/lib/common/data/data-context/data-context-source-event-binding.d.ts

@@ -1,28 +0,0 @@
-import { IDataContext } from './data-context';
-import { IDataSource } from '../datasource/data-source';
-import { DataContextLifeCycleBinding } from './data-context-life-cycle-binding';
-export declare class DataContextSourceEventBinding<T = any> extends DataContextLifeCycleBinding {
-    private readonly dataApi;
-    private readonly reloadOnChanges;
-    /***************************************************************************
-     *                                                                         *
-     * Constructor                                                             *
-     *                                                                         *
-     **************************************************************************/
-    constructor(dataContext: IDataContext<T>, dataApi: IDataSource<T>, reloadOnChanges: boolean);
-    /***************************************************************************
-     *                                                                         *
-     * Internal Impl                                                           *
-     *                                                                         *
-     **************************************************************************/
-    protected subscribe(): void;
-    /***************************************************************************
-     *                                                                         *
-     * Private methods                                                         *
-     *                                                                         *
-     **************************************************************************/
-    private handleDataChangeEvent;
-    private updateExisting;
-    private isReloadDesirable;
-    private buildPatchUpdates;
-}

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

@@ -1,30 +0,0 @@
-/**
- * Represents the status of a data-context
- */
-export declare class DataContextStatus {
-    private readonly _error;
-    private readonly _loading;
-    /***************************************************************************
-     *                                                                         *
-     * Static builders                                                         *
-     *                                                                         *
-     **************************************************************************/
-    static idle(): DataContextStatus;
-    static error(error: any): DataContextStatus;
-    static loading(): DataContextStatus;
-    /***************************************************************************
-     *                                                                         *
-     * Constructors                                                            *
-     *                                                                         *
-     **************************************************************************/
-    constructor(_error: any, _loading?: boolean);
-    /***************************************************************************
-     *                                                                         *
-     * Properties                                                              *
-     *                                                                         *
-     **************************************************************************/
-    get idle(): boolean;
-    get loading(): boolean;
-    get error(): any;
-    get hasError(): boolean;
-}

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

@@ -1,177 +0,0 @@
-import { DataContextStatus } from './data-context-status';
-import { Observable } from 'rxjs';
-import { Sort } from '../sort';
-import { Filter } from '../filters/filter';
-import { FilterContext } from '../filters/filter-context';
-import { PageRequest } from '../page';
-import { SortContext } from '../sort-context';
-import { IDataSource } from '../datasource/data-source';
-export declare class DataContextSnapshot<T> {
-    readonly data: T[];
-    readonly isEmpty: boolean;
-    readonly isLoading: boolean;
-    readonly total: number | undefined;
-    readonly status: DataContextStatus;
-    constructor(data: T[], isEmpty: boolean, isLoading: boolean, total: number | undefined, status: DataContextStatus);
-}
-/**
- * Manages a set of data (rows) which are to be displayed in a UI Component.
- *
- */
-export interface IDataContext<T> {
-    /***************************************************************************
-     *                                                                         *
-     * Properties                                                              *
-     *                                                                         *
-     **************************************************************************/
-    /**
-     * An auto generated id of this DataContext instance.
-     * Mostly for debugging purposes.
-     */
-    readonly id: string;
-    /**
-     * Gets the underlying DataSource of this DataContext.
-     */
-    readonly dataSource: IDataSource<T>;
-    /**
-     * Gets a snapshot of the current state in this data-context
-     */
-    readonly snapshot: DataContextSnapshot<T>;
-    /**
-     * Observable which emits the current data over time.
-     */
-    readonly data: Observable<T[]>;
-    /**
-     * Indicates if the context currently holds no data
-     */
-    readonly isEmpty: boolean;
-    /**
-     * Indicates if the context has been started.
-     */
-    readonly isStarted: boolean;
-    /**
-     * Indicates if the context has been started.
-     */
-    readonly isStarted$: Observable<boolean>;
-    /**
-     * Indicates if the context has been closed.
-     * Depending on the implementation, restarting might not be possible.
-     */
-    readonly isClosed: boolean;
-    /**
-     * Indicates if data is loading over time
-     */
-    readonly loading: Observable<boolean>;
-    /**
-     * The total count of all elements over time
-     * (I.e. the expected count when the data context is completed)
-     */
-    readonly total: Observable<number | undefined>;
-    /**
-     * Observable which emits when the status changes (i.e. error)
-     */
-    readonly status: Observable<DataContextStatus>;
-    /**
-     * Gets the sort context. Changes in this context are reflected by the data-context.
-     */
-    readonly sort: SortContext;
-    /**
-     * Gets the filter context. Changes in this context are reflected by the data-context.
-     */
-    readonly filter: FilterContext;
-    /***************************************************************************
-     *                                                                         *
-     * API                                                                     *
-     *                                                                         *
-     **************************************************************************/
-    /**
-     * Starts populating data context by loading first
-     * batch of data.
-     */
-    start(sorts?: Sort[], filters?: Filter[]): Observable<any>;
-    /**
-     * Requests a reload of the current data / chunk.
-     * Attempts to keep the current position.
-     */
-    reload(reason?: string): Observable<any>;
-    /**
-     * Refresh the data view from the local data model. (Does not request new data from the server)
-     * Useful if the data model has changes that need to be reflected in the UI.
-     */
-    refresh(): void;
-    /**
-     * Closes the data-context and cleans up resources
-     */
-    close(): void;
-    /**
-     * Returns the item by a custom index key.
-     * Requires that custom index functionality is enabled.
-     *
-     * For id based lookup, refer to findById().
-     *
-     * @param key
-     */
-    findByIndex(key: any): T | undefined;
-    /**
-     * Lookup an entity by its id. This method is guaranteed to be backed by a fast index.
-     * @param id The Entity Id.
-     */
-    findById(id: any): T | undefined;
-    /**
-     * Update the given entities in this data-context
-     */
-    update(entities: T[]): void;
-}
-/**
- * Represents a data-context which backs a infinite like data stream
- * where more data will be loaded and added to the backing rows.
- */
-export interface IDataContextContinuable<T> extends IDataContext<T> {
-    /**
-     * Returns true if this data-context can load more data
-     */
-    readonly hasMoreDataSnapshot: boolean;
-    /**
-     * Returns true if this data-context can load more data over time
-     */
-    readonly hasMoreData: Observable<boolean>;
-    /**
-     * Loads more data if any available.
-     * E.g. next page.
-     *
-     */
-    loadMore(): Observable<any>;
-    /**
-     * Loads all available data. In case of
-     * paged context loads page by page until finished.
-     */
-    loadAll(sorts?: Sort[], filters?: Filter[]): void;
-    /**
-     * Set the desired chunk size
-     */
-    set chunkSize(size: number | undefined);
-    get chunkSize(): number;
-    get chunkSize$(): Observable<number | undefined>;
-}
-export interface IDataContextActivePage<T> extends IDataContext<T> {
-    /**
-     * Gets the active page over time
-     */
-    readonly page: Observable<PageRequest>;
-    /**
-     * Gets the current active page
-     */
-    readonly pageSnapshot: PageRequest;
-    /**
-     * Sets the active page
-     */
-    setActivePage(page: PageRequest): void;
-}
-/***************************************************************************
- *                                                                         *
- * Type Predicates                                                         *
- *                                                                         *
- **************************************************************************/
-export declare function isDataContext(object: any): object is IDataContext<any>;
-export declare function isContinuableDataContext(object: IDataContext<any>): object is IDataContextContinuable<any>;
-export declare function isActivePagedDataContext(object: IDataContext<any>): object is IDataContextActivePage<any>;

package/lib/common/data/data-context/indexed-entities.d.ts

@@ -1,72 +0,0 @@
-import { Observable } from 'rxjs';
-import { Sort } from '../sort';
-import { SortContext } from '../sort-context';
-export declare class IndexedEntities<T, TId = any> {
-    private readonly idFn;
-    private readonly localSortFn;
-    private readonly sortContext;
-    /***************************************************************************
-     *                                                                         *
-     * Fields                                                                  *
-     *                                                                         *
-     **************************************************************************/
-    private readonly log;
-    private readonly _entities$;
-    private readonly _idToArrayIndex;
-    /***************************************************************************
-     *                                                                         *
-     * Constructor                                                             *
-     *                                                                         *
-     **************************************************************************/
-    constructor(idFn: (e: T) => TId, localSortFn: ((data: T[], sorts: Sort[]) => T[]) | undefined, sortContext: SortContext);
-    /***************************************************************************
-     *                                                                         *
-     * Properties                                                              *
-     *                                                                         *
-     **************************************************************************/
-    get entities$(): Observable<T[]>;
-    get entitiesSnapshot(): T[];
-    /***************************************************************************
-     *                                                                         *
-     * Public API                                                              *
-     *                                                                         *
-     **************************************************************************/
-    /**
-     * Replaces all existing entities with the new ones.
-     * The index is rebuilt. O(n)
-     */
-    replaceAll(newEntities?: T[]): void;
-    /**
-     * Keeps all existing entities, but replaces those which are updated with the new data.
-     * Provided updated entities which are currently not in this index are ignored.
-     * @param updated
-     */
-    updateSome(updated: T[]): void;
-    append(append: T[]): void;
-    /**
-     * Appends the given entities to this index.
-     * The new appended entities are included in the index.
-     * O(n) where n = number of appended entities
-     * @param inserted
-     * @param offset
-     */
-    insert(inserted: T[], offset: number): void;
-    /**
-     * Lookup an entity by its id.
-     * This will use an index O(1)
-     * @param id
-     */
-    getById(id: TId): T | undefined;
-    notify(): void;
-    destroy(): void;
-    /***************************************************************************
-     *                                                                         *
-     * Private methods                                                         *
-     *                                                                         *
-     **************************************************************************/
-    private rebuildIndex;
-    private reIndexFrom;
-    private indexById;
-    private getItemId;
-    private setEntities;
-}