microsoft-graph 2.6.0 → 2.7.1

package/dist/cjs/tasks/getWorkbookWorksheetByName.d.ts

@@ -0,0 +1,13 @@
+import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
+import type { WorkbookRef } from "../models/WorkbookRef.ts";
+import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Get a worksheet by its name. Throws an error if not found.
+ *
+ * @param workbookRef - A reference to the workbook containing the worksheet.
+ * @param name - The name of the worksheet to retrieve.
+ * @throws {NotFoundError} If the worksheet with the specified name is not found.
+ * @returns The worksheet details.
+ */
+export default function getWorkbookWorksheetByName(workbookRef: WorkbookRef, name: string): Promise<WorkbookWorksheet & WorkbookWorksheetRef>;
+//# sourceMappingURL=getWorkbookWorksheetByName.d.ts.map

package/dist/cjs/tasks/getWorkbookWorksheetByName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkbookWorksheetByName.d.ts","sourceRoot":"","sources":["../../../src/tasks/getWorkbookWorksheetByName.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAG9E;;;;;;;GAOG;AACH,wBAA8B,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAUlJ"}

package/dist/cjs/tasks/getWorkbookWorksheetByName.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getWorkbookWorksheetByName;
+const NotFoundError_ts_1 = __importDefault(require("../errors/NotFoundError.js"));
+const listWorkbookWorksheets_ts_1 = __importDefault(require("../operations/workbookWorksheet/listWorkbookWorksheets.js"));
+/**
+ * Get a worksheet by its name. Throws an error if not found.
+ *
+ * @param workbookRef - A reference to the workbook containing the worksheet.
+ * @param name - The name of the worksheet to retrieve.
+ * @throws {NotFoundError} If the worksheet with the specified name is not found.
+ * @returns The worksheet details.
+ */
+async function getWorkbookWorksheetByName(workbookRef, name) {
+    // TODO: More performant to get it by a direct call without listing all workbooks?
+    const worksheets = await (0, listWorkbookWorksheets_ts_1.default)(workbookRef);
+    const worksheet = worksheets.find((worksheetRef) => worksheetRef.name === name);
+    if (!worksheet) {
+        throw new NotFoundError_ts_1.default(`Worksheet '${name}' not found.`);
+    }
+    return worksheet;
+}

package/dist/cjs/tasks/iterateWorkbookRangeValues.d.ts

@@ -0,0 +1,11 @@
+import type { RowRangeValues } from "../models/RowRangeValues.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+/**
+ * Iterates over the values of a workbook range in chunks, fetching data in manageable sizes.
+ *
+ * @param rangeRef - A reference to the workbook range to iterate over.
+ * @param overwriteRowsPerRequest - Optional. The number of rows to fetch per request. If omitted, it is automatically calculated.
+ * @returns An async iterable that yields rows of range values.
+ */
+export default function iterateWorkbookRangeValues(rangeRef: WorkbookRangeRef, overwriteRowsPerRequest?: number | null): AsyncIterable<RowRangeValues>;
+//# sourceMappingURL=iterateWorkbookRangeValues.d.ts.map

package/dist/cjs/tasks/iterateWorkbookRangeValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterateWorkbookRangeValues.d.ts","sourceRoot":"","sources":["../../../src/tasks/iterateWorkbookRangeValues.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AActE;;;;;;GAMG;AACH,wBAA+B,0BAA0B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,uBAAuB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC,cAAc,CAAC,CAoClK"}

