is-secure-string.ts

import StringUtils from "../Utils/StringUtils/index.js";
import { SchemaValidateFunction } from "ajv";
import {
  DataValidateFunction,
  KeywordDefinition
} from "ajv/dist/types/index.js";

/**
 * The 'compile' method is a function that AJV calls during the schema compilation.
 * It should return a validation function that will be used by AJV for data validation.
 * In our case, the validation function uses the StringUtils.isSecureString method
 * to check if the string is secure, and if not, throws an error with an appropriate
 * message and parameters.
 *
 * @property {string} keyword - The name of the keyword.
 * @property {string} type - The type of data the keyword applies to.
 * @property {boolean} errors - Indicates that the keyword returns errors.
 * @property {function} compile - A function that AJV calls during schema compilation.
 */
const keyword: KeywordDefinition = {
  keyword: "secure-string",
  type: "string",
  errors: true,
  compile: function compile() {
    const validate: SchemaValidateFunction | DataValidateFunction = (
      data: any
    ) => {
      validate.errors = [];

      const { isValid, errorMessage } = StringUtils.isSecureString(data);
      if (!isValid) {
        validate.errors = [
          {
            keyword: "secure-string",
            message: `${errorMessage}`,
            params: { invalidInput: data }
          }
        ];
        return false;
      }

      return true;
    };

    return validate;
  }
};

export default keyword;