@mcurros2/microm 1.1.390-0 → 1.1.392-0

package/dist/index.d.ts

@@ -19,14 +19,14 @@ export type ValuesRecord = Value[];
 export interface MicroMRequestOptions {
     keepalive?: boolean;
 }
-export interface ImportDataMapping {
+export interface FileImportColumnMapping {
     SourceHeader: string | null;
     SourceIndex: number | null;
     DestinationColumnName: string;
 }
-export interface ExcelImportMapping {
+export interface FileImportMapping {
     SheetName: string | null;
-    Mapping: ImportDataMapping[];
+    Mapping: FileImportColumnMapping[];
 }
 export type SQLType = 'char' | 'nchar' | 'varchar' | 'nvarchar' | 'text' | 'ntext' | 'tinyint' | 'smallint' | 'int' | 'bigint' | 'float' | 'decimal' | 'real' | 'bit' | 'money' | 'datetime2' | 'datetime' | 'smalldatetime' | 'date' | 'binary' | 'varbinary' | 'image' | 'time';
 export interface DataResult {
@@ -49,7 +49,7 @@ export interface DBStatusResult {
     AutonumReturned: boolean;
     Results: DBStatus[];
 }
-export function isDBStatusResult(data: any): data is DBStatusResult;
+export function isDBStatusResult(data: unknown): data is DBStatusResult;
 export function isIn<T>(value: T, ...params: T[]): boolean;
 export function isPromise<T>(obj: unknown): obj is Promise<T>;
 export function createKeysSet<T>(): Set<keyof T>;
@@ -500,6 +500,7 @@ export interface StepperFormStep {
     nextStepLabel?: string;
     nextStepValidLabel?: string;
     nextStepValidation?: () => boolean | Promise<boolean>;
+    allowStepSelect?: boolean;
     icon?: ReactNode;
 }
 export interface StepperFormProps extends EntityFormProps {
@@ -509,10 +510,11 @@ export interface StepperFormProps extends EntityFormProps {
     initialStep: number;
     nextStepLabel?: string;
     prevStepLabel?: string;
-    allowStepClickForward?: boolean;
     completedContent?: ReactNode;
     hideNextAndBackWhenCompleted?: boolean;
     onCompleted?: () => void;
+    onCancelSubmit?: () => void | Promise<void>;
+    cancelSubmitLabel?: ReactNode;
     stepperProps?: Omit<Partial<StepperProps>, 'children' | 'active'>;
 }
 export const StepperFormDefaultProps: Partial<StepperFormProps>;
@@ -1242,7 +1244,7 @@ export class EntityAPI {
     /**
      * Import data
      */
-    importData(abort_signal: (AbortSignal | null) | undefined, import_procname: (string | null) | undefined, parentKeys: (ValuesObject | null) | undefined, fileprocess_id: string, excelImportMapping?: ExcelImportMapping, initialRow?: number): Promise<ImpDataResult>;
+    importData(abort_signal: (AbortSignal | null) | undefined, import_procname: (string | null) | undefined, parentKeys: (ValuesObject | null) | undefined, fileprocess_id: string, fileImportMapping?: FileImportMapping, initialRow?: number): Promise<ImpDataResult>;
     executeView(view: EntityView, view_parms?: ValuesObject, limit?: string | null, search?: string[] | null, abort_signal?: AbortSignal | null): Promise<DataResult[]>;
     downloadBlobFile(blob: Blob, filename: string): void;
     exportView(view: EntityView, view_parms?: ValuesObject, limit?: string | null, search?: string[] | null, abort_signal?: AbortSignal | null): Promise<Blob>;
@@ -1621,25 +1623,72 @@ export function useLocaleFormat(props: UseLocaleFormatProps): {
     getNativeValue: (value: Value, sqlType: SQLType) => Value;
     formatColumnValue: (col: EntityColumn<Value>) => string;
 };
-export interface ExcelImportMappingEditorProps {
-    file: File;
+export interface ImportFileSheet {
+    name: string | null;
+    rows: string[][];
+}
+export interface ParsedImportFile {
+    format: 'csv' | 'xls' | 'xlsx';
+    sheets: ImportFileSheet[];
+}
+export function getImportFileExtension(file: File): string;
+export function parseCSVRows(text: string): string[][];
+export function parseImportFile(file: File): Promise<ParsedImportFile>;
+export interface ImportDataMappingRow {
+    SourceHeader: string;
+    SourceIndex: number;
+    DestinationColumnName: string | null;
+}
+export interface ImportDataMappingState {
+    mapping: FileImportMapping;
+    initialRow: number;
+    isValid: boolean;
+    isSuccessful: boolean;
+    sourceColumnCount: number;
+    mappedColumnCount: number;
+    ignoredSourceColumns: string[];
+    omittedRequiredDestinations: string[];
+}
+export interface UseImportDataMappingProps {
     destinations: readonly string[];
-    onChange: (mapping: ExcelImportMapping | undefined, initialRow: number) => void;
+    requiredDestinations: readonly string[];
     initialRow?: number;
     sampleRowCount?: number;
+    fileErrorLabel?: string;
+}
+export interface ImportDataMappingAPI {
+    parsedFile?: ParsedImportFile;
+    sheetName: string;
+    headerRow: number;
+    mappingRows: ImportDataMappingRow[];
+    sampleRows: string[][];
+    mappingState?: ImportDataMappingState;
+    loading: boolean;
+    error?: string;
+    revision: number;
+    loadFile: (file: File) => Promise<void>;
+    reset: () => void;
+    selectSheet: (sheetName: string) => void;
+    selectHeaderRow: (headerRow: number) => void;
+    updateMappingRow: (rowIndex: number, destination: string | null) => void;
+}
+export function getImportSourceColumnLabel(row: ImportDataMappingRow): string;
+export function useImportDataMapping({ destinations, requiredDestinations, initialRow, sampleRowCount, fileErrorLabel }: UseImportDataMappingProps): ImportDataMappingAPI;
+export interface ImportDataMappingEditorProps {
+    mappingAPI: ImportDataMappingAPI;
+    destinations: readonly string[];
     worksheetLabel?: string;
     initialRowLabel?: string;
     sourceHeaderLabel?: string;
     sourceIndexLabel?: string;
     destinationLabel?: string;
-    previewLabel?: string;
-    addMappingLabel?: string;
-    legacyHelpLabel?: string;
+    mappingCorrectLabel?: string;
+    mappingReviewLabel?: string;
+    editMappedColumnsLabel?: string;
     noDestinationsLabel?: string;
-    workbookErrorLabel?: string;
 }
-export const ExcelImportMappingEditorDefaultProps: Partial<ExcelImportMappingEditorProps>;
-export function ExcelImportMappingEditor(props: ExcelImportMappingEditorProps): JSX.Element;
+export const ImportDataMappingEditorDefaultProps: Partial<ImportDataMappingEditorProps>;
+export function ImportDataMappingEditor(props: ImportDataMappingEditorProps): JSX.Element | null;
 export const ACTDownloadImportedFileLabels: {
     label: string;
     error: string;
@@ -1713,16 +1762,6 @@ export class ImportEntityDataDef extends EntityDefinition {
     };
     constructor();
 }
-export interface CircleFilledIconProps {
-    backColor?: MantineColor;
-    color?: MantineColor;
-    width?: string | number;
-    minWidth?: string | number;
-    icon: ReactNode;
-    mr?: string;
-}
-export const CircleFilledIconDefaultProps: Partial<CircleFilledIconProps>;
-export const CircleFilledIcon: ForwardRefExoticComponent<CircleFilledIconProps & RefAttributes<HTMLInputElement>>;
 export interface ImageCropOptions {
     aspectRatio?: number;
 }
@@ -1991,29 +2030,122 @@ export interface ModalFileUploadProps {
 }
 export const UseFileUploadFormOpenDefaultProps: Partial<ModalFileUploadProps>;
 export function useFilesUploadForm(): (props: ModalFileUploadProps) => Promise<void>;
+export interface CircleFilledIconProps {
+    backColor?: MantineColor;
+    color?: MantineColor;
+    width?: string | number;
+    minWidth?: string | number;
+    icon: ReactNode;
+    mr?: string;
+}
+export const CircleFilledIconDefaultProps: Partial<CircleFilledIconProps>;
+export const CircleFilledIcon: ForwardRefExoticComponent<CircleFilledIconProps & RefAttributes<HTMLInputElement>>;
+export interface ImportCompletedContentProps {
+    fileName: string;
+    result: ImpDataResult;
+    onClose?: () => void | Promise<void>;
+    importedFileLabel?: string;
+    recordsImportedSuccessfullyLabel?: string;
+    recordsNotImportedDueToErrorsLabel?: string;
+    errorColumnTitle?: string;
+    rowColumnTitle?: string;
+    closeLabel?: ReactNode;
+}
+export const ImportCompletedContentDefaultProps: Partial<ImportCompletedContentProps>;
+export function ImportCompletedContent(props: ImportCompletedContentProps): JSX.Element;
+export interface ImportDataMappingStepProps {
+    mappingAPI: ImportDataMappingAPI;
+    destinations: readonly string[];
+    validationError?: string;
+}
+export const ImportDataMappingStepDefaultProps: Partial<ImportDataMappingStepProps>;
+export function ImportDataMappingStep(props: ImportDataMappingStepProps): JSX.Element;
+export interface ImportFileStepProps {
+    entity: ImportEntityData;
+    disabled?: boolean;
+    validationError?: string;
+    onValidateFile: (file: File) => Promise<ValidateFileReturnType>;
+    onDelete: (fileGUID: string) => boolean | Promise<boolean>;
+    onUploadComplete: (report: UploadProgressReport) => Promise<UploadCompletionResult | void>;
+}
+export function ImportFileStep({ entity, disabled, validationError, onValidateFile, onDelete, onUploadComplete }: ImportFileStepProps): JSX.Element;
+export interface ImportInstructionsStepProps {
+    importEntity?: Entity<EntityDefinition>;
+    requiredColumns: readonly string[];
+    instructionsLabel?: string;
+    columnHeaderLabel?: string;
+    dataNameLabel?: string;
+    dataTypeLabel?: string;
+    contentLabel?: string;
+    dateFormatLabel?: string;
+    numberFormatLabel?: string;
+    downloadExcelSampleLabel?: string;
+    downloadCSVSampleLabel?: string;
+}
+export function getFriendlyImportDataType(type: SQLType): "Integer" | "Number" | "Date" | "Alphanumeric";
+export function ImportInstructionsStep({ importEntity, requiredColumns, instructionsLabel, columnHeaderLabel, dataNameLabel, dataTypeLabel, contentLabel, dateFormatLabel, numberFormatLabel, downloadExcelSampleLabel, downloadCSVSampleLabel }: ImportInstructionsStepProps): JSX.Element;
+export interface ImportSampleDataStepProps {
+    mappingAPI: ImportDataMappingAPI;
+    confirmationLabel?: string;
+    noSampleDataLabel?: string;
+}
+export const ImportSampleDataStepDefaultProps: Partial<ImportSampleDataStepProps>;
+export function ImportSampleDataStep(props: ImportSampleDataStepProps): JSX.Element;
+export interface ImportSummaryStepProps {
+    file: File | null;
+    mappingState?: ImportDataMappingState;
+    importStatus?: OperationStatus<ImpDataResult>;
+    summaryTitleLabel?: string;
+    fileLabel?: string;
+    formatLabel?: string;
+    unknownFormatLabel?: string;
+    worksheetLabel?: string;
+    headerRowLabel?: string;
+    mappedColumnsLabel?: string;
+    ofLabel?: string;
+    ignoredSourceColumnsLabel?: string;
+    omittedRequiredColumnsLabel?: string;
+    noneLabel?: string;
+    submitAndImportLabel?: string;
+    importingDataLabel?: string;
+}
+export const ImportSummaryStepDefaultProps: Partial<ImportSummaryStepProps>;
+export function ImportSummaryStep(props: ImportSummaryStepProps): JSX.Element | null;
 export interface ImportEntityDataFormProps extends FormOptions<ImportEntityData> {
     importEntity?: Entity<EntityDefinition>;
     entityProcName?: string;
     excludedImportDestinations?: string[];
     onImportSuccess?: () => Promise<void>;
-    importInfoLabel?: string;
-    csvInstructionsLabel?: string;
+    instructionsStepLabel?: string;
+    instructionsStepDescription?: string;
+    uploadStepLabel?: string;
+    uploadStepDescription?: string;
+    dataMappingStepLabel?: string;
+    dataMappingStepDescription?: string;
+    sampleDataStepLabel?: string;
+    sampleDataStepDescription?: string;
+    summaryStepLabel?: string;
+    summaryStepDescription?: string;
+    instructionsLabel?: string;
     columnHeaderLabel?: string;
     dataNameLabel?: string;
     contentLabel?: string;
     dataTypeLabel?: string;
-    errorReadingFileLabel?: string;
-    emptyCSVFileLabel?: string;
-    missingColumnsLabel?: string;
     dateFormatLabel?: string;
     numberFormatLabel?: string;
-    downloadSampleLabel?: string;
+    downloadExcelSampleLabel?: string;
+    downloadCSVSampleLabel?: string;
+    errorReadingFileLabel?: string;
+    emptyFileLabel?: string;
+    uploadRequiredLabel?: string;
+    mappingRequiredLabel?: string;
+    confirmDataMappingLabel?: string;
     importButtonLabel?: string;
-    importHelpAndInstructionsLabel?: string;
-    recordsImportedSusccessfullyLabel?: string;
-    recordsNotImportedDueToErrorsLabel?: string;
-    importTheCSVFileLabel?: string;
+    submitAndImportLabel?: string;
+    importingDataLabel?: string;
     importedFileLabel?: string;
+    recordsImportedSuccessfullyLabel?: string;
+    recordsNotImportedDueToErrorsLabel?: string;
     errorColumnTitle?: string;
     rowColumnTitle?: string;
 }
@@ -2078,17 +2210,6 @@ export const UseImportDataDefaultProps: {
     noFileProcessLabel: string;
     errorImportingDataLabel: string;
 };
-export interface useEntityCSVImportValidationProps {
-    errorReadingFileLabel?: string;
-    emptyCSVFileLabel?: string;
-    missingColumnsLabel?: string;
-}
-export function useEntityCSVImportValidation({ errorReadingFileLabel, emptyCSVFileLabel, missingColumnsLabel }: useEntityCSVImportValidationProps): {
-    validateEntityImportCSVFile: (props: {
-        file: File;
-        requiredColumns: string[];
-    }) => Promise<ValidateFileReturnType>;
-};
 export interface UseExportToExcelProps {
     data: DataResult[];
     dataResultNames?: string[];
@@ -2098,9 +2219,10 @@ export function useExportToExcel(props: UseExportToExcelProps): {
     exportToExcel: () => Promise<void>;
 };
 export function useImportData(importEntity?: Entity<EntityDefinition>): {
-    execute: (fileprocess_id: string, importProcedureName?: string, excelImportMapping?: ExcelImportMapping, initialRow?: number) => Promise<OperationStatus<ImpDataResult> | undefined>;
+    execute: (fileprocess_id: string, importProcedureName?: string, fileImportMapping?: FileImportMapping, initialRow?: number) => Promise<OperationStatus<ImpDataResult> | undefined>;
     importStatus: OperationStatus<ImpDataResult>;
-    cancellation: AbortController;
+    readonly cancellation: AbortController;
+    cancel: () => void;
 };
 export interface MicroMClientClaimTypes {
     username: string;
@@ -4627,7 +4749,7 @@ export class MicroMClient {
     proctoexcel(entity_name: string, parent_keys: ValuesObject | null, values: ValuesObject, recordsSelection: ValuesObject[] | null, proc_name: string, abort_signal?: AbortSignal | null): Promise<Blob>;
     process(entity_name: string, parent_keys: ValuesObject | null, values: ValuesObject, recordsSelection: ValuesObject[] | null, proc_name: string, abort_signal?: AbortSignal | null): Promise<DBStatusResult>;
     action<TReturn>(entity_name: string, parent_keys: ValuesObject | null, values: ValuesObject, action_name: string, abort_signal?: AbortSignal | null): Promise<TReturn>;
-    import(entity_name: string, parent_keys: ValuesObject | null, values: ValuesObject, import_procname: string | null, abort_signal?: AbortSignal | null, excelImportMapping?: ExcelImportMapping, initialRow?: number): Promise<ImpDataResult>;
+    import(entity_name: string, parent_keys: ValuesObject | null, values: ValuesObject, import_procname: string | null, abort_signal?: AbortSignal | null, fileImportMapping?: FileImportMapping, initialRow?: number): Promise<ImpDataResult>;
 }
 export class RecordReader {
     constructor(dataResult: DataResult);