This repository has been archived by the owner on Jan 18, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 51
/
Copy pathsprestlib.js
3643 lines (3349 loc) · 160 KB
/
sprestlib.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*\
|*| :: SpRestLib.js ::
|*|
|*| JavaScript Library for SharePoint Web Serices
|*| https://github.com/gitbrent/SpRestLib
|*|
|*| This library is released under the MIT Public License (MIT)
|*|
|*| SpRestLib (C) 2016-present Brent Ely (https://github.com/gitbrent)
|*|
|*| Permission is hereby granted, free of charge, to any person obtaining a copy
|*| of this software and associated documentation files (the "Software"), to deal
|*| in the Software without restriction, including without limitation the rights
|*| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|*| copies of the Software, and to permit persons to whom the Software is
|*| furnished to do so, subject to the following conditions:
|*|
|*| The above copyright notice and this permission notice shall be included in all
|*| copies or substantial portions of the Software.
|*|
|*| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|*| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|*| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|*| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|*| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|*| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|*| SOFTWARE.
\*/
/*
* TODO-2.0:
* refactor to enable use of strict mode
*/
/**
* SpRestLib
* @see: [SP REST API Index](https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index)
*/
(function(){
// APP VERSION/BUILD
var APP_VER = "1.10.0-beta";
var APP_BLD = "20190214";
// ENUMERATIONS
// REF: [`SP.BaseType`](https://msdn.microsoft.com/en-us/library/office/jj246925.aspx)
var ENUM_BASETYPES = {
"0": "List",
"1": "Library",
"3": "Discussion Board",
"4": "Survey",
"5": "Issue"
};
// REF: [`SP.Utilities.PrincipalType`](https://msdn.microsoft.com/en-us/library/ee553710(v=office.14).aspx)
var ENUM_PRINCIPALTYPES = {
"0" : "None",
"1" : "User",
"2" : "Distribution List",
"4" : "Security Group",
"8" : "SharePoint Group",
"15": "All"
};
// APP FUNCTIONALITY
var APP_FILTEROPS = {
"eq" : "==",
"ne" : "!=",
"gt" : ">",
"gte": ">=",
"lt" : "<",
"lte": "<="
};
// APP OPTIONS
var APP_OPTS = {
baseUrl: ( typeof _spPageContextInfo !== 'undefined' && _spPageContextInfo.webServerRelativeUrl ? _spPageContextInfo.webServerRelativeUrl : '..' ),
busySpinnerHtml: '<div class="sprlib-spinner"><div class="sprlib-bounce1"></div><div class="sprlib-bounce2"></div><div class="sprlib-bounce3"></div></div>',
cache: false,
cleanColHtml: true,
currencyChar: '$',
debug: false, /* verbose mode/lots of logging; undocumented option used for development */
language: 'en',
maxRetries: 2,
maxRows: 5000, /* Max rows queried - internal app limit (used when getting Lists, Users, etc) */
metadata: false,
nodeEnabled: false,
nodeCookie: '',
nodeServer: '',
overwriteUploads: false,
queryLimit: null, /* default queryLimit - allows global override of default SP "100 rows" limit */
retryAfter: 1000
};
// APP AUTHENTICATION
var APP_AUTH = {
bearer: null
};
// LIBRARY DEPS
var https = null;
// GLOBAL VARS
var gRegexGUID = /^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$/i;
var gRetryCounter = 0;
/* ===============================================================================================
|
# #
# # ###### # ##### ###### ##### ####
# # # # # # # # # #
####### ##### # # # ##### # # ####
# # # # ##### # ##### #
# # # # # # # # # #
# # ###### ###### # ###### # # ####
|
==================================================================================================
*/
/**
* Parse XHR Response Headers for SharePoint codes/error messages and return them as a string.
*
* @private
* @since 0.11.0
* @return {string} "(404) List not found."
*/
function parseErrorMessage(jqXHR) {
// STEP 1: Variables
jqXHR = jqXHR || {};
var strXhrCode = jqXHR.status || 'UNK';
var strErrCode = '';
var strErrText = jqXHR.responseText || 'UNK';
var objErrResp = {};
// STEP 2: Parse SharePoint error properties
if ( jqXHR.responseText && typeof jqXHR.responseText === 'string' ) {
try {
// A: Parse string back into object
objErrResp = JSON.parse(jqXHR.responseText);
// B: Handle 2 types of `message` (SP API -vs- Graph API)
if ( objErrResp.error && objErrResp.error.message && objErrResp.error.message.value ) {
/* [SP2016 API] EX: (SPO Dec-2018)
{
"error": {
"code": "-2147024891, System.UnauthorizedAccessException",
"message": {
"lang": "en-US",
"value": "Access denied. You do not have permission to perform this action or access this resource."
}
}
}
*/
strErrCode = objErrResp.error.code.split(',')[0];
strErrText = objErrResp.error.message.value;
}
else if ( objErrResp.error && objErrResp.error.message && typeof objErrResp.error.message === 'string' ) {
/* [MS Graph v1.0] Dec-2018
{
"error": {
"code": "Authorization_RequestDenied",
"message": "Insufficient privileges to complete the operation.",
"innerError": {
"request-id": "f7455057-474a-4c7d-9b69-3d1844d05910",
"date": "2018-12-16T18:34:31"
}
}
}
*/
strErrCode = objErrResp.error.code;
strErrText = objErrResp.error.message;
}
}
catch (ex) {
if (APP_OPTS.debug) {
console.warn('Unable to parse jqXHR response!');
console.log(jqXHR.responseText);
}
}
}
// LAST: Return parsed error message
return ( "("+ strXhrCode +") "+ (strErrCode ? "["+strErrCode+"] " : "") + strErrText );
}
/**
* Query SharePoint for a current `__REQUESTDIGEST`/contextinfo token used in `X-RequestDigest` headers
* Sets the form value for `__REQUESTDIGEST` if it exists
*
* @private
* @return {string} "0x1925741C8C2A5DA6BA9338[...C8ED,18 Apr 2018 03:19:26 -0000"
*/
function doRenewDigestToken() {
return new Promise(function(resolve,reject) {
/* OLD:
// Use SP.js UpdateFormDigest function if available
// @see http://www.wictorwilen.se/sharepoint-2013-how-to-refresh-the-request-digest-value-in-javascript
// UpdateFormDigest() is syncronous per this SharePoint MVP, so just run and return
// DEFAULT: UpdateFormDigest(_spPageContextInfo.webServerRelativeUrl, _spFormDigestRefreshInterval);
// Use a very short refresh interval to force token renewal (otherwise, unless it's been 30 min or whatever, no new token will be provided by SP)
UpdateFormDigest(_spPageContextInfo.webServerRelativeUrl, 10);
resolve();
*/
sprLib.rest({ url:'_api/contextinfo', type:'POST' })
.then(function(arrData){
var strToken = (arrData && arrData[0] && arrData[0].GetContextWebInformation && arrData[0].GetContextWebInformation.FormDigestValue ? arrData[0].GetContextWebInformation.FormDigestValue : null);
// A: Update the page token if it exists
if ( typeof document !== 'undefined' && document.getElementById('__REQUESTDIGEST') ) {
document.getElementById('__REQUESTDIGEST').value = strToken;
}
// B: Return the digest value
resolve( strToken );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/* ===============================================================================================
|
###### # ###### ###
# # # # ##### # # #### # # # # #
# # # # # # # # # # # # # # #
###### # # ##### # # # # # ###### #
# # # # # # # # ####### # #
# # # # # # # # # # # # #
# #### ##### ###### # #### # # # ###
|
==================================================================================================
*/
this.sprLib = {};
sprLib.version = APP_VER+'-'+APP_BLD;
// API: Authentication
/**
* Authentication Methods / Auth token/option getters/setters
* @public
* @since 1.10.0
*/
sprLib.auth = function auth(inOpt) {
var _appAuth = {};
// A: Options setup
inOpt = inOpt || {};
var _pageDigest = ( typeof document !== 'undefined' && document.getElementById('__REQUESTDIGEST') ? document.getElementById('__REQUESTDIGEST').value : null );
/**
* Getter/Setter for a few app options in `APP_AUTH`
*
* @public
* @param {object} inOpt - one or more auth options to set
* @returns {object} Return value of a few APP_AUTH
* @example - get options - `sprLib.auth()`
* @example - set baseUrl - `sprLib.auth({ pageDigest:'ABC123' })`
* @since 1.10.0
*/
/*
_appAuth.digest = function(inOpt) {
if ( !inOpt ) return _pageDigest;
var _requestDigest = ( (inOpt && inOpt.requestDigest) || (typeof document !== 'undefined' && document.getElementById('__REQUESTDIGEST') ? document.getElementById('__REQUESTDIGEST').value : null));
}
// doesnt work
_appAuth.digest.prototype = {
renew: function(){
return doRenewDigestToken();
}
}
*/
// TODO: option to set `bearer` Graph token
// LAST: Return this new List
return _appAuth;
}
// API: UTILITY: Token
// TODO-2.0: will become DEPRECATED: move under a new parent: ~`sprLib.auth().token().renew()`
sprLib.renewSecurityToken = function renewSecurityToken() {
return doRenewDigestToken();
}
// API: OPTIONS
/**
* Getter/Setter for a few app options in `APP_OPTS`
*
* @public
* @param {object} inOpt - one or more options to set
* @returns {object} Return value of a few APP_OPTS
* @example - get options - `sprLib.options();`
* @example - set baseUrl - `sprLib.options({ baseUrl:'/sites/devtest' });`
* @since 1.9.0
*/
sprLib.options = function options(inOpt) {
// CASE 1: Act as a GETTER when no value passed
if ( !inOpt || typeof inOpt !== 'object' ||
(
!inOpt.hasOwnProperty('baseUrl') && !inOpt.hasOwnProperty('queryLimit')
&& !inOpt.hasOwnProperty('nodeEnabled') && !inOpt.hasOwnProperty('nodeCookie') && !inOpt.hasOwnProperty('nodeServer')
&& !inOpt.hasOwnProperty('debug')
)
) {
return {
baseUrl: APP_OPTS.baseUrl,
nodeCookie: APP_OPTS.nodeCookie,
nodeEnabled: APP_OPTS.nodeEnabled,
nodeServer: APP_OPTS.nodeServer,
queryLimit: APP_OPTS.queryLimit
};
}
// CASE 2: Act as a SETTER
// A: Check options
if ( inOpt.baseUrl && typeof inOpt.baseUrl !== 'string' ) { console.warn('Warning: `baseUrl` should be a string'); return; }
if ( inOpt.nodeCookie && typeof inOpt.nodeCookie !== 'string' ) { console.warn('Warning: `nodeCookie` should be a string'); return; }
if ( inOpt.nodeEnabled && typeof inOpt.nodeEnabled !== 'boolean' ) { console.warn('Warning: `nodeEnabled` should be a boolean'); return; }
if ( inOpt.nodeServer && typeof inOpt.nodeServer !== 'string' ) { console.warn('Warning: `nodeServer` should be a string'); return; }
if ( inOpt.queryLimit && typeof inOpt.queryLimit !== 'number' ) { console.warn('Warning: `queryLimit` should be a number'); return; }
// B: Set options
if ( inOpt.baseUrl ) APP_OPTS.baseUrl = inOpt.baseUrl.replace(/\/+$/,'');
if ( inOpt.nodeCookie ) APP_OPTS.nodeCookie = inOpt.nodeCookie;
if ( inOpt.nodeServer ) APP_OPTS.nodeServer = inOpt.nodeServer;
if ( typeof inOpt.nodeEnabled === 'boolean' ) APP_OPTS.nodeEnabled = inOpt.nodeEnabled;
if ( typeof inOpt.queryLimit !== 'undefined' ) APP_OPTS.queryLimit = inOpt.queryLimit; // allow `null` so value can be un-set
// C: Undocumented options
if ( typeof inOpt.debug === 'boolean' ) {
APP_OPTS.debug = inOpt.debug;
return {
debug: APP_OPTS.debug
};
}
// LAST: Return current option values
return {
baseUrl: APP_OPTS.baseUrl,
nodeCookie: APP_OPTS.nodeCookie,
nodeEnabled: APP_OPTS.nodeEnabled,
nodeServer: APP_OPTS.nodeServer,
queryLimit: APP_OPTS.queryLimit
};
}
// DEPRECATED: TODO-2.0: Will be removed in v2.0.0 - use `options()` instead
/**
* Getter/Setter for the app option APP_OPTS.baseUrl
*
* @public
* @param {string} inStr - URL to use as the root of API calls
* @returns {string} Return value of APP_OPTS.baseUrl
* @example - set baseUrl - `sprLib.baseUrl('/sites/devtest');`
* @example - get baseUrl - `sprLib.baseUrl();`
*/
sprLib.baseUrl = function baseUrl(inStr) {
// CASE 1: Act as a GETTER when no value passed
if ( typeof inStr !== 'string' || inStr == '' || !inStr ) return APP_OPTS.baseUrl;
// CASE 2: Act as a SETTER
APP_OPTS.baseUrl = inStr.replace(/\/+$/,'');
if (APP_OPTS.debug) console.log('APP_OPTS.baseUrl = '+APP_OPTS.baseUrl);
}
// DEPRECATED: TODO-2.0: Will be removed in v2.0.0 - use `options()` instead
// API: NODEJS: Setup
sprLib.nodeConfig = function nodeConfig(inOpt) {
inOpt = (inOpt && typeof inOpt === 'object' ? inOpt : {});
APP_OPTS.nodeEnabled = (typeof inOpt.nodeEnabled !== 'undefined' ? inOpt.nodeEnabled : true);
APP_OPTS.nodeCookie = inOpt.cookie || '';
APP_OPTS.nodeServer = inOpt.server || '';
}
// TODO: TARGET-1.11.0: Add `baseUrl` to `file()` method
// API: FILE
/**
* SharePoint Library File Resource methods
* "Represents a file in a SharePoint Web site that can be a Web Part Page, an item in a document library, or a file in a folder."
*
* @param `inOpt` (object)/(string) - required - (`name` prop reqd)
* @example - `sprLib.file('/sites/dev/Shared%20Documents/SomeFolder/MyDoc.docx');`
* @example - `sprLib.file({ 'name':'/sites/dev/Shared%20Documents/SomeFolder/MyDoc.docx' });`
* @example - `sprLib.file({ 'name':'/MyDocuments/MyDoc.docx', 'requestDigest':'ABC1234567890' });`
* @since 1.8.0
* @see: [File API](https://gitbrent.github.io/SpRestLib/docs/api-file.html)
* @see: [Files and folders REST API reference](https://msdn.microsoft.com/en-us/library/office/dn450841.aspx)
*/
sprLib.file = function file(inOpt) {
// A: Options setup
inOpt = inOpt || {};
var _newFile = {};
var _fullName = "", _fldName = "", _dirName = "";
var _requestDigest = (inOpt.requestDigest || (typeof document !== 'undefined' && document.getElementById('__REQUESTDIGEST') ? document.getElementById('__REQUESTDIGEST').value : null));
// TODO: 20180701: need to honor `_baseUrl`
// TODO: include `baseUrl` param? OR do we parse URL from file and use that? (e.g.: `filePath` is the baseUrl)
// EX: sprLib.file({ 'name':'Shared%20Documents/SomeFolder/MyDoc.docx' });
// We dont want to require a full path, right?
// Use `getfilebyserverrelativeurl()`?? @see: https://msdn.microsoft.com/en-us/library/office/dn450841.aspx#bk_FileRequestExamples
// B: Param check
if ( inOpt && typeof inOpt === 'string' ) {
_fullName = encodeURI(inOpt);
}
else if ( inOpt && typeof inOpt === 'object' && inOpt.hasOwnProperty('name') ) {
_fullName = encodeURI(inOpt.name);
}
else {
console.error("ERROR: A 'fileName' is required! EX: `sprLib.file('Documents/Sample.docx')` or `sprLib.file({ 'name':'Documents/Sample.docx' })`");
console.error('ARGS:');
console.error(inOpt);
return null;
}
// C: Ensure `_fullName` does not end with a slash ("/")
_fullName = _fullName.replace(/\/$/gi,'');
//_pathName = _fullName.substring(0, _fullName.lastIndexOf('/'));
_fileName = _fullName.substring(_fullName.lastIndexOf('/')+1);
// D: Ensure a full path
// Allow relative names for web users
if ( _fullName.indexOf('/') != 0 && _spPageContextInfo && _spPageContextInfo.webServerRelativeUrl ) {
_fullName = _spPageContextInfo.webServerRelativeUrl + _fullName;
}
/**
* CheckIn a File
* @see: https://msdn.microsoft.com/en-us/library/office/dn450841.aspx#bk_FileCheckIn
* @since 1.9.0
*
* @param `inOpt` (object) - can contain `comment` and `type` options
* @example: sprLib.file('/site/Documents/MyDoc.docx').checkin("All done!")
* @returns: (boolean) - `true` on success
*/
_newFile.checkin = function(inOpt) {
return new Promise(function(resolve, reject) {
// A: Options setup
inOpt = inOpt || {};
inOpt.comment = inOpt.comment || "";
// DOCS: "The SP.CheckinType for the file: MinorCheckIn = 0; MajorCheckIn = 1; OverwriteCheckIn = 2."
if ( inOpt.type && ['major','minor','overwrite'].indexOf(inOpt.type.toLowerCase()) == -1 ) {
console.warn("Check your options! Available checkin() `type` options are: `major`,`minor`,`overwrite`");
inOpt.type = "1"; // Default to "Major"
}
else {
inOpt.type = (inOpt.type || 'major').toLowerCase().replace('major',1).replace('minor',0).replace('overwrite',2);
}
// B:
sprLib.rest({
type: "POST",
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')"
+ "/CheckIn(comment='"+ inOpt.comment +"',checkintype="+ inOpt.type +")"
})
.then(function(arrData){
// NOTE: SharePoint fall 2018 returns: `{ CheckIn: null }`
resolve( true );
})
.catch(function(strErr){
// EX: "(423) The file "Shared Documents/check-me-out.pptx" is not checked out."
reject( strErr );
});
});
}
/**
* CheckOut a File
* @see: https://msdn.microsoft.com/en-us/library/office/dn450841.aspx#bk_FileCheckOut
* @since 1.9.0
*
* @returns: (boolean) - `true` on success
*/
_newFile.checkout = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
type: "POST",
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')/CheckOut"
})
.then(function(arrData){
// NOTE: SharePoint fall 2018 returns: `{ CheckOut: null }`
resolve( true );
})
.catch(function(strErr){
// EX: "(423) The file "/sites/dev/Shared Documents/checkinout/check-me-out.pptx" is checked out for editing by i:0#.f|membership|admin@h[...]"
reject( strErr );
});
});
}
/**
* Delete a File (**permanent** - skips recycle bin!)
* @since 1.9.0
* @see: https://msdn.microsoft.com/en-us/library/office/dn450841.aspx
*
* @returns: (boolean) - `true` on success
*/
_newFile.delete = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
type: "POST",
headers: { "X-HTTP-Method":"DELETE" },
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')",
metadata: false
})
.then(function(arrData){
/* NOTE: SharePoint fall 2018 returns
* `{ location: null }`
*/
// Done
resolve( true );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Get a File (binary or text)
* @since 1.8.0
* @see: [https://msdn.microsoft.com/en-us/library/office/dn450841.aspx#bk_FileRequestExamples](The GetFileByServerRelativeUrl endpoint is recommended way to get a file. See SP.File request examples)
*
* @returns: a File as a Blob
*/
_newFile.get = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')/$value",
headers: {'binaryStringResponseBody':true},
metadata: false
})
.then(function(data){
if ( typeof Blob !== 'undefined' ) {
// Web browser: Return blob from ArrayBuffer
resolve( new Blob([data], {type:"application/octet-stream"}) );
}
else {
resolve( Buffer.from(data,'binary') );
}
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Get information about a File
* Optionally include a version tag to get info about a certain file version
* @since 1.8.0
*
* @param `inOpt` (object) - (`version` prop optional)
* @returns: an object containing information about the current File
* @example: sprLib.file('/site/Documents/MyDoc.docx').info()
* @example: sprLib.file('/site/Documents/MyDoc.docx').info({ version:12 })
*/
_newFile.info = function(inOpt) {
return new Promise(function(resolve, reject) {
var objData = {};
// A: Check opts
if ( inOpt && inOpt.hasOwnProperty('version') && isNaN(Number(inOpt.version)) ) {
console.error("ERROR: 'version' should be a number! EX: `sprLib.file('Sample.docx').info({ version:12 })`");
console.error("ARGS:");
console.error(inOpt);
return null;
}
// B: Get file info
sprLib.rest({
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')",
queryCols: ['Author/Id','CheckedOutByUser/Id','LockedByUser/Id','ModifiedBy/Id',
'CheckInComment','CheckOutType','ETag','Exists','Length','MajorVersion','MinorVersion',
'Name','ServerRelativeUrl','TimeCreated','TimeLastModified','UniqueId','UIVersionLabel'],
metadata: false
})
.then(function(arrData){
// A: Capture info
objData = ( arrData && arrData.length > 0 ? arrData[0] : {} ); // FYI: Empty object is correct return type when file-not-found
// B: Remove junk for user fields, enure an object is returned
['Author', 'CheckedOutByUser', 'LockedByUser', 'ModifiedBy'].forEach(function(field){
// Remove "junk"
if ( objData[field] && objData[field].__deferred ) delete objData[field].__deferred;
if ( objData[field] && objData[field].__metadata ) delete objData[field].__metadata;
// Ensure an empty array isnt returned (eg: files not checked out wont have a CheckedOutByUser value)
if ( objData[field] && Array.isArray(objData[field]) && objData[field].length == 0 ) objData[field] = {};
});
// C: Remap some properties
if ( objData.TimeCreated ) { objData.Created = objData.TimeCreated; delete objData.TimeCreated; }
if ( objData.TimeLastModified ) { objData.Modified = objData.TimeLastModified; delete objData.TimeLastModified; }
// D: Handle version option
if ( inOpt && inOpt.version ) {
return sprLib.rest({
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')/versions("+ (Number(inOpt.version)*512) +")",
queryCols: ['CheckInComment','Created','IsCurrentVersion','Length','VersionLabel'],
metadata: false
})
.catch(function(strErr){
throw strErr;
})
}
else {
return null;
}
})
.then(function(arrVersion){
// NOTE: Check for `VersionLabel` as it is not present when items are not version controlled!
if ( arrVersion && arrVersion[0] && arrVersion[0].VersionLabel ) {
// Gather version metadata
Object.keys(arrVersion[0]).forEach(function(key){
if ( key != 'VersionLabel' ) objData[key] = arrVersion[0][key];
});
// Update version metadata from first query
objData.MajorVersion = arrVersion[0].VersionLabel.split('.')[0];
objData.MinorVersion = arrVersion[0].VersionLabel.split('.')[1];
objData.UIVersionLabel = arrVersion[0].VersionLabel;
}
// Done
resolve( objData );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Get File permissions
* @since 1.8.0
*
* @returns: array of objects with `Member` and `Roles` properties
* @example: sprLib.file('/site/Documents/MyDoc.docx').perms().then( arr => console.log(arr) );
* .--------------------------------------------------------------------------------------------------------------------------------------------------------------------------.
* | Member | Roles |
* |---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
* | {"Title":"Dev Site Members","PrincipalType":"SharePoint Group","PrincipalId":8} | [{"Hidden":false,"Name":"Design"},{"Hidden":false,"Name":"Edit"}] |
* | {"Title":"Dev Site Owners","PrincipalType":"SharePoint Group","PrincipalId":6} | [{"Hidden":false,"Name":"Full Control"},{"Hidden":true,"Name":"Limited Access"}] |
* | {"Title":"Dev Site Visitors","PrincipalType":"SharePoint Group","PrincipalId":7} | [{"Hidden":false,"Name":"Read"}] |
* | {"Title":"Excel Services Viewers","PrincipalType":"SharePoint Group","PrincipalId":5} | [{"Hidden":false,"Name":"View Only"}] |
* '--------------------------------------------------------------------------------------------------------------------------------------------------------------------------'
*/
_newFile.perms = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')/ListItemAllFields/RoleAssignments",
queryCols: ['PrincipalId','Member/PrincipalType','Member/Title','RoleDefinitionBindings/Name','RoleDefinitionBindings/Hidden'],
metadata: false
})
.then(function(arrData){
// STEP 1: Transform: Results s/b 2 keys with props inside each
arrData.forEach(function(objItem,idx){
// A: "Rename" the `RoleDefinitionBindings` key to be user-friendly
Object.defineProperty(objItem, 'Roles', Object.getOwnPropertyDescriptor(objItem, 'RoleDefinitionBindings'));
delete objItem.RoleDefinitionBindings;
// B: Move `PrincipalId` inside {Member}
objItem.Member.PrincipalId = objItem.PrincipalId;
delete objItem.PrincipalId;
// C: Decode PrincipalType into text
objItem.Member.PrincipalType = ENUM_PRINCIPALTYPES[objItem.Member.PrincipalType] || objItem.Member.PrincipalType;
});
// STEP 2: Resolve results (NOTE: empty array is the correct default result)
resolve( arrData || [] );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Recycle a File (moves item to site recycle bin)
* @since 1.9.0
* @see: https://msdn.microsoft.com/en-us/library/office/dn450841.aspx
*
* @returns: (boolean) - `true` on success
*/
_newFile.recycle = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
type: "POST",
url: "_api/web/GetFileByServerRelativeUrl('"+ _fullName +"')/recycle()",
metadata: false
})
.then(function(arrData){
/* NOTE: SharePoint fall 2018 returns
* `{ Recycle: "ebced81f-4bac-4e94-a316-781e89e5a83e" }`
*/
// Done
resolve( true );
})
.catch(function(strErr){
reject( strErr );
});
});
}
// LAST: Return this new File
return _newFile;
}
// TODO: TARGET-1.11.0: Add `baseUrl` to `folder()` method
// API: FOLDER
/**
* SharePoint Library Folder Resource methods
*
* @param `inOpt` (object)/(string) - required - (`name` prop reqd)
* @example - `sprLib.folder('SiteAssets');`
* @example - `sprLib.folder('/sites/dev/SiteAssets/');`
* @example - `sprLib.folder({ 'name':'/sites/dev/SiteAssets/' });`
* @since 1.8.0
* @see: [File API](https://gitbrent.github.io/SpRestLib/docs/api-folder.html)
* @see: [Files and folders REST API reference](https://msdn.microsoft.com/en-us/library/office/dn450841.aspx#bk_Folder)
*/
sprLib.folder = function folder(inOpt) {
// A: Options setup
inOpt = inOpt || {};
var _newFolder = {};
var _fullName = "";
// TODO: store `listGUID` and `listName` on _newFolder, then check/use them in subsequent ops
// TODO: TARGET: 1.11.0
// Add `baseUrl` to `folder()` method
// elevate `urlBase` up here and use in all methods below - most are just "./" now (d'oh)
// B: Options check/set
if ( inOpt && typeof inOpt === 'string' ) {
_fullName = encodeURI(inOpt);
}
else if ( inOpt && typeof inOpt === 'object' && inOpt.hasOwnProperty('name') ) {
_fullName = encodeURI(inOpt.name);
}
else {
console.error("ERROR: A 'folderName' is required! EX: `sprLib.folder('Documents/Finance')` or `sprLib.folder({ 'name':'Documents/Finance' })`");
console.error('ARGS:');
console.error(inOpt);
return null;
}
// C: Ensure `_fullName` does not end with a slash ("/")
_fullName = _fullName.replace(/\/$/gi,'');
// D: Public Methods ----------------------------------------------
// TODO: implement these Methods:
// FYI: /_api/web/GetFolderByServerRelativeUrl(‘{folder url}’)/ListItemAllFields/breakroleinheritance(true)
/**
* Add/Create a new Folder
* @since 1.9.0
*
* @see: https://msdn.microsoft.com/en-us/library/office/dn450841.aspx#bk_FolderCollectionAdd
* @returns: (object) - folder object returned by SharePoint
*/
_newFolder.add = function(inOpt) {
return new Promise(function(resolve, reject) {
// A: Options setup
var strFullName = "";
// TODO: the logic below could be written better - if we really cant use `baseUrl` unless it begins with "/" or "http", then check above and return error up front
var urlBase = ( APP_OPTS.baseUrl.indexOf('http') == 0 || APP_OPTS.baseUrl.indexOf('/') == 0 ? APP_OPTS.baseUrl : ( _spPageContextInfo && _spPageContextInfo.webServerRelativeUrl ? _spPageContextInfo.webServerRelativeUrl : APP_OPTS.baseUrl ) );
inOpt = (inOpt ? inOpt : null);
if ( !inOpt || typeof inOpt !== 'string' ) {
console.error("Error: `folder().add()` requires a string folder name!");
return null;
}
// B: Ensure there is a fully-qualified URL
strFullName = ( inOpt.indexOf('http') == 0 || inOpt.indexOf('/') == 0 ? inOpt : encodeURI(_fullName +'/'+ inOpt) );
// C: Create folder
// NOTE: Both the `url` and the string passed to `add()` must be fully-qualified URLs (ex: not "../..")
sprLib.rest({
type: "POST",
url: urlBase+"/_api/web/folders/add('"+ strFullName +"')",
metadata: false
})
.then(function(arrData){
var objNewFolder = (arrData && arrData[0] ? arrData[0] : null);
/* EX:
.-----------------------------------------------------------------------------------------------------------------------------------------------------------.
| Prop Name | Prop Value |
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------|
| Files | {"__deferred":{"uri":"https://a.sharepoint.com/sites/dev/_api/Web/GetFolderByServerRelativePath(decodedurl='/a/Files"}} |
| ListItemAllFields | {"__deferred":{"uri":"https://a.sharepoint.com/sites/dev/_api/Web/GetFolderByServerRelativePath(decodedurl='/a')/ListItemAllFields"}} |
| ParentFolder | {"__deferred":{"uri":"https://a.sharepoint.com/sites/dev/_api/Web/GetFolderByServerRelativePath(decodedurl='/a')/ParentFolder"}} |
| Properties | {"__deferred":{"uri":"https://a.sharepoint.com/sites/dev/_api/Web/GetFolderByServerRelativePath(decodedurl='/a')/Properties"}} |
| StorageMetrics | {"__deferred":{"uri":"https://a.sharepoint.com/sites/dev/_api/Web/GetFolderByServerRelativePath(decodedurl='/a')/StorageMetrics"}} |
| Folders | {"__deferred":{"uri":"https://a.sharepoint.com/sites/dev/_api/Web/GetFolderByServerRelativePath(decodedurl='/a')/Folders"}} |
| Exists | true |
| IsWOPIEnabled | false |
| ItemCount | 0 |
| Name | "DEMO" |
| ProgID | null |
| ServerRelativeUrl | "/sites/dev/Shared Documents/folder/" |
| TimeCreated | "2018-11-13T03:34:48Z" |
| TimeLastModified | "2018-11-13T03:34:48Z" |
| UniqueId | "2ce2a781-a96a-4b50-aa9f-affe8f404fe4" |
| WelcomePage | "" |
'-----------------------------------------------------------------------------------------------------------------------------------------------------------.
*/
// Done
resolve( objNewFolder );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Delete a Folder (**permanent** - skips recycle bin!)
* @since 1.9.0
*
* @see: https://msdn.microsoft.com/en-us/library/office/dn450841.aspx
* @returns: (boolean) - `true` on success
*/
_newFolder.delete = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
type: "POST",
headers: { "X-HTTP-Method":"DELETE" },
url: "_api/web/GetFolderByServerRelativeUrl('"+ _fullName +"')",
metadata: false
})
.then(function(arrData){
/* NOTE: SharePoint fall 2018 returns
* `{ location: null }`
*/
// Done
resolve( true );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Get Files and their properties
* @since 1.8.0
*
* @example - relative URL: `sprLib.folder('Shared Documents').files()`
* @example - absolute URL: `sprLib.folder('/sites/dev/Shared Documents').files()`
* @returns: Promise<Object[]> with Files and their properties
*/
_newFolder.files = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
url: "_api/web/GetFolderByServerRelativeUrl('"+ _fullName +"')/Files",
queryCols: [
'Author/Id','CheckedOutByUser/Id','LockedByUser/Id','ModifiedBy/Id',
'Author/Title','CheckedOutByUser/Title','LockedByUser/Title','ModifiedBy/Title',
'CheckInComment','CheckOutType','ETag','Exists','Length','MajorVersion','MinorVersion',
'Name','ServerRelativeUrl','TimeCreated','TimeLastModified','Title','UniqueId'
],
metadata: false
})
.then(function(arrData){
// STEP 1: Transform results
arrData.forEach(function(file){
// A: Rename some cols
file.Created = file.TimeCreated; delete file.TimeCreated;
file.Modified = file.TimeLastModified; delete file.TimeLastModified;
// B: Convert numbers
if ( file.Length && !isNaN(Number(file.Length)) ) file.Length = Number(file.Length);
// C: These 2 values come back as `[]` when there's no value, and that sucks, so fix them
if ( file.CheckedOutByUser && Array.isArray(file.CheckedOutByUser) && file.CheckedOutByUser.length == 0 ) file.CheckedOutByUser = null;
if ( file.LockedByUser && Array.isArray(file.LockedByUser) && file.LockedByUser.length == 0 ) file.LockedByUser = null;
})
// STEP 2: Resolve results (NOTE: empty array is the correct default result)
resolve( arrData || [] );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Get Folders and their properties
* @since 1.8.0
*
* @example - relative URL: `sprLib.folder('Shared Documents').folders()`
* @example - absolute URL: `sprLib.folder('/sites/dev/Shared Documents').folders()`
* @returns: Promise<Object[]> with Folders and their properties
*/
_newFolder.folders = function() {
return new Promise(function(resolve, reject) {
sprLib.rest({
url: "_api/web/GetFolderByServerRelativeUrl('"+ _fullName +"')/Folders",
queryCols: [
'Name','ItemCount','ServerRelativeUrl',
'Properties/vti_x005f_timecreated','Properties/vti_x005f_timelastmodified','Properties/vti_x005f_hassubdirs',
'Properties/vti_x005f_isbrowsable','Properties/vti_x005f_foldersubfolderitemcount','Properties/vti_x005f_listname'
],
metadata: false
})
.then(function(arrData){
// STEP 1: Transform results
arrData.forEach(function(objFolder){
// A: Remap properties
if ( objFolder.Properties ) {
objFolder.Created = ( objFolder.Properties.vti_x005f_timecreated ? objFolder.Properties.vti_x005f_timecreated : null );
objFolder.FolderCount = ( objFolder.Properties.vti_x005f_foldersubfolderitemcount ? objFolder.Properties.vti_x005f_foldersubfolderitemcount : 0 );
objFolder.ItemCount = ( objFolder.ItemCount ? objFolder.ItemCount : 0 );
objFolder.GUID = ( objFolder.Properties.vti_x005f_listname ? objFolder.Properties.vti_x005f_listname : null );
objFolder.HasSubdirs = ( objFolder.Properties.vti_x005f_hassubdirs ? objFolder.Properties.vti_x005f_hassubdirs == "true" : false );
objFolder.Hidden = ( objFolder.Properties.vti_x005f_isbrowsable ? objFolder.Properties.vti_x005f_isbrowsable == "false" : false );
objFolder.Modified = ( objFolder.Properties.vti_x005f_timelastmodified ? objFolder.Properties.vti_x005f_timelastmodified : null );
delete objFolder.Properties;
}
});
// STEP 2: Resolve results (NOTE: empty array is the correct default result)
resolve( arrData || [] );
})
.catch(function(strErr){
reject( strErr );
});
});
}
/**
* Get information (properties) for a Folder
* @since 1.8.0
*
* @example: sprLib.folder('/site/Documents/Finance').info()
* @returns: Object with Folder properties
*/
_newFolder.info = function() {
return new Promise(function(resolve, reject) {
var objFolder = null;
sprLib.rest({
url: "_api/web/GetFolderByServerRelativeUrl('"+ _fullName +"')",
queryCols: [
'Name','ItemCount','ServerRelativeUrl','StorageMetrics/TotalSize',
'Properties/vti_x005f_parentid','Properties/vti_x005f_listtitle','Properties/vti_x005f_listname',
'Properties/vti_x005f_timecreated','Properties/vti_x005f_timelastmodified','Properties/vti_x005f_hassubdirs',
'Properties/vti_x005f_isbrowsable','Properties/vti_x005f_foldersubfolderitemcount'
],
metadata: false
})
.then(function(arrData){
// A: Capture info
objFolder = ( arrData && arrData.length > 0 ? arrData[0] : {} ); // FYI: Empty object is correct return type when file-not-found
// B: Remap properties
if ( objFolder.Properties ) {
objFolder.Created = ( objFolder.Properties.vti_x005f_timecreated ? objFolder.Properties.vti_x005f_timecreated : null );
objFolder.FolderCount = ( objFolder.Properties.vti_x005f_foldersubfolderitemcount ? objFolder.Properties.vti_x005f_foldersubfolderitemcount : 0 );
objFolder.ItemCount = ( objFolder.ItemCount ? objFolder.ItemCount : 0 );
objFolder.ListGUID = ( objFolder.Properties.vti_x005f_listname ? objFolder.Properties.vti_x005f_listname : null ); // NOTE: root Library [List]
objFolder.HasSubdirs = ( objFolder.Properties.vti_x005f_hassubdirs ? objFolder.Properties.vti_x005f_hassubdirs == "true" : false );
objFolder.Hidden = ( objFolder.Properties.vti_x005f_isbrowsable ? objFolder.Properties.vti_x005f_isbrowsable == "false" : false );
//objFolder.ParentGUID = ( objFolder.Properties.vti_x005f_parentid ? objFolder.Properties.vti_x005f_parentid : null );
//objFolder.ListTitle = ( objFolder.Properties.vti_x005f_listtitle ? objFolder.Properties.vti_x005f_listtitle : null ); // NOTE: wont exist for subfolders
objFolder.Modified = ( objFolder.Properties.vti_x005f_timelastmodified ? objFolder.Properties.vti_x005f_timelastmodified : null );
delete objFolder.Properties;
}
// C: Remap storage metrics
if ( objFolder.StorageMetrics && objFolder.StorageMetrics.TotalSize ) {
objFolder.TotalSize = Number(objFolder.StorageMetrics.TotalSize) || 0;
delete objFolder.StorageMetrics;
}
// D: Start chain for `HasUniqueRoleAssignments` prop
if ( objFolder.ListGUID ) {
return sprLib.rest({
url: "_api/web/Lists(guid'"+ objFolder.ListGUID.replace(/\{|\}/g,'') +"')/rootFolder/Folders",
queryCols: ['ListItemAllFields/Id'],
metadata: false
});
}
else {
return null;
}
})
.then(function(arrResults){
if ( arrResults && arrResults[0] && arrResults[0].ListItemAllFields && arrResults[0].ListItemAllFields.Id ) {
return sprLib.rest({
url: "_api/web/Lists(guid'"+ objFolder.ListGUID.replace(/\{|\}/g,'') +"')/items('"+arrResults[0].ListItemAllFields.Id+"')/HasUniqueRoleAssignments",
metadata: false
});