Merge pull request #187 from gunjandatta/gdatta

Added hasPermissions Helper Method

build/helper/methods.js

@@ -51,6 +51,38 @@ exports.createDocSet = function (name, listName, webUrl) {
         }, reject);
     });
 };
+/**
+ * Determines if the user has permissions, based on the permission kind value
+ */
+exports.hasPermissions = function (permissionMask, permissions) {
+    if (permissions === void 0) { permissions = []; }
+    var hasPermissions = false;
+    // Set the permissions
+    var requestedPermissions = typeof (permissions) === "number" ? [permissions] : permissions;
+    // Ensure the base permissions exist
+    if (SP && SP.BasePermissions) {
+        // Initialize the base permissions from the value
+        var basePermissions = new SP.BasePermissions();
+        basePermissions.initPropertiesFromJson(permissionMask);
+        // Default the permission flag
+        hasPermissions = true;
+        // Parse the requested permissions
+        for (var i = 0; i < requestedPermissions.length; i++) {
+            // See if the user has permissions
+            if (!basePermissions.has(requestedPermissions[i])) {
+                // Set the flag and break from the loop
+                hasPermissions = false;
+                break;
+            }
+        }
+    }
+    else {
+        // Log
+        console.info("[gd-sprest] The 'SP' core library is not available.");
+    }
+    // Return the value
+    return hasPermissions;
+};
 /**
  * Convert a JSON string to a base object
  */

build/mapper/sptypes.js

