tinybase 8.1.0-beta.0 → 8.1.0-beta.1

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

@@ -0,0 +1,2248 @@
+/**
+ * The ui-svelte module of the TinyBase project provides both hooks and
+ * components to make it easy to create reactive Svelte 5 apps with Store
+ * objects.
+ *
+ * The hooks in this module provide access to the data and structures exposed by
+ * other modules in the project. They return reactive objects with a `current`
+ * property. Hooks register listeners such that components using those hooks
+ * re-render when data changes.
+ *
+ * Hook parameters accept either plain values or reactive getter functions
+ * (`R<T> = T | (() => T)`), so passing `() => tableId` from a `let`-bound
+ * Svelte prop makes the hook re-execute whenever the prop changes.
+ *
+ * The components in this module provide a further abstraction over those hooks
+ * to ease the composition of user interfaces that use TinyBase.
+ * @see Building UIs With Svelte guide
+ * @packageDocumentation
+ * @module ui-svelte
+ * @since v8.1.0
+ */
+import type {Component, Snippet} from 'svelte';
+import type {CheckpointIds, Checkpoints} from '../checkpoints/index.d.ts';
+import type {Id, Ids} from '../common/index.d.ts';
+import type {Indexes} from '../indexes/index.d.ts';
+import type {Metrics} from '../metrics/index.d.ts';
+import type {AnyPersister, Status} from '../persisters/index.d.ts';
+import type {Queries} from '../queries/index.d.ts';
+import type {Relationships} from '../relationships/index.d.ts';
+import type {
+  Cell,
+  CellOrUndefined,
+  Row,
+  Store,
+  Table,
+  Tables,
+  Value,
+  ValueOrUndefined,
+  Values,
+} from '../store/index.d.ts';
+import type {Synchronizer} from '../synchronizers/index.d.ts';
+
+/**
+ * The R type represents a value that can be provided either as a plain value
+ * or as a reactive getter function.
+ *
+ * When a getter function is provided to a hook, the hook's internal `$effect`
+ * will re-run whenever the getter's reactive dependencies change. This is the
+ * mechanism that makes Svelte 5 props reactive in hooks.
+ * @category Identity
+ * @since v8.1.0
+ */
+export type R<T> = T | (() => T);
+
+/**
+ * The ProviderProps type describes the props of the Provider component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ProviderProps = {
+  /**
+   * A default single Store object that will be available within the Provider
+   * context.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly store?: Store;
+  /**
+   * An object containing multiple Store objects that will be available within
+   * the Provider context by their Id.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly storesById?: {readonly [id: Id]: Store};
+  /**
+   * A default single Metrics object that will be available within the Provider
+   * context.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly metrics?: Metrics;
+  /**
+   * An object containing multiple Metrics objects that will be available within
+   * the Provider context by their Id.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly metricsById?: {readonly [id: Id]: Metrics};
+  /**
+   * A default single Indexes object that will be available within the Provider
+   * context.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly indexes?: Indexes;
+  /**
+   * An object containing multiple Indexes objects that will be available within
+   * the Provider context by their Id.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly indexesById?: {readonly [id: Id]: Indexes};
+  /**
+   * A default single Relationships object that will be available within the
+   * Provider context.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly relationships?: Relationships;
+  /**
+   * An object containing multiple Relationships objects that will be available
+   * within the Provider context by their Id.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly relationshipsById?: {readonly [id: Id]: Relationships};
+  /**
+   * A default single Queries object that will be available within the Provider
+   * context, since v2.0.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly queries?: Queries;
+  /**
+   * An object containing multiple Queries objects that will be available within
+   * the Provider context by their Id, since v2.0.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly queriesById?: {readonly [id: Id]: Queries};
+  /**
+   * A default single Checkpoints object that will be available within the
+   * Provider context.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly checkpoints?: Checkpoints;
+  /**
+   * An object containing multiple Checkpoints objects that will be available
+   * within the Provider context by their Id.
+   * @category Prop
+   * @since v1.0.0
+   */
+  readonly checkpointsById?: {readonly [id: Id]: Checkpoints};
+  /**
+   * A default single Persister object that will be available within the
+   * Provider context.
+   * @category Prop
+   * @since v5.3.0
+   */
+  readonly persister?: AnyPersister;
+  /**
+   * An object containing multiple Persister objects that will be available
+   * within the Provider context by their Id.
+   * @category Prop
+   * @since v5.3.0
+   */
+  readonly persistersById?: {readonly [id: Id]: AnyPersister};
+  /**
+   * A default single Synchronizer object that will be available within the
+   * Provider context.
+   * @category Prop
+   * @since v5.3.0
+   */
+  readonly synchronizer?: Synchronizer;
+  /**
+   * An object containing multiple Synchronizer objects that will be available
+   * within the Provider context by their Id.
+   * @category Prop
+   * @since v5.3.0
+   */
+  readonly synchronizersById?: {readonly [id: Id]: Synchronizer};
+  /**
+   * The `children` prop of a ProviderProps object — the app subtree that will
+   * have access to the provided context.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly children: Snippet;
+};
+
+/**
+ * The CellViewProps type describes the props of the CellView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type CellViewProps = {
+  /**
+   * The `tableId` prop of a CellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly tableId: Id;
+  /**
+   * The `rowId` prop of a CellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly rowId: Id;
+  /**
+   * The `cellId` prop of a CellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly cellId: Id;
+  /**
+   * The `store` prop of a CellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly store?: Store | Id;
+  /**
+   * The `debugIds` prop of a CellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+};
+
+/**
+ * The ValueViewProps type describes the props of the ValueView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ValueViewProps = {
+  /**
+   * The `valueId` prop of a ValueViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly valueId: Id;
+  /**
+   * The `store` prop of a ValueViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly store?: Store | Id;
+  /**
+   * The `debugIds` prop of a ValueViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+};
+
+/**
+ * The MetricViewProps type describes the props of the MetricView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type MetricViewProps = {
+  /**
+   * The `metricId` prop of a MetricViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly metricId: Id;
+  /**
+   * The `metrics` prop of a MetricViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly metrics?: Metrics | Id;
+  /**
+   * The `debugIds` prop of a MetricViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+};
+
+/**
+ * The CheckpointViewProps type describes the props of the CheckpointView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type CheckpointViewProps = {
+  /**
+   * The `checkpointId` prop of a CheckpointViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpointId: Id;
+  /**
+   * The `checkpoints` prop of a CheckpointViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpoints?: Checkpoints | Id;
+  /**
+   * The `debugIds` prop of a CheckpointViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+};
+
+/**
+ * The RowViewProps type describes the props of the RowView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type RowViewProps = {
+  /**
+   * The `tableId` prop of a RowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly tableId: Id;
+  /**
+   * The `rowId` prop of a RowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly rowId: Id;
+  /**
+   * The `store` prop of a RowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly store?: Store | Id;
+  /**
+   * The `customCellIds` prop of a RowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly customCellIds?: Ids;
+  /**
+   * The `separator` prop of a RowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a RowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `cell` snippet prop of a RowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly cell?: Snippet<[cellId: Id]>;
+};
+
+/**
+ * The TableViewProps type describes the props of the TableView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type TableViewProps = {
+  /**
+   * The `tableId` prop of a TableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly tableId: Id;
+  /**
+   * The `store` prop of a TableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly store?: Store | Id;
+  /**
+   * The `customCellIds` prop of a TableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly customCellIds?: Ids;
+  /**
+   * The `separator` prop of a TableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a TableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a TableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The SortedTableViewProps type describes the props of the SortedTableView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type SortedTableViewProps = {
+  /**
+   * The `tableId` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly tableId: Id;
+  /**
+   * The `cellId` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly cellId?: Id;
+  /**
+   * The `descending` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly descending?: boolean;
+  /**
+   * The `offset` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly offset?: number;
+  /**
+   * The `limit` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly limit?: number;
+  /**
+   * The `store` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly store?: Store | Id;
+  /**
+   * The `customCellIds` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly customCellIds?: Ids;
+  /**
+   * The `separator` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a SortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The TablesViewProps type describes the props of the TablesView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type TablesViewProps = {
+  /**
+   * The `store` prop of a TablesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly store?: Store | Id;
+  /**
+   * The `separator` prop of a TablesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a TablesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `table` snippet prop of a TablesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly table?: Snippet<[tableId: Id]>;
+};
+
+/**
+ * The ValuesViewProps type describes the props of the ValuesView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ValuesViewProps = {
+  /**
+   * The `store` prop of a ValuesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly store?: Store | Id;
+  /**
+   * The `separator` prop of a ValuesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a ValuesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `value` snippet prop of a ValuesViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly value?: Snippet<[valueId: Id]>;
+};
+
+/**
+ * The IndexViewProps type describes the props of the IndexView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type IndexViewProps = {
+  /**
+   * The `indexId` prop of an IndexViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly indexId: Id;
+  /**
+   * The `indexes` prop of an IndexViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly indexes?: Indexes | Id;
+  /**
+   * The `separator` prop of an IndexViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of an IndexViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `slice` snippet prop of an IndexViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly slice?: Snippet<[sliceId: Id]>;
+};
+
+/**
+ * The SliceViewProps type describes the props of the SliceView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type SliceViewProps = {
+  /**
+   * The `indexId` prop of a SliceViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly indexId: Id;
+  /**
+   * The `sliceId` prop of a SliceViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly sliceId: Id;
+  /**
+   * The `indexes` prop of a SliceViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly indexes?: Indexes | Id;
+  /**
+   * The `separator` prop of a SliceViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a SliceViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a SliceViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The RemoteRowViewProps type describes the props of the RemoteRowView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type RemoteRowViewProps = {
+  /**
+   * The `relationshipId` prop of a RemoteRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly relationshipId: Id;
+  /**
+   * The `localRowId` prop of a RemoteRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly localRowId: Id;
+  /**
+   * The `relationships` prop of a RemoteRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly relationships?: Relationships | Id;
+  /**
+   * The `debugIds` prop of a RemoteRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a RemoteRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The LocalRowsViewProps type describes the props of the LocalRowsView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type LocalRowsViewProps = {
+  /**
+   * The `relationshipId` prop of a LocalRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly relationshipId: Id;
+  /**
+   * The `remoteRowId` prop of a LocalRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly remoteRowId: Id;
+  /**
+   * The `relationships` prop of a LocalRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly relationships?: Relationships | Id;
+  /**
+   * The `separator` prop of a LocalRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a LocalRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a LocalRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The LinkedRowsViewProps type describes the props of the LinkedRowsView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type LinkedRowsViewProps = {
+  /**
+   * The `relationshipId` prop of a LinkedRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly relationshipId: Id;
+  /**
+   * The `firstRowId` prop of a LinkedRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly firstRowId: Id;
+  /**
+   * The `relationships` prop of a LinkedRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly relationships?: Relationships | Id;
+  /**
+   * The `separator` prop of a LinkedRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a LinkedRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a LinkedRowsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The ResultCellViewProps type describes the props of the ResultCellView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ResultCellViewProps = {
+  /**
+   * The `queryId` prop of a ResultCellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queryId: Id;
+  /**
+   * The `rowId` prop of a ResultCellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly rowId: Id;
+  /**
+   * The `cellId` prop of a ResultCellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly cellId: Id;
+  /**
+   * The `queries` prop of a ResultCellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queries?: Queries | Id;
+  /**
+   * The `debugIds` prop of a ResultCellViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+};
+
+/**
+ * The ResultRowViewProps type describes the props of the ResultRowView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ResultRowViewProps = {
+  /**
+   * The `queryId` prop of a ResultRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queryId: Id;
+  /**
+   * The `rowId` prop of a ResultRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly rowId: Id;
+  /**
+   * The `queries` prop of a ResultRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queries?: Queries | Id;
+  /**
+   * The `separator` prop of a ResultRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a ResultRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `cell` snippet prop of a ResultRowViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly cell?: Snippet<[cellId: Id]>;
+};
+
+/**
+ * The ResultTableViewProps type describes the props of the ResultTableView
+ * component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ResultTableViewProps = {
+  /**
+   * The `queryId` prop of a ResultTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queryId: Id;
+  /**
+   * The `queries` prop of a ResultTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queries?: Queries | Id;
+  /**
+   * The `separator` prop of a ResultTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a ResultTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a ResultTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The ResultSortedTableViewProps type describes the props of the
+ * ResultSortedTableView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ResultSortedTableViewProps = {
+  /**
+   * The `queryId` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queryId: Id;
+  /**
+   * The `cellId` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly cellId?: Id;
+  /**
+   * The `descending` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly descending?: boolean;
+  /**
+   * The `offset` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly offset?: number;
+  /**
+   * The `limit` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly limit?: number;
+  /**
+   * The `queries` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly queries?: Queries | Id;
+  /**
+   * The `separator` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `row` snippet prop of a ResultSortedTableViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly row?: Snippet<[rowId: Id]>;
+};
+
+/**
+ * The BackwardCheckpointsViewProps type describes the props of the
+ * BackwardCheckpointsView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type BackwardCheckpointsViewProps = {
+  /**
+   * The `checkpoints` prop of a BackwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpoints?: Checkpoints | Id;
+  /**
+   * The `separator` prop of a BackwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a BackwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `checkpoint` snippet prop of a BackwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpoint?: Snippet<[checkpointId: Id]>;
+};
+
+/**
+ * The ForwardCheckpointsViewProps type describes the props of the
+ * ForwardCheckpointsView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type ForwardCheckpointsViewProps = {
+  /**
+   * The `checkpoints` prop of a ForwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpoints?: Checkpoints | Id;
+  /**
+   * The `separator` prop of a ForwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly separator?: Snippet<[]>;
+  /**
+   * The `debugIds` prop of a ForwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `checkpoint` snippet prop of a ForwardCheckpointsViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpoint?: Snippet<[checkpointId: Id]>;
+};
+
+/**
+ * The CurrentCheckpointViewProps type describes the props of the
+ * CurrentCheckpointView component.
+ * @category Props
+ * @since v8.1.0
+ */
+export type CurrentCheckpointViewProps = {
+  /**
+   * The `checkpoints` prop of a CurrentCheckpointViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpoints?: Checkpoints | Id;
+  /**
+   * The `debugIds` prop of a CurrentCheckpointViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly debugIds?: boolean;
+  /**
+   * The `checkpoint` snippet prop of a CurrentCheckpointViewProps object.
+   * @category Props
+   * @since v8.1.0
+   */
+  readonly checkpoint?: Snippet<[checkpointId: Id]>;
+};
+
+/**
+ * The Provider component wraps part of an application to make TinyBase objects
+ * available throughout its component subtree via Svelte context.
+ *
+ * Store objects, Metrics, Indexes, Relationships, Queries, Checkpoints,
+ * Persisters, and Synchronizers can all be provided both as single defaults and
+ * as named instances in a `*ById` map.
+ * @param props The props for this component.
+ * @example
+ * This example creates a Provider context with a default Store.
+ *
+ * ```ts
+ * // In a .svelte file:
+ * // <Provider store={createStore()}>
+ * //   <App />
+ * // </Provider>
+ * ```
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const Provider: Component<ProviderProps>;
+
+/**
+ * The BackwardCheckpointsView component renders the list of checkpoint Ids that
+ * represent backward checkpoints in a Checkpoints object, and registers a
+ * listener so that any changes to that result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the backward checkpoint Ids.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const BackwardCheckpointsView: Component<BackwardCheckpointsViewProps>;
+
+/**
+ * The CellView component renders the value of a single Cell in a given Row in
+ * a given Table, and registers a listener so that any changes to that result
+ * will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the Cell, or nothing if not present.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const CellView: Component<CellViewProps>;
+
+/**
+ * The CheckpointView component renders the label of a checkpoint in a
+ * Checkpoints object, and registers a listener so that any changes to that
+ * result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the checkpoint label.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const CheckpointView: Component<CheckpointViewProps>;
+
+/**
+ * The CurrentCheckpointView component renders the current checkpoint in a
+ * Checkpoints object, and registers a listener so that any changes to that
+ * result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the current checkpoint.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const CurrentCheckpointView: Component<CurrentCheckpointViewProps>;
+
+/**
+ * The ForwardCheckpointsView component renders the list of checkpoint Ids that
+ * represent forward checkpoints in a Checkpoints object, and registers a
+ * listener so that any changes to that result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the forward checkpoint Ids.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const ForwardCheckpointsView: Component<ForwardCheckpointsViewProps>;
+
+/**
+ * The IndexView component renders the slices in a named Index, and registers a
+ * listener so that any changes to that result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the slices.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const IndexView: Component<IndexViewProps>;
+
+/**
+ * The LinkedRowsView component renders the Rows in a linked list Relationship,
+ * and registers a listener so that any changes to that result will cause a
+ * re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the linked Row Ids.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const LinkedRowsView: Component<LinkedRowsViewProps>;
+
+/**
+ * The LocalRowsView component renders the local Row Ids for a given remote Row
+ * in a Relationship, and registers a listener so that any changes to that
+ * result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the local Row Ids.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const LocalRowsView: Component<LocalRowsViewProps>;
+
+/**
+ * The MetricView component renders the value of a named Metric in a Metrics
+ * object, and registers a listener so that any changes to that result will
+ * cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the Metric value.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const MetricView: Component<MetricViewProps>;
+
+/**
+ * The RemoteRowView component renders the remote Row Id for a given local Row
+ * in a Relationship, and registers a listener so that any changes to that
+ * result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the remote Row.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const RemoteRowView: Component<RemoteRowViewProps>;
+
+/**
+ * The ResultCellView component renders the value of a single Cell in a given
+ * Result Row in a given Result Table of a Queries object, and registers a
+ * listener so that any changes to that result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the result Cell.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const ResultCellView: Component<ResultCellViewProps>;
+
+/**
+ * The ResultRowView component renders the contents of a single Result Row in a
+ * given Result Table, and registers a listener so that any changes to that
+ * result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the result Row.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const ResultRowView: Component<ResultRowViewProps>;
+
+/**
+ * The ResultSortedTableView component renders the contents of a single sorted
+ * Result Table in a Queries object, and registers a listener so that any
+ * changes to that result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the sorted result Table.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const ResultSortedTableView: Component<ResultSortedTableViewProps>;
+
+/**
+ * The ResultTableView component renders the contents of a single Result Table
+ * in a Queries object, and registers a listener so that any changes to that
+ * result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the result Table.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const ResultTableView: Component<ResultTableViewProps>;
+
+/**
+ * The RowView component renders the contents of a single Row in a given Table,
+ * and registers a listener so that any changes to that result will cause a
+ * re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the Row, or nothing if not present.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const RowView: Component<RowViewProps>;
+
+/**
+ * The SliceView component renders the Row Ids in a named Slice in an Index,
+ * and registers a listener so that any changes to that result will cause a
+ * re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the Rows in the Slice.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const SliceView: Component<SliceViewProps>;
+
+/**
+ * The SortedTableView component renders the contents of a single Table in a
+ * sorted order, and registers a listener so that any changes to that result
+ * will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the sorted Table.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const SortedTableView: Component<SortedTableViewProps>;
+
+/**
+ * The TableView component renders the contents of a single Table, and
+ * registers a listener so that any changes to that result will cause a
+ * re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the Table.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const TableView: Component<TableViewProps>;
+
+/**
+ * The TablesView component renders the contents of all Tables in a Store, and
+ * registers a listener so that any changes to that result will cause a
+ * re-render.
+ * @param props The props for this component.
+ * @returns A rendering of all Tables.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const TablesView: Component<TablesViewProps>;
+
+/**
+ * The ValueView component renders the value of a single Value in a Store, and
+ * registers a listener so that any changes to that result will cause a
+ * re-render.
+ * @param props The props for this component.
+ * @returns A rendering of the Value, or nothing if not present.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const ValueView: Component<ValueViewProps>;
+
+/**
+ * The ValuesView component renders all Values in a Store, and registers a
+ * listener so that any changes to that result will cause a re-render.
+ * @param props The props for this component.
+ * @returns A rendering of all Values.
+ * @category Component
+ * @since v8.1.0
+ */
+export declare const ValuesView: Component<ValuesViewProps>;
+
+/**
+ * The useHasTables hook returns a reactive object indicating whether any Tables
+ * exist in the Store, and registers a listener so that any changes to that
+ * result will update `.current`.
+ * @param storeOrStoreId The Store to use, or its Id in a Provider context.
+ * @returns A reactive object with a `current` boolean property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useHasTables(storeOrStoreId?: R<Store | Id | undefined>): {
+  readonly current: boolean;
+};
+
+/**
+ * The useTables hook returns a reactive object reflecting the Tables in the
+ * Store, and registers a listener so that any changes to those Tables will
+ * update `.current`.
+ * @param storeOrStoreId The Store to use, or its Id in a Provider context.
+ * @returns A reactive object with a `current` Tables property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useTables(storeOrStoreId?: R<Store | Id | undefined>): {
+  readonly current: Tables;
+};
+
+/**
+ * The useTableIds hook returns a reactive object reflecting the Ids of the
+ * Tables in a Store, and registers a listener so that any changes to those Ids
+ * will update `.current`.
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useTableIds(storeOrStoreId?: R<Store | Id | undefined>): {
+  readonly current: Ids;
+};
+
+/**
+ * The useHasTable hook returns a reactive object indicating whether a Table
+ * exists in the Store, and registers a listener so that any changes to that
+ * result will update `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` boolean property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useHasTable(
+  tableId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: boolean};
+
+/**
+ * The useTable hook returns a reactive object reflecting a Table in a Store,
+ * and registers a listener so that any changes to that Table will update
+ * `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Table property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useTable(
+  tableId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: Table};
+
+/**
+ * The useTableCellIds hook returns a reactive object reflecting the Ids of all
+ * Cells used across a Table, and registers a listener so that any changes to
+ * those Ids will update `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useTableCellIds(
+  tableId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useHasTableCell hook returns a reactive object indicating whether a
+ * particular Cell is used anywhere in a Table, and registers a listener so
+ * that any changes to that result will update `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param cellId The Id of the Cell (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` boolean property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useHasTableCell(
+  tableId: R<Id>,
+  cellId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: boolean};
+
+/**
+ * The useRowCount hook returns a reactive object reflecting the number of Rows
+ * in a Table, and registers a listener so that any changes will update
+ * `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` number property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useRowCount(
+  tableId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: number};
+
+/**
+ * The useRowIds hook returns a reactive object reflecting the Ids of the Rows
+ * in a Table, and registers a listener so that any changes will update
+ * `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useRowIds(
+  tableId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useSortedRowIds hook returns a reactive object reflecting the sorted Row
+ * Ids in a Table, and registers a listener so that any changes will update
+ * `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param cellId The Id of the Cell to sort by (or a getter returning it).
+ * @param descending Whether to sort descending (or a getter returning it).
+ * @param offset The starting Row offset (or a getter returning it).
+ * @param limit The maximum number of Rows to return (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useSortedRowIds(
+  tableId: R<Id>,
+  cellId?: R<Id | undefined>,
+  descending?: R<boolean>,
+  offset?: R<number>,
+  limit?: R<number | undefined>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useHasRow hook returns a reactive object indicating whether a Row exists
+ * in a Table, and registers a listener so that any changes to that result will
+ * update `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` boolean property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useHasRow(
+  tableId: R<Id>,
+  rowId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: boolean};
+
+/**
+ * The useRow hook returns a reactive object reflecting a Row in a Table, and
+ * registers a listener so that any changes to that Row will update `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Row property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useRow(
+  tableId: R<Id>,
+  rowId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: Row};
+
+/**
+ * The useCellIds hook returns a reactive object reflecting the Ids of the
+ * Cells in a Row, and registers a listener so that any changes will update
+ * `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useCellIds(
+  tableId: R<Id>,
+  rowId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useHasCell hook returns a reactive object indicating whether a Cell
+ * exists in a Row in a Table, and registers a listener so that any changes to
+ * that result will update `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param cellId The Id of the Cell (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` boolean property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useHasCell(
+  tableId: R<Id>,
+  rowId: R<Id>,
+  cellId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: boolean};
+
+/**
+ * The useCell hook returns a reactive object reflecting the value of a Cell in
+ * a Row in a Table, and registers a listener so that any changes to that Cell
+ * will update `.current`.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param cellId The Id of the Cell (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` CellOrUndefined property.
+ * @example
+ * This example uses the useCell hook to display a Cell value reactively.
+ *
+ * ```ts
+ * // In a .svelte file:
+ * // const store = createStore().setCell('pets', 'cat', 'name', 'Fido');
+ * // const name = useCell('pets', 'cat', 'name', store);
+ * // $: console.log(name.current); // 'Fido'
+ * ```
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useCell(
+  tableId: R<Id>,
+  rowId: R<Id>,
+  cellId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: CellOrUndefined};
+
+/**
+ * The useCellState hook returns a reactive object reflecting the value of a
+ * Cell, with a settable `current` property that writes back to the Store.
+ * @param tableId The Id of the Table (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param cellId The Id of the Cell (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with gettable and settable `current`.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useCellState(
+  tableId: R<Id>,
+  rowId: R<Id>,
+  cellId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {get current(): CellOrUndefined; set current(v: Cell)};
+
+/**
+ * The useHasValues hook returns a reactive object indicating whether any Values
+ * exist in the Store, and registers a listener so that any changes to that
+ * result will update `.current`.
+ * @param storeOrStoreId The Store to use, or its Id in a Provider context.
+ * @returns A reactive object with a `current` boolean property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useHasValues(storeOrStoreId?: R<Store | Id | undefined>): {
+  readonly current: boolean;
+};
+
+/**
+ * The useValues hook returns a reactive object reflecting the Values in the
+ * Store, and registers a listener so that any changes will update `.current`.
+ * @param storeOrStoreId The Store to use, or its Id in a Provider context.
+ * @returns A reactive object with a `current` Values property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useValues(storeOrStoreId?: R<Store | Id | undefined>): {
+  readonly current: Values;
+};
+
+/**
+ * The useValueIds hook returns a reactive object reflecting the Ids of the
+ * Values in a Store, and registers a listener so that any changes will update
+ * `.current`.
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useValueIds(storeOrStoreId?: R<Store | Id | undefined>): {
+  readonly current: Ids;
+};
+
+/**
+ * The useHasValue hook returns a reactive object indicating whether a Value
+ * exists in the Store, and registers a listener so that any changes to that
+ * result will update `.current`.
+ * @param valueId The Id of the Value (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` boolean property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useHasValue(
+  valueId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: boolean};
+
+/**
+ * The useValue hook returns a reactive object reflecting the value of a Value
+ * in a Store, and registers a listener so that any changes to that Value will
+ * update `.current`.
+ * @param valueId The Id of the Value (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with a `current` ValueOrUndefined property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useValue(
+  valueId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {readonly current: ValueOrUndefined};
+
+/**
+ * The useValueState hook returns a reactive object reflecting the value of a
+ * Value, with a settable `current` property that writes back to the Store.
+ * @param valueId The Id of the Value (or a getter returning it).
+ * @param storeOrStoreId The Store to use (plain value or getter), or its Id.
+ * @returns A reactive object with gettable and settable `current`.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useValueState(
+  valueId: R<Id>,
+  storeOrStoreId?: R<Store | Id | undefined>,
+): {get current(): ValueOrUndefined; set current(v: Value)};
+
+/**
+ * The useStore hook returns the default Store from the current Provider context
+ * (or a named Store if an Id is provided).
+ * @param id An optional Id of a named Store in the Provider context.
+ * @returns The Store, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useStore(id?: Id): Store | undefined;
+
+/**
+ * The useStoreIds hook returns a reactive object with the Ids of all Stores
+ * registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useStoreIds(): {readonly current: Ids};
+
+/**
+ * The useMetrics hook returns the default Metrics object from the current
+ * Provider context (or a named one if an Id is provided).
+ * @param id An optional Id of a named Metrics object in the Provider context.
+ * @returns The Metrics object, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useMetrics(id?: Id): Metrics | undefined;
+
+/**
+ * The useMetricsIds hook returns a reactive object with the Ids of all Metrics
+ * objects registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useMetricsIds(): {readonly current: Ids};
+
+/**
+ * The useMetricIds hook returns a reactive object reflecting the Ids of the
+ * Metrics in a Metrics object, and registers a listener so that any changes
+ * will update `.current`.
+ * @param metricsOrMetricsId The Metrics object to use, or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useMetricIds(
+  metricsOrMetricsId?: R<Metrics | Id | undefined>,
+): {
+  readonly current: Ids;
+};
+
+/**
+ * The useMetric hook returns a reactive object reflecting the value of a named
+ * Metric in a Metrics object, and registers a listener so that any changes to
+ * that Metric will update `.current`.
+ * @param metricId The Id of the Metric (or a getter returning it).
+ * @param metricsOrMetricsId The Metrics object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` number | undefined property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useMetric(
+  metricId: R<Id>,
+  metricsOrMetricsId?: R<Metrics | Id | undefined>,
+): {readonly current: number | undefined};
+
+/**
+ * The useIndexes hook returns the default Indexes object from the current
+ * Provider context (or a named one if an Id is provided).
+ * @param id An optional Id of a named Indexes object in the Provider context.
+ * @returns The Indexes object, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useIndexes(id?: Id): Indexes | undefined;
+
+/**
+ * The useIndexesIds hook returns a reactive object with the Ids of all Indexes
+ * objects registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useIndexesIds(): {readonly current: Ids};
+
+/**
+ * The useIndexIds hook returns a reactive object reflecting the Ids of the
+ * Indexes in an Indexes object, and registers a listener so that any changes
+ * will update `.current`.
+ * @param indexesOrIndexesId The Indexes object to use, or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useIndexIds(indexesOrIndexesId?: R<Indexes | Id | undefined>): {
+  readonly current: Ids;
+};
+
+/**
+ * The useSliceIds hook returns a reactive object reflecting the Ids of the
+ * Slices in an Index, and registers a listener so that any changes will update
+ * `.current`.
+ * @param indexId The Id of the Index (or a getter returning it).
+ * @param indexesOrIndexesId The Indexes object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useSliceIds(
+  indexId: R<Id>,
+  indexesOrIndexesId?: R<Indexes | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useSliceRowIds hook returns a reactive object reflecting the Ids of the
+ * Rows in a Slice, and registers a listener so that any changes will update
+ * `.current`.
+ * @param indexId The Id of the Index (or a getter returning it).
+ * @param sliceId The Id of the Slice (or a getter returning it).
+ * @param indexesOrIndexesId The Indexes object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useSliceRowIds(
+  indexId: R<Id>,
+  sliceId: R<Id>,
+  indexesOrIndexesId?: R<Indexes | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useQueries hook returns the default Queries object from the current
+ * Provider context (or a named one if an Id is provided).
+ * @param id An optional Id of a named Queries object in the Provider context.
+ * @returns The Queries object, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useQueries(id?: Id): Queries | undefined;
+
+/**
+ * The useQueriesIds hook returns a reactive object with the Ids of all Queries
+ * objects registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useQueriesIds(): {readonly current: Ids};
+
+/**
+ * The useQueryIds hook returns a reactive object reflecting the Ids of the
+ * Queries in a Queries object, and registers a listener so that any changes
+ * will update `.current`.
+ * @param queriesOrQueriesId The Queries object to use, or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useQueryIds(queriesOrQueriesId?: R<Queries | Id | undefined>): {
+  readonly current: Ids;
+};
+
+/**
+ * The useResultTable hook returns a reactive object reflecting a result Table
+ * in a Queries object, and registers a listener so that any changes to that
+ * result will update `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Table property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultTable(
+  queryId: R<Id>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: Table};
+
+/**
+ * The useResultTableCellIds hook returns a reactive object reflecting the Ids
+ * of all Cells used across a result Table, and registers a listener so that
+ * any changes will update `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultTableCellIds(
+  queryId: R<Id>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useResultRowCount hook returns a reactive object reflecting the number of
+ * Rows in a result Table, and registers a listener so that any changes will
+ * update `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` number property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultRowCount(
+  queryId: R<Id>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: number};
+
+/**
+ * The useResultRowIds hook returns a reactive object reflecting the Ids of the
+ * Rows in a result Table, and registers a listener so that any changes will
+ * update `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultRowIds(
+  queryId: R<Id>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useResultSortedRowIds hook returns a reactive object reflecting the
+ * sorted Row Ids in a result Table, and registers a listener so that any
+ * changes will update `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param cellId The Id of the Cell to sort by (or a getter returning it).
+ * @param descending Whether to sort descending (or a getter returning it).
+ * @param offset The starting Row offset (or a getter returning it).
+ * @param limit The maximum number of Rows (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultSortedRowIds(
+  queryId: R<Id>,
+  cellId?: R<Id | undefined>,
+  descending?: R<boolean>,
+  offset?: R<number>,
+  limit?: R<number | undefined>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useResultRow hook returns a reactive object reflecting a result Row in a
+ * result Table, and registers a listener so that any changes will update
+ * `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Row property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultRow(
+  queryId: R<Id>,
+  rowId: R<Id>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: Row};
+
+/**
+ * The useResultCellIds hook returns a reactive object reflecting the Ids of the
+ * Cells in a result Row, and registers a listener so that any changes will
+ * update `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultCellIds(
+  queryId: R<Id>,
+  rowId: R<Id>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useResultCell hook returns a reactive object reflecting the value of a
+ * Cell in a result Row, and registers a listener so that any changes will
+ * update `.current`.
+ * @param queryId The Id of the Query (or a getter returning it).
+ * @param rowId The Id of the Row (or a getter returning it).
+ * @param cellId The Id of the Cell (or a getter returning it).
+ * @param queriesOrQueriesId The Queries object to use (plain or getter), or
+ * its Id.
+ * @returns A reactive object with a `current` Cell | undefined property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useResultCell(
+  queryId: R<Id>,
+  rowId: R<Id>,
+  cellId: R<Id>,
+  queriesOrQueriesId?: R<Queries | Id | undefined>,
+): {readonly current: CellOrUndefined};
+
+/**
+ * The useRelationships hook returns the default Relationships object from the
+ * current Provider context (or a named one if an Id is provided).
+ * @param id An optional Id of a named Relationships object in the Provider
+ * context.
+ * @returns The Relationships object, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useRelationships(id?: Id): Relationships | undefined;
+
+/**
+ * The useRelationshipsIds hook returns a reactive object with the Ids of all
+ * Relationships objects registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useRelationshipsIds(): {readonly current: Ids};
+
+/**
+ * The useRelationshipIds hook returns a reactive object reflecting the Ids of
+ * the Relationships in a Relationships object, and registers a listener so
+ * that any changes will update `.current`.
+ * @param relationshipsOrRelationshipsId The Relationships object to use, or
+ * its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useRelationshipIds(
+  relationshipsOrRelationshipsId?: R<Relationships | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useRemoteRowId hook returns a reactive object reflecting the remote Row
+ * Id for a given local Row in a Relationship, and registers a listener so that
+ * any changes will update `.current`.
+ * @param relationshipId The Id of the Relationship (or a getter returning it).
+ * @param localRowId The Id of the local Row (or a getter returning it).
+ * @param relationshipsOrRelationshipsId The Relationships object to use (plain
+ * or getter), or its Id.
+ * @returns A reactive object with a `current` Id | undefined property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useRemoteRowId(
+  relationshipId: R<Id>,
+  localRowId: R<Id>,
+  relationshipsOrRelationshipsId?: R<Relationships | Id | undefined>,
+): {readonly current: Id | undefined};
+
+/**
+ * The useLocalRowIds hook returns a reactive object reflecting the local Row
+ * Ids for a given remote Row in a Relationship, and registers a listener so
+ * that any changes will update `.current`.
+ * @param relationshipId The Id of the Relationship (or a getter returning it).
+ * @param remoteRowId The Id of the remote Row (or a getter returning it).
+ * @param relationshipsOrRelationshipsId The Relationships object to use (plain
+ * or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useLocalRowIds(
+  relationshipId: R<Id>,
+  remoteRowId: R<Id>,
+  relationshipsOrRelationshipsId?: R<Relationships | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useLinkedRowIds hook returns a reactive object reflecting the linked Row
+ * Ids in a Relationship, and registers a listener so that any changes will
+ * update `.current`.
+ * @param relationshipId The Id of the Relationship (or a getter returning it).
+ * @param firstRowId The Id of the first Row (or a getter returning it).
+ * @param relationshipsOrRelationshipsId The Relationships object to use (plain
+ * or getter), or its Id.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useLinkedRowIds(
+  relationshipId: R<Id>,
+  firstRowId: R<Id>,
+  relationshipsOrRelationshipsId?: R<Relationships | Id | undefined>,
+): {readonly current: Ids};
+
+/**
+ * The useCheckpoints hook returns the default Checkpoints object from the
+ * current Provider context (or a named one if an Id is provided).
+ * @param id An optional Id of a named Checkpoints object in the Provider
+ * context.
+ * @returns The Checkpoints object, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useCheckpoints(id?: Id): Checkpoints | undefined;
+
+/**
+ * The useCheckpointsIds hook returns a reactive object with the Ids of all
+ * Checkpoints objects registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useCheckpointsIds(): {readonly current: Ids};
+
+/**
+ * The useCheckpointIds hook returns a reactive object reflecting the
+ * CheckpointIds (backward, current, forward) in a Checkpoints object, and
+ * registers a listener so that any changes will update `.current`.
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
+ * getter), or its Id.
+ * @returns A reactive object with a `current` CheckpointIds property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useCheckpointIds(
+  checkpointsOrCheckpointsId?: R<Checkpoints | Id | undefined>,
+): {readonly current: CheckpointIds};
+
+/**
+ * The useCheckpoint hook returns a reactive object reflecting the label of a
+ * checkpoint, and registers a listener so that any changes will update
+ * `.current`.
+ * @param checkpointId The Id of the checkpoint (or a getter returning it).
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use (plain or
+ * getter), or its Id.
+ * @returns A reactive object with a `current` string | undefined property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useCheckpoint(
+  checkpointId: R<Id>,
+  checkpointsOrCheckpointsId?: R<Checkpoints | Id | undefined>,
+): {readonly current: string | undefined};
+
+/**
+ * The useGoBackwardCallback hook returns a callback function that, when called,
+ * moves the Checkpoints object backward to the previous checkpoint.
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
+ * @returns A callback function.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useGoBackwardCallback(
+  checkpointsOrCheckpointsId?: R<Checkpoints | Id | undefined>,
+): () => void;
+
+/**
+ * The useGoForwardCallback hook returns a callback function that, when called,
+ * moves the Checkpoints object forward to the next checkpoint.
+ * @param checkpointsOrCheckpointsId The Checkpoints object to use, or its Id.
+ * @returns A callback function.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useGoForwardCallback(
+  checkpointsOrCheckpointsId?: R<Checkpoints | Id | undefined>,
+): () => void;
+
+/**
+ * The usePersister hook returns the default Persister from the current Provider
+ * context (or a named one if an Id is provided).
+ * @param id An optional Id of a named Persister in the Provider context.
+ * @returns The Persister, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function usePersister(id?: Id): AnyPersister | undefined;
+
+/**
+ * The usePersisterIds hook returns a reactive object with the Ids of all
+ * Persisters registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function usePersisterIds(): {readonly current: Ids};
+
+/**
+ * The usePersisterStatus hook returns a reactive object reflecting the status
+ * of a Persister, and registers a listener so that any changes will update
+ * `.current`.
+ * @param persisterOrPersisterId The Persister to use, or its Id.
+ * @returns A reactive object with a `current` Status property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function usePersisterStatus(
+  persisterOrPersisterId?: AnyPersister | Id,
+): {readonly current: Status};
+
+/**
+ * The useSynchronizer hook returns the default Synchronizer from the current
+ * Provider context (or a named one if an Id is provided).
+ * @param id An optional Id of a named Synchronizer in the Provider context.
+ * @returns The Synchronizer, or `undefined` if not found.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useSynchronizer(id?: Id): Synchronizer | undefined;
+
+/**
+ * The useSynchronizerIds hook returns a reactive object with the Ids of all
+ * Synchronizers registered in the current Provider context.
+ * @returns A reactive object with a `current` Ids property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useSynchronizerIds(): {readonly current: Ids};
+
+/**
+ * The useSynchronizerStatus hook returns a reactive object reflecting the
+ * status of a Synchronizer, and registers a listener so that any changes will
+ * update `.current`.
+ * @param synchronizerOrSynchronizerId The Synchronizer to use, or its Id.
+ * @returns A reactive object with a `current` Status property.
+ * @category Hook
+ * @since v8.1.0
+ */
+export function useSynchronizerStatus(
+  synchronizerOrSynchronizerId?: Synchronizer | Id,
+): {readonly current: Status};
+
+/**
+ * The provideStore function registers a Store with a given Id into the current
+ * Provider context, making it available to all descendant components.
+ *
+ * This function must be called inside a Svelte component's `<script>` block
+ * that is a descendant of a Provider component.
+ * @param storeId The Id to register the Store under.
+ * @param store The Store to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function provideStore(storeId: Id, store: Store): void;
+
+/**
+ * The provideMetrics function registers a Metrics object with a given Id into
+ * the current Provider context.
+ * @param metricsId The Id to register the Metrics object under.
+ * @param metrics The Metrics object to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function provideMetrics(metricsId: Id, metrics: Metrics): void;
+
+/**
+ * The provideIndexes function registers an Indexes object with a given Id into
+ * the current Provider context.
+ * @param indexesId The Id to register the Indexes object under.
+ * @param indexes The Indexes object to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function provideIndexes(indexesId: Id, indexes: Indexes): void;
+
+/**
+ * The provideRelationships function registers a Relationships object with a
+ * given Id into the current Provider context.
+ * @param relationshipsId The Id to register the Relationships object under.
+ * @param relationships The Relationships object to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function provideRelationships(
+  relationshipsId: Id,
+  relationships: Relationships,
+): void;
+
+/**
+ * The provideQueries function registers a Queries object with a given Id into
+ * the current Provider context.
+ * @param queriesId The Id to register the Queries object under.
+ * @param queries The Queries object to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function provideQueries(queriesId: Id, queries: Queries): void;
+
+/**
+ * The provideCheckpoints function registers a Checkpoints object with a given
+ * Id into the current Provider context.
+ * @param checkpointsId The Id to register the Checkpoints object under.
+ * @param checkpoints The Checkpoints object to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function provideCheckpoints(
+  checkpointsId: Id,
+  checkpoints: Checkpoints,
+): void;
+
+/**
+ * The providePersister function registers a Persister with a given Id into the
+ * current Provider context.
+ * @param persisterId The Id to register the Persister under.
+ * @param persister The Persister to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function providePersister(
+  persisterId: Id,
+  persister: AnyPersister,
+): void;
+
+/**
+ * The provideSynchronizer function registers a Synchronizer with a given Id
+ * into the current Provider context.
+ * @param synchronizerId The Id to register the Synchronizer under.
+ * @param synchronizer The Synchronizer to register.
+ * @category Provider
+ * @since v8.1.0
+ */
+export function provideSynchronizer(
+  synchronizerId: Id,
+  synchronizer: Synchronizer,
+): void;