Merge pull request #26 from sparksuite/input-validation

Add input validation to the `validateText()` function

Author: WesCossick

src/validate-text.ts

@@ -48,6 +48,40 @@ async function validateText(
 	options: ValidateTextOptionsWithWarnings
 ): Promise<ValidateTextResultWithWarnings>;
 async function validateText(textToBeValidated: string, options?: ValidateTextOptions): Promise<ValidateTextResult> {
+	// Validations
+	if (!textToBeValidated) {
+		throw new Error('You must pass in text to be validated');
+	}
+
+	if (typeof textToBeValidated !== 'string') {
+		throw new Error('The text to be validated must be a string');
+	}
+
+	if (options) {
+		const allowedMediums: typeof options['medium'][] = [
+			'all',
+			'braille',
+			'embossed',
+			'handheld',
+			'print',
+			'projection',
+			'screen',
+			'speech',
+			'tty',
+			'tv',
+		];
+
+		if (options.medium && !allowedMediums.includes(options.medium)) {
+			throw new Error(`The medium must be one of the following: ${allowedMediums.join(', ')}`);
+		}
+
+		const allowedWarningLevels: typeof options['warningLevel'][] = [0, 1, 2, 3];
+
+		if (options.warningLevel && !allowedWarningLevels.includes(options.warningLevel)) {
+			throw new Error(`The warning level must be one of the following: ${allowedWarningLevels.join(', ')}`);
+		}
+	}
+
 	// Build URL for fetching
 	const params = {
 		text: encodeURIComponent(textToBeValidated),

test/index.test.ts

@@ -61,4 +61,29 @@ describe('#validateText()', () => {
 			errors: [],
 		});
 	});
+
+	it('Complains about missing text', async () => {
+		// @ts-expect-error: We're trying to force an error here
+		await expect(cssValidator.validateText()).rejects.toThrow('You must pass in text to be validated');
+		await expect(cssValidator.validateText('')).rejects.toThrow('You must pass in text to be validated');
+	});
+
+	it('Complains about text not being a string', async () => {
+		// @ts-expect-error: We're trying to force an error here
+		await expect(cssValidator.validateText(true)).rejects.toThrow('The text to be validated must be a string');
+	});
+
+	it('Complains about invalid medium', async () => {
+		// @ts-expect-error: We're trying to force an error here
+		await expect(cssValidator.validateText('abc', { medium: 'fake' })).rejects.toThrow(
+			'The medium must be one of the following:'
+		);
+	});
+
+	it('Complains about invalid warning level', async () => {
+		// @ts-expect-error: We're trying to force an error here
+		await expect(cssValidator.validateText('abc', { warningLevel: 'fake' })).rejects.toThrow(
+			'The warning level must be one of the following:'
+		);
+	});
 });