tinybase 8.0.0 → 8.1.0-beta.1

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

@@ -0,0 +1,1552 @@
+import type {Component, Snippet} from 'svelte';
+import type {
+  AllCellIdFromSchema,
+  CellIdFromSchema,
+  DefaultedValueFromSchema,
+  NoInfer,
+  TableIdFromSchema,
+  ValueIdFromSchema,
+} from '../../_internal/store/with-schemas/index.d.ts';
+import type {
+  CheckpointIds,
+  Checkpoints,
+} from '../../checkpoints/with-schemas/index.d.ts';
+import type {Id, Ids} from '../../common/with-schemas/index.d.ts';
+import type {Indexes} from '../../indexes/with-schemas/index.d.ts';
+import type {Metrics} from '../../metrics/with-schemas/index.d.ts';
+import type {
+  AnyPersister,
+  Status,
+} from '../../persisters/with-schemas/index.d.ts';
+import type {
+  Queries,
+  ResultCell,
+  ResultRow,
+  ResultTable,
+} from '../../queries/with-schemas/index.d.ts';
+import type {Relationships} from '../../relationships/with-schemas/index.d.ts';
+import type {
+  Cell,
+  CellOrUndefined,
+  OptionalSchemas,
+  Row,
+  Store,
+  Table,
+  Tables,
+  Value,
+  Values,
+} from '../../store/with-schemas/index.d.ts';
+import type {Synchronizer} from '../../synchronizers/with-schemas/index.d.ts';
+
+export type WithSchemas<Schemas extends OptionalSchemas> = {
+  /**
+ * 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
+ */
+  R: <T>(t: T) => T | (() => T);
+
+  /**
+ * The ProviderProps type describes the props of the Provider component.
+ * @category Props
+ * @since v8.1.0
+ */
+  ProviderProps: {
+    readonly store?: Store<Schemas>;
+    readonly storesById?: {readonly [id: Id]: Store<Schemas>};
+    readonly metrics?: Metrics<Schemas>;
+    readonly metricsById?: {readonly [id: Id]: Metrics<Schemas>};
+    readonly indexes?: Indexes<Schemas>;
+    readonly indexesById?: {readonly [id: Id]: Indexes<Schemas>};
+    readonly relationships?: Relationships<Schemas>;
+    readonly relationshipsById?: {readonly [id: Id]: Relationships<Schemas>};
+    readonly queries?: Queries<Schemas>;
+    readonly queriesById?: {readonly [id: Id]: Queries<Schemas>};
+    readonly checkpoints?: Checkpoints<Schemas>;
+    readonly checkpointsById?: {readonly [id: Id]: Checkpoints<Schemas>};
+    readonly persister?: AnyPersister<Schemas>;
+    readonly persistersById?: {readonly [id: Id]: AnyPersister<Schemas>};
+    readonly synchronizer?: Synchronizer<Schemas>;
+    readonly synchronizersById?: {readonly [id: Id]: Synchronizer<Schemas>};
+    readonly children: Snippet;
+  };
+
+  /**
+ * The Provider component wraps part of an application to make TinyBase objects
+ * available throughout its component subtree via Svelte context.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export declare const Provider: Component<ProviderProps>;
+ * ```
+ *
+ * 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
+ */
+  Provider: Component<{
+    readonly store?: Store<Schemas>;
+    readonly storesById?: {readonly [id: Id]: Store<Schemas>};
+    readonly metrics?: Metrics<Schemas>;
+    readonly metricsById?: {readonly [id: Id]: Metrics<Schemas>};
+    readonly indexes?: Indexes<Schemas>;
+    readonly indexesById?: {readonly [id: Id]: Indexes<Schemas>};
+    readonly relationships?: Relationships<Schemas>;
+    readonly relationshipsById?: {readonly [id: Id]: Relationships<Schemas>};
+    readonly queries?: Queries<Schemas>;
+    readonly queriesById?: {readonly [id: Id]: Queries<Schemas>};
+    readonly checkpoints?: Checkpoints<Schemas>;
+    readonly checkpointsById?: {readonly [id: Id]: Checkpoints<Schemas>};
+    readonly persister?: AnyPersister<Schemas>;
+    readonly persistersById?: {readonly [id: Id]: AnyPersister<Schemas>};
+    readonly synchronizer?: Synchronizer<Schemas>;
+    readonly synchronizersById?: {readonly [id: Id]: Synchronizer<Schemas>};
+    readonly children: Snippet;
+  }>;
+
+  /**
+ * 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
+ */
+  CellView: Component<{
+    readonly tableId: TableIdFromSchema<Schemas[0]>;
+    readonly rowId: Id;
+    readonly cellId: AllCellIdFromSchema<Schemas[0]>;
+    readonly store?: Store<Schemas> | Id;
+    readonly debugIds?: boolean;
+  }>;
+
+  /**
+ * 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
+ */
+  ValueView: Component<{
+    readonly valueId: ValueIdFromSchema<Schemas[1]>;
+    readonly store?: Store<Schemas> | Id;
+    readonly debugIds?: boolean;
+  }>;
+
+  /**
+ * 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
+ */
+  RowView: Component<{
+    readonly tableId: TableIdFromSchema<Schemas[0]>;
+    readonly rowId: Id;
+    readonly store?: Store<Schemas> | Id;
+    readonly customCellIds?: Ids;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly cell?: Snippet<[cellId: AllCellIdFromSchema<Schemas[0]>]>;
+  }>;
+
+  /**
+ * 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
+ */
+  TableView: Component<{
+    readonly tableId: TableIdFromSchema<Schemas[0]>;
+    readonly store?: Store<Schemas> | Id;
+    readonly customCellIds?: Ids;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  SortedTableView: Component<{
+    readonly tableId: TableIdFromSchema<Schemas[0]>;
+    readonly cellId?: AllCellIdFromSchema<Schemas[0]>;
+    readonly descending?: boolean;
+    readonly offset?: number;
+    readonly limit?: number;
+    readonly store?: Store<Schemas> | Id;
+    readonly customCellIds?: Ids;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  TablesView: Component<{
+    readonly store?: Store<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly table?: Snippet<[tableId: TableIdFromSchema<Schemas[0]>]>;
+  }>;
+
+  /**
+ * 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
+ */
+  ValuesView: Component<{
+    readonly store?: Store<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly value?: Snippet<[valueId: ValueIdFromSchema<Schemas[1]>]>;
+  }>;
+
+  /**
+ * 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
+ */
+  MetricView: Component<{
+    readonly metricId: Id;
+    readonly metrics?: Metrics<Schemas> | Id;
+    readonly debugIds?: boolean;
+  }>;
+
+  /**
+ * 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
+ */
+  IndexView: Component<{
+    readonly indexId: Id;
+    readonly indexes?: Indexes<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly slice?: Snippet<[sliceId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  SliceView: Component<{
+    readonly indexId: Id;
+    readonly sliceId: Id;
+    readonly indexes?: Indexes<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  RemoteRowView: Component<{
+    readonly relationshipId: Id;
+    readonly localRowId: Id;
+    readonly relationships?: Relationships<Schemas> | Id;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  LocalRowsView: Component<{
+    readonly relationshipId: Id;
+    readonly remoteRowId: Id;
+    readonly relationships?: Relationships<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  LinkedRowsView: Component<{
+    readonly relationshipId: Id;
+    readonly firstRowId: Id;
+    readonly relationships?: Relationships<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  ResultCellView: Component<{
+    readonly queryId: Id;
+    readonly rowId: Id;
+    readonly cellId: Id;
+    readonly queries?: Queries<Schemas> | Id;
+    readonly debugIds?: boolean;
+  }>;
+
+  /**
+ * 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
+ */
+  ResultRowView: Component<{
+    readonly queryId: Id;
+    readonly rowId: Id;
+    readonly queries?: Queries<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly cell?: Snippet<[cellId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  ResultTableView: Component<{
+    readonly queryId: Id;
+    readonly queries?: Queries<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  ResultSortedTableView: Component<{
+    readonly queryId: Id;
+    readonly cellId?: Id;
+    readonly descending?: boolean;
+    readonly offset?: number;
+    readonly limit?: number;
+    readonly queries?: Queries<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly row?: Snippet<[rowId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  CheckpointView: Component<{
+    readonly checkpointId: Id;
+    readonly checkpoints?: Checkpoints<Schemas> | Id;
+    readonly debugIds?: boolean;
+  }>;
+
+  /**
+ * 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
+ */
+  BackwardCheckpointsView: Component<{
+    readonly checkpoints?: Checkpoints<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly checkpoint?: Snippet<[checkpointId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  ForwardCheckpointsView: Component<{
+    readonly checkpoints?: Checkpoints<Schemas> | Id;
+    readonly separator?: Snippet<[]>;
+    readonly debugIds?: boolean;
+    readonly checkpoint?: Snippet<[checkpointId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  CurrentCheckpointView: Component<{
+    readonly checkpoints?: Checkpoints<Schemas> | Id;
+    readonly debugIds?: boolean;
+    readonly checkpoint?: Snippet<[checkpointId: Id]>;
+  }>;
+
+  /**
+ * 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
+ */
+  useHasTables: (
+    storeOrStoreId?:
+      | Store<Schemas>
+      | Id
+      | (() => Store<Schemas> | 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
+ */
+  useTables: (
+    storeOrStoreId?:
+      | Store<Schemas>
+      | Id
+      | (() => Store<Schemas> | Id | undefined),
+  ) => {
+    readonly current: Tables<Schemas[0]>;
+  };
+
+  /**
+ * 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
+ */
+  useTableIds: (storeOrStoreId?: Store<Schemas> | Id) => {
+    readonly current: TableIdFromSchema<Schemas[0]>[];
+  };
+
+  /**
+ * 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
+ */
+  useHasTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId | (() => TableId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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
+ */
+  useTable: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId | (() => TableId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {readonly current: Table<Schemas[0], TableId>};
+
+  /**
+ * 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
+ */
+  useTableCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId | (() => TableId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
+
+  /**
+ * 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
+ */
+  useHasTableCell: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId | (() => TableId),
+    cellId:
+      | CellIdFromSchema<Schemas[0], TableId>
+      | (() => CellIdFromSchema<Schemas[0], TableId>),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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
+ */
+  useRowCount: (
+    tableId:
+      | TableIdFromSchema<Schemas[0]>
+      | (() => TableIdFromSchema<Schemas[0]>),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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
+ */
+  useRowIds: (
+    tableId:
+      | TableIdFromSchema<Schemas[0]>
+      | (() => TableIdFromSchema<Schemas[0]>),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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
+ */
+  useSortedRowIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId | (() => TableId),
+    cellId?:
+      | CellIdFromSchema<Schemas[0], TableId>
+      | (() => CellIdFromSchema<Schemas[0], TableId>)
+      | undefined,
+    descending?: boolean | (() => boolean),
+    offset?: number | (() => number),
+    limit?: number | (() => number) | undefined,
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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
+ */
+  useHasRow: (
+    tableId:
+      | TableIdFromSchema<Schemas[0]>
+      | (() => TableIdFromSchema<Schemas[0]>),
+    rowId: Id | (() => Id),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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
+ */
+  useRow: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId | (() => TableId),
+    rowId: Id | (() => Id),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {readonly current: Row<Schemas[0], TableId>};
+
+  /**
+ * 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
+ */
+  useCellIds: <TableId extends TableIdFromSchema<Schemas[0]>>(
+    tableId: TableId | (() => TableId),
+    rowId: Id | (() => Id),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {readonly current: CellIdFromSchema<Schemas[0], TableId>[]};
+
+  /**
+ * 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
+ */
+  useHasCell: <
+    TableId extends TableIdFromSchema<Schemas[0]>,
+    CellId extends CellIdFromSchema<Schemas[0], TableId>,
+  >(
+    tableId: TableId | (() => TableId),
+    rowId: Id | (() => Id),
+    cellId: CellId | (() => CellId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * useCell(
+ *   tableId: R<Id>,
+ *   rowId: R<Id>,
+ *   cellId: R<Id>,
+ *   storeOrStoreId?: R<Store | Id | undefined>,
+ * ): {readonly current: CellOrUndefined};
+ * ```
+ *
+ * ```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
+ */
+  useCell: <
+    TableId extends TableIdFromSchema<Schemas[0]>,
+    CellId extends CellIdFromSchema<Schemas[0], TableId>,
+  >(
+    tableId: TableId | (() => TableId),
+    rowId: Id | (() => Id),
+    cellId: CellId | (() => CellId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {
+    readonly current: NoInfer<CellOrUndefined<Schemas[0], TableId, CellId>>;
+  };
+
+  /**
+ * 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
+ */
+  useCellState: <
+    TableId extends TableIdFromSchema<Schemas[0]>,
+    CellId extends CellIdFromSchema<Schemas[0], TableId>,
+  >(
+    tableId: TableId | (() => TableId),
+    rowId: Id | (() => Id),
+    cellId: CellId | (() => CellId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {
+    get current(): NoInfer<CellOrUndefined<Schemas[0], TableId, CellId>>;
+    set current(v: Cell<Schemas[0], TableId, CellId>);
+  };
+
+  /**
+ * 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
+ */
+  useHasValues: (
+    storeOrStoreId?:
+      | Store<Schemas>
+      | Id
+      | (() => Store<Schemas> | 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
+ */
+  useValues: (
+    storeOrStoreId?:
+      | Store<Schemas>
+      | Id
+      | (() => Store<Schemas> | Id | undefined),
+  ) => {
+    readonly current: Values<Schemas[1]>;
+  };
+
+  /**
+ * 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
+ */
+  useValueIds: (storeOrStoreId?: Store<Schemas> | Id) => {
+    readonly current: ValueIdFromSchema<Schemas[1]>[];
+  };
+
+  /**
+ * 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
+ */
+  useHasValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
+    valueId: ValueId | (() => ValueId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {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
+ */
+  useValue: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
+    valueId: ValueId | (() => ValueId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {
+    readonly current: NoInfer<DefaultedValueFromSchema<Schemas[1], ValueId>>;
+  };
+
+  /**
+ * 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
+ */
+  useValueState: <ValueId extends ValueIdFromSchema<Schemas[1]>>(
+    valueId: ValueId | (() => ValueId),
+    storeOrStoreId?: Store<Schemas> | Id,
+  ) => {
+    get current(): NoInfer<DefaultedValueFromSchema<Schemas[1], ValueId>>;
+    set current(v: Value<Schemas[1], ValueId>);
+  };
+
+  /**
+ * 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
+ */
+  useStore: (id?: Id) => Store<Schemas> | 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
+ */
+  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
+ */
+  useMetrics: (id?: Id) => Metrics<Schemas> | 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
+ */
+  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
+ */
+  useMetricIds: (
+    metricsOrMetricsId?:
+      | Metrics<Schemas>
+      | Id
+      | (() => Metrics<Schemas> | 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
+ */
+  useMetric: (
+    metricId: Id | (() => Id),
+    metricsOrMetricsId?: Metrics<Schemas> | Id,
+  ) => {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
+ */
+  useIndexes: (id?: Id) => Indexes<Schemas> | 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
+ */
+  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
+ */
+  useIndexIds: (
+    indexesOrIndexesId?:
+      | Indexes<Schemas>
+      | Id
+      | (() => Indexes<Schemas> | 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
+ */
+  useSliceIds: (
+    indexId: Id | (() => Id),
+    indexesOrIndexesId?: Indexes<Schemas> | Id,
+  ) => {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
+ */
+  useSliceRowIds: (
+    indexId: Id | (() => Id),
+    sliceId: Id | (() => Id),
+    indexesOrIndexesId?: Indexes<Schemas> | Id,
+  ) => {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
+ */
+  useQueries: (id?: Id) => Queries<Schemas> | 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
+ */
+  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
+ */
+  useQueryIds: (
+    queriesOrQueriesId?:
+      | Queries<Schemas>
+      | Id
+      | (() => Queries<Schemas> | 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
+ */
+  useResultTable: (
+    queryId: Id | (() => Id),
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {readonly current: ResultTable};
+
+  /**
+ * 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
+ */
+  useResultTableCellIds: (
+    queryId: Id | (() => Id),
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {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
+ */
+  useResultRowCount: (
+    queryId: Id | (() => Id),
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {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
+ */
+  useResultRowIds: (
+    queryId: Id | (() => Id),
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {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
+ */
+  useResultSortedRowIds: (
+    queryId: Id | (() => Id),
+    cellId?: Id | (() => Id) | undefined,
+    descending?: boolean | (() => boolean),
+    offset?: number | (() => number),
+    limit?: number | (() => number) | undefined,
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {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
+ */
+  useResultRow: (
+    queryId: Id | (() => Id),
+    rowId: Id | (() => Id),
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {readonly current: ResultRow};
+
+  /**
+ * 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
+ */
+  useResultCellIds: (
+    queryId: Id | (() => Id),
+    rowId: Id | (() => Id),
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {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
+ */
+  useResultCell: (
+    queryId: Id | (() => Id),
+    rowId: Id | (() => Id),
+    cellId: Id | (() => Id),
+    queriesOrQueriesId?: Queries<Schemas> | Id,
+  ) => {readonly current: ResultCell | undefined};
+
+  /**
+ * 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
+ */
+  useRelationships: (id?: Id) => Relationships<Schemas> | 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
+ */
+  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
+ */
+  useRelationshipIds: (
+    relationshipsOrRelationshipsId?:
+      | Relationships<Schemas>
+      | Id
+      | (() => Relationships<Schemas> | 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
+ */
+  useRemoteRowId: (
+    relationshipId: Id | (() => Id),
+    localRowId: Id | (() => Id),
+    relationshipsOrRelationshipsId?: Relationships<Schemas> | Id,
+  ) => {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
+ */
+  useLocalRowIds: (
+    relationshipId: Id | (() => Id),
+    remoteRowId: Id | (() => Id),
+    relationshipsOrRelationshipsId?: Relationships<Schemas> | Id,
+  ) => {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
+ */
+  useLinkedRowIds: (
+    relationshipId: Id | (() => Id),
+    firstRowId: Id | (() => Id),
+    relationshipsOrRelationshipsId?: Relationships<Schemas> | Id,
+  ) => {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
+ */
+  useCheckpoints: (id?: Id) => Checkpoints<Schemas> | 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
+ */
+  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
+ */
+  useCheckpointIds: (
+    checkpointsOrCheckpointsId?: Checkpoints<Schemas> | Id,
+  ) => {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
+ */
+  useCheckpoint: (
+    checkpointId: Id | (() => Id),
+    checkpointsOrCheckpointsId?: Checkpoints<Schemas> | Id,
+  ) => {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
+ */
+  useGoBackwardCallback: (
+    checkpointsOrCheckpointsId?:
+      | Checkpoints<Schemas>
+      | Id
+      | (() => Checkpoints<Schemas> | 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
+ */
+  useGoForwardCallback: (
+    checkpointsOrCheckpointsId?:
+      | Checkpoints<Schemas>
+      | Id
+      | (() => Checkpoints<Schemas> | 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
+ */
+  usePersister: (id?: Id) => AnyPersister<Schemas> | 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
+ */
+  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
+ */
+  usePersisterStatus: (persisterOrPersisterId?: AnyPersister<Schemas> | 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
+ */
+  useSynchronizer: (id?: Id) => Synchronizer<Schemas> | 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
+ */
+  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
+ */
+  useSynchronizerStatus: (
+    synchronizerOrSynchronizerId?: Synchronizer<Schemas> | 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 has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * provideStore(storeId: Id, store: Store): void;
+ * ```
+ *
+ * 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
+ */
+  provideStore: (storeId: Id, store: Store<Schemas>) => 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
+ */
+  provideMetrics: (metricsId: Id, metrics: Metrics<Schemas>) => 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
+ */
+  provideIndexes: (indexesId: Id, indexes: Indexes<Schemas>) => 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
+ */
+  provideRelationships: (
+    relationshipsId: Id,
+    relationships: Relationships<Schemas>,
+  ) => 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
+ */
+  provideQueries: (queriesId: Id, queries: Queries<Schemas>) => 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
+ */
+  provideCheckpoints: (
+    checkpointsId: Id,
+    checkpoints: Checkpoints<Schemas>,
+  ) => 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
+ */
+  providePersister: (persisterId: Id, persister: AnyPersister<Schemas>) => 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
+ */
+  provideSynchronizer: (
+    synchronizerId: Id,
+    synchronizer: Synchronizer<Schemas>,
+  ) => void;
+};