antelope-cli 1.2.4 → 1.2.5

package/ansible/onboarding-ca/roles/onboard_ca/defaults/main.yml

@@ -1,6 +1,6 @@
 ---
 # Pinned published antelope-cli version that provides the `onboarding-ca` command.
-antelope_cli_version: "1.2.3"
+antelope_cli_version: "1.2.4"
 
 # Where web-client-area is cloned on the control node.
 work_dir: "/tmp/onboard-ca/web-client-area"

package/ansible/onboarding-crm/onboard-crm.yml

@@ -49,9 +49,6 @@
     - name: languages
       prompt: "Languages — 2-letter codes, comma-separated (e.g. en,ar)"
       private: false
-    - name: fcm_sender_id
-      prompt: "Firebase FCMSenderId"
-      private: false
     - name: jira_key_crm_branding
       prompt: "Jira key (e.g. ATLP-47067)"
       private: false

package/ansible/onboarding-crm/roles/onboard_crm/defaults/main.yml

@@ -1,29 +1,28 @@
 ---
 # Pinned published antelope-cli version that provides the `onboarding-crm` command.
-antelope_cli_version: "1.2.3"
+antelope_cli_version: "1.2.4"
 
 # Where web-crm is cloned on the control node.
 work_dir: "/tmp/onboard-crm/web-crm"
 
 # --- CRM brand inputs (map to the `onboarding-crm` CLI flags) ------------------------
-# antelope_id  => --brand_id  (Antelope unique ID / connectedBrandName; keys every file the CLI writes)
-# brand_name, languages, fcm_sender_id, crm_type are REQUIRED; logo_url/favicon_url/base_url derive.
-# color is optional (blank => the CLI's $corp palette).
-#
-# favicon_url and base_url default to the SAME derivations as the deployment config
-# (xsites-devops ansible-deployment-new/roles/consul/templates/crm.json.j2), so the values
-# match what gets seeded into Consul. They resolve from the brand vars (antelope_id,
-# brand_name, crm_server_url) in the create_brand context; the standalone playbook's prompts
-# override them. crm_type is a per-brand value (not defaulted anywhere — set it in brand_vars
-# or -e). logo_url has no derivation in that template — must be provided explicitly.
+# antelope_id => --brand_id (connectedBrandName; keys theme/folder/devBrandName/favicon in configs.ts).
+# REQUIRED: antelope_id, brand_name, crm_type, logo_url, languages. base_url + affiliates_api_url
+# derive from the brand vars in create_brand; pass -e for a standalone run. configs.ts favicon is
+# DERIVED by the CLI (logos-<id>/favicon-<name>.png) and FCMSenderId is always '' (both placeholders).
 antelope_id: ""
-color: ""                                   # --color   hex, e.g. "#1a2b3c"; blank => default palette
-logo_url: "https://logos-{{ antelope_id }}.s3.eu-west-1.amazonaws.com/logo-{{ brand_name }}.png"   # derived like favicon_url; override with -e
+color: ""                                   # --color hex; blank => default palette
+logo_url: "https://logos-{{ antelope_id }}.s3.eu-west-1.amazonaws.com/logo-{{ brand_name }}.png"   # brand-logos.json entry; override with -e
 languages: ""                               # --languages: CSV "en,ar" or a YAML list [en, ar]
-fcm_sender_id: ""                           # --fcm_sender_id (Firebase) — blank in crm.json.j2 but the CLI requires it
-crm_type: ""                                # --type: one of allowed_crm_types below (per-brand; set in brand_vars)
-favicon_url: "https://logos-{{ antelope_id }}.s3.eu-west-1.amazonaws.com/favicon-{{ brand_name }}.png"
+crm_type: ""                                # --type: one of allowed_crm_types (per-brand; from group_vars derivation)
+# baseUrl uses the BE/CRM domain; affiliatesApiUrl uses the FE/CA domain (fe_server_url_list.0).
 base_url: "{{ ('https://' ~ crm_server_url ~ '/SignalsCRM/') if (crm_server_url | default('') | length > 0) else '' }}"
+affiliates_api_url: "{{ fe_server_url_list.0 | default('') }}"
+arctic_brand: false                          # --arctic_brand => configs.ts isArcticBrand
+# Consul KV key the generated configs.ts is PUT to (the env CRM config). Needs a consul_token
+# with write on this path. brand_name = the Consul namespace segment (e.g. Antelope/excelttra/crm_env).
+crm_env_consul_key: "Antelope/{{ brand_name }}/crm_env"
+manage_consul_crm_env: true
 # Kept in sync with ALLOWED_TYPES in antelope-cli/onboarding-crm/index.js.
 allowed_crm_types:
   - CORP_FL

package/ansible/onboarding-crm/roles/onboard_crm/tasks/main.yml

