@kwiz/common 1.0.107 → 1.0.109

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 (116) 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/browser.js +9 -5
  6. package/lib/cjs/helpers/browser.js.map +1 -1
  7. package/lib/cjs/types/libs/msal.types.js +26 -26
  8. package/lib/cjs/types/libs/msal.types.js.map +1 -1
  9. package/lib/cjs/types/sharepoint.utils.types.js +9 -1
  10. package/lib/cjs/types/sharepoint.utils.types.js.map +1 -1
  11. package/lib/cjs/utils/sharepoint.rest/file.folder.js +4 -4
  12. package/lib/cjs/utils/sharepoint.rest/file.folder.js.map +1 -1
  13. package/lib/cjs/utils/sharepoint.rest/list.js +60 -1
  14. package/lib/cjs/utils/sharepoint.rest/list.js.map +1 -1
  15. package/lib/cjs/utils/sharepoint.rest/user.js +11 -11
  16. package/lib/esm/helpers/browser.js +9 -5
  17. package/lib/esm/helpers/browser.js.map +1 -1
  18. package/lib/esm/types/libs/msal.types.js +26 -26
  19. package/lib/esm/types/libs/msal.types.js.map +1 -1
  20. package/lib/esm/types/sharepoint.utils.types.js +8 -0
  21. package/lib/esm/types/sharepoint.utils.types.js.map +1 -1
  22. package/lib/esm/utils/sharepoint.rest/file.folder.js +4 -4
  23. package/lib/esm/utils/sharepoint.rest/file.folder.js.map +1 -1
  24. package/lib/esm/utils/sharepoint.rest/list.js +57 -0
  25. package/lib/esm/utils/sharepoint.rest/list.js.map +1 -1
  26. package/lib/esm/utils/sharepoint.rest/user.js +11 -11
  27. package/lib/types/types/libs/msal.types.d.ts +8 -3
  28. package/lib/types/types/sharepoint.utils.types.d.ts +17 -0
  29. package/lib/types/utils/sharepoint.rest/list.d.ts +7 -1
  30. package/package.json +81 -81
  31. package/readme.md +17 -17
  32. package/src/_dependencies.ts +12 -12
  33. package/src/config.ts +17 -17
  34. package/src/helpers/Guid.ts +181 -181
  35. package/src/helpers/base64.ts +173 -173
  36. package/src/helpers/browser.test.js +13 -13
  37. package/src/helpers/browser.ts +1448 -1448
  38. package/src/helpers/browserinfo.ts +292 -292
  39. package/src/helpers/collections.base.test.js +25 -25
  40. package/src/helpers/collections.base.ts +437 -437
  41. package/src/helpers/collections.ts +107 -107
  42. package/src/helpers/color.ts +54 -54
  43. package/src/helpers/cookies.ts +59 -59
  44. package/src/helpers/date.test.js +119 -119
  45. package/src/helpers/date.ts +188 -188
  46. package/src/helpers/debug.ts +186 -186
  47. package/src/helpers/diagrams.ts +43 -43
  48. package/src/helpers/emails.ts +6 -6
  49. package/src/helpers/eval.ts +5 -5
  50. package/src/helpers/file.test.js +50 -50
  51. package/src/helpers/file.ts +63 -63
  52. package/src/helpers/flatted.ts +149 -149
  53. package/src/helpers/functions.ts +16 -16
  54. package/src/helpers/graph/calendar.types.ts +10 -10
  55. package/src/helpers/http.ts +69 -69
  56. package/src/helpers/images.ts +22 -22
  57. package/src/helpers/json.ts +44 -44
  58. package/src/helpers/md5.ts +189 -189
  59. package/src/helpers/objects.test.js +33 -33
  60. package/src/helpers/objects.ts +274 -274
  61. package/src/helpers/promises.test.js +37 -37
  62. package/src/helpers/promises.ts +165 -165
  63. package/src/helpers/random.ts +27 -27
  64. package/src/helpers/scheduler/scheduler.test.js +103 -103
  65. package/src/helpers/scheduler/scheduler.ts +131 -131
  66. package/src/helpers/sharepoint.ts +785 -785
  67. package/src/helpers/strings.test.js +122 -122
  68. package/src/helpers/strings.ts +337 -337
  69. package/src/helpers/typecheckers.test.js +34 -34
  70. package/src/helpers/typecheckers.ts +266 -266
  71. package/src/helpers/url.test.js +43 -43
  72. package/src/helpers/url.ts +207 -207
  73. package/src/helpers/urlhelper.ts +111 -111
  74. package/src/index.ts +6 -6
  75. package/src/types/auth.ts +54 -54
  76. package/src/types/common.types.ts +15 -15
  77. package/src/types/flatted.types.ts +59 -59
  78. package/src/types/globals.types.ts +6 -6
  79. package/src/types/graph/calendar.types.ts +80 -80
  80. package/src/types/knownscript.types.ts +18 -18
  81. package/src/types/libs/datajs.types.ts +28 -28
  82. package/src/types/libs/ics.types.ts +30 -30
  83. package/src/types/libs/msal.types.ts +57 -49
  84. package/src/types/locales.ts +125 -125
  85. package/src/types/localstoragecache.types.ts +8 -8
  86. package/src/types/location.types.ts +27 -27
  87. package/src/types/moment.ts +11 -11
  88. package/src/types/regex.types.ts +16 -16
  89. package/src/types/rest.types.ts +95 -95
  90. package/src/types/sharepoint.types.ts +1466 -1466
  91. package/src/types/sharepoint.utils.types.ts +306 -287
  92. package/src/utils/auth/common.ts +74 -74
  93. package/src/utils/auth/discovery.test.js +12 -12
  94. package/src/utils/auth/discovery.ts +132 -132
  95. package/src/utils/base64.ts +27 -27
  96. package/src/utils/consolelogger.ts +320 -320
  97. package/src/utils/date.ts +172 -172
  98. package/src/utils/emails.ts +24 -24
  99. package/src/utils/knownscript.ts +286 -286
  100. package/src/utils/localstoragecache.ts +446 -446
  101. package/src/utils/rest.ts +501 -501
  102. package/src/utils/script.ts +170 -170
  103. package/src/utils/sharepoint.rest/common.ts +154 -154
  104. package/src/utils/sharepoint.rest/date.ts +62 -62
  105. package/src/utils/sharepoint.rest/file.folder.ts +598 -598
  106. package/src/utils/sharepoint.rest/item.ts +547 -547
  107. package/src/utils/sharepoint.rest/list.ts +1548 -1482
  108. package/src/utils/sharepoint.rest/listutils/GetListItemsByCaml.ts +774 -774
  109. package/src/utils/sharepoint.rest/listutils/GetListItemsById.ts +275 -275
  110. package/src/utils/sharepoint.rest/listutils/common.ts +206 -206
  111. package/src/utils/sharepoint.rest/location.ts +141 -141
  112. package/src/utils/sharepoint.rest/navigation-links.ts +86 -86
  113. package/src/utils/sharepoint.rest/user-search.ts +252 -252
  114. package/src/utils/sharepoint.rest/user.ts +491 -491
  115. package/src/utils/sharepoint.rest/web.ts +1384 -1384
  116. package/src/utils/sod.ts +194 -194
