Merge branch 'Varuuna-dev' into dev

Author: estruyf

src/controls/securityTrimmedControl/ISecurityTrimmedControlProps.ts

@@ -25,4 +25,12 @@ export interface ISecurityTrimmedControlProps {
    * The relative URL of the list or library. Required when you want to check permissions on remote list.
    */
   relativeLibOrListUrl?: string;
+  /**
+   * Optional. Specify the name of a folder to check the user permissions against. Will be overridden if itemId is present.
+   */
+  folderPath?: string;
+  /**
+   * Optional. Specify the ID of the item to check the user permissions against. Takes precedence over folder.
+   */
+  itemId?: number;
 }

src/controls/securityTrimmedControl/PermissionLevel.ts

@@ -17,5 +17,13 @@ export enum PermissionLevel {
   /**
    * Checks permissions on the specified list/library URL in combination with the site URL
    */
-  remoteListOrLib
+  remoteListOrLib,
+  /**
+   * Check permissions on a specific item in a list/library
+   */
+  remoteListItem,
+  /**
+   * Check permissions on a specific folder
+   */
+  remoteFolder
 }

src/controls/securityTrimmedControl/SecurityTrimmedControl.tsx

@@ -28,9 +28,11 @@ export class SecurityTrimmedControl extends React.Component<ISecurityTrimmedCont
   public componentDidUpdate(prevProps: ISecurityTrimmedControlProps, prevState: ISecurityTrimmedControlState): void {
     // Check permissions only if necessary
     if (prevProps.level !== this.props.level ||
-        prevProps.permissions !== this.props.permissions ||
-        prevProps.relativeLibOrListUrl !== this.props.relativeLibOrListUrl ||
-        prevProps.remoteSiteUrl !== this.props.remoteSiteUrl) {
+      prevProps.permissions !== this.props.permissions ||
+      prevProps.relativeLibOrListUrl !== this.props.relativeLibOrListUrl ||
+      prevProps.remoteSiteUrl !== this.props.remoteSiteUrl ||
+      prevProps.folderPath !== this.props.folderPath ||
+      prevProps.itemId !== this.props.itemId) {
       this.checkPermissions();
     }
   }
@@ -60,6 +62,10 @@ export class SecurityTrimmedControl extends React.Component<ISecurityTrimmedCont
     } else if (level === PermissionLevel.remoteListOrLib) {
       // Check permissions on remote list/library
       this.checkRemoteListOrLibPermissions();
+    } else if (level === PermissionLevel.remoteListItem) {
+      this.checkRemoteListItem();
+    } else if (level === PermissionLevel.remoteFolder) {
+      this.checkRemoteFolder();
     }
   }
 
@@ -110,41 +116,76 @@ export class SecurityTrimmedControl extends React.Component<ISecurityTrimmedCont
    * Check the user its permissions on the remote list or library
    */
   private async checkRemoteListOrLibPermissions() {
-    const { context, remoteSiteUrl, relativeLibOrListUrl, permissions } = this.props;
+    const { remoteSiteUrl, relativeLibOrListUrl, permissions } = this.props;
     // Check if all properties are provided
     if (remoteSiteUrl && relativeLibOrListUrl && permissions) {
       const apiUrl = `${remoteSiteUrl}/_api/web/GetList(@listUrl)/EffectiveBasePermissions?@listUrl='${encodeURIComponent(relativeLibOrListUrl)}'`;
-      const result = await context.spHttpClient.get(apiUrl, SPHttpClient.configurations.v1).then(data => data.json());
-      // Check if a result was retrieved
-      if (result) {
-        // Check if an error was retrieved
-        if (result.error) {
-          // Do not allow rendering when there was an error
-          this.setState({
-            allowRender: false
-          });
-          console.error(`Error retrieved while checking user's remote list or library permissions.`);
-          return;
-        }
+      const hasPermissions = await this.checkRemotePermissions(apiUrl);
+      this.setState({
+        allowRender: hasPermissions
+      });
+    }
+  }
 
-        // Check the result high and low value are returned
-        if (typeof result.High !== "undefined" && typeof result.Low !== "undefined") {
-          // Create the permission mask
-          const permission = new SPPermission(result);
-          const hasPermissions = permission.hasAllPermissions(...permissions);
+  /**
+   * Check permissions on item level
+   */
+  private async checkRemoteListItem() {
+    const { remoteSiteUrl, relativeLibOrListUrl, permissions, itemId } = this.props;
+    // Check if all properties are provided
+    if (remoteSiteUrl && relativeLibOrListUrl && permissions && itemId) {
+      const apiUrl = `${remoteSiteUrl}/_api/web/GetList(@listUrl)/Items(${itemId})/EffectiveBasePermissions?@listUrl='${encodeURIComponent(relativeLibOrListUrl)}'`;
+      const hasPermissions = await this.checkRemotePermissions(apiUrl);
+      this.setState({
+        allowRender: hasPermissions
+      });
+    }
+  }
 
-          this.setState({
-            allowRender: hasPermissions
-          });
-          return;
-        }
-      } else {
-        this.setState({
-          allowRender: false
-        });
-        console.error(`No result value was retrieved when checking the user's remote list or library permissions.`);
-        return;
+  /**
+   * Check permissions on folder
+   */
+  private async checkRemoteFolder() {
+    const { remoteSiteUrl, relativeLibOrListUrl, permissions, folderPath } = this.props;
+    // Check if all properties are provided
+    if (remoteSiteUrl && relativeLibOrListUrl && permissions && folderPath) {
+      const folderByServerRelativeUrl: string = `${encodeURIComponent(relativeLibOrListUrl)}/${encodeURIComponent(folderPath)}`;
+      const apiUrl = `${remoteSiteUrl}/_api/web/GetFolderByServerRelativeUrl(@folderByServerRelativeUrl)/ListItemAllFields/EffectiveBasePermissions?@folderByServerRelativeUrl='${folderByServerRelativeUrl}'`;
+      const hasPermissions = await this.checkRemotePermissions(apiUrl);
+      this.setState({
+        allowRender: hasPermissions
+      });
+    }
+  }
+
+  /**
+   * Check the permissions
+   *
+   * @param apiUrl
+   */
+  private async checkRemotePermissions(apiUrl: string) {
+    const { context, permissions } = this.props;
+    const data = await context.spHttpClient.get(apiUrl, SPHttpClient.configurations.v1);
+    // Check if a result was retrieved
+    if (data && data.ok) {
+      const result = await data.json();
+      // Check if an error was retrieved
+      if (result.error) {
+        // Do not allow rendering when there was an error
+        console.error(`Error retrieved while checking permissions`);
+        return false;
+      }
+
+      // Check the result high and low value are returned
+      if (typeof result.High !== "undefined" && typeof result.Low !== "undefined") {
+        // Create the permission mask
+        const permission = new SPPermission(result);
+        const hasPermissions = permission.hasAllPermissions(...permissions);
+        return hasPermissions;
       }
+    } else {
+      console.error(`No result value was retrieved when checking the user's permissions.`);
+      return false;
     }
   }