@rimbu/table/src/custom/interface/creators.mts

Immutable spreadsheet-like data structures containing row keys, column keys, and cell values

import type { RMap } from '@rimbu/collection-types';
import type { HashMap } from '@rimbu/hashed';
import type { SortedMap } from '@rimbu/sorted';

import type {
  HashTableHashColumn,
  HashTableSortedColumn,
  SortedTableHashColumn,
  SortedTableSortedColumn,
  Table,
} from '@rimbu/table';
import type { TableBase } from '@rimbu/table/custom';

/**
 * A collection of helper functions used to create `Table.Context` instances.
 *
 * See the [Table documentation](https://rimbu.org/docs/collections/table) and the [Table API documentation](https://rimbu.org/api/rimbu/table/Table/interface).
 */
export interface TableCreators {
  /**
   * Returns a new Table context instance based on the given `options`.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   * @param options - an object containing the following properties:<br/>
   * - rowContext: the map context to use to map row keys to columns<br/>
   * - columnContext: the map context to use to map column keys to values
   */
  createContext<UR, UC>(options: {
    rowContext: RMap.Context<UR>;
    columnContext: RMap.Context<UC>;
  }): Table.Context<UR, UC>;
}

/**
 * The public creators for the `HashTableHashColumn` collection type.
 *
 * This interface extends `TableBase.Factory` with helpers to create and access `HashTableHashColumn.Context` instances.
 */
export interface HashTableHashColumnCreators
  extends TableBase.Factory<HashTableHashColumn.Types> {
  /**
   * Returns a new HashTableHashColumn context instance based on the given `options`.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   * @param options - (optional) an object containing the following properties:<br/>
   * - rowContext: (optional) the map context to use to map row keys to columns<br/>
   * - columnContext: (optional) the map context to use to map column keys to values
   */
  createContext<UR, UC>(options?: {
    rowContext?: HashMap.Context<UR>;
    columnContext?: HashMap.Context<UC>;
  }): HashTableHashColumn.Context<UR, UC>;
  /**
   * Returns the default context for HashTableHashColumns.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   */
  defaultContext<UR, UC>(): HashTableHashColumn.Context<UR, UC>;
}

/**
 * The public creators for the `HashTableSortedColumn` collection type.
 *
 * This interface extends `TableBase.Factory` with helpers to create and access `HashTableSortedColumn.Context` instances.
 */
export interface HashTableSortedColumnCreators
  extends TableBase.Factory<HashTableSortedColumn.Types> {
  /**
   * Returns a new HashTableSortedColumn context instance based on the given `options`.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   * @param options - (optional) an object containing the following properties:<br/>
   * - rowContext: (optional) the map context to use to map row keys to columns<br/>
   * - columnContext: (optional) the map context to use to map column keys to values
   */
  createContext<UR, UC>(options?: {
    rowContext?: HashMap.Context<UR>;
    columnContext?: SortedMap.Context<UC>;
  }): HashTableSortedColumn.Context<UR, UC>;
  /**
   * Returns the default context for HashTableSortedColumns.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   */
  defaultContext<UR, UC>(): HashTableSortedColumn.Context<UR, UC>;
}

/**
 * The public creators for the `SortedTableHashColumn` collection type.
 *
 * This interface extends `TableBase.Factory` with helpers to create and access `SortedTableHashColumn.Context` instances.
 */
export interface SortedTableHashColumnCreators
  extends TableBase.Factory<SortedTableHashColumn.Types> {
  /**
   * Returns a new SortedTableHashColumn context instance based on the given `options`.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   * @param options - (optional) an object containing the following properties:<br/>
   * - rowContext: (optional) the map context to use to map row keys to columns<br/>
   * - columnContext: (optional) the map context to use to map column keys to values
   */
  createContext<UR, UC>(options?: {
    rowContext?: SortedMap.Context<UR>;
    columnContext?: HashMap.Context<UC>;
  }): SortedTableHashColumn.Context<UR, UC>;
  /**
   * Returns the default context for SortedTableHashColumns.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   */
  defaultContext<UR, UC>(): SortedTableHashColumn.Context<UR, UC>;
}

/**
 * The public creators for the `SortedTableSortedColumn` collection type.
 *
 * This interface extends `TableBase.Factory` with helpers to create and access `SortedTableSortedColumn.Context` instances.
 */
export interface SortedTableSortedColumnCreators
  extends TableBase.Factory<SortedTableSortedColumn.Types> {
  /**
   * Returns a new HashTableHashColumn context instance based on the given `options`.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   * @param options - (optional) an object containing the following properties:<br/>
   * - rowContext: (optional) the map context to use to map row keys to columns<br/>
   * - columnContext: (optional) the map context to use to map column keys to values
   */
  createContext<UR, UC>(options?: {
    rowContext?: SortedMap.Context<UR>;
    columnContext?: SortedMap.Context<UC>;
  }): SortedTableSortedColumn.Context<UR, UC>;
  /**
   * Returns the default context for SortedTableSortedColumns.
   * @typeparam UR - the upper row key type for which the context can create instances
   * @typeparam UC - the upper column key type for which the context can create instances
   */
  defaultContext<UR, UC>(): SortedTableSortedColumn.Context<UR, UC>;
}