Add new validators

Author: AJCStriker

package.json

@@ -1,6 +1,6 @@
 {
   "name": "strontium",
-  "version": "2.3.5",
+  "version": "2.4.0",
   "description": "Strontium is a TypeScript toolkit for High Performance API servers built for Production not Projects.",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",

src/validation/drivers/validators/isArray.ts

@@ -0,0 +1,19 @@
+import { ValidationError } from "../../../errors"
+
+import { ValidatorFunction } from "../.."
+
+export const isArray = <V extends ValidatorFunction<unknown, O>, O>(
+    innerValidator: V
+) => async (input: unknown): Promise<Array<O>> => {
+    if (!Array.isArray(input)) {
+        throw new ValidationError(
+            "IS_ARRAY",
+            "Value not an array",
+            "This value must be an array."
+        )
+    }
+
+    let validatedArray: Array<O> = await Promise.all(input.map(innerValidator))
+
+    return validatedArray
+}

src/validation/index.ts

@@ -7,7 +7,9 @@ export * from "./drivers/helpers/either"
 export * from "./drivers/sanitizers/defaultValue"
 export * from "./drivers/sanitizers/normalizeEmail"
 
+export * from "./drivers/validators/isArray"
 export * from "./drivers/validators/isBoolean"
+export * from "./drivers/validators/isExactly"
 export * from "./drivers/validators/isISOCountry"
 export * from "./drivers/validators/isISODate"
 export * from "./drivers/validators/isNull"

tests/helpers/ExpectToThrowCustomClass.ts

@@ -12,3 +12,15 @@ export const expectToThrowCustomClass = (
         expect(e).to.be.instanceOf(classContructor)
     }
 }
+
+export const expectToThrowCustomClassAsync = async (
+    candidateFunction: Function,
+    classContructor: ConstructorOf<any>
+) => {
+    try {
+        await candidateFunction()
+        expect(false).to.equal(true)
+    } catch (e) {
+        expect(e).to.be.instanceOf(classContructor)
+    }
+}

tests/validation/drivers/validators/isArray.spec.ts

@@ -0,0 +1,99 @@
+import {
+    expectToThrowCustomClass,
+    expectToThrowCustomClassAsync,
+} from "../../../helpers/ExpectToThrowCustomClass"
+import { expect } from "chai"
+import { either } from "../../../../src/validation/drivers/helpers/either"
+import { isArray } from "../../../../src/validation/drivers/validators/isArray"
+import {
+    ValidationError,
+    isBoolean,
+    isNumber,
+    isObject,
+    isString,
+    isUndefined,
+} from "../../../../src"
+
+describe("isArray", () => {
+    it("should return the validated array if all values are valid", async () => {
+        let testValidator = isArray(
+            isObject({
+                test: isString,
+                otherTest: isNumber,
+                optionalTest: either(isUndefined, isBoolean),
+            })
+        )
+
+        expect(
+            await testValidator([
+                {
+                    test: "test",
+                    otherTest: 15,
+                },
+                {
+                    test: "more test",
+                    otherTest: 15,
+                    optionalTest: false,
+                },
+            ])
+        ).to.deep.equal([
+            {
+                test: "test",
+                otherTest: 15,
+            },
+            {
+                test: "more test",
+                otherTest: 15,
+                optionalTest: false,
+            },
+        ])
+
+        expect(await testValidator([])).to.deep.equal([])
+    })
+
+    it("should return a validation error if input is not boolean", async () => {
+        let testValidator = isArray(
+            isObject({
+                test: isString,
+                otherTest: isNumber,
+                optionalTest: either(isUndefined, isBoolean),
+            })
+        )
+
+        await expectToThrowCustomClassAsync(
+            async () => await testValidator({}),
+            ValidationError
+        )
+        await expectToThrowCustomClassAsync(
+            async () => await testValidator("false"),
+            ValidationError
+        )
+        await expectToThrowCustomClassAsync(
+            async () => await testValidator("true"),
+            ValidationError
+        )
+        await expectToThrowCustomClassAsync(
+            async () => await testValidator(false),
+            ValidationError
+        )
+        await expectToThrowCustomClassAsync(
+            async () => await testValidator([{}]),
+            ValidationError
+        )
+        await expectToThrowCustomClassAsync(
+            async () =>
+                await testValidator([
+                    {
+                        test: "test",
+                        otherTest: 15,
+                    },
+                    {
+                        test: "test",
+                        otherTest: 15,
+                        optionalTest: "wrong",
+                    },
+                ]),
+            ValidationError
+        )
+    })
+})

tests/validation/drivers/validators/isExactly.spec.ts

@@ -12,7 +12,7 @@ describe("isExactly", () => {
         expect(testValidator("more-test")).to.equal("more-test")
     })
 
-    it("should return a validation error if input is not boolean", () => {
+    it("should return a validation error if input is not in the allowed set", () => {
         let testValidator = isExactly(["test", "other-test", "more-test"])
 
         expectToThrowCustomClass(() => testValidator({}), ValidationError)