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

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

@@ -3,28 +3,29 @@
  * saving and loading Store and MergeableStore data, to and from different
  * destinations, or underlying storage types.
  *
- * Several entry points are provided (in separately installed modules), each of
- * which returns a new Persister object that can load and save a Store. Between
- * them, these allow you to store your TinyBase data locally, remotely, to
- * SQLite databases, and across synchronization boundaries with CRDT frameworks.
- *
- * |Module|Function|Storage|Store|MergeableStore
- * |-|-|-|-|-|
- * |persister-browser|createSessionPersister|Browser session storage|Yes|Yes
- * |persister-browser|createLocalPersister|Browser local storage|Yes|Yes
- * |persister-file|createFilePersister|Local file (where possible)|Yes|Yes
- * |persister-sqlite3|createSqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|Yes|Yes*
- * |persister-sqlite-wasm|createSqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*
- * |persister-expo-sqlite|createExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|Yes|Yes*
- * |persister-indexed-db|createIndexedDbPersister|Browser IndexedDB|Yes|No
- * |persister-remote|createRemotePersister|Remote server|Yes|No
- * |persister-partykit-client|createPartyKitPersister|PartyKit with the persister-partykit-server module|Yes|No
- * |persister-cr-sqlite-wasm|createCrSqliteWasmPersister|SQLite CRDTs, via [cr-sqlite-wasm](https://github.com/vlcn-io/cr-sqlite)|Yes|No
- * |persister-electric-sql|createElectricSqlPersister|Electric SQL, via [electric-sql](https://github.com/electric-sql/electric)|Yes|No
- * |persister-libsql|createLibSqlPersister|LibSQL for Turso, via [libsql-client](https://github.com/tursodatabase/libsql-client-ts)|Yes|No
- * |persister-powersync|createPowerSyncPersister|PowerSync, via [powersync-sdk](https://github.com/powersync-ja/powersync-js)|Yes|No
- * |persister-yjs|createYjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|Yes|No
- * |persister-automerge|createSqliteWasmPersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|Yes|No|
+ * Many entry points are provided (in separately installed modules), each of
+ * which returns different types of Persister that can load and save a Store.
+ * Between them, these allow you to store your TinyBase data locally, remotely,
+ * to SQLite databases, and across synchronization boundaries with CRDT
+ * frameworks.
+ *
+ * |Persister|Storage|Store|MergeableStore
+ * |-|-|-|-|
+ * |SessionPersister|Browser session storage|Yes|Yes
+ * |LocalPersister|Browser local storage|Yes|Yes
+ * |FilePersister|Local file (where possible)|Yes|Yes
+ * |IndexedDbPersister|Browser IndexedDB|Yes|No
+ * |RemotePersister|Remote server|Yes|No
+ * |Sqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|Yes|Yes*
+ * |SqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*
+ * |ExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|Yes|Yes*
+ * |CrSqliteWasmPersister|SQLite CRDTs, via [cr-sqlite-wasm](https://github.com/vlcn-io/cr-sqlite)|Yes|No
+ * |ElectricSqlPersister|Electric SQL, via [electric-sql](https://github.com/electric-sql/electric)|Yes|No
+ * |LibSqlPersister|LibSQL for Turso, via [libsql-client](https://github.com/tursodatabase/libsql-client-ts)|Yes|No
+ * |PowerSyncPersister|PowerSync, via [powersync-sdk](https://github.com/powersync-ja/powersync-js)|Yes|No
+ * |YjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|Yes|No
+ * |SqliteWasmPersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|Yes|No
+ * |PartyKitPersister|[PartyKit](https://www.partykit.io/), via the persister-partykit-server module|Yes|No|
  *
  * (*) Note that SQLite-based Persisters can currently only persist
  * MergeableStore data when using the JSON-based DpcJson mode, and not in a
@@ -33,14 +34,13 @@
  * Since persistence requirements can be different for every app, the
  * createCustomPersister function in this module can also be used to easily
  * create a fully customized way to save and load Store data.
- * @see Persisting Data guide
- * @see Database Persistence guide
- * @see Synchronizing Data guide
+ * @see Persistence guides
  * @see Countries demo
  * @see Todo App demos
  * @see Drawing demo
  * @packageDocumentation
  * @module persisters
+ * @since v1.0.0
  */
 
 import type {
@@ -73,15 +73,21 @@ import type {TableIdFromSchema} from '../../_internal/store/with-schemas/index.d
 export const enum Persists {
   /**
    * Indicates that only a regular Store can be supported by a Persister.
+   * @category Enum
+   * @since v5.0.0
    */
   StoreOnly = 1,
   /**
    * Indicates that only a MergeableStore can be supported by a Persister.
+   * @category Enum
+   * @since v5.0.0
    */
   MergeableStoreOnly = 2,
   /**
    * Indicates that either a regular Store or a MergeableStore can be supported
    * by a Persister.
+   * @category Enum
+   * @since v5.0.0
    */
   StoreOrMergeableStore = 3,
 }
@@ -229,14 +235,19 @@ export type PersisterListener<
  *
  * A PersisterStats object is returned from the getStats method.
  * @category Development
+ * @since v1.0.0
  */
 export type PersisterStats = {
   /**
    * The number of times data has been loaded.
+   * @category Stat
+   * @since v1.0.0
    */
   loads: number;
   /**
    * The number of times data has been saved.
+   * @category Stat
+   * @since v1.0.0
    */
   saves: number;
 };
@@ -356,27 +367,37 @@ export type DpcJson = {
    * The mode to be used for persisting the Store to the database, in this case
    * JSON serialization. See the DpcTabular type for the alternative tabular
    * mapping mode.
+   * @category Configuration
+   * @since v4.0.0
    */
   mode: 'json';
   /**
    * An optional string which indicates the name of a table in the database
    * which will be used to serialize the Store content into. It defaults to
    * `tinybase`.
+   * @category Configuration
+   * @since v4.0.0
    */
   storeTableName?: string;
   /**
    * The optional name of the column in the database table that will be used as
    * the Id for the Store, defaulting to '_id', since v5.0.
+   * @category Configuration
+   * @since v4.0.0
    */
   storeIdColumnName?: string;
   /**
    * The optional name of the column in the database table that will be used for
    * the JSON of the Store, defaulting to 'store', since v5.0.
+   * @category Configuration
+   * @since v4.0.0
    */
   storeColumnName?: string;
   /**
    * How often the Persister should poll the database for any changes made to it
    * by other clients, defaulting to 1 second.
+   * @category Configuration
+   * @since v4.0.0
    */
   autoLoadIntervalSeconds?: number;
 };
@@ -452,30 +473,42 @@ export type DpcTabular<Schema extends OptionalTablesSchema> = {
    * The mode to be used for persisting the Store to the database, in this case
    * tabular mapping. See the DpcJson type for the alternative JSON
    * serialization mode.
+   * @category Configuration
+   * @since v4.0.0
    */
   mode: 'tabular';
   /**
    * The settings for how the Store Tables are mapped to and from the database.
+   * @category Configuration
+   * @since v4.0.0
    */
   tables?: {
     /**
      * The settings for how the database tables are mapped into the Store Tables
      * when loading.
+     * @category Configuration
+     * @since v4.0.0
      */
     load?: DpcTabularLoad<Schema>;
     /**
      * The settings for how the Store Tables are mapped out to the database
      * tables when saving.
+     * @category Configuration
+     * @since v4.0.0
      */
     save?: DpcTabularSave<Schema>;
   };
   /**
    * The settings for how the Store Values are mapped to and from the database.
+   * @category Configuration
+   * @since v4.0.0
    */
   values?: DpcTabularValues;
   /**
    * How often the Persister should poll the database for any changes made to it
    * by other clients, defaulting to 1 second.
+   * @category Configuration
+   * @since v4.0.0
    */
   autoLoadIntervalSeconds?: number;
 };
@@ -562,11 +595,15 @@ export type DpcTabularLoad<Schema extends OptionalTablesSchema> = {
         /**
          * The Id of the Store Table into which data from this database table
          * should be loaded.
+         * @category Configuration
+         * @since v4.0.0
          */
         tableId: TableIdFromSchema<Schema>;
         /**
          * The optional name of the column in the database table that will be
          * used as the Row Ids in the Store Table, defaulting to '_id'.
+         * @category Configuration
+         * @since v4.0.0
          */
         rowIdColumnName?: string;
       }
@@ -671,21 +708,29 @@ export type DpcTabularSave<Schema extends OptionalTablesSchema> = {
         /**
          * The name of the database table out to which the Store Table should be
          * saved.
+         * @category Configuration
+         * @since v4.0.0
          */
         tableName: string;
         /**
          * The optional name of the column in the database table that will be
          * used to save the Row Ids from the Store Table, defaulting to '_id'.
+         * @category Configuration
+         * @since v4.0.0
          */
         rowIdColumnName?: string;
         /**
          * Whether columns in the database table will be removed if they are
          * empty in the Store Table, defaulting to false.
+         * @category Configuration
+         * @since v4.0.0
          */
         deleteEmptyColumns?: boolean;
         /**
          * Whether tables in the database will be removed if the Store Table is
          * empty, defaulting to false.
+         * @category Configuration
+         * @since v4.0.0
          */
         deleteEmptyTable?: boolean;
       }
@@ -724,15 +769,21 @@ export type DpcTabularSave<Schema extends OptionalTablesSchema> = {
 export type DpcTabularValues = {
   /**
    * Whether Store Values will be loaded from a database table.
+   * @category Configuration
+   * @since v4.0.0
    */
   load?: boolean;
   /**
    * Whether Store Values will be saved to a database table.
+   * @category Configuration
+   * @since v4.0.0
    */
   save?: boolean;
   /**
    * The optional name of the database table from and to which the Store Values
    * should be loaded or saved, defaulting to `tinybase_values`.
+   * @category Configuration
+   * @since v4.0.0
    */
   tableName?: string;
 };
@@ -851,6 +902,7 @@ export type DpcTabularValues = {
  * sessionStorage.clear();
  * ```
  * @category Persister
+ * @since v1.0.0
  */
 export interface Persister<
   in out Schemas extends OptionalSchemas,
@@ -924,6 +976,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Load
+   * @since v1.0.0
    */
   load(initialContent?: Content<Schemas, true>): Promise<this>;
 
@@ -986,6 +1039,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Load
+   * @since v1.0.0
    */
   startAutoLoad(initialContent?: Content<Schemas, true>): Promise<this>;
 
@@ -1033,6 +1087,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Load
+   * @since v1.0.0
    */
   stopAutoLoad(): this;
 
@@ -1094,6 +1149,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Save
+   * @since v1.0.0
    */
   save(): Promise<this>;
 
@@ -1134,6 +1190,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Save
+   * @since v1.0.0
    */
   startAutoSave(): Promise<this>;
 
@@ -1174,6 +1231,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Save
+   * @since v1.0.0
    */
   stopAutoSave(): this;
 
@@ -1286,6 +1344,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): PersistedStore<Schemas, Persist>;
 
@@ -1319,6 +1378,7 @@ export interface Persister<
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): this;
 
@@ -1364,6 +1424,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getStats(): PersisterStats;
 }
@@ -1543,6 +1604,7 @@ export interface Persister<
  * mergeableStorePersister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createCustomPersister<
   Schemas extends OptionalSchemas,

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

@@ -3,28 +3,29 @@
  * saving and loading Store and MergeableStore data, to and from different
  * destinations, or underlying storage types.
  *
- * Several entry points are provided (in separately installed modules), each of
- * which returns a new Persister object that can load and save a Store. Between
- * them, these allow you to store your TinyBase data locally, remotely, to
- * SQLite databases, and across synchronization boundaries with CRDT frameworks.
- *
- * |Module|Function|Storage|Store|MergeableStore
- * |-|-|-|-|-|
- * |persister-browser|createSessionPersister|Browser session storage|Yes|Yes
- * |persister-browser|createLocalPersister|Browser local storage|Yes|Yes
- * |persister-file|createFilePersister|Local file (where possible)|Yes|Yes
- * |persister-sqlite3|createSqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|Yes|Yes*
- * |persister-sqlite-wasm|createSqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*
- * |persister-expo-sqlite|createExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|Yes|Yes*
- * |persister-indexed-db|createIndexedDbPersister|Browser IndexedDB|Yes|No
- * |persister-remote|createRemotePersister|Remote server|Yes|No
- * |persister-partykit-client|createPartyKitPersister|PartyKit with the persister-partykit-server module|Yes|No
- * |persister-cr-sqlite-wasm|createCrSqliteWasmPersister|SQLite CRDTs, via [cr-sqlite-wasm](https://github.com/vlcn-io/cr-sqlite)|Yes|No
- * |persister-electric-sql|createElectricSqlPersister|Electric SQL, via [electric-sql](https://github.com/electric-sql/electric)|Yes|No
- * |persister-libsql|createLibSqlPersister|LibSQL for Turso, via [libsql-client](https://github.com/tursodatabase/libsql-client-ts)|Yes|No
- * |persister-powersync|createPowerSyncPersister|PowerSync, via [powersync-sdk](https://github.com/powersync-ja/powersync-js)|Yes|No
- * |persister-yjs|createYjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|Yes|No
- * |persister-automerge|createSqliteWasmPersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|Yes|No|
+ * Many entry points are provided (in separately installed modules), each of
+ * which returns different types of Persister that can load and save a Store.
+ * Between them, these allow you to store your TinyBase data locally, remotely,
+ * to SQLite databases, and across synchronization boundaries with CRDT
+ * frameworks.
+ *
+ * |Persister|Storage|Store|MergeableStore
+ * |-|-|-|-|
+ * |SessionPersister|Browser session storage|Yes|Yes
+ * |LocalPersister|Browser local storage|Yes|Yes
+ * |FilePersister|Local file (where possible)|Yes|Yes
+ * |IndexedDbPersister|Browser IndexedDB|Yes|No
+ * |RemotePersister|Remote server|Yes|No
+ * |Sqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|Yes|Yes*
+ * |SqliteWasmPersister|SQLite in a browser, via [sqlite-wasm](https://github.com/tomayac/sqlite-wasm)|Yes|Yes*
+ * |ExpoSqlitePersister|SQLite in React Native, via [expo-sqlite](https://github.com/expo/expo/tree/main/packages/expo-sqlite)|Yes|Yes*
+ * |CrSqliteWasmPersister|SQLite CRDTs, via [cr-sqlite-wasm](https://github.com/vlcn-io/cr-sqlite)|Yes|No
+ * |ElectricSqlPersister|Electric SQL, via [electric-sql](https://github.com/electric-sql/electric)|Yes|No
+ * |LibSqlPersister|LibSQL for Turso, via [libsql-client](https://github.com/tursodatabase/libsql-client-ts)|Yes|No
+ * |PowerSyncPersister|PowerSync, via [powersync-sdk](https://github.com/powersync-ja/powersync-js)|Yes|No
+ * |YjsPersister|Yjs CRDTs, via [yjs](https://github.com/yjs/yjs)|Yes|No
+ * |SqliteWasmPersister|Automerge CRDTs, via [automerge-repo](https://github.com/automerge/automerge-repo)|Yes|No
+ * |PartyKitPersister|[PartyKit](https://www.partykit.io/), via the persister-partykit-server module|Yes|No|
  *
  * (*) Note that SQLite-based Persisters can currently only persist
  * MergeableStore data when using the JSON-based DpcJson mode, and not in a
@@ -33,14 +34,13 @@
  * Since persistence requirements can be different for every app, the
  * createCustomPersister function in this module can also be used to easily
  * create a fully customized way to save and load Store data.
- * @see Persisting Data guide
- * @see Database Persistence guide
- * @see Synchronizing Data guide
+ * @see Persistence guides
  * @see Countries demo
  * @see Todo App demos
  * @see Drawing demo
  * @packageDocumentation
  * @module persisters
+ * @since v1.0.0
  */
 
 import type {
@@ -73,15 +73,21 @@ import type {TableIdFromSchema} from '../../_internal/store/with-schemas/index.d
 export const enum Persists {
   /**
    * Indicates that only a regular Store can be supported by a Persister.
+   * @category Enum
+   * @since v5.0.0
    */
   StoreOnly = 1,
   /**
    * Indicates that only a MergeableStore can be supported by a Persister.
+   * @category Enum
+   * @since v5.0.0
    */
   MergeableStoreOnly = 2,
   /**
    * Indicates that either a regular Store or a MergeableStore can be supported
    * by a Persister.
+   * @category Enum
+   * @since v5.0.0
    */
   StoreOrMergeableStore = 3,
 }
@@ -229,14 +235,19 @@ export type PersisterListener<
  *
  * A PersisterStats object is returned from the getStats method.
  * @category Development
+ * @since v1.0.0
  */
 export type PersisterStats = {
   /**
    * The number of times data has been loaded.
+   * @category Stat
+   * @since v1.0.0
    */
   loads: number;
   /**
    * The number of times data has been saved.
+   * @category Stat
+   * @since v1.0.0
    */
   saves: number;
 };
@@ -356,27 +367,37 @@ export type DpcJson = {
    * The mode to be used for persisting the Store to the database, in this case
    * JSON serialization. See the DpcTabular type for the alternative tabular
    * mapping mode.
+   * @category Configuration
+   * @since v4.0.0
    */
   mode: 'json';
   /**
    * An optional string which indicates the name of a table in the database
    * which will be used to serialize the Store content into. It defaults to
    * `tinybase`.
+   * @category Configuration
+   * @since v4.0.0
    */
   storeTableName?: string;
   /**
    * The optional name of the column in the database table that will be used as
    * the Id for the Store, defaulting to '_id', since v5.0.
+   * @category Configuration
+   * @since v4.0.0
    */
   storeIdColumnName?: string;
   /**
    * The optional name of the column in the database table that will be used for
    * the JSON of the Store, defaulting to 'store', since v5.0.
+   * @category Configuration
+   * @since v4.0.0
    */
   storeColumnName?: string;
   /**
    * How often the Persister should poll the database for any changes made to it
    * by other clients, defaulting to 1 second.
+   * @category Configuration
+   * @since v4.0.0
    */
   autoLoadIntervalSeconds?: number;
 };
@@ -452,30 +473,42 @@ export type DpcTabular<Schema extends OptionalTablesSchema> = {
    * The mode to be used for persisting the Store to the database, in this case
    * tabular mapping. See the DpcJson type for the alternative JSON
    * serialization mode.
+   * @category Configuration
+   * @since v4.0.0
    */
   mode: 'tabular';
   /**
    * The settings for how the Store Tables are mapped to and from the database.
+   * @category Configuration
+   * @since v4.0.0
    */
   tables?: {
     /**
      * The settings for how the database tables are mapped into the Store Tables
      * when loading.
+     * @category Configuration
+     * @since v4.0.0
      */
     load?: DpcTabularLoad<Schema>;
     /**
      * The settings for how the Store Tables are mapped out to the database
      * tables when saving.
+     * @category Configuration
+     * @since v4.0.0
      */
     save?: DpcTabularSave<Schema>;
   };
   /**
    * The settings for how the Store Values are mapped to and from the database.
+   * @category Configuration
+   * @since v4.0.0
    */
   values?: DpcTabularValues;
   /**
    * How often the Persister should poll the database for any changes made to it
    * by other clients, defaulting to 1 second.
+   * @category Configuration
+   * @since v4.0.0
    */
   autoLoadIntervalSeconds?: number;
 };
@@ -562,11 +595,15 @@ export type DpcTabularLoad<Schema extends OptionalTablesSchema> = {
         /**
          * The Id of the Store Table into which data from this database table
          * should be loaded.
+         * @category Configuration
+         * @since v4.0.0
          */
         tableId: TableIdFromSchema<Schema>;
         /**
          * The optional name of the column in the database table that will be
          * used as the Row Ids in the Store Table, defaulting to '_id'.
+         * @category Configuration
+         * @since v4.0.0
          */
         rowIdColumnName?: string;
       }
@@ -671,21 +708,29 @@ export type DpcTabularSave<Schema extends OptionalTablesSchema> = {
         /**
          * The name of the database table out to which the Store Table should be
          * saved.
+         * @category Configuration
+         * @since v4.0.0
          */
         tableName: string;
         /**
          * The optional name of the column in the database table that will be
          * used to save the Row Ids from the Store Table, defaulting to '_id'.
+         * @category Configuration
+         * @since v4.0.0
          */
         rowIdColumnName?: string;
         /**
          * Whether columns in the database table will be removed if they are
          * empty in the Store Table, defaulting to false.
+         * @category Configuration
+         * @since v4.0.0
          */
         deleteEmptyColumns?: boolean;
         /**
          * Whether tables in the database will be removed if the Store Table is
          * empty, defaulting to false.
+         * @category Configuration
+         * @since v4.0.0
          */
         deleteEmptyTable?: boolean;
       }
@@ -724,15 +769,21 @@ export type DpcTabularSave<Schema extends OptionalTablesSchema> = {
 export type DpcTabularValues = {
   /**
    * Whether Store Values will be loaded from a database table.
+   * @category Configuration
+   * @since v4.0.0
    */
   load?: boolean;
   /**
    * Whether Store Values will be saved to a database table.
+   * @category Configuration
+   * @since v4.0.0
    */
   save?: boolean;
   /**
    * The optional name of the database table from and to which the Store Values
    * should be loaded or saved, defaulting to `tinybase_values`.
+   * @category Configuration
+   * @since v4.0.0
    */
   tableName?: string;
 };
@@ -851,6 +902,7 @@ export type DpcTabularValues = {
  * sessionStorage.clear();
  * ```
  * @category Persister
+ * @since v1.0.0
  */
 export interface Persister<
   in out Schemas extends OptionalSchemas,
@@ -924,6 +976,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Load
+   * @since v1.0.0
    */
   load(initialContent?: Content<Schemas, true>): Promise<this>;
 
@@ -986,6 +1039,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Load
+   * @since v1.0.0
    */
   startAutoLoad(initialContent?: Content<Schemas, true>): Promise<this>;
 
@@ -1033,6 +1087,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Load
+   * @since v1.0.0
    */
   stopAutoLoad(): this;
 
@@ -1094,6 +1149,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Save
+   * @since v1.0.0
    */
   save(): Promise<this>;
 
@@ -1134,6 +1190,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Save
+   * @since v1.0.0
    */
   startAutoSave(): Promise<this>;
 
@@ -1174,6 +1231,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Save
+   * @since v1.0.0
    */
   stopAutoSave(): this;
 
@@ -1286,6 +1344,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): PersistedStore<Schemas, Persist>;
 
@@ -1319,6 +1378,7 @@ export interface Persister<
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): this;
 
@@ -1364,6 +1424,7 @@ export interface Persister<
    * sessionStorage.clear();
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getStats(): PersisterStats;
 }
@@ -1543,6 +1604,7 @@ export interface Persister<
  * mergeableStorePersister.destroy();
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createCustomPersister<
   Schemas extends OptionalSchemas,