input-validator.js 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. /*
  2. * Copyright 2018 Scytl Secure Electronic Voting SA
  3. *
  4. * All rights reserved
  5. *
  6. * See our extended copyright notice in *file 'Copyright.txt' which is part of this source code package
  7. */
  8. /* jshint node:true */
  9. 'use strict';
  10. /**
  11. * Input data validation utility for this module. Only intended for internal
  12. * use.
  13. */
  14. module.exports = {
  15. /**
  16. * Checks if a value is defined.
  17. *
  18. * @function checkIsDefined
  19. * @private
  20. * @param {Object}
  21. * value The value to check.
  22. * @param {string}
  23. * label The error message label for the value.
  24. * @throws {TypeError}
  25. * If the value is undefined.
  26. */
  27. checkIsDefined: function(value, label) {
  28. if (typeof value === 'undefined') {
  29. throw new TypeError(label + ' is undefined.');
  30. }
  31. },
  32. /**
  33. * Checks if a value is not null.
  34. *
  35. * @function checkIsNotNull
  36. * @private
  37. * @param {Object}
  38. * value The value to check.
  39. * @param {string}
  40. * label The error message label for the value.
  41. * @throws {TypeError}
  42. * If the value is null.
  43. */
  44. checkIsNotNull: function(value, label) {
  45. if (value === null) {
  46. throw new TypeError(label + ' is null.');
  47. }
  48. },
  49. /**
  50. * Checks if a value is defined and not null.
  51. *
  52. * @function checkIsDefinedAndNotNull
  53. * @private
  54. * @param {Object}
  55. * value The value to check.
  56. * @param {string}
  57. * label The error message label for the value.
  58. * @throws {TypeError}
  59. * If the value is not defined or it is null.
  60. */
  61. checkIsDefinedAndNotNull: function(value, label) {
  62. this.checkIsDefined(value, label);
  63. this.checkIsNotNull(value, label);
  64. },
  65. /**
  66. * Checks if a value is of an expected type.
  67. *
  68. * @function checkIsType
  69. * @private
  70. * @param {Object}
  71. * value The value to check.
  72. * @param {string}
  73. * type The expected type of the value.
  74. * @param {string}
  75. * label The error message label for the value.
  76. * @throws {TypeError}
  77. * If the value is not of the expected type.
  78. */
  79. checkIsType: function(value, type, label) {
  80. var typeFound = typeof value;
  81. if (typeFound !== type) {
  82. throw new TypeError(
  83. 'Expected ' + label + ' to have type \'' + type + '\' ; Found: \'' +
  84. typeFound + '\'');
  85. }
  86. },
  87. /**
  88. * Checks if a value is an instance of an Object.
  89. *
  90. * @function checkIsInstanceOf
  91. * @private
  92. * @param {Object}
  93. * value The value to check.
  94. * @param {Object}
  95. * obj The Object to check against.
  96. * @param {string}
  97. * objName The Object name, for error handling purposes.
  98. * @param {string}
  99. * label The error message label for the value.
  100. * @throws {TypeError}
  101. * If the object is undefined, null, or it is not an instance of
  102. * the Object.
  103. */
  104. checkIsInstanceOf: function(value, obj, objName, label) {
  105. this.checkIsDefinedAndNotNull(value, label);
  106. if (!(value instanceof obj)) {
  107. throw new TypeError(label + ' is not an instance of Object ' + objName);
  108. }
  109. },
  110. /**
  111. * Checks if a value is an object.
  112. *
  113. * @function checkIsObject
  114. * @private
  115. * @param {Object}
  116. * value The value to check.
  117. * @param {string}
  118. * label The error message label for the value.
  119. * @throws {TypeError}
  120. * If the value is not an object.
  121. */
  122. checkIsObject: function(value, label) {
  123. if (typeof value !== 'object') {
  124. throw new TypeError(label + ' is not an object.');
  125. }
  126. },
  127. /**
  128. * Checks if a value is an object and has properties.
  129. *
  130. * @function checkIsObjectWithProperties
  131. * @private
  132. * @param {Object}
  133. * value The value to check.
  134. * @param {string}
  135. * label The error message label for the value.
  136. * @throws {TypeError}
  137. * If the value is not an object or it has no properties.
  138. */
  139. checkIsObjectWithProperties: function(value, label) {
  140. this.checkIsDefinedAndNotNull(value, label);
  141. this.checkIsObject(value, label);
  142. if (!Object.getOwnPropertyNames(value).length) {
  143. throw new TypeError(label + ' does not have any properties.');
  144. }
  145. },
  146. /**
  147. * Checks if a value is an Array object.
  148. *
  149. * @function checkIsArray
  150. * @private
  151. * @param {Array}
  152. * array The value to check.
  153. * @param {string}
  154. * label The error message label for the value.
  155. * @throws {TypeError}
  156. * If the value is not an {Array} object.
  157. */
  158. checkIsArray: function(value, label) {
  159. this.checkIsDefinedAndNotNull(value, 'Array of ' + label);
  160. if (value.constructor !== Array) {
  161. throw new TypeError('Array of ' + label + ' is not of type Array.');
  162. }
  163. },
  164. /**
  165. * Checks if a value is a non-empty Array object.
  166. *
  167. * @function checkIsNonEmptyArray
  168. * @private
  169. * @param {Array}
  170. * array The value to check.
  171. * @param {string}
  172. * label The error message label for the value.
  173. * @throws {TypeError}
  174. * If the value is not a non-empty Array object.
  175. */
  176. checkIsNonEmptyArray: function(value, label) {
  177. this.checkIsArray(value, label);
  178. if (value.length < 1) {
  179. throw new TypeError('Array of ' + label + ' is empty.');
  180. }
  181. },
  182. /**
  183. * Checks if a value is a non-empty string.
  184. *
  185. * @function checkIsNonEmptyString
  186. * @private
  187. * @param {string}
  188. * value The value to check.
  189. * @param {string}
  190. * label The error message label for the value.
  191. * @throws {TypeError}
  192. * If the value is not a non-empty string.
  193. */
  194. checkIsNonEmptyString: function(value, label) {
  195. this.checkIsType(value, 'string', label);
  196. if (value.length === 0) {
  197. throw new TypeError(label + ' is empty.');
  198. }
  199. },
  200. /**
  201. * Checks if a value is an array of strings.
  202. *
  203. * @function checkIsStringArray
  204. * @private
  205. * @param {string[]}
  206. * value The value to check.
  207. * @param {string}
  208. * label The error message label for the value.
  209. * @throws {TypeError}
  210. * If value is not an array of strings.
  211. */
  212. checkIsStringArray: function(value, label) {
  213. this.checkIsNonEmptyArray(value, label);
  214. for (var i = 0; i < value.length; i++) {
  215. this.checkIsString(value[i], 'Element ' + i + ' of ' + label);
  216. }
  217. },
  218. /**
  219. * Checks if a value is an array of non-empty strings.
  220. *
  221. * @function checkIsNonEmptyStringArray
  222. * @private
  223. * @param {string[]}
  224. * value The value to check.
  225. * @param {string}
  226. * label The error message label for the value.
  227. * @throws {TypeError}
  228. * If value is not an array of non-empty strings.
  229. */
  230. checkIsNonEmptyStringArray: function(value, label) {
  231. this.checkIsNonEmptyArray(value, label);
  232. for (var i = 0; i < value.length; i++) {
  233. this.checkIsNonEmptyString(value[i], 'Element ' + i + ' of ' + label);
  234. }
  235. },
  236. /**
  237. * Checks if a value is a valid JSON object.
  238. *
  239. * @function checkIsJsonObject
  240. * @private
  241. * @param {Object}
  242. * value The value to check.
  243. * @param {string}
  244. * label The error message label for the value.
  245. * @throws {TypeError}
  246. * If the value is a valid JSON object.
  247. */
  248. checkIsJsonObject: function(value, label) {
  249. try {
  250. JSON.parse(value);
  251. } catch (error) {
  252. throw new TypeError(label + ' is not a valid JSON object.');
  253. }
  254. },
  255. /**
  256. * Checks if a value is a valid JSON string.
  257. *
  258. * @function checkIsJsonString
  259. * @private
  260. * @param {Object}
  261. * value The value to check.
  262. * @param {string}
  263. * label The error message label for the value.
  264. * @throws {TypeError}
  265. * If the value is a valid JSON string.
  266. */
  267. checkIsJsonString: function(value, label) {
  268. this.checkIsNonEmptyString(value, label);
  269. this.checkIsJsonObject(value, label);
  270. }
  271. };