microsoft-graph 2.33.0 → 2.34.0

package/dist/esm/tasks/{readRows.js → readWorkbookRangeRows.js}

@@ -5,20 +5,20 @@
  * @experimental
  */
 import { defaultCellScope } from "../services/cell.js";
-import { iterateRows } from "./iterateRows.js";
+import { iterateWorkbookRangeRows } from "./iterateWorkbookRangeRows.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.
+ * @remarks Where practical, prefer using {@link iterateWorkbookRangeRows} for more efficient memory usage.
  * @experimental
  * @example
  * const rows = await readRows(rangeRef);
  */
-export default async function readRows(rangeRef, scope = defaultCellScope) {
+export default async function readWorkbookRangeRows(rangeRef, scope = defaultCellScope) {
     const rows = [];
-    for await (const { cells } of iterateRows(rangeRef, scope)) {
+    for await (const { cells } of iterateWorkbookRangeRows(rangeRef, scope)) {
         rows.push(cells);
     }
     return rows;

package/dist/esm/tasks/{updateFirstRow.d.ts → updateWorkbookRangeFirstRow.d.ts}

@@ -22,5 +22,5 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  *  { value: "Column B", style: { alignment: { horizontal: "Right" }, font: { bold: true } } }
  * ]);
  */
-export default function updateFirstRow(originRef: WorkbookRangeRef, cells: Partial<Cell>[]): Promise<void>;
-//# sourceMappingURL=updateFirstRow.d.ts.map
+export default function updateWorkbookRangeFirstRow(originRef: WorkbookRangeRef, cells: Partial<Cell>[]): Promise<void>;
+//# sourceMappingURL=updateWorkbookRangeFirstRow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"updateWorkbookRangeFirstRow.d.ts","sourceRoot":"","sources":["../../../src/tasks/updateWorkbookRangeFirstRow.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAGnE;;;;;;;;;;;;;;;GAeG;AACH,wBAA8B,2BAA2B,CAAC,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5H"}

package/dist/esm/tasks/{updateFirstRow.js → updateWorkbookRangeFirstRow.js}

@@ -4,7 +4,7 @@
  * @category Tasks
  * @experimental
  */
-import updateRows from "./updateRows.js";
+import updateWorkbookRangeRows from "./updateWorkbookRangeRows.js";
 /**
  * Update first row in a given workbook range.
  * @param originRef Reference to the workbook range to update. Only the upper-left cell is used as an origin point.
@@ -21,7 +21,7 @@ import updateRows from "./updateRows.js";
  *  { value: "Column B", style: { alignment: { horizontal: "Right" }, font: { bold: true } } }
  * ]);
  */
-export default async function updateFirstRow(originRef, cells) {
+export default async function updateWorkbookRangeFirstRow(originRef, cells) {
     const rows = [cells];
-    await updateRows(originRef, rows);
+    await updateWorkbookRangeRows(originRef, rows);
 }

package/dist/{cjs/tasks/updateRows.d.ts → esm/tasks/updateWorkbookRangeRows.d.ts}

@@ -22,5 +22,5 @@ import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
  *   [{ value: 2, format: accountingCellFormat }, { value: "B" }],
  * ]);
  */
-export default function updateRows(originRef: WorkbookRangeRef, cells: Iterable<Partial<Cell>[]> | AsyncIterable<Partial<Cell>[]>, maxCellsPerOperation?: number | null): Promise<void>;
-//# sourceMappingURL=updateRows.d.ts.map
+export default function updateWorkbookRangeRows(originRef: WorkbookRangeRef, cells: Iterable<Partial<Cell>[]> | AsyncIterable<Partial<Cell>[]>, maxCellsPerOperation?: number | null): Promise<void>;
+//# sourceMappingURL=updateWorkbookRangeRows.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"updateWorkbookRangeRows.d.ts","sourceRoot":"","sources":["../../../src/tasks/updateWorkbookRangeRows.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAWnE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAA8B,uBAAuB,CAAC,SAAS,EAAE,gBAAgB,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,oBAAoB,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB/M"}

package/dist/esm/tasks/{updateRows.js → updateWorkbookRangeRows.js}

@@ -37,7 +37,7 @@ import { camelCaseToPascalCase } from "../services/stringCaseConversion.js";
  *   [{ value: 2, format: accountingCellFormat }, { value: "B" }],
  * ]);
  */
