microsoft-graph 2.3.0 → 2.4.0

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

package/dist/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,wBAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CASzF;AAED,gGAAgG;AAChG,wBAAgB,iBAAiB,IAAI,OAAO,CAO3C"}
+{"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"}

package/dist/services/site.js

@@ -1,6 +1,13 @@
 import ProtocolError from "../errors/ProtocolError.js";
 import { getDefaultContextRef } from "./context.js";
 import { getEnvironmentVariable } from "./environmentVariable.js";
+/**
+ * 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 function createSiteRef(contextRef, siteId) {
     if (!siteId) {
         throw new ProtocolError("SiteID is missing");
@@ -10,7 +17,11 @@ export function createSiteRef(contextRef, siteId) {
         siteId,
     };
 }
-/** 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 function getDefaultSiteRef() {
     const contextRef = getDefaultContextRef();
     const siteId = getEnvironmentVariable("SHAREPOINT_DEFAULT_SITE_ID");

package/dist/services/sleep.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Pauses execution for the specified number of milliseconds.
+ * @param ms - The number of milliseconds to sleep.
+ * @returns A promise that resolves after the specified time.
+ */
 export declare function sleep(ms: number): Promise<void>;
 //# sourceMappingURL=sleep.d.ts.map

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

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

package/dist/services/sleep.js

@@ -1,3 +1,8 @@
+/**
+ * Pauses execution for the specified number of milliseconds.
+ * @param ms - The number of milliseconds to sleep.
+ * @returns A promise that resolves after the specified time.
+ */
 export function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }

package/dist/services/stringCaseConversion.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Converts a kebab-case string to camelCase.
+ * @param str - The kebab-case string.
+ * @returns The camelCase string.
+ */
 export declare function kebabToCamelCase(str: string): string;
 //# sourceMappingURL=stringCaseConversion.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"stringCaseConversion.d.ts","sourceRoot":"","sources":["../../src/services/stringCaseConversion.ts"],"names":[],"mappings":"AAAA,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;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIpD"}

package/dist/services/stringCaseConversion.js

