gd-sprest 6.8.9 → 6.9.2

package/.github/workflows/build.yml

@@ -7,19 +7,21 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [8.x, 10.x, 12.x]
+        node-version: [14.x]
     steps:
     - uses: actions/checkout@v2
+
     - name: Use Node.js ${{ env.node-version }}
       uses: actions/setup-node@v1
       with:
         node-version: ${{ env.node-version }}
+
     - name: Build Library using NodeJS ${{ env.node-version }}
       run: |
-        # Build the project
         npm install
         npm run all
         npm run test --if-present
+
     - name: Build Artifacts
       uses: actions/upload-artifact@v1
       with:

package/@types/helper/index.d.ts

@@ -4,7 +4,11 @@ import { IJSLink } from "./jslink";
 import { IRibbonLink, ISuiteBarLink, ILinkInfo } from "./linkInfo";
 import { IListForm } from "./listForm";
 import { IListFormField } from "./listFormField";
-import { IRequest, IaddContentEditorWebPart, IaddScriptEditorWebPart, IcreateContentType, IcreateDocSet, IhasPermissions, Iparse, Irequest, IsetContentTypeFields, IsetGroupOwner } from "./methods";
+import {
+    IRequest, IaddContentEditorWebPart, IaddPermissionLevel, IaddScriptEditorWebPart, IcopyPermissionLevel,
+    IcreateContentType, IcreateDocSet, IhasPermissions, IloadSPCore, Iparse, Irequest, IsetContentTypeFields,
+    IsetGroupOwner
+} from "./methods";
 import { ISPComponents } from "./sp";
 import { ISPConfig, ISPConfigProps, IFieldInfo } from "./spCfg";
 import { ISPCfgFieldType, ISPCfgType } from "./spCfgTypes";
