Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x | /**
* @module module:lib/components/list/list.component
* @description List component module.
* @summary Provides the `ListComponent` which renders collections of data with
* support for infinite scroll, pagination, searching, filtering, custom item
* rendering and refresh events. Use this module's `ListComponent` to display
* lists sourced from models, functions or direct data arrays.
*
* @link {@link ListComponent}
*/
import {
Component,
OnInit,
EventEmitter,
Output,
Input,
HostListener,
OnDestroy,
} from '@angular/core';
import { InfiniteScrollCustomEvent, RefresherCustomEvent, SpinnerTypes } from '@ionic/angular';
import { TranslatePipe } from '@ngx-translate/core';
import {
IonButton,
IonInfiniteScroll,
IonInfiniteScrollContent,
IonItem,
IonLabel,
IonList,
IonRefresher,
IonRefresherContent,
IonSkeletonText,
IonText,
IonThumbnail,
} from '@ionic/angular/standalone';
import { OperationKeys } from '@decaf-ts/db-decorators';
import { Model, Primitives } from '@decaf-ts/decorator-validation';
import { Condition, Observer, Paginator } from '@decaf-ts/core';
import { debounceTime, shareReplay, Subject, takeUntil } from 'rxjs';
import { NgxComponentDirective } from '../../engine/NgxComponentDirective';
import { Dynamic } from '../../engine/decorators';
import { KeyValue, FunctionLike, DecafRepository } from '../../engine/types';
import {
ComponentsTagNames,
DefaultListEmptyOptions,
ListComponentsTypes,
} from '../../engine/constants';
import {
IBaseCustomEvent,
IListItemCustomEvent,
IPaginationCustomEvent,
IFilterQuery,
IFilterQueryItem,
IListEmptyOptions,
} from '../../engine/interfaces';
import { stringToBoolean, formatDate, isValidDate } from '../../utils/helpers';
import { SearchbarComponent } from '../searchbar/searchbar.component';
import { EmptyStateComponent } from '../empty-state/empty-state.component';
import { ComponentRendererComponent } from '../component-renderer/component-renderer.component';
import { PaginationComponent } from '../pagination/pagination.component';
import { FilterComponent } from '../filter/filter.component';
import { Constructor, Metadata } from '@decaf-ts/decoration';
import { ComponentEventNames, UIFunctionLike } from '@decaf-ts/ui-decorators';
/**
* @description A versatile list component that supports various data display modes.
* @summary This component provides a flexible way to display lists of data with support
* for infinite scrolling, pagination, searching, and custom item rendering. It can fetch
* data from various sources including models, functions, or direct data input.
*
* The component supports two main display types:
* 1. Infinite scrolling - Loads more data as the user scrolls
* 2. Pagination - Displays data in pages with navigation controls
*
* Additional features include:
* - Pull-to-refresh functionality
* - Search filtering
* - Empty state customization
* - Custom item rendering
* - Event emission for interactions
*
* @mermaid
* sequenceDiagram
* participant U as User
* participant L as ListComponent
* participant D as Data Source
* participant E as External Components
*
* U->>L: Initialize component
* L->>L: ngOnInit()
* L->>D: Request initial data
* D-->>L: Return data
* L->>L: Process and display data
*
* alt User scrolls (Infinite mode)
* U->>L: Scroll to bottom
* L->>D: Request more data
* D-->>L: Return additional data
* L->>L: Append to existing data
* else User changes page (Paginated mode)
* U->>L: Click page number
* L->>L: handlePaginate()
* L->>D: Request data for page
* D-->>L: Return page data
* L->>L: Replace displayed data
* end
*
* alt User searches
* U->>L: Enter search term
* L->>L: handleSearch()
* L->>D: Filter data by search term
* D-->>L: Return filtered data
* L->>L: Update displayed data
* end
*
* alt User clicks item
* U->>L: Click list item
* L->>L: handleClick()
* L->>E: Emit clickEvent
* end
*
* @example
* <ngx-decaf-list
* [source]="dataSource"
* [limit]="10"
* [type]="'infinite'"
* [showSearchbar]="true"
* (clickEvent)="handleItemClick($event)"
* (refreshEvent)="handleRefresh($event)">
* </ngx-decaf-list>
*
* @extends {NgxBaseComponentDirective}
* @implements {OnInit}
*/
@Dynamic()
@Component({
selector: 'ngx-decaf-list',
templateUrl: './list.component.html',
styleUrls: ['./list.component.scss'],
standalone: true,
imports: [
TranslatePipe,
IonRefresher,
IonButton,
PaginationComponent,
IonList,
IonItem,
IonThumbnail,
IonSkeletonText,
IonLabel,
IonText,
IonRefresherContent,
IonInfiniteScroll,
IonInfiniteScrollContent,
IonThumbnail,
IonSkeletonText,
SearchbarComponent,
EmptyStateComponent,
FilterComponent,
ComponentRendererComponent,
],
host: { '[attr.id]': 'uid' },
})
export class ListComponent extends NgxComponentDirective implements OnInit, OnDestroy {
/**
* @description The display mode for the list component.
* @summary Determines how the list data is loaded and displayed. Options include:
* - INFINITE: Loads more data as the user scrolls (infinite scrolling)
* - PAGINATED: Displays data in pages with navigation controls
*
* @type {ListComponentsTypes}
* @default ListComponentsTypes.INFINITE
* @memberOf ListComponent
*/
@Input()
type: ListComponentsTypes = ListComponentsTypes.PAGINATED;
/**
* @description Controls the visibility of the search bar.
* @summary When set to true, displays a search bar at the top of the list that allows
* users to filter the list items. The search functionality works by filtering the
* existing data or by triggering a new data fetch with search parameters.
*
* @type {boolean}
* @default true
* @memberOf ListComponent
*/
@Input()
showSearchbar: boolean = true;
/**
* @description Controls the visibility of the search bar.
* @summary When set to true, displays a search bar at the top of the list that allows
* users to filter the list items. The search functionality works by filtering the
* existing data or by triggering a new data fetch with search parameters.
*
* @type {boolean}
* @default true
* @memberOf ListComponent
*/
@Input()
searchbarPlaceholder!: string;
/**
* @description Direct data input for the list component.
* @summary Provides a way to directly pass data to the list component instead of
* fetching it from a source. When both data and source are provided, the component
* will use the source to fetch data only if the data array is empty.
*
* @type {KeyValue[] | undefined}
* @default undefined
* @memberOf ListComponent
*/
@Input()
data?: KeyValue[] | undefined = undefined;
/**
* @description The data source for the list component.
* @summary Specifies where the list should fetch its data from. This can be either:
* - A string URL or endpoint identifier
* - A function that returns data when called
* The component will call this source when it needs to load or refresh data.
*
* @type {string | FunctionLike}
* @required
* @memberOf ListComponent
*/
@Input()
source!: string | FunctionLike;
/**
* @description Controls whether more data can be loaded.
* @summary When set to true, the component will allow loading additional data
* through infinite scrolling or pagination. When false, the component will not
* attempt to load more data beyond what is initially displayed.
*
* @type {boolean}
* @default true
* @memberOf ListComponent
*/
@Input()
loadMoreData: boolean = true;
/**
* @description The style of dividing lines between list items.
* @summary Determines how dividing lines appear between list items. Options include:
* - "inset": Lines are inset from the edges
* - "full": Lines extend the full width
* - "none": No dividing lines
*
* @type {"inset" | "full" | "none"}
* @default "full"
* @memberOf ListComponent
*/
@Input()
lines: 'inset' | 'full' | 'none' = 'full';
/**
* @description Controls whether the list has inset styling.
* @summary When set to true, the list will have inset styling with rounded corners
* and margin around the edges. This creates a card-like appearance for the list.
*
* @type {boolean}
* @default false
* @memberOf ListComponent
*/
@Input()
inset: boolean = false;
/**
* @description The threshold for triggering infinite scroll loading.
* @summary Specifies how close to the bottom of the list the user must scroll
* before the component triggers loading of additional data. This is expressed
* as a percentage of the list height.
*
* @type {string}
* @default "15%"
* @memberOf ListComponent
*/
@Input()
scrollThreshold: string = '15%';
/**
* @description The position where new items are added during infinite scrolling.
* @summary Determines whether new items are added to the top or bottom of the list
* when loading more data through infinite scrolling.
*
* @type {"bottom" | "top"}
* @default "bottom"
* @memberOf ListComponent
*/
@Input()
scrollPosition: 'bottom' | 'top' = 'bottom';
/**
* @description Custom text to display during loading operations.
* @summary Specifies the text shown in the loading indicator when the component
* is fetching data. If not provided, a default loading message will be used.
*
* @type {string | undefined}
* @memberOf ListComponent
*/
@Input()
loadingText?: string;
/**
* @description Controls the visibility of the pull-to-refresh feature.
* @summary When set to true, enables the pull-to-refresh functionality that allows
* users to refresh the list data by pulling down from the top of the list.
*
* @type {boolean}
* @default true
* @memberOf ListComponent
*/
@Input()
showRefresher: boolean = true;
/**
* @description Controls the visibility of the create button.
* @summary When set to true, displays a button to create new items in the list.
*
* @type {boolean}
* @default false
* @memberOf ListComponent
*/
@Input()
createButton: boolean = false;
/**
* @description The type of spinner to display during loading operations.
* @summary Specifies the visual style of the loading spinner shown during data
* fetching operations. Uses Ionic's predefined spinner types.
*
* @type {SpinnerTypes}
* @default "circular"
* @memberOf ListComponent
*/
@Input()
loadingSpinner: SpinnerTypes = 'circular';
// /**
// * @description Query parameters for data fetching.
// * @summary Specifies additional query parameters to use when fetching data from
// * the source. This can be provided as a string (JSON) or a direct object.
// *
// * @type {string | KeyValue | undefined}
// * @memberOf ListComponent
// */
// @Input()
// query?: string | KeyValue;
/**
* @description Controls whether the filtering functionality is enabled.
* @summary When set to true, enables the filter component that allows users to create
* complex search criteria with multiple field filters, conditions, and values.
* When false, disables the filter interface entirely.
*
* @type {boolean}
* @default true
* @memberOf ListComponent
*/
@Input()
enableFilter: boolean = true;
/**
* @description Controls whether multiple filter groups can be applied simultaneously.
* @summary When true, the filter component allows users to build compound queries with
* several filter rows. When false, only a single filter row is available.
*
* @type {boolean}
* @default true
* @memberOf ListComponent
*/
@Input()
multipleFilter: boolean = true;
/**
* @description Controls whether sorting functionality is disabled.
* @summary When set to true, disables the sort controls and prevents users from
* changing the sort order or field. The list will maintain its default or
* programmatically set sort configuration without user interaction.
*
* @type {boolean}
* @default false
* @memberOf ListComponent
*/
@Input()
disableSort: boolean = false;
/**
* @description Configuration for the empty state display.
* @summary Customizes how the empty state is displayed when no data is available.
* This includes the title, subtitle, button text, icon, and navigation link.
*
* @type {Partial<IListEmptyOptions>}
* @default {
* title: 'empty.title',
* subtitle: 'empty.subtitle',
* showButton: false,
* icon: 'alert-circle-outline',
* buttonText: 'locale.empty.button',
* link: ''
* }
* @memberOf ListComponent
*/
@Input()
empty: Partial<IListEmptyOptions> = {};
/**
* @description The current page number in paginated mode.
* @summary Tracks which page is currently being displayed when the component
* is in paginated mode. This is used for pagination controls and data fetching.
*
* @type {number}
* @default 1
* @memberOf ListComponent
*/
page: number = 1;
/**
* @description The total number of pages available.
* @summary Stores the calculated total number of pages based on the data size
* and limit. This is used for pagination controls and boundary checking.
*
* @type {number}
* @memberOf ListComponent
*/
pages!: number;
/**
* @description Array used for rendering skeleton loading placeholders.
* @summary Contains placeholder items that are displayed during data loading.
* The length of this array determines how many skeleton items are shown.
*
* @type {string[]}
* @default new Array(2)
* @memberOf ListComponent
*/
skeletonData: string[] = new Array(2);
/**
* @description The processed list items ready for display.
* @summary Stores the current set of items being displayed in the list after
* processing from the raw data source. This may be a subset of the full data
* when using pagination or infinite scrolling.
*
* @type {KeyValue[]}
* @memberOf ListComponent
*/
items!: KeyValue[];
searching: boolean = false;
/**
* @description A paginator object for handling pagination operations.
* @summary Provides a paginator object that can be used to retrieve and navigate
* through data in chunks, reducing memory usage and improving performance.
*
* The paginator object is initialized in the `ngOnInit` lifecycle hook and is
* used to fetch and display data in the pagination component. It is an instance
* of the `Paginator` class from the `@decaf-ts/core` package, which provides
* methods for querying and manipulating paginated data.
*
* @type {Paginator<Model>}
* @memberOf PaginationComponent
*/
paginator!: Paginator<Model> | undefined;
/**
* @description The last page number that was displayed.
* @summary Keeps track of the previously displayed page number, which is useful
* for handling navigation and search operations in paginated mode.
*
* @type {number}
* @default 1
* @memberOf ListComponent
*/
lastPage: number = 1;
/**
* @description Event emitter for item click interactions.
* @summary Emits an event when a list item is clicked. The event includes the data
* of the clicked item, allowing parent components to respond to the interaction.
*
* @type {EventEmitter<KeyValue>}
* @memberOf ListComponent
*/
@Output()
clickEvent: EventEmitter<IListItemCustomEvent | IBaseCustomEvent> = new EventEmitter<
IListItemCustomEvent | IBaseCustomEvent
>();
/**
* @description Subject for debouncing click events.
* @summary Uses RxJS Subject to collect click events and emit them after a debounce
* period. This prevents multiple rapid clicks from triggering multiple events.
*
* @private
* @type {Subject<CustomEvent | IListItemCustomEvent | IBaseCustomEvent>}
* @memberOf ListComponent
*/
private clickItemSubject: Subject<CustomEvent | IListItemCustomEvent | IBaseCustomEvent> =
new Subject<CustomEvent | IListItemCustomEvent | IBaseCustomEvent>();
/**
* @description Initializes a new instance of the ListComponent.
* @summary Creates a new ListComponent and sets up the base component with the appropriate
* component name. This constructor is called when Angular instantiates the component and
* before any input properties are set. It passes the component name to the parent class
* constructor to enable proper localization and component identification.
*
* The constructor is intentionally minimal, with most initialization logic deferred to
* the ngOnInit lifecycle hook. This follows Angular best practices by keeping the constructor
* focused on dependency injection and basic setup, while complex initialization that depends
* on input properties is handled in ngOnInit.
*
* @memberOf ListComponent
*/
constructor() {
super('ListComponent');
}
/**
* @description Initializes the component after Angular sets the input properties.
* @summary Sets up the component by initializing event subscriptions, processing boolean
* inputs, and loading the initial data. This method prepares the component for user
* interaction by ensuring all properties are properly initialized and data is loaded.
*
* @returns {Promise<void>}
*
* @mermaid
* sequenceDiagram
* participant A as Angular Lifecycle
* participant L as ListComponent
* participant D as Data Source
*
* A->>L: ngOnInit()
* L->>L: Set up click event debouncing
* L->>L: Process boolean inputs
* L->>L: Configure component based on inputs
* L->>L: refresh()
* L->>D: Request initial data
* D-->>L: Return data
* L->>L: Process and display data
* L->>L: Configure empty state if needed
* L->>L: initialize()
*
* @memberOf ListComponent
*/
async ngOnInit(): Promise<void> {
this.initialized = false;
this.repositoryObserver = {
refresh: async (...args: unknown[]): Promise<void> => this.handleRepositoryRefresh(...args),
};
// this.router.events.subscribe(async event => {
// if (event instanceof NavigationStart)
// await super.ngOnDestroy();
// });
if (!this.searchbarPlaceholder) this.searchbarPlaceholder = `${this.locale}.search.placeholder`;
this.clickItemSubject
.pipe(debounceTime(100), shareReplay(1), takeUntil(this.destroySubscriptions$))
.subscribe((event) => this.clickEventEmit(event as IListItemCustomEvent | IBaseCustomEvent));
this.repositoryObserverSubject
.pipe(debounceTime(100), shareReplay(1), takeUntil(this.destroySubscriptions$))
.subscribe(([modelInstance, event, uid]) =>
this.handleObserveEvent(modelInstance, event, uid),
);
this.limit = Number(this.limit);
this.start = Number(this.start);
this.enableFilter = stringToBoolean(this.enableFilter);
this.inset = stringToBoolean(this.inset);
this.showRefresher = stringToBoolean(this.showRefresher);
this.loadMoreData = stringToBoolean(this.loadMoreData);
this.showSearchbar = stringToBoolean(this.showSearchbar);
this.disableSort = stringToBoolean(this.disableSort);
if (!this.operations || !this.operations.includes(OperationKeys.CREATE))
this.createButton = false;
Iif (typeof this.item?.['tag'] === 'boolean' && this.item?.['tag'] === true)
this.item['tag'] = ComponentsTagNames.LIST_ITEM as string;
if (!this.initialized) this.parseProps(this);
this.empty = Object.assign({}, DefaultListEmptyOptions, this.empty);
// await this.initialize();
await this.initialize();
await this.refresh();
}
/**
* @description Cleans up resources when the component is destroyed.
* @summary Performs cleanup operations when the component is being removed from the DOM.
* This includes clearing references to models and data to prevent memory leaks.
*
* @returns {Promise<void>}
* @memberOf ListComponent
*/
override async ngOnDestroy(): Promise<void> {
await this.destroy();
}
/**
* @description Releases component resources and unregisters repository observers.
* @summary Invoked by Angular teardown logic to ensure the base directive and any
* attached repositories stop emitting events, preventing memory leaks when the
* list component leaves the DOM.
*
* The method performs the following actions:
* - Delegates to the parent directive's `ngOnDestroy` for shared cleanup
* - Detaches the repository observer when one is registered
* - Catches and logs repository errors to avoid bubbling failures
* - Clears internal references to large objects so they can be garbage collected
*
* @returns {Promise<void>} Resolves when every teardown step completes.
*/
async destroy(): Promise<void> {
await super.ngOnDestroy();
Iif (this._repository && this.repositoryObserver) {
const repo = this._repository as DecafRepository<Model>;
//TODO: fix check observerHandler
const observeHandler = repo['observerHandler'] as { observers: Observer[] } | undefined;
Iif (observeHandler && observeHandler?.observers?.length) {
try {
repo.unObserve(this.repositoryObserver);
} catch (error: unknown) {
this.log.info((error as Error)?.message);
}
}
}
this.data = this.model = this._repository = this.paginator = undefined;
}
/**
* @description Produces the sanitized mapper configuration.
* @summary Merges the component mapper with the primary key metadata and filters
* non-string entries so downstream rendering logic only receives valid bindings.
*
* @protected
* @returns {KeyValue} A mapper object that contains string values mapped to the
* component's public keys.
*/
protected async getMapper(): Promise<KeyValue> {
this.mapper = { ...this.mapper, ...{ uid: this.pk } };
const mapper = {} as KeyValue;
for (const [key, value] of Object.entries(this.mapper as Record<string, unknown>)) {
Iif (typeof value === Primitives.STRING) {
mapper[key] = value;
continue;
}
const mapperFn = (value as KeyValue)?.['valueParserFn'] || undefined;
Iif (typeof mapperFn === 'function') {
const value = await mapperFn(this, key);
Iif (typeof value === Primitives.STRING) {
mapper[value] = key;
}
}
}
return mapper;
}
/**
* @description Refreshes the list data from the configured source.
* @summary This method handles both initial data loading and subsequent refresh operations,
* including pull-to-refresh and infinite scrolling. It manages the data fetching process,
* updates the component's state, and handles pagination or infinite scrolling logic based
* on the component's configuration.
*
* The method performs the following steps:
* 1. Sets the refreshing flag to indicate a data fetch is in progress
* 2. Calculates the appropriate start and limit values based on pagination settings
* 3. Fetches data from the appropriate source (model or request)
* 4. Updates the component's data and emits a refresh event
* 5. Handles pagination or infinite scrolling state updates
* 6. Completes any provided event (like InfiniteScrollCustomEvent)
*
* @param {InfiniteScrollCustomEvent | RefresherCustomEvent | boolean} event - The event that triggered the refresh,
* or a boolean flag indicating if this is a forced refresh
* @returns {Promise<void>} A promise that resolves when the refresh operation is complete
*
* @mermaid
* sequenceDiagram
* participant L as ListComponent
* participant D as Data Source
* participant E as Event System
*
* L->>L: refresh(event)
* L->>L: Set refreshing flag
* L->>L: Calculate start and limit
* alt Using model
* L->>D: getFromModel(force, start, limit)
* D-->>L: Return data
* else Using request
* L->>D: getFromRequest(force, start, limit)
* D-->>L: Return data
* end
* L->>E: refreshEventEmit()
* alt Infinite scrolling mode
* L->>L: Check if reached last page
* alt Last page reached
* L->>L: Complete scroll event
* L->>L: Disable loadMoreData
* else More pages available
* L->>L: Increment page number
* L->>L: Complete scroll event after delay
* end
* else Paginated mode
* L->>L: Clear refreshing flag after delay
* end
*
* @memberOf ListComponent
*/
override async refresh(
event: InfiniteScrollCustomEvent | RefresherCustomEvent | boolean = false,
): Promise<void> {
// if (typeof force !== 'boolean' && force.type === ComponentEventNames.BackButtonClickEvent) {
// const {refresh} = (force as CustomEvent).detail;
// if (!refresh)
// return false;
// }
this.refreshing = true;
const start: number = this.page > 1 ? (this.page - 1) * this.limit : this.start;
const limit: number = this.page * (this.limit > 12 ? 12 : this.limit);
this.data = !this.model
? await this.getFromRequest(!!event, start, limit)
: ((await this.getFromModel(!!event)) as KeyValue[]);
this.refreshEventEmit(this.data);
Iif (this.type === ListComponentsTypes.INFINITE) {
if (this.page === this.pages) {
Iif ((event as InfiniteScrollCustomEvent)?.target)
(event as InfiniteScrollCustomEvent).target.complete();
this.loadMoreData = false;
} else {
this.page += 1;
this.refreshing = false;
setTimeout(() => {
Iif (
(event as InfiniteScrollCustomEvent)?.target &&
(event as CustomEvent)?.type !== ComponentEventNames.BackButtonClickEvent
)
(event as InfiniteScrollCustomEvent).target.complete();
}, 200);
}
} else {
setTimeout(() => {
this.refreshing = false;
}, 200);
}
}
/**
* @description Handles specific repository events and updates the list accordingly.
* @summary Processes repository change events (CREATE, UPDATE, DELETE) and performs
* the appropriate list operations. This includes adding new items, updating existing
* ones, or removing deleted items from the list display.
*
* @param {UIFunctionLike} clazz - The model instance that changed
* @param {OperationKeys} event - The type of operation (CREATE, UPDATE, DELETE)
* @param {string | number} uid - The unique identifier of the affected item
* @returns {Promise<void>}
* @memberOf ListComponent
*/
override async handleObserveEvent(
clazz: UIFunctionLike,
event: OperationKeys,
uid: string | number,
): Promise<void> {
if (event === OperationKeys.CREATE) {
if (uid) {
await this.handleCreate(uid);
} else {
await this.refresh(true);
}
} else {
Iif (event === OperationKeys.UPDATE) await this.handleUpdate(uid);
Iif (event === OperationKeys.DELETE) this.handleDelete(uid);
this.refreshEventEmit();
}
}
/**
* @description Function for tracking items in the list.
* @summary Provides a tracking function for the `*ngFor` directive in the component template.
* This function is used to identify and control the rendering of items in the list,
* preventing duplicate or unnecessary rendering.
*
* The `trackItemFn` function takes two parameters: `index` (the index of the item in the list)
* and `item` (the actual item from the list). It returns the tracking key, which in this case
* is the union of the `uid` of the item with the model name.
*
* @param {number} index - The index of the item in the list.
* @param {KeyValue | string | number} item - The actual item from the list.
* @returns {string | number} The tracking key for the item.
* @memberOf ListComponent
*/
override trackItemFn(index: number, item: KeyValue | string | number): string | number {
return `${(item as KeyValue)?.['uid'] || (item as KeyValue)?.[this.pk]}-${index}`;
}
/**
* Handles the create event from the repository.
*
* @param {string | number} uid - The ID of the item to create.
* @returns {Promise<void>} A promise that resolves when the item is created and added to the list.
*/
async handleCreate(uid: string | number): Promise<void> {
const result = await this._repository?.read(uid);
const item = (await this.mapResults([result as KeyValue]))[0];
this.items = this.data = [item, ...(this.items || [])];
}
/**
* @description Handles the update event from the repository.
* @summary Updates the list item with the specified ID based on the new data.
*
* @param {string | number} uid - The ID of the item to update
* @returns {Promise<void>}
* @private
* @memberOf ListComponent
*/
async handleUpdate(uid: string | number): Promise<void> {
const item = await this._repository?.read(uid);
// const item: KeyValue = this.itemMapper((await this._repository?.read(uid)) || {}, this.mapper);
this.data = [];
this.changeDetectorRef.detectChanges();
for (const key in this.items as KeyValue[]) {
const child = this.items[key] as KeyValue;
Iif (`${child['uid']}`.trim() === `${uid}`.trim()) {
this.items[key] = Object.assign({}, child, this.itemMapper(item || {}, this.mapper), {
model: item || {},
});
break;
}
}
this.data = [...this.items];
this.changeDetectorRef.detectChanges();
}
/**
* @description Removes an item from the list by ID.
* @summary Filters out an item with the specified ID from the data array and
* refreshes the list display. This is typically used after a delete operation.
*
* @param {string} uid - The ID of the item to delete
* @param {string} pk - The primary key field name
* @returns {Promise<void>}
*
* @memberOf ListComponent
*/
handleDelete(uid: string | number, pk?: string): void {
Iif (!pk) pk = this.pk;
this.items = [...(this.data?.filter((item: KeyValue) => item['uid'] !== uid) || [])];
this.data = [...this.items];
Iif (!this.data.length) {
this.searchValue = undefined;
this.page = 1;
this.searching = false;
}
this.changeDetectorRef.detectChanges();
}
/**
* @description Handles click events from list items.
* @summary Listens for global ListItemClickEvent events and passes them to the
* debounced click subject. This allows the component to respond to clicks on
* list items regardless of where they originate from.
*
* @param {IListItemCustomEvent | IBaseCustomEvent} event - The click event
* @returns {Promise<void>}
*
* @memberOf ListComponent
*/
@HostListener('window:ListItemClickEvent', ['$event'])
async handleClick(event: IListItemCustomEvent | IBaseCustomEvent): Promise<void> {
this.clickItemSubject.next(event);
}
/**
* @description Handles search events from the search bar.
* @summary Processes search queries from the search bar component, updating the
* displayed data based on the search term. The behavior differs between infinite
* and paginated modes to provide the best user experience for each mode.
*
* @param {string | undefined} value - The search term or undefined to clear search
* @returns {Promise<void>}
*
* @mermaid
* flowchart TD
* A[Search Event] --> B{Type is Infinite?}
* B -->|Yes| C[Disable loadMoreData]
* B -->|No| D[Enable loadMoreData]
* C --> E{Search value undefined?}
* E -->|Yes| F[Enable loadMoreData]
* E -->|No| G[Store search value]
* D --> G
* F --> H[Reset page to 1]
* G --> I[Refresh data]
* H --> I
*
* @memberOf ListComponent
*/
@HostListener('window:searchbarEvent', ['$event'])
async handleSearch(value: string | IFilterQuery | undefined): Promise<void> {
this.searching = value !== undefined;
if (this.type === ListComponentsTypes.INFINITE) {
this.loadMoreData = false;
Iif (value === undefined) {
this.loadMoreData = true;
this.page = 1;
this.items = [];
}
Iif (this.isModalChild) this.changeDetectorRef.detectChanges();
this.searchValue = value;
await this.refresh(true);
} else {
this.loadMoreData = true;
this.searchValue = value;
Iif (value === undefined) this.page = this.lastPage;
await this.refresh(true);
}
}
/**
* @description Handles filter events from the filter component.
* @summary Processes filter queries from the filter component and applies them
* to the list data. This method acts as a bridge between the filter component
* and the search functionality, converting filter queries into search operations.
*
* @param {IFilterQuery | undefined} value - The filter query object or undefined to clear filters
* @returns {Promise<void>}
* @memberOf ListComponent
*/
async handleFilter(value: IFilterQuery | undefined): Promise<void> {
await this.handleSearch(value);
}
/**
* @description Clears the current search and resets the list.
* @summary Convenience method that clears the search by calling handleSearch
* with undefined. This resets the list to show all data without filtering.
*
* @returns {Promise<void>}
* @memberOf ListComponent
*/
async clearSearch(): Promise<void> {
await this.handleSearch(undefined);
Iif (this.isModalChild) this.changeDetectorRef.detectChanges();
}
/**
* @description Emits a refresh event with the current data.
* @summary Creates and emits a refresh event containing the current list data.
* This notifies parent components that the list data has been refreshed.
*
* @param {KeyValue[]} [data] - Optional data to include in the event
* @returns {void}
*
* @memberOf ListComponent
*/
refreshEventEmit(data?: KeyValue[]): void {
Iif (!data) data = this.items;
this.skeletonData = new Array(1);
// Avoid emitting refresh events when the component is a child of a modal to prevent
if (!this.isModalChild) {
this.refreshEvent.emit({
name: ComponentEventNames.Refresh,
data: data || [],
component: this.componentName,
});
}
}
/**
* @description Emits a click event for a list item.
* @summary Processes and emits a click event when a list item is clicked.
* This extracts the relevant data from the event and passes it to parent components.
*
* @private
* @param {IListItemCustomEvent | IBaseCustomEvent} event - The click event
* @returns {void}
*
* @memberOf ListComponent
*/
private clickEventEmit(event: IListItemCustomEvent | IBaseCustomEvent): void {
this.clickEvent.emit(event);
}
/**
* @description Handles pagination events from the pagination component.
* @summary Processes pagination events by updating the current page number and
* refreshing the list data to display the selected page. This method is called
* when a user interacts with the pagination controls to navigate between pages.
*
* @param {IPaginationCustomEvent} event - The pagination event containing page information
* @returns {Promise<void>}
*
* @memberOf ListComponent
*/
async handlePaginate(event: IPaginationCustomEvent | number): Promise<void> {
this.page = typeof event === 'number' ? event : event.data?.page;
await this.refresh(true);
}
/**
* @description Handles pull-to-refresh events from the refresher component.
* @summary Processes refresh events triggered by the user pulling down on the list
* or by programmatic refresh requests. This method refreshes the list data and
* completes the refresher animation when the data is loaded.
*
* @param {InfiniteScrollCustomEvent | CustomEvent} [event] - The refresh event
* @returns {Promise<void>} A promise that resolves when the refresh operation is complete
*
* @memberOf ListComponent
*/
async handleRefresh(event?: InfiniteScrollCustomEvent | CustomEvent): Promise<void> {
await this.refresh((event as InfiniteScrollCustomEvent) || true);
Iif (event instanceof CustomEvent)
setTimeout(() => {
// Any calls to load data go here
(event.target as HTMLIonRefresherElement).complete();
}, 400);
}
/**
* @description Filters data based on a search string.
* @summary Processes the current data array to find items that match the provided
* search string. This uses the arrayQueryByString utility to perform the filtering
* across all properties of the items.
*
* @param {KeyValue[]} results - The array of items to search through
* @param {string} search - The search string to filter by
* @returns {KeyValue[]} A promise that resolves to the filtered array of items
*
* @memberOf ListComponent
*/
parseSearchResults(results: KeyValue[], search: string): KeyValue[] {
const filtered = results.filter((item: KeyValue) =>
Object.values(item).some((v) => {
Iif (`${v}`.toLowerCase().includes((search as string)?.toLowerCase())) return v;
}),
);
return filtered;
}
/**
* @description Fetches data from a request source.
* @summary Retrieves data from the configured source function or URL, processes it,
* and updates the component's data state. This method handles both initial data loading
* and subsequent refresh operations when using an external data source rather than a model.
*
* @param {boolean} force - Whether to force a refresh even if data already exists
* @param {number} start - The starting index for pagination
* @param {number} limit - The maximum number of items to retrieve
* @returns {Promise<KeyValue[]>} A promise that resolves to the fetched data
*
* @memberOf ListComponent
*/
async getFromRequest(force: boolean = false, start: number, limit: number): Promise<KeyValue[]> {
let data: KeyValue[] = [...(this.data || [])];
if (
!this.data?.length ||
force ||
(this.searchValue as string)?.length ||
!!(this.searchValue as IFilterQuery)
) {
// (self.data as ListItem[]) = [];
if (!(this.searchValue as string)?.length && !(this.searchValue as IFilterQuery)) {
if (!this.source && !this.data?.length) {
this.log.info('No data and source passed to infinite list');
return [];
}
Iif (this.source instanceof Function) {
data = (await this.source()) as KeyValue[];
Iif (!Array.isArray(data)) data = data?.['response']?.['data'] || data?.['results'] || [];
}
Iif (!data?.length && this.data?.length) data = this.data as KeyValue[];
data = [...(await this.parseResult(data))];
Iif (this.data?.length)
data =
this.type === ListComponentsTypes.INFINITE
? [...(this.items || []).concat([...data.slice(start, limit)])]
: [...(data.slice(start, limit) as KeyValue[])];
} else E{
data = await this.parseResult(
this.parseSearchResults(this.data as [], this.searchValue as string),
);
}
this.items = [...data];
Iif (this.isModalChild) this.changeDetectorRef.detectChanges();
} else E{
const data = [...(await this.parseResult(this.data as []))];
this.items =
this.type === ListComponentsTypes.INFINITE
? [...(this.items || []), ...(data || [])]
: [...(data || [])];
Iif (this.isModalChild) this.changeDetectorRef.detectChanges();
}
Iif (this.loadMoreData && this.type === ListComponentsTypes.PAGINATED)
this.getMoreData(this.data?.length || 0);
return this.data || ([] as KeyValue[]);
}
/**
* @description Fetches data from a model source.
* @summary Retrieves data from the configured model using its pagination or find methods,
* processes it, and updates the component's data state. This method handles both initial
* data loading and subsequent refresh operations when using a model as the data source.
*
* @param {boolean} force - Whether to force a refresh even if data already exists
* @param {number} start - The starting index for pagination
* @param {number} limit - The maximum number of items to retrieve
* @returns {Promise<KeyValue[]>} A promise that resolves to the fetched data
*
* @memberOf ListComponent
*/
async getFromModel(force: boolean = false): Promise<KeyValue[]> {
let data = [...(this.data || [])];
let request: KeyValue[] = [];
Iif (!this._repository) {
this._repository = this.repository;
}
Iif (!this.repositoryObserver) {
this.repositoryObserver = {
refresh: async (...args) => this.handleRepositoryRefresh(...args),
};
}
try {
// const observerHandler = (this._repository as DecafRepository<Model>)['observerHandler'];
// if (!observerHandler)
// (this._repository as DecafRepository<Model>).observe(this.repositoryObserver);
const observerHandler = (this._repository as DecafRepository<Model>)['observerHandler'] as
| { observers: Observer[] }
| undefined;
Iif (!observerHandler?.observers?.length)
(this._repository as DecafRepository<Model>).observe(this.repositoryObserver);
} catch (error: unknown) {
this.log.info((error as Error)?.message);
}
const repo = this._repository as DecafRepository<Model>;
Iif (!this.indexes) {
this.indexes = Object.keys(Model.indexes(this.model as Model) || {});
}
Iif (
!this.data?.length ||
force ||
(this.searchValue as string)?.length ||
!!(this.searchValue as IFilterQuery)
) {
try {
if (!(this.searchValue as string)?.length && !(this.searchValue as IFilterQuery)) {
(this.data as KeyValue[]) = [];
// const rawQuery = this.parseQuery(self.model as Repository<Model>, start, limit);
// request = this.parseResult(await (this.model as any)?.paginate(start, limit));
Iif (!this.paginator) {
this.paginator = await this.paginate();
}
request = await this.parseResult(this.paginator as Paginator<Model>);
} else {
this.changeDetectorRef.detectChanges();
request = await this.parseResult(
await repo
.select()
.where(this.parseConditions(this.searchValue as string | number | IFilterQuery))
.orderBy((this.sortBy || this.pk) as keyof Model, this.sortDirection)
.execute(),
);
data = [];
this.changeDetectorRef.detectChanges();
}
data =
this.type === ListComponentsTypes.INFINITE ? [...data.concat(request)] : [...request];
} catch (error: unknown) {
this.log.error(
(error as Error)?.message ||
`Unable to find ${this.model} on registry. Return empty array from component`,
);
}
}
Iif (data?.length) {
if (this.searchValue) {
this.items = [...data];
Iif (this.items?.length <= this.limit) this.loadMoreData = false;
} else {
this.items = [...data];
}
}
Iif (this.type === ListComponentsTypes.PAGINATED && this.paginator && !this.pages)
this.getMoreData(this.paginator.total);
return data || ([] as KeyValue[]);
}
/**
* @description Converts search values or filter queries into database conditions.
* @summary Transforms search input or complex filter queries into Condition objects
* that can be used for database querying. Handles both simple string/number searches
* across indexed fields and complex filter queries with multiple criteria.
*
* For simple searches (string/number):
* - Creates conditions that search across all indexed fields
* - Uses equality for numeric values and regex for string values
* - Combines conditions with OR logic to search multiple fields
*
* For complex filter queries:
* - Processes each filter item with its specific condition type
* - Supports Equal, Not Equal, Contains, Not Contains, Greater Than, Less Than
* - Updates sort configuration based on the filter query
* - Combines multiple filter conditions with OR logic
*
* @param {string | number | IFilterQuery} value - The search value or filter query object
* @returns {Condition<Model>} A Condition object for database querying
* @memberOf ListComponent
*/
parseConditions(value: string | number | IFilterQuery): Condition<Model> {
let _condition: Condition<Model>;
const model = this.model as Model;
if (typeof value === Primitives.STRING) {
_condition = Condition.attribute<Model>(this.pk as keyof Model).eq(
this.pkType.toLocaleLowerCase() === Primitives.STRING ? value : Number(value),
);
for (const index of this.indexes as (keyof Model)[]) {
Iif (index === this.pk) continue;
let orCondition;
if (!isNaN(value as number)) {
orCondition = Condition.attribute<Model>(index).eq(Number(value));
} else {
const type = Metadata.type(model.constructor as Constructor<Model>, index).name;
orCondition =
type === Date
? Condition.attribute<Model>(index).eq(new Date(value as string))
: Condition.attribute<Model>(index).regexp(value as string);
}
_condition = _condition.or(orCondition);
}
} else {
const { query, sort } = value as IFilterQuery;
const pk = this.pk as keyof Model;
_condition = Condition.attribute<Model>(pk).dif('null');
Iif (query?.length) _condition = undefined as unknown as Condition<Model>;
(query || []).forEach((item: IFilterQueryItem) => {
const { value, condition, index } = item;
let val = value as string | number | Date;
Iif (index === this.pk || !isNaN(val as number)) {
val = Number(val);
}
const type = Metadata.type(
model.constructor as Constructor<Model>,
index as keyof Model,
).name;
Iif (type === Date.name) {
val = new Date(val as string);
}
let orCondition;
switch (condition) {
case 'Equal':
orCondition = Condition.attribute<Model>(index as keyof Model).eq(val);
break;
case 'Not Equal':
orCondition = Condition.attribute<Model>(index as keyof Model).dif(val);
break;
case 'Not Contains':
orCondition = !Condition.attribute<Model>(index as keyof Model).regexp(
new RegExp(`^(?!.*${val}).*$`),
);
break;
case 'Contains':
orCondition = Condition.attribute<Model>(index as keyof Model).regexp(val as string);
break;
case 'Greater Than':
orCondition = Condition.attribute<Model>(index as keyof Model).gte(val);
break;
case 'Less Than':
orCondition = Condition.attribute<Model>(index as keyof Model).lte(val);
break;
}
_condition = (
!_condition ? orCondition : _condition.and(orCondition as unknown as Condition<Model>)
) as Condition<Model>;
});
this.sortBy = (sort?.value as keyof Model) || this.pk;
this.sortDirection = sort?.direction || this.sortDirection;
}
return _condition as Condition<Model>;
}
/**
* @description Processes query results into a standardized format.
* @summary Handles different result formats from various data sources, extracting
* pagination information when available and applying any configured data mapping.
* This ensures consistent data structure regardless of the source.
*
* @protected
* @param {KeyValue[] | Paginator} result - The raw query result
* @returns {KeyValue[]} The processed array of items
*
* @memberOf ListComponent
*/
protected async parseResult(result: KeyValue[] | Paginator<Model>): Promise<KeyValue[]> {
if (!Array.isArray(result) && 'page' in result && 'total' in result) {
const paginator = result as Paginator<Model>;
try {
result = await paginator.page(this.page);
this.getMoreData(paginator.total || this.pages);
} catch (error: unknown) {
this.log.info(
(error as Error)?.message ||
'Unable to get page from paginator. Return empty array from component',
);
result = [];
}
} else {
this.getMoreData((result as KeyValue[])?.length || 0);
}
return Object.keys(this.mapper || {}).length ? await this.mapResults(result) : result;
}
/**
* @description Updates pagination state based on data length.
* @summary Calculates whether more data is available and how many pages exist
* based on the total number of items and the configured limit per page.
* This information is used to control pagination UI and infinite scrolling behavior.
*
* @param {number} length - The total number of items available
* @returns {void}
*
* @memberOf ListComponent
*/
getMoreData(length: number): void {
if (this.type === ListComponentsTypes.INFINITE) {
Iif (this.paginator) length = length * this.limit;
if (length <= this.limit) {
this.loadMoreData = false;
} else {
this.pages = Math.floor(length / this.limit);
Iif (this.pages * this.limit < length) this.pages += 1;
Iif (this.pages === 1) this.loadMoreData = false;
}
} else {
this.pages = length;
Iif (this.pages === 1) this.loadMoreData = false;
}
}
/**
* @description Maps a single item using the configured mapper.
* @summary Transforms a data item according to the mapping configuration,
* extracting nested properties and formatting values as needed. This allows
* the component to display data in a format different from how it's stored.
*
* @protected
* @param {KeyValue} item - The item to map
* @param {KeyValue} mapper - The mapping configuration
* @param {KeyValue} [props] - Additional properties to include
* @returns {KeyValue} The mapped item
*
* @memberOf ListComponent
*/
protected itemMapper(item: KeyValue, mapper: KeyValue, props?: KeyValue): KeyValue {
return Object.entries(mapper).reduce((accum: KeyValue, [key, value]) => {
const arrayValue = value.split('.');
if (!value) {
accum[key] = value;
} else {
if (arrayValue.length === 1) {
value = item?.[value] ? item[value] : '';
// value = item?.[value] ? item[value] : value !== key ? value : "";
Iif (isValidDate(value)) value = `${formatDate(value)}`;
accum[key] = value;
} else {
let val;
for (const _value of arrayValue)
val = !val
? item[_value]
: (typeof val === Primitives.STRING ? JSON.parse(val) : val)[_value];
Iif (isValidDate(new Date(val))) val = `${formatDate(val)}`;
accum[key] = val === null || val === undefined ? value : val;
}
}
return Object.assign({}, props || {}, accum);
}, {});
}
/**
* @description Maps all result items using the configured mapper.
* @summary Applies the itemMapper to each item in the result set, adding
* common properties like operations and route information. This transforms
* the raw data into the format expected by the list item components.
*
* @param {KeyValue[]} data - The array of items to map
* @returns {KeyValue[]} The array of mapped items
*
* @memberOf ListComponent
*/
async mapResults(data: KeyValue[]): Promise<KeyValue[]> {
Iif (!data || !data.length) return [];
this.mapper = await this.getMapper();
const props = Object.assign({
operations: this.operations,
route: this.route,
...Object.keys(this.item).reduce((acc: KeyValue, key: string) => {
acc[key] = this.item[key];
return acc;
}, {}),
});
return data.reduce((accum: KeyValue[], curr) => {
accum.push({
...this.itemMapper(curr, this.mapper as KeyValue, props),
...{
pk: this.pk,
model: curr,
isModalChild: this.isModalChild,
emitEvent: props.emitEvent,
},
});
return accum;
}, []);
}
parseSearchValue() {
Iif (typeof this.searchValue === Primitives.STRING) return this.searchValue || '';
const searchValue = this.searchValue as IFilterQuery;
Iif (searchValue?.query === undefined) return (this.searchValue = '');
return (searchValue?.query as IFilterQueryItem[])
.map((item) => `${item.index} ${item.condition} ${item.value}`)
.join(', ');
}
}
|