browser-extension-manager 0.0.1

package/.nvmrc

@@ -0,0 +1 @@
+v22/*

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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Browser Extension Manager
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,56 @@
+<p align="center">
+  <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>
+
+<p align="center">
+  <img src="https://img.shields.io/github/package-json/v/itw-creative-works/ultimate-browser-extension.svg">
+  <br>
+  <img src="https://img.shields.io/librariesio/release/npm/ultimate-browser-extension.svg">
+  <img src="https://img.shields.io/bundlephobia/min/ultimate-browser-extension.svg">
+  <img src="https://img.shields.io/codeclimate/maintainability-percentage/itw-creative-works/ultimate-browser-extension.svg">
+  <img src="https://img.shields.io/npm/dm/ultimate-browser-extension.svg">
+  <img src="https://img.shields.io/node/v/ultimate-browser-extension.svg">
+  <img src="https://img.shields.io/website/https/itwcreativeworks.com.svg">
+  <img src="https://img.shields.io/github/license/itw-creative-works/ultimate-browser-extension.svg">
+  <img src="https://img.shields.io/github/contributors/itw-creative-works/ultimate-browser-extension.svg">
+  <img src="https://img.shields.io/github/last-commit/itw-creative-works/ultimate-browser-extension.svg">
+  <br>
+  <br>
+  <a href="https://itwcreativeworks.com">Site</a> | <a href="https://www.npmjs.com/package/ultimate-browser-extension">NPM Module</a> | <a href="https://github.com/itw-creative-works/ultimate-browser-extension">GitHub Repo</a>
+  <br>
+  <br>
+  <strong>Ultimate Browser Extension</strong> is a template that helps you jumpstart your Jekyll sites and is fueled by an intuitive incorporation of npm, gulp, and is fully SEO optimized and blazingly fast.
+</p>
+
+## 🦄 Features
+* **Build for Any Browser**: Export to Chrome, Firefox, Edge, and Opera.
+* **NPM & Gulp**: Fueled by an intuitive incorporation of npm and gulp.
+
+## 🚀 Getting started
+1. [Create a repo](https://github.com/itw-creative-works/ultimate-browser-extension/generate) from the **Ultimate Browser Extension** template.
+2. Clone the repo to your local machine.
+3. Run these command to get everything setup and sync'd!
+```bash
+npm install
+npx bxm setup
+npm start
+```
+4. Open your browser and navigate to `chrome://extensions` (or the equivalent for your browser).
+5. Enable **Developer mode**.
+6. Click on **Load unpacked** and select the `dist` folder in your project directory.
+7. Your extension should now be loaded and ready to use!
+
+## 📦 How to sync with the template
+1. Simply run `npx bxm setup` in Terminal to get all the latest updates from the **Ultimate Browser Extension template**.
+
+## 🌎 Publishing your extension
+1. Run `npm run dist` in Terminal to build your extension for production in every browser.
+2. Upload the respective `.zip` files to the browser's extension store.
+
+<!-- ## ⛳️ Flags
+* `--test=false` - Coming soon
+```bash
+npm start -- --test=false
+``` -->

package/bin/browser-extension-manager

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+const argv = require('yargs').argv;
+const cli = new (require('../dist/cli.js'))(argv);
+(async function() {
+  'use strict';
+  await cli.process(argv);
+}());

package/dist/assets/css/fontawesome.scss

@@ -0,0 +1,2 @@
+// Import Font Awesome CSS
+// @import '~@fortawesome/fontawesome-free/css/all.min.css';

package/dist/assets/css/main.scss

@@ -0,0 +1,3 @@
+body {
+  font-family: 'main.css2', sans-serif;
+}

package/dist/assets/js/main.js

@@ -0,0 +1,4 @@
+// const Manager = new (require('web-manager'));
+const Manager = new (require(proccess.cwd() + '/node_modules/web-manager'));
+
+console.log('MAIN.js', Manager);

package/dist/assets/js copy/base.js

@@ -0,0 +1,7 @@
+// // Initiate the web manager
+// Manager = new (require('web-manager'));
+
+// Manager.init(Configuration, function() {
+//   // Initialize core.js
+//   require('./core.js');
+// });

package/dist/assets/js copy/core.js

@@ -0,0 +1,81 @@
+// Manager.log('Init main.js');
+
+// var dom = Manager.dom();
+// var url = window.location.href;
+
+// // Load page specific scripts
+// if (url.includes('/pricing')) {
+//   dom.loadScript({src: 'https://cdn.itwcreativeworks.com/assets/general/js/pricing-page-handler/index.js'})
+// } else if (url.includes('/download')) {
+//   dom.loadScript({src: 'https://cdn.itwcreativeworks.com/assets/general/js/download-page-handler/index.js'})
+// } else if (url.includes('/browser-extension') || url.includes('/extension')) {
+//   dom.loadScript({src: 'https://cdn.itwcreativeworks.com/assets/general/js/browser-extension-page-handler/index.js'})
+// } else if (window.location.pathname.endsWith('.html')) {
+//   // Redirect and remove .html
+//   window.location.pathname = window.location.pathname.replace('.html', '');
+// }
+
+// // Load Slapform
+// var slapform;
+// dom.select('form.slapform')
+// .each(function (el, i) {
+
+//   dom.select(el).on('submit', function (event) {
+//     event.preventDefault();
+//     import('./slapform-processor.js')
+//     .then(function (mod) {
+//       slapform = slapform || new mod.default;
+//       slapform.process(event);
+//     })
+//   });
+
+//   dom.select(el.querySelector('button[type="submit"]'))
+//     .removeAttribute('disabled')
+//     .removeClass('disabled');
+// })
+
+// // Setup Tracking
+// var storage = Manager.storage();
+// var auth = storage.get('user.auth') || {};
+// var setup = false;
+
+// if (auth && auth.uid && auth.email) {
+//   setupTracking(auth);
+// }
+
+// // Save user auth data
+// Manager.auth().ready(function (user) {
+//   setupTracking(user);
+
+//   storage.set('user.auth.uid', user.uid);
+//   storage.set('user.auth.email', user.email);
+// })
+
+// function setupTracking(config) {
+//   if (setup) { return; }
+
+//   var tracking = window.Configuration.global.tracking;
+//   var phone = config.phone ? parseInt(config.phone.replace(/\+/ig, '')) : null;
+
+//   // Google Analytics
+//   gtag('set', 'user_id', config.uid);
+
+//   // Facebook Pixel
+//   fbq('init', tracking.facebookPixel, {
+//     external_id: config.uid,
+//     em: config.email,
+//     ph: phone,
+//     // fn: 'first_name',
+//     // ln: 'last_name',
+//   });
+
+//   // TikTok Pixel
+//   ttq.identify({
+//     external_id: config.uid || '',
+//     email: config.email || '',
+//     phone_number: phone ? '+' + phone : '',
+//   })
+
+//   setup = true;
+// }
+

package/dist/assets/js copy/main.js

@@ -0,0 +1,10 @@
+// // Initiate the web manager
+// Manager = new (require('web-manager'));
+
+// Manager.init(Configuration, function() {
+//   // Initialize core.js
+//   require('./core.js');
+
+//   // Require app.js
+//   require('../app/app.js');
+// });

package/dist/background.js

@@ -0,0 +1,261 @@
+// Libraries
+
+// Variables
+const serviceWorker = self;
+
+// Class
+function Manager() {
+  const self = this;
+
+  // Properties
+  self.extension = null;
+
+  // Defaults
+  self.config = {};
+  self.version = '{ version }';
+  self.brand = {
+    name: '{ brand.name }',
+  };
+  self.app = '{ app.id }';
+  self.environment = '{ environment }';
+  self.libraries = {
+    firebase: false,
+    messaging: false,
+    promoServer: false,
+    cachePolyfill: false,
+  };
+  self.cache = {
+    breaker: '',
+    name: ''
+  };
+
+  // Return
+  return self;
+}
+
+// Initialize
+Manager.prototype.initialize = function () {
+  const self = this;
+
+  return new Promise(function(resolve, reject) {
+    // Properties
+    self.extension = require('./lib/extension');
+
+    // Parse config file
+    parseConfiguration(self);
+
+    // Setup listeners
+    setupListeners(self);
+
+    // Import firebase
+    // importFirebase(self);
+
+    // Log
+    self.log('Initialized!', self.version, self.cache.name, self);
+
+    // Return
+    return resolve(self);
+  });
+};
+
+// Setup logger
+['log', 'error', 'warn', 'info', 'debug'].forEach(method => {
+  Manager.prototype[method] = function() {
+    // Get arguments
+    const time = new Date().toLocaleTimeString('en-US', {
+      hour12: false,
+      hour: '2-digit',
+      minute: '2-digit',
+      second: '2-digit'
+    });
+
+    // Add prefix
+    const args = [`[${time}] background:`, ...Array.from(arguments)];
+
+    // Call the original console method
+    console[method].apply(console, args);
+  };
+});
+
+// Parse configuration
+function parseConfiguration(self) {
+  try {
+    // Log
+    self.cache.breaker = new Date().getTime();
+    self.cache.name = `${self.app}-${self.cache.breaker}`;
+
+    self.log('Parsed configuration', self.config);
+  } catch (e) {
+    self.error('Error parsing configuration', e);
+  }
+}
+
+// Setup listeners
+function setupListeners(self) {
+  // Force service worker to use the latest version
+  serviceWorker.addEventListener('install', (event) => {
+    event.waitUntil(serviceWorker.skipWaiting());
+  });
+
+  serviceWorker.addEventListener('activate', (event) => {
+    event.waitUntil(serviceWorker.clients.claim());
+  });
+
+  // Handle clicks on notifications
+  // Open the URL of the notification
+  // ⚠️⚠️⚠️ THIS MUST BE PLACED BEFORE THE FIREBASE IMPORTS HANDLER ⚠️⚠️⚠️
+  // https://stackoverflow.com/questions/78270541/cant-catch-fcm-notificationclick-event-in-background-using-firebase-messa
+  serviceWorker.addEventListener('notificationclick', (event) => {
+    // Get the properties of the notification
+    const notification = event.notification;
+    const data = (notification.data && notification.data.FCM_MSG ? notification.data.FCM_MSG.data : null) || {};
+    const payload = (notification.data && notification.data.FCM_MSG ? notification.data.FCM_MSG.notification : null) || {};
+
+    // Get the click action
+    const clickAction = payload.click_action || data.click_action || '/';
+
+    // Log
+    self.log('Event: notificationclick event', event);
+    self.log('Event: notificationclick data', data);
+    self.log('Event: notificationclick payload', payload);
+    self.log('Event: notificationclick clickAction', clickAction);
+
+    // Handle the click
+    event.waitUntil(
+      clients.openWindow(clickAction)
+    );
+
+    // Close the notification
+    notification.close();
+  });
+
+  // Send messages: https://stackoverflow.com/questions/35725594/how-do-i-pass-data-like-a-user-id-to-a-web-worker-for-fetching-additional-push
+  // more messaging: http://craig-russell.co.uk/2016/01/29/background-messaging.html#.XSKpRZNKiL8
+  serviceWorker.addEventListener('message', (event) => {
+    try {
+      // Get the data
+      const data = event.data || {};
+      const response = {
+        status: 'success',
+        command: '',
+        data: {}
+      };
+
+      // Parse the data
+      data.command = data.command || '';
+      data.args = data.args || {};
+      response.command = data.command;
+
+      // Quit if no command
+      if (data.command === '') { return };
+
+      // Log
+      self.log('Event: postMessage', data);
+
+      // Handle the command
+      if (data.command === 'function') {
+        data.args.function = data.args.function || function() {};
+        data.args.function();
+      } else if (data.command === 'debug') {
+        self.log('Debug data =', data);
+        event.ports[0].postMessage(response);
+      } else if (data.command === 'skipWaiting') {
+        self.skipWaiting();
+        event.ports[0].postMessage(response);
+      } else if (data.command === 'unregister') {
+        self.registration.unregister()
+        .then(() => {
+          event.ports[0].postMessage(response);
+        })
+        .catch(() => {
+          response.status = 'fail';
+          event.ports[0].postMessage(response);
+        });
+      } else if (data.command === 'cache') {
+        data.args.pages = data.args.pages || [];
+        var defaultPages =
+        [
+          '/',
+          '/index.html',
+          /* '/?homescreen=1', */
+          '/assets/css/main.css',
+          '/assets/js/main.js',
+        ];
+        var pagesToCache = arrayUnique(data.args.pages.concat(defaultPages));
+        caches.open(SWManager.cache.name).then(cache => {
+          return cache.addAll(
+            pagesToCache
+          )
+          .then(() => {
+            self.log('Cached resources.');
+            event.ports[0].postMessage(response);
+          })
+          .catch(() => {
+            response.status = 'fail';
+            event.ports[0].postMessage(response);
+            self.log('Failed to cache resources.')
+          });
+        })
+      }
+
+      event.ports[0].postMessage(response);
+    } catch (e) {
+      // Set up a response
+      response.success = 'fail';
+
+      // Try to send a response
+      try { event.ports[0].postMessage(response) } catch (e) {}
+
+      // Log
+      self.log('Failed to receive message:', data, e);
+    }
+  });
+
+  // Log
+  self.log('Set up listeners');
+}
+
+// Import Firebase
+function importFirebase(self) {
+  // Import Firebase libraries
+  // importScripts(
+  //   'https://www.gstatic.com/firebasejs/{ firebaseVersion }/firebase-app-compat.js',
+  //   'https://www.gstatic.com/firebasejs/{ firebaseVersion }/firebase-messaging-compat.js',
+  //   'https://www.gstatic.com/firebasejs/{ firebaseVersion }/firebase-database-compat.js',
+  //   'https://www.gstatic.com/firebasejs/{ firebaseVersion }/firebase-firestore-compat.js',
+  // );
+  console.error('---0');
+  console.error('---1', __dirname);
+  // const firebase = require('web-manager/node_modules/firebase/firebase-app-compat.js');
+  // const firebase = require('web-manager');
+  // const firebase = require('firebase/firebase-auth-compat.js');
+  console.error('---2', firebase);
+
+  // Initialize app
+  const app = firebase.initializeApp(self.config.firebase);
+
+  // Initialize messaging
+  self.libraries.messaging = firebase.messaging();
+
+  // Attach firebase to SWManager
+  self.libraries.firebase = firebase;
+}
+
+function arrayUnique(array) {
+  var a = array.concat();
+
+  // Loop through array
+  for(var i=0; i<a.length; ++i) {
+    for(var j=i+1; j<a.length; ++j) {
+      if(a[i] === a[j]) {
+        a.splice(j--, 1);
+      }
+    }
+  }
+
+  // Return
+  return a;
+}
+
+// Export
+module.exports = Manager;