@@ -35,10 +39,13 @@ export interface IHelper {
     /** Methods */
 
     addContentEditorWebPart: IaddContentEditorWebPart,
+    addPermissionLevel: IaddPermissionLevel,
     addScriptEditorWebPart: IaddScriptEditorWebPart,
+    copyPermissionLevel: IcopyPermissionLevel,
     createContentType: IcreateContentType,
     createDocSet: IcreateDocSet,
     hasPermissions: IhasPermissions,
+    loadSPCore: IloadSPCore,
     parse: Iparse,
     request: Irequest,
     setContentTypeFields: IsetContentTypeFields,

package/@types/helper/methods/addPermissionLevel.d.ts

@@ -6,6 +6,7 @@ import { RoleDefinition, RoleDefinitionCreationInformation } from "gd-sprest-def
 export interface IaddPermissionLevelProps extends RoleDefinitionCreationInformation {
     Permissions: Array<number>;
     Name: string;
+    Order?: number;
     WebUrl?: string;
 }
 

package/@types/helper/methods/copyPermissionLevel.d.ts

@@ -0,0 +1,23 @@
+import { RoleDefinition, RoleDefinitionCreationInformation } from "gd-sprest-def/lib/SP";
+
+/**
+ * Properties
+ */
+export interface IcopyPermissionLevelProps extends RoleDefinitionCreationInformation {
+    AddPermissions?: Array<number>;
+    Description: string;
+    BasePermission: string;
+    Order?: number;
+    Name: string;
+    RemovePermissions?: Array<number>;
+    WebUrl?: string;
+}
+
+/**
+ * Copies a permission level to the current or specified web.
+ * @props properties
+ */
+export const copyPermissionLevel: IcopyPermissionLevel;
+export interface IcopyPermissionLevel {
+    (props: IcopyPermissionLevelProps): PromiseLike<RoleDefinition>;
+}

package/@types/helper/methods/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./addContentEditorWebPart";
 export * from "./addPermissionLevel";
 export * from "./addScriptEditorWebPart";
+export * from "./copyPermissionLevel";
 export * from "./createContentType";
 export * from "./createDocSet";
 export * from "./hasPermissions";

package/@types/helper/spCfg.d.ts

@@ -441,6 +441,12 @@ export interface ISPConfig {
      */
     install(): PromiseLike<void>;
 
+    /**
+     * Sets the web url to install/uninstall the solution to/from.
+     * @param url - The web url.
+     */
+    setWebUrl(url: string);
+
     /**
      * Method to install the configuration
      */

package/build/helper/methods/addPermissionLevel.js

@@ -23,8 +23,8 @@ exports.addPermissionLevel = function (props) {
             var roleDefInfo = new SP.RoleDefinitionCreationInformation();
             roleDefInfo.set_basePermissions(basePermissions);
             roleDefInfo.set_description(props.Description);
-            roleDefInfo.set_order(props.Order);
             roleDefInfo.set_name(props.Name);
+            roleDefInfo.set_order(props.Order);
             // Add the role definition
             var roleDef_1 = ctx.get_site().get_rootWeb().get_roleDefinitions().add(roleDefInfo);
             ctx.load(roleDef_1);

package/build/helper/methods/copyPermissionLevel.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyPermissionLevel = void 0;
+var lib_1 = require("../../lib");
+var sptypes_1 = require("../../sptypes");
+/**
+ * Copies a permission level to the current or specified web.
+ */
+exports.copyPermissionLevel = function (props) {
+    // Return a promise
+    return new Promise(function (resolve, reject) {
+        // Ensure the base permissions exist
+        if (SP && SP.BasePermissions) {
+            // Set the context and get the role definitions
+            var ctx_1 = props.WebUrl ? new SP.ClientContext(props.WebUrl) : SP.ClientContext.get_current();
+            // Get the base permission
+            var basePerm = ctx_1.get_site().get_rootWeb().get_roleDefinitions().getByName(props.BasePermission);
+            ctx_1.load(basePerm);
+            ctx_1.executeQueryAsync(
+            // Success
+            function () {
+                // Copy the base permissions
+                var basePermissions = basePerm.get_basePermissions();
+                var permissions = new SP.BasePermissions();
+                var removePermissions = props.RemovePermissions || [];
+                for (var key in sptypes_1.SPTypes.BasePermissionTypes) {
+                    var permission = sptypes_1.SPTypes.BasePermissionTypes[key];
+                    // See if the base permission has this
+                    if (basePermissions.has(permission) && removePermissions.indexOf(permission) < 0) {
+                        // Set the permission
+                        permissions.set(permission);
+                    }
+                }
+                // Parse the custom permissions to add
+                var newPermissions = props.AddPermissions || [];
+                for (var i = 0; i < newPermissions.length; i++) {
+                    // Set the flag
+                    permissions.set(newPermissions[i]);
+                }
+                // Create the role definition
+                var roleDefInfo = new SP.RoleDefinitionCreationInformation();
+                roleDefInfo.set_basePermissions(permissions);
+                roleDefInfo.set_description(props.Description);
+                roleDefInfo.set_name(props.Name);
+                roleDefInfo.set_order(props.Order);
+                // Add the role definition
+                var roleDef = ctx_1.get_site().get_rootWeb().get_roleDefinitions().add(roleDefInfo);
+                ctx_1.load(roleDef);
+                // Execute the request
+                ctx_1.executeQueryAsync(function () {
+                    // Get the role definition
+                    lib_1.Site(props.WebUrl).RootWeb().RoleDefinitions().getById(roleDef.get_id()).execute(function (roleDef) {
+                        // Resolve the request
+                        resolve(roleDef);
+                    }, reject);
+                }, reject);
+            }, 
+            // Error
+            function () {
+                // Reject the request
+                reject("Permission not found in site: " + props.WebUrl);
+            });
+        }
+        else {
+            // Reject the request
+            reject("The 'SP' core library is not available.");
+        }
+    });
+};

package/build/helper/methods/index.js

@@ -13,6 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./addContentEditorWebPart"), exports);
 __exportStar(require("./addPermissionLevel"), exports);
 __exportStar(require("./addScriptEditorWebPart"), exports);
+__exportStar(require("./copyPermissionLevel"), exports);
 __exportStar(require("./createContentType"), exports);
 __exportStar(require("./createDocSet"), exports);
 __exportStar(require("./hasPermissions"), exports);

package/build/helper/spCfg.js

@@ -1265,6 +1265,8 @@ exports.SPConfig = function (cfg, webUrl) {
                 }, reject);
             });
         },
