microsoft-graph 2.3.0 → 2.4.0

package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts

@@ -0,0 +1,13 @@
+import type { WorkbookRange } from "@microsoft/microsoft-graph-types";
+import type { GraphOperation } from "../../models/GraphOperation.ts";
+import type { WorkbookRangeRef } from "../../models/WorkbookRangeRef.ts";
+import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
+/**
+ * Retrieve the visible (not hidden) range in a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
+ * @returns The visible range of the worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
+ */
+export default function getWorkbookWorksheetUsedVisibleRange(worksheetRef: WorkbookWorksheetRef): GraphOperation<WorkbookRange & WorkbookRangeRef>;
+//# sourceMappingURL=getWorkbookWorksheetUsedVisibleRange.d.ts.map

package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkbookWorksheetUsedVisibleRange.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAGtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,oCAAoC,CAAC,YAAY,EAAE,oBAAoB,GAAG,cAAc,CAAC,aAAa,GAAG,gBAAgB,CAAC,CAmBjJ"}

package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.js

@@ -0,0 +1,29 @@
+import { operation } from "../../graphApi.js";
+import { generatePath } from "../../services/templatedPaths.js";
+import { createWorkbookRangeRef } from "../../services/workbookRange.js";
+/**
+ * Retrieve the visible (not hidden) range in a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet, optionally including session information.
+ * @returns The visible range of the worksheet, including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/range-usedrange
+ */
+export default function getWorkbookWorksheetUsedVisibleRange(worksheetRef) {
+    return operation({
+        contextId: worksheetRef.contextId,
+        method: "GET",
+        path: generatePath("/sites/{site-id}/drives/{drive-id}/items/{item-id}/workbook/worksheets/{worksheet-id}/range/usedRange/visibleView", worksheetRef),
+        headers: {
+            "workbook-session-id": worksheetRef.sessionId,
+        },
+        body: null,
+        responseTransform: (response) => {
+            const range = response;
+            const rangeRef = createWorkbookRangeRef(worksheetRef, range.address);
+            return {
+                ...range,
+                ...rangeRef,
+            };
+        },
+    });
+}

package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getWorkbookWorksheetUsedVisibleRange.test.d.ts.map

package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWorkbookWorksheetUsedVisibleRange.test.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.ts"],"names":[],"mappings":""}

package/dist/operations/workbookWorksheet/getWorkbookWorksheetUsedVisibleRange.test.js

@@ -0,0 +1,37 @@
+import { describe, expect, it } from "vitest";
+import { getDefaultDriveRef } from "../../services/drive.js";
+import { driveItemPath } from "../../services/driveItem.js";
+import { generateTempFileName } from "../../services/temporaryFiles.js";
+import { createWorkbookRangeRef } from "../../services/workbookRange.js";
+import { createWorkbookWorksheetRef, defaultWorkbookWorksheetId } from "../../services/workbookWorksheet.js";
+import setRowHidden from "../../tasks/setRowHidden.js";
+import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
+import calculateWorkbook from "../workbook/calculateWorkbook.js";
+import createWorkbook from "../workbook/createWorkbook.js";
+import updateWorkbookRange from "../workbookRange/updateWorkbookRange.js";
+import getWorkbookWorksheetUsedVisibleRange from "./getWorkbookWorksheetUsedVisibleRange.js";
+describe("getWorkbookWorksheetUsedVisibleRange", () => {
+    it("can retrieve the used visible range from an existing workbook", async () => {
+        const workbookName = generateTempFileName("xlsx");
+        const workbookPath = driveItemPath(workbookName);
+        const driveRef = getDefaultDriveRef();
+        const workbook = await createWorkbook(driveRef, workbookPath);
+        const worksheetRef = createWorkbookWorksheetRef(workbook, defaultWorkbookWorksheetId);
+        const rangeRef = createWorkbookRangeRef(worksheetRef, "A1:B2");
+        try {
+            await updateWorkbookRange(rangeRef, {
+                values: [
+                    [1, 2],
+                    [3, 4],
+                ],
+            });
+            await setRowHidden(createWorkbookRangeRef(worksheetRef, "1:1"), true);
+            await calculateWorkbook(workbook);
+            const usedRange = await getWorkbookWorksheetUsedVisibleRange(worksheetRef);
+            expect(usedRange.values).toEqual([[3, 4]]);
+        }
+        finally {
+            await tryDeleteDriveItem(workbook);
+        }
+    });
+});

package/dist/operations/workbookWorksheet/listWorkbookWorksheets.d.ts

@@ -2,6 +2,12 @@ import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
 import type { GraphOperation } from "../../models/GraphOperation.ts";
 import type { WorkbookRef } from "../../models/WorkbookRef.ts";
 import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
-/** Retrieve a list of worksheets. @see https://learn.microsoft.com/en-us/graph/api/worksheet-list */
+/**
+ * Retrieve a list of worksheets in a workbook.
+ *
+ * @param workbookRef - A reference to the workbook, optionally including session information.
+ * @returns An array of worksheets, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-list
+ */
 export default function listWorkbookWorksheets(workbookRef: WorkbookRef): GraphOperation<(WorkbookWorksheet & WorkbookWorksheetRef)[]>;
 //# sourceMappingURL=listWorkbookWorksheets.d.ts.map

package/dist/operations/workbookWorksheet/listWorkbookWorksheets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"listWorkbookWorksheets.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookWorksheet/listWorkbookWorksheets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAG1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF,qGAAqG;AACrG,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,CAAC,CA0BrI"}
+{"version":3,"file":"listWorkbookWorksheets.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookWorksheet/listWorkbookWorksheets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAG1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAE/D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAIjF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc,CAAC,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,CAAC,CA0BrI"}

package/dist/operations/workbookWorksheet/listWorkbookWorksheets.js

