tinybase 3.1.0-beta.2 → 3.1.0-beta.4

package/lib/debug/tools.d.ts

@@ -10,7 +10,13 @@
  * @since v2.2.0
  */
 
-import {Store, TablesSchema, ValuesSchema} from './store.d';
+import {
+  NoSchemas,
+  OptionalSchemas,
+  Store,
+  TablesSchema,
+  ValuesSchema,
+} from './store.d';
 import {Id} from './common.d';
 
 /**
@@ -109,7 +115,7 @@ export type StoreStatsRowDetail = {
  * @category Tools
  * @since v2.2.0
  */
-export interface Tools {
+export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
   /* eslint-disable max-len */
   /**
    * The getStoreStats method provides a set of statistics about the Store, and
@@ -272,9 +278,9 @@ export interface Tools {
   getStoreValuesSchema(): ValuesSchema;
 
   /**
-   * The getStoreApi method returns code-generated .d.ts and .ts(x) files that
-   * describe the schema of a Store and React bindings (since v3.1.0) in an ORM
-   * style.
+   * The getStoreApi method returns code-generated `.d.ts` and `.ts(x)` files
+   * that describe the schema of a Store and React bindings (since v3.1.0) in an
+   * ORM style.
    *
    * If the Store does not already have an explicit TablesSchema or ValuesSchema
    * associated with it, the data in the Store will be scanned to attempt to
@@ -290,12 +296,12 @@ export interface Tools {
    * - `[storeName]-ui-react.d.ts`
    * - `[storeName]-ui-react.tsx`
    *
-   * Also you should save these alongside each other so that the .ts(x) files
-   * can import types from the .d.ts files.
+   * Also you should save these alongside each other so that the `.ts(x)` files
+   * can import types from the `.d.ts` files.
    *
-   * The .d.ts and .ts(x) files that are generated are designed to resemble the
-   * main TinyBase Store and React binding files, but provide named types and
-   * methods that describe the domain of the schema in the store.
+   * The `.d.ts` and `.ts(x)` files that are generated are designed to resemble
+   * the main TinyBase Store and React binding files, but provide named types
+   * and methods that describe the domain of the schema in the Store.
    *
    * For example, from a Store that has a `pets` Table, you will get methods
    * like `getPetsTable`, types like `PetsRow`, and hooks and components that
@@ -347,9 +353,7 @@ export interface Tools {
    *
    * const dTsLines = dTs.split('\n');
    * console.log(dTsLines[3]);
-   * // -> 'export type PetsTable = {[rowId: Id]: PetsRow};'
-   * console.log(dTsLines[6]);
-   * // -> 'export type PetsRow = {\'price\'?: number;};'
+   * // -> `export type Tables = {'pets'?: {[rowId: Id]: {'price'?: number}}};`
    *
    * const tsLines = ts.split('\n');
    * console.log(tsLines[39]);
@@ -368,9 +372,7 @@ export interface Tools {
    *
    * const dTsLines = dTs.split('\n');
    * console.log(dTsLines[3]);
-   * // -> 'export type PetsTable = {[rowId: Id]: PetsRow};'
-   * console.log(dTsLines[6]);
-   * // -> 'export type PetsRow = {\'price\': number;};'
+   * // -> `export type Tables = {'pets'?: {[rowId: Id]: {'price': number}}};`
    *
    * const tsLines = ts.split('\n');
    * console.log(tsLines[41]);
@@ -382,9 +384,9 @@ export interface Tools {
   getStoreApi(storeName: string): [string, string, string, string];
 
   /**
-   * The getPrettyStoreApi method attempts to returns a prettified
-   * code-generated .d.ts and .ts(x) files that describe the schema of a Store
-   * and React bindings (since v3.1.0) in an ORM style.
+   * The getPrettyStoreApi method attempts to return prettified code-generated
+   * `.d.ts` and `.ts(x)` files that describe the schema of a Store and React
+   * bindings (since v3.1.0) in an ORM style.
    *
    * This is simply a wrapper around the getStoreApi method that attempts to
    * invoke the `prettier` module (which it hopes you have installed) to format
@@ -403,8 +405,8 @@ export interface Tools {
    * - `[storeName]-ui-react.d.ts`
    * - `[storeName]-ui-react.tsx`
    *
-   * Also you should save these alongside each other so that the .ts(x) files
-   * can import types from the .d.ts files.
+   * Also you should save these alongside each other so that the `.ts(x)` files
+   * can import types from the `.d.ts` files.
    *
    * See the documentation for the getStoreApi method for details of the content
    * of the generated files.
@@ -429,12 +431,10 @@ export interface Tools {
    *
    * const dTsLines = dTs.split('\n');
    * console.log(dTsLines[5]);
-   * // -> 'export type PetsTable = {[rowId: Id]: PetsRow};'
-   * console.log(dTsLines[10]);
-   * // -> 'export type PetsRow = {price?: number};'
+   * // -> `export type Tables = {pets?: {[rowId: Id]: {price?: number}}};`
    *
    * const tsLines = ts.split('\n');
-   * console.log(tsLines[75]);
+   * console.log(tsLines[79]);
    * // -> '    hasPetsTable: (): boolean => store.hasTable(PETS),'
    * ```
    * @example
@@ -452,12 +452,10 @@ export interface Tools {
    *
    * const dTsLines = dTs.split('\n');
    * console.log(dTsLines[5]);
-   * // -> 'export type PetsTable = {[rowId: Id]: PetsRow};'
-   * console.log(dTsLines[10]);
-   * // -> 'export type PetsRow = {price: number};'
+   * // -> 'export type Tables = {pets?: {[rowId: Id]: {price: number}}};'
    *
    * const tsLines = ts.split('\n');
-   * console.log(tsLines[77]);
+   * console.log(tsLines[81]);
    * // -> '    hasPetsTable: (): boolean => store.hasTable(PETS),'
    * ```
    * @category Modelling
@@ -485,7 +483,7 @@ export interface Tools {
    * @category Getter
    * @since v3.0.0
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 }
 
 /* eslint-disable max-len */
@@ -532,5 +530,7 @@ export interface Tools {
  * @category Creation
  * @since v2.2.0
  */
-export function createTools(store: Store): Tools;
+export function createTools<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Tools<Schemas>;
 /* eslint-enable max-len */