+        // Method to update the web url to target
+        setWebUrl: function (url) { webUrl = url; },
         // Method to uninstall the configuration
         uninstall: function () {
             // Return a promise

package/build/rest.js

@@ -8,7 +8,7 @@ var sptypes_1 = require("./sptypes");
  * SharePoint REST Library
  */
 exports.$REST = {
-    __ver: 6.89,
+    __ver: 6.92,
     AppContext: function (siteUrl) { return Lib.Site.getAppContext(siteUrl); },
     Apps: Lib.Apps,
     ContextInfo: Lib.ContextInfo,

package/dist/gd-sprest.d.ts

@@ -94,7 +94,11 @@ declare module 'gd-sprest/helper' {
     import { IRibbonLink, ISuiteBarLink, ILinkInfo } from "gd-sprest/helper/linkInfo";
     import { IListForm } from "gd-sprest/helper/listForm";
     import { IListFormField } from "gd-sprest/helper/listFormField";
-    import { IRequest, IaddContentEditorWebPart, IaddScriptEditorWebPart, IcreateContentType, IcreateDocSet, IhasPermissions, Iparse, Irequest, IsetContentTypeFields, IsetGroupOwner } from "gd-sprest/helper/methods";
+    import {
+            IRequest, IaddContentEditorWebPart, IaddPermissionLevel, IaddScriptEditorWebPart, IcopyPermissionLevel,
+            IcreateContentType, IcreateDocSet, IhasPermissions, IloadSPCore, Iparse, Irequest, IsetContentTypeFields,
+            IsetGroupOwner
+    } from "./methods";
     import { ISPComponents } from "gd-sprest/helper/sp";
     import { ISPConfig, ISPConfigProps, IFieldInfo } from "gd-sprest/helper/spCfg";
     import { ISPCfgFieldType, ISPCfgType } from "gd-sprest/helper/spCfgTypes";
@@ -125,10 +129,13 @@ declare module 'gd-sprest/helper' {
     
             /** Methods */
             addContentEditorWebPart: IaddContentEditorWebPart,
+            addPermissionLevel: IaddPermissionLevel,
             addScriptEditorWebPart: IaddScriptEditorWebPart,
+            copyPermissionLevel: IcopyPermissionLevel,
             createContentType: IcreateContentType,
             createDocSet: IcreateDocSet,
             hasPermissions: IhasPermissions,
+            loadSPCore: IloadSPCore,
             parse: Iparse,
             request: Irequest,
             setContentTypeFields: IsetContentTypeFields,
@@ -2288,20 +2295,6 @@ declare module 'gd-sprest/helper/listFormField' {
     }
 }
 
-declare module 'gd-sprest/helper/methods' {
-    export * from "gd-sprest/helper/methods/addContentEditorWebPart";
-    export * from "gd-sprest/helper/methods/addPermissionLevel";
-    export * from "gd-sprest/helper/methods/addScriptEditorWebPart";
-    export * from "gd-sprest/helper/methods/createContentType";
-    export * from "gd-sprest/helper/methods/createDocSet";
-    export * from "gd-sprest/helper/methods/hasPermissions";
-    export * from "gd-sprest/helper/methods/loadSPCore";
-    export * from "gd-sprest/helper/methods/parse";
-    export * from "gd-sprest/helper/methods/request";
-    export * from "gd-sprest/helper/methods/setContentTypeFields";
-    export * from "gd-sprest/helper/methods/setGroupOwner";
-}
-
 declare module 'gd-sprest/helper/sp' {
     /**
         * References to the internal SharePoint libraries.
@@ -3398,6 +3391,12 @@ declare module 'gd-sprest/helper/spCfg' {
                 */
             install(): PromiseLike<void>;
     
+            /**
+                * Sets the web url to install/uninstall the solution to/from.
+                * @param url - The web url.
+                */
+            setWebUrl(url: string);
+    
             /**
                 * Method to install the configuration
                 */
@@ -3816,6 +3815,21 @@ declare module 'gd-sprest/helper/webpart' {
     }
 }
 
+declare module 'gd-sprest/helper/methods' {
+    export * from "gd-sprest/helper/methods/addContentEditorWebPart";
+    export * from "gd-sprest/helper/methods/addPermissionLevel";
+    export * from "gd-sprest/helper/methods/addScriptEditorWebPart";
+    export * from "gd-sprest/helper/methods/copyPermissionLevel";
+    export * from "gd-sprest/helper/methods/createContentType";
+    export * from "gd-sprest/helper/methods/createDocSet";
+    export * from "gd-sprest/helper/methods/hasPermissions";
+    export * from "gd-sprest/helper/methods/loadSPCore";
+    export * from "gd-sprest/helper/methods/parse";
+    export * from "gd-sprest/helper/methods/request";
+    export * from "gd-sprest/helper/methods/setContentTypeFields";
+    export * from "gd-sprest/helper/methods/setGroupOwner";
+}
+
 declare module 'gd-sprest/sptypes/sptypes' {
     import { BasePermissions } from "gd-sprest-def/lib/SP/complextypes";
     
@@ -5983,6 +5997,7 @@ declare module 'gd-sprest/helper/methods/addPermissionLevel' {
     export interface IaddPermissionLevelProps extends RoleDefinitionCreationInformation {
             Permissions: Array<number>;
             Name: string;
+            Order?: number;
             WebUrl?: string;
     }
     
@@ -6011,6 +6026,32 @@ declare module 'gd-sprest/helper/methods/addScriptEditorWebPart' {
     }
 }
 
+declare module 'gd-sprest/helper/methods/copyPermissionLevel' {
+    import { RoleDefinition, RoleDefinitionCreationInformation } from "gd-sprest-def/lib/SP";
+    
+    /**
+        * Properties
+        */
+    export interface IcopyPermissionLevelProps extends RoleDefinitionCreationInformation {
+            AddPermissions?: Array<number>;
+            Description: string;
+            BasePermission: string;
+            Order?: number;
+            Name: string;
+            RemovePermissions?: Array<number>;
+            WebUrl?: string;
+    }
+    
+    /**
+        * Copies a permission level to the current or specified web.
+        * @props properties
+        */
+    export const copyPermissionLevel: IcopyPermissionLevel;
+    export interface IcopyPermissionLevel {
+            (props: IcopyPermissionLevelProps): PromiseLike<RoleDefinition>;
+    }
+}
+
 declare module 'gd-sprest/helper/methods/createContentType' {
     import { ContentTypeCreationInformation } from "gd-sprest-def/lib/SP/complextypes";
     import { ContentType } from "gd-sprest-def/lib/SP/entitytypes";