@zxncij2390/monorepo3 3.18.0

package/docs/sp/column-defaults.md

@@ -0,0 +1,241 @@
+# @pnp/sp/column-defaults
+
+The column defaults sub-module allows you to manage the default column values on a library or library folder.
+
+[![Selective Imports Banner](https://img.shields.io/badge/Selective%20Imports-informational.svg)](../concepts/selective-imports.md)
+
+## Get Folder Defaults
+
+You can get the default values for a specific folder as shown below:
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders/web";
+import "@pnp/sp/column-defaults";
+
+const sp = spfi(...);
+
+const defaults = await sp.web.getFolderByServerRelativePath("/sites/dev/DefaultColumnValues/fld_GHk5").getDefaultColumnValues();
+
+/*
+The resulting structure will have the form:
+
+[
+  {
+    "name": "{field internal name}",
+    "path": "/sites/dev/DefaultColumnValues/fld_GHk5",
+    "value": "{the default value}"
+  },
+  {
+    "name": "{field internal name}",
+    "path": "/sites/dev/DefaultColumnValues/fld_GHk5",
+    "value": "{the default value}"
+  }
+]
+*/
+```
+
+## Set Folder Defaults
+
+When setting the defaults for a folder you need to include the field's internal name and the value.
+
+>For more examples of other field types see the section [Pattern for setting defaults on various column types](#Pattern-for-setting-defaults-on-various-column-types)
+
+>_Note: Be very careful when setting the path as the site collection url is case sensitive_
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders/web";
+import "@pnp/sp/column-defaults";
+
+const sp = spfi(...);
+
+await sp.web.getFolderByServerRelativePath("/sites/dev/DefaultColumnValues/fld_GHk5").setDefaultColumnValues([{
+  name: "TextField",
+  value: "Something",
+},
+{
+  name: "NumberField",
+  value: 14,
+}]);
+```
+
+## Get Library Defaults
+
+You can also get all of the defaults for the entire library.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/lists/web";
+import "@pnp/sp/column-defaults";
+
+const sp = spfi(...);
+
+const defaults = await sp.web.lists.getByTitle("DefaultColumnValues").getDefaultColumnValues();
+
+/*
+The resulting structure will have the form:
+
+[
+  {
+    "name": "{field internal name}",
+    "path": "/sites/dev/DefaultColumnValues",
+    "value": "{the default value}"
+  },
+  {
+    "name": "{field internal name}",
+    "path": "/sites/dev/DefaultColumnValues/fld_GHk5",
+    "value": "{a different default value}"
+  }
+]
+*/
+```
+
+## Set Library Defaults
+
+You can also set the defaults for an entire library at once (root and all sub-folders). This may be helpful in provisioning a library or other scenarios. When setting the defaults for the entire library you must also include the path value with is the server relative path to the folder. When setting the defaults for a folder you need to include the field's internal name and the value.
+
+>For more examples of other field types see the section [Pattern for setting defaults on various column types](#Pattern-for-setting-defaults-on-various-column-types)
+
+>_Note: Be very careful when setting the path as the site collection url is case sensitive_
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/lists/web";
+import "@pnp/sp/column-defaults";
+
+const sp = spfi(...);
+
+await sp.web.lists.getByTitle("DefaultColumnValues").setDefaultColumnValues([{
+  name: "TextField",
+  path: "/sites/dev/DefaultColumnValues",
+  value: "#PnPjs Rocks!",
+}]);
+```
+
+## Clear Folder Defaults
+
+If you want to clear all of the folder defaults you can use the clear method:
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders/web";
+import "@pnp/sp/column-defaults";
+
+const sp = spfi(...);
+
+await sp.web.getFolderByServerRelativePath("/sites/dev/DefaultColumnValues/fld_GHk5").clearDefaultColumnValues();
+```
+
+## Clear Library Defaults
+
+If you need to clear all of the default column values in a library you can pass an empty array to the list's setDefaultColumnValues method.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/lists/web";
+import "@pnp/sp/column-defaults";
+
+const sp = spfi(...);
+
+await sp.web.lists.getByTitle("DefaultColumnValues").setDefaultColumnValues([]);
+```
+
+## Pattern for setting defaults on various column types
+
+The following is an example of the structure for setting the default column value when using the setDefaultColumnValues that covers the various field types.
+
+```TypeScript
+[{
+    // Text/Boolean/CurrencyDateTime/Choice/User
+    name: "TextField":
+    path: "/sites/dev/DefaultColumnValues",
+    value: "#PnPjs Rocks!",
+}, {
+    //Number
+    name: "NumberField",
+    path: "/sites/dev/DefaultColumnValues",
+    value: 42,
+}, {
+    //Date
+    name: "NumberField",
+    path: "/sites/dev/DefaultColumnValues",
+    value: "1900-01-01T00:00:00Z",
+}, {
+    //Date - Today
+    name: "NumberField",
+    path: "/sites/dev/DefaultColumnValues",
+    value: "[today]",
+}, {
+    //MultiChoice
+    name: "MultiChoiceField",
+    path: "/sites/dev/DefaultColumnValues",
+    value: ["Item 1", "Item 2"],
+}, {
+    //MultiChoice - single value
+    name: "MultiChoiceField",
+    path: "/sites/dev/DefaultColumnValues/folder2",
+    value: ["Item 1"],
+}, {
+    //Taxonomy - single value
+    name: "TaxonomyField",
+    path: "/sites/dev/DefaultColumnValues",
+    value: {
+        wssId:"-1",
+        termName: "TaxValueName",
+        termId: "924d2077-d5e3-4507-9f36-4a3655e74274"
+        }
+}, {
+    //Taxonomy - multiple value
+    name: "TaxonomyMultiField",
+    path: "/sites/dev/DefaultColumnValues",
+    value: [{
+        wssId:"-1",
+        termName: "TaxValueName",
+        termId: "924d2077-d5e3-4507-9f36-4a3655e74274"
+        },{
+        wssId:"-1",
+        termName: "TaxValueName2",
+        termId: "95d4c307-dde5-49d8-b861-392e145d94d3"
+        },]
+}]);
+```
+
+## Taxonomy Full Example
+
+This example shows fully how to get the taxonomy values and set them as a default column value using PnPjs.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+import "@pnp/sp/column-defaults";
+import "@pnp/sp/taxonomy";
+
+const sp = spfi(...);
+
+// get the term's info we want to use as the default
+const term = await sp.termStore.sets.getById("ea6fc521-d293-4f3d-9e84-f3a5bc0936ce").getTermById("775c9cf6-c3cd-4db9-8cfa-fc0aeefad93a")();
+
+// get the default term label
+const defLabel = term.labels.find(v => v.isDefault);
+
+// set the default value using -1, the term id, and the term's default label name
+await sp.web.lists.getByTitle("MetaDataDocLib").rootFolder.setDefaultColumnValues([{
+  name: "MetaDataColumnInternalName",
+  value: {
+      wssId: "-1",
+      termId: term.id,
+      termName: defLabel.name,
+  }
+}])
+
+// check that the defaults have updated
+const newDefaults = await sp.web.lists.getByTitle("MetaDataDocLib").getDefaultColumnValues();
+```

package/docs/sp/comments-likes.md

@@ -0,0 +1,302 @@
+# @pnp/sp/comments and likes
+
+Comments can be accessed through either IItem or IClientsidePage instances, though in slightly different ways. For information on loading [clientside pages](./clientside-pages.md) or [items](./items.md) please refer to those articles.
+
+_These APIs are currently in BETA and are subject to change or may not work on all tenants._
+
+[![Invokable Banner](https://img.shields.io/badge/Invokable-informational.svg)](../concepts/invokable.md) [![Selective Imports Banner](https://img.shields.io/badge/Selective%20Imports-informational.svg)](../concepts/selective-imports.md)  
+
+## ClientsidePage Comments
+
+The IClientsidePage interface has three methods to provide easier access to the comments for a page, without requiring that you load the item separately.
+
+### Add Comments
+
+You can add a comment using the addComment method as shown
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { CreateClientsidePage } from "@pnp/sp/clientside-pages";
+import "@pnp/sp/comments/clientside-page";
+import "@pnp/sp/webs";
+
+const sp = spfi(...);
+
+const page = await CreateClientsidePage(sp.web, "mypage", "My Page Title", "Article");
+// optionally publish the page first
+await page.save();
+
+//add a comment as text
+const comment = await page.addComment("A test comment");
+
+//or you can include the @mentions. html anchor required to include mention in text body.
+const mentionHtml = `<a data-sp-mention-user-id="test@contoso.com" href="mailto&#58;test@contoso.com.com" tabindex="-1">Test User</a>`;
+
+const commentInfo: Partial<ICommentInfo> = { text: `${mentionHtml} This is the test comment with at mentions`, 
+    mentions: [{ loginName: 'test@contoso.com', email: 'test@contoso.com', name: 'Test User' }], };
+const comment = await page.addComment(commentInfo);
+```
+
+### Get Page Comments
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { CreateClientsidePage } from "@pnp/sp/clientside-pages";
+import "@pnp/sp/comments/clientside-page";
+import "@pnp/sp/webs";
+
+const sp = spfi(...);
+
+const page = await CreateClientsidePage(sp.web, "mypage", "My Page Title", "Article");
+// optionally publish the page first
+await page.save();
+
+await page.addComment("A test comment");
+await page.addComment("A test comment");
+await page.addComment("A test comment");
+await page.addComment("A test comment");
+await page.addComment("A test comment");
+await page.addComment("A test comment");
+
+const comments = await page.getComments();
+```
+
+### enableComments & disableComments
+
+Used to control the availability of comments on a page
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { IClientsidePage } from "@pnp/sp/clientside-pages";
+// you need to import the comments sub-module or use the all preset
+import "@pnp/sp/comments/clientside-page";
+import "@pnp/sp/webs";
+
+const sp = spfi(...);
+
+// our page instance
+const page: IClientsidePage = await sp.web.loadClientsidePage("/sites/dev/sitepages/home.aspx");
+
+// turn on comments
+await page.enableComments();
+
+// turn off comments
+await page.disableComments();
+```
+
+### GetById
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { CreateClientsidePage } from "@pnp/sp/clientside-pages";
+import "@pnp/sp/comments/clientside-page";
+import "@pnp/sp/webs";
+
+const sp = spfi(...);
+
+const page = await CreateClientsidePage(sp.web, "mypage", "My Page Title", "Article");
+// optionally publish the page first
+await page.save();
+
+const comment = await page.addComment("A test comment");
+
+const commentData = await page.getCommentById(parseInt(comment.id, 10));
+```
+
+### Clear Comments
+
+## Item Comments
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/files/web";
+import "@pnp/sp/items";
+import "@pnp/sp/comments/item";
+
+const sp = spfi(...);
+
+const item = await sp.web.getFileByServerRelativePath("/sites/dev/SitePages/Test_8q5L.aspx").getItem();
+
+// as an example, or any of the below options
+await item.like();
+```
+
+The below examples use a variable named "item" which is taken to represent an IItem instance.
+
+## Comments
+
+### Get Item Comments
+
+```TypeScript
+const comments = await item.comments();
+```
+
+You can also get the comments merged with instances of the Comment class to immediately start accessing the properties and methods:
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { IComments } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const comments: IComments = await item.comments();
+
+// these will be Comment instances in the array
+comments[0].replies.add({ text: "#PnPjs is pretty ok!" });
+
+//load the top 20 replies and comments for an item including likedBy information
+const comments = await item.comments.expand("replies", "likedBy", "replies/likedBy").top(20)();
+```
+
+### Add Comment
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { ICommentInfo } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+// you can add a comment as a string
+const comment = await item.comments.add("string comment");
+
+
+```
+
+### Delete a Comment
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { IComments } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const comments: IComments = await item.comments();
+
+// these will be Comment instances in the array
+comments[0].delete()
+```
+
+### Like Comment
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { IComments } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const comments: IComments = await item.comments();
+
+// these will be Comment instances in the array
+comments[0].like();
+```
+
+### Unlike Comment
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { IComments } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const comments: IComments = await item.comments();
+
+comments[0].unlike()
+```
+
+### Reply to a Comment
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { IComments } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const comments: IComments = await item.comments();
+
+const comment = await comments[0].comments.add({ text: "#PnPjs is pretty ok!" });
+```
+
+### Load Replies to a Comment
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { IComments } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const comments: IComments = await item.comments();
+
+const replies = await comments[0].replies();
+```
+
+## Like/Unlike
+
+You can like/unlike client-side pages, items, and comments on items. See above for how to like or unlike a comment. Below you can see how to like and unlike an items, as well as get the liked by data.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/lists";
+import "@pnp/sp/items";
+import "@pnp/sp/comments";
+import { ILikeData, ILikedByInformation } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const item = sp.web.lists.getByTitle("PnP List").items.getById(1);
+
+// like an item
+await item.like();
+
+// unlike an item
+await item.unlike();
+
+// get the liked by information
+const likedByInfo: ILikedByInformation = await item.getLikedByInformation();
+```
+
+To like/unlike a client-side page and get liked by information.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import { ILikedByInformation } from "@pnp/sp/comments";
+import { IClientsidePage } from "@pnp/sp/clientside-pages";
+
+import "@pnp/sp/webs";
+import "@pnp/sp/clientside-pages";
+import "@pnp/sp/comments/clientside-page";
+
+const sp = spfi(...);
+
+const page: IClientsidePage = await sp.web.loadClientsidePage("/sites/dev/sitepages/home.aspx");
+
+// like a page
+await page.like();
+
+// unlike a page
+await page.unlike();
+
+// get the liked by information
+const likedByInfo: ILikedByInformation = await page.getLikedByInformation();
+```
+
+## Rate
+
+You can rate list items with a numeric values between 1 and 5.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/lists";
+import "@pnp/sp/items";
+import "@pnp/sp/comments";
+import { ILikeData, ILikedByInformation } from "@pnp/sp/comments";
+
+const sp = spfi(...);
+
+const item = sp.web.lists.getByTitle("PnP List").items.getById(1);
+
+// rate an item
+await item.rate(2);
+```

package/docs/sp/content-types.md

@@ -0,0 +1,131 @@
+# @pnp/sp/content-types
+
+Content Types are used to define sets of columns in SharePoint.
+
+## IContentTypes
+
+[![Invokable Banner](https://img.shields.io/badge/Invokable-informational.svg)](../concepts/invokable.md) [![Selective Imports Banner](https://img.shields.io/badge/Selective%20Imports-informational.svg)](../concepts/selective-imports.md)  
+
+### Add an existing Content Type to a collection
+
+The following example shows how to add the built in Picture Content Type to the Documents library.
+
+```TypeScript
+const sp = spfi(...);
+
+sp.web.lists.getByTitle("Documents").contentTypes.addAvailableContentType("0x010102");
+```
+
+### Get a Content Type by Id
+
+```TypeScript
+import { IContentType } from "@pnp/sp/content-types";
+
+const sp = spfi(...);
+
+const d: IContentType = await sp.web.contentTypes.getById("0x01")();
+
+// log content type name to console
+console.log(d.name);
+```
+
+### Update a Content Type
+
+```Typescript
+import { IContentType } from "@pnp/sp/content-types";
+
+const sp = spfi(...);
+
+await sp.web.contentTypes.getById("0x01").update({EditFormClientSideComponentId: "9dfdb916-7380-4b69-8d92-bc711f5fa339"});
+```
+
+### Add a new Content Type
+
+To add a new Content Type to a collection, parameters id and name are required. For more information on creating content type IDs reference the [Microsoft Documentation](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v=office.14)). While this documentation references SharePoint 2010 the structure of the IDs has not changed.
+
+```TypeScript
+const sp = spfi(...);
+
+sp.web.contentTypes.add("0x01008D19F38845B0884EBEBE239FDF359184", "My Content Type");
+```
+
+It is also possible to provide a description and group parameter. For other settings, we can use the parameter named 'additionalSettings' which is a TypedHash, meaning you can send whatever properties you'd like in the body (provided that the property is supported by the SharePoint API).
+
+```TypeScript
+const sp = spfi(...);
+
+//Adding a content type with id, name, description, group and setting it to read only mode (using additionalsettings)
+sp.web.contentTypes.add("0x01008D19F38845B0884EBEBE239FDF359184", "My Content Type", "This is my content type.", "_PnP Content Types", { ReadOnly: true });
+```
+
+## IContentType
+
+[![Invokable Banner](https://img.shields.io/badge/Invokable-informational.svg)](../concepts/invokable.md) [![Selective Imports Banner](https://img.shields.io/badge/Selective%20Imports-informational.svg)](../concepts/selective-imports.md)  
+
+### Get the field links
+
+Use this method to get a collection containing all the field links (SP.FieldLink) for a Content Type.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { ContentType, IContentType } from "@pnp/sp/content-types";
+
+const sp = spfi(...);
+
+// get field links from built in Content Type Document (Id: "0x0101")
+const d = await sp.web.contentTypes.getById("0x0101").fieldLinks();
+
+// log collection of fieldlinks to console
+console.log(d);
+```
+
+### Get Content Type fields
+
+To get a collection with all fields on the Content Type, simply use this method.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { ContentType, IContentType } from "@pnp/sp/content-types";
+
+const sp = spfi(...);
+
+// get fields from built in Content Type Document (Id: "0x0101")
+const d = await sp.web.contentTypes.getById("0x0101").fields();
+
+// log collection of fields to console
+console.log(d);
+```
+
+### Get parent Content Type
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { ContentType, IContentType } from "@pnp/sp/content-types";
+
+const sp = spfi(...);
+
+// get parent Content Type from built in Content Type Document (Id: "0x0101")
+const d = await sp.web.contentTypes.getById("0x0101").parent();
+
+// log name of parent Content Type to console
+console.log(d.Name)
+```
+
+### Get Content Type Workflow associations
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { ContentType, IContentType } from "@pnp/sp/content-types";
+
+const sp = spfi(...);
+
+// get workflow associations from built in Content Type Document (Id: "0x0101")
+const d = await sp.web.contentTypes.getById("0x0101").workflowAssociations();
+
+// log collection of workflow associations to console
+console.log(d);
+```