package/dist/build.js

@@ -0,0 +1,92 @@
+// Libraries
+const path = require('path');
+const jetpack = require('fs-jetpack');
+const JSON5 = require('json5');
+const argv = require('yargs').argv;
+const { force } = require('node-powertools');
+
+// Class
+function Manager() {
+  const self = this;
+
+  // Properties
+  self._logger = null;
+
+  // Return
+  return self;
+}
+
+// Initialize
+Manager.prototype.initialize = function () {
+  console.log('initialize:');
+};
+
+// Logger
+Manager.prototype.logger = function (name) {
+  // Create logger
+  if (!this._logger) {
+    this._logger = new (require('./lib/logger'))(name);
+  }
+
+  return this._logger;
+};
+
+// argv
+Manager.getArguments = function () {
+  const options = argv || {};
+
+  // Fix
+  options._ = options._ || [];
+  options.browser = force(options.browser === undefined ? true : options.browser, 'boolean');
+  options.debug = force(options.debug === undefined ? false : options.debug, 'boolean');
+
+  // Return
+  return options;
+};
+Manager.prototype.getArguments = Manager.getArguments;
+
+// isBuildMode: checks if the build mode is enabled
+Manager.isBuildMode = function () {
+  return process.env.BXM_BUILD_MODE === 'true';
+}
+Manager.prototype.isBuildMode = Manager.isBuildMode;
+
+// getEnvironment: returns the environment based on the build mode
+Manager.getEnvironment = function () {
+  return Manager.isBuildMode()
+    ? 'production'
+    : 'development';
+}
+Manager.prototype.getEnvironment = Manager.getEnvironment;
+
+// getManifest: requires and parses config.yml
+Manager.getManifest = function () {
+  return JSON5.parse(jetpack.read('src/manifest.json') || '{}');
+}
+Manager.prototype.getManifest = Manager.getManifest;
+
+// getConfig: requires and parses config.json
+Manager.getConfig = function () {
+  return JSON5.parse(jetpack.read(path.join(process.cwd(), 'config.json')));
+}
+Manager.prototype.getConfig = Manager.getConfig;
+
+// getPackage: requires and parses package.json
+Manager.getPackage = function (type) {
+  const basePath = type === 'project'
+    ? process.cwd()
+    : path.resolve(__dirname, '..')
+
+  const pkgPath = path.join(basePath, 'package.json')
+  return JSON5.parse(jetpack.read(pkgPath))
+}
+Manager.prototype.getPackage = Manager.getPackage;
+
+// Require
+Manager.require = function (path) {
+  return require(path);
+};
+Manager.prototype.require = Manager.require;
+
+// Export
+module.exports = Manager;

