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

package/lib/debug/persisters.d.ts

@@ -27,7 +27,7 @@
  * @module persisters
  */
 
-import {Store, Tables, Values} from './store.d';
+import {NoSchemas, OptionalSchemas, Store, Tables, Values} from './store.d';
 import {Callback} from './common.d';
 
 /**
@@ -145,7 +145,7 @@ export type PersisterStats = {
  * ```
  * @category Persister
  */
-export interface Persister {
+export interface Persister<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The load method gets persisted data from storage, and loads it into the
    * Store with which the Persister is associated, once.
@@ -206,7 +206,10 @@ export interface Persister {
    * ```
    * @category Load
    */
-  load(initialTables?: Tables, initialValues?: Values): Promise<Persister>;
+  load(
+    initialTables?: Tables<Schemas[0], true>,
+    initialValues?: Values,
+  ): Promise<Persister<Schemas>>;
 
   /**
    * The startAutoLoad method gets persisted data from storage, and loads it
@@ -263,9 +266,9 @@ export interface Persister {
    * @category Load
    */
   startAutoLoad(
-    initialTables?: Tables,
+    initialTables?: Tables<Schemas[0], true>,
     initialValues?: Values,
-  ): Promise<Persister>;
+  ): Promise<Persister<Schemas>>;
 
   /**
    * The stopAutoLoad method stops the automatic loading of data from storage
@@ -310,7 +313,7 @@ export interface Persister {
    * ```
    * @category Load
    */
-  stopAutoLoad(): Persister;
+  stopAutoLoad(): Persister<Schemas>;
 
   /**
    * The save method takes data from the Store with which the Persister is
@@ -339,7 +342,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  save(): Promise<Persister>;
+  save(): Promise<Persister<Schemas>>;
 
   /**
    * The save method takes data from the Store with which the Persister is
@@ -377,7 +380,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  startAutoSave(): Promise<Persister>;
+  startAutoSave(): Promise<Persister<Schemas>>;
 
   /**
    * The stopAutoSave method stops the automatic save of data to storage
@@ -415,7 +418,7 @@ export interface Persister {
    * ```
    * @category Save
    */
-  stopAutoSave(): Persister;
+  stopAutoSave(): Persister<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -439,7 +442,7 @@ export interface Persister {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The destroy method should be called when this Persister object is no longer
@@ -470,7 +473,7 @@ export interface Persister {
    * ```
    * @category Lifecycle
    */
-  destroy(): Persister;
+  destroy(): Persister<Schemas>;
 
   /**
    * The getStats method provides a set of statistics about the Persister, and
@@ -546,10 +549,10 @@ export interface Persister {
  * ```
  * @category Creation
  */
-export function createSessionPersister(
-  store: Store,
+export function createSessionPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   storageName: string,
-): Persister;
+): Persister<Schemas>;
 
 /**
  * The createLocalPersister function creates a Persister object that can
@@ -579,10 +582,10 @@ export function createSessionPersister(
  * ```
  * @category Creation
  */
-export function createLocalPersister(
-  store: Store,
+export function createLocalPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   storageName: string,
-): Persister;
+): Persister<Schemas>;
 
 /**
  * The createRemotePersister function creates a Persister object that can
@@ -626,12 +629,12 @@ export function createLocalPersister(
  * ```
  * @category Creation
  */
-export function createRemotePersister(
-  store: Store,
+export function createRemotePersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   loadUrl: string,
   saveUrl: string,
   autoLoadIntervalSeconds: number,
-): Persister;
+): Persister<Schemas>;
 
 /**
  * The createFilePersister function creates a Persister object that can persist
@@ -661,7 +664,10 @@ export function createRemotePersister(
  * ```
  * @category Creation
  */
-export function createFilePersister(store: Store, filePath: string): Persister;
+export function createFilePersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+  filePath: string,
+): Persister<Schemas>;
 
 /**
  * The createCustomPersister function creates a Persister object that you can
@@ -718,10 +724,10 @@ export function createFilePersister(store: Store, filePath: string): Persister;
  * ```
  * @category Creation
  */
