@tanstack/db 0.0.7 → 0.0.9

package/dist/esm/types.d.ts

@@ -17,36 +17,41 @@ export type UtilsRecord = Record<string, Fn>;
  */
 export interface PendingMutation<T extends object = Record<string, unknown>> {
     mutationId: string;
-    original: Record<string, unknown>;
-    modified: Record<string, unknown>;
-    changes: Record<string, unknown>;
+    original: Partial<T>;
+    modified: T;
+    changes: Partial<T>;
+    globalKey: string;
     key: any;
     type: OperationType;
     metadata: unknown;
     syncMetadata: Record<string, unknown>;
     createdAt: Date;
     updatedAt: Date;
-    collection: Collection<T>;
+    collection: Collection<T, any>;
 }
 /**
  * Configuration options for creating a new transaction
  */
-export type MutationFnParams = {
-    transaction: Transaction;
+export type MutationFnParams<T extends object = Record<string, unknown>> = {
+    transaction: TransactionWithMutations<T>;
 };
-export type MutationFn = (params: MutationFnParams) => Promise<any>;
+export type MutationFn<T extends object = Record<string, unknown>> = (params: MutationFnParams<T>) => Promise<any>;
+/**
+ * Represents a non-empty array (at least one element)
+ */
+export type NonEmptyArray<T> = [T, ...Array<T>];
 /**
  * Utility type for a Transaction with at least one mutation
  * This is used internally by the Transaction.commit method
  */
-export type TransactionWithMutations<T extends object = Record<string, unknown>> = Transaction & {
-    mutations: [PendingMutation<T>, ...Array<PendingMutation<T>>];
+export type TransactionWithMutations<T extends object = Record<string, unknown>> = Transaction<T> & {
+    mutations: NonEmptyArray<PendingMutation<T>>;
 };
-export interface TransactionConfig {
+export interface TransactionConfig<T extends object = Record<string, unknown>> {
     /** Unique identifier for the transaction */
     id?: string;
     autoCommit?: boolean;
-    mutationFn: MutationFn;
+    mutationFn: MutationFn<T>;
     /** Custom metadata to associate with the transaction */
     metadata?: Record<string, unknown>;
 }
@@ -56,9 +61,9 @@ type Value<TExtensions = never> = string | number | boolean | bigint | null | TE
 };
 export type Row<TExtensions = never> = Record<string, Value<TExtensions>>;
 export type OperationType = `insert` | `update` | `delete`;
-export interface SyncConfig<T extends object = Record<string, unknown>> {
+export interface SyncConfig<T extends object = Record<string, unknown>, TKey extends string | number = string | number> {
     sync: (params: {
-        collection: Collection<T>;
+        collection: Collection<T, TKey>;
         begin: () => void;
         write: (message: Omit<ChangeMessage<T>, `key`>) => void;
         commit: () => void;
@@ -69,8 +74,8 @@ export interface SyncConfig<T extends object = Record<string, unknown>> {
      */
     getSyncMetadata?: () => Record<string, unknown>;
 }
-export interface ChangeMessage<T extends object = Record<string, unknown>> {
-    key: any;
+export interface ChangeMessage<T extends object = Record<string, unknown>, TKey extends string | number = string | number> {
+    key: TKey;
     value: T;
     previousValue?: T;
     type: OperationType;
@@ -101,9 +106,9 @@ export interface OperationConfig {
 export interface InsertConfig {
     metadata?: Record<string, unknown>;
 }
-export interface CollectionConfig<T extends object = Record<string, unknown>> {
+export interface CollectionConfig<T extends object = Record<string, unknown>, TKey extends string | number = string | number> {
     id?: string;
-    sync: SyncConfig<T>;
+    sync: SyncConfig<T, TKey>;
     schema?: StandardSchema<T>;
     /**
      * Function to extract the ID from an object
@@ -112,27 +117,27 @@ export interface CollectionConfig<T extends object = Record<string, unknown>> {
      * @returns The ID string for the item
      * @example
      * // For a collection with a 'uuid' field as the primary key
-     * getId: (item) => item.uuid
+     * getKey: (item) => item.uuid
      */
-    getId: (item: T) => any;
+    getKey: (item: T) => TKey;
     /**
      * Optional asynchronous handler function called before an insert operation
      * @param params Object containing transaction and mutation information
      * @returns Promise resolving to any value
      */
-    onInsert?: MutationFn;
+    onInsert?: MutationFn<T>;
     /**
      * Optional asynchronous handler function called before an update operation
      * @param params Object containing transaction and mutation information
      * @returns Promise resolving to any value
      */
-    onUpdate?: MutationFn;
+    onUpdate?: MutationFn<T>;
     /**
      * Optional asynchronous handler function called before a delete operation
      * @param params Object containing transaction and mutation information
      * @returns Promise resolving to any value
      */
-    onDelete?: MutationFn;
+    onDelete?: MutationFn<T>;
 }
 export type ChangesPayload<T extends object = Record<string, unknown>> = Array<ChangeMessage<T>>;
 /**
@@ -159,3 +164,4 @@ export type KeyedNamespacedRow = [unknown, NamespacedRow];
  * a `select` clause.
  */
 export type NamespacedAndKeyedStream = IStreamBuilder<KeyedNamespacedRow>;
+export type ChangeListener<T extends object = Record<string, unknown>, TKey extends string | number = string | number> = (changes: Array<ChangeMessage<T, TKey>>) => void;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@tanstack/db",
   "description": "A reactive client store for building super fast apps on sync",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "dependencies": {
-    "@electric-sql/d2ts": "^0.1.6",
+    "@electric-sql/d2ts": "^0.1.7",
     "@standard-schema/spec": "^1.0.0",
     "@tanstack/store": "^0.7.0"
   },