microsoft-graph 2.23.0 → 2.25.0

package/.vscode/extensions.json

@@ -1,3 +1,3 @@
 {
-  "recommendations": ["usernamehw.errorlens", "biomejs.biome"]
+	"recommendations": ["usernamehw.errorlens", "biomejs.biome"]
 }

package/.vscode/launch.json

@@ -1,15 +1,15 @@
 {
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Run",
-      "runtimeExecutable": "npx",
-      "runtimeArgs": ["tsx", "demo/index.ts"],
-      "cwd": "${workspaceFolder}",
-      "skipFiles": ["<node_internals>/**"],
-      "autoAttachChildProcesses": true
-    }
-  ]
-}
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Run",
+			"runtimeExecutable": "npx",
+			"runtimeArgs": ["tsx", "demo/index.ts"],
+			"cwd": "${workspaceFolder}",
+			"skipFiles": ["<node_internals>/**"],
+			"autoAttachChildProcesses": true
+		}
+	]
+}

package/.vscode/settings.json

@@ -1,18 +1,12 @@
 {
-  "[typescript]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "[json]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "[jsonc]": {
-    "editor.defaultFormatter": "biomejs.biome"
-  },
-  "cSpell.words": [
-    "Entra",
-    "FSAI",
-    "msgraph",
-    "sourcedoc",
-    "subaddress"
-  ],
-}
+	"[typescript]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[json]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"[jsonc]": {
+		"editor.defaultFormatter": "biomejs.biome"
+	},
+	"cSpell.words": ["Entra", "FSAI", "msgraph", "sourcedoc", "subaddress"]
+}

package/README.md

@@ -2,88 +2,61 @@
 ## Overview
 This is an extensible library that allows access to Microsoft's GraphAPI, including (but not only) Sharepoint's API. It currently supports the most common operations, with more being added over time.
 
-Note that this is a THIRD PARTY library and not associated with Microsoft.
+ℹ️ This is a THIRD PARTY library and not associated with Microsoft.
 
 ## Breaking changes
-2.15.0 has a path change for `listDriveItems`. It's now in `tasks/listDriveItems`. This is part of a fix that prevented `listDriveItems` from returning the first 200 items only.
-
-## Usage
+Version 2.25.0 has a few breaking changes:
+* **Signature change for `insertWorkbookCells` from `insertWorkbookCells(worksheetRef, address, shift)` to `insertWorkbookCells(rangeRef, shift)`**
+* `graphApi.ts` has moved to `services/operationInvoker.ts`
+* `NumberFormat` renamed to `CellFormat`
+* `Cell.numberFormat` renamed to `Cell.format`
+* `services/numberFormat.ts` moved to `services/cellFormat.ts`
+* Merged a number of files in `models` to reduce import count.
+* Removed return value from `setColumnHidden` and `setRowHidden`
+* `services/listDriveItems` now returns async iterable. Wrap this with `iterateToArray` if an array is actually desired.
+
+## TLDR
 Install the NPM package `npm i microsoft-graph`, then:
 
-### Prepare configuration
-Something like this, but whatever works in your context.
-
 ```typescript
-const tenantId = getEnvironmentVariable("AZURE_TENANT_ID") as TenantId;
-const clientId = getEnvironmentVariable("AZURE_CLIENT_ID") as ClientId;
-const clientSecret = getEnvironmentVariable("AZURE_CLIENT_SECRET") as ClientSecret;
-const siteId = getEnvironmentVariable("SHAREPOINT_DEFAULT_SITE_ID") as SiteId;
-const driveId = getEnvironmentVariable("SHAREPOINT_DEFAULT_DRIVE_ID") as DriveId;
-```
+console.info("Loading envs...");
+const tenantId = getEnvironmentVariable("AZURE_TENANT_ID") as AzureTenantId;
+const clientId = getEnvironmentVariable("AZURE_CLIENT_ID") as AzureClientId;
+const clientSecret = getEnvironmentVariable("AZURE_CLIENT_SECRET") as AzureClientSecret;
+const siteId = getEnvironmentVariable("SHAREPOINT_SITE_ID") as SiteId;
+const driveId = getEnvironmentVariable("SHAREPOINT_DRIVE_ID") as DriveId;
 
