tinybase 5.0.0-beta.1 → 5.0.0-beta.3

package/lib/types/tinybase.d.ts

@@ -10,4 +10,5 @@ export * from './metrics.d';
 export * from './persisters.d';
 export * from './queries.d';
 export * from './relationships.d';
+export * from './mergeable-store.d';
 export * from './store.d';

package/lib/types/tools.d.ts

@@ -417,7 +417,7 @@ export interface Tools {
    *   await createTools(store).getPrettyStoreApi('shop');
    *
    * const dTsLines = dTs.split('\n');
-   * console.log(dTsLines[17]);
+   * console.log(dTsLines[15]);
    * // -> `export type Tables = {pets?: {[rowId: Id]: {price?: number}}};`
    *
    * const tsLines = ts.split('\n');
@@ -437,7 +437,7 @@ export interface Tools {
    *   await createTools(store).getPrettyStoreApi('shop');
    *
    * const dTsLines = dTs.split('\n');
-   * console.log(dTsLines[17]);
+   * console.log(dTsLines[15]);
    * // -> 'export type Tables = {pets?: {[rowId: Id]: {price: number}}};'
    *
    * const tsLines = ts.split('\n');

package/lib/types/ui-react.d.ts

@@ -212,6 +212,7 @@ export type UndoOrRedoInformation = [boolean, Callback, Id | undefined, string];
  * useSetTableCallback hook or useSetRowCallback hook - so that the Id arguments
  * of the object to set can also be dependent on the event or parameter
  * provided (as well as the object itself being set).
+ * @category Identity
  */
 export type GetId<Parameter> = (parameter: Parameter, store: Store) => Id;
 

package/lib/types/with-schemas/internal/store.d.ts

@@ -1,7 +1,9 @@
 import {
   Cell,
+  OptionalSchemas,
   OptionalTablesSchema,
   OptionalValuesSchema,
+  Store,
   Value,
 } from '../store';
 import {Id} from '../common';
@@ -100,3 +102,5 @@ export type Truncate<Params> = Params extends [...infer ShorterParams, any]
   : never;
 
 export type NoInfer<Type> = [Type][Type extends any ? 0 : never];
+
+export type StoreAlias<Schemas extends OptionalSchemas> = Store<Schemas>;

package/lib/types/with-schemas/mergeable-store.d.ts

@@ -0,0 +1,112 @@
+/**
+ * The mergeable-store module
+ * @packageDocumentation
+ * @module mergeable-store
+ */
+
+import {
+  Cell,
+  NoSchemas,
+  OptionalSchemas,
+  OptionalTablesSchema,
+  OptionalValuesSchema,
+  Store,
+  Value,
+} from './store.d';
+import {Id} from './common';
+import {IdObj} from '../../common/obj';
+
+/**
+ * The Time type
+ * @category Stamps
+ */
+export type Time = string;
+
+/**
+ * The Stamp type
+ * @category Stamps
+ */
+export type Stamp<Thing> = [time: Time, thing: Thing];
+
+type MergeableCell<Schema extends OptionalTablesSchema> = Stamp<Cell<
+  Schema,
+  any,
+  any
+> | null>;
+type MergeableRow<Schema extends OptionalTablesSchema> = Stamp<IdObj<
+  MergeableCell<Schema>
+> | null>;
+type MergeableTable<Schema extends OptionalTablesSchema> = Stamp<IdObj<
+  MergeableRow<Schema>
+> | null>;
+type MergeableTables<Schema extends OptionalTablesSchema> = Stamp<
+  IdObj<MergeableTable<Schema>>
+>;
+type MergeableValue<Schema extends OptionalValuesSchema> = Stamp<Value<
+  Schema,
+  any,
+  any
+> | null>;
+type MergeableValues<Schema extends OptionalValuesSchema> = Stamp<
+  IdObj<MergeableValue<Schema>>
+>;
+
+/**
+ * The MergeableContent type
+ * @category Mergeable
+ */
+export type MergeableContent<Schemas extends OptionalSchemas> = Stamp<
+  [
+    mergeableTables: MergeableTables<Schemas[0]>,
+    mergeableValues: MergeableValues<Schemas[1]>,
+  ]
+>;
+
+/**
+ * The MergeableChanges type
+ * @category Mergeable
+ */
+export type MergeableChanges<Schemas extends OptionalSchemas> =
+  MergeableContent<Schemas>;
+
+/**
+ * The MergeableStore type
+ * @category Mergeable
+ */
+export interface MergeableStore<Schemas extends OptionalSchemas>
+  extends Store<Schemas> {
+  //
+  /**
+   * The merge method
+   * @category Merging
+   */
+  merge(mergeableStore: MergeableStore<Schemas>): MergeableStore<Schemas>;
+
+  /**
+   * The getMergeableContent method
+   * @category Merging
+   */
+  getMergeableContent(): MergeableContent<Schemas>;
+
+  /**
+   * The setMergeableContent method
+   * @category Merging
+   */
+  setMergeableContent(
+    mergeableContent: MergeableContent<Schemas>,
+  ): MergeableStore<Schemas>;
+
+  /**
+   * The applyMergeableChanges method
+   * @category Merging
+   */
+  applyMergeableChanges(
+    mergeableChanges: MergeableChanges<Schemas>,
+  ): MergeableStore<Schemas>;
+}
+
+/**
+ * The createMergeableStore function
+ * @category Creation
+ */
+export function createMergeableStore(id: Id): MergeableStore<NoSchemas>;

package/lib/types/with-schemas/persisters/persister-automerge.d.ts

@@ -12,7 +12,7 @@
  */
 
 import {OptionalSchemas, Store} from '../store';
-import {DocHandle} from 'automerge-repo';
+import {DocHandle} from '@automerge/automerge-repo';
 import {Persister} from '../persisters';
 
 /**
@@ -21,6 +21,7 @@ import {Persister} from '../persisters';
  *
  * It simply provides an extra getDocHandle method for accessing the Automerge
  * document handler the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface AutomergePersister<Schemas extends OptionalSchemas>
@@ -86,7 +87,7 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
  * await persister.save();
  * // Store will be saved to the document.
  *
- * console.log(docHandler.doc);
+ * console.log(await docHandler.doc());
  * // -> {tinybase: {t: {pets: {fido: {species: 'dog'}}}, v: {}}}
  *
  * persister.destroy();
@@ -102,7 +103,7 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
  *   network: [new BroadcastChannelNetworkAdapter()],
  * });
  * const docHandler1 = repo1.create();
- * await docHandler1.value();
+ * await docHandler1.doc();
  * const store1 = createStore();
  * const persister1 = createAutomergePersister(store1, docHandler1);
  * await persister1.startAutoLoad();
@@ -113,7 +114,7 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
  *   network: [new BroadcastChannelNetworkAdapter()],
  * });
  * const docHandler2 = repo2.find(docHandler1.documentId);
- * await docHandler2.value();
+ * await docHandler2.doc();
  * const store2 = createStore();
  * const persister2 = createAutomergePersister(store2, docHandler2);
  * await persister2.startAutoLoad();
@@ -122,9 +123,9 @@ export interface AutomergePersister<Schemas extends OptionalSchemas>
  * // A function that waits briefly and then for the documents to synchronize
  * // with each other, merely for the purposes of sequentiality in this example.
  * const syncDocsWait = async () => {
- *   await new Promise((resolve) => setTimeout(() => resolve(0), 10));
- *   await docHandler1.value();
- *   await docHandler2.value();
+ *   await new Promise((resolve) => setTimeout(() => resolve(0), 100));
+ *   await docHandler1.doc();
+ *   await docHandler2.doc();
  * };
  *
  * // Wait for the documents to synchronize in their initial state.

package/lib/types/with-schemas/persisters/persister-browser.d.ts

@@ -23,6 +23,7 @@ import {Persister} from '../persisters';
  *
  * It simply provides an extra getStorageName method for accessing the unique
  * key of the storage location the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface SessionPersister<Schemas extends OptionalSchemas>
@@ -55,6 +56,7 @@ export interface SessionPersister<Schemas extends OptionalSchemas>
  *
  * It simply provides an extra getStorageName method for accessing the unique
  * key of the storage location the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface LocalPersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-cr-sqlite-wasm.d.ts

@@ -18,6 +18,7 @@ import {DB} from '@vlcn.io/crsqlite-wasm';
  *
  * It simply provides an extra getDb method for accessing a reference to the
  * database instance the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface CrSqliteWasmPersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-electric-sql.d.ts

@@ -18,6 +18,7 @@ import {ElectricClient} from 'electric-sql/client/model';
  *
  * It simply provides an extra getElectricClient method for accessing a
  * reference to the Electric client the Store is being persisted to.
+ * @category Persister
  * @since v4.6.0
  */
 export interface ElectricSqlPersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-expo-sqlite-next.d.ts

@@ -30,6 +30,7 @@ import {SQLiteDatabase} from 'expo-sqlite/next';
  *
  * It simply provides an extra getDb method for accessing a reference to the
  * database instance the Store is being persisted to.
+ * @category Persister
  * @since v4.5.0
  */
 export interface ExpoSqliteNextPersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-expo-sqlite.d.ts

@@ -29,6 +29,7 @@ import {SQLiteDatabase} from 'expo-sqlite';
  *
  * It simply provides an extra getDb method for accessing a reference to the
  * database instance the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-file.d.ts

@@ -14,6 +14,7 @@ import {Persister} from '../persisters';
  *
  * It simply provides an extra getFilePath method for accessing the location of
  * the local file the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface FilePersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-indexed-db.d.ts

@@ -15,6 +15,7 @@ import {Persister} from '../persisters';
  *
  * It simply provides an extra getDbName method for accessing the unique key of
  * the IndexedDB the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface IndexedDbPersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-partykit-client.d.ts

@@ -29,6 +29,7 @@ import {Persister} from '../persisters';
  *
  * It simply provides an extra getConnection method for accessing the
  * PartySocket the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface PartyKitPersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-partykit-server.d.ts

@@ -21,14 +21,13 @@
 import {
   Cell,
   CellOrUndefined,
+  Changes,
+  Content,
   NoTablesSchema,
   NoValuesSchema,
   OptionalSchemas,
-  Tables,
-  TransactionChanges,
   Value,
   ValueOrUndefined,
-  Values,
 } from '../store';
 import {Connection, Party, Request, Server} from 'partykit/server';
 import {Id} from '../common';
@@ -149,6 +148,11 @@ export type TinyBasePartyKitServerConfig = {
  * @since v4.3.0
  */
 export class TinyBasePartyKitServer implements Server {
+  /**
+   * The constructor is used to create the server.
+   * @category Creation
+   * @since v4.3.9
+   */
   constructor(party: Party);
   /**
    * The config property is used to optionally configure the server, using an
@@ -590,7 +594,7 @@ export function hasStoreInStorage(
  * loadStoreFromStorage(
  *   storage: Storage,
  *   storagePrefix?: string,
- * ): Promise<[Tables, Values]>;
+ * ): Promise<Content>;
  * ```
  *
  * This is intended for specialist applications that require the ability to
@@ -611,18 +615,18 @@ export function hasStoreInStorage(
 export function loadStoreFromStorage<Schemas extends OptionalSchemas>(
   storage: Storage,
   storagePrefix?: string,
-): Promise<[Tables<Schemas[0]>, Values<Schemas[1]>]>;
+): Promise<Content<Schemas>>;
 
 /**
- * The broadcastTransactionChanges function allows you to broadcast Store
+ * The broadcastChanges function allows you to broadcast Store
  * changes to all the client connections of a TinyBasePartyKitServer.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
  * ```ts override
- * broadcastTransactionChanges(
+ * broadcastChanges(
  *   server: TinyBasePartyKitServer,
- *   transactionChanges: TransactionChanges,
+ *   changes: Changes,
  *   without?: string[],
  * ): Promise<void>;
  * ```
@@ -633,15 +637,15 @@ export function loadStoreFromStorage<Schemas extends OptionalSchemas>(
  * The function is asynchronous, so you should use the `await` keyword or handle
  * its completion as a promise.
  * @param server A reference to the TinyBasePartyKitServer object.
- * @param transactionChanges The Store changes to broadcast to the server's
+ * @param changes The Store changes to broadcast to the server's
  * clients.
  * @param without An optional array of client connection Ids to exclude from the
  * broadcast.
  * @category Connection
  * @since v4.5.1
  */
-export function broadcastTransactionChanges<Schemas extends OptionalSchemas>(
+export function broadcastChanges<Schemas extends OptionalSchemas>(
   server: TinyBasePartyKitServer,
-  transactionChanges: TransactionChanges<Schemas>,
+  changes: Changes<Schemas>,
   without?: string[],
 ): Promise<void>;

package/lib/types/with-schemas/persisters/persister-remote.d.ts

@@ -15,6 +15,7 @@ import {Persister} from '../persisters';
  *
  * It simply provides an extra getUrls method for accessing the URLs the Store
  * is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface RemotePersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-sqlite-wasm.d.ts

@@ -17,6 +17,7 @@ import {OptionalSchemas, Store} from '../store';
  *
  * It simply provides an extra getDb method for accessing a reference to the
  * database instance the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface SqliteWasmPersister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-sqlite3.d.ts

@@ -18,6 +18,7 @@ import {Database} from 'sqlite3';
  *
  * It simply provides an extra getDb method for accessing a reference to the
  * database instance the Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface Sqlite3Persister<Schemas extends OptionalSchemas>

package/lib/types/with-schemas/persisters/persister-yjs.d.ts

@@ -20,6 +20,7 @@ import {Doc as YDoc} from 'yjs';
  *
  * It simply provides an extra getYDoc method for accessing the Yjs document the
  * Store is being persisted to.
+ * @category Persister
  * @since v4.3.14
  */
 export interface YjsPersister<Schemas extends OptionalSchemas>