tinybase 5.4.0-beta.5 → 5.5.0-beta.0

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

@@ -51,8 +51,8 @@ export type Slice = Ids;
  * can do something based on every Index in the Indexes object. See that method
  * for specific examples.
  * @param indexId The Id of the Index that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Slice objects
- * in this Index.
+ * @param forEachSlice A function that will let you iterate over the Slice
+ * objects in this Index.
  * @category Callback
  * @since v1.0.0
  */

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

@@ -51,8 +51,8 @@ export type Slice = Ids;
  * can do something based on every Index in the Indexes object. See that method
  * for specific examples.
  * @param indexId The Id of the Index that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Slice objects
- * in this Index.
+ * @param forEachSlice A function that will let you iterate over the Slice
+ * objects in this Index.
  * @category Callback
  * @since v1.0.0
  */

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

@@ -75,8 +75,8 @@ export type Slice = Ids;
  * can do something based on every Index in the Indexes object. See that method
  * for specific examples.
  * @param indexId The Id of the Index that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Slice objects
- * in this Index.
+ * @param forEachSlice A function that will let you iterate over the Slice
+ * objects in this Index.
  * @category Callback
  * @since v1.0.0
  */

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

@@ -75,8 +75,8 @@ export type Slice = Ids;
  * can do something based on every Index in the Indexes object. See that method
  * for specific examples.
  * @param indexId The Id of the Index that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Slice objects
- * in this Index.
+ * @param forEachSlice A function that will let you iterate over the Slice
+ * objects in this Index.
  * @category Callback
  * @since v1.0.0
  */

package/@types/persisters/persister-durable-object-storage/index.d.cts

@@ -2,6 +2,7 @@
  * The persister-durable-object-storage module of the TinyBase project lets you
  * save and load Store data to and from Cloudflare Durable Object storage (in an
  * appropriate environment).
+ * @see Cloudflare Durable Objects guide
  * @see Persistence guides
  * @packageDocumentation
  * @module persister-durable-object-storage
@@ -72,6 +73,12 @@ export interface DurableObjectStoragePersister
  * A DurableObjectStoragePersister only supports MergeableStore objects, and
  * cannot be used to persist a regular Store.
  *
+ * Durable Objects have limitations on the data that can be stored in each key
+ * of their key-value structure. The DurableObjectStoragePersister uses one key
+ * per TinyBase Value, one key per Cell, one key per Row, and one key per Table.
+ * Mostly this is CRDT metadata, but the main caution is to ensure that each
+ * individual TinyBase Cell and Value data does not exceed the (128 KiB) limit.
+ *
  * As well as providing a reference to the MergeableStore to persist, you must
  * provide a `storage` parameter which identifies the Durable Object storage to
  * persist it to.

package/@types/persisters/persister-durable-object-storage/index.d.ts

@@ -2,6 +2,7 @@
  * The persister-durable-object-storage module of the TinyBase project lets you
  * save and load Store data to and from Cloudflare Durable Object storage (in an
  * appropriate environment).
+ * @see Cloudflare Durable Objects guide
  * @see Persistence guides
  * @packageDocumentation
  * @module persister-durable-object-storage
@@ -72,6 +73,12 @@ export interface DurableObjectStoragePersister
  * A DurableObjectStoragePersister only supports MergeableStore objects, and
  * cannot be used to persist a regular Store.
  *
+ * Durable Objects have limitations on the data that can be stored in each key
+ * of their key-value structure. The DurableObjectStoragePersister uses one key
+ * per TinyBase Value, one key per Cell, one key per Row, and one key per Table.
+ * Mostly this is CRDT metadata, but the main caution is to ensure that each
+ * individual TinyBase Cell and Value data does not exceed the (128 KiB) limit.
+ *
  * As well as providing a reference to the MergeableStore to persist, you must
  * provide a `storage` parameter which identifies the Durable Object storage to
  * persist it to.

package/@types/persisters/persister-durable-object-storage/with-schemas/index.d.cts

@@ -2,6 +2,7 @@
  * The persister-durable-object-storage module of the TinyBase project lets you
  * save and load Store data to and from Cloudflare Durable Object storage (in an
  * appropriate environment).
