@ingestro/importer-react 4.9.8 → 4.11.0

package/index.d.ts

@@ -299,6 +299,17 @@ export type IHeaderStepHandler = (params: {
   stay: IStayFn;
 }) => Promise<void> | void;
 
+export type IPreProcessingStepUpdateDataFn = IHeaderStepUpdateDataFn;
+
+export type IPreProcessingStepHandler = (params: {
+  data: ISheetData[];
+  updateData: IPreProcessingStepUpdateDataFn;
+  alert: IAlertFn;
+  block: IBlockFn;
+  proceed: IProceedFn;
+  stay: IStayFn;
+}) => Promise<void> | void;
+
 export type IReviewData = Record<
   string,
   {
@@ -320,6 +331,7 @@ export type IReviewStepHandler = (params: {
 
 export type IStepHandler = {
   uploadStep?: IUploadStepHandler;
+  preProcessingStep?: IPreProcessingStepHandler;
   mappingStep?: IMappingStepHandler;
   headerStep?: IHeaderStepHandler;
   reviewStep?: IReviewStepHandler;
@@ -574,6 +586,8 @@ export type ColumnAPI = {
 
 export type I18nOverrides =
   | {
+      ar?: Record<string, string>;
+      he?: Record<string, string>;
       en?: Record<string, string>;
       de?: Record<string, string>;
       es?: Record<string, string>;
@@ -597,6 +611,10 @@ export type I18nOverrides =
 type IAdditionalInfo = {
   uploadStep?: boolean;
   sheetSelectionStep?: boolean;
+  preProcessingStep?: boolean;
+  preProcessingModal?: boolean;
+  xmlModal?: boolean;
+  pdfModal?: boolean;
   headerStep?: boolean;
   mappingStep?: boolean;
   reviewStep?: boolean;
@@ -617,6 +635,7 @@ export type ISkipConfigurationMapping = {
   automaticMapping?: boolean;
   applyColumnMapping?: IApplyMappingMode;
   applyOptionMapping?: IApplyMappingMode;
+  requireConfirmation?: boolean;
 };
 
 export type ISkipConfiguration = {
@@ -691,6 +710,8 @@ export type SettingsAPI = {
   completeImportLogging?: boolean;
   submitModalConfiguration?: ISubmitModalConfiguration;
   prompts?: boolean;
+  /** Off by default. Turns on the review error/warning/info cell indicator. */
+  showReviewCellState?: boolean;
   successModalConfiguration?: ISuccessModalConfiguration;
   workersBaseUrl?: string;
   mappingViewMode?: 'sourceColumns' | 'targetColumns';
@@ -698,6 +719,7 @@ export type SettingsAPI = {
   transpose?: boolean;
   mergeHeaders?: boolean;
   metadataSelection?: boolean;
+  preProcessing?: boolean;
   collapseMatchedColumns?: boolean;
   skipConfiguration?: ISkipConfiguration;
   disableColumnRemapping?: boolean;
@@ -787,6 +809,18 @@ export type EntryChangeRow = {
   info: RowInfo;
 };
 
+export type DatasetRow = {
+  rowIndex: number;
+  data: Row;
+  info: RowInfo;
+};
+
+export type EntryChangeDataset = {
+  readonly rowCount: number;
+  getRow: (index: number) => DatasetRow | undefined;
+  forEachRow: (cb: (row: DatasetRow, index: number) => void) => void;
+};
+
 export type RowResult = Record<string, HookedRecordResult | FieldValue>;
 
 export type EntryChangeResult = {
@@ -803,7 +837,8 @@ export type ResultOnEntryChange =
 
 export type OnEntryChange = (
   rows: EntryChangeRow[],
-  logs: OnEntryChangeLogs
+  logs: OnEntryChangeLogs,
+  dataset: EntryChangeDataset
 ) => ResultOnEntryChange;
 
 export type HookedRecordRowResult = [HookedRecordResult, number];
@@ -891,6 +926,7 @@ export type AIpromptThemeAPI = {
     root?: CSSInterpolation;
     input?: {
       root?: CSSInterpolation;
+      placeholderColor?: string;
       variables?: {
         default?: CSSInterpolation;
         column?: CSSInterpolation;
@@ -923,6 +959,7 @@ export type AIpromptThemeAPI = {
     root?: CSSInterpolation;
     input?: {
       root?: CSSInterpolation;
+      placeholderColor?: string;
       variables?: {
         default?: CSSInterpolation;
         column?: CSSInterpolation;
@@ -973,6 +1010,7 @@ export type ThemeAPI = {
   };
   loader?: LoaderThemeAPI;
   headerSelect?: HeaderMatchAPI;
+  preProcessing?: PreProcessingThemeAPI;
   dropzone?: DropzoneThemeAPI;
   progressBar?: ProgressBarThemeAPI;
   joinSheet?: JoinSheetThemeAPI;
@@ -1089,7 +1127,7 @@ type HeaderMatchScrollbarAPI = {
   backgroundColor?: string;
 };
 
-type HeaderMatchSurfaceAPI = {
+export type HeaderMatchSurfaceAPI = {
   root?: CSSInterpolation;
   backgroundColor?: string;
   borderColor?: string;
@@ -1124,7 +1162,9 @@ type HeaderMatchSheetTabAPI = {
 type HeaderMatchButtonThemeAPI = CSSInterpolation;
 
 type HeaderMatchDeleteButtonThemeAPI = CSSInterpolation & {
-  // trash icon color (read as an inline style on the SVG, not via CSS spread on the button)
+  // trash icon stroke color (Lucide `color` prop) — not spread onto the button wrapper
+  color?: string;
+  // icon sizing only (width, height, strokeWidth); use top-level `color` for stroke
   icon?: CSSInterpolation;
 };
 
@@ -1139,6 +1179,55 @@ type HeaderMatchQuickFillButtonThemeAPI = CSSInterpolation & {
   icon?: CSSInterpolation;
 };
 
+export type MetadataSelectionThemeAPI = {
+  root?: CSSInterpolation;
+  iconButton?: CSSInterpolation;
+  iconColor?: string;
+  valuePreview?: {
+    root?: CSSInterpolation;
+    label?: CSSInterpolation;
+    value?: CSSInterpolation;
+  };
+};
+
+export type FormPopoverInputThemeAPI = {
+  root?: CSSInterpolation;
+  color?: string;
+  backgroundColor?: string;
+  borderColor?: string;
+  borderRadius?: string;
+  fontSize?: string;
+  placeholderColor?: string;
+  focusBorderColor?: string;
+};
+
+export type FormPopoverControlsThemeAPI = {
+  input?: FormPopoverInputThemeAPI;
+  quickFillButton?: HeaderMatchQuickFillButtonThemeAPI;
+};
+
+export type FormPopoverThemeAPI = HeaderMatchSurfaceAPI & {
+  width?: string;
+  header?: HeaderMatchDividerSectionAPI;
+  title?: HeaderMatchTextStyleAPI;
+  description?: HeaderMatchTextStyleAPI;
+  content?: CSSInterpolation;
+  footer?: HeaderMatchDividerSectionAPI;
+  controls?: FormPopoverControlsThemeAPI;
+};
+
+export type PreProcessingFormPopoverThemeAPI = Omit<
+  FormPopoverThemeAPI,
+  'controls'
+> & {
+  controls?: Pick<FormPopoverControlsThemeAPI, 'input'>;
+};
+
+export type FormButtonsThemeAPI = {
+  primary?: HeaderMatchButtonThemeAPI;
+  secondary?: HeaderMatchButtonThemeAPI;
+};
+
 export type HeaderMatchAPI = {
   // core — always rendered, no settings flag
   root?: CSSInterpolation;
@@ -1153,8 +1242,6 @@ export type HeaderMatchAPI = {
     td?: CSSInterpolation;
     selectRowColor?: string;
     hoverRowColor?: string;
-    // background/text color for a row that is both selected and hovered (defaults to a darkened selectRowColor)
-    highlightRowColor?: string;
     textColor?: string;
     mergedCell?: CSSInterpolation;
     scrollbar?: HeaderMatchScrollbarAPI;
@@ -1167,10 +1254,7 @@ export type HeaderMatchAPI = {
 
   // gated behind settings.transpose / settings.mergeHeaders / settings.metadataSelection
   features?: {
-    buttons?: {
-      primary?: HeaderMatchButtonThemeAPI;
-      secondary?: HeaderMatchButtonThemeAPI;
-    };
+    buttons?: FormButtonsThemeAPI;
     toolbar?: HeaderMatchSurfaceAPI & {
       dividerColor?: string;
       spinnerColor?: string;
@@ -1186,41 +1270,103 @@ export type HeaderMatchAPI = {
         item?: HeaderMatchDropdownItemThemeAPI;
       };
     };
-    metadataSelection?: {
+    metadataSelection?: MetadataSelectionThemeAPI;
+    formPopover?: FormPopoverThemeAPI;
+  };
+};
+
+/** Shared by headerSelect.features and preProcessing.preview.features (toolbar + merge edit bar). */
+export type HeaderMatchFeaturesThemeAPI = NonNullable<
+  HeaderMatchAPI['features']
+>;
+
+export type PreProcessingThemeAPI = {
+  accent?: {
+    color?: string;
+  };
+  root?: CSSInterpolation;
+  pageHeader?: HeaderThemeAPI;
+  footer?: FooterThemeAPI;
+  content?: CSSInterpolation;
+  inventory?: {
+    root?: CSSInterpolation;
+    fileChip?: CSSInterpolation & {
+      focused?: CSSInterpolation;
+      configureButton?: CSSInterpolation;
+      parsedBadge?: CSSInterpolation;
+    };
+    sheetRow?: CSSInterpolation & {
+      selected?: CSSInterpolation;
+      viewing?: CSSInterpolation;
+      processedTag?: CSSInterpolation;
+    };
+    addFileButton?: CSSInterpolation;
+  };
+  preview?: {
+    root?: CSSInterpolation;
+    title?: CSSInterpolation;
+    combineRequired?: CSSInterpolation;
+    table?: HeaderMatchAPI['table'];
+    features?: Pick<HeaderMatchFeaturesThemeAPI, 'toolbar' | 'buttons'>;
+  };
+  modal?: {
+    root?: CSSInterpolation;
+    overlay?: CSSInterpolation;
+    header?: CSSInterpolation;
+    footer?: CSSInterpolation;
+    additionalInfo?: IAdditionalInfoTheme;
+    buttons?: FormButtonsThemeAPI;
+    tabs?: {
       root?: CSSInterpolation;
-      selectedBorderColor?: string;
-      hoverBackground?: string;
-      // metadata +/- button container
-      iconButton?: CSSInterpolation;
-      // metadata +/- SVG color (falls back to selectedBorderColor)
-      iconColor?: string;
-      valuePreview?: {
-        root?: CSSInterpolation;
+      tab?: CSSInterpolation;
+      activeTab?: CSSInterpolation;
+    };
+    recipe?: {
+      root?: CSSInterpolation;
+      step?: CSSInterpolation;
+      stepEditing?: CSSInterpolation;
+      stepGenerated?: CSSInterpolation;
+      generatedBadge?: CSSInterpolation;
+      empty?: CSSInterpolation;
+      addStep?: CSSInterpolation;
+      addStepOption?: CSSInterpolation;
+      field?: {
         label?: CSSInterpolation;
-        value?: CSSInterpolation;
+        input?: CSSInterpolation;
+      };
+      dropdown?: {
+        button?: CSSInterpolation;
+        option?: CSSInterpolation;
+        selectedOption?: CSSInterpolation;
       };
     };
-    formPopover?: HeaderMatchSurfaceAPI & {
-      width?: string;
-      header?: HeaderMatchDividerSectionAPI;
-      title?: HeaderMatchTextStyleAPI;
-      description?: HeaderMatchTextStyleAPI;
-      content?: CSSInterpolation;
-      footer?: HeaderMatchDividerSectionAPI;
-      controls?: {
-        input?: {
-          root?: CSSInterpolation;
-          color?: string;
-          backgroundColor?: string;
-          borderColor?: string;
-          borderRadius?: string;
-          fontSize?: string;
-          placeholderColor?: string;
-          focusBorderColor?: string;
-        };
-        quickFillButton?: HeaderMatchQuickFillButtonThemeAPI;
+    combine?: {
+      toggle?: CSSInterpolation;
+      toggleSelected?: CSSInterpolation;
+      mapping?: CSSInterpolation;
+      matchStatus?: {
+        success?: CSSInterpolation;
+        warning?: CSSInterpolation;
       };
     };
+    aiAssist?: {
+      root?: CSSInterpolation;
+      input?: CSSInterpolation;
+      placeholderColor?: string;
+      mentionList?: CSSInterpolation;
+      mentionItem?: CSSInterpolation;
+      mentionItemActive?: CSSInterpolation;
+    };
+    metadataSelection?: MetadataSelectionThemeAPI;
+    formPopover?: PreProcessingFormPopoverThemeAPI;
+  };
+  configurePdf?: {
+    instruction?: {
+      placeholderColor?: string;
+    };
+    search?: {
+      placeholderColor?: string;
+    };
   };
 };
 
@@ -1305,6 +1451,7 @@ type CreateCustomTextField = {
   icon?: CSSInterpolation;
   input?: CSSInterpolation;
   errorMessage?: CSSInterpolation;
+  placeholderColor?: string;
 };
 
 type CreateCustomDropdown = {
@@ -1386,6 +1533,7 @@ type ColumnMatchThemeAPI = {
       backgroundColor?: string;
     };
     loading?: CSSInterpolation;
+    dateFormatPlaceholderColor?: string;
   };
   requiredColumns?: {
     title?: CSSInterpolation;
@@ -1440,6 +1588,7 @@ type FilterConditionDropdown = {
 type FindColumnDropdown = {
   root?: CSSInterpolation;
   icon?: CSSInterpolation;
+  placeholderColor?: string;
   list?: {
     root?: CSSInterpolation;
     item?: CSSInterpolation;
@@ -1472,6 +1621,7 @@ type SmartTableThemeAPI = {
       input?: {
         root?: CSSInterpolation;
         icon?: CSSInterpolation;
+        placeholderColor?: string;
       };
       label?: CSSInterpolation;
       valueList?: {
@@ -1501,6 +1651,12 @@ type SmartTableThemeAPI = {
   removeRows?: {
     root?: CSSInterpolation;
     dialog?: CSSInterpolation;
+    dropdown?: {
+      placeholderColor?: string;
+      search?: {
+        placeholderColor?: string;
+      };
+    };
   };
   freezeBoxShadow?: CSSObject['boxShadow'];
 };
@@ -1983,6 +2139,8 @@ export type ContextualEngineThemeAPI = {
 };
 
 export type LanguageType =
+  | 'ar'
+  | 'he'
   | 'de'
   | 'en'
   | 'es'
@@ -2021,6 +2179,7 @@ export declare const useDataImporter: (
 export type DynamicStepValues =
   | 'header'
   | 'mapping'
+  | 'preProcessing'
   | 'review'
   | 'sheetSelection';
 
@@ -2041,14 +2200,22 @@ export type IParseFileXmlConfiguration = {
   };
 };
 
+export type IParseFilePdfConfiguration = {
+  sourcePdfFile?: File;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  pdfDocument?: any;
+  selectedPdfTableIds?: string[];
+};
+
 export type SheetSelectionUploadFile = {
-  fileName: string;
+  fileName?: string;
   sheets: {
-    sheetName: string;
+    sheetName?: string;
     data: UploadData;
     visibility?: SheetVisibility;
   }[];
   xmlConfiguration?: IParseFileXmlConfiguration;
+  pdfConfiguration?: IParseFilePdfConfiguration;
 };
 
 export type SheetSelectionUploadData = SheetSelectionUploadFile[];
@@ -2071,6 +2238,7 @@ export type IParseFile = {
   fileName: string;
   sheets: IParseSheet[];
   xmlConfiguration?: IParseFileXmlConfiguration;
+  pdfConfiguration?: IParseFilePdfConfiguration;
 };
 
 export type OnEntryChangeLogs = {