@elderbyte/ngx-starter 15.3.4 → 15.4.0

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

@@ -7,7 +7,7 @@ import { FilterContext } from '../filters/filter-context';
 import { DataContextSnapshot, IDataContext } from './data-context';
 import { SortContext } from '../sort-context';
 import { IDataSource } from '../datasource/data-source';
-export declare abstract class DataContextBase<T> extends DataSource<T> implements IDataContext<T> {
+export declare abstract class DataContextBase<T, TId = any> extends DataSource<T> implements IDataContext<T> {
     private _indexFn;
     private _localApply;
     private _localSort;
@@ -26,7 +26,7 @@ export declare abstract class DataContextBase<T> extends DataSource<T> implement
     private readonly _status;
     private readonly _started;
     private readonly _closed;
-    private readonly _primaryIndex;
+    private readonly _customIndex;
     private readonly _reloadQueue;
     protected readonly unsubscribe$: Subject<void>;
     /***************************************************************************
@@ -73,11 +73,13 @@ export declare abstract class DataContextBase<T> extends DataSource<T> implement
     start(sorts?: Sort[], filters?: Filter[]): Observable<any>;
     reload(): void;
     findByIndex(key: any): T | undefined;
+    findById(id: any): T | undefined;
     /**
      * Closes this DataContext and cleans up all used resources.
      */
     close(): void;
     refresh(): void;
+    update(entities: T[]): void;
     /***************************************************************************
      *                                                                         *
      * Protected methods                                                       *
@@ -85,15 +87,21 @@ export declare abstract class DataContextBase<T> extends DataSource<T> implement
      **************************************************************************/
     protected reloadNow(): Observable<any>;
     /**
-     * Append the given rows to to existing ones.
+     * Append the given rows to the existing ones.
      */
     protected appendData(additionalData: T[]): void;
+    /**
+     * Insert the given rows at the given location.
+     */
+    protected insertData(additionalData: T[], offset: number): void;
     /**
      * Replaces the existing data with the new set.
      * @param newData The new data set.
      * @param alreadyIndexed The rows will be indexed unless they already have been.
      */
     protected setData(newData: T[], alreadyIndexed?: boolean): void;
+    protected clearData(): void;
+    private localApply;
     protected setTotal(total: number | undefined): void;
     /**
      * Clears the current data-context cached data.
@@ -110,6 +118,7 @@ export declare abstract class DataContextBase<T> extends DataSource<T> implement
      */
     protected indexAll(items: T[]): void;
     protected getItemKey(item: T): any;
+    protected getItemId(item: T): TId;
     /***************************************************************************
      *                                                                         *
      * Event handler                                                           *

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

@@ -97,7 +97,8 @@ export declare class DataContextBuilder<T> {
      *                                                                         *
      **************************************************************************/
     buildLocal(items: T[], idProperty?: string): IDataContext<T>;
-    buildLocalActivePaged(data: T[], idProperty?: string): IDataContextActivePage<T>;
+    buildLocalActivePaged(items: T[], idProperty?: string): IDataContextActivePage<T>;
+    private localListSource;
     /***************************************************************************
      *                                                                         *
      * Empty Data Builder                                                      *

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

@@ -0,0 +1,31 @@
+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;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(dataContext: IDataContext<T>, dataApi: IDataSource<T>, reloadOnChanges: boolean);
+    /***************************************************************************
+     *                                                                         *
+     * Internal Impl                                                           *
+     *                                                                         *
+     **************************************************************************/
+    protected subscribe(): void;
+    /***************************************************************************
+     *                                                                         *
+     * Private methods                                                         *
+     *                                                                         *
+     **************************************************************************/
+    private handleDataChangeEvent;
+    private isReloadDesirable;
+}

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

@@ -99,11 +99,23 @@ export interface IDataContext<T> {
      */
     close(): void;
     /**
-     * Returns the item by the given index key.
-     * Requires that index functionality is enabled.
+     * 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

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

@@ -0,0 +1,72 @@
+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;
+}

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

@@ -1,3 +1,4 @@
+export * from './indexed-entities';
 export * from './data-context-status';
 export * from './data-context';
 export * from './data-context-base';
@@ -9,5 +10,5 @@ export * from './data-context-active-page';
 export * from './mat-table-data-context-binding';
 export * from './data-context-life-cycle-binding';
 export * from './data-context-auto-starter';
-export * from './data-context-source-auto-reloader';
+export * from './data-context-source-event-binding';
 export * from './data-context-builder';

package/lib/common/data/datasource/data-source-base.d.ts

@@ -0,0 +1,38 @@
+import { IDataSource } from './data-source';
+import { DataSourceChangeEvent } from './data-source-change-event';
+import { Observable } from 'rxjs';
+export declare abstract class DataSourceBase<T> implements IDataSource<T> {
+    protected readonly idProperty: string | null;
+    /***************************************************************************
+     *                                                                         *
+     * Fields                                                                  *
+     *                                                                         *
+     **************************************************************************/
+    private readonly dataChangeEvents$;
+    /***************************************************************************
+     *                                                                         *
+     * Constructor                                                             *
+     *                                                                         *
+     **************************************************************************/
+    constructor(idProperty: string | null);
+    /***************************************************************************
+     *                                                                         *
+     * Properties                                                              *
+     *                                                                         *
+     **************************************************************************/
+    get dataChanged(): Observable<DataSourceChangeEvent<T>>;
+    /***************************************************************************
+     *                                                                         *
+     * Public API                                                              *
+     *                                                                         *
+     **************************************************************************/
+    publishChangeEvent(e: DataSourceChangeEvent<T>): void;
+    getId(entity: T): any;
+    /***************************************************************************
+     *                                                                         *
+     * Abstract methods                                                        *
+     *                                                                         *
+     **************************************************************************/
+    abstract findById(id: any): Observable<T>;
+    abstract findByIds(ids: any[]): Observable<T[]>;
+}

package/lib/common/data/datasource/data-source-change-event.d.ts

@@ -0,0 +1,13 @@
+export declare enum DataSourceChangeType {
+}
+export declare class DataSourceChangeEvent<T, TId = any> {
+    readonly deletedIds: TId[];
+    readonly modified: T[];
+    readonly created: T[];
+    static unknownChanges<T>(): DataSourceChangeEvent<T>;
+    static deleted<TId>(ids: TId[]): DataSourceChangeEvent<any, TId>;
+    static modified<T>(modified: T[]): DataSourceChangeEvent<T>;
+    static created<T>(created: T[]): DataSourceChangeEvent<T>;
+    readonly unknownChanges: boolean;
+    constructor(deletedIds: TId[], modified: T[], created: T[]);
+}

package/lib/common/data/datasource/data-source.d.ts

@@ -4,6 +4,7 @@ import { Filter } from '../filters/filter';
 import { Page, Pageable } from '../page';
 import { TokenChunkRequest } from '../token-chunk-request';
 import { ContinuableListing } from '../continuable-listing';
+import { DataSourceChangeEvent } from './data-source-change-event';
 /***************************************************************************
  *                                                                         *
  * Data Fetcher APIs                                                       *
@@ -27,7 +28,7 @@ export interface IDataSource<T> {
     /**
      * Notifies that this data source has modified elements.
      */
-    readonly dataChanged: Observable<any>;
+    readonly dataChanged: Observable<DataSourceChangeEvent<T>>;
     /**
      * Return the entity with the given Id.
      */

package/lib/common/data/datasource/local/local-list-data-source.d.ts

@@ -2,7 +2,8 @@ import { Filter } from '../../filters/filter';
 import { Sort } from '../../sort';
 import { Observable } from 'rxjs';
 import { IListDataSource } from '../data-source';
-export declare class LocalListDataSource<T> implements IListDataSource<T> {
+import { DataSourceBase } from '../data-source-base';
+export declare class LocalListDataSource<T> extends DataSourceBase<T> implements IListDataSource<T> {
     /***************************************************************************
      *                                                                         *
      * Fields                                                                  *
@@ -10,10 +11,8 @@ export declare class LocalListDataSource<T> implements IListDataSource<T> {
      **************************************************************************/
     private readonly logger;
     private readonly data$;
-    private readonly dataChange$;
     private readonly localSort;
     private readonly localFilter;
-    private readonly idProperty;
     /***************************************************************************
      *                                                                         *
      * Static Builder                                                          *
@@ -39,11 +38,9 @@ export declare class LocalListDataSource<T> implements IListDataSource<T> {
      * IDataSource API                                                         *
      *                                                                         *
      **************************************************************************/
-    get dataChanged(): Observable<any>;
     findById(id: any): Observable<T>;
     findByIds(ids: any[]): Observable<T[]>;
     findAllFiltered(filters?: Filter[], sorts?: Sort[]): Observable<T[]>;
-    getId(entity: T): any;
     /***************************************************************************
      *                                                                         *
      * Public API                                                              *
@@ -56,6 +53,5 @@ export declare class LocalListDataSource<T> implements IListDataSource<T> {
      * Private methods                                                         *
      *                                                                         *
      **************************************************************************/
-    protected onLocalDataChanges(data: T[]): void;
-    private guessIdProperty;
+    private static guessIdProperty;
 }

package/lib/common/data/datasource/local/local-paged-data-source.d.ts

@@ -1,8 +1,10 @@
 import { Page, Pageable } from '../../page';
 import { Filter } from '../../filters/filter';
 import { Observable } from 'rxjs';
+import { LocalListDataSource } from './local-list-data-source';
 import { Sort } from '../../sort';
 import { IPagedDataSource } from '../data-source';
+import { DataSourceChangeEvent } from '../data-source-change-event';
 export declare class LocalPagedDataSource<T> implements IPagedDataSource<T> {
     /***************************************************************************
      *                                                                         *
@@ -23,19 +25,19 @@ export declare class LocalPagedDataSource<T> implements IPagedDataSource<T> {
      * @param localFilter
      */
     static empty<T>(idProperty: string | null, localSort?: ((data: T[], sorts: Sort[]) => T[]), localFilter?: ((data: T[], filters: Filter[]) => T[])): LocalPagedDataSource<T>;
-    static from<T>(localData: T[], idProperty: string | null, localSort?: ((data: T[], sorts: Sort[]) => T[]), localFilter?: ((data: T[], filters: Filter[]) => T[])): LocalPagedDataSource<T>;
+    static of<T>(listDataSource: LocalListDataSource<T>): LocalPagedDataSource<T>;
     /***************************************************************************
      *                                                                         *
      * Constructor                                                             *
      *                                                                         *
      **************************************************************************/
-    constructor(localData: T[], idProperty: string | null, localSort: ((data: T[], sorts: Sort[]) => T[]), localFilter: ((data: T[], filters: Filter[]) => T[]));
+    constructor(listDataSource: LocalListDataSource<T>);
     /***************************************************************************
      *                                                                         *
      * Public API                                                              *
      *                                                                         *
      **************************************************************************/
-    get dataChanged(): Observable<any>;
+    get dataChanged(): Observable<DataSourceChangeEvent<T>>;
     findById(id: any): Observable<T>;
     findByIds(ids: any[]): Observable<T[]>;
     findAllPaged(pageable: Pageable, filters?: Filter[]): Observable<Page<T>>;

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

@@ -1,7 +1,9 @@
 export * from './data-source';
+export * from './data-source-base';
 export * from './data-source-adapter';
 export * from './data-source-processor';
 export * from './rest/public_api';
 export * from './local/local-list-data-source';
 export * from './local/local-paged-data-source';
 export * from './fetcher/delegate-data-source';
+export * from './data-source-change-event';

package/lib/common/data/datasource/rest/rest-client.d.ts

@@ -6,6 +6,7 @@ import { Page, Pageable } from '../../page';
 import { ContinuableListing } from '../../continuable-listing';
 import { TokenChunkRequest } from '../../token-chunk-request';
 import { IContinuableDataSource, IDataSource, IListDataSource, IPagedDataSource } from '../data-source';
+import { DataSourceBase } from '../data-source-base';
 export declare class InternalRestClientConfig {
     idField: string;
     idsParam: string;
@@ -24,7 +25,7 @@ export declare class RestClientConfig {
      */
     idsParam?: string;
 }
-export declare class RestClient<T, TID> implements IDataSource<T> {
+export declare class RestClient<T, TID> extends DataSourceBase<T> implements IDataSource<T> {
     protected readonly restEndpoint: string;
     protected readonly http: HttpClient;
     /***************************************************************************
@@ -33,24 +34,13 @@ export declare class RestClient<T, TID> implements IDataSource<T> {
      *                                                                         *
      **************************************************************************/
     private readonly _logger;
-    private readonly localChangeSubject;
     protected readonly config: InternalRestClientConfig;
     /***************************************************************************
      *                                                                         *
      * Constructor                                                             *
      *                                                                         *
      **************************************************************************/
-    constructor(restEndpoint: string, http: HttpClient, config?: RestClientConfig);
-    /***************************************************************************
-     *                                                                         *
-     * Properties                                                              *
-     *                                                                         *
-     **************************************************************************/
-    get dataChanged(): Observable<T>;
-    /**
-     * @deprecated Use dataChanged
-     */
-    get localChanged(): Observable<T>;
+    constructor(restEndpoint: string, http: HttpClient, config: InternalRestClientConfig);
     /***************************************************************************
      *                                                                         *
      * Public API                                                              *
@@ -63,11 +53,10 @@ export declare class RestClient<T, TID> implements IDataSource<T> {
      */
     save(entity: T, params?: HttpParams): Observable<T>;
     create<TC = T>(newEntity: TC, params?: HttpParams): Observable<T>;
-    update(updatedEntity: T, params?: HttpParams): Observable<T>;
-    updateAll(updatedEntities: T[], params?: HttpParams): Observable<T[]>;
+    update<TEntityUpdate>(update: TEntityUpdate, params?: HttpParams): Observable<T>;
+    updateAll<TEntityUpdate>(updatedEntities: TEntityUpdate[], params?: HttpParams): Observable<T[]>;
     delete(entity: T, params?: HttpParams): Observable<any>;
     deleteAll(entities: T[], params?: HttpParams): Observable<any>;
-    getId(entity: T): TID;
     /***************************************************************************
      *                                                                         *
      * Sub Resource Builder                                                    *
@@ -81,8 +70,11 @@ export declare class RestClient<T, TID> implements IDataSource<T> {
      * Protected methods                                                       *
      *                                                                         *
      **************************************************************************/
-    protected patchInternal<P, R = T>(id: TID, entityPatch: P, params?: HttpParams): Observable<R>;
-    protected patchAllInternal<P, R = T>(entityPatches: P[], params?: HttpParams): Observable<R[]>;
+    protected patchInternal<P>(id: TID, entityPatch: P, params?: HttpParams): Observable<T>;
+    protected patchAllInternal<P>(entityPatches: P[], params?: HttpParams): Observable<T[]>;
+    /**
+     * @deprecated Switch to publishChangeEvent
+     */
     protected onLocalChanged(entity?: T): void;
     protected getEntityUrlBy(entity: T): string;
     protected getEntityUrl(id: TID): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elderbyte/ngx-starter",
-  "version": "15.3.4",
+  "version": "15.4.0",
   "peerDependencies": {
     "@angular/core": "^15.0.0 || ^16.0.0",
     "@angular/common": "^15.0.0 || ^16.0.0",

package/theming/_elder-common.scss

@@ -1,13 +1,19 @@
 @use 'mat-icon-button-size' as icon-button-size;
 
-$xs: 4px;
-$sm: 8px;
-$md: 12px;
-$lg: 16px;
-$xl: 24px;
-$xxl: 32px;
-
-@mixin elder-common-styles {
+@mixin elder-common-styles ($common-sizes) {
+
+  /***************************************************************************
+   *                                                                         *
+   * Common Sizes                                                            *
+   *                                                                         *
+   **************************************************************************/
+
+  $xs: map-get($common-sizes, xs);
+  $sm: map-get($common-sizes, sm);
+  $md: map-get($common-sizes, md);
+  $lg: map-get($common-sizes, lg);
+  $xl: map-get($common-sizes, xl);
+  $xxl:map-get($common-sizes, xxl);
 
   /***************************************************************************
    *                                                                         *

package/theming/_elder-config.scss

@@ -0,0 +1,37 @@
+
+/*
+   Builds an elder-config.
+
+   All arguments are optional which means all, none are only a part of the arguments can be passed.
+   In case no arguments are passed, the default elder-config will be returned.
+
+   @Examples:
+      elder-config.build();                             // returns default config
+      elder-config.build($common-sizes: $custom-sizes); // returns config with custom sizes
+ */
+@function buildConfig($common-sizes: common-sizes()) {
+  @return (
+    common-sizes: $common-sizes
+  );
+}
+
+/*
+  Returns a map of common-sizes.
+ */
+@function common-sizes(
+  $xs: 4px,
+  $sm: 8px,
+  $md: 12px,
+  $lg: 16px,
+  $xl: 24px,
+  $xxl: 32px
+) {
+  @return (
+    xs: $xs,
+    sm: $sm,
+    md: $md,
+    lg: $lg,
+    xl: $xl,
+    xxl: $xxl
+  )
+}