@kwiz/common 1.0.129 → 1.0.132

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/LICENSE +21 -21
  3. package/lib/cjs/config.js +2 -0
  4. package/lib/cjs/config.js.map +1 -1
  5. package/lib/cjs/types/libs/msal.types.js +26 -26
  6. package/lib/cjs/utils/sharepoint.rest/user.js +11 -11
  7. package/lib/esm/config.js +2 -0
  8. package/lib/esm/config.js.map +1 -1
  9. package/lib/esm/types/libs/msal.types.js +26 -26
  10. package/lib/esm/utils/sharepoint.rest/user.js +11 -11
  11. package/lib/types/config.d.ts +2 -0
  12. package/package.json +81 -81
  13. package/readme.md +17 -17
  14. package/src/_dependencies.ts +12 -12
  15. package/src/config.ts +19 -17
  16. package/src/helpers/Guid.ts +181 -181
  17. package/src/helpers/base64.ts +173 -173
  18. package/src/helpers/browser.test.js +13 -13
  19. package/src/helpers/browser.ts +1504 -1504
  20. package/src/helpers/browserinfo.ts +292 -292
  21. package/src/helpers/collections.base.test.js +25 -25
  22. package/src/helpers/collections.base.ts +437 -437
  23. package/src/helpers/collections.ts +107 -107
  24. package/src/helpers/color.ts +54 -54
  25. package/src/helpers/cookies.ts +59 -59
  26. package/src/helpers/date.test.js +119 -119
  27. package/src/helpers/date.ts +188 -188
  28. package/src/helpers/debug.ts +186 -186
  29. package/src/helpers/diagrams.ts +43 -43
  30. package/src/helpers/emails.ts +6 -6
  31. package/src/helpers/eval.ts +5 -5
  32. package/src/helpers/file.test.js +50 -50
  33. package/src/helpers/file.ts +63 -63
  34. package/src/helpers/flatted.ts +149 -149
  35. package/src/helpers/functions.ts +16 -16
  36. package/src/helpers/graph/calendar.types.ts +10 -10
  37. package/src/helpers/http.ts +69 -69
  38. package/src/helpers/images.ts +22 -22
  39. package/src/helpers/json.ts +44 -44
  40. package/src/helpers/md5.ts +189 -189
  41. package/src/helpers/objects.test.js +33 -33
  42. package/src/helpers/objects.ts +274 -274
  43. package/src/helpers/promises.test.js +37 -37
  44. package/src/helpers/promises.ts +165 -165
  45. package/src/helpers/random.ts +27 -27
  46. package/src/helpers/scheduler/scheduler.test.js +103 -103
  47. package/src/helpers/scheduler/scheduler.ts +131 -131
  48. package/src/helpers/sharepoint.ts +796 -796
  49. package/src/helpers/strings.test.js +122 -122
  50. package/src/helpers/strings.ts +337 -337
  51. package/src/helpers/typecheckers.test.js +34 -34
  52. package/src/helpers/typecheckers.ts +266 -266
  53. package/src/helpers/url.test.js +43 -43
  54. package/src/helpers/url.ts +207 -207
  55. package/src/helpers/urlhelper.ts +111 -111
  56. package/src/index.ts +6 -6
  57. package/src/types/auth.ts +62 -62
  58. package/src/types/common.types.ts +15 -15
  59. package/src/types/flatted.types.ts +59 -59
  60. package/src/types/globals.types.ts +6 -6
  61. package/src/types/graph/calendar.types.ts +80 -80
  62. package/src/types/knownscript.types.ts +18 -18
  63. package/src/types/libs/datajs.types.ts +28 -28
  64. package/src/types/libs/ics.types.ts +30 -30
  65. package/src/types/libs/msal.types.ts +57 -57
  66. package/src/types/locales.ts +125 -125
  67. package/src/types/localstoragecache.types.ts +8 -8
  68. package/src/types/location.types.ts +27 -27
  69. package/src/types/moment.ts +11 -11
  70. package/src/types/regex.types.ts +16 -16
  71. package/src/types/rest.types.ts +95 -95
  72. package/src/types/sharepoint.types.ts +1466 -1466
  73. package/src/types/sharepoint.utils.types.ts +306 -306
  74. package/src/utils/auth/common.ts +118 -118
  75. package/src/utils/auth/discovery.test.js +12 -12
  76. package/src/utils/auth/discovery.ts +132 -132
  77. package/src/utils/base64.ts +27 -27
  78. package/src/utils/consolelogger.ts +333 -333
  79. package/src/utils/date.ts +172 -172
  80. package/src/utils/emails.ts +24 -24
  81. package/src/utils/knownscript.ts +286 -286
  82. package/src/utils/localstoragecache.ts +446 -446
  83. package/src/utils/rest.ts +501 -501
  84. package/src/utils/script.ts +170 -170
  85. package/src/utils/sharepoint.rest/common.ts +159 -159
  86. package/src/utils/sharepoint.rest/date.ts +62 -62
  87. package/src/utils/sharepoint.rest/file.folder.ts +685 -685
  88. package/src/utils/sharepoint.rest/item.ts +547 -547
  89. package/src/utils/sharepoint.rest/list.ts +1572 -1572
  90. package/src/utils/sharepoint.rest/listutils/GetListItemsByCaml.ts +774 -774
  91. package/src/utils/sharepoint.rest/listutils/GetListItemsById.ts +275 -275
  92. package/src/utils/sharepoint.rest/listutils/common.ts +206 -206
  93. package/src/utils/sharepoint.rest/location.ts +141 -141
  94. package/src/utils/sharepoint.rest/navigation-links.ts +86 -86
  95. package/src/utils/sharepoint.rest/user-search.ts +252 -252
  96. package/src/utils/sharepoint.rest/user.ts +558 -558
  97. package/src/utils/sharepoint.rest/web.ts +1384 -1384
  98. package/src/utils/sod.ts +194 -194
  99. package/.madgerc +0 -3
  100. package/fix-folder-imports.js +0 -27
