@updog/data-editor 0.1.79 → 0.1.81

package/index.d.ts

@@ -529,6 +529,9 @@ declare var export_default = {
         editColumnTitle: "Edit column",
         createColumnWarning: "A matching column already exists",
         newColumnTag: "New",
+        sampleValues: "Example values",
+        sampleValuesEmpty: "No values in this column",
+        showSampleValues: "Show example values from {{column}}",
         unmatchedWarning:
           "Unmatched columns won't be imported. Match this column to keep the data. You can transform columns after importing.",
       },
@@ -3122,10 +3125,24 @@ type CustomImportFormat = {
      * Returns rows, named tables, or a `File` in a format the SDK already reads.
      * Throw to fail the import; the thrown message is shown to the user.
      */
-    handle: (file: File, ctx: {
-        signal: AbortSignal;
-    }) => Promise<File | Record<string, unknown>[] | CustomImportTable[]>;
+    handle: FileHandler;
 };
+/**
+ * What client code may hand back for a file the SDK will not read itself: rows,
+ * named tables, or a `File` in a format the SDK already reads.
+ */
+type FileHandlerResult = File | Record<string, unknown>[] | CustomImportTable[];
+/** Claims a file by extension and turns it into tables the SDK can stage. */
+type FileHandler = (file: File, ctx: {
+    signal: AbortSignal;
+}) => Promise<FileHandlerResult>;
+/**
+ * Takes over a readable file that holds no single table. `null` declines the
+ * file, leaving it to be staged the ordinary way.
+ */
+type UnstructuredFileHandler = (file: File, ctx: {
+    signal: AbortSignal;
+}) => Promise<FileHandlerResult | null>;
 /**
  * Controls the initial view when the editor opens.
  *
@@ -3246,6 +3263,17 @@ type DataEditorBaseProps<TRow extends DataEditorRow = DataEditorRow> = {
      * the file and stages whatever `handle()` returns.
      */
     customFormats?: CustomImportFormat[];
+    /**
+     * Called when a file the SDK can read turns out to hold no single table —
+     * a report with a banner, several tables on one sheet, a sheet that is really
+     * a document. You get the `File` and return tables, exactly as a
+     * `customFormats` handler does.
+     *
+     * Return `null`, throw, or take longer than 30 seconds and the file is staged
+     * the ordinary way, as if this prop were absent. Nothing about the file
+     * reaches Updog.
+     */
+    onUnstructuredFile?: UnstructuredFileHandler;
     /**
      * Which file formats the user can export to. `undefined` allows all
      * formats, `false` disables export entirely.