package/dist/cjs/tasks/iterateWorkbookRangeValues.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = iterateWorkbookRangeValues;
+const InvalidArgumentError_ts_1 = __importDefault(require("../errors/InvalidArgumentError.js"));
+const getWorkbookWorksheetRange_ts_1 = __importDefault(require("../operations/workbookRange/getWorkbookWorksheetRange.js"));
+const addressManipulation_ts_1 = require("../services/addressManipulation.js");
+const addressOffset_ts_1 = require("../services/addressOffset.js");
+const workbookRange_ts_1 = require("../services/workbookRange.js");
+/**
+ * Maximum number of cells that can be retrieved in a single request, unless overwritten.
+ * @remarks The Microsoft Graph API documentation does not specify a fixed maximum number of cells that can be retrieved in a single request.
+ * However, it mentions that large ranges may result in errors due to resource constraints. Additionally, discussions in developer
+ * communities suggest that requests exceeding 10,000 cells may encounter issues.
+ */
+const maxCellsPerRequest = 10_000;
+/**
+ * Iterates over the values of a workbook range in chunks, fetching data in manageable sizes.
+ *
+ * @param rangeRef - A reference to the workbook range to iterate over.
+ * @param overwriteRowsPerRequest - Optional. The number of rows to fetch per request. If omitted, it is automatically calculated.
+ * @returns An async iterable that yields rows of range values.
+ */
+async function* iterateWorkbookRangeValues(rangeRef, overwriteRowsPerRequest = null) {
+    const address = rangeRef.address;
+    const components = (0, addressManipulation_ts_1.decomposeAddress)(address);
+    const columnsPerRow = (0, addressOffset_ts_1.columnAddressToOffset)(components.endColumn) - (0, addressOffset_ts_1.columnAddressToOffset)(components.startColumn) + 1;
+    if (overwriteRowsPerRequest !== null && overwriteRowsPerRequest < 1) {
+        throw new InvalidArgumentError_ts_1.default("overwriteRowsPerRequest must be greater than 0");
+    }
+    const rowsPerRequest = overwriteRowsPerRequest ?? Math.floor(maxCellsPerRequest / columnsPerRow);
+    const rangeStartRowOffset = (0, addressOffset_ts_1.rowAddressToOffset)(components.startRow);
+    const rangeEndRowOffset = (0, addressOffset_ts_1.rowAddressToOffset)(components.endRow);
+    for (let chunkRowOffset = rangeStartRowOffset; chunkRowOffset <= rangeEndRowOffset; chunkRowOffset = (chunkRowOffset + rowsPerRequest)) {
+        const requestStartRowOffset = chunkRowOffset;
+        const requestEndRowOffset = Math.min(chunkRowOffset + rowsPerRequest - 1, rangeEndRowOffset);
+        const chunkStartRow = (0, addressOffset_ts_1.offsetToRowAddress)(requestStartRowOffset);
+        const chunkEndRow = (0, addressOffset_ts_1.offsetToRowAddress)(requestEndRowOffset);
+        const requestAddress = (0, addressManipulation_ts_1.composeAddress)({
+            startRow: chunkStartRow,
+            endRow: chunkEndRow,
+            startColumn: components.startColumn,
+            endColumn: components.endColumn,
+        });
+        const requestRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(rangeRef, requestAddress);
+        const range = await (0, getWorkbookWorksheetRange_ts_1.default)(requestRef);
+        for (const row of range.values) {
+            yield row;
+        }
+    }
+}

package/dist/cjs/tasks/iterateWorkbookRangeValues.test.d.ts

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

package/dist/cjs/tasks/iterateWorkbookRangeValues.test.d.ts.map

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

