@memberjunction/ng-entity-viewer 2.133.0 → 3.0.0

package/dist/lib/entity-grid/entity-grid.component.d.ts

@@ -0,0 +1,216 @@
+import { EventEmitter, OnChanges, OnInit, SimpleChanges } from '@angular/core';
+import { EntityInfo } from '@memberjunction/core';
+import { BaseEntity } from '@memberjunction/core';
+import { ColDef, GridReadyEvent, RowClickedEvent, RowDoubleClickedEvent, RowSelectionOptions, GetRowIdParams, SortChangedEvent as AgSortChangedEvent, ColumnResizedEvent, ColumnMovedEvent } from 'ag-grid-community';
+import { GridColumnDef, RecordSelectedEvent, RecordOpenedEvent, SortState, SortChangedEvent, ViewGridStateConfig, GridStateChangedEvent } from '../types';
+import * as i0 from "@angular/core";
+/**
+ * EntityGridComponent - AG Grid based table view for entity records
+ *
+ * This component provides a lightweight, customizable grid view for displaying
+ * entity records. It uses AG Grid Community edition for high-performance rendering.
+ *
+ * Supports two modes:
+ * 1. Parent-managed data: Records are passed in via [records] input
+ * 2. Standalone: Component loads its own data with pagination
+ *
+ * @example
+ * ```html
+ * <mj-entity-grid
+ *   [entity]="selectedEntity"
+ *   [records]="filteredRecords"
+ *   [selectedRecordId]="selectedId"
+ *   [sortState]="currentSort"
+ *   [serverSideSorting]="true"
+ *   (recordSelected)="onRecordSelected($event)"
+ *   (recordOpened)="onRecordOpened($event)"
+ *   (sortChanged)="onSortChanged($event)">
+ * </mj-entity-grid>
+ * ```
+ */
+export declare class EntityGridComponent implements OnInit, OnChanges {
+    /**
+     * The entity metadata for the records being displayed
+     */
+    entity: EntityInfo | null;
+    /**
+     * The records to display in the grid (optional - component can load its own)
+     */
+    records: BaseEntity[] | null;
+    /**
+     * The currently selected record's primary key string
+     */
+    selectedRecordId: string | null;
+    /**
+     * Custom column definitions (optional - auto-generated if not provided)
+     */
+    columns: GridColumnDef[];
+    /**
+     * Height of the grid (CSS value)
+     * @default '100%'
+     */
+    height: string;
+    /**
+     * Whether to enable row selection
+     * @default true
+     */
+    enableSelection: boolean;
+    /**
+     * Filter text for highlighting matches in cells
+     * Supports SQL-style % wildcards
+     */
+    filterText: string;
+    /**
+     * Current sort state (for external control)
+     */
+    sortState: SortState | null;
+    /**
+     * Whether sorting is handled server-side
+     * When true, sort changes emit events but don't sort locally
+     * @default true
+     */
+    serverSideSorting: boolean;
+    /**
+     * Page size for standalone data loading
+     * @default 100
+     */
+    pageSize: number;
+    /**
+     * Grid state from a User View - controls columns, widths, order, sort
+     * When provided, this takes precedence over auto-generated columns
+     */
+    gridState: ViewGridStateConfig | null;
+    /**
+     * Emitted when a record is selected (single click)
+     */
+    recordSelected: EventEmitter<RecordSelectedEvent>;
+    /**
+     * Emitted when a record should be opened (double click)
+     */
+    recordOpened: EventEmitter<RecordOpenedEvent>;
+    /**
+     * Emitted when sort state changes
+     */
+    sortChanged: EventEmitter<SortChangedEvent>;
+    /**
+     * Emitted when grid state changes (column resize, reorder, etc.)
+     */
+    gridStateChanged: EventEmitter<GridStateChangedEvent>;
+    /** AG Grid column definitions */
+    columnDefs: ColDef[];
+    /** AG Grid row data */
+    rowData: Record<string, unknown>[];
+    /** AG Grid API reference */
+    private gridApi;
+    /** Internal records when loading standalone */
+    private internalRecords;
+    /** Track if we're in standalone mode (no external records provided) */
+    private standaloneMode;
+    /** Loading state for standalone mode */
+    isLoading: boolean;
+    /** Suppress sort changed events during programmatic sort updates */
+    private suppressSortEvents;
+    /** Default column settings */
+    defaultColDef: ColDef;
+    /** AG Grid theme (v34+) */
+    theme: import("ag-grid-community").Theme<import("ag-grid-community").ThemeDefaultParams>;
+    /** Row selection configuration (v34+ object-based API) */
+    rowSelection: RowSelectionOptions;
+    /** Get row ID function for AG Grid */
+    getRowId: (params: GetRowIdParams<Record<string, unknown>>) => string;
+    ngOnInit(): void;
+    ngOnChanges(changes: SimpleChanges): void;
+    /**
+     * Get effective records (external or internal)
+     */
+    private get effectiveRecords();
+    /**
+     * Load data in standalone mode
+     */
+    private loadData;
+    /**
+     * Handle AG Grid ready event
+     */
+    onGridReady(event: GridReadyEvent): void;
+    /**
+     * Handle AG Grid sort changed event
+     */
+    onGridSortChanged(event: AgSortChangedEvent): void;
+    /**
+     * Handle column resized event
+     */
+    onColumnResized(event: ColumnResizedEvent): void;
+    /**
+     * Handle column moved event
+     */
+    onColumnMoved(event: ColumnMovedEvent): void;
+    /**
+     * Emit grid state changed event with current column/sort state
+     */
+    private emitGridStateChanged;
+    /**
+     * Build current grid state from AG Grid's column state
+     */
+    private buildCurrentGridState;
+    /**
+     * Apply external sort state to the grid
+     */
+    private applySortStateToGrid;
+    /**
+     * Handle row click event
+     */
+    onRowClicked(event: RowClickedEvent): void;
+    /**
+     * Handle row double-click event
+     */
+    onRowDoubleClicked(event: RowDoubleClickedEvent): void;
+    /**
+     * Build AG Grid column definitions from gridState, custom columns, or entity metadata
+     * Priority: gridState > custom columns > auto-generated
+     */
+    private buildColumnDefs;
+    /**
+     * Build column definitions from gridState column settings
+     */
+    private buildColumnDefsFromGridState;
+    /**
+     * Map custom column definition to AG Grid ColDef
+     */
+    private mapCustomColumnDef;
+    /**
+     * Auto-generate column definitions from entity metadata
+     */
+    private generateColumnDefs;
+    /**
+     * Cell renderer that highlights matching text
+     * Uses HighlightUtil which only highlights if the text actually matches the pattern
+     */
+    private highlightCellRenderer;
+    /**
+     * Determine if a field should be shown in the grid
+     */
+    private shouldShowField;
+    /**
+     * Estimate appropriate column width based on field type
+     */
+    private estimateColumnWidth;
+    /**
+     * Get value formatter for a field based on its type
+     */
+    private getValueFormatter;
+    /**
+     * Build row data from entity records
+     */
+    private buildRowData;
+    /**
+     * Update grid selection to match selectedRecordId and scroll to the selected row
+     */
+    private updateSelection;
+    /**
+     * Find a record by its primary key string
+     */
+    private findRecordByPk;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EntityGridComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EntityGridComponent, "mj-entity-grid", never, { "entity": { "alias": "entity"; "required": false; }; "records": { "alias": "records"; "required": false; }; "selectedRecordId": { "alias": "selectedRecordId"; "required": false; }; "columns": { "alias": "columns"; "required": false; }; "height": { "alias": "height"; "required": false; }; "enableSelection": { "alias": "enableSelection"; "required": false; }; "filterText": { "alias": "filterText"; "required": false; }; "sortState": { "alias": "sortState"; "required": false; }; "serverSideSorting": { "alias": "serverSideSorting"; "required": false; }; "pageSize": { "alias": "pageSize"; "required": false; }; "gridState": { "alias": "gridState"; "required": false; }; }, { "recordSelected": "recordSelected"; "recordOpened": "recordOpened"; "sortChanged": "sortChanged"; "gridStateChanged": "gridStateChanged"; }, never, never, false, never>;
+}
+//# sourceMappingURL=entity-grid.component.d.ts.map

