sp-jsom-node
Version:
SharePoint JavaScript Object Model for Node.js
249 lines (167 loc) • 8.66 kB
Markdown
# sp-jsom-node - SharePoint JavaScript Object Model for Node.js
[](https://nodei.co/npm/sp-jsom-node/)
[](https://badge.fury.io/js/sp-jsom-node)
[](https://www.npmjs.com/package/sp-jsom-node)
[](https://koltyakov.visualstudio.com/SPNode/_build/latest?definitionId=8&branchName=master)
[](https://gitter.im/sharepoint-node/Lobby)
`sp-jsom-node` provides a feasibility of using JSOM (CSOM, SharePoint Client Object Model) in Node.js.
`sp-jsom-node` patches global variables and request client which let's `JSOM` used to behave as if it were in it's usual environment - a browser's SharePoint page.
## Supported SharePoint versions
- SharePoint Online, Project Online
- SharePoint 2019, 2016, Project Server
- SharePoint 2013
- SharePoint 2010 [not officially supported]
## APIs list
- `core` - core JSOM module (loaded by default at first place)
- `search` - sp.search.js
- `publishing` - [sp.publishing.js](https://msdn.microsoft.com/en-us/library/office/jj607192.aspx)
- `taxonomy` - [sp.taxonomy.js](https://msdn.microsoft.com/en-us/library/office/jj857114.aspx)
- `userprofiles` - [sp.userprofiles.js](https://msdn.microsoft.com/en-us/library/office/jj642927.aspx)
- `documentmanagement` - [sp.documentmanagement.js](https://msdn.microsoft.com/en-us/library/office/jj607384.aspx)
- `workmanagement` - [sp.workmanagement.js](https://msdn.microsoft.com/en-us/library/office/jj607384.aspx)
- `policy` - sp.policy.js
- `project` - [PS.js](https://msdn.microsoft.com/en-us/library/office/jj669820.aspx) (Project Server API)
## Supported authentication scenarios
- SharePoint On-Premise (2019, 2016, 2013):
- User credentials (NTLM)
- Form-based authentication (FBA)
- Add-In Only permissions
- ADFS user credentials
- SharePoint Online:
- User credentials (SAML)
- Add-In Only permissions
- ADFS user credentials
## Installation
```bash
npm install sp-jsom-node --save
```
## Usage examples
### Minimal setup (TypeScript)
```typescript
import { JsomNode, IConfigSettings } from 'sp-jsom-node';
export const setting: IConfigSettings = {
configPath: './config/private.json'
}; // Optional setting, by default ./config/private.json is used
new JsomNode().wizard(setting).then((siteUrl) => {
/// ... <<< JSOM can be used here
const ctx = new SP.ClientContext(siteUrl);
}).catch(console.log);
```
First wizard run propmts for SharePoint site url and credentials strategy parameters.
### Minimal setup (JavaScript)
```typescript
const JsomNode = require('sp-jsom-node').JsomNode;
new JsomNode().wizard().then((siteUrl) => {
/// ... <<< JSOM can be used here
const ctx = new SP.ClientContext(siteUrl);
}).catch(console.log);
```
### Initiation with parameters
```typescript
import { JsomNode, IJsomNodeContext } from 'sp-jsom-node';
const authOptions: any = require('./config/private.json');
const authContext: IJsomNodeContext = {
siteUrl: authOptions.siteUrl,
authOptions
};
const ctx = new JsomNode().init(authContext).getContext();
/// ... <<< JSOM can be used here
// const ctx = SP.ClientContext.get_current(); // works with single environment
const oWeb = ctx.get_web();
const oLists = oWeb.get_lists();
const listCreationInfo = new SP.ListCreationInformation();
listCreationInfo.set_title('New Lists');
listCreationInfo.set_templateType(100);
const oList = oLists.add(listCreationInfo);
ctx.load(oList);
ctx.executeQueryAsync(() => {
console.log(oList);
}, (sender, args) => {
console.log(args.get_message());
});
```
### Async/Await usage
Client context runtime is extended with `executeQueryPromise` - promisified version of `executeQueryAsync`. Which allows coding with async/await in a "synchronous" handy style, having elegant and easily maintainable code.
```typescript
import { JsomNode, IJsomNodeContext } from 'sp-jsom-node';
const authOptions: any = require('./config/private.json');
const authContext: IJsomNodeContext = {
siteUrl: authOptions.siteUrl,
authOptions
};
(async () => {
const clientContex = new JsomNode().init(authOptions).getContext();
// const clientContex = SP.ClientContext.get_current();
const oListsCollection = clientContext.get_web().get_lists();
clientContext.load(oListsCollection, 'Include(Title)');
await clientContext.executeQueryPromise(); // Using JSOM extension
const listsTitlesArr = oListsCollection.get_data()
.map((l) => l.get_title());
console.log('Lists', listsTitlesArr);
})()
.catch(console.error);
```
### Modules
By default, only core modules are loaded.
Additional CSOM features can be requested in `modules` setting.
[Modules list](#apis-list).
```typescript
import { JsomNode, IJsomNodeSettings } from 'sp-jsom-node';
// ...authOptions
const settings: any = require('./config/private.json');
const jsomSettings: IJsomNodeSettings = {
modules: [ 'taxonomy', 'userprofiles' ],
envCode: '2013' // 'spo' is default
};
new JsomNode(jsomSettings).init(authOptions);
/// ... <<< JSOM can be used here
```
### Project server (PM.js)
```typescript
import { JsomNode, IJsomNodeSettings } from 'sp-jsom-node';
// ...authOptions
const settings: any = require('./config/private.json');
const jsomSettings: IJsomNodeSettings = {
modules: [ 'project' ]
};
new JsomNode(jsomNodeOptions).init(authOptions);
(async () => {
// API Reference - https://msdn.microsoft.com/en-us/library/office/jj669820.aspx
const projCtx = PS.ProjectContext.get_current();
const projects = projCtx.get_projects();
projCtx.load(projects, 'Include(Name, Id)');
await projCtx.executeQueryPromise();
console.log(projects.get_data().map(p => p.get_name()));
})()
.catch(console.error);
```
#### JSOM Node Settings options
- `modules`?: JsomModules[]; // On demand modules load | Default is ['core']
- `envCode`?: 'spo' | '2019' | '2016' | '2013'; // Loads different version of JSOM javascripts | Default is 'spo'
#### Synchronous initiation `.init(context: IJsomNodeContext)`
- `siteUrl`: string; // Optional SPWeb url
- `authOptions`: IAuthOptions; `node-sp-auth` [credentials options](https://github.com/s-KaiNet/node-sp-auth)
#### Async/wizard initiation `.wizard(config?: IConfigSettings)`
`node-sp-auth-config` [options](https://github.com/koltyakov/node-sp-auth-config)
- `configPath`?: string; // Path to auth config .json | Default is './config/private.json'
- `encryptPassword`?: boolean; // Encrypts password to a machine-bind hash | Default is 'true'
- `saveConfigOnDisk`?: boolean; // Saves config .json to disk | Default is 'true'
- ... [see more](https://github.com/koltyakov/node-sp-auth-config)
Settings can be left blank. Auth options in such a case will be asked by `node-sp-auth-config` [options](https://github.com/koltyakov/node-sp-auth-config) in a wizard like approach.
### Settings scenarios
- No initial settings (defaults): wizard approach, covers console applications cases with user interaction
- With explicitly defined `authOptions`:
- external tools is in charge for preparing auth credentials in `node-sp-auth` format
- credentials should not be dumped on disc
- Config file with prepopulated credentials: schedule, job automation, continues integration
## Integration tests
```bash
npm run test
```
## Bundling scripts
When creating automation scripts for production environment, e.g. Azure Job or Function or embedded application like Electron, it can be important to bundle and minify sources with positive performant effect as a result.
Check [example](https://github.com/koltyakov/sp-jsom-node/tree/master/examples/basic) with bundling.
## Inspiration and references
This project was mostly inspired by [Vadim Gremyachev](https://github.com/vgrem)'s project - [CSOMNode](https://github.com/vgrem/CSOMNode), but implements JSOM in node in a bit different way, in TypeScript and supports different auth scenarious implemented in [node-sp-auth](https://github.com/s-KaiNet/node-sp-auth) by [Sergei Sergeev](https://github.com/s-KaiNet).