microsoft-graph 2.22.3 → 2.24.0

package/dist/esm/services/{accessToken.js → azureApplicationCredentials.js}

@@ -1,3 +1,8 @@
+/**
+ * Azure application credential helpers for authentication and token management.
+ * @module azureApplicationCredentials
+ * @category Services
+ */
 import { ClientSecretCredential } from "@azure/identity";
 const innerTokenCache = {};
 /**

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

@@ -1,3 +1,8 @@
+/**
+ * Constants and helpers for batching Microsoft Graph API requests.
+ * @module batch
+ * @category Services
+ */
 /**
  * Maximum number of cells that can be retrieved in a single request, unless overwritten.
  * @remarks The Microsoft Graph API documentation does not specify a fixed maximum number of cells that can be retrieved in a single request.

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

@@ -1 +1 @@
-{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../../src/services/batch.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,QAAQ,CAAC"}
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../../src/services/batch.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,QAAQ,CAAC"}

package/dist/esm/services/batch.js

@@ -1,3 +1,8 @@
+/**
+ * Constants and helpers for batching Microsoft Graph API requests.
+ * @module batch
+ * @category Services
+ */
 /**
  * Maximum number of cells that can be retrieved in a single request, unless overwritten.
  * @remarks The Microsoft Graph API documentation does not specify a fixed maximum number of cells that can be retrieved in a single request.

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

@@ -1,3 +1,8 @@
+/**
+ * Utilities for converting between A1 addresses and Cartesian coordinates.
+ * @module cartesianAddress
+ * @category Services
+ */
 import type { Address } from "../models/Address.ts";
 import type { Cartesian } from "../models/Cartesian.ts";
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"cartesianAddress.d.ts","sourceRoot":"","sources":["../../../src/services/cartesianAddress.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAIxD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAU9D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAqBzE"}
+{"version":3,"file":"cartesianAddress.d.ts","sourceRoot":"","sources":["../../../src/services/cartesianAddress.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAIxD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAU9D;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,SAAS,GAAG,OAAO,CAqBzE"}

package/dist/esm/services/cartesianAddress.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for converting between A1 addresses and Cartesian coordinates.
+ * @module cartesianAddress
+ * @category Services
+ */
 import InvalidArgumentError from "../errors/InvalidArgumentError.js";
 import { composeAddress, decomposeAddress } from "./addressManipulation.js";
 import { columnAddressToOffset, columnOffsetToAddress, rowAddressToOffset, rowOffsetToAddress } from "./addressOffset.js";

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

@@ -1,3 +1,8 @@
+/**
+ * Utilities for working with cell text values in spreadsheets.
+ * @module cellText
+ * @category Services
+ */
 import type { CellText } from "../models/CellText.ts";
 /**
  * Casts a string to CellText.

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

@@ -1 +1 @@
-{"version":3,"file":"cellText.d.ts","sourceRoot":"","sources":["../../../src/services/cellText.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAEjD"}
+{"version":3,"file":"cellText.d.ts","sourceRoot":"","sources":["../../../src/services/cellText.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAEjD"}

package/dist/esm/services/cellText.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for working with cell text values in spreadsheets.
+ * @module cellText
+ * @category Services
+ */
 /**
  * Casts a string to CellText.
  */

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

@@ -1,28 +1,29 @@
-import type { ClientId } from "../models/ClientId.ts";
-import type { ClientSecret } from "../models/ClientSecret.ts";
-import type { Context } from "../models/Context.ts";
-import type { ContextId } from "../models/ContextId.ts";
-import type { ContextRef } from "../models/ContextRef.ts";
-import type { TenantId } from "../models/TenantId.ts";
 /**
- * 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.
- * @returns A reference to the registered context.
+ * Context creation and management utilities for Microsoft Graph API authentication.
+ * @module context
+ * @category Services
  */
-export declare function register(tenantId: TenantId, clientId: ClientId, clientSecret: ClientSecret): ContextRef;
+import type { AccessToken } from "../models/AccessToken.ts";
+import type { AccessTokenGenerator } from "../models/AccessTokenGenerator.ts";
+import type { AzureClientId, AzureClientSecret, AzureTenantId, Scope } from "../models/AzureApplicationCredentials.ts";
+import type { ContextRef } from "../models/ContextRef.ts";
+/** Create a context using the client secret credential. */
+export declare function createClientSecretContext(tenantId: AzureTenantId, clientId: AzureClientId, clientSecret: AzureClientSecret, scope?: Scope): 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.
+ * Create a context using a static access token.
+ * @remarks You must manually handle renewal of the access token with this approach.
  */
-export declare function getContext(contextId: ContextId): Context;
+export declare function createAccessTokenContext(accessToken: AccessToken): ContextRef;
+/** Create a context using a given access token generator. */
+export declare function createContext(accessTokenGenerator: AccessTokenGenerator): ContextRef;
+/** Create a context using the client secret credential using environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET. */
+export declare function createDefaultClientSecretContext(): ContextRef;
 /**
- * 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.
+ @deprecated Use `createDefaultClientSecretContext()` instead.
  */
 export declare function getDefaultContextRef(): ContextRef;
+/**
+ * @deprecated Use `createClientSecretContext()` instead.
+ */
+export declare function register(tenantId: AzureTenantId, clientId: AzureClientId, clientSecret: AzureClientSecret): ContextRef;
 //# sourceMappingURL=context.d.ts.map

package/dist/esm/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,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAMtD;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,GAAG,UAAU,CAcvG;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAMxD;AAYD;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,UAAU,CAQjD"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/services/context.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,0CAA0C,CAAC;AACvH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAO1D,2DAA2D;AAC3D,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,iBAAiB,EAAE,KAAK,GAAE,KAAoB,GAAG,UAAU,CAMpK;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,WAAW,EAAE,WAAW,GAAG,UAAU,CAK7E;AAED,6DAA6D;AAC7D,wBAAgB,aAAa,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,UAAU,CAQpF;AAED,gJAAgJ;AAChJ,wBAAgB,gCAAgC,IAAI,UAAU,CAM7D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,UAAU,CAEjD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,iBAAiB,GAAG,UAAU,CAEtH"}

