antelope-cli 1.2.0 → 1.2.1

package/onboarding-crm/index.js

@@ -0,0 +1,157 @@
+const readline = require('readline');
+const chalk = require('chalk');
+const brandModule = require('./brand.js');
+const variablesColors = require('./variablesColors.js');
+const themes = require('./themes.js');
+const translations = require('./translations.js');
+const createConfig = require('./createConfig.js');
+
+const ALLOWED_TYPES = ['CORP_FL', 'IB_FL', 'CORP_AFF_FL', 'CORP_AFF_IB_PORTAL', 'CORP_AFF_MSQ'];
+
+const HELP = `
+Usage: ant-cli onboarding-crm --brand_name <name> [options]
+
+Onboards a CRM brand in the current web-crm checkout — same edits as "onboarding", but
+every value is taken from flags (interactive prompts are only a fallback in a TTY):
+  src/ng1/assets/css/sass/variables-colors.scss     (+ $colors entry and color shades)
+  src/ng1/assets/css/sass/materialism/themes.scss   (+ theme maps and .theme-template block)
+  src/assets/brands/<folder>/languages/<lang>.json  (one empty file per language)
+  src/configs/configs.ts                            (rewritten for the brand)
+
+Options:
+  --brand_name <name>          Display name → configs title, e.g. "Zenith Horizon Group" (required)
+  --brand_assets_folder <f>    Brand assets folder / connectedBrandName. Default: derived from
+                               --brand_name (lowercased, spaces removed)
+  --color <hex>                Brand hex color, e.g. "#1a2b3c". Empty ⇒ default palette ($corp)
+  --logo_url <url>             Logo image URL (black background) (required)
+  --favicon_url <url>          Favicon image URL (required)
+  --languages <csv>            2-letter language codes, comma-separated, e.g. "en,ar,de" (required)
+  --fcm_sender_id <id>         Firebase FCMSenderId (required)
+  --type <type>                One of: ${ALLOWED_TYPES.join(', ')} (required)
+  -h, --help                   Show this help
+
+Run from the root of a web-crm checkout — files are written relative to the current directory.
+`;
+
+const FLAGS = {
+  '--brand_name': 'brandName',
+  '--brand_assets_folder': 'brandAssetsFolder',
+  '--color': 'color',
+  '--logo_url': 'logo',
+  '--favicon_url': 'favicon',
+  '--languages': 'languages',
+  '--fcm_sender_id': 'fcmSenderId',
+  '--type': 'type'
+};
+
+function parseArgs(argv) {
+  const opts = {};
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === '--help' || a === '-h') opts.help = true;
+    else if (FLAGS[a]) opts[FLAGS[a]] = argv[++i];
+  }
+  return opts;
+}
+
+const ask = (rl, question) => new Promise((resolve) => rl.question(question, (a) => resolve(a)));
+
+// Resolve a value: prefer the flag; otherwise prompt (interactive only). Returns undefined
+// when absent and non-interactive, so the caller can report it as a missing required field.
+async function resolve(opts, key, promptText, interactive, rl) {
+  if (opts[key] !== undefined) return opts[key];
+  if (interactive) return ask(rl, promptText);
+  return undefined;
+}
+
+async function run() {
+  const opts = parseArgs(process.argv.slice(3));
+  if (opts.help) {
+    console.log(HELP);
+    return;
+  }
+
+  console.log(chalk.underline(chalk.cyan('Antelope CRM on-boarding\n')));
+
+  // Interactive only in a real terminal and when not forced non-interactive (CI / Ansible).
+  const interactive = Boolean(process.stdin.isTTY) && !process.env.CI;
+  const rl = interactive ? readline.createInterface({ input: process.stdin, output: process.stdout }) : null;
+
+  try {
+    const brandName = await resolve(opts, 'brandName', "What is the new brand's name?\n", interactive, rl);
+    const kebabCaseName = brandName ? brandName.toLowerCase().replace(/ /g, '-') : '';
+    const connectedBrandName = opts.brandAssetsFolder
+      ? opts.brandAssetsFolder.trim().toLowerCase().replace(/ /g, '')
+      : (brandName ? brandName.toLowerCase().replace(/ /g, '') : '');
+
+    // Color is optional (empty ⇒ default palette).
+    const color = opts.color !== undefined
+      ? opts.color
+      : (interactive ? await ask(rl, `Please set a color for "${kebabCaseName}", use hex value, leave empty for default.\n`) : '');
+
+    const logo = await resolve(opts, 'logo', 'Please enter the URL to the logo image suitable for a black background:\n', interactive, rl);
+    const favicon = await resolve(opts, 'favicon', 'Please provide the url to your favicon image:\n', interactive, rl);
+    const languagesInput = await resolve(opts, 'languages', 'Enter the languages (2-letter codes) separated by commas:\n', interactive, rl);
+    const fcmSenderId = await resolve(opts, 'fcmSenderId', 'Enter the FCMSenderId value (see https://xsites.atlassian.net/wiki/spaces/IKB/pages/777650347/Onboarding+Branding+Manual+for+devs#Firebase): ', interactive, rl);
+    const typeInput = await resolve(opts, 'type', `Enter the type value (allowed values: ${ALLOWED_TYPES.join(', ')}): `, interactive, rl);
+
+    // Validate required fields.
+    const missing = [];
+    if (!brandName) missing.push('--brand_name');
+    if (!logo) missing.push('--logo_url');
+    if (!favicon) missing.push('--favicon_url');
+    if (!languagesInput) missing.push('--languages');
+    if (!fcmSenderId) missing.push('--fcm_sender_id');
+    if (!typeInput) missing.push('--type');
+    if (missing.length) {
+      console.error(chalk.red(`Error: missing required value(s): ${missing.join(', ')}`));
+      console.log(HELP);
+      process.exitCode = 1;
+      return;
+    }
+
+    const type = typeInput.toUpperCase();
+    if (!ALLOWED_TYPES.includes(type)) {
+      console.error(chalk.red(`Error: invalid --type "${typeInput}". Allowed: ${ALLOWED_TYPES.join(', ')}`));
+      process.exitCode = 1;
+      return;
+    }
+
+    const languages = languagesInput.trim().split(',').map((l) => l.trim()).filter(Boolean);
+    if (!languages.length) {
+      console.error(chalk.red('Error: --languages must contain at least one 2-letter code.'));
+      process.exitCode = 1;
+      return;
+    }
+
+    brandModule.updateBrand({
+      brandName,
+      kebabCaseName,
+      connectedBrandName,
+      color: color || '',
+      logo,
+      favicon,
+      languages,
+      FCMSenderId: fcmSenderId,
+      type
+    });
+
+    console.log(chalk.bold(chalk.yellow(`\nOnboarding "${brandName}" (folder: ${connectedBrandName})`)));
+    console.log(chalk.bold(chalk.yellow('\nStep 1: Add to variables-colors.scss')));
+    await variablesColors.start();
+    console.log(chalk.bold(chalk.yellow('\nStep 2: Add to themes.scss')));
+    await themes.start();
+    console.log(chalk.bold(chalk.yellow('\nStep 3: Adding translations')));
+    await translations.start();
+    console.log(chalk.bold(chalk.yellow('\nStep 4: Editing the config file')));
+    await createConfig.start();
+    console.log(chalk.green('\nCRM onboarding completed!'));
+  } catch (err) {
+    console.error(chalk.red(err) + '\n Please delete files and code added by this failed session.');
+    process.exitCode = 1;
+  } finally {
+    if (rl) rl.close();
+  }
+}
+
+run();

