@updog/data-editor 0.1.95 → 0.1.97

package/index.d.ts

@@ -418,6 +418,7 @@ declare var export_default = {
       invalidEmail: "Invalid email address",
       invalidFormat: "Invalid format",
       invalidNumber: "Invalid number",
+      invalidPhone: "Invalid phone number",
       invalidOption: "Invalid option",
       invalidTime: "Invalid time",
       invalidUrl: "Invalid URL",
@@ -567,11 +568,15 @@ declare var export_default = {
       },
     },
     chat: {
-      emptyTitle: "What would you like to fix?",
-      header: "Chat with AI",
+      cancelRequest: "Cancel request",
       inputLabel: "Ask AI about your data",
       placeholder: "Ask AI...",
+      requestCancelled: "Cancelled",
+      requestDone: "Applied",
+      requestFailed: "Failed",
       send: "Send",
+      toggle: "AI",
+      toggleLabel: "Toggle AI assistant",
     },
     common: {
       cancel: "Cancel",
@@ -782,6 +787,22 @@ type EmailEditorCell = {
 type UrlEditorCell = {
     type: "url";
 };
+/**
+ * Phone cell. A plain text input; the column is checked against
+ * `{ type: "phone" }` even when it declares no validator. On the way in a
+ * number is read with libphonenumber and stored in E.164 (`+4915112345678`);
+ * the screen shows it spaced (`+49 1511 2345678`). What does not read as
+ * one possible number stays as it came, trimmed, and is flagged.
+ */
+type PhoneEditorCell = {
+    type: "phone";
+    /**
+     * ISO 3166-1 alpha-2 region a number without a country code belongs to,
+     * `"DE"`. Omitted: only numbers carrying `+` (or digits that read as
+     * `+digits`) are recognised.
+     */
+    defaultRegion?: string;
+};
 /** Date picker cell. Bounds come from the column's `{ type: "date" }` validator. */
 type DateEditorCell = {
     type: "date";
@@ -882,6 +903,7 @@ type NumberEditorCell = {
  * - `"text"` — plain text input (default).
  * - `"email"` — plain text input; the column is checked against `{ type: "email" }`, spaces cut and the domain lower-cased on the way in.
  * - `"url"` — plain text input; the column is checked against `{ type: "url" }`, a bare host such as `acme.com` becomes `https://acme.com` on the way in.
+ * - `"phone"` — plain text input; the column is checked against `{ type: "phone" }`, a number is stored in E.164 and shown spaced.
  * - `"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.
@@ -891,7 +913,7 @@ type NumberEditorCell = {
  * - `"number"` — number input with locale-aware formatting.
  * - `"boolean"` — stores a real `true`/`false`; reads yes/no, 1/0, on/off and Excel's localized TRUE/FALSE.
  */
-type CellEditor = TextEditorCell | EmailEditorCell | UrlEditorCell | DateEditorCell | TimeEditorCell | SelectEditorCell | MultiSelectEditorCell | CountryEditorCell | CurrencyEditorCell | NumberEditorCell | BooleanEditorCell;
+type CellEditor = TextEditorCell | EmailEditorCell | UrlEditorCell | PhoneEditorCell | DateEditorCell | TimeEditorCell | SelectEditorCell | MultiSelectEditorCell | CountryEditorCell | CurrencyEditorCell | NumberEditorCell | BooleanEditorCell;
 /** Dropdown filter shown in the sidebar Filters panel. */
 type SelectColumnFilter = {
     type: "select";
@@ -1059,6 +1081,11 @@ type BuiltInValidator = {
  | {
     type: "url";
     message?: string;
+}
+/** The cell holds one possible phone number in E.164. Implicit on every phone column. */
+ | {
+    type: "phone";
+    message?: string;
 } | {
     type: "date";
     min?: string;
@@ -1235,10 +1262,17 @@ type ChatErrorSummary = {
     examples: string[];
 };
 /**
- * Context about the current dataset, passed to `loadSuggestions` and extended
- * into `ChatContext` for `onMessage`.
+ * The full context passed to `DataEditorChat.onMessage` when the user sends
+ * a prompt. Includes the prompt itself and all dataset context.
  */
-type ChatDataContext<TRow extends DataEditorRow = DataEditorRow> = {
+type ChatContext<TRow extends DataEditorRow = DataEditorRow> = {
+    /** The user's chat prompt. */
+    message: string;
+    /**
+     * Aborted when the user cancels the request. Pass it to `fetch` so the
+     * in-flight call stops; the SDK stops reading the stream on its own.
+     */
+    signal: AbortSignal;
     /** Full column definitions. */
     columns: DataEditorColumn[];
     /** Row identifier field, or the list of fields that identify a row together. */
@@ -1254,19 +1288,11 @@ type ChatDataContext<TRow extends DataEditorRow = DataEditorRow> = {
     /** Access all rows. Use for full-dataset operations. */
     getRows: () => ChatRow<TRow>[];
 };
-/**
- * The full context passed to `DataEditorChat.onMessage` when the user sends
- * a prompt. Includes the prompt itself and all dataset context.
- */
-type ChatContext<TRow extends DataEditorRow = DataEditorRow> = ChatDataContext<TRow> & {
-    /** The user's chat prompt. */
-    message: string;
-};
 /**
  * Bring-your-own-AI chat configuration. When provided via the `chat` prop,
- * the editor shows a chat panel alongside the grid. You own the AI
- * integration; the SDK hands you dataset context and renders the streamed
- * response.
+ * the editor footer gains an AI button that opens the assistant over the grid.
+ * You own the AI integration; the SDK hands you dataset context, applies the
+ * streamed row changes and shows each request with its status.
  *
  * @example
  * ```ts
@@ -1296,19 +1322,16 @@ type DataEditorChat<TRow extends DataEditorRow = DataEditorRow> = {
      * representative slice including rows with errors. When omitted, the SDK decides.
      */
     sampleSize?: number;
-    /** Title shown above the suggestion list when the chat is empty. */
-    emptyTitle?: string;
-    /** How many suggestions to request from `loadSuggestions`. */
-    suggestionsCount?: number;
-    /** Optional prompt generator for the empty-state suggestion chips. */
-    loadSuggestions?: (context: ChatDataContext<TRow>) => Promise<string[]>;
     /**
      * Called when the user sends a message. Receives full dataset context.
      * Returns an async iterable of response chunks — the SDK streams them
      * into the UI.
      */
     onMessage: (context: ChatContext<TRow>) => AsyncIterable<ChatResponseChunk<TRow>>;
-    /** Called when the user cancels a pending request. Use to abort your API call. */
+    /**
+     * Called when the user cancels a pending request, after `context.signal`
+     * is aborted. Use for cleanup the signal cannot reach.
+     */
     onCancel?: () => void;
 };