+ * @see Cloudflare Durable Objects guide
  * @see Persistence guides
  * @packageDocumentation
  * @module persister-durable-object-storage
@@ -84,6 +85,12 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
  * A DurableObjectStoragePersister only supports MergeableStore objects, and
  * cannot be used to persist a regular Store.
  *
+ * Durable Objects have limitations on the data that can be stored in each key
+ * of their key-value structure. The DurableObjectStoragePersister uses one key
+ * per TinyBase Value, one key per Cell, one key per Row, and one key per Table.
+ * Mostly this is CRDT metadata, but the main caution is to ensure that each
+ * individual TinyBase Cell and Value data does not exceed the (128 KiB) limit.
+ *
  * As well as providing a reference to the MergeableStore to persist, you must
  * provide a `storage` parameter which identifies the Durable Object storage to
  * persist it to.

package/@types/persisters/persister-durable-object-storage/with-schemas/index.d.ts

@@ -2,6 +2,7 @@
  * The persister-durable-object-storage module of the TinyBase project lets you
  * save and load Store data to and from Cloudflare Durable Object storage (in an
  * appropriate environment).
+ * @see Cloudflare Durable Objects guide
  * @see Persistence guides
  * @packageDocumentation
  * @module persister-durable-object-storage
@@ -84,6 +85,12 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
  * A DurableObjectStoragePersister only supports MergeableStore objects, and
  * cannot be used to persist a regular Store.
  *
+ * Durable Objects have limitations on the data that can be stored in each key
+ * of their key-value structure. The DurableObjectStoragePersister uses one key
+ * per TinyBase Value, one key per Cell, one key per Row, and one key per Table.
+ * Mostly this is CRDT metadata, but the main caution is to ensure that each
+ * individual TinyBase Cell and Value data does not exceed the (128 KiB) limit.
+ *
  * As well as providing a reference to the MergeableStore to persist, you must
  * provide a `storage` parameter which identifies the Durable Object storage to
  * persist it to.

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