-export default async function updateRows(originRef, cells, maxCellsPerOperation = null) {
+export default async function updateWorkbookRangeRows(originRef, cells, maxCellsPerOperation = null) {
     let maxRowsPerOperation = maxCellsPerOperation;
     let colCount = null;
     let rowCount = 0;
@@ -56,8 +56,8 @@ export default async function updateRows(originRef, cells, maxCellsPerOperation
             rowCount += await writeBatch(batch, originRef, rowCount, colCount);
         }
     }
-    if (colCount) {
-        await writeBatch(batch, originRef, rowCount, colCount);
+    if (colCount !== null) {
+        rowCount += await writeBatch(batch, originRef, rowCount, colCount);
     }
 }
 async function writeBatch(cells, originRef, rowsCompleted, colCount) {

package/docs/api/README.md

@@ -156,6 +156,8 @@
 | [createWorkbookAndStartSession](createWorkbookAndStartSession.md) | Create a new workbook and open a session for that workbook. |
 | [downloadDriveItemContent](downloadDriveItemContent.md) | Download a drive item and save it to the local disk. |
 | [getWorkbookWorksheetByName](getWorkbookWorksheetByName-1.md) | Get a worksheet by its name. |
+| [insertRow](insertRow.md) | Inserts a single row into a workbook range. |
+| [insertRows](insertRows.md) | Inserts rows into a workbook range. |
 | [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. |

package/docs/api/insertRow.md

@@ -0,0 +1,34 @@
+[Microsoft Graph SDK](README.md) / insertRow
+
+# insertRow
+
+**`Experimental`**
+
+Inserts a single row into a workbook range.
+
+## Functions
+
+### insertWorkbookRangeRow()
+
+> **insertWorkbookRangeRow**(`originRef`, `row`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Defined in: [src/tasks/insertWorkbookRangeRow.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/insertWorkbookRangeRow.ts#L20)
+
+**`Experimental`**
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `originRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | Reference to the workbook range to update. Only the upper-left cell is used as an origin point. |
+| `row` | [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[] | Array of cells to insert as a single row. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Example
+
+```ts
+await insertRow(originRef, [{ value: "A1" }, { value: "B1" }, { value: "C1" }]);
+```

package/docs/api/insertRows.md

@@ -0,0 +1,47 @@
+[Microsoft Graph SDK](README.md) / insertRows
+
+# insertRows
+
+**`Experimental`**
+
+Inserts rows into a workbook range.
+
+## Functions
+
+### insertWorkbookRangeRows()
+
+> **insertWorkbookRangeRows**(`originRef`, `cells`, `maxCellsPerOperation`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Defined in: [src/tasks/insertWorkbookRangeRows.ts:38](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/insertWorkbookRangeRows.ts#L38)
+
+**`Experimental`**
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `originRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | `undefined` | Reference to the workbook range to update. Only the upper-left cell is used as an origin point. |
+| `cells` | [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[], `any`, `any`\> \| `AsyncIterable`\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[], `any`, `any`\> | `undefined` | Array of arrays of cells to update in the specified range. |
+| `maxCellsPerOperation` | `null` \| `number` | `null` | Prescribe max cells to retrieve per operation. `null` automatically determines value. DO NOT SET EXCEPT FOR ADVANCED TUNING. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Example
+
+```ts
+// Basic example:
+await insertRows(originRef, [
+  [{ value: "A1" }, { value: "B1" }, { value: "C1" }],
+  [{ value: "A2" }, { value: "B2" }, { value: "C2" }],
+ [{ value: "A3" }, { value: "B3" }, { value: "C3" }],
+])
+
+// Advanced example with cell formatting:
+await insertRows(originRef, [
+  [{ value: "A1", format: { fontColor: "red" } }, { value: "B1" }, { value: "C1" }],
+  [{ value: "A2" }, { value: "B2", format: { fontColor: "blue" } }, { value: "C2" }],
+  [{ value: "A3" }, { value: "B3" }, { value: "C3", format: { fontColor: "green" } }],
+]);
+```

package/docs/api/iterateRows.md

@@ -12,28 +12,28 @@ Iterate over the rows in a given worksheet range.
 
 > **IteratedRow** = `object`
 
-Defined in: [src/tasks/iterateRows.ts:33](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L33)
+Defined in: [src/tasks/iterateWorkbookRangeRows.ts:33](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateWorkbookRangeRows.ts#L33)
 
 **`Experimental`**
 
-Represents a row yielded by the [iterateRows](#iteraterows) generator.
+Represents a row yielded by the [iterateWorkbookRangeRows](#iterateworkbookrangerows) 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) |
+| <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/iterateWorkbookRangeRows.ts:34](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateWorkbookRangeRows.ts#L34) |
+| <a id="isfirst"></a> `isFirst` | `boolean` | If this is the first row in the iteration. | [src/tasks/iterateWorkbookRangeRows.ts:36](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateWorkbookRangeRows.ts#L36) |
+| <a id="islast"></a> `isLast` | `boolean` | If this is the last row in the iteration. | [src/tasks/iterateWorkbookRangeRows.ts:37](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateWorkbookRangeRows.ts#L37) |
+| <a id="offset"></a> `offset` | [`RowOffset`](Row.md#rowoffset) | Zero-based offset of the row within the original range. | [src/tasks/iterateWorkbookRangeRows.ts:35](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateWorkbookRangeRows.ts#L35) |
 
 ## Functions
 
-### iterateRows()
+### iterateWorkbookRangeRows()
 
-> **iterateRows**(`rangeRef`, `scope`, `maxCellsPerOperation`): `AsyncIterable`\<[`IteratedRow`](#iteratedrow)\>
+> **iterateWorkbookRangeRows**(`rangeRef`, `scope`, `maxCellsPerOperation`): `AsyncIterable`\<[`IteratedRow`](#iteratedrow)\>
 
-Defined in: [src/tasks/iterateRows.ts:51](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateRows.ts#L51)
+Defined in: [src/tasks/iterateWorkbookRangeRows.ts:51](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/iterateWorkbookRangeRows.ts#L51)
 
 **`Experimental`**
 

package/docs/api/readFirstRow.md

@@ -8,11 +8,11 @@ Read the first row from a given workbook range.
 
 ## Functions
 
-### readFirstRow()
+### readWorkbookRangeFirstRow()
 
-> **readFirstRow**(`rangeRef`, `scope`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Cell`](Cell.md#cell)[]\>
+> **readWorkbookRangeFirstRow**(`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](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/readFirstRow.ts#L23)
+Defined in: [src/tasks/readWorkbookRangeFirstRow.ts:23](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/readWorkbookRangeFirstRow.ts#L23)
 
 **`Experimental`**
 

package/docs/api/readRows.md

@@ -8,11 +8,11 @@ Read all rows from a given workbook range.
 
 ## Functions
 
-### readRows()
+### readWorkbookRangeRows()
 
-> **readRows**(`rangeRef`, `scope`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Cell`](Cell.md#cell)[][]\>
+> **readWorkbookRangeRows**(`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](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/readRows.ts#L23)
+Defined in: [src/tasks/readWorkbookRangeRows.ts:23](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/readWorkbookRangeRows.ts#L23)
 
 **`Experimental`**
 
@@ -31,7 +31,7 @@ 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.
+Where practical, prefer using [iterateWorkbookRangeRows](iterateRows.md#iterateworkbookrangerows) for more efficient memory usage.
 
 #### Example
 

package/docs/api/updateFirstRow.md

@@ -8,11 +8,11 @@ Update first row in a given workbook range.
 
 ## Functions
 
-### updateFirstRow()
+### updateWorkbookRangeFirstRow()
 
-> **updateFirstRow**(`originRef`, `cells`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+> **updateWorkbookRangeFirstRow**(`originRef`, `cells`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
 
-Defined in: [src/tasks/updateFirstRow.ts:28](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/updateFirstRow.ts#L28)
+Defined in: [src/tasks/updateWorkbookRangeFirstRow.ts:28](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/updateWorkbookRangeFirstRow.ts#L28)
 
 **`Experimental`**
 

package/docs/api/updateRows.md

@@ -8,11 +8,11 @@ Update rows in a given workbook range.
 
 ## Functions
 
-### updateRows()
+### updateWorkbookRangeRows()
 
-> **updateRows**(`originRef`, `cells`, `maxCellsPerOperation`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+> **updateWorkbookRangeRows**(`originRef`, `cells`, `maxCellsPerOperation`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
 
-Defined in: [src/tasks/updateRows.ts:44](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/updateRows.ts#L44)
+Defined in: [src/tasks/updateWorkbookRangeRows.ts:44](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/updateWorkbookRangeRows.ts#L44)
 
 **`Experimental`**