-export function createCustomPersister(
-  store: Store,
+export function createCustomPersister<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
   getPersisted: () => Promise<string | null | undefined>,
   setPersisted: (json: string) => Promise<void>,
   startListeningToPersisted: (didChange: Callback) => void,
   stopListeningToPersisted: Callback,
-): Persister;
+): Persister<Schemas>;

package/lib/debug/queries.d.ts

@@ -18,6 +18,8 @@ import {
   CellOrUndefined,
   GetCell,
   GetCellChange,
+  NoSchemas,
+  OptionalSchemas,
   Row,
   RowCallback,
   Store,
@@ -1427,7 +1429,7 @@ export type Having = {
  * @category Queries
  * @since v2.0.0
  */
-export interface Queries {
+export interface Queries<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setQueryDefinition method lets you set the definition of a query.
    *
@@ -1501,7 +1503,7 @@ export interface Queries {
       group: Group;
       having: Having;
     }) => void,
-  ): Queries;
+  ): Queries<Schemas>;
 
   /**
    * The delQueryDefinition method removes an existing query definition.
@@ -1534,7 +1536,7 @@ export interface Queries {
    * @category Configuration
    * @since v2.0.0
    */
-  delQueryDefinition(queryId: Id): Queries;
+  delQueryDefinition(queryId: Id): Queries<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -1560,7 +1562,7 @@ export interface Queries {
    * @category Getter
    * @since v2.0.0
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getQueryIds method returns an array of the query Ids registered with
@@ -2919,7 +2921,7 @@ export interface Queries {
    * @category Listener
    * @since v2.0.0
    */
-  delListener(listenerId: Id): Queries;
+  delListener(listenerId: Id): Queries<Schemas>;
 
   /**
    * The destroy method should be called when this Queries object is no longer
@@ -3021,4 +3023,6 @@ export interface Queries {
  * @category Creation
  * @since v2.0.0
  */
-export function createQueries(store: Store): Queries;
+export function createQueries<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Queries<Schemas>;

package/lib/debug/relationships.d.ts

@@ -11,7 +11,13 @@
  * @module relationships
  */
 
-import {GetCell, RowCallback, Store} from './store.d';
+import {
+  GetCell,
+  NoSchemas,
+  OptionalSchemas,
+  RowCallback,
+  Store,
+} from './store.d';
 import {Id, IdOrNull, Ids} from './common.d';
 
 /**
@@ -247,7 +253,7 @@ export type RelationshipsListenerStats = {
  * @see Drawing demo
  * @category Relationships
  */
-export interface Relationships {
+export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
   /**
    * The setRelationshipDefinition method lets you set the definition of a
    * Relationship.
@@ -339,7 +345,7 @@ export interface Relationships {
     localTableId: Id,
     remoteTableId: Id,
     getRemoteRowId: Id | ((getCell: GetCell, localRowId: Id) => Id),
-  ): Relationships;
+  ): Relationships<Schemas>;
 
   /**
    * The delRelationshipDefinition method removes an existing Relationship
@@ -379,7 +385,7 @@ export interface Relationships {
    * ```
    * @category Configuration
    */
-  delRelationshipDefinition(relationshipId: Id): Relationships;
+  delRelationshipDefinition(relationshipId: Id): Relationships<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
@@ -404,7 +410,7 @@ export interface Relationships {
    * ```
    * @category Getter
    */
-  getStore(): Store;
+  getStore(): Store<Schemas>;
 
   /**
    * The getRelationshipIds method returns an array of the Relationship Ids
@@ -1081,7 +1087,7 @@ export interface Relationships {
    * ```
    * @category Listener
    */
-  delListener(listenerId: Id): Relationships;
+  delListener(listenerId: Id): Relationships<Schemas>;
 
   /**
    * The destroy method should be called when this Relationships object is no
@@ -1198,4 +1204,6 @@ export interface Relationships {
  * ```
  * @category Creation
  */
-export function createRelationships(store: Store): Relationships;
+export function createRelationships<Schemas extends OptionalSchemas>(
+  store: Store<Schemas>,
+): Relationships<Schemas>;