@tanstack/db 0.0.4 → 0.0.6

package/dist/esm/types.d.ts

@@ -1,3 +1,4 @@
+import { IStreamBuilder } from '@electric-sql/d2ts';
 import { Collection } from './collection.js';
 import { StandardSchemaV1 } from '@standard-schema/spec';
 import { Transaction } from './transactions.js';
@@ -11,7 +12,7 @@ export interface PendingMutation<T extends object = Record<string, unknown>> {
     original: Record<string, unknown>;
     modified: Record<string, unknown>;
     changes: Record<string, unknown>;
-    key: string;
+    key: any;
     type: OperationType;
     metadata: unknown;
     syncMetadata: Record<string, unknown>;
@@ -26,6 +27,13 @@ export type MutationFnParams = {
     transaction: Transaction;
 };
 export type MutationFn = (params: MutationFnParams) => Promise<any>;
+/**
+ * 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 interface TransactionConfig {
     /** Unique identifier for the transaction */
     id?: string;
@@ -36,7 +44,7 @@ export interface TransactionConfig {
 }
 export type { Transaction };
 type Value<TExtensions = never> = string | number | boolean | bigint | null | TExtensions | Array<Value<TExtensions>> | {
-    [key: string]: Value<TExtensions>;
+    [key: string | number | symbol]: Value<TExtensions>;
 };
 export type Row<TExtensions = never> = Record<string, Value<TExtensions>>;
 export type OperationType = `insert` | `update` | `delete`;
@@ -44,17 +52,17 @@ export interface SyncConfig<T extends object = Record<string, unknown>> {
     sync: (params: {
         collection: Collection<T>;
         begin: () => void;
-        write: (message: ChangeMessage<T>) => void;
+        write: (message: Omit<ChangeMessage<T>, `key`>) => void;
         commit: () => void;
     }) => void;
     /**
      * Get the sync metadata for insert operations
-     * @returns Record containing primaryKey and relation information
+     * @returns Record containing relation information
      */
     getSyncMetadata?: () => Record<string, unknown>;
 }
 export interface ChangeMessage<T extends object = Record<string, unknown>> {
-    key: string;
+    key: any;
     value: T;
     previousValue?: T;
     type: OperationType;
@@ -83,12 +91,63 @@ export interface OperationConfig {
     metadata?: Record<string, unknown>;
 }
 export interface InsertConfig {
-    key?: string | Array<string | undefined>;
     metadata?: Record<string, unknown>;
 }
 export interface CollectionConfig<T extends object = Record<string, unknown>> {
-    id: string;
+    id?: string;
     sync: SyncConfig<T>;
     schema?: StandardSchema<T>;
+    /**
+     * Function to extract the ID from an object
+     * This is required for update/delete operations which now only accept IDs
+     * @param item The item to extract the ID from
+     * @returns The ID string for the item
+     * @example
+     * // For a collection with a 'uuid' field as the primary key
+     * getId: (item) => item.uuid
+     */
+    getId: (item: T) => any;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
 }
 export type ChangesPayload<T extends object = Record<string, unknown>> = Array<ChangeMessage<T>>;
+/**
+ * An input row from a collection
+ */
+export type InputRow = [unknown, Record<string, unknown>];
+/**
+ * A keyed stream is a stream of rows
+ * This is used as the inputs from a collection to a query
+ */
+export type KeyedStream = IStreamBuilder<InputRow>;
+/**
+ * A namespaced row is a row withing a pipeline that had each table wrapped in its alias
+ */
+export type NamespacedRow = Record<string, Record<string, unknown>>;
+/**
+ * A keyed namespaced row is a row with a key and a namespaced row
+ * This is the main representation of a row in a query pipeline
+ */
+export type KeyedNamespacedRow = [unknown, NamespacedRow];
+/**
+ * A namespaced and keyed stream is a stream of rows
+ * This is used throughout a query pipeline and as the output from a query without
+ * a `select` clause.
+ */
+export type NamespacedAndKeyedStream = IStreamBuilder<KeyedNamespacedRow>;

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.4",
+  "version": "0.0.6",
   "dependencies": {
-    "@electric-sql/d2ts": "^0.1.5",
+    "@electric-sql/d2ts": "^0.1.6",
     "@standard-schema/spec": "^1.0.0",
     "@tanstack/store": "^0.7.0"
   },