@@ -234,7 +234,7 @@ export type ResultTableCallback = (
  * that you can do something based on every ResultRow in a ResultTable. See that
  * method for specific examples.
  * @param rowId The Id of the ResultRow that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the ResultCell
+ * @param forEachCell A function that will let you iterate over the ResultCell
  * values in this ResultRow.
  * @category Callback
  * @since v2.0.0

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

@@ -234,7 +234,7 @@ export type ResultTableCallback = (
  * that you can do something based on every ResultRow in a ResultTable. See that
  * method for specific examples.
  * @param rowId The Id of the ResultRow that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the ResultCell
+ * @param forEachCell A function that will let you iterate over the ResultCell
  * values in this ResultRow.
  * @category Callback
  * @since v2.0.0

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

@@ -245,7 +245,7 @@ export type ResultTableCallback = (
  * that you can do something based on every ResultRow in a ResultTable. See that
  * method for specific examples.
  * @param rowId The Id of the ResultRow that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the ResultCell
+ * @param forEachCell A function that will let you iterate over the ResultCell
  * values in this ResultRow.
  * @category Callback
  * @since v2.0.0

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

@@ -245,7 +245,7 @@ export type ResultTableCallback = (
  * that you can do something based on every ResultRow in a ResultTable. See that
  * method for specific examples.
  * @param rowId The Id of the ResultRow that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the ResultCell
+ * @param forEachCell A function that will let you iterate over the ResultCell
  * values in this ResultRow.
  * @category Callback
  * @since v2.0.0

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

@@ -394,7 +394,7 @@ export type TableCellCallback = (cellId: Id, count: number) => void;
  * do something based on every Row in a Table. See that method for specific
  * examples.
  * @param rowId The Id of the Row that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Cell values
+ * @param forEachCell A function that will let you iterate over the Cell values
  * in this Row.
  * @category Callback
  * @since v1.0.0

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

@@ -394,7 +394,7 @@ export type TableCellCallback = (cellId: Id, count: number) => void;
  * do something based on every Row in a Table. See that method for specific
  * examples.
  * @param rowId The Id of the Row that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Cell values
+ * @param forEachCell A function that will let you iterate over the Cell values
  * in this Row.
  * @category Callback
  * @since v1.0.0

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

@@ -588,7 +588,7 @@ export type TableCellCallback<
  * do something based on every Row in a Table. See that method for specific
  * examples.
  * @param rowId The Id of the Row that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Cell values
+ * @param forEachCell A function that will let you iterate over the Cell values
  * in this Row.
  * @category Callback
  * @since v1.0.0

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

@@ -588,7 +588,7 @@ export type TableCellCallback<
  * do something based on every Row in a Table. See that method for specific
  * examples.
  * @param rowId The Id of the Row that the callback can operate on.
- * @param forEachRow A function that will let you iterate over the Cell values
+ * @param forEachCell A function that will let you iterate over the Cell values
  * in this Row.
  * @category Callback
  * @since v1.0.0

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

@@ -2,6 +2,7 @@
  * The synchronizer-ws-server-durable-object module of the TinyBase project lets
  * you create a server that facilitates synchronization between clients, running
  * as a Cloudflare Durable Object.
+ * @see Cloudflare Durable Objects guide
  * @see Synchronization guide
  * @see Todo App v6 (collaboration) demo
  * @packageDocumentation
@@ -17,6 +18,16 @@ import {DurableObject} from 'cloudflare:workers';
  * A WsServerDurableObject is the server component (running as a Cloudflare
  * Durable Object) for synchronization between clients that are using
  * WsSynchronizer instances.
+ *
+ * The WsServerDurableObject is an overridden implementation of the
+ * DurableObject class, so you can have access to its members as well as the
+ * TinyBase-specific methods. If you are using the storage for other data, you
+ * may want to configure a `prefix` parameter to ensure you don't accidentally
+ * collide with TinyBase data.
+ *
+ * Always remember to call the `super` implementations of the methods that
+ * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
+ * `webSocketClose`) if you further override them.
  * @category Creation
  * @since v5.4.0
  */
@@ -26,12 +37,16 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
    * the TinyBase clients.
    *
    * For basic TinyBase synchronization and persistence, you don't need to
-   * override this method, but if you do, ensure you call the super constructor.
+   * override this method, but if you do, ensure you call the `super`
+   * constructor
+   * with the two parameters.
+   * @param ctx The DurableObjectState context.
+   * @param env The DurableObjectState environment.
    * @returns A new instance of the WsServerDurableObject.
    * @category Creation
    * @since v5.4.0
    */
-  constructor();
+  constructor(ctx: DurableObjectState, env: Env);
 
   /**
    * The createPersister method is used to return a persister for the Durable

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

@@ -2,6 +2,7 @@
  * The synchronizer-ws-server-durable-object module of the TinyBase project lets
  * you create a server that facilitates synchronization between clients, running
  * as a Cloudflare Durable Object.
+ * @see Cloudflare Durable Objects guide
  * @see Synchronization guide
  * @see Todo App v6 (collaboration) demo
  * @packageDocumentation
@@ -17,6 +18,16 @@ import {DurableObject} from 'cloudflare:workers';
  * A WsServerDurableObject is the server component (running as a Cloudflare
  * Durable Object) for synchronization between clients that are using
  * WsSynchronizer instances.
+ *
+ * The WsServerDurableObject is an overridden implementation of the
+ * DurableObject class, so you can have access to its members as well as the
+ * TinyBase-specific methods. If you are using the storage for other data, you
+ * may want to configure a `prefix` parameter to ensure you don't accidentally
+ * collide with TinyBase data.
+ *
+ * Always remember to call the `super` implementations of the methods that
+ * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
+ * `webSocketClose`) if you further override them.
  * @category Creation
  * @since v5.4.0
  */
@@ -26,12 +37,16 @@ export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {
    * the TinyBase clients.
    *
    * For basic TinyBase synchronization and persistence, you don't need to
-   * override this method, but if you do, ensure you call the super constructor.
+   * override this method, but if you do, ensure you call the `super`
+   * constructor
+   * with the two parameters.
+   * @param ctx The DurableObjectState context.
+   * @param env The DurableObjectState environment.
    * @returns A new instance of the WsServerDurableObject.
    * @category Creation
    * @since v5.4.0
    */
-  constructor();
+  constructor(ctx: DurableObjectState, env: Env);
 
   /**
    * The createPersister method is used to return a persister for the Durable

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

@@ -2,6 +2,7 @@
  * The synchronizer-ws-server-durable-object module of the TinyBase project lets
  * you create a server that facilitates synchronization between clients, running
  * as a Cloudflare Durable Object.
+ * @see Cloudflare Durable Objects guide
  * @see Synchronization guide
  * @see Todo App v6 (collaboration) demo
  * @packageDocumentation
@@ -25,6 +26,16 @@ import {DurableObject} from 'cloudflare:workers';
  * A WsServerDurableObject is the server component (running as a Cloudflare
  * Durable Object) for synchronization between clients that are using
  * WsSynchronizer instances.
+ *
+ * The WsServerDurableObject is an overridden implementation of the
+ * DurableObject class, so you can have access to its members as well as the
+ * TinyBase-specific methods. If you are using the storage for other data, you
+ * may want to configure a `prefix` parameter to ensure you don't accidentally
+ * collide with TinyBase data.
+ *
+ * Always remember to call the `super` implementations of the methods that
+ * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
+ * `webSocketClose`) if you further override them.
  * @category Creation
  * @since v5.4.0
  */
@@ -37,12 +48,16 @@ export class WsServerDurableObject<
    * the TinyBase clients.
    *
    * For basic TinyBase synchronization and persistence, you don't need to
-   * override this method, but if you do, ensure you call the super constructor.
+   * override this method, but if you do, ensure you call the `super`
+   * constructor
+   * with the two parameters.
+   * @param ctx The DurableObjectState context.
+   * @param env The DurableObjectState environment.
    * @returns A new instance of the WsServerDurableObject.
    * @category Creation
    * @since v5.4.0
    */
-  constructor();
+  constructor(ctx: DurableObjectState, env: Env);
 
   /**
    * The createPersister method is used to return a persister for the Durable

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

@@ -2,6 +2,7 @@
  * The synchronizer-ws-server-durable-object module of the TinyBase project lets
  * you create a server that facilitates synchronization between clients, running
  * as a Cloudflare Durable Object.
+ * @see Cloudflare Durable Objects guide
  * @see Synchronization guide
  * @see Todo App v6 (collaboration) demo
  * @packageDocumentation
@@ -25,6 +26,16 @@ import {DurableObject} from 'cloudflare:workers';
  * A WsServerDurableObject is the server component (running as a Cloudflare
  * Durable Object) for synchronization between clients that are using
  * WsSynchronizer instances.
+ *
+ * The WsServerDurableObject is an overridden implementation of the
+ * DurableObject class, so you can have access to its members as well as the
+ * TinyBase-specific methods. If you are using the storage for other data, you
+ * may want to configure a `prefix` parameter to ensure you don't accidentally
+ * collide with TinyBase data.
+ *
+ * Always remember to call the `super` implementations of the methods that
+ * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
+ * `webSocketClose`) if you further override them.
  * @category Creation
  * @since v5.4.0
  */
@@ -37,12 +48,16 @@ export class WsServerDurableObject<
    * the TinyBase clients.
    *
    * For basic TinyBase synchronization and persistence, you don't need to
-   * override this method, but if you do, ensure you call the super constructor.
+   * override this method, but if you do, ensure you call the `super`
+   * constructor
+   * with the two parameters.
+   * @param ctx The DurableObjectState context.
+   * @param env The DurableObjectState environment.
    * @returns A new instance of the WsServerDurableObject.
    * @category Creation
    * @since v5.4.0
    */
-  constructor();
+  constructor(ctx: DurableObjectState, env: Env);
 
   /**
    * The createPersister method is used to return a persister for the Durable

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tinybase",
-  "version": "5.4.0-beta.5",
+  "version": "5.5.0-beta.0",
   "author": "jamesgpearce",
   "repository": "github:tinyplex/tinybase",
   "license": "MIT",