-### Get reference to drive
-```typescript
-const contextRef = register(tenantId, clientId, clientSecret);
+console.info("Get drive...");
+const contextRef = createClientSecretContext(tenantId, clientId, clientSecret);
 const siteRef = createSiteRef(contextRef, siteId);
 const driveRef = createDriveRef(siteRef, driveId);
-```
-
-### Create folder
-```typescript
-const folder = await createFolder(driveRef, "folder-name");
-```
-
-### Create workbook
-```typescript
-const workbook = await createWorkbookAndStartSession(folder, "workbook-name");
-```
 
-## Getting worksheet
-```typescript
-const workbook = await getWorkbookWorksheetByName(workbook, "Sheet1");
-
-// OR this cheat to get the default sheet for a newly-created book
-const worksheetRef = createDefaultWorkbookWorksheetRef(workbook);
-```
-
-### Writing values to a range
-```typescript
-const rangeRef = createWorkbookRangeRef(worksheet, "A1:B2");
-await setWorkbookRangeValues(rangeRef, [
-	[1, 2],
-	[3, 4],
-	[5, 6],
-]);
-```
-
-### Reading values from a range
-```typescript
-for await (const rowValues of iterateWorkbookRangeValues(rangeRef)) {
-	// This automatically uses multiple requests if the range is too big for a single request
-	debug(` ${rowValues}`);
+console.info("Creating workbook...");
+const workbook = await createWorkbookAndStartSession(driveRef, generateTempFileName(workbookFileExtension));
+try {
+	console.info("Getting worksheet...");
+	const worksheetRef = createDefaultWorkbookWorksheetRef(workbook); // OR `await getWorkbookWorksheetByName(workbook, "Sheet1");` to get one by name
+
+	console.info("Writing values to range...");
+	const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B3");
+	await writeWorkbookRows(rangeRef, [
+		[{ value: 1 }, { value: 2 }],
+		[{ value: 3 }, { value: 4 }],
+		[{ value: 5 }, { value: 6 }],
+	]);
+
+	console.info("Reading range...");
+	for await (const row of readWorkbookRows(rangeRef)) {
+		console.debug(` ${row.map((cell) => cell.value).join(", ")}`);
+	}
+} finally {
+	console.info("Cleanup...");
+	await safeDeleteWorkbook(workbook);
 }
-```
 
-### List files
-```typescript
-for (const item of await listDriveItems(folder)) {
-	console.debug(` - ${item.name}`);
-}
-```
-
-### Cleanup
-```typescript
-await safeDeleteWorkbook(workbook); // Closes session and waits for unlock
-await deleteDriveItem(folder);
+console.info("Done.");
 ```
 
