Type Alias: GetBomDebugInfo()

GetBomDebugInfo = () => Promise<Nullable<{ bomItems: ProcessedBomItem[]; customFields: CustomFieldSimple[]; variables: BomVariable[]; }>>

Function

Retrieves Bill of Materials (BOM) information for the current configuration.

This method provides detailed BOM data for the configured product, including component parts, quantities, materials, and custom field values. This information is primarily used for manufacturing, inventory, and procurement purposes, but can also be valuable for detailed specification documentation.

The BOM reflects the specific configuration of the product, with components and quantities dynamically adjusted based on selected options.

Returns

Promise<Nullable<{ bomItems: ProcessedBomItem[]; customFields: CustomFieldSimple[]; variables: BomVariable[]; }>>

A promise resolving to the BOM data if available, or null if unavailable or not enabled

Example

// Get and display BOM information for the current configuration
window.mimeeqApp.actions.getBomDebugInfo().then(bomData => {
  if (bomData) {
    // Display the BOM in a table
    const bomTable = document.getElementById('bom-table');
    bomTable.innerHTML = '';

    bomData.bomItems.forEach(item => {
      const row = document.createElement('tr');
      row.innerHTML = `
        <td>${item.name || ''}</td>
        <td>${item.code || ''}</td>
        <td>${item.quantity}</td>
        <td>${item.unit}</td>
      `;
      bomTable.appendChild(row);

      // Add sub-items if present
      if (item.subItems && item.subItems.length) {
        renderSubItems(bomTable, item.subItems, 1);
      }
    });
  }
});