@odoo/o-spreadsheet 14.0.0 → 14.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (198) hide show
  1. package/.eslintrc.json +20 -0
  2. package/.husky/post-checkout +9 -0
  3. package/.husky/pre-commit +39 -0
  4. package/.prettierignore +1 -0
  5. package/astToFormula.patch +0 -0
  6. package/demo/data.js +255 -0
  7. package/demo/index.html +9 -0
  8. package/demo/libs/Chart.bundle.js +20755 -0
  9. package/demo/main.js +101 -0
  10. package/doc/readme.md +46 -0
  11. package/package.json +3 -17
  12. package/rollup.config.js +23 -0
  13. package/src/base_plugin.ts +102 -0
  14. package/src/components/autofill.ts +146 -0
  15. package/src/components/bottom_bar.ts +199 -0
  16. package/src/components/color_picker.ts +150 -0
  17. package/src/components/composer/autocomplete_dropdown.ts +135 -0
  18. package/src/components/composer/composer.ts +487 -0
  19. package/src/components/composer/content_editable_helper.ts +146 -0
  20. package/src/components/figures/chart.ts +70 -0
  21. package/src/components/figures/container.ts +268 -0
  22. package/src/components/figures/text_figure.ts +36 -0
  23. package/src/components/grid.ts +635 -0
  24. package/src/components/helpers/dom_helpers.ts +7 -0
  25. package/src/components/helpers/drag_and_drop.ts +17 -0
  26. package/src/components/icons.ts +36 -0
  27. package/src/components/index.ts +1 -0
  28. package/src/components/menu.ts +288 -0
  29. package/src/components/overlay.ts +457 -0
  30. package/src/components/scrollbar.ts +22 -0
  31. package/src/components/selection_input.ts +168 -0
  32. package/src/components/side_panel/cell_is_rule_editor.ts +169 -0
  33. package/src/components/side_panel/chart_panel.ts +104 -0
  34. package/src/components/side_panel/color_scale_rule_editor.ts +145 -0
  35. package/src/components/side_panel/conditional_formatting.ts +396 -0
  36. package/src/components/side_panel/side_panel.ts +127 -0
  37. package/src/components/side_panel/translations_terms.ts +45 -0
  38. package/src/components/spreadsheet.ts +198 -0
  39. package/src/components/top_bar.ts +535 -0
  40. package/src/constants.ts +26 -0
  41. package/src/data.ts +149 -0
  42. package/src/fonts.ts +41 -0
  43. package/src/formulas/compiler.ts +258 -0
  44. package/src/formulas/composer_tokenizer.ts +70 -0
  45. package/src/formulas/index.ts +15 -0
  46. package/src/formulas/normalize.ts +52 -0
  47. package/src/formulas/parser.ts +280 -0
  48. package/src/formulas/range_tokenizer.ts +97 -0
  49. package/src/formulas/tokenizer.ts +242 -0
  50. package/src/functions/arguments.ts +114 -0
  51. package/src/functions/dates.ts +302 -0
  52. package/src/functions/helpers.ts +592 -0
  53. package/src/functions/index.ts +52 -0
  54. package/src/functions/module_database.ts +282 -0
  55. package/src/functions/module_date.ts +743 -0
  56. package/src/functions/module_info.ts +69 -0
  57. package/src/functions/module_logical.ts +208 -0
  58. package/src/functions/module_lookup.ts +185 -0
  59. package/src/functions/module_math.ts +1252 -0
  60. package/src/functions/module_operators.ts +291 -0
  61. package/src/functions/module_statistical.ts +882 -0
  62. package/src/functions/module_text.ts +370 -0
  63. package/src/helpers/color.ts +30 -0
  64. package/src/helpers/coordinates.ts +71 -0
  65. package/src/helpers/grid_manipulation.ts +68 -0
  66. package/src/helpers/index.ts +7 -0
  67. package/src/helpers/misc.ts +76 -0
  68. package/src/helpers/numbers.ts +117 -0
  69. package/src/helpers/uuid.ts +19 -0
  70. package/src/helpers/zones.ts +263 -0
  71. package/src/history.ts +186 -0
  72. package/src/index.ts +84 -0
  73. package/src/model.ts +261 -0
  74. package/src/plugins/autofill.ts +412 -0
  75. package/src/plugins/chart.ts +404 -0
  76. package/src/plugins/clipboard.ts +461 -0
  77. package/src/plugins/conditional_format.ts +445 -0
  78. package/src/plugins/core.ts +1502 -0
  79. package/src/plugins/edition.ts +157 -0
  80. package/src/plugins/evaluation.ts +428 -0
  81. package/src/plugins/figures.ts +123 -0
  82. package/src/plugins/formatting.ts +630 -0
  83. package/src/plugins/highlight.ts +187 -0
  84. package/src/plugins/index.ts +32 -0
  85. package/src/plugins/merge.ts +524 -0
  86. package/src/plugins/renderer.ts +571 -0
  87. package/src/plugins/selection.ts +562 -0
  88. package/src/plugins/selection_inputs.ts +326 -0
  89. package/src/registries/autofill_modifiers.ts +76 -0
  90. package/src/registries/autofill_rules.ts +98 -0
  91. package/src/registries/figure_registry.ts +30 -0
  92. package/src/registries/index.ts +7 -0
  93. package/src/registries/menu_items_registry.ts +110 -0
  94. package/src/registries/menus/cell_menu_registry.ts +79 -0
  95. package/src/registries/menus/col_menu_registry.ts +63 -0
  96. package/src/registries/menus/index.ts +6 -0
  97. package/src/registries/menus/menu_items_actions.ts +425 -0
  98. package/src/registries/menus/row_menu_registry.ts +63 -0
  99. package/src/registries/menus/sheet_menu_registry.ts +75 -0
  100. package/src/registries/menus/topbar_menu_registry.ts +204 -0
  101. package/src/registries/side_panel_registry.ts +26 -0
  102. package/src/registries/topbar_component_registry.ts +12 -0
  103. package/src/registry.ts +51 -0
  104. package/src/translation.ts +44 -0
  105. package/src/types/autofill.ts +48 -0
  106. package/src/types/chart.ts +26 -0
  107. package/src/types/commands.ts +716 -0
  108. package/src/types/conditional_formatting.ts +124 -0
  109. package/src/types/env.ts +13 -0
  110. package/src/types/functions.ts +35 -0
  111. package/src/types/getters.ts +103 -0
  112. package/src/types/index.ts +20 -0
  113. package/src/types/misc.ts +143 -0
  114. package/src/types/rendering.ts +41 -0
  115. package/src/types/workbook_data.ts +62 -0
  116. package/tests/__mocks__/uuid.ts +7 -0
  117. package/tests/canvas.mock.ts +34 -0
  118. package/tests/components/__mocks__/content_editable_helper.ts +79 -0
  119. package/tests/components/__mocks__/scrollbar.ts +18 -0
  120. package/tests/components/__snapshots__/autocomplete_dropdown_test.ts.snap +29 -0
  121. package/tests/components/__snapshots__/bottom_bar_test.ts.snap +75 -0
  122. package/tests/components/__snapshots__/context_menu_test.ts.snap +88 -0
  123. package/tests/components/__snapshots__/grid_test.ts.snap +60 -0
  124. package/tests/components/__snapshots__/spreadsheet_test.ts.snap +455 -0
  125. package/tests/components/__snapshots__/top_bar_test.ts.snap +705 -0
  126. package/tests/components/autocomplete_dropdown_test.ts +315 -0
  127. package/tests/components/autofill_test.ts +167 -0
  128. package/tests/components/bottom_bar_test.ts +262 -0
  129. package/tests/components/chart_side_panel_test.ts +123 -0
  130. package/tests/components/composer_test.ts +400 -0
  131. package/tests/components/context_menu_test.ts +825 -0
  132. package/tests/components/grid_manipulation_test.ts +163 -0
  133. package/tests/components/grid_test.ts +581 -0
  134. package/tests/components/overlay_test.ts +541 -0
  135. package/tests/components/selection_input_test.ts +259 -0
  136. package/tests/components/side_panel_test.ts +148 -0
  137. package/tests/components/spreadsheet_test.ts +194 -0
  138. package/tests/components/top_bar_test.ts +427 -0
  139. package/tests/data_test.ts +175 -0
  140. package/tests/dom_helper.ts +42 -0
  141. package/tests/formulas/__snapshots__/compiler_test.ts.snap +302 -0
  142. package/tests/formulas/compiler_test.ts +266 -0
  143. package/tests/formulas/composer_tokenizer_test.ts +137 -0
  144. package/tests/formulas/expressions_test.ts +57 -0
  145. package/tests/formulas/formulas_test.ts +80 -0
  146. package/tests/formulas/normalize_test.ts +82 -0
  147. package/tests/formulas/parser_test.ts +224 -0
  148. package/tests/formulas/range_tokenizer_test.ts +187 -0
  149. package/tests/formulas/tokenizer_test.ts +164 -0
  150. package/tests/functions/arguments_test.ts +141 -0
  151. package/tests/functions/dates_test.ts +1081 -0
  152. package/tests/functions/functions_test.ts +53 -0
  153. package/tests/functions/helper_test.ts +98 -0
  154. package/tests/functions/module_database_test.ts +311 -0
  155. package/tests/functions/module_date_test.ts +941 -0
  156. package/tests/functions/module_info_test.ts +139 -0
  157. package/tests/functions/module_logical_test.ts +369 -0
  158. package/tests/functions/module_lookup_test.ts +541 -0
  159. package/tests/functions/module_math_test.ts +2482 -0
  160. package/tests/functions/module_operators_test.ts +955 -0
  161. package/tests/functions/module_statistical_test.ts +2014 -0
  162. package/tests/functions/module_text_test.ts +667 -0
  163. package/tests/helpers/coordinates_test.ts +25 -0
  164. package/tests/helpers/misc_test.ts +95 -0
  165. package/tests/helpers/numbers_test.ts +196 -0
  166. package/tests/helpers/zones_test.ts +97 -0
  167. package/tests/helpers.ts +384 -0
  168. package/tests/menu_items_registry_test.ts +540 -0
  169. package/tests/model/plugins/__snapshots__/chart_test.ts.snap +90 -0
  170. package/tests/model/plugins/chart_test.ts +562 -0
  171. package/tests/model_test.ts +82 -0
  172. package/tests/plugins/__snapshots__/conditional_formatting_test.ts.snap +131 -0
  173. package/tests/plugins/__snapshots__/renderer_test.ts.snap +371 -0
  174. package/tests/plugins/autofill_test.ts +457 -0
  175. package/tests/plugins/borders_test.ts +295 -0
  176. package/tests/plugins/clipboard_test.ts +1180 -0
  177. package/tests/plugins/conditional_formatting_test.ts +1253 -0
  178. package/tests/plugins/core_test.ts +614 -0
  179. package/tests/plugins/edition_test.ts +100 -0
  180. package/tests/plugins/evaluation_async_test.ts +332 -0
  181. package/tests/plugins/evaluation_dates_test.ts +79 -0
  182. package/tests/plugins/evaluation_test.ts +901 -0
  183. package/tests/plugins/figures_test.ts +327 -0
  184. package/tests/plugins/formatting_test.ts +391 -0
  185. package/tests/plugins/grid_manipulation_test.ts +1366 -0
  186. package/tests/plugins/highlight_test.ts +413 -0
  187. package/tests/plugins/history_test.ts +142 -0
  188. package/tests/plugins/import_export_test.ts +276 -0
  189. package/tests/plugins/merges_test.ts +490 -0
  190. package/tests/plugins/navigation_test.ts +181 -0
  191. package/tests/plugins/plugins/evaluation_test.ts +111 -0
  192. package/tests/plugins/renderer_test.ts +598 -0
  193. package/tests/plugins/resizing_test.ts +152 -0
  194. package/tests/plugins/selection_input_test.ts +409 -0
  195. package/tests/plugins/selection_test.ts +442 -0
  196. package/tests/plugins/sheets_test.ts +643 -0
  197. package/tests/plugins/style_test.ts +90 -0
  198. package/tsconfig.json +22 -0
