@oicl/openbridge-webcomponents 2.0.0-next.153 → 2.0.0-next.155

package/dist/components/alert-list-details-experimental/alert-list-details-experimental.d.ts

@@ -1,5 +1,6 @@
-import { LitElement } from 'lit';
+import { LitElement, PropertyValues } from 'lit';
 import { Alert } from '../../types.js';
+import { ObcTableCellData } from '../table/table.js';
 import '../icon-button/icon-button.js';
 import '../button/button.js';
 import '../../icons/icon-silence-iec.js';
@@ -12,56 +13,174 @@ import '../../icons/icon-alarm-noack-iec.js';
 import '../../icons/icon-warning-noack-iec.js';
 import '../alert-icon/alert-icon.js';
 import '../scrollbar/scrollbar.js';
-export declare enum AlertListMode {
+export declare enum FilterModes {
     UNACKED = "unacked",
     ALL = "all",
     SHELVED = "shelved",
     BLOCKED = "blocked",
     RECTIFIED = "rectified"
 }
-export type ObcAckClickEvent = CustomEvent<{
+export type ObcAlertListCellClickEvent = CustomEvent<{
     alert: Alert;
+    columnKey: string;
+    rowId: string;
 }>;
 export type ObcRowClickEvent = CustomEvent<{
     alert: Alert;
+    rowId: string;
 }>;
-export declare function getAlertListModeData(selectedMode: AlertListMode): {
-    name: AlertListMode;
+export interface AlertListColumnBase {
+    /** Unique within the list; part of the cell slot name. */
+    key: string;
+    label: string;
+    /** CSS grid track size. Defaults to `1fr` for the first column, `min-content` for the rest. */
+    width?: string;
+    dividerRight?: boolean;
+}
+/** A column whose cells the list renders from `cell(alert)`. */
+export interface AlertListDataColumn extends AlertListColumnBase {
+    cell: (alert: Alert) => ObcTableCellData | undefined;
+    /** Makes the column sortable. */
+    compare?: (a: Alert, b: Alert) => number;
+    sortDirection?: 'asc' | 'desc';
+}
+/** A column whose cells the consumer supplies through `cell-<key>:<rowId>` slots. */
+export interface AlertListSlotColumn extends AlertListColumnBase {
+    slot: true;
+}
+export type AlertListColumn = AlertListDataColumn | AlertListSlotColumn;
+export type AlertListColumnOptions = Partial<AlertListColumnBase>;
+/** One cell of a slot column, for every row including rows in collapsed groups. */
+export interface AlertListCellSlot {
+    name: string;
+    alert: Alert;
+    rowId: string;
+    columnKey: string;
+}
+export type ObcAlertListCellSlotsChangeEvent = CustomEvent<AlertListCellSlot[]>;
+export interface AlertListRow {
+    rowId: string;
+    parentRowId?: string;
+    alert: Alert;
+    level: number;
+    expandable: boolean;
+}
+export declare function getFilterModeData(filterMode: FilterModes): {
+    name: FilterModes;
     title: string;
     emptyTitle: string;
     emptyIcon: import('lit-html').TemplateResult<1>;
     filter: (alert: Alert) => boolean;
 };
 export declare function canAckFilter(filter: (alert: Alert) => boolean): (alert: Alert) => boolean;
+/** Name of the slot that fills the cell of a slot column in one row. */
+export declare function alertListCellSlotName(columnKey: string, rowId: string): string;
+/** Alert icon, text and source; sorted by priority. */
+export declare function statusColumn(options?: AlertListColumnOptions): AlertListDataColumn;
+/** ACK button, or the no-ack icon, for alerts that await acknowledgement. The button fires `cell-click`. */
+export declare function ackColumn(options?: AlertListColumnOptions): AlertListDataColumn;
+/** Activation time; sorted by time. */
+export declare function timeColumn({ formatter, ...options }?: AlertListColumnOptions & {
+    formatter?: (time: Date) => string;
+}): AlertListDataColumn;
+/** Tag ID prefixed with `#`; sorted alphabetically. */
+export declare function tagIdColumn(options?: AlertListColumnOptions): AlertListDataColumn;
+/**
+ * Every row `obc-alert-list-details-experimental` can show for these alerts
+ * and filter mode, rows inside collapsed groups included. An alert that is a member
+ * of several groups gets one row, and one `rowId`, under each.
+ */
+export declare function getAlertRows(alerts: Alert[], filterMode: FilterModes): AlertListRow[];
 /**
- * @availableWhen timeFormatter showTime==true
+ * `<obc-alert-list-details-experimental>` lists alerts in a table with
+ * consumer-defined columns, grouping alerts through `memberOf`.
+ *
+ * ## Features
+ * - **Columns:** `columns` sets which columns show and in what order. A data
+ *   column renders each cell from `cell(alert)`; a slot column renders
+ *   whatever the consumer places in the cell's slot.
+ * - **Column factories:** `statusColumn()`, `ackColumn()`, `timeColumn()` and
+ *   `tagIdColumn()` build the standard data columns; each takes overrides
+ *   such as `label`, `width` or `dividerRight`.
+ * - **Filter modes:** `filterMode` lists unacknowledged, all, shelved,
+ *   blocked or rectified alerts, with an empty state per filter mode.
+ * - **Grouping:** an alert listing group ids in `memberOf` renders under each
+ *   of those groups; groups nest and can be collapsed.
+ * - **Selection:** `selectedRowId` highlights one row. When a collapsed group
+ *   hides it, the nearest visible group row is highlighted instead.
+ *
+ * ## Usage Guidelines
+ * - Use a slot column when the cell content must be owned by the consumer,
+ *   for example a button the application disables or removes later. Slotted
+ *   content stays in the light DOM, so it can be looked up by id.
+ * - Slot names are `cell-<key>:<rowId>`. `cellSlots` lists every one, with its
+ *   alert, row id and column key, and `cell-slots-change` fires when the list
+ *   changes. The Svelte wrapper renders its `cell` snippet once per entry. An
+ *   alert in two groups has two rows, so it gets two entries.
+ * - Without a wrapper, build the names from `getAlertRows(alerts, filterMode)`
+ *   and `alertListCellSlotName(key, rowId)`, or read `cellSlots`.
+ * - Clicks on buttons, links and inputs in a cell do not fire `row-click`.
+ * - The consumer owns the selection: set `selectedRowId` from `row-click`, and
+ *   set it to `undefined` on a second click to unselect. The list never changes
+ *   it; clear it when the row is no longer in `getAlertRows(alerts, filterMode)`.
+ *
+ * ## Example
+ * ```html
+ * <obc-alert-list-details-experimental>
+ *   <obc-button slot="cell-ack:radar" id="ack-radar">ACK</obc-button>
+ * </obc-alert-list-details-experimental>
+ * ```
+ * with `columns` set to `[statusColumn(), {key: 'ack', label: 'ACK-status', slot: true}]`.
+ *
+ * @property filterMode - Which alerts to list.
+ * @property alerts - Alerts to list.
+ * @property columns - Columns in display order.
+ * @property showHeader - Whether to show the column header row.
  * @property defaultExpanded - Whether groups start expanded. Set false to open the list collapsed.
- * @fires {ObcAckClickEvent} ack-click - Fired when the user clicks the "ACK" button.
+ * @property selectedRowId - Row id to highlight, as given by `row-click` or `getAlertRows()`. Nothing is highlighted when no row has this id.
+ * @slot cell-<key>:<rowId> - Content of the cell in slot column `<key>` for row `<rowId>`.
+ * @fires {ObcAlertListCellClickEvent} cell-click - Fired when the user clicks a button rendered by a data column, such as the one from `ackColumn()`.
  * @fires {ObcRowClickEvent} row-click - Fired when the user clicks a row.
+ * @fires {ObcAlertListCellSlotsChangeEvent} cell-slots-change - Fired when `cellSlots` changes; the detail is the new list.
  * @experimental
  */
 export declare class ObcAlertListDetailsExperimental extends LitElement {
-    selectedMode: AlertListMode;
+    /** Which alerts to list. */
+    filterMode: FilterModes;
+    /** Alerts to list. */
     alerts: Alert[];
-    showTime: boolean;
-    /** Available when `showTime==true`. */
-    timeFormatter: (time: Date) => string;
-    small: boolean;
+    /** Columns in display order. */
+    columns: AlertListColumn[];
+    /** Whether to show the column header row. */
+    showHeader: boolean;
     /** Whether groups start expanded. Set false to open the list collapsed. */
     defaultExpanded: boolean;
+    /** Row id to highlight, as given by `row-click` or `getAlertRows()`. Nothing is highlighted when no row has this id. */
+    selectedRowId?: string;
     private alertList;
     private expansionOverrides;
     private alertByRowId;
+    private allRowIds;
+    private _cellSlots;
+    private cellSlotsChanged;
+    /** Slot of every cell in a slot column, rows in collapsed groups included. */
+    get cellSlots(): AlertListCellSlot[];
+    willUpdate(changed: PropertyValues<this>): void;
+    updated(): void;
     getVisibleAlerts(): Alert[];
     private onRowClick;
     private onCellButtonClick;
     private onExpandToggle;
     private isExpanded;
-    private get columns();
+    private compareRows;
+    private get tableColumns();
+    private get gridColumns();
     private get metadata();
-    private get filteredAlerts();
     private buildVisibleRows;
+    /** The selected row, or the nearest visible group row when a collapsed group hides it. */
+    private highlightedRowId;
     private buildRowCells;
+    private slotNames;
     render(): import('lit-html').TemplateResult<1>;
     static styles: import('lit').CSSResult;
 }

package/dist/components/alert-list-details-experimental/alert-list-details-experimental.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"alert-list-details-experimental.d.ts","sourceRoot":"","sources":["../../../src/components/alert-list-details-experimental/alert-list-details-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAkB,MAAM,KAAK,CAAC;AAKhD,OAAO,+BAA+B,CAAC;AACvC,OAAO,qBAAqB,CAAC;AAC7B,OAAO,iCAAiC,CAAC;AACzC,OAAO,4BAA4B,CAAC;AACpC,OAAO,kCAAkC,CAAC;AAC1C,OAAO,mCAAmC,CAAC;AAC3C,OAAO,yCAAyC,CAAC;AACjD,OAAO,oCAAoC,CAAC;AAC5C,OAAO,qCAAqC,CAAC;AAC7C,OAAO,uCAAuC,CAAC;AAC/C,OAAO,6BAA6B,CAAC;AACrC,OAAO,EACL,KAAK,EAMN,MAAM,gBAAgB,CAAC;AAgBxB,OAAO,2BAA2B,CAAC;AAEnC,oBAAY,aAAa;IACvB,OAAO,YAAY;IACnB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC;IACzC,KAAK,EAAE,KAAK,CAAC;CACd,CAAC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC;IACzC,KAAK,EAAE,KAAK,CAAC;CACd,CAAC,CAAC;AAEH,wBAAgB,oBAAoB,CAAC,YAAY,EAAE,aAAa;;;;;oBAO1C,KAAK;EAuC1B;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,IACpD,OAAO,KAAK,aAKrB;AAED;;;;;;GAMG;AACH,qBACa,+BAAgC,SAAQ,UAAU;IACnC,YAAY,EAAE,aAAa,CAAqB;IACjD,MAAM,EAAE,KAAK,EAAE,CAAM;IACnB,QAAQ,EAAE,OAAO,CAAS;IACvB,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,CAEV;IAC9B,KAAK,EAAE,OAAO,CAAS;IACL,eAAe,EAAE,OAAO,CAAQ;IAG7E,OAAO,CAAC,SAAS,CAAY;IAEpB,OAAO,CAAC,kBAAkB,CAA8B;IAEjE,OAAO,CAAC,YAAY,CAA4B;IAEzC,gBAAgB,IAAI,KAAK,EAAE;IAelC,OAAO,CAAC,UAAU;IASlB,OAAO,CAAC,iBAAiB;IAYzB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,UAAU;IAIlB,OAAO,KAAK,OAAO,GAkFlB;IAED,OAAO,KAAK,QAAQ,GAEnB;IAED,OAAO,KAAK,cAAc,GAEzB;IAED,OAAO,CAAC,gBAAgB;IAiFxB,OAAO,CAAC,aAAa;IAkEZ,MAAM;IA0Bf,OAAgB,MAAM,0BAA2B;CAClD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,qCAAqC,EAAE,+BAA+B,CAAC;KACxE;CACF"}
+{"version":3,"file":"alert-list-details-experimental.d.ts","sourceRoot":"","sources":["../../../src/components/alert-list-details-experimental/alert-list-details-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAE,cAAc,EAAkB,MAAM,KAAK,CAAC;AAMhE,OAAO,+BAA+B,CAAC;AACvC,OAAO,qBAAqB,CAAC;AAC7B,OAAO,iCAAiC,CAAC;AACzC,OAAO,4BAA4B,CAAC;AACpC,OAAO,kCAAkC,CAAC;AAC1C,OAAO,mCAAmC,CAAC;AAC3C,OAAO,yCAAyC,CAAC;AACjD,OAAO,oCAAoC,CAAC;AAC5C,OAAO,qCAAqC,CAAC;AAC7C,OAAO,uCAAuC,CAAC;AAC/C,OAAO,6BAA6B,CAAC;AACrC,OAAO,EACL,KAAK,EAMN,MAAM,gBAAgB,CAAC;AAMxB,OAAO,EAGL,gBAAgB,EAMjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,2BAA2B,CAAC;AAEnC,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,GAAG,QAAQ;IACX,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,MAAM,MAAM,0BAA0B,GAAG,WAAW,CAAC;IACnD,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC;IACzC,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC,CAAC;AAEH,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,+FAA+F;IAC/F,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,gEAAgE;AAChE,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,gBAAgB,GAAG,SAAS,CAAC;IACrD,iCAAiC;IACjC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,KAAK,MAAM,CAAC;IACzC,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAChC;AAED,qFAAqF;AACrF,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAExE,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAElE,mFAAmF;AACnF,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,gCAAgC,GAAG,WAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC;AAEhF,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,WAAW;;;;;oBAOnC,KAAK;EAuC1B;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,IACpD,OAAO,KAAK,aAKrB;AAED,wEAAwE;AACxE,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAGrE;AAED,uDAAuD;AACvD,wBAAgB,YAAY,CAC1B,OAAO,GAAE,sBAA2B,GACnC,mBAAmB,CAoBrB;AAED,4GAA4G;AAC5G,wBAAgB,SAAS,CACvB,OAAO,GAAE,sBAA2B,GACnC,mBAAmB,CA2BrB;AAED,uCAAuC;AACvC,wBAAgB,UAAU,CAAC,EACzB,SACqD,EACrD,GAAG,OAAO,EACX,GAAE,sBAAsB,GAAG;IAC1B,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC;CAC/B,GAAG,mBAAmB,CAa3B;AAED,uDAAuD;AACvD,wBAAgB,WAAW,CACzB,OAAO,GAAE,sBAA2B,GACnC,mBAAmB,CAYrB;AA8FD;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,KAAK,EAAE,EACf,UAAU,EAAE,WAAW,GACtB,YAAY,EAAE,CAGhB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,qBACa,+BAAgC,SAAQ,UAAU;IACnC,UAAU,EAAE,WAAW,CAAmB;IAC3C,MAAM,EAAE,KAAK,EAAE,CAAM;IACH,OAAO,EAAE,eAAe,EAAE,CAInE;IAC2C,UAAU,EAAE,OAAO,CAAQ;IAC3B,eAAe,EAAE,OAAO,CAAQ;IACnD,aAAa,CAAC,EAAE,MAAM,CAAC;IAGjD,OAAO,CAAC,SAAS,CAAY;IAEpB,OAAO,CAAC,kBAAkB,CAA8B;IAEjE,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,SAAS,CAAqB;IAEtC,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,gBAAgB,CAAS;IAEjC,8EAA8E;IAC9E,IAAI,SAAS,IAAI,iBAAiB,EAAE,CAEnC;IAEQ,UAAU,CAAC,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC;IAgCxC,OAAO;IAWT,gBAAgB,IAAI,KAAK,EAAE;IAelC,OAAO,CAAC,UAAU;IAYlB,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,WAAW;IAUnB,OAAO,KAAK,YAAY,GA4BvB;IAED,OAAO,KAAK,WAAW,GAOtB;IAED,OAAO,KAAK,QAAQ,GAEnB;IAED,OAAO,CAAC,gBAAgB;IAkBxB,0FAA0F;IAC1F,OAAO,CAAC,gBAAgB;IAcxB,OAAO,CAAC,aAAa;IAarB,OAAO,CAAC,SAAS;IAOR,MAAM;IAkCf,OAAgB,MAAM,0BAA2B;CAClD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,qCAAqC,EAAE,+BAA+B,CAAC;KACxE;CACF"}