import { ValidationOptions } from "../ValidationOptions";
import { buildMessage, ValidateBy } from "../common/ValidateBy";
import validator from "validator";

export const IS_ISO31661_ALPHA_3 = "isISO31661Alpha3";

/**
 * Check if the string is a valid [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) officially assigned country code.
 */
export function isISO31661Alpha3(value: unknown): boolean {
    return typeof value === "string" && validator.isISO31661Alpha3(value);
}

/**
 * Check if the string is a valid [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) officially assigned country code.
 */
export function IsISO31661Alpha3(validationOptions?: ValidationOptions): PropertyDecorator {
    return ValidateBy(
        {
            name: IS_ISO31661_ALPHA_3,
            validator: {
                validate: (value, args): boolean => isISO31661Alpha3(value),
                defaultMessage: buildMessage(
                    (eachPrefix) => eachPrefix + "$property must be a valid ISO31661 Alpha3 code",
                    validationOptions
                )
            }
        },
        validationOptions
    );
}