microsoft-graph 2.23.0 → 2.25.0

package/dist/esm/{graphApi.js → services/operationInvoker.js}

@@ -1,16 +1,32 @@
+/**
+ * Invoke operations, potentially as parallel or sequential batches.
+ * @module operationInvoker
+ * @category Services
+ **/
 import axios from "axios";
-import InconsistentContextError from "./errors/InconsistentContextError.js";
-import InvalidArgumentError from "./errors/InvalidArgumentError.js";
-import NeverError from "./errors/NeverError.js";
-import ProtocolError from "./errors/ProtocolError.js";
-import RequestFailedError from "./errors/RequestFailedError.js";
-import { executeHttpRequest } from "./services/http.js";
-import { isGatewayTimeout, isHttpSuccess, isHttpTooManyRequests, isLocked, isServiceUnavailable } from "./services/httpStatus.js";
-import { operationIdToIndex, operationIndexToId } from "./services/operationId.js";
-import { sleep } from "./services/sleep.js";
+import InconsistentContextError from "../errors/InconsistentContextError.js";
+import InvalidArgumentError from "../errors/InvalidArgumentError.js";
+import NeverError from "../errors/NeverError.js";
+import ProtocolError from "../errors/ProtocolError.js";
+import RequestFailedError from "../errors/RequestFailedError.js";
+import { executeHttpRequest } from "./http.js";
+import { isGatewayTimeout, isHttpSuccess, isHttpTooManyRequests, isLocked, isServiceUnavailable } from "./httpStatus.js";
+import { operationIdToIndex, operationIndexToId } from "./operationId.js";
+import { sleep } from "./sleep.js";
+/**
+ * Endpoint for submitting individual requests.
+ * @internal
+ */
 export const endpoint = "https://graph.microsoft.com/v1.0";
+/**
+ * Endpoint for submitting batch requests.
+ * @internal
+ */
 export const batchEndpoint = `${endpoint}/$batch`;
