@olenbetong/appframe-core 2.4.4 → 2.5.0

package/src/SessionHandler.ts

@@ -3,60 +3,60 @@ import mitt, { Emitter, Handler } from "mitt";
 type SessionHandlerEvent = "onExpired" | "onAuthenticated";
 
 export default class SessionHandler {
-  private eventHandler: Emitter<{ onAuthenticated: void; onExpired: void }> = mitt();
-
-  authenticated() {
-    this.eventHandler.emit("onAuthenticated");
-  }
-
-  async expired(callback?: () => void, type?: "RequireTwoFactor"): Promise<void> {
-    try {
-      let authPromise = new Promise<void>((resolve) => {
-        let eventHandler = () => {
-          this.eventHandler.off("onAuthenticated", eventHandler);
-          callback?.();
-          resolve();
-        };
-
-        this.eventHandler.on("onAuthenticated", eventHandler);
-      });
-
-      let dialog: HTMLDialogElement | null = document.querySelector("dialog.session-expired-dialog");
-      if (!dialog) {
-        dialog = document.createElement("dialog");
-        dialog.className = "session-expired-dialog";
-        dialog.style.display = "flex";
-        dialog.style.padding = "0";
-        dialog.style.left = "50%";
-        dialog.style.transform = "translateX(-50%)";
-
-        let link = "/login?ReturnUrl=%2fapi/sessionexpired/remove";
-        if (type !== "RequireTwoFactor") {
-          await fetch("/logout", { method: "POST" });
-        } else {
-          link = "/login?RequireTwoFactor=1&ReturnUrl=%2fapi/sessionexpired/remove";
-        }
-
-        dialog.innerHTML = `<iframe sandbox="allow-same-origin allow-scripts allow-modals allow-top-navigation-by-user-activation allow-forms" src="${link}" style="border:0;width:min(500px,100vw);height:min(700px, 100vh);"></iframe>`;
-        document.body.append(dialog);
-        dialog.showModal();
-        await authPromise;
-        dialog.remove();
-      } else {
-        await authPromise;
-      }
-    } catch (_) {
-      window.location.href = `/login?ReturnUrl=${encodeURIComponent(window.location.pathname)}${encodeURIComponent(
-        window.location.search
-      )}`;
-    }
-  }
-
-  attachEvent(eventName: SessionHandlerEvent, handler: Handler) {
-    return this.eventHandler.on(eventName, handler);
-  }
-
-  detachEvent(eventName: SessionHandlerEvent, handler: Handler) {
-    return this.eventHandler.off(eventName, handler);
-  }
+	private eventHandler: Emitter<{ onAuthenticated: void; onExpired: void }> = mitt();
+
+	authenticated() {
+		this.eventHandler.emit("onAuthenticated");
+	}
+
+	async expired(callback?: () => void, type?: "RequireTwoFactor"): Promise<void> {
+		try {
+			let authPromise = new Promise<void>((resolve) => {
+				let eventHandler = () => {
+					this.eventHandler.off("onAuthenticated", eventHandler);
+					callback?.();
+					resolve();
+				};
+
+				this.eventHandler.on("onAuthenticated", eventHandler);
+			});
+
+			let dialog: HTMLDialogElement | null = document.querySelector("dialog.session-expired-dialog");
+			if (!dialog) {
+				dialog = document.createElement("dialog");
+				dialog.className = "session-expired-dialog";
+				dialog.style.display = "flex";
+				dialog.style.padding = "0";
+				dialog.style.left = "50%";
+				dialog.style.transform = "translateX(-50%)";
+
+				let link = "/login?ReturnUrl=%2fapi/sessionexpired/remove";
+				if (type !== "RequireTwoFactor") {
+					await fetch("/logout", { method: "POST" });
+				} else {
+					link = "/login?RequireTwoFactor=1&ReturnUrl=%2fapi/sessionexpired/remove";
+				}
+
+				dialog.innerHTML = `<iframe sandbox="allow-same-origin allow-scripts allow-modals allow-top-navigation-by-user-activation allow-forms" src="${link}" style="border:0;width:min(500px,100vw);height:min(700px, 100vh);"></iframe>`;
+				document.body.append(dialog);
+				dialog.showModal();
+				await authPromise;
+				dialog.remove();
+			} else {
+				await authPromise;
+			}
+		} catch (_) {
+			window.location.href = `/login?ReturnUrl=${encodeURIComponent(window.location.pathname)}${encodeURIComponent(
+				window.location.search
+			)}`;
+		}
+	}
+
+	attachEvent(eventName: SessionHandlerEvent, handler: Handler) {
+		return this.eventHandler.on(eventName, handler);
+	}
+
+	detachEvent(eventName: SessionHandlerEvent, handler: Handler) {
+		return this.eventHandler.off(eventName, handler);
+	}
 }