package/dist/cjs/tasks/iterateWorkbookRangeValues.test.js

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const calculateWorkbook_ts_1 = __importDefault(require("../operations/workbook/calculateWorkbook.js"));
+const createWorkbook_ts_1 = __importDefault(require("../operations/workbook/createWorkbook.js"));
+const drive_ts_1 = require("../services/drive.js");
+const driveItem_ts_1 = require("../services/driveItem.js");
+const temporaryFiles_ts_1 = require("../services/temporaryFiles.js");
+const workbookRange_ts_1 = require("../services/workbookRange.js");
+const workbookWorksheet_ts_1 = require("../services/workbookWorksheet.js");
+const iterateWorkbookRangeValues_ts_1 = __importDefault(require("./iterateWorkbookRangeValues.js"));
+const setWorkbookRangeValues_ts_1 = __importDefault(require("./setWorkbookRangeValues.js"));
+const tryDeleteDriveItem_ts_1 = __importDefault(require("./tryDeleteDriveItem.js"));
+(0, vitest_1.describe)("iterateWorkbookRangeValues", () => {
+    (0, vitest_1.it)("Single request", async () => {
+        const workbookName = (0, temporaryFiles_ts_1.generateTempFileName)("xlsx");
+        const workbookPath = (0, driveItem_ts_1.driveItemPath)(workbookName);
+        const driveRef = (0, drive_ts_1.getDefaultDriveRef)();
+        const workbook = await (0, createWorkbook_ts_1.default)(driveRef, workbookPath);
+        const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbook, workbookWorksheet_ts_1.defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "A1:C3");
+            const values = [
+                [1, 2, 3],
+                [4, 5, 6],
+                [7, 8, 9],
+            ];
+            await (0, setWorkbookRangeValues_ts_1.default)(rangeRef, values);
+            await (0, calculateWorkbook_ts_1.default)(workbook);
+            let idx = 0;
+            for await (const row of (0, iterateWorkbookRangeValues_ts_1.default)(rangeRef)) {
+                (0, vitest_1.expect)(row).toEqual(values[idx++]);
+            }
+        }
+        finally {
+            await (0, tryDeleteDriveItem_ts_1.default)(workbook);
+        }
+    });
+    (0, vitest_1.it)("Multiple requests", async () => {
+        const workbookName = (0, temporaryFiles_ts_1.generateTempFileName)("xlsx");
+        const workbookPath = (0, driveItem_ts_1.driveItemPath)(workbookName);
+        const driveRef = (0, drive_ts_1.getDefaultDriveRef)();
+        const workbook = await (0, createWorkbook_ts_1.default)(driveRef, workbookPath);
+        const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbook, workbookWorksheet_ts_1.defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "A1:C3");
+            const values = [
+                [1, 2, 3],
+                [4, 5, 6],
+                [7, 8, 9],
+            ];
+            await (0, setWorkbookRangeValues_ts_1.default)(rangeRef, values);
+            await (0, calculateWorkbook_ts_1.default)(workbook);
+            let idx = 0;
+            for await (const row of (0, iterateWorkbookRangeValues_ts_1.default)(rangeRef, 1)) {
+                (0, vitest_1.expect)(row).toEqual(values[idx++]);
+            }
+        }
+        finally {
+            await (0, tryDeleteDriveItem_ts_1.default)(workbook);
+        }
+    });
+});

package/dist/cjs/tasks/safeDeleteWorkbook.d.ts

@@ -0,0 +1,10 @@
+import type { WorkbookRef } from "../models/WorkbookRef.ts";
+/**
+ * Safely delete a workbook by first closing any open sessions and then deleting it with a back-off retry to allow for any outstanding locks to be closed.
+ *
+ * @param workbookRef - A reference to the workbook to be deleted.
+ * @returns Void when the workbook is successfully deleted.
+ * @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md
+ */
+export default function safeDeleteWorkbook(workbookRef: WorkbookRef): Promise<void>;
+//# sourceMappingURL=safeDeleteWorkbook.d.ts.map

package/dist/cjs/tasks/safeDeleteWorkbook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"safeDeleteWorkbook.d.ts","sourceRoot":"","sources":["../../../src/tasks/safeDeleteWorkbook.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;;;;;GAMG;AACH,wBAA8B,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAKxF"}

package/dist/cjs/tasks/safeDeleteWorkbook.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = safeDeleteWorkbook;
+const closeWorkbookSession_ts_1 = __importDefault(require("../operations/workbookSession/closeWorkbookSession.js"));
+const deleteDriveItemWithRetry_ts_1 = __importDefault(require("./deleteDriveItemWithRetry.js"));
+/**
+ * Safely delete a workbook by first closing any open sessions and then deleting it with a back-off retry to allow for any outstanding locks to be closed.
+ *
+ * @param workbookRef - A reference to the workbook to be deleted.
+ * @returns Void when the workbook is successfully deleted.
+ * @see https://github.com/Future-Secure-AI/microsoft-graph/blob/main/docs/lockedWorkbook.md
+ */
+async function safeDeleteWorkbook(workbookRef) {
+    if (workbookRef.sessionId) {
+        await (0, closeWorkbookSession_ts_1.default)(workbookRef);
+    }
+    await (0, deleteDriveItemWithRetry_ts_1.default)(workbookRef);
+}

package/dist/cjs/tasks/setColumnHidden.d.ts

@@ -0,0 +1,11 @@
+import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+/**
+ * Hide or show one or more columns.
+ *
+ * @param rangeRef - A reference to the workbook range representing the columns to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the columns.
+ * @returns The updated workbook range.
+ */
+export default function setColumnHidden(rangeRef: WorkbookRangeRef, hidden: boolean): Promise<WorkbookRange & WorkbookRangeRef>;
+//# sourceMappingURL=setColumnHidden.d.ts.map

