microsoft-graph 2.34.1 → 2.36.0

package/docs/api/objectMapping.md

@@ -0,0 +1,225 @@
+[Microsoft Graph SDK](README.md) / objectMapping
+
+# objectMapping
+
+Automated conversion of rows to objects and vice versa based on defined mapping rules.
+
+## Type Aliases
+
+### ObjectMapping\<T\>
+
+> **ObjectMapping**\<`T`\> = `{ [K in keyof T]-?: { columnPattern: RegExp; decode?: (cell: Cell) => T[K]; encode?: (prop: T[K]) => Cell } }`
+
+Defined in: [src/services/objectMapping.ts:16](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L16)
+
+Defines rules for mapping between spreadsheet rows and object properties.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | Object type to map to/from. |
+
+***
+
+### ResolvedObjectMapping\<T\>
+
+> **ResolvedObjectMapping**\<`T`\> = `{ [K in keyof T]-?: { columnOffset: ColumnOffset; decode: (cell: Cell) => T[K]; encode: (prop: T[K]) => Cell } }`
+
+Defined in: [src/services/objectMapping.ts:50](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L50)
+
+Resolved mapping from object properties to column offsets and encode/decode functions.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | Object type being mapped. |
+
+## Functions
+
+### createObjectMapping()
+
+> **createObjectMapping**\<`T`\>(`headerRow`, `rules`): [`ResolvedObjectMapping`](#resolvedobjectmapping)\<`T`\>
+
+Defined in: [src/services/objectMapping.ts:86](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L86)
+
+Creates a mapping from a header row to object properties based on provided rules.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The object type being mapped. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `headerRow` | ([`Cell`](Cell.md#cell) \| [`ColumnName`](Column.md#columnname))[] | The header row, used to determine column offsets. |
+| `rules` | [`ObjectMapping`](#objectmapping)\<`T`\> | The mapping rules for converting cells to object properties. |
+
+#### Returns
+
+[`ResolvedObjectMapping`](#resolvedobjectmapping)\<`T`\>
+
+The resolved mapping for use in row/object conversion.
+
+#### Throws
+
+If a column matching a pattern is not found in the header row.
+
+***
+
+### objectsToRows()
+
+> **objectsToRows**\<`T`\>(`objects`, `mapping`): `AsyncIterable`\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[]\>
+
+Defined in: [src/services/objectMapping.ts:146](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L146)
+
+Converts objects to spreadsheet rows using a provided mapping.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The object type to convert. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `objects` | [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)\<`T`, `any`, `any`\> \| `AsyncIterable`\<`T`, `any`, `any`\> | Iterable or async iterable of objects. |
+| `mapping` | [`ResolvedObjectMapping`](#resolvedobjectmapping)\<`T`\> | The resolved mapping for object/row conversion. |
+
+#### Returns
+
+`AsyncIterable`\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[]\>
+
+#### Yields
+
+Arrays of partial cells, one for each object.
+
+***
+
+### objectToRow()
+
+> **objectToRow**\<`T`\>(`record`, `mapper`): [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[]
+
+Defined in: [src/services/objectMapping.ts:184](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L184)
+
+Converts an object to a row of cells using the provided mapping.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The object type to convert. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `record` | `T` | The object to convert. |
+| `mapper` | [`ResolvedObjectMapping`](#resolvedobjectmapping)\<`T`\> | The resolved mapping for object/row conversion. |
+
+#### Returns
+
+[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[]
+
+An array of partial cells representing the row.
+
+***
+
+### rowsToObjects()
+
+> **rowsToObjects**\<`T`\>(`rows`, `mapping`): `AsyncIterable`\<`T`\>
+
+Defined in: [src/services/objectMapping.ts:133](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L133)
+
+Converts spreadsheet rows to objects using a provided mapping.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The object type to yield. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rows` | [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)\<[`Cell`](Cell.md#cell)[], `any`, `any`\> \| `AsyncIterable`\<[`Cell`](Cell.md#cell)[], `any`, `any`\> | Iterable or async iterable of cell arrays (rows). |
+| `mapping` | [`ResolvedObjectMapping`](#resolvedobjectmapping)\<`T`\> | The resolved mapping for row/object conversion. |
+
+#### Returns
+
+`AsyncIterable`\<`T`\>
+
+#### Yields
+
+Objects of type T, one for each row.
+
+***
+
+### rowsToObjectsWithHeader()
+
+> **rowsToObjectsWithHeader**\<`T`\>(`rows`, `rules`): `AsyncIterable`\<`T`\>
+
+Defined in: [src/services/objectMapping.ts:65](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L65)
+
+Converts spreadsheet rows to objects using the first row as a header.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The object type to yield. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `rows` | [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)\<[`Cell`](Cell.md#cell)[], `any`, `any`\> \| `AsyncIterable`\<[`Cell`](Cell.md#cell)[], `any`, `any`\> | Iterable or async iterable of cell arrays (rows). |
+| `rules` | [`ObjectMapping`](#objectmapping)\<`T`\> | Mapping rules for converting columns to object properties. |
+
+#### Returns
+
+`AsyncIterable`\<`T`\>
+
+#### Yields
+
+Objects of type T, one for each data row.
+
+***
+
+### rowToObject()
+
+> **rowToObject**\<`T`\>(`cells`, `rules`): `T`
+
+Defined in: [src/services/objectMapping.ts:160](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/objectMapping.ts#L160)
+
+Converts a row of cells to an object using the provided mapping.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The object type to return. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cells` | [`Cell`](Cell.md#cell)[] | The array of cells representing a row. |
+| `rules` | [`ResolvedObjectMapping`](#resolvedobjectmapping)\<`T`\> | The resolved mapping for row/object conversion. |
+
+#### Returns
+
+`T`
+
+The object of type T.
+
+#### Throws
+
+If a required column is missing in the row.

package/docs/api/operationInvoker.md

@@ -10,29 +10,29 @@ Invoke operations, potentially as parallel or sequential batches.
 
 > **operation**\<`T`\>(`definition`): [`GraphOperation`](GraphOperation.md#graphoperation)\<`T`\>
 
-Defined in: [src/services/operationInvoker.ts:36](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L36)
+Defined in: [src/services/operationInvoker.ts:90](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L90)
 
-Define a operation.
+Defines a Graph operation.
+
+Operations can be awaited to execute independently, or passed with others as arguments to [parallel](#parallel) or [sequential](#sequential) to execute as part of a batch.
 
 #### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` |
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The response type of the operation. |
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `definition` | [`GraphOperationDefinition`](GraphOperation.md#graphoperationdefinition)\<`T`\> |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `definition` | [`GraphOperationDefinition`](GraphOperation.md#graphoperationdefinition)\<`T`\> | Definition of the Graph operation. |
 
 #### Returns
 
 [`GraphOperation`](GraphOperation.md#graphoperation)\<`T`\>
 
-#### Remarks
-
-Operations can be `await`d to execute independently, or passed with others as arguments to `parallel` or `sequential` to execute as part of a batch.
+GraphOperation instance.
 
 ***
 
@@ -40,29 +40,29 @@ Operations can be `await`d to execute independently, or passed with others as ar
 
 > **parallel**\<`T`\>(...`operations`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
 
-Defined in: [src/services/operationInvoker.ts:50](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L50)
+Defined in: [src/services/operationInvoker.ts:109](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L109)
 
 Execute a batch of GraphAPI operations in parallel.
 
+Provides the best performance for batch operations, however only useful if operations can logically be performed at the same time.
+
 #### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* [`GraphOperation`](GraphOperation.md#graphoperation)\<`unknown`\>[] |
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` *extends* [`GraphOperation`](GraphOperation.md#graphoperation)\<`unknown`\>[] | Tuple of GraphOperation types. |
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`operations` | `T` |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| ...`operations` | `T` | Operations to execute in parallel. |
 
 #### Returns
 
 [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
 
-#### Remarks
-
-Provides the best performance for batch operations, however only useful if operations can logically be performed at the same time.
+The responses for each operation, in the same order.
 
 ***
 
@@ -70,22 +70,45 @@ Provides the best performance for batch operations, however only useful if opera
 
 > **sequential**\<`T`\>(...`operations`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
 
-Defined in: [src/services/operationInvoker.ts:59](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L59)
+Defined in: [src/services/operationInvoker.ts:124](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L124)
 
 Execute a batch of GraphAPI operations sequentially.
 
+Each operation is dependent on the previous operation in the batch.
+
 #### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* [`GraphOperation`](GraphOperation.md#graphoperation)\<`unknown`\>[] |
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` *extends* [`GraphOperation`](GraphOperation.md#graphoperation)\<`unknown`\>[] | Tuple of GraphOperation types. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| ...`operations` | `T` | Operations to execute sequentially. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
+
+The responses for each operation, in the same order.
+
+***
+
+### throwException()
+
+> **throwException**(`responseCode`, `message`): `never`
+
+Defined in: [src/services/operationInvoker.ts:329](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/operationInvoker.ts#L329)
 
 #### Parameters
 
 | Parameter | Type |
 | ------ | ------ |
-| ...`operations` | `T` |
+| `responseCode` | `number` |
+| `message` | `string` |
 
 #### Returns
 
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`OperationResponse`](GraphOperation.md#operationresponse)\<`T`\>\>
+`never`

package/docs/api/{readFirstRow.md → readWorkbookRangeFirstRow.md}

@@ -1,6 +1,6 @@
-[Microsoft Graph SDK](README.md) / readFirstRow
+[Microsoft Graph SDK](README.md) / readWorkbookRangeFirstRow
 
-# readFirstRow
+# readWorkbookRangeFirstRow
 
 **`Experimental`**
 
@@ -36,5 +36,5 @@ Particularly useful for reading header rows.
 #### Example
 
 ```ts
-const firstRow = await readFirstRow(rangeRef);
+const firstRow = await readWorkbookRangeFirstRow(rangeRef);
 ```

package/docs/api/{readRows.md → readWorkbookRangeRows.md}

@@ -1,6 +1,6 @@
-[Microsoft Graph SDK](README.md) / readRows
+[Microsoft Graph SDK](README.md) / readWorkbookRangeRows
 
-# readRows
+# readWorkbookRangeRows
 
 **`Experimental`**
 
@@ -31,10 +31,10 @@ A promise that resolves to an array of rows, each containing an array of cells.
 
 #### Remarks
 
-Where practical, prefer using [iterateWorkbookRangeRows](iterateRows.md#iterateworkbookrangerows) for more efficient memory usage.
+Where practical, prefer using [iterateWorkbookRangeRows](iterateWorkbookRangeRows.md#iterateworkbookrangerows) for more efficient memory usage.
 
 #### Example
 
 ```ts
-const rows = await readRows(rangeRef);
+const rows = await readWorkbookRangeRows(rangeRef);
 ```

package/docs/api/streamDriveItemContent.md

@@ -10,7 +10,7 @@ Stream the content of a drive item as a Node.js readable stream.
 
 > **streamDriveItemContent**(`itemRef`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`ReadableStream`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/4771e16937e188c0e0eca9749d208676f85fefb9/types/node/globals.d.ts#L201)\>
 
-Defined in: [src/operations/driveItem/streamDriveItemContent.ts:20](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/driveItem/streamDriveItemContent.ts#L20)
+Defined in: [src/operations/driveItem/streamDriveItemContent.ts:21](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/operations/driveItem/streamDriveItemContent.ts#L21)
 
 Stream the content of a drive item.
 

package/docs/api/{updateFirstRow.md → updateWorkbookRangeFirstRow.md}

@@ -1,6 +1,6 @@
-[Microsoft Graph SDK](README.md) / updateFirstRow
+[Microsoft Graph SDK](README.md) / updateWorkbookRangeFirstRow
 
-# updateFirstRow
+# updateWorkbookRangeFirstRow
 
 **`Experimental`**
 
@@ -35,10 +35,10 @@ Defined in: [src/tasks/updateWorkbookRangeFirstRow.ts:28](https://github.com/Fut
 
 ```ts
 // Basic example:
-await updateFirstRow(rangeRef, [{ value: 1 }, { value: 2 }]);
+await updateWorkbookRangeFirstRow(rangeRef, [{ value: 1 }, { value: 2 }]);
 
 // Advanced example with cell formatting:
-await updateRows(rangeRef, [
+await updateWorkbookRangeFirstRow(rangeRef, [
  { value: "Column A", style: { alignment: { horizontal: "Right" }, font: { bold: true } } },
  { value: "Column B", style: { alignment: { horizontal: "Right" }, font: { bold: true } } }
 ]);

package/docs/api/{updateRows.md → updateWorkbookRangeRows.md}

@@ -1,6 +1,6 @@
-[Microsoft Graph SDK](README.md) / updateRows
+[Microsoft Graph SDK](README.md) / updateWorkbookRangeRows
 
-# updateRows
+# updateWorkbookRangeRows
 
 **`Experimental`**
 
@@ -12,7 +12,7 @@ Update rows in a given workbook range.
 
 > **updateWorkbookRangeRows**(`originRef`, `cells`, `maxCellsPerOperation`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
 
-Defined in: [src/tasks/updateWorkbookRangeRows.ts:44](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/updateWorkbookRangeRows.ts#L44)
+Defined in: [src/tasks/updateWorkbookRangeRows.ts:54](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/updateWorkbookRangeRows.ts#L54)
 
 **`Experimental`**
 
@@ -21,7 +21,7 @@ Defined in: [src/tasks/updateWorkbookRangeRows.ts:44](https://github.com/Future-
 | 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. |
+| `cells` | `AsyncIterable`\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[], `any`, `any`\> \| [`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`\> | `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
@@ -36,16 +36,25 @@ Defined in: [src/tasks/updateWorkbookRangeRows.ts:44](https://github.com/Future-
 
 ```ts
 // Basic example:
-await updateRows(rangeRef, [
+await updateWorkbookRangeRows(rangeRef, [
   [{ value: 1 }, { value: 2 }],
   [{ value: 3 }, { value: 4 }],
   [{ value: 5 }, { value: 6 }],
 ]);
 
 // Advanced example with cell formatting:
-await updateRows(rangeRef, [
-  [{ value: "Column A", style: { alignment: { horizontal: "Right" }, font: { bold: true } } }, { value: "Column B", style: { alignment: { horizontal: "Right" }, font: { bold: true } }  }],
-  [{ value: 1, format: accountingCellFormat }, { value: "A" }],
-  [{ value: 2, format: accountingCellFormat }, { value: "B" }],
-]);
+await updateWorkbookRangeRows(rangeRef, [
+[
+	{ value: "Column A", alignment: { horizontal: "Right" }, font: { bold: true, color: "#ffffff" as Color }, fill: { color: "#000000" as Color } },
+	{ value: "Column B", alignment: { horizontal: "Right" }, font: { bold: true, color: "#ffffff" as Color }, fill: { color: "#000000" as Color } },
+],
+[
+	{ value: 1, format: accountingCellFormat },
+	{ value: "A" },
+],
+[
+	{ value: 2, format: accountingCellFormat },
+	{ value: "B" }],
+],
+);
 ```

package/docs/api/writeWorkbookRows.md

@@ -19,7 +19,7 @@ Write rows to a workbook range.
 | Parameter | Type | Default value | Description |
 | ------ | ------ | ------ | ------ |
 | `originRef` | [`WorkbookRangeRef`](WorkbookRange-1.md#workbookrangeref) | `undefined` | The reference to the workbook range where rows will be written. Only the upper-left is used as an origin point. |
-| `rows` | [`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` | An iterable or async iterable of rows to write. Each row is an array of cells. |
+| `rows` | `AsyncIterable`\<[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](Cell.md#cell)\>[], `any`, `any`\> \| [`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`\> | `undefined` | An iterable or async iterable of rows to write. Each row is an array of cells. |
 | `overwriteMaxRowsPerChunk` | `null` \| `number` | `null` | Overwrite the number of rows per underlying request. DO NOT SET EXCEPT FOR ADVANCED TUNING. |
 
 #### Returns