dattatable 1.8.7 → 1.8.8

package/build/comments.d.ts

@@ -20,5 +20,9 @@ export declare class Comments {
     static init(listName: string): PromiseLike<void>;
     private static load;
     static new(item: any): void;
+    static security(cfg: {
+        principalId: number;
+        roleDefId: number;
+    }[], webUrl?: string): PromiseLike<void>;
     static view(item: any): void;
 }

package/build/comments.js

@@ -181,6 +181,48 @@ var Comments = /** @class */ (function () {
         // Show the form
         modal_1.Modal.show();
     };
+    // Security configuration
+    Comments.security = function (cfg, webUrl) {
+        // Resets the list permissions
+        var resetPermissions = function () {
+            return new Promise(function (resolve) {
+                var list = (0, gd_sprest_bs_1.Web)(webUrl).Lists(LIST_NAME);
+                // Reset the inheritance
+                list.resetRoleInheritance().execute();
+                // Clear the permissions
+                list.breakRoleInheritance(false, true).execute(resolve, true);
+            });
+        };
+        // Return a promise
+        return new Promise(function (resolve) {
+            var list = (0, gd_sprest_bs_1.Web)(webUrl).Lists(LIST_NAME);
+            // Ensure a configuration exists
+            if (cfg && cfg.length > 0) {
+                // Reset the list permissions
+                resetPermissions().then(function () {
+                    var _loop_1 = function (i) {
+                        var principalId = cfg[i].principalId;
+                        var roleDefId = cfg[i].roleDefId;
+                        // Update the list settings
+                        list.RoleAssignments().addRoleAssignment(principalId, roleDefId).execute(function () {
+                            // Log
+                            console.log("[Comments List] The user/group (" + principalId + ") was added successfully.");
+                        });
+                    };
+                    // Parse the configuration
+                    for (var i = 0; i < cfg.length; i++) {
+                        _loop_1(i);
+                    }
+                    // Wait for the requests to complete
+                    list.done(resolve);
+                });
+            }
+            else {
+                // Resolve the request
+                resolve();
+            }
+        });
+    };
     // Displays the comments in a canvas form
     Comments.view = function (item) {
         var _this = this;

package/dist/dattatable.js

@@ -16,7 +16,7 @@
 /***/ ((__unused_webpack_module, exports, __webpack_require__) => {
 
 "use strict";
-eval("\r\nObject.defineProperty(exports, \"__esModule\", ({ value: true }));\r\nexports.Comments = void 0;\r\nvar gd_sprest_bs_1 = __webpack_require__(/*! gd-sprest-bs */ \"./node_modules/.pnpm/gd-sprest-bs@9.6.0/node_modules/gd-sprest-bs/build/index.js\");\r\nvar moment = __webpack_require__(/*! moment */ \"./node_modules/.pnpm/moment@2.29.3/node_modules/moment/moment.js\");\r\nvar canvas_1 = __webpack_require__(/*! ./common/canvas */ \"./build/common/canvas.js\");\r\nvar loadingDialog_1 = __webpack_require__(/*! ./common/loadingDialog */ \"./build/common/loadingDialog.js\");\r\nvar modal_1 = __webpack_require__(/*! ./common/modal */ \"./build/common/modal.js\");\r\n// List Name\r\nvar LIST_NAME = \"Comments\";\r\n/**\r\n * Comments\r\n */\r\nvar Comments = /** @class */ (function () {\r\n    function Comments() {\r\n    }\r\n    // Adds a comment to an item\r\n    Comments.add = function (item, comment) {\r\n        var _this = this;\r\n        // Return a promise\r\n        return new Promise(function (resolve, reject) {\r\n            // Ensure a comment exists\r\n            if (comment) {\r\n                // Show a loading dialog\r\n                loadingDialog_1.LoadingDialog.setHeader(\"Adding Comment\");\r\n                loadingDialog_1.LoadingDialog.setBody(\"This dialog will close after the comment is added.\");\r\n                loadingDialog_1.LoadingDialog.show();\r\n                // Add the item\r\n                (0, gd_sprest_bs_1.List)(LIST_NAME).Items().add({\r\n                    Comment: comment,\r\n                    Title: _this._listId + \"|\" + item.Id\r\n                }).execute(function () {\r\n                    // Hide the loading dialog\r\n                    loadingDialog_1.LoadingDialog.hide();\r\n                    // Resolve the request\r\n                    resolve();\r\n                }, reject);\r\n            }\r\n            else {\r\n                // Resolve the request\r\n                resolve();\r\n            }\r\n        });\r\n    };\r\n    // Configuration\r\n    Comments.configuration = function (cfg) {\r\n        var commentsCfg = gd_sprest_bs_1.Helper.SPConfig({\r\n            ListCfg: [\r\n                {\r\n                    ListInformation: {\r\n                        Title: LIST_NAME,\r\n                        BaseTemplate: gd_sprest_bs_1.SPTypes.ListTemplateType.GenericList,\r\n                        Hidden: true,\r\n                        NoCrawl: true\r\n                    },\r\n                    TitleFieldDisplayName: \"Comment ID\",\r\n                    TitleFieldIndexed: true,\r\n                    CustomFields: [\r\n                        {\r\n                            name: \"Comment\",\r\n                            title: \"Comment\",\r\n                            type: gd_sprest_bs_1.Helper.SPCfgFieldType.Note,\r\n                            noteType: gd_sprest_bs_1.SPTypes.FieldNoteType.TextOnly\r\n                        }\r\n                    ],\r\n                    ViewInformation: [\r\n                        {\r\n                            ViewName: \"All Items\",\r\n                            ViewQuery: \"Author eq [Me]\",\r\n                            ViewFields: [\"LinkTitle\", \"Comment\", \"Author\", \"Created\"]\r\n                        }\r\n                    ]\r\n                }\r\n            ]\r\n        });\r\n        // Append the comments to the configuration if it exists\r\n        if (cfg && cfg._configuration.ListCfg && cfg._configuration.ListCfg.length > 0) {\r\n            // Append the list configuration\r\n            cfg._configuration.ListCfg = cfg._configuration.ListCfg.concat(commentsCfg._configuration.ListCfg);\r\n        }\r\n        // Return the configuration\r\n        return cfg || commentsCfg;\r\n    };\r\n    // Initialization of the component\r\n    Comments.init = function (listName) {\r\n        var _this = this;\r\n        // Return a promise\r\n        return new Promise(function (resolve, reject) {\r\n            // Load the List Information\r\n            (0, gd_sprest_bs_1.List)(listName).execute(function (list) {\r\n                // Set the list id\r\n                _this._listId = list.Id;\r\n                // Resolve the request\r\n                resolve();\r\n            }, reject);\r\n        });\r\n    };\r\n    // Loads the comments for the item\r\n    Comments.load = function (item) {\r\n        var _this = this;\r\n        // Return a promise\r\n        return new Promise(function (resolve, reject) {\r\n            // Ensure a list id exists\r\n            if (_this._listId) {\r\n                // Load the comments for this item\r\n                (0, gd_sprest_bs_1.List)(LIST_NAME).Items().query({\r\n                    Expand: [\"Author\"],\r\n                    Filter: \"Title eq '\" + _this._listId + \"|\" + item.Id + \"'\",\r\n                    OrderBy: [\"Created desc\"],\r\n                    Select: [\"Id\", \"Comment\", \"Created\", \"Title\", \"Author/Id\", \"Author/EMail\", \"Author/Title\"]\r\n                }).execute(function (items) {\r\n                    // Resolve the request\r\n                    resolve(items.results);\r\n                }, reject);\r\n            }\r\n            else {\r\n                // Reject the request\r\n                reject(\"The target list doesn't exist. Please initialize the component before using it.\");\r\n            }\r\n        });\r\n    };\r\n    // Displays the new comment form\r\n    Comments.new = function (item) {\r\n        var _this = this;\r\n        // Clear the modal dialog\r\n        modal_1.Modal.clear();\r\n        // Hide the close button\r\n        modal_1.Modal.setCloseButtonVisibility(false);\r\n        // Set the header\r\n        modal_1.Modal.setHeader(\"Add Comment\");\r\n        // Create the form\r\n        var form = gd_sprest_bs_1.Components.Form({\r\n            el: modal_1.Modal.BodyElement,\r\n            controls: [{\r\n                    name: \"comment\",\r\n                    label: \"Comment\",\r\n                    type: gd_sprest_bs_1.Components.FormControlTypes.TextArea,\r\n                    rows: 10,\r\n                    required: true,\r\n                    errorMessage: \"A value is required\"\r\n                }]\r\n        });\r\n        // Set the footer\r\n        gd_sprest_bs_1.Components.TooltipGroup({\r\n            el: modal_1.Modal.FooterElement,\r\n            tooltips: [\r\n                {\r\n                    content: \"Click to add a comment to the request.\",\r\n                    btnProps: {\r\n                        text: \"Add\",\r\n                        type: gd_sprest_bs_1.Components.ButtonTypes.OutlineSuccess,\r\n                        onClick: function () {\r\n                            // Ensure the form is valid\r\n                            if (form.isValid()) {\r\n                                // Hide the modal\r\n                                modal_1.Modal.hide();\r\n                                // Add the comment\r\n                                _this.add(item, form.getValues()[\"comment\"]).then(function () {\r\n                                    // View the comments\r\n                                    _this.view(item);\r\n                                });\r\n                            }\r\n                        }\r\n                    }\r\n                },\r\n                {\r\n                    content: \"Closes this dialog and views the comments\",\r\n                    btnProps: {\r\n                        text: \"Close\",\r\n                        type: gd_sprest_bs_1.Components.ButtonTypes.OutlineDanger,\r\n                        onClick: function () {\r\n                            // Hide the modal\r\n                            modal_1.Modal.hide();\r\n                            // Show the canvas form\r\n                            canvas_1.CanvasForm.show();\r\n                        }\r\n                    }\r\n                }\r\n            ]\r\n        });\r\n        // Show the form\r\n        modal_1.Modal.show();\r\n    };\r\n    // Displays the comments in a canvas form\r\n    Comments.view = function (item) {\r\n        var _this = this;\r\n        // Display a loading dialog\r\n        loadingDialog_1.LoadingDialog.setHeader(\"Loading Comments\");\r\n        loadingDialog_1.LoadingDialog.setBody(\"This dialog will close after the comments are loaded.\");\r\n        loadingDialog_1.LoadingDialog.show();\r\n        // Load the items\r\n        this.load(item).then(function (comments) {\r\n            // Clear the form\r\n            canvas_1.CanvasForm.clear();\r\n            // Set the header\r\n            canvas_1.CanvasForm.setHeader(\"<h5>Comments</h5>\");\r\n            // Render a nav\r\n            gd_sprest_bs_1.Components.Navbar({\r\n                el: canvas_1.CanvasForm.BodyElement,\r\n                itemsEnd: [{\r\n                        text: \"+ Add Comment\",\r\n                        onClick: function () {\r\n                            // Hide the form\r\n                            canvas_1.CanvasForm.hide();\r\n                            // Display a modal to add the comment\r\n                            _this.new(item);\r\n                        }\r\n                    }]\r\n            });\r\n            // Parse the comments\r\n            for (var i = 0; i < comments.length; i++) {\r\n                var comment = comments[i];\r\n                // Render a toast\r\n                gd_sprest_bs_1.Components.Toast({\r\n                    el: canvas_1.CanvasForm.BodyElement,\r\n                    headerText: comment.Author.Title,\r\n                    mutedText: moment(new Date(comment.Created)).toString(),\r\n                    body: (comment.Comment || \"\").replace(/\\r?\\n/g, '<br />'),\r\n                    options: {\r\n                        animation: true,\r\n                        autohide: false\r\n                    }\r\n                });\r\n            }\r\n            // Hide the dialog\r\n            loadingDialog_1.LoadingDialog.hide();\r\n            // Show the canvas form\r\n            canvas_1.CanvasForm.show();\r\n        });\r\n    };\r\n    Comments._listId = null;\r\n    return Comments;\r\n}());\r\nexports.Comments = Comments;\r\n\n\n//# sourceURL=webpack://dattatable/./build/comments.js?");
+eval("\r\nObject.defineProperty(exports, \"__esModule\", ({ value: true }));\r\nexports.Comments = void 0;\r\nvar gd_sprest_bs_1 = __webpack_require__(/*! gd-sprest-bs */ \"./node_modules/.pnpm/gd-sprest-bs@9.6.0/node_modules/gd-sprest-bs/build/index.js\");\r\nvar moment = __webpack_require__(/*! moment */ \"./node_modules/.pnpm/moment@2.29.3/node_modules/moment/moment.js\");\r\nvar canvas_1 = __webpack_require__(/*! ./common/canvas */ \"./build/common/canvas.js\");\r\nvar loadingDialog_1 = __webpack_require__(/*! ./common/loadingDialog */ \"./build/common/loadingDialog.js\");\r\nvar modal_1 = __webpack_require__(/*! ./common/modal */ \"./build/common/modal.js\");\r\n// List Name\r\nvar LIST_NAME = \"Comments\";\r\n/**\r\n * Comments\r\n */\r\nvar Comments = /** @class */ (function () {\r\n    function Comments() {\r\n    }\r\n    // Adds a comment to an item\r\n    Comments.add = function (item, comment) {\r\n        var _this = this;\r\n        // Return a promise\r\n        return new Promise(function (resolve, reject) {\r\n            // Ensure a comment exists\r\n            if (comment) {\r\n                // Show a loading dialog\r\n                loadingDialog_1.LoadingDialog.setHeader(\"Adding Comment\");\r\n                loadingDialog_1.LoadingDialog.setBody(\"This dialog will close after the comment is added.\");\r\n                loadingDialog_1.LoadingDialog.show();\r\n                // Add the item\r\n                (0, gd_sprest_bs_1.List)(LIST_NAME).Items().add({\r\n                    Comment: comment,\r\n                    Title: _this._listId + \"|\" + item.Id\r\n                }).execute(function () {\r\n                    // Hide the loading dialog\r\n                    loadingDialog_1.LoadingDialog.hide();\r\n                    // Resolve the request\r\n                    resolve();\r\n                }, reject);\r\n            }\r\n            else {\r\n                // Resolve the request\r\n                resolve();\r\n            }\r\n        });\r\n    };\r\n    // Configuration\r\n    Comments.configuration = function (cfg) {\r\n        var commentsCfg = gd_sprest_bs_1.Helper.SPConfig({\r\n            ListCfg: [\r\n                {\r\n                    ListInformation: {\r\n                        Title: LIST_NAME,\r\n                        BaseTemplate: gd_sprest_bs_1.SPTypes.ListTemplateType.GenericList,\r\n                        Hidden: true,\r\n                        NoCrawl: true\r\n                    },\r\n                    TitleFieldDisplayName: \"Comment ID\",\r\n                    TitleFieldIndexed: true,\r\n                    CustomFields: [\r\n                        {\r\n                            name: \"Comment\",\r\n                            title: \"Comment\",\r\n                            type: gd_sprest_bs_1.Helper.SPCfgFieldType.Note,\r\n                            noteType: gd_sprest_bs_1.SPTypes.FieldNoteType.TextOnly\r\n                        }\r\n                    ],\r\n                    ViewInformation: [\r\n                        {\r\n                            ViewName: \"All Items\",\r\n                            ViewQuery: \"Author eq [Me]\",\r\n                            ViewFields: [\"LinkTitle\", \"Comment\", \"Author\", \"Created\"]\r\n                        }\r\n                    ]\r\n                }\r\n            ]\r\n        });\r\n        // Append the comments to the configuration if it exists\r\n        if (cfg && cfg._configuration.ListCfg && cfg._configuration.ListCfg.length > 0) {\r\n            // Append the list configuration\r\n            cfg._configuration.ListCfg = cfg._configuration.ListCfg.concat(commentsCfg._configuration.ListCfg);\r\n        }\r\n        // Return the configuration\r\n        return cfg || commentsCfg;\r\n    };\r\n    // Initialization of the component\r\n    Comments.init = function (listName) {\r\n        var _this = this;\r\n        // Return a promise\r\n        return new Promise(function (resolve, reject) {\r\n            // Load the List Information\r\n            (0, gd_sprest_bs_1.List)(listName).execute(function (list) {\r\n                // Set the list id\r\n                _this._listId = list.Id;\r\n                // Resolve the request\r\n                resolve();\r\n            }, reject);\r\n        });\r\n    };\r\n    // Loads the comments for the item\r\n    Comments.load = function (item) {\r\n        var _this = this;\r\n        // Return a promise\r\n        return new Promise(function (resolve, reject) {\r\n            // Ensure a list id exists\r\n            if (_this._listId) {\r\n                // Load the comments for this item\r\n                (0, gd_sprest_bs_1.List)(LIST_NAME).Items().query({\r\n                    Expand: [\"Author\"],\r\n                    Filter: \"Title eq '\" + _this._listId + \"|\" + item.Id + \"'\",\r\n                    OrderBy: [\"Created desc\"],\r\n                    Select: [\"Id\", \"Comment\", \"Created\", \"Title\", \"Author/Id\", \"Author/EMail\", \"Author/Title\"]\r\n                }).execute(function (items) {\r\n                    // Resolve the request\r\n                    resolve(items.results);\r\n                }, reject);\r\n            }\r\n            else {\r\n                // Reject the request\r\n                reject(\"The target list doesn't exist. Please initialize the component before using it.\");\r\n            }\r\n        });\r\n    };\r\n    // Displays the new comment form\r\n    Comments.new = function (item) {\r\n        var _this = this;\r\n        // Clear the modal dialog\r\n        modal_1.Modal.clear();\r\n        // Hide the close button\r\n        modal_1.Modal.setCloseButtonVisibility(false);\r\n        // Set the header\r\n        modal_1.Modal.setHeader(\"Add Comment\");\r\n        // Create the form\r\n        var form = gd_sprest_bs_1.Components.Form({\r\n            el: modal_1.Modal.BodyElement,\r\n            controls: [{\r\n                    name: \"comment\",\r\n                    label: \"Comment\",\r\n                    type: gd_sprest_bs_1.Components.FormControlTypes.TextArea,\r\n                    rows: 10,\r\n                    required: true,\r\n                    errorMessage: \"A value is required\"\r\n                }]\r\n        });\r\n        // Set the footer\r\n        gd_sprest_bs_1.Components.TooltipGroup({\r\n            el: modal_1.Modal.FooterElement,\r\n            tooltips: [\r\n                {\r\n                    content: \"Click to add a comment to the request.\",\r\n                    btnProps: {\r\n                        text: \"Add\",\r\n                        type: gd_sprest_bs_1.Components.ButtonTypes.OutlineSuccess,\r\n                        onClick: function () {\r\n                            // Ensure the form is valid\r\n                            if (form.isValid()) {\r\n                                // Hide the modal\r\n                                modal_1.Modal.hide();\r\n                                // Add the comment\r\n                                _this.add(item, form.getValues()[\"comment\"]).then(function () {\r\n                                    // View the comments\r\n                                    _this.view(item);\r\n                                });\r\n                            }\r\n                        }\r\n                    }\r\n                },\r\n                {\r\n                    content: \"Closes this dialog and views the comments\",\r\n                    btnProps: {\r\n                        text: \"Close\",\r\n                        type: gd_sprest_bs_1.Components.ButtonTypes.OutlineDanger,\r\n                        onClick: function () {\r\n                            // Hide the modal\r\n                            modal_1.Modal.hide();\r\n                            // Show the canvas form\r\n                            canvas_1.CanvasForm.show();\r\n                        }\r\n                    }\r\n                }\r\n            ]\r\n        });\r\n        // Show the form\r\n        modal_1.Modal.show();\r\n    };\r\n    // Security configuration\r\n    Comments.security = function (cfg, webUrl) {\r\n        // Resets the list permissions\r\n        var resetPermissions = function () {\r\n            return new Promise(function (resolve) {\r\n                var list = (0, gd_sprest_bs_1.Web)(webUrl).Lists(LIST_NAME);\r\n                // Reset the inheritance\r\n                list.resetRoleInheritance().execute();\r\n                // Clear the permissions\r\n                list.breakRoleInheritance(false, true).execute(resolve, true);\r\n            });\r\n        };\r\n        // Return a promise\r\n        return new Promise(function (resolve) {\r\n            var list = (0, gd_sprest_bs_1.Web)(webUrl).Lists(LIST_NAME);\r\n            // Ensure a configuration exists\r\n            if (cfg && cfg.length > 0) {\r\n                // Reset the list permissions\r\n                resetPermissions().then(function () {\r\n                    var _loop_1 = function (i) {\r\n                        var principalId = cfg[i].principalId;\r\n                        var roleDefId = cfg[i].roleDefId;\r\n                        // Update the list settings\r\n                        list.RoleAssignments().addRoleAssignment(principalId, roleDefId).execute(function () {\r\n                            // Log\r\n                            console.log(\"[Comments List] The user/group (\" + principalId + \") was added successfully.\");\r\n                        });\r\n                    };\r\n                    // Parse the configuration\r\n                    for (var i = 0; i < cfg.length; i++) {\r\n                        _loop_1(i);\r\n                    }\r\n                    // Wait for the requests to complete\r\n                    list.done(resolve);\r\n                });\r\n            }\r\n            else {\r\n                // Resolve the request\r\n                resolve();\r\n            }\r\n        });\r\n    };\r\n    // Displays the comments in a canvas form\r\n    Comments.view = function (item) {\r\n        var _this = this;\r\n        // Display a loading dialog\r\n        loadingDialog_1.LoadingDialog.setHeader(\"Loading Comments\");\r\n        loadingDialog_1.LoadingDialog.setBody(\"This dialog will close after the comments are loaded.\");\r\n        loadingDialog_1.LoadingDialog.show();\r\n        // Load the items\r\n        this.load(item).then(function (comments) {\r\n            // Clear the form\r\n            canvas_1.CanvasForm.clear();\r\n            // Set the header\r\n            canvas_1.CanvasForm.setHeader(\"<h5>Comments</h5>\");\r\n            // Render a nav\r\n            gd_sprest_bs_1.Components.Navbar({\r\n                el: canvas_1.CanvasForm.BodyElement,\r\n                itemsEnd: [{\r\n                        text: \"+ Add Comment\",\r\n                        onClick: function () {\r\n                            // Hide the form\r\n                            canvas_1.CanvasForm.hide();\r\n                            // Display a modal to add the comment\r\n                            _this.new(item);\r\n                        }\r\n                    }]\r\n            });\r\n            // Parse the comments\r\n            for (var i = 0; i < comments.length; i++) {\r\n                var comment = comments[i];\r\n                // Render a toast\r\n                gd_sprest_bs_1.Components.Toast({\r\n                    el: canvas_1.CanvasForm.BodyElement,\r\n                    headerText: comment.Author.Title,\r\n                    mutedText: moment(new Date(comment.Created)).toString(),\r\n                    body: (comment.Comment || \"\").replace(/\\r?\\n/g, '<br />'),\r\n                    options: {\r\n                        animation: true,\r\n                        autohide: false\r\n                    }\r\n                });\r\n            }\r\n            // Hide the dialog\r\n            loadingDialog_1.LoadingDialog.hide();\r\n            // Show the canvas form\r\n            canvas_1.CanvasForm.show();\r\n        });\r\n    };\r\n    Comments._listId = null;\r\n    return Comments;\r\n}());\r\nexports.Comments = Comments;\r\n\n\n//# sourceURL=webpack://dattatable/./build/comments.js?");
 
 /***/ }),