[FIX] range: add result changeType

closes #7751

Task: 5095364
Signed-off-by: Pierre Rousseau (pro) <[email protected]>

Author: LucasLefevre

src/collaborative/ot/srt_specific.ts

@@ -66,7 +66,7 @@ function addConditionalFormatCommandAdaptRange(
     cmd.cf.rule = {
       ...rule,
       rangeValues: rule.rangeValues
-        ? adaptStringRange(cmd.sheetId, rule.rangeValues, applyChange)
+        ? adaptStringRange(cmd.sheetId, rule.rangeValues, applyChange).range
         : undefined,
     };
   }

src/helpers/figures/charts/chart_common.ts

@@ -306,18 +306,26 @@ export function transformChartDefinitionWithDataSetsWithZone<T extends ChartWith
 ): T {
   let labelRange: string | undefined;
   if (definition.labelRange) {
-    const adaptedRange = adaptStringRange(chartSheetId, definition.labelRange, applyChange);
-    if (adaptedRange !== CellErrorType.InvalidReference) {
+    const { changeType, range: adaptedRange } = adaptStringRange(
+      chartSheetId,
+      definition.labelRange,
+      applyChange
+    );
+    if (changeType !== "REMOVE") {
       labelRange = adaptedRange;
     }
   }
 
   const dataSets: CustomizedDataSet[] = [];
   for (const dataSet of definition.dataSets) {
     const newDataSet = { ...dataSet };
-    const adaptedRange = adaptStringRange(chartSheetId, dataSet.dataRange, applyChange);
+    const { changeType, range: adaptedRange } = adaptStringRange(
+      chartSheetId,
+      dataSet.dataRange,
+      applyChange
+    );
 
-    if (adaptedRange !== CellErrorType.InvalidReference) {
+    if (changeType !== "REMOVE") {
       newDataSet.dataRange = adaptedRange;
       dataSets.push(newDataSet);
     }

src/helpers/figures/charts/gauge_chart.ts

@@ -163,8 +163,12 @@ export class GaugeChart extends AbstractChart {
   ): GaugeChartDefinition {
     let dataRange: string | undefined;
     if (definition.dataRange) {
-      const adaptedRange = adaptStringRange(chartSheetId, definition.dataRange, applyChange);
-      if (adaptedRange !== CellErrorType.InvalidReference) {
+      const { changeType, range: adaptedRange } = adaptStringRange(
+        chartSheetId,
+        definition.dataRange,
+        applyChange
+      );
+      if (changeType !== "REMOVE") {
         dataRange = adaptedRange;
       }
     }

src/helpers/figures/charts/scorecard_chart.ts

@@ -26,7 +26,6 @@ import {
   ScorecardChartDefinition,
   ScorecardChartRuntime,
 } from "../../../types/chart/scorecard_chart";
-import { CellErrorType } from "../../../types/errors";
 import { Validator } from "../../../types/validator";
 import { formatValue, humanizeNumber } from "../../format/format";
 import { adaptStringRange } from "../../formulas";
@@ -211,14 +210,22 @@ export class ScorecardChart extends AbstractChart {
     let baseline: string | undefined;
     let keyValue: string | undefined;
     if (definition.baseline) {
-      const adaptedRange = adaptStringRange(chartSheetId, definition.baseline, applyChange);
-      if (adaptedRange !== CellErrorType.InvalidReference) {
+      const { changeType, range: adaptedRange } = adaptStringRange(
+        chartSheetId,
+        definition.baseline,
+        applyChange
+      );
+      if (changeType !== "REMOVE") {
         baseline = adaptedRange;
       }
     }
     if (definition.keyValue) {
-      const adaptedRange = adaptStringRange(chartSheetId, definition.keyValue, applyChange);
-      if (adaptedRange !== CellErrorType.InvalidReference) {
+      const { changeType, range: adaptedRange } = adaptStringRange(
+        chartSheetId,
+        definition.keyValue,
+        applyChange
+      );
+      if (changeType !== "REMOVE") {
         keyValue = adaptedRange;
       }
     }

src/helpers/formulas.ts

@@ -1,5 +1,7 @@
 import { rangeTokenize } from "../formulas";
 import { Range, RangeAdapter, UID } from "../types";
+import { CellErrorType } from "../types/errors";
+import { ApplyRangeChangeResult } from "../types/misc";
 import { concat } from "./misc";
 import { createInvalidRange, createRangeFromXc, getRangeString } from "./range";
 import { rangeReference, splitReference } from "./references";
@@ -19,7 +21,7 @@ export function adaptFormulaStringRanges(
       continue;
     }
     const sheetXC = tokens[tokenIdx].value;
-    const newSheetXC = adaptStringRange(defaultSheetId, sheetXC, applyChange);
+    const newSheetXC = adaptStringRange(defaultSheetId, sheetXC, applyChange).range;
 
     if (sheetXC !== newSheetXC) {
       tokens[tokenIdx] = {
@@ -35,28 +37,34 @@ export function adaptStringRange(
   defaultSheetId: UID,
   sheetXC: string,
   rangeAdapter: RangeAdapter
-): string {
+): ApplyRangeChangeResult<string> {
   const sheetName = splitReference(sheetXC).sheetName;
   if (
     sheetName
       ? !isSheetNameEqual(sheetName, rangeAdapter.sheetName.old)
       : defaultSheetId !== rangeAdapter.sheetId
   ) {
-    return sheetXC;
+    return { changeType: "NONE", range: sheetXC };
   }
   const sheetId = sheetName ? rangeAdapter.sheetId : defaultSheetId;
 
   const range = getRange(sheetXC, sheetId);
   if (range.invalidXc) {
-    return sheetXC;
+    return { changeType: "NONE", range: sheetXC };
   }
 
   const change = rangeAdapter.applyChange(range);
   if (change.changeType === "NONE" || change.changeType === "REMOVE") {
-    return sheetXC;
+    return { changeType: change.changeType, range: sheetXC };
   }
-
-  return getRangeString(change.range, defaultSheetId, getSheetNameGetter(rangeAdapter));
+  const rangeStr = getRangeString(change.range, defaultSheetId, getSheetNameGetter(rangeAdapter));
+  if (rangeStr === CellErrorType.InvalidReference) {
+    return { changeType: "REMOVE", range: rangeStr };
+  }
+  return {
+    changeType: change.changeType,
+    range: rangeStr,
+  };
 }
 
 function getSheetNameGetter(applyChange: RangeAdapter) {

src/plugins/core/range.ts

@@ -92,7 +92,7 @@ export class RangeAdapterPlugin implements CommandHandler<CoreCommand> {
    */
   private verifyRangeRemoved(adaptRange: ApplyRangeChange): ApplyRangeChange {
     return (range: Range) => {
-      const result: ApplyRangeChangeResult = adaptRange(range);
+      const result: ApplyRangeChangeResult<Range> = adaptRange(range);
       if (result.changeType !== "NONE" && !isZoneValid(result.range.zone)) {
         return { range: result.range, changeType: "REMOVE" };
       }

src/types/misc.ts

@@ -289,8 +289,9 @@ export const enum DIRECTION {
 }
 
 export type ChangeType = "REMOVE" | "RESIZE" | "MOVE" | "CHANGE" | "NONE";
-export type ApplyRangeChangeResult = { changeType: ChangeType; range: Range };
-export type ApplyRangeChange = (range: Range) => ApplyRangeChangeResult;
+export type ApplyRangeChangeResult<T> = { changeType: ChangeType; range: T };
+export type ApplyFormulaRangeChangeResult = { changeType: ChangeType; formula: string };
+export type ApplyRangeChange = (range: Range) => ApplyRangeChangeResult<Range>;
 
 export type AdaptSheetName = { old: string; current: string };
 
@@ -302,7 +303,7 @@ export type RangeAdapter = {
 
 export type RangeAdapterFunctions = {
   applyChange: ApplyRangeChange;
-  adaptRangeString: (defaultSheetId: UID, sheetXC: string) => string;
+  adaptRangeString: (defaultSheetId: UID, sheetXC: string) => ApplyRangeChangeResult<string>;
   adaptFormulaString: (defaultSheetId: UID, formula: string) => string;
 };