@dynamic-entity/server 2.2.0 → 2.3.1

package/{write-template-C2dCEp48.d.ts → write-template-CzKVVjgT.d.ts}

@@ -1,4 +1,4 @@
-import { ImportRowError, ConfigProblem, EntityFormConfig, MappingPlan, FormRule, ImportLookups, TemplateSpec } from '@dynamic-entity/core';
+import { CsvDelimiter, ImportRowError, ConfigProblem, EntityFormConfig, MappingPlan, FormRule, ImportLookups, TemplateSpec } from '@dynamic-entity/core';
 import { Writable } from 'node:stream';
 
 /**
@@ -126,7 +126,8 @@ declare function destroySource(source: unknown): void;
  * 1. **Format is decided by content, never by the filename.** `.csv` is client-controlled and
  *    an attacker who wants a zip parsed will name their zip `.csv`. The first four bytes are
  *    not. Both readers then meet the same row guards, so a workbook cannot buy itself a
- *    larger sheet by being a workbook.
+ *    larger sheet by being a workbook. The name is consulted only after the bytes have said
+ *    the file is text, and only for its separator: `.tsv` means tab, as it does in the browser.
  * 2. **Rows arrive one at a time.** Nothing here ever holds the sheet. `rows` is an
  *    `AsyncIterable`, so a consumer that stops pulling stops the read.
  *
@@ -143,10 +144,17 @@ interface SheetSource {
     headers: string[];
     /** Data rows, one at a time. Pulling stops the read; not pulling stops it too. */
     rows: AsyncIterable<unknown[]>;
+    /** The field separator a CSV turned out to use. Absent for a workbook. */
+    delimiter?: CsvDelimiter;
 }
 interface ReadSheetOptions {
     stream: ByteSource;
-    /** Display only — it names the file in an error message and decides nothing. */
+    /**
+     * The client's name for the upload. It never decides the format — the bytes do. Once they
+     * have said the file is text, a name ending in `.tsv` fixes the separator as a tab, the way
+     * the browser reads one; any other name leaves the separator to `detectDelimiter`. A wrong
+     * name can at worst split a text file oddly, which the preview shows before anything imports.
+     */
     filename?: string;
     limits?: Partial<ImportLimits>;
 }
@@ -217,6 +225,11 @@ interface RunImportOptions {
     /** Values for every `listName` the config mentions. A server has no `LOOKUP_REGISTRY`. */
     lookups?: ImportLookups;
     lang?: string;
+    /**
+     * The decimal mark in number cells. Defaults to `,` for a CSV that uses `;` between fields,
+     * because that is what Excel writes in exactly those locales, and `.` otherwise.
+     */
+    decimal?: '.' | ',';
     /** Omit to validate without writing: the identical pipeline, every error, nothing stored. */
     onBatch?: OnBatch;
     limits?: Partial<ImportLimits>;
@@ -279,6 +292,10 @@ interface SheetPreview {
     /** Data rows in the file, which the whole stream is read to count. */
     rowCount: number;
     format: SheetFormat;
+    /** The field separator a CSV uses. Absent for a workbook. */
+    delimiter?: CsvDelimiter;
+    /** Rows of each repeating field the suggestion was sized for — see `arrayBoundFor`. */
+    arrayBound: number;
 }
 /**
  * Headers, a sample, and a suggested mapping.