tinybase 5.0.0-beta.26 → 5.0.0-beta.28

package/@types/persisters/persister-partykit-client/index.d.ts

@@ -3,8 +3,8 @@
  * client portion of the PartyKit integration.
  *
  * It contains a Persister which, when run in a PartyKit client environment,
- * lets you save and load Store data from the client to durable PartyKit cloud
- * storage of a server (that is using the complementary
+ * lets you save and load Store data from the client to the durable PartyKit
+ * cloud storage of a server (that is using the complementary
  * persister-partykit-server module).
  *
  * This enables synchronization of the same Store across multiple clients in a
@@ -12,10 +12,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-client
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {PartySocket} from 'partysocket';
@@ -23,14 +23,16 @@ import type {Persister} from '../index.d.ts';
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The PartyKitPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getConnection method for accessing the
- * PartySocket the Store is being persisted to.
+ * The PartyKitPersister interface represents a Persister that lets you save and
+ * load Store data from the client to the durable PartyKit cloud storage of a
+ * server.
  *
  * You should use the createPartyKitPersister function to create a
  * PartyKitPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getConnection method for accessing the PartySocket the Store is being
+ * persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -95,12 +97,16 @@ export type PartyKitPersisterConfig = {
    * The HTTP protocol to use (in addition to the websocket channel). This
    * defaults to 'https' but you may wish to use 'http' for local PartyKit
    * development.
+   * @category Configuration
+   * @since v4.3.0
    */
   storeProtocol?: 'http' | 'https';
   /**
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the TinyBasePartyKitServerConfig
    * object used on the server. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -110,14 +116,19 @@ export type PartyKitPersisterConfig = {
    * This must match the messagePrefix property of the
    * TinyBasePartyKitServerConfig object used on the server. Both default to an
    * empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
 };
 
 /**
- * The createPartyKitPersister function creates a Persister object that can
- * persist the Store to durable PartyKit storage, enabling synchronization of
- * the same Store across multiple clients.
+ * The createPartyKitPersister function creates a PartyKitPersister object that
+ * can persist the Store to durable PartyKit storage, enabling synchronization
+ * of the same Store across multiple clients.
+ *
+ * A PartyKitPersister only supports regular Store objects, and cannot be used
+ * to persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `connection` parameter which is a PartyKit PartySocket that you have already
@@ -175,7 +186,7 @@ export type PartyKitPersisterConfig = {
  * persister.destroy();
  * ```
  * @category Creation
- * @since 4.3.0
+ * @since v4.3.0
  */
 export function createPartyKitPersister(
   store: Store,

package/@types/persisters/persister-partykit-client/with-schemas/index.d.cts

@@ -3,8 +3,8 @@
  * client portion of the PartyKit integration.
  *
  * It contains a Persister which, when run in a PartyKit client environment,
- * lets you save and load Store data from the client to durable PartyKit cloud
- * storage of a server (that is using the complementary
+ * lets you save and load Store data from the client to the durable PartyKit
+ * cloud storage of a server (that is using the complementary
  * persister-partykit-server module).
  *
  * This enables synchronization of the same Store across multiple clients in a
@@ -12,10 +12,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-client
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -26,14 +26,16 @@ import type {PartySocket} from 'partysocket';
 import type {Persister} from '../../with-schemas/index.d.cts';
 
 /**
- * The PartyKitPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getConnection method for accessing the
- * PartySocket the Store is being persisted to.
+ * The PartyKitPersister interface represents a Persister that lets you save and
+ * load Store data from the client to the durable PartyKit cloud storage of a
+ * server.
  *
  * You should use the createPartyKitPersister function to create a
  * PartyKitPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getConnection method for accessing the PartySocket the Store is being
+ * persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -99,12 +101,16 @@ export type PartyKitPersisterConfig = {
    * The HTTP protocol to use (in addition to the websocket channel). This
    * defaults to 'https' but you may wish to use 'http' for local PartyKit
    * development.
+   * @category Configuration
+   * @since v4.3.0
    */
   storeProtocol?: 'http' | 'https';
   /**
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the TinyBasePartyKitServerConfig
    * object used on the server. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -114,14 +120,16 @@ export type PartyKitPersisterConfig = {
    * This must match the messagePrefix property of the
    * TinyBasePartyKitServerConfig object used on the server. Both default to an
    * empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
 };
 
 /**
- * The createPartyKitPersister function creates a Persister object that can
- * persist the Store to durable PartyKit storage, enabling synchronization of
- * the same Store across multiple clients.
+ * The createPartyKitPersister function creates a PartyKitPersister object that
+ * can persist the Store to durable PartyKit storage, enabling synchronization
+ * of the same Store across multiple clients.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -134,6 +142,9 @@ export type PartyKitPersisterConfig = {
  * ): PartyKitPersister;
  * ```
  *
+ * A PartyKitPersister only supports regular Store objects, and cannot be used
+ * to persist the metadata of a MergeableStore.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `connection` parameter which is a PartyKit PartySocket that you have already
  * instantiated with details of the host and room.
@@ -190,7 +201,7 @@ export type PartyKitPersisterConfig = {
  * persister.destroy();
  * ```
  * @category Creation
- * @since 4.3.0
+ * @since v4.3.0
  */
 export function createPartyKitPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,

package/@types/persisters/persister-partykit-client/with-schemas/index.d.ts

@@ -3,8 +3,8 @@
  * client portion of the PartyKit integration.
  *
  * It contains a Persister which, when run in a PartyKit client environment,
- * lets you save and load Store data from the client to durable PartyKit cloud
- * storage of a server (that is using the complementary
+ * lets you save and load Store data from the client to the durable PartyKit
+ * cloud storage of a server (that is using the complementary
  * persister-partykit-server module).
  *
  * This enables synchronization of the same Store across multiple clients in a
@@ -12,10 +12,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-client
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -26,14 +26,16 @@ import type {PartySocket} from 'partysocket';
 import type {Persister} from '../../with-schemas/index.d.ts';
 
 /**
- * The PartyKitPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getConnection method for accessing the
- * PartySocket the Store is being persisted to.
+ * The PartyKitPersister interface represents a Persister that lets you save and
+ * load Store data from the client to the durable PartyKit cloud storage of a
+ * server.
  *
  * You should use the createPartyKitPersister function to create a
  * PartyKitPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getConnection method for accessing the PartySocket the Store is being
+ * persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -99,12 +101,16 @@ export type PartyKitPersisterConfig = {
    * The HTTP protocol to use (in addition to the websocket channel). This
    * defaults to 'https' but you may wish to use 'http' for local PartyKit
    * development.
+   * @category Configuration
+   * @since v4.3.0
    */
   storeProtocol?: 'http' | 'https';
   /**
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the TinyBasePartyKitServerConfig
    * object used on the server. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -114,14 +120,16 @@ export type PartyKitPersisterConfig = {
    * This must match the messagePrefix property of the
    * TinyBasePartyKitServerConfig object used on the server. Both default to an
    * empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
 };
 
 /**
- * The createPartyKitPersister function creates a Persister object that can
- * persist the Store to durable PartyKit storage, enabling synchronization of
- * the same Store across multiple clients.
+ * The createPartyKitPersister function creates a PartyKitPersister object that
+ * can persist the Store to durable PartyKit storage, enabling synchronization
+ * of the same Store across multiple clients.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -134,6 +142,9 @@ export type PartyKitPersisterConfig = {
  * ): PartyKitPersister;
  * ```
  *
+ * A PartyKitPersister only supports regular Store objects, and cannot be used
+ * to persist the metadata of a MergeableStore.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `connection` parameter which is a PartyKit PartySocket that you have already
  * instantiated with details of the host and room.
@@ -190,7 +201,7 @@ export type PartyKitPersisterConfig = {
  * persister.destroy();
  * ```
  * @category Creation
- * @since 4.3.0
+ * @since v4.3.0
  */
 export function createPartyKitPersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,

package/@types/persisters/persister-partykit-server/index.d.cts

@@ -11,10 +11,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-server
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -70,6 +70,8 @@ export type TinyBasePartyKitServerConfig = {
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the PartyKitPersisterConfig used
    * on the client. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -78,12 +80,16 @@ export type TinyBasePartyKitServerConfig = {
    * not collide with any other message syntax that your room is using. This
    * must match the messagePrefix property of the PartyKitPersisterConfig object
    * used on the client. Both default to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
   /**
    * The prefix used before all the keys in the server's durable storage. Use
    * this in case you are worried about the Store data colliding with other data
    * stored in the room. Defaults to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   storagePrefix?: string;
   /**
@@ -99,6 +105,8 @@ export type TinyBasePartyKitServerConfig = {
    * If you set this field, it will override the default completely. So, for
    * example, if you add another header but still want the CORS defaults, you
    * will need to explicitly set the Access-Control-Allow headers above again.
+   * @category Configuration
+   * @since v4.3.0
    */
   responseHeaders?: HeadersInit;
 };
@@ -149,7 +157,7 @@ export type TinyBasePartyKitServerConfig = {
  * See the [PartyKit server API
  * documentation](https://docs.partykit.io/reference/partyserver-api/) for
  * more details.
- * @category Creation
+ * @category Server
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {

package/@types/persisters/persister-partykit-server/index.d.ts

@@ -11,10 +11,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-server
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -70,6 +70,8 @@ export type TinyBasePartyKitServerConfig = {
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the PartyKitPersisterConfig used
    * on the client. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -78,12 +80,16 @@ export type TinyBasePartyKitServerConfig = {
    * not collide with any other message syntax that your room is using. This
    * must match the messagePrefix property of the PartyKitPersisterConfig object
    * used on the client. Both default to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
   /**
    * The prefix used before all the keys in the server's durable storage. Use
    * this in case you are worried about the Store data colliding with other data
    * stored in the room. Defaults to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   storagePrefix?: string;
   /**
@@ -99,6 +105,8 @@ export type TinyBasePartyKitServerConfig = {
    * If you set this field, it will override the default completely. So, for
    * example, if you add another header but still want the CORS defaults, you
    * will need to explicitly set the Access-Control-Allow headers above again.
+   * @category Configuration
+   * @since v4.3.0
    */
   responseHeaders?: HeadersInit;
 };
@@ -149,7 +157,7 @@ export type TinyBasePartyKitServerConfig = {
  * See the [PartyKit server API
  * documentation](https://docs.partykit.io/reference/partyserver-api/) for
  * more details.
- * @category Creation
+ * @category Server
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {

package/@types/persisters/persister-partykit-server/with-schemas/index.d.cts

@@ -11,10 +11,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-server
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -67,6 +67,8 @@ export type TinyBasePartyKitServerConfig = {
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the PartyKitPersisterConfig used
    * on the client. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -75,12 +77,16 @@ export type TinyBasePartyKitServerConfig = {
    * not collide with any other message syntax that your room is using. This
    * must match the messagePrefix property of the PartyKitPersisterConfig object
    * used on the client. Both default to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
   /**
    * The prefix used before all the keys in the server's durable storage. Use
    * this in case you are worried about the Store data colliding with other data
    * stored in the room. Defaults to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   storagePrefix?: string;
   /**
@@ -96,6 +102,8 @@ export type TinyBasePartyKitServerConfig = {
    * If you set this field, it will override the default completely. So, for
    * example, if you add another header but still want the CORS defaults, you
    * will need to explicitly set the Access-Control-Allow headers above again.
+   * @category Configuration
+   * @since v4.3.0
    */
   responseHeaders?: HeadersInit;
 };
@@ -146,7 +154,7 @@ export type TinyBasePartyKitServerConfig = {
  * See the [PartyKit server API
  * documentation](https://docs.partykit.io/reference/partyserver-api/) for
  * more details.
- * @category Creation
+ * @category Server
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {

package/@types/persisters/persister-partykit-server/with-schemas/index.d.ts

@@ -11,10 +11,10 @@
  *
  * Note that both the client and server parts of this Persister are currently
  * experimental as PartyKit is new and still maturing.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-partykit-server
- * @since 4.3.0
+ * @since v4.3.0
  */
 
 import type {
@@ -67,6 +67,8 @@ export type TinyBasePartyKitServerConfig = {
    * The path used to set and get the whole Store over HTTP(S) on the server.
    * This must match the storePath property of the PartyKitPersisterConfig used
    * on the client. Both default to '/store'.
+   * @category Configuration
+   * @since v4.3.0
    */
   storePath?: string;
   /**
@@ -75,12 +77,16 @@ export type TinyBasePartyKitServerConfig = {
    * not collide with any other message syntax that your room is using. This
    * must match the messagePrefix property of the PartyKitPersisterConfig object
    * used on the client. Both default to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   messagePrefix?: string;
   /**
    * The prefix used before all the keys in the server's durable storage. Use
    * this in case you are worried about the Store data colliding with other data
    * stored in the room. Defaults to an empty string.
+   * @category Configuration
+   * @since v4.3.0
    */
   storagePrefix?: string;
   /**
@@ -96,6 +102,8 @@ export type TinyBasePartyKitServerConfig = {
    * If you set this field, it will override the default completely. So, for
    * example, if you add another header but still want the CORS defaults, you
    * will need to explicitly set the Access-Control-Allow headers above again.
+   * @category Configuration
+   * @since v4.3.0
    */
   responseHeaders?: HeadersInit;
 };
@@ -146,7 +154,7 @@ export type TinyBasePartyKitServerConfig = {
  * See the [PartyKit server API
  * documentation](https://docs.partykit.io/reference/partyserver-api/) for
  * more details.
- * @category Creation
+ * @category Server
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {

package/@types/persisters/persister-powersync/index.d.cts

@@ -2,7 +2,7 @@
  * The persister-powersync module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database that is automatically synced
  * using the PowerSync service.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-powersync
  * @since v4.8.0
@@ -13,14 +13,17 @@ import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common'
 import type {Store} from '../../store/index.d.cts';
 
 /**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
+ * The PowerSyncPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
  * You should use the createPowerSyncPersister function to create a
  * PowerSyncPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPowerSync method for accessing a reference to the PowerSync instance
+ * the Store is being persisted to.
+ * @category Persister
  * @since v4.8.0
  */
 export interface PowerSyncPersister extends Persister {
@@ -53,9 +56,12 @@ export interface PowerSyncPersister extends Persister {
 }
 
 /**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
+ * The createPowerSyncPersister function creates a PowerSyncPersister object
+ * that can persist the Store to a local SQLite database that is automatically
+ * synced using the PowerSync service.
+ *
+ * A PowerSyncPersister only supports regular Store objects, and cannot be used
+ * to persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `powerSync` parameter which identifies the PowerSync instance.

package/@types/persisters/persister-powersync/index.d.ts

@@ -2,7 +2,7 @@
  * The persister-powersync module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database that is automatically synced
  * using the PowerSync service.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-powersync
  * @since v4.8.0
@@ -13,14 +13,17 @@ import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common'
 import type {Store} from '../../store/index.d.ts';
 
 /**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
+ * The PowerSyncPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
  * You should use the createPowerSyncPersister function to create a
  * PowerSyncPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPowerSync method for accessing a reference to the PowerSync instance
+ * the Store is being persisted to.
+ * @category Persister
  * @since v4.8.0
  */
 export interface PowerSyncPersister extends Persister {
@@ -53,9 +56,12 @@ export interface PowerSyncPersister extends Persister {
 }
 
 /**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
+ * The createPowerSyncPersister function creates a PowerSyncPersister object
+ * that can persist the Store to a local SQLite database that is automatically
+ * synced using the PowerSync service.
+ *
+ * A PowerSyncPersister only supports regular Store objects, and cannot be used
+ * to persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide a
  * `powerSync` parameter which identifies the PowerSync instance.

package/@types/persisters/persister-powersync/with-schemas/index.d.cts

@@ -2,7 +2,7 @@
  * The persister-powersync module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database that is automatically synced
  * using the PowerSync service.
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-powersync
  * @since v4.8.0
@@ -19,14 +19,17 @@ import type {
 import type {AbstractPowerSyncDatabase} from '@journeyapps/powersync-sdk-common';
 
 /**
- * The PowerSyncPersister interface is a minor extension to the Persister
- * interface.
- *
- * It simply provides an extra getPowerSync method for accessing a reference to
- * the PowerSync instance the Store is being persisted to.
+ * The PowerSyncPersister interface represents a Persister that lets you save
+ * and load Store data to and from a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
  * You should use the createPowerSyncPersister function to create a
  * PowerSyncPersister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getPowerSync method for accessing a reference to the PowerSync instance
+ * the Store is being persisted to.
+ * @category Persister
  * @since v4.8.0
  */
 export interface PowerSyncPersister<Schemas extends OptionalSchemas>
@@ -60,9 +63,9 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createPowerSyncPersister function creates a Persister object that can
- * persist the Store to a local SQLite database that is automatically synced
- * using the PowerSync service.
+ * The createPowerSyncPersister function creates a PowerSyncPersister object
+ * that can persist the Store to a local SQLite database that is automatically
+ * synced using the PowerSync service.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -76,6 +79,9 @@ export interface PowerSyncPersister<Schemas extends OptionalSchemas>
  * ): PowerSyncPersister;
  * ```
  *
+ * A PowerSyncPersister only supports regular Store objects, and cannot be used
+ * to persist the metadata of a MergeableStore.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `powerSync` parameter which identifies the PowerSync instance.
  *