Skip to content

Instantly share code, notes, and snippets.

@anomepani

anomepani/SPRest.ts

Last active May 10, 2019 07:43
Show Gist options
  • Save anomepani/df2222e81d75126e05402185054d100d to your computer and use it in GitHub Desktop.
Save anomepani/df2222e81d75126e05402185054d100d to your computer and use it in GitHub Desktop.
Download ZIP
Raw
SPRest.ts
var SPRest = /** @class */ (function () {
function SPRest(rootWeb) {
var _this = this;
this.Utils = (function () {
/**
* Reference or motivation link : https://github.com/omkarkhair/sp-jello/blob/master/lib/jello.js
* https://github.com/abhishekseth054/SharePoint-Rest
* https://github.com/gunjandatta/sprest
*/
var reqUrl = _this.rootUrl + "/_api/web/lists/getbytitle('AWSResponseList')/items";
//var fetch = require("node-fetch");
// TODO- Need to transform this json to closure function to allow only get operation.
//TODO - Need to add support for Field Meta in utils
var spDefaultMeta = {
List: {
BaseTemplate: 100,
// "Title": "List Created with Fetch UTIL1112",
__metadata: { type: "SP.List" }
},
Document: {
__metadata: { type: "SP.List" },
AllowContentTypes: true,
BaseTemplate: 101,
ContentTypesEnabled: true
// 'Description': 'My doc. lib. description',
// 'Title': 'Test'
},
ListItem: {
__metadata: { type: "SP.Data.AWSResponseListListItem" }
// "Title": "Test"
}
};
console.log(_this.rootUrl);
var isOdataVerbose = true;
var _rootUrl = _this.rootUrl;
//Here "Accept" and "Content-Type" header must require for Sharepoint Onlin REST API
var _payloadOptions = {
method: "GET",
body: undefined,
headers: {
credentials: "include",
Accept: "application/json; odata=verbose",
"Content-Type": "application/json; odata=verbose"
}
};
// TODO- To support for param base odata
//No to fetch Metadata, response only requested data.
// Reference link https://www.microsoft.com/en-us/microsoft-365/blog/2014/08/13/json-light-support-rest-sharepoint-api-released/
//Option 1: verbose “accept: application/json; odata=verbose”
//Option 2: minimalmetadata “accept: application/json; odata=minimalmetadata”
//Option 3: nometadata “accept: application/json; odata=nometadata”
//Option 4: Don’t provide it “accept: application/json” This defaults to minimalmetadata option
if (!isOdataVerbose) {
_payloadOptions.headers.Accept = "application/json; odata=nometadata";
}
// Reference from :https://www.tjvantoll.com/2015/09/13/fetch-and-errors/
//Reference rom : https://sharepoint.stackexchange.com/questions/105380/adding-new-list-item-using-rest
// Get List Item Type metadata
var getItemTypeForListName = function (name) {
return ("SP.Data." +
name.charAt(0).toUpperCase() +
name
.split(" ")
.join("")
.slice(1) +
"ListItem");
};
var Get = function (url) {
var _localPayload = _payloadOptions;
_localPayload.method = "GET";
//Internally if body is set for GET request then need to remove it by setting undefined
// otherwise it return with error : Failed to execute 'fetch' on 'Window': Request with GET/HEAD method cannot have body
_localPayload.body = undefined;
delete _localPayload.headers["IF-MATCH"];
delete _localPayload.headers["X-HTTP-Method"];
console.log(_localPayload);
return fetch(url, _localPayload).then(function (r) { return r.json(); });
};
var getRequestDigest = function (url) {
if (url === void 0) { url = ""; }
if (url) {
url = _this.rootUrl;
}
url += "/_api/contextinfo";
var _localPayload = _payloadOptions;
_localPayload.method = "POST";
return fetch(url, _payloadOptions).then(function (r) { return r.json(); });
};
var postWithRequestDigestExtension = function (url, _a) {
var _b = _a.headers, headers = _b === void 0 ? {} : _b, payload = _a.payload;
return getRequestDigest().then(function (token) {
// payload.requestDigest = token.d.GetContextWebInformation.FormDigestValue;
headers["X-RequestDigest"] =
token.d.GetContextWebInformation.FormDigestValue;
return PostExtension(url, { headers: headers, payload: payload });
});
};
var postWithRequestDigest = function (url, payload) {
return getRequestDigest().then(function (token) {
payload.requestDigest =
token.d.GetContextWebInformation.FormDigestValue;
return Post(url, payload);
});
};
//Need to refactor below method and need to merge in single method postWithRequestDigestExtension
//Based on Action Type in headers using switch case add or remove extra headers
// Try to add header name same as standard name so it can be replaced with for loop e.g. _extraHeaders
var updateWithRequestDigest = function (url, payload) {
return getRequestDigest(payload.rootUrl + "/_api/contextinfo").then(function (token) {
payload.requestDigest =
token.d.GetContextWebInformation.FormDigestValue;
payload._extraHeaders = {
"IF-MATCH": "*",
"X-HTTP-Method": "MERGE"
};
//For Update operation or Merge Operation no response will return only status will return for http request
payload.isNoJsonResponse = true;
return Post(url, payload);
});
};
var deleteWithRequestDigest = function (url, payload) {
return getRequestDigest(payload.rootUrl + "/_api/contextinfo").then(function (token) {
payload.requestDigest =
token.d.GetContextWebInformation.FormDigestValue;
payload._extraHeaders = {
"IF-MATCH": "*",
"X-HTTP-Method": "DELETE"
};
//For Update operation or Merge Operation no response will return only status will return for http request
payload.isNoJsonResponse = true;
return Post(url, payload);
});
};
var Post = function (url, payload) {
var _localPayload = _payloadOptions;
// TODO For Safety this method can be wrapped with request Digest so always get token.
// But need to ensure it request only when request digest is expired.
_localPayload.method = "POST";
_localPayload.body = payload.data;
var _metaInfo = payload.metaInfo;
//Pre validation Check Before update body or meta detail
if (_metaInfo && spDefaultMeta[_metaInfo.type]) {
//Update Title and Description while creating new List/Column/Fields
var type = _metaInfo.type, title = _metaInfo.title, listName = _metaInfo.listName;
var _body = spDefaultMeta[type];
if (title) {
//Update title if it is present in metaInfo
_body.Title = title;
}
if (type === "ListItem") {
//TODO Extra Efforts
_body.__metadata.type = getItemTypeForListName(listName);
}
//If Extra fields are present then store to payload
//Before Stringify ,store extra fields/columns in body
if (payload.extraFields) {
for (var field in payload.extraFields) {
//Add all extra columns in body
// TODO- Need to ensure that column value is stringify
_body[field] = payload.extraFields[field];
}
// Merge two object
// _localPayload.body = Object.assign({}, _localPayload.body, payload.extraFields)
}
//Pass body data as stringyfy;
_localPayload.body = JSON.stringify(_body);
_localPayload.body.Title = title;
}
//If Extra header is present in payload for update or other operation, Append to existing header
if (payload._extraHeaders) {
for (var _header in payload._extraHeaders) {
_localPayload.headers[_header] = payload._extraHeaders[_header];
}
}
else {
//IF Not present that means it is POST Request, reset Extraheader for this request
_localPayload.headers["IF-MATCH"] = undefined;
_localPayload.headers["X-HTTP-Method"] = undefined;
}
_localPayload.headers["X-RequestDigest"] = payload.requestDigest;
console.log(_localPayload);
//TODO- Naming convention can be updated.
if (payload.isNoJsonResponse) {
return fetch(url, _localPayload).then(function (r) { return r; });
}
else {
return fetch(url, _localPayload).then(function (r) { return r.json(); });
}
};
var PostExtension = function (url, _a) {
var headers = _a.headers, payload = _a.payload;
var _localPayload = {};
_localPayload = _payloadOptions;
// TODO For Safety this method can be wrapped with request Digest so always get token.
// But need to ensure it request only when request digest is expired.
_localPayload.method = "POST";
//If Extra header is present in payload for update or other operation, Append to existing header
if (headers) {
for (var _header in headers) {
_localPayload.headers[_header] = headers[_header];
}
}
//Below code not required to reset functionality
// else {
// //IF Not present that means it is POST Request, reset Extraheader for this request
// __copyPayloadOptions.headers["IF-MATCH"] = undefined;
// __copyPayloadOptions.headers["X-HTTP-Method"] = undefined;
// }
//TODO -Assume payload is in object so applied stringyfy other wise need check before apply
_localPayload.body = JSON.stringify(payload.data);
// console.log(_payloadOptions);
//TODO- Naming convention can be updated.
// if (payload.isNoJsonResponse) {
//Instead of storing extra info in payload use headers
if (payload.isNoJsonResponse) {
return fetch(url, _localPayload).then(function (r) { return r; });
}
else {
return fetch(url, _localPayload).then(function (r) { return r.json(); });
}
};
/**
* Generate GUID in javascript
* Reference from : https://github.com/andrewconnell/sp-o365-rest/blob/master/SpRestBatchSample/Scripts/App.js
*/
function generateUUID() {
var d = new Date().getTime();
var uuid = "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
var r = (d + Math.random() * 16) % 16 | 0;
d = Math.floor(d / 16);
return (c == "x" ? r : (r & 0x7) | 0x8).toString(16);
});
return uuid;
}
/**
* Prepare batch request in Sharepoint Online
* Reference from : https://github.com/andrewconnell/sp-o365-rest/blob/master/SpRestBatchSample/Scripts/App.js
*/
var GenerateBatchRequest = function (_a) {
var _b = _a.listName, listName = _b === void 0 ? "" : _b, data = _a.data, _c = _a.DigestValue, DigestValue = _c === void 0 ? "" : _c, _d = _a.action, action = _d === void 0 ? "ADD" : _d, _e = _a.itemIds, itemIds = _e === void 0 ? [] : _e;
// generate a batch boundary
var batchGuid = generateUUID();
// creating the body
var batchContents = new Array();
var changeSetId = generateUUID();
// get current host
// var temp = document.createElement('a');
// temp.href = this.rootUrl;
// var host = temp.hostname;
// iterate through each employee
////TODO NEED TO SEPARATE BATCH OPERATION CREATION FOR ADD,UPDATE and DELETE OPERATION
// MIXED INSERT and UPDATE Operation
// MIXED ISERT ,UPDATE and DELETE Operation
for (var _index = 0; _index < data.length; _index++) {
//TODO for payload or "data" need to generate or extract metadata based on type and batch action
var _item = data[_index];
if (action === "UPDATE") {
_item.Title = "##Updated_" + _item.Title;
}
//Generate and prepare request url for each item
switch (action) {
case "ADD":
var endpoint = generateRestRequest({ listName: listName, type: "ListItem" });
break;
case "UPDATE":
var endpoint = generateRestRequest({
listName: listName,
type: "ListItem",
Id: itemIds[_index]
});
_item.Title += _index;
break;
case "DELETE":
var endpoint = generateRestRequest({
listName: listName,
type: "ListItem",
Id: itemIds[_index]
});
break;
}
// create the request endpoint
// create the changeset
batchContents.push("--changeset_" + changeSetId);
batchContents.push("Content-Type: application/http");
batchContents.push("Content-Transfer-Encoding: binary");
batchContents.push("");
if (action === "UPDATE") {
batchContents.push("PATCH " + endpoint + " HTTP/1.1");
batchContents.push("If-Match: *");
batchContents.push("Content-Type: application/json;odata=verbose");
batchContents.push("");
batchContents.push(JSON.stringify(_item));
}
else if (action === "ADD") {
batchContents.push("POST " + endpoint + " HTTP/1.1");
batchContents.push("Content-Type: application/json;odata=verbose");
batchContents.push("");
batchContents.push(JSON.stringify(_item));
}
else if (action === "DELETE") {
batchContents.push("DELETE " + endpoint + " HTTP/1.1");
batchContents.push("If-Match: *");
}
//Commented POST request line and added code for UPDATE as well
// batchContents.push("POST " + endpoint + " HTTP/1.1");
// batchContents.push("Content-Type: application/json;odata=verbose");
// batchContents.push("");
// batchContents.push(JSON.stringify(_item));
batchContents.push("");
}
// END changeset to create data
batchContents.push("--changeset_" + changeSetId + "--");
// batch body
var batchBody = batchContents.join("\r\n");
batchContents = [];
// create batch for creating items
batchContents.push("--batch_" + batchGuid);
batchContents.push('Content-Type: multipart/mixed; boundary="changeset_' +
changeSetId +
'"');
batchContents.push("Content-Length: " + batchBody.length);
batchContents.push("Content-Transfer-Encoding: binary");
batchContents.push("");
batchContents.push(batchBody);
batchContents.push("");
// create request in batch to get all items after all are created
////Commented below endpoint as we are utilizing same endpoint without orderby
// endpoint = _this.rootUrl +
// "/_api/web/lists/getbytitle('" + listName + "')" +
// '/items?$orderby=Title';
// batchContents.push('--batch_' + batchGuid);
// batchContents.push('Content-Type: application/http');
// batchContents.push('Content-Transfer-Encoding: binary');
// batchContents.push('');
//COmmented below lines of code as I don't need to request GET after insertion
// batchContents.push('GET ' + endpoint + ' HTTP/1.1');
// batchContents.push('Accept: application/json;odata=verbose');
// batchContents.push('');
batchContents.push("--batch_" + batchGuid + "--");
batchBody = batchContents.join("\r\n");
// create the request endpoint
var batchEndpoint = _this.rootUrl + "/_api/$batch";
// var batchRequestHeader = {
// 'X-RequestDigest': DigestValue,
// 'Content-Type': 'multipart/mixed; boundary="batch_' + batchGuid + '"'
// };
return getRequestDigest().then(function (r) {
//SPECIAL CASE IS BATCH REQUEST MODE
var batchRequestHeader = {
"X-RequestDigest": r.d.GetContextWebInformation.FormDigestValue,
"Content-Type": 'multipart/mixed; boundary="batch_' + batchGuid + '"'
};
return fetch(batchEndpoint, {
method: "POST",
headers: batchRequestHeader,
body: batchBody
}).then(function (r) { return r.text(); });
});
//return PostExtension(batchEndpoint,{headers:batchRequestHeader,payload:batchBody})
//fetch(batchEndpoint,{method:'POST',headers:batchRequestHeader,body:batchBody}).then(r=>r.text()).then(r=>console.log(r))
//OLD CODE Commented
// create request
// jQuery.ajax({
// url: endpoint,
// type: 'POST',
// headers: batchRequestHeader,
// data: batchBody,
// success: function(response) {
// var responseInLines = response.split('\n');
// // $("#tHead").append("<tr><th>First Name</th><th>Last Name</th><th>Technology</th></tr>");
// for (var currentLine = 0; currentLine < responseInLines.length; currentLine++) {
// try {
// var tryParseJson = JSON.parse(responseInLines[currentLine]);
// console.log(tryParseJson);
// } catch (e) {
// console.log("Error")
// }
// }
// },
// fail: function(error) {
// }
// });
};
var generateRestRequest = function (_a) {
var _b = _a.listName, listName = _b === void 0 ? "" : _b, _c = _a.Id, Id = _c === void 0 ? "" : _c, type = _a.type, _d = _a.oDataOption, oDataOption = _d === void 0 ? "" : _d, _e = _a.url, url = _e === void 0 ? "" : _e;
if (url) {
return url;
}
var prepareRequest = _this.rootUrl + "/_api/web/lists";
switch (type) {
case "ListItem":
prepareRequest += "/getbytitle('" + listName + "')/items";
if (Id) {
prepareRequest += "(" + Id + ")";
}
if (oDataOption) {
prepareRequest += "?" + oDataOption;
}
break;
case "List":
if (listName) {
prepareRequest += "/getbytitle('" + listName + "')";
}
if (oDataOption) {
prepareRequest += "?" + oDataOption;
}
//TODO
break;
case "MSGraph":
//Special Case
break;
}
//OLDER Code for ListItem
// prepareRequest = `/getbytitle('${listName}')/items`;
// if (Id) {
// prepareRequest += `(${Id})`;
// }
return prepareRequest;
};
//Provide support for odata query so, for specific provided expression append it with base requet
var ListItem = {
Add: function (_a) { },
Update: function (_a) { },
Delete: function (_a) { },
GetItemById: function (_a) { },
GetAllItem: function (_a) { }
};
var List = {
Add: function (_a) { },
Update: function (_a) {
console.log("Implementation is pending");
},
Delete: function (_a) {
console.log("Implementation is pending");
},
GetByTitle: function (_a) {
console.log("Implementation is pending");
},
GetAll: function (_a) { }
};
List.GetAll = function (_a) {
var _b = _a.oDataOption, oDataOption = _b === void 0 ? "" : _b, _c = _a.url, url = _c === void 0 ? "" : _c;
return Get(generateRestRequest({ listName: "", type: "List", oDataOption: oDataOption, url: url }));
};
List.GetByTitle = function (_a) {
var listName = _a.listName, oDataOption = _a.oDataOption, url = _a.url;
return Get(generateRestRequest({ listName: listName, type: "List", oDataOption: oDataOption, url: url }));
};
List.Add = function (_a) {
var listName = _a.listName, data = _a.data;
var _reqUrl = generateRestRequest({ listName: listName, type: "List" });
var _prePayload = preparePayloadData({
action: "ADD",
type: "List",
listName: listName,
data: data
});
return postWithRequestDigestExtension(_reqUrl, _prePayload);
};
ListItem.GetAllItem = function (_a) {
var listName = _a.listName, _b = _a.oDataOption, oDataOption = _b === void 0 ? "" : _b, _c = _a.url, url = _c === void 0 ? "" : _c;
return Get(generateRestRequest({ listName: listName, type: "ListItem", oDataOption: oDataOption, url: url }));
};
ListItem.GetItemById = function (_a) {
var listName = _a.listName, Id = _a.Id, _b = _a.oDataOption, oDataOption = _b === void 0 ? "" : _b, _c = _a.url, url = _c === void 0 ? "" : _c;
return Get(generateRestRequest({ listName: listName, Id: Id, type: "ListItem", oDataOption: oDataOption, url: url }));
};
// Add/Update/Delete require same types of metaData as well as payload only difference is Headers
ListItem.Add = function (_a) {
var listName = _a.listName, data = _a.data;
var _reqUrl = generateRestRequest({ listName: listName, type: "ListItem" });
var _prePayload = preparePayloadData({
action: "ADD",
type: "ListItem",
listName: listName,
data: data
});
return postWithRequestDigestExtension(_reqUrl, _prePayload);
};
ListItem.Update = function (_a) {
var listName = _a.listName, Id = _a.Id, data = _a.data;
var _reqUrl = generateRestRequest({ listName: listName, Id: Id, type: "ListItem" });
var _prePayload = preparePayloadData({
action: "UPDATE",
type: "ListItem",
listName: listName,
data: data
});
return postWithRequestDigestExtension(_reqUrl, _prePayload);
};
ListItem.Delete = function (_a) {
var listName = _a.listName, Id = _a.Id, data = _a.data;
var _reqUrl = generateRestRequest({ listName: listName, Id: Id, type: "ListItem" });
var _prePayload = preparePayloadData({
action: "DELETE",
type: "ListItem",
listName: listName,
data: data
});
return postWithRequestDigestExtension(_reqUrl, _prePayload);
};
var preparePayloadData = function (_a) {
var listName = _a.listName, data = _a.data, action = _a.action, type = _a.type;
var payload = {
data: { __metadata: spDefaultMeta[type] }
};
//payload.data = {};
// let _metaInfo: any = spDefaultMeta["ListItem"];
// _metaInfo.__metadata.type = getItemTypeForListName(listName);
// payload.data.__metadata=spDefaultMeta["ListItem"];
switch (type) {
case "ListItem":
//Update ListItem Content type
payload.data.__metadata.type = getItemTypeForListName(listName);
break;
}
//Need to check is data is object then iterate otherwise not
if (data) {
for (var _key in data) {
payload.data[_key] = data[_key];
}
}
//TODO Verify about extra header
// //Pass body data as stringyfy;
// // _payloadOptions.body = JSON.stringify(_body);
// // _payloadOptions.body.Title = title;
// return postWithRequestDigest(_reqUrl);
var _headers = {};
switch (action) {
case "ADD":
_headers = {
"IF-MATCH": undefined,
"X-HTTP-Method": undefined
};
break;
case "UPDATE":
_headers = {
"IF-MATCH": "*",
"X-HTTP-Method": "MERGE"
};
//For Update operation or Merge Operation no response will return only status will return for http request
payload.isNoJsonResponse = true;
break;
case "DELETE":
_headers = {
"IF-MATCH": "*",
"X-HTTP-Method": "DELETE"
};
//For Update operation or Merge Operation no response will return only status will return for http request
payload.isNoJsonResponse = true;
break;
}
return { headers: _headers, payload: payload };
};
return {
ListItem: ListItem,
Get: Get,
getRequestDigest: getRequestDigest,
Post: postWithRequestDigest,
Update: updateWithRequestDigest,
Delete: deleteWithRequestDigest,
BatchInsert: GenerateBatchRequest
};
})();
this.rootUrl = rootWeb;
}
return SPRest;
}());
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment