@updog/data-editor 0.1.86 → 0.1.88

package/index.d.ts

@@ -67,6 +67,8 @@ declare var export_default = {
       clearField: "Clear field",
       showPassword: "Show password",
       hidePassword: "Hide password",
+      switchToAm: "Switch to AM",
+      switchToPm: "Switch to PM",
     },
     select: {
       noResults: "No results",
@@ -409,15 +411,19 @@ 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",
       invalidNumber: "Invalid number",
       invalidOption: "Invalid option",
+      invalidTime: "Invalid time",
       outOfRange: "Out of range",
       required: "This field is required",
       structuralMismatch: "This might be in the wrong column.",
       tooManyDecimals: "Too many decimal places",
+      tooPreciseTime: "Too precise for this column",
       valueMustBeUnique: "Value must be unique",
     },
     license: {
@@ -533,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.",
@@ -708,6 +716,11 @@ type Filters = {
         min?: string;
         max?: string;
     }>;
+    /** Per-column time-of-day range filters. Key = column ID, values are canonical times. */
+    columnTimeRangeFilters: Record<string, {
+        min?: string;
+        max?: string;
+    }>;
 };
 
 /**
@@ -752,6 +765,16 @@ type TextEditorCell = {
 type DateEditorCell = {
     type: "date";
 };
+/** Time-of-day cell. Bounds come from the column's `{ type: "time" }` validator. */
+type TimeEditorCell = {
+    type: "time";
+    /**
+     * The clock the cell draws, `h23` for `18:00` and `h12` for `6:00 PM`.
+     * Defaults to the clock the reader's own browser uses. Whichever is drawn,
+     * both forms stay readable when the person types.
+     */
+    hourCycle?: "h12" | "h23";
+};
 /** Dropdown select cell. The user picks from a fixed list of options. */
 type SelectEditorCell = {
     type: "select";
@@ -773,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";
@@ -786,11 +850,14 @@ type NumberEditorCell = {
  *
  * - `"text"` — plain text input (default).
  * - `"date"` — date picker; the calendar honours the column's date validator bounds.
+ * - `"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 | 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";
@@ -815,14 +882,21 @@ type DateRangeColumnFilter = {
     /** Label displayed above the filter. */
     label?: string;
 };
+/** Time-of-day min/max range filter shown in the sidebar Filters panel. */
+type TimeRangeColumnFilter = {
+    type: "time-range";
+    /** Label displayed above the filter. */
+    label?: string;
+};
 /**
  * Filter control shown in the sidebar Filters panel for a column.
  *
  * - `"select"` — dropdown to pick one or more values.
  * - `"number-range"` — two inputs for min and max number.
  * - `"date-range"` — two date pickers for start and end date.
+ * - `"time-range"` — two time fields for the earliest and latest time of day.
  */
-type ColumnFilter = SelectColumnFilter | NumberRangeColumnFilter | DateRangeColumnFilter;
+type ColumnFilter = SelectColumnFilter | NumberRangeColumnFilter | DateRangeColumnFilter | TimeRangeColumnFilter;
 /** Lock mode for a column. `"all"` locks for every row; `"default"` locks only default-source rows. */
 type ColumnLockMode = "all" | "default";
 /**
@@ -897,6 +971,8 @@ type DataEditorColumn = {
     locked?: boolean | ColumnLockMode;
 };
 
+/** How precisely a time-of-day column is written. */
+type TimePrecision = "minutes" | "seconds" | "milliseconds";
 /**
  * A built-in declarative validator — a declarative object the SDK interprets.
  */
@@ -912,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. */
@@ -929,6 +1015,15 @@ type BuiltInValidator = {
     min?: string;
     max?: string;
     message?: string;
+} | {
+    type: "time";
+    /** Inclusive lower bound, canonical, any of the three precisions. */
+    min?: string;
+    /** Inclusive upper bound, canonical, any of the three precisions. */
+    max?: string;
+    /** The finest the column is written. A value carrying more is flagged, never trimmed. */
+    precision?: TimePrecision;
+    message?: string;
 } | {
     type: "unique";
     message?: string;
@@ -1168,6 +1263,24 @@ 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
@@ -1205,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;
@@ -1352,6 +1455,8 @@ type NormalizedColumn = Omit<DataEditorColumn, "validators"> & {
     asyncConfig?: AsyncFunctionValidator[];
     numberConfig?: NumberConfig;
     dateConfig?: DateConfig;
+    timeConfig?: TimeConfig;
+    addedOptions?: readonly string[];
 };
 type NumberConfig = {
     min?: number;
@@ -1362,6 +1467,11 @@ type DateConfig = {
     min?: string;
     max?: string;
 };
+type TimeConfig = {
+    min?: string;
+    max?: string;
+    precision?: TimePrecision;
+};
 
 type PrimaryKeyInput = string | readonly string[];
 
@@ -1451,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;
@@ -1879,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;
 };
 
 /**
@@ -1902,7 +2014,7 @@ type MultiSelectEditorConfig = {
 
 type MultiSelectTarget = {
     delimiter: string;
-    editor: MultiSelectEditorConfig;
+    editor: ListCell;
 };
 type PasteSpec = {
     sourceColumnIds: string[];
@@ -2007,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;
@@ -2126,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
@@ -2355,7 +2471,7 @@ type ColumnDelta = {
 
 /** Numeric row identifier. V8 stores small integers (Smi) inline — no heap allocation. */
 type TRowId = number;
-type SortType = "text" | "number" | "date";
+type SortType = "text" | "number" | "date" | "time";
 
 /** A pointer to a specific cell in the grid. */
 type CellLocation = {