tinybase 1.0.2 → 1.1.0-beta.0

package/lib/store.d.ts

@@ -0,0 +1,2688 @@
+/**
+ * The store module is the core of the TinyBase project and contains the types,
+ * interfaces, and functions to work with Store objects.
+ *
+ * The main entry point to this module is the createStore function, which
+ * returns a new Store. From there, you can set and get data, register
+ * listeners, and use other modules to build an entire app around the state and
+ * tabular data within.
+ *
+ * @packageDocumentation
+ * @module store
+ */
+
+import {Id, IdOrNull, Ids, Json} from './common.d';
+
+/**
+ * The Tables type is the data structure representing all of the data in a
+ * Store.
+ *
+ * A Tables object is used when setting all of the tables together with the
+ * setTables method, and when getting them back out again with the getTables
+ * method. A Tables object is a regular JavaScript object containing individual
+ * Table objects, keyed by their Id.
+ *
+ * @example
+ * ```js
+ * const tables: Tables = {
+ *   pets: {
+ *     fido: {species: 'dog', color: 'brown'},
+ *     felix: {species: 'cat'},
+ *   },
+ *   species: {
+ *     dog: {price: 5},
+ *     cat: {price: 4},
+ *   },
+ * };
+ * ```
+ * @category Store
+ */
+export type Tables = {[tableId: Id]: Table};
+
+/**
+ * The Table type is the data structure representing the data in a single table.
+ *
+ * A Table is used when setting a table with the setTable method, and when
+ * getting it back out again with the getTable method. A Table object is a
+ * regular JavaScript object containing individual Row objects, keyed by their
+ * Id.
+ *
+ * @example
+ * ```js
+ * const table: Table = {
+ *   fido: {species: 'dog', color: 'brown'},
+ *   felix: {species: 'cat'},
+ * };
+ * ```
+ * @category Store
+ */
+export type Table = {[rowId: Id]: Row};
+
+/**
+ * The Row type is the data structure representing the data in a single row.
+ *
+ * A Row is used when setting a row with the setRow method, and when getting it
+ * back out again with the getRow method. A Row object is a regular JavaScript
+ * object containing individual Cell objects, keyed by their Id.
+ *
+ * @example
+ * ```js
+ * const row: Row = {species: 'dog', color: 'brown'};
+ * ```
+ * @category Store
+ */
+export type Row = {[cellId: Id]: Cell};
+
+/**
+ * The Cell type is the data structure representing the data in a single cell.
+ *
+ * A Cell is used when setting a cell with the setCell method, and when getting
+ * it back out again with the getCell method. A Cell is a JavaScript string,
+ * number, or boolean.
+ *
+ * @example
+ * ```js
+ * const cell: Cell = 'dog';
+ * ```
+ * @category Store
+ */
+export type Cell = string | number | boolean;
+
+/**
+ * The TableCallback type describes a function that takes a Table's Id and a
+ * callback to loop over each Row within it.
+ *
+ * A TableCallback is provided when using the forEachTable method, so that you
+ * can do something based on every Table in the Store. See that method for
+ * specific examples.
+ *
+ * @param tableId The Id of the Table that the callback can operate on.
+ * @param forEachRow A function that will let you iterate over the Row objects
+ * in this Table.
+ * @category Callback
+ */
+export type TableCallback = (
+  tableId: Id,
+  forEachRow: (rowCallback: RowCallback) => void,
+) => void;
+
+/**
+ * The RowCallback type describes a function that takes a Row's Id and a
+ * callback to loop over each Cell within it.
+ *
+ * A RowCallback is provided when using the forEachRow method, so that you can
+ * do something based on every Row in a Table. See that method for specific
+ * examples.
+ *
+ * @param rowId The Id of the Row that the callback can operate on.
+ * @param forEachRow A function that will let you iterate over the Cell values
+ * in this Row.
+ * @category Callback
+ */
+export type RowCallback = (
+  rowId: Id,
+  forEachCell: (cellCallback: CellCallback) => void,
+) => void;
+
+/**
+ * The CellCallback type describes a function that takes a Cell's Id and its
+ * value.
+ *
+ * A CellCallback is provided when using the forEachCell method, so that you can
+ * do something based on every Cell in a Row. See that method for specific
+ * examples.
+ *
+ * @param cellId The Id of the Cell that the callback can operate on.
+ * @param cell The value of the Cell.
+ * @category Callback
+ */
+export type CellCallback = (cellId: Id, cell: Cell) => void;
+
+/**
+ * The MapCell type describes a function that takes an existing Cell value and
+ * returns another.
+ *
+ * A MapCell can be provided in the setCell method to map an existing value to a
+ * new one, such as when incrementing a number. See that method for specific
+ * examples.
+ *
+ * @param cell The current value of the Cell to map to a new value.
+ * @category Callback
+ */
+export type MapCell = (cell: Cell | undefined) => Cell;
+
+/**
+ * The GetCell type describes a function that takes a Id and returns the Cell
+ * value for a particular Row.
+ *
+ * A GetCell can be provided when setting definitions, as in the
+ * setMetricDefinition method of a Metrics object, or the setIndexDefinition
+ * method of an Indexes object. See those methods for specific examples.
+ *
+ * @param cellId The Id of the Cell to fetch the value for.
+ * @category Callback
+ */
+export type GetCell = (cellId: Id) => Cell | undefined;
+
+/**
+ * The TablesListener type describes a function that is used to listen to
+ * changes to the whole Store.
+ *
+ * A TablesListener is provided when using the addTablesListener method. See
+ * that method for specific examples.
+ *
+ * When called, a TablesListener is given a reference to the Store and a
+ * GetCellChange function that can be used to query Cell values before and after
+ * the current transaction.
+ *
+ * Note that if the listener was manually forced to be called (with the
+ * callListener method rather than due to a real change in the Store), the
+ * GetCellChange function will not be present.
+ *
+ * @param store A reference to the Store that changed.
+ * @param getCellChange A function that returns information about any Cell's
+ * changes.
+ * @category Listener
+ */
+export type TablesListener = (
+  store: Store,
+  getCellChange: GetCellChange | undefined,
+) => void;
+
+/**
+ * The TableIdsListener type describes a function that is used to listen to
+ * changes to the Table Ids in the Store.
+ *
+ * A TableIdsListener is provided when using the addTableIdsListener method. See
+ * that method for specific examples.
+ *
+ * When called, a TableIdsListener is given a reference to the Store.
+ *
+ * @param store A reference to the Store that changed.
+ * @category Listener
+ */
+export type TableIdsListener = (store: Store) => void;
+
+/**
+ * The TableListener type describes a function that is used to listen to changes
+ * to a Table.
+ *
+ * A TableListener is provided when using the addTableListener method. See that
+ * method for specific examples.
+ *
+ * When called, a TableListener is given a reference to the Store, the Id of the
+ * Table that changed, and a GetCellChange function that can be used to query
+ * Cell values before and after the current transaction.
+ *
+ * Note that if the listener was manually forced to be called (with the
+ * callListener method rather than due to a real change in the Store), the
+ * GetCellChange function will not be present.
+ *
+ * @param store A reference to the Store that changed.
+ * @param tableId The Id of the Table that changed.
+ * @param getCellChange A function that returns information about any Cell's
+ * changes.
+ * @category Listener
+ */
+export type TableListener = (
+  store: Store,
+  tableId: Id,
+  getCellChange: GetCellChange | undefined,
+) => void;
+
+/**
+ * The RowIdsListener type describes a function that is used to listen to
+ * changes to the Row Ids in a Table.
+ *
+ * A RowIdsListener is provided when using the addRowIdsListener method. See
+ * that method for specific examples.
+ *
+ * When called, a RowIdsListener is given a reference to the Store, and the Id
+ * of the Table whose Row Ids changed.
+ *
+ * @param store A reference to the Store that changed.
+ * @param tableId The Id of the Table that changed.
+ * @category Listener
+ */
+export type RowIdsListener = (store: Store, tableId: Id) => void;
+
+/**
+ * The RowListener type describes a function that is used to listen to changes
+ * to a Row.
+ *
+ * A RowListener is provided when using the addRowListener method. See that
+ * method for specific examples.
+ *
+ * When called, a RowListener is given a reference to the Store, the Id of the
+ * Table that changed, the Id of the Row that changed, and a GetCellChange
+ * function that can be used to query Cell values before and after the current
+ * transaction.
+ *
+ * Note that if the listener was manually forced to be called (with the
+ * callListener method rather than due to a real change in the Store), the
+ * GetCellChange function will not be present.
+ *
+ * @param store A reference to the Store that changed.
+ * @param tableId The Id of the Table that changed.
+ * @param rowId The Id of the Row that changed.
+ * @param getCellChange A function that returns information about any Cell's
+ * changes.
+ * @category Listener
+ */
+export type RowListener = (
+  store: Store,
+  tableId: Id,
+  rowId: Id,
+  getCellChange: GetCellChange | undefined,
+) => void;
+
+/**
+ * The CellIdsListener type describes a function that is used to listen to
+ * changes to the Cell Ids in a Row.
+ *
+ * A CellIdsListener is provided when using the addCellIdsListener method. See
+ * that method for specific examples.
+ *
+ * When called, a CellIdsListener is given a reference to the Store, the Id of
+ * the Table that changed, and the Id of the Row whose Cell Ids changed.
+ *
+ * @param store A reference to the Store that changed.
+ * @param tableId The Id of the Table that changed.
+ * @param rowId The Id of the Row that changed.
+ * changes.
+ * @category Listener
+ */
+export type CellIdsListener = (store: Store, tableId: Id, rowId: Id) => void;
+
+/**
+ * The CellListener type describes a function that is used to listen to changes
+ * to a Cell.
+ *
+ * A CellListener is provided when using the addCellListener method. See that
+ * method for specific examples.
+ *
+ * When called, a CellListener is given a reference to the Store, the Id of the
+ * Table that changed, the Id of the Row that changed, and the Id of Cell that
+ * changed. It is also given the new value of the Cell, the old value of the
+ * Cell, and a GetCellChange function that can be used to query Cell values
+ * before and after the current transaction.
+ *
+ * Note that if the listener was manually forced to be called (with the
+ * callListener method rather than due to a real change in the Store), the
+ * GetCellChange function will not be present and the new and old values of the
+ * Cell will be the same.
+ *
+ * @param store A reference to the Store that changed.
+ * @param tableId The Id of the Table that changed.
+ * @param rowId The Id of the Row that changed.
+ * @param cellId The Id of the Cell that changed.
+ * @param newCell The new value of the Cell that changed.
+ * @param oldCell The old value of the Cell that changed.
+ * @param getCellChange A function that returns information about any Cell's
+ * changes.
+ * @category Listener
+ */
+export type CellListener = (
+  store: Store,
+  tableId: Id,
+  rowId: Id,
+  cellId: Id,
+  newCell: Cell,
+  oldCell: Cell,
+  getCellChange: GetCellChange | undefined,
+) => void;
+
+/**
+ * The InvalidCellListener type describes a function that is used to listen to
+ * attempts to set invalid data to a Cell.
+ *
+ * A InvalidCellListener is provided when using the addInvalidCellListener
+ * method. See that method for specific examples.
+ *
+ * When called, a InvalidCellListener is given a reference to the Store, the Id
+ * of the Table, the Id of the Row, and the Id of Cell that were being attempted
+ * to be changed. It is also given the invalid value of the Cell, which could
+ * have been of absolutely any type. Since there could have been multiple failed
+ * attempts to set the Cell within a single transaction, this is an array
+ * containing each attempt, chronologically.
+ *
+ * @param store A reference to the Store that was being changed.
+ * @param tableId The Id of the Table that was being changed.
+ * @param rowId The Id of the Row that was being changed.
+ * @param cellId The Id of the Cell that was being changed.
+ * @param invalidCells An array of the values of the Cell that were invalid.
+ * @category Listener
+ */
+export type InvalidCellListener = (
+  store: Store,
+  tableId: Id,
+  rowId: Id,
+  cellId: Id,
+  invalidCells: any[],
+) => void;
+
+/**
+ * The GetCellChange type describes a function that returns information about
+ * any Cell's changes during a transaction.
+ *
+ * A GetCellChange function is provided to every listener when called due the
+ * Store changing. The listener can then fetch the previous value of a Cell
+ * before the current transaction, the new value after it, and a convenience
+ * flag that indicates that the value has changed.
+ *
+ * @param tableId The Id of the Table to inspect.
+ * @param rowId The Id of the Row to inspect.
+ * @param cellId The Id of the Cell to inspect.
+ * @returns A CellChange array containing information about the Cell's changes.
+ * @category Listener
+ */
+export type GetCellChange = (tableId: Id, rowId: Id, cellId: Id) => CellChange;
+
+/**
+ * The CellChange type describes a Cell's changes during a transaction.
+ *
+ * This is returned by the GetCellChange function that is provided to every
+ * listener when called. This array contains the previous value of a Cell
+ * before the current transaction, the new value after it, and a convenience
+ * flag that indicates that the value has changed.
+ *
+ * @category Listener
+ */
+export type CellChange = [
+  changed: boolean,
+  oldCell: Cell | undefined,
+  newCell: Cell | undefined,
+];
+
+/**
+ * The Schema type describes the structure of a Store in terms of valid Table
+ * Ids and the types of Cell that can exist within them.
+ *
+ * A Schema comprises a JavaScript object describing each Table, in turn a
+ * nested JavaScript object containing information about each Cell and its
+ * CellSchema. It is provided to the setSchema method.
+ *
+ * @example
+ * When applied to a Store, this Schema only allows one Table called `pets`, in
+ * which each Row may contain a string `species` Cell, and is guaranteed to
+ * contain a boolean `sold` Cell that defaults to `false`.
+ *
+ *```js
+ * const schema: Schema = {
+ *   pets: {
+ *     species: {type: 'string'},
+ *     sold: {type: 'boolean', default: false},
+ *   },
+ * };
+ * ```
+ * @category Schema
+ */
+export type Schema = {
+  [tableId: Id]: {
+    [cellId: Id]: CellSchema;
+  };
+};
+
+/**
+ * The CellSchema type describes what values are allowed for each Cell in a
+ * Table.
+ *
+ * A CellSchema specifies the type of the Cell (`string`, `boolean`, or
+ * `number`), and what the default value can be when an explicit value is not
+ * specified.
+ *
+ * If a default value is provided (and its type is correct), you can be certain
+ * that that Cell will always be present in a Row.
+ *
+ * If the default value is _not_ provided (or its type is incorrect), the Cell
+ * may be missing from the Row, but when present you can be guaranteed it is of
+ * the correct type.
+ *
+ * @example
+ * When applied to a Store, this CellSchema ensures a boolean Cell is always
+ * present, and defaults it to `false`.
+ *
+ *```js
+ * const requiredBoolean: CellSchema = {type: 'boolean', default: false};
+ * ```
+ * @category Schema
+ */
+export type CellSchema =
+  | {
+      type: 'string';
+      default?: string;
+    }
+  | {
+      type: 'number';
+      default?: number;
+    }
+  | {
+      type: 'boolean';
+      default?: boolean;
+    };
+
+/**
+ * The StoreListenerStats type describes the number of listeners registered with
+ * the Store, and can be used for debugging purposes.
+ *
+ * The StoreListenerStats object contains a breakdown of the different types of
+ * listener. Totals include both mutator and non-mutator listeners. A
+ * StoreListenerStats object is returned from the getListenerStats method, and
+ * is only populated in a debug build.
+ *
+ * @category Development
+ */
+export type StoreListenerStats = {
+  /**
+   * The number of TablesListeners registered with the Store.
+   */
+  tables?: number;
+  /**
+   * The number of TableIdsListeners registered with the Store.
+   */
+  tableIds?: number;
+  /**
+   * The number of TableListeners registered with the Store.
+   */
+  table?: number;
+  /**
+   * The number of RowIdsListeners registered with the Store.
+   */
+  rowIds?: number;
+  /**
+   * The number of RowListeners registered with the Store.
+   */
+  row?: number;
+  /**
+   * The number of CellIdsListeners registered with the Store.
+   */
+  cellIds?: number;
+  /**
+   * The number of CellListeners registered with the Store.
+   */
+  cell?: number;
+};
+
+/**
+ * A Store is the main location for keeping structured state and tabular data.
+ *
+ * Create a Store easily with the createStore function. From there, you can set
+ * and get data, add listeners for when the data changes, set a Schema, and so
+ * on.
+ *
+ * A Store has a simple hierarchical structure:
+ *
+ * - The Store contains a number of Table objects.
+ * - Each Table contains a number of Row objects.
+ * - Each Row contains a number of Cell objects.
+ *
+ * A Cell is a string, boolean, or number value.
+ *
+ * The members of each level of this hierarchy are identified with a unique Id
+ * (which is a string). In other words you can naively think of a Store as a
+ * three-level-deep JavaScript object, keyed with strings:
+ *
+ * ```json
+ * {                     // Store
+ *   "table1": {           // Table
+ *     "row1": {             // Row
+ *       "cell1": "one",       // Cell (string)
+ *       "cell2": true,        // Cell (boolean)
+ *       "cell3": 3,           // Cell (number)
+ *       ...
+ *     },
+ *     ...
+ *   },
+ *   ...
+ * }
+ * ```
+ *
+ * In its default form, a Store has no sense of a structured schema, so, as long
+ * as they are unique within their own parent, the Id keys can each be any
+ * string you want. However, you _can_ optionally specify a Schema for a Store,
+ * which then usefully constrains the Table and Cell Ids (and Cell values) you
+ * can use.
+ *
+ * # Setting and getting data
+ *
+ * Every part of the Store can be accessed with getter methods. When you
+ * retrieve data from the Store, you are receiving a copy - rather than a
+ * reference - of it. This means that manipulating the data in the Store must be
+ * performed with the equivalent setter and deleter methods.
+ *
+ * To benefit from the reactive behavior of the Store, you can also subscribe to
+ * changes on any part of it with 'listeners'. Registering a listener returns a
+ * listener Id (that you can use later to remove it with the delListener
+ * method), and it will then be called every time there is a change within the
+ * part of the hierarchy you're listening to.
+ *
+ * This table shows the main ways you can set, get, and listen to, different
+ * types of data in a Store:
+ *
+ * |Type|Get data|Set data|Delete data|Add a listener|
+ * |-|-|-|-|-|
+ * |Tables|getTables|setTables|delTables|addTablesListener|
+ * |Table Ids|getTableIds|-|-|addTableIdsListener|
+ * |Table|getTable|setTable|delTable|addTableListener|
+ * |Row Ids|getRowIds|-|-|addRowIdsListener|
+ * |Row|getRow|setRow|delRow|addRowListener|
+ * |Cell Ids|getCellIds|-|-|addCellIdsListener|
+ * |Cell|getCell|setCell|delCell|addCellListener|
+ *
+ * Additionally, there are two extra methods to manipulate Row objects. The
+ * addRow method is like the setRow method but automatically assigns it a new
+ * unique Id. And the setPartialRow method lets you update multiple Cell values
+ * in a Row without affecting the others.
+ *
+ * You can listen to attempts to write invalid data to a Cell with the
+ * addInvalidCellListener method.
+ *
+ * The transaction method is used to wrap multiple changes to the Store so that
+ * the relevant listeners only fire once.
+ *
+ * The setJson method and the getJson method allow you to work with a
+ * JSON-encoded representation of the entire Store, which is useful for
+ * persisting it.
+ *
+ * Finally, the callListener method provides a way for you to manually provoke a
+ * listener to be called, even if the underlying data hasn't changed. This is
+ * useful when you are using mutator listeners to guarantee that data conforms
+ * to programmatic conditions, and those conditions change such that you need to
+ * update the Store in bulk.
+ *
+ * Read more about setting and changing data in The Basics guides, and about
+ * listeners in the Listening to Stores guide.
+ *
+ * # Creating a Schema
+ *
+ * You can set a Schema on a Store when you create it with createStore function,
+ * or at a later stage with the setSchema method. A Schema constrains the Table
+ * Ids the Store can have, and the types of Cell data in each Table. Each Cell
+ * requires its type to be specified, and can also take a default value for when
+ * it's not specified.
+ *
+ * You can also get a serialization of the Schema out of the Store with the
+ * getSchemaJson method, and remove the Schema altogether with the delSchema
+ * method.
+ *
+ * Read more about schemas in the Using Schemas guide.
+ *
+ * # Convenience methods
+ *
+ * There are a few additional helper methods to make it easier to work with a
+ * Store. There are methods for easily checking the existence of a Table, Row,
+ * or Cell, and iterators that let you act on the children of a common parent:
+ *
+ * ||Checking existence|Iterator|
+ * |-|-|-|
+ * |Table|hasTable|forEachTable|
+ * |Row|hasRow|forEachRow|
+ * |Cell|hasCell|forEachCell|
+ *
+ * Finally, the getListenerStats method describes the current state of the
+ * Store's listeners for debugging purposes.
+ *
+ * @example
+ * This example shows a very simple lifecycle of a Store: from creation, to
+ * adding and getting some data, and then registering and removing a listener.
+ *
+ * ```js
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * console.log(store.getRow('pets', 'fido'));
+ * // -> {species: 'dog'}
+ *
+ * store.setCell('pets', 'fido', 'color', 'brown');
+ * console.log(store.getCell('pets', 'fido', 'color'));
+ * // -> 'brown'
+ *
+ * const listenerId = store.addTableListener('pets', () => {
+ *   console.log('changed');
+ * });
+ *
+ * store.setCell('pets', 'fido', 'sold', false);
+ * // -> 'changed'
+ *
+ * store.delListener(listenerId);
+ * ```
+ * @see The Basics guides
+ * @see Using Schemas guides
+ * @see Hello World demos
+ * @see Todo App demos
+ * @category Store
+ */
+export interface Store {
+  /**
+   * The getTables method returns a Tables object containing the entire data of
+   * the Store.
+   *
+   * Note that this returns a copy of, rather than a reference to the underlying
+   * data, so changes made to the returned object are not made to the Store
+   * itself.
+   *
+   * @returns A Tables object containing the entire data of the Store.
+   * @example
+   * This example retrieves the data in a Store.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog'}},
+   *   species: {dog: {price: 5}},
+   * });
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}, species: {dog: {price: 5}}}
+   * ```
+   * @example
+   * This example retrieves the Tables of an empty Store, returning an empty
+   * object.
+   *
+   * ```js
+   * const store = createStore();
+   * console.log(store.getTables());
+   * // -> {}
+   * ```
+   * @see
+   * # Guides
+   * Creating a Store
+   * @see Indexes
+   * @category Getter
+   */
+  getTables(): Tables;
+
+  /**
+   * The getTableIds method returns the Ids of every Table in the Store.
+   *
+   * Note that this returns a copy of, rather than a reference, to the list of
+   * Ids, so changes made to the list are not made to the Store itself. Although
+   * the order of Ids have no meaning, this method is expected to return them in
+   * the order in which each Table was added.
+   *
+   * @returns An array of the Ids of every Table in the Store.
+   * @example
+   * This example retrieves the Table Ids in a Store.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog'}},
+   *   species: {dog: {price: 5}},
+   * });
+   * console.log(store.getTableIds());
+   * // -> ['pets', 'species']
+   * ```
+   * @example
+   * This example retrieves the Table Ids of an empty Store, returning an empty
+   * array.
+   *
+   * ```js
+   * const store = createStore();
+   * console.log(store.getTableIds());
+   * // -> []
+   * ```
+   * @category Getter
+   */
+  getTableIds(): Ids;
+
+  /**
+   * The getTable method returns an object containing the entire data of a
+   * single Table in the Store.
+   *
+   * Note that this returns a copy of, rather than a reference to the underlying
+   * data, so changes made to the returned object are not made to the Store
+   * itself.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @returns An object containing the entire data of the Table.
+   * @example
+   * This example retrieves the data in a single Table.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog'}},
+   *   species: {dog: {price: 5}},
+   * });
+   * console.log(store.getTable('pets'));
+   * // -> {fido: {species: 'dog'}}
+   * ```
+   * @example
+   * This example retrieves a Table that does not exist, returning an empty
+   * object.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.getTable('employees'));
+   * // -> {}
+   * ```
+   * @category Getter
+   */
+  getTable(tableId: Id): Table;
+
+  /**
+   * The getRowIds method returns the Ids of every Row in a given Table.
+   *
+   * Note that this returns a copy of, rather than a reference, to the list of
+   * Ids, so changes made to the list are not made to the Store itself. Although
+   * the order of Ids have no meaning, this method is expected to return them in
+   * the order in which each Row was added.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @returns An array of the Ids of every Row in the Table.
+   * @example
+   * This example retrieves the Row Ids in a Table.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {
+   *     fido: {species: 'dog'},
+   *     felix: {species: 'cat'},
+   *   },
+   * });
+   * console.log(store.getRowIds('pets'));
+   * // -> ['fido', 'felix']
+   * ```
+   * @example
+   * This example retrieves the Row Ids of a Table that does not exist,
+   * returning an empty array.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.getRowIds('employees'));
+   * // -> []
+   * ```
+   * @category Getter
+   */
+  getRowIds(tableId: Id): Ids;
+
+  /**
+   * The getRow method returns an object containing the entire data of a single
+   * Row in a given Table.
+   *
+   * Note that this returns a copy of, rather than a reference to the underlying
+   * data, so changes made to the returned object are not made to the Store
+   * itself.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @returns An object containing the entire data of the Row.
+   * @example
+   * This example retrieves the data in a single Row.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {
+   *     fido: {species: 'dog'},
+   *     felix: {species: 'cat'},
+   *   },
+   * });
+   * console.log(store.getRow('pets', 'fido'));
+   * // -> {species: 'dog'}
+   * ```
+   * @example
+   * This example retrieves a Row that does not exist, returning an empty
+   * object.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.getRow('pets', 'felix'));
+   * // -> {}
+   * ```
+   * @category Getter
+   */
+  getRow(tableId: Id, rowId: Id): Row;
+
+  /**
+   * The getCellIds method returns the Ids of every Cell in a given Row, in a
+   * given Table.
+   *
+   * Note that this returns a copy of, rather than a reference, to the list of
+   * Ids, so changes made to the list are not made to the Store itself. Although
+   * the order of Ids have no meaning, this method is expected to return them in
+   * the order in which each Row was added.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @returns An array of the Ids of every Cell in the Row.
+   * @example
+   * This example retrieves the Cell Ids in a Row.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {
+   *     fido: {species: 'dog', color: 'brown'},
+   *   },
+   * });
+   * console.log(store.getCellIds('pets', 'fido'));
+   * // -> ['species', 'color']
+   * ```
+   * @example
+   * This example retrieves the Cell Ids of a Cell that does not exist,
+   * returning an empty array.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.getCellIds('pets', 'felix'));
+   * // -> []
+   * ```
+   * @category Getter
+   */
+  getCellIds(tableId: Id, rowId: Id): Ids;
+
+  /**
+   * The getCell method returns an object containing the value of a single Cell
+   * in a given Row, in a given Table.
+   *
+   * Note that this returns a copy of, rather than a reference to the underlying
+   * data, so changes made to the returned object are not made to the Store
+   * itself.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @param cellId The Id of the Cell in the Row.
+   * @returns The value of the Cell.
+   * @example
+   * This example retrieves a single Cell.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * console.log(store.getCell('pets', 'fido', 'species'));
+   * // -> 'dog'
+   * ```
+   * @example
+   * This example retrieves a Cell that does not exist, returning `undefined`.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.getCell('pets', 'fido', 'color'));
+   * // -> undefined
+   * ```
+   * @category Getter
+   */
+  getCell(tableId: Id, rowId: Id, cellId: Id): Cell | undefined;
+
+  /**
+   * The hasTables method returns a boolean indicating whether any Table objects
+   * exist in the Store.
+   *
+   * @returns Whether any Tables exist.
+   * @example
+   * This example shows simple existence checks.
+   *
+   * ```js
+   * const store = createStore();
+   * console.log(store.hasTables());
+   * // -> false
+   * store.setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.hasTables());
+   * // -> true
+   * ```
+   * @category Getter
+   */
+  hasTables(): boolean;
+
+  /**
+   * The hasTable method returns a boolean indicating whether a given Table
+   * exists in the Store.
+   *
+   * @param tableId The Id of a possible Table in the Store.
+   * @returns Whether a Table with that Id exists.
+   * @example
+   * This example shows two simple Table existence checks.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.hasTable('pets'));
+   * // -> true
+   * console.log(store.hasTable('employees'));
+   * // -> false
+   * ```
+   * @category Getter
+   */
+  hasTable(tableId: Id): boolean;
+
+  /**
+   * The hasRow method returns a boolean indicating whether a given Row exists
+   * in the Store.
+   *
+   * @param tableId The Id of a possible Table in the Store.
+   * @param rowId The Id of a possible Row in the Table.
+   * @returns Whether a Row with that Id exists in that Table.
+   * @example
+   * This example shows two simple Row existence checks.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.hasRow('pets', 'fido'));
+   * // -> true
+   * console.log(store.hasRow('pets', 'felix'));
+   * // -> false
+   * ```
+   * @category Getter
+   */
+  hasRow(tableId: Id, rowId: Id): boolean;
+
+  /**
+   * The hasCell method returns a boolean indicating whether a given Cell exists
+   * in the Store.
+   *
+   * @param tableId The Id of a possible Table in the Store.
+   * @param rowId The Id of a possible Row in the Table.
+   * @param cellId The Id of a possible Cell in the Row.
+   * @returns Whether a Cell with that Id exists in that Row in that Table.
+   * @example
+   * This example shows two simple Cell existence checks.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.hasCell('pets', 'fido', 'species'));
+   * // -> true
+   * console.log(store.hasCell('pets', 'fido', 'color'));
+   * // -> false
+   * ```
+   * @category Getter
+   */
+  hasCell(tableId: Id, rowId: Id, cellId: Id): boolean;
+
+  /**
+   * The getJson method returns a string serialization of all of the Tables in
+   * the Store.
+   *
+   * @returns A string serialization of all of the Tables in the Store.
+   * @example
+   * This example serializes the contents of a Store.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * console.log(store.getJson());
+   * // -> '{"pets":{"fido":{"species":"dog"}}}'
+   * ```
+   * @example
+   * This example serializes the contents of an empty Store.
+   *
+   * ```js
+   * const store = createStore();
+   * console.log(store.getJson());
+   * // -> '{}'
+   * ```
+   * @category Getter
+   */
+  getJson(): Json;
+
+  /**
+   * The getSchemaJson method returns a string serialization of the Schema of
+   * the Store.
+   *
+   * If no Schema has been set on the Store (or if it has been removed with the
+   * delSchema method), then it will return the serialization of an empty
+   * object, `{}`.
+   *
+   * @returns A string serialization of the Schema of the Store.
+   * @example
+   * This example serializes the Schema of a Store.
+   *
+   * ```js
+   * const store = createStore().setSchema({
+   *   pets: {
+   *     species: {type: 'string'},
+   *     sold: {type: 'boolean'},
+   *   },
+   * });
+   * console.log(store.getSchemaJson());
+   * // -> '{"pets":{"species":{"type":"string"},"sold":{"type":"boolean"}}}'
+   * ```
+   * @example
+   * This example serializes the Schema of an empty Store.
+   *
+   * ```js
+   * const store = createStore();
+   * console.log(store.getSchemaJson());
+   * // -> '{}'
+   * ```
+   * @category Getter
+   */
+  getSchemaJson(): Json;
+
+  /**
+   * The setTables method takes an object and sets the entire data of the Store.
+   *
+   * This method will cause listeners to be called for any Table, Row, Cell, or
+   * Id changes resulting from it.
+   *
+   * Any part of the provided object that is invalid (either according to the
+   * Tables type, or because it does not match a Schema associated with the
+   * Store), will be ignored silently.
+   *
+   * Assuming that at least some of the provided Tables object is valid, any
+   * data that was already present in the Store will be completely overwritten.
+   * If the object is completely invalid, no change will be made to the Store.
+   *
+   * The method returns a reference to the Store to that subsequent operations
+   * can be chained in a fluent style.
+   *
+   * @param tables The data of the Store to be set.
+   * @example
+   * This example sets the data of a Store.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog'}},
+   *   species: {dog: {price: 5}},
+   * });
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}, species: {dog: {price: 5}}}
+   * ```
+   * @example
+   * This example attempts to set the data of an existing Store with partly
+   * invalid, and then completely invalid, Tables objects.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   *
+   * store.setTables({pets: {felix: {species: 'cat', bug: []}}});
+   * console.log(store.getTables());
+   * // -> {pets: {felix: {species: 'cat'}}}
+   *
+   * store.setTables({meaning: 42});
+   * console.log(store.getTables());
+   * // -> {pets: {felix: {species: 'cat'}}}
+   * ```
+   * @category Setter
+   */
+  setTables(tables: Tables): Store;
+
+  /**
+   * The setTable method takes an object and sets the entire data of a single
+   * Table in the Store.
+   *
+   * This method will cause listeners to be called for any Table, Row, Cell, or
+   * Id changes resulting from it.
+   *
+   * Any part of the provided object that is invalid (either according to the
+   * Table type, or because it does not match a Schema associated with the
+   * Store), will be ignored silently.
+   *
+   * Assuming that at least some of the provided Table object is valid, any data
+   * that was already present in the Store for that Table will be completely
+   * overwritten. If the object is completely invalid, no change will be made to
+   * the Store.
+   *
+   * The method returns a reference to the Store to that subsequent operations
+   * can be chained in a fluent style.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param table The data of a single Table to be set.
+   * @example
+   * This example sets the data of a single Table.
+   *
+   * ```js
+   * const store = createStore().setTable('pets', {
+   *   fido: {species: 'dog'},
+   *   felix: {species: 'cat'},
+   * });
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+   * ```
+   * @example
+   * This example attempts to set the data of an existing Store with partly
+   * invalid, and then completely invalid, Table objects.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   *
+   * store.setTable('pets', {felix: {species: 'cat', bug: []}});
+   * console.log(store.getTables());
+   * // -> {pets: {felix: {species: 'cat'}}}
+   *
+   * store.setTable('pets', {meaning: 42});
+   * console.log(store.getTables());
+   * // -> {pets: {felix: {species: 'cat'}}}
+   * ```
+   * @category Setter
+   */
+  setTable(tableId: Id, table: Table): Store;
+
+  /**
+   * The setRow method takes an object and sets the entire data of a single Row
+   * in the Store.
+   *
+   * This method will cause listeners to be called for any Table, Row, Cell, or
+   * Id changes resulting from it.
+   *
+   * Any part of the provided object that is invalid (either according to the
+   * Row type, or because it does not match a Schema associated with the Store),
+   * will be ignored silently.
+   *
+   * Assuming that at least some of the provided Row object is valid, any data
+   * that was already present in the Store for that Row will be completely
+   * overwritten. If the object is completely invalid, no change will be made to
+   * the Store.
+   *
+   * The method returns a reference to the Store to that subsequent operations
+   * can be chained in a fluent style.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @param row The data of a single Row to be set.
+   * @returns A reference to the Store.
+   * @example
+   * This example sets the data of a single Row.
+   *
+   * ```js
+   * const store = createStore().setRow('pets', 'fido', {species: 'dog'});
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}}
+   * ```
+   * @example
+   * This example attempts to set the data of an existing Store with partly
+   * invalid, and then completely invalid, Row objects.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   *
+   * store.setRow('pets', 'fido', {color: 'brown', bug: []});
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {color: 'brown'}}}
+   *
+   * store.setRow('pets', 'fido', 42);
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {color: 'brown'}}}
+   * ```
+   * @category Setter
+   */
+  setRow(tableId: Id, rowId: Id, row: Row): Store;
+
+  /**
+   * The addRow method takes an object and creates a new Row in the Store,
+   * returning the unique Id assigned to it.
+   *
+   * This method will cause listeners to be called for any Table, Row, Cell, or
+   * Id changes resulting from it.
+   *
+   * Any part of the provided object that is invalid (either according to the
+   * Row type, or because it does not match a Schema associated with the Store),
+   * will be ignored silently.
+   *
+   * Assuming that at least some of the provided Row object is valid, a new Row
+   * will be created. If the object is completely invalid, no change will be
+   * made to the Store and the method will return `undefined`
+   *
+   * You should not guarantee the form of the unique Id that is generated when a
+   * Row is added to the Table. However it is likely to be a string
+   * representation of an increasing integer.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param row The data of a single Row to be added.
+   * @returns A reference to the Store.
+   * @example
+   * This example adds a single Row.
+   *
+   * ```js
+   * const store = createStore();
+   * console.log(store.addRow('pets', {species: 'dog'}));
+   * // -> '0'
+   * console.log(store.getTables());
+   * // -> {pets: {'0': {species: 'dog'}}}
+   * ```
+   * @example
+   * This example attempts to add Rows to an existing Store with partly invalid,
+   * and then completely invalid, Row objects.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {'0': {species: 'dog'}}});
+   *
+   * console.log(store.addRow('pets', {species: 'cat', bug: []}));
+   * // -> '1'
+   * console.log(store.getTables());
+   * // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
+   *
+   * console.log(store.addRow('pets', 42));
+   * // -> undefined
+   * console.log(store.getTables());
+   * // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
+   * ```
+   * @category Setter
+   */
+  addRow(tableId: Id, row: Row): Id | undefined;
+
+  /**
+   * The setPartialRow method takes an object and sets partial data of a single
+   * Row in the Store, leaving other Cell values unaffected.
+   *
+   * This method will cause listeners to be called for any Table, Row, Cell, or
+   * Id changes resulting from it.
+   *
+   * Any part of the provided object that is invalid (either according to the
+   * Row type, or because, when combined with the current Row data, it does not
+   * match a Schema associated with the Store), will be ignored silently.
+   *
+   * Assuming that at least some of the provided Row object is valid, it will be
+   * merged with the data that was already present in the Store. If the object
+   * is completely invalid, no change will be made to the Store.
+   *
+   * The method returns a reference to the Store to that subsequent operations
+   * can be chained in a fluent style.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @param partialRow The partial data of a single Row to be set.
+   * @returns A reference to the Store.
+   * @example
+   * This example sets some of the data of a single Row.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * store.setPartialRow('pets', 'fido', {color: 'walnut', visits: 1});
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog', color: 'walnut', visits: 1}}}
+   * ```
+   * @example
+   * This example attempts to set some of the data of an existing Store with
+   * partly invalid, and then completely invalid, Row objects.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   *
+   * store.setPartialRow('pets', 'fido', {color: 'brown', bug: []});
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog', color: 'brown'}}}
+   *
+   * store.setPartialRow('pets', 'fido', 42);
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog', color: 'brown'}}}
+   * ```
+   * @category Setter
+   */
+  setPartialRow(tableId: Id, rowId: Id, partialRow: Row): Store;
+
+  /**
+   * The setCell method sets the value of a single Cell in the Store.
+   *
+   * This method will cause listeners to be called for any Table, Row, Cell, or
+   * Id changes resulting from it.
+   *
+   * If the Cell value is invalid (either because of its type, or because it
+   * does not match a Schema associated with the Store), will be ignored
+   * silently.
+   *
+   * As well as string, number, or boolean Cell types, this method can also take
+   * a MapCell function that takes the current Cell value as a parameter and
+   * maps it. This is useful if you want to efficiently increment a value
+   * without fetching it first, for example.
+   *
+   * The method returns a reference to the Store to that subsequent operations
+   * can be chained in a fluent style.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @param cellId The Id of the Cell in the Row.
+   * @param cell The value of the Cell to be set, or a MapCell function to
+   * update it.
+   * @returns A reference to the Store.
+   * @example
+   * This example sets the value of a single Cell.
+   *
+   * ```js
+   * const store = createStore().setCell('pets', 'fido', 'species', 'dog');
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}}
+   * ```
+   * @example
+   * This example sets the data of a single Cell by mapping the existing value.
+   *
+   * ```js
+   * const increment = (cell) => cell + 1;
+   * const store = createStore().setTables({pets: {fido: {visits: 1}}});
+   *
+   * store.setCell('pets', 'fido', 'visits', increment);
+   * console.log(store.getCell('pets', 'fido', 'visits'));
+   * // -> 2
+   * ```
+   * @example
+   * This example attempts to set the data of an existing Store with an invalid
+   * Cell value.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   *
+   * store.setCell('pets', 'fido', 'bug', []);
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}}
+   * ```
+   * @category Setter
+   */
+  setCell(tableId: Id, rowId: Id, cellId: Id, cell: Cell | MapCell): Store;
+
+  /**
+   * The setJson method takes a string serialization of all of the Tables in the
+   * Store and attempts to update it to that value
+   *
+   * If the JSON cannot be parsed, this will fail silently. If it can be parsed,
+   * it will then be subject to the same validation rules as the setTables
+   * method (according to the Tables type, and matching any Schema associated
+   * with the Store).
+   *
+   * @param json A string serialization of all of the Tables in the Store.
+   * @returns A reference to the Store.
+   * @example
+   * This example sets the contents of a Store from a serialization.
+   *
+   * ```js
+   * const store = createStore();
+   * store.setJson('{"pets":{"fido":{"species":"dog"}}}');
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}}
+   * ```
+   * @example
+   * This example attempts to set the contents of a Store from an invalid
+   * serialization.
+   *
+   * ```js
+   * const store = createStore();
+   * store.setJson('{"pets":{"fido":{');
+   * console.log(store.getTables());
+   * // -> {}
+   * ```
+   * @category Setter
+   */
+  setJson(json: Json): Store;
+
+  /**
+   * The setSchema method lets you specify the Schema of the Store.
+   *
+   * Note that this may result in a change to data in the Store, as defaults are
+   * applied or as invalid Table, Row, or Cell objects are removed. These
+   * changes will fire any listeners to that data, as expected.
+   *
+   * When no longer needed, you can also completely remove an existing Schema
+   * with the delSchema method.
+   *
+   * @param schema The Schema to be set for the Store.
+   * @returns A reference to the Store.
+   * @example
+   * This example sets the Schema of a Store after it has been created.
+   *
+   * ```js
+   * const store = createStore().setSchema({
+   *   pets: {
+   *     species: {type: 'string'},
+   *     sold: {type: 'boolean', default: false},
+   *   },
+   * });
+   * store.addRow('pets', {species: 'dog', color: 'brown', sold: 'maybe'});
+   * console.log(store.getTables());
+   * // -> {pets: {0: {species: 'dog', sold: false}}}
+   * ```
+   * @category Setter
+   */
+  setSchema(tablesSchema: Schema): Store;
+
+  /**
+   * The delTables method lets you remove all of the data in a Store.
+   *
+   * @returns A reference to the Store.
+   * @example
+   * This example removes the data of a Store.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   *
+   * store.delTables();
+   * console.log(store.getTables());
+   * // -> {}
+   * ```
+   * @category Deleter
+   */
+  delTables(): Store;
+
+  /**
+   * The delTable method lets you remove a single Table from the Store.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @returns A reference to the Store.
+   * @example
+   * This example removes a Table from a Store.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog'}},
+   *   species: {dog: {price: 5}},
+   * });
+   * store.delTable('pets');
+   *
+   * console.log(store.getTables());
+   * // -> {species: {dog: {price: 5}}}
+   * ```
+   * @category Deleter
+   */
+  delTable(tableId: Id): Store;
+
+  /**
+   * The delRow method lets you remove a single Row from a Table.
+   *
+   * If this is the last Row in its Table, then that Table will be removed.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @returns A reference to the Store.
+   * @example
+   * This example removes a Row from a Table.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog'}, felix: {species: 'cat'}},
+   * });
+   * store.delRow('pets', 'fido');
+   *
+   * console.log(store.getTables());
+   * // -> {pets: {felix: {species: 'cat'}}}
+   * ```
+   * @category Deleter
+   */
+  delRow(tableId: Id, rowId: Id): Store;
+
+  /**
+   * The delCell method lets you remove a single Cell from a Row.
+   *
+   * When there is no Schema applied to the Store, then if this is the last Cell
+   * in its Row, then that Row will be removed. If, in turn, that is the last
+   * Row in its Table, then that Table will be removed.
+   *
+   * If there is a Schema applied to the Store and it specifies a default value
+   * for this Cell, then deletion will result in it being set back to its
+   * default value. To override this, use the `forceDel` parameter, as described
+   * below.
+   *
+   * The `forceDel` parameter is an optional flag that is only relevant if a
+   * Schema provides a default value for this Cell. Under such circumstances,
+   * deleting a Cell value will normally restore it to the default value. If
+   * this flag is set to `true`, the complete removal of the Cell is instead
+   * guaranteed. But since doing do so would result in an invalid Row (according
+   * to the Schema), in fact the whole Row is deleted to retain the integrity of
+   * the Table. Therefore, this flag should be used with caution.
+   *
+   * @param tableId The Id of the Table in the Store.
+   * @param rowId The Id of the Row in the Table.
+   * @param cellId The Id of the Cell in the Row.
+   * @param forceDel An optional flag to indicate that the whole Row should be
+   * deleted, even if a Schema provides a default value for this Cell. Defaults
+   * to `false`.
+   * @returns A reference to the Store.
+   * @example
+   * This example removes a Cell from a Row without a Schema.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', sold: true}},
+   * });
+   * store.delCell('pets', 'fido', 'sold');
+   *
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}}
+   * ```
+   * @example
+   * This example removes a Cell from a Row with a Schema that defaults its
+   * value.
+   *
+   * ```js
+   * const store = createStore()
+   *   .setTables({
+   *     pets: {fido: {species: 'dog', sold: true}},
+   *   })
+   *   .setSchema({
+   *     pets: {
+   *       species: {type: 'string'},
+   *       sold: {type: 'boolean', default: false},
+   *     },
+   *   });
+   * store.delCell('pets', 'fido', 'sold');
+   *
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog', sold: false}}}
+   * ```
+   * @example
+   * This example removes a Cell from a Row with a Schema that defaults its
+   * value, but uses the `forceDel` parameter to override it.
+   *
+   * ```js
+   * const store = createStore()
+   *   .setTables({
+   *     pets: {fido: {species: 'dog', sold: true}, felix: {species: 'cat'}},
+   *   })
+   *   .setSchema({
+   *     pets: {
+   *       species: {type: 'string'},
+   *       sold: {type: 'boolean', default: false},
+   *     },
+   *   });
+   * store.delCell('pets', 'fido', 'sold', true);
+   *
+   * console.log(store.getTables());
+   * // -> {pets: {felix: {species: 'cat', sold: false}}}
+   * ```
+   * @category Deleter
+   */
+  delCell(tableId: Id, rowId: Id, cellId: Id, forceDel?: boolean): Store;
+
+  /**
+   * The delSchema method lets you remove the Schema of the Store.
+   *
+   * @returns A reference to the Store.
+   * @example
+   * This example removes the Schema of a Store.
+   *
+   * ```js
+   * const store = createStore().setSchema({pets: {species: {type: 'string'}}});
+   * store.delSchema();
+   * console.log(store.getSchemaJson());
+   * // -> '{}'
+   * ```
+   * @category Deleter
+   */
+  delSchema(): Store;
+
+  /**
+   * The transaction method takes a function that makes multiple mutations to
+   * the store, buffering all calls to the relevant listeners until it
+   * completes.
+   *
+   * This method is useful for making bulk changes to the data in a Store, and
+   * when you don't want listeners to be called as you make each change. Changes
+   * are made silently during the transaction, and listeners relevant to the
+   * changes you have made will instead only be called when the whole
+   * transaction is complete.
+   *
+   * If multiple changes are made to a piece of Store data throughout the
+   * transaction, a relevant listener will only be called with the final value
+   * (assuming it is different to the value at the start of the transaction),
+   * regardless of the changes that happened in between. For example, if a Cell
+   * had a value `'b'` and then, within a transaction, it was changed to `'b'`
+   * and then `'c'`, any CellListener registered for that cell would be called
+   * once as if there had been a single change from `'a'` to `'c'`.
+   *
+   * Transactions can be nested. Relevant listeners will be called only when the
+   * outermost one completes.
+   *
+   * @param actions The function to be executed as a transaction.
+   * @returns Whatever value the provided transaction function returns.
+   * @example
+   * This example makes changes to two Cells, first outside, and secondly
+   * within, a transaction. In the second case, the Row listener is only called
+   * once.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * store.addRowListener('pets', 'fido', () => console.log('Fido changed'));
+   *
+   * store.setCell('pets', 'fido', 'color', 'brown');
+   * store.setCell('pets', 'fido', 'sold', false);
+   * // -> 'Fido changed'
+   * // -> 'Fido changed'
+   *
+   * store.transaction(() => {
+   *   store.setCell('pets', 'fido', 'color', 'walnut');
+   *   store.setCell('pets', 'fido', 'sold', true);
+   * });
+   * // -> 'Fido changed'
+   * ```
+   * @example
+   * This example makes multiple changes to one Cell. The Cell listener is
+   * called once - and with the final value - only if there is a net overall
+   * change.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * store.addCellListener(
+   *   'pets',
+   *   'fido',
+   *   'color',
+   *   (store, tableId, rowId, cellId, newCell) => console.log(newCell),
+   * );
+   *
+   * store.transaction(() => {
+   *   store.setCell('pets', 'fido', 'color', 'black');
+   *   store.setCell('pets', 'fido', 'color', 'brown');
+   *   store.setCell('pets', 'fido', 'color', 'walnut');
+   * });
+   * // -> 'walnut'
+   *
+   * store.transaction(() => {
+   *   store.setCell('pets', 'fido', 'color', 'black');
+   *   store.setCell('pets', 'fido', 'color', 'walnut');
+   * });
+   * // -> undefined
+   * // No net change during the transaction, so the listener is not called.
+   * ```
+   * @category Setter
+   */
+  transaction<Return>(actions: () => Return): Return;
+
+  /**
+   * The forEachTable method takes a function that it will then call for each
+   * Table in the Store.
+   *
+   * This method is useful for iterating over the Table structure of the Store
+   * in a functional style. The `tableCallback` parameter is a TableCallback
+   * function that will be called with the Id of each Table, and with a function
+   * that can then be used to iterate over each Row of the Table, should you
+   * wish.
+   *
+   * @param tableCallback The function that should be called for every Table.
+   * @example
+   * This example iterates over each Table in a Store, and lists each Row Id
+   * within them.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog'}},
+   *   species: {dog: {price: 5}},
+   * });
+   * store.forEachTable((tableId, forEachRow) => {
+   *   console.log(tableId);
+   *   forEachRow((rowId) => console.log(`- ${rowId}`));
+   * });
+   * // -> 'pets'
+   * // -> '- fido'
+   * // -> 'species'
+   * // -> '- dog'
+   * ```
+   * @category Iterator
+   */
+  forEachTable(tableCallback: TableCallback): void;
+
+  /**
+   * The forEachRow method takes a function that it will then call for each Row
+   * in a specified Table.
+   *
+   * This method is useful for iterating over the Row structure of the Table in
+   * a functional style. The `rowCallback` parameter is a RowCallback function
+   * that will be called with the Id of each Row, and with a function that can
+   * then be used to iterate over each Cell of the Row, should you wish.
+   *
+   * @param tableId The Id of the Table to iterate over.
+   * @param rowCallback The function that should be called for every Row.
+   * @example
+   * This example iterates over each Row in a Table, and lists each Cell Id
+   * within them.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {
+   *     fido: {species: 'dog'},
+   *     felix: {color: 'black'},
+   *   },
+   * });
+   * store.forEachRow('pets', (rowId, forEachCell) => {
+   *   console.log(rowId);
+   *   forEachCell((cellId) => console.log(`- ${cellId}`));
+   * });
+   * // -> 'fido'
+   * // -> '- species'
+   * // -> 'felix'
+   * // -> '- color'
+   * ```
+   * @category Iterator
+   */
+  forEachRow(tableId: Id, rowCallback: RowCallback): void;
+
+  /**
+   * The forEachCell method takes a function that it will then call for each
+   * Cell in a specified Row.
+   *
+   * This method is useful for iterating over the Cell structure of the Row in a
+   * functional style. The `cellCallback` parameter is a CellCallback function
+   * that will be called with the Id and value of each Cell.
+   *
+   * @param tableId The Id of the Table containing the Row to iterate over.
+   * @param rowId The Id of the Row to iterate over.
+   * @param cellCallback The function that should be called for every Cell.
+   * @example
+   * This example iterates over each Cell in a Row, and lists its value.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * store.forEachCell('pets', 'fido', (cellId, cell) => {
+   *   console.log(`${cellId}: ${cell}`);
+   * });
+   * // -> 'species: dog'
+   * // -> 'color: brown'
+   * ```
+   * @category Iterator
+   */
+  forEachCell(tableId: Id, rowId: Id, cellCallback: CellCallback): void;
+
+  /**
+   * The addTablesListener method registers a listener function with the Store
+   * that will be called whenever data in the Store changes.
+   *
+   * The provided listener is a TablesListener function, and will be called with
+   * a reference to the Store and a GetCellChange function in case you need to
+   * inspect any changes that occurred.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param listener The function that will be called whenever data in the Store
+   * changes.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any changes to the whole
+   * Store.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addTablesListener((store, getCellChange) => {
+   *   console.log('Tables changed');
+   *   console.log(getCellChange('pets', 'fido', 'color'));
+   * });
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'Tables changed'
+   * // -> [true, 'brown', 'walnut']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to the whole
+   * Store, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addTablesListener(
+   *   (store) => store.setCell('meta', 'update', 'store', true),
+   *   true,
+   * );
+   *
+   * store.delCell('pets', 'fido', 'color');
+   * console.log(store.getTable('meta'));
+   * // -> {update: {store: true}}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addTablesListener(listener: TablesListener, mutator?: boolean): Id;
+
+  /**
+   * The addTableIdsListener method registers a listener function with the Store
+   * that will be called whenever the Table Ids in the Store change.
+   *
+   * Such a listener is only called when a Table is added or removed. To listen
+   * to all changes in the Store, use the addTablesListener method.
+   *
+   * The provided listener is a TableIdsListener function, and will be called
+   * with a reference to the Store.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param listener The function that will be called whenever the Table Ids in
+   * the Store change.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any change to the Table
+   * Ids.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addTableIdsListener((store) => {
+   *   console.log('Table Ids changed');
+   *   console.log(store.getTableIds());
+   * });
+   *
+   * store.setTable('species', {dog: {price: 5}});
+   * // -> 'Table Ids changed'
+   * // -> ['pets', 'species']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any change to the Table
+   * Ids, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addTableIdsListener(
+   *   (store) => store.setCell('meta', 'update', 'store', true),
+   *   true,
+   * );
+   *
+   * store.setTable('species', {dog: {price: 5}});
+   * console.log(store.getTable('meta'));
+   * // -> {update: {store: true}}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addTableIdsListener(listener: TableIdsListener, mutator?: boolean): Id;
+
+  /**
+   * The addTableListener method registers a listener function with the Store
+   * that will be called whenever data in a Table changes.
+   *
+   * You can either listen to a single Table (by specifying its Id as the
+   * method's first parameter) or changes to any Table (by providing a `null`
+   * wildcard).
+   *
+   * The provided listener is a TableListener function, and will be called with
+   * a reference to the Store, the Id of the Table that changed, and a
+   * GetCellChange function in case you need to inspect any changes that
+   * occurred.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
+   * @param listener The function that will be called whenever data in the
+   * matching Table changes.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any changes to a
+   * specific Table.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addTableListener(
+   *   'pets',
+   *   (store, tableId, getCellChange) => {
+   *     console.log('pets table changed');
+   *     console.log(getCellChange('pets', 'fido', 'color'));
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'pets table changed'
+   * // -> [true, 'brown', 'walnut']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to any
+   * Table.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addTableListener(null, (store, tableId) => {
+   *   console.log(`${tableId} table changed`);
+   * });
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'pets table changed'
+   * store.setTable('species', {dog: {price: 5}});
+   * // -> 'species table changed'
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to a
+   * specific Table, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addTableListener(
+   *   'pets',
+   *   (store, tableId) => store.setCell('meta', 'update', tableId, true),
+   *   true,
+   * );
+   *
+   * store.delCell('pets', 'fido', 'color');
+   * console.log(store.getTable('meta'));
+   * // -> {update: {pets: true}}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addTableListener(
+    tableId: IdOrNull,
+    listener: TableListener,
+    mutator?: boolean,
+  ): Id;
+
+  /**
+   * The addRowIdsListener method registers a listener function with the Store
+   * that will be called whenever the Row Ids in a Table change.
+   *
+   * Such a listener is only called when a Row is added or removed. To listen to
+   * all changes in the Table, use the addTableListener method.
+   *
+   * You can either listen to a single Table (by specifying its Id as the
+   * method's first parameter) or changes to any Table (by providing `null`).
+   *
+   * The provided listener is a RowIdsListener function, and will be called with
+   * a reference to the Store and the Id of the Table that changed.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
+   * @param listener The function that will be called whenever the Row Ids in
+   * the Table change.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any change to the Row
+   * Ids of a specific Table.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addRowIdsListener('pets', (store) => {
+   *   console.log('Row Ids for pets table changed');
+   *   console.log(store.getRowIds('pets'));
+   * });
+   *
+   * store.setRow('pets', 'felix', {species: 'cat'});
+   * // -> 'Row Ids for pets table changed'
+   * // -> ['fido', 'felix']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any change to the Row
+   * Ids of any Table.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addRowIdsListener(null, (store, tableId) => {
+   *   console.log(`Row Ids for ${tableId} table changed`);
+   *   console.log(store.getRowIds(tableId));
+   * });
+   *
+   * store.setRow('pets', 'felix', {species: 'cat'});
+   * // -> 'Row Ids for pets table changed'
+   * // -> ['fido', 'felix']
+   * store.setRow('species', 'dog', {price: 5});
+   * // -> 'Row Ids for species table changed'
+   * // -> ['dog']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any change to the Row
+   * Ids of a specific Table, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addRowIdsListener(
+   *   'pets',
+   *   (store, tableId) => store.setCell('meta', 'update', tableId, true),
+   *   true,
+   * );
+   *
+   * store.setRow('pets', 'felix', {species: 'cat'});
+   * console.log(store.getTable('meta'));
+   * // -> {update: {pets: true}}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addRowIdsListener(
+    tableId: IdOrNull,
+    listener: RowIdsListener,
+    mutator?: boolean,
+  ): Id;
+
+  /**
+   * The addRowListener method registers a listener function with the Store that
+   * will be called whenever data in a Row changes.
+   *
+   * You can either listen to a single Row (by specifying the Table Id and Row
+   * Id as the method's first two parameters) or changes to any Row (by
+   * providing `null` wildcards).
+   *
+   * Both, either, or neither of the `tableId` and `rowId` parameters can be
+   * wildcarded with `null`. You can listen to a specific Row in a specific
+   * Table, any Row in a specific Table, a specific Row in any Table, or any Row
+   * in any Table.
+   *
+   * The provided listener is a RowListener function, and will be called with a
+   * reference to the Store, the Id of the Table that changed, the Id of the Row
+   * that changed, and a GetCellChange function in case you need to inspect any
+   * changes that occurred.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
+   * @param rowId The Id of the Row to listen to, or `null` as a wildcard.
+   * @param listener The function that will be called whenever data in the
+   * matching Row changes.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any changes to a
+   * specific Row.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addRowListener(
+   *   'pets',
+   *   'fido',
+   *   (store, tableId, rowId, getCellChange) => {
+   *     console.log('fido row in pets table changed');
+   *     console.log(getCellChange('pets', 'fido', 'color'));
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'fido row in pets table changed'
+   * // -> [true, 'brown', 'walnut']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to any Row.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addRowListener(
+   *   null,
+   *   null,
+   *   (store, tableId, rowId) => {
+   *     console.log(`${rowId} row in ${tableId} table changed`);
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'fido row in pets table changed'
+   * store.setTable('species', {dog: {price: 5}});
+   * // -> 'dog row in species table changed'
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to a
+   * specific Row, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addRowListener(
+   *   'pets',
+   *   'fido',
+   *   (store, tableId, rowId) =>
+   *     store.setCell('meta', 'update', `${tableId}_${rowId}`, true),
+   *   true,
+   * );
+   *
+   * store.delCell('pets', 'fido', 'color');
+   * console.log(store.getTable('meta'));
+   * // -> {update: {pets_fido: true}}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addRowListener(
+    tableId: IdOrNull,
+    rowId: IdOrNull,
+    listener: RowListener,
+    mutator?: boolean,
+  ): Id;
+
+  /**
+   * The addCellIdsListener method registers a listener function with the Store
+   * that will be called whenever the Cell Ids in a Row change.
+   *
+   * Such a listener is only called when a Cell is added or removed. To listen
+   * to all changes in the Row, use the addRowListener method.
+   *
+   * You can either listen to a single Row (by specifying the Table Id and Row
+   * Id as the method's first two parameters) or changes to any Row (by
+   * providing `null`).
+   *
+   * Both, either, or neither of the `tableId` and `rowId` parameters can be
+   * wildcarded with `null`. You can listen to a specific Row in a specific
+   * Table, any Row in a specific Table, a specific Row in any Table, or any Row
+   * in any Table.
+   *
+   * The provided listener is a CellIdsListener function, and will be called
+   * with a reference to the Store, the Id of the Table, and the Id of the Row
+   * that changed.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
+   * @param rowId The Id of the Row to listen to, or `null` as a wildcard.
+   * @param listener The function that will be called whenever the Cell Ids in
+   * the Row change.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any change to the Cell
+   * Ids of a specific Row.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addCellIdsListener('pets', 'fido', (store) => {
+   *   console.log('Cell Ids for fido row in pets table changed');
+   *   console.log(store.getCellIds('pets', 'fido'));
+   * });
+   *
+   * store.setCell('pets', 'fido', 'color', 'brown');
+   * // -> 'Cell Ids for fido row in pets table changed'
+   * // -> ['species', 'color']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any change to the Cell
+   * Ids of any Row.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addCellIdsListener(
+   *   null,
+   *   null,
+   *   (store, tableId, rowId) => {
+   *     console.log(`Cell Ids for ${rowId} row in ${tableId} table changed`);
+   *     console.log(store.getCellIds(tableId, rowId));
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', 'brown');
+   * // -> 'Cell Ids for fido row in pets table changed'
+   * // -> ['species', 'color']
+   * store.setCell('species', 'dog', 'price', 5);
+   * // -> 'Cell Ids for dog row in species table changed'
+   * // -> ['price']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any change to the Cell
+   * Ids of a specific Row, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const listenerId = store.addCellIdsListener(
+   *   'pets',
+   *   'fido',
+   *   (store, tableId, rowId) =>
+   *     store.setCell('meta', 'update', `${tableId}_${rowId}`, true),
+   *   true,
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', 'brown');
+   * console.log(store.getTable('meta'));
+   * // -> {update: {pets_fido: true}}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addCellIdsListener(
+    tableId: IdOrNull,
+    rowId: IdOrNull,
+    listener: CellIdsListener,
+    mutator?: boolean,
+  ): Id;
+
+  /**
+   * The addCellListener method registers a listener function with the Store
+   * that will be called whenever data in a Cell changes.
+   *
+   * You can either listen to a single Cell (by specifying the Table Id, Row Id,
+   * and Cell Id as the method's first three parameters) or changes to any Cell
+   * (by providing `null` wildcards).
+   *
+   * All, some, or none of the `tableId`, `rowId`, and `cellId` parameters can
+   * be wildcarded with `null`. You can listen to a specific Cell in a specific
+   * Row in a specific Table, any Cell in any Row in any Table, for example - or
+   * every other combination of wildcards.
+   *
+   * The provided listener is a CellListener function, and will be called with a
+   * reference to the Store, the Id of the Table that changed, the Id of the Row
+   * that changed, the Id of the Cell that changed, the new Cell value, the old
+   * Cell value, and a GetCellChange function in case you need to inspect any
+   * changes that occurred.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
+   * @param rowId The Id of the Row to listen to, or `null` as a wildcard.
+   * @param cellId The Id of the Cell to listen to, or `null` as a wildcard.
+   * @param listener The function that will be called whenever data in the
+   * matching Cell changes.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any changes to a
+   * specific Cell.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addCellListener(
+   *   'pets',
+   *   'fido',
+   *   'color',
+   *   (store, tableId, rowId, cellId, newCell, oldCell, getCellChange) => {
+   *     console.log('color cell in fido row in pets table changed');
+   *     console.log([oldCell, newCell]);
+   *     console.log(getCellChange('pets', 'fido', 'color'));
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'color cell in fido row in pets table changed'
+   * // -> ['brown', 'walnut']
+   * // -> [true, 'brown', 'walnut']
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to any Cell.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addCellListener(
+   *   null,
+   *   null,
+   *   null,
+   *   (store, tableId, rowId, cellId) => {
+   *     console.log(
+   *       `${cellId} cell in ${rowId} row in ${tableId} table changed`,
+   *     );
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'color cell in fido row in pets table changed'
+   * store.setTable('species', {dog: {price: 5}});
+   * // -> 'price cell in dog row in species table changed'
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to a
+   * specific Cell, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addCellListener(
+   *   'pets',
+   *   'fido',
+   *   'color',
+   *   (store, tableId, rowId, cellId) =>
+   *     store.setCell('meta', 'update', `${tableId}_${rowId}_${cellId}`, true),
+   *   true,
+   * );
+   *
+   * store.delCell('pets', 'fido', 'color');
+   * console.log(store.getTable('meta'));
+   * // -> {update: {pets_fido_color: true}}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addCellListener(
+    tableId: IdOrNull,
+    rowId: IdOrNull,
+    cellId: IdOrNull,
+    listener: CellListener,
+    mutator?: boolean,
+  ): Id;
+
+  /**
+   * The addInvalidCellListener method registers a listener function with the
+   * Store that will be called whenever invalid data was attempted to be written
+   * to a Cell.
+   *
+   * You can either listen to a single Cell (by specifying the Table Id, Row Id,
+   * and Cell Id as the method's first three parameters) or invalid attempts to
+   * change any Cell (by providing `null` wildcards).
+   *
+   * All, some, or none of the `tableId`, `rowId`, and `cellId` parameters can
+   * be wildcarded with `null`. You can listen to a specific Cell in a specific
+   * Row in a specific Table, any Cell in any Row in any Table, for example - or
+   * every other combination of wildcards.
+   *
+   * The provided listener is an InvalidCellListener function, and will be
+   * called with a reference to the Store, the Id of the Table, the Id of the
+   * Row, and the Id of Cell that were being attempted to be changed. It is also
+   * given the invalid value of the Cell, which could have been of absolutely
+   * any type. Since there could have been multiple failed attempts to set the
+   * Cell within a single transaction, this is an array containing each attempt,
+   * chronologically.
+   *
+   * Use the optional mutator parameter to indicate that there is code in the
+   * listener that will mutate Store data. If set to `false` (or omitted), such
+   * mutations will be silently ignored. All relevant mutator listeners (with
+   * this flag set to `true`) are called _before_ any non-mutator listeners
+   * (since the latter may become relevant due to changes made in the former).
+   * The changes made by mutator listeners do not fire other mutating listeners,
+   * though they will fire non-mutator listeners.
+   *
+   * @param tableId The Id of the Table to listen to, or `null` as a wildcard.
+   * @param rowId The Id of the Row to listen to, or `null` as a wildcard.
+   * @param cellId The Id of the Cell to listen to, or `null` as a wildcard.
+   * @param listener The function that will be called whenever an attempt to
+   * write invalid data to the matching Cell was made.
+   * @param mutator An optional boolean that indicates that the listener mutates
+   * Store data.
+   * @returns A unique Id for the listener that can later be used to call it
+   * explicitly, or to remove it.
+   * @example
+   * This example registers a listener that responds to any invalid changes to a
+   * specific Cell.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addInvalidCellListener(
+   *   'pets',
+   *   'fido',
+   *   'color',
+   *   (store, tableId, rowId, cellId, invalidCells) => {
+   *     console.log('Invalid color cell in fido row in pets table');
+   *     console.log(invalidCells);
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', {r: '96', g: '4B', b: '00'});
+   * // -> 'Invalid color cell in fido row in pets table'
+   * // -> [{r: '96', g: '4B', b: '00'}]
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any invalid changes to
+   * any Cell.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addInvalidCellListener(
+   *   null,
+   *   null,
+   *   null,
+   *   (store, tableId, rowId, cellId) => {
+   *     console.log(
+   *       `Invalid ${cellId} cell in ${rowId} row in ${tableId} table`,
+   *     );
+   *   },
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', {r: '96', g: '4B', b: '00'});
+   * // -> 'Invalid color cell in fido row in pets table'
+   * store.setTable('sales', {fido: {date: new Date()}});
+   * // -> 'Invalid date cell in fido row in sales table'
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @example
+   * This example registers a listener that responds to any changes to a
+   * specific Cell, and which also mutates the Store itself.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addInvalidCellListener(
+   *   'pets',
+   *   'fido',
+   *   'color',
+   *   (store, tableId, rowId, cellId, invalidCells) =>
+   *     store.setCell(
+   *       'meta',
+   *       'invalid_updates',
+   *       `${tableId}_${rowId}_${cellId}`,
+   *       JSON.stringify(invalidCells[0]),
+   *     ),
+   *   true,
+   * );
+   *
+   * store.setCell('pets', 'fido', 'color', {r: '96', g: '4B', b: '00'});
+   * console.log(store.getRow('meta', 'invalid_updates'));
+   * // -> {'pets_fido_color': '{"r":"96","g":"4B","b":"00"}'}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  addInvalidCellListener(
+    tableId: IdOrNull,
+    rowId: IdOrNull,
+    cellId: IdOrNull,
+    listener: InvalidCellListener,
+    mutator?: boolean,
+  ): Id;
+
+  /**
+   * The callListener method provides a way for you to manually provoke a
+   * listener to be called, even if the underlying data hasn't changed.
+   *
+   * This is useful when you are using mutator listeners to guarantee that data
+   * conforms to programmatic conditions, and those conditions change such that
+   * you need to update the Store in bulk.
+   *
+   * @param listenerId The Id of the listener to call.
+   * @returns A reference to the Store.
+   * @example
+   * This example registers a listener that ensures a Cell has one of list of a
+   * valid values. After that list changes, the listener is called to apply the
+   * condition to the existing data.
+   *
+   * ```js
+   * const validColors = ['walnut', 'brown', 'black'];
+   * const store = createStore();
+   * const listenerId = store.addCellListener(
+   *   'pets',
+   *   null,
+   *   'color',
+   *   (store, tableId, rowId, cellId, color) => {
+   *     if (!validColors.includes(color)) {
+   *       store.setCell(tableId, rowId, cellId, validColors[0]);
+   *     }
+   *   },
+   *   true,
+   * );
+   *
+   * store.setRow('pets', 'fido', {species: 'dog', color: 'honey'});
+   * console.log(store.getRow('pets', 'fido'));
+   * // -> {species: 'dog', color: 'walnut'}
+   *
+   * validColors.shift();
+   * console.log(validColors);
+   * // -> ['brown', 'black']
+   *
+   * store.callListener(listenerId);
+   * console.log(store.getRow('pets', 'fido'));
+   * // -> {species: 'dog', color: 'brown'}
+   *
+   * store.delListener(listenerId);
+   * ```
+   * @category Listener
+   */
+  callListener(listenerId: Id): Store;
+
+  /**
+   * The delListener method removes a listener that was previously added to the
+   * Store.
+   *
+   * Use the Id returned by whichever method was used to add the listener. Note
+   * that the Store may re-use this Id for future listeners added to it.
+   *
+   * @param listenerId The Id of the listener to remove.
+   * @returns A reference to the Store.
+   * @example
+   * This example registers a listener and then removes it.
+   *
+   * ```js
+   * const store = createStore().setTables({
+   *   pets: {fido: {species: 'dog', color: 'brown'}},
+   * });
+   * const listenerId = store.addTablesListener(() => {
+   *   console.log('Tables changed');
+   * });
+   *
+   * store.setCell('pets', 'fido', 'color', 'walnut');
+   * // -> 'Tables changed'
+   *
+   * store.delListener(listenerId);
+   *
+   * store.setCell('pets', 'fido', 'color', 'honey');
+   * // -> undefined
+   * // The listener is not called.
+   * ```
+   * @category Listener
+   */
+  delListener(listenerId: Id): Store;
+
+  /**
+   * The getListenerStats method provides a set of statistics about the
+   * listeners registered with the Store, and is used for debugging purposes.
+   *
+   * The StoreListenerStats object contains a breakdown of the different types
+   * of listener. Totals include both mutator and non-mutator listeners.
+   *
+   * The statistics are only populated in a debug build: production builds
+   * return an empty object. The method is intended to be used during
+   * development to ensure your application is not leaking listener
+   * registrations, for example.
+   *
+   * @returns A StoreListenerStats object containing Store listener statistics.
+   * @example
+   * This example gets the listener statistics of a small and simple Store.
+   *
+   * ```js
+   * const store = createStore();
+   * store.addTablesListener(() => console.log('Tables changed'));
+   * store.addRowIdsListener(() => console.log('Row Ids changed'));
+   *
+   * const listenerStats = store.getListenerStats();
+   * console.log(listenerStats.rowIds);
+   * // -> 1
+   * console.log(listenerStats.tables);
+   * // -> 1
+   * ```
+   * @category Development
+   */
+  getListenerStats(): StoreListenerStats;
+}
+
+/**
+ * The createStore function creates a Store, and is the main entry point into
+ * the store module.
+ *
+ * Since (or perhaps _because_) it is the most important function in the whole
+ * module, it is trivially simple.
+ *
+ * @returns A reference to the new Store.
+ * @example
+ * This example creates a Store.
+ *
+ * ```js
+ * const store = createStore();
+ * console.log(store.getTables());
+ * // -> {}
+ * ```
+ * @example
+ * This example creates a Store with some initial data:
+ *
+ * ```js
+ * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog'}}}
+ * ```
+ * @example
+ * This example creates a Store with some initial data and a Schema:
+ *
+ * ```js
+ * const store = createStore()
+ *   .setTables({pets: {fido: {species: 'dog'}}})
+ *   .setSchema({
+ *     pets: {
+ *       species: {type: 'string'},
+ *       sold: {type: 'boolean', default: false},
+ *     },
+ *   });
+ * console.log(store.getTables());
+ * // -> {pets: {fido: {species: 'dog', sold: false}}}
+ * ```
+ * @see The Basics guides
+ * @category Creation
+ */
+export function createStore(): Store;