@updog/data-editor-wc 0.1.74 → 0.1.75

package/index.d.ts

@@ -1147,8 +1147,13 @@ type DataEditorResult<TRow extends DataEditorRow = DataEditorRow> = {
         invalid: number;
     };
     /**
-     * Import mappings the user confirmed that weren't already known, split into
-     * `columns` and `values`. Persist and feed back through `synonyms` so repeat
+     * Import mappings the user changed **by hand** in the wizard, split into
+     * `columns` (header → column title) and `values` (imported value → option).
+     * Mappings the SDK matched on its own are excluded, as are mappings returned
+     * by `onColumnMatch` / `onValueMatch` and pairs the synonym tables already
+     * cover. A cancelled import contributes nothing.
+     *
+     * Persist and feed back through `synonyms` — the shapes line up — so repeat
      * imports auto-match. Each list is `[]` when nothing new was learned.
      */
     learnedSynonyms: LearnedSynonyms;
@@ -1420,24 +1425,31 @@ type DataEditorBaseProps<TRow extends DataEditorRow = DataEditorRow> = {
      */
     onValueMatch?: (valuesToMatch: Record<string, ValueMatchInput>) => ValueMatchOutput | Promise<ValueMatchOutput>;
     /**
-     * Extra synonyms layered on top of the built-ins for both column matching
-     * (header vs column) and value matching (imported value vs select option).
-     * Each key is the canonical target (a column ID/title, or a select option
-     * value); the array lists aliases the matching engine should treat as
-     * equivalent. Merged with the built-ins as a union per key.
+     * Extra synonyms layered on top of the built-ins, in two tables that stay
+     * apart: `columns` scores a file header against your columns, `values`
+     * scores an imported cell against a select option. Each key is the canonical
+     * target (a column ID/title, or an option value); the array lists aliases the
+     * matching engine treats as equivalent. Merged with the built-ins per key.
+     *
+     * Feed `result.learnedSynonyms` straight back — it comes out in this shape.
      *
      * @example
      * ```ts
      * synonyms={{
-     *   // column aliases
-     *   productSku: ["sku", "article_no", "item_code"],
-     *   firstName: ["first", "given_name", "fname"],
-     *   // value aliases (e.g. for a "status" select)
-     *   Active: ["live", "enabled"],
+     *   columns: {
+     *     productSku: ["sku", "article_no", "item_code"],
+     *     firstName: ["first", "given_name", "fname"],
+     *   },
+     *   values: {
+     *     Active: ["live", "enabled"],
+     *   },
      * }}
      * ```
      */
-    synonyms?: Record<string, string[]>;
+    synonyms?: {
+        columns?: Record<string, string[]>;
+        values?: Record<string, string[]>;
+    };
     /**
      * Sample rows included in the "Download Example" file. When the user clicks
      * "Download Example" in the import wizard, the SDK generates a template