@kwiz/common 1.0.5 → 1.0.7

package/src/helpers/objects.ts

@@ -1,11 +1,14 @@
 import { makeUniqueArray } from "./collections.base";
 import { jsonParse } from "./json";
-import { isDate, isFunction, isNotEmptyArray, isNullOrEmptyString, isNullOrUndefined, isObject, isPrimitiveValue, primitiveTypes } from "./typecheckers";
+import { isDate, isFunction, isNotEmptyArray, isNullOrEmptyString, isNullOrUndefined, isObject, isPrimitiveValue, isString, primitiveTypes } from "./typecheckers";
 
 /** global window, safe for testing and environments without a browser */
 export var $w = typeof window === "undefined" ? {
     setTimeout: setTimeout,
-    clearTimeout: clearTimeout
+    clearTimeout: clearTimeout,
+    location: {
+        href: "", host: ""
+    }
 } as any as Window : window;
 
 /** wrapper for hasOwnProperty that satisfies https://eslint.org/docs/latest/rules/no-prototype-builtins */
@@ -253,4 +256,16 @@ class DefaultProp<T>{
 /** creates a safe property, if the value is null/undefined or empty string - it will return the default value. */
 export function GetDefaultProp<T>(defaultValue: T | (() => T), initialValue?: T, isValid?: (value: T) => boolean) {
     return new DefaultProp(defaultValue, initialValue, isValid);
+}
+
+/** Get string error message from an error object */
+export function GetError(error: any, defaultError: string = "Unknown error"): string {
+    const err = isNullOrUndefined(error)
+        ? defaultError
+        : isString(error)
+            ? error
+            : isString((error as Error).message)
+                ? error.message
+                : defaultError;
+    return err.length > 0 ? err : defaultError;
 }

package/src/helpers/strings.test.js

@@ -4,6 +4,12 @@ import { capitalizeFirstLetter, escapeXml, replaceAll, replaceRegex } from './st
 
 test('replaceAll', t => {
     assert.strictEqual(replaceAll("hello old#@! world old#@! !", "old#@!", "new!@$"), "hello new!@$ world new!@$ !");
+
+    //this failed since the input find included protected regex characters.
+    //escapeRegExp needs to fix that
+    const source = "string with special regex[:(s:) chars";
+    const result = "string with special regex[~~(s~~) chars";
+    assert.strictEqual(replaceAll(source, source, result), result);
 });
 
 test('capitalizeFirstLetter', async t => {
@@ -30,7 +36,7 @@ test('escapeXml', async t => {
 
 test('replaceRegex', t => {
     /** Match anything between {zone:*} */
-    var matchZones = /{zone:\w+}/gi;
+    var match = /{zone:\w+}/gi;
 
     var source = `text {zone:one} {zone:two}
 more text
@@ -39,5 +45,11 @@ more text
 more text
 THREE`;
 
-    assert.strictEqual(replaceRegex(source, matchZones, m => m.slice(1, m.length - 1).split(':')[1].toLocaleUpperCase()), result);
+    assert.strictEqual(replaceRegex(source, match, m => m.slice(1, m.length - 1).split(':')[1].toLocaleUpperCase()), result);
+
+    /** match: "](______)" */
+    match = /]\(.+\)/gi;
+    source = '[name:root](https://kwizcom.sharepoint.com/:fl:/g/contentstorage)';
+    result = '[name:root](https~~~~//kwizcom.sharepoint.com/~~~~fl~~~~/g/contentstorage)';
+    assert.strictEqual(replaceRegex(source, match, m => m.replace(/:/gi, "~~~~")), result);
 });

package/src/helpers/strings.ts

@@ -241,7 +241,8 @@ export function normalizeHtmlSpace(html: string) {
 }
 
 export function replaceAll(str: string, find: string, replace: string, ignoreCase = false) {
-    return str.replace(new RegExp(find, `g${ignoreCase ? 'i' : ''}`), replace);
+    //must call escapeRegExp on find, to make sure it works when there are protected regex characters
+    return str.replace(new RegExp(escapeRegExp(find), `g${ignoreCase ? 'i' : ''}`), replace);
 }
 
 export function capitalizeFirstLetter(str: string) {

package/src/types/auth.ts

@@ -0,0 +1,46 @@
+export interface ITenantInfo {
+    environment: AzureEnvironment;
+    idOrName: string;
+    authorityUrl: string;
+    valid: boolean;
+}
+
+// eslint-disable-next-line no-shadow
+export const enum AzureEnvironment {
+    Production = 0,
+    PPE = 1,
+    China = 2,
+    Germany = 3,
+    USGovernment = 4
+}
+/** AuthenticationModes enum values for projects that can't use enums (when isolatedModules is true) */
+export const $AzureEnvironment = {
+    Production: 0,
+    PPE: 1,
+    China: 2,
+    Germany: 3,
+    USGovernment: 4,
+}
+
+// eslint-disable-next-line no-shadow
+export const enum AuthenticationModes {
+    Certificate = "certificate",
+    clientSecret = "secret"
+}
+/** AuthenticationModes enum values for projects that can't use enums (when isolatedModules is true) */
+export const $AuthenticationModes = {
+    Certificate: AuthenticationModes.Certificate,
+    clientSecret: AuthenticationModes.clientSecret,
+};
+
+
+export type AuthContextType = {
+    authenticationMode: AuthenticationModes.Certificate,
+    clientId: string,
+    privateKey: string,
+    thumbprint: string
+} | {
+    authenticationMode: AuthenticationModes.clientSecret,
+    clientId: string,
+    clientSecret: string
+};

package/src/types/index.ts

@@ -1,3 +1,4 @@
+export * from "./auth";
 export * from "./common.types";
 export * from './flatted.types';
 export * from "./globals.types";
@@ -9,4 +10,3 @@ export * from "./regex.types";
 export * from "./rest.types";
 export * from "./sharepoint.types";
 export * from "./sharepoint.utils.types";
-

package/src/types/libs/msal.types.ts

@@ -1,35 +1,7 @@
+import { ITenantInfo } from "../auth";
+
 export interface IMSALBaseRequest { scopes: string[]; }
 export interface IMSALConfig { }
-export interface ITenantInfo {
-    environment: AzureEnvironment;
-    idOrName: string;
-    authorityUrl: string;
-    valid: boolean;
-}
-
-// eslint-disable-next-line no-shadow
-export enum AzureEnvironment {
-    /// <summary>
-    /// 
-    /// </summary>
-    Production = 0,
-    /// <summary>
-    /// 
-    /// </summary>
-    PPE = 1,
-    /// <summary>
-    /// 
-    /// </summary>
-    China = 2,
-    /// <summary>
-    /// 
-    /// </summary>
-    Germany = 3,
-    /// <summary>
-    /// 
-    /// </summary>
-    USGovernment = 4
-}
 
 export const MSALSampleLoginPopupScript = `<p id="msg">please wait...</p>
 <script>
@@ -59,13 +31,6 @@ function finish() {
 finish();
 </script>`;
 
-export function GetTokenAudiencePrefix(appId: string) {
-    return `api://${appId}`;
-}
-export function GetDefaultScope(appId: string) {
-    return `${GetTokenAudiencePrefix(appId)}/access_as_user`;
-}
-
 export interface IMSAL {
     AutoDiscoverTenantInfo: () => Promise<ITenantInfo>;
     GetConfig: (clientId: string, authority: string, redirectUri: string) => Promise<IMSALConfig>;
@@ -76,4 +41,4 @@ declare global {
     interface IKWizComGlobalsLibs {
         msal?: IMSAL;
     }
-}
+}

package/src/types/rest.types.ts

@@ -44,6 +44,8 @@ export interface IRestRequestOptions {
         [key: string]: string;
         Accept?: string;
         "content-type"?: string;
+        /** `Bearer ${token}` */
+        Authorization?: string;
     };
     /** allow cache on post requests if you provide a unique key to identify and match */
     postCacheKey?: string;

package/src/utils/auth/common.ts

@@ -0,0 +1,9 @@
+export function GetTokenAudiencePrefix(appId: string) {
+    return `api://${appId}`;
+}
+export function GetDefaultScope(appId: string) {
+    return `${GetTokenAudiencePrefix(appId)}/access_as_user`;
+}
+export function GetMSALSiteScope(siteUrl: string) {
+    return `https://${new URL(siteUrl).hostname}`;
+}

package/src/utils/auth/discovery.ts

@@ -0,0 +1,92 @@
+import { AzureEnvironment, ITenantInfo, isNullOrEmptyString, isValidGuid, promiseOnce } from "../_dependencies";
+import { GetJson } from "../rest";
+
+export function DiscoverTenantInfo(hostName: string) {
+    hostName = hostName.toLowerCase();
+    return promiseOnce(`DiscoverTenantInfo|${hostName}`, async () => {
+        let data: ITenantInfo = {
+            environment: AzureEnvironment.Production,
+            idOrName: null,
+            authorityUrl: null,
+            valid: false
+        };
+
+        let tenantId: string = null;
+        let friendlyName: string = null;
+
+        try {
+            if (hostName.indexOf(".sharepoint.") !== -1) {
+                let hostParts = hostName.split('.');//should be xxx.sharepoint.com or xxx.sharepoint.us
+                let firstHostPart = hostParts[0];
+                let lastHostPart = hostParts[hostParts.length - 1] === "us" || hostParts[hostParts.length - 1] === "de" ? hostParts[hostParts.length - 1] : "com";
+                if (firstHostPart.endsWith("-admin")) firstHostPart = firstHostPart.substring(0, firstHostPart.length - 6);
+                friendlyName = `${firstHostPart}.onmicrosoft.${lastHostPart}`;
+            }
+            else friendlyName = hostName;//could be an exchange email domain, or bpos customer
+
+            let config = await GetJson<{
+                token_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/token
+                cloud_instance_name: string;//microsoftonline.com
+                token_endpoint_auth_methods_supported: string[];// ["client_secret_post", "private_key_jwt", "client_secret_basic"]
+                response_modes_supported: string[];// ["query", "fragment", "form_post"]
+                response_types_supported: string[];// ["code", "id_token", "code id_token", "token id_token", "token"]
+                scopes_supported: string[];// ["openid"]
+                issuer: string;//https://sts.windows.net/7d034656-be03-457d-8d82-60e90cf5f400/
+                authorization_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/authorize
+                device_authorization_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/devicecode
+                end_session_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/oauth2/logout
+                userinfo_endpoint: string;//https://login.microsoftonline.com/7d034656-be03-457d-8d82-60e90cf5f400/openid/userinfo
+                tenant_region_scope: string;//NA
+                cloud_graph_host_name: string;//graph.windows.net
+                msgraph_host: string;//graph.microsoft.com
+            }>(`https://login.microsoftonline.com/${friendlyName}/v2.0/.well-known/openid-configuration`);
+
+            let endpoint = config.token_endpoint;//https://xxxx/{tenant}/....
+            tenantId = endpoint.replace("//", "/").split('/')[2];//replace :// with :/ split by / and take the second part.
+            let instance = config.cloud_instance_name;//microsoftonline.us
+
+            data.environment = GetEnvironmentFromACSEndPoint(instance);
+            if (!isNullOrEmptyString(tenantId) || isValidGuid(tenantId))
+                data.idOrName = tenantId;
+            else
+                data.idOrName = friendlyName;
+
+            data.authorityUrl = `${GetAzureADLoginEndPoint(data.environment)}/${data.idOrName}`;
+            data.valid = true;
+        }
+        catch (e) { }
+
+        return data;
+    });
+}
+
+export function AutoDiscoverTenantInfo() {
+    return DiscoverTenantInfo(window.location.hostname.toLowerCase());
+}
+
+export function GetEnvironmentFromACSEndPoint(ACSEndPoint: string): AzureEnvironment {
+    switch (ACSEndPoint) {
+        case "microsoftonline.us":
+            return AzureEnvironment.USGovernment;
+        case "microsoftonline.de":
+            return AzureEnvironment.Germany;
+        case "accesscontrol.chinacloudapi.cn":
+            return AzureEnvironment.China;
+        case "windows-ppe.net":
+            return AzureEnvironment.PPE;
+        case "accesscontrol.windows.net":
+        default:
+            return AzureEnvironment.Production;
+    }
+}
+export function GetAzureADLoginEndPoint(environment: AzureEnvironment): string {
+    switch (environment) {
+        case AzureEnvironment.Germany: return "https://login.microsoftonline.de";
+        case AzureEnvironment.China: return "https://login.chinacloudapi.cn";
+        case AzureEnvironment.USGovernment: return "https://login.microsoftonline.us";
+        case AzureEnvironment.PPE: return "https://login.windows-ppe.net";
+        case AzureEnvironment.Production:
+        default:
+            return "https://login.microsoftonline.com";
+    }
+}

package/src/utils/auth/index.ts

@@ -0,0 +1,3 @@
+export * from "./common";
+export * from "./discovery";
+

package/src/utils/index.ts

@@ -9,5 +9,6 @@ export * from './localstoragecache';
 export * from './rest';
 export * from './sharepoint.rest';
 export * from './sod';
+export * from './auth';
 export const script = _script;
 export const Sod = _sod;