Merge remote-tracking branch 'origin/dev' into v2.0.0

Author: muthurathinam-m

README.md

@@ -184,7 +184,7 @@ try {
 }
 ```
 
-For more information, refer: [Calling Pattern](docs/CallingPattern.md), [Actions](docs/Actions.md), [Query Params](docs/QueryParameters.md), [API Methods](docs/APIMethods.md) and [more](docs/).
+For more information, refer: [Calling Pattern](docs/CallingPattern.md), [Actions](docs/Actions.md), [Query Params](docs/QueryParameters.md), [API Methods](docs/OtherAPIs.md) and [more](docs/).
 
 ## Documentation
 

docs/CallingPattern.md

@@ -0,0 +1,49 @@
+# Calling Pattern
+
+All calls to Microsoft Graph are chained together starting with **.api()**, then chain [query parameters](./QueryParameters.md) and end with an [action](./Actions.md).
+
+## Path supports the following formats
+
+* `me`
+* `/me`
+* `https://graph.microsoft.com/v1.0/me`
+* `https://graph.microsoft.com/beta/me`
+* `me/events?$filter=startswith(subject, "Adventure")`
+
+## Promise based calling
+
+Getting user details with `async`/`await`,
+
+```typescript
+try {
+    let res = await client.api("/me").get();
+    console.log(res);
+} catch (error) {
+    throw error;
+}
+```
+
+Getting user details with `then`/`catch`,
+
+```typescript
+client
+    .api('/me')
+    .get()
+    .then((res) => {
+        console.log(res);
+    }).catch((err) => {
+        console.log(err);
+    });
+```
+
+## Callback based calling
+
+Getting user details by passing `callback`,
+
+```typescript
+client
+    .api('/me')
+    .get((err, res, rawResponse) => {
+        console.log(res);
+    });
+```

docs/tasks/LargeFileUploadTask.md

@@ -1,6 +1,6 @@
-# Large File Upload Task - Uploading large files to OneDrive.
+# Large File Upload Task - Uploading large files to OneDrive
 
-This task simplifies the implementation of onedrive's [resumable upload](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/driveitem_createuploadsession).
+This task simplifies the implementation of OneDrive's [resumable upload](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/api/driveitem_createuploadsession).
 
 ## Creating the client instance
 
@@ -20,47 +20,60 @@ Get files from the input element and start uploading.
 async function fileUpload(elem) {
 	let file = elem.files[0];
 	try {
-		let response = await largeFilUpload(client, file, file.name);
+		let response = await largeFileUpload(client, file, file.name);
+		console.log(response);
+		console.log("File Uploaded Successfully.!!");
 	} catch (error) {
 		console.error(error);
 	}
 }
+
+async function largeFileUpload(client, file) {
+	try {
+		let options = {
+			path: "/Documents",
+			fileName: file.name,
+			rangeSize: 1024 * 1024,
+		};
+		const uploadTask = await MicrosoftGraph.OneDriveLargeFileUploadTask.create(client, file, options);
+		const response = await uploadTask.upload();
+		return response;
+	} catch (err) {
+		throw err;
+	}
+}
 ```
 
 ## Uploading from NodeJS
 
 ```typescript
 function uploadFile() {
-    fs.readFile(<PATH_OF_THE_FILE>, {}, function (err, file) {
-        if(err) {
-            throw err;
-        }
-        let fileName = <NAME_OF_THE_FILE>;
-        largeFileUpload(client, file, fileName)
-        .then((response) => {
-            console.log(response);
-        })
-        .catch((error) => {
-            console.error(error);
-        });
-    });
+	fs.readFile("<PATH_OF_THE_FILE>", {}, function(err, file) {
+		if (err) {
+			throw err;
+		}
+		let fileName = "<NAME_OF_THE_FILE_WITH_EXTN>";
+		oneDriveLargeFileUpload(client, file, fileName)
+			.then((response) => {
+				console.log(response);
+				console.log("File Uploaded Successfully.!!");
+			})
+			.catch((error) => {
+				throw err;
+			});
+	});
 }
