-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[IMP] xlsx: support import/export of data validation rules
This commit enhances XLSX handling capabilities by adding support for importing and exporting data validation rules, which helps in maintaining data integrity and consistency when working with Excel files. Task: 3637642
- Loading branch information
Showing
21 changed files
with
833 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| import { DataValidationRuleData } from "../../types"; | ||
| import { XLSXDataValidation } from "../../types/xlsx"; | ||
| import { WarningTypes, XLSXImportWarningManager } from "../helpers/xlsx_parser_error_manager"; | ||
| import { | ||
| XLSX_DV_DATE_OPERATOR_TO_DV_TYPE_MAPPING, | ||
| XLSX_DV_DECIMAL_OPERATOR_TO_DV_TYPE_MAPPING, | ||
| } from "./conversion_maps"; | ||
|
|
||
| export function convertDataValidationRules( | ||
| xlsxDataValidations: XLSXDataValidation[], | ||
| warningManager: XLSXImportWarningManager | ||
| ): DataValidationRuleData[] { | ||
| const dvRules: DataValidationRuleData[] = []; | ||
| let dvId = 1; | ||
| for (const dv of xlsxDataValidations) { | ||
| if (!dv) { | ||
| continue; | ||
| } | ||
| switch (dv.type) { | ||
| case "time": | ||
| warningManager.generateNotSupportedWarning(WarningTypes.TimeDataValidationNotSupported); | ||
| break; | ||
| case "textLength": | ||
| warningManager.generateNotSupportedWarning( | ||
| WarningTypes.TextLengthDataValidationNotSupported | ||
| ); | ||
| break; | ||
| case "whole": | ||
| warningManager.generateNotSupportedWarning( | ||
| WarningTypes.WholeNumberDataValidationNotSupported | ||
| ); | ||
| break; | ||
| case "decimal": | ||
| const decimalRule = convertDecimalRule(dvId++, dv); | ||
| dvRules.push(decimalRule); | ||
| break; | ||
| case "list": | ||
| const listRule = convertListrule(dvId++, dv); | ||
| dvRules.push(listRule); | ||
| break; | ||
| case "date": | ||
| if (dv.operator === "notEqual") { | ||
| warningManager.generateNotSupportedWarning( | ||
| WarningTypes.NotEqualDateDataValidationNotSupported | ||
| ); | ||
| break; | ||
| } | ||
| const dateRule = convertDateRule(dvId++, dv); | ||
| dvRules.push(dateRule); | ||
| break; | ||
| case "custom": | ||
| const customRule = convertCustomRule(dvId++, dv); | ||
| dvRules.push(customRule); | ||
| break; | ||
| } | ||
| } | ||
| return dvRules; | ||
| } | ||
|
|
||
| function convertDecimalRule(id: number, dv: XLSXDataValidation): DataValidationRuleData { | ||
| const values = [dv.formula1.toString()]; | ||
| if (dv.formula2) { | ||
| values.push(dv.formula2.toString()); | ||
| } | ||
| return { | ||
| id: id.toString(), | ||
| ranges: dv.sqref, | ||
| isBlocking: dv.errorStyle !== "warning", | ||
| criterion: { | ||
| type: XLSX_DV_DECIMAL_OPERATOR_TO_DV_TYPE_MAPPING[dv.operator] ?? "isBetween", | ||
| values, | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| function convertListrule(id: number, dv: XLSXDataValidation): DataValidationRuleData { | ||
| const values = [dv.formula1.toString()]; | ||
| if (dv.formula2) { | ||
| values.push(dv.formula2.toString()); | ||
| } | ||
| return { | ||
| id: id.toString(), | ||
| ranges: dv.sqref, | ||
| isBlocking: dv.errorStyle !== "warning", | ||
| criterion: { | ||
| type: "isValueInRange", | ||
| values: dv.formula1.split(","), | ||
| displayStyle: "arrow", | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| function convertDateRule(id: number, dv: XLSXDataValidation): DataValidationRuleData { | ||
| const values = [dv.formula1.toString()]; | ||
| if (dv.formula2 && dv.formula2 !== "undefined") { | ||
| values.push(dv.formula2.toString()); | ||
| } | ||
| let criterion = { | ||
| type: XLSX_DV_DATE_OPERATOR_TO_DV_TYPE_MAPPING[dv.operator] ?? "dateIsBetween", | ||
| values: values, | ||
| }; | ||
| if (!dv.formula2 || dv.formula2 === "undefined") { | ||
| // @ts-ignore | ||
| criterion.dateValue = "exactDate"; | ||
| } | ||
| return { | ||
| id: id.toString(), | ||
| ranges: dv.sqref, | ||
| isBlocking: dv.errorStyle !== "warning", | ||
| criterion: criterion, | ||
| }; | ||
| } | ||
|
|
||
| function convertCustomRule(id: number, dv: XLSXDataValidation): DataValidationRuleData { | ||
| return { | ||
| id: id.toString(), | ||
| ranges: dv.sqref, | ||
| isBlocking: dv.errorStyle !== "warning", | ||
| criterion: { | ||
| type: "customFormula", | ||
| values: [`=${dv.formula1.toString()}`], | ||
| }, | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| import { | ||
| XLSXDataValidation, | ||
| XLSXDataValidationOperatorType, | ||
| XLSXFileStructure, | ||
| XLSXImportFile, | ||
| XLSXTheme, | ||
| } from "../../types/xlsx"; | ||
| import { XLSXImportWarningManager } from "../helpers/xlsx_parser_error_manager"; | ||
| import { XlsxBaseExtractor } from "./base_extractor"; | ||
|
|
||
| export class XlsxDataValidationExtractor extends XlsxBaseExtractor { | ||
| theme?: XLSXTheme; | ||
|
|
||
| constructor( | ||
| sheetFile: XLSXImportFile, | ||
| xlsxStructure: XLSXFileStructure, | ||
| warningManager: XLSXImportWarningManager, | ||
| theme: XLSXTheme | undefined | ||
| ) { | ||
| super(sheetFile, xlsxStructure, warningManager); | ||
| this.theme = theme; | ||
| } | ||
|
|
||
| public extractDataValidations(): XLSXDataValidation[] { | ||
| const dataValidations = this.mapOnElements( | ||
| { parent: this.rootFile.file.xml, query: "worksheet > dataValidations > dataValidation" }, | ||
| (dvElement): XLSXDataValidation => { | ||
| return { | ||
| type: this.extractAttr(dvElement, "type", { required: true }).asString(), | ||
| operator: this.extractAttr( | ||
| dvElement, | ||
| "operator" | ||
| )?.asString() as XLSXDataValidationOperatorType, | ||
| sqref: this.extractAttr(dvElement, "sqref", { required: true }).asString().split(" "), | ||
| errorStyle: this.extractAttr(dvElement, "errorStyle")?.asString(), | ||
| formula1: this.extractDataValidationFormula(dvElement, 1)[0], | ||
| formula2: this.extractDataValidationFormula(dvElement, 2)[0], | ||
| showErrorMessage: this.extractAttr(dvElement, "showErrorMessage")?.asBool(), | ||
| errorTitle: this.extractAttr(dvElement, "errorTitle")?.asString(), | ||
| error: this.extractAttr(dvElement, "error")?.asString(), | ||
| showInputMessage: this.extractAttr(dvElement, "showInputMessage")?.asBool(), | ||
| promptTitle: this.extractAttr(dvElement, "promptTitle")?.asString(), | ||
| prompt: this.extractAttr(dvElement, "prompt")?.asString(), | ||
| allowBlank: this.extractAttr(dvElement, "allowBlank")?.asBool(), | ||
| }; | ||
| } | ||
| ); | ||
| return dataValidations; | ||
| } | ||
|
|
||
| private extractDataValidationFormula(dvElement: Element, index: number): string[] { | ||
| return this.mapOnElements( | ||
| { parent: dvElement, query: `formula${index}` }, | ||
| (cfFormulaElements): string => { | ||
| return this.extractTextContent(cfFormulaElements, { required: true }); | ||
| } | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.