@kwiz/node 1.0.14 → 1.0.17

package/src/auth/msal.ts

@@ -1,44 +1,44 @@
-import { ConfidentialClientApplication } from "@azure/msal-node";
-import { AuthContextType, AuthenticationModes, ITenantInfo } from "@kwiz/common";
-//find tenant id? https://login.microsoftonline.com/kwizcom.onmicrosoft.com/.well-known/openid-configuration
-//https://stackoverflow.com/questions/54771270/msal-ad-token-not-valid-with-sharepoint-online-csom
-
-var apps: { [tenant: string]: ConfidentialClientApplication } = {};
-
-function GetApp(tenantInfo: ITenantInfo, auth: AuthContextType) {
-    let key = `${tenantInfo.idOrName}|${auth.authenticationMode}`
-    if (!apps[key]) {
-        auth.authenticationMode === AuthenticationModes.clientSecret
-            ? apps[key] = new ConfidentialClientApplication({
-                auth: {
-                    clientId: auth.clientId,
-                    authority: tenantInfo.authorityUrl,
-                    clientSecret: auth.clientSecret
-                },
-
-            })
-            : apps[key] = new ConfidentialClientApplication({
-                auth: {
-                    clientId: auth.clientId,
-                    authority: tenantInfo.authorityUrl,
-                    clientCertificate: {
-                        thumbprint: auth.thumbprint,
-                        privateKey: auth.privateKey
-                    }
-                },
-
-            });
-    }
-    return apps[key];
-}
-
-/** client secret not supported by SharePoint, must use certificate */
-export async function GetMSALToken(tenantInfo: ITenantInfo, scope: string, auth: AuthContextType, clearCache?: boolean) {
-    const app = GetApp(tenantInfo, auth);
-    if (clearCache)
-        app.clearCache();
-    let token = await app.acquireTokenByClientCredential({
-        scopes: [`${scope}/.default`]
-    });
-    return token.accessToken;
+import { ConfidentialClientApplication } from "@azure/msal-node";
+import { AuthContextType, AuthenticationModes, ITenantInfo } from "@kwiz/common";
+//find tenant id? https://login.microsoftonline.com/kwizcom.onmicrosoft.com/.well-known/openid-configuration
+//https://stackoverflow.com/questions/54771270/msal-ad-token-not-valid-with-sharepoint-online-csom
+
+var apps: { [tenant: string]: ConfidentialClientApplication } = {};
+
+function GetApp(tenantInfo: ITenantInfo, auth: AuthContextType) {
+    let key = `${tenantInfo.idOrName}|${auth.authenticationMode}`
+    if (!apps[key]) {
+        auth.authenticationMode === AuthenticationModes.clientSecret
+            ? apps[key] = new ConfidentialClientApplication({
+                auth: {
+                    clientId: auth.clientId,
+                    authority: tenantInfo.authorityUrl,
+                    clientSecret: auth.clientSecret
+                },
+
+            })
+            : apps[key] = new ConfidentialClientApplication({
+                auth: {
+                    clientId: auth.clientId,
+                    authority: tenantInfo.authorityUrl,
+                    clientCertificate: {
+                        thumbprint: auth.thumbprint,
+                        privateKey: auth.privateKey
+                    }
+                },
+
+            });
+    }
+    return apps[key];
+}
+
+/** client secret not supported by SharePoint, must use certificate */
+export async function GetMSALToken(tenantInfo: ITenantInfo, scope: string, auth: AuthContextType, clearCache?: boolean) {
+    const app = GetApp(tenantInfo, auth);
+    if (clearCache)
+        app.clearCache();
+    let token = await app.acquireTokenByClientCredential({
+        scopes: [`${scope}/.default`]
+    });
+    return token.accessToken;
 }

package/src/axios.ts

@@ -1,32 +1,45 @@
-import { isNullOrEmptyString } from "@kwiz/common";
-import { AxiosRequestConfig } from "axios";
-import { Agent, globalAgent } from "https";
-
-type axiosConfigOptions = {
-    contantType?: "application/json" | "application/json; odata=nometadata" | "application/xml";
-}
-export function getAxiosConfigBearer(token: string, options?: axiosConfigOptions) {
-    return getAxiosConfig(`Bearer ${token}`, options);
-}
-
-export function getAxiosConfig(token?: string, options?: axiosConfigOptions) {
-    //allow self sign ssl certificates
-    globalAgent.options.rejectUnauthorized = false;
-    const config: AxiosRequestConfig<any> = {
-        httpAgent: new Agent({
-            rejectUnauthorized: false
-        }),
-        headers: {}
-    };
-
-    if (!isNullOrEmptyString(token))
-        config.headers!.Authorization = token;
-
-    if (options) {
-        if (!isNullOrEmptyString(options.contantType)) {
-            config.headers!["Content-Type"] = options.contantType;
-            config.headers!["Accept"] = options.contantType;
-        }
-    }
-    return config;
+import { isNullOrEmptyString } from "@kwiz/common";
+import { AxiosError, AxiosRequestConfig } from "axios";
+import { Agent, globalAgent } from "https";
+
+type axiosConfigOptions = {
+    contantType?: "application/json" | "application/json; odata=nometadata" | "application/xml";
+}
+export function getAxiosConfigBearer(token: string, options?: axiosConfigOptions) {
+    return getAxiosConfig(`Bearer ${token}`, options);
+}
+
+export function getAxiosConfig(token?: string, options?: axiosConfigOptions) {
+    //allow self sign ssl certificates
+    globalAgent.options.rejectUnauthorized = false;
+    const config: AxiosRequestConfig<any> = {
+        httpAgent: new Agent({
+            rejectUnauthorized: false
+        }),
+        headers: {}
+    };
+
+    if (!isNullOrEmptyString(token))
+        config.headers!.Authorization = token;
+
+    if (options) {
+        if (!isNullOrEmptyString(options.contantType)) {
+            config.headers!["Content-Type"] = options.contantType;
+            config.headers!["Accept"] = options.contantType;
+        }
+    }
+    return config;
+}
+
+export function getAxiosErrorData(error: AxiosError) {
+    let code = error.code || "Unknown";
+    let errorMessage = error.message || "Unspecified error";
+    if (error && error.response && error.response.data && error.response.data["odata.error"]) {
+        let errorData: { code: string; message: { value: string; }; } = error.response.data["odata.error"];
+        if (errorData.message && errorData.message.value)
+            errorMessage = errorData.message.value;
+        if (errorData && errorData.code)
+            code = errorData.code;
+    }
+    return { code: code, message: errorMessage };
 }

package/src/exports-index.ts

@@ -3,3 +3,4 @@ export * from './auth/exports-index';
 export * from './graph/exports-index';
 export * from './storage/exports-index';
 export * from './axios';
+export * from './get-with-cache';

package/src/get-with-cache.ts

@@ -0,0 +1,38 @@
+import { IDictionary, isNullOrUndefined } from "@kwiz/common";
+
+const $$cache: IDictionary<{ expires: Date; value: any }> = {};
+
+export async function getWithCache<T>(worker: () => Promise<{ success: boolean; value: T }>, info: {
+    /** seconds */
+    successCacheDuration: number;
+    /** seconds */
+    failedCacheDuration?: number;
+    /** must be unique for your call! function name, and parameters */
+    cacheKey: string;
+    forceRefresh?: boolean;
+}) {
+    const now = new Date();
+    //purge old values
+    Object.keys($$cache).forEach(key => {
+        if ($$cache[key].expires < now) delete $$cache[key];
+    });
+
+    let cached = info.forceRefresh ? null : $$cache[info.cacheKey];
+
+    if (isNullOrUndefined(cached)) {
+        const result = await worker();
+        if (result.success) {
+            $$cache[info.cacheKey] = {
+                expires: new Date(new Date().getTime() + info.successCacheDuration * 1000),
+                value: result.value
+            };
+        }
+        else if (info.failedCacheDuration > 0) {
+            $$cache[info.cacheKey] = {
+                expires: new Date(new Date().getTime() + info.failedCacheDuration * 1000),
+                value: result.value
+            };
+        }
+    }
+    return $$cache[info.cacheKey].value;
+}

package/src/graph/graph.ts

@@ -1,18 +1,18 @@
-import { AuthContextType, ITenantInfo, isNullOrUndefined } from "@kwiz/common";
-import { GetMSALToken } from "../auth/msal";
-import { getAxiosConfigBearer } from "../axios";
-
-/** "https://graph.microsoft.com" */
-export const graphScope = "https://graph.microsoft.com";
-
-var auth: AuthContextType = null;
-export function ConfigureGraphAuth(config?: AuthContextType) {
-    auth = config;
-}
-export async function getAxiosConfigGraph(tenantInfo: ITenantInfo, clearCache?: boolean) {
-    if (isNullOrUndefined(auth)) throw Error("Call ConfigureGraphAuth first");
-
-    // secret or certificate supported
-    let token = await GetMSALToken(tenantInfo, graphScope, auth, clearCache);
-    return getAxiosConfigBearer(token);
+import { AuthContextType, ITenantInfo, isNullOrUndefined } from "@kwiz/common";
+import { GetMSALToken } from "../auth/msal";
+import { getAxiosConfigBearer } from "../axios";
+
+/** "https://graph.microsoft.com" */
+export const graphScope = "https://graph.microsoft.com";
+
+var auth: AuthContextType = null;
+export function ConfigureGraphAuth(config?: AuthContextType) {
+    auth = config;
+}
+export async function getAxiosConfigGraph(tenantInfo: ITenantInfo, clearCache?: boolean) {
+    if (isNullOrUndefined(auth)) throw Error("Call ConfigureGraphAuth first");
+
+    // secret or certificate supported
+    let token = await GetMSALToken(tenantInfo, graphScope, auth, clearCache);
+    return getAxiosConfigBearer(token);
 }

package/src/index.ts

@@ -1 +1 @@
-export * from "./exports-index";
+export * from "./exports-index";

package/src/storage/common.ts

@@ -1,15 +1,15 @@
-import { isNullOrEmptyString } from "@kwiz/common";
-import axios from "axios";
-
-export async function IsAzuriteRunning() {
-    let responseServer = "";
-    try {
-        //make a request for http://127.0.0.1:10000/ expect response headers "Server" to contain "Azurite"
-        const result = await axios.get("http://127.0.0.1:10000/");
-        responseServer = result.headers.server;
-    } catch (e) {
-        responseServer = e.response && e.response.headers && e.response.headers.server;
-    }
-
-    return isNullOrEmptyString(responseServer) ? false : responseServer.toLowerCase().indexOf("azurite") >= 0;
-}
+import { isNullOrEmptyString } from "@kwiz/common";
+import axios from "axios";
+
+export async function IsAzuriteRunning() {
+    let responseServer = "";
+    try {
+        //make a request for http://127.0.0.1:10000/ expect response headers "Server" to contain "Azurite"
+        const result = await axios.get("http://127.0.0.1:10000/");
+        responseServer = result.headers.server;
+    } catch (e) {
+        responseServer = e.response && e.response.headers && e.response.headers.server;
+    }
+
+    return isNullOrEmptyString(responseServer) ? false : responseServer.toLowerCase().indexOf("azurite") >= 0;
+}

package/src/storage/odata.ts

@@ -1,87 +1,87 @@
-import { isNullOrEmptyArray, isNullOrEmptyString, isNullOrUndefined } from "@kwiz/common";
-
-export enum ODataOperators {
-    equal = "eq",
-    notEqual = "ne",
-    greater = "gt",
-    greaterOrEqual = "ge",
-    less = "lt",
-    lessOrEqual = "le",
-    contains = "in",
-    startswith = "startswith"
-}
-export enum ODataJoinOperators {
-    and = "and",
-    or = "or"
-}
-
-export interface IOdataFilter<DataType> {
-    property: keyof DataType;
-    operator: ODataOperators;
-    value: string | Date | number | boolean;
-    not?: boolean;
-}
-export interface IOdataFilterStatement<DataType> {
-    filters: (IOdataFilter<DataType> | IOdataFilterStatement<DataType>)[];
-    /** default: or */
-    join?: ODataJoinOperators;
-    not?: boolean;
-}
-function isIOdataFilter<DataType>(f: IOdataFilter<DataType> | IOdataFilterStatement<DataType>): f is IOdataFilter<DataType> {
-    if (typeof (f as IOdataFilter<DataType>).property === "string")
-        return true;
-    return false;
-}
-function isIOdataFilterStatement<DataType>(f: IOdataFilter<DataType> | IOdataFilterStatement<DataType>): f is IOdataFilter<DataType> {
-    if (typeof (f as IOdataFilterStatement<DataType>).filters === "object" && Array.isArray((f as IOdataFilterStatement<DataType>).filters))
-        return true;
-    return false;
-}
-
-enum TableStorageKnownColumns {
-    partitionKey = "PartitionKey",
-    rowKey = "RowKey"
-}
-
-function getPropNameForFilter(prop: string | number | symbol) {
-    return TableStorageKnownColumns[prop] || prop as string;
-}
-function getOdataFilterStatement<DataType>(filter: IOdataFilter<DataType>) {
-    let filterValue = isNullOrUndefined(filter.value)
-        ? `null`
-        : typeof filter.value === "string"
-            ? `'${filter.value.replace(/'/g, "''")}'`
-            : filter.value instanceof Date
-                ? `'${filter.value.toISOString()}'`
-                : `${filter.value}`;
-
-    if (filter.operator === ODataOperators.startswith)
-        return `${filter.not ? 'not ' : ''}${filter.operator}(${getPropNameForFilter(filter.property)}, ${filterValue})`;
-    return `${filter.not ? 'not ' : ''}${getPropNameForFilter(filter.property)} ${filter.operator} ${filterValue}`;
-}
-
-export function getOdataFilter<DataType>(statement: IOdataFilterStatement<DataType>) {
-    if (isNullOrUndefined(statement) || isNullOrEmptyArray(statement.filters)) return "";
-    if (isNullOrEmptyString(statement.join)) statement.join = ODataJoinOperators.or;
-
-    let filterStatements: string[] = [];
-    statement.filters.forEach(filter => {
-        if (isIOdataFilter(filter)) {
-            filterStatements.push(getOdataFilterStatement<DataType>(filter));
-        }
-        else {
-            let subStatement = getOdataFilter(filter);
-            if (!isNullOrEmptyString(subStatement))
-                filterStatements.push(subStatement);
-        }
-    });
-    if (filterStatements.length === 0) return "";
-
-    let result = "";
-    if (filterStatements.length === 1) result = filterStatements[0];
-    else if (filterStatements.length > 1) {
-        result = `(${filterStatements.join(` ${statement.join} `)})`;
-    }
-
-    return `${statement.not ? '(not ' : ''}${result}${statement.not ? ')' : ''}`;
+import { isNullOrEmptyArray, isNullOrEmptyString, isNullOrUndefined } from "@kwiz/common";
+
+export enum ODataOperators {
+    equal = "eq",
+    notEqual = "ne",
+    greater = "gt",
+    greaterOrEqual = "ge",
+    less = "lt",
+    lessOrEqual = "le",
+    contains = "in",
+    startswith = "startswith"
+}
+export enum ODataJoinOperators {
+    and = "and",
+    or = "or"
+}
+
+export interface IOdataFilter<DataType> {
+    property: keyof DataType;
+    operator: ODataOperators;
+    value: string | Date | number | boolean;
+    not?: boolean;
+}
+export interface IOdataFilterStatement<DataType> {
+    filters: (IOdataFilter<DataType> | IOdataFilterStatement<DataType>)[];
+    /** default: or */
+    join?: ODataJoinOperators;
+    not?: boolean;
+}
+function isIOdataFilter<DataType>(f: IOdataFilter<DataType> | IOdataFilterStatement<DataType>): f is IOdataFilter<DataType> {
+    if (typeof (f as IOdataFilter<DataType>).property === "string")
+        return true;
+    return false;
+}
+function isIOdataFilterStatement<DataType>(f: IOdataFilter<DataType> | IOdataFilterStatement<DataType>): f is IOdataFilter<DataType> {
+    if (typeof (f as IOdataFilterStatement<DataType>).filters === "object" && Array.isArray((f as IOdataFilterStatement<DataType>).filters))
+        return true;
+    return false;
+}
+
+enum TableStorageKnownColumns {
+    partitionKey = "PartitionKey",
+    rowKey = "RowKey"
+}
+
+function getPropNameForFilter(prop: string | number | symbol) {
+    return TableStorageKnownColumns[prop] || prop as string;
+}
+function getOdataFilterStatement<DataType>(filter: IOdataFilter<DataType>) {
+    let filterValue = isNullOrUndefined(filter.value)
+        ? `null`
+        : typeof filter.value === "string"
+            ? `'${filter.value.replace(/'/g, "''")}'`
+            : filter.value instanceof Date
+                ? `'${filter.value.toISOString()}'`
+                : `${filter.value}`;
+
+    if (filter.operator === ODataOperators.startswith)
+        return `${filter.not ? 'not ' : ''}${filter.operator}(${getPropNameForFilter(filter.property)}, ${filterValue})`;
+    return `${filter.not ? 'not ' : ''}${getPropNameForFilter(filter.property)} ${filter.operator} ${filterValue}`;
+}
+
+export function getOdataFilter<DataType>(statement: IOdataFilterStatement<DataType>) {
+    if (isNullOrUndefined(statement) || isNullOrEmptyArray(statement.filters)) return "";
+    if (isNullOrEmptyString(statement.join)) statement.join = ODataJoinOperators.or;
+
+    let filterStatements: string[] = [];
+    statement.filters.forEach(filter => {
+        if (isIOdataFilter(filter)) {
+            filterStatements.push(getOdataFilterStatement<DataType>(filter));
+        }
+        else {
+            let subStatement = getOdataFilter(filter);
+            if (!isNullOrEmptyString(subStatement))
+                filterStatements.push(subStatement);
+        }
+    });
+    if (filterStatements.length === 0) return "";
+
+    let result = "";
+    if (filterStatements.length === 1) result = filterStatements[0];
+    else if (filterStatements.length > 1) {
+        result = `(${filterStatements.join(` ${statement.join} `)})`;
+    }
+
+    return `${statement.not ? '(not ' : ''}${result}${statement.not ? ')' : ''}`;
 }