@@ -75,16 +75,13 @@
       - brand_name is defined and (brand_name | length) > 0
       - jira_key_crm_branding is defined and (jira_key_crm_branding | length) > 0
       - logo_url is defined and (logo_url | length) > 0
-      - favicon_url is defined and (favicon_url | length) > 0
       - languages is defined and (languages | length) > 0
-      - fcm_sender_id is defined and (fcm_sender_id | length) > 0
       - crm_type is defined and (crm_type | length) > 0
       - crm_type in allowed_crm_types
       - bitbucket_token is defined and (bitbucket_token | length) > 0
       - bitbucket_email is defined and (bitbucket_email | length) > 0
     fail_msg: >-
-      Required: antelope_id, brand_name, jira_key_crm_branding, logo_url, favicon_url, languages,
-      fcm_sender_id, crm_type (one of {{ allowed_crm_types | join(', ') }}), bitbucket_email.
+      Required: antelope_id, brand_name, jira_key_crm_branding, logo_url, languages, crm_type (one of {{ allowed_crm_types | join(', ') }}), bitbucket_email.
       bitbucket_token must be provided (via --extra-vars / prompt) or resolvable from 1Password
       item '{{ onepassword_bitbucket_item }}' field '{{ onepassword_bitbucket_field }}' (op signin).
 
@@ -322,3 +319,39 @@
 - name: Summary of pull requests
   ansible.builtin.debug:
     msg: "{{ pr_results | default([]) }}"
+
+# --- Consul: publish the generated configs.ts to the brand's crm_env KV --------------
+# configs.ts is gitignored (not committed) — it is the env's CRM config, so push it to Consul
+# (Antelope/<brand>/crm_env) in addition to the PR body. Non-fatal: warns if the token lacks write.
+- name: Read generated configs.ts for Consul crm_env
+  when: manage_consul_crm_env | default(true) | bool
+  ansible.builtin.slurp:
+    src: "{{ work_dir }}/src/configs/configs.ts"
+  register: crm_configs_ts_final
+  failed_when: false
+
+- name: Update Consul crm_env with the generated configs.ts
+  when:
+    - manage_consul_crm_env | default(true) | bool
+    - crm_configs_ts_final is not skipped
+    - (crm_configs_ts_final.content | default('') | length) > 0
+    - (consul_token | default('') | length) > 0
+  ansible.builtin.uri:
+    url: "{{ consul_url }}/v1/kv/{{ crm_env_consul_key }}"
+    method: PUT
+    headers:
+      X-Consul-Token: "{{ consul_token }}"
+    body: "{{ crm_configs_ts_final.content | b64decode }}"
+    status_code: [200]
+  register: consul_crm_env_put
+  failed_when: false
+  no_log: false
+
+- name: Confirm the Consul crm_env update
+  when: manage_consul_crm_env | default(true) | bool and (consul_crm_env_put is defined)
+  ansible.builtin.debug:
+    msg: >-
+      {{ 'Updated Consul ' ~ crm_env_consul_key
+         if (consul_crm_env_put.status | default(0)) == 200
+         else 'Consul crm_env NOT updated (HTTP ' ~ (consul_crm_env_put.status | default('n/a'))
+              ~ ') - token may lack write on ' ~ crm_env_consul_key }}

package/ansible/onboarding-crm/roles/onboard_crm/tasks/per_branch.yml

@@ -48,10 +48,10 @@
           '--brand_id', antelope_id_norm,
           '--brand_name', brand_name,
           '--logo_url', logo_url,
-          '--favicon_url', favicon_url,
           '--languages', languages_csv,
-          '--fcm_sender_id', (fcm_sender_id | string),
-          '--type', crm_type]
+          '--type', crm_type,
+          '--affiliates_api_url', affiliates_api_url,
+          '--arctic_brand', (arctic_brand | default(false) | string | lower)]
          + (['--color', color] if (color | default('') | length) > 0 else [])
          + (['--base_url', base_url] if (base_url | default('') | length) > 0 else []) }}
     chdir: "{{ work_dir }}"
@@ -59,6 +59,23 @@
     CI: "true"
   changed_when: true
 
+- name: "[{{ dest_branch }}] Read generated configs.ts (gitignored) for the PR body / Consul"
+  ansible.builtin.slurp:
+    src: "{{ work_dir }}/src/configs/configs.ts"
+  register: crm_configs_ts
+  failed_when: false
+
+- name: "[{{ dest_branch }}] Compose PR description (ticket + configs.ts for Consul copy-paste)"
+  ansible.builtin.set_fact:
+    pr_description: |-
+      {{ jira_key_crm_branding }}: On-Boarding {{ brand_name }} CRM Branding
+
+      configs.ts — copy into Consul `{{ crm_env_consul_key }}`:
+
+      ```ts
+      {{ crm_configs_ts.content | default('') | b64decode }}
+      ```
+
 - name: "[{{ dest_branch }}] Stage changes"
   ansible.builtin.command:
     cmd: git add -A