package/dist/cli.js

@@ -0,0 +1,70 @@
+// Libraries
+const path = require('path');
+const jetpack = require('fs-jetpack');
+
+// Command Aliases
+const DEFAULT = 'setup';
+const ALIASES = {
+  clean: ['-c', '--clean'],
+  install: ['-i', 'i', '--install'],
+  setup: ['-s', '--setup'],
+  version: ['-v', '--version'],
+};
+
+// Function to resolve command name from aliases
+function resolveCommand(options) {
+  // Check if a command was explicitly passed via positional argument
+  if (options._.length > 0) {
+    const command = options._[0];
+    for (const [key, aliases] of Object.entries(ALIASES)) {
+      if (command === key || aliases.includes(command)) {
+        return key;
+      }
+    }
+    return command; // If not found in aliases, return as-is
+  }
+
+  // Check if any alias was passed as a flag (e.g., -g)
+  for (const [key, aliases] of Object.entries(ALIASES)) {
+    for (const alias of aliases) {
+      if (options[alias.replace(/^-+/, '')]) { // Remove leading `-`
+        return key;
+      }
+    }
+  }
+
+  return DEFAULT; // Fallback to default if no match is found
+}
+
+// Main Function
+function Main() {}
+
+Main.prototype.process = async function (options) {
+  // Fix options
+  options = options || {};
+  options._ = options._ || [];
+
+  // Determine the command (use default if not provided)
+  const command = resolveCommand(options);
+
+  try {
+    // Get the command file path
+    const commandFile = path.join(__dirname, 'commands', `${command}.js`);
+
+    // Check if the command file exists
+    if (!jetpack.exists(commandFile)) {
+      throw new Error(`Error: Command "${command}" not found.`);
+    }
+
+    // Execute the command
+    const Command = require(commandFile);
+    await Command(options);
+  } catch (e) {
+    console.error(`Error executing command "${command}": ${e.message}`);
+
+    // Exit with error
+    throw e;
+  }
+};
+
+module.exports = Main;

package/dist/commands/clean.js

@@ -0,0 +1,33 @@
+// Libraries
+const Manager = new (require('../build.js'));
+const logger = Manager.logger('clean');
+const jetpack = require('fs-jetpack');
+
+// Load package
+const package = Manager.getPackage('main');
+const project = Manager.getPackage('project');
+
+// Const dirs
+const dirs = [
+  '.temp',
+  'dist',
+  'packaged',
+]
+
+module.exports = async function (options) {
+  // Log
+  logger.log(`Cleaning up .temp, dist, and packaged directories...`);
+
+  try {
+    // Loop through dirs
+    dirs.forEach((dir) => {
+      // Remove
+      jetpack.remove(dir);
+
+      // Create empty dir
+      jetpack.dir(dir);
+    });
+  } catch (e) {
+    logger.error(`Error clearing directories: ${e}`);
+  }
+};