@lindle/sharepoint_requests 0.1.9 → 0.1.11

package/dist/sharepoint_requests.esm.js

@@ -25,6 +25,15 @@ function _asyncToGenerator(n) {
     });
   };
 }
+function _extends() {
+  return _extends = Object.assign ? Object.assign.bind() : function (n) {
+    for (var e = 1; e < arguments.length; e++) {
+      var t = arguments[e];
+      for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]);
+    }
+    return n;
+  }, _extends.apply(null, arguments);
+}
 function _regenerator() {
   /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */
   var e,
@@ -120,32 +129,61 @@ function _regeneratorDefine(e, r, n, t) {
     i = 0;
   }
   _regeneratorDefine = function (e, r, n, t) {
-    if (r) i ? i(e, r, {
+    function o(r, n) {
+      _regeneratorDefine(e, r, function (e) {
+        return this._invoke(r, n, e);
+      });
+    }
+    r ? i ? i(e, r, {
       value: n,
       enumerable: !t,
       configurable: !t,
       writable: !t
-    }) : e[r] = n;else {
-      function o(r, n) {
-        _regeneratorDefine(e, r, function (e) {
-          return this._invoke(r, n, e);
-        });
-      }
-      o("next", 0), o("throw", 1), o("return", 2);
-    }
+    }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2));
   }, _regeneratorDefine(e, r, n, t);
 }
 