@@ -97,7 +114,7 @@
     body_format: json
     body:
       title: "{{ jira_key_crm_branding }}: On-Boarding {{ brand_name }} CRM Branding"
-      description: "{{ jira_key_crm_branding }}: On-Boarding {{ brand_name }} CRM Branding"
+      description: "{{ pr_description }}"
       source:
         branch:
           name: "{{ source_branch }}"

package/onboarding-crm/brand.js

@@ -5,8 +5,8 @@ let brand = {
   color: '',
   logo: '',
   languages: null,
-  favicon: '',
-  FCMSenderId: '',
+  affiliatesApiUrl: '',
+  isArcticBrand: false,
   type: '',
   baseUrl: ''
 };

package/onboarding-crm/createConfig.js

@@ -21,20 +21,27 @@ function start() {
 
 const updateConfigFile = () => {
   const brand = brandModule.getBrand();
+  const id = brand.connectedBrandName;
   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.brandName}',
-    favicon: '${brand.favicon}',
-    logo: '${brand.logo}',
-    FCMSenderId: '${brand.FCMSenderId}',
-    brandAssetsFolder: '${brand.connectedBrandName}'
-  };`;
+  baseUrl: '${brand.baseUrl}',
+  affiliatesApiUrl: '${brand.affiliatesApiUrl}',
+  appId: 0,
+  type: '${brand.type}',
+  title: '${brand.brandName} CRM',
+  colorTheme: 'theme-${id}',
+  templateTheme: 'theme-template-${id}',
+  brandAssetsFolder: '${id}',
+  devBrandName: '${id}',
+  favicon: 'https://logos-${id}.s3.eu-west-1.amazonaws.com/favicon-${brand.brandName}.png',
+  gaTrackingID: 'UA-70456753-2',
+  FCMSenderId: '',
+  isFnsStatusActive: true,
+  showTradingInfo: true,
+  CrmAvailableCurrencies: ['USD'],
+  showNewClientCard: true,
+  newAppSubdomain: 'ant-crm',
+  isArcticBrand: ${brand.isArcticBrand ? 'true' : 'false'}
+};`;
 };
 
 module.exports = { start };

package/onboarding-crm/index.js

@@ -29,10 +29,14 @@ Options:
   --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)
+  --affiliates_api_url  configs.ts affiliatesApiUrl — the FE host, e.g. "apife.<ca-domain>"
+                        (apife.excelttra.com). Not derivable from base_url (that's the BE domain).
+  --arctic_brand <t|f>  configs.ts isArcticBrand. Default: false
   --type <type>         One of: ${ALLOWED_TYPES.join(', ')} → configs.ts (required)
   --base_url <url>      configs.ts baseUrl. Default: ${DEFAULT_BASE_URL}
+
+Note: configs.ts favicon is DERIVED (logos-<id>/favicon-<name>.png) and FCMSenderId is always '';
+both are placeholders that get hand-edited per brand. configs.ts is gitignored (Consul copy-paste).
   -h, --help            Show this help
 
 Run from the root of a web-crm checkout — files are written relative to the current directory.
@@ -44,8 +48,8 @@ const FLAGS = {
   '--color': 'color',
   '--logo_url': 'logo',
   '--languages': 'languages',
-  '--favicon_url': 'favicon',
-  '--fcm_sender_id': 'fcmSenderId',
+  '--affiliates_api_url': 'affiliatesApiUrl',
+  '--arctic_brand': 'arcticBrand',
   '--type': 'type',
   '--base_url': 'baseUrl'
 };
@@ -97,9 +101,7 @@ async function run() {
       : (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).
@@ -107,14 +109,18 @@ async function run() {
       ? opts.baseUrl
       : (interactive ? (await ask(rl, `Enter the configs.ts baseUrl (leave empty for ${DEFAULT_BASE_URL}):\n`)) || DEFAULT_BASE_URL : DEFAULT_BASE_URL);
 
+    // affiliatesApiUrl (FE host, e.g. apife.<ca-domain>) → configs.ts. Explicit input; NOT
+    // derivable from baseUrl (baseUrl is the BE/CRM domain). configs.ts favicon is derived
+    // from the id + brand_name; FCMSenderId is always ''. isArcticBrand defaults false.
+    const affiliatesApiUrl = opts.affiliatesApiUrl || '';
+    const isArcticBrand = String(opts.arcticBrand).toLowerCase() === 'true';
+
     // 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(', ')}`));
@@ -144,8 +150,8 @@ async function run() {
       color: color || '',
       logo,
       languages,
-      favicon,
-      FCMSenderId: fcmSenderId,
+      affiliatesApiUrl,
+      isArcticBrand,
       type,
       baseUrl
     });

package/package.json

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