@@ -1,3 +1,8 @@
+/**
+ * Converts a kebab-case string to camelCase.
+ * @param str - The kebab-case string.
+ * @returns The camelCase string.
+ */
 export function kebabToCamelCase(str) {
     return str
         .replace(/^-+|-+$/g, "") // Remove leading and trailing dashes

package/dist/services/templatedPaths.d.ts

@@ -1,4 +1,10 @@
 import type { GraphPath } from "../models/GraphOperation.ts";
-/** Create a GraphAPI path based on a given template and arguments. Escaping is automatically handeld */
+/**
+ * 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.
+ * @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, string | undefined>): GraphPath;
 //# sourceMappingURL=templatedPaths.d.ts.map

package/dist/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,wGAAwG;AACxG,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAgBlG"}
+{"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,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAgBlG"}

package/dist/services/templatedPaths.js

@@ -1,7 +1,13 @@
 import BadTemplateError from "../errors/BadTemplateError.js";
 import { kebabToCamelCase } from "./stringCaseConversion.js";
 const argumentPattern = /\{([a-z-]+)\}/g;
-/** Create a GraphAPI path based on a given template and arguments. Escaping is automatically handeld */
+/**
+ * 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.
+ * @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.`);

package/dist/services/temporaryFiles.d.ts

@@ -1,3 +1,8 @@
 import type { DriveItemPath } from "../models/DriveItemPath.ts";
+/**
+ * Generates a temporary file name with the specified extension.
+ * @param extension - The file extension. Defaults to "tmp".
+ * @returns A temporary file name.
+ */
 export declare function generateTempFileName(extension?: string | null): DriveItemPath;
 //# sourceMappingURL=temporaryFiles.d.ts.map

package/dist/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,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,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAGhE;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,GAAE,MAAM,GAAG,IAAY,GAAG,aAAa,CAGpF"}

package/dist/services/temporaryFiles.js

@@ -1,4 +1,9 @@
 import { generateRandomString } from "./random.js";
+/**
+ * Generates a temporary file name with the specified extension.
+ * @param extension - The file extension. Defaults to "tmp".
+ * @returns A temporary file name.
+ */
 export function generateTempFileName(extension = "tmp") {
     const body = generateRandomString(16);
     return `~${body}.${extension}`;

package/dist/services/workbookRange.d.ts

@@ -1,5 +1,11 @@
 import type { Address } from "../models/Address.ts";
 import type { WorkbookRangeRef } from "../models/WorkbookRangeRef.ts";
 import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Creates a reference to a workbook range.
+ * @param worksheetRef - The reference to the worksheet containing the range.
+ * @param address - The address of the range.
+ * @returns A reference to the workbook range.
+ */
 export declare function createWorkbookRangeRef(worksheetRef: WorkbookWorksheetRef, address: Address): WorkbookRangeRef;
 //# sourceMappingURL=workbookRange.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"workbookRange.d.ts","sourceRoot":"","sources":["../../src/services/workbookRange.ts"],"names":[],"mappings":"AAAA,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;AAE9E,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB,CAU7G"}
+{"version":3,"file":"workbookRange.d.ts","sourceRoot":"","sources":["../../src/services/workbookRange.ts"],"names":[],"mappings":"AAAA,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;AAE9E;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB,CAU7G"}

package/dist/services/workbookRange.js

@@ -1,3 +1,9 @@
+/**
+ * Creates a reference to a workbook range.
+ * @param worksheetRef - The reference to the worksheet containing the range.
+ * @param address - The address of the range.
+ * @returns A reference to the workbook range.
+ */
 export function createWorkbookRangeRef(worksheetRef, address) {
     return {
         contextId: worksheetRef.contextId,

package/dist/services/workbookTable.d.ts

@@ -1,5 +1,12 @@
 import type { WorkbookTableId } from "../models/WorkbookTableId.ts";
 import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
 import type { WorkbookWorksheetRef } from "../models/WorkbookWorksheetRef.ts";
+/**
+ * Creates a reference to a workbook table.
+ * @param worksheetRef - The reference to the worksheet containing the table.
+ * @param tableId - The ID of the table.
+ * @returns A reference to the workbook table.
+ * @throws Error if the table ID is missing.
+ */
 export declare function createWorkbookTableRef(worksheetRef: WorkbookWorksheetRef, tableId: WorkbookTableId | undefined): WorkbookTableRef;
 //# sourceMappingURL=workbookTable.d.ts.map

package/dist/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,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,eAAe,GAAG,SAAS,GAAG,gBAAgB,CAajI"}
+{"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"}

package/dist/services/workbookTable.js

@@ -1,3 +1,10 @@
+/**
+ * Creates a reference to a workbook table.
+ * @param worksheetRef - The reference to the worksheet containing the table.
+ * @param tableId - The ID of the table.
+ * @returns A reference to the workbook table.
+ * @throws Error if the table ID is missing.
+ */
 export function createWorkbookTableRef(worksheetRef, tableId) {
     if (!tableId) {
         throw new Error("TableId is missing");

package/dist/services/workbookTableColumn.d.ts

@@ -0,0 +1,12 @@
+import type { ColumnAddress } from "../models/Address.ts";
+import type { WorkbookTableColumnRef } from "../models/WorkbookTableColumnRef.ts";
+import type { WorkbookTableRef } from "../models/WorkbookTableRef.ts";
+/**
+ * Creates a reference to a workbook table column.
+ * @param tableRef - The reference to the worksheet containing the table.
+ * @param column  - The ID of the table.
+ * @returns A reference to the workbook table.
+ * @throws Error if the table ID is missing.
+ */
+export declare function createWorkbookTableColumnRef(tableRef: WorkbookTableRef, column: ColumnAddress | undefined): WorkbookTableColumnRef;
+//# sourceMappingURL=workbookTableColumn.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workbookTableColumn.d.ts","sourceRoot":"","sources":["../../src/services/workbookTableColumn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,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,aAAa,GAAG,SAAS,GAAG,sBAAsB,CAelI"}