SharepointPlus

SharepointPlus ($SP) is a JavaScript library which offers some extended features for SharePoint entirely on client side (requires no server install). $SP will simplify your interactions with the Sharepoint Web Services and will help you to deal with the List Forms.

Other JavaScript library like this one are often complex, with few or no example. With SharepointPlus it's easy (like the SQL syntax) and you'll find examples for each method.

Documentation

The documentation is in the docs directory, it serves as the demo as well.

Browse online documentation here.

Quick Start

Requirements

If you plan to use IE11, you need to add the Promise polyfill.

CDN / Standalone

  <script type="text/javascript" src="sharepointplus-5.0.min.js"></script>

You may also want to use a CDN: SharepointPlus on JSDelivr

Node.js

Install

npm install sharepointplus # npm
yarn add --dev sharepointplus # yarn

Usage:

// the credentials depend of your authentication system
// see: https://github.com/s-KaiNet/node-sp-auth
const credentials = {
  username:'my_username',
  password:'mypassword',
  domain:'mydomain'
};
// you can also define a proxy
const proxyweb = "http://" + credentials.domain + "%5C" + credentials.username + ":" + credentials.password + "@proxy:80";

const $SP = require('sharepointplus');
const sp = $SP().proxy(proxyweb).auth(credentials);

Webpack

For Webpack, you need to ignore sp-request with IgnorePlugin for builds to succeed:

// webpack.config.js

plugins: [
  new webpack.IgnorePlugin(/^sp-request$/)
]

Usage / Examples

Update all items with an "Amount" value bigger than 1000:

$SP().list('My List Name').update({
  Title:"Too expensive"
}, {
  where:"Amount > 1000"
}).then(function(res) {
  alert(res.passed.length+" items successfully updated!");
});

Get all items with "Requestor" as the current user and with "Default Color" is "pink":

$SP().list('ListName').get({
  fields:"Title,Size",
  where:"Requestor = '[Me]' AND Default_x0020_Color = 'pink'",
  orderby:"Size DESC"
}).then(function(data) {
  var html = "<ul>";
  for (var i=data.length; i--;)
    html += "<li>Model '"+data[i].getAttribute("Title")+"' (size: "+data[i].getAttribute("Default_x0020_Color")+")<li>";
  $('#list').append(html+'</ul>');
});