microsoft-graph 3.1.2 → 3.2.0

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

@@ -7,7 +7,7 @@ import type { DriveName } from "../models/Drive.ts";
 import type { DriveItemId } from "../models/DriveItem.ts";
 import type { HostName } from "../models/HostName.ts";
 import type { SiteName } from "../models/Site.ts";
-type SharepointUrlComponents = {
+export type SharepointUrlComponents = {
     hostName: HostName | null;
     siteName: SiteName | null;
     driveName: DriveName | null;
@@ -20,5 +20,4 @@ type SharepointUrlComponents = {
  * @throws InvalidArgumentError if the URL is invalid or required components are missing.
  */
 export declare function parseSharepointUrl(urlString: string): SharepointUrlComponents;
-export {};
 //# sourceMappingURL=sharepointUrl.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sharepointUrl.d.ts","sourceRoot":"","sources":["../../../src/services/sharepointUrl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,KAAK,uBAAuB,GAAG;IAC9B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,uBAAuB,CAiD7E"}
+{"version":3,"file":"sharepointUrl.d.ts","sourceRoot":"","sources":["../../../src/services/sharepointUrl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,MAAM,MAAM,uBAAuB,GAAG;IACrC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,uBAAuB,CAiD7E"}

package/dist/cjs/tasks/getDriveFromUrl.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ * @module getDriveFromUrl
+ * @category Tasks
+ */
+import type { Drive } from "@microsoft/microsoft-graph-types";
+import type { ContextRef } from "../models/Context.ts";
+import type { DriveRef } from "../models/Drive.ts";
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ *
+ * Parses the given SharePoint URL to extract the host, site, and drive names, then locates and returns the corresponding Drive object.
+ *
+ * @param contextRef - The context reference containing authentication and environment information.
+ * @param url - The SharePoint URL pointing to the drive.
+ * @returns A Promise that resolves to the Drive object with additional DriveRef properties.
+ * @throws If the URL is invalid or the drive cannot be found.
+ */
+export default function getDriveFromUrl(contextRef: ContextRef, url: string): Promise<Drive & DriveRef>;
+//# sourceMappingURL=getDriveFromUrl.d.ts.map

package/dist/cjs/tasks/getDriveFromUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDriveFromUrl.d.ts","sourceRoot":"","sources":["../../../src/tasks/getDriveFromUrl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kCAAkC,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAKnD;;;;;;;;;GASG;AACH,wBAA8B,eAAe,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,QAAQ,CAAC,CA2B5G"}

package/dist/cjs/tasks/getDriveFromUrl.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ * @module getDriveFromUrl
+ * @category Tasks
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getDriveFromUrl;
+const getSiteByName_ts_1 = __importDefault(require("../operations/site/getSiteByName.js"));
+const sharepointUrl_ts_1 = require("../services/sharepointUrl.js");
+const iterateDrives_ts_1 = __importDefault(require("./iterateDrives.js"));
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ *
+ * Parses the given SharePoint URL to extract the host, site, and drive names, then locates and returns the corresponding Drive object.
+ *
+ * @param contextRef - The context reference containing authentication and environment information.
+ * @param url - The SharePoint URL pointing to the drive.
+ * @returns A Promise that resolves to the Drive object with additional DriveRef properties.
+ * @throws If the URL is invalid or the drive cannot be found.
+ */
+async function getDriveFromUrl(contextRef, url) {
+    const { hostName, siteName, driveName } = (0, sharepointUrl_ts_1.parseSharepointUrl)(url);
+    if (!hostName) {
+        throw new Error("Invalid SharePoint URL: Host name is missing.");
+    }
+    if (!siteName) {
+        throw new Error("Invalid SharePoint URL: Site name is missing.");
+    }
+    if (!driveName) {
+        throw new Error("Invalid SharePoint URL: Drive name is missing.");
+    }
+    const site = await (0, getSiteByName_ts_1.default)(contextRef, hostName, siteName);
+    let drive = null;
+    for await (const d of (0, iterateDrives_ts_1.default)(site)) {
+        if (sanitizeUrlName(d.name ?? "") === driveName) {
+            drive = d;
+        }
+    }
+    if (!drive) {
+        throw new Error(`Drive "${driveName}" not found in site "${siteName}" on host "${hostName}".`);
+    }
+    return drive;
+}
+function sanitizeUrlName(name) {
+    return name.replace(/[^A-Za-z0-9\-_.~]/g, "");
+}

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

@@ -7,7 +7,7 @@ import type { DriveName } from "../models/Drive.ts";
 import type { DriveItemId } from "../models/DriveItem.ts";
 import type { HostName } from "../models/HostName.ts";
 import type { SiteName } from "../models/Site.ts";
-type SharepointUrlComponents = {
+export type SharepointUrlComponents = {
     hostName: HostName | null;
     siteName: SiteName | null;
     driveName: DriveName | null;
@@ -20,5 +20,4 @@ type SharepointUrlComponents = {
  * @throws InvalidArgumentError if the URL is invalid or required components are missing.
  */
 export declare function parseSharepointUrl(urlString: string): SharepointUrlComponents;
-export {};
 //# sourceMappingURL=sharepointUrl.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"sharepointUrl.d.ts","sourceRoot":"","sources":["../../../src/services/sharepointUrl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,KAAK,uBAAuB,GAAG;IAC9B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,uBAAuB,CAiD7E"}
+{"version":3,"file":"sharepointUrl.d.ts","sourceRoot":"","sources":["../../../src/services/sharepointUrl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,MAAM,MAAM,uBAAuB,GAAG;IACrC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAC5B,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,uBAAuB,CAiD7E"}

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

@@ -0,0 +1,20 @@
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ * @module getDriveFromUrl
+ * @category Tasks
+ */
+import type { Drive } from "@microsoft/microsoft-graph-types";
+import type { ContextRef } from "../models/Context.ts";
+import type { DriveRef } from "../models/Drive.ts";
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ *
+ * Parses the given SharePoint URL to extract the host, site, and drive names, then locates and returns the corresponding Drive object.
+ *
+ * @param contextRef - The context reference containing authentication and environment information.
+ * @param url - The SharePoint URL pointing to the drive.
+ * @returns A Promise that resolves to the Drive object with additional DriveRef properties.
+ * @throws If the URL is invalid or the drive cannot be found.
+ */
+export default function getDriveFromUrl(contextRef: ContextRef, url: string): Promise<Drive & DriveRef>;
+//# sourceMappingURL=getDriveFromUrl.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getDriveFromUrl.d.ts","sourceRoot":"","sources":["../../../src/tasks/getDriveFromUrl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kCAAkC,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAKnD;;;;;;;;;GASG;AACH,wBAA8B,eAAe,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,QAAQ,CAAC,CA2B5G"}

package/dist/esm/tasks/getDriveFromUrl.js

@@ -0,0 +1,44 @@
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ * @module getDriveFromUrl
+ * @category Tasks
+ */
+import getSiteByName from "../operations/site/getSiteByName.js";
+import { parseSharepointUrl } from "../services/sharepointUrl.js";
+import iterateDrives from "./iterateDrives.js";
+/**
+ * Retrieves a Drive from a SharePoint URL.
+ *
+ * Parses the given SharePoint URL to extract the host, site, and drive names, then locates and returns the corresponding Drive object.
+ *
+ * @param contextRef - The context reference containing authentication and environment information.
+ * @param url - The SharePoint URL pointing to the drive.
+ * @returns A Promise that resolves to the Drive object with additional DriveRef properties.
+ * @throws If the URL is invalid or the drive cannot be found.
+ */
+export default async function getDriveFromUrl(contextRef, url) {
+    const { hostName, siteName, driveName } = parseSharepointUrl(url);
+    if (!hostName) {
+        throw new Error("Invalid SharePoint URL: Host name is missing.");
+    }
+    if (!siteName) {
+        throw new Error("Invalid SharePoint URL: Site name is missing.");
+    }
+    if (!driveName) {
+        throw new Error("Invalid SharePoint URL: Drive name is missing.");
+    }
+    const site = await getSiteByName(contextRef, hostName, siteName);
+    let drive = null;
+    for await (const d of iterateDrives(site)) {
+        if (sanitizeUrlName(d.name ?? "") === driveName) {
+            drive = d;
+        }
+    }
+    if (!drive) {
+        throw new Error(`Drive "${driveName}" not found in site "${siteName}" on host "${hostName}".`);
+    }
+    return drive;
+}
+function sanitizeUrlName(name) {
+    return name.replace(/[^A-Za-z0-9\-_.~]/g, "");
+}

package/docs/api/README.md

@@ -180,6 +180,7 @@
 | [copyDriveItem](copyDriveItem.md) | Copy a drive item. |
 | [createWorkbookAndStartSession](createWorkbookAndStartSession.md) | Create a new workbook and open a session for that workbook. |
 | [downloadDriveItemContent](downloadDriveItemContent.md) | Download a drive item and save it to the local disk. |
+| [getDriveFromUrl](getDriveFromUrl.md) | Retrieves a Drive from a SharePoint URL. |
 | [insertWorkbookRangeRow](insertWorkbookRangeRow.md) | Inserts a single row into a workbook range. |
 | [insertWorkbookRangeRows](insertWorkbookRangeRows.md) | Inserts rows into a workbook range. |
 | [iterateDriveItems](iterateDriveItems.md) | List drive items in a drive or a drive item. |

package/docs/api/getDriveFromUrl.md

@@ -0,0 +1,34 @@
+[Microsoft Graph SDK](README.md) / getDriveFromUrl
+
+# getDriveFromUrl
+
+Retrieves a Drive from a SharePoint URL.
+
+## Functions
+
+### getDriveFromUrl()
+
+> **getDriveFromUrl**(`contextRef`, `url`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`Drive` & [`SiteRef`](Site-1.md#siteref) & `object`\>
+
+Defined in: [src/tasks/getDriveFromUrl.ts:24](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/tasks/getDriveFromUrl.ts#L24)
+
+Retrieves a Drive from a SharePoint URL.
+
+Parses the given SharePoint URL to extract the host, site, and drive names, then locates and returns the corresponding Drive object.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `contextRef` | [`ContextRef`](Context-1.md#contextref) | The context reference containing authentication and environment information. |
+| `url` | `string` | The SharePoint URL pointing to the drive. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`Drive` & [`SiteRef`](Site-1.md#siteref) & `object`\>
+
+A Promise that resolves to the Drive object with additional DriveRef properties.
+
+#### Throws
+
+If the URL is invalid or the drive cannot be found.

package/docs/api/sharepointUrl.md

@@ -4,11 +4,28 @@
 
 Utilities for parsing and extracting information from SharePoint URLs.
 
+## Type Aliases
+
+### SharepointUrlComponents
+
+> **SharepointUrlComponents** = `object`
+
+Defined in: [src/services/sharepointUrl.ts:12](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sharepointUrl.ts#L12)
+
+#### Properties
+
+| Property | Type | Defined in |
+| ------ | ------ | ------ |
+| <a id="drivename"></a> `driveName` | [`DriveName`](Drive-1.md#drivename) \| `null` | [src/services/sharepointUrl.ts:15](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sharepointUrl.ts#L15) |
+| <a id="hostname"></a> `hostName` | [`HostName`](HostName.md#hostname) \| `null` | [src/services/sharepointUrl.ts:13](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sharepointUrl.ts#L13) |
+| <a id="itemid"></a> `itemId` | [`DriveItemId`](DriveItem-1.md#driveitemid) \| `null` | [src/services/sharepointUrl.ts:16](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sharepointUrl.ts#L16) |
+| <a id="sitename"></a> `siteName` | [`SiteName`](Site-1.md#sitename) \| `null` | [src/services/sharepointUrl.ts:14](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sharepointUrl.ts#L14) |
+
 ## Functions
 
 ### parseSharepointUrl()
 
-> **parseSharepointUrl**(`urlString`): `SharepointUrlComponents`
+> **parseSharepointUrl**(`urlString`): [`SharepointUrlComponents`](#sharepointurlcomponents)
 
 Defined in: [src/services/sharepointUrl.ts:25](https://github.com/Future-Secure-AI/microsoft-graph/blob/main/src/services/sharepointUrl.ts#L25)
 
@@ -22,7 +39,7 @@ Parses a SharePoint document URL string to extract the site name, host name, dri
 
 #### Returns
 
-`SharepointUrlComponents`
+[`SharepointUrlComponents`](#sharepointurlcomponents)
 
 An object containing the host name, site name, drive name (if present), and item ID (if present).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "microsoft-graph",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "description": "Microsoft GraphAPI SDK for NodeJS",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -1649,6 +1649,16 @@
       "require": "./dist/cjs/tasks/downloadDriveItemContent.js",
       "types": "./dist/esm/tasks/downloadDriveItemContent.d.ts"
     },
+    "./getDriveFromUrl": {
+      "import": "./dist/esm/tasks/getDriveFromUrl.js",
+      "require": "./dist/cjs/tasks/getDriveFromUrl.js",
+      "types": "./dist/esm/tasks/getDriveFromUrl.d.ts"
+    },
+    "./dist/cjs/tasks/getDriveFromUrl": {
+      "import": "./dist/esm/tasks/getDriveFromUrl.js",
+      "require": "./dist/cjs/tasks/getDriveFromUrl.js",
+      "types": "./dist/esm/tasks/getDriveFromUrl.d.ts"
+    },
     "./getRangeLastUsedCell": {
       "import": "./dist/esm/tasks/getRangeLastUsedCell.js",
       "require": "./dist/cjs/tasks/getRangeLastUsedCell.js",