@@ -1,338 +1,338 @@
1
- import { IDictionary } from "../types/common.types";
2
- import { filterEmptyEntries, makeUniqueArray } from "./collections.base";
3
- import { isNullOrEmptyString, isNullOrUndefined, isNumber, isString } from "./typecheckers";
4
-
5
- export function endsWith(str: string, value: string, ignoreCase?: boolean): boolean {
6
- let str1 = str;
7
- let find = value;
8
- if (ignoreCase) {
9
- str1 = str1.toLowerCase();
10
- find = find.toLowerCase();
11
- }
12
-
13
- return str1.substr(str1.length - find.length) === find;
14
- }
15
-
16
- export function startsWith(str: string, value: string, ignoreCase?: boolean): boolean {
17
- let str1 = str;
18
- let find = value;
19
- if (ignoreCase) {
20
- str1 = str1.toLowerCase();
21
- find = find.toLowerCase();
22
- }
23
- return str1.substr(0, find.length) === find;
24
- }
25
-
26
- /** remove space at start or end */
27
- export function trim(str: string): string {
28
- return str.replace(/^\s+|\s+$/g, '');
29
- }
30
-
31
- export function trimEnd(str: string): string {
32
- return str.replace(/\s+$/, "");
33
- }
34
-
35
- export function trimStart(str: string): string {
36
- return str.replace(/^\s+/, "");
37
- }
38
-
39
- export function splice(str: string, start: number, delCount: number, insert: string) {
40
- return str.slice(0, start) + insert + str.slice(start + Math.abs(delCount));
41
- }
42
-
43
- export function padRight(value: string | number, length: number, fillString: string = "0") {
44
- if (isNumber(value))
45
- value = value.toString(10);
46
- let pad = isNullOrEmptyString(fillString) ? "0" : fillString[0];
47
- return value + Array(length - value.length + 1).join(pad);
48
- }
49
-
50
- export function padLeft(value: string | number, length: number, fillString: string = "0") {
51
- if (isNumber(value))
52
- value = value.toString(10);
53
- let pad = isNullOrEmptyString(fillString) ? "0" : fillString[0];
54
- return Array(length - String(value).length + 1).join(pad) + value;
55
- }
56
-
57
- /** returns array of [token] found inside the string
58
- * supports token formats [Author??Created by {0}::Unknown author] will return "Author" as the token
59
- * */
60
- export function GetTokens(StringFormat: string): string[] {
61
- let tokensResult: string[] = [];
62
- if (isNullOrEmptyString(StringFormat)) return tokensResult;
63
-
64
- let tokens = StringFormat.match(/\[[^\]]*\]/g);
65
- if (tokens && tokens.length > 0) {
66
- tokens.forEach(token => {
67
- let key = token.slice(1, token.length - 1);
68
- key = GetTokenInfo(key).tokenName;
69
- if (tokensResult.indexOf(key) < 0)
70
- tokensResult.push(key);
71
- });
72
- }
73
-
74
- return tokensResult;
75
- }
76
-
77
- /** replaces a string with [token] and [otherToken] with their matched provided values
78
- * supports token formats [Author??Created by {0}::Unknown author]
79
- */
80
- export function ReplaceTokens(StringFormat: string, TokenValues: IDictionary<string>, options?: {
81
- /**set to true if you want to keep "[token]" in the string when a token value wasn't provided */
82
- keepMissingTokens?: boolean;
83
- }): string {
84
-
85
- let skipMissingTokens = options && options.keepMissingTokens;
86
-
87
- if (isNullOrUndefined(StringFormat)) return null;
88
- if (StringFormat !== '') {
89
- let tokens = StringFormat.match(/\[[^\]]*\]/g);
90
- if (tokens && tokens.length > 0) {
91
- if (isNullOrUndefined(TokenValues)) TokenValues = {};
92
-
93
- tokens.forEach(token => {
94
- let key = token.slice(1, token.length - 1);
95
- let tokenInfo = GetTokenInfo(key);
96
- let value = TokenValues[tokenInfo.tokenName];
97
- let skip = false;
98
- if (isNullOrUndefined(value)) {
99
- value = "";
100
- skip = skipMissingTokens;//if true we won't replace this one
101
- }
102
- if (!skip || tokenInfo.hasFormat)
103
- StringFormat = StringFormat.replace(token, tokenInfo.getValue(value));
104
- });
105
- }
106
- }
107
- return StringFormat;
108
- }
109
-
110
- /** calls replace tokens on every dictionary value, or set null keys to "". This function ignores null/empty dictionaries */
111
- export function ReplaceTokensInDictionary(Dictionary: IDictionary<string>, TokenValues: IDictionary<string>) {
112
- if (!isNullOrUndefined(Dictionary)) {
113
- Object.keys(Dictionary).forEach(key => {
114
- Dictionary[key] = isNullOrEmptyString(Dictionary[key]) ? "" : ReplaceTokens(Dictionary[key], TokenValues);
115
- });
116
- }
117
- }
118
-
119
- /** Normalizes a guid string, lower case and removes {} */
120
- export function normalizeGuid(text: string, removeDashes?: boolean): string {
121
- if (isNullOrEmptyString(text) || !isString(text)) {
122
- return text;
123
- }
124
- var guid = text.toLowerCase().trim();
125
-
126
- if (guid.startsWith("{")) {
127
- guid = guid.substr(1);
128
- }
129
-
130
- if (guid.endsWith("}")) {
131
- guid = guid.substr(0, guid.length - 1);
132
- }
133
-
134
- if (removeDashes) {
135
- guid = guid.replace(/-/g, '');
136
- }
137
-
138
- return guid;
139
- }
140
-
141
- export function isEmptyGuid(guid: { toString(): string; }) {
142
- if (isNullOrEmptyString(guid)) return true;
143
- else if (Number(normalizeGuid(guid.toString(), true)) === 0) return true;
144
- return false;
145
- }
146
-
147
- export function escapeRegExp(text: string) {
148
- return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
149
- }
150
-
151
- export function isValidDomainLogin(login: string) {
152
- return /^[A-Za-z0-9\\._-]{7,}$/.test(login);
153
- }
154
-
155
- export function stripRichTextWhitespace(value: string) {
156
- // richText fields in have random markup even when field is empty
157
- // \u200B zero width space
158
- // \u200C zero width non-joiner Unicode code point
159
- // \u200D zero width joiner Unicode code point
160
- // \uFEFF zero width no-break space Unicode code point
161
- return isString(value) ? value.replace(/[\u200B-\u200D\uFEFF]/g, "") : value;
162
- }
163
-
164
- /** allows min length 1, letters, numbers underscore only */
165
- export function isValidVarName(text: string) {
166
- return /^[A-Za-z0-9_]{1,}$/.test(text);
167
- }
168
-
169
- /** allows min length 1, letters, numbers underscore and hyphen only */
170
- export function isValidHeaderName(text: string) {
171
- return /^[A-Za-z0-9_-]{1,}$/.test(text);
172
- }
173
-
174
- /** returns token info with format */
175
- export function GetTokenInfo(text: string) {
176
- let split = text.split('??');
177
- let hasFormat = split.length > 0 && !isNullOrEmptyString(split[1]);
178
- let formatSplit = hasFormat ? split[1].split('::') : [];
179
- let valueIfEmpty = formatSplit.length > 1 ? formatSplit[1] : "";
180
- let formatIfNotEmpty = formatSplit[0];
181
- let info = {
182
- tokenName: hasFormat ? split[0] : text,
183
- hasFormat: hasFormat,
184
- getValue: (value: string) => {
185
- if (!hasFormat) return value;
186
- else {
187
- if (isNullOrEmptyString(value)) return valueIfEmpty;
188
- else return formatIfNotEmpty.replace('{0}', value);
189
- }
190
- }
191
- };
192
- return info;
193
- }
194
-
195
- /** return true if both strings are the same, or both are empty/null/undefined */
196
- export function stringEqualsOrEmpty(str1: string, str2: string, ignoreCase?: boolean) {
197
- if (isNullOrEmptyString(str1) && isNullOrEmptyString(str2)) return true;
198
- if (ignoreCase) {
199
- if (!isNullOrEmptyString(str1)) str1 = str1.toLowerCase();
200
- if (!isNullOrEmptyString(str2)) str2 = str2.toLowerCase();
201
- }
202
-
203
- return str1 === str2;
204
- }
205
-
206
- /** return true if str1 contains str2 */
207
- export function stringContains(str1: string, str2: string, ignoreCase?: boolean) {
208
- if (isNullOrEmptyString(str1) && isNullOrEmptyString(str2)) return true;
209
-
210
- if (isNullOrEmptyString(str1))
211
- str1 = "";
212
- if (isNullOrEmptyString(str2))
213
- str2 = "";
214
-
215
- if (ignoreCase) {
216
- str1 = str1.toLowerCase();
217
- str2 = str2.toLowerCase();
218
- }
219
-
220
- return str1.indexOf(str2) >= 0;
221
- }
222
-
223
- export function cleanupString(str: string, options: {
224
- replaceNewLines?: string;
225
- collapseMultipleSpaces?: string;
226
- collapseMultipleDashes?: string;
227
- collapseMultipleUnderscore?: string;
228
- }) {
229
- if (isString(options.replaceNewLines))
230
- str = str.replace(/\r/g, '')//no returns
231
- .replace(/\n/g, options.replaceNewLines);//no line breaks
232
- if (isString(options.collapseMultipleDashes))
233
- str = str.replace(/-+/g, options.collapseMultipleSpaces);//no extra spaces
234
- if (isString(options.collapseMultipleUnderscore))
235
- str = str.replace(/_+/g, options.collapseMultipleUnderscore);//no extra spaces
236
-
237
- // do this last, so it will collapse spaces added by previous options
238
- if (isString(options.collapseMultipleSpaces)) {
239
- str = str.replace(new RegExp(String.fromCharCode(160), "g"), '')//get rid of non-breaking spaces
240
- .replace(/ +/g, options.collapseMultipleSpaces);//no extra spaces
241
- }
242
-
243
- return str;
244
- }
245
-
246
- /** normalizes &#160; to &nbsp; see Issue 752 */
247
- export function normalizeHtmlSpace(html: string) {
248
- if (isNullOrEmptyString(html)) return html;
249
- return html.replace(/&#160;/i, "&nbsp;");
250
- }
251
-
252
- export function replaceAll(str: string, find: string, replace: string, ignoreCase = false) {
253
- //must call escapeRegExp on find, to make sure it works when there are protected regex characters
254
- return str.replace(new RegExp(escapeRegExp(find), `g${ignoreCase ? 'i' : ''}`), replace);
255
- }
256
-
257
- export function capitalizeFirstLetter(str: string) {
258
- return isNullOrEmptyString(str)
259
- ? ""
260
- : `${str.charAt(0).toUpperCase()}${str.substring(1)}`;
261
- }
262
-
263
- export function escapeXml(unsafe: string, isAttribute = false) {
264
- if (isNullOrEmptyString(unsafe)) return "";
265
- return isAttribute
266
- ? unsafe.replace(/[<>&'"]/g, (c) => {
267
- switch (c) {
268
- case '<': return '&lt;';
269
- case '>': return '&gt;';
270
- case '&': return '&amp;';
271
- case '\'': return '&apos;';
272
- case '"': return '&quot;';
273
- }
274
- return c;
275
- })
276
- : unsafe.replace(/[<>&]/g, (c) => {
277
- switch (c) {
278
- case '<': return '&lt;';
279
- case '>': return '&gt;';
280
- case '&': return '&amp;';
281
- }
282
- return c;
283
- });
284
- }
285
-
286
- /** uses regex str.match to replace each match by calling the replacer function (imported from CMS) */
287
- export function replaceRegex(str: string, regex: RegExp, replacer: (match: string) => string | null) {
288
- let matches = str.match(regex);
289
- if (!matches || matches.length < 1) return str;
290
- //replace each found token only once
291
- let unique = makeUniqueArray(matches);
292
- //todo: this has a bug where tokens matched contain each other, example, match numbers and prefix with #: 10, 100 will match both and produce #10 ##100
293
- unique.forEach(m => {
294
- let replacement = replacer(m);
295
- if (!isNullOrUndefined(replacement))//ignore nulls
296
- str = replaceAll(str, m, replacement);
297
- });
298
- return str;
299
- }
300
-
301
- /** masks a long string, keeping X number for characters at the start/end and replacing the middle with the mask string (default: CC*****CCC) */
302
- export function maskString(str: string, options?: {
303
- /** mask string, default ***** */
304
- mask?: string;
305
- /** characters to keep at start, default 2 */
306
- start?: number;
307
- /** characters to keep at end, default 2 */
308
- end?: number;
309
- }) {
310
- const mask = options && options.mask || "*****";
311
- const start = options && isNumber(options.start) ? options.start : 2;
312
- const end = options && isNumber(options.end) ? options.end : 2;
313
- const prefix = start >= 0 ? str.slice(0, start) : str;
314
- const sliceEnd = str.length - end;
315
- const suffix = sliceEnd >= 0 ? str.slice(sliceEnd) : str;
316
-
317
- return `${prefix}${mask}${suffix}`;
318
- }
319
-
320
- export function splitString(str: string, options: { maxLength?: number; marker?: string | RegExp; clearEmptyEntries?: boolean }) {
321
- let strArr: string[] = [str];
322
- if (!isNullOrUndefined(options.marker)) strArr = str.split(options.marker);
323
- if (isNumber(options.maxLength) && options.maxLength > 0) {
324
- let splitted: string[] = [];
325
- strArr.forEach(currentStr => {
326
- while (currentStr.length > 0) {
327
- splitted.push(currentStr.slice(0, options.maxLength));
328
- currentStr = currentStr.slice(options.maxLength);
329
- }
330
- });
331
-
332
- strArr = splitted;
333
- }
334
-
335
- if (options.clearEmptyEntries)
336
- strArr = filterEmptyEntries(strArr);
337
- return strArr;
1
+ import { IDictionary } from "../types/common.types";
2
+ import { filterEmptyEntries, makeUniqueArray } from "./collections.base";
3
+ import { isNullOrEmptyString, isNullOrUndefined, isNumber, isString } from "./typecheckers";
4
+
5
+ export function endsWith(str: string, value: string, ignoreCase?: boolean): boolean {
6
+ let str1 = str;
7
+ let find = value;
8
+ if (ignoreCase) {
9
+ str1 = str1.toLowerCase();
10
+ find = find.toLowerCase();
11
+ }
12
+
13
+ return str1.substr(str1.length - find.length) === find;
14
+ }
15
+
16
+ export function startsWith(str: string, value: string, ignoreCase?: boolean): boolean {
17
+ let str1 = str;
18
+ let find = value;
19
+ if (ignoreCase) {
20
+ str1 = str1.toLowerCase();
21
+ find = find.toLowerCase();
22
+ }
23
+ return str1.substr(0, find.length) === find;
24
+ }
25
+
26
+ /** remove space at start or end */
27
+ export function trim(str: string): string {
28
+ return str.replace(/^\s+|\s+$/g, '');
29
+ }
30
+
31
+ export function trimEnd(str: string): string {
32
+ return str.replace(/\s+$/, "");
33
+ }
34
+
35
+ export function trimStart(str: string): string {
36
+ return str.replace(/^\s+/, "");
37
+ }
38
+
39
+ export function splice(str: string, start: number, delCount: number, insert: string) {
40
+ return str.slice(0, start) + insert + str.slice(start + Math.abs(delCount));
41
+ }
42
+
43
+ export function padRight(value: string | number, length: number, fillString: string = "0") {
44
+ if (isNumber(value))
45
+ value = value.toString(10);
46
+ let pad = isNullOrEmptyString(fillString) ? "0" : fillString[0];
47
+ return value + Array(length - value.length + 1).join(pad);
48
+ }
49
+
50
+ export function padLeft(value: string | number, length: number, fillString: string = "0") {
51
+ if (isNumber(value))
52
+ value = value.toString(10);
53
+ let pad = isNullOrEmptyString(fillString) ? "0" : fillString[0];
54
+ return Array(length - String(value).length + 1).join(pad) + value;
55
+ }
56
+
57
+ /** returns array of [token] found inside the string
58
+ * supports token formats [Author??Created by {0}::Unknown author] will return "Author" as the token
59
+ * */
60
+ export function GetTokens(StringFormat: string): string[] {
61
+ let tokensResult: string[] = [];
62
+ if (isNullOrEmptyString(StringFormat)) return tokensResult;
63
+
64
+ let tokens = StringFormat.match(/\[[^\]]*\]/g);
65
+ if (tokens && tokens.length > 0) {
66
+ tokens.forEach(token => {
67
+ let key = token.slice(1, token.length - 1);
68
+ key = GetTokenInfo(key).tokenName;
69
+ if (tokensResult.indexOf(key) < 0)
70
+ tokensResult.push(key);
71
+ });
72
+ }
73
+
74
+ return tokensResult;
75
+ }
76
+
77
+ /** replaces a string with [token] and [otherToken] with their matched provided values
78
+ * supports token formats [Author??Created by {0}::Unknown author]
79
+ */
80
+ export function ReplaceTokens(StringFormat: string, TokenValues: IDictionary<string>, options?: {
81
+ /**set to true if you want to keep "[token]" in the string when a token value wasn't provided */
82
+ keepMissingTokens?: boolean;
83
+ }): string {
84
+
85
+ let skipMissingTokens = options && options.keepMissingTokens;
86
+
87
+ if (isNullOrUndefined(StringFormat)) return null;
88
+ if (StringFormat !== '') {
89
+ let tokens = StringFormat.match(/\[[^\]]*\]/g);
90
+ if (tokens && tokens.length > 0) {
91
+ if (isNullOrUndefined(TokenValues)) TokenValues = {};
92
+
93
+ tokens.forEach(token => {
94
+ let key = token.slice(1, token.length - 1);
95
+ let tokenInfo = GetTokenInfo(key);
96
+ let value = TokenValues[tokenInfo.tokenName];
97
+ let skip = false;
98
+ if (isNullOrUndefined(value)) {
99
+ value = "";
100
+ skip = skipMissingTokens;//if true we won't replace this one
101
+ }
102
+ if (!skip || tokenInfo.hasFormat)
103
+ StringFormat = StringFormat.replace(token, tokenInfo.getValue(value));
104
+ });
105
+ }
106
+ }
107
+ return StringFormat;
108
+ }
109
+
110
+ /** calls replace tokens on every dictionary value, or set null keys to "". This function ignores null/empty dictionaries */
111
+ export function ReplaceTokensInDictionary(Dictionary: IDictionary<string>, TokenValues: IDictionary<string>) {
112
+ if (!isNullOrUndefined(Dictionary)) {
113
+ Object.keys(Dictionary).forEach(key => {
114
+ Dictionary[key] = isNullOrEmptyString(Dictionary[key]) ? "" : ReplaceTokens(Dictionary[key], TokenValues);
115
+ });
116
+ }
117
+ }
118
+
119
+ /** Normalizes a guid string, lower case and removes {} */
120
+ export function normalizeGuid(text: string, removeDashes?: boolean): string {
121
+ if (isNullOrEmptyString(text) || !isString(text)) {
122
+ return text;
123
+ }
124
+ var guid = text.toLowerCase().trim();
125
+
126
+ if (guid.startsWith("{")) {
127
+ guid = guid.substr(1);
128
+ }
129
+
130
+ if (guid.endsWith("}")) {
131
+ guid = guid.substr(0, guid.length - 1);
132
+ }
133
+
134
+ if (removeDashes) {
135
+ guid = guid.replace(/-/g, '');
136
+ }
137
+
138
+ return guid;
139
+ }
140
+
141
+ export function isEmptyGuid(guid: { toString(): string; }) {
142
+ if (isNullOrEmptyString(guid)) return true;
143
+ else if (Number(normalizeGuid(guid.toString(), true)) === 0) return true;
144
+ return false;
145
+ }
146
+
147
+ export function escapeRegExp(text: string) {
148
+ return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
149
+ }
150
+
151
+ export function isValidDomainLogin(login: string) {
152
+ return /^[A-Za-z0-9\\._-]{7,}$/.test(login);
153
+ }
154
+
155
+ export function stripRichTextWhitespace(value: string) {
156
+ // richText fields in have random markup even when field is empty
157
+ // \u200B zero width space
158
+ // \u200C zero width non-joiner Unicode code point
159
+ // \u200D zero width joiner Unicode code point
160
+ // \uFEFF zero width no-break space Unicode code point
161
+ return isString(value) ? value.replace(/[\u200B-\u200D\uFEFF]/g, "") : value;
162
+ }
163
+
164
+ /** allows min length 1, letters, numbers underscore only */
165
+ export function isValidVarName(text: string) {
166
+ return /^[A-Za-z0-9_]{1,}$/.test(text);
167
+ }
168
+
169
+ /** allows min length 1, letters, numbers underscore and hyphen only */
170
+ export function isValidHeaderName(text: string) {
171
+ return /^[A-Za-z0-9_-]{1,}$/.test(text);
172
+ }
173
+
174
+ /** returns token info with format */
175
+ export function GetTokenInfo(text: string) {
176
+ let split = text.split('??');
177
+ let hasFormat = split.length > 0 && !isNullOrEmptyString(split[1]);
178
+ let formatSplit = hasFormat ? split[1].split('::') : [];
179
+ let valueIfEmpty = formatSplit.length > 1 ? formatSplit[1] : "";
180
+ let formatIfNotEmpty = formatSplit[0];
181
+ let info = {
182
+ tokenName: hasFormat ? split[0] : text,
183
+ hasFormat: hasFormat,
184
+ getValue: (value: string) => {
185
+ if (!hasFormat) return value;
186
+ else {
187
+ if (isNullOrEmptyString(value)) return valueIfEmpty;
188
+ else return formatIfNotEmpty.replace('{0}', value);
189
+ }
190
+ }
191
+ };
192
+ return info;
193
+ }
194
+
195
+ /** return true if both strings are the same, or both are empty/null/undefined */
196
+ export function stringEqualsOrEmpty(str1: string, str2: string, ignoreCase?: boolean) {
197
+ if (isNullOrEmptyString(str1) && isNullOrEmptyString(str2)) return true;
198
+ if (ignoreCase) {
199
+ if (!isNullOrEmptyString(str1)) str1 = str1.toLowerCase();
200
+ if (!isNullOrEmptyString(str2)) str2 = str2.toLowerCase();
201
+ }
202
+
203
+ return str1 === str2;
204
+ }
205
+
206
+ /** return true if str1 contains str2 */
207
+ export function stringContains(str1: string, str2: string, ignoreCase?: boolean) {
208
+ if (isNullOrEmptyString(str1) && isNullOrEmptyString(str2)) return true;
209
+
210
+ if (isNullOrEmptyString(str1))
211
+ str1 = "";
212
+ if (isNullOrEmptyString(str2))
213
+ str2 = "";
214
+
215
+ if (ignoreCase) {
216
+ str1 = str1.toLowerCase();
217
+ str2 = str2.toLowerCase();
218
+ }
219
+
220
+ return str1.indexOf(str2) >= 0;
221
+ }
222
+
223
+ export function cleanupString(str: string, options: {
224
+ replaceNewLines?: string;
225
+ collapseMultipleSpaces?: string;
226
+ collapseMultipleDashes?: string;
227
+ collapseMultipleUnderscore?: string;
228
+ }) {
229
+ if (isString(options.replaceNewLines))
230
+ str = str.replace(/\r/g, '')//no returns
231
+ .replace(/\n/g, options.replaceNewLines);//no line breaks
232
+ if (isString(options.collapseMultipleDashes))
233
+ str = str.replace(/-+/g, options.collapseMultipleSpaces);//no extra spaces
234
+ if (isString(options.collapseMultipleUnderscore))
235
+ str = str.replace(/_+/g, options.collapseMultipleUnderscore);//no extra spaces
236
+
237
+ // do this last, so it will collapse spaces added by previous options
238
+ if (isString(options.collapseMultipleSpaces)) {
239
+ str = str.replace(new RegExp(String.fromCharCode(160), "g"), '')//get rid of non-breaking spaces
240
+ .replace(/ +/g, options.collapseMultipleSpaces);//no extra spaces
241
+ }
242
+
243
+ return str;
244
+ }
245
+
246
+ /** normalizes &#160; to &nbsp; see Issue 752 */
247
+ export function normalizeHtmlSpace(html: string) {
248
+ if (isNullOrEmptyString(html)) return html;
249
+ return html.replace(/&#160;/i, "&nbsp;");
250
+ }
251
+
252
+ export function replaceAll(str: string, find: string, replace: string, ignoreCase = false) {
253
+ //must call escapeRegExp on find, to make sure it works when there are protected regex characters
254
+ return str.replace(new RegExp(escapeRegExp(find), `g${ignoreCase ? 'i' : ''}`), replace);
255
+ }
256
+
257
+ export function capitalizeFirstLetter(str: string) {
258
+ return isNullOrEmptyString(str)
259
+ ? ""
260
+ : `${str.charAt(0).toUpperCase()}${str.substring(1)}`;
261
+ }
262
+
263
+ export function escapeXml(unsafe: string, isAttribute = false) {
264
+ if (isNullOrEmptyString(unsafe)) return "";
265
+ return isAttribute
266
+ ? unsafe.replace(/[<>&'"]/g, (c) => {
267
+ switch (c) {
268
+ case '<': return '&lt;';
269
+ case '>': return '&gt;';
270
+ case '&': return '&amp;';
271
+ case '\'': return '&apos;';
272
+ case '"': return '&quot;';
273
+ }
274
+ return c;
275
+ })
276
+ : unsafe.replace(/[<>&]/g, (c) => {
277
+ switch (c) {
278
+ case '<': return '&lt;';
279
+ case '>': return '&gt;';
280
+ case '&': return '&amp;';
281
+ }
282
+ return c;
283
+ });
284
+ }
285
+
286
+ /** uses regex str.match to replace each match by calling the replacer function (imported from CMS) */
287
+ export function replaceRegex(str: string, regex: RegExp, replacer: (match: string) => string | null) {
288
+ let matches = str.match(regex);
289
+ if (!matches || matches.length < 1) return str;
290
+ //replace each found token only once
291
+ let unique = makeUniqueArray(matches);
292
+ //todo: this has a bug where tokens matched contain each other, example, match numbers and prefix with #: 10, 100 will match both and produce #10 ##100
293
+ unique.forEach(m => {
294
+ let replacement = replacer(m);
295
+ if (!isNullOrUndefined(replacement))//ignore nulls
296
+ str = replaceAll(str, m, replacement);
297
+ });
298
+ return str;
299
+ }
300
+
301
+ /** masks a long string, keeping X number for characters at the start/end and replacing the middle with the mask string (default: CC*****CCC) */
302
+ export function maskString(str: string, options?: {
303
+ /** mask string, default ***** */
304
+ mask?: string;
305
+ /** characters to keep at start, default 2 */
306
+ start?: number;
307
+ /** characters to keep at end, default 2 */
308
+ end?: number;
309
+ }) {
310
+ const mask = options && options.mask || "*****";
311
+ const start = options && isNumber(options.start) ? options.start : 2;
312
+ const end = options && isNumber(options.end) ? options.end : 2;
313
+ const prefix = start >= 0 ? str.slice(0, start) : str;
314
+ const sliceEnd = str.length - end;
315
+ const suffix = sliceEnd >= 0 ? str.slice(sliceEnd) : str;
316
+
317
+ return `${prefix}${mask}${suffix}`;
318
+ }
319
+
320
+ export function splitString(str: string, options: { maxLength?: number; marker?: string | RegExp; clearEmptyEntries?: boolean }) {
321
+ let strArr: string[] = [str];
322
+ if (!isNullOrUndefined(options.marker)) strArr = str.split(options.marker);
323
+ if (isNumber(options.maxLength) && options.maxLength > 0) {
324
+ let splitted: string[] = [];
325
+ strArr.forEach(currentStr => {
326
+ while (currentStr.length > 0) {
327
+ splitted.push(currentStr.slice(0, options.maxLength));
328
+ currentStr = currentStr.slice(options.maxLength);
329
+ }
330
+ });
331
+
332
+ strArr = splitted;
333
+ }
334
+
335
+ if (options.clearEmptyEntries)
336
+ strArr = filterEmptyEntries(strArr);
337
+ return strArr;
338
338
  }