browser-extension-manager 1.0.14 → 1.1.0

package/dist/build.js

@@ -1,9 +1,10 @@
 // Libraries
 const path = require('path');
 const jetpack = require('fs-jetpack');
+const fs = require('fs');
 const JSON5 = require('json5');
 const argv = require('yargs').argv;
-const { force } = require('node-powertools');
+const { force, execute } = require('node-powertools');
 
 // Class
 function Manager() {
@@ -23,7 +24,13 @@ Manager.prototype.initialize = function () {
 
 // Logger
 Manager.prototype.logger = function (name) {
-  // Create logger
+  // Check if called as static method (this is not a Manager instance)
+  if (!(this instanceof Manager)) {
+    // For static calls, just return a new logger without caching
+    return new (require('./lib/logger'))(name);
+  }
+
+  // For instance calls, cache the logger
   if (!this._logger) {
     this._logger = new (require('./lib/logger'))(name);
   }
@@ -45,12 +52,44 @@ Manager.getArguments = function () {
 };
 Manager.prototype.getArguments = Manager.getArguments;
 
+// Report build errors with notification
+Manager.reportBuildError = function (error, callback) {
+  const logger = new (require('./lib/logger'))('build-error');
+
+  // Send notification using notifly
+  const errorMessage = error.message || error.toString() || 'Unknown error';
+  const errorPlugin = error.plugin || 'Build';
+
+  execute(`notifly --title 'Build Error: ${errorPlugin}' --message '${errorMessage.replace(/'/g, "\\'")}' --appIcon '/Users/ian/claude-ai-icon.png' --timeout 3 --sound 'Sosumi'`)
+    .catch((e) => {
+      logger.error('Failed to send notification', e);
+    });
+
+  // Log the error
+  logger.error(`[${errorPlugin}] ${errorMessage}`);
+
+  // If callback provided, call it with error
+  if (callback) {
+    return callback(error);
+  }
+
+  // Otherwise return a function that calls the callback with error
+  return (cb) => cb ? cb(error) : error;
+};
+Manager.prototype.reportBuildError = Manager.reportBuildError;
+
 // isBuildMode: checks if the build mode is enabled
 Manager.isBuildMode = function () {
   return process.env.BXM_BUILD_MODE === 'true';
 }
 Manager.prototype.isBuildMode = Manager.isBuildMode;
 
+// actLikeProduction - determines if we should act like production mode
+Manager.actLikeProduction = function () {
+  return Boolean(Manager.isBuildMode() || process.env.UJ_AUDIT_FORCE === 'true');
+}
+Manager.prototype.actLikeProduction = Manager.actLikeProduction;
+
 // getEnvironment: returns the environment based on the build mode
 Manager.getEnvironment = function () {
   return Manager.isBuildMode()
@@ -65,9 +104,9 @@ Manager.getManifest = function () {
 }
 Manager.prototype.getManifest = Manager.getManifest;
 
-// getConfig: requires and parses config.json
+// getConfig: requires and parses browser-extension-manager.json
 Manager.getConfig = function () {
-  return JSON5.parse(jetpack.read(path.join(process.cwd(), 'config', 'config.json')));
+  return JSON5.parse(jetpack.read(path.join(process.cwd(), 'config', 'browser-extension-manager.json')));
 }
 Manager.prototype.getConfig = Manager.getConfig;
 
@@ -100,11 +139,61 @@ Manager.getLiveReloadPort = function () {
 }
 Manager.prototype.getLiveReloadPort = Manager.getLiveReloadPort;
 
+// Create dummy file in project dist to force jekyll to build
+Manager.triggerRebuild = function (files, logger) {
+  // Ensure logger is defined
+  logger = this?._logger || logger || console;
+
+  // Normalize files into an array of file names
+  if (typeof files === 'string') {
+    files = [files]; // Single string file name
+  } else if (Array.isArray(files)) {
+    // Already an array, no changes needed
+  } else if (typeof files === 'object' && files !== null) {
+    files = Object.keys(files); // Extract keys from object
+  } else {
+    logger.error('Invalid files for triggerRebuild()');
+    return;
+  }
+
+  // Set current time
+  const now = new Date();
+
+  // Touch all files to update mtime (so Jekyll notices)
+  files.forEach((file) => {
+    try {
+      fs.utimesSync(file, now, now);
+      logger.log(`Triggered build: ${file}`);
+    } catch (e) {
+      logger.error(`Failed to trigger build ${file}`, e);
+    }
+  });
+}
+Manager.prototype.triggerRebuild = Manager.triggerRebuild;
+
 // Require
 Manager.require = function (path) {
   return require(path);
 };
 Manager.prototype.require = Manager.require;
 
+// Memory monitoring utility
+Manager.getMemoryUsage = function () {
+  const used = process.memoryUsage();
+  return {
+    rss: Math.round(used.rss / 1024 / 1024),
+    heapTotal: Math.round(used.heapTotal / 1024 / 1024),
+    heapUsed: Math.round(used.heapUsed / 1024 / 1024),
+    external: Math.round(used.external / 1024 / 1024),
+  };
+};
+Manager.prototype.getMemoryUsage = Manager.getMemoryUsage;
+
+Manager.logMemory = function (logger, label) {
+  const mem = Manager.getMemoryUsage();
+  logger.log(`[Memory ${label}] RSS: ${mem.rss}MB | Heap Used: ${mem.heapUsed}MB / ${mem.heapTotal}MB | External: ${mem.external}MB`);
+};
+Manager.prototype.logMemory = Manager.logMemory;
+
 // Export
 module.exports = Manager;

package/dist/commands/setup.js

@@ -15,58 +15,11 @@ const package = Manager.getPackage('main');
 const project = Manager.getPackage('project');
 const manifest = Manager.getManifest();
 
-// Load config
-const templating = {
-  nodeVersion: version.major(package.engines.node),
-};
-
 // Dependency MAP
 const DEPENDENCY_MAP = {
   'gulp': 'dev',
 }
 
-// File MAP
-const FILE_MAP = {
-  // Files to skip overwrite
-  'hooks/**/*': {
-    overwrite: false,
-  },
-  'src/**/*': {
-    overwrite: false,
-  },
-  'src/**/*.{html,md}': {
-    skip: (file) => {
-      // Get the name
-      const name = path.basename(file.name, path.extname(file.name));
-      const htmlFilePath = path.join(file.destination, `${name}.html`);
-      const mdFilePath = path.join(file.destination, `${name}.md`);
-      const htmlFileExists = jetpack.exists(htmlFilePath);
-      const mdFileExists = jetpack.exists(mdFilePath);
-      const eitherExists = htmlFileExists || mdFileExists;
-
-      // Skip if both files exist
-      return eitherExists;
-    },
-  },
-
-  // Files to rewrite path
-  // Removed because getting too confusing
-  // 'dist/pages/**/*': {
-  //   path: (file) => file.source.replace('dist/pages', 'dist'),
-  // },
-  '_.gitignore': {
-    name: (file) => file.name.replace('_.gitignore', '.gitignore'),
-  },
-
-  // Files to run templating on
-  '.github/workflows/build.yml': {
-    template: templating,
-  },
-  '.nvmrc': {
-    template: templating,
-  },
-}
-
 module.exports = async function (options) {
   // Fix options
   options = options || {};
@@ -74,8 +27,6 @@ module.exports = async function (options) {
   options.checkNode = force(options.checkNode || true, 'boolean');
   options.checkPeerDependencies = force(options.checkPeerDependencies || true, 'boolean');
   options.setupScripts = force(options.setupScripts || true, 'boolean');
-  options.buildSiteFiles = force(options.buildSiteFiles || true, 'boolean');
-  options.buildSiteFilesInput = force(options.buildSiteFilesInput || ['**/*'], 'array');
   options.checkLocality = force(options.checkLocality || true, 'boolean');
 
   // Log
@@ -110,11 +61,6 @@ module.exports = async function (options) {
       await setupScripts();
     }
 
-    // Build files
-    if (options.buildSiteFiles) {
-      await buildSiteFiles({ input: options.buildSiteFilesInput });
-    }
-
     // Copy all files from src/defaults/dist on first run
     // await copyDefaultDistFiles();
 
@@ -259,220 +205,6 @@ function install(package, ver, location) {
   });
 }
 
-function buildSiteFiles(options) {
-  options = options || {};
-  options.input = options.input || ['**/*'];
-
-  // Loop through all files in /defaults directory
-  const dir = path.join(__dirname, '..', 'defaults');
-  const input = [
-    // Files to include
-    // '**/*',
-    ...options.input,
-
-    // Files to exclude
-    // Dist files
-    // '!dist/**',
-    '!**/.DS_Store', // TODO: NOT WORKING
-  ]
-
-  // Get all files
-  const files = glob(input, {
-    cwd: dir,
-    dot: true,
-    nodir: true,
-  });
-
-  const debug = argv.debug
-    || true;
-
-  // Log
-  logger.log(`Preparing to copy ${files.length} default files...`);
-
-  // Loop
-  for (const file of files) {
-    // Build item
-    const item = {
-      source: null,
-      destination: null,
-      name: null,
-    }
-    // Get the destination
-    // const source = path.join(dir, file);
-    // let destination = path.join(process.cwd(), file.replace('defaults/', ''));
-    // const filename = path.basename(destination);
-
-    // Set the item properties
-    item.source = path.dirname(path.join(dir, file));
-    item.name = path.basename(file);
-    item.destination = path.dirname(path.join(process.cwd(), file.replace('defaults/', '')));
-
-    // Get options
-    const options = getFileOptions(file);
-    const ogName = item.name;
-
-    // Quit if file is '_'
-    // We have files like this to trigger the creation of directories without them being ignored by git
-    if (item.name === '_') {
-      // First, create the directory around the file
-      jetpack.dir(item.destination);
-
-      // Skip
-      continue;
-    }
-
-    // Resolve name
-    if (typeof options.name === 'function') {
-      item.name = options.name(item);
-    }
-
-    // Resolve path
-    if (typeof options.path === 'function') {
-      item.destination = options.path(item);
-    }
-
-    // Resolve overwrite
-    if (typeof options.overwrite === 'function') {
-      options.overwrite = options.overwrite(item);
-    }
-
-    // Resolve skip
-    if (typeof options.skip === 'function') {
-      options.skip = options.skip(item);
-    }
-
-    // Log
-    if (debug) {
-      logger.log(`Copying defaults...`);
-      logger.log(`  name: ${item.name}`);
-      logger.log(`  from: ${item.source}`);
-      logger.log(`  to: ${item.destination}`);
-      logger.log(`  overwrite: ${options.overwrite}`);
-      logger.log(`  skip: ${options.skip}`);
-
-      // logger.log('File:', file);
-      // logger.log('filename:', filename);
-      // logger.log('options:', options);
-      // // logger.log('contents:', jetpack.read(source));
-      // logger.log('source:', source);
-      // logger.log('Destination:', destination);
-      console.log('\n');
-    }
-
-    // Skip if needed
-    if (options.skip) {
-      continue;
-    }
-
-    // Get final paths
-    const finalSource = path.join(item.source, ogName);
-    const finalDestination = path.join(item.destination, item.name);
-
-    // console.log('---finalSource', finalSource);
-    // console.log('---finalDestination', finalDestination);
-
-    // Check if the file exists
-    const exists = jetpack.exists(finalDestination);
-
-    // Skip if exists and we don't want to overwrite
-    if (!options.overwrite && exists) {
-      continue;
-    }
-
-    // Run templating if needed
-    if (options.template) {
-      // Log
-      // logger.log('Running templating on:', destination);
-
-      // Run the templating
-      const contents = jetpack.read(finalSource);
-      const templated = template(contents, options.template);
-
-      // Write the file
-      jetpack.write(finalDestination, templated);
-    } else {
-      // Copy the file
-      jetpack.copy(finalSource, finalDestination, { overwrite: true });
-    }
-  }
-}
-
-// Copy default dist files
-// async function copyDefaultDistFiles() {
-//   // Get the directory
-//   const dir = path.join(__dirname, '..', '..', 'defaults', 'dist');
-
-//   // Log
-//   logger.log(`Copying default dist files from ${dir}`);
-
-//   // Copy the files
-//   jetpack.copy(dir, 'dist', { overwrite: true });
-// }
-// async function copyDefaultDistFiles() {
-//   // Loop through all files in /defaults directory
-//   const dir = path.join(__dirname, '..', '..', 'defaults', 'dist');
-//   const input = [
-//     // Files to include
-//     '**/*',
-
-//     // Files to exclude
-//     '!**/.DS_Store', // TODO: NOT WORKING
-//   ]
-
-//   // Get all files
-//   const files = glob(input, {
-//     cwd: dir,
-//     dot: true,
-//     nodir: true,
-//   });
-
-//   // Log
-//   logger.log(`Preparing to copy ${files.length} default dist files...`);
-
-//   for (const file of files) {
-//     // const relativePath = path.relative(path.join(__dirname, '..', '..', 'defaults', 'dist'), file);
-//     // const destination = path.join(__dirname, '..', '..', 'dist', relativePath.replace('pages', ''));
-//     const source = path.join(dir, file);
-//     const destination = path.join(process.cwd(), file.replace('dist/pages', 'dist'));
-
-//     // Log
-//     if (true) {
-//       logger.log(`Copying default dist file...`);
-//       logger.log(`  file: ${file}`);
-//       logger.log(`  from: ${source}`);
-//       logger.log(`  to: ${destination}`);
-//       console.log('\n');
-//     }
-
-//     // Ensure the directory exists
-//     // await jetpack.dir(path.dirname(destination));
-
-//     // Copy the file
-//     // await jetpack.copy(file, destination, { overwrite: true });
-//   }
-// }
-
-function getFileOptions(filePath) {
-  const defaults = {
-    overwrite: true,
-    name: null,
-    path: null,
-    template: null,
-    skip: false,
-  };
-
-  let options = { ...defaults };
-
-  // Loop through all patterns
-  for (const pattern in FILE_MAP) {
-    if (minimatch(filePath, pattern)) {
-      options = { ...options, ...FILE_MAP[pattern] };
-    }
-  }
-
-  return options;
-}
-
 function logVersionCheck(name, installedVersion, latestVersion, isUpToDate) {
   // Quit if local
   if (installedVersion.startsWith('file:')) {

package/dist/config/manifest.json

@@ -10,8 +10,10 @@
     '512': 'assets/images/icons/icon-512x.png',
     '256': 'assets/images/icons/icon-256x.png',
     '128': 'assets/images/icons/icon-128x.png',
+    '64': 'assets/images/icons/icon-64x.png',
     '48': 'assets/images/icons/icon-48x.png',
     '32': 'assets/images/icons/icon-32x.png',
+    '24': 'assets/images/icons/icon-24x.png',
     '16': 'assets/images/icons/icon-16x.png',
   },
 
@@ -20,7 +22,7 @@
 
   // Background script
   background: {
-    service_worker: 'assets/js/background.bundle.js',
+    service_worker: 'assets/js/components/background.bundle.js',
   },
 
   // Permissions
@@ -31,7 +33,7 @@
 
   // Options page
   options_ui: {
-    page: 'pages/options.html',
+    page: 'views/options/index.html',
   },
 
   // Content scripts
@@ -43,10 +45,16 @@
     default_icon: {
       '48': 'assets/images/icons/icon-48x.png',
       '32': 'assets/images/icons/icon-32x.png',
+      '24': 'assets/images/icons/icon-24x.png',
       '16': 'assets/images/icons/icon-16x.png',
     },
     default_title: '__MSG_appName__',
-    default_popup: 'pages/popup.html',
+    // default_popup: '', // Disabled so we can customize what happens on click
+  },
+
+  // Side panel
+  side_panel: {
+    default_path: 'views/sidepanel/index.html',
   },
 
   // Content security policy

package/dist/config/page-template.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html data-bs-theme="{{ theme.appearance }}">
+  <head>
+    <!-- Meta -->
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>{{ page.title }}</title>
+
+    <!-- Main CSS (includes Font Awesome) -->
+    <link href="/assets/css/main.bundle.css" rel="stylesheet">
+
+    <!-- Component-specific CSS -->
+    <link href="/assets/css/components/{{ page.name }}.bundle.css" rel="stylesheet">
+  </head>
+  <body>
+    {{ content }}
+
+    <!-- Main JS -->
+    <script src="/assets/js/components/{{ page.name }}.bundle.js"></script>
+  </body>
+</html>

package/dist/defaults/.nvmrc

@@ -1 +1 @@
-v{nodeVersion}/*
+v{ versions.node }/*

package/dist/defaults/CLAUDE.md

@@ -0,0 +1,8 @@
+# Identity
+This is a browser extension that is "consuming" a browser extension template project called Browser Extension Manager (BEM)--a collection of components that can be used to build a browser extension quickly and efficiently.
+
+## BEM Documentation
+You should have a full understanding of Browser Extension Manager before editing this project, which can be found at: node_modules/browser-extension-manager/CLAUDE.md
+
+## Project-specific Notes
+Add any notes specific to this project here.

package/dist/defaults/config/browser-extension-manager.json

@@ -0,0 +1,37 @@
+{
+  app: {
+    id: 'ultimate-jekyll',
+  },
+  theme: {
+    id: 'classy',
+  },
+  brand: {
+    name: 'Ultimate Jekyll',
+    url: 'https://ultimate-jekyll.itwcreativeworks.com',
+    contact: {
+      email: 'support@itwcreativeworks.com',
+    },
+    images: {
+      brandmark: 'https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-blue-1024x1024.png',
+      wordmark: 'https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-wordmark-blue-1024x.png',
+      combomark: 'https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-combomark-blue-1024x.png',
+    },
+  },
+  sentry: {
+    dsn: '',
+  },
+  google_analytics: {
+    id: '',
+    secret: '',
+  },
+  firebaseConfig: {
+    apiKey: 'AIzaSyDzy5BG9-i9RmymyFx6mfwSgaRioyfa0Cc',
+    authDomain: 'ultimate-jekyll.itwcreativeworks.com',
+    databaseURL: 'https://ultimate-jekyll.firebaseio.com',
+    projectId: 'ultimate-jekyll',
+    storageBucket: 'ultimate-jekyll.appspot.com',
+    messagingSenderId: '837186164890',
+    appId: '1:837186164890:web:f1f59569d661078c',
+    measurementId: 'G-FR3X7X4KYN',
+  },
+}

package/dist/defaults/src/assets/css/components/content/index.scss

@@ -0,0 +1,11 @@
+// ============================================
+// Content Script Component
+// ============================================
+
+// Import default content script component styles
+@use 'components/content' as *;
+
+// ============================================
+// Custom Content Script Styles
+// ============================================
+// Add your project-specific content script CSS below...

package/dist/defaults/src/assets/css/components/options/index.scss

@@ -0,0 +1,14 @@
+// ============================================
+// Custom Options Component Override
+// ============================================
+
+// Import the default options component styles first
+@use 'components/options' as *;
+
+// ============================================
+// Project-Specific Options Customization
+// ============================================
+body {
+  min-width: 400px;
+  max-width: 100%;
+}

package/dist/defaults/src/assets/css/components/pages/index.scss

@@ -0,0 +1,10 @@
+// ============================================
+// Index Page (Main Extension Page)
+// ============================================
+
+// Import the default index page component styles first
+@use 'components/pages/index' as *;
+
+// ============================================
+// Project-Specific Index Page Customization
+// ============================================

package/dist/defaults/src/assets/css/components/popup/index.scss

@@ -0,0 +1,10 @@
+// ============================================
+// Custom Popup Component Override
+// ============================================
+
+// Import the default popup component styles first
+@use 'components/popup' as *;
+
+// ============================================
+// Project-Specific Popup Customization
+// ============================================

package/dist/defaults/src/assets/css/components/sidepanel/index.scss

@@ -0,0 +1,6 @@
+// ============================================
+// Sidepanel Component Styles
+// ============================================
+// Default styles for the sidepanel view
+
+// Add your sidepanel-specific styles here

package/dist/defaults/src/assets/css/main.scss

@@ -0,0 +1,32 @@
+// ============================================
+// Theme Configuration
+// ============================================
+
+// Customize Browser Extension Manager theme variables here
+@use 'browser-extension-manager' as * with (
+  // ============================================
+  // Brand Colors
+  // ============================================
+  $primary: #5B47FB,
+  // $secondary: #6C757D,
+
+  // ============================================
+  // Typography (uncomment to customize)
+  // ============================================
+  // $font-family-base: 'Inter', -apple-system, sans-serif,
+
+  // ============================================
+  // Borders (uncomment to customize)
+  // ============================================
+  // $border-radius: 0.5rem,
+
+  // ============================================
+  // Add more customizations below
+  // See theme.scss for all customizable variables
+  // ============================================
+);
+
+// ============================================
+// Custom Global Styles
+// ============================================
+// Add your project-specific global CSS below that applies everywhere...

package/dist/defaults/src/assets/js/components/background/index.js

@@ -0,0 +1,22 @@
+// ============================================
+// Background Component (Service Worker)
+// ============================================
+
+// Import Browser Extension Manager
+import Manager from 'browser-extension-manager/background';
+
+// Create instance
+const manager = new Manager();
+
+// Initialize
+manager.initialize()
+.then(() => {
+  // Shortcuts
+  const { extension, logger, webManager } = manager;
+
+  // Add your project-specific background logic here
+  // ...
+
+  // Log the initialization
+  logger.log('Background initialized!');
+});