tinybase 6.0.0-beta.1 → 6.0.0-beta.3

package/@types/_internal/queries/with-schemas/index.d.cts

@@ -1,13 +1,13 @@
-import type {
-  CellIdFromSchema,
-  TableIdFromSchema,
-} from '../../store/with-schemas/index.d.cts';
+import type {Id} from '../../../common/with-schemas/index.d.cts';
+import type {ResultCell} from '../../../queries/with-schemas/index.d.cts';
 import type {
   NoTablesSchema,
   OptionalTablesSchema,
 } from '../../../store/with-schemas/index.d.cts';
-import type {Id} from '../../../common/with-schemas/index.d.cts';
-import type {ResultCell} from '../../../queries/with-schemas/index.d.cts';
+import type {
+  CellIdFromSchema,
+  TableIdFromSchema,
+} from '../../store/with-schemas/index.d.cts';
 
 export type JoinedCellIdOrId<
   Schema extends OptionalTablesSchema = NoTablesSchema,

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

@@ -1,13 +1,13 @@
-import type {
-  CellIdFromSchema,
-  TableIdFromSchema,
-} from '../../store/with-schemas/index.d.ts';
+import type {Id} from '../../../common/with-schemas/index.d.ts';
+import type {ResultCell} from '../../../queries/with-schemas/index.d.ts';
 import type {
   NoTablesSchema,
   OptionalTablesSchema,
 } from '../../../store/with-schemas/index.d.ts';
-import type {Id} from '../../../common/with-schemas/index.d.ts';
-import type {ResultCell} from '../../../queries/with-schemas/index.d.ts';
+import type {
+  CellIdFromSchema,
+  TableIdFromSchema,
+} from '../../store/with-schemas/index.d.ts';
 
 export type JoinedCellIdOrId<
   Schema extends OptionalTablesSchema = NoTablesSchema,

package/@types/_internal/store/with-schemas/index.d.cts

