antelope-cli 1.2.0 → 1.2.2

package/onboarding-ca/index.js

@@ -1,94 +1,94 @@
-const readline = require('readline');
-const chalk = require('chalk');
-const brandModule = require('./brand.js');
-const scss = require('./scss.js');
-const riskDisclaimer = require('./riskDisclaimer.js');
-
-const HELP = `
-Usage: ant-cli onboarding-ca --brand_assets_folder <folder>
-
-Creates the Client Area brand assets in the current web-client-area checkout:
-  src/assets/other/<folder>/<folder>.scss              (empty)
-  src/assets/other/<folder>/legal/risk-disclaimer.html
-
-Options:
-  --brand_assets_folder   Brand assets folder name, e.g. "zenithhorizongroup"
-                          (required in non-interactive mode). This is the value used for
-                          ENV_branding.brand_assets_folder. Normalized to lowercase, spaces removed.
-  -h, --help              Show this help
-
-Run from the root of a web-client-area checkout — files are written relative to the current directory.
-`;
-
-// Normalize to the folder convention used across the brand repos (connectedBrandName):
-// lowercase, no spaces. Harmless when a clean folder name is already supplied.
-const normalizeFolder = (value) => value.trim().toLowerCase().replace(/ /g, '');
-
-function parseArgs(argv) {
-  const opts = {};
-  for (let i = 0; i < argv.length; i++) {
-    const a = argv[i];
-    if (a === '--brand_assets_folder') opts.brandAssetsFolder = argv[++i];
-    else if (a === '--help' || a === '-h') opts.help = true;
-  }
-  return opts;
-}
-
-function promptFolder(rl) {
-  return new Promise((resolve) => {
-    rl.question('Enter the brand assets folder name (e.g. zenithhorizongroup):\n', (name) => resolve(name));
-  });
-}
-
-async function run() {
-  // process.argv: [node, index.js, "onboarding-ca", ...flags]
-  const opts = parseArgs(process.argv.slice(3));
-  if (opts.help) {
-    console.log(HELP);
-    return;
-  }
-
-  console.log(chalk.underline(chalk.cyan('Antelope Client-Area 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;
-
-  let rl;
-  let rawFolder = opts.brandAssetsFolder;
-  if (!rawFolder) {
-    if (!interactive) {
-      console.error(chalk.red('Error: --brand_assets_folder is required in non-interactive mode.'));
-      console.log(HELP);
-      process.exitCode = 1;
-      return;
-    }
-    rl = readline.createInterface({ input: process.stdin, output: process.stdout });
-    rawFolder = await promptFolder(rl);
-  }
-
-  const brandAssetsFolder = normalizeFolder(rawFolder || '');
-  if (!brandAssetsFolder) {
-    console.error(chalk.red('Error: brand assets folder must not be empty.'));
-    if (rl) rl.close();
-    process.exitCode = 1;
-    return;
-  }
-
-  brandModule.updateBrand({ brandAssetsFolder });
-
-  try {
-    console.log(chalk.bold(chalk.yellow(`\nOnboarding brand assets folder "${brandAssetsFolder}"`)));
-    console.log(chalk.bold(chalk.yellow('\nStep 1: Create brand stylesheet')));
-    await scss.start();
-    console.log(chalk.bold(chalk.yellow('\nStep 2: Create legal/risk-disclaimer.html')));
-    await riskDisclaimer.start();
-    console.log(chalk.green('\nClient-Area onboarding completed!'));
-  } catch (err) {
-    console.error(chalk.red(err) + '\n Please delete files added by this failed session.');
-    process.exitCode = 1;
-  } finally {
-    if (rl) rl.close();
-  }
-}
-
-run();
+const readline = require('readline');
+const chalk = require('chalk');
+const brandModule = require('./brand.js');
+const scss = require('./scss.js');
+const riskDisclaimer = require('./riskDisclaimer.js');
+
+const HELP = `
+Usage: ant-cli onboarding-ca --brand_assets_folder <folder>
+
+Creates the Client Area brand assets in the current web-client-area checkout:
+  src/assets/other/<folder>/<folder>.scss              (empty)
+  src/assets/other/<folder>/legal/risk-disclaimer.html
+
+Options:
+  --brand_assets_folder   Brand assets folder name, e.g. "zenithhorizongroup"
+                          (required in non-interactive mode). This is the value used for
+                          ENV_branding.brand_assets_folder. Normalized to lowercase, spaces removed.
+  -h, --help              Show this help
+
+Run from the root of a web-client-area checkout — files are written relative to the current directory.
+`;
+
+// Normalize to the folder convention used across the brand repos (connectedBrandName):
+// lowercase, no spaces. Harmless when a clean folder name is already supplied.
+const normalizeFolder = (value) => value.trim().toLowerCase().replace(/ /g, '');
+
+function parseArgs(argv) {
+  const opts = {};
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === '--brand_assets_folder') opts.brandAssetsFolder = argv[++i];
+    else if (a === '--help' || a === '-h') opts.help = true;
+  }
+  return opts;
+}
+
+function promptFolder(rl) {
+  return new Promise((resolve) => {
+    rl.question('Enter the brand assets folder name (e.g. zenithhorizongroup):\n', (name) => resolve(name));
+  });
+}
+
+async function run() {
+  // process.argv: [node, index.js, "onboarding-ca", ...flags]
+  const opts = parseArgs(process.argv.slice(3));
+  if (opts.help) {
+    console.log(HELP);
+    return;
+  }
+
+  console.log(chalk.underline(chalk.cyan('Antelope Client-Area 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;
+
+  let rl;
+  let rawFolder = opts.brandAssetsFolder;
+  if (!rawFolder) {
+    if (!interactive) {
+      console.error(chalk.red('Error: --brand_assets_folder is required in non-interactive mode.'));
+      console.log(HELP);
+      process.exitCode = 1;
+      return;
+    }
+    rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    rawFolder = await promptFolder(rl);
+  }
+
+  const brandAssetsFolder = normalizeFolder(rawFolder || '');
+  if (!brandAssetsFolder) {
+    console.error(chalk.red('Error: brand assets folder must not be empty.'));
+    if (rl) rl.close();
+    process.exitCode = 1;
+    return;
+  }
+
+  brandModule.updateBrand({ brandAssetsFolder });
+
+  try {
+    console.log(chalk.bold(chalk.yellow(`\nOnboarding brand assets folder "${brandAssetsFolder}"`)));
+    console.log(chalk.bold(chalk.yellow('\nStep 1: Create brand stylesheet')));
+    await scss.start();
+    console.log(chalk.bold(chalk.yellow('\nStep 2: Create legal/risk-disclaimer.html')));
+    await riskDisclaimer.start();
+    console.log(chalk.green('\nClient-Area onboarding completed!'));
+  } catch (err) {
+    console.error(chalk.red(err) + '\n Please delete files added by this failed session.');
+    process.exitCode = 1;
+  } finally {
+    if (rl) rl.close();
+  }
+}
+
+run();

package/onboarding-ca/riskDisclaimer.js

@@ -1,27 +1,27 @@
-const fs = require('fs');
-const path = require('path');
-const chalk = require('chalk');
-const brandModule = require('./brand.js');
-
-// The disclaimer is the same fixed markup for every brand. Read the bundled template
-// via __dirname (resolves inside the installed package, regardless of the cwd we write to).
-const templatePath = path.join(__dirname, 'templates', 'risk-disclaimer.html');
-
-function start() {
-  return new Promise((resolve, reject) => {
-    try {
-      const { brandAssetsFolder } = brandModule.getBrand();
-      const dir = path.join('src', 'assets', 'other', brandAssetsFolder, 'legal');
-      fs.mkdirSync(dir, { recursive: true });
-      const file = path.join(dir, 'risk-disclaimer.html');
-      const template = fs.readFileSync(templatePath, 'utf8');
-      fs.writeFileSync(file, template, 'utf8');
-      console.log(chalk.cyan(`Created ${file}`));
-      resolve(file);
-    } catch (error) {
-      reject(error);
-    }
-  });
-}
-
-module.exports = { start };
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const brandModule = require('./brand.js');
+
+// The disclaimer is the same fixed markup for every brand. Read the bundled template
+// via __dirname (resolves inside the installed package, regardless of the cwd we write to).
+const templatePath = path.join(__dirname, 'templates', 'risk-disclaimer.html');
+
+function start() {
+  return new Promise((resolve, reject) => {
+    try {
+      const { brandAssetsFolder } = brandModule.getBrand();
+      const dir = path.join('src', 'assets', 'other', brandAssetsFolder, 'legal');
+      fs.mkdirSync(dir, { recursive: true });
+      const file = path.join(dir, 'risk-disclaimer.html');
+      const template = fs.readFileSync(templatePath, 'utf8');
+      fs.writeFileSync(file, template, 'utf8');
+      console.log(chalk.cyan(`Created ${file}`));
+      resolve(file);
+    } catch (error) {
+      reject(error);
+    }
+  });
+}
+
+module.exports = { start };

package/onboarding-ca/scss.js

@@ -1,24 +1,24 @@
-const fs = require('fs');
-const path = require('path');
-const chalk = require('chalk');
-const brandModule = require('./brand.js');
-
-// Creates the brand stylesheet. It is intentionally EMPTY — matches every existing
-// brand in web-client-area (git blob e69de29b). brands.ts require()s it dynamically.
-function start() {
-  return new Promise((resolve, reject) => {
-    try {
-      const { brandAssetsFolder } = brandModule.getBrand();
-      const dir = path.join('src', 'assets', 'other', brandAssetsFolder);
-      fs.mkdirSync(dir, { recursive: true });
-      const file = path.join(dir, `${brandAssetsFolder}.scss`);
-      fs.writeFileSync(file, '', 'utf8');
-      console.log(chalk.cyan(`Created ${file}`));
-      resolve(file);
-    } catch (error) {
-      reject(error);
-    }
-  });
-}
-
-module.exports = { start };
+const fs = require('fs');
+const path = require('path');
+const chalk = require('chalk');
+const brandModule = require('./brand.js');
+
+// Creates the brand stylesheet. It is intentionally EMPTY — matches every existing
+// brand in web-client-area (git blob e69de29b). brands.ts require()s it dynamically.
+function start() {
+  return new Promise((resolve, reject) => {
+    try {
+      const { brandAssetsFolder } = brandModule.getBrand();
+      const dir = path.join('src', 'assets', 'other', brandAssetsFolder);
+      fs.mkdirSync(dir, { recursive: true });
+      const file = path.join(dir, `${brandAssetsFolder}.scss`);
+      fs.writeFileSync(file, '', 'utf8');
+      console.log(chalk.cyan(`Created ${file}`));
+      resolve(file);
+    } catch (error) {
+      reject(error);
+    }
+  });
+}
+
+module.exports = { start };

package/onboarding-ca/templates/risk-disclaimer.html

@@ -1,12 +1,12 @@
-<div class="page-wrapper push-up">
-  <a
-    class="disclaimer__top-image push-down"
-    href="{{ 'RISK.DISCLAIMER.SPONSOR.URL' | translate }}"
-    target="_blank"
-    layout="row"
-    layout-align="center center"
-    ><img alt=""
-  /></a>
-  <div class="disclaimer__title"><span translate="COMMON.RISK_DISCLAIMER"></span>:</div>
-  <p translate="DISCLAIMER" translate-value-risk="{{$ctrl.risk}}"></p>
-</div>
+<div class="page-wrapper push-up">
+  <a
+    class="disclaimer__top-image push-down"
+    href="{{ 'RISK.DISCLAIMER.SPONSOR.URL' | translate }}"
+    target="_blank"
+    layout="row"
+    layout-align="center center"
+    ><img alt=""
+  /></a>
+  <div class="disclaimer__title"><span translate="COMMON.RISK_DISCLAIMER"></span>:</div>
+  <p translate="DISCLAIMER" translate-value-risk="{{$ctrl.risk}}"></p>
+</div>

package/onboarding-crm/brand.js

@@ -0,0 +1,22 @@
+let brand = {
+  brandId: '',
+  brandName: '',
+  connectedBrandName: '',
+  color: '',
+  logo: '',
+  languages: null,
+  favicon: '',
+  FCMSenderId: '',
+  type: '',
+  baseUrl: ''
+};
+
+function updateBrand(updatedBrand) {
+  brand = { ...brand, ...updatedBrand };
+}
+
+function getBrand() {
+  return brand;
+}
+
+module.exports = { updateBrand, getBrand };

package/onboarding-crm/brandLocations.js

@@ -0,0 +1,33 @@
+const fs = require('fs');
+const chalk = require('chalk');
+const brandModule = require('./brand.js');
+
+const brandLocationsPath = 'BRAND_LOCATIONS.md';
+
+// Append a sprint-tracking row "<brand_name> → <brand_id>" to BRAND_LOCATIONS.md,
+// mirroring the migrate-brand-to-id skill (today's date, QA sign-off left blank).
+function start() {
+  return new Promise((resolve, reject) => {
+    try {
+      if (!fs.existsSync(brandLocationsPath)) {
+        console.log(chalk.yellow(`${brandLocationsPath} not found — skipping tracking row.`));
+        return resolve(null);
+      }
+      const { brandName, brandId } = brandModule.getBrand();
+      const date = new Date().toISOString().slice(0, 10);
+      const cell = `${brandName} → ${brandId}`;
+      const row = `| ${date} | ${cell.padEnd(27)} |             |`;
+
+      let data = fs.readFileSync(brandLocationsPath, 'utf8');
+      if (!data.endsWith('\n')) data += '\n';
+      data += row + '\n';
+      fs.writeFileSync(brandLocationsPath, data, 'utf8');
+      console.log(chalk.cyan(`BRAND_LOCATIONS.md updated: ${cell}`));
+      resolve(null);
+    } catch (error) {
+      reject(error);
+    }
+  });
+}
+
+module.exports = { start };

package/onboarding-crm/createConfig.js

@@ -0,0 +1,40 @@
+const fs = require('fs');
+const brandModule = require('./brand.js');
+const chalk = require('chalk');
+const configsFilePath = 'src/configs/configs.ts';
+
+// Writes configs.ts (devops copy-paste this into the env's Consul config).
+// Brand references use the Antelope ID (connectedBrandName = brand_id); baseUrl comes from the flag.
+function start() {
+  return new Promise((resolve, reject) => {
+    fs.mkdirSync('src/configs', { recursive: true });
+    fs.writeFile(configsFilePath, updateConfigFile(), 'utf8', (error) => {
+      if (error) {
+        reject(error);
+      } else {
+        console.log(chalk.cyan('configs.ts file updated successfully!'));
+        resolve(null);
+      }
+    });
+  });
+}
+
+const updateConfigFile = () => {
+  const brand = brandModule.getBrand();
+  return `export const configs: WebCrmConfig = {
+    baseUrl: '${brand.baseUrl}',
+    appId: 0,
+    type: '${brand.type}',
+    defaultLanguage: 'en',
+    gaTrackingID: 'UA-70456753-2',
+    colorTheme: 'theme-${brand.connectedBrandName}',
+    templateTheme: 'theme-template-${brand.connectedBrandName}',
+    title: '${brand.connectedBrandName}',
+    favicon: '${brand.favicon}',
+    affiliatesApiUrl: '',
+    FCMSenderId: '${brand.FCMSenderId}',
+    brandAssetsFolder: '${brand.connectedBrandName}',
+  };`;
+};
+
+module.exports = { start };

package/onboarding-crm/index.js

@@ -0,0 +1,171 @@
+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 brandLocations = require('./brandLocations.js');
+
+const ALLOWED_TYPES = ['CORP_FL', 'IB_FL', 'CORP_AFF_FL', 'CORP_AFF_IB_PORTAL', 'CORP_AFF_MSQ'];
+const DEFAULT_BASE_URL = 'https://dev-apicrm.antelopesystem.com/SignalsCRM/';
+
+const HELP = `
+Usage: ant-cli onboarding-crm --brand_id <id> --brand_name <name> [options]
+
+Onboards a CRM brand in the current web-crm checkout, keyed by the brand's Antelope ID.
+All inputs come from flags (interactive prompts are only a fallback in a TTY):
+  src/ng1/assets/css/sass/variables-colors.scss     (+ $<id> shades and $colors entry)
+  src/ng1/assets/css/sass/materialism/themes.scss   (+ theme maps and .theme-template-<id> block)
+  src/assets/brands/<id>/languages/<lang>.json      (one empty file per language)
+  src/configs/configs.ts                            (rewritten for the brand — copy into Consul)
+  BRAND_LOCATIONS.md                                (+ sprint tracking row "<name> -> <id>")
+
+Options:
+  --brand_id <id>       Antelope unique ID, e.g. "xxxxx" — the code identifier used everywhere (required)
+  --brand_name <name>   Human brand name — recorded in the BRAND_LOCATIONS.md tracking row (required)
+  --color <hex>         Brand hex color, e.g. "#1a2b3c". Empty => default palette ($corp)
+  --logo_url <url>      Logo image URL (black background) (required)
+  --languages <csv>     2-letter language codes, comma-separated, e.g. "en,ar" (required)
+  --favicon_url <url>   Favicon image URL → configs.ts favicon (required)
+  --fcm_sender_id <id>  Firebase FCMSenderId → configs.ts (required)
+  --type <type>         One of: ${ALLOWED_TYPES.join(', ')} → configs.ts (required)
+  --base_url <url>      configs.ts baseUrl. Default: ${DEFAULT_BASE_URL}
+  -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_id': 'brandId',
+  '--brand_name': 'brandName',
+  '--color': 'color',
+  '--logo_url': 'logo',
+  '--languages': 'languages',
+  '--favicon_url': 'favicon',
+  '--fcm_sender_id': 'fcmSenderId',
+  '--type': 'type',
+  '--base_url': 'baseUrl'
+};
+
+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;
+}
+
+// Antelope IDs are lowercase alphanumeric; normalize defensively (trim, lowercase, drop spaces).
+const normalizeId = (value) => value.trim().toLowerCase().replace(/ /g, '');
+
+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 brandIdRaw = await resolve(opts, 'brandId', "Enter the brand's Antelope ID (e.g. xxxxx):\n", interactive, rl);
+    const brandName = await resolve(opts, 'brandName', "What is the new brand's name?\n", interactive, rl);
+    const connectedBrandName = brandIdRaw ? normalizeId(brandIdRaw) : '';
+
+    // Color is optional (empty => default palette).
+    const color = opts.color !== undefined
+      ? opts.color
+      : (interactive ? await ask(rl, `Please set a color for "${connectedBrandName}", 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);
+
+    // baseUrl is optional (defaults to the dev URL).
+    const baseUrl = opts.baseUrl !== undefined && opts.baseUrl !== ''
+      ? opts.baseUrl
+      : (interactive ? (await ask(rl, `Enter the configs.ts baseUrl (leave empty for ${DEFAULT_BASE_URL}):\n`)) || DEFAULT_BASE_URL : DEFAULT_BASE_URL);
+
+    // Validate required fields.
+    const missing = [];
+    if (!connectedBrandName) missing.push('--brand_id');
+    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({
+      brandId: connectedBrandName,
+      brandName,
+      connectedBrandName,
+      color: color || '',
+      logo,
+      languages,
+      favicon,
+      FCMSenderId: fcmSenderId,
+      type,
+      baseUrl
+    });
+
+    console.log(chalk.bold(chalk.yellow(`\nOnboarding "${brandName}" (id: ${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.bold(chalk.yellow('\nStep 5: Recording in BRAND_LOCATIONS.md')));
+    await brandLocations.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();