package/src/UserSession.ts

@@ -1,29 +1,43 @@
 import SessionHandler from "./SessionHandler.js";
 
 export class UserSession extends SessionHandler {
-  amDesignator: string = "a.m.";
-  dayNames: string[] = ["sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"];
-  dayNamesShort: string[] = ["sun", "mon", "tue", "wed", "thu", "fri", "sat"];
-  decimalSeparator: string = ".";
-  domain: string = "OB";
-  email: string | null | undefined;
-  formats: undefined | Record<string, string>;
-  groupSeparator: string | null = null;
-  integratedSecurity: boolean = false;
-  isDeveloper: boolean = false;
-  login: string = "";
-  loginType: string | undefined;
-  monthNames: string[] = ["january", "february", "march", "april", "may", "june", "july", "august", "september", "october", "november", "december", ""];
-  monthNamesShort: string[] = ["jan", "feb", "mar", "apr", "may", "jun", "jul", "augt", "sep", "oct", "nov", "dec", ""];
-  name: string | undefined;
-  pmDesignator: string = "p.m.";
-  shortDateFormat: string = "dd.MM.yyyy";
-  culture: string = "en-GB";
-  uiculture: string = "en-GB";
+	amDesignator: string = "a.m.";
+	dayNames: string[] = ["sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"];
+	dayNamesShort: string[] = ["sun", "mon", "tue", "wed", "thu", "fri", "sat"];
+	decimalSeparator: string = ".";
+	domain: string = "OB";
+	email: string | null | undefined;
+	formats: undefined | Record<string, string>;
+	groupSeparator: string | null = null;
+	integratedSecurity: boolean = false;
+	isDeveloper: boolean = false;
+	login: string = "";
+	loginType: string | undefined;
+	monthNames: string[] = [
+		"january",
+		"february",
+		"march",
+		"april",
+		"may",
+		"june",
+		"july",
+		"august",
+		"september",
+		"october",
+		"november",
+		"december",
+		"",
+	];
+	monthNamesShort: string[] = ["jan", "feb", "mar", "apr", "may", "jun", "jul", "augt", "sep", "oct", "nov", "dec", ""];
+	name: string | undefined;
+	pmDesignator: string = "p.m.";
+	shortDateFormat: string = "dd.MM.yyyy";
+	culture: string = "en-GB";
+	uiculture: string = "en-GB";
 
-  constructor(userData: any) {
-    super();
-    this.formats = {};
-    Object.assign(this, userData);
-  }
+	constructor(userData: any) {
+		super();
+		this.formats = {};
+		Object.assign(this, userData);
+	}
 }

package/src/downloadBlob.ts

@@ -1,21 +1,21 @@
 export function downloadBlob(blob: Blob | MediaSource, fileName: string) {
-  return new Promise<void>(function (resolve, reject) {
-    try {
-      const url = URL.createObjectURL(blob);
-      const parent = document.body;
-      const anchor = document.createElement("a");
-      anchor.setAttribute("download", fileName);
-      anchor.href = url;
-      parent.append(anchor);
-      anchor.click();
-      parent.removeChild(anchor);
+	return new Promise<void>(function (resolve, reject) {
+		try {
+			const url = URL.createObjectURL(blob);
+			const parent = document.body;
+			const anchor = document.createElement("a");
+			anchor.setAttribute("download", fileName);
+			anchor.href = url;
+			parent.append(anchor);
+			anchor.click();
+			parent.removeChild(anchor);
 
-      setTimeout(function () {
-        URL.revokeObjectURL(url);
-        resolve();
-      }, 250);
-    } catch (ex) {
-      reject(ex);
-    }
-  });
+			setTimeout(function () {
+				URL.revokeObjectURL(url);
+				resolve();
+			}, 250);
+		} catch (ex) {
+			reject(ex);
+		}
+	});
 }