-```
 
-## Creating session and start uploading
-
-```typescript
-async function uploadFile(client, file) {
+async function oneDriveLargeFileUpload(client, file, fileName) {
 	try {
 		let options = {
 			path: "/Documents",
-			fileName: file.name,
+			fileName,
 			rangeSize: 1024 * 1024,
 		};
-		const uploadTask = await MicrosoftGraph.OneDriveLargeFileUploadTask.create(client, file, options);
+		const uploadTask = await OneDriveLargeFileUploadTask.create(client, file, options);
 		const response = await uploadTask.upload();
-		console.log(response);
-		console.log("File Uploaded Successfully.!!");
+		return response;
 	} catch (err) {
 		console.log(err);
 	}
@@ -84,3 +97,35 @@ let range = uploadTask.getNextRange();
 let slicedFile = uploadTask.sliceFile(range);
 uploadTask.uploadSlice(slicedFile, range, uploadTask.file.size);
 ```
+
+## Uploading with custom options
+
+_You can pass in the customized options using LargeFileUploadTask_
+
+```typescript
+async function largeFileUpload(client, file) {
+	const filename = file.name;
+	const driveId = "<YOUR_DRIVE_ID>";
+	const path = "<LOCATION_TO_STORE_FILE>";
+	try {
+		const requestUrl = `/drives/${driveId}/root:${path}/${fileName}:/createUploadSession`;
+		const payload = {
+			item: {
+				"@microsoft.graph.conflictBehavior": "fail",
+				name: fileName,
+			},
+		};
+		const fileObject = {
+			size: file.size,
+			content: file,
+			name: fileName,
+		};
+		const uploadSession = await LargeFileUploadTask.createUploadSession(client, requestUrl, payload);
+		const uploadTask = await new LargeFileUploadTask(client, fileObject, uploadSession);
+		const response = await uploadTask.upload();
+		return response;
+	} catch (err) {
+		throw err;
+	}
+}
+```

package-lock.json

@@ -1,7 +1,7 @@
 {
 	"name": "@microsoft/microsoft-graph-client",
 	"//": "NOTE: The version here should match exactly the exported const PACKAGE_VERSION in Constants.ts. If you change it here, also change it there.",
-	"version": "1.7.0-Preview.1",
+	"version": "1.7.0",
 	"description": "Microsoft Graph Client Library",
 	"main": "lib/src/index.js",
 	"module": "lib/es/index.js",

package.json

@@ -14,6 +14,7 @@ You can get an access token by doing the following:
 ## Run Sample
 
 1. Run `npm install` to install the application.
-2. Run samples in one of two ways
+2. Run `npm run build` to build the library files.
+3. Run samples in one of two ways
     1. Run and debug the node samples found under ./samples/node/main.js by running the Run node samples configuration from the Debug menu in Visual Studio Code.
-    2. Run the node samples from the CLI by entering node ./samples/node/main.js (assuming you are at the root of this repository).
+    2. Run the node samples from the CLI by entering `node ./samples/node/main.js` (assuming you are at the root of this repository).

samples/node/README.md

@@ -30,29 +30,6 @@ describe("GraphErrorHandler.ts", () => {
 		});
 	});
 
-	describe("constructErrorFromRawResponse", async () => {
-		it("Should parse error from raw response", async () => {
-			const body = "unauthorized";
-			const statusCode = 401;
-			const errorResponse = new Response(body, {
-				status: statusCode,
-			});
-			const gError = await GraphErrorHandler["constructErrorFromRawResponse"](errorResponse, statusCode);
-			assert.equal(gError.statusCode, statusCode);
-			assert.equal(gError.body, body);
-		});
-
-		it("Should parse error without body", async () => {
-			const statusCode = 401;
-			const errorResponse = new Response(undefined, {
-				status: statusCode,
-			});
-			const gError = await GraphErrorHandler["constructErrorFromRawResponse"](errorResponse, statusCode);
-			assert.equal(gError.statusCode, statusCode);
-			assert.isNull(gError.body);
-		});
-	});
-
 	describe("constructErrorFromResponse", () => {
 		const statusCode = 400;
 		const error: any = {

spec/core/GraphErrorHandler.ts

@@ -158,17 +158,5 @@ describe("GraphResponseHandler.ts", () => {
 			const responseValue = await GraphResponseHandler.getResponse(response, ResponseType.TEXT);
 			assert.isDefined(responseValue);
 		});
-
-		it("Should parse from raw response for NOT OK response", async () => {
-			try {
-				const response = new Response("NOT OK", status500);
-				const responseValue = await GraphResponseHandler.getResponse(response, ResponseType.TEXT);
-				throw new Error("Something wrong with validating OK response");
-			} catch (error) {
-				assert.isDefined(error);
-				assert.isTrue(error instanceof Response);
-				assert.equal(error.status, 500);
-			}
-		});
 	});
 });

spec/core/GraphResponseHandler.ts

@@ -11,6 +11,7 @@ import { LargeFileUploadTask } from "../../src/tasks/LargeFileUploadTask";
 import { getClient } from "../test-helper";
 
 describe("LargeFileUploadTask.ts", () => {
+	/* tslint:disable: no-string-literal */
 	describe("Parsing Range", () => {
 		const name = "sample_image.jpg";
 		const arrayBuffer = new ArrayBuffer(80000);
@@ -27,34 +28,33 @@ describe("LargeFileUploadTask.ts", () => {
 		const options = {};
 		const uploadTask = new LargeFileUploadTask(getClient(), fileObj, uploadSession, options);
 		it("Should return default range for given undefined range", (done) => {
-			const range = uploadTask.parseRange([]);
+			const range = uploadTask["parseRange"]([]);
 			assert.equal(range.minValue, -1);
 			assert.equal(range.maxValue, -1);
 			done();
 		});
 
 		it("Should return default range for given empty range", (done) => {
-			const range = uploadTask.parseRange([""]);
+			const range = uploadTask["parseRange"]([""]);
 			assert.equal(range.minValue, -1);
 			assert.equal(range.maxValue, -1);
 			done();
 		});
 
 		it("Should return valid range for given range with from and to values", (done) => {
-			const range = uploadTask.parseRange(["100-200"]);
+			const range = uploadTask["parseRange"](["100-200"]);
 			assert.equal(range.minValue, 100);
 			assert.equal(range.maxValue, 200);
 			done();
 		});
 
 		it("Should return valid range for given range without to value", (done) => {
-			const range = uploadTask.parseRange(["0-"]);
+			const range = uploadTask["parseRange"](["0-"]);
 			assert.equal(range.minValue, 0);
 			assert.equal(range.maxValue, 99999);
 			done();
 		});
 	});
-	/* tslint:disable: no-string-literal */
 	describe("Update Task Status", () => {
 		const name = "sample_image.jpg";
 		const arrayBuffer = new ArrayBuffer(80000);
@@ -75,7 +75,7 @@ describe("LargeFileUploadTask.ts", () => {
 				expirationDateTime: "2018-08-06T09:05:45.195Z",
 				nextExpectedRanges: ["100-2000"],
 			};
-			uploadTask.updateTaskStatus(statusResponse);
+			uploadTask["updateTaskStatus"](statusResponse);
 			assert.equal(uploadTask["nextRange"].minValue, 100);
 			assert.equal(uploadTask["nextRange"].maxValue, 2000);
 			done();
@@ -85,13 +85,12 @@ describe("LargeFileUploadTask.ts", () => {
 				expirationDateTime: "2018-08-06T09:05:45.195Z",
 				nextExpectedRanges: ["100-"],
 			};
-			uploadTask.updateTaskStatus(statusResponse);
+			uploadTask["updateTaskStatus"](statusResponse);
 			assert.equal(uploadTask["nextRange"].minValue, 100);
 			assert.equal(uploadTask["nextRange"].maxValue, 99999);
 			done();
 		});
 	});
-	/* tslint:enable: no-string-literal */
 
 	describe("GetNextRange", () => {
 		const name = "sample_image.jpg";
@@ -123,7 +122,7 @@ describe("LargeFileUploadTask.ts", () => {
 				expirationDateTime: "2018-08-06T09:05:45.195Z",
 				nextExpectedRanges: ["327680-"],
 			};
-			uploadTask.updateTaskStatus(statusResponse);
+			uploadTask["updateTaskStatus"](statusResponse);
 			const nextRange = uploadTask.getNextRange();
 			assert.equal(nextRange.minValue, 327680);
 			assert.equal(nextRange.maxValue, 328679);
@@ -135,7 +134,7 @@ describe("LargeFileUploadTask.ts", () => {
 				expirationDateTime: "2018-08-06T09:05:45.195Z",
 				nextExpectedRanges: [],
 			};
-			uploadTask.updateTaskStatus(statusResponse);
+			uploadTask["updateTaskStatus"](statusResponse);
 			const nextRange = uploadTask.getNextRange();
 			assert.equal(nextRange.minValue, -1);
 			assert.equal(nextRange.maxValue, -1);
@@ -165,7 +164,7 @@ describe("LargeFileUploadTask.ts", () => {
 				expirationDateTime: "2018-08-06T09:05:45.195Z",
 				nextExpectedRanges: [],
 			};
-			uploadTask.updateTaskStatus(statusResponse);
+			uploadTask["updateTaskStatus"](statusResponse);
 			uploadTask
 				.upload()
 				.then((res) => {
@@ -178,4 +177,5 @@ describe("LargeFileUploadTask.ts", () => {
 				});
 		});
 	});
+	/* tslint:enable: no-string-literal */
 });