tinybase 3.1.0-beta.4 → 3.1.0-beta.5

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

@@ -11,10 +11,11 @@
  * @module relationships
  */
 
+import {CellIdFromSchema, TableIdFromSchema} from './internal/store';
 import {
   GetCell,
-  NoSchemas,
   OptionalSchemas,
+  OptionalTablesSchema,
   RowCallback,
   Store,
 } from './store.d';
@@ -59,9 +60,9 @@ export type Relationship = {
  * objects in this Relationship.
  * @category Callback
  */
-export type RelationshipCallback = (
+export type RelationshipCallback<Schema extends OptionalTablesSchema> = (
   relationshipId: Id,
-  forEachRow: (rowCallback: RowCallback) => void,
+  forEachRow: (rowCallback: RowCallback<Schema>) => void,
 ) => void;
 
 /**
@@ -80,8 +81,8 @@ export type RelationshipCallback = (
  * @param localRowId The Id of the local Row whose remote Row Id changed.
  * @category Listener
  */
-export type RemoteRowIdListener = (
-  relationships: Relationships,
+export type RemoteRowIdListener<Schemas extends OptionalSchemas> = (
+  relationships: Relationships<Schemas>,
   relationshipId: Id,
   localRowId: Id,
 ) => void;
@@ -102,8 +103,8 @@ export type RemoteRowIdListener = (
  * @param remoteRowId The Id of the remote Row whose local Row Ids changed.
  * @category Listener
  */
-export type LocalRowIdsListener = (
-  relationships: Relationships,
+export type LocalRowIdsListener<Schemas extends OptionalSchemas> = (
+  relationships: Relationships<Schemas>,
   relationshipId: Id,
   remoteRowId: Id,
 ) => void;
@@ -125,8 +126,8 @@ export type LocalRowIdsListener = (
  * members changed.
  * @category Listener
  */
-export type LinkedRowIdsListener = (
-  relationships: Relationships,
+export type LinkedRowIdsListener<Schemas extends OptionalSchemas> = (
+  relationships: Relationships<Schemas>,
   relationshipId: Id,
   firstRowId: Id,
 ) => void;
@@ -253,7 +254,7 @@ export type RelationshipsListenerStats = {
  * @see Drawing demo
  * @category Relationships
  */
-export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
+export interface Relationships<in out Schemas extends OptionalSchemas> {
   /**
    * The setRelationshipDefinition method lets you set the definition of a
    * Relationship.
@@ -340,11 +341,13 @@ export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Configuration
    */
-  setRelationshipDefinition(
+  setRelationshipDefinition<LocalTableId extends TableIdFromSchema<Schemas[0]>>(
     relationshipId: Id,
-    localTableId: Id,
-    remoteTableId: Id,
-    getRemoteRowId: Id | ((getCell: GetCell, localRowId: Id) => Id),
+    localTableId: LocalTableId,
+    remoteTableId: TableIdFromSchema<Schemas[0]>,
+    getRemoteRowId:
+      | CellIdFromSchema<Schemas[0], LocalTableId>
+      | ((getCell: GetCell<Schemas[0], LocalTableId>, localRowId: Id) => Id),
   ): Relationships<Schemas>;
 
   /**
@@ -473,7 +476,9 @@ export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Iterator
    */
-  forEachRelationship(relationshipCallback: RelationshipCallback): void;
+  forEachRelationship(
+    relationshipCallback: RelationshipCallback<Schemas[0]>,
+  ): void;
 
   /**
    * The hasRelationship method returns a boolean indicating whether a given
@@ -528,7 +533,9 @@ export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Getter
    */
-  getLocalTableId(relationshipId: Id): Id;
+  getLocalTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
+    relationshipId: Id,
+  ): TableId | undefined;
 
   /**
    * The getRemoteTableId method returns the Id of the underlying remote Table
@@ -560,7 +567,9 @@ export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
    * ```
    * @category Getter
    */
-  getRemoteTableId(relationshipId: Id): Id;
+  getRemoteTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
+    relationshipId: Id,
+  ): TableId | undefined;
 
   /**
    * The getRemoteRowId method gets the remote Row Id for a given local Row in a
@@ -833,7 +842,7 @@ export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
   addRemoteRowIdListener(
     relationshipId: IdOrNull,
     localRowId: IdOrNull,
-    listener: RemoteRowIdListener,
+    listener: RemoteRowIdListener<Schemas>,
   ): Id;
 
   /**
@@ -959,7 +968,7 @@ export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
   addLocalRowIdsListener(
     relationshipId: IdOrNull,
     remoteRowId: IdOrNull,
-    listener: LocalRowIdsListener,
+    listener: LocalRowIdsListener<Schemas>,
   ): Id;
 
   /**
@@ -1030,7 +1039,7 @@ export interface Relationships<Schemas extends OptionalSchemas = NoSchemas> {
   addLinkedRowIdsListener(
     relationshipId: Id,
     firstRowId: Id,
-    listener: LinkedRowIdsListener,
+    listener: LinkedRowIdsListener<Schemas>,
   ): Id;
 
   /**