web-manager 3.2.50 → 3.2.52

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# CHANGELOG
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## Changelog Categories
+
+- `BREAKING` for breaking changes.
+- `Added` for new features.
+- `Changed` for changes in existing functionality.
+- `Deprecated` for soon-to-be removed features.
+- `Removed` for now removed features.
+- `Fixed` for any bug fixes.
+- `Security` in case of vulnerabilities.
+
+---
+## [1.0.0] - 2024-06-19
+### Added
+- Initial release of the project 🚀

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg">
+  <a href="https://itwcreativeworks.com">
     <img src="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" width="100px">
   </a>
 </p>
@@ -28,26 +28,26 @@
   This module is best used when bundled with <a href="https://www.npmjs.com/package/webpack">webpack</a>.
 </p>
 
-## Install
+## 📦 Install Web Manager
 Install with npm:
 ```shell
 npm install web-manager
 ```
 
-## Features
+## 🦄 Features
 * Polyfill detection and implementation for Promises, Array methods, window.fetch, and more!
 * Dom API that acts as a super lightweight and optimized version of jQuery
 * Improved Localstorage API
 * Utility API with the most useful Lodash methods `get` and `set`
 
-## Libraries
+## 📚 Libraries
 * Firebase (Firebase app, Firestore, Auth, & Messaging)
 * Lazysizes to lazyload images
 * Sentry to report errors
 * [Chatsy.ai](https://chatsy.ai) AI chatbot integration
 * Cookieconsent to comply with GDPR
 
-## Example Setup
+## 📘 Example Setup
 After installing via npm, simply paste this script before the closing `</body>` tag to initialize Web Manager.
 ```html
 <script type="text/javascript">
@@ -61,7 +61,7 @@ After installing via npm, simply paste this script before the closing `</body>`
 </script>
 ```
 
-## Example Usage
+## 📘 Example Usage
 Lets go over some example usage of the library.
 
 ### Kitchen Sink Config example
@@ -75,7 +75,7 @@ By default, all of the libraries are enabled. But you can simply set `enabled` t
       },
       serviceWorker: {
         path: 'firebase-messaging-sw.js' // Path to your service worker
-      },    
+      },
       libraries: {
         firebase_app: { // Config is required if enabled
           enabled: true,
@@ -88,7 +88,7 @@ By default, all of the libraries are enabled. But you can simply set `enabled` t
             messagingSenderId: '123456',
             appId: '1:xxx'
           }
-        },     
+        },
         tawk: { // Config is required if enabled
           enabled: true,
           config: {
@@ -128,7 +128,7 @@ By default, all of the libraries are enabled. But you can simply set `enabled` t
         },
         lazysizes: { // No config required
           enabled: true
-        }      
+        }
       }
     }
   var Manager = new (require('web-manager'));
@@ -212,7 +212,7 @@ The Web Manager .utilities() API wraps some useful functions such as getting and
 ```html
 <script type="text/javascript">
   console.log('--- Exploring the .utilities() API ---');
-  
+
   // .get() and .set()
   Manager.ready(function() {
     var object = {
@@ -241,7 +241,7 @@ The Web Manager .utilities() API wraps some useful functions such as getting and
   Manager.utilities().clipboardCopy('I am copied to the clipboard!')
 
   // .escapeHTML()
-  Manager.utilities().escapeHTML('<strong>This will will NOT render as bold!</strong>')  
+  Manager.utilities().escapeHTML('<strong>This will will NOT render as bold!</strong>')
 </script>
 ```
 
@@ -390,11 +390,11 @@ To preserve file size and enforce optimization, the `.account()` library must be
 
 
 
