sp-pnp-node - PnPjs's auth client factory for Node.js
Consider using pnp-auth as a successor which soaked the best of
sp-pnp-node
andnode-pnp-sp
libraries. I'm keepingsp-pnp-node
not archived and update it from time to time only because of some production implementations which I'm too lazy to migrate topnp-auth
right away.
sp-pnp-node
provides a simple way for using PnPjs
in Node.js with support of various authentication strategies.
About PnPjs
PnPjs Client Side Libraries for Microsoft 365 was created to help developers by simplifying common operations within SharePoint and the SharePoint Framework. Currently it contains a fluent API for working with the full SharePoint REST API as well as utility and helper functions. This takes the guess work out of creating REST requests, letting developers focus on the what and less on the how.
Supported SharePoint versions
- SharePoint Online
- SharePoint On-Prem (2019, 2016, 2013)
Install
npm install sp-pnp-node @pnp/pnpjs@^1.3.11
Usage examples
Minimal setup
Can be as simple as 5 lines of code:
;; new PnpNode.init.then.catchconsole.log;
sp-pnp-node
has two modes:
- ambient init - wraps
PnPjs
with promise based auth wizard helper - factory -
fetchClientFactory
implementation
When to use ambient init: in scripts with user interaction involved when there is no information about authentication and target invironment before script is executed. SharePoint url and the creds are prompted in a console.
In CI/CD scenarios, factory approach is recommended over interactive console as it can lead to a task stuck.
TypeScript
Ambient init example
;; ; new PnpNodeoptionalInitSettings.init.then.catchconsole.log;
Factory example
;; ; ; pnp.sp.setup; pnp.sp.web.get .thenconsole.log .catchconsole.log; // Or /*new Web('http://adhoc.url/sites/site').get() .then(console.log) .catch(console.log);*/
JavaScript
const Web = ;const PnpNode = ; ;
OData Metadata modes
;; new PnpNode.init.then.catchconsole.log;
Initiation settings
; ; new PnpNodepnpNodeSettings.init.then.catchconsole.log;
Raw Fetch client usage
; declare ; new PnpNode.init.then;
PnP Node Settings options
- siteUrl?: string; // Optional SPWeb url
- authOptions?: IAuthOptions;
node-sp-auth
credentials options - config?: IAuthConf;
node-sp-auth-config
options- 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'
Settings can be left blank. Auth options in such a case will be asked by node-sp-auth-config
options 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
- external tools is in charge for preparing auth credentials in
- Config file with prepopulated credentials: schedule, job automation, continues integration
Supported authentication scenarios
-
SharePoint On-Premise (2013, 2016):
- 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
Inspiration and references
This project was inspired by Sergei Sergeev and Patrick Rodgers. Main ideas were taken from node-pnpjs-sample and Using PnP JS Core and node-sp-auth. The result project implements the same concepts with a goal of reusability and maintenance simplification.