package/dist/cjs/tasks/setColumnHidden.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setColumnHidden.d.ts","sourceRoot":"","sources":["../../../src/tasks/setColumnHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,eAAe,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAWpI"}

package/dist/cjs/tasks/setColumnHidden.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = setColumnHidden;
+const updateWorkbookRange_ts_1 = __importDefault(require("../operations/workbookRange/updateWorkbookRange.js"));
+const addressManipulation_ts_1 = require("../services/addressManipulation.js");
+/**
+ * Hide or show one or more columns.
+ *
+ * @param rangeRef - A reference to the workbook range representing the columns to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the columns.
+ * @returns The updated workbook range.
+ */
+async function setColumnHidden(rangeRef, hidden) {
+    if ((0, addressManipulation_ts_1.isAllColumnsAddress)(rangeRef.address)) {
+        throw new Error("Cannot hide all columns");
+    }
+    const components = (0, addressManipulation_ts_1.decomposeAddress)(rangeRef.address);
+    rangeRef.address = `${components.startColumn}:${components.endColumn}`; // Workaround API explicitly wanting a range
+    return await (0, updateWorkbookRange_ts_1.default)(rangeRef, {
+        columnHidden: hidden,
+    });
+}

package/dist/cjs/tasks/setColumnHidden.test.d.ts

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

package/dist/cjs/tasks/setColumnHidden.test.d.ts.map

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

package/dist/cjs/tasks/setColumnHidden.test.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const calculateWorkbook_ts_1 = __importDefault(require("../operations/workbook/calculateWorkbook.js"));
+const createWorkbook_ts_1 = __importDefault(require("../operations/workbook/createWorkbook.js"));
+const getWorkbookVisibleRange_ts_1 = __importDefault(require("../operations/workbookRange/getWorkbookVisibleRange.js"));
+const updateWorkbookRange_ts_1 = __importDefault(require("../operations/workbookRange/updateWorkbookRange.js"));
+const drive_ts_1 = require("../services/drive.js");
+const driveItem_ts_1 = require("../services/driveItem.js");
+const temporaryFiles_ts_1 = require("../services/temporaryFiles.js");
+const workbookRange_ts_1 = require("../services/workbookRange.js");
+const workbookWorksheet_ts_1 = require("../services/workbookWorksheet.js");
+const setColumnHidden_ts_1 = __importDefault(require("./setColumnHidden.js"));
+const tryDeleteDriveItem_ts_1 = __importDefault(require("./tryDeleteDriveItem.js"));
+(0, vitest_1.describe)("setColumnHidden", () => {
+    (0, vitest_1.it)("hides a single column in an existing workbook", async () => {
+        const workbookName = (0, temporaryFiles_ts_1.generateTempFileName)("xlsx");
+        const workbookPath = (0, driveItem_ts_1.driveItemPath)(workbookName);
+        const driveRef = (0, drive_ts_1.getDefaultDriveRef)();
+        const workbook = await (0, createWorkbook_ts_1.default)(driveRef, workbookPath);
+        const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbook, workbookWorksheet_ts_1.defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "A1:C3");
+            await (0, updateWorkbookRange_ts_1.default)(rangeRef, {
+                values: [
+                    [1, 2, 3],
+                    [4, 5, 6],
+                    [7, 8, 9],
+                ],
+            });
+            const hiddenRange = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "B");
+            await (0, setColumnHidden_ts_1.default)(hiddenRange, true);
+            await (0, calculateWorkbook_ts_1.default)(workbook);
+            const visibleView = await (0, getWorkbookVisibleRange_ts_1.default)(rangeRef);
+            (0, vitest_1.expect)(visibleView.values).toEqual([
+                [1, 3],
+                [4, 6],
+                [7, 9],
+            ]);
+        }
+        finally {
+            await (0, tryDeleteDriveItem_ts_1.default)(workbook);
+        }
+    });
+    (0, vitest_1.it)("hides a multiple columns in an existing workbook", async () => {
+        const workbookName = (0, temporaryFiles_ts_1.generateTempFileName)("xlsx");
+        const workbookPath = (0, driveItem_ts_1.driveItemPath)(workbookName);
+        const driveRef = (0, drive_ts_1.getDefaultDriveRef)();
+        const workbook = await (0, createWorkbook_ts_1.default)(driveRef, workbookPath);
+        const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbook, workbookWorksheet_ts_1.defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "A1:C3");
+            await (0, updateWorkbookRange_ts_1.default)(rangeRef, {
+                values: [
+                    [1, 2, 3],
+                    [4, 5, 6],
+                    [7, 8, 9],
+                ],
+            });
+            const hiddenRange = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "B:C");
+            await (0, setColumnHidden_ts_1.default)(hiddenRange, true);
+            await (0, calculateWorkbook_ts_1.default)(workbook);
+            const visibleView = await (0, getWorkbookVisibleRange_ts_1.default)(rangeRef);
+            (0, vitest_1.expect)(visibleView.values).toEqual([[1], [4], [7]]);
+        }
+        finally {
+            await (0, tryDeleteDriveItem_ts_1.default)(workbook);
+        }
+    });
+});

