tinybase 10.0.0-beta.1 → 10.0.0-beta.2

package/@types/queries/index.d.ts

@@ -3272,6 +3272,7 @@ export interface Queries {
    * with a reference to the Queries object.
    * @param listener The function that will be called whenever a Query
    * definition is added or removed.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example creates a Store, a Queries object, and then registers a
    * listener that responds to the addition and the removal of a Query
@@ -3321,6 +3322,7 @@ export interface Queries {
    * @param queryId The Id of the query to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the param values
    * of the query change.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example registers two listeners that respond to changes to the param
    * values of a specific query, or any query respectively.
@@ -3392,6 +3394,7 @@ export interface Queries {
    * @param paramId The Id of the param to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the specific
    * param value of the query changes.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example registers two listeners that respond to changes to a specific
    * param value of a specific query, or any param value of any query

package/@types/queries/with-schemas/index.d.ts

@@ -3582,6 +3582,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * with a reference to the Queries object.
    * @param listener The function that will be called whenever a Query
    * definition is added or removed.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example creates a Store, a Queries object, and then registers a
    * listener that responds to the addition and the removal of a Query
@@ -3637,6 +3638,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * @param queryId The Id of the query to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the param values
    * of the query change.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example registers two listeners that respond to changes to the param
    * values of a specific query, or any query respectively.
@@ -3721,6 +3723,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * @param paramId The Id of the param to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the specific
    * param value of the query changes.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example registers two listeners that respond to changes to a specific
    * param value of a specific query, or any param value of any query

package/@types/relationships/index.d.ts

@@ -755,6 +755,7 @@ export interface Relationships {
    * called with a reference to the Relationships object.
    * @param listener The function that will be called whenever a Relationship
    * definition is added or removed.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example creates a Store, a Relationships object, and then registers a
    * listener that responds to the addition and the removal of a Relationship

package/@types/relationships/with-schemas/index.d.ts

@@ -866,6 +866,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * called with a reference to the Relationships object.
    * @param listener The function that will be called whenever a Relationship
    * definition is added or removed.
+   * @returns A unique Id for the listener that can later be used to remove it.
    * @example
    * This example creates a Store, a Relationships object, and then registers a
    * listener that responds to the addition and the removal of a Relationship

package/@types/store/index.d.ts

@@ -739,6 +739,7 @@ export type ValueCallback = (valueId: Id, value: Value) => void;
  * 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.
+ * @returns The new value of the Cell.
  * @category Callback
  * @since v1.0.0
  */
@@ -752,6 +753,7 @@ export type MapCell = (cell: CellOrUndefined) => Cell;
  * a new one, such as when incrementing a number. See that method for specific
  * examples.
  * @param value The current Value to map to a new Value.
+ * @returns The new Value.
  * @category Callback
  * @since v3.0.0
  */
@@ -765,6 +767,7 @@ export type MapValue = (value: ValueOrUndefined) => Value;
  * 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.
+ * @returns The value of the Cell, or `undefined`.
  * @category Callback
  * @since v1.0.0
  */
@@ -871,6 +874,7 @@ export type ChangedValueIds = {[valueId: Id]: IdAddedOrRemoved};
  * can use the getTransactionChanges method and getTransactionLog method of the
  * Store directly to decide whether to do the rollback.
  * @param store A reference to the Store that is completing a transaction.
+ * @returns Whether to rollback the transaction.
  * @category Callback
  * @since v1.0.0
  */

package/@types/store/with-schemas/index.d.ts

@@ -1000,6 +1000,7 @@ export type ValueCallback<
  * 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.
+ * @returns The new value of the Cell.
  * @category Callback
  * @since v1.0.0
  */
@@ -1025,6 +1026,7 @@ export type MapCell<
  * a new one, such as when incrementing a number. See that method for specific
  * examples.
  * @param value The current Value to map to a new Value.
+ * @returns The new Value.
  * @category Callback
  * @since v3.0.0
  */
@@ -1047,6 +1049,7 @@ export type MapValue<
  * 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.
+ * @returns The value of the Cell, or `undefined`.
  * @category Callback
  * @since v1.0.0
  */
@@ -1200,6 +1203,7 @@ export type ChangedValueIds<Schema extends OptionalValuesSchema> = {
  * can use the getTransactionChanges method and getTransactionLog method of the
  * Store directly to decide whether to do the rollback.
  * @param store A reference to the Store that is completing a transaction.
+ * @returns Whether to rollback the transaction.
  * @category Callback
  * @since v1.0.0
  */

package/@types/ui-react/index.d.ts

@@ -288,6 +288,7 @@ export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
  * useSetTableCallback hook or useSetRowCallback hook - so that the Id arguments
  * of the object to set can also be dependent on the event or parameter provided
  * (as well as the object itself being set).
+ * @returns The Id, determined from the parameter and Store.
  * @category Identity
  * @since v1.0.0
  */
@@ -392,6 +393,7 @@ export function useCreateStore(
 
 /**
  * The useCreateMergeableStore hook.
+ * @returns A reference to the MergeableStore.
  * @category Store hooks
  * @since v1.0.0
  */

package/@types/ui-react/with-schemas/index.d.ts

@@ -491,6 +491,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
 
   /**
  * The useCreateMergeableStore hook.
+ * @returns A reference to the MergeableStore.
  * @category Store hooks
  * @since v1.0.0
  */

package/@types/ui-react-dom-charts/index.d.ts

@@ -489,6 +489,7 @@ export type YAxisProps = {
  * The series children declare their own xCellId and yCellId bindings. The
  * optional XAxis component and YAxis component children can be used to
  * configure axis titles, bounds, ticks, and tick formatting.
+ * @returns A rendering of the chart frame and its series.
  * @category Store components
  * @since v8.5.0
  * @example
@@ -544,6 +545,7 @@ export function CartesianChart(
  *
  * ![XAxis component example](https://beta.tinybase.org/shots/axis-overrides-react-demo.png
  * "XAxis component example")
+ * @returns Nothing, since this component only configures the x axis.
  * @category Store components
  * @since v8.5.0
  */
@@ -560,6 +562,7 @@ export function XAxis(props: XAxisProps): ComponentReturnType;
  *
  * ![YAxis component example](https://beta.tinybase.org/shots/axis-overrides-react-demo.png
  * "YAxis component example")
+ * @returns Nothing, since this component only configures the y axis.
  * @category Store components
  * @since v8.5.0
  */
@@ -576,6 +579,7 @@ export function YAxis(props: YAxisProps): ComponentReturnType;
  *
  * ![LineSeries component example](https://beta.tinybase.org/shots/composing-charts-react-demo.png
  * "LineSeries component example")
+ * @returns A rendering of the line series.
  * @category Store components
  * @since v8.5.0
  */
@@ -592,6 +596,7 @@ export function LineSeries(props: SeriesProps): ComponentReturnType;
  *
  * ![BarSeries component example](https://beta.tinybase.org/shots/composing-charts-react-demo.png
  * "BarSeries component example")
+ * @returns A rendering of the bar series.
  * @category Store components
  * @since v8.5.0
  */
@@ -609,6 +614,7 @@ export function BarSeries(props: SeriesProps): ComponentReturnType;
  *
  * ![LineChart component example](https://beta.tinybase.org/shots/basic-chart-react-demo.png "LineChart
  * component example")
+ * @returns A rendering of the line chart.
  * @category Store components
  * @since v8.5.0
  * @example
@@ -662,6 +668,7 @@ export function LineChart(
  *
  * ![BarChart component example](https://beta.tinybase.org/shots/sorting-and-types-react-demo.png
  * "BarChart component example")
+ * @returns A rendering of the bar chart.
  * @category Store components
  * @since v8.5.0
  * @example

package/@types/ui-react-dom-charts/with-schemas/index.d.ts

@@ -550,6 +550,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * The series children declare their own xCellId and yCellId bindings. The
  * optional XAxis component and YAxis component children can be used to
  * configure axis titles, bounds, ticks, and tick formatting.
+ * @returns A rendering of the chart frame and its series.
  * @category Store components
  * @since v8.5.0
  * @example
@@ -611,6 +612,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * ![XAxis component example](https://beta.tinybase.org/shots/axis-overrides-react-demo.png
  * "XAxis component example")
+ * @returns Nothing, since this component only configures the x axis.
  * @category Store components
  * @since v8.5.0
  */
@@ -627,6 +629,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * ![YAxis component example](https://beta.tinybase.org/shots/axis-overrides-react-demo.png
  * "YAxis component example")
+ * @returns Nothing, since this component only configures the y axis.
  * @category Store components
  * @since v8.5.0
  */
@@ -643,6 +646,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * ![LineSeries component example](https://beta.tinybase.org/shots/composing-charts-react-demo.png
  * "LineSeries component example")
+ * @returns A rendering of the line series.
  * @category Store components
  * @since v8.5.0
  */
@@ -659,6 +663,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * ![BarSeries component example](https://beta.tinybase.org/shots/composing-charts-react-demo.png
  * "BarSeries component example")
+ * @returns A rendering of the bar series.
  * @category Store components
  * @since v8.5.0
  */
@@ -686,6 +691,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * ![LineChart component example](https://beta.tinybase.org/shots/basic-chart-react-demo.png "LineChart
  * component example")
+ * @returns A rendering of the line chart.
  * @category Store components
  * @since v8.5.0
  * @example
@@ -752,6 +758,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  *
  * ![BarChart component example](https://beta.tinybase.org/shots/sorting-and-types-react-demo.png
  * "BarChart component example")
+ * @returns A rendering of the bar chart.
  * @category Store components
  * @since v8.5.0
  * @example

package/@types/ui-solid/index.d.ts

@@ -315,6 +315,7 @@ export type UndoOrRedoInformation = [
  * useSetTableCallback primitive or useSetRowCallback primitive - so that the Id
  * arguments of the object to set can also be dependent on the event or
  * parameter provided (as well as the object itself being set).
+ * @returns The Id, determined from the parameter and Store.
  * @category Identity
  * @since v8.3.0
  */
@@ -357,6 +358,7 @@ export function useCreateStore(create: () => Store): Accessor<Store>;
 
 /**
  * The useCreateMergeableStore primitive.
+ * @returns A reference to the MergeableStore.
  * @category Store primitives
  * @since v8.3.0
  */

package/@types/ui-solid/with-schemas/index.d.ts

@@ -449,6 +449,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
 
   /**
  * The useCreateMergeableStore primitive.
+ * @returns A reference to the MergeableStore.
  * @category Store primitives
  * @since v8.3.0
  */

package/@types/ui-svelte/index.d.ts

@@ -1335,6 +1335,7 @@ export type CurrentCheckpointViewProps = {
  * defaults and named instances remain visible unless a nearer Provider replaces
  * them.
  * @param props The props for this component.
+ * @returns A rendering of the child components.
  * @example
  * This example creates a Provider context with a default Store.
  *
@@ -1344,6 +1345,7 @@ export type CurrentCheckpointViewProps = {
  * //   <App />
  * // </Provider>
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1391,6 +1393,7 @@ export const Provider: Component<ProviderProps>;
  * console.log(app.textContent);
  * // -> ''
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1435,6 +1438,7 @@ export const BackwardCheckpointsView: Component<BackwardCheckpointsViewProps>;
  * console.log(app.textContent);
  * // -> 'dog'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1480,6 +1484,7 @@ export const CellView: Component<CellViewProps>;
  * console.log(app.textContent);
  * // -> ''
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1527,6 +1532,7 @@ export const CheckpointView: Component<CheckpointViewProps>;
  * console.log(app.textContent);
  * // -> '0'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1574,6 +1580,7 @@ export const CurrentCheckpointView: Component<CurrentCheckpointViewProps>;
  * console.log(app.textContent);
  * // -> ''
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1625,6 +1632,7 @@ export const ForwardCheckpointsView: Component<ForwardCheckpointsViewProps>;
  * console.log(app.textContent);
  * // -> 'dog cat'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1683,6 +1691,7 @@ export const IndexView: Component<IndexViewProps>;
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1735,6 +1744,7 @@ export const LinkedRowsView: Component<LinkedRowsViewProps>;
  * console.log(app.textContent);
  * // -> 'fido'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1784,6 +1794,7 @@ export const LocalRowsView: Component<LocalRowsViewProps>;
  * console.log(app.textContent);
  * // -> '2'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1836,6 +1847,7 @@ export const MetricView: Component<MetricViewProps>;
  * console.log(app.textContent);
  * // -> 'dog'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1885,6 +1897,7 @@ export const RemoteRowView: Component<RemoteRowViewProps>;
  * console.log(app.textContent);
  * // -> 'brown'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1936,6 +1949,7 @@ export const ResultCellView: Component<ResultCellViewProps>;
  * console.log(app.textContent);
  * // -> 'color'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1993,6 +2007,7 @@ export const ResultRowView: Component<ResultRowViewProps>;
  * console.log(app.textContent);
  * // -> 'felix fido'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2045,6 +2060,7 @@ export const ResultSortedTableView: Component<ResultSortedTableViewProps>;
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2089,6 +2105,7 @@ export const ResultTableView: Component<ResultTableViewProps>;
  * console.log(app.textContent);
  * // -> 'dog'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2140,6 +2157,7 @@ export const RowView: Component<RowViewProps>;
  * console.log(app.textContent);
  * // -> 'fido'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2187,6 +2205,7 @@ export const SliceView: Component<SliceViewProps>;
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2233,6 +2252,7 @@ export const SortedTableView: Component<SortedTableViewProps>;
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2280,6 +2300,7 @@ export const TableView: Component<TableViewProps>;
  * console.log(app.textContent);
  * // -> 'pets species'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2324,6 +2345,7 @@ export const TablesView: Component<TablesViewProps>;
  * console.log(app.textContent);
  * // -> 'true'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2370,6 +2392,7 @@ export const ValueView: Component<ValueViewProps>;
  * console.log(app.textContent);
  * // -> 'open employees'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */

package/@types/ui-svelte/with-schemas/index.d.ts

@@ -1420,6 +1420,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * defaults and named instances remain visible unless a nearer Provider replaces
  * them.
  * @param props The props for this component.
+ * @returns A rendering of the child components.
  * @example
  * This example creates a Provider context with a default Store.
  *
@@ -1429,6 +1430,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * //   <App />
  * // </Provider>
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1479,6 +1481,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'dog'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1529,6 +1532,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'true'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1579,6 +1583,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'dog'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1631,6 +1636,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1684,6 +1690,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1737,6 +1744,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'pets species'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1789,6 +1797,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'open employees'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1844,6 +1853,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> '2'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1901,6 +1911,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'dog cat'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -1958,6 +1969,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'fido'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2016,6 +2028,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'dog'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2074,6 +2087,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'fido'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2138,6 +2152,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2193,6 +2208,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'brown'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2250,6 +2266,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'color'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2308,6 +2325,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'fido felix'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2371,6 +2389,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> 'felix fido'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2424,6 +2443,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> ''
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2477,6 +2497,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> ''
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2532,6 +2553,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> ''
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */
@@ -2587,6 +2609,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * console.log(app.textContent);
  * // -> '0'
  * ```
+ * @function
  * @category Component
  * @since v8.1.0
  */