microsoft-graph 2.15.2 → 2.17.0

package/dist/esm/services/source.js

@@ -0,0 +1,178 @@
+// import InvalidOperationError from "../errors/InvalidOperationError.ts";
+// import NeverError from "../errors/NeverError.ts";
+// import type { Cell } from "../models/Cell.ts";
+// import type { ColumnName } from "../models/ColumnName.ts";
+// import type { ColumnOffset } from "../models/ColumnOffset.ts";
+// import type { Item } from "../models/Item.ts";
+// import type { RecordBase } from "../models/RecordBase.ts";
+// import type { RowNumber } from "../models/RowNumber.ts";
+// import type { RowOffset } from "../models/RowOffset.ts";
+// import type { Source } from "../models/source.ts";
+// import type { SourceDecoder } from "../models/SourceDecoder.ts";
+// import type { SourceEncoder } from "../models/SourceEncoder.ts";
+// import type { SourceRow } from "../models/SourceRow.ts";
+// import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+// import deleteWorkbookRange from "../operations/workbookRange/deleteWorkbookRange.ts";
+// import insertWorkbookCells from "../operations/workbookRange/insertWorkbookCells.ts";
+// import setWorkbookRangeFont from "../operations/workbookRange/setWorkbookRangeFont.ts";
+// import updateWorkbookRange from "../operations/workbookRange/updateWorkbookRange.ts";
+// import getWorkbookWorksheetUsedRangeAddress from "../operations/workbookWorksheet/getWorkbookWorksheetUsedRangeAddress.ts";
+// import iterateWorkbookRange from "../tasks/iterateWorkbookRange.ts";
+// import { countAddressColumns, countAddressRows } from "./addressManipulation.ts";
+// import { rowOffsetToAddress } from "./addressOffset.ts";
+// import { addressToCartesian, cartesianToAddress } from "./cartesianAddress.ts";
+// import { createWorkbookRangeRef } from "./workbookRange.ts";
+export {};
+// export async function defineSource<T extends RecordBase>(worksheetRef: WorkbookWorksheetRef, decode: SourceDecoder<T>, encode: SourceEncoder<T>): Promise<Source<T>> {
+// 	const usedRange = await getWorkbookWorksheetUsedRangeAddress(worksheetRef);
+// 	const rangeRef = createWorkbookRangeRef(worksheetRef, usedRange);
+// 	const b = addressToCartesian(usedRange);
+// 	// TODO: Header
+// 	const a = await getWorkbookWorksheetRange();
+// 	const source: Source<T> = {
+// 		rangeRef,
+// 		coding: {
+// 			decode,
+// 			encode,
+// 		},
+// 		head: [],
+// 		async *[Symbol.asyncIterator](): AsyncGenerator<Item<T>> {
+// 			let hasHead = false;
+// 			for await (const { rowOffset, row } of iterateWorkbookRange(rangeRef)) {
+// 				if (!hasHead) {
+// 					source.head = row.map((cell) => cell.text) as ColumnName[];
+// 					hasHead = true;
+// 					continue;
+// 				}
+// 				const record = rowToRecord<T>(row, source);
+// 				const rowNumber = rowOffsetToNumber(rowOffset);
+// 				yield {
+// 					rowOffset,
+// 					rowNumber,
+// 					record,
+// 				};
+// 			}
+// 		},
+// 	};
+// 	return source;
+// }
+// export async function initializeSource<T extends RecordBase>(source: Source<T>, empty: T): Promise<void> {
+// 	if (!isEmpty(source)) {
+// 		throw new InvalidOperationError("Cannot initialize source with non-empty worksheet.");
+// 	}
+// 	source.head = Object.keys(empty) as ColumnName[];
+// 	const address = cartesianToAddress({
+// 		ax: 0 as ColumnOffset,
+// 		bx: (source.head.length - 1) as ColumnOffset,
+// 		ay: 0 as RowOffset,
+// 		by: 0 as RowOffset,
+// 	});
+// 	source.rangeRef = createWorkbookRangeRef(source.rangeRef, address);
+// 	await updateWorkbookRange(source.rangeRef, {
+// 		values: [source.head],
+// 	});
+// 	await setWorkbookRangeFont(source.rangeRef, {
+// 		bold: true,
+// 	});
+// }
+// export async function readAllItems<T extends RecordBase>(source: Source<T>): Promise<Item<T>[]> {
+// 	const result: Item<T>[] = [];
+// 	for await (const item of source) {
+// 		result.push(item);
+// 	}
+// 	return result;
+// }
+// export async function createItem<T extends RecordBase>(source: Source<T>, record: T, after: RowOffset = 0 as RowOffset): Promise<Item<T>> {
+// 	if (!isInitialized(source)) {
+// 		throw new InvalidOperationError("Source not initialized.");
+// 	}
+// 	await insertWorkbookCells(source.rangeRef, rowOffsetToAddress(after), "Down");
+// 	const row = recordToRow(record, source);
+// 	const address = cartesianToAddress({
+// 		ax: 0 as ColumnOffset,
+// 		bx: (row.length - 1) as ColumnOffset,
+// 		ay: after,
+// 		by: after,
+// 	});
+// 	const rangeRef = createWorkbookRangeRef(source.rangeRef, address);
+// 	await updateWorkbookRange(rangeRef, {
+// 		values: [row],
+// 		// TODO: Format
+// 	});
+// 	const { ax, bx, ay, by } = addressToCartesian(source.rangeRef.address);
+// 	source.rangeRef.address = cartesianToAddress({
+// 		ax,
+// 		bx,
+// 		ay,
+// 		by: (by + 1) as RowOffset,
+// 	});
+// 	return {
+// 		rowOffset: after,
+// 		rowNumber: rowOffsetToNumber(after),
+// 		record,
+// 	};
+// }
+// export async function updateItem<T extends RecordBase>(source: Source<T>, offset: RowOffset, record: T): Promise<void> {
+// 	if (!isInitialized(source)) {
+// 		throw new InvalidOperationError("Source not initialized.");
+// 	}
+// 	const row = recordToRow(record, source);
+// 	const address = cartesianToAddress({
+// 		ax: 0 as ColumnOffset,
+// 		bx: (row.length - 1) as ColumnOffset,
+// 		ay: offset,
+// 		by: offset,
+// 	});
+// 	const rangeRef = createWorkbookRangeRef(source.rangeRef, address);
+// 	await updateWorkbookRange(rangeRef, {
+// 		values: [row],
+// 		// TODO: format
+// 	});
+// }
+// export async function deleteItem<T extends RecordBase>(source: Source<T>, offset: RowOffset): Promise<void> {
+// 	if (!isInitialized(source)) {
+// 		throw new InvalidOperationError("Source not initialized.");
+// 	}
+// 	const rangeRef = createWorkbookRangeRef(source.rangeRef, rowOffsetToAddress(offset));
+// 	await deleteWorkbookRange(rangeRef, "Up");
+// 	const { ax, bx, ay, by } = addressToCartesian(source.rangeRef.address);
+// 	source.rangeRef.address = cartesianToAddress({
+// 		ax,
+// 		bx,
+// 		ay,
+// 		by: (by - 1) as RowOffset,
+// 	});
+// }
+// function rowToRecord<T extends RecordBase>(row: Cell[], source: Source<T>): T {
+// 	const sourceRow = source.head.reduce((acc, heading, columnIndex) => {
+// 		const cell = row[columnIndex];
+// 		if (!cell) {
+// 			throw new NeverError(`Cell at index ${columnIndex} is undefined`);
+// 		}
+// 		acc[heading] = cell;
+// 		return acc;
+// 	}, {} as SourceRow);
+// 	const record = source.coding.decode(sourceRow);
+// 	return record;
+// }
+// function recordToRow<T extends RecordBase>(record: T, source: Source<T>): Cell[] {
+// 	const sourceRow = source.coding.encode(record);
+// 	const row = source.head.map((heading) => {
+// 		const cell = sourceRow[heading];
+// 		if (cell === undefined) {
+// 			throw new NeverError(`Cell at index ${heading} is undefined`);
+// 		}
+// 		return cell;
+// 	});
+// 	return row;
+// }
+// function rowOffsetToNumber(offset: RowOffset): RowNumber {
+// 	return (offset + 1) as RowNumber;
+// }
+// function isEmpty<T extends RecordBase>(source: Source<T>) {
+// 	return countAddressRows(source.rangeRef.address) <= 1 && countAddressColumns(source.rangeRef.address) <= 1;
+// }
+// function isInitialized<T extends RecordBase>(source: Source<T>) {
+// 	return source.head.length > 0;
+// }
+// // TODO: Tidy Cell/CellValue types

