import type { GridRowData, GridRowId, GridRowMeta } from '../types'

export type Collection<TDataModel extends GridRowData = GridRowData> = {
    /**
     * For flat structures, this is all ids. For grouped and trees, this includes
     * only the top level nodes
     */
    ids: GridRowId[]
    /**
     * An id & row Map
     */
    entities: Map<GridRowId, TDataModel>

    /**
     * An id & row meta Map
     */
    meta: Map<GridRowId, GridRowMeta>
}

export type SortFn<TDataModel extends GridRowData = GridRowData> =
    | null
    | ((
          ids: GridRowId[],
          entities: Map<GridRowId, TDataModel>,
          meta: Map<GridRowId, GridRowMeta>
      ) => GridRowId[])