package/dist/cjs/tasks/setRowHidden.d.ts

@@ -0,0 +1,11 @@
+import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+/**
+ * Hide or show one or more rows.
+ *
+ * @param rangeRef - A reference to the workbook range representing the rows to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the rows.
+ * @returns The updated workbook range.
+ */
+export default function setRowHidden(rangeRef: WorkbookRangeRef, hidden: boolean): Promise<WorkbookRange & WorkbookRangeRef>;
+//# sourceMappingURL=setRowHidden.d.ts.map

package/dist/cjs/tasks/setRowHidden.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setRowHidden.d.ts","sourceRoot":"","sources":["../../../src/tasks/setRowHidden.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAEtE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAWjI"}

package/dist/cjs/tasks/setRowHidden.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = setRowHidden;
+const updateWorkbookRange_ts_1 = __importDefault(require("../operations/workbookRange/updateWorkbookRange.js"));
+const addressManipulation_ts_1 = require("../services/addressManipulation.js");
+/**
+ * Hide or show one or more rows.
+ *
+ * @param rangeRef - A reference to the workbook range representing the rows to hide or show.
+ * @param hidden - A boolean indicating whether to hide (`true`) or show (`false`) the rows.
+ * @returns The updated workbook range.
+ */
+async function setRowHidden(rangeRef, hidden) {
+    if ((0, addressManipulation_ts_1.isAllRowsAddress)(rangeRef.address)) {
+        throw new Error("Cannot hide all rows");
+    }
+    const components = (0, addressManipulation_ts_1.decomposeAddress)(rangeRef.address);
+    rangeRef.address = `${components.startRow}:${components.endRow}`; // Workaround API explicitly wanting a range
+    return await (0, updateWorkbookRange_ts_1.default)(rangeRef, {
+        rowHidden: hidden,
+    });
+}

package/dist/cjs/tasks/setRowHidden.test.d.ts

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

package/dist/cjs/tasks/setRowHidden.test.d.ts.map

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

package/dist/cjs/tasks/setRowHidden.test.js

