@updog/data-editor 0.1.27 → 0.1.29

package/index.d.ts

@@ -2396,6 +2396,7 @@ declare class DataStore<TRow extends DataEditorRow = DataEditorRow> {
      */
     insertRowServer(row: TRow, localPosition: number, anchorRowId: TRowId | undefined, insertPosition: 'above' | 'below', columnIds: string[]): Promise<TRowId>;
     appendRows(sourceId: DataSourceId, newRows: TRow[], rowIdMap?: Map<number, TRowId>): TRowId[];
+    seedInitialChanges(assignedRowIds: TRowId[], currentRows: TRow[], changes: InitialRowChange<TRow>[]): void;
     upsertRows(sourceId: DataSourceId, newRows: TRow[], options?: {
         anchorKey?: keyof TRow;
         newRowIds?: TRowId[];
@@ -2662,14 +2663,37 @@ type DataEditorResult<TRow extends DataEditorRow = DataEditorRow> = {
         invalid: number;
     };
 };
+/**
+ * Describes the change state of a single row within a chunk, used to seed
+ * the editor with a previously saved diff on load.
+ *
+ * The client passes current-state rows via `onChunk` and attaches change
+ * descriptors to mark which rows were edited, added, or deleted in a
+ * previous session. The SDK uses these to seed DirtyTracker so the diff
+ * is visible from the first frame.
+ */
+type InitialRowChange<TRow extends DataEditorRow = DataEditorRow> = {
+    /** Index of this row within the chunk's rows array. */
+    index: number;
+    /**
+     * Original field values before the user's edits.
+     * Only include fields that differ from the current row.
+     * Presence of this field marks the row as "edited".
+     */
+    originalValues?: Partial<TRow>;
+    /** Marks this row as a new addition (not from backend). */
+    isNew?: boolean;
+    /** Marks this row as pending deletion. */
+    isDeleted?: boolean;
+};
 /**
  * Options used to tag a chunk passed to `loadData`'s `onChunk` callback.
- * Sources are auto-registered on first encounter. Chunks without options go
- * to "Existing Data".
+ * Sources are auto-registered on first encounter. Chunks without options
+ * (or options without `source`) go to "Existing Data".
  */
-type ChunkSourceOptions = {
-    /** Display name for this data source. Required when tagging a source. */
-    source: string;
+type ChunkSourceOptions<TRow extends DataEditorRow = DataEditorRow> = {
+    /** Display name for this data source. When omitted, chunk goes to the default backend source. */
+    source?: string;
     /** Stable identifier. Defaults to the `source` value when omitted. */
     id?: string;
     /** Whether the user can delete this source from the editor. @default false */
@@ -2681,6 +2705,8 @@ type ChunkSourceOptions = {
      * @default false
      */
     done?: boolean;
+    /** Seed change state for specific rows in this chunk. Sparse: only rows that differ from backend. */
+    changes?: InitialRowChange<TRow>[];
 };
 type DataSourceId = string;
 type DataSourceState = {
@@ -3130,4 +3156,4 @@ declare function exportDataEditor<TRow extends DataEditorRow>(params: ExportPara
 declare function DataEditor<TRow extends DataEditorRow = DataEditorRow>(allProps: DataEditorProps<TRow>): react_jsx_runtime.JSX.Element;
 
 export { DataEditor, downloadExampleFile, exportDataEditor };
-export type { CellValidator, ChatContext, ChatErrorSummary, ChatResponseChunk, ChatRow, ChatRowStatus, ChunkSourceOptions, DataEditorChat, DataEditorColumn, DataEditorFormat, DataEditorInlineProps, DataEditorLocalStorage, DataEditorModalProps, DataEditorMode, DataEditorProps, DataEditorResult, DataEditorRow, DataEditorSourceResult, DataEditorTranslations, DataEditorVariant, RemoteSource, ResultRow, UpdogError, UpdogErrorCode, ValidationError, ValueMatchInput, ValueMatchOutput };
+export type { CellValidator, ChatContext, ChatErrorSummary, ChatResponseChunk, ChatRow, ChatRowStatus, ChunkSourceOptions, DataEditorChat, DataEditorColumn, DataEditorFormat, DataEditorInlineProps, DataEditorLocalStorage, DataEditorModalProps, DataEditorMode, DataEditorProps, DataEditorResult, DataEditorRow, DataEditorSourceResult, DataEditorTranslations, DataEditorVariant, InitialRowChange, RemoteSource, ResultRow, UpdogError, UpdogErrorCode, ValidationError, ValueMatchInput, ValueMatchOutput };