tinybase 5.0.0-beta.25 → 5.0.0-beta.26

package/@types/synchronizers/synchronizer-ws-client/index.d.ts

@@ -16,7 +16,7 @@ import type {WebSocket as WsWebSocket} from 'ws';
 export type WebSocketTypes = WebSocket | WsWebSocket;
 
 /**
- * The WsSynchronizer interface
+ * The WsSynchronizer interface.
  * @category Synchronizer
  */
 export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
@@ -25,7 +25,7 @@ export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
 }
 
 /**
- * The createWsSynchronizer function
+ * The createWsSynchronizer function.
  * @category Creation
  */
 export function createWsSynchronizer<WebSocketType extends WebSocketTypes>(

package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.cts

@@ -17,7 +17,7 @@ import type {WebSocket as WsWebSocket} from 'ws';
 export type WebSocketTypes = WebSocket | WsWebSocket;
 
 /**
- * The WsSynchronizer interface
+ * The WsSynchronizer interface.
  * @category Synchronizer
  */
 export interface WsSynchronizer<
@@ -28,7 +28,7 @@ export interface WsSynchronizer<
 }
 
 /**
- * The createWsSynchronizer function
+ * The createWsSynchronizer function.
  * @category Creation
  */
 export function createWsSynchronizer<

package/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.ts

@@ -17,7 +17,7 @@ import type {WebSocket as WsWebSocket} from 'ws';
 export type WebSocketTypes = WebSocket | WsWebSocket;
 
 /**
- * The WsSynchronizer interface
+ * The WsSynchronizer interface.
  * @category Synchronizer
  */
 export interface WsSynchronizer<
@@ -28,7 +28,7 @@ export interface WsSynchronizer<
 }
 
 /**
- * The createWsSynchronizer function
+ * The createWsSynchronizer function.
  * @category Creation
  */
 export function createWsSynchronizer<

package/@types/synchronizers/synchronizer-ws-server/index.d.cts