package/onboarding-crm/themes.js

@@ -0,0 +1,92 @@
+const fs = require('fs');
+const brandModule = require('./brand.js');
+const chalk = require('chalk');
+const themesPath = 'src/ng1/assets/css/sass/materialism/themes.scss';
+
+function addColorToMap(mapName, key, value, data) {
+  const mapRegex = new RegExp(`\\$${mapName}:\\s*\\(([\\s\\S]*?)\\)`);
+  const match = data.match(mapRegex);
+  if (match) {
+    const mapContent = match[1];
+    const newMapContent = `$${mapName}: (${mapContent},\n  '${key}': ${value})`;
+    data = data.replace(mapRegex, newMapContent);
+  } else {
+    throw new Error(`Error: Could not find ${mapName} map in the file`);
+  }
+  return data;
+}
+
+// Same edits as onboarding/themes.js, driven by resolved brand state (no prompts).
+function start() {
+  const brand = brandModule.getBrand();
+  return new Promise((resolve, reject) => {
+    const themeVar = `
+    .theme-template-${brand.connectedBrandName} {
+      #logo {
+        display: inline-block;
+        width: 240px;
+        height: 120px;
+        background: url('${brand.logo}') no-repeat center center;
+        background-size: contain;
+      }
+      .navbar-toggle-container {
+        background: #222C38;
+
+        .icon-bar {
+          background: #fff !important;
+        }
+      }
+      .sidebar {
+        background: #222C38;
+        color: #ffffff;
+
+        ul a,
+        i {
+          color: #ffffff;
+        }
+
+        .brand-logo,
+        .brand-logo-text {
+          display: none;
+        }
+        .user-logged-in:after {
+          background: #26303C;
+        }
+      }
+    }
+    \n`;
+    fs.readFile(themesPath, 'utf8', (err, data) => {
+      if (err) {
+        return reject(err);
+      }
+      try {
+        data = addColorToMap(
+          'theme-colors',
+          brand.connectedBrandName,
+          brand.color ? `$${brand.connectedBrandName}` : '$corp',
+          data
+        );
+        data = addColorToMap(
+          'theme-secondary-colors',
+          brand.connectedBrandName,
+          brand.color ? `'${brand.connectedBrandName}'` : "'corp'",
+          data
+        );
+      } catch (mapError) {
+        return reject(mapError);
+      }
+      const insertionPoint = data.lastIndexOf('@each $color-name');
+      const newFileContent = data.slice(0, insertionPoint) + themeVar + data.slice(insertionPoint);
+      fs.writeFile(themesPath, newFileContent, 'utf8', (error) => {
+        if (error) {
+          reject(error);
+        } else {
+          console.log(chalk.cyan('themes.scss file updated successfully!'));
+          resolve(null);
+        }
+      });
+    });
+  });
+}
+
+module.exports = { start };