+var instance = function instance(baseURL, config) {
+  if (config === void 0) {
+    config = {
+      headers: {
+        Accept: 'application/json; odata=verbose',
+        'Content-Type': 'application/json; odata=verbose'
+      },
+      timeout: 15000,
+      withCredentials: true
+    };
+  }
+  return axios.create(_extends({
+    baseURL: baseURL
+  }, config));
+};
+
 var HTTPSharePointRequests = /*#__PURE__*/function () {
+  /**
+   * Creates an HTTP SharePoint requester bound to the provided base URL.
+   *
+   * @param baseURL The root SharePoint site URL (with or without trailing slash).
+   */
   function HTTPSharePointRequests(baseURL) {
     var _this = this;
     this.lists = {
+      /**
+       * Fetches all SharePoint lists available to the current site.
+       *
+       * @returns Promise resolving to the list collection response payload.
+       */
       get: function get() {
         _this.endpoint = '_api/web/lists';
         return _this.get_v2();
       }
     };
     this.folders = {
+      /**
+       * Retrieves SharePoint folders from the default folders endpoint.
+       *
+       * @returns A promise resolving with folder metadata.
+       */
       get: function get() {
         _this.endpoint = '_api/web/folders';
         _this.get_v2();
@@ -181,6 +219,11 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       }
     };
     this.user = {
+      /**
+       * Provides accessors for the current user's profile information.
+       *
+       * @returns Helper exposing a `get` function to retrieve profile details.
+       */
       properties: function properties() {
         return {
           get: function get() {
@@ -188,12 +231,30 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
           }
         };
       },
+      /**
+       * Searches across site users and their groups.
+       *
+       * @param searchValue Query string to match site users.
+       * @returns Promise resolving to matching site users.
+       */
       searchSiteUser: function searchSiteUser(searchValue) {
         return _this.getSiteUser(searchValue);
       },
+      /**
+       * Performs a people-picker search scoped to the current site collection.
+       *
+       * @param input Search prefix.
+       * @param filter Optional additional filter condition.
+       * @returns Promise with type-ahead person results.
+       */
       searchUser: function searchUser(input, filter) {
         return _this.typeAhead(input, filter);
       },
+      /**
+       * Fetches the currently authenticated SharePoint user.
+       *
+       * @returns Helper exposing `get` that resolves to the current user payload.
+       */
       current: function current() {
         _this.endpoint = '_api/web/currentUser';
         return {
@@ -202,6 +263,11 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
           }
         };
       },
+      /**
+       * Retrieves calculated permission level for the current user.
+       *
+       * @returns Helper exposing `get` resolving to the user's permission definition.
+       */
       currentPermission: function currentPermission() {
         return {
           get: function get() {
@@ -213,19 +279,14 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
     this.baseURL = baseURL.endsWith('/') ? baseURL : baseURL + "/";
     this.endpoint = '/api';
     this.listName = '';
-    var headers = {
-      Accept: 'application/json; odata=verbose',
-      'Content-Type': 'application/json; odata=verbose'
-    };
-    this.instance = axios.create({
-      baseURL: "" + this.baseURL,
-      withCredentials: true,
-      headers: {
-        common: headers,
-        post: headers
-      }
-    });
+    this.instance = instance(this.baseURL);
   }
+  /**
+   * Converts array values in a payload to the `Collection(Edm.String)` structure
+   * expected by SharePoint REST endpoints.
+   *
+   * @param data The list item payload to harmonise in-place.
+   */
   var _proto = HTTPSharePointRequests.prototype;
   _proto.transformArraysToEdmStrings = function transformArraysToEdmStrings(data) {
     for (var key in data) {
@@ -246,7 +307,14 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
     this.listName = listName;
     this.endpoint = "_vti_bin/ListData.svc/" + listName;
     return this;
-  };
+  }
+  /**
+   * Selects a SharePoint list and exposes list-scoped CRUD helpers.
+   *
+   * @param listName Logical list key configured in the generic type map.
+   * @param sharepoint_ver SharePoint version used to choose the correct REST endpoint.
+   * @returns Chainable helpers bound to the selected list.
+   */;
   _proto.from = function from(listName, sharepoint_ver) {
     var _this2 = this;
     if (sharepoint_ver === void 0) {
@@ -280,7 +348,13 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
         };
       }
     };
-  };
+  }
+  /**
+   * Targets a SharePoint folder path and exposes file retrieval helpers.
+   *
+   * @param folderName Optional folder path relative to `Shared Documents`.
+   * @returns Helper exposing `get` to fetch files or sub-folders.
+   */;
   _proto.folder = function folder(folderName) {
     var _this3 = this;
     var filePath = ['Shared Documents'];
@@ -289,6 +363,12 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
     }
     this.endpoint = "_api/web/GetFolderByServerRelativeUrl('" + filePath.join('/') + "')";
     return {
+      /**
+       * Fetches files or folders from the targeted path.
+       *
+       * @param options Optional REST query options to refine the result set.
+       * @returns Promise resolving to folder contents and metadata.
+       */
       get: function get(options) {
         if (!(options != null && options.type)) {
           _this3.endpoint += '/Files';
@@ -298,11 +378,22 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
         return _this3.get_files(options);
       }
     };
-  };
+  }
+  /**
+   * Retrieves user list items and exposes a get helper with optional query parameters.
+   *
+   * @param options Optional REST query options.
+   * @returns Helper exposing `get` returning SharePoint user rows.
+   */;
   _proto.users = function users(options) {
     var _this4 = this;
     this.endpoint = '_api/web/SiteUserInfoList/items';
     return {
+      /**
+       * Executes the user list request using the specified options.
+       *
+       * @returns Promise resolving to the SharePoint user list response.
+       */
       get: function get() {
         return _this4.get_v2(options);
       }
@@ -348,8 +439,17 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _getDigest.apply(this, arguments);
     }
     return getDigest;
-  }();
-  _proto.get_only = /*#__PURE__*/function () {
+  }()
+  /**
+   * Executes a GET request without additional metadata wrapping.
+   *
+   * @param options Optional REST query options.
+   * @returns SharePoint response payload or undefined when empty.
+   */
+  ;
+  _proto.get_only =
+  /*#__PURE__*/
+  function () {
     var _get_only = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(options) {
       var _ref, expand, orderBy, limit, filter, cols, skip, params, _yield$this$instance$, data;
       return _regenerator().w(function (_context2) {
@@ -385,8 +485,17 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _get_only.apply(this, arguments);
     }
     return get_only;
-  }();
-  _proto.get_files = /*#__PURE__*/function () {
+  }()
+  /**
+   * Retrieves folder contents with optional filtering and returns the payload with metadata.
+   *
+   * @param options REST options describing expand/filter/order conditions.
+   * @returns Folder data and the fully resolved request URL.
+   */
+  ;
+  _proto.get_files =
+  /*#__PURE__*/
+  function () {
     var _get_files = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(options) {
       var _ref2, expand, orderBy, limit, filter, cols, skip, params, url, response, data, meta;
       return _regenerator().w(function (_context3) {
@@ -432,8 +541,17 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _get_files.apply(this, arguments);
     }
     return get_files;
-  }();
-  _proto.get_v2 = /*#__PURE__*/function () {
+  }()
+  /**
+   * Performs a typed list read against the current endpoint.
+   *
+   * @param options Optional REST query options governing expand, filter, ordering and pagination.
+   * @returns SharePoint list items alongside the fully-resolved request URL.
+   */
+  ;
+  _proto.get_v2 =
+  /*#__PURE__*/
+  function () {
     var _get_v = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4(options) {
       var _ref4, expand, orderBy, limit, filter, cols, skip, params, url, response, data, meta;
       return _regenerator().w(function (_context4) {
@@ -479,8 +597,19 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _get_v.apply(this, arguments);
     }
     return get_v2;
-  }();
-  _proto.update_2 = /*#__PURE__*/function () {
+  }()
+  /**
+   * Updates an item in the currently selected list.
+   *
+   * @param id Target list item identifier.
+   * @param data Payload with fields to update.
+   * @param digest Optional pre-fetched form digest to reuse.
+   * @returns Axios response of the update request.
+   */
+  ;
+  _proto.update_2 =
+  /*#__PURE__*/
+  function () {
     var _update_ = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(id, data, digest) {
       var formDigestValue, url, response, _t2;
       return _regenerator().w(function (_context5) {
@@ -522,10 +651,19 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _update_.apply(this, arguments);
     }
     return update_2;
-  }();
-  _proto.create_v2 = /*#__PURE__*/function () {
+  }()
+  /**
+   * Creates a new item within the active list.
+   *
+   * @param listData SharePoint list item payload.
+   * @returns Axios response resolved from the create request.
+   */
+  ;
+  _proto.create_v2 =
+  /*#__PURE__*/
+  function () {
     var _create_v = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(listData) {
-      var response, _t3, _t4, _t5, _t6, _t7, _t8;
+      var response, _t3, _t4, _t5, _t6, _t7;
       return _regenerator().w(function (_context6) {
         while (1) switch (_context6.n) {
           case 0:
@@ -544,14 +682,13 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
               'X-RequestDigest': _t6,
               'IF-MATCH': '*'
             };
-            _t8 = {
+            _context6.n = 2;
+            return _t3.instance.call(_t3, {
               url: _t4,
               method: 'POST',
               data: _t5,
               headers: _t7
-            };
-            _context6.n = 2;
-            return _t3.instance.call(_t3, _t8);
+            });
           case 2:
             response = _context6.v;
             return _context6.a(2, response);
@@ -562,31 +699,39 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _create_v.apply(this, arguments);
     }
     return create_v2;
-  }();
-  _proto.createFile = /*#__PURE__*/function () {
+  }()
+  /**
+   * Uploads an attachment file to an existing list item.
+   *
+   * @param props File payload and target item identifier.
+   * @returns Axios response describing the upload result.
+   */
+  ;
+  _proto.createFile =
+  /*#__PURE__*/
+  function () {
     var _createFile = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee7(_ref6) {
-      var file, itemId, requestUrl, res, _t9, _t0, _t1, _t10, _t11, _t12;
+      var file, itemId, requestUrl, res, _t8, _t9, _t0, _t1, _t10;
       return _regenerator().w(function (_context7) {
         while (1) switch (_context7.n) {
           case 0:
             file = _ref6.file, itemId = _ref6.itemId;
             requestUrl = "_api/lists/getbytitle('" + this.listName + "')/items(" + itemId + ")/AttachmentFiles/add(FileName='" + file.name + "')";
-            _t9 = this.instance;
-            _t0 = requestUrl;
-            _t1 = file;
+            _t8 = this.instance;
+            _t9 = requestUrl;
+            _t0 = file;
             _context7.n = 1;
             return this.getDigest();
           case 1:
-            _t10 = _context7.v;
-            _t11 = {
-              'X-RequestDigest': _t10
-            };
-            _t12 = {
-              headers: _t11,
-              withCredentials: true
+            _t1 = _context7.v;
+            _t10 = {
+              'X-RequestDigest': _t1
             };
             _context7.n = 2;
-            return _t9.post.call(_t9, _t0, _t1, _t12);
+            return _t8.post.call(_t8, _t9, _t0, {
+              headers: _t10,
+              withCredentials: true
+            });
           case 2:
             res = _context7.v;
             return _context7.a(2, res);
@@ -597,8 +742,17 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _createFile.apply(this, arguments);
     }
     return createFile;
-  }();
-  _proto["delete"] = /*#__PURE__*/function () {
+  }()
+  /**
+   * Deletes an item using the current endpoint.
+   *
+   * @param ID Identifier of the entity to remove.
+   * @returns Axios response from the delete call.
+   */
+  ;
+  _proto["delete"] =
+  /*#__PURE__*/
+  function () {
     var _delete2 = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee8(ID) {
       var response;
       return _regenerator().w(function (_context8) {
@@ -619,24 +773,24 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
   }();
   _proto.sendEmail = /*#__PURE__*/function () {
     var _sendEmail = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee9(_ref7) {
-      var From, To, Subject, Body, httpRequest, response, _t13, _t14, _t15, _t16, _t17, _t18;
+      var From, To, Subject, Body, httpRequest, response, _t11, _t12, _t13, _t14, _t15;
       return _regenerator().w(function (_context9) {
         while (1) switch (_context9.n) {
           case 0:
             From = _ref7.From, To = _ref7.To, Subject = _ref7.Subject, Body = _ref7.Body;
             httpRequest = '_api/SP.Utilities.Utility.SendEmail';
-            _t13 = this;
-            _t14 = httpRequest;
+            _t11 = this;
+            _t12 = httpRequest;
             _context9.n = 1;
             return this.getDigest();
           case 1:
-            _t15 = _context9.v;
-            _t16 = {
-              'X-RequestDigest': _t15,
+            _t13 = _context9.v;
+            _t14 = {
+              'X-RequestDigest': _t13,
               'X-Http-Method': 'POST',
               'Content-Type': 'application/json;odata=verbose'
             };
-            _t17 = JSON.stringify({
+            _t15 = JSON.stringify({
               properties: {
                 __metadata: {
                   type: 'SP.Utilities.EmailProperties'
@@ -649,14 +803,13 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
                 Subject: Subject
               }
             });
-            _t18 = {
-              url: _t14,
-              method: 'POST',
-              headers: _t16,
-              data: _t17
-            };
             _context9.n = 2;
-            return _t13.instance.call(_t13, _t18);
+            return _t11.instance.call(_t11, {
+              url: _t12,
+              method: 'POST',
+              headers: _t14,
+              data: _t15
+            });
           case 2:
             response = _context9.v;
             return _context9.a(2, response);
@@ -667,8 +820,18 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _sendEmail.apply(this, arguments);
     }
     return sendEmail;
-  }();
-  _proto.typeAhead = /*#__PURE__*/function () {
+  }()
+  /**
+   * Queries SharePoint's people picker endpoint for matching users.
+   *
+   * @param input Free-text search term.
+   * @param filter Optional additional filter condition.
+   * @returns Promise with type-ahead results payload.
+   */
+  ;
+  _proto.typeAhead =
+  /*#__PURE__*/
+  function () {
     var _typeAhead = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee0(input, filter) {
       var filterValue, response;
       return _regenerator().w(function (_context0) {
@@ -687,8 +850,16 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _typeAhead.apply(this, arguments);
     }
     return typeAhead;
-  }();
-  _proto.currentUserProperties = /*#__PURE__*/function () {
+  }()
+  /**
+   * Retrieves the current user profile and flattens selected properties.
+   *
+   * @returns Promise containing the current user's profile information.
+   */
+  ;
+  _proto.currentUserProperties =
+  /*#__PURE__*/
+  function () {
     var _currentUserProperties = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee1() {
       var requestUrl, profile;
       return _regenerator().w(function (_context1) {
@@ -722,8 +893,17 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _currentUserProperties.apply(this, arguments);
     }
     return currentUserProperties;
-  }();
-  _proto.getSiteUser = /*#__PURE__*/function () {
+  }()
+  /**
+   * Searches site users based on a substring match across common fields.
+   *
+   * @param searchValue Term to match against the SharePoint user directory.
+   * @returns Promise with matching site users and their groups.
+   */
+  ;
+  _proto.getSiteUser =
+  /*#__PURE__*/
+  function () {
     var _getSiteUser = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee10(searchValue) {
       var requestUrl, response;
       return _regenerator().w(function (_context10) {
@@ -742,8 +922,16 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _getSiteUser.apply(this, arguments);
     }
     return getSiteUser;
-  }();
-  _proto.roleDefinitions = /*#__PURE__*/function () {
+  }()
+  /**
+   * Retrieves all available role definitions for the current site.
+   *
+   * @returns Promise resolving to an array of role definitions.
+   */
+  ;
+  _proto.roleDefinitions =
+  /*#__PURE__*/
+  function () {
     var _roleDefinitions = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee11() {
       var requestUrl, response;
       return _regenerator().w(function (_context11) {
@@ -762,8 +950,16 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _roleDefinitions.apply(this, arguments);
     }
     return roleDefinitions;
-  }();
-  _proto.getEffectiveBasePermissions = /*#__PURE__*/function () {
+  }()
+  /**
+   * Fetches the bit-encoded permissions of the current user.
+   *
+   * @returns Promise resolving to the `EffectiveBasePermissions` object.
+   */
+  ;
+  _proto.getEffectiveBasePermissions =
+  /*#__PURE__*/
+  function () {
     var _getEffectiveBasePermissions = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee12() {
       var requestUrl, response;
       return _regenerator().w(function (_context12) {
@@ -782,8 +978,16 @@ var HTTPSharePointRequests = /*#__PURE__*/function () {
       return _getEffectiveBasePermissions.apply(this, arguments);
     }
     return getEffectiveBasePermissions;
-  }();
-  _proto.currentUserPermissions = /*#__PURE__*/function () {
+  }()
+  /**
+   * Matches the current user's effective permissions against known role definitions.
+   *
+   * @returns The matching SharePoint role definition as a structured permission object.
+   */
+  ;
+  _proto.currentUserPermissions =
+  /*#__PURE__*/
+  function () {
     var _currentUserPermissions = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee13() {
       var _yield$this$getEffect, High, roleDefinitions, result;
       return _regenerator().w(function (_context13) {