microsoft-graph 2.3.0 → 2.3.1

package/dist/services/addressManipulation.js

@@ -6,6 +6,12 @@ const lastColumn = "XFD";
 const firstRow = "1";
 const lastRow = "1048576";
 const addressPattern = /^(?<sheet>[A-Za-z0-9_]+!)?(?:(?<startColumn>[A-Z]+)?(?<startRow>\d+)?(?::(?<endColumn>[A-Z]+)?(?<endRow>\d+)?)?)$/;
+/**
+ * Decomposes an address into its components (start and end columns/rows).
+ * @param address - The address to decompose.
+ * @returns The decomposed address components.
+ * @throws InvalidArgumentError if the address format is invalid.
+ */
 export function decomposeAddress(address) {
     const match = address.match(addressPattern);
     if (!match?.groups) {
@@ -19,6 +25,12 @@ export function decomposeAddress(address) {
         endRow: groups.endRow ?? groups.startRow ?? lastRow,
     };
 }
+/**
+ * Composes an address from its components.
+ * @param components - The address components.
+ * @returns The composed address.
+ * @throws InvalidArgumentError if the components are invalid.
+ */
 export function composeAddress(components) {
     if (isSingleColumn(components) && isMaxRows(components)) {
         return composeColumnAddress(components.startColumn);
@@ -43,14 +55,29 @@ export function composeAddress(components) {
     }
     return composeCellRangeAddress(components.startColumn, components.startRow, components.endColumn, components.endRow);
 }
+/**
+ * Gets the first cell address from a given address.
+ * @param address - The address to analyze.
+ * @returns The first cell address.
+ */
 export function getFirstCellAddress(address) {
     const components = decomposeAddress(address);
     return composeCellAddress(components.startColumn, components.startRow);
 }
+/**
+ * Gets the last cell address from a given address.
+ * @param address - The address to analyze.
+ * @returns The last cell address.
+ */
 export function getLastCellAddress(address) {
     const components = decomposeAddress(address);
     return composeCellAddress(components.endColumn, components.endRow);
 }
+/**
+ * Gets the first row address from a given address.
+ * @param address - The address to analyze.
+ * @returns The first row address.
+ */
 export function getFirstRowAddress(address) {
     const components = decomposeAddress(address);
     return composeAddress({
@@ -60,6 +87,11 @@ export function getFirstRowAddress(address) {
         endRow: components.startRow,
     });
 }
+/**
+ * Gets the last row address from a given address.
+ * @param address - The address to analyze.
+ * @returns The last row address.
+ */
 export function getLastRowAddress(address) {
     const components = decomposeAddress(address);
     return composeAddress({
@@ -69,6 +101,11 @@ export function getLastRowAddress(address) {
         endRow: components.endRow,
     });
 }
+/**
+ * Gets the first column address from a given address.
+ * @param address - The address to analyze.
+ * @returns The first column address.
+ */
 export function getFirstColumnAddress(address) {
     const components = decomposeAddress(address);
     return composeAddress({
@@ -78,6 +115,11 @@ export function getFirstColumnAddress(address) {
         endRow: components.endRow,
     });
 }
+/**
+ * Gets the last column address from a given address.
+ * @param address - The address to analyze.
+ * @returns The last column address.
+ */
 export function getLastColumnAddress(address) {
     const components = decomposeAddress(address);
     return composeAddress({
@@ -87,6 +129,15 @@ export function getLastColumnAddress(address) {
         endRow: components.endRow,
     });
 }
+/**
+ * Offsets an address by the specified column and row offsets.
+ * @param address - The address to offset.
+ * @param columnOffset - The column offset.
+ * @param rowOffset - The row offset.
+ * @returns The offset address.
+ * @throws UnsupportedAddressTypeError if the address cannot be offset.
+ * @throws InvalidArgumentError if the offset is out of bounds.
+ */
 export function offsetAddress(address, columnOffset, rowOffset) {
     const components = decomposeAddress(address);
     if (isMaxRows(components) && rowOffset !== 0) {
@@ -116,12 +167,28 @@ export function offsetAddress(address, columnOffset, rowOffset) {
         endRow: newEndRow,
     });
 }
+/**
+ * Increments the row address by one.
+ * @param address - The address to increment.
+ * @returns The incremented address.
+ */
 export function incrementRowAddress(address) {
     return offsetAddress(address, 0, +1);
 }
+/**
+ * Decrements the row address by one.
+ * @param address - The address to decrement.
+ * @returns The decremented address.
+ */
 export function decrementRowAddress(address) {
     return offsetAddress(address, 0, -1);
 }
+/**
+ * Checks if two addresses overlap.
+ * @param address1 - The first address.
+ * @param address2 - The second address.
+ * @returns True if the addresses overlap, otherwise false.
+ */
 export function isAddressOverlapping(address1, address2) {
     const components1 = decomposeAddress(address1);
     const components2 = decomposeAddress(address2);

package/dist/services/addressOffset.d.ts

@@ -1,8 +1,28 @@
 import type { ColumnAddress, RowAddress } from "../models/Address.ts";
 import type { ColumnOffset } from "../models/ColumnOffset.ts";
 import type { RowOffset } from "../models/RowOffset.ts";
+/**
+ * Converts a column address (e.g., "A") to a zero-based column offset.
+ * @param column - The column address.
+ * @returns The zero-based column offset.
+ */
 export declare function columnAddressToOffset(column: ColumnAddress): ColumnOffset;
+/**
+ * Converts a zero-based column offset to a column address (e.g., "A").
+ * @param offset - The zero-based column offset.
+ * @returns The column address.
+ */
 export declare function offsetToColumnAddress(offset: ColumnOffset): ColumnAddress;
+/**
+ * Converts a row address (e.g., "1") to a zero-based row offset.
+ * @param row - The row address.
+ * @returns The zero-based row offset.
+ */
 export declare function rowAddressToOffset(row: RowAddress): RowOffset;
+/**
+ * Converts a zero-based row offset to a row address (e.g., "1").
+ * @param offset - The zero-based row offset.
+ * @returns The row address.
+ */
 export declare function offsetToRowAddress(offset: RowOffset): RowAddress;
 //# sourceMappingURL=addressOffset.d.ts.map

package/dist/services/addressOffset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addressOffset.d.ts","sourceRoot":"","sources":["../../src/services/addressOffset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAMzE;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,aAAa,CASzE;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,UAAU,GAAG,SAAS,CAE7D;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAEhE"}
+{"version":3,"file":"addressOffset.d.ts","sourceRoot":"","sources":["../../src/services/addressOffset.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,aAAa,GAAG,YAAY,CAMzE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,aAAa,CASzE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,UAAU,GAAG,SAAS,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,GAAG,UAAU,CAEhE"}

package/dist/services/addressOffset.js

@@ -1,3 +1,8 @@
+/**
+ * Converts a column address (e.g., "A") to a zero-based column offset.
+ * @param column - The column address.
+ * @returns The zero-based column offset.
+ */
 export function columnAddressToOffset(column) {
     let offset = 0;
     for (let i = 0; i < column.length; i++) {
@@ -5,6 +10,11 @@ export function columnAddressToOffset(column) {
     }
     return (offset - 1);
 }
+/**
+ * Converts a zero-based column offset to a column address (e.g., "A").
+ * @param offset - The zero-based column offset.
+ * @returns The column address.
+ */
 export function offsetToColumnAddress(offset) {
     let result = "";
     let currentOffset = offset + 1;
@@ -15,9 +25,19 @@ export function offsetToColumnAddress(offset) {
     }
     return result;
 }
+/**
+ * Converts a row address (e.g., "1") to a zero-based row offset.
+ * @param row - The row address.
+ * @returns The zero-based row offset.
+ */
 export function rowAddressToOffset(row) {
     return (Number.parseInt(row, 10) - 1);
 }
+/**
+ * Converts a zero-based row offset to a row address (e.g., "1").
+ * @param offset - The zero-based row offset.
+ * @returns The row address.
+ */
 export function offsetToRowAddress(offset) {
     return (offset + 1).toString();
 }

package/dist/services/context.d.ts

@@ -5,9 +5,26 @@ import type { ContextId } from "../models/ContextId.ts";
 import type { ContextRef } from "../models/ContextRef.ts";
 import type { HttpProxy } from "../models/HttpProxy.ts";
 import type { TenantId } from "../models/TenantId.ts";
-/** Register a tenant/client so that it's secret can be used latter. */
+/**
+ * Registers a tenant+client so that its secret can be used later.
+ * @param tenantId - The tenant ID.
+ * @param clientId - The client ID.
+ * @param clientSecret - The client secret.
+ * @param httpProxy - Optional HTTP proxy configuration.
+ * @returns A reference to the registered context.
+ */
 export declare function register(tenantId: TenantId, clientId: ClientId, clientSecret: ClientSecret, httpProxy?: HttpProxy | undefined): ContextRef;
+/**
+ * Retrieves the context for a given context ID.
+ * @param contextId - The ID of the context.
+ * @returns The context associated with the given ID.
+ * @throws ContextNotRegisteredError if the context ID is not registered.
+ */
 export declare function getContext(contextId: ContextId): Context;
-/** Opinionated method of getting default context reference. Not recommended for production use. */
+/**
+ * Retrieves the opinionated default context reference. NOT RECOMMENDED FOR PRODUCTION USE.
+ * @returns A reference to the default context.
+ * @remarks This method is opinionated and not recommended for production use.
+ */
 export declare function getDefaultContextRef(): ContextRef;
 //# sourceMappingURL=context.d.ts.map

package/dist/services/context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/services/context.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAMtD,uEAAuE;AACvE,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAe1I;AAED,wBAAgB,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAMxD;AAYD,mGAAmG;AACnG,wBAAgB,oBAAoB,IAAI,UAAU,CASjD"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/services/context.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAMtD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAe1I;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAMxD;AAYD;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,UAAU,CASjD"}

package/dist/services/context.js

@@ -2,7 +2,14 @@ import ContextNotRegisteredError from "../errors/ContextNotRegisteredError.js";
 import { getEnvironmentVariable } from "./environmentVariable.js";
 import { generateRandomString } from "./random.js";
 const contexts = {};
-/** Register a tenant/client so that it's secret can be used latter. */
+/**
+ * Registers a tenant+client so that its secret can be used later.
+ * @param tenantId - The tenant ID.
+ * @param clientId - The client ID.
+ * @param clientSecret - The client secret.
+ * @param httpProxy - Optional HTTP proxy configuration.
+ * @returns A reference to the registered context.
+ */
 export function register(tenantId, clientId, clientSecret, httpProxy) {
     const contextId = generateContextId();
     const context = {
@@ -15,6 +22,12 @@ export function register(tenantId, clientId, clientSecret, httpProxy) {
     const contextRef = createContextRef(contextId);
     return contextRef;
 }
+/**
+ * Retrieves the context for a given context ID.
+ * @param contextId - The ID of the context.
+ * @returns The context associated with the given ID.
+ * @throws ContextNotRegisteredError if the context ID is not registered.
+ */
 export function getContext(contextId) {
     const context = contexts[contextId];
     if (!context) {
@@ -30,7 +43,11 @@ function createContextRef(contextId) {
         contextId,
     };
 }
-/** Opinionated method of getting default context reference. Not recommended for production use. */
+/**
+ * Retrieves the opinionated default context reference. NOT RECOMMENDED FOR PRODUCTION USE.
+ * @returns A reference to the default context.
+ * @remarks This method is opinionated and not recommended for production use.
+ */
 export function getDefaultContextRef() {
     const tenantId = getEnvironmentVariable("AZURE_TENANT_ID");
     const clientId = getEnvironmentVariable("AZURE_CLIENT_ID");

package/dist/services/drive.d.ts

@@ -1,7 +1,18 @@
 import type { DriveId } from "../models/DriveId.ts";
 import type { DriveRef } from "../models/DriveRef.ts";
 import type { SiteRef } from "../models/SiteRef.ts";
+/**
+ * Creates a reference to a drive.
+ * @param siteRef - The reference to the site.
+ * @param driveId - The ID of the drive.
+ * @returns A reference to the drive.
+ * @throws ProtocolError if the drive ID is missing.
+ */
 export declare function createDriveRef(siteRef: SiteRef, driveId: DriveId | undefined): DriveRef;
-/** Opinionated method of getting default drive reference. Not recommended for production use. */
+/**
+ * Retrieves the opinionated default drive reference. NOT RECOMMENDED FOR PRODUCTION USE.
+ * @returns A reference to the default drive.
+ * @remarks This method is opinionated and not recommended for production use.
+ */
 export declare function getDefaultDriveRef(): DriveRef;
 //# sourceMappingURL=drive.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"drive.d.ts","sourceRoot":"","sources":["../../src/services/drive.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAMpD,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAUvF;AAED,iGAAiG;AACjG,wBAAgB,kBAAkB,IAAI,QAAQ,CAa7C"}
+{"version":3,"file":"drive.d.ts","sourceRoot":"","sources":["../../src/services/drive.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGtD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAMpD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAUvF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAa7C"}

package/dist/services/drive.js

@@ -2,6 +2,13 @@ import ProtocolError from "../errors/ProtocolError.js";
 import { register } from "./context.js";
 import { getEnvironmentVariable } from "./environmentVariable.js";
 import { createSiteRef } from "./site.js";
+/**
+ * Creates a reference to a drive.
+ * @param siteRef - The reference to the site.
+ * @param driveId - The ID of the drive.
+ * @returns A reference to the drive.
+ * @throws ProtocolError if the drive ID is missing.
+ */
 export function createDriveRef(siteRef, driveId) {
     if (!driveId) {
         throw new ProtocolError("DriveID is missing");
@@ -12,7 +19,11 @@ export function createDriveRef(siteRef, driveId) {
         driveId,
     };
 }
-/** Opinionated method of getting default drive reference. Not recommended for production use. */
+/**
+ * Retrieves the opinionated default drive reference. NOT RECOMMENDED FOR PRODUCTION USE.
+ * @returns A reference to the default drive.
+ * @remarks This method is opinionated and not recommended for production use.
+ */
 export function getDefaultDriveRef() {
     const tenantId = getEnvironmentVariable("AZURE_TENANT_ID");
     const clientId = getEnvironmentVariable("AZURE_CLIENT_ID");

package/dist/services/driveItem.d.ts

@@ -4,7 +4,19 @@ import type { DriveItemRef } from "../models/DriveItemRef.ts";
 import type { DriveRef } from "../models/DriveRef.ts";
 export declare const workbookFileExtension = "xlsx";
 export declare const rootDriveItemPath: DriveItemPath;
-/** Create a drive item path from a given set of segments. Ie ["a","b"] => "/a/b" */
+/**
+ * Creates a drive item path from a given set of segments.
+ * @param segments - The segments of the path.
+ * @returns The constructed drive item path.
+ * @throws InvalidArgumentError if a segment is invalid or the path exceeds 400 characters.
+ */
 export declare function driveItemPath(...segments: string[]): DriveItemPath;
+/**
+ * Creates a reference to a drive item.
+ * @param driveRef - The reference to the drive.
+ * @param itemId - The ID of the drive item.
+ * @returns A reference to the drive item.
+ * @throws ProtocolError if the item ID is missing.
+ */
 export declare function createDriveItemRef(driveRef: DriveRef, itemId: DriveItemId | undefined): DriveItemRef;
 //# sourceMappingURL=driveItem.d.ts.map

package/dist/services/driveItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"driveItem.d.ts","sourceRoot":"","sources":["../../src/services/driveItem.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,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,eAAO,MAAM,qBAAqB,SAAS,CAAC;AAE5C,eAAO,MAAM,iBAAiB,eAAqB,CAAC;AAEpD,oFAAoF;AACpF,wBAAgB,aAAa,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,aAAa,CAkClE;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,YAAY,CAWpG"}
+{"version":3,"file":"driveItem.d.ts","sourceRoot":"","sources":["../../src/services/driveItem.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,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,eAAO,MAAM,qBAAqB,SAAS,CAAC;AAE5C,eAAO,MAAM,iBAAiB,eAAqB,CAAC;AAEpD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,aAAa,CAkClE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,YAAY,CAWpG"}

package/dist/services/driveItem.js

@@ -4,7 +4,12 @@ const segmentPattern = /^[^"*:<>?\\|#]{1,256}$/;
 const reservedNames = ["CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9"];
 export const workbookFileExtension = "xlsx";
 export const rootDriveItemPath = driveItemPath("/");
-/** Create a drive item path from a given set of segments. Ie ["a","b"] => "/a/b" */
+/**
+ * Creates a drive item path from a given set of segments.
+ * @param segments - The segments of the path.
+ * @returns The constructed drive item path.
+ * @throws InvalidArgumentError if a segment is invalid or the path exceeds 400 characters.
+ */
 export function driveItemPath(...segments) {
     for (const segment of segments) {
         if (segment === "") {
@@ -32,6 +37,13 @@ export function driveItemPath(...segments) {
     }
     return path;
 }
+/**
+ * Creates a reference to a drive item.
+ * @param driveRef - The reference to the drive.
+ * @param itemId - The ID of the drive item.
+ * @returns A reference to the drive item.
+ * @throws ProtocolError if the item ID is missing.
+ */
 export function createDriveItemRef(driveRef, itemId) {
     if (!itemId) {
         throw new ProtocolError("ItemID is missing");

package/dist/services/environmentVariable.d.ts

@@ -1,3 +1,16 @@
+/**
+ * Retrieves the value of an environment variable.
+ * @param env - The name of the environment variable.
+ * @param fallbackValue - The fallback value to use if the environment variable is not set. Defaults to null.
+ * @returns The value of the environment variable or the fallback value.
+ * @throws EnvironmentVariableMissingError if the environment variable is not set and no fallback value is provided.
+ */
 export declare function getEnvironmentVariable(env: string, fallbackValue?: string | null): unknown;
+/**
+ * Binds an environment variable to a function that retrieves its value.
+ * @param env - The name of the environment variable.
+ * @param fallbackValue - The fallback value to use if the environment variable is not set. Defaults to null.
+ * @returns A function that retrieves the value of the environment variable or the fallback value.
+ */
 export declare function bindEnvironmentVariable(env: string, fallbackValue?: string | null): () => unknown;
 //# sourceMappingURL=environmentVariable.d.ts.map

package/dist/services/environmentVariable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environmentVariable.d.ts","sourceRoot":"","sources":["../../src/services/environmentVariable.ts"],"names":[],"mappings":"AAEA,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAWhG;AAED,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM,OAAO,CAEvG"}
+{"version":3,"file":"environmentVariable.d.ts","sourceRoot":"","sources":["../../src/services/environmentVariable.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAWhG;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,GAAE,MAAM,GAAG,IAAW,GAAG,MAAM,OAAO,CAEvG"}

package/dist/services/environmentVariable.js

@@ -1,4 +1,11 @@
 import EnvironmentVariableMissingError from "../errors/EnvironmentVariableMissingError.js";
+/**
+ * Retrieves the value of an environment variable.
+ * @param env - The name of the environment variable.
+ * @param fallbackValue - The fallback value to use if the environment variable is not set. Defaults to null.
+ * @returns The value of the environment variable or the fallback value.
+ * @throws EnvironmentVariableMissingError if the environment variable is not set and no fallback value is provided.
+ */
 export function getEnvironmentVariable(env, fallbackValue = null) {
     const value = process.env[env]?.trim() ?? "";
     if (value === "") {
@@ -9,6 +16,12 @@ export function getEnvironmentVariable(env, fallbackValue = null) {
     }
     return value;
 }
+/**
+ * Binds an environment variable to a function that retrieves its value.
+ * @param env - The name of the environment variable.
+ * @param fallbackValue - The fallback value to use if the environment variable is not set. Defaults to null.
+ * @returns A function that retrieves the value of the environment variable or the fallback value.
+ */
 export function bindEnvironmentVariable(env, fallbackValue = null) {
     return () => getEnvironmentVariable(env, fallbackValue);
 }

package/dist/services/httpAgent.d.ts

@@ -1,4 +1,9 @@
 import { HttpsProxyAgent } from "https-proxy-agent";
 import type { HttpProxy } from "../models/HttpProxy.ts";
+/**
+ * Attempts to create an HTTP agent for a given proxy configuration.
+ * @param httpProxy - The HTTP proxy configuration.
+ * @returns An instance of HttpsProxyAgent if the proxy is defined, otherwise undefined.
+ */
 export declare function tryGetHttpAgent(httpProxy: HttpProxy | undefined): HttpsProxyAgent<string> | undefined;
 //# sourceMappingURL=httpAgent.d.ts.map

package/dist/services/httpAgent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"httpAgent.d.ts","sourceRoot":"","sources":["../../src/services/httpAgent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,SAAS,CAKrG"}
+{"version":3,"file":"httpAgent.d.ts","sourceRoot":"","sources":["../../src/services/httpAgent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,GAAG,SAAS,CAKrG"}

package/dist/services/httpAgent.js

@@ -1,4 +1,9 @@
 import { HttpsProxyAgent } from "https-proxy-agent";
+/**
+ * Attempts to create an HTTP agent for a given proxy configuration.
+ * @param httpProxy - The HTTP proxy configuration.
+ * @returns An instance of HttpsProxyAgent if the proxy is defined, otherwise undefined.
+ */
 export function tryGetHttpAgent(httpProxy) {
     if (!httpProxy) {
         return undefined;

package/dist/services/httpStatus.d.ts

@@ -1,4 +1,19 @@
+/**
+ * Checks if the HTTP status code indicates a successful response.
+ * @param status - The HTTP status code.
+ * @returns True if the status code is in the range 200-299, otherwise false.
+ */
 export declare function isHttpOk(status: number): boolean;
+/**
+ * Checks if the HTTP status code indicates too many requests (rate limiting).
+ * @param status - The HTTP status code.
+ * @returns True if the status code is 429, otherwise false.
+ */
 export declare function isHttpTooManyRequests(status: number): boolean;
+/**
+ * Checks if the HTTP status code indicates the service is unavailable.
+ * @param status - The HTTP status code.
+ * @returns True if the status code is 503, otherwise false.
+ */
 export declare function isServiceUnavailable(status: number): boolean;
 //# sourceMappingURL=httpStatus.d.ts.map

package/dist/services/httpStatus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"httpStatus.d.ts","sourceRoot":"","sources":["../../src/services/httpStatus.ts"],"names":[],"mappings":"AAAA,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE5D"}
+{"version":3,"file":"httpStatus.d.ts","sourceRoot":"","sources":["../../src/services/httpStatus.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE5D"}

package/dist/services/httpStatus.js

@@ -1,9 +1,24 @@
+/**
+ * Checks if the HTTP status code indicates a successful response.
+ * @param status - The HTTP status code.
+ * @returns True if the status code is in the range 200-299, otherwise false.
+ */
 export function isHttpOk(status) {
     return status >= 200 && status < 300;
 }
+/**
+ * Checks if the HTTP status code indicates too many requests (rate limiting).
+ * @param status - The HTTP status code.
+ * @returns True if the status code is 429, otherwise false.
+ */
 export function isHttpTooManyRequests(status) {
     return status === 429;
 }
+/**
+ * Checks if the HTTP status code indicates the service is unavailable.
+ * @param status - The HTTP status code.
+ * @returns True if the status code is 503, otherwise false.
+ */
 export function isServiceUnavailable(status) {
     return status === 503;
 }

package/dist/services/operationId.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Converts an operation index to an operation ID.
+ * @param index - The operation index.
+ * @returns The operation ID as a string.
+ */
 export declare function operationIndexToId(index: number): string;
+/**
+ * Converts an operation ID to an operation index.
+ * @param id - The operation ID as a string.
+ * @returns The operation index as a number.
+ */
 export declare function operationIdToIndex(id: string): number;
 //# sourceMappingURL=operationId.d.ts.map

package/dist/services/operationId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operationId.d.ts","sourceRoot":"","sources":["../../src/services/operationId.ts"],"names":[],"mappings":"AAAA,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAErD"}
+{"version":3,"file":"operationId.d.ts","sourceRoot":"","sources":["../../src/services/operationId.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAExD;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAErD"}

package/dist/services/operationId.js

@@ -1,6 +1,16 @@
+/**
+ * Converts an operation index to an operation ID.
+ * @param index - The operation index.
+ * @returns The operation ID as a string.
+ */
 export function operationIndexToId(index) {
     return index.toString();
 }
+/**
+ * Converts an operation ID to an operation index.
+ * @param id - The operation ID as a string.
+ * @returns The operation index as a number.
+ */
 export function operationIdToIndex(id) {
     return Number.parseInt(id, 10);
 }

package/dist/services/random.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Generates a random alphanumeric string of the specified length.
+ * @param length - The length of the string to generate. Defaults to 16.
+ * @returns A random alphanumeric string.
+ */
 export declare function generateRandomString(length?: number): string;
 //# sourceMappingURL=random.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"random.d.ts","sourceRoot":"","sources":["../../src/services/random.ts"],"names":[],"mappings":"AAIA,wBAAgB,oBAAoB,CAAC,MAAM,SAAK,GAAG,MAAM,CAQxD"}
+{"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"}

package/dist/services/random.js

@@ -1,5 +1,10 @@
 import { randomInt } from "node:crypto";
 const characters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+/**
+ * Generates a random alphanumeric string of the specified length.
+ * @param length - The length of the string to generate. Defaults to 16.
+ * @returns A random alphanumeric string.
+ */
 export function generateRandomString(length = 16) {
     let result = "";
     for (let i = 0; i < length; i++) {

package/dist/services/sharepointUrl.d.ts

@@ -1,7 +1,12 @@
 import type { DriveItemId } from "../models/DriveItemId.ts";
 import type { HostName } from "../models/HostName.ts";
 import type { SiteName } from "../models/SiteName.ts";
-/** Get the site name and item path from a given SharePoint document URL. (ie https://msftfuturesecureai.sharepoint.com/sites/FSAI-MQG/_layouts/15/doc.aspx?sourcedoc={500ff055-1e0f-4c2e-8b32-d167fba4778b} */
+/**
+ * Parses a SharePoint document URL to extract the site name, host name, and item ID.
+ * @param url - The SharePoint document URL.
+ * @returns An object containing the host name, site name, and item ID.
+ * @throws InvalidArgumentError if the URL is invalid or required components are missing.
+ */
 export declare function parseSharepointUrl(url: URL): {
     hostName: HostName;
     siteName: SiteName;

package/dist/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,+MAA+M;AAC/M,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":"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"}

package/dist/services/sharepointUrl.js

@@ -1,5 +1,10 @@
 import InvalidArgumentError from "../errors/InvalidArgumentError.js";
-/** Get the site name and item path from a given SharePoint document URL. (ie https://msftfuturesecureai.sharepoint.com/sites/FSAI-MQG/_layouts/15/doc.aspx?sourcedoc={500ff055-1e0f-4c2e-8b32-d167fba4778b} */
+/**
+ * Parses a SharePoint document URL to extract the site name, host name, and item ID.
+ * @param url - The SharePoint document URL.
+ * @returns An object containing the host name, site name, and item ID.
+ * @throws InvalidArgumentError if the URL is invalid or required components are missing.
+ */
 export function parseSharepointUrl(url) {
     if (!url.hostname.endsWith(".sharepoint.com")) {
         throw new InvalidArgumentError("Invalid SharePoint URL. Hostname must end with '.sharepoint.com'.");

package/dist/services/site.d.ts

@@ -1,7 +1,18 @@
 import type { ContextRef } from "../models/ContextRef.ts";
 import type { SiteId } from "../models/SiteId.ts";
 import type { SiteRef } from "../models/SiteRef.ts";
+/**
+ * Creates a reference to a site.
+ * @param contextRef - The reference to the context.
+ * @param siteId - The ID of the site.
+ * @returns A reference to the site.
+ * @throws ProtocolError if the site ID is missing.
+ */
 export declare function createSiteRef(contextRef: ContextRef, siteId: SiteId | undefined): SiteRef;
-/** Opinionated method of getting default site reference. Not recommended for production use. */
+/**
+ * Retrieves the opinionated default site reference. NOT RECOMMENDED FOR PRODUCTION USE
+ * @returns A reference to the default site.
+ * @remarks This method is opinionated and not recommended for production use.
+ */
 export declare function getDefaultSiteRef(): SiteRef;
 //# sourceMappingURL=site.d.ts.map