errors.js

  1. /**
  2.  * Predefined errors that ui-predicate-core will yield from rejected promises
  3.  * @namespace errors
  4.  * @since 1.0.0
  5.  * @note errors are 100% tested from PredicateCore.test.js
  6.  */
  8. const { mergeAll } = require('ramda');
  9. const errorEx = require('error-ex');
  11. function err(name) {
  12.   return {
  13.     [name]: errorEx(name),
  14.   };
  15. }
  17. module.exports = mergeAll([
  18.   /**
  19.    * Error when a Predicate is created without
  20.    * @typedef {Error} InvalidPredicateType
  21.    * @memberof errors
  22.    * @since 1.0.0
  23.    */
  24.   err('InvalidPredicateType'),
  26.   /**
  27.    * Error when a json data passed to PredicateCore Constructor is neither a serialized ComparisonPredicate or a CompoundPredicate
  28.    * @typedef {Error} CompoundPredicate
  29.    * @memberof errors
  30.    * @since 1.0.0
  31.    */
  32.   err('UnknownJSONData'),
  34.   /**
  35.    * Error when someone tried to remove the last remaining predicate from a CompoundPredicate
  36.    * @typedef {Error} CompoundPredicateMustHaveAtLeastOneSubPredicate
  37.    * @memberof errors
  38.    * @since 1.0.0
  39.    */
  40.   err('CompoundPredicateMustHaveAtLeastOneSubPredicate'),
  42.   /**
  43.    * Error when setData `data` parameter is called with something else than a  {@link dataclasses.CompoundPredicate}
  44.    * @typedef {Error} RootPredicateMustBeACompoundPredicate
  45.    * @memberof errors
  46.    * @since 1.0.0
  47.    */
  48.   err('RootPredicateMustBeACompoundPredicate'),
  50.   /**
  51.    * Error when a function was requiring a {@link dataclasses.CompoundPredicate} as a parameter
  52.    * @typedef {Error} RootPredicateMustBeACompoundPredicate
  53.    * @memberof errors
  54.    * @since 1.0.0
  55.    */
  56.   err('PredicateMustBeACompoundPredicate'),
  58.   /**
  59.    * Error when a function was requiring a {@link dataclasses.ComparisonPredicate} as a parameter
  60.    * @typedef {Error} PredicateMustBeAComparisonPredicate
  61.    * @memberof errors
  62.    * @since 1.0.0
  63.    */
  64.   err('PredicateMustBeAComparisonPredicate'),
  66.   /**
  67.    * Error add is called with something else than "after" parameter
  68.    * @typedef {Error} AddCurrentlyOnlySupportAfterInsertion
  69.    * @memberof errors
  70.    * @since 1.0.0
  71.    */
  72.   err('AddCurrentlyOnlySupportAfterInsertion'),
  74.   /**
  75.    * Thrown when a specified target refers to a undefined type.
  76.    * It means the user has missed a type definition in `types`.
  77.    * @typedef {Error} TargetMustReferToADefinedType
  78.    * @memberof errors
  79.    * @since 1.0.0
  80.    */
  81.   err('TargetMustReferToADefinedType'),
  83.   /**
  84.    * Thrown when a user asked for a logic change
  85.    * but the logicalType_id was invalid because it referred to no existing targets
  86.    * @typedef {Error} LogicalType_idMustReferToADefinedLogicalType
  87.    * @memberof errors
  88.    * @since 1.0.0
  89.    */
  90.   err('LogicalType_idMustReferToADefinedLogicalType'),
  92.   /**
  93.    * Thrown when a user asked for a target
  94.    * but the target_id was invalid because it referred to no existing targets
  95.    * @typedef {Error} Target_idMustReferToADefinedTarget
  96.    * @memberof errors
  97.    * @since 1.0.0
  98.    */
  99.   err('Target_idMustReferToADefinedTarget'),
  101.   /**
  102.    * Thrown when a user asked for a operator
  103.    * but the operator_id was invalid because it referred to no existing operators
  104.    * @typedef {Error} Operator_idMustReferToADefinedOperator
  105.    * @memberof errors
  106.    * @since 1.0.0
  107.    */
  108.   err('Operator_idMustReferToADefinedOperator'),
  110.   /**
  111.    * Thrown when a user asked for a operator change on a predicate
  112.    * but the operator_id was invalid because it referred
  113.    * to no existing operators for the currently selected predicate's target
  114.    * @typedef {Error} Operator_idMustReferToADefinedOperator
  115.    * @memberof errors
  116.    * @since 1.0.0
  117.    */
  118.   err('Operator_idMustReferToADefinedOperator'),
  120.   /**
  121.    * Thrown when remove is called on root {@link dataclasses.CompoundPredicate}
  122.    * @typedef {Error} ForbiddenCannotRemoveRootCompoundPredicate
  123.    * @memberof errors
  124.    * @since 1.0.0
  125.    */
  126.   err('ForbiddenCannotRemoveRootCompoundPredicate'),
  128.   /**
  129.    * Thrown when remove is called on root CompoundPredicate
  130.    * @typedef {Error} ForbiddenCannotRemoveLastComparisonPredicate
  131.    * @memberof errors
  132.    * @since 1.0.0
  133.    */
  134.   err('ForbiddenCannotRemoveLastComparisonPredicate'),
  136.   /**
  137.    * Thrown when remove is called with an invalid type of predicate
  138.    * @typedef {Error} CannotRemoveSomethingElseThanACompoundPredicateOrAComparisonPredicate
  139.    * @memberof errors
  140.    * @since 1.0.0
  141.    */
  142.   err('CannotRemoveSomethingElseThanACompoundPredicateOrAComparisonPredicate'),
  144.   /**
  145.    * Thrown when add is called with an invalid type of predicate
  146.    * @typedef {Error} CannotAddSomethingElseThanACompoundPredicateOrAComparisonPredicate
  147.    * @memberof errors
  148.    * @since 1.0.0
  149.    */
  150.   err('CannotAddSomethingElseThanACompoundPredicateOrAComparisonPredicate'),
  152.   /**
  153.    * Thrown when the UI Framework adapter forgot to pass `getDefaultArgumentComponent` in the option object to UIPredicateCore constructor
  154.    * @typedef {Error} UIFrameworkMustImplementgetDefaultArgumentComponent
  155.    * @memberof errors
  156.    * @since 1.0.0
  157.    */
  158.   err('UIFrameworkMustImplementgetDefaultArgumentComponent'),
  159. ]);