@@ -1,119 +1,119 @@
1
- import { getCacheItem, IRestOptions, setCacheItem } from "../../exports-index";
2
- import { isNullOrEmptyString, isNullOrUndefined, isNumber } from "../../helpers/typecheckers";
3
- import { SPFxAuthToken, SPFxAuthTokenType } from "../../types/auth";
4
- import { GetJson, GetJsonSync } from "../rest";
5
- import { GetRestBaseUrl } from "../sharepoint.rest/common";
6
-
7
- export function GetTokenAudiencePrefix(appId: string) {
8
- return `api://${appId}`;
9
- }
10
- export function GetDefaultScope(appId: string) {
11
- return `${GetTokenAudiencePrefix(appId)}/access_as_user`;
12
- }
13
- export function GetMSALSiteScope(hostName: string) {
14
- return `https://${hostName}`;
15
- }
16
-
17
- function _getGetSPFxClientAuthTokenParams(siteUrl: string, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
18
- let acquireURL = `${GetRestBaseUrl(siteUrl)}/SP.OAuth.Token/Acquire`;
19
- //todo: add all the resource end points (ie. OneNote, Yammer, Stream)
20
- let resource = "";
21
- let isSPOToken = false;
22
- switch (spfxTokenType) {
23
- case SPFxAuthTokenType.Outlook:
24
- resource = "https://outlook.office365.com/search";
25
- break;
26
- case SPFxAuthTokenType.SharePoint:
27
- case SPFxAuthTokenType.MySite:
28
- isSPOToken = true;
29
- resource = new URL(acquireURL).origin;
30
- if (spfxTokenType === SPFxAuthTokenType.MySite) {
31
- let split = resource.split(".");
32
- split[0] += "-my";
33
- resource = split.join(".");
34
- }
35
- break;
36
- default:
37
- resource = "https://graph.microsoft.com";
38
- }
39
-
40
- let data = {
41
- resource: resource,
42
- tokenType: isSPOToken ? "SPO" : undefined
43
- };
44
-
45
- let params: {
46
- url: string,
47
- body: string,
48
- options: IRestOptions
49
- } = {
50
- url: acquireURL,
51
- body: JSON.stringify(data),
52
- options: {
53
- allowCache: false,
54
- // ...shortLocalCache,
55
- // postCacheKey: `${spfxTokenType}_${_spPageContextInfo.webId}`,
56
- includeDigestInPost: true,
57
- headers: {
58
- "Accept": "application/json;odata.metadata=minimal",
59
- "content-type": "application/json; charset=UTF-8",
60
- "odata-version": "4.0",
61
- }
62
- }
63
- };
64
-
65
- return params;
66
- }
67
-
68
- function _parseAndCacheGetSPFxClientAuthTokenResult(result: SPFxAuthToken, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
69
- if (!isNullOrUndefined(result) && !isNullOrEmptyString(result.access_token)) {
70
- let expiration = isNumber(result.expires_on) ?
71
- new Date(result.expires_on * 1000) :
72
- {
73
- minutes: 15
74
- };
75
-
76
- setCacheItem(`access_token_${spfxTokenType}_${_spPageContextInfo.webId}`, result.access_token, expiration);
77
-
78
- return result.access_token;
79
- }
80
- return null;
81
- }
82
-
83
- function _getSPFxClientAuthTokenFromCache(spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
84
- let cachedToken = getCacheItem<string>(`access_token_${spfxTokenType}_${_spPageContextInfo.webId}`);
85
- if (!isNullOrEmptyString(cachedToken)) {
86
- return cachedToken;
87
- }
88
- return null;
89
- }
90
-
91
- /** Acquire an authorization token for a Outlook, Graph, or SharePoint the same way SPFx clients do */
92
- export async function GetSPFxClientAuthToken(siteUrl: string, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
93
- try {
94
- let cachedToken = _getSPFxClientAuthTokenFromCache(spfxTokenType);
95
- if (!isNullOrEmptyString(cachedToken)) {
96
- return cachedToken;
97
- }
98
- let { url, body, options } = _getGetSPFxClientAuthTokenParams(siteUrl, spfxTokenType);
99
- let result = await GetJson<SPFxAuthToken>(url, body, options);
100
- return _parseAndCacheGetSPFxClientAuthTokenResult(result, spfxTokenType);
101
- } catch {
102
- }
103
- return null;
104
- }
105
-
106
- /** Acquire an authorization token for a Outlook, Graph, or SharePoint the same way SPFx clients do */
107
- export function GetSPFxClientAuthTokenSync(siteUrl: string, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
108
- try {
109
- let cachedToken = _getSPFxClientAuthTokenFromCache(spfxTokenType);
110
- if (!isNullOrEmptyString(cachedToken)) {
111
- return cachedToken;
112
- }
113
- let { url, body, options } = _getGetSPFxClientAuthTokenParams(siteUrl, spfxTokenType);
114
- let response = GetJsonSync<SPFxAuthToken>(url, body, options);
115
- return _parseAndCacheGetSPFxClientAuthTokenResult(response.result, spfxTokenType);
116
- } catch {
117
- }
118
- return null;
1
+ import { getCacheItem, IRestOptions, setCacheItem } from "../../exports-index";
2
+ import { isNullOrEmptyString, isNullOrUndefined, isNumber } from "../../helpers/typecheckers";
3
+ import { SPFxAuthToken, SPFxAuthTokenType } from "../../types/auth";
4
+ import { GetJson, GetJsonSync } from "../rest";
5
+ import { GetRestBaseUrl } from "../sharepoint.rest/common";
6
+
7
+ export function GetTokenAudiencePrefix(appId: string) {
8
+ return `api://${appId}`;
9
+ }
10
+ export function GetDefaultScope(appId: string) {
11
+ return `${GetTokenAudiencePrefix(appId)}/access_as_user`;
12
+ }
13
+ export function GetMSALSiteScope(hostName: string) {
14
+ return `https://${hostName}`;
15
+ }
16
+
17
+ function _getGetSPFxClientAuthTokenParams(siteUrl: string, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
18
+ let acquireURL = `${GetRestBaseUrl(siteUrl)}/SP.OAuth.Token/Acquire`;
19
+ //todo: add all the resource end points (ie. OneNote, Yammer, Stream)
20
+ let resource = "";
21
+ let isSPOToken = false;
22
+ switch (spfxTokenType) {
23
+ case SPFxAuthTokenType.Outlook:
24
+ resource = "https://outlook.office365.com/search";
25
+ break;
26
+ case SPFxAuthTokenType.SharePoint:
27
+ case SPFxAuthTokenType.MySite:
28
+ isSPOToken = true;
29
+ resource = new URL(acquireURL).origin;
30
+ if (spfxTokenType === SPFxAuthTokenType.MySite) {
31
+ let split = resource.split(".");
32
+ split[0] += "-my";
33
+ resource = split.join(".");
34
+ }
35
+ break;
36
+ default:
37
+ resource = "https://graph.microsoft.com";
38
+ }
39
+
40
+ let data = {
41
+ resource: resource,
42
+ tokenType: isSPOToken ? "SPO" : undefined
43
+ };
44
+
45
+ let params: {
46
+ url: string,
47
+ body: string,
48
+ options: IRestOptions
49
+ } = {
50
+ url: acquireURL,
51
+ body: JSON.stringify(data),
52
+ options: {
53
+ allowCache: false,
54
+ // ...shortLocalCache,
55
+ // postCacheKey: `${spfxTokenType}_${_spPageContextInfo.webId}`,
56
+ includeDigestInPost: true,
57
+ headers: {
58
+ "Accept": "application/json;odata.metadata=minimal",
59
+ "content-type": "application/json; charset=UTF-8",
60
+ "odata-version": "4.0",
61
+ }
62
+ }
63
+ };
64
+
65
+ return params;
66
+ }
67
+
68
+ function _parseAndCacheGetSPFxClientAuthTokenResult(result: SPFxAuthToken, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
69
+ if (!isNullOrUndefined(result) && !isNullOrEmptyString(result.access_token)) {
70
+ let expiration = isNumber(result.expires_on) ?
71
+ new Date(result.expires_on * 1000) :
72
+ {
73
+ minutes: 15
74
+ };
75
+
76
+ setCacheItem(`access_token_${spfxTokenType}_${_spPageContextInfo.webId}`, result.access_token, expiration);
77
+
78
+ return result.access_token;
79
+ }
80
+ return null;
81
+ }
82
+
83
+ function _getSPFxClientAuthTokenFromCache(spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
84
+ let cachedToken = getCacheItem<string>(`access_token_${spfxTokenType}_${_spPageContextInfo.webId}`);
85
+ if (!isNullOrEmptyString(cachedToken)) {
86
+ return cachedToken;
87
+ }
88
+ return null;
89
+ }
90
+
91
+ /** Acquire an authorization token for a Outlook, Graph, or SharePoint the same way SPFx clients do */
92
+ export async function GetSPFxClientAuthToken(siteUrl: string, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
93
+ try {
94
+ let cachedToken = _getSPFxClientAuthTokenFromCache(spfxTokenType);
95
+ if (!isNullOrEmptyString(cachedToken)) {
96
+ return cachedToken;
97
+ }
98
+ let { url, body, options } = _getGetSPFxClientAuthTokenParams(siteUrl, spfxTokenType);
99
+ let result = await GetJson<SPFxAuthToken>(url, body, options);
100
+ return _parseAndCacheGetSPFxClientAuthTokenResult(result, spfxTokenType);
101
+ } catch {
102
+ }
103
+ return null;
104
+ }
105
+
106
+ /** Acquire an authorization token for a Outlook, Graph, or SharePoint the same way SPFx clients do */
107
+ export function GetSPFxClientAuthTokenSync(siteUrl: string, spfxTokenType: SPFxAuthTokenType = SPFxAuthTokenType.Graph) {
108
+ try {
109
+ let cachedToken = _getSPFxClientAuthTokenFromCache(spfxTokenType);
110
+ if (!isNullOrEmptyString(cachedToken)) {
111
+ return cachedToken;
112
+ }
113
+ let { url, body, options } = _getGetSPFxClientAuthTokenParams(siteUrl, spfxTokenType);
114
+ let response = GetJsonSync<SPFxAuthToken>(url, body, options);
115
+ return _parseAndCacheGetSPFxClientAuthTokenResult(response.result, spfxTokenType);
116
+ } catch {
117
+ }
118
+ return null;
119
119
  }
@@ -1,13 +1,13 @@
1
- import assert from 'assert/strict';
2
- import test from 'node:test';
3
- import { normalizeGuid } from '../../helpers/strings';
4
- import { isValidGuid } from '../../helpers/typecheckers';
5
- import { DiscoverTenantInfo } from './discovery';
6
-
7
- test('DiscoverTenantInfo', async t => {
8
- global.XMLHttpRequest = require('xhr2');
9
- let info = await DiscoverTenantInfo("kwizcomdev.sharepoint.com");
10
- await t.test("response not null/undefined", t => assert.notDeepEqual(info, null) && assert.notDeepEqual(info, undefined));
11
- await t.test("has valid guid", t => assert.deepEqual(isValidGuid(info && info.idOrName), true));
12
- await t.test("has correct guid", t => assert.deepEqual(normalizeGuid(info && info.idOrName), normalizeGuid("3bf37eb8-6c20-45a9-aff6-ac72d276f375")));
1
+ import assert from 'assert/strict';
2
+ import test from 'node:test';
3
+ import { normalizeGuid } from '../../helpers/strings';
4
+ import { isValidGuid } from '../../helpers/typecheckers';
5
+ import { DiscoverTenantInfo } from './discovery';
6
+
7
+ test('DiscoverTenantInfo', async t => {
8
+ global.XMLHttpRequest = require('xhr2');
9
+ let info = await DiscoverTenantInfo("kwizcomdev.sharepoint.com");
10
+ await t.test("response not null/undefined", t => assert.notDeepEqual(info, null) && assert.notDeepEqual(info, undefined));
11
+ await t.test("has valid guid", t => assert.deepEqual(isValidGuid(info && info.idOrName), true));
12
+ await t.test("has correct guid", t => assert.deepEqual(normalizeGuid(info && info.idOrName), normalizeGuid("3bf37eb8-6c20-45a9-aff6-ac72d276f375")));
13
13
  });
@@ -1,132 +1,132 @@
1
- import { promiseOnce } from "../../helpers/promises";
2
- import { isNullOrEmptyString, isValidGuid } from "../../helpers/typecheckers";
3
- import { AzureEnvironment, ITenantInfo } from "../../types/auth";
4
- import { GetJson, GetJsonSync } from "../rest";
5
-
6
- interface IOpenidConfiguration {
7
- token_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/token
8
- cloud_instance_name: string;//microsoftonline.com
9
- token_endpoint_auth_methods_supported: string[];// ["client_secret_post", "private_key_jwt", "client_secret_basic"]
10
- response_modes_supported: string[];// ["query", "fragment", "form_post"]
11
- response_types_supported: string[];// ["code", "id_token", "code id_token", "token id_token", "token"]
12
- scopes_supported: string[];// ["openid"]
13
- issuer: string;//https://sts.windows.net/7d034656-be03-457d-8d82-60e90cf5f400/
14
- authorization_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/authorize
15
- device_authorization_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/devicecode
16
- end_session_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/logout
17
- userinfo_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/openid/userinfo
18
- tenant_region_scope: string;//NA
19
- cloud_graph_host_name: string;//graph.windows.net
20
- msgraph_host: string;//graph.microsoft.com
21
- }
22
-
23
- function _getFriendlyName(hostName: string) {
24
- if (hostName.indexOf(".sharepoint.") !== -1) {
25
- let hostParts = hostName.split('.');//should be xxx.sharepoint.com or xxx.sharepoint.us
26
- let firstHostPart = hostParts[0];
27
- let lastHostPart = hostParts[hostParts.length - 1] === "us" || hostParts[hostParts.length - 1] === "de" ? hostParts[hostParts.length - 1] : "com";
28
- if (firstHostPart.endsWith("-admin")) firstHostPart = firstHostPart.substring(0, firstHostPart.length - 6);
29
- return `${firstHostPart}.onmicrosoft.${lastHostPart}`;
30
- }
31
- else {
32
- return hostName;//could be an exchange email domain, or bpos customer
33
- }
34
- }
35
-
36
- function _getOpenIdConfigurationUrl(friendlyName: string) {
37
- return `https://login.microsoftonline.com/${friendlyName}/v2.0/.well-known/openid-configuration`;
38
- }
39
-
40
- function _processOpenidConfiguration(config: IOpenidConfiguration, friendlyName: string) {
41
- let data: ITenantInfo = {
42
- environment: AzureEnvironment.Production,
43
- idOrName: null,
44
- authorityUrl: null,
45
- valid: false
46
- };
47
-
48
- let endpoint = config.token_endpoint;//https://xxxx/{tenant}/....
49
- let tenantId = endpoint.replace("//", "/").split('/')[2];//replace :// with :/ split by / and take the second part.
50
- let instance = config.cloud_instance_name;//microsoftonline.us
51
-
52
- data.environment = GetEnvironmentFromACSEndPoint(instance);
53
- if (!isNullOrEmptyString(tenantId) || isValidGuid(tenantId)) {
54
- data.idOrName = tenantId;
55
- } else {
56
- data.idOrName = friendlyName;
57
- }
58
-
59
- data.authorityUrl = `${GetAzureADLoginEndPoint(data.environment)}/${data.idOrName}`;
60
- data.valid = true;
61
-
62
- return data;
63
- }
64
-
65
- export function DiscoverTenantInfo(hostName: string, sync?: false): Promise<ITenantInfo>
66
- export function DiscoverTenantInfo(hostName: string, sync: true): ITenantInfo
67
- export function DiscoverTenantInfo(hostName: string, sync?: boolean): ITenantInfo | Promise<ITenantInfo> {
68
- hostName = hostName.toLowerCase();
69
-
70
- let friendlyName = _getFriendlyName(hostName);
71
- let url = _getOpenIdConfigurationUrl(friendlyName);
72
-
73
- if (sync === true) {
74
- try {
75
- let response = GetJsonSync<IOpenidConfiguration>(url);
76
- let config = response.result;
77
- let data = _processOpenidConfiguration(config, friendlyName);
78
- return data;
79
- } catch (ex) {
80
- console.log(ex);
81
- }
82
- return null;
83
- } else {
84
- return promiseOnce(`DiscoverTenantInfo|${hostName}`, async () => {
85
- try {
86
- let config = await GetJson<IOpenidConfiguration>(url);
87
- let data = _processOpenidConfiguration(config, friendlyName);
88
- return data;
89
- }
90
- catch (ex) {
91
- console.log(ex);
92
- }
93
- return null;
94
- });
95
- }
96
- }
97
-
98
- export function AutoDiscoverTenantInfo(sync?: false): Promise<ITenantInfo>
99
- export function AutoDiscoverTenantInfo(sync: true): ITenantInfo
100
- export function AutoDiscoverTenantInfo(sync?: boolean): ITenantInfo | Promise<ITenantInfo> {
101
- if (sync === true) {
102
- return DiscoverTenantInfo(window.location.hostname.toLowerCase(), true);
103
- }
104
- return DiscoverTenantInfo(window.location.hostname.toLowerCase(), false);
105
- }
106
-
107
- export function GetEnvironmentFromACSEndPoint(ACSEndPoint: string): AzureEnvironment {
108
- switch (ACSEndPoint) {
109
- case "microsoftonline.us":
110
- return AzureEnvironment.USGovernment;
111
- case "microsoftonline.de":
112
- return AzureEnvironment.Germany;
113
- case "accesscontrol.chinacloudapi.cn":
114
- return AzureEnvironment.China;
115
- case "windows-ppe.net":
116
- return AzureEnvironment.PPE;
117
- case "accesscontrol.windows.net":
118
- default:
119
- return AzureEnvironment.Production;
120
- }
121
- }
122
- export function GetAzureADLoginEndPoint(environment: AzureEnvironment): string {
123
- switch (environment) {
124
- case AzureEnvironment.Germany: return "https://login.microsoftonline.de";
125
- case AzureEnvironment.China: return "https://login.chinacloudapi.cn";
126
- case AzureEnvironment.USGovernment: return "https://login.microsoftonline.us";
127
- case AzureEnvironment.PPE: return "https://login.windows-ppe.net";
128
- case AzureEnvironment.Production:
129
- default:
130
- return "https://login.microsoftonline.com";
131
- }
132
- }
1
+ import { promiseOnce } from "../../helpers/promises";
2
+ import { isNullOrEmptyString, isValidGuid } from "../../helpers/typecheckers";
3
+ import { AzureEnvironment, ITenantInfo } from "../../types/auth";
4
+ import { GetJson, GetJsonSync } from "../rest";
5
+
6
+ interface IOpenidConfiguration {
7
+ token_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/token
8
+ cloud_instance_name: string;//microsoftonline.com
9
+ token_endpoint_auth_methods_supported: string[];// ["client_secret_post", "private_key_jwt", "client_secret_basic"]
10
+ response_modes_supported: string[];// ["query", "fragment", "form_post"]
11
+ response_types_supported: string[];// ["code", "id_token", "code id_token", "token id_token", "token"]
12
+ scopes_supported: string[];// ["openid"]
13
+ issuer: string;//https://sts.windows.net/7d034656-be03-457d-8d82-60e90cf5f400/
14
+ authorization_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/authorize
15
+ device_authorization_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/devicecode
16
+ end_session_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/logout
17
+ userinfo_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/openid/userinfo
18
+ tenant_region_scope: string;//NA
19
+ cloud_graph_host_name: string;//graph.windows.net
20
+ msgraph_host: string;//graph.microsoft.com
21
+ }
22
+
23
+ function _getFriendlyName(hostName: string) {
24
+ if (hostName.indexOf(".sharepoint.") !== -1) {
25
+ let hostParts = hostName.split('.');//should be xxx.sharepoint.com or xxx.sharepoint.us
26
+ let firstHostPart = hostParts[0];
27
+ let lastHostPart = hostParts[hostParts.length - 1] === "us" || hostParts[hostParts.length - 1] === "de" ? hostParts[hostParts.length - 1] : "com";
28
+ if (firstHostPart.endsWith("-admin")) firstHostPart = firstHostPart.substring(0, firstHostPart.length - 6);
29
+ return `${firstHostPart}.onmicrosoft.${lastHostPart}`;
30
+ }
31
+ else {
32
+ return hostName;//could be an exchange email domain, or bpos customer
33
+ }
34
+ }
35
+
36
+ function _getOpenIdConfigurationUrl(friendlyName: string) {
37
+ return `https://login.microsoftonline.com/${friendlyName}/v2.0/.well-known/openid-configuration`;
38
+ }
39
+
40
+ function _processOpenidConfiguration(config: IOpenidConfiguration, friendlyName: string) {
41
+ let data: ITenantInfo = {
42
+ environment: AzureEnvironment.Production,
43
+ idOrName: null,
44
+ authorityUrl: null,
45
+ valid: false
46
+ };
47
+
48
+ let endpoint = config.token_endpoint;//https://xxxx/{tenant}/....
49
+ let tenantId = endpoint.replace("//", "/").split('/')[2];//replace :// with :/ split by / and take the second part.
50
+ let instance = config.cloud_instance_name;//microsoftonline.us
51
+
52
+ data.environment = GetEnvironmentFromACSEndPoint(instance);
53
+ if (!isNullOrEmptyString(tenantId) || isValidGuid(tenantId)) {
54
+ data.idOrName = tenantId;
55
+ } else {
56
+ data.idOrName = friendlyName;
57
+ }
58
+
59
+ data.authorityUrl = `${GetAzureADLoginEndPoint(data.environment)}/${data.idOrName}`;
60
+ data.valid = true;
61
+
62
+ return data;
63
+ }
64
+
65
+ export function DiscoverTenantInfo(hostName: string, sync?: false): Promise<ITenantInfo>
66
+ export function DiscoverTenantInfo(hostName: string, sync: true): ITenantInfo
67
+ export function DiscoverTenantInfo(hostName: string, sync?: boolean): ITenantInfo | Promise<ITenantInfo> {
68
+ hostName = hostName.toLowerCase();
69
+
70
+ let friendlyName = _getFriendlyName(hostName);
71
+ let url = _getOpenIdConfigurationUrl(friendlyName);
72
+
73
+ if (sync === true) {
74
+ try {
75
+ let response = GetJsonSync<IOpenidConfiguration>(url);
76
+ let config = response.result;
77
+ let data = _processOpenidConfiguration(config, friendlyName);
78
+ return data;
79
+ } catch (ex) {
80
+ console.log(ex);
81
+ }
82
+ return null;
83
+ } else {
84
+ return promiseOnce(`DiscoverTenantInfo|${hostName}`, async () => {
85
+ try {
86
+ let config = await GetJson<IOpenidConfiguration>(url);
87
+ let data = _processOpenidConfiguration(config, friendlyName);
88
+ return data;
89
+ }
90
+ catch (ex) {
91
+ console.log(ex);
92
+ }
93
+ return null;
94
+ });
95
+ }
96
+ }
97
+
98
+ export function AutoDiscoverTenantInfo(sync?: false): Promise<ITenantInfo>
99
+ export function AutoDiscoverTenantInfo(sync: true): ITenantInfo
100
+ export function AutoDiscoverTenantInfo(sync?: boolean): ITenantInfo | Promise<ITenantInfo> {
101
+ if (sync === true) {
102
+ return DiscoverTenantInfo(window.location.hostname.toLowerCase(), true);
103
+ }
104
+ return DiscoverTenantInfo(window.location.hostname.toLowerCase(), false);
105
+ }
106
+
107
+ export function GetEnvironmentFromACSEndPoint(ACSEndPoint: string): AzureEnvironment {
108
+ switch (ACSEndPoint) {
109
+ case "microsoftonline.us":
110
+ return AzureEnvironment.USGovernment;
111
+ case "microsoftonline.de":
112
+ return AzureEnvironment.Germany;
113
+ case "accesscontrol.chinacloudapi.cn":
114
+ return AzureEnvironment.China;
115
+ case "windows-ppe.net":
116
+ return AzureEnvironment.PPE;
117
+ case "accesscontrol.windows.net":
118
+ default:
119
+ return AzureEnvironment.Production;
120
+ }
121
+ }
122
+ export function GetAzureADLoginEndPoint(environment: AzureEnvironment): string {
123
+ switch (environment) {
124
+ case AzureEnvironment.Germany: return "https://login.microsoftonline.de";
125
+ case AzureEnvironment.China: return "https://login.chinacloudapi.cn";
126
+ case AzureEnvironment.USGovernment: return "https://login.microsoftonline.us";
127
+ case AzureEnvironment.PPE: return "https://login.windows-ppe.net";
128
+ case AzureEnvironment.Production:
129
+ default:
130
+ return "https://login.microsoftonline.com";
131
+ }
132
+ }
@@ -1,28 +1,28 @@
1
- import { blobToBase64 } from "../helpers/base64";
2
- import { isNullOrEmptyString } from "../helpers/typecheckers";
3
- import { GetJson } from "./rest";
4
- import { GetFile } from "./sharepoint.rest/file.folder";
5
-
6
- /** if the file is in SharePoint, provide a siteRelativeUrl so that we can get the file value via REST api to avoid CORS error when accessing a file on the site from within the app web */
7
- export async function imageToBase64(imageSrc: string, siteRelativeUrl?: string): Promise<string> {
8
- try {
9
- let fileBlob: Blob = null;
10
- if (!isNullOrEmptyString(siteRelativeUrl) && imageSrc.toLowerCase().indexOf(siteRelativeUrl.toLowerCase()) >= 0) {
11
- let spFile = await GetFile<Blob>(siteRelativeUrl, imageSrc, true, "blob");
12
- if (spFile && spFile.Exists)
13
- fileBlob = spFile.Content;
14
- }
15
-
16
- //try simple rest if the first option failed
17
- if (fileBlob === null) {
18
- fileBlob = await GetJson<Blob>(imageSrc, null, { responseType: "blob", allowCache: true });
19
- }
20
-
21
- if (fileBlob) {
22
- let base64 = await blobToBase64(fileBlob);
23
- return base64;
24
- }
25
- } catch (e) {
26
- }
27
- return null;
1
+ import { blobToBase64 } from "../helpers/base64";
2
+ import { isNullOrEmptyString } from "../helpers/typecheckers";
3
+ import { GetJson } from "./rest";
4
+ import { GetFile } from "./sharepoint.rest/file.folder";
5
+
6
+ /** if the file is in SharePoint, provide a siteRelativeUrl so that we can get the file value via REST api to avoid CORS error when accessing a file on the site from within the app web */
7
+ export async function imageToBase64(imageSrc: string, siteRelativeUrl?: string): Promise<string> {
8
+ try {
9
+ let fileBlob: Blob = null;
10
+ if (!isNullOrEmptyString(siteRelativeUrl) && imageSrc.toLowerCase().indexOf(siteRelativeUrl.toLowerCase()) >= 0) {
11
+ let spFile = await GetFile<Blob>(siteRelativeUrl, imageSrc, true, "blob");
12
+ if (spFile && spFile.Exists)
13
+ fileBlob = spFile.Content;
14
+ }
15
+
16
+ //try simple rest if the first option failed
17
+ if (fileBlob === null) {
18
+ fileBlob = await GetJson<Blob>(imageSrc, null, { responseType: "blob", allowCache: true });
19
+ }
20
+
21
+ if (fileBlob) {
22
+ let base64 = await blobToBase64(fileBlob);
23
+ return base64;
24
+ }
25
+ } catch (e) {
26
+ }
27
+ return null;
28
28
  }