tests: add tests for core apis and properties are present

Author: KevinVandy

packages/table-core/src/core/cells/Cells.ts

@@ -1,4 +1,4 @@
-import { assignAPIs, getMemoOptions, memo } from '../../utils'
+import { assignAPIs } from '../../utils'
 import { cell_getContext, cell_getValue, cell_renderValue } from './Cells.utils'
 import type { CellData, RowData } from '../../types/type-utils'
 import type { TableFeature, TableFeatures } from '../../types/TableFeatures'

packages/table-core/src/core/cells/createCell.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, it } from 'vitest'
+import { _createCell } from './createCell'
+import { Cells } from './Cells'
+import type { Row } from '../../types/Row'
+import type { Column } from '../../types/Column'
+import type { Table } from '../../types/Table'
+
+describe('createCell', () => {
+  it('should populate the cell with all core cell APIs and properties', () => {
+    const column = { id: 'test-column' } as Column<any, any, any>
+    const row = { id: 'test-row' } as Row<any, any>
+    const table = { _features: { Cells }, options: {} } as Table<any, any>
+    const coreCell = _createCell(column, row, table)
+
+    expect(coreCell).toBeDefined()
+    expect(coreCell).toHaveProperty('column')
+    expect(coreCell).toHaveProperty('id')
+    expect(coreCell).toHaveProperty('row')
+    expect(coreCell).toHaveProperty('getContext')
+    expect(coreCell).toHaveProperty('getValue')
+    expect(coreCell).toHaveProperty('renderValue')
+
+    expect(coreCell.id).toBe(`${row.id}_${column.id}`)
+    expect(coreCell.column).toBe(column)
+    expect(coreCell.row).toBe(row)
+  })
+})

packages/table-core/src/core/columns/Columns.types.ts