@@ -2,7 +2,13 @@ import ProtocolError from "../../errors/ProtocolError.js";
 import { operation } from "../../graphApi.js";
 import { generatePath } from "../../services/templatedPaths.js";
 import { createWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
-/** Retrieve a list of worksheets. @see https://learn.microsoft.com/en-us/graph/api/worksheet-list */
+/**
+ * Retrieve a list of worksheets in a workbook.
+ *
+ * @param workbookRef - A reference to the workbook, optionally including session information.
+ * @returns An array of worksheets, each including its metadata and reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-list
+ */
 export default function listWorkbookWorksheets(workbookRef) {
     return operation({
         contextId: workbookRef.contextId,

package/dist/operations/workbookWorksheet/listWorkbookWorksheets.test.js

@@ -3,7 +3,7 @@ import { sequential } from "../../graphApi.js";
 import { getDefaultDriveRef } from "../../services/drive.js";
 import { driveItemPath } from "../../services/driveItem.js";
 import { generateTempFileName } from "../../services/temporaryFiles.js";
-import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
+import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
 import calculateWorkbook from "../workbook/calculateWorkbook.js";
 import createWorkbook from "../workbook/createWorkbook.js";
 import createWorkbookWorksheet from "./createWorkbookWorksheet.js";
@@ -24,7 +24,7 @@ describe("listWorkbookWorksheets", () => {
             expect(worksheetIds).toContain(worksheet2.worksheetId);
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
     it("can list worksheets in an existing workbook parallel", async () => {
@@ -39,7 +39,7 @@ describe("listWorkbookWorksheets", () => {
             expect(worksheetIds).toContain(worksheet2.worksheetId);
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
 });

package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts

@@ -1,7 +1,17 @@
 import type { WorkbookWorksheet } from "@microsoft/microsoft-graph-types";
 import type { GraphOperation } from "../../models/GraphOperation.ts";
 import type { WorkbookWorksheetRef } from "../../models/WorkbookWorksheetRef.ts";
-/** Update the name, position and/or visibility of a worksheet. @see https://learn.microsoft.com/en-us/graph/api/worksheet-update */
+/**
+ * Update the name, position, and/or visibility of a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet to be updated, optionally including session information.
+ * @param updates - An object containing the properties to update:
+ *   - `name` (optional): The new name for the worksheet.
+ *   - `position` (optional): The new position of the worksheet in the workbook.
+ *   - `visibility` (optional): The visibility state of the worksheet. Can be "Visible", "Hidden", or "VeryHidden".
+ * @returns The updated worksheet, including its reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-update
+ */
 export default function updateWorkbookWorksheet(worksheetRef: WorkbookWorksheetRef, updates: {
     name?: string;
     position?: number;

package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookWorksheet/updateWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAGjF,oIAAoI;AACpI,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAA;CAAE,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAkB7O"}
+{"version":3,"file":"updateWorkbookWorksheet.d.ts","sourceRoot":"","sources":["../../../src/operations/workbookWorksheet/updateWorkbookWorksheet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAE1E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAGjF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,uBAAuB,CAAC,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,YAAY,CAAA;CAAE,GAAG,cAAc,CAAC,iBAAiB,GAAG,oBAAoB,CAAC,CAkB7O"}

package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.js

@@ -1,6 +1,16 @@
 import { operation } from "../../graphApi.js";
 import { generatePath } from "../../services/templatedPaths.js";
-/** Update the name, position and/or visibility of a worksheet. @see https://learn.microsoft.com/en-us/graph/api/worksheet-update */
+/**
+ * Update the name, position, and/or visibility of a worksheet.
+ *
+ * @param worksheetRef - A reference to the worksheet to be updated, optionally including session information.
+ * @param updates - An object containing the properties to update:
+ *   - `name` (optional): The new name for the worksheet.
+ *   - `position` (optional): The new position of the worksheet in the workbook.
+ *   - `visibility` (optional): The visibility state of the worksheet. Can be "Visible", "Hidden", or "VeryHidden".
+ * @returns The updated worksheet, including its reference information.
+ * @see https://learn.microsoft.com/en-us/graph/api/worksheet-update
+ */
 export default function updateWorkbookWorksheet(worksheetRef, updates) {
     return operation({
         contextId: worksheetRef.contextId,

package/dist/operations/workbookWorksheet/updateWorkbookWorksheet.test.js

@@ -3,8 +3,8 @@ import { getDefaultDriveRef } from "../../services/drive.js";
 import { driveItemPath } from "../../services/driveItem.js";
 import { generateTempFileName } from "../../services/temporaryFiles.js";
 import { createDefaultWorkbookWorksheetRef } from "../../services/workbookWorksheet.js";
-import deleteDriveItemWithRetry from "../../tasks/deleteDriveItemWithRetry.js";
 import getWorkbookWorksheetByName from "../../tasks/getWorkbookWorksheetByName.js";
+import tryDeleteDriveItem from "../../tasks/tryDeleteDriveItem.js";
 import calculateWorkbook from "../workbook/calculateWorkbook.js";
 import createWorkbook from "../workbook/createWorkbook.js";
 import createWorkbookWorksheet from "./createWorkbookWorksheet.js";
@@ -23,7 +23,7 @@ describe("updateWorkbookWorksheet", () => {
             expect(updatedWorksheet.name).toBe(newName);
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
     it("can update the visibility of an existing worksheet", async () => {
@@ -38,7 +38,7 @@ describe("updateWorkbookWorksheet", () => {
             expect(updatedWorksheet.visibility).toBe("Hidden");
         }
         finally {
-            await deleteDriveItemWithRetry(workbook);
+            await tryDeleteDriveItem(workbook);
         }
     });
 });

package/dist/services/accessToken.d.ts

@@ -3,6 +3,14 @@ import type { ClientId } from "../models/ClientId.ts";
 import type { ClientSecret } from "../models/ClientSecret.ts";
 import type { Scope } from "../models/Scope.ts";
 import type { TenantId } from "../models/TenantId.ts";
-/** Get an access token for a given client and scope. If an unexpired one is cached it will be returned, otherwise requests a new one. */
+/**
+ * Retrieves the current access token for a given client and scope.
+ * If a valid token is cached, it will be returned; otherwise, a new token will be requested.
+ * @param tenantId - The tenant ID.
+ * @param clientId - The client ID.
+ * @param clientSecret - The client secret.
+ * @param scope - The scope for which the token is requested.
+ * @returns A promise that resolves to the access token.
+ */
 export declare function getCurrentAccessToken(tenantId: TenantId, clientId: ClientId, clientSecret: ClientSecret, scope: Scope): Promise<AccessToken>;
 //# sourceMappingURL=accessToken.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"accessToken.d.ts","sourceRoot":"","sources":["../../src/services/accessToken.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,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAItD,yIAAyI;AACzI,wBAAsB,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,CAWlJ"}
+{"version":3,"file":"accessToken.d.ts","sourceRoot":"","sources":["../../src/services/accessToken.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,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAItD;;;;;;;;GAQG;AACH,wBAAsB,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,CAWlJ"}

package/dist/services/accessToken.js

@@ -1,6 +1,14 @@
 import { ClientSecretCredential } from "@azure/identity";
 const innerTokenCache = {};
-/** Get an access token for a given client and scope. If an unexpired one is cached it will be returned, otherwise requests a new one. */
+/**
+ * Retrieves the current access token for a given client and scope.
+ * If a valid token is cached, it will be returned; otherwise, a new token will be requested.
+ * @param tenantId - The tenant ID.
+ * @param clientId - The client ID.
+ * @param clientSecret - The client secret.
+ * @param scope - The scope for which the token is requested.
+ * @returns A promise that resolves to the access token.
+ */
 export async function getCurrentAccessToken(tenantId, clientId, clientSecret, scope) {
     const cacheKey = createCacheKey(tenantId, clientId, scope);
     let innerToken = innerTokenCache[cacheKey];

package/dist/services/addressManipulation.d.ts

@@ -5,16 +5,83 @@ export type AddressComponents = {
     startRow: RowAddress;
     endRow: RowAddress;
 };
+/**
+ * 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 declare function decomposeAddress(address: Address): AddressComponents;
+/**
+ * Composes an address from its components.
+ * @param components - The address components.
+ * @returns The composed address.
+ * @throws InvalidArgumentError if the components are invalid.
+ */
 export declare function composeAddress(components: AddressComponents): Address;
+/**
+ * Gets the first cell address from a given address.
+ * @param address - The address to analyze.
+ * @returns The first cell address.
+ */
 export declare function getFirstCellAddress(address: Address): CellAddress;
+/**
+ * Gets the last cell address from a given address.
+ * @param address - The address to analyze.
+ * @returns The last cell address.
+ */
 export declare function getLastCellAddress(address: Address): CellAddress;
+/**
+ * Gets the first row address from a given address.
+ * @param address - The address to analyze.
+ * @returns The first row address.
+ */
 export declare function getFirstRowAddress(address: Address): Address;
+/**
+ * Gets the last row address from a given address.
+ * @param address - The address to analyze.
+ * @returns The last row address.
+ */
 export declare function getLastRowAddress(address: Address): Address;
+/**
+ * Gets the first column address from a given address.
+ * @param address - The address to analyze.
+ * @returns The first column address.
+ */
 export declare function getFirstColumnAddress(address: Address): Address;
+/**
+ * Gets the last column address from a given address.
+ * @param address - The address to analyze.
+ * @returns The last column address.
+ */
 export declare function getLastColumnAddress(address: Address): Address;
+/**
+ * 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 declare function offsetAddress(address: Address, columnOffset: number, rowOffset: number): Address;
+/**
+ * Increments the row address by one.
+ * @param address - The address to increment.
+ * @returns The incremented address.
+ */
 export declare function incrementRowAddress(address: Address): Address;
+/**
+ * Decrements the row address by one.
+ * @param address - The address to decrement.
+ * @returns The decremented address.
+ */
 export declare function decrementRowAddress(address: Address): Address;
+/**
+ * Checks if two addresses overlap.
+ * @param address1 - The first address.
+ * @param address2 - The second address.
+ * @returns True if the addresses overlap, otherwise false.
+ */
 export declare function isAddressOverlapping(address1: Address, address2: Address): boolean;
 //# sourceMappingURL=addressManipulation.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"addressManipulation.d.ts","sourceRoot":"","sources":["../../src/services/addressManipulation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAoB,aAAa,EAAsB,UAAU,EAAmB,MAAM,sBAAsB,CAAC;AAmBnJ,MAAM,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,aAAa,CAAC;IAC3B,SAAS,EAAE,aAAa,CAAC;IACzB,QAAQ,EAAE,UAAU,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAcpE;AAED,wBAAgB,cAAc,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CA6BrE;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGjE;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGhE;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS5D;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS3D;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS/D;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS9D;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAqChG;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAKlF"}
+{"version":3,"file":"addressManipulation.d.ts","sourceRoot":"","sources":["../../src/services/addressManipulation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAoB,aAAa,EAAsB,UAAU,EAAmB,MAAM,sBAAsB,CAAC;AAmBnJ,MAAM,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,aAAa,CAAC;IAC3B,SAAS,EAAE,aAAa,CAAC;IACzB,QAAQ,EAAE,UAAU,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,iBAAiB,CAcpE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,iBAAiB,GAAG,OAAO,CA6BrE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGjE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,CAGhE;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS5D;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS3D;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS/D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAS9D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAqChG;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAKlF"}

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"}