browser-extension-manager 1.1.12 → 1.2.0

package/CHANGELOG.md

@@ -15,6 +15,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - `Security` in case of vulnerabilities.
 
 ---
+## [1.1.13] - 2025-11-26
+### Added
+- Default `.env` file with publish credential templates for all stores
+- Intelligent line-based merging for `.gitignore` and `.env` files with section markers
+- Template variable support for `.yml` and `.yaml` files
+
+### Changed
+- Credentials now read from `.env` file instead of config (better security)
+- `.gitignore` and `.env` files use section markers to separate defaults from custom values
+- Template transform now passes `versions` data for workflow templating
+
 ## [1.1.6] - 2025-11-14
 ### Added
 - Bootstrap exposure to `window.bootstrap` in all UI components (popup, options, sidepanel, page)

package/README.md

@@ -52,9 +52,40 @@ When you run `npm run build`, BEM automatically translates your `src/_locales/en
 Only missing translations are generated - existing translations are preserved.
 
 ## 🌎 Publishing your extension
+
+### Manual Upload
 1. Run `npm run build` in Terminal to build your extension for production.
 2. Upload the `.zip` file to the browser's extension store.
 
+### Automatic Publishing
+BEM can automatically publish to Chrome, Firefox, and Edge stores when `BXM_IS_PUBLISH=true`:
+
+```bash
+BXM_IS_PUBLISH=true npm run build
+```
+
+**Setup:** Add store credentials to your `.env` file:
+
+```bash
+# Chrome Web Store
+CHROME_EXTENSION_ID="your-extension-id"
+CHROME_CLIENT_ID="your-client-id"
+CHROME_CLIENT_SECRET="your-client-secret"
+CHROME_REFRESH_TOKEN="your-refresh-token"
+
+# Firefox Add-ons
+FIREFOX_EXTENSION_ID="your-extension-id"
+FIREFOX_API_KEY="your-api-key"
+FIREFOX_API_SECRET="your-api-secret"
+
+# Microsoft Edge Add-ons
+EDGE_PRODUCT_ID="your-product-id"
+EDGE_CLIENT_ID="your-client-id"
+EDGE_API_KEY="your-api-key"
+```
+
+Only stores with configured credentials will be published to.
+
 <!-- ## ⛳️ Flags
 * `--test=false` - Coming soon
 ```bash

package/dist/defaults/.github/workflows/publish.yml

