tinybase 5.4.0-beta.3 → 5.4.0-beta.4

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

@@ -71,6 +71,7 @@ export type TinyBasePartyKitServerConfig = {
    * @since v4.3.0
    */
   storePath?: string;
+
   /**
    * The prefix at the beginning of the web socket messages between the client
    * and the server when synchronizing the Store. Use this to make sure they do
@@ -81,6 +82,7 @@ export type TinyBasePartyKitServerConfig = {
    * @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
@@ -89,6 +91,7 @@ export type TinyBasePartyKitServerConfig = {
    * @since v4.3.0
    */
   storagePrefix?: string;
+
   /**
    * An object containing the extra HTTP(S) headers returned to the client from
    * this server. This defaults to the following three headers to allow CORS.
@@ -160,10 +163,12 @@ export type TinyBasePartyKitServerConfig = {
 export class TinyBasePartyKitServer implements Server {
   /**
    * The constructor is used to create the server.
+   * @returns A new instance of the TinyBasePartyKitServer.
    * @category Creation
    * @since v4.3.9
    */
   constructor(party: Party);
+
   /**
    * The config property is used to optionally configure the server, using an
    * object of the TinyBasePartyKitServerConfig type.
@@ -173,6 +178,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.9
    */
   readonly config: TinyBasePartyKitServerConfig;
+
   /**
    * The onRequest method is called when a HTTP request is made to the party
    * URL.
@@ -199,6 +205,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onRequest(request: Request): Promise<Response>;
+
   /**
    * The onMessage method is called when the server receives a message from a
    * client.
@@ -225,6 +232,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onMessage(message: string, connection: Connection): Promise<void>;
+
   /**
    * The canSetTable method lets you allow or disallow any changes to a Table
    * stored on the server, as sent from a client.
@@ -273,6 +281,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelTable method lets you allow or disallow deletions of a Table
    * stored on the server, as sent from a client.
@@ -307,6 +316,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelTable(tableId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetRow method lets you allow or disallow any changes to a Row stored
    * on the server, as sent from a client.
@@ -352,6 +362,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelRow method lets you allow or disallow deletions of a Row stored
    * on the server, as sent from a client.
@@ -387,6 +398,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelRow(tableId: Id, rowId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetCell method lets you allow or disallow any changes to a Cell
    * stored on the server, as sent from a client.
@@ -452,6 +464,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldCell: CellOrUndefined<NoTablesSchema, Id, Id>,
   ): Promise<boolean>;
+
   /**
    * The canDelCell method lets you allow or disallow deletions of a Cell stored
    * on the server, as sent from a client.
@@ -492,6 +505,7 @@ export class TinyBasePartyKitServer implements Server {
     cellId: Id,
     connection: Connection,
   ): Promise<boolean>;
+
   /**
    * The canSetValue method lets you allow or disallow any changes to a Value
    * stored on the server, as sent from a client.
@@ -553,6 +567,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldValue: ValueOrUndefined<NoValuesSchema, Id>,
   ): Promise<boolean>;
+
   /**
    * The canDelValue method lets you allow or disallow deletions of a Value
    * stored on the server, as sent from a client.

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

@@ -71,6 +71,7 @@ export type TinyBasePartyKitServerConfig = {
    * @since v4.3.0
    */
   storePath?: string;
+
   /**
    * The prefix at the beginning of the web socket messages between the client
    * and the server when synchronizing the Store. Use this to make sure they do
@@ -81,6 +82,7 @@ export type TinyBasePartyKitServerConfig = {
    * @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
@@ -89,6 +91,7 @@ export type TinyBasePartyKitServerConfig = {
    * @since v4.3.0
    */
   storagePrefix?: string;
+
   /**
    * An object containing the extra HTTP(S) headers returned to the client from
    * this server. This defaults to the following three headers to allow CORS.
@@ -160,10 +163,12 @@ export type TinyBasePartyKitServerConfig = {
 export class TinyBasePartyKitServer implements Server {
   /**
    * The constructor is used to create the server.
+   * @returns A new instance of the TinyBasePartyKitServer.
    * @category Creation
    * @since v4.3.9
    */
   constructor(party: Party);
+
   /**
    * The config property is used to optionally configure the server, using an
    * object of the TinyBasePartyKitServerConfig type.
@@ -173,6 +178,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.9
    */
   readonly config: TinyBasePartyKitServerConfig;
+
   /**
    * The onRequest method is called when a HTTP request is made to the party
    * URL.
@@ -199,6 +205,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onRequest(request: Request): Promise<Response>;
+
   /**
    * The onMessage method is called when the server receives a message from a
    * client.
@@ -225,6 +232,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onMessage(message: string, connection: Connection): Promise<void>;
+
   /**
    * The canSetTable method lets you allow or disallow any changes to a Table
    * stored on the server, as sent from a client.
@@ -273,6 +281,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelTable method lets you allow or disallow deletions of a Table
    * stored on the server, as sent from a client.
@@ -307,6 +316,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelTable(tableId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetRow method lets you allow or disallow any changes to a Row stored
    * on the server, as sent from a client.
@@ -352,6 +362,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelRow method lets you allow or disallow deletions of a Row stored
    * on the server, as sent from a client.
@@ -387,6 +398,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelRow(tableId: Id, rowId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetCell method lets you allow or disallow any changes to a Cell
    * stored on the server, as sent from a client.
@@ -452,6 +464,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldCell: CellOrUndefined<NoTablesSchema, Id, Id>,
   ): Promise<boolean>;
+
   /**
    * The canDelCell method lets you allow or disallow deletions of a Cell stored
    * on the server, as sent from a client.
@@ -492,6 +505,7 @@ export class TinyBasePartyKitServer implements Server {
     cellId: Id,
     connection: Connection,
   ): Promise<boolean>;
+
   /**
    * The canSetValue method lets you allow or disallow any changes to a Value
    * stored on the server, as sent from a client.
@@ -553,6 +567,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldValue: ValueOrUndefined<NoValuesSchema, Id>,
   ): Promise<boolean>;
+
   /**
    * The canDelValue method lets you allow or disallow deletions of a Value
    * stored on the server, as sent from a client.

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

@@ -1561,6 +1561,7 @@ export interface Persister<
    * the underlying Store and storage are removed and it can be correctly
    * garbage collected. It is equivalent to running the stopAutoLoad method and
    * the stopAutoSave method in succession.
+   * @returns A reference to the Persister object.
    * @example
    * This example creates a Store, associates a Persister object with it (that
    * registers a TablesListener with the underlying Store), and then destroys it

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

@@ -1561,6 +1561,7 @@ export interface Persister<
    * the underlying Store and storage are removed and it can be correctly
    * garbage collected. It is equivalent to running the stopAutoLoad method and
    * the stopAutoSave method in succession.
+   * @returns A reference to the Persister object.
    * @example
    * This example creates a Store, associates a Persister object with it (that
    * registers a TablesListener with the underlying Store), and then destroys it

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

@@ -473,13 +473,14 @@ export type GetCell = (cellId: Id) => CellOrUndefined;
 
 /**
  * The IdAddedOrRemoved type describes a change made to an Id in either the
- * tabular of keyed-value part of the Store.
+ * tabular or keyed-value part of the Store (or in other TinyBase modules).
  *
  * This type is used in other types like ChangedTableIds, ChangedRowIds,
- * ChangedCellIds, and ChangedValueIds.
+ * ChangedCellIds, and ChangedValueIds, as well as in other events or listeners
+ * where a list of Ids has changed.
  *
- * It is a simple number: a 1 indicates that a given Id was added to the Store
- * during a transaction, and a -1 indicates that it was removed.
+ * It is a simple number: a 1 indicates that a given Id was added to a list of
+ * Ids, and a -1 indicates that it was removed.
  * @category Transaction
  * @since v4.0.0
  */
@@ -7518,13 +7519,14 @@ export interface Store {
   getListenerStats(): StoreListenerStats;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
   //
 }
 

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

@@ -473,13 +473,14 @@ export type GetCell = (cellId: Id) => CellOrUndefined;
 
 /**
  * The IdAddedOrRemoved type describes a change made to an Id in either the
- * tabular of keyed-value part of the Store.
+ * tabular or keyed-value part of the Store (or in other TinyBase modules).
  *
  * This type is used in other types like ChangedTableIds, ChangedRowIds,
- * ChangedCellIds, and ChangedValueIds.
+ * ChangedCellIds, and ChangedValueIds, as well as in other events or listeners
+ * where a list of Ids has changed.
  *
- * It is a simple number: a 1 indicates that a given Id was added to the Store
- * during a transaction, and a -1 indicates that it was removed.
+ * It is a simple number: a 1 indicates that a given Id was added to a list of
+ * Ids, and a -1 indicates that it was removed.
  * @category Transaction
  * @since v4.0.0
  */
@@ -7518,13 +7519,14 @@ export interface Store {
   getListenerStats(): StoreListenerStats;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
   //
 }
 

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

@@ -749,13 +749,14 @@ export type GetCell<
 
 /**
  * The IdAddedOrRemoved type describes a change made to an Id in either the
- * tabular of keyed-value part of the Store.
+ * tabular or keyed-value part of the Store (or in other TinyBase modules).
  *
  * This type is used in other types like ChangedTableIds, ChangedRowIds,
- * ChangedCellIds, and ChangedValueIds.
+ * ChangedCellIds, and ChangedValueIds, as well as in other events or listeners
+ * where a list of Ids has changed.
  *
- * It is a simple number: a 1 indicates that a given Id was added to the Store
- * during a transaction, and a -1 indicates that it was removed.
+ * It is a simple number: a 1 indicates that a given Id was added to a list of
+ * Ids, and a -1 indicates that it was removed.
  * @category Transaction
  * @since v4.0.0
  */
@@ -9191,13 +9192,14 @@ export interface Store<in out Schemas extends OptionalSchemas> {
   getListenerStats(): StoreListenerStats;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
 }
 
 /**

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

@@ -749,13 +749,14 @@ export type GetCell<
 
 /**
  * The IdAddedOrRemoved type describes a change made to an Id in either the
- * tabular of keyed-value part of the Store.
+ * tabular or keyed-value part of the Store (or in other TinyBase modules).
  *
  * This type is used in other types like ChangedTableIds, ChangedRowIds,
- * ChangedCellIds, and ChangedValueIds.
+ * ChangedCellIds, and ChangedValueIds, as well as in other events or listeners
+ * where a list of Ids has changed.
  *
- * It is a simple number: a 1 indicates that a given Id was added to the Store
- * during a transaction, and a -1 indicates that it was removed.
+ * It is a simple number: a 1 indicates that a given Id was added to a list of
+ * Ids, and a -1 indicates that it was removed.
  * @category Transaction
  * @since v4.0.0
  */
@@ -9191,13 +9192,14 @@ export interface Store<in out Schemas extends OptionalSchemas> {
   getListenerStats(): StoreListenerStats;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
 }
 
 /**