browser-extension-manager 1.3.0 → 1.3.2

package/CHANGELOG.md

@@ -18,16 +18,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## [1.3.0] - 2025-12-16
 
 ### Added
-- Multi-target builds for Chromium and Firefox with automatic manifest adjustments
+- Multi-target builds for Chromium, Firefox, and Opera with automatic manifest adjustments
 - Chromium build uses `background.service_worker`, Firefox build uses `background.scripts`
-- Edge loading instructions in BUILD_INSTRUCTIONS.md
+- Opera build auto-resolves `__MSG_*__` placeholders in `short_name` (Opera enforces 12-char limit including placeholder text)
+- Browser-specific `TARGETS` config object with `adjustManifest()` functions for each target
+- Opera loading instructions in BUILD_INSTRUCTIONS.md
 
 ### Changed
-- Packaged output structure changed from `packaged/raw/` to `packaged/{chromium,firefox}/raw/`
-- Extension zip moved from `packaged/extension.zip` to `packaged/{chromium,firefox}/extension.zip`
-- `package.js` now creates separate builds for each browser target
-- `publish.js` uses target-specific paths (chromium zip for Chrome/Edge, firefox raw for Firefox)
+- Packaged output structure changed from `packaged/raw/` to `packaged/{chromium,firefox,opera}/raw/`
+- Extension zip moved from `packaged/extension.zip` to `packaged/{chromium,firefox,opera}/extension.zip`
+- `package.js` now creates separate builds for each browser target using configurable `TARGETS` object
+- `publish.js` uses target-specific paths (chromium zip for Chrome/Edge, firefox raw for Firefox, opera zip for Opera)
 - `audit.js` audits chromium build (code is identical between targets)
+- Manifest compilation now uses 3-step process: apply defaults → target adjustments → cleanup
 
 ## [1.1.13] - 2025-11-26
 ### Added

package/dist/config/manifest.json

@@ -2,6 +2,8 @@
   // Basic info
   manifest_version: 3,
   name: '__MSG_appName__',
+  // NOTE: Opera enforces a 12-char limit on short_name INCLUDING the placeholder text
+  // '__MSG_appNameShort__' is 19 chars, so use a static value for Opera compatibility
   short_name: '__MSG_appNameShort__',
   description: '__MSG_appDescription__',
 

package/dist/defaults/_.env

@@ -1,22 +1,26 @@
 # ========== Default Values ==========
+# Github Token
+# Get token at: https://github.com/settings/tokens
+GH_TOKEN=""
+
 # Chrome Web Store Publishing Credentials
 # Get credentials at: https://developer.chrome.com/docs/webstore/using_webstore_api/
-CHROME_EXTENSION_ID="your-extension-id"
-CHROME_CLIENT_ID="your-client-id"
-CHROME_CLIENT_SECRET="your-client-secret"
-CHROME_REFRESH_TOKEN="your-refresh-token"
+CHROME_EXTENSION_ID=""
+CHROME_CLIENT_ID=""
+CHROME_CLIENT_SECRET=""
+CHROME_REFRESH_TOKEN=""
 
 # Firefox Add-ons Publishing Credentials
 # Get credentials at: https://addons.mozilla.org/developers/addon/api/key/
-FIREFOX_EXTENSION_ID="your-extension-id"
-FIREFOX_API_KEY="your-api-key"
-FIREFOX_API_SECRET="your-api-secret"
+FIREFOX_EXTENSION_ID=""
+FIREFOX_API_KEY=""
+FIREFOX_API_SECRET=""
 
 # Microsoft Edge Add-ons Publishing Credentials
 # Get credentials at: https://learn.microsoft.com/en-us/microsoft-edge/extensions-chromium/publish/api/using-addons-api
-EDGE_PRODUCT_ID="your-product-id"
-EDGE_CLIENT_ID="your-client-id"
-EDGE_API_KEY="your-api-key"
+EDGE_PRODUCT_ID=""
+EDGE_CLIENT_ID=""
+EDGE_API_KEY=""
 
 # Opera Add-ons
 # NOTE: Opera does not have a publishing API. Extensions must be submitted manually at:

package/dist/gulp/tasks/package.js

@@ -152,8 +152,97 @@ function getPackageVersion(packageName) {
   }
 }
 