package/src/downloadRequest.ts

@@ -2,77 +2,77 @@ import { downloadBlob } from "./downloadBlob.js";
 import { invariant } from "./invariant.js";
 
 export type DownloadItem = {
-  status: "cancelled" | "error" | "requested" | "downloading" | "downloaded" | "completed";
-  bytesReceived?: number;
-  error?: string;
+	status: "cancelled" | "error" | "requested" | "downloading" | "downloaded" | "completed";
+	bytesReceived?: number;
+	error?: string;
 };
 
 export type DownloadParameters = {
-  signal?: AbortSignal;
-  fileName: string;
-  onProgress?: (progress: DownloadItem) => void;
+	signal?: AbortSignal;
+	fileName: string;
+	onProgress?: (progress: DownloadItem) => void;
 };
 
 export async function downloadRequest(request: Request, { fileName, signal, onProgress }: DownloadParameters) {
-  function reportProgress(progress: DownloadItem) {
-    if (typeof onProgress === "function") {
-      onProgress({ ...progress });
-    }
-  }
-
-  let bytesReceived = 0;
-
-  reportProgress({ status: "requested" });
-
-  try {
-    let response = await fetch(request);
-
-    if (!response.ok || !response.body) {
-      if (response.headers.get("content-type")?.includes("application/json")) {
-        let data = await response.json();
-        invariant(!data.error, data.error);
-      }
-      throw new Error(`${response.status} ${response.statusText}`);
-    }
-
-    try {
-      const reader = response.body.getReader();
-      const stream = new ReadableStream({
-        start: function (controller) {
-          function pump(): Promise<void> {
-            return reader.read().then(function (read) {
-              if (read.done) {
-                controller.close();
-                return;
-              }
-
-              bytesReceived += read.value.length;
-              reportProgress({ bytesReceived, status: "downloading" });
-              controller.enqueue(read.value);
-
-              return pump();
-            });
-          }
-
-          return pump();
-        },
-      });
-
-      response = new Response(stream);
-    } catch (error) {}
-
-    const blob = await response.blob();
-
-    reportProgress({ bytesReceived, status: "downloaded" });
-
-    await downloadBlob(blob, fileName);
-
-    reportProgress({ bytesReceived, status: "completed" });
-  } catch (err) {
-    if (signal?.aborted) {
-      reportProgress({ status: "cancelled" });
-    } else {
-      reportProgress({ error: (err as Error).message, status: "error" });
-    }
-  }
+	function reportProgress(progress: DownloadItem) {
+		if (typeof onProgress === "function") {
+			onProgress({ ...progress });
+		}
+	}
+
+	let bytesReceived = 0;
+
+	reportProgress({ status: "requested" });
+
+	try {
+		let response = await fetch(request);
+
+		if (!response.ok || !response.body) {
+			if (response.headers.get("content-type")?.includes("application/json")) {
+				let data = await response.json();
+				invariant(!data.error, data.error);
+			}
+			throw new Error(`${response.status} ${response.statusText}`);
+		}
+
+		try {
+			const reader = response.body.getReader();
+			const stream = new ReadableStream({
+				start: function (controller) {
+					function pump(): Promise<void> {
+						return reader.read().then(function (read) {
+							if (read.done) {
+								controller.close();
+								return;
+							}
+
+							bytesReceived += read.value.length;
+							reportProgress({ bytesReceived, status: "downloading" });
+							controller.enqueue(read.value);
+
+							return pump();
+						});
+					}
+
+					return pump();
+				},
+			});
+
+			response = new Response(stream);
+		} catch (error) {}
+
+		const blob = await response.blob();
+
+		reportProgress({ bytesReceived, status: "downloaded" });
+
+		await downloadBlob(blob, fileName);
+
+		reportProgress({ bytesReceived, status: "completed" });
+	} catch (err) {
+		if (signal?.aborted) {
+			reportProgress({ status: "cancelled" });
+		} else {
+			reportProgress({ error: (err as Error).message, status: "error" });
+		}
+	}
 }

