@zxncij2390/monorepo3 3.18.0

package/docs/sp/folders.md

@@ -0,0 +1,532 @@
+# @pnp/sp/folders
+
+Folders serve as a container for your files and list items.
+
+## IFolders
+
+[![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)  
+
+Represents a collection of folders. SharePoint webs, lists, and list items have a collection of folders under their properties.
+
+### Get folders collection for various SharePoint objects
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/items";
+import "@pnp/sp/folders";
+import "@pnp/sp/lists";
+
+const sp = spfi(...);
+
+// gets web's folders
+const webFolders = await sp.web.folders();
+
+// gets list's folders
+const listFolders = await sp.web.lists.getByTitle("My List").rootFolder.folders();
+
+// gets item's folders
+const itemFolders = await sp.web.lists.getByTitle("My List").items.getById(1).folder.folders();
+```
+
+### folderFromServerRelativePath
+
+_Added in 3.3.0_
+
+Utility method allowing you to get an IFolder reference using any SPQueryable as a base and the server relative path to the folder. Helpful when you do not have convenient access to an IWeb to use `getFolderByServerRelativePath`.
+
+```TS
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { folderFromServerRelativePath } from "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const url = "/sites/dev/documents/folder4";
+
+// file is an IFile and supports all the file operations
+const folder = folderFromServerRelativePath(sp.web, url);
+```
+
+### folderFromAbsolutePath
+
+_Added in 3.8.0_
+
+Utility method allowing you to get an IFile reference using any SPQueryable as a base and an absolute path to the file.
+
+> Works across site collections within the same tenant
+
+```TS
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { folderFromAbsolutePath } from "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const url = "https://tenant.sharepoint.com/sites/dev/documents/folder";
+
+// file is an IFile and supports all the file operations
+const folder = folderFromAbsolutePath(sp.web, url);
+
+// for example
+const folderInfo = await folder();
+```
+
+### folderFromPath
+
+_Added in 3.8.0_
+
+Utility method allowing you to get an IFolder reference using any SPQueryable as a base and an absolute OR server relative path to the file.
+
+> Works across site collections within the same tenant
+
+```TS
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import { folderFromPath } from "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const url = "https://tenant.sharepoint.com/sites/dev/documents/folder";
+
+// file is an IFile and supports all the file operations
+const folder = folderFromPath(sp.web, url);
+
+// for example
+const folderInfo = await folder();
+
+const url2 = "/sites/dev/documents/folder";
+
+// file is an IFile and supports all the file operations
+const folder2 = folderFromPath(sp.web, url2);
+
+// for example
+const folderInfo2 = await folder2();
+```
+
+### add
+
+Adds a new folder to collection of folders
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+// creates a new folder for web with specified url
+const folderAddResult = await sp.web.folders.addUsingPath("folder url");
+```
+
+### getByUrl
+
+Gets a folder instance from a collection by folder's name
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const folder = await sp.web.folders.getByUrl("folder name")();
+```
+
+## IFolder  
+
+Represents an instance of a SharePoint folder.
+
+[![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 a folder object associated with different SharePoint artifacts (web, list, list item)
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+import "@pnp/sp/lists";
+import "@pnp/sp/items";
+
+const sp = spfi(...);
+
+// web's folder
+const rootFolder = await sp.web.rootFolder();
+
+// list's folder
+const listRootFolder = await sp.web.lists.getByTitle("234").rootFolder();
+
+// item's folder
+const itemFolder = await sp.web.lists.getByTitle("234").items.getById(1).folder();
+```
+
+### getItem
+
+Gets list item associated with a folder
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const folderItem = await sp.web.rootFolder.folders.getByUrl("SiteAssets").folders.getByUrl("My Folder").getItem();
+```
+
+### storageMetrics
+
+_Added in 3.8.0_
+
+Gets a set of metrics describing the total file size contained in the folder.
+
+```TS
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const metrics = await sp.web.getFolderByServerRelativePath("/sites/dev/shared documents/target").storageMetrics();
+
+// you can also select specific metrics if desired:
+const metrics2 = await sp.web.getFolderByServerRelativePath("/sites/dev/shared documents/target").storageMetrics.select("TotalSize")();
+```
+
+### move by path
+
+It's possible to move a folder to a new destination within the same or a different site collection  
+
+> If you change the filename during the move operation this is considered an "edit" and the file's modified information will be updated regardless of the "RetainEditorAndModifiedOnMove" setting.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+// destination is a server-relative url of a new folder
+const destinationUrl = `/sites/my-site/SiteAssets/new-folder`;
+
+await sp.web.rootFolder.folders.getByUrl("SiteAssets").folders.getByUrl("My Folder").moveByPath(destinationUrl, true);
+```  
+
+_Added in 3.8.0_
+
+You can also supply a set of detailed options to better control the move process:
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+// destination is a server-relative url of a new file
+const destinationUrl = `/sites/dev2/SiteAssets/folder`;
+
+await sp.web.getFolderByServerRelativePath("/sites/dev/Shared Documents/folder").moveByPath(destinationUrl, {
+    KeepBoth: false,
+    RetainEditorAndModifiedOnMove: true,
+    ShouldBypassSharedLocks: false,
+});
+```
+
+### copy by path
+
+It's possible to copy a folder to a new destination within the same or a different site collection  
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+// destination is a server-relative url of a new folder
+const destinationUrl = `/sites/my-site/SiteAssets/new-folder`;
+
+await sp.web.rootFolder.folders.getByUrl("SiteAssets").folders.getByUrl("My Folder").copyByPath(destinationUrl, true);
+```  
+
+_Added in 3.8.0_
+
+You can also supply a set of detailed options to better control the copy process:
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+// destination is a server-relative url of a new file
+const destinationUrl = `/sites/dev2/SiteAssets/folder`;
+
+await sp.web.getFolderByServerRelativePath("/sites/dev/Shared Documents/folder").copyByPath(destinationUrl, false, {
+    KeepBoth: false,
+    ResetAuthorAndCreatedOnCopy: true,
+    ShouldBypassSharedLocks: false,
+});
+```
+
+### delete
+
+Deletes a folder
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+await sp.web.rootFolder.folders.getByUrl("My Folder").delete();
+```  
+
+### delete with params
+
+Deletes a folder with options
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+await sp.web.rootFolder.folders.getByUrl("My Folder").deleteWithParams({
+                BypassSharedLock: true,
+                DeleteIfEmpty: true,
+            });
+```  
+
+### recycle
+
+Recycles a folder
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+await sp.web.rootFolder.folders.getByUrl("My Folder").recycle();
+```  
+
+### serverRelativeUrl
+
+Gets folder's server relative url
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const relUrl = await sp.web.rootFolder.folders.getByUrl("SiteAssets").select('ServerRelativeUrl')();
+```  
+
+### update
+
+Updates folder's properties
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+await sp.web.getFolderByServerRelativePath("Shared Documents/Folder2").update({
+        "Name": "New name",
+    });
+```
+
+### contentTypeOrder
+
+Gets content type order of a folder
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const order = await sp.web.getFolderByServerRelativePath("Shared Documents").select('contentTypeOrder')();
+```
+
+### folders
+
+Gets all child folders associated with the current folder
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const folders = await sp.web.rootFolder.folders();
+```
+
+### files
+
+Gets all files inside a folder
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+import "@pnp/sp/files/folder";
+
+const sp = spfi(...);
+
+const files = await sp.web.getFolderByServerRelativePath("Shared Documents").files();
+```
+
+### listItemAllFields
+
+Gets this folder's list item field values
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const itemFields = await sp.web.getFolderByServerRelativePath("Shared Documents/My Folder").listItemAllFields();
+```
+
+### parentFolder
+
+Gets the parent folder, if available
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const parentFolder = await sp.web.getFolderByServerRelativePath("Shared Documents/My Folder").parentFolder();
+```
+
+### properties
+
+Gets this folder's properties
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const properties = await sp.web.getFolderByServerRelativePath("Shared Documents/Folder2").properties();
+```
+
+### uniqueContentTypeOrder
+
+Gets a value that specifies the content type order.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const contentTypeOrder = await sp.web.getFolderByServerRelativePath("Shared Documents/Folder2").select('uniqueContentTypeOrder')();
+```
+
+### Rename a folder
+
+You can rename a folder by updating `FileLeafRef` property:
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const folder = sp.web.getFolderByServerRelativePath("Shared Documents/My Folder");
+
+const item = await folder.getItem();
+const result = await item.update({ FileLeafRef: "Folder2" });
+```
+
+### Create a folder with custom content type  
+
+Below code creates a new folder under Document library and assigns custom folder content type to a newly created folder. Additionally it sets a field of a custom folder content type.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/items";
+import "@pnp/sp/folders";
+import "@pnp/sp/lists";
+
+const sp = spfi(...);
+
+const newFolderResult = await sp.web.rootFolder.folders.getByUrl("Shared Documents").folders.addUsingPath("My New Folder");
+const item = await newFolderResult.folder.listItemAllFields();
+
+await sp.web.lists.getByTitle("Documents").items.getById(item.ID).update({
+    ContentTypeId: "0x0120001E76ED75A3E3F3408811F0BF56C4CDDD",
+    MyFolderField: "field value",
+    Title: "My New Folder",
+});
+```
+
+### addSubFolderUsingPath
+
+You can use the addSubFolderUsingPath method to add a folder with some special chars supported
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+import { IFolder } from "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+// add a folder to site assets
+const folder: IFolder = await sp.web.rootFolder.folders.getByUrl("SiteAssets").addSubFolderUsingPath("folder name");
+```
+
+### getFolderById
+
+You can get a folder by Id from a web.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+import { IFolder } from "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const folder: IFolder = sp.web.getFolderById("2b281c7b-ece9-4b76-82f9-f5cf5e152ba0");
+```
+
+### getParentInfos
+
+Gets information about folder, including details about the parent list, parent list root folder, and parent web.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/webs";
+import "@pnp/sp/folders";
+
+const sp = spfi(...);
+
+const folder: IFolder = sp.web.getFolderById("2b281c7b-ece9-4b76-82f9-f5cf5e152ba0");
+await folder.getParentInfos();
+```  

package/docs/sp/forms.md

@@ -0,0 +1,22 @@
+# @pnp/sp/forms
+
+Forms in SharePoint are the Display, New, and Edit forms associated with a list.
+
+## IForms
+
+[![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 Form by Id
+
+Gets a form from the collection by id (guid). Note that the library will handle a guid formatted with curly braces (i.e. '{03b05ff4-d95d-45ed-841d-3855f77a2483}') as well as without curly braces (i.e. '03b05ff4-d95d-45ed-841d-3855f77a2483'). The Id parameter is also case insensitive.
+
+```TypeScript
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/forms";
+import "@pnp/sp/lists";
+
+const sp = spfi(...);
+
+// get the field by Id for web
+const form = sp.web.lists.getByTitle("Documents").forms.getById("{c4486774-f1e2-4804-96f3-91edf3e22a19}")();
+```

package/docs/sp/groupSiteManager.md

@@ -0,0 +1,40 @@
+
+## @pnp/sp/groupsitemanager
+
+The `@pnp/sp/groupsitemanager` package represents calls to `_api/groupsitemanager` endpoint and is accessible from any site url.
+
+```TS
+import { spfi } from "@pnp/sp";
+import "@pnp/sp/groupsitemanager";
+
+const sp = spfi(...);
+
+// call method to check if the current user can create Microsoft 365 groups
+const isUserAllowed = await sp.groupSiteManager.canUserCreateGroup();
+
+// call method to delete a group-connected site
+await sp.groupSiteManager.delete("https://contoso.sharepoint.com/sites/hrteam");
+
+//call method to gets labels configured for the tenant
+const orgLabels = await sp.groupSiteManager.getAllOrgLabels(0);
+
+//call method to get information regarding site groupification configuration for the current site context
+const groupCreationContext = await sp.groupSiteManager.getGroupCreationContext();
+
+//call method to get information regarding site groupification configuration for the current site context
+const siteData = await sp.groupSiteManager.getGroupSiteConversionData();
+
+// call method to get teams membership for a user
+const userTeams = await sp.groupSiteManager.getUserTeamConnectedMemberGroups("meganb@contoso.onmicrosoft.com");
+
+// call method to get shared channel memberhsip for user
+const sharedChannels = await sp.groupSiteManager.getUserSharedChannelMemberGroups("meganb@contoso.onmicrosoft.com");
+
+//call method to get valid site url from Alias
+const siteUrl = await sp.groupSiteManager.getValidSiteUrlFromAlias("contoso");
+
+//call method to check if teamify prompt is hidden
+const isTeamifyPromptHidden = await sp.groupSiteManager.isTeamifyPromptHidden("https://contoso.sharepoint.com/sites/hrteam");
+```
+
+> For more information on the methods available and how to use them, please review the code comments in the source.