microsoft-graph 2.2.1 → 2.2.3

package/dist/tasks/setWorkbookTableBodyVisibleRows.js

@@ -0,0 +1,39 @@
+import InvalidArgumentError from "../errors/InvalidArgumentError.js";
+import NeverError from "../errors/NeverError.js";
+import insertWorkbookCells from "../operations/workbookRange/insertWorkbookCells.js";
+import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
+import getWorkbookTableBodyRange from "../operations/workbookTable/getWorkbookTableBodyRange.js";
+import getWorkbookWorksheetRange from "../operations/workbookWorksheet/getWorkbookWorksheetRange.js";
+import { cellToIndexes, getAddressEnd, getAddressStart, indexesToBox } from "../services/address.js";
+import { createWorkbookRangeRef } from "../services/workbookRange.js";
+/** Overwrite visible rows of a workbook table with the provided 2D array of values, inserting new rows at the end if needed. THIS IS SLOW as it must check each rows visibility. */
+export async function setWorkbookTableBodyVisibleRows(tableRef, values) {
+    const visibleRange = await getWorkbookTableBodyRange(tableRef);
+    if (values.some((row) => row.length !== visibleRange.columnCount)) {
+        throw new InvalidArgumentError(`Invalid number of columns in input values. Expected all rows to have ${visibleRange.columnCount}.`);
+    }
+    const [startRowIndex, startColumnIndex] = cellToIndexes(getAddressStart(visibleRange.address));
+    const [endRowIndex, endColumnIndex] = cellToIndexes(getAddressEnd(visibleRange.address));
+    if (endColumnIndex - startColumnIndex + 1 !== visibleRange.columnCount) {
+        throw new NeverError("Insane address");
+    }
+    let currentRowIndex = startRowIndex;
+    for (const srcRowValues of values) {
+        let dstRowRef;
+        let dstRow;
+        let dstRowHidden = false;
+        do {
+            dstRowRef = createWorkbookRangeRef(tableRef, indexesToBox(currentRowIndex, startColumnIndex, currentRowIndex, endColumnIndex));
+            if (currentRowIndex > endRowIndex) {
+                await insertWorkbookCells(dstRowRef, dstRowRef.address, "Down");
+                dstRowHidden = false;
+            }
+            else {
+                dstRow = await getWorkbookWorksheetRange(dstRowRef);
+                dstRowHidden = dstRow.rowHidden ?? false;
+            }
+            currentRowIndex++;
+        } while (dstRowHidden);
+        await updateWorkbookRange(dstRowRef, { values: [srcRowValues] });
+    }
+}

package/dist/tasks/setWorkbookTableBodyVisibleRows.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=setWorkbookTableBodyVisibleRows.test.d.ts.map

package/dist/tasks/setWorkbookTableBodyVisibleRows.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setWorkbookTableBodyVisibleRows.test.d.ts","sourceRoot":"","sources":["../../src/tasks/setWorkbookTableBodyVisibleRows.test.ts"],"names":[],"mappings":""}

package/dist/tasks/setWorkbookTableBodyVisibleRows.test.js

@@ -0,0 +1,83 @@
+import { describe, expect, it } from "vitest";
+import calculateWorkbook from "../operations/workbook/calculateWorkbook.js";
+import createWorkbook from "../operations/workbook/createWorkbook.js";
+import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.js";
+import createWorkbookTable from "../operations/workbookTable/createWorkbookTable.js";
+import { getDefaultDriveRef } from "../services/drive.js";
+import { driveItemPath } from "../services/driveItem.js";
+import { generateTempFileName } from "../services/temporaryFiles.js";
+import { createWorkbookRangeRef } from "../services/workbookRange.js";
+import { createDefaultWorkbookWorksheetRef } from "../services/workbookWorksheet.js";
+import deleteDriveItemWithRetry from "./deleteDriveItemWithRetry.js";
+import { getWorkbookTableVisibleBody } from "./getWorkbookTableVisibleBody.js";
+import setRowHidden from "./setRowHidden.js";
+import { setWorkbookTableBodyVisibleRows } from "./setWorkbookTableBodyVisibleRows.js";
+describe("setWorkbookTableBodyVisibleRows", () => {
+    it("writes input rows to visible rows of a table", { timeout: 30000 }, async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            const worksheetRef = createDefaultWorkbookWorksheetRef(workbook);
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D4");
+            const table = await createWorkbookTable(rangeRef, true);
+            await updateWorkbookRange(rangeRef, {
+                values: [
+                    ["Header1", "Header2", "Header3", "Header4"],
+                    ["OldValue1", "OldValue2", "OldValue3", "OldValue4"],
+                    ["OldValue5", "OldValue6", "OldValue7", "OldValue8"], // <== Will be hidden and therefore preserved
+                    ["OldValue9", "OldValue10", "OldValue11", "OldValue12"],
+                ],
+            });
+            await setRowHidden(createWorkbookRangeRef(worksheetRef, "A3:A3"), true);
+            await calculateWorkbook(workbook);
+            await setWorkbookTableBodyVisibleRows(table, [
+                ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
+                ["NewValue5", "NewValue6", "NewValue7", "NewValue8"],
+            ]);
+            const visibleBodyRange = await getWorkbookTableVisibleBody(table);
+            expect(visibleBodyRange.values).toEqual([
+                ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
+                ["OldValue5", "OldValue6", "OldValue7", "OldValue8"],
+                ["NewValue5", "NewValue6", "NewValue7", "NewValue8"],
+            ]);
+        }
+        finally {
+            await deleteDriveItemWithRetry(workbook);
+        }
+    });
+    it("writes input rows to visible rows of a table with insert", { timeout: 30000 }, async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        try {
+            const worksheetRef = createDefaultWorkbookWorksheetRef(workbook);
+            const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:D3");
+            const table = await createWorkbookTable(rangeRef, true);
+            await updateWorkbookRange(rangeRef, {
+                values: [
+                    ["Header1", "Header2", "Header3", "Header4"],
+                    ["OldValue1", "OldValue2", "OldValue3", "OldValue4"],
+                    ["OldValue5", "OldValue6", "OldValue7", "OldValue8"], // <== Will be hidden and therefore preserved
+                ],
+            });
+            await setRowHidden(createWorkbookRangeRef(worksheetRef, "A3:A3"), true);
+            await calculateWorkbook(workbook);
+            await setWorkbookTableBodyVisibleRows(table, [
+                ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
+                ["NewValue5", "NewValue6", "NewValue7", "NewValue8"],
+            ]);
+            const visibleBodyRange = await getWorkbookTableVisibleBody(table);
+            expect(visibleBodyRange.values).toEqual([
+                ["NewValue1", "NewValue2", "NewValue3", "NewValue4"],
+                ["OldValue5", "OldValue6", "OldValue7", "OldValue8"],
+                ["NewValue5", "NewValue6", "NewValue7", "NewValue8"],
+            ]);
+        }
+        finally {
+            await deleteDriveItemWithRetry(workbook);
+        }
+    });
+});