@@ -97,7 +97,17 @@ export interface Table_Columns<
   TFeatures extends TableFeatures,
   TData extends RowData,
 > {
+  /**
+   * Returns a map of all flat columns by their ID.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getallflatcolumnsbyid)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   getAllFlatColumnsById: () => Record<string, Column<TFeatures, TData, unknown>>
+  /**
+   * Returns the default column options to use for all column defs supplied to the table.
+   * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#getdefaultcolumndef)
+   * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
+   */
   getDefaultColumnDef: () => Partial<ColumnDef<TFeatures, TData, unknown>>
   /**
    * Returns all columns in the table in their normalized and nested hierarchy.

packages/table-core/src/core/columns/createColumn.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it } from 'vitest'
+import { Columns } from './Columns'
+import { _createColumn } from './createColumn'
+import type { ColumnDef } from '../../types/ColumnDef'
+import type { Table } from '../../types/Table'
+
+describe('createColumn', () => {
+  it('should create a column with all core column APIs and properties', () => {
+    const table = { _features: { Columns }, options: {} } as Table<any, any>
+    const columnDef = {
+      id: 'test-column',
+      accessorKey: 'test-accessor-key',
+    } as ColumnDef<any, any, any>
+    const depth = 0
+    const parent = undefined
+
+    const column = _createColumn(table, columnDef, depth, parent)
+
+    expect(column).toBeDefined()
+    expect(column).toHaveProperty('accessorFn')
+    expect(column).toHaveProperty('columnDef')
+    expect(column).toHaveProperty('columns')
+    expect(column).toHaveProperty('depth')
+    expect(column).toHaveProperty('id')
+    expect(column).toHaveProperty('parent')
+    expect(column).toHaveProperty('getFlatColumns')
+    expect(column).toHaveProperty('getLeafColumns')
+
+    expect(column.id).toBe(columnDef.id)
+    expect(column.depth).toBe(depth)
+    expect(column.parent).toBe(parent)
+  })
+})

packages/table-core/src/core/headers/createHeader.test.ts

@@ -0,0 +1,38 @@
+import { describe, expect, it } from 'vitest'
+import { Headers } from './Headers'
+import { _createHeader } from './createHeader'
+import type { Column } from '../../types/Column'
+import type { Table } from '../../types/Table'
+
+describe('createHeader', () => {
+  it('should create a column with all core column APIs and properties', () => {
+    const table = { _features: { Headers }, options: {} } as Table<any, any>
+    const column = {
+      id: 'test-column',
+      columnDef: { id: 'test-column-def' },
+    } as Column<any, any, any>
+    const index = 0
+    const depth = 0
+
+    const header = _createHeader(table, column, {
+      index,
+      depth,
+    })
+
+    expect(header).toBeDefined()
+    expect(header).toHaveProperty('colSpan')
+    expect(header).toHaveProperty('column')
+    expect(header).toHaveProperty('depth')
+    expect(header).toHaveProperty('headerGroup')
+    expect(header).toHaveProperty('id')
+    expect(header).toHaveProperty('index')
+    expect(header).toHaveProperty('isPlaceholder')
+    expect(header).toHaveProperty('placeholderId')
+    expect(header).toHaveProperty('rowSpan')
+    expect(header).toHaveProperty('subHeaders')
+    expect(header).toHaveProperty('getContext')
+    expect(header).toHaveProperty('getLeafHeaders')
+
+    expect(header.id).toBe(column.id)
+  })
+})

packages/table-core/src/core/rows/createRow.test.ts

@@ -0,0 +1,56 @@
+import { describe, expect, it } from 'vitest'
+import { Rows } from './Rows'
+import { _createRow } from './createRow'
+import type { Row } from '../../types/Row'
+import type { Table } from '../../types/Table'
+
+interface Person {
+  firstName: string
+}
+
+describe('createRow', () => {
+  it('should create a row with all core row APIs and properties', () => {
+    const table = { _features: { Rows }, options: {} } as Table<any, Person>
+    const id = 'test-row'
+    const original = { firstName: 'Tanner' } as Person
+    const rowIndex = 0
+    const depth = 0
+    const subRows = [] as Array<Row<any, Person>>
+    const parentId = 'parent-id'
+
+    const row = _createRow(
+      table,
+      id,
+      original,
+      rowIndex,
+      depth,
+      subRows,
+      parentId,
+    )
+
+    expect(row).toBeDefined()
+    expect(row).toHaveProperty('_uniqueValuesCache')
+    expect(row).toHaveProperty('_valuesCache')
+    expect(row).toHaveProperty('depth')
+    expect(row).toHaveProperty('id')
+    expect(row).toHaveProperty('index')
+    expect(row).toHaveProperty('original')
+    expect(row).toHaveProperty('parentId')
+    expect(row).toHaveProperty('subRows')
+    expect(row).toHaveProperty('getAllCellsByColumnId')
+    expect(row).toHaveProperty('getAllCells')
+    expect(row).toHaveProperty('getLeafRows')
+    expect(row).toHaveProperty('getParentRow')
+    expect(row).toHaveProperty('getParentRows')
+    expect(row).toHaveProperty('getUniqueValues')
+    expect(row).toHaveProperty('getValue')
+    expect(row).toHaveProperty('renderValue')
+
+    expect(row.id).toBe(id)
+    expect(row.original).toBe(original)
+    expect(row.index).toBe(rowIndex)
+    expect(row.depth).toBe(depth)
+    expect(row.subRows).toBe(subRows)
+    expect(row.parentId).toBe(parentId)
+  })
+})

packages/table-core/src/core/table/createTable.test.ts

@@ -0,0 +1,47 @@
+import { describe, expect, it } from 'vitest'
+import { tableFeatures } from '../../helpers/tableFeatures'
+import { _createTable, coreFeatures } from './createTable'
+
+describe('createTable', () => {
+  it('should create a table with all core table APIs and properties', () => {
+    const table = _createTable({
+      _features: coreFeatures,
+      columns: [],
+      data: [],
+    })
+
+    expect(table).toBeDefined()
+    // core table properties
+    expect(table).toHaveProperty('_features')
+    expect(table).toHaveProperty('_rowModels')
+    expect(table).toHaveProperty('initialState')
+    expect(table).toHaveProperty('options')
+
+    // column related table APIs
+    expect(table).toHaveProperty('getAllFlatColumnsById')
+    expect(table).toHaveProperty('getDefaultColumnDef')
+    expect(table).toHaveProperty('getAllColumns')
+    expect(table).toHaveProperty('getAllFlatColumns')
+    expect(table).toHaveProperty('getAllLeafColumns')
+    expect(table).toHaveProperty('getColumn')
+
+    // header related table APIs
+    expect(table).toHaveProperty('getHeaderGroups')
+    expect(table).toHaveProperty('getFooterGroups')
+    expect(table).toHaveProperty('getFlatHeaders')
+    expect(table).toHaveProperty('getLeafHeaders')
+
+    // row related table APIs
+    expect(table).toHaveProperty('getRowId')
+    expect(table).toHaveProperty('getRow')
+
+    // table APIs
+    expect(table).toHaveProperty('_queue')
+    expect(table).toHaveProperty('getCoreRowModel')
+    expect(table).toHaveProperty('getRowModel')
+    expect(table).toHaveProperty('getState')
+    expect(table).toHaveProperty('reset')
+    expect(table).toHaveProperty('setState')
+    expect(table).toHaveProperty('setOptions')
+  })
+})

packages/table-core/src/helpers/tableFeatures.ts

@@ -1,4 +1,4 @@
-import type { TableFeatures } from '../types/TableFeatures'
+import type { CoreTableFeatures, TableFeatures } from '../types/TableFeatures'
 
 /**
  * A helper function to help define the features that are to be imported and applied to a table instance.

packages/table-core/src/types/TableFeatures.ts

@@ -61,7 +61,7 @@ export interface CoreTableFeatures {
   Cells: TableFeature
 }
 
-export interface TableFeatures {
+export interface TableFeatures extends CoreTableFeatures {
   ColumnFaceting?: TableFeature
   ColumnFiltering?: TableFeature
   ColumnGrouping?: TableFeature

packages/table-core/vite.config.ts

@@ -5,7 +5,7 @@ import packageJson from './package.json'
 const config = defineConfig({
   test: {
     name: packageJson.name,
-    dir: './tests',
+    dir: './',
     watch: false,
     environment: 'jsdom',
     setupFiles: ['./tests/test-setup.ts'],