Skip to content

Commit df6697f

Browse files
authored
docs(plugin-grid): reflect audit-timeline preservation in the historical-import hint (#3493) (#2822)
Companion to framework #3497. The "Import as historical data" checkbox already sends treatAsHistorical (verified: ImportWizard.tsx + assembleImportRequest on both paths, pinned by importDryRun.test.ts), so the server-side preserveAudit extension is reachable with no wiring change. Only the hint copy was stale — it described just the state-machine-skip half. Update the wizard hint and the ImportRequest.treatAsHistorical type doc to also mention that original timestamps/author (and business readonly fields) are preserved. Copy-only, no behavior change.
1 parent 92a59db commit df6697f

3 files changed

Lines changed: 20 additions & 3 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
"@object-ui/plugin-grid": patch
3+
---
4+
5+
docs(plugin-grid): the "Import as historical data" wizard hint now reflects audit-timeline preservation (#3493)
6+
7+
`treatAsHistorical` gained a second half in framework #3493/#3497 — the import
8+
write context also carries `preserveAudit`, so a historical import keeps the
9+
original `updated_at`/`updated_by` and business `readonly` fields instead of
10+
stamping-now / stripping them. The checkbox hint only described the
11+
state-machine-skip half; it now also says the original timestamps & author are
12+
preserved. The `ImportRequest.treatAsHistorical` type doc (`@object-ui/types`)
13+
is updated to match. Copy-only — no behavior change (the checkbox already sent
14+
`treatAsHistorical`, so the server-side extension is reached without any wiring
15+
change).

packages/plugin-grid/src/ImportWizard.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ const IMPORT_DEFAULT_TRANSLATIONS: Record<string, string> = {
121121
'grid.import.optCreateOptions': 'Keep unknown option values',
122122
'grid.import.optRunAutomations': 'Run automations & triggers',
123123
'grid.import.optTreatHistorical': 'Import as historical data',
124-
'grid.import.optTreatHistoricalHint': '(skip state-machine checks so already-completed records import as-is)',
124+
'grid.import.optTreatHistoricalHint': '(import completed records as-is — skip state-machine checks and keep their original timestamps & author instead of stamping now)',
125125
'grid.import.optSkipBlankKey': 'Skip rows with a blank match value',
126126
'grid.import.optBackground': 'Import in the background',
127127
'grid.import.optBackgroundHint': '(runs as an undoable job)',

packages/types/src/data.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -819,9 +819,11 @@ export interface ImportRequestOptions {
819819
matchFields?: string[];
820820
/** Fire triggers/hooks for each imported row (off by default for bulk). */
821821
runAutomations?: boolean;
822-
/** Import as established historical facts: skip the `state_machine` rule so
822+
/** Import as established historical facts. Skips the `state_machine` rule so
823823
* mid-lifecycle rows (already-closed tickets, closed_won deals) aren't rejected
824-
* by `initialStates` (framework #3479). @default false */
824+
* by `initialStates` (framework #3479), AND preserves the original audit timeline:
825+
* a supplied `updated_at`/`updated_by` and business `readonly` fields are kept
826+
* instead of stamped-now / stripped (framework #3493). @default false */
825827
treatAsHistorical?: boolean;
826828
/** Trim leading/trailing whitespace from string cells. @default true */
827829
trimWhitespace?: boolean;

0 commit comments

Comments
 (0)