tinybase 5.0.0-beta.12 → 5.0.0-beta.14

package/lib/types/mergeable-store.d.ts

@@ -6,7 +6,7 @@
  */
 
 import {CellOrUndefined, Content, Store, ValueOrUndefined} from './store.d.ts';
-import {Id} from './common';
+import {Id} from './common.d.ts';
 
 /**
  * The Hash type
@@ -104,12 +104,6 @@ export type MergeableChanges = [
  */
 export interface MergeableStore extends Store {
   //
-  /**
-   * The getId method
-   * @category Getter
-   */
-  getId(): Id;
-
   /**
    * The getMergeableContent method
    * @category Getter
@@ -211,4 +205,4 @@ export interface MergeableStore extends Store {
  * The createMergeableStore function
  * @category Creation
  */
-export function createMergeableStore(id: Id): MergeableStore;
+export function createMergeableStore(uniqueId?: Id): MergeableStore;

package/lib/types/persisters/persister-automerge.d.ts

@@ -12,8 +12,8 @@
  */
 
 import {DocHandle} from '@automerge/automerge-repo';
-import {Persister} from '../persisters';
-import {Store} from '../store';
+import {Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 
 /**
  * The AutomergePersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-browser.d.ts

@@ -14,9 +14,9 @@
  * @module persister-browser
  */
 
-import {MergeableStore} from '../mergeable-store';
-import {Persister} from '../persisters';
-import {Store} from '../store';
+import {MergeableStore} from '../mergeable-store.d.ts';
+import {Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 
 /**
  * The SessionPersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-cr-sqlite-wasm.d.ts

@@ -8,9 +8,9 @@
  * @since v4.0.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {DB} from '@vlcn.io/crsqlite-wasm';
-import {Store} from '../store';
+import {Store} from '../store.d.ts';
 
 /**
  * The CrSqliteWasmPersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-electric-sql.d.ts

@@ -8,9 +8,9 @@
  * @since v4.6.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {ElectricClient} from 'electric-sql/client/model';
-import {Store} from '../store';
+import {Store} from '../store.d.ts';
 
 /**
  * The ElectricSqlPersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-expo-sqlite-next.d.ts

@@ -20,9 +20,9 @@
  * @since v4.5.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {SQLiteDatabase} from 'expo-sqlite/next';
-import {Store} from '../store';
+import {Store} from '../store.d.ts';
 
 /**
  * The ExpoSqliteNextPersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-expo-sqlite.d.ts

@@ -19,9 +19,9 @@
  * @since v4.0.3
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {SQLiteDatabase} from 'expo-sqlite';
-import {Store} from '../store';
+import {Store} from '../store.d.ts';
 
 /**
  * The ExpoSqlitePersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-file.d.ts

@@ -6,9 +6,9 @@
  * @module persister-file
  */
 
-import {MergeableStore} from '../mergeable-store';
-import {Persister} from '../persisters';
-import {Store} from '../store';
+import {MergeableStore} from '../mergeable-store.d.ts';
+import {Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 
 /**
  * The FilePersister interface is a minor extension to the Persister interface.

package/lib/types/persisters/persister-indexed-db.d.ts

@@ -6,8 +6,8 @@
  * @module persister-indexed-db
  */
 
-import {Persister} from '../persisters';
-import {Store} from '../store';
+import {Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 
 /**
  * The IndexedDbPersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-libsql.d.ts

@@ -8,9 +8,9 @@
  * @since v4.7.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {Client} from '@libsql/client';
-import {Store} from '../store';
+import {Store} from '../store.d.ts';
 
 /**
  * The LibSqlPersister interface is a minor extension to the Persister
@@ -67,7 +67,7 @@ export interface LibSqlPersister extends Persister {
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
  * @param store The Store to persist.
- * @param db The database client that was returned from `createClient(...)`.
+ * @param client The database client that was returned from `createClient(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the
  * persistence mode (or a string to set the `storeTableName` property of the
  * JSON serialization).

package/lib/types/persisters/persister-partykit-client.d.ts

@@ -19,8 +19,8 @@
  */
 
 import PartySocket from 'partysocket';
-import {Persister} from '../persisters';
-import {Store} from '../store';
+import {Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 
 /**
  * The PartyKitPersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-partykit-server.d.ts

@@ -24,9 +24,9 @@ import {
   Content,
   Value,
   ValueOrUndefined,
-} from '../store';
+} from '../store.d.ts';
 import {Connection, Party, Request, Server, Storage} from 'partykit/server';
-import {Id} from '../common';
+import {Id} from '../common.d.ts';
 
 /**
  * The TinyBasePartyKitServerConfig type describes the configuration of a

package/lib/types/persisters/persister-powersync.d.ts

@@ -8,9 +8,9 @@
  * @since v4.8.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
-import {Store} from '../store';
+import {Store} from '../store.d.ts';
 
 /**
  * The PowerSyncPersister interface is a minor extension to the Persister
@@ -150,7 +150,7 @@ export interface PowerSyncPersister extends Persister {
  */
 export function createPowerSyncPersister(
   store: Store,
-  db: AbstractPowerSyncDatabase,
+  powerSync: AbstractPowerSyncDatabase,
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,

package/lib/types/persisters/persister-remote.d.ts

@@ -6,8 +6,8 @@
  * @module persister-remote
  */
 
-import {Persister} from '../persisters';
-import {Store} from '../store';
+import {Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 
 /**
  * The RemotePersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-sqlite-wasm.d.ts

@@ -8,8 +8,8 @@
  * @since v4.0.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {Store} from '../store';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {Store} from '../store.d.ts';
 
 /**
  * The SqliteWasmPersister interface is a minor extension to the Persister

package/lib/types/persisters/persister-sqlite3.d.ts

@@ -8,9 +8,9 @@
  * @since v4.0.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
 import {Database} from 'sqlite3';
-import {Store} from '../store';
+import {Store} from '../store.d.ts';
 
 /**
  * The Sqlite3Persister interface is a minor extension to the Persister

package/lib/types/persisters.d.ts

@@ -45,7 +45,7 @@ import {
   MergeableChanges,
   MergeableContent,
   MergeableStore,
-} from './mergeable-store';
+} from './mergeable-store.d.ts';
 import {Id} from './common.d.ts';
 
 /**
@@ -1180,9 +1180,10 @@ export interface Persister<StoreType extends StoreTypes = 1> {
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @param supportsMergeableStore An optional boolean to indicate that this
- * Persister will be able to handle MergeableStore persistence as well as
- * regular Store persistence, since v5.0.
+ * @param supportedStoreType Since v5.0, an optional integer to indicate which
+ * types of Store are supported by this Persister: `1` indicates only a regular
+ * Store is supported, `2` indicates only a MergeableStore is supported, and `3`
+ * indicates that both Store and MergeableStore are supported.
  * @returns A reference to the new Persister object.
  * @example
  * This example creates a custom Persister object and persists the Store to a

package/lib/types/relationships.d.ts

@@ -491,7 +491,7 @@ export interface Relationships {
    * ```
    * @category Getter
    */
-  hasRelationship(indexId: Id): boolean;
+  hasRelationship(relationshipId: Id): boolean;
 
   /**
    * The getLocalTableId method returns the Id of the underlying local Table

package/lib/types/synchronizers/synchronizer-local.d.ts

@@ -8,8 +8,8 @@
  * @since v5.0.0
  */
 
-import {MergeableStore} from '../mergeable-store';
-import {Synchronizer} from '../synchronizers';
+import {MergeableStore} from '../mergeable-store.d.ts';
+import {Synchronizer} from '../synchronizers.d.ts';
 
 /**
  * The LocalSynchronizer interface

package/lib/types/synchronizers/synchronizer-ws-client.d.ts

@@ -9,8 +9,8 @@
  * @since v5.0.0
  */
 
-import {MergeableStore} from '../mergeable-store';
-import {Synchronizer} from '../synchronizers';
+import {MergeableStore} from '../mergeable-store.d.ts';
+import {Synchronizer} from '../synchronizers.d.ts';
 import {WebSocket as WsWebSocket} from 'ws';
 
 export type WebSocketTypes = WebSocket | WsWebSocket;

package/lib/types/synchronizers/synchronizer-ws-server.d.ts

@@ -8,8 +8,8 @@
  * @since v5.0.0
  */
 
-import {Id, IdOrNull, Ids} from '../common';
-import {GetIdChanges} from '../store';
+import {Id, IdOrNull, Ids} from '../common.d.ts';
+import {GetIdChanges} from '../store.d.ts';
 import {WebSocketServer} from 'ws';
 
 /**

package/lib/types/synchronizers.d.ts

@@ -7,10 +7,10 @@
  * @since v5.0.0
  */
 
-import {Id, IdOrNull} from './common';
-import {Content} from './store';
-import {MergeableStore} from './mergeable-store';
-import {Persister} from './persisters';
+import {Id, IdOrNull} from './common.d.ts';
+import {Content} from './store.d.ts';
+import {MergeableStore} from './mergeable-store.d.ts';
+import {Persister} from './persisters.d.ts';
 
 /**
  * The MessageType type
@@ -83,12 +83,16 @@ export interface Synchronizer extends Persister<2> {
  * persist one MergeableStore to another.
  *
  * As well as providing a reference to the MergeableStore to synchronize, you
- * must provide a `client` parameter which identifies the Client that is used to
- * transmit changes to and from this MergeableStore and its peers.
+ * must provide parameters which identify how to send and receive changes to and
+ * from this MergeableStore and its peers.
  * @param store The MergeableStore to synchronize.
- * @param client The reference of the Client.
- * @param requestTimeoutSeconds An optional number of seconds before a request
- * to the Client times out, defaulting to 5.
+ * @param send A Send function for sending a message.
+ * @param onReceive A callback to register a Receive function for receiving a
+ * message.
+ * @param destroy A function called when destroying the Persister which can be
+ * used to clean up underlying resources.
+ * @param requestTimeoutSeconds An number of seconds before a request sent from
+ * this Persister to another peer times out.
  * @param onIgnoredError An optional handler for the errors that the
  * Synchronizer would otherwise ignore when trying to save or load data. This is
  * suitable for debugging synchronization issues in a development environment.

package/lib/types/ui-react-dom.d.ts

@@ -21,8 +21,8 @@ import {
   ResultCellProps,
   StoreOrStoreId,
   ValueProps,
-} from './ui-react';
-import {Id, Ids} from './common';
+} from './ui-react.d.ts';
+import {Id, Ids} from './common.d.ts';
 import {ComponentType} from 'react';
 
 /**

package/lib/types/ui-react.d.ts

@@ -83,7 +83,7 @@ import {
   ResultTableCellIdsListener,
   ResultTableListener,
 } from './queries.d.ts';
-import {MergeableStore} from './mergeable-store';
+import {MergeableStore} from './mergeable-store.d.ts';
 import {Persister} from './persisters.d.ts';
 import {Synchronizer} from './synchronizers';
 
@@ -7357,7 +7357,7 @@ export function useQueries(id?: Id): Queries | undefined;
  *
  * This is unlikely to be used often. For most situations, you will want to use
  * the useQueries hook.
- * @param queriesOrOrQueriesId Either an Id for accessing a Queries object that
+ * @param queriesOrQueriesId Either an Id for accessing a Queries object that
  * was named with an Id in the Provider, or the Queries object itself.
  * @returns A reference to the Queries object (or `undefined` if not within a
  * Provider context, or if the requested Queries object does not exist).
@@ -7421,9 +7421,9 @@ export function useQueriesOrQueriesById(
  * Query Ids in the Queries object will cause a re-render. When the component
  * containing this hook is unmounted, the listener will be automatically
  * removed.
- * @param relationshipsOrRelationshipsId The Queries object to be accessed: omit
- * for the default context Queries object, provide an Id for a named context
- * Queries object, or provide an explicit reference.
+ * @param queriesOrQueriesId The Queries object to be accessed: omit for the
+ * default context Queries object, provide an Id for a named context Queries
+ * object, or provide an explicit reference.
  * @returns The Query Ids in the Queries object, or an empty array.
  * @example
  * This example creates an Queries object outside the application, which is used

package/lib/types/with-schemas/common.d.ts

@@ -104,3 +104,10 @@ export type SortKey = string | number | boolean;
  * @category Convenience
  */
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
+
+/**
+ * The getUniqueId function
+ * @category Convenience
+ * @since v5.0.0
+ */
+export function getUniqueId(): Id;

package/lib/types/with-schemas/indexes.d.ts

@@ -10,7 +10,7 @@
  * @module indexes
  */
 
-import {CellIdFromSchema, TableIdFromSchema} from './internal/store';
+import {CellIdFromSchema, TableIdFromSchema} from './internal/store.d.ts';
 import {
   GetCell,
   OptionalSchemas,

package/lib/types/with-schemas/internal/queries.d.ts

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

package/lib/types/with-schemas/internal/store.d.ts

@@ -5,8 +5,8 @@ import {
   OptionalValuesSchema,
   Store,
   Value,
-} from '../store';
-import {Id} from '../common';
+} from '../store.d.ts';
+import {Id} from '../common.d.ts';
 
 export type TableIdFromSchema<Schema extends OptionalTablesSchema> = AsId<
   keyof Schema

package/lib/types/with-schemas/internal/ui-react.d.ts

@@ -1,12 +1,16 @@
-import {Callback, Id} from '../common';
-import {CellIdFromSchema, TableIdFromSchema, ValueIdFromSchema} from './store';
+import {Callback, Id} from '../common.d.ts';
+import {
+  CellIdFromSchema,
+  TableIdFromSchema,
+  ValueIdFromSchema,
+} from './store.d.ts';
 import {ComponentType, ReactElement} from 'react';
-import {OptionalSchemas, Store} from '../store';
-import {Checkpoints} from '../checkpoints';
-import {Indexes} from '../indexes';
-import {Metrics} from '../metrics';
-import {Queries} from '../queries';
-import {Relationships} from '../relationships';
+import {OptionalSchemas, Store} from '../store.d.ts';
+import {Checkpoints} from '../checkpoints.d.ts';
+import {Indexes} from '../indexes.d.ts';
+import {Metrics} from '../metrics.d.ts';
+import {Queries} from '../queries.d.ts';
+import {Relationships} from '../relationships.d.ts';
 
 type StoreOrStoreId<Schemas extends OptionalSchemas> = Store<Schemas> | Id;
 

package/lib/types/with-schemas/mergeable-store.d.ts

@@ -9,7 +9,7 @@ import {
   CellIdFromSchema,
   TableIdFromSchema,
   ValueIdFromSchema,
-} from './internal/store';
+} from './internal/store.d.ts';
 import {
   CellOrUndefined,
   Content,
@@ -24,7 +24,7 @@ import {
   ValueOrUndefined,
   ValuesSchema,
 } from './store.d.ts';
-import {Id} from './common';
+import {Id} from './common.d.ts';
 
 /**
  * The Hash type
@@ -166,12 +166,6 @@ export type MergeableChanges<Schemas extends OptionalSchemas> = [
 export interface MergeableStore<Schemas extends OptionalSchemas>
   extends Store<Schemas> {
   //
-  /**
-   * The getId method
-   * @category Getter
-   */
-  getId(): Id;
-
   /**
    * The getMergeableContent method
    * @category Getter
@@ -489,4 +483,4 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
  * The createMergeableStore function
  * @category Creation
  */
-export function createMergeableStore(id: Id): MergeableStore<NoSchemas>;
+export function createMergeableStore(uniqueId?: Id): MergeableStore<NoSchemas>;

package/lib/types/with-schemas/metrics.d.ts

@@ -10,7 +10,7 @@
  * @module metrics
  */
 
-import {CellIdFromSchema, TableIdFromSchema} from './internal/store';
+import {CellIdFromSchema, TableIdFromSchema} from './internal/store.d.ts';
 import {GetCell, OptionalSchemas, Store} from './store.d.ts';
 import {Id, IdOrNull, Ids} from './common.d.ts';
 

package/lib/types/with-schemas/persisters/persister-automerge.d.ts

@@ -11,9 +11,9 @@
  * @since v4.0.0
  */
 
-import {OptionalSchemas, Store} from '../store';
+import {OptionalSchemas, Store} from '../store.d.ts';
 import {DocHandle} from '@automerge/automerge-repo';
-import {Persister} from '../persisters';
+import {Persister} from '../persisters.d.ts';
 
 /**
  * The AutomergePersister interface is a minor extension to the Persister

package/lib/types/with-schemas/persisters/persister-browser.d.ts

@@ -14,9 +14,9 @@
  * @module persister-browser
  */
 
-import {OptionalSchemas, Store} from '../store';
-import {MergeableStore} from '../mergeable-store';
-import {Persister} from '../persisters';
+import {OptionalSchemas, Store} from '../store.d.ts';
+import {MergeableStore} from '../mergeable-store.d.ts';
+import {Persister} from '../persisters.d.ts';
 
 /**
  * The SessionPersister interface is a minor extension to the Persister

package/lib/types/with-schemas/persisters/persister-cr-sqlite-wasm.d.ts

@@ -8,8 +8,8 @@
  * @since v4.0.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {OptionalSchemas, Store} from '../store';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {OptionalSchemas, Store} from '../store.d.ts';
 import {DB} from '@vlcn.io/crsqlite-wasm';
 
 /**

package/lib/types/with-schemas/persisters/persister-electric-sql.d.ts

@@ -8,8 +8,8 @@
  * @since v4.6.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {OptionalSchemas, Store} from '../store';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {OptionalSchemas, Store} from '../store.d.ts';
 import {ElectricClient} from 'electric-sql/client/model';
 
 /**

package/lib/types/with-schemas/persisters/persister-expo-sqlite-next.d.ts

@@ -20,8 +20,8 @@
  * @since v4.5.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {OptionalSchemas, Store} from '../store';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {OptionalSchemas, Store} from '../store.d.ts';
 import {SQLiteDatabase} from 'expo-sqlite/next';
 
 /**

package/lib/types/with-schemas/persisters/persister-expo-sqlite.d.ts

@@ -19,8 +19,8 @@
  * @since v4.0.3
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {OptionalSchemas, Store} from '../store';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {OptionalSchemas, Store} from '../store.d.ts';
 import {SQLiteDatabase} from 'expo-sqlite';
 
 /**

package/lib/types/with-schemas/persisters/persister-file.d.ts

@@ -6,9 +6,9 @@
  * @module persister-file
  */
 
-import {OptionalSchemas, Store} from '../store';
-import {MergeableStore} from '../mergeable-store';
-import {Persister} from '../persisters';
+import {OptionalSchemas, Store} from '../store.d.ts';
+import {MergeableStore} from '../mergeable-store.d.ts';
+import {Persister} from '../persisters.d.ts';
 
 /**
  * The FilePersister interface is a minor extension to the Persister interface.

package/lib/types/with-schemas/persisters/persister-indexed-db.d.ts

@@ -6,8 +6,8 @@
  * @module persister-indexed-db
  */
 
-import {OptionalSchemas, Store} from '../store';
-import {Persister} from '../persisters';
+import {OptionalSchemas, Store} from '../store.d.ts';
+import {Persister} from '../persisters.d.ts';
 
 /**
  * The IndexedDbPersister interface is a minor extension to the Persister

package/lib/types/with-schemas/persisters/persister-libsql.d.ts

@@ -8,8 +8,8 @@
  * @since v4.7.0
  */
 
-import {DatabasePersisterConfig, Persister} from '../persisters';
-import {OptionalSchemas, Store} from '../store';
+import {DatabasePersisterConfig, Persister} from '../persisters.d.ts';
+import {OptionalSchemas, Store} from '../store.d.ts';
 import {Client} from '@libsql/client';
 
 /**
@@ -80,7 +80,7 @@ export interface LibSqlPersister<Schemas extends OptionalSchemas>
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
  * @param store The Store to persist.
- * @param db The database client that was returned from `createClient(...)`.
+ * @param client The database client that was returned from `createClient(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the
  * persistence mode (or a string to set the `storeTableName` property of the
  * JSON serialization).