package/dist/lib/entity-grid/entity-grid.component.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-grid.component.d.ts","sourceRoot":"","sources":["../../../src/lib/entity-grid/entity-grid.component.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACzG,OAAO,EAAE,UAAU,EAA4B,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EACL,MAAM,EACN,cAAc,EACd,eAAe,EAEf,qBAAqB,EAGrB,mBAAmB,EACnB,cAAc,EAGd,gBAAgB,IAAI,kBAAkB,EACtC,kBAAkB,EAClB,gBAAgB,EAEjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,SAAS,EAAE,gBAAgB,EAAiB,mBAAmB,EAAoC,qBAAqB,EAAE,MAAM,UAAU,CAAC;;AAM3M;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAKa,mBAAoB,YAAW,MAAM,EAAE,SAAS;IAC3D;;OAEG;IACM,MAAM,EAAE,UAAU,GAAG,IAAI,CAAQ;IAE1C;;OAEG;IACM,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAQ;IAE7C;;OAEG;IACM,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEhD;;OAEG;IACM,OAAO,EAAE,aAAa,EAAE,CAAM;IAEvC;;;OAGG;IACM,MAAM,EAAE,MAAM,CAAU;IAEjC;;;OAGG;IACM,eAAe,EAAE,OAAO,CAAQ;IAEzC;;;OAGG;IACM,UAAU,EAAE,MAAM,CAAM;IAEjC;;OAEG;IACM,SAAS,EAAE,SAAS,GAAG,IAAI,CAAQ;IAE5C;;;;OAIG;IACM,iBAAiB,EAAE,OAAO,CAAQ;IAE3C;;;OAGG;IACM,QAAQ,EAAE,MAAM,CAAO;IAEhC;;;OAGG;IACM,SAAS,EAAE,mBAAmB,GAAG,IAAI,CAAQ;IAEtD;;OAEG;IACO,cAAc,oCAA2C;IAEnE;;OAEG;IACO,YAAY,kCAAyC;IAE/D;;OAEG;IACO,WAAW,iCAAwC;IAE7D;;OAEG;IACO,gBAAgB,sCAA6C;IAEvE,iCAAiC;IAC1B,UAAU,EAAE,MAAM,EAAE,CAAM;IAEjC,uBAAuB;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAM;IAE/C,4BAA4B;IAC5B,OAAO,CAAC,OAAO,CAAwB;IAEvC,+CAA+C;IAC/C,OAAO,CAAC,eAAe,CAAoB;IAE3C,uEAAuE;IACvE,OAAO,CAAC,cAAc,CAAkB;IAExC,wCAAwC;IACjC,SAAS,EAAE,OAAO,CAAS;IAElC,oEAAoE;IACpE,OAAO,CAAC,kBAAkB,CAAkB;IAE5C,8BAA8B;IACvB,aAAa,EAAE,MAAM,CAK1B;IAEF,2BAA2B;IACpB,KAAK,oFAAe;IAE3B,0DAA0D;IACnD,YAAY,EAAE,mBAAmB,CAEtC;IAEF,sCAAsC;IAC/B,QAAQ,WAAY,eAAe,OAAO,MAAM,EAAE,OAAO,CAAC,CAAC,YAAmC;IAErG,QAAQ,IAAI,IAAI;IAWhB,WAAW,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAyCzC;;OAEG;IACH,OAAO,KAAK,gBAAgB,GAE3B;IAED;;OAEG;YACW,QAAQ;IAgCtB;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAaxC;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI;IA2BlD;;OAEG;IACH,eAAe,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI;IAOhD;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI;IAO5C;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAU5B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAoC7B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAgB5B;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI;IAa1C;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,qBAAqB,GAAG,IAAI;IAatD;;;OAGG;IACH,OAAO,CAAC,eAAe;IAevB;;OAEG;IACH,OAAO,CAAC,4BAA4B;IA2CpC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA6B1B;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAQ7B;;OAEG;IACH,OAAO,CAAC,eAAe;IAkBvB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAgB3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAyCzB;;OAEG;IACH,OAAO,CAAC,YAAY;IAqBpB;;OAEG;IACH,OAAO,CAAC,eAAe;IAcvB;;OAEG;IACH,OAAO,CAAC,cAAc;yCAhoBX,mBAAmB;2CAAnB,mBAAmB;CAmoB/B"}