package/src/errorHandler.ts

@@ -1,26 +1,26 @@
 if (process.env.NODE_ENV === "production") {
-  globalThis.window?.addEventListener("error", (event) => {
-    try {
-      // Try to avoid error-logging-loop
-      const data = {
-        error: event.error?.message ?? event.message ?? null,
-        file: event.filename,
-        line: event.lineno ?? 0,
-        column: event.colno ?? 0,
-        stack: event.error?.stack ?? null,
-      };
+	globalThis.window?.addEventListener("error", (event) => {
+		try {
+			// Try to avoid error-logging-loop
+			const data = {
+				error: event.error?.message ?? event.message ?? null,
+				file: event.filename,
+				line: event.lineno ?? 0,
+				column: event.colno ?? 0,
+				stack: event.error?.stack ?? null,
+			};
 
-      fetch("/data/Logger/LogError", {
-        body: JSON.stringify(data),
-        headers: {
-          Accept: "application/json",
-          "Content-Type": "application/json; charset=utf-8",
-          "X-Requested-With": "XMLHttpRequest",
-        },
-        method: "POST",
-      });
-    } catch (ex) {
-      // ignore
-    }
-  });
+			fetch("/data/Logger/LogError", {
+				body: JSON.stringify(data),
+				headers: {
+					Accept: "application/json",
+					"Content-Type": "application/json; charset=utf-8",
+					"X-Requested-With": "XMLHttpRequest",
+				},
+				method: "POST",
+			});
+		} catch (ex) {
+			// ignore
+		}
+	});
 }

package/src/expose.ts

@@ -3,52 +3,63 @@ import { invariant } from "./invariant.js";
 import { parseFunc } from "./parseFunc.js";
 import { requireNamespace } from "./requireNamespace.js";
 
+export type ExposeOptions = {
+	/**
+	 * Whether we should overwrite any existing values without warning.
+	 */
+	overwrite?: boolean;
+};
+
 /**
  * Expose a value to a potentially deeply nested global variable
  * @param name {string | object} Either a dot-separated path to the global variable, or an object to expose the value on
  * @param value {object | Function | Function[]} The value(s) to expose
  */