@@ -0,0 +1,72 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const calculateWorkbook_ts_1 = __importDefault(require("../operations/workbook/calculateWorkbook.js"));
+const createWorkbook_ts_1 = __importDefault(require("../operations/workbook/createWorkbook.js"));
+const getWorkbookVisibleRange_ts_1 = __importDefault(require("../operations/workbookRange/getWorkbookVisibleRange.js"));
+const updateWorkbookRange_ts_1 = __importDefault(require("../operations/workbookRange/updateWorkbookRange.js"));
+const drive_ts_1 = require("../services/drive.js");
+const driveItem_ts_1 = require("../services/driveItem.js");
+const temporaryFiles_ts_1 = require("../services/temporaryFiles.js");
+const workbookRange_ts_1 = require("../services/workbookRange.js");
+const workbookWorksheet_ts_1 = require("../services/workbookWorksheet.js");
+const setRowHidden_ts_1 = __importDefault(require("./setRowHidden.js"));
+const tryDeleteDriveItem_ts_1 = __importDefault(require("./tryDeleteDriveItem.js"));
+(0, vitest_1.describe)("setRowHidden", () => {
+    (0, vitest_1.it)("hides a single row in an existing workbook", async () => {
+        const workbookName = (0, temporaryFiles_ts_1.generateTempFileName)("xlsx");
+        const workbookPath = (0, driveItem_ts_1.driveItemPath)(workbookName);
+        const driveRef = (0, drive_ts_1.getDefaultDriveRef)();
+        const workbook = await (0, createWorkbook_ts_1.default)(driveRef, workbookPath);
+        const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbook, workbookWorksheet_ts_1.defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "A1:C3");
+            await (0, updateWorkbookRange_ts_1.default)(rangeRef, {
+                values: [
+                    [1, 2, 3],
+                    [4, 5, 6],
+                    [7, 8, 9],
+                ],
+            });
+            const hiddenRange = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "2");
+            await (0, setRowHidden_ts_1.default)(hiddenRange, true);
+            await (0, calculateWorkbook_ts_1.default)(workbook);
+            const visibleView = await (0, getWorkbookVisibleRange_ts_1.default)(rangeRef);
+            (0, vitest_1.expect)(visibleView.values).toEqual([
+                [1, 2, 3],
+                [7, 8, 9],
+            ]);
+        }
+        finally {
+            await (0, tryDeleteDriveItem_ts_1.default)(workbook);
+        }
+    });
+    (0, vitest_1.it)("hides multiple rows in an existing workbook", async () => {
+        const workbookName = (0, temporaryFiles_ts_1.generateTempFileName)("xlsx");
+        const workbookPath = (0, driveItem_ts_1.driveItemPath)(workbookName);
+        const driveRef = (0, drive_ts_1.getDefaultDriveRef)();
+        const workbook = await (0, createWorkbook_ts_1.default)(driveRef, workbookPath);
+        const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbook, workbookWorksheet_ts_1.defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "A1:C3");
+            await (0, updateWorkbookRange_ts_1.default)(rangeRef, {
+                values: [
+                    [1, 2, 3],
+                    [4, 5, 6],
+                    [7, 8, 9],
+                ],
+            });
+            const hiddenRange = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "2:3");
+            await (0, setRowHidden_ts_1.default)(hiddenRange, true);
+            await (0, calculateWorkbook_ts_1.default)(workbook);
+            const visibleView = await (0, getWorkbookVisibleRange_ts_1.default)(rangeRef);
+            (0, vitest_1.expect)(visibleView.values).toEqual([[1, 2, 3]]);
+        }
+        finally {
+            await (0, tryDeleteDriveItem_ts_1.default)(workbook);
+        }
+    });
+});

package/dist/cjs/tasks/setWorkbookRangeValues.d.ts

@@ -0,0 +1,11 @@
+import type { CellRangeValues } from "../models/CellRangeValues.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
+/**
+ * Sets the values of a specified workbook range.
+ *
+ * @param {WorkbookRangeRef} rangeRef - A reference to the workbook range to update.
+ * @param {CellRangeValues} values - The values to set in the specified workbook range. Must match the range's dimensions.
+ * @returns Nothing
+ */
+export default function setWorkbookRangeValues(rangeRef: WorkbookRangeRef, values: CellRangeValues): Promise<void>;
+//# sourceMappingURL=setWorkbookRangeValues.d.ts.map

package/dist/cjs/tasks/setWorkbookRangeValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setWorkbookRangeValues.d.ts","sourceRoot":"","sources":["../../../src/tasks/setWorkbookRangeValues.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAItE;;;;;;GAMG;AACH,wBAA8B,sBAAsB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,eAAe,iBAcvG"}

package/dist/cjs/tasks/setWorkbookRangeValues.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = setWorkbookRangeValues;
+const InvalidArgumentError_ts_1 = __importDefault(require("../errors/InvalidArgumentError.js"));
+const updateWorkbookRange_ts_1 = __importDefault(require("../operations/workbookRange/updateWorkbookRange.js"));
+const addressManipulation_ts_1 = require("../services/addressManipulation.js");
+/**
+ * Sets the values of a specified workbook range.
+ *
+ * @param {WorkbookRangeRef} rangeRef - A reference to the workbook range to update.
+ * @param {CellRangeValues} values - The values to set in the specified workbook range. Must match the range's dimensions.
+ * @returns Nothing
+ */
+async function setWorkbookRangeValues(rangeRef, values) {
+    const rowCount = (0, addressManipulation_ts_1.countAddressRows)(rangeRef.address);
+    if (values.length !== rowCount) {
+        throw new InvalidArgumentError_ts_1.default(`The number of rows in the values array (${values.length}) does not match the number of rows in the range (${rowCount}).`);
+    }
+    const columnCount = (0, addressManipulation_ts_1.countAddressColumns)(rangeRef.address);
+    if (values.some((row) => row.length !== columnCount)) {
+        throw new InvalidArgumentError_ts_1.default(`The number of columns in the values array does not match the number of columns in the range (${columnCount}).`);
+    }
+    await (0, updateWorkbookRange_ts_1.default)(rangeRef, {
+        values: values,
+    });
+}

