@kwiz/common 1.0.132 → 1.0.133

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