-From here, have a look at:
-* [`/docs`](https://github.com/ProspectSafe/microsoft-graph/tree/main/docs) for more general documentation and advice.
-* [`/src/operations`](https://github.com/ProspectSafe/microsoft-graph/tree/main/src/operations) for other supported GraphAPI operations.
-* [`/src/tasks`](https://github.com/ProspectSafe/microsoft-graph/tree/main/src/tasks) for supported tasks that make use of multiple operations. 
-* [`/src/services`](https://github.com/ProspectSafe/microsoft-graph/tree/main/src/services) for a bunch of helpers that make life generally easier.
-
-That's it!
-
-## Extension
-If you require more operations you can either raise an [issue](https://github.com/ProspectSafe/microsoft-graph/issues), or [raise a pull-request](CONTRIBUTING.md).
+## Further reading
+* [API Documentation](/docs/api/README.md)
+* [Common questions and advanced topics](/docs/topics/README.md)

package/biome.jsonc

@@ -7,7 +7,7 @@
 		"defaultBranch": "main"
 	},
 	"files": {
-		"include": ["*.ts"],
+		"include": ["*.ts", "*.js", "*.jsonc"],
 		"maxSize": 2097152 // 2MB to cover generated models
 	},
 	"formatter": {

package/dist/cjs/errors/BadPathTemplateError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Error thrown when path template did not match the expected format.
+ * @module BadTemplateError
+ * @category Errors
+ */
+export default class BadPathTemplateError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=BadPathTemplateError.d.ts.map

package/dist/cjs/errors/BadPathTemplateError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BadPathTemplateError.d.ts","sourceRoot":"","sources":["../../../src/errors/BadPathTemplateError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,KAAK;gBACnC,OAAO,EAAE,MAAM;CAIlC"}

package/dist/cjs/errors/BadPathTemplateError.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when path template did not match the expected format.
+ * @module BadTemplateError
+ * @category Errors
+ */
+class BadPathTemplateError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "BadPathTemplateError";
+    }
+}
+exports.default = BadPathTemplateError;

package/dist/cjs/errors/EnvironmentVariableMissingError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a required environment variable is not set, empty or whitespace.
+ * @module EnvironmentVariableMissingError
+ * @category Errors
+ */
 export default class EnvironmentVariableMissingError extends Error {
     constructor(env: string);
 }

package/dist/cjs/errors/EnvironmentVariableMissingError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EnvironmentVariableMissingError.d.ts","sourceRoot":"","sources":["../../../src/errors/EnvironmentVariableMissingError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,+BAAgC,SAAQ,KAAK;gBAC9C,GAAG,EAAE,MAAM;CAI9B"}
+{"version":3,"file":"EnvironmentVariableMissingError.d.ts","sourceRoot":"","sources":["../../../src/errors/EnvironmentVariableMissingError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,+BAAgC,SAAQ,KAAK;gBAC9C,GAAG,EAAE,MAAM;CAI9B"}

package/dist/cjs/errors/EnvironmentVariableMissingError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a required environment variable is not set, empty or whitespace.
+ * @module EnvironmentVariableMissingError
+ * @category Errors
+ */
 class EnvironmentVariableMissingError extends Error {
     constructor(env) {
         super(`Environment variable '${env}' is not set, empty or whitespace.`);

package/dist/cjs/errors/InconsistentContextError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when batched operations are performed with an inconsistent context (ie, different authentication).
+ * @module InconsistentContextError
+ * @category Errors
+ */
 export default class InconsistentContextError extends Error {
     constructor(message: string);
 }

package/dist/cjs/errors/InconsistentContextError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InconsistentContextError.d.ts","sourceRoot":"","sources":["../../../src/errors/InconsistentContextError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,KAAK;gBACvC,OAAO,EAAE,MAAM;CAIlC"}
+{"version":3,"file":"InconsistentContextError.d.ts","sourceRoot":"","sources":["../../../src/errors/InconsistentContextError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,KAAK;gBACvC,OAAO,EAAE,MAAM;CAIlC"}

package/dist/cjs/errors/InconsistentContextError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when batched operations are performed with an inconsistent context (ie, different authentication).
+ * @module InconsistentContextError
+ * @category Errors
+ */
 class InconsistentContextError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/errors/InvalidArgumentError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a function is called with one or more invalid arguments.
+ * @module InvalidArgumentError
+ * @category Errors
+ */
 export default class InvalidArgumentError extends Error {
     constructor(message: string);
     static throwIfOutside(value: number, min: number, max: number, message: string): void;

package/dist/cjs/errors/InvalidArgumentError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InvalidArgumentError.d.ts","sourceRoot":"","sources":["../../../src/errors/InvalidArgumentError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,KAAK;gBACnC,OAAO,EAAE,MAAM;WAKpB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;WAM9E,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;WAMjE,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;CAKjE"}
+{"version":3,"file":"InvalidArgumentError.d.ts","sourceRoot":"","sources":["../../../src/errors/InvalidArgumentError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,KAAK;gBACnC,OAAO,EAAE,MAAM;WAKpB,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;WAM9E,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;WAMjE,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;CAKjE"}

package/dist/cjs/errors/InvalidArgumentError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a function is called with one or more invalid arguments.
+ * @module InvalidArgumentError
+ * @category Errors
+ */
 class InvalidArgumentError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/errors/InvalidOperationError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a function is called when the system is in an unexpected state.
+ * @module InvalidOperationError
+ * @category Errors
+ */
 export default class InvalidOperationError extends Error {
     constructor(message?: string);
 }

package/dist/cjs/errors/InvalidOperationError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InvalidOperationError.d.ts","sourceRoot":"","sources":["../../../src/errors/InvalidOperationError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,KAAK;gBACpC,OAAO,CAAC,EAAE,MAAM;CAInC"}
+{"version":3,"file":"InvalidOperationError.d.ts","sourceRoot":"","sources":["../../../src/errors/InvalidOperationError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,qBAAsB,SAAQ,KAAK;gBACpC,OAAO,CAAC,EAAE,MAAM;CAInC"}

package/dist/cjs/errors/InvalidOperationError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a function is called when the system is in an unexpected state.
+ * @module InvalidOperationError
+ * @category Errors
+ */
 class InvalidOperationError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/errors/NeverError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a theoretically impossible state is encountered. This is akin to a panic.
+ * @module NeverError
+ * @category Errors
+ */
 export default class NeverError extends Error {
     constructor(message?: string);
 }

package/dist/cjs/errors/NeverError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NeverError.d.ts","sourceRoot":"","sources":["../../../src/errors/NeverError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK;gBACzB,OAAO,CAAC,EAAE,MAAM;CAInC"}
+{"version":3,"file":"NeverError.d.ts","sourceRoot":"","sources":["../../../src/errors/NeverError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,UAAW,SAAQ,KAAK;gBACzB,OAAO,CAAC,EAAE,MAAM;CAInC"}

package/dist/cjs/errors/NeverError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a theoretically impossible state is encountered. This is akin to a panic.
+ * @module NeverError
+ * @category Errors
+ */
 class NeverError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/errors/NotFoundError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a requested resource is not found.
+ * @module NotFoundError
+ * @category Errors
+ */
 export default class NotFoundError extends Error {
     constructor(message: string);
 }

package/dist/cjs/errors/NotFoundError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NotFoundError.d.ts","sourceRoot":"","sources":["../../../src/errors/NotFoundError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAIlC"}
+{"version":3,"file":"NotFoundError.d.ts","sourceRoot":"","sources":["../../../src/errors/NotFoundError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAIlC"}

package/dist/cjs/errors/NotFoundError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a requested resource is not found.
+ * @module NotFoundError
+ * @category Errors
+ */
 class NotFoundError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/errors/NotImplementedError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a requested feature or functionality is not yet implemented.
+ * @module NotImplementedError
+ * @category Errors
+ */
 export default class NotImplementedError extends Error {
     constructor(message?: string);
 }

package/dist/cjs/errors/NotImplementedError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NotImplementedError.d.ts","sourceRoot":"","sources":["../../../src/errors/NotImplementedError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,KAAK;gBAClC,OAAO,CAAC,EAAE,MAAM;CAInC"}
+{"version":3,"file":"NotImplementedError.d.ts","sourceRoot":"","sources":["../../../src/errors/NotImplementedError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,KAAK;gBAClC,OAAO,CAAC,EAAE,MAAM;CAInC"}

package/dist/cjs/errors/NotImplementedError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a requested feature or functionality is not yet implemented.
+ * @module NotImplementedError
+ * @category Errors
+ */
 class NotImplementedError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/errors/ProtocolError.d.ts

@@ -1,5 +1,9 @@
+/**
+ * Error thrown when a response from the server does not conform to the expected protocol.
+ * @module ProtocolError
+ * @category Errors
+ */
 export default class ProtocolError extends Error {
     constructor(message: string);
-    static throwIfFalsy(value: unknown, message: string): void;
 }
 //# sourceMappingURL=ProtocolError.d.ts.map

package/dist/cjs/errors/ProtocolError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ProtocolError.d.ts","sourceRoot":"","sources":["../../../src/errors/ProtocolError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;WAKpB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;CAKjE"}
+{"version":3,"file":"ProtocolError.d.ts","sourceRoot":"","sources":["../../../src/errors/ProtocolError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,aAAc,SAAQ,KAAK;gBAC5B,OAAO,EAAE,MAAM;CAIlC"}

package/dist/cjs/errors/ProtocolError.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a response from the server does not conform to the expected protocol.
+ * @module ProtocolError
+ * @category Errors
+ */
 class ProtocolError extends Error {
     constructor(message) {
         super(message);
         this.name = "ProtocolError";
     }
-    static throwIfFalsy(value, message) {
-        if (!value) {
-            throw new ProtocolError(message);
-        }
-    }
 }
 exports.default = ProtocolError;

package/dist/cjs/errors/RequestFailedError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a request to the server fails.
+ * @module RequestFailedError
+ * @category Errors
+ */
 export default class RequestFailedError extends Error {
     constructor(message: string);
     static throw(message: string, request: unknown, response?: unknown): never;

package/dist/cjs/errors/RequestFailedError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestFailedError.d.ts","sourceRoot":"","sources":["../../../src/errors/RequestFailedError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;WAKpB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,KAAK;CAOjF"}
+{"version":3,"file":"RequestFailedError.d.ts","sourceRoot":"","sources":["../../../src/errors/RequestFailedError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;WAKpB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,KAAK;CAOjF"}

package/dist/cjs/errors/RequestFailedError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a request to the server fails.
+ * @module RequestFailedError
+ * @category Errors
+ */
 class RequestFailedError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/errors/RequestTimeoutError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Error thrown when a request exceeds the allowed time limit.
+ * @module RequestTimeoutError
+ * @category Errors
+ */
+export default class RequestTimeoutError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=RequestTimeoutError.d.ts.map

package/dist/cjs/errors/RequestTimeoutError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RequestTimeoutError.d.ts","sourceRoot":"","sources":["../../../src/errors/RequestTimeoutError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM;CAIlC"}

package/dist/cjs/errors/RequestTimeoutError.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a request exceeds the allowed time limit.
+ * @module RequestTimeoutError
+ * @category Errors
+ */
+class RequestTimeoutError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "TimeoutError";
+    }
+}
+exports.default = RequestTimeoutError;

package/dist/cjs/errors/UnsupportedAddressTypeError.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Error thrown when a given address does not confirm to any known address type.
+ * @module UnsupportedAddressTypeError
+ * @category Errors
+ */
 export default class UnsupportedAddressTypeError extends Error {
     constructor(message: string);
 }

package/dist/cjs/errors/UnsupportedAddressTypeError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UnsupportedAddressTypeError.d.ts","sourceRoot":"","sources":["../../../src/errors/UnsupportedAddressTypeError.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,2BAA4B,SAAQ,KAAK;gBAC1C,OAAO,EAAE,MAAM;CAIlC"}
+{"version":3,"file":"UnsupportedAddressTypeError.d.ts","sourceRoot":"","sources":["../../../src/errors/UnsupportedAddressTypeError.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,2BAA4B,SAAQ,KAAK;gBAC1C,OAAO,EAAE,MAAM;CAIlC"}

package/dist/cjs/errors/UnsupportedAddressTypeError.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Error thrown when a given address does not confirm to any known address type.
+ * @module UnsupportedAddressTypeError
+ * @category Errors
+ */
 class UnsupportedAddressTypeError extends Error {
     constructor(message) {
         super(message);

package/dist/cjs/models/AccessToken.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Token sent to server to authenticate a request.
+ * @remarks May be automatically generated by graphApi (for instance, when `createClientSecretContext` or `createContext` is used with a `accessTokenGenerator`) or may be static (ie when `createAccessTokenContext` is used).
+ * @module AccessToken
+ * @category Models
+ */
 export type AccessToken = string & {
     __brand: "AccessToken";
 };

package/dist/cjs/models/AccessToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccessToken.d.ts","sourceRoot":"","sources":["../../../src/models/AccessToken.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG;IAClC,OAAO,EAAE,aAAa,CAAC;CACvB,CAAC"}
+{"version":3,"file":"AccessToken.d.ts","sourceRoot":"","sources":["../../../src/models/AccessToken.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG;IAClC,OAAO,EAAE,aAAa,CAAC;CACvB,CAAC"}

package/dist/cjs/models/AccessTokenGenerator.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Callback function that generates an access token.
+ * @remarks Passed to `createContext`.
+ * @module AccessTokenGenerator
+ * @category Models
+ */
 import type { AccessToken } from "./AccessToken.ts";
 export type AccessTokenGenerator = () => Promise<AccessToken>;
 //# sourceMappingURL=AccessTokenGenerator.d.ts.map

package/dist/cjs/models/AccessTokenGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AccessTokenGenerator.d.ts","sourceRoot":"","sources":["../../../src/models/AccessTokenGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC"}
+{"version":3,"file":"AccessTokenGenerator.d.ts","sourceRoot":"","sources":["../../../src/models/AccessTokenGenerator.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC"}

package/dist/cjs/models/AccessTokenGenerator.js

@@ -1,2 +1,8 @@
 "use strict";
+/**
+ * Callback function that generates an access token.
+ * @remarks Passed to `createContext`.
+ * @module AccessTokenGenerator
+ * @category Models
+ */
 Object.defineProperty(exports, "__esModule", { value: true });