@@ -0,0 +1,82 @@
+name: Build and Publish Extension
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - main
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  NODE_VERSION: '[versions.node]'
+  BXM_BUILD_MODE: 'true'
+  BXM_IS_PUBLISH: 'true'
+
+  # Chrome Web Store credentials
+  CHROME_EXTENSION_ID: ${{ secrets.CHROME_EXTENSION_ID }}
+  CHROME_CLIENT_ID: ${{ secrets.CHROME_CLIENT_ID }}
+  CHROME_CLIENT_SECRET: ${{ secrets.CHROME_CLIENT_SECRET }}
+  CHROME_REFRESH_TOKEN: ${{ secrets.CHROME_REFRESH_TOKEN }}
+
+  # Firefox Add-ons credentials
+  FIREFOX_EXTENSION_ID: ${{ secrets.FIREFOX_EXTENSION_ID }}
+  FIREFOX_API_KEY: ${{ secrets.FIREFOX_API_KEY }}
+  FIREFOX_API_SECRET: ${{ secrets.FIREFOX_API_SECRET }}
+
+  # Microsoft Edge Add-ons credentials
+  EDGE_PRODUCT_ID: ${{ secrets.EDGE_PRODUCT_ID }}
+  EDGE_CLIENT_ID: ${{ secrets.EDGE_CLIENT_ID }}
+  EDGE_API_KEY: ${{ secrets.EDGE_API_KEY }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Setup git config
+        run: |
+          git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com"
+          git config --global user.name "$GITHUB_ACTOR"
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Log dependency versions
+        run: |
+          echo "Node: $(node -v)"
+          echo "NPM: $(npm -v)"
+          echo "BXM: $(npx bxm version)"
+          echo ""
+          echo "NPM Dependencies:"
+          npm list --depth=0 || echo ""
+
+      - name: Build and publish extension
+        run: |
+          npx bxm setup && npm run build
+
+      - name: Upload extension artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: extension-${{ github.sha }}
+          path: packaged/extension.zip
+          retention-days: 30
+
+      - name: Purge old artifacts
+        uses: kolpav/purge-artifacts-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          expire-in: 7 days

package/dist/defaults/_.env

@@ -0,0 +1,22 @@
+# ========== Default Values ==========
+# 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"
+
+# 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"
+
+# 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"
+
+# ========== Custom Values ==========
+# ...

package/dist/defaults/_.gitignore

@@ -1,4 +1,7 @@
+# ========== Default Values ==========
+# macOS
 .DS_Store
+
 # Logs
 logs
 *.log
@@ -11,10 +14,6 @@ firebase-debug.log*
 .firebase/
 
 # Firebase config
-
-# Uncomment this if you'd like others to create their own Firebase project.
-# For a team working on the same Firebase project(s), it is recommended to leave
-# it commented so all members can deploy to the same project(s) in .firebaserc.
 .firebaserc
 
 # Runtime data
@@ -32,16 +31,16 @@ coverage
 # nyc test coverage
 .nyc_output
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+# Grunt intermediate storage
 .grunt
 
-# Bower dependency directory (https://bower.io/)
+# Bower dependency directory
 bower_components
 
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
+# Compiled binary addons
 build/Release
 
 # Dependency directories
@@ -69,3 +68,8 @@ node_modules/
 /dist
 /packaged
 /.temp
+/.cache
+/_legacy
+
+# ========== Custom Values ==========
+# ...

package/dist/gulp/main.js

@@ -45,6 +45,7 @@ exports.build = series(
   parallel(exports.sass, exports.webpack, exports.icons, exports.html),
   exports.package,
   exports.audit,
+  exports.publish,
 );
 
 // Compose task scheduler

package/dist/gulp/tasks/defaults.js

@@ -56,6 +56,11 @@ const FILE_MAP = {
   // },
   '_.gitignore': {
     name: (file) => file.name.replace('_.gitignore', '.gitignore'),
+    mergeLines: true,
+  },
+  '_.env': {
+    name: (file) => file.name.replace('_.env', '.env'),
+    mergeLines: true,
   },
 
   // Config file with smart merging
@@ -89,6 +94,188 @@ const delay = 250;
 // Index
 let index = -1;
 
+// Helper function to merge line-based files (.gitignore, .env)
+function mergeLineBasedFiles(existingContent, newContent, fileName) {
+  // Parse existing content into lines
+  const existingLines = existingContent.split('\n');
+  const newLines = newContent.split('\n');
+
+  // For .env files, we track keys; for .gitignore, we track the full line
+  const isEnvFile = fileName === '.env';
+
+  // Markers for separating default values from user custom values
+  const DEFAULT_SECTION_MARKER = '# ========== Default Values ==========';
+  const CUSTOM_SECTION_MARKER = '# ========== Custom Values ==========';
+
+  // Parse existing file into default section and custom section
+  let defaultSection = [];
+  let customSection = [];
+  let inCustomSection = false;
+  let inDefaultSection = false;
+
+  const existingDefaultKeys = new Set();
+  const existingCustomKeys = new Set();
+
+  for (const line of existingLines) {
+    const trimmed = line.trim();
+
+    // Check for section markers
+    if (trimmed === DEFAULT_SECTION_MARKER) {
+      inDefaultSection = true;
+      inCustomSection = false;
+      continue;
+    }
+    if (trimmed === CUSTOM_SECTION_MARKER) {
+      inCustomSection = true;
+      inDefaultSection = false;
+      continue;
+    }
+
+    // Add to appropriate section
+    if (inCustomSection) {
+      customSection.push(line);
+      // Track custom keys
+      if (isEnvFile && trimmed && !trimmed.startsWith('#')) {
+        const key = trimmed.split('=')[0].trim();
+        if (key) {
+          existingCustomKeys.add(key);
+        }
+      }
+    } else if (inDefaultSection) {
+      defaultSection.push(line);
+      // Track default keys
+      if (isEnvFile && trimmed && !trimmed.startsWith('#')) {
+        const key = trimmed.split('=')[0].trim();
+        if (key) {
+          existingDefaultKeys.add(key);
+        }
+      }
+    }
+  }
+
+  // Parse new content to build complete default section in order
+  const newDefaultSection = [];
+  const newDefaultKeys = new Set();
+
+  let inNewDefaultSection = false;
+  let inNewCustomSection = false;
+
+  for (const line of newLines) {
+    const trimmed = line.trim();
+
+    // Check for section markers
+    if (trimmed === DEFAULT_SECTION_MARKER) {
+      inNewDefaultSection = true;
+      inNewCustomSection = false;
+      continue;
+    }
+    if (trimmed === CUSTOM_SECTION_MARKER) {
+      inNewCustomSection = true;
+      inNewDefaultSection = false;
+      continue;
+    }
+
+    // Only process default section from new file
+    if (inNewDefaultSection) {
+      // For env files, check if key exists
+      if (isEnvFile && trimmed && !trimmed.startsWith('#')) {
+        const key = trimmed.split('=')[0].trim();
+        if (key) {
+          newDefaultKeys.add(key);
+          // If key exists in user's file (either section), skip the default value
+          if (!existingDefaultKeys.has(key) && !existingCustomKeys.has(key)) {
+            // New key - add it
+            newDefaultSection.push(line);
+          } else {
+            // Key exists - we'll add user's value later in order
+            newDefaultSection.push(null); // Placeholder to maintain order
+          }
+        } else {
+          newDefaultSection.push(line);
+        }
+      } else {
+        // Comments and empty lines
+        newDefaultSection.push(line);
+      }
+    }
+  }
+
+  // Now merge user's existing default values in the correct order
+  const mergedDefaultSection = [];
+  let defaultSectionIndex = 0;
+
+  for (const line of newDefaultSection) {
+    if (line === null) {
+      // Placeholder - insert corresponding user value
+      // Find the next user value
+      while (defaultSectionIndex < defaultSection.length) {
+        const userLine = defaultSection[defaultSectionIndex++];
+        const trimmed = userLine.trim();
+        if (trimmed && !trimmed.startsWith('#')) {
+          mergedDefaultSection.push(userLine);
+          break;
+        }
+      }
+    } else {
+      mergedDefaultSection.push(line);
+    }
+  }
+
+  // Find any user-added lines in default section that aren't in new defaults
+  // These should be moved to custom section
+  const userAddedToDefaults = [];
+
+  for (const line of defaultSection) {
+    const trimmed = line.trim();
+
+    // Skip empty lines and comments
+    if (!trimmed || trimmed.startsWith('#')) {
+      continue;
+    }
+
+    if (isEnvFile) {
+      // For .env, check if key exists in new defaults
+      const key = trimmed.split('=')[0].trim();
+      if (key && !newDefaultKeys.has(key) && !existingCustomKeys.has(key)) {
+        // User added this key to defaults section - move to custom
+        userAddedToDefaults.push(line);
+      }
+    } else {
+      // For .gitignore, check if line exists in new defaults
+      // We need to check if this exact line appears in the new default section
+      const lineExistsInNewDefaults = newLines.some(newLine => {
+        return newLine.trim() === trimmed;
+      });
+
+      if (!lineExistsInNewDefaults) {
+        // User added this line to defaults section - move to custom
+        userAddedToDefaults.push(line);
+      }
+    }
+  }
+
+  // Build final result
+  const result = [];
+
+  // Add default section
+  result.push(DEFAULT_SECTION_MARKER);
+  result.push(...mergedDefaultSection);
+
+  // Add custom section
+  result.push('');
+  result.push(CUSTOM_SECTION_MARKER);
+
+  // First add any user lines that were in default section (moved to custom)
+  if (userAddedToDefaults.length > 0) {
+    result.push(...userAddedToDefaults);
+  }
+
+  // Then add existing custom section
+  result.push(...customSection);
+
+  return result.join('\n');
+}
+
 // Helper function to merge configs intelligently
 function mergeConfigs(existingConfig, newConfig) {
   const merged = { ...newConfig };
@@ -139,7 +326,7 @@ function defaults(complete, changedFile) {
   // return src(input, { base: 'src' })
   return src(filesToProcess, { base: `${rootPathPackage}/dist/defaults`, dot: true, encoding: false })  // Add base to preserve directory structure
     .pipe(customTransform())
-    .pipe(createTemplateTransform({site: config}))
+    .pipe(createTemplateTransform({site: config, versions: package.engines}))
     .pipe(dest(output, { encoding: false }))
     .on('finish', () => {
       // Log
@@ -226,8 +413,27 @@ function customTransform() {
       }
     }
 
+    // Handle line-based merging (.gitignore, .env)
+    if (options.mergeLines && exists && !isBinaryFile) {
+      try {
+        const existingContent = jetpack.read(fullOutputPath);
+        const newContent = file.contents.toString();
+
+        // Merge line-by-line, passing the filename to handle .env differently
+        const mergedContent = mergeLineBasedFiles(existingContent, newContent, item.name);
+
+        // Update file contents
+        file.contents = Buffer.from(mergedContent);
+
+        logger.log(`Merged line-based file: ${relativePath}`);
+      } catch (error) {
+        logger.error(`Error merging line-based file ${relativePath}:`, error);
+        // Fall through to normal processing if merge fails
+      }
+    }
+
     // Skip if instructed
-    if (options.skip || (!options.overwrite && exists && !options.merge)) {
+    if (options.skip || (!options.overwrite && exists && !options.merge && !options.mergeLines)) {
       logger.log(`Skipping file: ${relativePath}`);
       return callback();
     }
@@ -292,6 +498,8 @@ function getFileOptions(filePath) {
     path: null,
     template: null,
     skip: false,
+    merge: false,
+    mergeLines: false,
     rule: null,
   };
 

package/dist/gulp/tasks/publish.js

@@ -0,0 +1,218 @@
+// Libraries
+const Manager = new (require('../../build.js'));
+const logger = Manager.logger('publish');
+const { series } = require('gulp');
+const jetpack = require('fs-jetpack');
+const path = require('path');
+const { execute } = require('node-powertools');
+
+// Load package
+const project = Manager.getPackage('project');
+
+// Paths
+const zipPath = path.join(process.cwd(), 'packaged', 'extension.zip');
+
+// Store configurations - all credentials come from .env file
+const STORES = {
+  chrome: {
+    name: 'Chrome Web Store',
+    enabled: () => !!(process.env.CHROME_EXTENSION_ID && process.env.CHROME_CLIENT_ID),
+  },
+  firefox: {
+    name: 'Firefox Add-ons',
+    enabled: () => !!(process.env.FIREFOX_API_KEY && process.env.FIREFOX_API_SECRET),
+  },
+  edge: {
+    name: 'Microsoft Edge Add-ons',
+    enabled: () => !!(process.env.EDGE_PRODUCT_ID && process.env.EDGE_CLIENT_ID),
+  },
+};
+
+// Main publish task
+async function publish(complete) {
+  // Check if publish mode is enabled
+  if (!process.env.BXM_IS_PUBLISH) {
+    logger.log('Skipping publish (BXM_IS_PUBLISH not set)');
+    return complete();
+  }
+
+  // Log
+  logger.log('Starting publish...');
+
+  // Check if zip exists
+  if (!jetpack.exists(zipPath)) {
+    logger.error(`Extension zip not found at ${zipPath}. Run build first.`);
+    return complete();
+  }
+
+  // Log version
+  logger.log(`Publishing version ${project.version}`);
+
+  // Get enabled stores
+  const enabledStores = Object.entries(STORES)
+    .filter(([key, store]) => store.enabled())
+    .map(([key]) => key);
+
+  if (enabledStores.length === 0) {
+    logger.warn('No stores configured for publishing. Add credentials to .env file');
+    logger.log('Required environment variables:');
+    logger.log('  Chrome: CHROME_EXTENSION_ID, CHROME_CLIENT_ID, CHROME_CLIENT_SECRET, CHROME_REFRESH_TOKEN');
+    logger.log('  Firefox: FIREFOX_EXTENSION_ID, FIREFOX_API_KEY, FIREFOX_API_SECRET');
+    logger.log('  Edge: EDGE_PRODUCT_ID, EDGE_CLIENT_ID, EDGE_API_KEY');
+    return complete();
+  }
+
+  logger.log(`Publishing to: ${enabledStores.join(', ')}`);
+
+  // Run publish tasks in parallel
+  const publishTasks = enabledStores.map(async (store) => {
+    try {
+      switch (store) {
+        case 'chrome':
+          await publishToChrome();
+          break;
+        case 'firefox':
+          await publishToFirefox();
+          break;
+        case 'edge':
+          await publishToEdge();
+          break;
+      }
+      logger.log(`[${store}] Published successfully`);
+    } catch (e) {
+      logger.error(`[${store}] Publish failed: ${e.message}`);
+    }
+  });
+
+  await Promise.all(publishTasks);
+
+  // Log
+  logger.log('Publish finished!');
+
+  // Complete
+  return complete();
+}
+
+// Publish to Chrome Web Store
+async function publishToChrome() {
+  // Get credentials from env
+  const extensionId = process.env.CHROME_EXTENSION_ID;
+  const clientId = process.env.CHROME_CLIENT_ID;
+  const clientSecret = process.env.CHROME_CLIENT_SECRET;
+  const refreshToken = process.env.CHROME_REFRESH_TOKEN;
+
+  // Validate
+  if (!extensionId || !clientId || !clientSecret || !refreshToken) {
+    throw new Error('Missing Chrome credentials. Set CHROME_EXTENSION_ID, CHROME_CLIENT_ID, CHROME_CLIENT_SECRET, CHROME_REFRESH_TOKEN in .env');
+  }
+
+  logger.log('[chrome] Uploading to Chrome Web Store...');
+
+  // Use chrome-webstore-upload-cli
+  const command = [
+    'npx chrome-webstore-upload-cli',
+    `--source "${zipPath}"`,
+    `--extension-id "${extensionId}"`,
+    `--client-id "${clientId}"`,
+    `--client-secret "${clientSecret}"`,
+    `--refresh-token "${refreshToken}"`,
+  ].join(' ');
+
+  await execute(command);
+
+  logger.log('[chrome] Upload complete');
+}
+
+// Publish to Firefox Add-ons
+async function publishToFirefox() {
+  // Get credentials from env
+  const extensionId = process.env.FIREFOX_EXTENSION_ID;
+  const apiKey = process.env.FIREFOX_API_KEY;
+  const apiSecret = process.env.FIREFOX_API_SECRET;
+  const channel = process.env.FIREFOX_CHANNEL || 'listed';
+
+  // Validate
+  if (!apiKey || !apiSecret) {
+    throw new Error('Missing Firefox credentials. Set FIREFOX_API_KEY, FIREFOX_API_SECRET in .env');
+  }
+
+  logger.log('[firefox] Uploading to Firefox Add-ons...');
+
+  // Use web-ext sign
+  const rawDir = path.join(process.cwd(), 'packaged', 'raw');
+  const command = [
+    'npx web-ext sign',
+    `--source-dir "${rawDir}"`,
+    `--api-key "${apiKey}"`,
+    `--api-secret "${apiSecret}"`,
+    `--channel "${channel}"`,
+    extensionId ? `--id "${extensionId}"` : '',
+  ].filter(Boolean).join(' ');
+
+  await execute(command);
+
+  logger.log('[firefox] Upload complete');
+}
+
+// Publish to Microsoft Edge Add-ons
+async function publishToEdge() {
+  // Get credentials from env
+  const productId = process.env.EDGE_PRODUCT_ID;
+  const clientId = process.env.EDGE_CLIENT_ID;
+  const apiKey = process.env.EDGE_API_KEY;
+
+  // Validate
+  if (!productId || !clientId || !apiKey) {
+    throw new Error('Missing Edge credentials. Set EDGE_PRODUCT_ID, EDGE_CLIENT_ID, EDGE_API_KEY in .env');
+  }
+
+  logger.log('[edge] Uploading to Microsoft Edge Add-ons...');
+
+  // Read zip file
+  const zipBuffer = jetpack.read(zipPath, 'buffer');
+
+  // Edge API v1.1 endpoint
+  const uploadUrl = `https://api.addons.microsoftedge.microsoft.com/v1/products/${productId}/submissions/draft/package`;
+
+  // Upload using fetch
+  const response = await fetch(uploadUrl, {
+    method: 'POST',
+    headers: {
+      'Authorization': `ApiKey ${apiKey}`,
+      'X-ClientID': clientId,
+      'Content-Type': 'application/zip',
+    },
+    body: zipBuffer,
+  });
+
+  if (!response.ok) {
+    const errorText = await response.text();
+    throw new Error(`Edge API error: ${response.status} - ${errorText}`);
+  }
+
+  logger.log('[edge] Package uploaded, submitting for review...');
+
+  // Submit for review
+  const publishUrl = `https://api.addons.microsoftedge.microsoft.com/v1/products/${productId}/submissions`;
+  const publishResponse = await fetch(publishUrl, {
+    method: 'POST',
+    headers: {
+      'Authorization': `ApiKey ${apiKey}`,
+      'X-ClientID': clientId,
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({
+      notes: `Automated publish of version ${project.version}`,
+    }),
+  });
+
+  if (!publishResponse.ok) {
+    const errorText = await publishResponse.text();
+    throw new Error(`Edge publish error: ${publishResponse.status} - ${errorText}`);
+  }
+
+  logger.log('[edge] Upload complete');
+}
+
+// Export task
+module.exports = series(publish);

package/dist/gulp/tasks/utils/template-transform.js

@@ -7,7 +7,7 @@ const path = require('path');
  * Creates a through2 transform stream that processes template variables in files
  **/
 function createTemplateTransform(data) {
-  const extensions = ['html', 'md', 'liquid', 'json']
+  const extensions = ['html', 'md', 'liquid', 'json', 'yml', 'yaml']
 
   return through2.obj(function(file, encoding, callback) {
     // Skip directories

package/package.json

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