@updog/data-editor 0.1.88 → 0.1.89

package/index.d.ts

@@ -1286,7 +1286,7 @@ type ColumnFormat = {
  * `license.*` codes cover license validation failures (previously a separate
  * `LicenseErrorCode` enum).
  */
-type UpdogErrorCode = "PARSE_ERROR" | "RENDER_ERROR" | "TRANSFORM_ERROR" | "VALIDATION_ERROR" | "WORKER_ERROR" | "COMMAND_ERROR" | "OPERATION_ERROR" | "license.invalid" | "license.missing" | "license.domain_not_allowed" | "license.subscription_inactive" | "license.trial_expired";
+type UpdogErrorCode = "PARSE_ERROR" | "RENDER_ERROR" | "TRANSFORM_ERROR" | "VALIDATION_ERROR" | "WORKER_ERROR" | "COMMAND_ERROR" | "OPERATION_ERROR" | "HOOK_ERROR" | "license.invalid" | "license.missing" | "license.domain_not_allowed" | "license.subscription_inactive" | "license.trial_expired";
 /**
  * An internal error caught by the SDK and passed to `onError`. The SDK
  * recovers gracefully where possible — `onError` is for your logging and
@@ -2250,6 +2250,11 @@ declare class DataStore<TRow extends DataEditorRow = DataEditorRow> {
      * the dialog is out of scope (spec section 10).
      */
     private reportAmbiguity;
+    /**
+     * `fieldReader`, public: the value takes the column's storage shape; a
+     * field outside the schema returns it untouched.
+     */
+    readFieldValue(field: string, value: unknown): unknown;
     /**
      * The column's reader with no verdict behind it. A formula result is one
      * value, so there is nothing to vote on; the reader is here to give the
@@ -2469,6 +2474,43 @@ type ColumnDelta = {
     newValues: Map<TRowId, unknown>;
 };
 
+/** One input row: the schema shape after reading plus the raw file row. */
+type RowImportInputRow = {
+    /**
+     * Keys are your schema column ids; values went through format reading,
+     * value mapping, and the column's `transformer`.
+     */
+    row: Record<string, unknown>;
+    /**
+     * Keys are the file's headers, unmapped ones included; values are the
+     * cell texts as they appear in the file.
+     */
+    raw: Record<string, string>;
+};
+type RowImportMeta = {
+    /** Zero-based chunk number within the current workbook. */
+    chunkIndex: number;
+    /** Total number of chunks in the current workbook. */
+    chunkCount: number;
+    isLastChunk: boolean;
+    /** The workbook being imported: source name, sheet (XLSX), file headers. */
+    workbook: {
+        name: string;
+        sheetName?: string;
+        headers: string[];
+    };
+    /** This workbook's column mapping: file header → schema column id. */
+    mapping: Record<string, string | undefined>;
+    /** The `context` prop, untouched. */
+    context: unknown;
+};
+/**
+ * Chunk in, chunk out. The returned array is positional: element `i` answers
+ * `rows[i]`, `null` drops that row, elements past `rows.length` append new
+ * rows. Returning nothing leaves the chunk as it is.
+ */
+type RowImportHook = (rows: RowImportInputRow[], meta: RowImportMeta) => (Record<string, unknown> | null)[] | void | Promise<(Record<string, unknown> | null)[] | void>;
+
 /** Numeric row identifier. V8 stores small integers (Smi) inline — no heap allocation. */
 type TRowId = number;
 type SortType = "text" | "number" | "date" | "time";
@@ -2960,6 +3002,40 @@ type DataEditorBaseProps<TRow extends DataEditorRow = DataEditorRow> = {
      * ```
      */
     onValueMatch?: (valuesToMatch: Record<string, ValueMatchInput>) => ValueMatchOutput | Promise<ValueMatchOutput>;
+    /**
+     * Edit, drop, or append rows between the file and the editor. Called once
+     * per chunk of 5,000 rows of each imported workbook, after every cell went
+     * through format reading, value mapping, and the column's `transformer` —
+     * the raw file row rides along in `raw`, unmapped headers included.
+     *
+     * The returned array is positional: element `i` replaces `rows[i].row`,
+     * `null` drops that row, elements past `rows.length` append new rows.
+     * Return nothing to leave the chunk as it is. Every field the hook changed
+     * is re-read as if it came from the file — format reading, value mapping,
+     * and `transformer` run again on it.
+     *
+     * A thrown error, a timeout of 30 seconds per chunk, or an array shorter
+     * than the input counts as a failure: the chunk lands unchanged, one
+     * `HOOK_ERROR` reaches `onError`, and the hook stays off for the rest of
+     * that import run.
+     *
+     * @example
+     * ```ts
+     * // Split "USD 100" from the file's price column into two schema fields.
+     * onRowImport={(rows) =>
+     *   rows.map(({ row, raw }) => {
+     *     const [currency, amount] = (raw["price"] ?? "").split(" ");
+     *     return { ...row, currency, amount };
+     *   })
+     * }
+     * ```
+     */
+    onRowImport?: RowImportHook;
+    /**
+     * Anything you want your hooks to see: `onRowImport` receives it untouched
+     * as `meta.context`.
+     */
+    context?: unknown;
     /**
      * Extra synonyms layered on top of the built-ins, in two tables that stay
      * apart: `columns` scores a file header against your columns, `values`
@@ -3154,4 +3230,4 @@ declare function exportDataEditor<TRow extends DataEditorRow>(params: ExportPara
 declare function DataEditor<TRow extends DataEditorRow = DataEditorRow>(allProps: DataEditorProps<TRow>): react.JSX.Element;
 
 export { DataEditor, downloadExampleFile, exportDataEditor };
-export type { CellValidator, ChatContext, ChatErrorSummary, ChatResponseChunk, ChatRow, ChatRowStatus, ChunkSourceOptions, CustomImportFormat, CustomImportTable, DataEditorChat, DataEditorColumn, DataEditorFormat, DataEditorInlineProps, DataEditorLocalStorage, DataEditorModalProps, DataEditorMode, DataEditorProps, DataEditorResult, DataEditorRow, DataEditorSourceResult, DataEditorTranslations, DataEditorVariant, InitialRowChange, RemoteSource, ResultRow, UpdogError, UpdogErrorCode, ValidationError, ValueMatchInput, ValueMatchOutput };
+export type { CellValidator, ChatContext, ChatErrorSummary, ChatResponseChunk, ChatRow, ChatRowStatus, ChunkSourceOptions, CustomImportFormat, CustomImportTable, DataEditorChat, DataEditorColumn, DataEditorFormat, DataEditorInlineProps, DataEditorLocalStorage, DataEditorModalProps, DataEditorMode, DataEditorProps, DataEditorResult, DataEditorRow, DataEditorSourceResult, DataEditorTranslations, DataEditorVariant, InitialRowChange, RemoteSource, ResultRow, RowImportHook, RowImportInputRow, RowImportMeta, UpdogError, UpdogErrorCode, ValidationError, ValueMatchInput, ValueMatchOutput };