@kelsus/show-group-config-utilities

show-group-config-utilities

Circle

Functions

getFeatureEffects

Description:

This function takes in a feature ID, an array of all available feature configurations, a context object for evaluating the rules, and optional effect type and rule trigger conditions. It then retrieves the feature configuration based on the provided feature ID, evaluates the rules based on the trigger conditions and effect type (if provided), and returns an object with the triggered effects for the specified feature ID. If the specified feature ID is not found in the features array, an error will be thrown with the message "Feature {featureId} not found".

Parameters:

• featureId (String): The ID of the feature for which to get triggered effects.
• features (Array): An array of all available feature configurations.
• context (Object): An object containing the context for evaluating the rules.
• effectType (String): The type of effect to filter for.
• rulesTriggersConditions (Array): An array of rule trigger conditions.

Returns:

• effect (Object): An object with the triggered effects for the specified feature ID.

Errors

Throws an error if the provided featureId is not found in the features array.

getFeatureValues

Description

This module provides a utility function getFeatureValues for retrieving the values, label, and default value of a feature in a Node.js application.

Parameters:

• featureId (String): The ID of the feature for which to retrieve values.
• features (Array): An array of all available feature configurations.

Returns: An object with the following properties:

• label (String): The label of the feature.
• values (Array): An array of values associated with the feature.
• default (Any): The default value of the feature.

Errors

Throws an error if the provided featureId is not found in the features array.

**Example

const { getFeatureValues } = require('./getFeatureValues');

const features = [
  {
    id: 'color',
    label: 'Color',
    values: ['red', 'green', 'blue'],
    default: 'red',
  },
];

const featureValues = getFeatureValues({ featureId: 'color', features });

console.log(featureValues);
// Output:
// {
//   label: 'Color',
//   values: ['red', 'green', 'blue'],
//   default: 'red',
// }

validateFeatureTriggersConsistency

Description

This function validates the consistency of rule triggers in a group of feature configurations. Parameters

• groupConfig: An object containing the feature group configuration. It should have the properties features and rulesTriggersConditions.

Returns

This function does not return any value.

Errors

If any trigger condition is not found, the function will throw an Error with the message: Trigger condition {triggersConditionsId} not found.

Example

const groupConfig = {
  features: [
    // ...feature objects with rules property
  ],
  rulesTriggersConditions: [
    // ...rule trigger condition objects with id property
  ],
};

try {
  validateFeatureTriggersConsistency(groupConfig);
  console.log('Feature triggers consistency is valid');
} catch (error) {
  console.error('Error:', error.message);
}

validateEffectValue

Description

This function validates the value of an effect based on its type.

Parameters

• effect: An object containing the effect information. It should have the properties id, type, and value.
• value: The value that will be checked based on the effect type.

Returns

This function does not return any value.

Errors

If the value is not valid, the function will throw an Error with the message: Invalid value for effect {id}, expected {type} {effectValue} ({typeof effectValue}) but got {value} ({typeof value}).

Example

const effect = {
  id: 'exampleEffect',
  type: 'equals',
  value: 10,
};

const valueToCheck = 10;

try {
  validateEffectValue({ effect, value: valueToCheck });
  console.log('Effect value is valid');
} catch (error) {
  console.error('Error:', error.message);
}