tinybase 5.0.0-beta.27 → 5.0.0-beta.28

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

@@ -1,9 +1,10 @@
 /**
  * The persister-file module of the TinyBase project lets you save and load
  * Store data to and from a local file system (in an appropriate environment).
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-file
+ * @since v1.0.0
  */
 
 import type {
@@ -17,12 +18,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The FilePersister interface represents a Persister that lets you save and
  * load Store data to and from a local file system.
  *
+ * You should use the createFilePersister function to create a FilePersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getFilePath method for accessing the location of the local file the
  * Store is being persisted to.
- *
- * You should use the createFilePersister function to create a FilePersister
- * object.
  * @category Persister
  * @since v4.3.14
  */
@@ -98,6 +99,7 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createFilePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,

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

@@ -1,9 +1,10 @@
 /**
  * The persister-file module of the TinyBase project lets you save and load
  * Store data to and from a local file system (in an appropriate environment).
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-file
+ * @since v1.0.0
  */
 
 import type {
@@ -17,12 +18,12 @@ import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d
  * The FilePersister interface represents a Persister that lets you save and
  * load Store data to and from a local file system.
  *
+ * You should use the createFilePersister function to create a FilePersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getFilePath method for accessing the location of the local file the
  * Store is being persisted to.
- *
- * You should use the createFilePersister function to create a FilePersister
- * object.
  * @category Persister
  * @since v4.3.14
  */
@@ -98,6 +99,7 @@ export interface FilePersister<Schemas extends OptionalSchemas>
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createFilePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas> | MergeableStore<Schemas>,

package/@types/persisters/persister-indexed-db/index.d.cts

@@ -1,9 +1,10 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 import type {Persister} from '../index.d.cts';
@@ -13,12 +14,12 @@ import type {Store} from '../../store/index.d.cts';
  * The IndexedDbPersister interface represents a Persister that lets you save
  * and load Store data to and from browser IndexedDB storage.
  *
+ * You should use the createIndexedDbPersister function to create an
+ * IndexedDbPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDbName method for accessing the unique key of the IndexedDB the
  * Store is being persisted to.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
  * @category Persister
  * @since v4.3.14
  */

package/@types/persisters/persister-indexed-db/index.d.ts

@@ -1,9 +1,10 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 import type {Persister} from '../index.d.ts';
@@ -13,12 +14,12 @@ import type {Store} from '../../store/index.d.ts';
  * The IndexedDbPersister interface represents a Persister that lets you save
  * and load Store data to and from browser IndexedDB storage.
  *
+ * You should use the createIndexedDbPersister function to create an
+ * IndexedDbPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDbName method for accessing the unique key of the IndexedDB the
  * Store is being persisted to.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -1,9 +1,10 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 import type {
@@ -16,12 +17,12 @@ import type {Persister} from '../../with-schemas/index.d.cts';
  * The IndexedDbPersister interface represents a Persister that lets you save
  * and load Store data to and from browser IndexedDB storage.
  *
+ * You should use the createIndexedDbPersister function to create an
+ * IndexedDbPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDbName method for accessing the unique key of the IndexedDB the
  * Store is being persisted to.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -1,9 +1,10 @@
 /**
  * The persister-indexed-db module of the TinyBase project lets you save and
  * load Store data to and from browser IndexedDB storage.
- * @see Persisting Data guide
+ * @see Persistence guides
  * @packageDocumentation
  * @module persister-indexed-db
+ * @since v4.2.0
  */
 
 import type {
@@ -16,12 +17,12 @@ import type {Persister} from '../../with-schemas/index.d.ts';
  * The IndexedDbPersister interface represents a Persister that lets you save
  * and load Store data to and from browser IndexedDB storage.
  *
+ * You should use the createIndexedDbPersister function to create an
+ * IndexedDbPersister object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getDbName method for accessing the unique key of the IndexedDB the
  * Store is being persisted to.
- *
- * You should use the createIndexedDbPersister function to create an
- * IndexedDbPersister object.
  * @category Persister
  * @since v4.3.14
  */

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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -16,12 +16,13 @@ import type {Store} from '../../store/index.d.cts';
  * The LibSqlPersister interface represents a Persister that lets you save and
  * load Store data to and from a local LibSQL database.
  *
+ * You should use the createLibSqlPersister function to create a LibSqlPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getClient method for accessing a reference to the database client the
  * Store is being persisted to.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister extends Persister {

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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -16,12 +16,13 @@ import type {Store} from '../../store/index.d.ts';
  * The LibSqlPersister interface represents a Persister that lets you save and
  * load Store data to and from a local LibSQL database.
  *
+ * You should use the createLibSqlPersister function to create a LibSqlPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getClient method for accessing a reference to the database client the
  * Store is being persisted to.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister extends Persister {

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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -22,12 +22,13 @@ import type {Client} from '@libsql/client';
  * The LibSqlPersister interface represents a Persister that lets you save and
  * load Store data to and from a local LibSQL database.
  *
+ * You should use the createLibSqlPersister function to create a LibSqlPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getClient method for accessing a reference to the database client the
  * Store is being persisted to.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister<Schemas extends OptionalSchemas>

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

@@ -2,7 +2,7 @@
  * The persister-libsql module of the TinyBase project lets you save and load
  * Store data to and from a local LibSQL database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-libsql
  * @since v4.7.0
@@ -22,12 +22,13 @@ import type {Client} from '@libsql/client';
  * The LibSqlPersister interface represents a Persister that lets you save and
  * load Store data to and from a local LibSQL database.
  *
+ * You should use the createLibSqlPersister function to create a LibSqlPersister
+ * object.
+ *
  * It is a minor extension to the Persister interface and simply provides an
  * extra getClient method for accessing a reference to the database client the
  * Store is being persisted to.
- *
- * You should use the createLibSqlPersister function to create a LibSqlPersister
- * object.
+ * @category Persister
  * @since v4.7.0
  */
 export interface LibSqlPersister<Schemas extends OptionalSchemas>

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

@@ -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';
@@ -27,12 +27,12 @@ import type {Store} from '../../store/index.d.cts';
  * 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.
- *
- * You should use the createPartyKitPersister function to create a
- * PartyKitPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -97,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;
   /**
@@ -112,6 +116,8 @@ 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;
 };
@@ -180,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/index.d.ts

@@ -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';
@@ -27,12 +27,12 @@ import type {Store} from '../../store/index.d.ts';
  * 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.
- *
- * You should use the createPartyKitPersister function to create a
- * PartyKitPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -97,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;
   /**
@@ -112,6 +116,8 @@ 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;
 };
@@ -180,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

@@ -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 {
@@ -30,12 +30,12 @@ import type {Persister} from '../../with-schemas/index.d.cts';
  * 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.
- *
- * You should use the createPartyKitPersister function to create a
- * PartyKitPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -101,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;
   /**
@@ -116,6 +120,8 @@ 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;
 };
@@ -195,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

@@ -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 {
@@ -30,12 +30,12 @@ import type {Persister} from '../../with-schemas/index.d.ts';
  * 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.
- *
- * You should use the createPartyKitPersister function to create a
- * PartyKitPersister object.
  * @category Persister
  * @since v4.3.14
  */
@@ -101,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;
   /**
@@ -116,6 +120,8 @@ 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;
 };
@@ -195,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 {