fix: support normalized json array for attribute input

[louis-bompart]

Usually, we use <my-cmp attr-name="['val1', 'val2']" for attributes. This one differs from the norm, let's fix that :)

KIT-5305

[Copilot]

Pull request overview

This PR adds support for normalized JSON array input to the fieldsToIncludeInCitations property in the atomic-generated-answer component. The change allows the property to accept either a string array (new standard) or a comma-separated string (deprecated), maintaining backward compatibility while preparing for v4 where only array input will be supported.

Key changes:

• Property type updated from string to string | string[]
• New getCitationFieldsInputArray() helper method to handle both input formats with deprecation warning
• Refactored getCitationFields() to delegate to the new helper

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Missing semicolon after .split(','). This will cause a syntax error.

Suggested change

	.split(',')
	.split(',');

[Copilot]

This method should have an explicit return type annotation for type safety. Add : string[] as the return type.

Suggested change

	private getCitationFieldsInputArray() {
	private getCitationFieldsInputArray(): string[] {

[Copilot]

The deprecation warning should only be logged when a string value is actually provided. Currently, it will log even when the property is undefined. Consider adding a check:

} else if (this.fieldsToIncludeInCitations) {
  this.bindings.engine.logger.warn(
    // ... warning message
  );
  return (this.fieldsToIncludeInCitations ?? '').split(',');
} else {
  return [];
}

This prevents unnecessary warnings when the property is not set at all.

Suggested change

	if( Array.isArray(this.fieldsToIncludeInCitations)) {
	return this.fieldsToIncludeInCitations;
	} else {
	this.bindings.engine.logger.warn(
	`Starting from Atomic v4, the "fields-to-include-in-citations" property will only accept an array of strings. Using a string value is now deprecated. Please update the value to be an array of strings. For example: fields-to-include-in-citations='["fieldA","fieldB"]'`
	);
	return (this.fieldsToIncludeInCitations ?? '')
	.split(',')
	if (Array.isArray(this.fieldsToIncludeInCitations)) {
	return this.fieldsToIncludeInCitations;
	} else if (typeof this.fieldsToIncludeInCitations === 'string') {
	this.bindings.engine.logger.warn(
	`Starting from Atomic v4, the "fields-to-include-in-citations" property will only accept an array of strings. Using a string value is now deprecated. Please update the value to be an array of strings. For example: fields-to-include-in-citations='["fieldA","fieldB"]'`
	);
	return this.fieldsToIncludeInCitations.split(',');
	} else {
	return [];

[Copilot]

Extra space after if keyword. Should be if( not if(.

Suggested change

	if( Array.isArray(this.fieldsToIncludeInCitations)) {
	if (Array.isArray(this.fieldsToIncludeInCitations)) {

[louis-bompart]

@copilot open a new pull request to apply changes based on the comments in this thread
Ignore the resolved conversation tho

[Copilot]

@louis-bompart I've opened a new pull request, #6739, to work on those changes. Once the pull request is ready, I'll request review from you.

[fbeaudoincoveo]

Normally I'd say we need to adjust the unit tests accordingly, but given that the component hasn't yet been migrated I guess this will have to wait 😁

[lavoiesl]

Nice use of the a TODO ticket and deprecation warning 👍🏼

[lavoiesl]

Unrelated to this PR: Should we have a dedicated primitive for raising deprecations?

Here's what Rails does: https://blog.saeloun.com/2024/11/19/rails-7-1-adds-application-deprecators-method/

# 1) Define a Custom Deprecator:
# config/initializers/deprecators.rb

Rails.application.deprecators[:user_full_name] = ActiveSupport::Deprecation.new("2.0", "user_full_name")

# Here, the custom deprecator :user_full_name is defined for deprecations related to the full_name method, specifying the Rails version (2.0) and a name for context.

# 2) Use the Deprecator in Code:

class User < ApplicationRecord
  def full_name
    Rails.application.deprecators[:user_full_name].warn("The `full_name` method will be removed in the next major release.")
  end
end

Benefits:

• Encourages defining a target version
• Standardizes how it's reported
• Allows telemetry to track adoption
• Allows silencing those warnings in production use
• Allows deduplication of warnings to avoid spamming in the case of a repeated item