package/dist/esm/tasks/iterateWorkbookRange.d.ts

@@ -0,0 +1,15 @@
+import type { Cell } from "../models/Cell.ts";
+import type { RowOffset } from "../models/RowOffset.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 iterateWorkbookRange(rangeRef: WorkbookRangeRef, overwriteRowsPerRequest?: number | null): AsyncIterable<{
+    rowOffset: RowOffset;
+    row: Cell[];
+}>;
+//# sourceMappingURL=iterateWorkbookRange.d.ts.map

package/dist/esm/tasks/iterateWorkbookRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterateWorkbookRange.d.ts","sourceRoot":"","sources":["../../../src/tasks/iterateWorkbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AActE;;;;;;GAMG;AACH,wBAA+B,oBAAoB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,uBAAuB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC;IAAE,SAAS,EAAE,SAAS,CAAC;IAAC,GAAG,EAAE,IAAI,EAAE,CAAA;CAAE,CAAC,CAsDnL"}

package/dist/esm/tasks/iterateWorkbookRange.js

@@ -0,0 +1,62 @@
+import InvalidArgumentError from "../errors/InvalidArgumentError.js";
+import getWorkbookWorksheetRange from "../operations/workbookRange/getWorkbookWorksheetRange.js";
+import { composeAddress, countAddressColumns, decomposeAddress } from "../services/addressManipulation.js";
+import { columnAddressToOffset, rowAddressToOffset, rowOffsetToAddress } from "../services/addressOffset.js";
+import { createWorkbookRangeRef } from "../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.
+ */
+export default async function* iterateWorkbookRange(rangeRef, overwriteRowsPerRequest = null) {
+    const address = rangeRef.address;
+    const components = decomposeAddress(address);
+    const columnsPerRow = columnAddressToOffset(components.endColumn) - columnAddressToOffset(components.startColumn) + 1;
+    if (overwriteRowsPerRequest !== null && overwriteRowsPerRequest < 1) {
+        throw new InvalidArgumentError("overwriteRowsPerRequest must be greater than 0");
+    }
+    const columnCount = countAddressColumns(address);
+    const rowsPerRequest = overwriteRowsPerRequest ?? Math.floor(maxCellsPerRequest / columnsPerRow);
+    const rangeStartRowOffset = rowAddressToOffset(components.startRow);
+    const rangeEndRowOffset = rowAddressToOffset(components.endRow);
+    let offset = 0;
+    for (let chunkRowOffset = rangeStartRowOffset; chunkRowOffset <= rangeEndRowOffset; chunkRowOffset = (chunkRowOffset + rowsPerRequest)) {
+        const requestStartRowOffset = chunkRowOffset;
+        const requestEndRowOffset = Math.min(chunkRowOffset + rowsPerRequest - 1, rangeEndRowOffset);
+        const chunkStartRow = rowOffsetToAddress(requestStartRowOffset);
+        const chunkEndRow = rowOffsetToAddress(requestEndRowOffset);
+        const requestAddress = composeAddress({
+            startRow: chunkStartRow,
+            endRow: chunkEndRow,
+            startColumn: components.startColumn,
+            endColumn: components.endColumn,
+        });
+        const requestRef = createWorkbookRangeRef(rangeRef, requestAddress);
+        const range = await getWorkbookWorksheetRange(requestRef);
+        const values = range.values;
+        const text = range.text;
+        const numberFormat = range.numberFormat;
+        const rowCount = values.length;
+        for (let r = 0; r < rowCount; r++) {
+            const row = Array.from({ length: columnCount }, (_, c) => ({
+                text: text[r]?.[c] ?? "",
+                value: values[r]?.[c] ?? "",
+                numberFormat: numberFormat?.[r]?.[c] ?? "",
+            }));
+            yield {
+                rowOffset: offset,
+                row,
+            };
+            offset++;
+        }
+    }
+}

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

@@ -6,6 +6,7 @@ import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
  * @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.
+ * @deprecated Use `iterateWorkbookRange` instead.
  */
 export default function iterateWorkbookRangeValues(rangeRef: WorkbookRangeRef, overwriteRowsPerRequest?: number | null): AsyncIterable<RowRangeValues>;
 //# sourceMappingURL=iterateWorkbookRangeValues.d.ts.map

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

@@ -1 +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"}
+{"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;;;;;;;GAOG;AACH,wBAA+B,0BAA0B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,uBAAuB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC,cAAc,CAAC,CAoClK"}

package/dist/esm/tasks/iterateWorkbookRangeValues.js

@@ -16,6 +16,7 @@ const maxCellsPerRequest = 10_000;
  * @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.
+ * @deprecated Use `iterateWorkbookRange` instead.
  */
 export default async function* iterateWorkbookRangeValues(rangeRef, overwriteRowsPerRequest = null) {
     const address = rangeRef.address;