@smallpearl/ngx-helper 0.29.23 → 0.29.26

package/mat-entity-list/src/mat-entity-list.component.d.ts

@@ -1,11 +1,11 @@
-import { HttpClient, HttpContext, HttpContextToken } from '@angular/common/http';
+import { HttpClient, HttpContext, HttpContextToken, HttpParams } from '@angular/common/http';
 import { AfterViewInit, ElementRef, EventEmitter, Injector, OnDestroy, OnInit, QueryList } from '@angular/core';
 import { PageEvent } from '@angular/material/paginator';
 import { MatSort } from '@angular/material/sort';
 import { MatColumnDef, MatTable, MatTableDataSource } from '@angular/material/table';
 import { DomSanitizer } from '@angular/platform-browser';
 import { SPEntityField, SPEntityFieldSpec } from '@smallpearl/ngx-helper/entity-field';
-import { Observable, Subscription } from 'rxjs';
+import { Observable, Subject, Subscription } from 'rxjs';
 import { SPMatEntityListEntityLoaderFn, SPMatEntityListPaginator } from './mat-entity-list-types';
 import * as i0 from "@angular/core";
 export declare class HeaderAlignmentDirective implements AfterViewInit {
@@ -16,6 +16,18 @@ export declare class HeaderAlignmentDirective implements AfterViewInit {
     static ɵfac: i0.ɵɵFactoryDeclaration<HeaderAlignmentDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<HeaderAlignmentDirective, "[headerAlignment]", never, { "headerAlignment": { "alias": "headerAlignment"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
+/**
+ * Represents a request to load entities from the remote. This is used to
+ * compare two requests to determine if they are equal. This is useful to
+ * prevent duplicate requests being sent to the remote.
+ */
+declare class LoadRequest {
+    endpoint: string;
+    params: HttpParams;
+    force: boolean;
+    constructor(endpoint: string, params: HttpParams, force?: boolean);
+    isEqualToAndNotForced(prev: LoadRequest): boolean;
+}
 /**
  * A component to display a list of entities loaded from remote.
  */
@@ -122,6 +134,7 @@ export declare class SPMatEntityListComponent<TEntity extends {
     clientColumnDefs: QueryList<MatColumnDef>;
     contentColumnDefs: MatColumnDef[];
     subs$: Subscription;
+    destroy$: Subject<void>;
     entityCount: import("@angular/core").WritableSignal<number>;
     pageIndex: import("@angular/core").WritableSignal<number>;
     lastFetchedEntitiesCount: import("@angular/core").WritableSignal<number>;
@@ -153,6 +166,12 @@ export declare class SPMatEntityListComponent<TEntity extends {
     ngxHelperConfig: import("@smallpearl/ngx-helper/core").SPNgxHelperConfig;
     fieldConfig: import("@smallpearl/ngx-helper/entity-field").SPEntityFieldConfig;
     entityListConfig: import("./mat-entity-list-types").SPMatEntityListConfig;
+    /**
+     * A signal that can be used to trigger loading of more entities from the
+     * remote. This can be visualized as the event loop of the entity list
+     * component.
+     */
+    loadRequest$: Subject<LoadRequest>;
     endpointChanged: import("@angular/core").EffectRef;
     constructor(http: HttpClient, sanitizer: DomSanitizer, injector: Injector);
     ngOnInit(): void;
@@ -162,7 +181,7 @@ export declare class SPMatEntityListComponent<TEntity extends {
      * Clear all entities in store and reload them from endpoint as if
      * the entities are being loaded for the first time.
      */
-    refresh(): void;
+    refresh(force?: boolean): void;
     addEntity(entity: TEntity): void;
     /**
      * Update an entity with a modified version. Can be used by CRUD UPDATE
@@ -199,7 +218,28 @@ export declare class SPMatEntityListComponent<TEntity extends {
     buildColumns(): void;
     setupSort(): void;
     infiniteScrollLoadNextPage(ev: any): void;
-    loadMoreEntities(): void;
+    loadMoreEntities(forceRefresh?: boolean): void;
+    /**
+     * Creates a LoadRequest object for loading entities using the current state
+     * of the component. Therefore, if the request is for next page of entities,
+     * the LoadRequest object will have the updated page index. However, if
+     * pagination has been reset (refer to refresh()), the LoadRequest object
+     * will be for the first page of data. Note that when 'endpoint' value
+     * changes, the component's pagination state is reset causing a refresh()
+     * to be called, which in turn will create a new LoadRequest object for the
+     * first page of data.
+     * @returns LoadRequest object for the next load request.
+     */
+    private createNextLoadRequest;
+    /**
+     * Does the actual load of entities from the remote or via calling the
+     * entityLoaderFn. This method is the workhorse of the entity list
+     * 'loader-loop'.
+     * @param lr
+     * @returns Observable that emits the response from the remote or from
+     * entityLoaderFn().
+     */
+    private doActualLoad;
     private findArrayInResult;
     handlePageEvent(e: PageEvent): void;
     getUrl(endpoint: string): string;
@@ -207,3 +247,4 @@ export declare class SPMatEntityListComponent<TEntity extends {
     static ɵfac: i0.ɵɵFactoryDeclaration<SPMatEntityListComponent<any, any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SPMatEntityListComponent<any, any>, "sp-mat-entity-list", never, { "entityName": { "alias": "entityName"; "required": true; "isSignal": true; }; "entityNamePlural": { "alias": "entityNamePlural"; "required": false; "isSignal": true; }; "endpoint": { "alias": "endpoint"; "required": false; "isSignal": true; }; "entityLoaderFn": { "alias": "entityLoaderFn"; "required": false; "isSignal": true; }; "columns": { "alias": "columns"; "required": true; "isSignal": true; }; "displayedColumns": { "alias": "displayedColumns"; "required": false; "isSignal": true; }; "pageSize": { "alias": "pageSize"; "required": false; "isSignal": true; }; "idKey": { "alias": "idKey"; "required": false; "isSignal": true; }; "pagination": { "alias": "pagination"; "required": false; "isSignal": true; }; "paginator": { "alias": "paginator"; "required": false; "isSignal": true; }; "sorter": { "alias": "sorter"; "required": false; "isSignal": true; }; "disableSort": { "alias": "disableSort"; "required": false; "isSignal": true; }; "infiniteScrollContainer": { "alias": "infiniteScrollContainer"; "required": false; "isSignal": true; }; "infiniteScrollDistance": { "alias": "infiniteScrollDistance"; "required": false; "isSignal": true; }; "infiniteScrollThrottle": { "alias": "infiniteScrollThrottle"; "required": false; "isSignal": true; }; "infiniteScrollWindow": { "alias": "infiniteScrollWindow"; "required": false; "isSignal": true; }; "httpReqContext": { "alias": "httpReqContext"; "required": false; "isSignal": true; }; "_deferViewInit": { "alias": "_deferViewInit"; "required": false; "isSignal": true; }; }, { "selectEntity": "selectEntity"; }, ["clientColumnDefs"], never, true, never>;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smallpearl/ngx-helper",
-  "version": "0.29.23",
+  "version": "0.29.26",
   "peerDependencies": {
     "@angular/common": "^19.1.0",
     "@angular/core": "^19.1.0",
@@ -54,26 +54,26 @@
       "types": "./entity-field/index.d.ts",
       "default": "./fesm2022/smallpearl-ngx-helper-entity-field.mjs"
     },
-    "./hover-dropdown": {
-      "types": "./hover-dropdown/index.d.ts",
-      "default": "./fesm2022/smallpearl-ngx-helper-hover-dropdown.mjs"
+    "./forms": {
+      "types": "./forms/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-forms.mjs"
+    },
+    "./mat-context-menu": {
+      "types": "./mat-context-menu/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-context-menu.mjs"
     },
     "./locale": {
       "types": "./locale/index.d.ts",
       "default": "./fesm2022/smallpearl-ngx-helper-locale.mjs"
     },
+    "./hover-dropdown": {
+      "types": "./hover-dropdown/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-hover-dropdown.mjs"
+    },
     "./mat-busy-wheel": {
       "types": "./mat-busy-wheel/index.d.ts",
       "default": "./fesm2022/smallpearl-ngx-helper-mat-busy-wheel.mjs"
     },
-    "./mat-context-menu": {
-      "types": "./mat-context-menu/index.d.ts",
-      "default": "./fesm2022/smallpearl-ngx-helper-mat-context-menu.mjs"
-    },
-    "./forms": {
-      "types": "./forms/index.d.ts",
-      "default": "./fesm2022/smallpearl-ngx-helper-forms.mjs"
-    },
     "./mat-entity-crud": {
       "types": "./mat-entity-crud/index.d.ts",
       "default": "./fesm2022/smallpearl-ngx-helper-mat-entity-crud.mjs"
@@ -98,14 +98,14 @@
       "types": "./mat-side-menu-layout/index.d.ts",
       "default": "./fesm2022/smallpearl-ngx-helper-mat-side-menu-layout.mjs"
     },
-    "./mat-tel-input": {
-      "types": "./mat-tel-input/index.d.ts",
-      "default": "./fesm2022/smallpearl-ngx-helper-mat-tel-input.mjs"
-    },
     "./sideload": {
       "types": "./sideload/index.d.ts",
       "default": "./fesm2022/smallpearl-ngx-helper-sideload.mjs"
     },
+    "./mat-tel-input": {
+      "types": "./mat-tel-input/index.d.ts",
+      "default": "./fesm2022/smallpearl-ngx-helper-mat-tel-input.mjs"
+    },
     "./stationary-with-line-items": {
       "types": "./stationary-with-line-items/index.d.ts",
       "default": "./fesm2022/smallpearl-ngx-helper-stationary-with-line-items.mjs"