@updog/data-editor 0.1.87 → 0.1.89

package/index.d.ts

@@ -411,6 +411,8 @@ declare var export_default = {
     validation: {
       alreadyExists: "Already exists in your database",
       endDateBeforeStart: "End date must be after start date",
+      invalidCountry: "Invalid country",
+      invalidCurrency: "Invalid currency",
       invalidDate: "Invalid date",
       invalidEmail: "Invalid email address",
       invalidFormat: "Invalid format",
@@ -537,6 +539,8 @@ declare var export_default = {
         showAll: "Show all",
         showMatched: "Show matched",
         allMatched: "All values are matched",
+        corrected: "Corrected",
+        possibleMatch: "Possible match",
         tooManyValues: "Showing first {{shown}} of {{total}} values",
         unmatchedWarning:
           "Unmatched values won't be imported. Match this value to keep the data. You can edit values after importing.",
@@ -792,6 +796,47 @@ type MultiSelectEditorCell = {
     /** Splits a raw imported cell and joins on export. Omitted: import auto-detects, export joins with `", "`. */
     delimiter?: string;
 };
+/**
+ * Country cell. Stores the ISO 3166-1 alpha-2 code in upper case; the screen
+ * shows the country name in the interface language. The list is the 249
+ * assigned ISO codes plus `XK` for Kosovo, which ISO does not assign.
+ */
+type CountryEditorCell = {
+    type: "country";
+    /** Pick zero or more countries; the stored value becomes `string[]`. */
+    multiple?: boolean;
+    /**
+     * Let users add a value the list has not got. Defaults to **false** — the
+     * country list is closed until the client opens it. A created value reaches
+     * `onComplete` next to `DE` and `FR` with no code of its own.
+     */
+    enableCustomValue?: boolean;
+    /** Splits a raw imported cell and joins on export, when `multiple`. Omitted:
+     * import auto-detects, export joins with `", "`. */
+    delimiter?: string;
+    /**
+     * The codes the column takes, alpha-2, in the order the dropdown shows them
+     * under `currency` and before the name sort under `country`. A code the ISO
+     * list has not got is dropped with a warning. Omitted: the whole list.
+     */
+    only?: string[];
+};
+/**
+ * Currency cell. Stores the ISO 4217 code in upper case and shows it as is;
+ * the list is the 178 codes of the current ISO list. Reads codes, numeric
+ * codes, names in 26 languages, ISO names and symbols on the way in.
+ */
+type CurrencyEditorCell = {
+    type: "currency";
+    /**
+     * Let users add a value the list has not got. Defaults to **false** — the
+     * currency list is closed until the client opens it. A created value reaches
+     * `onComplete` next to `USD` and `EUR` with no code of its own.
+     */
+    enableCustomValue?: boolean;
+    /** The ISO 4217 codes the column takes, in the order the dropdown shows them. */
+    only?: string[];
+};
 /** Number input cell with locale-aware formatting. Bounds and decimal digits come from the column's `{ type: "number" }` validator. */
 type NumberEditorCell = {
     type: "number";
@@ -808,9 +853,11 @@ type NumberEditorCell = {
  * - `"time"` — plain text input for a time of day; the column is checked against `{ type: "time" }`.
  * - `"select"` — dropdown with a fixed list of options.
  * - `"multiselect"` — dropdown allowing zero or more options; stored as `string[]`.
+ * - `"country"` — dropdown over the ISO country list; stores the alpha-2 code, shows the name.
+ * - `"currency"` — dropdown over the ISO 4217 list; stores and shows the three-letter code.
  * - `"number"` — number input with locale-aware formatting.
  */
-type CellEditor = TextEditorCell | DateEditorCell | TimeEditorCell | SelectEditorCell | MultiSelectEditorCell | NumberEditorCell;
+type CellEditor = TextEditorCell | DateEditorCell | TimeEditorCell | SelectEditorCell | MultiSelectEditorCell | CountryEditorCell | CurrencyEditorCell | NumberEditorCell;
 /** Dropdown filter shown in the sidebar Filters panel. */
 type SelectColumnFilter = {
     type: "select";
@@ -941,6 +988,16 @@ type BuiltInValidator = {
     type: "oneOf";
     values: string[];
     message?: string;
+}
+/** The cell holds a code from the country list. Implicit on every country column. */
+ | {
+    type: "country";
+    message?: string;
+}
+/** The cell holds a code from the currency list. Implicit on every currency column. */
+ | {
+    type: "currency";
+    message?: string;
 } | {
     type: "number";
     /** Inclusive lower bound. */
@@ -1206,12 +1263,30 @@ type DataEditorChat<TRow extends DataEditorRow = DataEditorRow> = {
     onCancel?: () => void;
 };
 
+/**
+ * The parts of a column every cell type reads. Both `DataEditorColumn` and
+ * `NormalizedColumn` satisfy it, so core and the UI pass the column they hold.
+ */
+type TypedColumn = Pick<DataEditorColumn, "id" | "editor" | "formatter"> & {
+    /** Values the person created at the screen; `options()` lists them after
+     * the column's own. */
+    addedOptions?: readonly string[];
+};
+type FormatContext = {
+    locale: string | null;
+    t: TFunction | null;
+};
+type ColumnFormat = {
+    readonly typeId: string;
+    readonly candidateId: string;
+};
+
 /**
  * Categories of internal errors surfaced through the `onError` callback.
  * `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
@@ -1243,16 +1318,6 @@ declare class ErrorHandler {
     handleError(error: UpdogError): void;
 }
 
-/**
- * The parts of a column every cell type reads. Both `DataEditorColumn` and
- * `NormalizedColumn` satisfy it, so core and the UI pass the column they hold.
- */
-type TypedColumn = Pick<DataEditorColumn, "id" | "editor" | "formatter">;
-type ColumnFormat = {
-    readonly typeId: string;
-    readonly candidateId: string;
-};
-
 type FormatScope = string;
 type FormatField = {
     key: string;
@@ -1391,6 +1456,7 @@ type NormalizedColumn = Omit<DataEditorColumn, "validators"> & {
     numberConfig?: NumberConfig;
     dateConfig?: DateConfig;
     timeConfig?: TimeConfig;
+    addedOptions?: readonly string[];
 };
 type NumberConfig = {
     min?: number;
@@ -1495,7 +1561,7 @@ type IFilterEngine<TRow extends DataEditorRow = DataEditorRow> = {
     getWordsPerRow(): number;
     getShowOnlyDeletedRows(): boolean;
     getSortState(): SortState;
-    setColumns(columns: DataEditorColumn[]): void;
+    setColumns(columns: DataEditorColumn[], ctx?: FormatContext): void;
     setFilters(filters: Partial<Filters>): void;
     setSortState(state: SortState, sortType?: SortType, locales?: string[]): Promise<void>;
     updateRowText(rowId: TRowId, row: TRow): void;
@@ -1923,10 +1989,12 @@ type SelectionRect = {
     readonly rowIds: readonly TRowId[];
 };
 
-type MultiSelectEditorConfig = {
+/** What a list column's type answers, gathered by the caller: the options,
+ * the declared delimiter if any, and whether a value outside the list stays. */
+type ListCell = {
     options: string[];
     delimiter?: string;
-    enableCustomValue?: boolean;
+    allowsCustom: boolean;
 };
 
 /**
@@ -1946,7 +2014,7 @@ type MultiSelectEditorConfig = {
 
 type MultiSelectTarget = {
     delimiter: string;
-    editor: MultiSelectEditorConfig;
+    editor: ListCell;
 };
 type PasteSpec = {
     sourceColumnIds: string[];
@@ -2051,6 +2119,10 @@ declare class DataStore<TRow extends DataEditorRow = DataEditorRow> {
     getRowId(index: number): TRowId | undefined;
     getLocalRowCount(): number;
     setValidator(validator: IValidator<TRow>): void;
+    /**
+     * The filter engine printed its formatters with the language it had when
+     * the columns arrived, and the columns arrive before the language does.
+     */
     setI18n(i18n: {
         t: TFunction;
         locale: string;
@@ -2170,7 +2242,7 @@ declare class DataStore<TRow extends DataEditorRow = DataEditorRow> {
      * has already normalised through buildImportRow — never transforms twice.
      */
     appendClientRows(sourceId: DataSourceId, newRows: TRow[]): TRowId[];
-    private formatContext;
+    getFormatContext(): FormatContext;
     /**
      * A column nothing separated is a signal to whoever integrated the SDK, so
      * it goes out in English through `onError` rather than to the person at the
@@ -2178,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
@@ -2397,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";
@@ -2888,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`
@@ -3082,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 };