npm - @etsoo/shared - Versions diffs - 1.2.35 → 1.2.36 - Mend

@etsoo/shared 1.2.35 → 1.2.36

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 (8) hide show

package/README.md CHANGED Viewed

@@ -227,6 +227,7 @@ DOM/window related utilities
 |mergeFormData|Merge form data to primary one|
 |mergeURLSearchParams|Merge URL search parameters|
 |setFocus|Set HTML element focus by name|
+|setupLogging|Setup frontend logging|
 |verifyPermission|Verify file system permission|
 |zhHans|Get simplified Chinese resources definition|
 |zhHant|Get traditional Chinese resources definition|

package/__tests__/DomUtils.ts CHANGED Viewed

@@ -333,7 +333,7 @@ test('Tests for setupLogging', async () => {
     const action = jest.fn((data: ErrorData) => {
         expect(data.message).toBe('Test');
     });
-    DomUtils.setupLogging(action, true);
+    DomUtils.setupLogging(action, true, globalThis.self);
     // Act
     console.error('Test');

package/lib/cjs/DomUtils.d.ts CHANGED Viewed

@@ -151,11 +151,12 @@ export declare namespace DomUtils {
      */
     function setFocus(name: string | object, container?: HTMLElement): void;
     /**
-     * Setup logging
+     * Setup frontend logging
      * @param action Logging action
      * @param preventDefault Is prevent default action
+     * @param window Window object
      */
-    function setupLogging(action: (data: ErrorData) => void | Promise<void>, preventDefault?: ((type: ErrorType) => boolean) | boolean): void;
+    function setupLogging(action: (data: ErrorData) => void | Promise<void>, preventDefault?: ((type: ErrorType) => boolean) | boolean, window?: Window & typeof globalThis): void;
     /**
      * Verify file system permission
      * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission

package/lib/cjs/DomUtils.js CHANGED Viewed

@@ -497,22 +497,24 @@ var DomUtils;
     }
     DomUtils.setFocus = setFocus;
     /**
-     * Setup logging
+     * Setup frontend logging
      * @param action Logging action
      * @param preventDefault Is prevent default action
+     * @param window Window object
      */
-    function setupLogging(action, preventDefault) {
-        // Avoid multiple setup, if there is already a handler, please set "globalThis.onunhandledrejection = null" first
-        if (globalThis.onunhandledrejection)
+    function setupLogging(action, preventDefault, window = globalThis.window) {
+        // Avoid multiple setup, if there is already a handler, please set "window.onunhandledrejection = null" first
+        if (window.onunhandledrejection)
             return;
-        const errorPD = Utils_1.Utils.getResult(preventDefault, 'error') ?? true;
-        globalThis.onerror = (message, source, lineNo, colNo, error) => {
+        const errorType = 'error';
+        const errorPD = Utils_1.Utils.getResult(preventDefault, errorType) ?? true;
+        window.onerror = (message, source, lineNo, colNo, error) => {
             // Default source
-            source || (source = globalThis.location.href);
+            source || (source = window.location.href);
             let data;
             if (typeof message === 'string') {
                 data = {
-                    type: 'error',
+                    type: errorType,
                     message, // Share the same message with error
                     source,
                     lineNo,
@@ -522,7 +524,7 @@ var DomUtils;
             }
             else {
                 data = {
-                    type: 'error',
+                    type: errorType,
                     subType: message.type,
                     message: error?.message ??
                         `${message.currentTarget} event error`,
@@ -536,28 +538,31 @@ var DomUtils;
             // Return true to suppress error alert
             return errorPD;
         };
-        const rejectionPD = Utils_1.Utils.getResult(preventDefault, 'error') ?? true;
-        globalThis.onunhandledrejection = (event) => {
+        const rejectionType = 'unhandledrejection';
+        const rejectionPD = Utils_1.Utils.getResult(preventDefault, rejectionType) ?? true;
+        window.onunhandledrejection = (event) => {
             if (rejectionPD)
                 event.preventDefault();
             const reason = event.reason;
+            const source = window.location.href;
             let data;
             if (reason instanceof Error) {
+                const { name: subType, message, stack } = reason;
                 data = {
-                    type: 'unhandledrejection',
-                    subType: reason.name,
-                    message: reason.message,
-                    stack: reason.stack,
-                    source: globalThis.location.href
+                    type: rejectionType,
+                    subType,
+                    message,
+                    stack,
+                    source
                 };
             }
             else {
                 data = {
-                    type: 'unhandledrejection',
+                    type: rejectionType,
                     message: typeof reason === 'string'
                         ? reason
                         : JSON.stringify(reason),
-                    source: globalThis.location.href
+                    source
                 };
             }
             action(data);
@@ -582,14 +587,14 @@ var DomUtils;
                 const data = {
                     type,
                     message,
-                    source: globalThis.location.href,
+                    source: window.location.href,
                     stack
                 };
                 action(data);
             };
         };
-        globalThis.console.warn = localConsole('consoleWarn', globalThis.console.warn);
-        globalThis.console.error = localConsole('consoleError', globalThis.console.error);
+        window.console.warn = localConsole('consoleWarn', window.console.warn);
+        window.console.error = localConsole('consoleError', window.console.error);
     }
     DomUtils.setupLogging = setupLogging;
     /**

package/lib/mjs/DomUtils.d.ts CHANGED Viewed

@@ -151,11 +151,12 @@ export declare namespace DomUtils {
      */
     function setFocus(name: string | object, container?: HTMLElement): void;
     /**
-     * Setup logging
+     * Setup frontend logging
      * @param action Logging action
      * @param preventDefault Is prevent default action
+     * @param window Window object
      */
-    function setupLogging(action: (data: ErrorData) => void | Promise<void>, preventDefault?: ((type: ErrorType) => boolean) | boolean): void;
+    function setupLogging(action: (data: ErrorData) => void | Promise<void>, preventDefault?: ((type: ErrorType) => boolean) | boolean, window?: Window & typeof globalThis): void;
     /**
      * Verify file system permission
      * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission

package/lib/mjs/DomUtils.js CHANGED Viewed

@@ -494,22 +494,24 @@ export var DomUtils;
     }
     DomUtils.setFocus = setFocus;
     /**
-     * Setup logging
+     * Setup frontend logging
      * @param action Logging action
      * @param preventDefault Is prevent default action
+     * @param window Window object
      */
-    function setupLogging(action, preventDefault) {
-        // Avoid multiple setup, if there is already a handler, please set "globalThis.onunhandledrejection = null" first
-        if (globalThis.onunhandledrejection)
+    function setupLogging(action, preventDefault, window = globalThis.window) {
+        // Avoid multiple setup, if there is already a handler, please set "window.onunhandledrejection = null" first
+        if (window.onunhandledrejection)
             return;
-        const errorPD = Utils.getResult(preventDefault, 'error') ?? true;
-        globalThis.onerror = (message, source, lineNo, colNo, error) => {
+        const errorType = 'error';
+        const errorPD = Utils.getResult(preventDefault, errorType) ?? true;
+        window.onerror = (message, source, lineNo, colNo, error) => {
             // Default source
-            source || (source = globalThis.location.href);
+            source || (source = window.location.href);
             let data;
             if (typeof message === 'string') {
                 data = {
-                    type: 'error',
+                    type: errorType,
                     message, // Share the same message with error
                     source,
                     lineNo,
@@ -519,7 +521,7 @@ export var DomUtils;
             }
             else {
                 data = {
-                    type: 'error',
+                    type: errorType,
                     subType: message.type,
                     message: error?.message ??
                         `${message.currentTarget} event error`,
@@ -533,28 +535,31 @@ export var DomUtils;
             // Return true to suppress error alert
             return errorPD;
         };
-        const rejectionPD = Utils.getResult(preventDefault, 'error') ?? true;
-        globalThis.onunhandledrejection = (event) => {
+        const rejectionType = 'unhandledrejection';
+        const rejectionPD = Utils.getResult(preventDefault, rejectionType) ?? true;
+        window.onunhandledrejection = (event) => {
             if (rejectionPD)
                 event.preventDefault();
             const reason = event.reason;
+            const source = window.location.href;
             let data;
             if (reason instanceof Error) {
+                const { name: subType, message, stack } = reason;
                 data = {
-                    type: 'unhandledrejection',
-                    subType: reason.name,
-                    message: reason.message,
-                    stack: reason.stack,
-                    source: globalThis.location.href
+                    type: rejectionType,
+                    subType,
+                    message,
+                    stack,
+                    source
                 };
             }
             else {
                 data = {
-                    type: 'unhandledrejection',
+                    type: rejectionType,
                     message: typeof reason === 'string'
                         ? reason
                         : JSON.stringify(reason),
-                    source: globalThis.location.href
+                    source
                 };
             }
             action(data);
@@ -579,14 +584,14 @@ export var DomUtils;
                 const data = {
                     type,
                     message,
-                    source: globalThis.location.href,
+                    source: window.location.href,
                     stack
                 };
                 action(data);
             };
         };
-        globalThis.console.warn = localConsole('consoleWarn', globalThis.console.warn);
-        globalThis.console.error = localConsole('consoleError', globalThis.console.error);
+        window.console.warn = localConsole('consoleWarn', window.console.warn);
+        window.console.error = localConsole('consoleError', window.console.error);
     }
     DomUtils.setupLogging = setupLogging;
     /**

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.2.35",
+    "version": "1.2.36",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -59,7 +59,7 @@
         "jest": "^29.7.0",
         "jest-environment-jsdom": "^29.7.0",
         "ts-jest": "^29.1.2",
-        "typescript": "^5.3.3"
+        "typescript": "^5.4.2"
     },
     "dependencies": {
         "lodash.isequal": "^4.5.0"

package/src/DomUtils.ts CHANGED Viewed

@@ -602,25 +602,28 @@ export namespace DomUtils {
     }
     /**
-     * Setup logging
+     * Setup frontend logging
      * @param action Logging action
      * @param preventDefault Is prevent default action
+     * @param window Window object
      */
     export function setupLogging(
         action: (data: ErrorData) => void | Promise<void>,
-        preventDefault?: ((type: ErrorType) => boolean) | boolean
+        preventDefault?: ((type: ErrorType) => boolean) | boolean,
+        window: Window & typeof globalThis = globalThis.window
     ) {
-        // Avoid multiple setup, if there is already a handler, please set "globalThis.onunhandledrejection = null" first
-        if (globalThis.onunhandledrejection) return;
+        // Avoid multiple setup, if there is already a handler, please set "window.onunhandledrejection = null" first
+        if (window.onunhandledrejection) return;
-        const errorPD = Utils.getResult(preventDefault, 'error') ?? true;
-        globalThis.onerror = (message, source, lineNo, colNo, error) => {
+        const errorType: ErrorType = 'error';
+        const errorPD = Utils.getResult(preventDefault, errorType) ?? true;
+        window.onerror = (message, source, lineNo, colNo, error) => {
             // Default source
-            source ||= globalThis.location.href;
+            source ||= window.location.href;
             let data: ErrorData;
             if (typeof message === 'string') {
                 data = {
-                    type: 'error',
+                    type: errorType,
                     message, // Share the same message with error
                     source,
                     lineNo,
@@ -629,7 +632,7 @@ export namespace DomUtils {
                 };
             } else {
                 data = {
-                    type: 'error',
+                    type: errorType,
                     subType: message.type,
                     message:
                         error?.message ??
@@ -647,29 +650,33 @@ export namespace DomUtils {
             return errorPD;
         };
-        const rejectionPD = Utils.getResult(preventDefault, 'error') ?? true;
-        globalThis.onunhandledrejection = (event) => {
+        const rejectionType: ErrorType = 'unhandledrejection';
+        const rejectionPD =
+            Utils.getResult(preventDefault, rejectionType) ?? true;
+        window.onunhandledrejection = (event) => {
             if (rejectionPD) event.preventDefault();
             const reason = event.reason;
+            const source = window.location.href;
             let data: ErrorData;
             if (reason instanceof Error) {
+                const { name: subType, message, stack } = reason;
                 data = {
-                    type: 'unhandledrejection',
-                    subType: reason.name,
-                    message: reason.message,
-                    stack: reason.stack,
-                    source: globalThis.location.href
+                    type: rejectionType,
+                    subType,
+                    message,
+                    stack,
+                    source
                 };
             } else {
                 data = {
-                    type: 'unhandledrejection',
+                    type: rejectionType,
                     message:
                         typeof reason === 'string'
                             ? reason
                             : JSON.stringify(reason),
-                    source: globalThis.location.href
+                    source
                 };
             }
@@ -701,7 +708,7 @@ export namespace DomUtils {
                 const data: ErrorData = {
                     type,
                     message,
-                    source: globalThis.location.href,
+                    source: window.location.href,
                     stack
                 };
@@ -709,14 +716,11 @@ export namespace DomUtils {
             };
         };
-        globalThis.console.warn = localConsole(
-            'consoleWarn',
-            globalThis.console.warn
-        );
+        window.console.warn = localConsole('consoleWarn', window.console.warn);
-        globalThis.console.error = localConsole(
+        window.console.error = localConsole(
             'consoleError',
-            globalThis.console.error
+            window.console.error
         );
     }