@pnp/sp - npm Package Compare versions

Comparing version 1.0.0-beta.11 to 1.0.0-rc.0

docs/alm.md

@@ -5,4 +5,2 @@ # @pnp/sp/appcatalog
 
-Unless otherwise noted this functionality was introduced in version 3.0.2 of the library.
-
 ### Understanding the App Catalog Heirarchy
@@ -9,0 +7,0 @@

docs/attachments.md

@@ -73,4 +73,2 @@ # @pnp/sp/attachments
 
-_Added in 3.0.2_
-
 ```TypeScript
@@ -77,0 +75,0 @@ const list = pnp.sp.web.lists.getByTitle("MyList");

docs/index.md

 # @pnp/sp
 
+[![npm version](https://badge.fury.io/js/%40pnp%2Fsp.svg)](https://badge.fury.io/js/%40pnp%2Fsp)
+
 This package contains the fluent api used to call the SharePoint rest services.
 
+## Getting Started
+
+Install the library and required dependencies
+
+`npm install @pnp/logging @pnp/common @pnp/odata @pnp/sp --save`
+
+Import the library into your application and access the root sp object
+
+```TypeScript
+import { sp } from "@pnp/sp";
+
+(function main() {
+
+    // here we will load the current web's title
+    sp.web.select("Title").get().then(w => {
+
+        console.log(`Web Title: ${w.Title}`);
+    });
+})()
+```
+
+## Getting Started: SharePoint Framework
+
+Install the library and required dependencies
+
+`npm install @pnp/logging @pnp/common @pnp/odata @pnp/sp --save`
+
+Import the library into your application, update OnInit, and access the root sp object in render
+
+```TypeScript
+import { sp } from "@pnp/sp";
+
+// ...
+
+public onInit(): Promise<void> {
+
+  return super.onInit().then(_ => {
+
+    // other init code may be present
+
+    sp.setup({
+      spfxContext: this.context
+    });
+  });
+}
+
+// ...
+
+public render(): void {
+
+    // A simple loading message
+    this.domElement.innerHTML = `Loading...`;
+
+    sp.web.select("Title").get().then(w => {
+
+        this.domElement.innerHTML = `Web Title: ${w.Title}`;
+    });
+}
+```
+
+## Getting Started: Nodejs
+
+Install the library and required dependencies
+
+`npm install @pnp/logging @pnp/common @pnp/odata @pnp/sp @pnp/nodejs --save`
+
+Import the library into your application, setup the node client, make a request
+
+```TypeScript
+import { sp } from "@pnp/sp";
+import { SPFetchClient } from "@pnp/nodejs";
+
+// do this once per page load
+sp.setup({
+    sp: {
+        fetchClientFactory: () => {
+            return new SPFetchClient("{your site url}", "{your client id}", "{your client secret}");
+        },
+    },
+});
+
+// now make any calls you need using the configured client
+sp.web.select("Title").get().then(w => {
+
+    console.log(`Web Title: ${w.Title}`);
+});
+```
+
+## Library Topics
+
 * [Alias Parameters](alias-parameters.md)
@@ -6,0 +98,0 @@ * [ALM api](alm.md)

package.json

 {
     "name": "@pnp/sp",
-    "version": "1.0.0-beta.11",
+    "version": "1.0.0-rc.0",
     "description": "pnp - provides a fluent api for working with SharePoint REST",
@@ -8,8 +8,8 @@ "main": "./dist/sp.es5.umd.js",
     "dependencies": {
-        "tslib": "1.7.1"
+        "tslib": "1.8.1"
     },
     "peerDependencies": {
-        "@pnp/common": "1.0.0-beta.11",
-        "@pnp/logging": "1.0.0-beta.11",
-        "@pnp/odata": "1.0.0-beta.11"
+        "@pnp/common": "1.0.0-rc.0",
+        "@pnp/logging": "1.0.0-rc.0",
+        "@pnp/odata": "1.0.0-rc.0"
     },
@@ -16,0 +16,0 @@ "author": {

readme.md

 ![SharePoint Patterns and Practices](https://devofficecdn.azureedge.net/media/Default/PnP/sppnp.png)
 
+The SharePoint Patterns and Practices client side libraries were created to help enable developers to do their best work, without worrying about the exact
+REST api details. Built with feedback from the community they represent a way to simplify your day-to-day dev cycle while relying on tested and proven
+patterns.
+
+Please use [http://aka.ms/sppnp](http://aka.ms/sppnp) for the latest updates around the whole *SharePoint Patterns and Practices (PnP) initiative*.
+
+## Source & Docs
+
 This code is managed within the [main pnp repo](https://github.com/pnp/pnp), please report issues and submit pull requests there.
 
+Please see the public site for [package documentation](https://pnp.github.io/pnp/).
+
 ### Code of Conduct
+
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[e-mail]](mailto:[e-mail]) with any additional questions or comments.
@@ -7,0 +18,0 @@

src/batch.d.ts

@@ -8,3 +8,2 @@ import { ODataBatch } from "@pnp/odata";
     constructor(baseUrl: string);
-    protected executeImpl(): Promise<void>;
     /**
@@ -15,3 +14,4 @@ * Parses the response from a batch request into an array of Response instances
      */
-    private _parseResponse(body);
+    static ParseResponse(body: string): Promise<Response[]>;
+    protected executeImpl(): Promise<void>;
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5012303

increased by0.24%

Lines of code

37029

increased by0.23%

Number of lines in readme file

22

increased by100%

Dependency changes

• + Added@pnp/common@1.0.0-rc.0(transitive)

• + Added@pnp/logging@1.0.0-rc.0(transitive)

• + Added@pnp/odata@1.0.0-rc.0(transitive)

• + Addedtslib@1.8.1(transitive)

• - Removed@pnp/common@1.0.0-beta.11(transitive)

• - Removed@pnp/logging@1.0.0-beta.11(transitive)

• - Removed@pnp/odata@1.0.0-beta.11(transitive)

• - Removedtslib@1.7.1(transitive)

• Updatedtslib@1.8.1