cloudonix-js/src/verbs/dialNouns/header.js

A JavaScript library for building and serving Cloudonix Voice Application XML (CXML) documents with support for AI voice agents, media streaming, and advanced telephony features

/**
 * @file Header noun implementation for Dial verb
 * @copyright 2025 Nir Simionovich, nirs@cloudonix.io
 * @license MIT
 * @module cloudonix-js/verbs/dialNouns/header
 * @description Implements the Header noun for adding custom headers to outbound calls
 */

'use strict';

module.exports = {
  /**
   * Add a Header noun to the Dial element
   * @param {Object} dialElement - The Dial element to add the Header to
   * @param {string} name - The header name
   * @param {string} value - The header value
   * @returns {void}
   */
  add: (dialElement, name, value) => {
    if (!dialElement.Header) {
      dialElement.Header = [];
    }
    
    if (!Array.isArray(dialElement.Header)) {
      dialElement.Header = [dialElement.Header];
    }
    
    const headerElement = {
      '@_name': name,
      '@_value': value
    };
    
    dialElement.Header.push(headerElement);
  },
  
  /**
   * Create a Header element
   * @param {string} name - The header name
   * @param {string} value - The header value
   * @returns {Object} - The Header element
   */
  create: (name, value) => {
    return {
      '@_name': name,
      '@_value': value
    };
  }
};