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 someone tried to remove the last remaining predicate from a CompoundPredicate
  28.    * @typedef {Error} CompoundPredicateMustHaveAtLeastOneSubPredicate
  29.    * @memberof errors
  30.    * @since 1.0.0
  31.    */
  32.   err('CompoundPredicateMustHaveAtLeastOneSubPredicate'),
  34.   /**
  35.    * Error when setData `data` parameter is called with something else than a  {@link dataclasses.CompoundPredicate}
  36.    * @typedef {Error} RootPredicateMustBeACompoundPredicate
  37.    * @memberof errors
  38.    * @since 1.0.0
  39.    */
  40.   err('RootPredicateMustBeACompoundPredicate'),
  42.   /**
  43.    * Error when a function was requiring a {@link dataclasses.CompoundPredicate} as a parameter
  44.    * @typedef {Error} RootPredicateMustBeACompoundPredicate
  45.    * @memberof errors
  46.    * @since 1.0.0
  47.    */
  48.   err('PredicateMustBeACompoundPredicate'),
  50.   /**
  51.    * Error when a function was requiring a {@link dataclasses.ComparisonPredicate} as a parameter
  52.    * @typedef {Error} PredicateMustBeAComparisonPredicate
  53.    * @memberof errors
  54.    * @since 1.0.0
  55.    */
  56.   err('PredicateMustBeAComparisonPredicate'),
  58.   /**
  59.    * Error add is called with something else than "after" parameter
  60.    * @typedef {Error} AddCurrentlyOnlySupportAfterInsertion
  61.    * @memberof errors
  62.    * @since 1.0.0
  63.    */
  64.   err('AddCurrentlyOnlySupportAfterInsertion'),
  66.   /**
  67.    * Thrown when a specified target refers to a undefined type.
  68.    * It means the user has missed a type definition in `types`.
  69.    * @typedef {Error} TargetMustReferToADefinedType
  70.    * @memberof errors
  71.    * @since 1.0.0
  72.    */
  73.   err('TargetMustReferToADefinedType'),
  75.   /**
  76.    * Thrown when a user asked for a logic change on a {@link dataclasses.CompoundPredicate}
  77.    * but the logicalType_id was invalid because it referred to no existing targets
  78.    * @typedef {Error} LogicalType_idMustReferToADefinedLogicalType
  79.    * @memberof errors
  80.    * @since 1.0.0
  81.    */
  82.   err('LogicalType_idMustReferToADefinedLogicalType'),
  84.   /**
  85.    * Thrown when a user asked for a target change on a predicate
  86.    * but the target_id was invalid because it referred to no existing targets
  87.    * @typedef {Error} Target_idMustReferToADefinedTarget
  88.    * @memberof errors
  89.    * @since 1.0.0
  90.    */
  91.   err('Target_idMustReferToADefinedTarget'),
  93.   /**
  94.    * Thrown when a user asked for a operator change on a predicate
  95.    * but the operator_id was invalid because it referred
  96.    * to no existing operators for the currently selected predicate's target
  97.    * @typedef {Error} Operator_idMustReferToADefinedOperator
  98.    * @memberof errors
  99.    * @since 1.0.0
  100.    */
  101.   err('Operator_idMustReferToADefinedOperator'),
  103.   /**
  104.    * Thrown when remove is called on root {@link dataclasses.CompoundPredicate}
  105.    * @typedef {Error} ForbiddenCannotRemoveRootCompoundPredicate
  106.    * @memberof errors
  107.    * @since 1.0.0
  108.    */
  109.   err('ForbiddenCannotRemoveRootCompoundPredicate'),
  111.   /**
  112.    * Thrown when remove is called on root CompoundPredicate
  113.    * @typedef {Error} ForbiddenCannotRemoveLastComparisonPredicate
  114.    * @memberof errors
  115.    * @since 1.0.0
  116.    */
  117.   err('ForbiddenCannotRemoveLastComparisonPredicate'),
  119.   /**
  120.    * Thrown when remove is called with an invalid type of predicate
  121.    * @typedef {Error} CannotRemoveSomethingElseThanACompoundPredicateOrAComparisonPredicate
  122.    * @memberof errors
  123.    * @since 1.0.0
  124.    */
  125.   err('CannotRemoveSomethingElseThanACompoundPredicateOrAComparisonPredicate'),
  127.   /**
  128.    * Thrown when add is called with an invalid type of predicate
  129.    * @typedef {Error} CannotAddSomethingElseThanACompoundPredicateOrAComparisonPredicate
  130.    * @memberof errors
  131.    * @since 1.0.0
  132.    */
  133.   err('CannotAddSomethingElseThanACompoundPredicateOrAComparisonPredicate'),
  134. ]);