@@ -1,3 +1,4 @@
+import type {Id} from '../../../common/with-schemas/index.d.cts';
 import type {
   Cell,
   OptionalSchemas,
@@ -6,7 +7,6 @@ import type {
   Store,
   Value,
 } from '../../../store/with-schemas/index.d.cts';
-import type {Id} from '../../../common/with-schemas/index.d.cts';
 
 export type TableIdFromSchema<Schema extends OptionalTablesSchema> = AsId<
   keyof Schema

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

@@ -1,3 +1,4 @@
+import type {Id} from '../../../common/with-schemas/index.d.ts';
 import type {
   Cell,
   OptionalSchemas,
@@ -6,7 +7,6 @@ import type {
   Store,
   Value,
 } from '../../../store/with-schemas/index.d.ts';
-import type {Id} from '../../../common/with-schemas/index.d.ts';
 
 export type TableIdFromSchema<Schema extends OptionalTablesSchema> = AsId<
   keyof Schema

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

@@ -1,24 +1,24 @@
+import type {Checkpoints} from '../../../checkpoints/with-schemas/index.d.cts';
 import type {Callback, Id} from '../../../common/with-schemas/index.d.cts';
-import type {
-  CellIdFromSchema,
-  TableIdFromSchema,
-  ValueIdFromSchema,
-} from '../../store/with-schemas/index.d.cts';
-import type {ComponentType, ReactElement} from 'react';
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/with-schemas/index.d.cts';
+import type {Indexes} from '../../../indexes/with-schemas/index.d.cts';
+import type {Metrics} from '../../../metrics/with-schemas/index.d.cts';
 import type {
   Persister,
   Persists,
 } from '../../../persisters/with-schemas/index.d.cts';
-import type {Checkpoints} from '../../../checkpoints/with-schemas/index.d.cts';
-import type {Indexes} from '../../../indexes/with-schemas/index.d.cts';
-import type {Metrics} from '../../../metrics/with-schemas/index.d.cts';
 import type {Queries} from '../../../queries/with-schemas/index.d.cts';
 import type {Relationships} from '../../../relationships/with-schemas/index.d.cts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.cts';
 import type {Synchronizer} from '../../../synchronizers/with-schemas/index.d.cts';
+import type {
+  CellIdFromSchema,
+  TableIdFromSchema,
+  ValueIdFromSchema,
+} from '../../store/with-schemas/index.d.cts';
+import type {ComponentType, ReactElement} from 'react';
 
 type StoreOrStoreId<Schemas extends OptionalSchemas> = Store<Schemas> | Id;
 

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

@@ -1,24 +1,24 @@
+import type {Checkpoints} from '../../../checkpoints/with-schemas/index.d.ts';
 import type {Callback, Id} from '../../../common/with-schemas/index.d.ts';
-import type {
-  CellIdFromSchema,
-  TableIdFromSchema,
-  ValueIdFromSchema,
-} from '../../store/with-schemas/index.d.ts';
-import type {ComponentType, ReactElement} from 'react';
-import type {
-  OptionalSchemas,
-  Store,
-} from '../../../store/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 {
   Persister,
   Persists,
 } from '../../../persisters/with-schemas/index.d.ts';
-import type {Checkpoints} from '../../../checkpoints/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 {Queries} from '../../../queries/with-schemas/index.d.ts';
 import type {Relationships} from '../../../relationships/with-schemas/index.d.ts';
+import type {
+  OptionalSchemas,
+  Store,
+} from '../../../store/with-schemas/index.d.ts';
 import type {Synchronizer} from '../../../synchronizers/with-schemas/index.d.ts';
+import type {
+  CellIdFromSchema,
+  TableIdFromSchema,
+  ValueIdFromSchema,
+} from '../../store/with-schemas/index.d.ts';
+import type {ComponentType, ReactElement} from 'react';
 
 type StoreOrStoreId<Schemas extends OptionalSchemas> = Store<Schemas> | Id;
 

package/@types/checkpoints/index.d.cts

@@ -10,7 +10,6 @@
  * @module checkpoints
  * @since v1.0.0
  */
-
 import type {Id, IdOrNull, Ids} from '../common/index.d.cts';
 import type {Store} from '../store/index.d.cts';
 

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

@@ -10,7 +10,6 @@
  * @module checkpoints
  * @since v1.0.0
  */
-
 import type {Id, IdOrNull, Ids} from '../common/index.d.ts';
 import type {Store} from '../store/index.d.ts';
 

package/@types/checkpoints/with-schemas/index.d.cts

@@ -10,7 +10,6 @@
  * @module checkpoints
  * @since v1.0.0
  */
-
 import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.cts';
 import type {OptionalSchemas, Store} from '../../store/with-schemas/index.d.cts';
 

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

@@ -10,7 +10,6 @@
  * @module checkpoints
  * @since v1.0.0
  */
-
 import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.ts';
 import type {OptionalSchemas, Store} from '../../store/with-schemas/index.d.ts';
 

package/@types/indexes/index.d.cts

@@ -10,9 +10,8 @@
  * @module indexes
  * @since v1.0.0
  */
-
-import type {GetCell, RowCallback, Store} from '../store/index.d.cts';
 import type {Id, IdOrNull, Ids, SortKey} from '../common/index.d.cts';
+import type {GetCell, RowCallback, Store} from '../store/index.d.cts';
 
 /**
  * The Index type represents the concept of a map of Slice objects, keyed by Id.

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

@@ -10,9 +10,8 @@
  * @module indexes
  * @since v1.0.0
  */
-
-import type {GetCell, RowCallback, Store} from '../store/index.d.ts';
 import type {Id, IdOrNull, Ids, SortKey} from '../common/index.d.ts';
+import type {GetCell, RowCallback, Store} from '../store/index.d.ts';
 
 /**
  * The Index type represents the concept of a map of Slice objects, keyed by Id.

package/@types/indexes/with-schemas/index.d.cts

@@ -10,11 +10,16 @@
  * @module indexes
  * @since v1.0.0
  */
-
 import type {
   CellIdFromSchema,
   TableIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.cts';
+import type {
+  Id,
+  IdOrNull,
+  Ids,
+  SortKey,
+} from '../../common/with-schemas/index.d.cts';
 import type {
   GetCell,
   OptionalSchemas,
@@ -22,12 +27,6 @@ import type {
   RowCallback,
   Store,
 } from '../../store/with-schemas/index.d.cts';
-import type {
-  Id,
-  IdOrNull,
-  Ids,
-  SortKey,
-} from '../../common/with-schemas/index.d.cts';
 
 /**
  * The Index type represents the concept of a map of Slice objects, keyed by Id.

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

@@ -10,11 +10,16 @@
  * @module indexes
  * @since v1.0.0
  */
-
 import type {
   CellIdFromSchema,
   TableIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.ts';
+import type {
+  Id,
+  IdOrNull,
+  Ids,
+  SortKey,
+} from '../../common/with-schemas/index.d.ts';
 import type {
   GetCell,
   OptionalSchemas,
@@ -22,12 +27,6 @@ import type {
   RowCallback,
   Store,
 } from '../../store/with-schemas/index.d.ts';
-import type {
-  Id,
-  IdOrNull,
-  Ids,
-  SortKey,
-} from '../../common/with-schemas/index.d.ts';
 
 /**
  * The Index type represents the concept of a map of Slice objects, keyed by Id.

package/@types/mergeable-store/index.d.cts

@@ -19,14 +19,13 @@
  * @module mergeable-store
  * @since v5.0.0
  */
-
+import type {Id} from '../common/index.d.cts';
 import type {
   CellOrUndefined,
   Content,
   Store,
   ValueOrUndefined,
 } from '../store/index.d.cts';
-import type {Id} from '../common/index.d.cts';
 
 /**
  * The Hash type is used within the mergeable-store module to quickly compare

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

@@ -19,14 +19,13 @@
  * @module mergeable-store
  * @since v5.0.0
  */
-
+import type {Id} from '../common/index.d.ts';
 import type {
   CellOrUndefined,
   Content,
   Store,
   ValueOrUndefined,
 } from '../store/index.d.ts';
-import type {Id} from '../common/index.d.ts';
 
 /**
  * The Hash type is used within the mergeable-store module to quickly compare

package/@types/mergeable-store/with-schemas/index.d.cts

@@ -19,12 +19,12 @@
  * @module mergeable-store
  * @since v5.0.0
  */
-
 import type {
   CellIdFromSchema,
   TableIdFromSchema,
   ValueIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.cts';
+import type {Id} from '../../common/with-schemas/index.d.cts';
 import type {
   CellOrUndefined,
   Content,
@@ -39,7 +39,6 @@ import type {
   ValueOrUndefined,
   ValuesSchema,
 } from '../../store/with-schemas/index.d.cts';
-import type {Id} from '../../common/with-schemas/index.d.cts';
 
 /**
  * The Hash type is used within the mergeable-store module to quickly compare

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

@@ -19,12 +19,12 @@
  * @module mergeable-store
  * @since v5.0.0
  */
-
 import type {
   CellIdFromSchema,
   TableIdFromSchema,
   ValueIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.ts';
+import type {Id} from '../../common/with-schemas/index.d.ts';
 import type {
   CellOrUndefined,
   Content,
@@ -39,7 +39,6 @@ import type {
   ValueOrUndefined,
   ValuesSchema,
 } from '../../store/with-schemas/index.d.ts';
-import type {Id} from '../../common/with-schemas/index.d.ts';
 
 /**
  * The Hash type is used within the mergeable-store module to quickly compare

package/@types/metrics/index.d.cts

@@ -10,9 +10,8 @@
  * @module metrics
  * @since v1.0.0
  */
-
-import type {GetCell, Store} from '../store/index.d.cts';
 import type {Id, IdOrNull, Ids} from '../common/index.d.cts';
+import type {GetCell, Store} from '../store/index.d.cts';
 
 /**
  * The Metric type is simply an alias, but represents a number formed by

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

@@ -10,9 +10,8 @@
  * @module metrics
  * @since v1.0.0
  */
-
-import type {GetCell, Store} from '../store/index.d.ts';
 import type {Id, IdOrNull, Ids} from '../common/index.d.ts';
+import type {GetCell, Store} from '../store/index.d.ts';
 
 /**
  * The Metric type is simply an alias, but represents a number formed by

package/@types/metrics/with-schemas/index.d.cts

@@ -10,17 +10,16 @@
  * @module metrics
  * @since v1.0.0
  */
-
 import type {
   CellIdFromSchema,
   TableIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.cts';
+import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.cts';
 import type {
   GetCell,
   OptionalSchemas,
   Store,
 } from '../../store/with-schemas/index.d.cts';
-import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.cts';
 
 /**
  * The Metric type is simply an alias, but represents a number formed by

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

@@ -10,17 +10,16 @@
  * @module metrics
  * @since v1.0.0
  */
-
 import type {
   CellIdFromSchema,
   TableIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.ts';
+import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.ts';
 import type {
   GetCell,
   OptionalSchemas,
   Store,
 } from '../../store/with-schemas/index.d.ts';
-import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.ts';
 
 /**
  * The Metric type is simply an alias, but represents a number formed by

package/@types/persisters/index.d.cts

@@ -49,14 +49,13 @@
  * @module persisters
  * @since v1.0.0
  */
-
-import type {Changes, Content, Store} from '../store/index.d.cts';
+import type {Id} from '../common/index.d.cts';
 import type {
   MergeableChanges,
   MergeableContent,
   MergeableStore,
 } from '../mergeable-store/index.d.cts';
-import type {Id} from '../common/index.d.cts';
+import type {Changes, Content, Store} from '../store/index.d.cts';
 
 /**
  * The Status enum is used to indicate whether a Persister is idle, or loading or
@@ -865,8 +864,8 @@ export type DpcTabularValues = {
  * finally destroys the Persister again.
  *
  * ```js
- * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
  * import {createStore} from 'tinybase';
+ * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
  *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = createSessionPersister(store, 'pets');
@@ -889,8 +888,8 @@ export type DpcTabularValues = {
  * persisted data (implicitly firing a StorageEvent), are reflected accordingly.
  *
  * ```js
- * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
  * import {createStore} from 'tinybase';
+ * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
  *
  * const store = createStore();
  * const persister = createSessionPersister(store, 'pets');
@@ -944,8 +943,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * previously populated.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * sessionStorage.setItem('pets', '[{"pets":{"fido":{"species":"dog"}}},{}]');
    *
@@ -965,8 +964,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * previously been persisted and instead, that is loaded.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
@@ -1020,8 +1019,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * from session storage changes made in another browser tab).
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
@@ -1059,8 +1058,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * stopped, subsequent changes are not reflected in the Store.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
@@ -1103,8 +1102,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * This example creates a Persister and queries whether it is autoLoading.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const persister = createSessionPersister(createStore(), 'pets');
    *
@@ -1138,8 +1137,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * session storage.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSessionPersister(store, 'pets');
@@ -1175,8 +1174,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * saved to the underlying storage.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSessionPersister(store, 'pets');
@@ -1211,8 +1210,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * stopped, subsequent changes are not reflected.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = createSessionPersister(store, 'pets');
@@ -1247,8 +1246,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * This example creates a Persister and queries whether it is autoSaving.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const persister = createSessionPersister(createStore(), 'pets');
    *
@@ -1286,8 +1285,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * This example creates a Persister and queries its status.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const persister = createSessionPersister(createStore(), 'pets');
    *
@@ -1315,8 +1314,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * the Persister.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const persister = createSessionPersister(createStore(), 'pets');
    *
@@ -1352,8 +1351,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * This example registers a listener and then removes it.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const persister = createSessionPersister(createStore(), 'pets');
    *
@@ -1403,8 +1402,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    *   getDataFromRemoteSystem,
    *   sendDataToRemoteSystem,
    * } from 'custom-remote-handlers';
-   * import {createCustomPersister} from 'tinybase/persisters';
    * import {createStore} from 'tinybase';
+   * import {createCustomPersister} from 'tinybase/persisters';
    *
    * const store = createStore();
    * const persister = createCustomPersister(
@@ -1438,8 +1437,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * then gets its reference in order to update its data.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const persister = createSessionPersister(createStore(), 'pets');
    * await persister.startAutoSave();
@@ -1471,8 +1470,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * again, removing the listener.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
@@ -1510,8 +1509,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * invoked by changes to the Store and to the underlying storage.
    *
    * ```js
-   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    * import {createStore} from 'tinybase';
+   * import {createSessionPersister} from 'tinybase/persisters/persister-browser';
    *
    * const store = createStore();
    * const persister = createSessionPersister(store, 'pets');
@@ -1642,8 +1641,8 @@ export type DatabaseChangeListener = (tableName: string) => void;
  * Store.
  *
  * ```js
- * import {createCustomPersister} from 'tinybase/persisters';
  * import {createStore} from 'tinybase';
+ * import {createCustomPersister} from 'tinybase/persisters';
  *
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * let persistedJson;
@@ -1682,8 +1681,8 @@ export type DatabaseChangeListener = (tableName: string) => void;
  * MergeableStore.
  *
  * ```js
- * import {Persists, createCustomPersister} from 'tinybase/persisters';
  * import {createMergeableStore, createStore} from 'tinybase';
+ * import {Persists, createCustomPersister} from 'tinybase/persisters';
  *
  * let persistedJson;
  * const createJsonPersister = (storeOrMergeableStore) =>