-## Final Words
+## 🗨️ Final Words
 If you are still having difficulty, we would love for you to post
 a question to [the Web Manager issues page](https://github.com/itw-creative-works/web-manager/issues). It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
 
-## Projects Using this Library
+## 📚 Projects Using this Library
 [Somiibo](https://somiibo.com/): A Social Media Bot with an open-source module library. <br>
 [JekyllUp](https://jekyllup.com/): A website devoted to sharing the best Jekyll themes. <br>
 [Slapform](https://slapform.com/): A backend processor for your HTML forms on static sites. <br>

package/index.js

@@ -486,6 +486,8 @@ function Manager() {
                 config: {
                   dsn: '',
                   release: '',
+                  replaysSessionSampleRate: 0.1,
+                  replaysOnErrorSampleRate: 1.0,
                 },
               },
               chatsy: {
@@ -1476,50 +1478,65 @@ function Manager() {
       if (options.libraries.sentry.enabled === true) {
         import('@sentry/browser')
         .then(function(mod) {
+          // Set global
           window.Sentry = mod;
+
+          // Set config
           var config = options.libraries.sentry.config;
           config.release = config.release + '@' + self.properties.global.version;
           config.environment = self.properties.meta.environment;
+          config.integrations = config.integrations || [];
 
           // if (self.isDevelopment()) {
           //   config.dsn = 'https://901db748bbb9469f860dc36fb07a4374@o1120154.ingest.sentry.io/6155285';
           // }
 
+          // Add integration: browser tracing
+          config.integrations.push(Sentry.browserTracingIntegration());
+
+          // Add integration: replay
           if (config.replaysSessionSampleRate > 0 || config.replaysOnErrorSampleRate > 0) {
-            config.integrations = [
-              new Sentry.Replay({
-                // Additional SDK configuration goes in here, for example:
-                // maskAllText: true,
-                // blockAllMedia: true,
-              }),
-            ]
+            config.integrations.push(Sentry.replayIntegration({
+              maskAllText: false,
+              blockAllMedia: false,
+            }));
           }
 
+          // Setup before send
           config.beforeSend = function (event, hint) {
             var startTime = self.properties.page.startTime;
             var hoursSinceStart = (new Date() - startTime) / (1000 * 3600);
 
+            // Setup tags
             event.tags = event.tags || {};
             event.tags['process.type'] = event.tags['process.type'] || 'browser';
-
             // event.tags['usage.total.opens'] = parseInt(usage.total.opens);
             // event.tags['usage.total.hours'] = usage.total.hours;
             event.tags['usage.session.hours'] = hoursSinceStart.toFixed(2);
             // event.tags['store'] = self.properties().isStore();
+
+            // Setup user
             event.user = event.user || {};
             event.user.email = storage.get('user.auth.email', '')
             event.user.uid = storage.get('user.auth.uid', '');
             // event.user.ip = storage.get('user.ip', '');
 
+            // Log to console
             console.error('[SENTRY] Caught error', event, hint);
 
-            if (self.isDevelopment()) {
-              return null;
-            }
+            // Skip processing the event
+            // if (self.isDevelopment()) {
+            //   return null;
+            // }
 
+            // Process the event
             return event;
           }
+
+          // Initialize
           Sentry.init(config);
+
+          // Resolve
           resolve();
         })
         .catch(reject);
@@ -1565,7 +1582,7 @@ function Manager() {
     if (featuresDefault && featuresCustom) {
       cb();
     } else {
-      loadScript({src: 'https://polyfill.io/v3/polyfill.min.js?flags=always%2Cgated&features=default%2Ces5%2Ces6%2Ces7%2CPromise.prototype.finally%2C%7Ehtml5-elements%2ClocalStorage%2Cfetch%2CURLSearchParams'})
+      loadScript({src: 'https://cdnjs.cloudflare.com/polyfill/v3/polyfill.min.js?flags=always%2Cgated&features=default%2Ces5%2Ces6%2Ces7%2CPromise.prototype.finally%2C%7Ehtml5-elements%2ClocalStorage%2Cfetch%2CURLSearchParams'})
         .then(function() {
           cb();
         })

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "web-manager",
-  "version": "3.2.50",
+  "version": "3.2.52",
   "description": "Easily access important variables such as the query string, current domain, and current page in a single object.",
   "main": "index.js",
   "scripts": {
     "test": "./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
     "test_": "npm run prepare && ./node_modules/mocha/bin/mocha test/ --recursive --timeout=10000",
-    "prepare_": "node -e 'require(`prepare-package`)()'"
+    "prepare_": "node -e 'require(`prepare-package`)()'",
+    "prepare": "node -e \"require('prepare-package')()\"",
+    "prepare:watch": "nodemon -w ./src -e '*' --exec 'npm run prepare'"
   },
   "engines": {
-    "node": ">=6.0.0"
+    "node": ">=12"
   },
   "repository": {
     "type": "git",
@@ -32,15 +34,21 @@
       "lazysizes": "^5.3.2"
     }
   },
+  "preparePackage": {
+    "input": "./src",
+    "output": "./dist",
+    "replace": {}
+  },
   "dependencies": {
-    "@sentry/browser": "^7.117.0",
+    "@sentry/browser": "^8.13.0",
     "cookieconsent": "^3.1.1",
     "firebase": "^9.23.0",
-    "itwcw-package-analytics": "^1.0.1",
+    "itwcw-package-analytics": "^1.0.4",
     "lazysizes": "^5.3.2"
   },
   "devDependencies": {
     "lodash": "^4.17.21",
-    "mocha": "^8.4.0"
+    "mocha": "^8.4.0",
+    "prepare-package": "^1.1.13"
   }
 }

package/.codeclimate.yml

@@ -1,33 +0,0 @@
-version: "2"         # required to adjust maintainability checks
-checks:
-#   argument-count:
-#     config:
-#       threshold: 4
-#   complex-logic:
-#     config:
-#       threshold: 4
-#   file-lines:
-#     config:
-#       threshold: 250
-#   method-complexity:
-#     config:
-#       threshold: 5
-#   method-count:
-#     config:
-#       threshold: 20
-  method-lines:
-    config:
-      threshold: 200
-  # nested-control-flow:
-  #   config:
-  #     threshold: 4
-  # return-statements:
-  #   config:
-  #     threshold: 4
-  # similar-code:
-  #   config:
-  #     threshold: # language-specific defaults. an override will affect all languages.
-  # identical-code:
-  #   config:
-  #     threshold: # language-specific defaults. an override will affect all languages.
-

package/test/test.js

@@ -1,158 +0,0 @@
-const package = require('../package.json');
-const assert = require('assert');
-
-beforeEach(() => {
-});
-
-before(() => {
-});
-
-after(() => {
-});
-
-/*
- * ============
- *  Test Cases
- * ============
- */
-describe(`${package.name}`, () => {
-  const _ = require('../lib/utilities.js');
-  const lodash = require('lodash');
-
-  // Utilities
-  describe('.utilities()', () => {
-    const sample = {
-      main: {
-        true: true,
-        false: false,
-        zero: 0,
-        one: 1,
-        string: 'string',
-        stringEmpty: '',
-        object: {},
-        array: [],
-        null: null,
-        undefined: undefined,
-        nan: NaN,
-        infinity: Infinity,
-        negativeInfinity: -Infinity,
-        function: function () {},
-      }
-    }
-
-    // Normal Cases
-    describe('.get()', () => {
-      it('should return true', () => {
-        // console.log('---lodash', lodash.get(sample, 'main.true'));
-        // console.log('---_.get', _.get(sample, 'main.true'));
-        // console.log('---_.get2', _.get2(sample, 'main.true'));
-
-        assert.strictEqual(_.get(sample, 'main.true'), true);
-      });
-
-      it('should return false', () => {
-        assert.strictEqual(_.get(sample, 'main.false'), false);
-      });
-
-      it('should return 0', () => {
-        assert.strictEqual(_.get(sample, 'main.zero'), 0);
-      });
-
-      it('should return 1', () => {
-        assert.strictEqual(_.get(sample, 'main.one'), 1);
-      });
-
-      it('should return a string', () => {
-        assert.strictEqual(_.get(sample, 'main.string'), 'string');
-      });
-
-      it('should return an empty string', () => {
-        assert.strictEqual(_.get(sample, 'main.stringEmpty'), '');
-      });
-
-      it('should return an object', () => {
-        assert.deepStrictEqual(_.get(sample, 'main.object'), {});
-      });
-
-      it('should return an array', () => {
-        assert.deepStrictEqual(_.get(sample, 'main.array'), []);
-      });
-
-      it('should return null', () => {
-        assert.strictEqual(_.get(sample, 'main.null'), null);
-      });
-
-      it('should return undefined', () => {
-        assert.strictEqual(_.get(sample, 'main.undefined'), undefined);
-      });
-
-      it('should return NaN', () => {
-        assert.strictEqual(Number.isNaN(_.get(sample, 'main.nan')), true);
-      });
-
-      it('should return Infinity', () => {
-        assert.strictEqual(_.get(sample, 'main.infinity'), Infinity);
-      });
-
-      it('should return -Infinity', () => {
-        assert.strictEqual(_.get(sample, 'main.negativeInfinity'), -Infinity);
-      });
-
-      it('should return a function', () => {
-        assert.strictEqual(typeof _.get(sample, 'main.function'), 'function');
-      });
-
-      // Non-existent
-      it('should return undefined', () => {
-        assert.strictEqual(_.get(sample, 'main.nonexistent'), undefined);
-      });
-
-      // No path
-      it('should return undefined', () => {
-        assert.strictEqual(_.get(sample), undefined);
-      });
-
-      // Empty path
-      it('should return undefined', () => {
-        assert.strictEqual(_.get(sample, ''), undefined);
-      });
-
-      // Default value
-      it('should return default value', () => {
-        assert.strictEqual(_.get(sample, 'main.nonexistent', 'default'), 'default');
-      });
-
-      it('should return actual value', () => {
-        assert.strictEqual(_.get(sample, 'main.false', 'default'), false);
-      });
-
-      it('should return actual value', () => {
-        assert.strictEqual(_.get(sample, 'main.null', 'default'), null);
-      });
-
-      it('should return default value', () => {
-        assert.strictEqual(_.get(sample, 'main.undefined', 'default'), 'default');
-      });
-
-      // Non-object for object
-      it('should return undefined', () => {
-        assert.strictEqual(_.get(undefined, 'main.true'), undefined);
-      });
-
-      it('should return undefined', () => {
-        assert.strictEqual(_.get(null, 'main.true'), undefined);
-      });
-
-      it('should return undefined', () => {
-        assert.strictEqual(_.get(false, 'main.true'), undefined);
-      });
-
-      it('should return undefined', () => {
-        assert.strictEqual(_.get('', 'main.true'), undefined);
-      });
-
-    });
-
-  });
-
-})