@kwiz/common 1.0.96 → 1.0.97

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/.github/workflows/npm-publish.yml +24 -24
  2. package/.madgerc +2 -2
  3. package/LICENSE +21 -21
  4. package/fix-folder-imports.js +26 -26
  5. package/lib/cjs/helpers/strings.js +20 -1
  6. package/lib/cjs/helpers/strings.js.map +1 -1
  7. package/lib/cjs/types/libs/msal.types.js +26 -26
  8. package/lib/cjs/utils/sharepoint.rest/user.js +11 -11
  9. package/lib/esm/helpers/strings.js +19 -1
  10. package/lib/esm/helpers/strings.js.map +1 -1
  11. package/lib/esm/types/libs/msal.types.js +26 -26
  12. package/lib/esm/utils/sharepoint.rest/user.js +11 -11
  13. package/lib/types/helpers/strings.d.ts +5 -0
  14. package/package.json +81 -81
  15. package/readme.md +17 -17
  16. package/src/_dependencies.ts +12 -12
  17. package/src/config.ts +17 -17
  18. package/src/helpers/Guid.ts +181 -181
  19. package/src/helpers/base64.ts +173 -173
  20. package/src/helpers/browser.test.js +13 -13
  21. package/src/helpers/browser.ts +1399 -1399
  22. package/src/helpers/browserinfo.ts +292 -292
  23. package/src/helpers/collections.base.test.js +25 -25
  24. package/src/helpers/collections.base.ts +437 -437
  25. package/src/helpers/collections.ts +107 -107
  26. package/src/helpers/color.ts +54 -54
  27. package/src/helpers/cookies.ts +59 -59
  28. package/src/helpers/date.test.js +119 -119
  29. package/src/helpers/date.ts +188 -188
  30. package/src/helpers/debug.ts +186 -186
  31. package/src/helpers/diagrams.ts +43 -43
  32. package/src/helpers/emails.ts +6 -6
  33. package/src/helpers/eval.ts +5 -5
  34. package/src/helpers/file.test.js +50 -50
  35. package/src/helpers/file.ts +60 -60
  36. package/src/helpers/flatted.ts +149 -149
  37. package/src/helpers/functions.ts +16 -16
  38. package/src/helpers/graph/calendar.types.ts +10 -10
  39. package/src/helpers/http.ts +69 -69
  40. package/src/helpers/images.ts +22 -22
  41. package/src/helpers/json.ts +38 -38
  42. package/src/helpers/md5.ts +189 -189
  43. package/src/helpers/objects.test.js +33 -33
  44. package/src/helpers/objects.ts +274 -274
  45. package/src/helpers/promises.test.js +37 -37
  46. package/src/helpers/promises.ts +165 -165
  47. package/src/helpers/random.ts +27 -27
  48. package/src/helpers/scheduler/scheduler.test.js +103 -103
  49. package/src/helpers/scheduler/scheduler.ts +131 -131
  50. package/src/helpers/sharepoint.ts +776 -776
  51. package/src/helpers/strings.test.js +122 -101
  52. package/src/helpers/strings.ts +337 -317
  53. package/src/helpers/typecheckers.test.js +34 -34
  54. package/src/helpers/typecheckers.ts +266 -266
  55. package/src/helpers/url.test.js +43 -43
  56. package/src/helpers/url.ts +207 -207
  57. package/src/helpers/urlhelper.ts +111 -111
  58. package/src/index.ts +6 -6
  59. package/src/types/auth.ts +54 -54
  60. package/src/types/common.types.ts +15 -15
  61. package/src/types/flatted.types.ts +59 -59
  62. package/src/types/globals.types.ts +6 -6
  63. package/src/types/graph/calendar.types.ts +80 -80
  64. package/src/types/knownscript.types.ts +18 -18
  65. package/src/types/libs/datajs.types.ts +28 -28
  66. package/src/types/libs/ics.types.ts +30 -30
  67. package/src/types/libs/msal.types.ts +49 -49
  68. package/src/types/locales.ts +124 -124
  69. package/src/types/localstoragecache.types.ts +8 -8
  70. package/src/types/location.types.ts +27 -27
  71. package/src/types/moment.ts +11 -11
  72. package/src/types/regex.types.ts +16 -16
  73. package/src/types/rest.types.ts +95 -95
  74. package/src/types/sharepoint.types.ts +1465 -1465
  75. package/src/types/sharepoint.utils.types.ts +287 -287
  76. package/src/utils/auth/common.ts +74 -74
  77. package/src/utils/auth/discovery.test.js +12 -12
  78. package/src/utils/auth/discovery.ts +132 -132
  79. package/src/utils/base64.ts +27 -27
  80. package/src/utils/consolelogger.ts +320 -320
  81. package/src/utils/date.ts +35 -35
  82. package/src/utils/emails.ts +24 -24
  83. package/src/utils/knownscript.ts +286 -286
  84. package/src/utils/localstoragecache.ts +441 -441
  85. package/src/utils/rest.ts +501 -501
  86. package/src/utils/script.ts +170 -170
  87. package/src/utils/sharepoint.rest/common.ts +154 -154
  88. package/src/utils/sharepoint.rest/date.ts +62 -62
  89. package/src/utils/sharepoint.rest/file.folder.ts +598 -598
  90. package/src/utils/sharepoint.rest/item.ts +547 -547
  91. package/src/utils/sharepoint.rest/list.ts +1480 -1480
  92. package/src/utils/sharepoint.rest/listutils/GetListItemsByCaml.ts +774 -774
  93. package/src/utils/sharepoint.rest/listutils/GetListItemsById.ts +275 -275
  94. package/src/utils/sharepoint.rest/listutils/common.ts +206 -206
  95. package/src/utils/sharepoint.rest/location.ts +141 -141
  96. package/src/utils/sharepoint.rest/navigation-links.ts +86 -86
  97. package/src/utils/sharepoint.rest/user-search.ts +252 -252
  98. package/src/utils/sharepoint.rest/user.ts +491 -491
  99. package/src/utils/sharepoint.rest/web.ts +1384 -1384
  100. package/src/utils/sod.ts +194 -194