@@ -0,0 +1,614 @@
1
+ import { functionRegistry } from "../../src/functions/index";
2
+ import { Model } from "../../src/model";
3
+ import { LOADING } from "../../src/plugins/evaluation";
4
+ import { getCell, waitForRecompute } from "../helpers";
5
+
6
+ describe("core", () => {
7
+ describe("aggregate", () => {
8
+ test("properly compute sum of current cells", () => {
9
+ const model = new Model();
10
+ model.dispatch("SET_VALUE", { xc: "A2", text: "3" });
11
+ model.dispatch("SET_VALUE", { xc: "A3", text: "54" });
12
+
13
+ expect(model.getters.getAggregate()).toBe(null);
14
+
15
+ model.dispatch("SELECT_CELL", { col: 0, row: 0 });
16
+
17
+ expect(model.getters.getAggregate()).toBe(null);
18
+
19
+ model.dispatch("ALTER_SELECTION", { cell: [0, 2] });
20
+ expect(model.getters.getAggregate()).toBe("57");
21
+ });
22
+
23
+ test("ignore cells with an error", () => {
24
+ const model = new Model();
25
+ model.dispatch("SET_VALUE", { xc: "A1", text: "2" });
26
+ model.dispatch("SET_VALUE", { xc: "A2", text: "=A2" });
27
+ model.dispatch("SET_VALUE", { xc: "A3", text: "3" });
28
+
29
+ // select A1
30
+ model.dispatch("SELECT_CELL", { col: 0, row: 0 });
31
+ expect(model.getters.getAggregate()).toBe(null);
32
+
33
+ // select A1:A2
34
+ model.dispatch("ALTER_SELECTION", { cell: [0, 1] });
35
+ expect(model.getters.getAggregate()).toBe(null);
36
+
37
+ // select A1:A3
38
+ model.dispatch("ALTER_SELECTION", { cell: [0, 2] });
39
+ expect(model.getters.getAggregate()).toBe("5");
40
+ });
41
+
42
+ describe("raise error from compilation with specific error message", () => {
43
+ functionRegistry.add("TWOARGSNEEDED", {
44
+ description: "any function",
45
+ compute: () => {
46
+ return true;
47
+ },
48
+ args: [
49
+ { name: "arg1", description: "", type: ["ANY"] },
50
+ { name: "arg2", description: "", type: ["ANY"] },
51
+ ],
52
+ returns: ["ANY"],
53
+ });
54
+
55
+ const model = new Model();
56
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=TWOARGSNEEDED(42)" });
57
+ expect(getCell(model, "A1")!.value).toBe("#BAD_EXPR");
58
+ expect(getCell(model, "A1")!.error).toBe(
59
+ `Invalid number of arguments for the TWOARGSNEEDED function. Expected 2, but got 1 instead.`
60
+ );
61
+ });
62
+
63
+ test("ignore async cells while they are not ready", async () => {
64
+ const model = new Model();
65
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=Wait(1000)" });
66
+ model.dispatch("SET_VALUE", { xc: "A2", text: "44" });
67
+
68
+ // select A1
69
+ model.dispatch("SELECT_CELL", { col: 0, row: 0 });
70
+ expect(model.getters.getAggregate()).toBe(null);
71
+
72
+ // select A1:A2
73
+ model.dispatch("ALTER_SELECTION", { cell: [0, 1] });
74
+ expect(model.getters.getAggregate()).toBe(null);
75
+
76
+ await waitForRecompute();
77
+ expect(model.getters.getAggregate()).toBe("1044");
78
+ });
79
+
80
+ test("format cell that point to an empty cell properly", () => {
81
+ const model = new Model();
82
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=A2" });
83
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("0");
84
+ });
85
+
86
+ test.each([
87
+ [undefined, ""],
88
+ [{ hello: 1 }, "[object Object]"],
89
+ [{ hello: 1, toString: () => "hello" }, "hello"],
90
+ [null, "0"],
91
+ ])("getCellText of cell with %j value", (a, expected) => {
92
+ const model = new Model();
93
+ expect(
94
+ model.getters.getCellText({
95
+ value: a,
96
+ col: 0,
97
+ row: 0,
98
+ type: "text",
99
+ xc: "A1",
100
+ })
101
+ ).toBe(expected);
102
+ });
103
+
104
+ test("format cell without content: empty string", () => {
105
+ const model = new Model();
106
+ model.dispatch("SELECT_CELL", { col: 1, row: 1 });
107
+ model.dispatch("SET_FORMATTING", {
108
+ sheet: model.getters.getActiveSheet(),
109
+ target: model.getters.getSelectedZones(),
110
+ border: "bottom",
111
+ });
112
+ expect(model.getters.getCellText(getCell(model, "B2")!)).toBe("");
113
+ });
114
+
115
+ test("format cell with the zero value", () => {
116
+ const model = new Model();
117
+ model.dispatch("SET_VALUE", { xc: "A1", text: "0" });
118
+ model.dispatch("SELECT_CELL", { col: 0, row: 0 });
119
+ model.dispatch("SET_FORMATTER", {
120
+ sheet: model.getters.getActiveSheet(),
121
+ target: model.getters.getSelectedZones(),
122
+ formatter: "0.00000",
123
+ });
124
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("0.00000");
125
+ model.dispatch("SET_VALUE", { xc: "A2", text: "0" });
126
+ model.dispatch("SELECT_CELL", { col: 0, row: 1 });
127
+ model.dispatch("SET_FORMATTER", {
128
+ sheet: model.getters.getActiveSheet(),
129
+ target: model.getters.getSelectedZones(),
130
+ formatter: "0.00%",
131
+ });
132
+ expect(model.getters.getCellText(getCell(model, "A2")!)).toBe("0.00%");
133
+ });
134
+
135
+ test("format a pendingcell: should not apply formatter to Loading...", () => {
136
+ const model = new Model();
137
+ model.dispatch("SET_VALUE", { xc: "B2", text: "=Wait(1000)" });
138
+ model.dispatch("SELECT_CELL", { col: 1, row: 1 });
139
+ model.dispatch("SET_FORMATTER", {
140
+ sheet: model.getters.getActiveSheet(),
141
+ target: model.getters.getSelectedZones(),
142
+ formatter: "#,##0.00",
143
+ });
144
+ expect(model.getters.getCellText(getCell(model, "B2")!)).toBe(LOADING);
145
+ });
146
+
147
+ test("evaluate properly a cell with a style just recently applied", () => {
148
+ const model = new Model();
149
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=sum(A2) + 1" });
150
+ model.dispatch("SET_FORMATTING", {
151
+ sheet: "Sheet1",
152
+ target: [{ left: 0, top: 0, right: 0, bottom: 0 }],
153
+ style: { bold: true },
154
+ });
155
+ expect(model.getters.getCellText(model.getters.getCell(0, 0)!)).toEqual("1");
156
+ });
157
+
158
+ test("format cell to a boolean value", () => {
159
+ const model = new Model();
160
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=false" });
161
+ model.dispatch("SET_VALUE", { xc: "A2", text: "=true" });
162
+
163
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("FALSE");
164
+ expect(model.getters.getCellText(getCell(model, "A2")!)).toBe("TRUE");
165
+ });
166
+
167
+ test("detect and format percentage values automatically", () => {
168
+ const model = new Model();
169
+ model.dispatch("SET_VALUE", { xc: "A1", text: "3%" });
170
+ model.dispatch("SET_VALUE", { xc: "A2", text: "3.4%" });
171
+
172
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("3%");
173
+ expect(getCell(model, "A1")!.format).toBe("0%");
174
+ expect(model.getters.getCellText(getCell(model, "A2")!)).toBe("3.40%");
175
+ expect(getCell(model, "A2")!.format).toBe("0.00%");
176
+ });
177
+ });
178
+
179
+ test("does not reevaluate cells if edition does not change content", () => {
180
+ const model = new Model();
181
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=rand()" });
182
+
183
+ expect(getCell(model, "A1")!.value).toBeDefined();
184
+ const val = getCell(model, "A1")!.value;
185
+
186
+ model.dispatch("START_EDITION");
187
+ model.dispatch("STOP_EDITION");
188
+ expect(getCell(model, "A1")!.value).toBe(val);
189
+ });
190
+
191
+ test("getCell getter does not crash if invalid col/row", () => {
192
+ const model = new Model();
193
+ expect(model.getters.getCell(-1, -1)).toBe(null);
194
+ });
195
+
196
+ test("single cell XC conversion", () => {
197
+ const model = new Model({});
198
+ expect(model.getters.zoneToXC(/*A1*/ { top: 0, left: 0, right: 0, bottom: 0 })).toBe("A1");
199
+ });
200
+
201
+ test("multi cell zone XC conversion", () => {
202
+ const model = new Model({});
203
+ expect(model.getters.zoneToXC(/*A1:B2*/ { top: 0, left: 0, right: 1, bottom: 1 })).toBe(
204
+ "A1:B2"
205
+ );
206
+ });
207
+
208
+ test("xc is expanded to overlapping merges", () => {
209
+ const model = new Model({
210
+ sheets: [{ colNumber: 10, rowNumber: 10, merges: ["A1:B2"] }],
211
+ });
212
+ expect(model.getters.zoneToXC(/*A2:B3*/ { top: 1, bottom: 2, left: 0, right: 1 })).toBe(
213
+ "A1:B3"
214
+ );
215
+ });
216
+
217
+ test("zone is across two merges", () => {
218
+ const model = new Model({
219
+ sheets: [{ colNumber: 10, rowNumber: 10, merges: ["A1:B2", "A4:B5"] }],
220
+ });
221
+ expect(model.getters.zoneToXC(/*A2:B4*/ { top: 1, bottom: 3, left: 0, right: 1 })).toBe(
222
+ "A1:B5"
223
+ );
224
+ });
225
+
226
+ test("merge is considered as one single cell", () => {
227
+ const model = new Model({
228
+ sheets: [{ colNumber: 10, rowNumber: 10, merges: ["A1:B2"] }],
229
+ });
230
+ expect(model.getters.zoneToXC(/*A2:B2*/ { top: 1, bottom: 1, left: 0, right: 1 })).toBe("A1");
231
+ });
232
+
233
+ test("can get row/col of inactive sheet", () => {
234
+ const model = new Model();
235
+ model.dispatch("CREATE_SHEET", { id: "42" });
236
+ const [, sheet2] = model.getters.getSheets();
237
+ model.dispatch("RESIZE_ROWS", { sheet: sheet2.id, rows: [0], size: 24 });
238
+ model.dispatch("RESIZE_COLUMNS", { sheet: sheet2.id, cols: [0], size: 42 });
239
+ expect(sheet2.id).not.toBe(model.getters.getActiveSheet());
240
+ expect(model.getters.getRow(sheet2.id, 0)).toEqual({
241
+ cells: {},
242
+ end: 24,
243
+ name: "1",
244
+ size: 24,
245
+ start: 0,
246
+ });
247
+ expect(model.getters.getCol(sheet2.id, 0)).toEqual({ end: 42, name: "A", size: 42, start: 0 });
248
+ });
249
+
250
+ test("can get row/col number of inactive sheet", () => {
251
+ const model = new Model({
252
+ sheets: [
253
+ { colNumber: 10, rowNumber: 10, id: "1" },
254
+ { colNumber: 19, rowNumber: 29, id: "2" },
255
+ ],
256
+ });
257
+ expect(model.getters.getActiveSheet()).not.toBe("2");
258
+ expect(model.getters.getNumberRows("2")).toEqual(29);
259
+ expect(model.getters.getNumberCols("2")).toEqual(19);
260
+ });
261
+
262
+ test("Range with absolute references are correctly updated on rows manipulation", () => {
263
+ const model = new Model();
264
+ model.dispatch("UPDATE_CELL", {
265
+ col: 0,
266
+ row: 0,
267
+ sheet: model.getters.getActiveSheet(),
268
+ content: "=SUM($C$1:$C$5)",
269
+ });
270
+ model.dispatch("ADD_ROWS", {
271
+ position: "after",
272
+ row: 2,
273
+ quantity: 1,
274
+ sheet: model.getters.getActiveSheet(),
275
+ });
276
+ expect(model.getters.getCell(0, 0)!.content).toBe("=SUM($C$1:$C$6)");
277
+ model.dispatch("ADD_ROWS", {
278
+ position: "before",
279
+ row: 0,
280
+ quantity: 1,
281
+ sheet: model.getters.getActiveSheet(),
282
+ });
283
+ expect(model.getters.getCell(0, 1)!.content).toBe("=SUM($C$2:$C$7)");
284
+ });
285
+
286
+ test("Absolute references are correctly updated on rows manipulation", () => {
287
+ const model = new Model();
288
+ model.dispatch("UPDATE_CELL", {
289
+ col: 0,
290
+ row: 0,
291
+ sheet: model.getters.getActiveSheet(),
292
+ content: "=SUM($C$1)",
293
+ });
294
+ model.dispatch("ADD_ROWS", {
295
+ position: "after",
296
+ row: 2,
297
+ quantity: 1,
298
+ sheet: model.getters.getActiveSheet(),
299
+ });
300
+ expect(model.getters.getCell(0, 0)!.content).toBe("=SUM($C$1)");
301
+ model.dispatch("ADD_ROWS", {
302
+ position: "before",
303
+ row: 0,
304
+ quantity: 1,
305
+ sheet: model.getters.getActiveSheet(),
306
+ });
307
+ expect(model.getters.getCell(0, 1)!.content).toBe("=SUM($C$2)");
308
+ });
309
+
310
+ test("Range with absolute references are correctly updated on columns manipulation", () => {
311
+ const model = new Model();
312
+ model.dispatch("UPDATE_CELL", {
313
+ col: 0,
314
+ row: 0,
315
+ sheet: model.getters.getActiveSheet(),
316
+ content: "=SUM($A$2:$E$2)",
317
+ });
318
+ model.dispatch("ADD_COLUMNS", {
319
+ position: "after",
320
+ column: 2,
321
+ quantity: 1,
322
+ sheet: model.getters.getActiveSheet(),
323
+ });
324
+ expect(model.getters.getCell(0, 0)!.content).toBe("=SUM($A$2:$F$2)");
325
+ model.dispatch("ADD_COLUMNS", {
326
+ position: "before",
327
+ column: 0,
328
+ quantity: 1,
329
+ sheet: model.getters.getActiveSheet(),
330
+ });
331
+ expect(model.getters.getCell(1, 0)!.content).toBe("=SUM($B$2:$G$2)");
332
+ });
333
+
334
+ test("Absolute references are correctly updated on columns manipulation", () => {
335
+ const model = new Model();
336
+ model.dispatch("UPDATE_CELL", {
337
+ col: 0,
338
+ row: 0,
339
+ sheet: model.getters.getActiveSheet(),
340
+ content: "=SUM($A$2)",
341
+ });
342
+ model.dispatch("ADD_COLUMNS", {
343
+ position: "after",
344
+ column: 2,
345
+ quantity: 1,
346
+ sheet: model.getters.getActiveSheet(),
347
+ });
348
+ expect(model.getters.getCell(0, 0)!.content).toBe("=SUM($A$2)");
349
+ model.dispatch("ADD_COLUMNS", {
350
+ position: "before",
351
+ column: 0,
352
+ quantity: 1,
353
+ sheet: model.getters.getActiveSheet(),
354
+ });
355
+ expect(model.getters.getCell(1, 0)!.content).toBe("=SUM($B$2)");
356
+ });
357
+ });
358
+
359
+ describe("history", () => {
360
+ test("can undo and redo a add cell operation", () => {
361
+ const model = new Model();
362
+
363
+ expect(model.getters.canUndo()).toBe(false);
364
+ expect(model.getters.canRedo()).toBe(false);
365
+
366
+ model.dispatch("START_EDITION", { text: "abc" });
367
+ model.dispatch("STOP_EDITION");
368
+
369
+ expect(getCell(model, "A1")!.content).toBe("abc");
370
+ expect(model.getters.canUndo()).toBe(true);
371
+ expect(model.getters.canRedo()).toBe(false);
372
+
373
+ model.dispatch("UNDO");
374
+ expect(getCell(model, "A1")).toBeNull();
375
+ expect(model.getters.canUndo()).toBe(false);
376
+ expect(model.getters.canRedo()).toBe(true);
377
+
378
+ model.dispatch("REDO");
379
+ expect(getCell(model, "A1")!.content).toBe("abc");
380
+ expect(model.getters.canUndo()).toBe(true);
381
+ expect(model.getters.canRedo()).toBe(false);
382
+ });
383
+
384
+ test("can undo and redo a cell update", () => {
385
+ const model = new Model({
386
+ sheets: [{ colNumber: 10, rowNumber: 10, cells: { A1: { content: "1" } } }],
387
+ });
388
+
389
+ expect(model.getters.canUndo()).toBe(false);
390
+ expect(model.getters.canRedo()).toBe(false);
391
+
392
+ model.dispatch("START_EDITION", { text: "abc" });
393
+ model.dispatch("STOP_EDITION");
394
+
395
+ expect(getCell(model, "A1")!.content).toBe("abc");
396
+ expect(model.getters.canUndo()).toBe(true);
397
+ expect(model.getters.canRedo()).toBe(false);
398
+
399
+ model.dispatch("UNDO");
400
+ expect(getCell(model, "A1")!.content).toBe("1");
401
+ expect(model.getters.canUndo()).toBe(false);
402
+ expect(model.getters.canRedo()).toBe(true);
403
+
404
+ model.dispatch("REDO");
405
+ expect(getCell(model, "A1")!.content).toBe("abc");
406
+ expect(model.getters.canUndo()).toBe(true);
407
+ expect(model.getters.canRedo()).toBe(false);
408
+ });
409
+
410
+ test("can undo and redo a delete cell operation", () => {
411
+ const model = new Model();
412
+ model.dispatch("SET_VALUE", { xc: "A2", text: "3" });
413
+
414
+ expect(getCell(model, "A2")!.content).toBe("3");
415
+ model.dispatch("SELECT_CELL", { col: 0, row: 1 });
416
+ model.dispatch("DELETE_CONTENT", {
417
+ sheet: model.getters.getActiveSheet(),
418
+ target: model.getters.getSelectedZones(),
419
+ });
420
+ expect(getCell(model, "A2")).toBeNull();
421
+
422
+ model.dispatch("UNDO");
423
+ expect(getCell(model, "A2")!.content).toBe("3");
424
+
425
+ model.dispatch("REDO");
426
+ expect(getCell(model, "A2")).toBeNull();
427
+ });
428
+
429
+ test("can delete a cell with a style", () => {
430
+ const model = new Model();
431
+ model.dispatch("SET_VALUE", { xc: "A1", text: "3" });
432
+ model.dispatch("SET_FORMATTING", {
433
+ sheet: "Sheet1",
434
+ target: [{ left: 0, top: 0, right: 0, bottom: 0 }],
435
+ style: { bold: true },
436
+ });
437
+
438
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("3");
439
+
440
+ model.dispatch("DELETE_CONTENT", {
441
+ sheet: model.getters.getActiveSheet(),
442
+ target: [{ left: 0, top: 0, right: 0, bottom: 0 }],
443
+ });
444
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("");
445
+ });
446
+
447
+ test("can delete a cell with a border", () => {
448
+ const model = new Model();
449
+ model.dispatch("SET_VALUE", { xc: "A1", text: "3" });
450
+ model.dispatch("SET_FORMATTING", {
451
+ sheet: model.getters.getActiveSheet(),
452
+ target: [{ left: 0, top: 0, right: 0, bottom: 0 }],
453
+ border: "bottom",
454
+ });
455
+
456
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("3");
457
+
458
+ model.dispatch("DELETE_CONTENT", {
459
+ sheet: model.getters.getActiveSheet(),
460
+ target: [{ left: 0, top: 0, right: 0, bottom: 0 }],
461
+ });
462
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("");
463
+ });
464
+
465
+ test("can delete a cell with a formatter", () => {
466
+ const model = new Model();
467
+ model.dispatch("SET_VALUE", { xc: "A1", text: "3" });
468
+ model.dispatch("SET_FORMATTER", {
469
+ sheet: model.getters.getActiveSheet(),
470
+ target: [{ left: 0, top: 0, right: 0, bottom: 0 }],
471
+ formatter: "#,##0.00",
472
+ });
473
+
474
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("3.00");
475
+
476
+ model.dispatch("DELETE_CONTENT", {
477
+ sheet: model.getters.getActiveSheet(),
478
+ target: [{ left: 0, top: 0, right: 0, bottom: 0 }],
479
+ });
480
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("");
481
+ });
482
+
483
+ test("setting a date to a cell will reformat it", () => {
484
+ const model = new Model();
485
+ model.dispatch("SET_VALUE", { xc: "A1", text: "03/2/2011" });
486
+ model.dispatch("SET_VALUE", { xc: "A2", text: " 03/12/2011" });
487
+ expect(getCell(model, "A1")!.content).toBe("03/02/2011");
488
+ expect(getCell(model, "A2")!.content).toBe("03/12/2011");
489
+ });
490
+
491
+ test("get cell formula text", () => {
492
+ const model = new Model();
493
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=SUM(1, 2)" });
494
+ model.dispatch("SET_VALUE", { xc: "A2", text: "This is Patrick" });
495
+ model.dispatch("SET_FORMULA_VISIBILITY", { show: true });
496
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("=SUM(1, 2)");
497
+ expect(model.getters.getCellText(getCell(model, "A2")!)).toBe("This is Patrick");
498
+ model.dispatch("SET_FORMULA_VISIBILITY", { show: false });
499
+ expect(model.getters.getCellText(getCell(model, "A1")!)).toBe("3");
500
+ expect(model.getters.getCellText(getCell(model, "A2")!)).toBe("This is Patrick");
501
+ });
502
+
503
+ test("set formula visibility is idempotent", () => {
504
+ const model = new Model();
505
+ model.dispatch("SET_FORMULA_VISIBILITY", { show: true });
506
+ expect(model.getters.shouldShowFormulas()).toBe(true);
507
+ model.dispatch("SET_FORMULA_VISIBILITY", { show: true });
508
+ expect(model.getters.shouldShowFormulas()).toBe(true);
509
+ model.dispatch("SET_FORMULA_VISIBILITY", { show: false });
510
+ expect(model.getters.shouldShowFormulas()).toBe(false);
511
+ });
512
+
513
+ describe("getters", () => {
514
+ test("getRangeFormattedValues", () => {
515
+ const sheet1Id = "42";
516
+ const sheet2Id = "43";
517
+ const model = new Model({
518
+ sheets: [
519
+ {
520
+ id: sheet1Id,
521
+ colNumber: 10,
522
+ rowNumber: 10,
523
+ cells: {
524
+ A1: { content: "1000", format: "#,##0" },
525
+ A3: { content: "2000", format: "#,##0" },
526
+ B2: { content: "TRUE", format: "#,##0" },
527
+ },
528
+ },
529
+ {
530
+ id: sheet2Id,
531
+ colNumber: 10,
532
+ rowNumber: 10,
533
+ cells: {
534
+ A1: { content: "21000", format: "#,##0" },
535
+ A3: { content: "12-31-2020", format: "mm/dd/yyyy" },
536
+ B2: { content: "TRUE", format: "#,##0" },
537
+ },
538
+ },
539
+ ],
540
+ });
541
+ model.dispatch("ACTIVATE_SHEET", { from: sheet1Id, to: sheet2Id }); // evaluate Sheet2
542
+ expect(model.getters.getRangeFormattedValues("A1:A3", sheet1Id)).toEqual([
543
+ ["1,000", "", "2,000"],
544
+ ]);
545
+ expect(model.getters.getRangeFormattedValues("$A$1:$A$3", sheet1Id)).toEqual([
546
+ ["1,000", "", "2,000"],
547
+ ]);
548
+ expect(model.getters.getRangeFormattedValues("Sheet1!A1:A3", sheet1Id)).toEqual([
549
+ ["1,000", "", "2,000"],
550
+ ]);
551
+ expect(model.getters.getRangeFormattedValues("Sheet2!A1:A3", sheet2Id)).toEqual([
552
+ ["21,000", "", "12/31/2020"],
553
+ ]);
554
+ expect(model.getters.getRangeFormattedValues("Sheet2!A1:A3", sheet1Id)).toEqual([
555
+ ["21,000", "", "12/31/2020"],
556
+ ]);
557
+ expect(model.getters.getRangeFormattedValues("B2", sheet1Id)).toEqual([["TRUE"]]);
558
+ expect(model.getters.getRangeFormattedValues("Sheet1!B2", sheet1Id)).toEqual([["TRUE"]]);
559
+ expect(model.getters.getRangeFormattedValues("Sheet2!B2", sheet2Id)).toEqual([["TRUE"]]);
560
+ expect(model.getters.getRangeFormattedValues("Sheet2!B2", sheet1Id)).toEqual([["TRUE"]]);
561
+ });
562
+
563
+ test("getRangeValues", () => {
564
+ const sheet1Id = "42";
565
+ const sheet2Id = "43";
566
+ const model = new Model({
567
+ sheets: [
568
+ {
569
+ id: sheet1Id,
570
+ colNumber: 10,
571
+ rowNumber: 10,
572
+ cells: {
573
+ A1: { content: "1000", format: "#,##0" },
574
+ A3: { content: "2000", format: "#,##0" },
575
+ B2: { content: "TRUE", format: "#,##0" },
576
+ },
577
+ },
578
+ {
579
+ id: sheet2Id,
580
+ colNumber: 10,
581
+ rowNumber: 10,
582
+ cells: {
583
+ A1: { content: "21000", format: "#,##0" },
584
+ A3: { content: "12-31-2020", format: "mm/dd/yyyy" },
585
+ B2: { content: "TRUE", format: "#,##0" },
586
+ },
587
+ },
588
+ ],
589
+ });
590
+ const date = {
591
+ format: "m-d-yyyy",
592
+ value: 44196,
593
+ jsDate: new Date("12-31-2020"),
594
+ };
595
+ expect(model.getters.getRangeValues("A1:A3", sheet1Id)).toEqual([[1000, undefined, 2000]]);
596
+ expect(model.getters.getRangeValues("$A$1:$A$3", sheet1Id)).toEqual([
597
+ [1000, undefined, 2000],
598
+ ]);
599
+ expect(model.getters.getRangeValues("Sheet1!A1:A3", sheet1Id)).toEqual([
600
+ [1000, undefined, 2000],
601
+ ]);
602
+ expect(model.getters.getRangeValues("Sheet2!A1:A3", sheet2Id)).toEqual([
603
+ [21000, undefined, date],
604
+ ]);
605
+ expect(model.getters.getRangeValues("Sheet2!A1:A3", sheet1Id)).toEqual([
606
+ [21000, undefined, date],
607
+ ]);
608
+ expect(model.getters.getRangeValues("B2", sheet1Id)).toEqual([[true]]);
609
+ expect(model.getters.getRangeValues("Sheet1!B2", sheet1Id)).toEqual([[true]]);
610
+ expect(model.getters.getRangeValues("Sheet2!B2", sheet2Id)).toEqual([[true]]);
611
+ expect(model.getters.getRangeValues("Sheet2!B2", sheet1Id)).toEqual([[true]]);
612
+ });
613
+ });
614
+ });