package/dist/cjs/tasks/setWorkbookRangeValues.test.d.ts

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

package/dist/cjs/tasks/setWorkbookRangeValues.test.d.ts.map

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

package/dist/cjs/tasks/setWorkbookRangeValues.test.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const calculateWorkbook_ts_1 = __importDefault(require("../operations/workbook/calculateWorkbook.js"));
+const createWorkbook_ts_1 = __importDefault(require("../operations/workbook/createWorkbook.js"));
+const getWorkbookWorksheetUsedRange_ts_1 = __importDefault(require("../operations/workbookWorksheet/getWorkbookWorksheetUsedRange.js"));
+const drive_ts_1 = require("../services/drive.js");
+const driveItem_ts_1 = require("../services/driveItem.js");
+const temporaryFiles_ts_1 = require("../services/temporaryFiles.js");
+const workbookRange_ts_1 = require("../services/workbookRange.js");
+const workbookWorksheet_ts_1 = require("../services/workbookWorksheet.js");
+const setWorkbookRangeValues_ts_1 = __importDefault(require("./setWorkbookRangeValues.js"));
+const tryDeleteDriveItem_ts_1 = __importDefault(require("./tryDeleteDriveItem.js"));
+(0, vitest_1.describe)("setWorkbookRangeValues", () => {
+    (0, vitest_1.it)("calls updateWorkbookRange with the correct arguments when values match the range dimensions", async () => {
+        const workbookName = (0, temporaryFiles_ts_1.generateTempFileName)("xlsx");
+        const workbookPath = (0, driveItem_ts_1.driveItemPath)(workbookName);
+        const driveRef = (0, drive_ts_1.getDefaultDriveRef)();
+        const workbook = await (0, createWorkbook_ts_1.default)(driveRef, workbookPath);
+        const worksheetRef = (0, workbookWorksheet_ts_1.createWorkbookWorksheetRef)(workbook, workbookWorksheet_ts_1.defaultWorkbookWorksheetId);
+        try {
+            const rangeRef = (0, workbookRange_ts_1.createWorkbookRangeRef)(worksheetRef, "A1:C3");
+            const values = [
+                [1, 2, 3],
+                [4, 5, 6],
+                [7, 8, 9],
+            ];
+            await (0, setWorkbookRangeValues_ts_1.default)(rangeRef, values);
+            await (0, calculateWorkbook_ts_1.default)(workbook);
+            const visibleView = await (0, getWorkbookWorksheetUsedRange_ts_1.default)(rangeRef);
+            (0, vitest_1.expect)(visibleView.values).toEqual(values);
+        }
+        finally {
+            await (0, tryDeleteDriveItem_ts_1.default)(workbook);
+        }
+    });
+});

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

@@ -0,0 +1,12 @@
+import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
+/**
+ * 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 row's visibility.
+ *
+ * @param tableRef - A reference to the workbook table.
+ * @param values - A 2D array of strings representing the values to set in the visible rows of the table.
+ * @throws {InvalidArgumentError} If the number of columns in any row of `values` does not match the table's column count.
+ * @returns Void when the operation is complete.
+ */
+export declare function setWorkbookTableBodyVisibleRows(tableRef: WorkbookTableRef, values: string[][]): Promise<void>;
+//# sourceMappingURL=setWorkbookTableBodyVisibleRows.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"setWorkbookTableBodyVisibleRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/setWorkbookTableBodyVisibleRows.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAQtE;;;;;;;;GAQG;AACH,wBAAsB,+BAA+B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BnH"}