thingsboard/ui-ngx/src/app/modules/home/components/rule-node/enrichment/related-attributes-config.component.ts

///
/// Copyright © 2016-2025 The Thingsboard Authors
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///

import { Component } from '@angular/core';
import { deepTrim, isDefinedAndNotNull } from '@core/public-api';
import { FormBuilder, FormGroup, Validators } from '@angular/forms';
import { TranslateService } from '@ngx-translate/core';
import { RuleNodeConfiguration, RuleNodeConfigurationComponent } from '@app/shared/models/rule-node.models';
import {
  allowedOriginatorFields,
  DataToFetch,
  dataToFetchTranslations,
  FetchTo,
  msgMetadataLabelTranslations,
  SvMapOption
} from '../rule-node-config.models';
import { entityFields } from '@shared/models/entity.models';

@Component({
  selector: 'tb-enrichment-node-related-attributes-config',
  templateUrl: './related-attributes-config.component.html',
  styleUrls: []
})
export class RelatedAttributesConfigComponent extends RuleNodeConfigurationComponent {

  relatedAttributesConfigForm: FormGroup;

  protected readonly DataToFetch = DataToFetch;

  public msgMetadataLabelTranslations = msgMetadataLabelTranslations;
  public originatorFields: SvMapOption[] = [];
  public fetchToData = [];

  constructor(private fb: FormBuilder,
              private translate: TranslateService) {
    super();
    for (const field of Object.keys(allowedOriginatorFields)) {
      this.originatorFields.push({
        value: allowedOriginatorFields[field].value,
        name: this.translate.instant(allowedOriginatorFields[field].name)
      });
    }
    for (const key of dataToFetchTranslations.keys()) {
      this.fetchToData.push({
        value: key,
        name: this.translate.instant(dataToFetchTranslations.get(key as DataToFetch))
      });
    }
  }

  protected configForm(): FormGroup {
    return this.relatedAttributesConfigForm;
  }

  protected prepareOutputConfig(configuration: RuleNodeConfiguration): RuleNodeConfiguration {
    if (configuration.dataToFetch === DataToFetch.FIELDS) {
      configuration.dataMapping = configuration.svMap;
      delete configuration.svMap;
    } else {
      configuration.dataMapping = configuration.kvMap;
      delete configuration.kvMap;
    }

    const filteDataMapping = {};
    if (configuration && configuration.dataMapping) {
      for (const key of Object.keys(configuration.dataMapping)) {
        filteDataMapping[key.trim()] = configuration.dataMapping[key];
      }
    }
    configuration.dataMapping = filteDataMapping;
    delete configuration.svMap;
    delete configuration.kvMap;

    return deepTrim(configuration);
  }

  protected prepareInputConfig(configuration: RuleNodeConfiguration): RuleNodeConfiguration {
    let svMap = {
      [entityFields.name.value]: `relatedEntity${this.translate.instant(entityFields.name.name)}`
    };
    let kvMap = {
      serialNumber: 'sn'
    };

    let dataToFetch: DataToFetch;
    if (isDefinedAndNotNull(configuration?.telemetry)) {
      dataToFetch = configuration.telemetry ? DataToFetch.LATEST_TELEMETRY : DataToFetch.ATTRIBUTES;
    } else {
      dataToFetch = isDefinedAndNotNull(configuration?.dataToFetch) ? configuration.dataToFetch : DataToFetch.ATTRIBUTES;
    }

    let dataMapping;
    if (isDefinedAndNotNull(configuration?.attrMapping)) {
      dataMapping = configuration.attrMapping;
    } else {
      dataMapping = isDefinedAndNotNull(configuration?.dataMapping) ? configuration.dataMapping : null;
    }

    if (dataToFetch === DataToFetch.FIELDS) {
      svMap = dataMapping;
    } else {
      kvMap = dataMapping;
    }

    return {
      relationsQuery: isDefinedAndNotNull(configuration?.relationsQuery) ? configuration.relationsQuery : null,
      dataToFetch,
      svMap,
      kvMap,
      fetchTo: isDefinedAndNotNull(configuration?.fetchTo) ? configuration.fetchTo : FetchTo.METADATA
    };
  }

  public selectTranslation(latestTelemetryTranslation: string, attributesTranslation: string) {
    if (this.relatedAttributesConfigForm.get('dataToFetch').value === DataToFetch.LATEST_TELEMETRY) {
      return latestTelemetryTranslation;
    } else {
      return attributesTranslation;
    }
  }

  protected onConfigurationSet(configuration: RuleNodeConfiguration) {
    this.relatedAttributesConfigForm = this.fb.group({
      relationsQuery: [configuration.relationsQuery, [Validators.required]],
      dataToFetch: [configuration.dataToFetch, []],
      kvMap: [configuration.kvMap, [Validators.required]],
      svMap: [configuration.svMap, [Validators.required]],
      fetchTo: [configuration.fetchTo, []]
    });
  }

  protected validatorTriggers(): string[] {
    return ['dataToFetch'];
  }

  protected updateValidators(emitEvent: boolean) {
    if (this.relatedAttributesConfigForm.get('dataToFetch').value === DataToFetch.FIELDS) {
      this.relatedAttributesConfigForm.get('svMap').enable({emitEvent: false});
      this.relatedAttributesConfigForm.get('kvMap').disable({emitEvent: false});
      this.relatedAttributesConfigForm.get('svMap').updateValueAndValidity();
    } else {
      this.relatedAttributesConfigForm.get('svMap').disable({emitEvent: false});
      this.relatedAttributesConfigForm.get('kvMap').enable({emitEvent: false});
      this.relatedAttributesConfigForm.get('kvMap').updateValueAndValidity();
    }
  }
}