tinybase 5.0.0-beta.25 → 5.0.0-beta.27

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';

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

@@ -116,6 +116,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -136,6 +137,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * ```
    * @example
    * This example creates a Tools object and gets detailed statistics about it.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -188,6 +190,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -208,6 +211,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -252,6 +256,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -268,6 +273,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -295,12 +301,12 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    *
    * 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.
@@ -347,6 +353,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -370,6 +377,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -409,12 +417,12 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    *
    * 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.
@@ -428,6 +436,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -451,6 +460,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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/with-schemas/index.d.ts

@@ -116,6 +116,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -136,6 +137,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * ```
    * @example
    * This example creates a Tools object and gets detailed statistics about it.
+   *
    * ```js
    * import {createStore} from 'tinybase';
    * import {createTools} from 'tinybase/tools';
@@ -188,6 +190,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -208,6 +211,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -252,6 +256,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -268,6 +273,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -295,12 +301,12 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    *
    * 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.
@@ -347,6 +353,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -370,6 +377,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -409,12 +417,12 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    *
    * 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.
@@ -428,6 +436,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -451,6 +460,7 @@ export interface Tools<in out Schemas extends OptionalSchemas> {
    * @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/ui-react/index.d.cts

@@ -324,7 +324,7 @@ export function useCreateStore(
 ): Store;
 
 /**
- * The useCreateMergeableStore hook
+ * The useCreateMergeableStore hook.
  */
 export function useCreateMergeableStore(
   create: () => MergeableStore,

package/@types/ui-react/index.d.ts

@@ -324,7 +324,7 @@ export function useCreateStore(
 ): Store;
 
 /**
- * The useCreateMergeableStore hook
+ * The useCreateMergeableStore hook.
  */
 export function useCreateMergeableStore(
   create: () => MergeableStore,

package/@types/ui-react/with-schemas/index.d.cts

@@ -406,7 +406,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   ) => Store<Schemas>;
 
   /**
- * The useCreateMergeableStore hook
+ * The useCreateMergeableStore hook.
  */
   useCreateMergeableStore: (
     create: () => MergeableStore<Schemas>,

package/@types/ui-react/with-schemas/index.d.ts

@@ -406,7 +406,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
   ) => Store<Schemas>;
 
   /**
- * The useCreateMergeableStore hook
+ * The useCreateMergeableStore hook.
  */
   useCreateMergeableStore: (
     create: () => MergeableStore<Schemas>,

package/@types/ui-react-dom/index.d.cts

@@ -275,7 +275,7 @@ export type SliceInHtmlTableProps = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  * @category Props
  * @since v4.1.0
  */
@@ -1057,7 +1057,7 @@ export function SliceInHtmlTable(
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  *
  * This component uses the useRowIds and useRemoteRowId hooks under the covers,
  * which means that any changes to the structure of either Table resulting in a

package/@types/ui-react-dom/index.d.ts

@@ -275,7 +275,7 @@ export type SliceInHtmlTableProps = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  * @category Props
  * @since v4.1.0
  */
@@ -1057,7 +1057,7 @@ export function SliceInHtmlTable(
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  *
  * This component uses the useRowIds and useRemoteRowId hooks under the covers,
  * which means that any changes to the structure of either Table resulting in a

package/@types/ui-react-dom/with-schemas/index.d.cts

@@ -320,7 +320,7 @@ export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  * @category Props
  * @since v4.1.0
  */
@@ -1150,7 +1150,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  *
  * This component uses the useRowIds and useRemoteRowId hooks under the covers,
  * which means that any changes to the structure of either Table resulting in a

package/@types/ui-react-dom/with-schemas/index.d.ts

@@ -320,7 +320,7 @@ export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  * @category Props
  * @since v4.1.0
  */
@@ -1150,7 +1150,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  *
  * This component uses the useRowIds and useRemoteRowId hooks under the covers,
  * which means that any changes to the structure of either Table resulting in a

package/@types/ui-react-inspector/with-schemas/index.d.cts

@@ -319,7 +319,7 @@ export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  * @category Props
  * @since v4.1.0
  */
@@ -1127,7 +1127,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  *
  * This component uses the useRowIds and useRemoteRowId hooks under the covers,
  * which means that any changes to the structure of either Table resulting in a

package/@types/ui-react-inspector/with-schemas/index.d.ts

@@ -319,7 +319,7 @@ export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  * @category Props
  * @since v4.1.0
  */
@@ -1127,7 +1127,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * Note the use of dotted 'tableId.cellId' string pairs when specifying custom
  * rendering for the cells in this table, since Cells from both the
  * relationship's 'local' and 'remote' Table objects can be rendered and need to
- * be distinguished
+ * be distinguished.
  *
  * This component uses the useRowIds and useRemoteRowId hooks under the covers,
  * which means that any changes to the structure of either Table resulting in a