package/onboarding-crm/translations.js

@@ -0,0 +1,37 @@
+const fs = require('fs');
+const chalk = require('chalk');
+const brandModule = require('./brand.js');
+const path = require('path');
+
+function createTranslationsFolder(translationsDirectory) {
+  const folderPath = path.join(translationsDirectory, 'languages');
+  if (!fs.existsSync(folderPath)) {
+    fs.mkdirSync(folderPath, { recursive: true });
+  }
+  return folderPath;
+}
+
+function createLanguageFiles(languages, folderPath) {
+  languages.forEach((language) => {
+    const filePath = path.join(folderPath, `${language}.json`);
+    fs.writeFileSync(filePath, '{}', 'utf8');
+  });
+}
+
+// Same as onboarding/translations.js, but the languages list is resolved from flags/prompt upfront.
+function start() {
+  const brand = brandModule.getBrand();
+  const translationsDir = `src/assets/brands/${brand.connectedBrandName}`;
+  return new Promise((resolve, reject) => {
+    try {
+      const folderPath = createTranslationsFolder(translationsDir);
+      createLanguageFiles(brand.languages, folderPath);
+      console.log(chalk.cyan('Translations added successfully!'));
+      resolve(null);
+    } catch (error) {
+      reject(error + '\n Please add the translations manually.');
+    }
+  });
+}
+
+module.exports = { start };

package/onboarding-crm/variablesColors.js

@@ -0,0 +1,54 @@
+const fs = require('fs');
+const brandModule = require('./brand.js');
+const chalk = require('chalk');
+const variablesColorsPath = 'src/ng1/assets/css/sass/variables-colors.scss';
+const defaultColor = '$corp';
+
+// Same edits as onboarding/variablesColors.js, driven by resolved brand state (no prompts).
+function start() {
+  return new Promise((resolve, reject) => {
+    try {
+      const { connectedBrandName, color: hexColor } = brandModule.getBrand();
+      let data = fs.readFileSync(variablesColorsPath, 'utf8');
+
+      // Check if $colors map exists in the file
+      const colorsRegex = /\$colors:\s*\(([\s\S]*?)\)/;
+      const match = data.match(colorsRegex);
+      if (match) {
+        const colorsMap = match[1];
+
+        // Append the new brand to the colors map
+        const newColorsMap = `$colors: (${colorsMap},\n '${connectedBrandName}': ${
+          hexColor ? '$' + connectedBrandName : defaultColor
+        })`;
+
+        // Replace the $colors map in the file with the new one
+        data = data.replace(colorsRegex, newColorsMap);
+      } else {
+        return reject('Error: Could not find $colors map in the file');
+      }
+
+      const brandVar = `\$${connectedBrandName}: (
+        'lighten-5': lighten(${hexColor}, 25%),
+        'lighten-4': lighten(${hexColor}, 20%),
+        'lighten-3': lighten(${hexColor}, 15%),
+        'lighten-2': lighten(${hexColor}, 10%),
+        'lighten-1': lighten(${hexColor}, 5%),
+        'base': ${hexColor},
+        'darken-1': darken(${hexColor}, 5%),
+        'darken-2': darken(${hexColor}, 10%),
+        'darken-3': darken(${hexColor}, 15%),
+        'darken-4': darken(${hexColor}, 20%),
+      );\n`;
+
+      const newData = hexColor ? brandVar + data : data;
+      fs.writeFileSync(variablesColorsPath, newData, 'utf8');
+      console.log(chalk.cyan('\nvariables-colors.scss file updated successfully!'));
+      resolve(null);
+    } catch (error) {
+      reject(error);
+    }
+  });
+}
+
+module.exports = { start };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "antelope-cli",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "CLI-Tool for automating processes for Antelope-Systems ",
   "main": "index.js",
   "bin": {