package/dist/esm/services/context.js

@@ -1,55 +1,54 @@
-import ContextNotRegisteredError from "../errors/ContextNotRegisteredError.js";
-import { getEnvironmentVariable } from "./environmentVariable.js";
-import { generateRandomString } from "./random.js";
-const contexts = {};
 /**
- * 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.
- * @returns A reference to the registered context.
+ * Context creation and management utilities for Microsoft Graph API authentication.
+ * @module context
+ * @category Services
  */
-export function register(tenantId, clientId, clientSecret) {
-    const contextId = generateContextId();
-    const context = {
-        tenantId,
-        clientId,
-        clientSecret,
+import { getCurrentAccessToken } from "./azureApplicationCredentials.js";
+import { getEnvironmentVariable } from "./environmentVariable.js";
+("../models/Scope.ts");
+const defaultScope = "https://graph.microsoft.com/.default";
+/** Create a context using the client secret credential. */
+export function createClientSecretContext(tenantId, clientId, clientSecret, scope = defaultScope) {
+    const generateAccessToken = async () => {
+        return await getCurrentAccessToken(tenantId, clientId, clientSecret, scope);
     };
-    contexts[contextId] = context;
-    const contextRef = createContextRef(contextId);
-    return contextRef;
+    return createContext(generateAccessToken);
 }
 /**
- * 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.
+ * Create a context using a static access token.
+ * @remarks You must manually handle renewal of the access token with this approach.
  */
-export function getContext(contextId) {
-    const context = contexts[contextId];
-    if (!context) {
-        throw new ContextNotRegisteredError(`Context with ID ${contextId} is not registered`);
-    }
-    return context;
-}
-function generateContextId() {
-    return generateRandomString(16);
+export function createAccessTokenContext(accessToken) {
+    // biome-ignore lint/suspicious/useAwait: Not applicable here, as we are creating a context that returns a static access token.
+    return createContext(async () => {
+        return accessToken;
+    });
 }
-function createContextRef(contextId) {
+/** Create a context using a given access token generator. */
+export function createContext(accessTokenGenerator) {
+    const context = {
+        generateAccessToken: accessTokenGenerator,
+    };
     return {
-        contextId,
+        context,
     };
 }
-/**
- * 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() {
+/** Create a context using the client secret credential using environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET. */
+export function createDefaultClientSecretContext() {
     const tenantId = getEnvironmentVariable("AZURE_TENANT_ID");
     const clientId = getEnvironmentVariable("AZURE_CLIENT_ID");
     const clientSecret = getEnvironmentVariable("AZURE_CLIENT_SECRET");
-    const contextRef = register(tenantId, clientId, clientSecret);
-    return contextRef;
+    return createClientSecretContext(tenantId, clientId, clientSecret);
+}
+/**
+ @deprecated Use `createDefaultClientSecretContext()` instead.
+ */
+export function getDefaultContextRef() {
+    return createDefaultClientSecretContext();
+}
+/**
+ * @deprecated Use `createClientSecretContext()` instead.
+ */
+export function register(tenantId, clientId, clientSecret) {
+    return createClientSecretContext(tenantId, clientId, clientSecret);
 }

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

@@ -1,5 +1,12 @@
+/**
+ * Utilities for working with Microsoft Graph Drive references and operations.
+ * @module drive
+ * @category Services
+ */
+import type { AzureClientId, AzureClientSecret, AzureTenantId } from "../models/AzureApplicationCredentials.ts";
 import type { DriveId } from "../models/DriveId.ts";
 import type { DriveRef } from "../models/DriveRef.ts";
+import type { SiteId } from "../models/SiteId.ts";
 import type { SiteRef } from "../models/SiteRef.ts";
 /**
  * Creates a reference to a drive.
@@ -9,10 +16,13 @@ import type { SiteRef } from "../models/SiteRef.ts";
  * @throws ProtocolError if the drive ID is missing.
  */
 export declare function createDriveRef(siteRef: SiteRef, driveId: DriveId | undefined): DriveRef;
+/** Creates a context with a reference to a drive. */
+export declare function createClientSecretContextWithDriveRef(tenantId: AzureTenantId, clientId: AzureClientId, clientSecret: AzureClientSecret, siteId: SiteId, driveId: DriveId): DriveRef;
 /**
  * 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.
+ * @deprecated Use `createClientSecretContextWithDriveRef()` instead.
  */
 export declare function getDefaultDriveRef(): DriveRef;
 //# sourceMappingURL=drive.d.ts.map

package/dist/esm/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;AAEtD,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,CAY7C"}
+{"version":3,"file":"drive.d.ts","sourceRoot":"","sources":["../../../src/services/drive.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,0CAA0C,CAAC;AAChH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAKpD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAUvF;AAED,qDAAqD;AACrD,wBAAgB,qCAAqC,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,QAAQ,CAKnL;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAY7C"}

package/dist/esm/services/drive.js

@@ -1,5 +1,10 @@
+/**
+ * Utilities for working with Microsoft Graph Drive references and operations.
+ * @module drive
+ * @category Services
+ */
 import ProtocolError from "../errors/ProtocolError.js";
-import { register } from "./context.js";
+import { createClientSecretContext, register } from "./context.js";
 import { getEnvironmentVariable } from "./environmentVariable.js";
 import { createSiteRef } from "./site.js";
 /**
@@ -11,18 +16,26 @@ import { createSiteRef } from "./site.js";
  */
 export function createDriveRef(siteRef, driveId) {
     if (!driveId) {
-        throw new ProtocolError("DriveID is missing");
+        throw new ProtocolError("DriveId is missing");
     }
     return {
-        contextId: siteRef.contextId,
+        context: siteRef.context,
         siteId: siteRef.siteId,
         driveId,
     };
 }
+/** Creates a context with a reference to a drive. */
+export function createClientSecretContextWithDriveRef(tenantId, clientId, clientSecret, siteId, driveId) {
+    const context = createClientSecretContext(tenantId, clientId, clientSecret);
+    const siteRef = createSiteRef(context, siteId);
+    const driveRef = createDriveRef(siteRef, driveId);
+    return driveRef;
+}
 /**
  * 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.
+ * @deprecated Use `createClientSecretContextWithDriveRef()` instead.
  */
 export function getDefaultDriveRef() {
     const tenantId = getEnvironmentVariable("AZURE_TENANT_ID");

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

@@ -1,3 +1,8 @@
+/**
+ * Utilities for working with Microsoft Graph Drive Items (files and folders).
+ * @module driveItem
+ * @category Services
+ */
 import type { DriveItemId } from "../models/DriveItemId.ts";
 import type { DriveItemPath } from "../models/DriveItemPath.ts";
 import type { DriveItemRef } from "../models/DriveItemRef.ts";

package/dist/esm/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;;;;;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;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,aAAa,GAAG;IAAE,UAAU,EAAE,aAAa,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAa3G"}
+{"version":3,"file":"driveItem.d.ts","sourceRoot":"","sources":["../../../src/services/driveItem.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,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;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,aAAa,GAAG;IAAE,UAAU,EAAE,aAAa,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAa3G"}

package/dist/esm/services/driveItem.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for working with Microsoft Graph Drive Items (files and folders).
+ * @module driveItem
+ * @category Services
+ */
 import InvalidArgumentError from "../errors/InvalidArgumentError.js";
 import ProtocolError from "../errors/ProtocolError.js";
 const segmentPattern = /^[^"*:<>?\\|#]{1,256}$/;
@@ -49,7 +54,7 @@ export function createDriveItemRef(driveRef, itemId) {
         throw new ProtocolError("ItemID is missing");
     }
     return {
-        contextId: driveRef.contextId,
+        context: driveRef.context,
         siteId: driveRef.siteId,
         driveId: driveRef.driveId,
         itemId,

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

@@ -1,6 +1,11 @@
+/**
+ * Utilities for accessing environment variables with error handling and fallbacks.
+ * @module environmentVariable
+ * @category Services
+ */
 /**
  * Retrieves the value of an environment variable.
- * @param env - The name of the environment variable.
+ * @param env - 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.
@@ -8,7 +13,7 @@
 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 env - 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.
  */

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"environmentVariable.d.ts","sourceRoot":"","sources":["../../../src/services/environmentVariable.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;;;;;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/esm/services/environmentVariable.js

@@ -1,7 +1,12 @@
+/**
+ * Utilities for accessing environment variables with error handling and fallbacks.
+ * @module environmentVariable
+ * @category Services
+ */
 import EnvironmentVariableMissingError from "../errors/EnvironmentVariableMissingError.js";
 /**
  * Retrieves the value of an environment variable.
- * @param env - The name of the environment variable.
+ * @param env - 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.
@@ -18,7 +23,7 @@ export function getEnvironmentVariable(env, fallbackValue = null) {
 }
 /**
  * Binds an environment variable to a function that retrieves its value.
- * @param env - The name of the environment variable.
+ * @param env - 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.
  */

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

@@ -1,3 +1,8 @@
+/**
+ * HTTP request utilities for Microsoft Graph API, with proxy support.
+ * @module http
+ * @category Services
+ */
 import { type AxiosRequestConfig } from "axios";
 export declare function executeHttpRequest(config: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
 //# sourceMappingURL=http.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../src/services/http.ts"],"names":[],"mappings":"AAAA,OAAc,EAAsB,KAAK,kBAAkB,EAA4B,MAAM,OAAO,CAAC;AAKrG,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,oDAMlE"}
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../src/services/http.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAc,EAAsB,KAAK,kBAAkB,EAA4B,MAAM,OAAO,CAAC;AAKrG,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,oDAMlE"}

package/dist/esm/services/http.js

@@ -1,3 +1,8 @@
+/**
+ * HTTP request utilities for Microsoft Graph API, with proxy support.
+ * @module http
+ * @category Services
+ */
 import axios from "axios";
 import { HttpsProxyAgent } from "https-proxy-agent";
 let instance = null;

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

@@ -1,3 +1,8 @@
+/**
+ * Utilities for analyzing HTTP status codes for Microsoft Graph API responses.
+ * @module httpStatus
+ * @category Services
+ */
 /**
  * Checks if the HTTP status code indicates a successful response.
  * @param status - The HTTP status code.

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

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

package/dist/esm/services/httpStatus.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for analyzing HTTP status codes for Microsoft Graph API responses.
+ * @module httpStatus
+ * @category Services
+ */
 /**
  * Checks if the HTTP status code indicates a successful response.
  * @param status - The HTTP status code.

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

@@ -1,3 +1,8 @@
+/**
+ * Spreadsheet number format constants for Microsoft Graph API.
+ * @module numberFormat
+ * @category Services
+ */
 import type { NumberFormat } from "../models/NumberFormat.ts";
 export declare const generalNumberFormat: NumberFormat;
 export declare const numberNumberFormat: NumberFormat;

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

@@ -1 +1 @@
-{"version":3,"file":"numberFormat.d.ts","sourceRoot":"","sources":["../../../src/services/numberFormat.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,eAAO,MAAM,mBAAmB,EAAgB,YAAY,CAAC;AAC7D,eAAO,MAAM,kBAAkB,EAAiB,YAAY,CAAC;AAC7D,eAAO,MAAM,oBAAoB,EAAkB,YAAY,CAAC;AAChE,eAAO,MAAM,sBAAsB,EAA2D,YAAY,CAAC;AAC3G,eAAO,MAAM,sBAAsB,EAAc,YAAY,CAAC;AAC9D,eAAO,MAAM,qBAAqB,EAAmB,YAAY,CAAC;AAClE,eAAO,MAAM,gBAAgB,EAAsB,YAAY,CAAC;AAChE,eAAO,MAAM,gBAAgB,EAAU,YAAY,CAAC"}
+{"version":3,"file":"numberFormat.d.ts","sourceRoot":"","sources":["../../../src/services/numberFormat.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,eAAO,MAAM,mBAAmB,EAAgB,YAAY,CAAC;AAC7D,eAAO,MAAM,kBAAkB,EAAiB,YAAY,CAAC;AAC7D,eAAO,MAAM,oBAAoB,EAAkB,YAAY,CAAC;AAChE,eAAO,MAAM,sBAAsB,EAA2D,YAAY,CAAC;AAC3G,eAAO,MAAM,sBAAsB,EAAc,YAAY,CAAC;AAC9D,eAAO,MAAM,qBAAqB,EAAmB,YAAY,CAAC;AAClE,eAAO,MAAM,gBAAgB,EAAsB,YAAY,CAAC;AAChE,eAAO,MAAM,gBAAgB,EAAU,YAAY,CAAC"}

package/dist/esm/services/numberFormat.js

@@ -1,3 +1,8 @@
+/**
+ * Spreadsheet number format constants for Microsoft Graph API.
+ * @module numberFormat
+ * @category Services
+ */
 export const generalNumberFormat = "General";
 export const numberNumberFormat = "#,##0.00";
 export const currencyNumberFormat = "$#,##0.00";

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

@@ -1,3 +1,8 @@
+/**
+ * Utilities for converting between operation IDs and indexes.
+ * @module operationId
+ * @category Services
+ */
 /**
  * Converts an operation index to an operation ID.
  * @param index - The operation index.

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

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"operationId.d.ts","sourceRoot":"","sources":["../../../src/services/operationId.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;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/esm/services/operationId.js

@@ -1,3 +1,8 @@
+/**
+ * Utilities for converting between operation IDs and indexes.
+ * @module operationId
+ * @category Services
+ */
 /**
  * Converts an operation index to an operation ID.
  * @param index - The operation index.

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,3 +1,8 @@
+/**
+ * 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";
@@ -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,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"}

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,3 +1,8 @@
+/**
+ * Utilities for parsing and extracting information from SharePoint URLs.
+ * @module sharepointUrl
+ * @category Services
+ */
 import type { DriveItemId } from "../models/DriveItemId.ts";
 import type { HostName } from "../models/HostName.ts";
 import type { SiteName } from "../models/SiteName.ts";

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,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/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.