bluebird67 / sp-request

Simplified SharePoint HTTP client

sp-request - simplified SharePoint HTTP client

sp-request based on request-promise (promise-aware implementation of request) and node-sp-auth modules. node-sp-auth implements different authentication options for unattended SharePoint authentication from nodejs. You can send REST queries to SharePoint (works with both on-prem and online) using well-known request syntax with the same params that request supports, and sp-request (with help of node-sp-auth) takes care about authenticating you inside SharePoint. Responses implemented using modern promise-style approach.

Versions supported:

• SharePoint 2013, 2016
• SharePoint Online

---

How to use:

Install:

npm install sp-request --save-dev

Create sprequest function:

var spr = require('sp-request').create(credentialOptions);

Get list by title:

spr.get('http://sp2013dev/sites/dev/_api/web/lists/GetByTitle(\'TestList\')')
  .then(function (response) {
    console.log('List Id: ' + response.body.d.Id);
  })
  .catch(function(err){
    console.log('Ohhh, something went wrong...');
  });

Update list title:

spr.requestDigest('http://sp2013dev/sites/dev')
  .then(function (digest) {
    return spr.post('http://sp2013dev/sites/dev/_api/web/lists/GetByTitle(\'TestList\')', {
      body: {
        '__metadata': { 'type': 'SP.List' },
        'Title': 'TestList'
      },
      headers: {
        'X-RequestDigest': digest,
        'X-HTTP-Method': 'MERGE',
        'IF-MATCH': '*'
      }
    });
  })
  .then(function (response) {
    if (response.statusCode === 204) {
      console.log('List title updated!');
    }
  }, function (err) {
    if (err.statusCode === 404) {
      console.log('List not found!');
    } else {
      console.log(err);
    }
  });

... as simple as that! A bit more samples you can find under integration tests

API:

[main sp-request export].create(credentialOptions):

• credentialOptions: required, object containing credentials. Since version 2.x sp-request relies on node-sp-auth module for authentication. You can find description for credentialOptions under node-sp-auth.

Call to require('sp-request').create(credentialOption) returns sprequest function with predefined authentication. You can use this function later to send REST queries (like in samples above) without specifying credentials again.

sprequest(options):

• options: required, settings object for request module. For all available values refer to the original request docs

By default sp-request sets following params for request:

{
    json: true,
    strictSSL: false, /* bypassing SSL validation errors */
    headers: {
        'Accept': 'application/json;odata=verbose',
        'Content-Type': 'application/json;odata=verbose'
    }
}

as a result you can access body.d property as an object. You can provide your own headers and override defaults if it's required. The only difference from original request, that sp-request returns Bluebird's Promise (ES2015 promise implementation), instead of relying on callbacks. So you can combine multiple requests in a convenient and readable way.

sprequest.requestDigest(url):

• url - required, string site url

Returns request digest as string via promise.

Convenience methods:

sprequest(url, options):

• url - required, string
• options - required, request options object

The same as sprequest(options) but options.url will be equal to the first param.

sprequest.get(url, options)

• url - required, string
• options - optional, request options object

The same as sprequest(options) but options.url will be equal to the first param and options.method: 'GET'.

sprequest.post(url, options)

• url - required, string
• options - optional, request options object

The same as sprequest(options) but options.url will be equal to the first param and options.method: 'POST'.

Development:

I recommend using VS Code for development. Repository already contains some settings for VS Code editor.

Before creating Pull Request you need to create an appropriate issue and reference it from PR.

1. git clone https://github.com/s-KaiNet/sp-request.git
2. npm run build - restores dependencies and runs typescript compilation
3. gulp live-dev - setup watchers and automatically runs typescript compilation, tslint and tests when you save files

Tests:

1. npm test. As a result /reports folder will be created with test results in junit format and code coverage. Additionally test reports will be available in a console window.

Integration testing:

1. Rename file /test/integration/config.sample.ts to config.ts.
2. Update information in config.ts with appropriate values (urls, credentials, environment).
3. Run gulp test-int.