@@ -1,599 +1,599 @@
1
- import { jsonStringify } from "../../helpers/json";
2
- import { isNotEmptyArray, isNullOrEmptyString, isNullOrUndefined, isNumber, isNumeric, newGuid } from "../../helpers/typecheckers";
3
- import { encodeURIComponentEX, makeServerRelativeUrl, normalizeUrl } from "../../helpers/url";
4
- import { IDictionary } from "../../types/common.types";
5
- import { IRequestBody, IRestOptions, IRestResponseType, jsonTypes } from "../../types/rest.types";
6
- import { IFolderBasicInfo, IFolderInfo } from "../../types/sharepoint.types";
7
- import { FileLevel, IFileInfoWithModerationStatus, ModerationStatus } from "../../types/sharepoint.utils.types";
8
- import { ConsoleLogger } from "../consolelogger";
9
- import { GetJson, GetJsonSync, longLocalCache, mediumLocalCache, noLocalCache, shortLocalCache } from "../rest";
10
- import { GetRestBaseUrl, GetSiteUrl } from "./common";
11
- import { GetListRestUrl } from "./list";
12
-
13
- const logger = ConsoleLogger.get("SharePoint.Rest.FileNFolder");
14
-
15
- let existingFolders: string[] = [];
16
-
17
- export async function EnsureFolderPath(siteUrl: string, folderServerRelativeUrl: string): Promise<boolean> {
18
- siteUrl = GetSiteUrl(siteUrl);
19
-
20
- //issue 7176
21
- folderServerRelativeUrl = makeServerRelativeUrl(folderServerRelativeUrl, siteUrl);
22
- if (existingFolders.indexOf(folderServerRelativeUrl) >= 0) {
23
- return true;
24
- }
25
-
26
- let url = `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderServerRelativeUrl}')?$select=exists`;
27
- let folder = await GetJson<{ d: { Exists: boolean; }; }>(url);
28
- if (folder && folder.d.Exists) {
29
- existingFolders.push(folderServerRelativeUrl);
30
- return true;
31
- }
32
- else {
33
- let parts = folderServerRelativeUrl.split('/');
34
- if (parts.length > 1) {
35
- let parentFolder = parts.slice(0, parts.length - 1).join('/');
36
-
37
- //ensure parent
38
- let parent = await EnsureFolderPath(siteUrl, parentFolder);
39
- if (parent) {
40
- //create it
41
- let ensure = await EnsureFolder(siteUrl, parentFolder, parts[parts.length - 1]);
42
- if (ensure.Exists) {
43
- existingFolders.push(folderServerRelativeUrl);
44
- return true;
45
- }
46
- }
47
- }
48
- }
49
- return false;
50
- }
51
-
52
- export function EnsureFolder(siteUrl: string, parentFolderServerRelativeUrl: string, folderName: string): Promise<{ Exists: boolean; ServerRelativeUrl?: string; }> {
53
- siteUrl = GetSiteUrl(siteUrl);
54
-
55
- parentFolderServerRelativeUrl = makeServerRelativeUrl(parentFolderServerRelativeUrl, siteUrl);
56
-
57
- return GetJson<{ d: { Exists: boolean; ServerRelativeUrl: string; }; }>(`${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${parentFolderServerRelativeUrl}')/folders/add(url='${folderName}')`, null, { method: "POST", spWebUrl: siteUrl })
58
- .then(r => { return r.d; })
59
- .catch<{ Exists: boolean; ServerRelativeUrl?: string; }>(() => { return { Exists: false }; });
60
- }
61
-
62
- export function DeleteFolder(siteUrl: string, folderUrl: string): Promise<boolean> {
63
- siteUrl = GetSiteUrl(siteUrl);
64
- folderUrl = makeServerRelativeUrl(folderUrl, siteUrl);
65
- var requestUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderUrl}')`;
66
-
67
- return GetJson(requestUrl, null, {
68
- method: "POST",
69
- xHttpMethod: "DELETE"
70
- })
71
- .then(r => true)
72
- .catch<boolean>((e) => false);
73
- }
74
-
75
- export function GetFolderFiles(siteUrl: string, folderUrl: string): Promise<IFileInfoWithModerationStatus[]> {
76
- siteUrl = GetSiteUrl(siteUrl);
77
- folderUrl = makeServerRelativeUrl(folderUrl, siteUrl);
78
- var requestUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderUrl}')`
79
- + `/files?$select=Level,Exists,Name,ServerRelativeUrl,Title,TimeCreated,TimeLastModified,ListItemAllFields/OData__ModerationStatus&$expand=ListItemAllFields`;
80
-
81
- return GetJson<{ d: { results: IFileInfoWithModerationStatus[]; }; }>(requestUrl).then(r => {
82
- return r.d && r.d.results || [];
83
- }).catch<IFileInfoWithModerationStatus[]>(() => {
84
- return [];
85
- });
86
- }
87
-
88
- export function UploadFileSync(siteUrl: string, folderServerRelativeUrl: string, fileName: string, fileContent: IRequestBody): {
89
- Exists: boolean;
90
- ServerRelativeUrl?: string;
91
- ListItemAllFields?: { [fieldInternalName: string]: any; };
92
- } {
93
- siteUrl = GetSiteUrl(siteUrl);
94
-
95
- folderServerRelativeUrl = makeServerRelativeUrl(folderServerRelativeUrl, siteUrl);
96
-
97
- let res = GetJsonSync<{ d: { Exists: boolean; ServerRelativeUrl: string; }; }>(
98
- `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderServerRelativeUrl}')/files/add(url='${fileName}',overwrite=true)?$expand=ListItemAllFields`,
99
- fileContent, {
100
- method: 'POST',
101
- spWebUrl: siteUrl
102
- });
103
-
104
- return res.success && res.result && res.result.d ? res.result.d : { Exists: false };
105
- }
106
-
107
- export async function UploadFile(siteUrl: string, folderServerRelativeUrl: string, fileName: string, fileContent: IRequestBody,
108
- /** default options: { overwrite: true } */
109
- options?: {
110
- overwrite?: boolean;
111
- /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
112
- autoRename?: boolean;
113
- }): Promise<{
114
- Exists: boolean;
115
- ServerRelativeUrl?: string;
116
- [fieldInternalName: string]: any;
117
- }> {
118
- siteUrl = GetSiteUrl(siteUrl);
119
-
120
- options = options || { overwrite: true };
121
-
122
- folderServerRelativeUrl = makeServerRelativeUrl(folderServerRelativeUrl, siteUrl);
123
-
124
- if (options && options.autoRename) {
125
- //get all files from this folder and find the next available name
126
- let files = await GetFolderFiles(siteUrl, folderServerRelativeUrl);
127
- let fileNames = files.map(f => f.Name.toLowerCase());
128
- let counter = 0;
129
- let originalName = fileName.split('.');
130
- originalName.splice(originalName.length - 1, 0, counter.toString());
131
- while (fileNames.includes(fileName.toLowerCase())) {
132
- counter++;
133
- originalName[originalName.length - 2] = counter.toString();
134
- fileName = originalName.join('.');
135
- }
136
- }
137
-
138
- return GetJson<{ d: { Exists: boolean; ServerRelativeUrl: string; }; }>(
139
- `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderServerRelativeUrl}')/files/add(url='${fileName}'${options.overwrite ? ',overwrite=true' : ''})?$expand=ListItemAllFields`,
140
- fileContent, {
141
- method: 'POST',
142
- spWebUrl: siteUrl,
143
- allowCache: false,
144
- postCacheKey: null
145
- })//Issue 6657 force set "POST" since we might send empty string as the value
146
- .then(r => { return r.d; })
147
- .catch<{
148
- Exists: boolean;
149
- ServerRelativeUrl?: string;
150
- [fieldInternalName: string]: any;
151
- }>(() => { return { Exists: false }; });
152
- }
153
-
154
- export async function PublishFile(siteUrl: string, fileUrl: string, comment: string = "") {
155
- let result = await _moderateFile(siteUrl, fileUrl, "publish");
156
- return result;
157
- }
158
-
159
- export async function UnpublishFile(siteUrl: string, fileUrl: string, comment: string = "") {
160
- let result = await _moderateFile(siteUrl, fileUrl, "unpublish");
161
- return result;
162
- }
163
-
164
- export async function ApproveFile(siteUrl: string, fileUrl: string, comment: string = "") {
165
- siteUrl = GetSiteUrl(siteUrl);
166
- let result = await _moderateFile(siteUrl, fileUrl, "approve");
167
- return result;
168
- }
169
-
170
- export async function RejectFile(siteUrl: string, fileUrl: string, comment: string = "") {
171
- let result = await _moderateFile(siteUrl, fileUrl, "deny");
172
- return result;
173
- }
174
-
175
- async function _moderateFile(siteUrl: string, fileUrl: string, action: "publish" | "unpublish" | "approve" | "deny", comment: string = "") {
176
- siteUrl = GetSiteUrl(siteUrl);
177
- let fileServerRelativeUrl = makeServerRelativeUrl(fileUrl, siteUrl);
178
- try {
179
- let publishUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFileByServerRelativeUrl('${fileServerRelativeUrl}')/${action}('${comment}')`;
180
- let publishResult = await GetJson<{ "odata.null": boolean }>(publishUrl, null, {
181
- method: "POST",
182
- jsonMetadata: jsonTypes.nometadata,
183
- includeDigestInPost: true
184
- });
185
- return !isNullOrUndefined(publishResult) && publishResult["odata.null"] === true;
186
- } catch {
187
- }
188
- return null;
189
- }
190
-
191
- export function RecycleFile(siteUrl: string, fileServerRelativeUrl: string): Promise<boolean> {
192
- siteUrl = GetSiteUrl(siteUrl);
193
-
194
- let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl) + "/recycle()";
195
-
196
- return GetJson(fileRestUrl, null, {
197
- method: "POST",
198
- headers: {
199
- "IF-MATCH": "*"
200
- }
201
- })
202
- .then(r => true)
203
- .catch<boolean>((e) => false);
204
- }
205
-
206
- export function DeleteFile(siteUrl: string, fileServerRelativeUrl: string): Promise<boolean> {
207
- siteUrl = GetSiteUrl(siteUrl);
208
-
209
- let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
210
-
211
- return GetJson(fileRestUrl, null, {
212
- method: "POST",
213
- xHttpMethod: "DELETE"
214
- })
215
- .then(r => true)
216
- .catch<boolean>((e) => false);
217
- }
218
-
219
- /** get the REST url for the site/_api/web/getfile....() */
220
- function GetFileRestUrl(siteUrl: string, fileServerRelativeUrl: string) {
221
- fileServerRelativeUrl = makeServerRelativeUrl(fileServerRelativeUrl, siteUrl);
222
- let fileRestUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFileByServerRelativeUrl('${fileServerRelativeUrl}')`;
223
- return fileRestUrl;
224
- }
225
-
226
- export function GetFileSync<T>(siteUrl: string, fileServerRelativeUrl: string, responseType?: IRestResponseType, options?: {
227
- /** default, short cache. */
228
- cache?: "long" | "short" | "nocache";
229
- }): { Exists: boolean; Content?: T; } {
230
- siteUrl = GetSiteUrl(siteUrl);
231
-
232
- let restOptions: IRestOptions = isNullOrUndefined(options) || options.cache !== "long"
233
- ? { ...shortLocalCache }
234
- : { ...longLocalCache };
235
-
236
- if (options && options.cache === "nocache")
237
- restOptions.forceCacheUpdate = true;
238
-
239
- if (!isNullOrUndefined(responseType)) {
240
- restOptions.responseType = responseType;
241
- }
242
-
243
- let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
244
- if (!restOptions.forceCacheUpdate && reloadCacheFileModifiedRecently(siteUrl, fileServerRelativeUrl)) {
245
- restOptions.forceCacheUpdate = true;
246
- }
247
-
248
- let response = GetJsonSync<T>(`${fileRestUrl}/$value`, null, restOptions);
249
- if (response && response.success)
250
- return {
251
- Exists: true,
252
- Content: response.result
253
- };
254
- else
255
- return {
256
- Exists: false
257
- };
258
- }
259
-
260
- export function GetFile<T>(siteUrl: string, fileServerRelativeUrl: string, allowCache?: boolean, responseType?: IRestResponseType): Promise<{ Exists: boolean; Content?: T; }> {
261
- siteUrl = GetSiteUrl(siteUrl);
262
-
263
- let options: IRestOptions = { ...(allowCache === true ? shortLocalCache : noLocalCache), forceCacheUpdate: allowCache !== true };
264
- if (!isNullOrUndefined(responseType)) {
265
- options.responseType = responseType;
266
- }
267
-
268
- let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
269
- if (!options.forceCacheUpdate && reloadCacheFileModifiedRecently(siteUrl, fileServerRelativeUrl)) {
270
- options.forceCacheUpdate = true;
271
- }
272
-
273
- return GetJson<T>(`${fileRestUrl}/$value`, null, options).then(r => {
274
- return {
275
- Exists: true,
276
- Content: r
277
- };
278
- }).catch<{ Exists: boolean; Content?: T; }>(() => {
279
- return {
280
- Exists: false
281
- };
282
- });
283
- }
284
-
285
- var $reloadCacheFileModifiedRecentlyFlagged: string[] = [];
286
- function reloadCacheFileModifiedRecently(siteUrl: string, fileServerRelativeUrl: string) {
287
- let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
288
- let key = fileRestUrl.toLowerCase();
289
-
290
- //only flag it once, first time it is requested...
291
- if (!$reloadCacheFileModifiedRecentlyFlagged.includes(key)) {
292
- try {
293
- $reloadCacheFileModifiedRecentlyFlagged.push(key);
294
-
295
- let fileInfo = GetJsonSync<{ TimeLastModified: string; }>(`${fileRestUrl}?$select=TimeLastModified`,
296
- null, {
297
- allowCache: true,//only allow in-memory cache for this
298
- jsonMetadata: jsonTypes.nometadata
299
- });
300
- if (fileInfo.success && fileInfo.result) {
301
- let modified = new Date(fileInfo.result.TimeLastModified);
302
- let now = new Date();
303
- let difference = now.getTime() - modified.getTime();
304
- if (difference < 5 * 60 * 1000) {
305
- //file has changed in the past 5 minutes - do not allow cache on it.
306
- //happens when user uses classic app to change settings, the clear cache does not clear it on the main
307
- //site URL ( support case - Issue 778 780 & 782 )
308
- return true;
309
- }
310
- }
311
- } catch (e) { }
312
- }
313
-
314
- return false;
315
- }
316
-
317
- /** Get file size (bytes) by file server relative url - can also get this by selecting FileSizeDisplay field on the item */
318
- export async function GetFileSize(siteUrl: string, fileServerRelativeUrl: string, allowCache?: boolean);
319
- /** Get file size (bytes) by list item - can also get this by selecting FileSizeDisplay field on the item */
320
- export async function GetFileSize(siteUrl: string, listId: string, itemId: number, allowCache?: boolean);
321
- export async function GetFileSize(siteUrl: string, fileServerRelativeUrlOrListId: string, itemIdOrAllowCache?: number | boolean, allowCache?: boolean): Promise<number> {
322
- siteUrl = GetSiteUrl(siteUrl);
323
-
324
- let requestUrl = "";
325
- if (isNumber(itemIdOrAllowCache) || isNumeric(itemIdOrAllowCache)) {
326
- requestUrl = GetListRestUrl(siteUrl, fileServerRelativeUrlOrListId) + `/items(${itemIdOrAllowCache})/File`;
327
- }
328
- else {
329
- allowCache = itemIdOrAllowCache === true;
330
- requestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrlOrListId);
331
- }
332
- let options: IRestOptions = { allowCache: allowCache === true, jsonMetadata: jsonTypes.nometadata };
333
-
334
- try {
335
- let result = await GetJson<{ vti_x005f_filesize: number; }>(`${requestUrl}/Properties?$select=vti_x005f_filesize`, null, options);
336
- return result.vti_x005f_filesize;
337
- } catch (e) {
338
- return null;
339
- }
340
- }
341
-
342
- export async function GetListFolders(siteUrl: string, listIdOrTitle: string): Promise<IFolderBasicInfo[]> {
343
- siteUrl = GetSiteUrl(siteUrl);
344
-
345
- //switched to get request with no meta data - much faster.
346
- let url = GetListRestUrl(siteUrl, listIdOrTitle) + `/items?$Select=Folder/ServerRelativeUrl,Folder/Name&$filter=FSObjType eq 1&$expand=Folder`;
347
-
348
- let results: IFolderBasicInfo[] = [];
349
- try {
350
- let requestResult = (await GetJson<{
351
- value: { Folder: IFolderBasicInfo; }[];
352
- }>(url, null, { allowCache: true, jsonMetadata: jsonTypes.nometadata }));
353
-
354
- if (isNotEmptyArray(requestResult && requestResult.value)) {
355
- results = requestResult.value.map(f => ({
356
- Name: f.Folder.Name,
357
- ServerRelativeUrl: normalizeUrl(f.Folder.ServerRelativeUrl)
358
- }));
359
- }
360
- } catch (e) {
361
- //Issue 7543 throttled library with lots of items will fail so return empty array
362
- logger.error(`Could not get folders from ${listIdOrTitle}, check network for more infromation.`);
363
- }
364
-
365
- return results;
366
- }
367
-
368
- export async function GetFolder(siteUrl: string, folderUrl: string, options: { allowCache?: boolean, includeFolders?: boolean, includeFiles?: boolean } = {}) {
369
- options = { includeFiles: false, includeFolders: false, allowCache: true, ...options };
370
- siteUrl = GetSiteUrl(siteUrl);
371
- try {
372
- let folderServerRelativeUrl = makeServerRelativeUrl(folderUrl, siteUrl);
373
- let restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFolderByServerRelativeUrl('${encodeURIComponentEX(folderServerRelativeUrl)}')`;
374
-
375
- if (options.includeFiles === true || options.includeFolders === true) {
376
- let expand = [];
377
- if (options.includeFiles) {
378
- expand.push("Files");
379
- }
380
- if (options.includeFolders) {
381
- expand.push("Folders");
382
- }
383
-
384
- restUrl += `?$expand=${expand.join(",")}`;
385
- }
386
-
387
- const result = await GetJson<IFolderInfo>(
388
- restUrl,
389
- null,
390
- {
391
- ...(options.allowCache ? mediumLocalCache : noLocalCache),
392
- jsonMetadata: jsonTypes.nometadata
393
- });
394
- return result;
395
- } catch {
396
- }
397
- return null;
398
- }
399
-
400
- export async function GetFileItemId(siteUrl: string, fileServerRelativeUrl: string) {
401
- siteUrl = GetSiteUrl(siteUrl);
402
- const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/ListItemAllFields/id`;
403
- const result = await GetJson<{ value: number; }>(restUrl, null, { jsonMetadata: jsonTypes.nometadata });
404
- return result.value;
405
- }
406
-
407
- export async function GetFileModerationStatus(siteUrl: string, fileServerRelativeUrl: string) {
408
- siteUrl = GetSiteUrl(siteUrl);
409
- const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/ListItemAllFields/OData__ModerationStatus`;
410
- const result = await GetJson<{ value: ModerationStatus; }>(restUrl, null, { jsonMetadata: jsonTypes.nometadata });
411
- return result.value;
412
- }
413
-
414
- export async function GetFilePublishingStatus(siteUrl: string, fileServerRelativeUrl: string) {
415
- siteUrl = GetSiteUrl(siteUrl);
416
- const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/level`;
417
- const result = await GetJson<{ value: FileLevel; }>(restUrl, null, { jsonMetadata: jsonTypes.nometadata });
418
- return result.value;
419
- }
420
-
421
- export async function GetFileItemInfo(siteUrl: string, fileServerRelativeUrl: string): Promise<{ listId: string; itemId: number; }> {
422
- try {
423
- siteUrl = GetSiteUrl(siteUrl);
424
- const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/ListItemAllFields`;
425
- const result = await GetJson<{
426
- d: {
427
- __metadata: {
428
- //returns something like this:
429
- uri: string;//"https://x.sharepoint.com/sites/xxx/_api/Web/Lists(guid'6f743572-6620-40e3-b2dd-c8099e73e9c8')/Items(11)"
430
- },
431
- Id: number;
432
- }
433
- }>(restUrl, null, {
434
- jsonMetadata: jsonTypes.verbose
435
- });
436
-
437
- const itemId = result.d.Id;
438
- const listId = result.d.__metadata.uri.split("'")[1];
439
-
440
- return { listId, itemId };
441
- }
442
- catch (e) {
443
- return null;
444
- }
445
- }
446
-
447
- export async function GetFolderItemInfo(siteUrl: string, folderServerRelativeUrl: string): Promise<{ listId: string; itemId: number; }> {
448
- try {
449
- siteUrl = GetSiteUrl(siteUrl);
450
- const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFolderByServerRelativeUrl('${encodeURIComponentEX(folderServerRelativeUrl)}')/ListItemAllFields`;
451
- const result = await GetJson<{
452
- d: {
453
- __metadata: {
454
- //returns something like this:
455
- uri: string;//"https://x.sharepoint.com/sites/xxx/_api/Web/Lists(guid'6f743572-6620-40e3-b2dd-c8099e73e9c8')/Items(11)"
456
- },
457
- Id: number;
458
- }
459
- }>(restUrl, null, { jsonMetadata: jsonTypes.verbose });
460
-
461
- const itemId = result.d.Id;
462
- const listId = result.d.__metadata.uri.split("'")[1];
463
-
464
- return { listId, itemId };
465
- }
466
- catch (e) { return null; }
467
- }
468
-
469
- interface iWebPartPageProps {
470
- /** webpart id */
471
- id: string;
472
- /** unique instance id - random guid, or blank to auto-generate */
473
- instanceId?: string;
474
- title: string;
475
- description: string;
476
- dataVersion?: "1.0";
477
- properties: IDictionary<string | boolean>
478
- }
479
- interface iWebPartPageResult {
480
- /** site relative random page name, such as: "SitePages/y2k9xm8v.aspx" */
481
- value: string;
482
- }
483
- /** Creates a modern single app page and return its URL. if a file in that name exists, it will return one with (1) appended to it. */
484
- export async function CreateAppPage(siteUrl: string, info: {
485
- /** file name, without extension */
486
- name: string; webPartDataAsJson: iWebPartPageProps
487
- }) {
488
- //read more:
489
- //https://petelus.sharepoint.com/sites/CMSTest/_api/SitePages/Pages/CreateAppPage
490
- //https://spblog.net/post/2019/03/05/what-s-new-and-what-s-changed-in-sharepoint-online-rest-api-in-january-february-2019
491
-
492
- function getFileServerRelativeUrl(siteRelative: string) {
493
- const fileRelativeUrl = makeServerRelativeUrl(`${siteUrl}${siteRelative}`);
494
- return fileRelativeUrl;
495
- }
496
-
497
- let webPartDataAsJson = info.webPartDataAsJson;
498
- if (isNullOrEmptyString(webPartDataAsJson.instanceId))
499
- webPartDataAsJson.instanceId = newGuid();
500
- if (isNullOrEmptyString(webPartDataAsJson.dataVersion))
501
- webPartDataAsJson.dataVersion = "1.0";
502
-
503
- return logger.groupAsync("CreateAppPage", async log => {
504
- siteUrl = GetSiteUrl(siteUrl);
505
- const restUrl = `${GetRestBaseUrl(siteUrl)}/SitePages/Pages/CreateAppPage`;
506
- const result = await GetJson<iWebPartPageResult>(restUrl, jsonStringify({
507
- webPartDataAsJson: jsonStringify(webPartDataAsJson)
508
- }), { method: 'POST', jsonMetadata: jsonTypes.nometadata });
509
- log(`created page`);
510
- log(jsonStringify(result));
511
-
512
- let fileRelativeUrl = getFileServerRelativeUrl(result.value);
513
-
514
- const fileId = await GetFileItemId(siteUrl, fileRelativeUrl);
515
- const updateRestUrl = `${GetRestBaseUrl(siteUrl)}/SitePages/Pages/UpdateAppPage`;
516
- const updateResult = await GetJson<iWebPartPageResult>(updateRestUrl, jsonStringify({
517
- pageId: fileId,
518
- title: info.name,
519
- webPartDataAsJson: jsonStringify(webPartDataAsJson)
520
- }), { method: 'POST', jsonMetadata: jsonTypes.nometadata });
521
-
522
- log(`updated page`);
523
- log(jsonStringify(updateResult));
524
-
525
- fileRelativeUrl = getFileServerRelativeUrl(updateResult.value);
526
-
527
- return fileRelativeUrl;
528
- });
529
- }
530
-
531
- /** Move a file to a new name/url, this API allows for changing file extension as well */
532
- export async function MoveFile(siteUrl: string, currentServerRelativeUrl: string, targetServerRelativeUrl: string, options?: {
533
- overwrite?: boolean;
534
- /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
535
- autoRename?: boolean;
536
- }) {
537
- return CopyOrMoveFile(siteUrl, currentServerRelativeUrl, targetServerRelativeUrl, "move", options);
538
- //this does NOT allow to change the file extension. only file name.
539
- // return UpdateItem(siteUrl, listIdOrTitle, itemId, {
540
- // FileLeafRef: newFileName "hello.txt" >> "hello.md" won't work.
541
- // });
542
- }
543
-
544
- /** Copy a file to a new name/url, this API allows for changing file extension as well */
545
- export async function CopyFile(siteUrl: string, currentServerRelativeUrl: string, targetServerRelativeUrl: string, options?: {
546
- overwrite?: boolean;
547
- /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
548
- autoRename?: boolean;
549
- }) {
550
- return CopyOrMoveFile(siteUrl, currentServerRelativeUrl, targetServerRelativeUrl, "copy", options);
551
- }
552
-
553
- async function CopyOrMoveFile(siteUrl: string, currentServerRelativeUrl: string, targetServerRelativeUrl: string, action: "copy" | "move", options?: {
554
- overwrite?: boolean;
555
- /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
556
- autoRename?: boolean;
557
- }) {
558
- try {
559
-
560
- if (options && options.autoRename) {
561
- let targetParts = targetServerRelativeUrl.split('/');
562
- let fileName = targetParts.pop();
563
- let targetFolderUrl = targetParts.join('/');
564
- //get all files from this folder and find the next available name
565
- let files = await GetFolderFiles(siteUrl, targetFolderUrl);
566
- let fileNames = files.map(f => f.Name.toLowerCase());
567
- let counter = 0;
568
- let originalName = fileName.split('.');
569
- originalName.splice(originalName.length - 1, 0, counter.toString());
570
- while (fileNames.includes(fileName.toLowerCase())) {
571
- counter++;
572
- originalName[originalName.length - 2] = counter.toString();
573
- fileName = originalName.join('.');
574
- }
575
- targetServerRelativeUrl = `${targetFolderUrl}/${fileName}`;
576
- }
577
-
578
- let url = `${GetRestBaseUrl(siteUrl)}/web/getfilebyserverrelativeurl('${currentServerRelativeUrl}')/`
579
- if (action === "copy") {
580
- url += `copyto(strNewUrl='${targetServerRelativeUrl}',bOverwrite=${options && options.overwrite ? "true" : "false"})`;
581
- } else {
582
- url += `moveto(newurl='${targetServerRelativeUrl}',flags=${options && options.overwrite ? 1 : 0})`;
583
- }
584
-
585
- let result = await GetJson(url, undefined, {
586
- method: "POST",
587
- jsonMetadata: jsonTypes.nometadata
588
- });
589
- logger.json(result, "CopyOrMoveFile");
590
- return true;
591
- } catch (e) {
592
- logger.json(e, "CopyOrMoveFile");
593
- return false;
594
- }
595
- //this does NOT allow to change the file extension. only file name.
596
- // return UpdateItem(siteUrl, listIdOrTitle, itemId, {
597
- // FileLeafRef: newFileName "hello.txt" >> "hello.md" won't work.
598
- // });
1
+ import { jsonStringify } from "../../helpers/json";
2
+ import { isNotEmptyArray, isNullOrEmptyString, isNullOrUndefined, isNumber, isNumeric, newGuid } from "../../helpers/typecheckers";
3
+ import { encodeURIComponentEX, makeServerRelativeUrl, normalizeUrl } from "../../helpers/url";
4
+ import { IDictionary } from "../../types/common.types";
5
+ import { IRequestBody, IRestOptions, IRestResponseType, jsonTypes } from "../../types/rest.types";
6
+ import { IFolderBasicInfo, IFolderInfo } from "../../types/sharepoint.types";
7
+ import { FileLevel, IFileInfoWithModerationStatus, ModerationStatus } from "../../types/sharepoint.utils.types";
8
+ import { ConsoleLogger } from "../consolelogger";
9
+ import { GetJson, GetJsonSync, longLocalCache, mediumLocalCache, noLocalCache, shortLocalCache } from "../rest";
10
+ import { GetRestBaseUrl, GetSiteUrl } from "./common";
11
+ import { GetListRestUrl } from "./list";
12
+
13
+ const logger = ConsoleLogger.get("SharePoint.Rest.FileNFolder");
14
+
15
+ let existingFolders: string[] = [];
16
+
17
+ export async function EnsureFolderPath(siteUrl: string, folderServerRelativeUrl: string): Promise<boolean> {
18
+ siteUrl = GetSiteUrl(siteUrl);
19
+
20
+ //issue 7176
21
+ folderServerRelativeUrl = makeServerRelativeUrl(folderServerRelativeUrl, siteUrl);
22
+ if (existingFolders.indexOf(folderServerRelativeUrl) >= 0) {
23
+ return true;
24
+ }
25
+
26
+ let url = `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderServerRelativeUrl}')?$select=exists`;
27
+ let folder = await GetJson<{ d: { Exists: boolean; }; }>(url);
28
+ if (folder && folder.d.Exists) {
29
+ existingFolders.push(folderServerRelativeUrl);
30
+ return true;
31
+ }
32
+ else {
33
+ let parts = folderServerRelativeUrl.split('/');
34
+ if (parts.length > 1) {
35
+ let parentFolder = parts.slice(0, parts.length - 1).join('/');
36
+
37
+ //ensure parent
38
+ let parent = await EnsureFolderPath(siteUrl, parentFolder);
39
+ if (parent) {
40
+ //create it
41
+ let ensure = await EnsureFolder(siteUrl, parentFolder, parts[parts.length - 1]);
42
+ if (ensure.Exists) {
43
+ existingFolders.push(folderServerRelativeUrl);
44
+ return true;
45
+ }
46
+ }
47
+ }
48
+ }
49
+ return false;
50
+ }
51
+
52
+ export function EnsureFolder(siteUrl: string, parentFolderServerRelativeUrl: string, folderName: string): Promise<{ Exists: boolean; ServerRelativeUrl?: string; }> {
53
+ siteUrl = GetSiteUrl(siteUrl);
54
+
55
+ parentFolderServerRelativeUrl = makeServerRelativeUrl(parentFolderServerRelativeUrl, siteUrl);
56
+
57
+ return GetJson<{ d: { Exists: boolean; ServerRelativeUrl: string; }; }>(`${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${parentFolderServerRelativeUrl}')/folders/add(url='${folderName}')`, null, { method: "POST", spWebUrl: siteUrl })
58
+ .then(r => { return r.d; })
59
+ .catch<{ Exists: boolean; ServerRelativeUrl?: string; }>(() => { return { Exists: false }; });
60
+ }
61
+
62
+ export function DeleteFolder(siteUrl: string, folderUrl: string): Promise<boolean> {
63
+ siteUrl = GetSiteUrl(siteUrl);
64
+ folderUrl = makeServerRelativeUrl(folderUrl, siteUrl);
65
+ var requestUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderUrl}')`;
66
+
67
+ return GetJson(requestUrl, null, {
68
+ method: "POST",
69
+ xHttpMethod: "DELETE"
70
+ })
71
+ .then(r => true)
72
+ .catch<boolean>((e) => false);
73
+ }
74
+
75
+ export function GetFolderFiles(siteUrl: string, folderUrl: string): Promise<IFileInfoWithModerationStatus[]> {
76
+ siteUrl = GetSiteUrl(siteUrl);
77
+ folderUrl = makeServerRelativeUrl(folderUrl, siteUrl);
78
+ var requestUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderUrl}')`
79
+ + `/files?$select=Level,Exists,Name,ServerRelativeUrl,Title,TimeCreated,TimeLastModified,ListItemAllFields/OData__ModerationStatus&$expand=ListItemAllFields`;
80
+
81
+ return GetJson<{ d: { results: IFileInfoWithModerationStatus[]; }; }>(requestUrl).then(r => {
82
+ return r.d && r.d.results || [];
83
+ }).catch<IFileInfoWithModerationStatus[]>(() => {
84
+ return [];
85
+ });
86
+ }
87
+
88
+ export function UploadFileSync(siteUrl: string, folderServerRelativeUrl: string, fileName: string, fileContent: IRequestBody): {
89
+ Exists: boolean;
90
+ ServerRelativeUrl?: string;
91
+ ListItemAllFields?: { [fieldInternalName: string]: any; };
92
+ } {
93
+ siteUrl = GetSiteUrl(siteUrl);
94
+
95
+ folderServerRelativeUrl = makeServerRelativeUrl(folderServerRelativeUrl, siteUrl);
96
+
97
+ let res = GetJsonSync<{ d: { Exists: boolean; ServerRelativeUrl: string; }; }>(
98
+ `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderServerRelativeUrl}')/files/add(url='${fileName}',overwrite=true)?$expand=ListItemAllFields`,
99
+ fileContent, {
100
+ method: 'POST',
101
+ spWebUrl: siteUrl
102
+ });
103
+
104
+ return res.success && res.result && res.result.d ? res.result.d : { Exists: false };
105
+ }
106
+
107
+ export async function UploadFile(siteUrl: string, folderServerRelativeUrl: string, fileName: string, fileContent: IRequestBody,
108
+ /** default options: { overwrite: true } */
109
+ options?: {
110
+ overwrite?: boolean;
111
+ /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
112
+ autoRename?: boolean;
113
+ }): Promise<{
114
+ Exists: boolean;
115
+ ServerRelativeUrl?: string;
116
+ [fieldInternalName: string]: any;
117
+ }> {
118
+ siteUrl = GetSiteUrl(siteUrl);
119
+
120
+ options = options || { overwrite: true };
121
+
122
+ folderServerRelativeUrl = makeServerRelativeUrl(folderServerRelativeUrl, siteUrl);
123
+
124
+ if (options && options.autoRename) {
125
+ //get all files from this folder and find the next available name
126
+ let files = await GetFolderFiles(siteUrl, folderServerRelativeUrl);
127
+ let fileNames = files.map(f => f.Name.toLowerCase());
128
+ let counter = 0;
129
+ let originalName = fileName.split('.');
130
+ originalName.splice(originalName.length - 1, 0, counter.toString());
131
+ while (fileNames.includes(fileName.toLowerCase())) {
132
+ counter++;
133
+ originalName[originalName.length - 2] = counter.toString();
134
+ fileName = originalName.join('.');
135
+ }
136
+ }
137
+
138
+ return GetJson<{ d: { Exists: boolean; ServerRelativeUrl: string; }; }>(
139
+ `${GetRestBaseUrl(siteUrl)}/Web/getFolderByServerRelativeUrl(serverRelativeUrl='${folderServerRelativeUrl}')/files/add(url='${fileName}'${options.overwrite ? ',overwrite=true' : ''})?$expand=ListItemAllFields`,
140
+ fileContent, {
141
+ method: 'POST',
142
+ spWebUrl: siteUrl,
143
+ allowCache: false,
144
+ postCacheKey: null
145
+ })//Issue 6657 force set "POST" since we might send empty string as the value
146
+ .then(r => { return r.d; })
147
+ .catch<{
148
+ Exists: boolean;
149
+ ServerRelativeUrl?: string;
150
+ [fieldInternalName: string]: any;
151
+ }>(() => { return { Exists: false }; });
152
+ }
153
+
154
+ export async function PublishFile(siteUrl: string, fileUrl: string, comment: string = "") {
155
+ let result = await _moderateFile(siteUrl, fileUrl, "publish");
156
+ return result;
157
+ }
158
+
159
+ export async function UnpublishFile(siteUrl: string, fileUrl: string, comment: string = "") {
160
+ let result = await _moderateFile(siteUrl, fileUrl, "unpublish");
161
+ return result;
162
+ }
163
+
164
+ export async function ApproveFile(siteUrl: string, fileUrl: string, comment: string = "") {
165
+ siteUrl = GetSiteUrl(siteUrl);
166
+ let result = await _moderateFile(siteUrl, fileUrl, "approve");
167
+ return result;
168
+ }
169
+
170
+ export async function RejectFile(siteUrl: string, fileUrl: string, comment: string = "") {
171
+ let result = await _moderateFile(siteUrl, fileUrl, "deny");
172
+ return result;
173
+ }
174
+
175
+ async function _moderateFile(siteUrl: string, fileUrl: string, action: "publish" | "unpublish" | "approve" | "deny", comment: string = "") {
176
+ siteUrl = GetSiteUrl(siteUrl);
177
+ let fileServerRelativeUrl = makeServerRelativeUrl(fileUrl, siteUrl);
178
+ try {
179
+ let publishUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFileByServerRelativeUrl('${fileServerRelativeUrl}')/${action}('${comment}')`;
180
+ let publishResult = await GetJson<{ "odata.null": boolean }>(publishUrl, null, {
181
+ method: "POST",
182
+ jsonMetadata: jsonTypes.nometadata,
183
+ includeDigestInPost: true
184
+ });
185
+ return !isNullOrUndefined(publishResult) && publishResult["odata.null"] === true;
186
+ } catch {
187
+ }
188
+ return null;
189
+ }
190
+
191
+ export function RecycleFile(siteUrl: string, fileServerRelativeUrl: string): Promise<boolean> {
192
+ siteUrl = GetSiteUrl(siteUrl);
193
+
194
+ let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl) + "/recycle()";
195
+
196
+ return GetJson(fileRestUrl, null, {
197
+ method: "POST",
198
+ headers: {
199
+ "IF-MATCH": "*"
200
+ }
201
+ })
202
+ .then(r => true)
203
+ .catch<boolean>((e) => false);
204
+ }
205
+
206
+ export function DeleteFile(siteUrl: string, fileServerRelativeUrl: string): Promise<boolean> {
207
+ siteUrl = GetSiteUrl(siteUrl);
208
+
209
+ let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
210
+
211
+ return GetJson(fileRestUrl, null, {
212
+ method: "POST",
213
+ xHttpMethod: "DELETE"
214
+ })
215
+ .then(r => true)
216
+ .catch<boolean>((e) => false);
217
+ }
218
+
219
+ /** get the REST url for the site/_api/web/getfile....() */
220
+ function GetFileRestUrl(siteUrl: string, fileServerRelativeUrl: string) {
221
+ fileServerRelativeUrl = makeServerRelativeUrl(fileServerRelativeUrl, siteUrl);
222
+ let fileRestUrl = `${GetRestBaseUrl(siteUrl)}/Web/getFileByServerRelativeUrl('${fileServerRelativeUrl}')`;
223
+ return fileRestUrl;
224
+ }
225
+
226
+ export function GetFileSync<T>(siteUrl: string, fileServerRelativeUrl: string, responseType?: IRestResponseType, options?: {
227
+ /** default, short cache. */
228
+ cache?: "long" | "short" | "nocache";
229
+ }): { Exists: boolean; Content?: T; } {
230
+ siteUrl = GetSiteUrl(siteUrl);
231
+
232
+ let restOptions: IRestOptions = isNullOrUndefined(options) || options.cache !== "long"
233
+ ? { ...shortLocalCache }
234
+ : { ...longLocalCache };
235
+
236
+ if (options && options.cache === "nocache")
237
+ restOptions.forceCacheUpdate = true;
238
+
239
+ if (!isNullOrUndefined(responseType)) {
240
+ restOptions.responseType = responseType;
241
+ }
242
+
243
+ let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
244
+ if (!restOptions.forceCacheUpdate && reloadCacheFileModifiedRecently(siteUrl, fileServerRelativeUrl)) {
245
+ restOptions.forceCacheUpdate = true;
246
+ }
247
+
248
+ let response = GetJsonSync<T>(`${fileRestUrl}/$value`, null, restOptions);
249
+ if (response && response.success)
250
+ return {
251
+ Exists: true,
252
+ Content: response.result
253
+ };
254
+ else
255
+ return {
256
+ Exists: false
257
+ };
258
+ }
259
+
260
+ export function GetFile<T>(siteUrl: string, fileServerRelativeUrl: string, allowCache?: boolean, responseType?: IRestResponseType): Promise<{ Exists: boolean; Content?: T; }> {
261
+ siteUrl = GetSiteUrl(siteUrl);
262
+
263
+ let options: IRestOptions = { ...(allowCache === true ? shortLocalCache : noLocalCache), forceCacheUpdate: allowCache !== true };
264
+ if (!isNullOrUndefined(responseType)) {
265
+ options.responseType = responseType;
266
+ }
267
+
268
+ let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
269
+ if (!options.forceCacheUpdate && reloadCacheFileModifiedRecently(siteUrl, fileServerRelativeUrl)) {
270
+ options.forceCacheUpdate = true;
271
+ }
272
+
273
+ return GetJson<T>(`${fileRestUrl}/$value`, null, options).then(r => {
274
+ return {
275
+ Exists: true,
276
+ Content: r
277
+ };
278
+ }).catch<{ Exists: boolean; Content?: T; }>(() => {
279
+ return {
280
+ Exists: false
281
+ };
282
+ });
283
+ }
284
+
285
+ var $reloadCacheFileModifiedRecentlyFlagged: string[] = [];
286
+ function reloadCacheFileModifiedRecently(siteUrl: string, fileServerRelativeUrl: string) {
287
+ let fileRestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrl);
288
+ let key = fileRestUrl.toLowerCase();
289
+
290
+ //only flag it once, first time it is requested...
291
+ if (!$reloadCacheFileModifiedRecentlyFlagged.includes(key)) {
292
+ try {
293
+ $reloadCacheFileModifiedRecentlyFlagged.push(key);
294
+
295
+ let fileInfo = GetJsonSync<{ TimeLastModified: string; }>(`${fileRestUrl}?$select=TimeLastModified`,
296
+ null, {
297
+ allowCache: true,//only allow in-memory cache for this
298
+ jsonMetadata: jsonTypes.nometadata
299
+ });
300
+ if (fileInfo.success && fileInfo.result) {
301
+ let modified = new Date(fileInfo.result.TimeLastModified);
302
+ let now = new Date();
303
+ let difference = now.getTime() - modified.getTime();
304
+ if (difference < 5 * 60 * 1000) {
305
+ //file has changed in the past 5 minutes - do not allow cache on it.
306
+ //happens when user uses classic app to change settings, the clear cache does not clear it on the main
307
+ //site URL ( support case - Issue 778 780 & 782 )
308
+ return true;
309
+ }
310
+ }
311
+ } catch (e) { }
312
+ }
313
+
314
+ return false;
315
+ }
316
+
317
+ /** Get file size (bytes) by file server relative url - can also get this by selecting FileSizeDisplay field on the item */
318
+ export async function GetFileSize(siteUrl: string, fileServerRelativeUrl: string, allowCache?: boolean);
319
+ /** Get file size (bytes) by list item - can also get this by selecting FileSizeDisplay field on the item */
320
+ export async function GetFileSize(siteUrl: string, listId: string, itemId: number, allowCache?: boolean);
321
+ export async function GetFileSize(siteUrl: string, fileServerRelativeUrlOrListId: string, itemIdOrAllowCache?: number | boolean, allowCache?: boolean): Promise<number> {
322
+ siteUrl = GetSiteUrl(siteUrl);
323
+
324
+ let requestUrl = "";
325
+ if (isNumber(itemIdOrAllowCache) || isNumeric(itemIdOrAllowCache)) {
326
+ requestUrl = GetListRestUrl(siteUrl, fileServerRelativeUrlOrListId) + `/items(${itemIdOrAllowCache})/File`;
327
+ }
328
+ else {
329
+ allowCache = itemIdOrAllowCache === true;
330
+ requestUrl = GetFileRestUrl(siteUrl, fileServerRelativeUrlOrListId);
331
+ }
332
+ let options: IRestOptions = { allowCache: allowCache === true, jsonMetadata: jsonTypes.nometadata };
333
+
334
+ try {
335
+ let result = await GetJson<{ vti_x005f_filesize: number; }>(`${requestUrl}/Properties?$select=vti_x005f_filesize`, null, options);
336
+ return result.vti_x005f_filesize;
337
+ } catch (e) {
338
+ return null;
339
+ }
340
+ }
341
+
342
+ export async function GetListFolders(siteUrl: string, listIdOrTitle: string): Promise<IFolderBasicInfo[]> {
343
+ siteUrl = GetSiteUrl(siteUrl);
344
+
345
+ //switched to get request with no meta data - much faster.
346
+ let url = GetListRestUrl(siteUrl, listIdOrTitle) + `/items?$Select=Folder/ServerRelativeUrl,Folder/Name&$filter=FSObjType eq 1&$expand=Folder`;
347
+
348
+ let results: IFolderBasicInfo[] = [];
349
+ try {
350
+ let requestResult = (await GetJson<{
351
+ value: { Folder: IFolderBasicInfo; }[];
352
+ }>(url, null, { allowCache: true, jsonMetadata: jsonTypes.nometadata }));
353
+
354
+ if (isNotEmptyArray(requestResult && requestResult.value)) {
355
+ results = requestResult.value.map(f => ({
356
+ Name: f.Folder.Name,
357
+ ServerRelativeUrl: normalizeUrl(f.Folder.ServerRelativeUrl)
358
+ }));
359
+ }
360
+ } catch (e) {
361
+ //Issue 7543 throttled library with lots of items will fail so return empty array
362
+ logger.error(`Could not get folders from ${listIdOrTitle}, check network for more infromation.`);
363
+ }
364
+
365
+ return results;
366
+ }
367
+
368
+ export async function GetFolder(siteUrl: string, folderUrl: string, options: { allowCache?: boolean, includeFolders?: boolean, includeFiles?: boolean } = {}) {
369
+ options = { includeFiles: false, includeFolders: false, allowCache: true, ...options };
370
+ siteUrl = GetSiteUrl(siteUrl);
371
+ try {
372
+ let folderServerRelativeUrl = makeServerRelativeUrl(folderUrl, siteUrl);
373
+ let restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFolderByServerRelativeUrl('${encodeURIComponentEX(folderServerRelativeUrl)}')`;
374
+
375
+ if (options.includeFiles === true || options.includeFolders === true) {
376
+ let expand = [];
377
+ if (options.includeFiles) {
378
+ expand.push("Files");
379
+ }
380
+ if (options.includeFolders) {
381
+ expand.push("Folders");
382
+ }
383
+
384
+ restUrl += `?$expand=${expand.join(",")}`;
385
+ }
386
+
387
+ const result = await GetJson<IFolderInfo>(
388
+ restUrl,
389
+ null,
390
+ {
391
+ ...(options.allowCache ? mediumLocalCache : noLocalCache),
392
+ jsonMetadata: jsonTypes.nometadata
393
+ });
394
+ return result;
395
+ } catch {
396
+ }
397
+ return null;
398
+ }
399
+
400
+ export async function GetFileItemId(siteUrl: string, fileServerRelativeUrl: string) {
401
+ siteUrl = GetSiteUrl(siteUrl);
402
+ const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/ListItemAllFields/id`;
403
+ const result = await GetJson<{ value: number; }>(restUrl, null, { jsonMetadata: jsonTypes.nometadata });
404
+ return result.value;
405
+ }
406
+
407
+ export async function GetFileModerationStatus(siteUrl: string, fileServerRelativeUrl: string) {
408
+ siteUrl = GetSiteUrl(siteUrl);
409
+ const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/ListItemAllFields/OData__ModerationStatus`;
410
+ const result = await GetJson<{ value: ModerationStatus; }>(restUrl, null, { jsonMetadata: jsonTypes.nometadata });
411
+ return result.value;
412
+ }
413
+
414
+ export async function GetFilePublishingStatus(siteUrl: string, fileServerRelativeUrl: string) {
415
+ siteUrl = GetSiteUrl(siteUrl);
416
+ const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/level`;
417
+ const result = await GetJson<{ value: FileLevel; }>(restUrl, null, { jsonMetadata: jsonTypes.nometadata });
418
+ return result.value;
419
+ }
420
+
421
+ export async function GetFileItemInfo(siteUrl: string, fileServerRelativeUrl: string): Promise<{ listId: string; itemId: number; }> {
422
+ try {
423
+ siteUrl = GetSiteUrl(siteUrl);
424
+ const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFileByServerRelativeUrl('${encodeURIComponentEX(fileServerRelativeUrl)}')/ListItemAllFields`;
425
+ const result = await GetJson<{
426
+ d: {
427
+ __metadata: {
428
+ //returns something like this:
429
+ uri: string;//"https://x.sharepoint.com/sites/xxx/_api/Web/Lists(guid'6f743572-6620-40e3-b2dd-c8099e73e9c8')/Items(11)"
430
+ },
431
+ Id: number;
432
+ }
433
+ }>(restUrl, null, {
434
+ jsonMetadata: jsonTypes.verbose
435
+ });
436
+
437
+ const itemId = result.d.Id;
438
+ const listId = result.d.__metadata.uri.split("'")[1];
439
+
440
+ return { listId, itemId };
441
+ }
442
+ catch (e) {
443
+ return null;
444
+ }
445
+ }
446
+
447
+ export async function GetFolderItemInfo(siteUrl: string, folderServerRelativeUrl: string): Promise<{ listId: string; itemId: number; }> {
448
+ try {
449
+ siteUrl = GetSiteUrl(siteUrl);
450
+ const restUrl = `${GetRestBaseUrl(siteUrl)}/web/getFolderByServerRelativeUrl('${encodeURIComponentEX(folderServerRelativeUrl)}')/ListItemAllFields`;
451
+ const result = await GetJson<{
452
+ d: {
453
+ __metadata: {
454
+ //returns something like this:
455
+ uri: string;//"https://x.sharepoint.com/sites/xxx/_api/Web/Lists(guid'6f743572-6620-40e3-b2dd-c8099e73e9c8')/Items(11)"
456
+ },
457
+ Id: number;
458
+ }
459
+ }>(restUrl, null, { jsonMetadata: jsonTypes.verbose });
460
+
461
+ const itemId = result.d.Id;
462
+ const listId = result.d.__metadata.uri.split("'")[1];
463
+
464
+ return { listId, itemId };
465
+ }
466
+ catch (e) { return null; }
467
+ }
468
+
469
+ interface iWebPartPageProps {
470
+ /** webpart id */
471
+ id: string;
472
+ /** unique instance id - random guid, or blank to auto-generate */
473
+ instanceId?: string;
474
+ title: string;
475
+ description: string;
476
+ dataVersion?: "1.0";
477
+ properties: IDictionary<string | boolean>
478
+ }
479
+ interface iWebPartPageResult {
480
+ /** site relative random page name, such as: "SitePages/y2k9xm8v.aspx" */
481
+ value: string;
482
+ }
483
+ /** Creates a modern single app page and return its URL. if a file in that name exists, it will return one with (1) appended to it. */
484
+ export async function CreateAppPage(siteUrl: string, info: {
485
+ /** file name, without extension */
486
+ name: string; webPartDataAsJson: iWebPartPageProps
487
+ }) {
488
+ //read more:
489
+ //https://petelus.sharepoint.com/sites/CMSTest/_api/SitePages/Pages/CreateAppPage
490
+ //https://spblog.net/post/2019/03/05/what-s-new-and-what-s-changed-in-sharepoint-online-rest-api-in-january-february-2019
491
+
492
+ function getFileServerRelativeUrl(siteRelative: string) {
493
+ const fileRelativeUrl = makeServerRelativeUrl(`${siteUrl}${siteRelative}`);
494
+ return fileRelativeUrl;
495
+ }
496
+
497
+ let webPartDataAsJson = info.webPartDataAsJson;
498
+ if (isNullOrEmptyString(webPartDataAsJson.instanceId))
499
+ webPartDataAsJson.instanceId = newGuid();
500
+ if (isNullOrEmptyString(webPartDataAsJson.dataVersion))
501
+ webPartDataAsJson.dataVersion = "1.0";
502
+
503
+ return logger.groupAsync("CreateAppPage", async log => {
504
+ siteUrl = GetSiteUrl(siteUrl);
505
+ const restUrl = `${GetRestBaseUrl(siteUrl)}/SitePages/Pages/CreateAppPage`;
506
+ const result = await GetJson<iWebPartPageResult>(restUrl, jsonStringify({
507
+ webPartDataAsJson: jsonStringify(webPartDataAsJson)
508
+ }), { method: 'POST', jsonMetadata: jsonTypes.nometadata });
509
+ log(`created page`);
510
+ log(jsonStringify(result));
511
+
512
+ let fileRelativeUrl = getFileServerRelativeUrl(result.value);
513
+
514
+ const fileId = await GetFileItemId(siteUrl, fileRelativeUrl);
515
+ const updateRestUrl = `${GetRestBaseUrl(siteUrl)}/SitePages/Pages/UpdateAppPage`;
516
+ const updateResult = await GetJson<iWebPartPageResult>(updateRestUrl, jsonStringify({
517
+ pageId: fileId,
518
+ title: info.name,
519
+ webPartDataAsJson: jsonStringify(webPartDataAsJson)
520
+ }), { method: 'POST', jsonMetadata: jsonTypes.nometadata });
521
+
522
+ log(`updated page`);
523
+ log(jsonStringify(updateResult));
524
+
525
+ fileRelativeUrl = getFileServerRelativeUrl(updateResult.value);
526
+
527
+ return fileRelativeUrl;
528
+ });
529
+ }
530
+
531
+ /** Move a file to a new name/url, this API allows for changing file extension as well */
532
+ export async function MoveFile(siteUrl: string, currentServerRelativeUrl: string, targetServerRelativeUrl: string, options?: {
533
+ overwrite?: boolean;
534
+ /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
535
+ autoRename?: boolean;
536
+ }) {
537
+ return CopyOrMoveFile(siteUrl, currentServerRelativeUrl, targetServerRelativeUrl, "move", options);
538
+ //this does NOT allow to change the file extension. only file name.
539
+ // return UpdateItem(siteUrl, listIdOrTitle, itemId, {
540
+ // FileLeafRef: newFileName "hello.txt" >> "hello.md" won't work.
541
+ // });
542
+ }
543
+
544
+ /** Copy a file to a new name/url, this API allows for changing file extension as well */
545
+ export async function CopyFile(siteUrl: string, currentServerRelativeUrl: string, targetServerRelativeUrl: string, options?: {
546
+ overwrite?: boolean;
547
+ /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
548
+ autoRename?: boolean;
549
+ }) {
550
+ return CopyOrMoveFile(siteUrl, currentServerRelativeUrl, targetServerRelativeUrl, "copy", options);
551
+ }
552
+
553
+ async function CopyOrMoveFile(siteUrl: string, currentServerRelativeUrl: string, targetServerRelativeUrl: string, action: "copy" | "move", options?: {
554
+ overwrite?: boolean;
555
+ /** set to true to automatically find the next available file name. uploading file.ext to a folder that has that file will upload a file named file.1.ext instead */
556
+ autoRename?: boolean;
557
+ }) {
558
+ try {
559
+
560
+ if (options && options.autoRename) {
561
+ let targetParts = targetServerRelativeUrl.split('/');
562
+ let fileName = targetParts.pop();
563
+ let targetFolderUrl = targetParts.join('/');
564
+ //get all files from this folder and find the next available name
565
+ let files = await GetFolderFiles(siteUrl, targetFolderUrl);
566
+ let fileNames = files.map(f => f.Name.toLowerCase());
567
+ let counter = 0;
568
+ let originalName = fileName.split('.');
569
+ originalName.splice(originalName.length - 1, 0, counter.toString());
570
+ while (fileNames.includes(fileName.toLowerCase())) {
571
+ counter++;
572
+ originalName[originalName.length - 2] = counter.toString();
573
+ fileName = originalName.join('.');
574
+ }
575
+ targetServerRelativeUrl = `${targetFolderUrl}/${fileName}`;
576
+ }
577
+
578
+ let url = `${GetRestBaseUrl(siteUrl)}/web/getfilebyserverrelativeurl('${currentServerRelativeUrl}')/`
579
+ if (action === "copy") {
580
+ url += `copyto(strNewUrl='${targetServerRelativeUrl}',bOverwrite=${options && options.overwrite ? "true" : "false"})`;
581
+ } else {
582
+ url += `moveto(newurl='${targetServerRelativeUrl}',flags=${options && options.overwrite ? 1 : 0})`;
583
+ }
584
+
585
+ let result = await GetJson(url, undefined, {
586
+ method: "POST",
587
+ jsonMetadata: jsonTypes.nometadata
588
+ });
589
+ logger.json(result, "CopyOrMoveFile");
590
+ return true;
591
+ } catch (e) {
592
+ logger.json(e, "CopyOrMoveFile");
593
+ return false;
594
+ }
595
+ //this does NOT allow to change the file extension. only file name.
596
+ // return UpdateItem(siteUrl, listIdOrTitle, itemId, {
597
+ // FileLeafRef: newFileName "hello.txt" >> "hello.md" won't work.
598
+ // });
599
599
  }