-/** Define a operation, which can either be `await`d to execute independently, or passed with other operations ot `parallel` or `sequential` to execute as part of a batch. */
+/**
+ * Define a operation.
+ * @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.
+ */
 export function operation(definition) {
     const single = async (definition) => {
         return await executeSingle(definition);
@@ -19,12 +35,17 @@ export function operation(definition) {
     op.definition = definition;
     return op;
 }
-/** 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. */
+/**
+ * Execute a batch of GraphAPI operations in parallel.
+ * @remarks Provides the best performance for batch operations, however only useful if operations can logically be performed at the same time.
+ */
 export async function parallel(...operations) {
     const definitions = operations.map((op) => op.definition);
     return (await executeBatch(...definitions));
 }
-/** Execute a batch of GraphAPI operations sequentially. */
+/**
+ * Execute a batch of GraphAPI operations sequentially.
+ */
 export async function sequential(...operations) {
     const definitions = operations.map((definition, index) => ({
         ...definition.definition,

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

@@ -1,3 +1,8 @@
+/**
+ * Utilities for generating random values for spreadsheet and API operations.
+ * @module random
+ * @category Services
+ */
 /**
  * Generates a random alphanumeric string of the specified length.
  * @param length - The length of the string to generate. Defaults to 16.

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

@@ -1 +1 @@
-{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../../../src/services/random.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,SAAK,GAAG,MAAM,CAQxD"}
+{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../../../src/services/random.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,SAAK,GAAG,MAAM,CAQxD"}

package/dist/esm/services/random.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for generating random values for spreadsheet and API operations.
+ * @module random
+ * @category Services
+ */
 import { randomInt } from "node:crypto";
 const characters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
 /**

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

@@ -1,7 +1,12 @@
+/**
+ * Utilities for inferring and manipulating spreadsheet ranges and objects.
+ * @module rangeManipulation
+ * @category Services
+ */
 import type { Address } from "../models/Address.ts";
-import type { CellValue } from "../models/CellValue.ts";
-import type { ColumnOffset } from "../models/ColumnOffset.ts";
-import type { RowOffset } from "../models/RowOffset.ts";
+import type { CellValue } from "../models/Cell.ts";
+import type { ColumnOffset } from "../models/Column.ts";
+import type { RowOffset } from "../models/Row.ts";
 /**
  * Converts a 2D array of cell values into range address in the upper left.
  *
@@ -26,7 +31,7 @@ export declare function inferRowAddress(row: CellValue[], rowOffset?: RowOffset,
  * Assumes the first row is a header and uses it as keys for the objects.
  *
  * @param {CellValue[][]} values - A 2D array representing cell values.
- * @returns {unknown[]} An array of objects where each object represents a row.
+ * @returns {unknown[]} Array of objects where each object represents a row.
  * @throws {InvalidArgumentError} If rows have inconsistent column counts or no header row is present.
  */
 export declare function inferRangeObject(values: CellValue[][]): unknown[];
@@ -34,7 +39,7 @@ export declare function inferRangeObject(values: CellValue[][]): unknown[];
  * Converts an array of objects into a 2D array of cell values.
  * The first row of the 2D array contains the keys as headers.
  *
- * @param {unknown[]} objs - An array of objects to convert.
+ * @param {unknown[]} objs - Array of objects to convert.
  * @param {string[] | null} header - Optional header row. If not provided, it will be inferred from the object keys.
  * @returns {CellValue[][]} A 2D array where the first row is the header and subsequent rows are the object values.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"rangeManipulation.d.ts","sourceRoot":"","sources":["../../../src/services/rangeManipulation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAGxD;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,GAAE,SAA0B,EAAE,YAAY,GAAE,YAAgC,GAAG,OAAO,CA8BvJ;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,SAAS,GAAE,SAA0B,EAAE,YAAY,GAAE,YAAgC,GAAG,OAAO,CAiBhJ;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,EAAE,CAoBjE;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,MAAM,GAAE,MAAM,EAAE,GAAG,IAAW,GAAG,SAAS,EAAE,EAAE,CAS/F"}
+{"version":3,"file":"rangeManipulation.d.ts","sourceRoot":"","sources":["../../../src/services/rangeManipulation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAGlD;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,GAAE,SAA0B,EAAE,YAAY,GAAE,YAAgC,GAAG,OAAO,CA8BvJ;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,SAAS,GAAE,SAA0B,EAAE,YAAY,GAAE,YAAgC,GAAG,OAAO,CAiBhJ;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,EAAE,CAoBjE;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,MAAM,GAAE,MAAM,EAAE,GAAG,IAAW,GAAG,SAAS,EAAE,EAAE,CAS/F"}

package/dist/esm/services/rangeManipulation.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for inferring and manipulating spreadsheet ranges and objects.
+ * @module rangeManipulation
+ * @category Services
+ */
 import InvalidArgumentError from "../errors/InvalidArgumentError.js";
 import { cartesianToAddress } from "./cartesianAddress.js";
 /**
@@ -65,7 +70,7 @@ export function inferRowAddress(row, rowOffset = 0, columnOffset = 0) {
  * Assumes the first row is a header and uses it as keys for the objects.
  *
  * @param {CellValue[][]} values - A 2D array representing cell values.
- * @returns {unknown[]} An array of objects where each object represents a row.
+ * @returns {unknown[]} Array of objects where each object represents a row.
  * @throws {InvalidArgumentError} If rows have inconsistent column counts or no header row is present.
  */
 export function inferRangeObject(values) {
@@ -87,7 +92,7 @@ export function inferRangeObject(values) {
  * Converts an array of objects into a 2D array of cell values.
  * The first row of the 2D array contains the keys as headers.
  *
- * @param {unknown[]} objs - An array of objects to convert.
+ * @param {unknown[]} objs - Array of objects to convert.
  * @param {string[] | null} header - Optional header row. If not provided, it will be inferred from the object keys.
  * @returns {CellValue[][]} A 2D array where the first row is the header and subsequent rows are the object values.
  */

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

@@ -1,6 +1,11 @@
-import type { DriveItemId } from "../models/DriveItemId.ts";
+/**
+ * Utilities for parsing and extracting information from SharePoint URLs.
+ * @module sharepointUrl
+ * @category Services
+ */
+import type { DriveItemId } from "../models/DriveItem.ts";
 import type { HostName } from "../models/HostName.ts";
-import type { SiteName } from "../models/SiteName.ts";
+import type { SiteName } from "../models/Site.ts";
 /**
  * Parses a SharePoint document URL to extract the site name, host name, and item ID.
  * @param url - The SharePoint document URL.

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

@@ -1 +1 @@
-{"version":3,"file":"sharepointUrl.d.ts","sourceRoot":"","sources":["../../../src/services/sharepointUrl.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,CAyB5G"}
+{"version":3,"file":"sharepointUrl.d.ts","sourceRoot":"","sources":["../../../src/services/sharepointUrl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,GAAG,GAAG;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,WAAW,CAAA;CAAE,CAyB5G"}

package/dist/esm/services/sharepointUrl.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for parsing and extracting information from SharePoint URLs.
+ * @module sharepointUrl
+ * @category Services
+ */
 import InvalidArgumentError from "../errors/InvalidArgumentError.js";
 /**
  * Parses a SharePoint document URL to extract the site name, host name, and item ID.

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

@@ -1,6 +1,10 @@
-import type { ContextRef } from "../models/ContextRef.ts";
-import type { SiteId } from "../models/SiteId.ts";
-import type { SiteRef } from "../models/SiteRef.ts";
+/**
+ * Utilities for working with Microsoft Graph Site references and operations.
+ * @module site
+ * @category Services
+ */
+import type { ContextRef } from "../models/Context.ts";
+import type { SiteId, SiteRef } from "../models/Site.ts";
 /**
  * Creates a reference to a site.
  * @param contextRef - The reference to the context.

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

@@ -1 +1 @@
-{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../src/services/site.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAIpD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CASzF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAO3C"}
+{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../src/services/site.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAIzD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CASzF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAO3C"}

package/dist/esm/services/site.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for working with Microsoft Graph Site references and operations.
+ * @module site
+ * @category Services
+ */
 import ProtocolError from "../errors/ProtocolError.js";
 import { getDefaultContextRef } from "./context.js";
 import { getEnvironmentVariable } from "./environmentVariable.js";

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

@@ -1,6 +1,11 @@
+/**
+ * Utility for pausing execution (sleep) in async workflows.
+ * @module sleep
+ * @category Services
+ */
 /**
  * Pauses execution for the specified number of milliseconds.
- * @param ms - The number of milliseconds to sleep.
+ * @param ms - Number of milliseconds to sleep.
  * @returns A promise that resolves after the specified time.
  */
 export declare function sleep(ms: number): Promise<void>;

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

@@ -1 +1 @@
-{"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../../src/services/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C"}
+{"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../../src/services/sleep.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C"}

package/dist/esm/services/sleep.js

@@ -1,6 +1,11 @@
+/**
+ * Utility for pausing execution (sleep) in async workflows.
+ * @module sleep
+ * @category Services
+ */
 /**
  * Pauses execution for the specified number of milliseconds.
- * @param ms - The number of milliseconds to sleep.
+ * @param ms - Number of milliseconds to sleep.
  * @returns A promise that resolves after the specified time.
  */
 export function sleep(ms) {

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

@@ -1,3 +1,8 @@
+/**
+ * Utilities for converting string case styles (e.g., kebab-case to camelCase).
+ * @module stringCaseConversion
+ * @category Services
+ */
 /**
  * Converts a kebab-case string to camelCase.
  * @param str - The kebab-case string.

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

@@ -1 +1 @@
-{"version":3,"file":"stringCaseConversion.d.ts","sourceRoot":"","sources":["../../../src/services/stringCaseConversion.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIpD"}
+{"version":3,"file":"stringCaseConversion.d.ts","sourceRoot":"","sources":["../../../src/services/stringCaseConversion.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIpD"}

package/dist/esm/services/stringCaseConversion.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for converting string case styles (e.g., kebab-case to camelCase).
+ * @module stringCaseConversion
+ * @category Services
+ */
 /**
  * Converts a kebab-case string to camelCase.
  * @param str - The kebab-case string.

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

@@ -1,10 +1,15 @@
-import type { GraphPath } from "../models/GraphOperation.ts";
+/**
+ * Utilities for generating and parsing templated HTTP paths.
+ * @module templatedPaths
+ * @category Services
+ */
+import type { HttpPath } from "../models/Http.ts";
 /**
  * Generates a HTTP path based on a template and arguments. Arguments are automatically escaped.
  * @param template - The path template, which must start with a slash.
- * @param args - A record of arguments to replace placeholders in the template.
+ * @param args Record of arguments to replace placeholders in the template.
  * @returns The generated Graph API path.
  * @throws BadTemplateError if the template is invalid or required arguments are missing.
  */
-export declare function generatePath(template: string, args: Record<string, unknown>): GraphPath;
+export declare function generatePath(template: string, args: Record<string, unknown>): HttpPath;
 //# sourceMappingURL=templatedPaths.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"templatedPaths.d.ts","sourceRoot":"","sources":["../../../src/services/templatedPaths.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAK7D;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAmBvF"}
+{"version":3,"file":"templatedPaths.d.ts","sourceRoot":"","sources":["../../../src/services/templatedPaths.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAKlD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,QAAQ,CAmBtF"}

package/dist/esm/services/templatedPaths.js

@@ -1,28 +1,33 @@
-import BadTemplateError from "../errors/BadTemplateError.js";
+/**
+ * Utilities for generating and parsing templated HTTP paths.
+ * @module templatedPaths
+ * @category Services
+ */
+import BadPathTemplateError from "../errors/BadPathTemplateError.js";
 import { kebabToCamelCase } from "./stringCaseConversion.js";
 const argumentPattern = /\{([a-z-]+)\}/g;
 /**
  * Generates a HTTP path based on a template and arguments. Arguments are automatically escaped.
  * @param template - The path template, which must start with a slash.
- * @param args - A record of arguments to replace placeholders in the template.
+ * @param args Record of arguments to replace placeholders in the template.
  * @returns The generated Graph API path.
  * @throws BadTemplateError if the template is invalid or required arguments are missing.
  */
 export function generatePath(template, args) {
     if (!template.startsWith("/")) {
-        throw new BadTemplateError(`Path template '${template}' must start with a slash.`);
+        throw new BadPathTemplateError(`Path template '${template}' must start with a slash.`);
     }
     if (template.includes("\n")) {
-        throw new BadTemplateError("Path template must not contain newlines.");
+        throw new BadPathTemplateError("Path template must not contain newlines.");
     }
     return template.replace(argumentPattern, (_, match) => {
         const camelCaseKey = kebabToCamelCase(match);
         const value = args[camelCaseKey];
         if (value === undefined || value === null) {
-            throw new BadTemplateError(`Path template references argument '${camelCaseKey}' however no such argument provided.`);
+            throw new BadPathTemplateError(`Path template references argument '${camelCaseKey}' however no such argument provided.`);
         }
         if (typeof value !== "string" && typeof value !== "number") {
-            throw new BadTemplateError(`Path template references argument '${camelCaseKey}' which is of type ${typeof value}, but only strings and numbers are allowed.`);
+            throw new BadPathTemplateError(`Path template references argument '${camelCaseKey}' which is of type ${typeof value}, but only strings and numbers are allowed.`);
         }
         return encodeURIComponent(value.toString());
     });

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

@@ -1,4 +1,9 @@
-import type { DriveItemPath } from "../models/DriveItemPath.ts";
+/**
+ * Utilities for generating temporary file names for use with Drive Items.
+ * @module temporaryFiles
+ * @category Services
+ */
+import type { DriveItemPath } from "../models/DriveItem.ts";
 /**
  * Generates a temporary file name with the specified extension.
  * @param extension - The file extension. Defaults to "tmp".

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

@@ -1 +1 @@
-{"version":3,"file":"temporaryFiles.d.ts","sourceRoot":"","sources":["../../../src/services/temporaryFiles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAY,GAAG,aAAa,CAGpF"}
+{"version":3,"file":"temporaryFiles.d.ts","sourceRoot":"","sources":["../../../src/services/temporaryFiles.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAG5D;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAY,GAAG,aAAa,CAGpF"}

package/dist/esm/services/temporaryFiles.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for generating temporary file names for use with Drive Items.
+ * @module temporaryFiles
+ * @category Services
+ */
 import { generateRandomString } from "./random.js";
 /**
  * Generates a temporary file name with the specified extension.

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

@@ -1,6 +1,11 @@
+/**
+ * Utilities for working with workbook ranges and references.
+ * @module workbookRange
+ * @category Services
+ */
 import type { Address } from "../models/Address.ts";
-import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
-import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+import type { WorkbookRangeRef } from "../models/WorkbookRange.ts";
+import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheet.ts";
 /**
  * Creates a reference to a workbook range.
  * @param worksheetRef - The reference to the worksheet containing the range.

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

@@ -1 +1 @@
-{"version":3,"file":"workbookRange.d.ts","sourceRoot":"","sources":["../../../src/services/workbookRange.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAG9E;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,gBAAgB,CAgBzH"}
+{"version":3,"file":"workbookRange.d.ts","sourceRoot":"","sources":["../../../src/services/workbookRange.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAG3E;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,gBAAgB,CAgBzH"}

package/dist/esm/services/workbookRange.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for working with workbook ranges and references.
+ * @module workbookRange
+ * @category Services
+ */
 import ProtocolError from "../errors/ProtocolError.js";
 import { normalizeAddress } from "./addressManipulation.js";
 /**

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

@@ -1,6 +1,10 @@
-import type { WorkbookTableId } from "../models/WorkbookTableId.ts";
-import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
-import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Utilities for creating and working with workbook table references.
+ * @module workbookTable
+ * @category Services
+ */
+import type { WorkbookTableId, WorkbookTableRef } from "../models/WorkbookTable.ts";
+import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheet.ts";
 /**
  * Creates a reference to a workbook table.
  * @param worksheetRef - The reference to the worksheet containing the table.

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

@@ -1 +1 @@
-{"version":3,"file":"workbookTable.d.ts","sourceRoot":"","sources":["../../../src/services/workbookTable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB,CAcjI"}
+{"version":3,"file":"workbookTable.d.ts","sourceRoot":"","sources":["../../../src/services/workbookTable.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AACpF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAE3E;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB,CAcjI"}

package/dist/esm/services/workbookTable.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for creating and working with workbook table references.
+ * @module workbookTable
+ * @category Services
+ */
 /**
  * Creates a reference to a workbook table.
  * @param worksheetRef - The reference to the worksheet containing the table.

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

@@ -1,6 +1,10 @@
-import type { ColumnName } from "../models/ColumnName.ts";
-import type { WorkbookTableColumnRef } from "../models/WorkbookTableColumnRef.ts";
-import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
+/**
+ * Utilities for creating and working with workbook table column references.
+ * @module workbookTableColumn
+ * @category Services
+ */
+import type { ColumnName } from "../models/Column.ts";
+import type { WorkbookTableColumnRef, WorkbookTableRef } from "../models/WorkbookTable.ts";
 /**
  * Creates a reference to a workbook table column.
  * @param tableRef - The reference to the worksheet containing the table.

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

@@ -1 +1 @@
-{"version":3,"file":"workbookTableColumn.d.ts","sourceRoot":"","sources":["../../../src/services/workbookTableColumn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,sBAAsB,CAexI"}
+{"version":3,"file":"workbookTableColumn.d.ts","sourceRoot":"","sources":["../../../src/services/workbookTableColumn.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE3F;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,sBAAsB,CAexI"}

package/dist/esm/services/workbookTableColumn.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for creating and working with workbook table column references.
+ * @module workbookTableColumn
+ * @category Services
+ */
 /**
  * Creates a reference to a workbook table column.
  * @param tableRef - The reference to the worksheet containing the table.

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

@@ -1,7 +1,10 @@
-import type { WorkbookRef } from "../models/WorkbookRef.ts";
-import type { WorkbookWorksheetId } from "../models/WorkbookWorksheetId.ts";
-import type { WorkbookWorksheetName } from "../models/WorkbookWorksheetName.ts";
-import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Utilities for creating and working with workbook worksheet references.
+ * @module workbookWorksheet
+ * @category Services
+ */
+import type { WorkbookRef } from "../models/Workbook.ts";
+import type { WorkbookWorksheetId, WorkbookWorksheetName, WorkbookWorksheetRef } from "../models/WorkbookWorksheet.ts";
 /** ID of the initial worksheet that is included in a new workbook. */
 export declare const defaultWorkbookWorksheetId: WorkbookWorksheetId;
 /** Name of the initial worksheet that is included in a new workbook. */

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

@@ -1 +1 @@
-{"version":3,"file":"workbookWorksheet.d.ts","sourceRoot":"","sources":["../../../src/services/workbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAE9E,sEAAsE;AACtE,eAAO,MAAM,0BAA0B,EAA+C,mBAAmB,CAAC;AAE1G,wEAAwE;AACxE,eAAO,MAAM,4BAA4B,EAAe,qBAAqB,CAAC;AAE9E;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,SAAS,GAAG,oBAAoB,CAavI;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,CAEhG"}
+{"version":3,"file":"workbookWorksheet.d.ts","sourceRoot":"","sources":["../../../src/services/workbookWorksheet.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAEvH,sEAAsE;AACtE,eAAO,MAAM,0BAA0B,EAA+C,mBAAmB,CAAC;AAE1G,wEAAwE;AACxE,eAAO,MAAM,4BAA4B,EAAe,qBAAqB,CAAC;AAE9E;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,GAAG,SAAS,GAAG,oBAAoB,CAavI;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,WAAW,GAAG,oBAAoB,CAEhG"}

package/dist/esm/services/workbookWorksheet.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for creating and working with workbook worksheet references.
+ * @module workbookWorksheet
+ * @category Services
+ */
 /** ID of the initial worksheet that is included in a new workbook. */
 export const defaultWorkbookWorksheetId = "{00000000-0001-0000-0000-000000000000}"; // Program Manager in Microsoft Office Extensibility team says this ID is used for the first sheet of all workbooks by design, but not documented. https://github.com/OfficeDev/office-js/issues/552#issuecomment-800841930
 /** Name of the initial worksheet that is included in a new workbook. */

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

@@ -1,14 +1,20 @@
+/**
+ * Copy a drive item.
+ * @module copyDriveItem
+ * @category Tasks
+ */
 import type { DriveItem } from "@microsoft/microsoft-graph-types";
-import type { DriveItemPath } from "../models/DriveItemPath.ts";
-import type { DriveItemRef } from "../models/DriveItemRef.ts";
-import type { DriveRef } from "../models/DriveRef.ts";
+import type { DriveRef } from "../models/Drive.ts";
+import type { DriveItemPath, DriveItemRef } from "../models/DriveItem.ts";
 /**
- * Copy a drive item, blocking and polling for completion.
- *
- * @param srcFileRef - A reference to the source file to be copied.
- * @param dstFilePath - Destination file path
- * @param timeoutMs - Timeout in milliseconds for the copy operation.
- * @returns
+ * Copy a drive item.
+ * @remarks The underlying GraphAPI operation is asynchronous, so this function will block until the copy operation is complete or the timeout is reached.
+ * @param srcFileRef A reference to the source file to be copied.
+ * @param dstDriveRef Destination drive
+ * @param dstFilePath Destination path where the item should be copied to.
+ * @param timeoutMs Timeout in milliseconds for the copy operation.
+ * @returns Reference to the new drive item.
+ * @throws {@link RequestTimeoutError} If the copy operation does not complete within the specified timeout.
  */
 export default function copyDriveItem(srcFileRef: DriveItemRef, dstDriveRef: DriveRef, dstFilePath: DriveItemPath, timeoutMs?: number): Promise<DriveItem & DriveItemRef>;
 //# sourceMappingURL=copyDriveItem.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"copyDriveItem.d.ts","sourceRoot":"","sources":["../../../src/tasks/copyDriveItem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAElE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAMtD;;;;;;;GAOG;AACH,wBAA8B,aAAa,CAAC,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,SAAS,SAAQ,GAAG,OAAO,CAAC,SAAS,GAAG,YAAY,CAAC,CAqB7K"}
+{"version":3,"file":"copyDriveItem.d.ts","sourceRoot":"","sources":["../../../src/tasks/copyDriveItem.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAElE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAM1E;;;;;;;;;GASG;AACH,wBAA8B,aAAa,CAAC,UAAU,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EAAE,SAAS,SAAQ,GAAG,OAAO,CAAC,SAAS,GAAG,YAAY,CAAC,CAqB7K"}

package/dist/esm/tasks/copyDriveItem.js

@@ -1,15 +1,22 @@
-import TimeoutError from "../errors/TimeoutError.js";
+/**
+ * Copy a drive item.
+ * @module copyDriveItem
+ * @category Tasks
+ */
+import RequestTimeoutError from "../errors/RequestTimeoutError.js";
 import getDriveItemByPath from "../operations/driveItem/getDriveItemByPath.js";
 import initiateCopyDriveItem from "../operations/driveItem/initiateCopyDriveItem.js";
 import { splitDriveItemPath } from "../services/driveItem.js";
 import { sleep } from "../services/sleep.js";
 /**
- * Copy a drive item, blocking and polling for completion.
- *
- * @param srcFileRef - A reference to the source file to be copied.
- * @param dstFilePath - Destination file path
- * @param timeoutMs - Timeout in milliseconds for the copy operation.
- * @returns
+ * Copy a drive item.
+ * @remarks The underlying GraphAPI operation is asynchronous, so this function will block until the copy operation is complete or the timeout is reached.
+ * @param srcFileRef A reference to the source file to be copied.
+ * @param dstDriveRef Destination drive
+ * @param dstFilePath Destination path where the item should be copied to.
+ * @param timeoutMs Timeout in milliseconds for the copy operation.
+ * @returns Reference to the new drive item.
+ * @throws {@link RequestTimeoutError} If the copy operation does not complete within the specified timeout.
  */
 export default async function copyDriveItem(srcFileRef, dstDriveRef, dstFilePath, timeoutMs = 16000) {
     const { folderPath, fileName } = splitDriveItemPath(dstFilePath);
@@ -24,7 +31,7 @@ export default async function copyDriveItem(srcFileRef, dstDriveRef, dstFilePath
         catch (_) {
             const elapsedTime = Date.now() - start;
             if (elapsedTime + delay > timeoutMs) {
-                throw new TimeoutError(`Timeout while copying ${srcFileRef.itemId} to ${dstFilePath}`);
+                throw new RequestTimeoutError(`Timeout while copying ${srcFileRef.itemId} to ${dstFilePath}`);
             }
             await sleep(delay);
             delay = Math.min(delay * 2, timeoutMs - (Date.now() - start)); // Double the delay but don't exceed remaining time

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

@@ -1,12 +1,16 @@
+/**
+ * Create a new workbook and open a session for that workbook.
+ * @module createWorkbookAndStartSession
+ * @category Tasks
+ */
 import type { Workbook } from "@microsoft/microsoft-graph-types";
-import type { DriveItemPath } from "../models/DriveItemPath.ts";
-import type { DriveItemRef } from "../models/DriveItemRef.ts";
-import type { DriveRef } from "../models/DriveRef.ts";
-import type { WorkbookRef } from "../models/WorkbookRef.ts";
+import type { DriveRef } from "../models/Drive.ts";
+import type { DriveItemPath, DriveItemRef } from "../models/DriveItem.ts";
+import type { WorkbookRef } from "../models/Workbook.ts";
 /**
- * Create a new workbook and open a session for that workbook in a single operation.
+ * Create a new workbook and open a session for that workbook/
  *
- * @param parentRef - A reference to the drive or driveItem where the workbook will be created.
+ * @param parentRef Reference to the drive or driveItem where the workbook will be created.
  * @param itemPath - The path of the new workbook within the drive.
  * @returns The created workbook and session details.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"createWorkbookAndStartSession.d.ts","sourceRoot":"","sources":["../../../src/tasks/createWorkbookAndStartSession.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;;;;;GAMG;AACH,wBAA8B,6BAA6B,CAAC,SAAS,EAAE,QAAQ,GAAG,YAAY,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC,CAQxJ"}
+{"version":3,"file":"createWorkbookAndStartSession.d.ts","sourceRoot":"","sources":["../../../src/tasks/createWorkbookAndStartSession.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIzD;;;;;;GAMG;AACH,wBAA8B,6BAA6B,CAAC,SAAS,EAAE,QAAQ,GAAG,YAAY,EAAE,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,GAAG,WAAW,CAAC,CAQxJ"}