microsoft-graph 2.31.0 → 2.32.0

package/dist/esm/services/dataSource.js

@@ -14,7 +14,7 @@ import getWorkbookWorksheetUsedRangeRef from "../operations/workbookWorksheet/ge
 import readWorkbookRows from "../tasks/readWorkbookRows.js";
 import { countAddressRows, subRange, superRange } from "./addressManipulation.js";
 import { addressToCartesian } from "./cartesianAddress.js";
-import { generalCellFormat } from "./cellFormat.js";
+import { generalCellFormat } from "./cell.js";
 /**
  * Define a datasource from an entire worksheet.
  * @template T Type of the record, extending RecordBase.

package/dist/esm/services/drive.d.ts

@@ -21,6 +21,7 @@ export declare function createClientSecretContextWithDriveRef(tenantId: AzureTen
  * @returns A reference to the default drive.
  * @remarks This method is opinionated and not recommended for production use.
  * @deprecated Use `createClientSecretContextWithDriveRef()` instead.
+ * @hidden
  */
 export declare function getDefaultDriveRef(): DriveRef;
 //# sourceMappingURL=drive.d.ts.map

package/dist/esm/services/drive.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"drive.d.ts","sourceRoot":"","sources":["../../../src/services/drive.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAChH,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAKzD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAUvF;AAED,qDAAqD;AACrD,wBAAgB,qCAAqC,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,QAAQ,CAKnL;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAY7C"}
+{"version":3,"file":"drive.d.ts","sourceRoot":"","sources":["../../../src/services/drive.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAChH,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAKzD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAUvF;AAED,qDAAqD;AACrD,wBAAgB,qCAAqC,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,QAAQ,CAKnL;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAY7C"}

package/dist/esm/services/drive.js

@@ -36,6 +36,7 @@ export function createClientSecretContextWithDriveRef(tenantId, clientId, client
  * @returns A reference to the default drive.
  * @remarks This method is opinionated and not recommended for production use.
  * @deprecated Use `createClientSecretContextWithDriveRef()` instead.
+ * @hidden
  */
 export function getDefaultDriveRef() {
     const tenantId = getEnvironmentVariable("AZURE_TENANT_ID");

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

@@ -4,21 +4,33 @@
  * @category Tasks
  * @experimental
  */
-import type { CellScope } from "../models/Cell.ts";
-import type { Row } from "../models/Row.ts";
+import type { Cell, CellScope } from "../models/Cell.ts";
+import type { RowOffset } from "../models/Row.ts";
 import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+/**
+ * Represents a row yielded by the {@link iterateRows} generator.
+ * @property {Cell[]} cells Array of cells in the row, each containing value, text, format, and optionally style information depending on the scope.
+ * @property {RowOffset} offset Zero-based offset of the row within the original range.
+ * @property {boolean} isFirst If this is the first row in the iteration.
+ * @property {boolean} isLast If this is the last row in the iteration.
+ */
+export type IteratedRow = {
+    cells: Cell[];
+    offset: RowOffset;
+    isFirst: boolean;
+    isLast: boolean;
+};
 /**
  * Iterate over the rows in a given worksheet range.
  * @param rangeRef Reference to the workbook range to iterate over.
- * @param skip Number of rows to skip before starting to yield rows. Can be negative to get last rows (e.g., -1 for the last row).
- * @param take Max number of rows to yield. `POSITIVE_INFINITY` returns all rows.
  * @param scope Amount of detail to include for each cell.
  * @param maxCellsPerOperation Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING.
  * @remarks Including `style` in the scope requires over three operations for each and every cell. Use this sparingly!
+ * @experimental
  * @example
- * for await (const row of iterateRows(rangeRef)) {
+ * for await (const { row } of iterateRows(rangeRef)) {
  *   console.log(row);
  * }
  */
-export declare function iterateRows(rangeRef: WorkbookRangeRef, skip?: number, take?: number, scope?: Partial<CellScope>, maxCellsPerOperation?: number | null): AsyncIterable<Row>;
+export declare function iterateRows(rangeRef: WorkbookRangeRef, scope?: Partial<CellScope>, maxCellsPerOperation?: number | null): AsyncIterable<IteratedRow>;
 //# sourceMappingURL=iterateRows.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"iterateRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/iterateRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAA6C,SAAS,EAAwE,MAAM,mBAAmB,CAAC;AAGpK,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAWnE;;;;;;;;;;;;GAYG;AACH,wBAAuB,WAAW,CAAC,QAAQ,EAAE,gBAAgB,EAAE,IAAI,SAAI,EAAE,IAAI,GAAE,MAAiC,EAAE,KAAK,GAAE,OAAO,CAAC,SAAS,CAAgB,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC,GAAG,CAAC,CAiC1N"}
+{"version":3,"file":"iterateRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/iterateRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,IAAI,EAAuC,SAAS,EAAwE,MAAM,mBAAmB,CAAC;AAIpK,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAUnE;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAuB,WAAW,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,GAAE,OAAO,CAAC,SAAS,CAAoB,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,aAAa,CAAC,WAAW,CAAC,CAwCnL"}

package/dist/esm/tasks/iterateRows.js

@@ -12,45 +12,51 @@ import getWorkbookWorksheetRange from "../operations/workbookRange/getWorkbookWo
 import listWorkbookRangeBorders from "../operations/workbookRange/listWorkbookRangeBorders.js";
 import { countAddressColumns, countAddressRows, subRange } from "../services/addressManipulation.js";
 import { maxCellsPerRequest } from "../services/batch.js";
-const defaultScope = { values: true, text: true, format: true };
+import { defaultCellScope } from "../services/cell.js";
 /**
  * Iterate over the rows in a given worksheet range.
  * @param rangeRef Reference to the workbook range to iterate over.
- * @param skip Number of rows to skip before starting to yield rows. Can be negative to get last rows (e.g., -1 for the last row).
- * @param take Max number of rows to yield. `POSITIVE_INFINITY` returns all rows.
  * @param scope Amount of detail to include for each cell.
  * @param maxCellsPerOperation Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING.
  * @remarks Including `style` in the scope requires over three operations for each and every cell. Use this sparingly!
+ * @experimental
  * @example
- * for await (const row of iterateRows(rangeRef)) {
+ * for await (const { row } of iterateRows(rangeRef)) {
  *   console.log(row);
  * }
  */
-export async function* iterateRows(rangeRef, skip = 0, take = Number.POSITIVE_INFINITY, scope = defaultScope, maxCellsPerOperation = null) {
-    const totalRangeRef = subRange(rangeRef, skip, take);
-    const totalColumnCount = countAddressColumns(totalRangeRef.address);
-    const totalRowCount = countAddressRows(totalRangeRef.address);
+export async function* iterateRows(rangeRef, scope = defaultCellScope, maxCellsPerOperation = null) {
+    const totalColumnCount = countAddressColumns(rangeRef.address);
+    const totalRowCount = countAddressRows(rangeRef.address);
     const maxRowsPerOperation = calculateMaxRowsPerOperation(totalColumnCount, maxCellsPerOperation);
     const rangeSelect = scopeToRangeSelect(scope);
     for (let operationRowStart = 0; operationRowStart < totalRowCount; operationRowStart += maxRowsPerOperation) {
         const operationRowCount = Math.min(maxRowsPerOperation, totalRowCount - operationRowStart);
-        const operationRangeRef = subRange(totalRangeRef, operationRowStart, operationRowCount);
+        const operationRangeRef = subRange(rangeRef, operationRowStart, operationRowCount);
         const range = rangeSelect ? await getWorkbookWorksheetRange(operationRangeRef, rangeSelect) : null;
-        for (let rowIndex = 0; rowIndex < operationRowCount; rowIndex++) {
-            const row = [];
-            for (let columnIndex = 0; columnIndex < totalColumnCount; columnIndex++) {
-                const value = (range?.values?.[rowIndex]?.[columnIndex] ?? ""); // The root of these is undefined if that detail isn't in scope
-                const text = (range?.text?.[rowIndex]?.[columnIndex] ?? "");
-                const format = (range?.numberFormat?.[rowIndex]?.[columnIndex] ?? "");
-                const style = await getStyle(subRange(rangeRef, rowIndex, 1, columnIndex, 1), scope); // This line is potentially expensive
-                row.push({
+        for (let operationRowOffset = 0; operationRowOffset < operationRowCount; operationRowOffset++) {
+            const cells = [];
+            for (let columnOffset = 0; columnOffset < totalColumnCount; columnOffset++) {
+                const value = (range?.values?.[operationRowOffset]?.[columnOffset] ?? ""); // The root of these is undefined if that detail isn't in scope
+                const text = (range?.text?.[operationRowOffset]?.[columnOffset] ?? "");
+                const format = (range?.numberFormat?.[operationRowOffset]?.[columnOffset] ?? "");
+                const style = await getStyle(subRange(rangeRef, operationRowOffset, 1, columnOffset, 1), scope); // This line is potentially expensive
+                cells.push({
                     value,
                     text,
                     format,
                     style,
                 });
             }
-            yield row;
+            const offset = (operationRowStart + operationRowOffset);
+            const isFirst = offset === 0;
+            const isLast = offset === totalRowCount - 1;
+            yield {
+                cells,
+                offset,
+                isFirst,
+                isLast,
+            };
         }
     }
 }

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

@@ -0,0 +1,18 @@
+/**
+ * Read the first row from a given workbook range.
+ * @module readFirstRow
+ * @category Tasks
+ * @experimental
+ */
+import type { Cell } from "../models/Cell.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+/** * Read the first row from a given workbook range.
+ * @param rangeRef Reference to the workbook range to read.
+ * @param scope Amount of detail to include for each cell.
+ * @returns A promise that resolves to an array of cells in the first row.
+ * @remarks Particularly useful for reading header rows.
+ * @example
+ * const firstRow = await readFirstRow(rangeRef);
+ */
+export default function readFirstRow(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[]>;
+//# sourceMappingURL=readFirstRow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readFirstRow.d.ts","sourceRoot":"","sources":["../../../src/tasks/readFirstRow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAKnE;;;;;;;GAOG;AACH,wBAA8B,YAAY,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,wCAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAQhH"}

package/dist/esm/tasks/readFirstRow.js

@@ -0,0 +1,25 @@
+/**
+ * Read the first row from a given workbook range.
+ * @module readFirstRow
+ * @category Tasks
+ * @experimental
+ */
+import InvalidArgumentError from "../errors/InvalidArgumentError.js";
+import { subRange } from "../services/addressManipulation.js";
+import { defaultCellScope } from "../services/cell.js";
+import { iterateRows } from "./iterateRows.js";
+/** * Read the first row from a given workbook range.
+ * @param rangeRef Reference to the workbook range to read.
+ * @param scope Amount of detail to include for each cell.
+ * @returns A promise that resolves to an array of cells in the first row.
+ * @remarks Particularly useful for reading header rows.
+ * @example
+ * const firstRow = await readFirstRow(rangeRef);
+ */
+export default async function readFirstRow(rangeRef, scope = defaultCellScope) {
+    const firstRowRef = subRange(rangeRef, 0, 1);
+    for await (const { cells } of iterateRows(firstRowRef, scope)) {
+        return cells;
+    }
+    throw new InvalidArgumentError("No rows in the specified range.");
+}

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

@@ -0,0 +1,20 @@
+/**
+ * Read all rows from a given workbook range.
+ * @module readRows
+ * @category Tasks
+ * @experimental
+ */
+import type { Cell } from "../models/Cell.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+/**
+ * Read all rows from a given workbook range.
+ * @param rangeRef Reference to the workbook range to read.
+ * @param scope Amount of detail to include for each cell.
+ * @returns A promise that resolves to an array of rows, each containing an array of cells.
+ * @remarks Where practical, prefer using {@link iterateRows} for more efficient memory usage.
+ * @experimental
+ * @example
+ * const rows = await readRows(rangeRef);
+ */
+export default function readRows(rangeRef: WorkbookRangeRef, scope?: import("../models/Cell.ts").CellScope): Promise<Cell[][]>;
+//# sourceMappingURL=readRows.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/readRows.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAInE;;;;;;;;;GASG;AACH,wBAA8B,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,wCAAmB,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAO9G"}

package/dist/esm/tasks/readRows.js

@@ -0,0 +1,25 @@
+/**
+ * Read all rows from a given workbook range.
+ * @module readRows
+ * @category Tasks
+ * @experimental
+ */
+import { defaultCellScope } from "../services/cell.js";
+import { iterateRows } from "./iterateRows.js";
+/**
+ * Read all rows from a given workbook range.
+ * @param rangeRef Reference to the workbook range to read.
+ * @param scope Amount of detail to include for each cell.
+ * @returns A promise that resolves to an array of rows, each containing an array of cells.
+ * @remarks Where practical, prefer using {@link iterateRows} for more efficient memory usage.
+ * @experimental
+ * @example
+ * const rows = await readRows(rangeRef);
+ */
+export default async function readRows(rangeRef, scope = defaultCellScope) {
+    const rows = [];
+    for await (const { cells } of iterateRows(rangeRef, scope)) {
+        rows.push(cells);
+    }
+    return rows;
+}

package/docs/api/Border.md

@@ -21,7 +21,7 @@ Defined in: [src/models/Border.ts:9](https://github.com/Future-Secure-AI/microso
 | Property | Type | Defined in |
 | ------ | ------ | ------ |
 | <a id="color"></a> `color` | [`Color`](Color.md#color) | [src/models/Border.ts:10](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Border.ts#L10) |
-| <a id="style"></a> `style` | [`BorderType`](#bordertype) | [src/models/Border.ts:11](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Border.ts#L11) |
+| <a id="style"></a> `style` | [`BorderStyle`](#borderstyle-1) | [src/models/Border.ts:11](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Border.ts#L11) |
 | <a id="weight"></a> `weight` | [`BorderWeight`](#borderweight-1) | [src/models/Border.ts:12](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Border.ts#L12) |
 
 ***
@@ -36,9 +36,9 @@ Defined in: [src/models/Border.ts:15](https://github.com/Future-Secure-AI/micros
 
 ***
 
-### BorderType
+### BorderStyle
 
-> **BorderType** = `"None"` \| `"Continuous"` \| `"Dash"` \| `"DashDot"` \| `"DashDotDot"` \| `"Dot"` \| `"Double"` \| `"SlantDashDot"`
+> **BorderStyle** = `"None"` \| `"Continuous"` \| `"Dash"` \| `"DashDot"` \| `"DashDotDot"` \| `"Dot"` \| `"Double"` \| `"SlantDashDot"`
 
 Defined in: [src/models/Border.ts:17](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Border.ts#L17)
 

package/docs/api/Cell.md

@@ -69,13 +69,13 @@ The amount of detail that we're reading from a cell.
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="alignment"></a> `alignment` | `boolean` | Content position with the cell. Expensive to read/write (1 op per cell) | [src/models/Cell.ts:138](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L138) |
-| <a id="borders"></a> `borders` | `boolean` | Cell borders. Expensive to read/write (1 op per cell) | [src/models/Cell.ts:141](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L141) |
-| <a id="fill"></a> `fill` | `boolean` | Background fill style. Expensive to read/write (1 op per cell) | [src/models/Cell.ts:144](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L144) |
-| <a id="font"></a> `font` | `boolean` | Text style. Expensive to read/write (1 op per cell) | [src/models/Cell.ts:147](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L147) |
-| <a id="format-1"></a> `format` | `boolean` | Logic used to format values to text. Cheap to read/write (1 op per ~10K cells for values, text & format) | [src/models/Cell.ts:135](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L135) |
-| <a id="text-1"></a> `text` | `boolean` | Formatted value, as presented to the user. Cheap to read/write (1 op per ~10K cells for values, text & format) | [src/models/Cell.ts:132](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L132) |
-| <a id="values"></a> `values` | `boolean` | Raw underlying value. Cheap to read/write (1 op per ~10K cells for values, text & format) | [src/models/Cell.ts:129](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L129) |
+| <a id="alignment"></a> `alignment` | `boolean` | Content position with the cell. VERY EXPENSIVE (+1 op per cell) | [src/models/Cell.ts:138](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L138) |
+| <a id="borders"></a> `borders` | `boolean` | Cell borders. VERY EXPENSIVE (+1 op per cell) | [src/models/Cell.ts:141](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L141) |
+| <a id="fill"></a> `fill` | `boolean` | Background fill style. VERY EXPENSIVE (+1 op per cell) | [src/models/Cell.ts:144](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L144) |
+| <a id="font"></a> `font` | `boolean` | Text style. VERY EXPENSIVE (+1 op per cell) | [src/models/Cell.ts:147](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L147) |
+| <a id="format-1"></a> `format` | `boolean` | Logic used to format values to text. CHEAP (~1 op per 10K cells, no additional call op `values` or `text`) | [src/models/Cell.ts:135](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L135) |
+| <a id="text-1"></a> `text` | `boolean` | Formatted value, as presented to the user. CHEAP (~1 op per 10K cells, no additional call op `values` or `format`) | [src/models/Cell.ts:132](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L132) |
+| <a id="values"></a> `values` | `boolean` | Raw cell value. CHEAP (~1 op per 10K cells, no additional op with `text` or `format`) | [src/models/Cell.ts:129](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/models/Cell.ts#L129) |
 
 ***
 

package/docs/api/CellFormat.md

@@ -2,7 +2,7 @@
 
 # CellFormat
 
-Spreadsheet number format constants for Microsoft Graph API.
+Cell utilities.
 
 ## Variables
 
@@ -10,23 +10,15 @@ Spreadsheet number format constants for Microsoft Graph API.
 
 > `const` **accountingCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
 
-Defined in: [src/services/cellFormat.ts:12](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L12)
+Defined in: src/services/cell.ts:12
 
 ***
 
-### currencyCellFormat
+### defaultCellScope
 
-> `const` **currencyCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
+> `const` **defaultCellScope**: [`CellScope`](Cell.md#cellscope)
 
-Defined in: [src/services/cellFormat.ts:11](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L11)
-
-***
-
-### dateShortCellFormat
-
-> `const` **dateShortCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
-
-Defined in: [src/services/cellFormat.ts:14](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L14)
+Defined in: src/services/cell.ts:18
 
 ***
 
@@ -34,7 +26,7 @@ Defined in: [src/services/cellFormat.ts:14](https://github.com/Future-Secure-AI/
 
 > `const` **generalCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
 
-Defined in: [src/services/cellFormat.ts:9](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L9)
+Defined in: src/services/cell.ts:9
 
 ***
 
@@ -42,15 +34,7 @@ Defined in: [src/services/cellFormat.ts:9](https://github.com/Future-Secure-AI/m
 
 > `const` **numberCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
 
-Defined in: [src/services/cellFormat.ts:10](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L10)
-
-***
-
-### percentageCellFormat
-
-> `const` **percentageCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
-
-Defined in: [src/services/cellFormat.ts:13](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L13)
+Defined in: src/services/cell.ts:11
 
 ***
 
@@ -58,12 +42,4 @@ Defined in: [src/services/cellFormat.ts:13](https://github.com/Future-Secure-AI/
 
 > `const` **textCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
 
-Defined in: [src/services/cellFormat.ts:16](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L16)
-
-***
-
-### timeCellFormat
-
-> `const` **timeCellFormat**: [`CellFormat`](Cell.md#cellformat-1)
-
-Defined in: [src/services/cellFormat.ts:15](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/cellFormat.ts#L15)
+Defined in: src/services/cell.ts:10

package/docs/api/README.md

@@ -124,7 +124,7 @@
 | [azureApplicationCredentials](azureApplicationCredentials.md) | Azure application credential helpers for authentication and token management. |
 | [batch](batch.md) | Constants and helpers for batching Microsoft Graph API requests. |
 | [cartesianAddress](cartesianAddress.md) | Utilities for converting between A1 addresses and Cartesian coordinates. |
-| [CellFormat](CellFormat.md) | Spreadsheet number format constants for Microsoft Graph API. |
+| [CellFormat](CellFormat.md) | Cell utilities. |
 | [context](context.md) | Context creation and management utilities for Microsoft Graph API authentication. |
 | [dataSource](dataSource.md) | Tooling for easily creating, updating, and deleting items in a worksheet or range. |
 | [drive](drive.md) | Utilities for working with Microsoft Graph Drive references and operations. |
@@ -158,6 +158,8 @@
 | [getWorkbookWorksheetByName](getWorkbookWorksheetByName-1.md) | Get a worksheet by its name. |
 | [iterateRows](iterateRows.md) | Iterate over the rows in a given worksheet range. |
 | [listDriveItems](listDriveItems.md) | List drive items in a drive or a drive item. |
+| [readFirstRow](readFirstRow.md) | Read the first row from a given workbook range. |
+| [readRows](readRows.md) | Read all rows from a given workbook range. |
 | [readWorkbookRows](readWorkbookRows.md) | Iterates over the rows in a given worksheet range. |
 | [safeDeleteWorkbook](safeDeleteWorkbook.md) | Safely delete a workbook by first closing any open sessions and then deleting it. |
 | [setColumnHidden](setColumnHidden.md) | Set one or more columns visibility. |

package/docs/api/createBinaryWorkbook.md

@@ -10,7 +10,7 @@ Create a new blank binary workbook (XLSB).
 
 > **createBinaryWorkbook**(`parentRef`, `itemPath`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`DriveItem` & [`SiteRef`](Site-1.md#siteref) & `object` & `object` & `object`\>
 
-Defined in: src/operations/workbook/createBinaryWorkbook.ts:28
+Defined in: [src/operations/workbook/createBinaryWorkbook.ts:28](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/workbook/createBinaryWorkbook.ts#L28)
 
 Create a new blank binary workbook (XLSB).
 

package/docs/api/drive.md

@@ -54,27 +54,3 @@ A reference to the drive.
 #### Throws
 
 ProtocolError if the drive ID is missing.
-
-***
-
-### ~~getDefaultDriveRef()~~
-
-> **getDefaultDriveRef**(): [`DriveRef`](Drive-1.md#driveref)
-
-Defined in: [src/services/drive.ts:48](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/drive.ts#L48)
-
-Retrieves the opinionated default drive reference. NOT RECOMMENDED FOR PRODUCTION USE.
-
-#### Returns
-
-[`DriveRef`](Drive-1.md#driveref)
-
-A reference to the default drive.
-
-#### Remarks
-
-This method is opinionated and not recommended for production use.
-
-#### Deprecated
-
-Use `createClientSecretContextWithDriveRef()` instead.

package/docs/api/iterateRows.md

@@ -6,13 +6,34 @@
 
 Iterate over the rows in a given worksheet range.
 
+## Type Aliases
+
+### IteratedRow
+
+> **IteratedRow** = `object`
+
+Defined in: [src/tasks/iterateRows.ts:33](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L33)
+
+**`Experimental`**
+
+Represents a row yielded by the [iterateRows](#iteraterows) generator.
+
+#### Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="cells"></a> `cells` | [`Cell`](Cell.md#cell)[] | Array of cells in the row, each containing value, text, format, and optionally style information depending on the scope. | [src/tasks/iterateRows.ts:34](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L34) |
+| <a id="isfirst"></a> `isFirst` | `boolean` | If this is the first row in the iteration. | [src/tasks/iterateRows.ts:36](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L36) |
+| <a id="islast"></a> `isLast` | `boolean` | If this is the last row in the iteration. | [src/tasks/iterateRows.ts:37](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L37) |
+| <a id="offset"></a> `offset` | [`RowOffset`](Row.md#rowoffset) | Zero-based offset of the row within the original range. | [src/tasks/iterateRows.ts:35](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L35) |
+
 ## Functions
 
 ### iterateRows()
 
-> **iterateRows**(`rangeRef`, `skip`, `take`, `scope`, `maxCellsPerOperation`): `AsyncIterable`\<[`Row`](Row.md#row)\>
+> **iterateRows**(`rangeRef`, `scope`, `maxCellsPerOperation`): `AsyncIterable`\<[`IteratedRow`](#iteratedrow)\>
 
-Defined in: [src/tasks/iterateRows.ts:39](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L39)
+Defined in: [src/tasks/iterateRows.ts:52](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L52)
 
 **`Experimental`**
 
@@ -21,14 +42,12 @@ Defined in: [src/tasks/iterateRows.ts:39](https://github.com/Future-Secure-AI/mi
 | Parameter | Type | Default value | Description |
 | ------ | ------ | ------ | ------ |
 | `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | `undefined` | Reference to the workbook range to iterate over. |
-| `skip` | `number` | `0` | Number of rows to skip before starting to yield rows. Can be negative to get last rows (e.g., -1 for the last row). |
-| `take` | `number` | `Number.POSITIVE_INFINITY` | Max number of rows to yield. `POSITIVE_INFINITY` returns all rows. |
-| `scope` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`CellScope`](Cell.md#cellscope)\> | `defaultScope` | Amount of detail to include for each cell. |
+| `scope` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`CellScope`](Cell.md#cellscope)\> | `defaultCellScope` | Amount of detail to include for each cell. |
 | `maxCellsPerOperation` | `null` \| `number` | `null` | Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING. |
 
 #### Returns
 
-`AsyncIterable`\<[`Row`](Row.md#row)\>
+`AsyncIterable`\<[`IteratedRow`](#iteratedrow)\>
 
 #### Remarks
 
@@ -37,7 +56,7 @@ Including `style` in the scope requires over three operations for each and every
 #### Example
 
 ```ts
-for await (const row of iterateRows(rangeRef)) {
+for await (const { row } of iterateRows(rangeRef)) {
   console.log(row);
 }
 ```

package/docs/api/readFirstRow.md

@@ -0,0 +1,40 @@
+[Microsoft Graph SDK](README.md) / readFirstRow
+
+# readFirstRow
+
+**`Experimental`**
+
+Read the first row from a given workbook range.
+
+## Functions
+
+### readFirstRow()
+
+> **readFirstRow**(`rangeRef`, `scope`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Cell`](Cell.md#cell)[]\>
+
+Defined in: src/tasks/readFirstRow.ts:23
+
+**`Experimental`**
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | `undefined` | Reference to the workbook range to read. |
+| `scope` | [`CellScope`](Cell.md#cellscope) | `defaultCellScope` | Amount of detail to include for each cell. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Cell`](Cell.md#cell)[]\>
+
+A promise that resolves to an array of cells in the first row.
+
+#### Remarks
+
+Particularly useful for reading header rows.
+
+#### Example
+
+```ts
+const firstRow = await readFirstRow(rangeRef);
+```

package/docs/api/readRows.md

@@ -0,0 +1,40 @@
+[Microsoft Graph SDK](README.md) / readRows
+
+# readRows
+
+**`Experimental`**
+
+Read all rows from a given workbook range.
+
+## Functions
+
+### readRows()
+
+> **readRows**(`rangeRef`, `scope`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Cell`](Cell.md#cell)[][]\>
+
+Defined in: src/tasks/readRows.ts:23
+
+**`Experimental`**
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `rangeRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | `undefined` | Reference to the workbook range to read. |
+| `scope` | [`CellScope`](Cell.md#cellscope) | `defaultCellScope` | Amount of detail to include for each cell. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Cell`](Cell.md#cell)[][]\>
+
+A promise that resolves to an array of rows, each containing an array of cells.
+
+#### Remarks
+
+Where practical, prefer using [iterateRows](iterateRows.md#iteraterows) for more efficient memory usage.
+
+#### Example
+
+```ts
+const rows = await readRows(rangeRef);
+```