add trim for Prefer header items, update readme

Author: AleksandrRogov

README.md

@@ -183,7 +183,7 @@ id | String | `retrieveRequest`, `updateRequest`, `upsertRequest`, `deleteReques
 ifmatch | String | `retrieveRequest`, `updateRequest`, `upsertRequest`, `deleteRequest` | Sets If-Match header value that enables to use conditional retrieval or optimistic concurrency in applicable requests. [More info](https://msdn.microsoft.com/en-us/library/mt607711.aspx).
 ifnonematch | String | `retrieveRequest`, `upsertRequest` | Sets If-None-Match header value that enables to use conditional retrieval in applicable requests. [More info](https://msdn.microsoft.com/en-us/library/mt607711.aspx).
 impersonate | String | All | A String representing the GUID value for the Dynamics 365 system user id. Impersonates the user.
-includeAnnotations | String | `retrieveRequest`, `retrieveMultipleRequest` | Sets Prefer header with value "odata.include-annotations=" and the specified annotation. Annotations provide additional information about lookups, options sets and other complex attribute types.
+includeAnnotations | String | `retrieveRequest`, `retrieveMultipleRequest`, `updateRequest`, `upsertRequest` | Sets Prefer header with value "odata.include-annotations=" and the specified annotation. Annotations provide additional information about lookups, options sets and other complex attribute types.
 maxPageSize | Number | `retrieveMultipleRequest` | Sets the odata.maxpagesize preference value to request the number of entities returned in the response.
 navigationProperty | String | `retrieveRequest` | A String representing the name of a single-valued navigation property. Useful when needed to retrieve information about a related record in a single request.
 orderBy | Array | `retrieveMultipleRequest` | An Array (of Strings) representing the order in which items are returned using the $orderby system query option. Use the asc or desc suffix to specify ascending or descending order respectively. The default is ascending if the suffix isn't applied.
@@ -229,6 +229,35 @@ dynamicsWebApi.create(lead, "leads").then(function (id) {
 })
 ```
 
+If you need to return just created entity record, add "return=representation" parameter:
+
+```js
+//initialize a CRM entity record object
+var lead = {
+    subject: "Test WebAPI",
+    firstname: "Test",
+    lastname: "WebAPI",
+    jobtitle: "Title"
+};
+//call dynamicsWebApi.create function
+dynamicsWebApi.create(lead, "leads", ["return=representation"]).then(function (record) {
+    //do something with a record here
+	var subject = record.subject;
+}).catch(function (error) {
+    //catch error here
+})
+```
+
+Also you can include attribute annotations:
+
+```js
+dynamicsWebApi.create(lead, "leads", ["return=representation", "odata.include-annotations=*"]) //...
+//or
+dynamicsWebApi.create(lead, "leads", "return=representation,odata.include-annotations=*") //...
+//and select some attributes from the record
+dynamicsWebApi.create(lead, "leads", ["return=representation", "odata.include-annotations=*"], ["subject"]) //...
+```
+
 ### Update a record
 
 #### Basic

lib/utilities/buildPreferHeader.js

@@ -20,14 +20,15 @@ module.exports = function buildPreferHeader(request, functionName, config) {
             prefer = prefer.split(',');
         }
         for (var i in prefer) {
-            if (prefer[i] === DWA.Prefer.ReturnRepresentation) {
+            var item = prefer[i].trim();
+            if (item === DWA.Prefer.ReturnRepresentation) {
                 returnRepresentation = true;
             }
-            else if (prefer[i].startsWith("odata.include-annotations=")) {
-                includeAnnotations = prefer[i].replace('odata.include-annotations=', '').replace(/"/g,'');
+            else if (item.startsWith("odata.include-annotations=")) {
+                includeAnnotations = item.replace('odata.include-annotations=', '').replace(/"/g,'');
             }
-            else if (prefer[i].startsWith("odata.maxpagesize=")) {
-                maxPageSize = prefer[i].replace('odata.maxpagesize=', '').replace(/"/g, '');
+            else if (item.startsWith("odata.maxpagesize=")) {
+                maxPageSize = item.replace('odata.maxpagesize=', '').replace(/"/g, '');
             }
         }
     }

tests/common-tests.js

@@ -931,6 +931,19 @@ describe("RequestConverter.convertRequestOptions -", function() {
         });
     });
 
+    it("prefer - SPACE - includeAnnotations & maxPageSize", function () {
+        var dwaRequest = {
+            prefer: 'odata.include-annotations=*, odata.maxpagesize=20'
+        };
+
+        var result = RequestConverter.convertRequestOptions(dwaRequest, "", stubUrl);
+        expect(result).to.deep.equal({
+            url: stubUrl, query: "", headers: {
+                Prefer: 'odata.include-annotations="*",odata.maxpagesize=20'
+            }
+        });
+    });
+
     it("prefer - returnRepresentation & maxPageSize", function () {
         var dwaRequest = {
             prefer: 'return=representation,odata.maxpagesize=20'