@@ -13,7 +13,7 @@ import type {GetIdChanges} from '../../store/index.d.cts';
 import type {WebSocketServer} from 'ws';
 
 /**
- * The PathIdsListener type
+ * The PathIdsListener type.
  */
 export type PathIdsListener<> = (
   wsServer: WsServer,
@@ -21,7 +21,7 @@ export type PathIdsListener<> = (
 ) => void;
 
 /**
- * The ClientIdsListener type
+ * The ClientIdsListener type.
  */
 export type ClientIdsListener<> = (
   wsServer: WsServer,
@@ -30,7 +30,7 @@ export type ClientIdsListener<> = (
 ) => void;
 
 /**
- * The WsServerStats type
+ * The WsServerStats type.
  */
 export type WsServerStats = {
   paths: number;
@@ -38,7 +38,7 @@ export type WsServerStats = {
 };
 
 /**
- * The WsServer interface
+ * The WsServer interface.
  */
 export interface WsServer {
   getWebSocketServer: () => WebSocketServer;
@@ -52,7 +52,7 @@ export interface WsServer {
 }
 
 /**
- * The createWsServer function
+ * The createWsServer function.
  * @category Creation
  */
 export function createWsServer(WebSocketServer: WebSocketServer): WsServer;

package/@types/synchronizers/synchronizer-ws-server/index.d.ts

@@ -13,7 +13,7 @@ import type {GetIdChanges} from '../../store/index.d.ts';
 import type {WebSocketServer} from 'ws';
 
 /**
- * The PathIdsListener type
+ * The PathIdsListener type.
  */
 export type PathIdsListener<> = (
   wsServer: WsServer,
@@ -21,7 +21,7 @@ export type PathIdsListener<> = (
 ) => void;
 
 /**
- * The ClientIdsListener type
+ * The ClientIdsListener type.
  */
 export type ClientIdsListener<> = (
   wsServer: WsServer,
@@ -30,7 +30,7 @@ export type ClientIdsListener<> = (
 ) => void;
 
 /**
- * The WsServerStats type
+ * The WsServerStats type.
  */
 export type WsServerStats = {
   paths: number;
@@ -38,7 +38,7 @@ export type WsServerStats = {
 };
 
 /**
- * The WsServer interface
+ * The WsServer interface.
  */
 export interface WsServer {
   getWebSocketServer: () => WebSocketServer;
@@ -52,7 +52,7 @@ export interface WsServer {
 }
 
 /**
- * The createWsServer function
+ * The createWsServer function.
  * @category Creation
  */
 export function createWsServer(WebSocketServer: WebSocketServer): WsServer;

package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.cts

@@ -13,7 +13,7 @@ import type {GetIdChanges} from '../../../store/with-schemas/index.d.cts';
 import type {WebSocketServer} from 'ws';
 
 /**
- * The PathIdsListener type
+ * The PathIdsListener type.
  */
 export type PathIdsListener<> = (
   wsServer: WsServer,
@@ -21,7 +21,7 @@ export type PathIdsListener<> = (
 ) => void;
 
 /**
- * The ClientIdsListener type
+ * The ClientIdsListener type.
  */
 export type ClientIdsListener<> = (
   wsServer: WsServer,
@@ -30,7 +30,7 @@ export type ClientIdsListener<> = (
 ) => void;
 
 /**
- * The WsServerStats type
+ * The WsServerStats type.
  */
 export type WsServerStats = {
   paths: number;
@@ -38,7 +38,7 @@ export type WsServerStats = {
 };
 
 /**
- * The WsServer interface
+ * The WsServer interface.
  */
 export interface WsServer {
   getWebSocketServer: () => WebSocketServer;
@@ -52,7 +52,7 @@ export interface WsServer {
 }
 
 /**
- * The createWsServer function
+ * The createWsServer function.
  * @category Creation
  */
 export function createWsServer(WebSocketServer: WebSocketServer): WsServer;

package/@types/synchronizers/synchronizer-ws-server/with-schemas/index.d.ts

@@ -13,7 +13,7 @@ import type {GetIdChanges} from '../../../store/with-schemas/index.d.ts';
 import type {WebSocketServer} from 'ws';
 
 /**
- * The PathIdsListener type
+ * The PathIdsListener type.
  */
 export type PathIdsListener<> = (
   wsServer: WsServer,
@@ -21,7 +21,7 @@ export type PathIdsListener<> = (
 ) => void;
 
 /**
- * The ClientIdsListener type
+ * The ClientIdsListener type.
  */
 export type ClientIdsListener<> = (
   wsServer: WsServer,
@@ -30,7 +30,7 @@ export type ClientIdsListener<> = (
 ) => void;
 
 /**
- * The WsServerStats type
+ * The WsServerStats type.
  */
 export type WsServerStats = {
   paths: number;
@@ -38,7 +38,7 @@ export type WsServerStats = {
 };
 
 /**
- * The WsServer interface
+ * The WsServer interface.
  */
 export interface WsServer {
   getWebSocketServer: () => WebSocketServer;
@@ -52,7 +52,7 @@ export interface WsServer {
 }
 
 /**
- * The createWsServer function
+ * The createWsServer function.
  * @category Creation
  */
 export function createWsServer(WebSocketServer: WebSocketServer): WsServer;

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

@@ -12,17 +12,20 @@ import type {
   OptionalSchemas,
 } from '../../store/with-schemas/index.d.cts';
 import type {Id, IdOrNull} from '../../common/with-schemas/index.d.cts';
+import type {
+  Persister,
+  Persists,
+} from '../../persisters/with-schemas/index.d.cts';
 import type {MergeableStore} from '../../mergeable-store/with-schemas/index.d.cts';
-import type {Persister} from '../../persisters/with-schemas/index.d.cts';
 
 /**
- * The MessageType type
+ * The MessageType type.
  * @category Synchronization
  */
 export type MessageType = number;
 
 /**
- * The Receive type
+ * The Receive type.
  * @category Synchronization
  */
 export type Receive = (
@@ -33,7 +36,7 @@ export type Receive = (
 ) => void;
 
 /**
- * The Send type
+ * The Send type.
  * @category Synchronization
  */
 export type Send = (
@@ -44,7 +47,7 @@ export type Send = (
 ) => void;
 
 /**
- * The SynchronizerStats type
+ * The SynchronizerStats type.
  * @category Development
  */
 export type SynchronizerStats = {
@@ -64,19 +67,19 @@ export type SynchronizerStats = {
  * @since v5.0.0
  */
 export interface Synchronizer<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 2> {
+  extends Persister<Schemas, Persists.MergeableStoreOnly> {
   /**
-   * The startSync method
+   * The startSync method.
    * @category Synchronization
    */
   startSync(initialContent?: Content<Schemas, true>): Promise<this>;
   /**
-   * The stopSync method
+   * The stopSync method.
    * @category Synchronization
    */
   stopSync(): this;
   /**
-   * The getSynchronizerStats method
+   * The getSynchronizerStats method.
    * @category Synchronization
    */
   getSynchronizerStats(): SynchronizerStats;

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

@@ -12,17 +12,20 @@ import type {
   OptionalSchemas,
 } from '../../store/with-schemas/index.d.ts';
 import type {Id, IdOrNull} from '../../common/with-schemas/index.d.ts';
+import type {
+  Persister,
+  Persists,
+} from '../../persisters/with-schemas/index.d.ts';
 import type {MergeableStore} from '../../mergeable-store/with-schemas/index.d.ts';
-import type {Persister} from '../../persisters/with-schemas/index.d.ts';
 
 /**
- * The MessageType type
+ * The MessageType type.
  * @category Synchronization
  */
 export type MessageType = number;
 
 /**
- * The Receive type
+ * The Receive type.
  * @category Synchronization
  */
 export type Receive = (
@@ -33,7 +36,7 @@ export type Receive = (
 ) => void;
 
 /**
- * The Send type
+ * The Send type.
  * @category Synchronization
  */
 export type Send = (
@@ -44,7 +47,7 @@ export type Send = (
 ) => void;
 
 /**
- * The SynchronizerStats type
+ * The SynchronizerStats type.
  * @category Development
  */
 export type SynchronizerStats = {
@@ -64,19 +67,19 @@ export type SynchronizerStats = {
  * @since v5.0.0
  */
 export interface Synchronizer<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, 2> {
+  extends Persister<Schemas, Persists.MergeableStoreOnly> {
   /**
-   * The startSync method
+   * The startSync method.
    * @category Synchronization
    */
   startSync(initialContent?: Content<Schemas, true>): Promise<this>;
   /**
-   * The stopSync method
+   * The stopSync method.
    * @category Synchronization
    */
   stopSync(): this;
   /**
-   * The getSynchronizerStats method
+   * The getSynchronizerStats method.
    * @category Synchronization
    */
   getSynchronizerStats(): SynchronizerStats;

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

@@ -117,6 +117,7 @@ export interface Tools {
    * @returns A StoreStats object containing statistics about the Store.
    * @example
    * This example creates a Tools object and gets basic statistics about it.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -137,6 +138,7 @@ export interface Tools {
    * ```
    * @example
    * This example creates a Tools object and gets detailed statistics about it.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -189,6 +191,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and gets the schema of a Store that
    * already has a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -209,6 +212,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and infers the schema of a Store that
    * doesn't already have a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -253,6 +257,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and gets the schema of a Store that
    * already has a ValuesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -269,6 +274,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and infers the schema of a Store that
    * doesn't already have a ValuesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -296,12 +302,12 @@ export interface Tools {
    *
    * The method takes a single argument which represents the name you want the
    * generated store object to have in code. You are expected to save the four
-   * files yourself, as, respectively:
+   * files yourself, as the following:
    *
-   * - `[storeName].d.cts`
-   * - `[storeName].ts`
-   * - `[storeName]-ui-react.d.cts`
-   * - `[storeName]-ui-react.tsx`
+   * - `[storeName].d.cts` as the main definition,
+   * - `[storeName].ts` as the main library,
+   * - `[storeName]-ui-react.d.cts` as the ui-react module definition,
+   * - `[storeName]-ui-react.tsx` as the ui-react module library.
    *
    * Also you should save these alongside each other so that the `.ts(x)` files
    * can import types from the `.d.cts` files.
@@ -348,6 +354,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * already has a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -371,6 +378,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * doesn't already have a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -410,12 +418,12 @@ export interface Tools {
    *
    * The method takes a single argument which represents the name you want the
    * generated store object to have in code. You are expected to save the four
-   * files yourself, as, respectively:
+   * files yourself, as the following:
    *
-   * - `[storeName].d.cts`
-   * - `[storeName].ts`
-   * - `[storeName]-ui-react.d.cts`
-   * - `[storeName]-ui-react.tsx`
+   * - `[storeName].d.cts` as the main definition,
+   * - `[storeName].ts` as the main library,
+   * - `[storeName]-ui-react.d.cts` as the ui-react module definition,
+   * - `[storeName]-ui-react.tsx` as the ui-react module library.
    *
    * Also you should save these alongside each other so that the `.ts(x)` files
    * can import types from the `.d.cts` files.
@@ -429,6 +437,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * already has a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -452,6 +461,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * doesn't already have a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';

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

@@ -117,6 +117,7 @@ export interface Tools {
    * @returns A StoreStats object containing statistics about the Store.
    * @example
    * This example creates a Tools object and gets basic statistics about it.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -137,6 +138,7 @@ export interface Tools {
    * ```
    * @example
    * This example creates a Tools object and gets detailed statistics about it.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -189,6 +191,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and gets the schema of a Store that
    * already has a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -209,6 +212,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and infers the schema of a Store that
    * doesn't already have a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -253,6 +257,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and gets the schema of a Store that
    * already has a ValuesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -269,6 +274,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and infers the schema of a Store that
    * doesn't already have a ValuesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -296,12 +302,12 @@ export interface Tools {
    *
    * The method takes a single argument which represents the name you want the
    * generated store object to have in code. You are expected to save the four
-   * files yourself, as, respectively:
+   * files yourself, as the following:
    *
-   * - `[storeName].d.ts`
-   * - `[storeName].ts`
-   * - `[storeName]-ui-react.d.ts`
-   * - `[storeName]-ui-react.tsx`
+   * - `[storeName].d.ts` as the main definition,
+   * - `[storeName].ts` as the main library,
+   * - `[storeName]-ui-react.d.ts` as the ui-react module definition,
+   * - `[storeName]-ui-react.tsx` as the ui-react module library.
    *
    * Also you should save these alongside each other so that the `.ts(x)` files
    * can import types from the `.d.ts` files.
@@ -348,6 +354,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * already has a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -371,6 +378,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * doesn't already have a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -410,12 +418,12 @@ export interface Tools {
    *
    * The method takes a single argument which represents the name you want the
    * generated store object to have in code. You are expected to save the four
-   * files yourself, as, respectively:
+   * files yourself, as the following:
    *
-   * - `[storeName].d.ts`
-   * - `[storeName].ts`
-   * - `[storeName]-ui-react.d.ts`
-   * - `[storeName]-ui-react.tsx`
+   * - `[storeName].d.ts` as the main definition,
+   * - `[storeName].ts` as the main library,
+   * - `[storeName]-ui-react.d.ts` as the ui-react module definition,
+   * - `[storeName]-ui-react.tsx` as the ui-react module library.
    *
    * Also you should save these alongside each other so that the `.ts(x)` files
    * can import types from the `.d.ts` files.
@@ -429,6 +437,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * already has a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -452,6 +461,7 @@ export interface Tools {
    * @example
    * This example creates a Tools object and generates code for a Store that
    * doesn't already have a TablesSchema.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';