@olenbetong/appframe-core 2.3.1 → 2.4.0

package/es/expose.js

@@ -1,4 +1,5 @@
 import { has } from "./has.js";
+import { invariant } from "./invariant.js";
 import { parseFunc } from "./parseFunc.js";
 import { requireNamespace } from "./requireNamespace.js";
 /**
@@ -7,18 +8,12 @@ import { requireNamespace } from "./requireNamespace.js";
  * @param value {object | Function | Function[]} The value(s) to expose
  */
 export function expose(name, value) {
-    if (arguments.length !== 2) {
-        throw new Error("Incorrect number of arguments passed to the expose function!");
-    }
+    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);
-            if (funcName) {
-                expose(name, func); // Expose func on namespace found in pName
-            }
-            else {
-                throw new Error("Unable to detect name of function! Name it, or only supply one function and include name in first parameter.");
-            }
+            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 {
@@ -39,7 +34,7 @@ export function expose(name, value) {
             namespace = name;
         }
         else {
-            throw new TypeError("Invalid typeof parameter 'name', or unable to parse pValue!");
+            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

package/es/getLocalizedString.js

@@ -1,4 +1,4 @@
-import { has } from "./has";
+import { has } from "./has.js";
 async function fetchLocalizedString(text) {
     try {
         let response = await fetch(`/api/user/localize/new/${af.article.id}`, {

package/es/index.d.ts

@@ -7,8 +7,9 @@ export * from "./downloadRequest.js";
 export { expose } from "./expose.js";
 export * from "./getUserImage.js";
 export { getLocalizedString } from "./getLocalizedString.js";
-export { localize } from "./localize.js";
 export * from "./has.js";
+export { invariant } from "./invariant.js";
+export { localize } from "./localize.js";
 export { default as localStorage } from "./localStorage.js";
 export { default as SessionHandler } from "./SessionHandler.js";
 export { UserSession };

package/es/index.js

@@ -7,10 +7,11 @@ export * from "./downloadRequest.js";
 export { expose } from "./expose.js";
 export * from "./getUserImage.js";
 export { getLocalizedString } from "./getLocalizedString.js";
-export { localize } from "./localize.js";
 export * from "./has.js";
+export { invariant } from "./invariant.js";
+export { localize } from "./localize.js";
 export { default as localStorage } from "./localStorage.js";
 export { default as SessionHandler } from "./SessionHandler.js";
 export { UserSession };
 export * from "./settings.js";
-export const version = "2.3.1";
+export const version = "2.4.0";

package/es/invariant.d.ts

@@ -0,0 +1 @@
+export declare function invariant(condition: any, message?: string | (() => string)): asserts condition;

package/es/invariant.js

@@ -0,0 +1,7 @@
+export function invariant(condition, message) {
+    if (condition) {
+        return;
+    }
+    const provided = typeof message === "function" ? message() : message;
+    throw new Error(provided ?? "Invariant failed");
+}

package/es/localize.js

@@ -1,4 +1,5 @@
 import { getLocalizedString } from "./getLocalizedString.js";
+import { invariant } from "./invariant.js";
 /**
  * Localization function for tagged templates. Replaces the arguments
  * with $n, where n is the index, before asking Appframe to translate
@@ -13,9 +14,7 @@ import { getLocalizedString } from "./getLocalizedString.js";
  * @returns Translated string
  */
 export function localize(stringParts, ...args) {
-    if (!Array.isArray(stringParts) || stringParts.length !== args.length + 1) {
-        throw TypeError("Method 'localize' must be used as a tag function");
-    }
+    invariant(!Array.isArray(stringParts) || stringParts.length !== args.length + 1, "Method 'localize' must be used as a tag function");
     let stringToLocalize = stringParts.map((s, i) => (i === stringParts.length - 1 ? s : `${s}\$${i}`)).join("");
     let localized = getLocalizedString(stringToLocalize);
     args.forEach((arg, index) => {

package/es/parseFunc.js

@@ -1,8 +1,7 @@
+import { invariant } from "./invariant.js";
 const funcRegex = /^function(?:\s+([a-zA-Z$_][a-zA-Z0-9$_]*))?\s*\(((?:(?:\s*[a-zA-Z$_][a-zA-Z0-9$_]*)(?:\s*,\s*[a-zA-Z$_][a-zA-Z0-9$_]*)*)?)\s*\)\s*\{((?:.|\n|\r)*)\}$/;
 export function parseFunc(func) {
     var match = func.toString().match(funcRegex);
-    if (match === null) {
-        throw new TypeError("Unable to parse function!");
-    }
+    invariant(match, "Unable to parse function!");
     return { name: match[1], args: match[2].split(","), body: match[3] };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olenbetong/appframe-core",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "Javascript libraries to utilize the Appframe framework",
   "type": "module",
   "sideEffects": [
@@ -46,7 +46,7 @@
     "mitt": "^3.0.0"
   },
   "devDependencies": {
-    "chalk": "^5.0.1"
+    "chalk": "^5.1.2"
   },
-  "gitHead": "1305f1e71ed33b486606deb000310fe09e6629e8"
+  "gitHead": "d484fdccc2273b06f14dc4bf7f690a0952c4a5c6"
 }

package/src/downloadRequest.ts

@@ -1,4 +1,5 @@
 import { downloadBlob } from "./downloadBlob.js";
+import { invariant } from "./invariant.js";
 
 export type DownloadItem = {
   status: "cancelled" | "error" | "requested" | "downloading" | "downloaded" | "completed";
@@ -29,9 +30,7 @@ export async function downloadRequest(request: Request, { fileName, signal, onPr
     if (!response.ok || !response.body) {
       if (response.headers.get("content-type")?.includes("application/json")) {
         let data = await response.json();
-        if (data.error) {
-          throw new Error(data.error);
-        }
+        invariant(!data.error, data.error);
       }
       throw new Error(`${response.status} ${response.statusText}`);
     }

package/src/errorHandler.ts

@@ -1,24 +1,26 @@
-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,
-    };
+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,
+      };
 
-    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

@@ -1,4 +1,5 @@
 import { has } from "./has.js";
+import { invariant } from "./invariant.js";
 import { parseFunc } from "./parseFunc.js";
 import { requireNamespace } from "./requireNamespace.js";
 
@@ -8,21 +9,17 @@ import { requireNamespace } from "./requireNamespace.js";
  * @param value {object | Function | Function[]} The value(s) to expose
  */
 export function expose(name: object | string, value: object | Function | Function[]): void {
-  if (arguments.length !== 2) {
-    throw new Error("Incorrect number of arguments passed to the expose function!");
-  }
+  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);
 
-      if (funcName) {
-        expose(name, func); // Expose func on namespace found in pName
-      } else {
-        throw new Error(
-          "Unable to detect name of function! Name it, or only supply one function and include name in first parameter."
-        );
-      }
+      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;
@@ -44,7 +41,7 @@ export function expose(name: object | string, value: object | Function | Functio
     } else if (keyName && (typeof name === "object" || typeof name === "function")) {
       namespace = name;
     } else {
-      throw new TypeError("Invalid typeof parameter 'name', or unable to parse pValue!");
+      invariant(false, "Invalid typeof parameter 'name', or unable to parse pValue!");
     }
 
     if (has(namespace, keyName)) {

package/src/getLocalizedString.ts

@@ -1,4 +1,4 @@
-import { has } from "./has";
+import { has } from "./has.js";
 
 async function fetchLocalizedString(text: string) {
   try {

package/src/index.ts

@@ -9,8 +9,9 @@ export * from "./downloadRequest.js";
 export { expose } from "./expose.js";
 export * from "./getUserImage.js";
 export { getLocalizedString } from "./getLocalizedString.js";
-export { localize } from "./localize.js";
 export * from "./has.js";
+export { invariant } from "./invariant.js";
+export { localize } from "./localize.js";
 export { default as localStorage } from "./localStorage.js";
 export { default as SessionHandler } from "./SessionHandler.js";
 export { UserSession };

package/src/invariant.ts

@@ -0,0 +1,8 @@
+export function invariant(condition: any, message?: string | (() => string)): asserts condition {
+  if (condition) {
+    return;
+  }
+  const provided: string | undefined = typeof message === "function" ? message() : message;
+
+  throw new Error(provided ?? "Invariant failed");
+}

package/src/localize.ts

@@ -1,29 +1,31 @@
 import { getLocalizedString } from "./getLocalizedString.js";
+import { invariant } from "./invariant.js";
 
 /**
  * Localization function for tagged templates. Replaces the arguments
  * with $n, where n is the index, before asking Appframe to translate
  * the string.
- * 
+ *
  * For example, if you call localize`Page ${2} or ${5}`, the string
  * "Page $0 of $1" will be sent to Appframe, and for norwegian,
  * "Side 2 av 5" will be returned.
- * 
- * @param stringParts 
- * @param args 
+ *
+ * @param stringParts
+ * @param args
  * @returns Translated string
  */
 export function localize(stringParts: TemplateStringsArray, ...args: any[]): string {
-  if (!Array.isArray(stringParts) || stringParts.length !== args.length + 1) {
-    throw TypeError("Method 'localize' must be used as a tag function");
-  }
+  invariant(
+    !Array.isArray(stringParts) || stringParts.length !== args.length + 1,
+    "Method 'localize' must be used as a tag function"
+  );
 
   let stringToLocalize = stringParts.map((s, i) => (i === stringParts.length - 1 ? s : `${s}\$${i}`)).join("");
   let localized = getLocalizedString(stringToLocalize);
 
   args.forEach((arg, index) => {
     localized = localized.replace("$" + index, arg);
-  })
+  });
 
   return localized;
-}
+}

package/src/parseFunc.ts

@@ -1,9 +1,10 @@
-const funcRegex = /^function(?:\s+([a-zA-Z$_][a-zA-Z0-9$_]*))?\s*\(((?:(?:\s*[a-zA-Z$_][a-zA-Z0-9$_]*)(?:\s*,\s*[a-zA-Z$_][a-zA-Z0-9$_]*)*)?)\s*\)\s*\{((?:.|\n|\r)*)\}$/;
+import { invariant } from "./invariant.js";
+
+const funcRegex =
+  /^function(?:\s+([a-zA-Z$_][a-zA-Z0-9$_]*))?\s*\(((?:(?:\s*[a-zA-Z$_][a-zA-Z0-9$_]*)(?:\s*,\s*[a-zA-Z$_][a-zA-Z0-9$_]*)*)?)\s*\)\s*\{((?:.|\n|\r)*)\}$/;
 
 export function parseFunc(func: Function) {
   var match = func.toString().match(funcRegex);
-  if (match === null) {
-    throw new TypeError("Unable to parse function!");
-  }
+  invariant(match, "Unable to parse function!");
   return { name: match[1], args: match[2].split(","), body: match[3] };
 }