tinybase 3.1.0-beta.4 → 3.1.0

package/lib/types/with-schemas/tinybase.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This is everything.
+ *
+ * @packageDocumentation
+ */
+
+export * from './checkpoints.d';
+export * from './common.d';
+export * from './indexes.d';
+export * from './metrics.d';
+export * from './persisters.d';
+export * from './queries.d';
+export * from './relationships.d';
+export * from './store.d';

package/lib/{cjs-es6 → types/with-schemas}/tools.d.ts

@@ -10,13 +10,7 @@
  * @since v2.2.0
  */
 
-import {
-  NoSchemas,
-  OptionalSchemas,
-  Store,
-  TablesSchema,
-  ValuesSchema,
-} from './store.d';
+import {OptionalSchemas, Store} from './store.d';
 import {Id} from './common.d';
 
 /**
@@ -90,6 +84,9 @@ export type StoreStatsTableDetail = {
    * The number of Cell objects in the Table, across all Row objects.
    */
   tableCells: number;
+  /**
+   * Detail about the Table object.
+   */
   rows: {[rowId: Id]: StoreStatsRowDetail};
 };
 
@@ -115,7 +112,7 @@ export type StoreStatsRowDetail = {
  * @category Tools
  * @since v2.2.0
  */
-export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
+export interface Tools<in out Schemas extends OptionalSchemas> {
   /* eslint-disable max-len */
   /**
    * The getStoreStats method provides a set of statistics about the Store, and
@@ -174,6 +171,7 @@ export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
    * @since v2.2.0
    */
   getStoreStats(detail?: boolean): StoreStats;
+
   /* eslint-enable max-len */
 
   /**
@@ -236,7 +234,7 @@ export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
    * @category Modelling
    * @since v3.0.0
    */
-  getStoreTablesSchema(): TablesSchema;
+  getStoreTablesSchema(): Schemas[0];
 
   /**
    * The getStoreValuesSchema method returns the ValuesSchema of the Store as an
@@ -275,7 +273,7 @@ export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
    * @category Modelling
    * @since v3.0.0
    */
-  getStoreValuesSchema(): ValuesSchema;
+  getStoreValuesSchema(): Schemas[1];
 
   /**
    * The getStoreApi method returns code-generated `.d.ts` and `.ts(x)` files
@@ -469,6 +467,12 @@ export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
    * The getStore method returns a reference to the underlying Store that is
    * backing this Tools object.
    *
+   * This has schema-based typing. The following is a simplified representation:
+   *
+   * ```ts override
+   * getStore(): Store;
+   * ```
+   *
    * @returns A reference to the Store.
    * @example
    * This example creates a Tools object against a newly-created Store and
@@ -491,6 +495,12 @@ export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
  * The createTools function creates a Tools object, and is the main entry point
  * into the tools module.
  *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createTools(store: Store): Tools;
+ * ```
+ *
  * A given Store can only have one Tools object associated with it. If you call
  * this function twice on the same Store, your second call will return a
  * reference to the Tools object created by the first.
@@ -533,4 +543,5 @@ export interface Tools<Schemas extends OptionalSchemas = NoSchemas> {
 export function createTools<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
 ): Tools<Schemas>;
+
 /* eslint-enable max-len */