-// Build targets
-const TARGETS = ['chromium', 'firefox'];
+// Build targets with browser-specific configurations
+const TARGETS = {
+  chromium: {
+    // Chrome, Edge, Brave, etc. - uses service_worker
+    adjustManifest: (manifest) => {
+      if (manifest.background) {
+        delete manifest.background.scripts;
+      }
+      return manifest;
+    },
+  },
+  firefox: {
+    // Firefox - uses scripts array, no service_worker
+    adjustManifest: (manifest) => {
+      if (manifest.background) {
+        if (manifest.background.service_worker) {
+          if (!manifest.background.scripts) {
+            manifest.background.scripts = [manifest.background.service_worker];
+          }
+          delete manifest.background.service_worker;
+        }
+      }
+      return manifest;
+    },
+  },
+  opera: {
+    // Opera - like chromium but with stricter requirements
+    // Opera enforces 12-char limit on short_name INCLUDING placeholder text
+    adjustManifest: (manifest) => {
+      // Same as chromium for background
+      if (manifest.background) {
+        delete manifest.background.scripts;
+      }
+
+      // Opera requires static short_name (12 char limit includes placeholder text)
+      // __MSG_appNameShort__ is 19 chars, so we must use actual value
+      if (manifest.short_name && manifest.short_name.startsWith('__MSG_')) {
+        // Try to get the value from default locale
+        const localesDir = path.join('dist', '_locales');
+        const defaultLocale = manifest.default_locale || 'en';
+        const messagesPath = path.join(localesDir, defaultLocale, 'messages.json');
+
+        if (jetpack.exists(messagesPath)) {
+          try {
+            const messages = JSON5.parse(jetpack.read(messagesPath));
+            // Extract key from __MSG_keyName__
+            const key = manifest.short_name.replace(/^__MSG_/, '').replace(/__$/, '');
+            if (messages[key]?.message) {
+              manifest.short_name = messages[key].message;
+              logger.log(`[opera] Resolved short_name to "${manifest.short_name}"`);
+            }
+          } catch (e) {
+            logger.warn(`[opera] Could not resolve short_name from locale: ${e.message}`);
+          }
+        }
+      }
+
+      return manifest;
+    },
+  },
+};
+
+// Recursively remove empty arrays and objects from an object
+function removeEmptyValues(obj) {
+  if (Array.isArray(obj)) {
+    return obj;
+  }
+
+  if (obj && typeof obj === 'object') {
+    const result = {};
+    for (const [key, value] of Object.entries(obj)) {
+      // Recursively clean nested objects
+      const cleaned = removeEmptyValues(value);
+
+      // Skip empty arrays
+      if (Array.isArray(cleaned) && cleaned.length === 0) {
+        continue;
+      }
+
+      // Skip empty objects (after cleaning)
+      if (cleaned && typeof cleaned === 'object' && !Array.isArray(cleaned) && Object.keys(cleaned).length === 0) {
+        continue;
+      }
+
+      result[key] = cleaned;
+    }
+    return result;
+  }
+
+  return obj;
+}
 
 // Special Compilation Task for manifest.json with default settings
 async function compileManifest(outputDir, target) {
@@ -163,10 +252,12 @@ async function compileManifest(outputDir, target) {
     const configPath = path.join(rootPathPackage, 'dist', 'config', 'manifest.json');
 
     // Read and parse using JSON5
-    const manifest = JSON5.parse(jetpack.read(manifestPath));
+    let manifest = JSON5.parse(jetpack.read(manifestPath));
     const defaultConfig = JSON5.parse(jetpack.read(configPath));
 
-    // Apply defaults
+    // ═══════════════════════════════════════════════════════════════════════════
+    // STEP 1: Apply defaults (shared across all targets)
+    // ═══════════════════════════════════════════════════════════════════════════
     getKeys(defaultConfig).forEach(key => {
       const defaultValue = key.split('.').reduce((o, k) => (o || {})[k], defaultConfig);
       const userValue = key.split('.').reduce((o, k) => (o || {})[k], manifest);
@@ -192,25 +283,22 @@ async function compileManifest(outputDir, target) {
     // Add package version to manifest
     manifest.version = project.version;
 
-    // Apply target-specific manifest adjustments
-    if (manifest.background) {
-      if (target === 'chromium') {
-        // Chrome/Edge uses service_worker only
-        delete manifest.background.scripts;
-      } else if (target === 'firefox') {
-        // Firefox uses scripts array only
-        if (manifest.background.service_worker) {
-          // Ensure scripts array exists (derive from service_worker if needed)
-          if (!manifest.background.scripts) {
-            manifest.background.scripts = [manifest.background.service_worker];
-          }
-          delete manifest.background.service_worker;
-        }
-      }
+    // ═══════════════════════════════════════════════════════════════════════════
+    // STEP 2: Apply target-specific adjustments
+    // ═══════════════════════════════════════════════════════════════════════════
+    const targetConfig = TARGETS[target];
+    if (targetConfig?.adjustManifest) {
+      manifest = targetConfig.adjustManifest(manifest);
     }
 
+    // ═══════════════════════════════════════════════════════════════════════════
+    // STEP 3: Clean up (shared across all targets)
+    // ═══════════════════════════════════════════════════════════════════════════
+    // Remove empty arrays and objects from manifest
+    const cleanedManifest = removeEmptyValues(manifest);
+
     // Save as regular JSON
-    jetpack.write(outputPath, JSON.stringify(manifest, null, 2));
+    jetpack.write(outputPath, JSON.stringify(cleanedManifest, null, 2));
 
     logger.log(`[${target}] Manifest compiled with defaults`);
   } catch (e) {
@@ -245,14 +333,14 @@ async function compileLocales(outputDir) {
   }
 }
 
-// Package Task for raw - creates both chromium and firefox builds
+// Package Task for raw - creates builds for all browser targets
 async function packageRaw() {
   // Log
   logger.log(`Starting raw packaging...`);
 
   try {
     // Build for each target
-    for (const target of TARGETS) {
+    for (const target of Object.keys(TARGETS)) {
       await packageRawForTarget(target);
     }
 
@@ -320,7 +408,7 @@ async function packageZip() {
 
   try {
     // Create zip for each target
-    for (const target of TARGETS) {
+    for (const target of Object.keys(TARGETS)) {
       const inputDir = `packaged/${target}/raw`;
       const zipPath = `packaged/${target}/extension.zip`;
 

package/dist/gulp/tasks/publish.js

@@ -19,6 +19,10 @@ const PATHS = {
     zip: path.join(process.cwd(), 'packaged', 'firefox', 'extension.zip'),
     raw: path.join(process.cwd(), 'packaged', 'firefox', 'raw'),
   },
+  opera: {
+    zip: path.join(process.cwd(), 'packaged', 'opera', 'extension.zip'),
+    raw: path.join(process.cwd(), 'packaged', 'opera', 'raw'),
+  },
 };
 
 // Helper to check if a credential is valid (not empty or placeholder)

package/dist/gulp/templates/BUILD_INSTRUCTIONS.md

@@ -26,17 +26,12 @@ npm install
 npm run build
 ```
 5. The built extensions will be in `packaged/` directory:
-   - **Firefox:** `packaged/firefox/raw/` (unpacked) and `packaged/firefox/extension.zip`
    - **Chrome/Edge:** `packaged/chromium/raw/` (unpacked) and `packaged/chromium/extension.zip`
+   - **Firefox:** `packaged/firefox/raw/` (unpacked) and `packaged/firefox/extension.zip`
+   - **Opera:** `packaged/opera/raw/` (unpacked) and `packaged/opera/extension.zip`
 
 ## Loading the Extension
 
-### Firefox
-1. Go to `about:debugging`
-2. Click "This Firefox"
-3. Click "Load Temporary Add-on"
-4. Select `packaged/firefox/raw/manifest.json`
-
 ### Chrome
 1. Go to `chrome://extensions`
 2. Enable "Developer mode"
@@ -49,6 +44,18 @@ npm run build
 3. Click "Load unpacked"
 4. Select the `packaged/chromium/raw/` directory
 
+### Firefox
+1. Go to `about:debugging`
+2. Click "This Firefox"
+3. Click "Load Temporary Add-on"
+4. Select `packaged/firefox/raw/manifest.json`
+
+### Opera
+1. Go to `opera://extensions`
+2. Enable "Developer mode"
+3. Click "Load unpacked"
+4. Select the `packaged/opera/raw/` directory
+
 ## Questions
 
 If you have any questions about the build process, please contact the developer.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-manager",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "description": "Browser Extension Manager dependency manager",
   "main": "dist/index.js",
   "exports": {