tinybase 6.0.0-beta.2 → 6.0.0

package/@types/relationships/index.d.cts

@@ -10,9 +10,8 @@
  * @module relationships
  * @since v1.0.0
  */
-
-import type {GetCell, RowCallback, Store} from '../store/index.d.cts';
 import type {Id, IdOrNull, Ids} from '../common/index.d.cts';
+import type {GetCell, RowCallback, Store} from '../store/index.d.cts';
 
 /**
  * The Relationship type represents the concept of a map that connects one Row
@@ -200,6 +199,7 @@ export type RelationshipsListenerStats = {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', next: 'felix'},
@@ -308,6 +308,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -339,6 +340,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -377,6 +379,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -417,6 +420,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -443,6 +447,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore())
    *   .setRelationshipDefinition('petSpecies', 'pets', 'species', 'species')
    *   .setRelationshipDefinition('petSequence', 'pets', 'pets', 'next');
@@ -471,6 +476,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -509,6 +515,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(
    *   createStore(),
    * ).setRelationshipDefinition('petSpecies', 'pets', 'species', 'species');
@@ -537,6 +544,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -570,6 +578,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -605,6 +614,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -653,6 +663,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -706,6 +717,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -750,6 +762,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -817,6 +830,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -860,6 +874,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -951,6 +966,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -993,6 +1009,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -1080,6 +1097,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -1134,6 +1152,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1189,6 +1208,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1238,6 +1258,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const relationships = createRelationships(store);
    * relationships.addRemoteRowIdListener(null, null, () => {
@@ -1274,6 +1295,7 @@ export interface Relationships {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const relationships = createRelationships(store);
  * console.log(relationships.getRelationshipIds());
@@ -1285,6 +1307,7 @@ export interface Relationships {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const relationships1 = createRelationships(store);
  * const relationships2 = createRelationships(store);

package/@types/relationships/index.d.ts

@@ -10,9 +10,8 @@
  * @module relationships
  * @since v1.0.0
  */
-
-import type {GetCell, RowCallback, Store} from '../store/index.d.ts';
 import type {Id, IdOrNull, Ids} from '../common/index.d.ts';
+import type {GetCell, RowCallback, Store} from '../store/index.d.ts';
 
 /**
  * The Relationship type represents the concept of a map that connects one Row
@@ -200,6 +199,7 @@ export type RelationshipsListenerStats = {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', next: 'felix'},
@@ -308,6 +308,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -339,6 +340,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -377,6 +379,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -417,6 +420,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -443,6 +447,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore())
    *   .setRelationshipDefinition('petSpecies', 'pets', 'species', 'species')
    *   .setRelationshipDefinition('petSequence', 'pets', 'pets', 'next');
@@ -471,6 +476,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -509,6 +515,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(
    *   createStore(),
    * ).setRelationshipDefinition('petSpecies', 'pets', 'species', 'species');
@@ -537,6 +544,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -570,6 +578,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -605,6 +614,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -653,6 +663,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -706,6 +717,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -750,6 +762,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -817,6 +830,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -860,6 +874,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -951,6 +966,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -993,6 +1009,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -1080,6 +1097,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -1134,6 +1152,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1189,6 +1208,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1238,6 +1258,7 @@ export interface Relationships {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const relationships = createRelationships(store);
    * relationships.addRemoteRowIdListener(null, null, () => {
@@ -1274,6 +1295,7 @@ export interface Relationships {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const relationships = createRelationships(store);
  * console.log(relationships.getRelationshipIds());
@@ -1285,6 +1307,7 @@ export interface Relationships {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const relationships1 = createRelationships(store);
  * const relationships2 = createRelationships(store);

package/@types/relationships/with-schemas/index.d.cts

@@ -10,11 +10,11 @@
  * @module relationships
  * @since v1.0.0
  */
-
 import type {
   CellIdFromSchema,
   TableIdFromSchema,
 } from '../../_internal/store/with-schemas/index.d.cts';
+import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.cts';
 import type {
   GetCell,
   OptionalSchemas,
@@ -22,7 +22,6 @@ import type {
   RowCallback,
   Store,
 } from '../../store/with-schemas/index.d.cts';
-import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.cts';
 
 /**
  * The Relationship type represents the concept of a map that connects one Row
@@ -257,6 +256,7 @@ export type RelationshipsListenerStats = {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', next: 'felix'},
@@ -375,6 +375,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -406,6 +407,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -452,6 +454,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -498,6 +501,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -524,6 +528,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore())
    *   .setRelationshipDefinition('petSpecies', 'pets', 'species', 'species')
    *   .setRelationshipDefinition('petSequence', 'pets', 'pets', 'next');
@@ -558,6 +563,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -598,6 +604,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(
    *   createStore(),
    * ).setRelationshipDefinition('petSpecies', 'pets', 'species', 'species');
@@ -632,6 +639,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -673,6 +681,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -710,6 +719,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -758,6 +768,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -811,6 +822,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -861,6 +873,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -938,6 +951,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -981,6 +995,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -1082,6 +1097,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1124,6 +1140,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -1221,6 +1238,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -1281,6 +1299,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1336,6 +1355,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1385,6 +1405,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    *
    * ```js
    * import {createRelationships, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const relationships = createRelationships(store);
    * relationships.addRemoteRowIdListener(null, null, () => {
@@ -1426,6 +1447,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const relationships = createRelationships(store);
  * console.log(relationships.getRelationshipIds());
@@ -1437,6 +1459,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
  *
  * ```js
  * import {createRelationships, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const relationships1 = createRelationships(store);
  * const relationships2 = createRelationships(store);