tinybase 3.1.0-beta.3 → 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
@@ -459,180 +465,6 @@ export interface Tools {
     storeName: string,
   ): Promise<[string, string, string, string]>;
 
-  /**
-   * The getStoreRefinement method returns code-generated `.d.ts` files that
-   * refine the Store and React bindings to have schema-specific methods and
-   * types.
-   *
-   * 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
-   * infer new schemas. The method returns two strings (which should be saved as
-   * files) though if no schema can be inferred, the strings will be empty.
-   *
-   * 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 two
-   * files yourself, as, respectively:
-   *
-   * - `[storeName]-refinement.d.ts`
-   * - `[storeName]-ui-react-refinement.d.ts`
-   *
-   * You should save these alongside each other.
-   *
-   * The `.d.ts` files that are generated are designed to resemble the main
-   * TinyBase Store and React binding files. In your application you will need
-   * to coerce the Store to the refined interface to benefit from the type
-   * safety. One easy way to do this is to cast the TinyBase module to the
-   * refined module in bulk, and then destructure to get the refined imports:
-   *
-   * ```js yolo
-   * import * as tinybase from 'tinybase';
-   * import shopRefinement from './shop-refinement.d';
-   *
-   * const {createStore} = tinybase as typeof shopRefinement;
-   *
-   * const shop = createStore(); // shop is a refined Store
-   * // ...
-   * ```
-   *
-   * This is a particularly good approach for the React module which has many
-   * top-level hook and component functions. You don't need to refine them one
-   * by one:
-   *
-   * ```js yolo
-   * import * as tinybaseUiReact from 'tinybase/ui-react';
-   * import shopUiReactRefinement from './shop-ui-react-refinement.d';
-   *
-   * const {
-   *   useTables, // a refined hook
-   *   RowView, //   a refined component
-   *   // ...
-   * } = tinybaseUiReact as typeof shopUiReactRefinement;
-   *
-   * // ...
-   * ```
-   *
-   * If you need access to refined types from the generated module definition,
-   * you can access them as normal, in a separate import:
-   *
-   * ```js yolo
-   * import {Tables} from './shop-refinement.d';
-   * ```
-   *
-   * @param storeName The name you want to provide to the generated Store, which
-   * should also be used to save the `.d.ts` files.
-   * @returns A pair of strings representing the contents of the `.d.ts` files
-   * for the generated Store and React modules.
-   * @example
-   * This example creates a Tools object and generates type refinements for a
-   * Store that already has a TablesSchema.
-   * ```js
-   * const store = createStore().setTablesSchema({
-   *   pets: {
-   *     price: {type: 'number'},
-   *   },
-   * });
-   * const [refinementDTs, uiReactRefinementDTs] =
-   *   createTools(store).getStoreRefinement('shop');
-   *
-   * const dTsLines = refinementDTs.split('\n');
-   * // console.log(dTsLines[3]);
-   * // // -> ''
-   * // console.log(dTsLines[6]);
-   * // // -> ''
-   * ```
-   * @example
-   * This example creates a Tools object and generates code for a Store that
-   * doesn't already have a TablesSchema.
-   * ```js
-   * const store = createStore().setTable('pets', {
-   *   fido: {price: 5},
-   *   felix: {price: 4},
-   * });
-   * const [refinementDTs, uiReactRefinementDTs] =
-   *   createTools(store).getStoreRefinement('shop');
-   *
-   * const dTsLines = refinementDTs.split('\n');
-   * // console.log(dTsLines[3]);
-   * // // -> ''
-   * // console.log(dTsLines[6]);
-   * // // -> ''
-   * ```
-   * @category Modelling
-   * @since v3.1.0
-   */
-  getStoreRefinement(storeName: string): [string, string];
-
-  /**
-   * The getPrettyStoreRefinement method attempts to return prettified
-   * code-generated `.d.ts` files that refine the Store and React bindings to
-   * have schema-specific methods and types.
-   *
-   * This is simply a wrapper around the getStoreRefinement method that attempts
-   * to invoke the `prettier` module (which it hopes you have installed) to
-   * format the generated code. If `prettier` is not present, the output will
-   * resemble that of the underlying getStoreRefinement method.
-   *
-   * The method is asynchronous, so you should use the `await` keyword or handle
-   * the results as a promise.
-   *
-   * 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 two
-   * files yourself, as, respectively:
-   *
-   * - `[storeName]-refinement.d.ts`
-   * - `[storeName]-ui-react-refinement.d.ts`
-   *
-   * You should save these alongside each other.
-   *
-   * See the documentation for the getStoreRefinement method for details of the
-   * content of the generated files.
-   *
-   * @param storeName The name you want to provide to the generated Store, which
-   * should also be used to save the `.d.ts` files.
-   * @returns A pair of strings representing the contents of the `.d.ts` files
-   * for the generated Store and React modules.
-   * @example
-   * This example creates a Tools object and generates type refinements for a
-   * Store that already has a TablesSchema.
-   * ```js
-   * const store = createStore().setTablesSchema({
-   *   pets: {
-   *     price: {type: 'number'},
-   *   },
-   * });
-   * const [refinementDTs, uiReactRefinementDTs] = await createTools(
-   *   store,
-   * ).getPrettyStoreRefinement('shop');
-   *
-   * const dTsLines = refinementDTs.split('\n');
-   * // console.log(dTsLines[3]);
-   * // // -> ''
-   * // console.log(dTsLines[6]);
-   * // // -> ''
-   * ```
-   * @example
-   * This example creates a Tools object and generates code for a Store that
-   * doesn't already have a TablesSchema.
-   * ```js
-   * const store = createStore().setTable('pets', {
-   *   fido: {price: 5},
-   *   felix: {price: 4},
-   * });
-   * const [refinementDTs, uiReactRefinementDTs] = await createTools(
-   *   store,
-   * ).getPrettyStoreRefinement('shop');
-   *
-   * const dTsLines = refinementDTs.split('\n');
-   * // console.log(dTsLines[3]);
-   * // // -> ''
-   * // console.log(dTsLines[6]);
-   * // // -> ''
-   * ```
-   * @category Modelling
-   * @since v3.1.0
-   */
-  getPrettyStoreRefinement(storeName: string): Promise<[string, string]>;
-
   /**
    * The getStore method returns a reference to the underlying Store that is
    * backing this Tools object.
@@ -651,7 +483,7 @@ export interface Tools {
    * @category Getter
    * @since v3.0.0
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 }
 
 /* eslint-disable max-len */
@@ -698,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 */