tinybase 5.0.0-beta.17 → 5.0.0-beta.18

package/lib/types/queries.d.ts

@@ -24,7 +24,9 @@ import {Id, IdOrNull, Ids} from './common.d.ts';
  * object containing individual ResultRow objects, keyed by their Id.
  * @example
  * ```js
- * const resultTable: ResultTable = {
+ * import {ResultTable} from 'tinybase';
+ *
+ * export const resultTable: ResultTable = {
  *   fido: {species: 'dog', color: 'brown'},
  *   felix: {species: 'cat'},
  * };
@@ -43,7 +45,9 @@ export type ResultTable = {[rowId: Id]: ResultRow};
  * object containing individual ResultCell objects, keyed by their Id.
  * @example
  * ```js
- * const resultRow: ResultRow = {species: 'dog', color: 'brown'};
+ * import {ResultRow} from 'tinybase';
+ *
+ * export const resultRow: ResultRow = {species: 'dog', color: 'brown'};
  * ```
  * @category Result
  */
@@ -59,7 +63,9 @@ export type ResultRow = {[cellId: Id]: ResultCell};
  * number, or boolean.
  * @example
  * ```js
- * const resultCell: ResultCell = 'dog';
+ * import {ResultCell} from 'tinybase';
+ *
+ * export const resultCell: ResultCell = 'dog';
  * ```
  * @category Result
  */
@@ -624,6 +630,8 @@ export type GetTableCell = {
  * This example shows a query that selects two Cells from the main query Table.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog', color: 'brown', legs: 4},
  *   felix: {species: 'cat', color: 'black', legs: 4},
@@ -647,6 +655,8 @@ export type GetTableCell = {
  * This example shows a query that selects two Cells, one from a joined Table.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', ownerId: '1'},
@@ -678,6 +688,8 @@ export type GetTableCell = {
  * This example shows a query that calculates a value from two underlying Cells.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', ownerId: '1'},
@@ -693,7 +705,7 @@ export type GetTableCell = {
  * const queries = createQueries(store);
  * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
  *   select(
- *     (getTableCell, rowId) =>
+ *     (getTableCell) =>
  *       `${getTableCell('species')} for ${getTableCell('owners', 'name')}`,
  *   ).as('description');
  *   join('owners', 'ownerId');
@@ -761,6 +773,8 @@ export type Select = {
  * Both are aliased with the 'as' function:
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', ownerId: '1'},
@@ -824,6 +838,8 @@ export type SelectedAs = {
  * in the main query Table.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', ownerId: '1'},
@@ -858,6 +874,8 @@ export type SelectedAs = {
  * the ResultTable.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', buyerId: '1', sellerId: '2'},
@@ -891,6 +909,8 @@ export type SelectedAs = {
  * from multiple values in the root Table rather than a single Cell.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', color: 'brown'},
@@ -926,6 +946,8 @@ export type SelectedAs = {
  * intermediate other.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', ownerId: '1'},
@@ -945,7 +967,7 @@ export type SelectedAs = {
  * const queries = createQueries(store);
  * queries.setQueryDefinition('query', 'pets', ({select, join}) => {
  *   select(
- *     (getTableCell, rowId) =>
+ *     (getTableCell) =>
  *       `${getTableCell('species')} in ${getTableCell('states', 'name')}`,
  *   ).as('description');
  *   // from pets
@@ -1045,6 +1067,8 @@ export type Join = {
  * disambiguate them. Note that the selected Cells are also aliased.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', buyerId: '1', sellerId: '2'},
@@ -1107,6 +1131,8 @@ export type JoinedAs = {
  * comparing an underlying Cell from it with a value.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog'},
  *   felix: {species: 'cat'},
@@ -1131,6 +1157,8 @@ export type JoinedAs = {
  * table has also been aliased, and so its alias is used in the Where clause.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', ownerId: '1'},
@@ -1164,6 +1192,8 @@ export type JoinedAs = {
  * alias is used in the Where clause.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', ownerId: '1'},
@@ -1281,6 +1311,8 @@ export type Where = {
  * single selected Cell from a joined Table.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog'},
@@ -1311,6 +1343,8 @@ export type Where = {
  * aggregated by the two other dimensional 'group by' Cells.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', owner: 'alice'},
@@ -1378,6 +1412,8 @@ export type Group = (
  * disambiguate them.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog', price: 5},
  *   felix: {species: 'cat', price: 4},
@@ -1435,6 +1471,8 @@ export type GroupedAs = {
  * comparing a Cell from it with a value.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog', price: 5},
  *   felix: {species: 'cat', price: 4},
@@ -1464,6 +1502,8 @@ export type GroupedAs = {
  * a condition that is calculated from Cell values.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog', price: 5},
  *   felix: {species: 'cat', price: 4},
@@ -1540,6 +1580,8 @@ export type Having = {
  * and removing listeners for them.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', color: 'brown', ownerId: '1'},
@@ -1657,6 +1699,8 @@ export interface Queries {
    * the `species` Cell matches as certain value.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   * 
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -1696,6 +1740,8 @@ export interface Queries {
    * query, and then removes it.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -1728,6 +1774,8 @@ export interface Queries {
    * then gets its reference in order to update its data.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const queries = createQueries(createStore());
    * queries.setQueryDefinition('dogColors', 'pets', ({select, where}) => {
    *   select('color');
@@ -1753,6 +1801,8 @@ export interface Queries {
    * the Ids of the definitions.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const queries = createQueries(createStore())
    *   .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
    *     select('color');
@@ -1783,6 +1833,8 @@ export interface Queries {
    * This example iterates over each query in a Queries object.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const queries = createQueries(createStore())
    *   .setQueryDefinition('dogColors', 'pets', ({select, where}) => {
    *     select('color');
@@ -1813,6 +1865,8 @@ export interface Queries {
    * This example shows two simple query existence checks.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const queries = createQueries(createStore()).setQueryDefinition(
    *   'dogColors',
    *   'pets',
@@ -1845,6 +1899,8 @@ export interface Queries {
    * underlying Table Id.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const queries = createQueries(createStore()).setQueryDefinition(
    *   'dogColors',
    *   'pets',
@@ -1883,6 +1939,8 @@ export interface Queries {
    * ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -1927,6 +1985,8 @@ export interface Queries {
    * ResultCell Ids.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -1968,6 +2028,8 @@ export interface Queries {
    * ResultRow count.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2010,6 +2072,8 @@ export interface Queries {
    * ResultRow Ids.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2069,6 +2133,8 @@ export interface Queries {
    * ResultRow Ids.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2120,6 +2186,8 @@ export interface Queries {
    * the ResultRow.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2165,6 +2233,8 @@ export interface Queries {
    * ResultCell Ids.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2208,6 +2278,8 @@ export interface Queries {
    * the ResultCell.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2243,6 +2315,8 @@ export interface Queries {
    * This example shows two simple ResultTable existence checks.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2278,6 +2352,8 @@ export interface Queries {
    * This example shows two simple ResultRow existence checks.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2314,6 +2390,8 @@ export interface Queries {
    * This example shows two simple ResultRow existence checks.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2354,6 +2432,8 @@ export interface Queries {
    * This example iterates over each query's ResultTable in a Queries object.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2401,6 +2481,8 @@ export interface Queries {
    * This example iterates over each ResultRow in a query's ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2446,6 +2528,8 @@ export interface Queries {
    * This example iterates over each ResultCell in a query's ResultRow.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2492,6 +2576,8 @@ export interface Queries {
    * definition.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2539,6 +2625,8 @@ export interface Queries {
    * specific ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2573,6 +2661,8 @@ export interface Queries {
    * ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2633,6 +2723,8 @@ export interface Queries {
    * Cell Ids of a specific ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2651,7 +2743,7 @@ export interface Queries {
    *
    * const listenerId = queries.addResultTableCellIdsListener(
    *   'dogColorsAndLegs',
-   *   (queries, tableId) => {
+   *   (queries) => {
    *     console.log(`Cell Ids for dogColorsAndLegs result table changed`);
    *     console.log(queries.getResultTableCellIds('dogColorsAndLegs'));
    *   },
@@ -2668,6 +2760,8 @@ export interface Queries {
    * ResultCell Ids of any ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black', legs: 4},
@@ -2730,6 +2824,8 @@ export interface Queries {
    * of ResultRow objects in a specific ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2764,6 +2860,8 @@ export interface Queries {
    * of ResultRow objects any ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2829,6 +2927,8 @@ export interface Queries {
    * ResultRow Ids of a specific ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2846,7 +2946,7 @@ export interface Queries {
    *
    * const listenerId = queries.addResultRowIdsListener(
    *   'dogColors',
-   *   (queries, tableId) => {
+   *   (queries) => {
    *     console.log(`Row Ids for dogColors result table changed`);
    *     console.log(queries.getResultRowIds('dogColors'));
    *   },
@@ -2863,6 +2963,8 @@ export interface Queries {
    * ResultRow Ids of any ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2943,6 +3045,8 @@ export interface Queries {
    * ResultRow Ids of a specific ResultTable.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -2983,6 +3087,8 @@ export interface Queries {
    * their own value, since the `cellId` parameter is explicitly undefined.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -3058,6 +3164,8 @@ export interface Queries {
    * specific ResultRow.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -3093,6 +3201,8 @@ export interface Queries {
    * ResultRow.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -3164,6 +3274,8 @@ export interface Queries {
    * ResultCell Ids of a specific ResultRow.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -3183,7 +3295,7 @@ export interface Queries {
    * const listenerId = queries.addResultCellIdsListener(
    *   'dogColors',
    *   'fido',
-   *   (store, tableId, rowId) => {
+   *   (queries) => {
    *     console.log(`Cell Ids for fido row in dogColors result table changed`);
    *     console.log(queries.getResultCellIds('dogColors', 'fido'));
    *   },
@@ -3200,6 +3312,8 @@ export interface Queries {
    * ResultCell Ids of any ResultRow.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -3275,6 +3389,8 @@ export interface Queries {
    * specific ResultCell.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -3315,6 +3431,8 @@ export interface Queries {
    * ResultCell.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown', price: 5},
    *   felix: {species: 'cat', color: 'black', price: 4},
@@ -3373,6 +3491,8 @@ export interface Queries {
    * then removes it.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -3387,7 +3507,7 @@ export interface Queries {
    *   },
    * );
    *
-   * const listenerId = queries.addResultTableListener('species', (queries) =>
+   * const listenerId = queries.addResultTableListener('species', () =>
    *   console.log('species result changed'),
    * );
    *
@@ -3417,6 +3537,8 @@ export interface Queries {
    * again, removing the listener.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -3455,6 +3577,8 @@ export interface Queries {
    * This example gets the listener statistics of a Queries object.
    *
    * ```js
+   * import {createQueries, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const queries = createQueries(store);
    * queries.addResultTableListener(null, () => console.log('Result changed'));
@@ -3484,6 +3608,8 @@ export interface Queries {
  * This example creates a Queries object.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const queries = createQueries(store);
  * console.log(queries.getQueryIds());
@@ -3494,6 +3620,8 @@ export interface Queries {
  * for the same Store to return the same object.
  *
  * ```js
+ * import {createQueries, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const queries1 = createQueries(store);
  * const queries2 = createQueries(store);