-export function expose(name: object | string, value: object | Function | Function[]): void {
-  invariant(arguments.length === 2, "Incorrect number of arguments passed to the expose function!");
-
-  if (Array.isArray(value)) {
-    for (let func of value) {
-      const { name: funcName } = parseFunc(func);
-
-      invariant(
-        funcName,
-        "Unable to detect name of function! Name it, or only supply one function and include name in first parameter."
-      );
-      expose(name, func); // Expose func on namespace found in pName
-    }
-  } else {
-    let keyName: string | undefined;
-    let namespace;
-
-    if (typeof value === "function") {
-      keyName = parseFunc(value).name;
-    }
-
-    if (typeof name === "string") {
-      let pathParts = name.split(".");
-
-      if (!keyName) {
-        keyName = pathParts[pathParts.length - 1];
-        pathParts = pathParts.slice(0, pathParts.length - 1);
-      }
-
-      namespace = requireNamespace(window, pathParts);
-    } else if (keyName && (typeof name === "object" || typeof name === "function")) {
-      namespace = name;
-    } else {
-      invariant(false, "Invalid typeof parameter 'name', or unable to parse pValue!");
-    }
-
-    if (has(namespace, keyName)) {
-      // If class is already defined, warn or show an alert
-      console.warn([name, keyName].join(".") + " is already defined!");
-    } else {
-      namespace[keyName] = value;
-    }
-  }
+export function expose(
+	name: object | string,
+	value: object | Function | Function[],
+	options: ExposeOptions = {}
+): void {
+	invariant(arguments.length === 2, "Incorrect number of arguments passed to the expose function!");
+
+	if (Array.isArray(value)) {
+		for (let func of value) {
+			const { name: funcName } = parseFunc(func);
+
+			invariant(
+				funcName,
+				"Unable to detect name of function! Name it, or only supply one function and include name in first parameter."
+			);
+			expose(name, func); // Expose func on namespace found in pName
+		}
+	} else {
+		let keyName: string | undefined;
+		let namespace;
+
+		if (typeof value === "function") {
+			keyName = parseFunc(value).name;
+		}
+
+		if (typeof name === "string") {
+			let pathParts = name.split(".");
+
+			if (!keyName) {
+				keyName = pathParts[pathParts.length - 1];
+				pathParts = pathParts.slice(0, pathParts.length - 1);
+			}
+
+			namespace = requireNamespace(window, pathParts);
+		} else if (keyName && (typeof name === "object" || typeof name === "function")) {
+			namespace = name;
+		} else {
+			invariant(false, "Invalid typeof parameter 'name', or unable to parse pValue!");
+		}
+
+		if (has(namespace, keyName) && options?.overwrite !== true) {
+			// If class is already defined, warn or show an alert
+			console.warn([name, keyName].join(".") + " is already defined!");
+		} else {
+			namespace[keyName] = value;
+		}
+	}
 }

package/src/getLocalizedString.ts

@@ -1,30 +1,30 @@
 import { has } from "./has.js";
 
 async function fetchLocalizedString(text: string) {
-  try {
-    let response = await fetch(`/api/user/localize/new/${af.article.id}`, {
-      body: JSON.stringify({ text }),
-      headers: {
-        Accept: "application/json; */*",
-        "Content-Type": "application/json",
-        "X-Requested-With": "XMLHttpRequest",
-      },
-      method: "POST",
-    });
+	try {
+		let response = await fetch(`/api/user/localize/new/${af.article.id}`, {
+			body: JSON.stringify({ text }),
+			headers: {
+				Accept: "application/json; */*",
+				"Content-Type": "application/json",
+				"X-Requested-With": "XMLHttpRequest",
+			},
+			method: "POST",
+		});
 
-    if (response.ok) {
-      return (await response.json()) as string;
-    }
-  } catch (error) {}
+		if (response.ok) {
+			return (await response.json()) as string;
+		}
+	} catch (error) {}
 
-  return text;
+	return text;
 }
 export function getLocalizedStringAsync(string: undefined | null): undefined | null;
 export function getLocalizedStringAsync(string: string): Promise<string>;
 export function getLocalizedStringAsync(string: string | undefined | null) {
-  if (!string) return string;
+	if (!string) return string;
 
-  return getLocalizedString(string, true);
+	return getLocalizedString(string, true);
 }
 
 export function getLocalizedString(string: undefined | null): undefined | null;
@@ -33,33 +33,33 @@ export function getLocalizedString(string: string, wait: false): string;
 export function getLocalizedString(string: string, wait: true): Promise<string>;
 export function getLocalizedString(string: undefined | null, wait: true): undefined | null;
 export function getLocalizedString(
-  string: string | undefined | null,
-  wait?: boolean
+	string: string | undefined | null,
+	wait?: boolean
 ): string | undefined | null | Promise<string> {
-  if (typeof string === "string" && string.trim().length === 0) {
-    return string;
-  }
+	if (typeof string === "string" && string.trim().length === 0) {
+		return string;
+	}
 
-  if (string === undefined || string === "" || string === null) {
-    return;
-  }
+	if (string === undefined || string === "" || string === null) {
+		return;
+	}
 
-  if (af?.article?.i18n !== undefined) {
-    if (!has(af.article.i18n, string)) {
-      af.article.i18n[string] = string;
+	if (af?.article?.i18n !== undefined) {
+		if (!has(af.article.i18n, string)) {
+			af.article.i18n[string] = string;
 
-      let promise = fetchLocalizedString(string).then((text) => {
-        af.article.i18n[string] = text;
-        return text;
-      });
+			let promise = fetchLocalizedString(string).then((text) => {
+				af.article.i18n[string] = text;
+				return text;
+			});
 
-      if (wait) {
-        return promise;
-      }
-    }
+			if (wait) {
+				return promise;
+			}
+		}
 
-    return af.article.i18n[string];
-  } else {
-    return string;
-  }
+		return af.article.i18n[string];
+	} else {
+		return string;
+	}
 }