openproject/frontend/app/components/wp-fast-table/wp-table.interfaces.ts

import {WorkPackageResource} from '../api/api-v3/hal-resources/work-package-resource.service';
import {WorkPackageTable} from './wp-fast-table';

/**
 * Interface of a single row instance handled by the table.
 * May contain references to the current inserted row (if present)
 * or the group it belonged to when initially rendered.
 */
export interface WorkPackageTableRow {
  object:WorkPackageResource;
  workPackageId:string;
  position:number;
  element?:HTMLElement;
  group?:GroupObject;
}

export interface GroupableColumn {
  name:string;
  title:string;
  sortable:boolean;
  groupable:boolean;
  custom_field:boolean;
}

/**
 * A reference to a group object as returned from the API.
 * Augmented with state information such as collapsed state.
 */
export interface GroupObject {
  value:any;
  count:number;
  collapsed?:boolean;
  index?:number;
  href:string;
  _links?: {
    valueLink: { href:string };
  }
}

export interface WPTableRowSelectionState {
  // Map of selected rows
  selected: {[workPackageId: number]: boolean};
  // Index of current selection
  // required for shift-offsets
  activeRowIndex: number | null;
}

export interface RowsBuilderInterface {
  buildRows(table:WorkPackageTable):DocumentFragment;
  redrawRow(row:WorkPackageTableRow, table:WorkPackageTable):HTMLElement;
}