@@ -17,6 +17,7 @@ exports.BasePermissionTypes = {
     ManagePersonalViews: 10,
     ManageLists: 12,
     ViewFormPages: 13,
+    AnonymousSearchAccessList: 14,
     Open: 17,
     ViewPages: 18,
     AddAndCustomizePages: 19,
@@ -32,6 +33,7 @@ exports.BasePermissionTypes = {
     AddDelPrivateWebParts: 29,
     UpdatePersonalWebParts: 30,
     ManageWeb: 31,
+    AnonymousSearchAccessWebLists: 32,
     UseClientIntegration: 37,
     UseRemoteAPIs: 38,
     ManageAlerts: 39,

build/rest.js

@@ -7,7 +7,7 @@ var Mapper = require("./mapper");
  * SharePoint REST Library
  */
 exports.$REST = {
-    __ver: 4.35,
+    __ver: 4.36,
     AppContext: function (siteUrl) { return Lib.Site.getAppContext(siteUrl); },
     ContextInfo: Lib.ContextInfo,
     DefaultRequestToHostFl: false,
@@ -18,6 +18,7 @@ exports.$REST = {
         createDocSet: Helper.createDocSet,
         Executor: Helper.Executor,
         FieldSchemaXML: Helper.FieldSchemaXML,
+        hasPermissions: Helper.hasPermissions,
         JSLink: Helper.JSLink,
         ListForm: Helper.ListForm,
         ListFormField: Helper.ListFormField,

dist/gd-sprest.d.ts

@@ -32,6 +32,7 @@ declare module 'gd-sprest' {
 }
 
 declare module 'gd-sprest/helper/types/helper' {
+    import { SP } from "gd-sprest-def";
     import * as HelperTypes from "gd-sprest/helper/types";
     import * as MapperTypes from "gd-sprest/mapper/types";
     import * as UtilTypes from "gd-sprest/utils/types";
@@ -70,6 +71,11 @@ declare module 'gd-sprest/helper/types/helper' {
                 */
             FieldSchemaXML: (fieldInfo: HelperTypes.IFieldInfo) => PromiseLike<string>;
 
+            /**
+                * Determines if the user has permissions, based on the permission kind value
+                */
+            hasPermissions(permissionMask: SP.BasePermissions, permissions: Array<number> | number): boolean;
+
             /**
                 * Helper class for implementing JSLink solutions
                 */
@@ -4805,6 +4811,8 @@ declare module 'gd-sprest/mapper/types/socialFeed' {
 }
 
 declare module 'gd-sprest/mapper/types/sptypes' {
+    import { SP } from "gd-sprest-def";
+
     /**
         * Base Permission Types
         */
@@ -4813,6 +4821,8 @@ declare module 'gd-sprest/mapper/types/sptypes' {
             AddAndCustomizePages: number,
             AddDelPrivateWebParts: number,
             AddListItems: number,
+            AnonymousSearchAccessList: number,
+            AnonymousSearchAccessWebLists: number,
             ApplyStyleSheets: number,
             ApplyThemeAndBorder: number,
             ApproveItems: number,
@@ -4847,6 +4857,13 @@ declare module 'gd-sprest/mapper/types/sptypes' {
             ViewVersions: number
     }
 
+    /**
+        * Base Permission Result
+        */
+    export interface IGetUserEffectivePermissionsResult {
+            GetUserEffectivePermissions: SP.BasePermissions
+    }
+
     /**
         * Calendar Types
         */

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gd-sprest",
-  "version": "4.3.5",
+  "version": "4.3.6",
   "description": "An easy way to develop against the SharePoint REST API.",
   "author": "Gunjan Datta <[email protected]> (https://gunjandatta.github.io)",
   "license": "<LICENSE>",

src/helper/methods.ts

@@ -2,6 +2,7 @@ import { Web } from "../lib";
 import { IListItemResult } from "../mapper/types";
 import { Base } from "../utils";
 import { IRequest } from "./types";
+declare var SP;
 
 /**
  * Creates a document set item.
@@ -53,6 +54,41 @@ export const createDocSet = (name: string, listName: string, webUrl?: string): P
     });
 }
 
+/**
+ * Determines if the user has permissions, based on the permission kind value
+ */
+export const hasPermissions = (permissionMask: any, permissions: Array<number> | number = []): boolean => {
+    let hasPermissions = false;
+
+    // Set the permissions
+    let requestedPermissions = typeof (permissions) === "number" ? [permissions] : permissions;
+
+    // Ensure the base permissions exist
+    if (SP && SP.BasePermissions) {
+        // Initialize the base permissions from the value
+        let basePermissions = new SP.BasePermissions();
+        basePermissions.initPropertiesFromJson(permissionMask);
+
+        // Default the permission flag
+        hasPermissions = true;
+
+        // Parse the requested permissions
+        for (let i = 0; i < requestedPermissions.length; i++) {
+            // See if the user has permissions
+            if (!basePermissions.has(requestedPermissions[i])) {
+                // Set the flag and break from the loop
+                hasPermissions = false;
+                break;
+            }
+        }
+    } else {
+        // Log
+        console.info("[gd-sprest] The 'SP' core library is not available.");
+    }
+
+    // Return the value
+    return hasPermissions;
+}
 
 /**
  * Convert a JSON string to a base object

src/helper/types/helper.d.ts

@@ -1,3 +1,4 @@
+import { SP } from "gd-sprest-def";
 import * as HelperTypes from ".";
 import * as MapperTypes from "../../mapper/types";
 import * as UtilTypes from "../../utils/types";
@@ -36,6 +37,11 @@ export interface IHelper {
      */
     FieldSchemaXML: (fieldInfo: HelperTypes.IFieldInfo) => PromiseLike<string>;
 
+    /**
+     * Determines if the user has permissions, based on the permission kind value
+     */
+    hasPermissions(permissionMask: SP.BasePermissions, permissions: Array<number> | number): boolean;
+
     /**
      * Helper class for implementing JSLink solutions
      */

src/mapper/sptypes.ts

@@ -17,6 +17,7 @@ export const BasePermissionTypes: SPTypes.IBasePermissionTypes = {
     ManagePersonalViews: 10,
     ManageLists: 12,
     ViewFormPages: 13,
+    AnonymousSearchAccessList: 14,
     Open: 17,
     ViewPages: 18,
     AddAndCustomizePages: 19,
@@ -32,6 +33,7 @@ export const BasePermissionTypes: SPTypes.IBasePermissionTypes = {
     AddDelPrivateWebParts: 29,
     UpdatePersonalWebParts: 30,
     ManageWeb: 31,
+    AnonymousSearchAccessWebLists: 32,
     UseClientIntegration: 37,
     UseRemoteAPIs: 38,
     ManageAlerts: 39,

src/mapper/types/sptypes.d.ts

@@ -1,3 +1,5 @@
+import { SP } from "gd-sprest-def";
+
 /**
  * Base Permission Types
  */
@@ -6,6 +8,8 @@ export type IBasePermissionTypes = {
     AddAndCustomizePages: number,
     AddDelPrivateWebParts: number,
     AddListItems: number,
+    AnonymousSearchAccessList: number,
+    AnonymousSearchAccessWebLists: number,
     ApplyStyleSheets: number,
     ApplyThemeAndBorder: number,
     ApproveItems: number,
@@ -40,6 +44,13 @@ export type IBasePermissionTypes = {
     ViewVersions: number
 }
 
+/**
+ * Base Permission Result
+ */
+export interface IGetUserEffectivePermissionsResult {
+    GetUserEffectivePermissions: SP.BasePermissions
+}
+
 /**
  * Calendar Types
  */

src/rest.ts

@@ -7,7 +7,7 @@ import { IREST } from "./rest.d";
  * SharePoint REST Library
  */
 export const $REST: IREST = {
-    __ver: 4.35,
+    __ver: 4.36,
     AppContext: (siteUrl: string) => { return Lib.Site.getAppContext(siteUrl); },
     ContextInfo: Lib.ContextInfo,
     DefaultRequestToHostFl: false,
@@ -18,6 +18,7 @@ export const $REST: IREST = {
         createDocSet: Helper.createDocSet,
         Executor: Helper.Executor,
         FieldSchemaXML: Helper.FieldSchemaXML,
+        hasPermissions: Helper.hasPermissions,
         JSLink: Helper.JSLink,
         ListForm: Helper.ListForm,
         ListFormField: Helper.ListFormField,

test/test.ts

@@ -1,15 +1,19 @@
 import {
-    $REST,
-    Helper
-} from "../dist/gd-sprest";
+    $REST
+} from "../src";
+
+$REST.Web().getUserEffectivePermissions("").execute(r => {
+    let h = r.GetUserEffectivePermissions.High;
+});
+
+$REST.List("").execute(l => {l.EffectiveBasePermissions})
 
 $REST.Search().postquery({
     Querytext: "*",
     Properties: [
         {
-            Key: "GraphQuery",
-            Value: "ACTOR(ME,action:1013)",
-            ValueType: "string"
+            Name: "GraphQuery",
+            Value: { StrVal: "ACTOR(ME,action:1013)" }
         }
     ]
 });
@@ -20,7 +24,7 @@ $REST.Helper.SPConfig({
             { name: "Location", title: "Location", type: $REST.Helper.SPCfgFieldType.Geolocation },
         ],
         ListInformation: {
-            TemplateType: 100,
+            BaseTemplate: 100,
             Title: "Map"
         }
     }]