ion-schema 0.15.0

use crate::ion_extension::ElementExtensions;
use crate::isl::isl_import::IslImportType;
use crate::isl::isl_type_reference::{IslTypeRef, IslVariablyOccurringTypeRef};
use crate::isl::ranges::{I64Range, TimestampPrecisionRange, U64Range, UsizeRange};
use crate::isl::util::{
    Annotation, Ieee754InterchangeFormat, TimestampOffset, TimestampPrecision, ValidValue,
};
use crate::isl::IslVersion;
use crate::result::{invalid_schema_error, invalid_schema_error_raw, IonSchemaResult};
use crate::{isl, isl_require};
use ion_rs::{Element, Value};
use ion_rs::{IonResult, SequenceWriter, StructWriter, ValueWriter, WriteAsIon};
use ion_rs::{IonType, Symbol};
use std::collections::HashMap;
use std::convert::TryInto;

/// Provides public facing APIs for constructing ISL constraints programmatically for ISL 1.0
pub mod v_1_0 {
    use crate::isl::isl_constraint::{
        IslAnnotationsConstraint, IslConstraint, IslConstraintValue, IslRegexConstraint,
        IslSimpleAnnotationsConstraint, IslTimestampOffsetConstraint, IslValidValuesConstraint,
    };
    use crate::isl::isl_type_reference::{IslTypeRef, IslVariablyOccurringTypeRef};
    use crate::isl::ranges::{I64Range, TimestampPrecisionRange, U64Range, UsizeRange};
    use crate::isl::util::{Annotation, TimestampOffset, ValidValue};
    use crate::isl::IslVersion;
    use crate::result::IonSchemaResult;
    use ion_rs::Element;

    /// Creates a `type` constraint using the [IslTypeRef] referenced inside it
    // type is rust keyword hence this method is named type_constraint unlike other ISL constraint methods
    pub fn type_constraint(isl_type: IslTypeRef) -> IslConstraint {
        IslConstraint::new(IslVersion::V1_0, IslConstraintValue::Type(isl_type))
    }

    /// Creates an `all_of` constraint using the [IslTypeRef] referenced inside it
    pub fn all_of<A: Into<Vec<IslTypeRef>>>(isl_types: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::AllOf(isl_types.into()),
        )
    }

    /// Creates an `any_of` constraint using the [IslTypeRef] referenced inside it
    pub fn any_of<A: Into<Vec<IslTypeRef>>>(isl_types: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::AnyOf(isl_types.into()),
        )
    }

    /// Creates a `one_of` constraint using the [IslTypeRef] referenced inside it
    pub fn one_of<A: Into<Vec<IslTypeRef>>>(isl_types: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::OneOf(isl_types.into()),
        )
    }

    /// Creates an `ordered_elements` constraint using the [IslVariablyOccurringTypeRef] referenced inside it
    pub fn ordered_elements<A: Into<Vec<IslVariablyOccurringTypeRef>>>(
        isl_types: A,
    ) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::OrderedElements(isl_types.into()),
        )
    }

    /// Creates a `precision` constraint using the range specified in it
    pub fn precision(precision: U64Range) -> IslConstraint {
        IslConstraint::new(IslVersion::V1_0, IslConstraintValue::Precision(precision))
    }

    /// Creates a `scale` constraint using the range specified in it
    pub fn scale(scale: I64Range) -> IslConstraint {
        IslConstraint::new(IslVersion::V1_0, IslConstraintValue::Scale(scale))
    }

    /// Creates a `fields` constraint using the field names and [IslVariablyOccurringTypeRef]s referenced inside it
    pub fn fields<I>(fields: I) -> IslConstraint
    where
        I: Iterator<Item = (String, IslVariablyOccurringTypeRef)>,
    {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::Fields(fields.collect(), false),
        )
    }

    /// Creates a `not` constraint using the [IslTypeRef] referenced inside it
    pub fn not(isl_type: IslTypeRef) -> IslConstraint {
        IslConstraint::new(IslVersion::V1_0, IslConstraintValue::Not(isl_type))
    }

    /// Creates a `contains` constraint using the [Element] specified inside it
    pub fn contains<A: Into<Vec<Element>>>(values: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::Contains(values.into()),
        )
    }

    /// Creates a `container_length` constraint using the range specified in it
    pub fn container_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::ContainerLength(length),
        )
    }

    /// Creates a `byte_length` constraint using the range specified in it
    pub fn byte_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(IslVersion::V1_0, IslConstraintValue::ByteLength(length))
    }

    /// Creates a `codepoint_length` constraint using the range specified in it
    pub fn codepoint_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::CodepointLength(length),
        )
    }

    /// Creates a `timestamp_precision` constraint using the range specified in it
    pub fn timestamp_precision(precision: TimestampPrecisionRange) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::TimestampPrecision(precision),
        )
    }

    /// Creates a `timestamp_offset` constraint using the offset list specified in it
    pub fn timestamp_offset(offsets: Vec<TimestampOffset>) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::TimestampOffset(IslTimestampOffsetConstraint::new(offsets)),
        )
    }

    /// Creates an `utf_byte_length` constraint using the range specified in it
    pub fn utf8_byte_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(IslVersion::V1_0, IslConstraintValue::Utf8ByteLength(length))
    }

    /// Creates an `element` constraint using the [IslTypeRef] referenced inside it
    pub fn element(isl_type: IslTypeRef) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::Element(isl_type, false),
        )
    }

    /// Creates an `annotations` constraint using [str]s and [Element]s specified inside it
    pub fn annotations<'a, A: IntoIterator<Item = &'a str>, B: IntoIterator<Item = Element>>(
        annotations_modifiers: A,
        annotations: B,
    ) -> IslConstraint {
        let annotations_modifiers: Vec<&str> = annotations_modifiers.into_iter().collect();
        let annotations: Vec<Annotation> = annotations
            .into_iter()
            .map(|a| {
                Annotation::new(
                    a.as_text().unwrap().to_owned(),
                    Annotation::is_annotation_required(
                        &a,
                        annotations_modifiers.contains(&"required"),
                    ),
                    IslVersion::V1_0,
                )
            })
            .collect();
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::Annotations(IslAnnotationsConstraint::SimpleAnnotations(
                IslSimpleAnnotationsConstraint::new(
                    annotations_modifiers.contains(&"closed"),
                    annotations_modifiers.contains(&"ordered"),
                    annotations_modifiers.contains(&"required"),
                    annotations,
                ),
            )),
        )
    }

    /// Creates a `valid_values` constraint using the [Element]s specified inside it
    pub fn valid_values(valid_values: Vec<ValidValue>) -> IonSchemaResult<IslConstraint> {
        Ok(IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::ValidValues(IslValidValuesConstraint { valid_values }),
        ))
    }

    /// Creates a `regex` constraint using the expression and flags (case_insensitive, multi_line)
    pub fn regex(case_insensitive: bool, multi_line: bool, expression: String) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V1_0,
            IslConstraintValue::Regex(IslRegexConstraint::new(
                case_insensitive,
                multi_line,
                expression,
            )),
        )
    }
}

/// Provides public facing APIs for constructing ISL constraints programmatically for ISL 2.0
pub mod v_2_0 {
    use crate::isl::isl_constraint::{
        IslAnnotationsConstraint, IslConstraint, IslSimpleAnnotationsConstraint,
    };
    use crate::isl::isl_constraint::{
        IslConstraintValue, IslTimestampOffsetConstraint, IslValidValuesConstraint,
    };
    use crate::isl::isl_type_reference::{IslTypeRef, IslVariablyOccurringTypeRef};
    use crate::isl::ranges::{I64Range, TimestampPrecisionRange, U64Range, UsizeRange};
    use crate::isl::util::{Annotation, Ieee754InterchangeFormat, TimestampOffset, ValidValue};
    use crate::isl::IslVersion;
    use crate::result::{invalid_schema_error, IonSchemaResult};
    use ion_rs::Element;

    /// Creates a `type` constraint using the [IslTypeRef] referenced inside it
    // type is rust keyword hence this method is named type_constraint unlike other ISL constraint methods
    pub fn type_constraint(isl_type: IslTypeRef) -> IslConstraint {
        IslConstraint::new(IslVersion::V2_0, IslConstraintValue::Type(isl_type))
    }

    /// Creates an `all_of` constraint using the [IslTypeRef] referenced inside it
    pub fn all_of<A: Into<Vec<IslTypeRef>>>(isl_types: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::AllOf(isl_types.into()),
        )
    }

    /// Creates an `any_of` constraint using the [IslTypeRef] referenced inside it
    pub fn any_of<A: Into<Vec<IslTypeRef>>>(isl_types: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::AnyOf(isl_types.into()),
        )
    }

    /// Creates an `one_of` constraint using the [IslTypeRef] referenced inside it
    pub fn one_of<A: Into<Vec<IslTypeRef>>>(isl_types: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::OneOf(isl_types.into()),
        )
    }

    /// Creates an `ordered_elements` constraint using the [IslVariablyOccurringTypeRef] referenced inside it
    pub fn ordered_elements<A: Into<Vec<IslVariablyOccurringTypeRef>>>(
        isl_types: A,
    ) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::OrderedElements(isl_types.into()),
        )
    }

    /// Creates a `precision` constraint using the range specified in it
    pub fn precision(precision: U64Range) -> IslConstraint {
        IslConstraint::new(IslVersion::V2_0, IslConstraintValue::Precision(precision))
    }

    /// Creates an `exponent` constraint from a [Range] specifying an exponent range.
    pub fn exponent(exponent: I64Range) -> IslConstraint {
        IslConstraint::new(IslVersion::V2_0, IslConstraintValue::Exponent(exponent))
    }

    /// Creates a `fields` constraint using the field names and [IslVariablyOccurringTypeRef]s referenced inside it
    /// and specify if the `fields` are closed or not (i.e. indicates whether only fields that are explicitly specified should be allowed or not).
    pub fn fields<I>(fields: I, is_closed: bool) -> IslConstraint
    where
        I: Iterator<Item = (String, IslVariablyOccurringTypeRef)>,
    {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::Fields(fields.collect(), is_closed),
        )
    }

    /// Creates a `field_names` constraint using the [IslTypeRef] referenced inside it and considers whether distinct elements are required or not
    pub fn field_names(isl_type: IslTypeRef, require_distinct_field_names: bool) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::FieldNames(isl_type, require_distinct_field_names),
        )
    }

    /// Creates a `not` constraint using the [IslTypeRef] referenced inside it
    pub fn not(isl_type: IslTypeRef) -> IslConstraint {
        IslConstraint::new(IslVersion::V2_0, IslConstraintValue::Not(isl_type))
    }

    /// Creates a `contains` constraint using the [Element] specified inside it
    pub fn contains<A: Into<Vec<Element>>>(values: A) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::Contains(values.into()),
        )
    }

    /// Creates a `container_length` constraint using the range specified in it
    pub fn container_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::ContainerLength(length),
        )
    }

    /// Creates a `byte_length` constraint using the range specified in it
    pub fn byte_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(IslVersion::V2_0, IslConstraintValue::ByteLength(length))
    }

    /// Creates a `codepoint_length` constraint using the range specified in it
    pub fn codepoint_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::CodepointLength(length),
        )
    }

    /// Creates a `timestamp_precision` constraint using the range specified in it
    pub fn timestamp_precision(precision: TimestampPrecisionRange) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::TimestampPrecision(precision),
        )
    }

    /// Creates a `timestamp_offset` constraint using the offset list specified in it
    pub fn timestamp_offset(offsets: Vec<TimestampOffset>) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::TimestampOffset(IslTimestampOffsetConstraint::new(offsets)),
        )
    }

    /// Creates a `utf8_byte_length` constraint using the range specified in it
    pub fn utf8_byte_length(length: UsizeRange) -> IslConstraint {
        IslConstraint::new(IslVersion::V2_0, IslConstraintValue::Utf8ByteLength(length))
    }

    /// Creates an `element` constraint using the [IslTypeRef] referenced inside it and considers whether distinct elements are required or not
    pub fn element(isl_type: IslTypeRef, require_distinct_elements: bool) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::Element(isl_type, require_distinct_elements),
        )
    }

    /// Creates an `annotations` constraint using a list of valid annotations and specify whether annotations are required or closed or both.
    /// If both `is_required` and `is_closed` are false then this returns an error as ISL 2.0 requires that either annotations are closed or required or both.
    pub fn annotations_simplified<A: IntoIterator<Item = Element>>(
        is_required: bool,
        is_closed: bool,
        annotations: A,
    ) -> IonSchemaResult<IslConstraint> {
        let annotations: Vec<Annotation> = annotations
            .into_iter()
            .map(|a| {
                Annotation::new(
                    a.as_text().unwrap().to_owned(),
                    Annotation::is_annotation_required(&a, is_required),
                    IslVersion::V2_0,
                )
            })
            .collect();

        if !is_required && !is_closed {
            return invalid_schema_error(
                "annotations constraints must either be required or closed or both.",
            );
        }

        Ok(IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::Annotations(IslAnnotationsConstraint::SimpleAnnotations(
                IslSimpleAnnotationsConstraint::new(is_closed, false, is_required, annotations),
            )),
        ))
    }

    /// Creates an `annotations` constraint using an [IslTypeRef].
    pub fn annotations(isl_type: IslTypeRef) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::Annotations(IslAnnotationsConstraint::StandardAnnotations(
                isl_type,
            )),
        )
    }

    /// Creates a `valid_values` constraint using the [`ValidValue`]s specified inside it
    pub fn valid_values(valid_values: Vec<ValidValue>) -> IonSchemaResult<IslConstraint> {
        Ok(IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::ValidValues(IslValidValuesConstraint { valid_values }),
        ))
    }

    /// Creates a `regex` constraint using the expression and flags (case_insensitive, multi_line)
    pub fn regex(case_insensitive: bool, multi_line: bool, expression: String) -> IslConstraint {
        todo!()
    }

    /// Creates a `ieee754_float` constraint using `Ieee754InterchangeFormat` specified in it.
    pub fn ieee754_float(interchange_format: Ieee754InterchangeFormat) -> IslConstraint {
        IslConstraint::new(
            IslVersion::V2_0,
            IslConstraintValue::Ieee754Float(interchange_format),
        )
    }
}

/// Represents schema constraints [IslConstraint]
#[derive(Debug, Clone, PartialEq)]
pub struct IslConstraint {
    pub(crate) version: IslVersion,
    pub(crate) constraint_value: IslConstraintValue,
}

impl IslConstraint {
    pub(crate) fn new(version: IslVersion, constraint: IslConstraintValue) -> Self {
        Self {
            constraint_value: constraint,
            version,
        }
    }

    /// Provides an enum to match constraint types and get underlying constraint value
    pub fn constraint(&self) -> &IslConstraintValue {
        &self.constraint_value
    }
}

#[derive(Debug, Clone, PartialEq)]
pub enum IslConstraintValue {
    AllOf(Vec<IslTypeRef>),
    Annotations(IslAnnotationsConstraint),
    AnyOf(Vec<IslTypeRef>),
    ByteLength(UsizeRange),
    CodepointLength(UsizeRange),
    Contains(Vec<Element>),
    ContentClosed,
    ContainerLength(UsizeRange),
    // Represents Element(type_reference, expected_distinct).
    // For ISL 2.0 true/false is specified based on whether `distinct` annotation is present or not.
    // For ISL 1.0 which doesn't support `distinct` elements this will be (type_reference, false).
    Element(IslTypeRef, bool),
    Exponent(I64Range),
    // Represents Fields(fields, content_closed)
    // For ISL 2.0 true/false is specified based on whether `closed::` annotation is present or not
    // For ISL 1.0 this will always be (fields, false) as it doesn't support `closed::` annotation on fields constraint
    Fields(HashMap<String, IslVariablyOccurringTypeRef>, bool),
    // Represents FieldNames(type_reference, expected_distinct).
    // For ISL 2.0 true/false is specified based on whether `distinct` annotation is present or not.
    // For ISL 1.0 which doesn't support `field_names` constraint this will be (type_reference, false).
    FieldNames(IslTypeRef, bool),
    Ieee754Float(Ieee754InterchangeFormat),
    Not(IslTypeRef),
    OneOf(Vec<IslTypeRef>),
    OrderedElements(Vec<IslVariablyOccurringTypeRef>),
    Precision(U64Range),
    Regex(IslRegexConstraint),
    Scale(I64Range),
    TimestampOffset(IslTimestampOffsetConstraint),
    TimestampPrecision(TimestampPrecisionRange),
    Type(IslTypeRef),
    Unknown(String, Element), // Unknown constraint is used to store open contents
    Utf8ByteLength(UsizeRange),
    ValidValues(IslValidValuesConstraint),
}

impl IslConstraintValue {
    /// Parse constraints inside an [Element] to an [IslConstraint]
    pub fn from_ion_element(
        isl_version: IslVersion,
        constraint_name: &str,
        value: &Element,
        type_name: &str,
        inline_imported_types: &mut Vec<IslImportType>,
    ) -> IonSchemaResult<IslConstraintValue> {
        // TODO: add more constraints to match below
        match constraint_name {
            "all_of" => {
                let types: Vec<IslTypeRef> =
                    IslConstraintValue::isl_type_references_from_ion_element(
                        isl_version,
                        value,
                        inline_imported_types,
                        "all_of",
                    )?;
                Ok(IslConstraintValue::AllOf(types))
            }
            "annotations" => {
                if value.is_null() {
                    return invalid_schema_error(
                        "annotations constraint was a null instead of a list",
                    );
                }

                if value.ion_type() == IonType::List {
                    Ok(IslConstraintValue::Annotations(
                        IslAnnotationsConstraint::SimpleAnnotations(
                            IslSimpleAnnotationsConstraint::from_ion_element(value, isl_version)?,
                        ),
                    ))
                } else if value.ion_type() == IonType::Struct && isl_version == IslVersion::V2_0 {
                    let type_reference: IslTypeRef =
                        IslTypeRef::from_ion_element(isl_version, value, inline_imported_types)?;

                    Ok(IslConstraintValue::Annotations(
                        IslAnnotationsConstraint::StandardAnnotations(type_reference),
                    ))
                } else {
                    return invalid_schema_error(format!(
                        "annotations constraint was a {:?} instead of a list",
                        value.ion_type()
                    ));
                }
            }
            "any_of" => {
                let types: Vec<IslTypeRef> =
                    IslConstraintValue::isl_type_references_from_ion_element(
                        isl_version,
                        value,
                        inline_imported_types,
                        "any_of",
                    )?;
                Ok(IslConstraintValue::AnyOf(types))
            }
            "byte_length" => Ok(IslConstraintValue::ByteLength(
                UsizeRange::from_ion_element(value, Element::as_usize)?,
            )),
            "codepoint_length" => Ok(IslConstraintValue::CodepointLength(
                UsizeRange::from_ion_element(value, Element::as_usize)?,
            )),
            "contains" => {
                if value.is_null() {
                    return invalid_schema_error(
                        "contains constraint was a null instead of a list",
                    );
                }

                if value.ion_type() != IonType::List {
                    return invalid_schema_error(format!(
                        "contains constraint was a {:?} instead of a list",
                        value.ion_type()
                    ));
                }

                if !value.annotations().is_empty() {
                    return invalid_schema_error("contains list can not have any annotations");
                }

                let values: Vec<Element> = value
                    .as_sequence()
                    .unwrap()
                    .elements()
                    .map(|e| e.to_owned())
                    .collect();
                Ok(IslConstraintValue::Contains(values))
            }
            "content" => {
                if value.is_null() {
                    return invalid_schema_error(
                        "content constraint was a null instead of a symbol `closed`",
                    );
                }

                if value.ion_type() != IonType::Symbol {
                    return invalid_schema_error(format!(
                        "content constraint was a {:?} instead of a symbol `closed`",
                        value.ion_type()
                    ));
                }

                if let Some(closed) = value.as_text() {
                    if closed != "closed" {
                        return invalid_schema_error(format!(
                            "content constraint was a {closed} instead of a symbol `closed`"
                        ));
                    }
                }

                Ok(IslConstraintValue::ContentClosed)
            }

            "container_length" => Ok(IslConstraintValue::ContainerLength(
                UsizeRange::from_ion_element(value, Element::as_usize)?,
            )),
            "element" => {
                let type_reference: IslTypeRef =
                    IslTypeRef::from_ion_element(isl_version, value, inline_imported_types)?;
                match isl_version {
                    IslVersion::V1_0 => {
                        // for ISL 1.0 `distinct annotation on `element` constraint is not supported which is represented by `false` here
                        Ok(IslConstraintValue::Element(type_reference, false))
                    }
                    IslVersion::V2_0 => {
                        // return error if there are any annotations other than `distinct` or `$null_or`
                        if value
                            .annotations()
                            .iter()
                            .any(|a| a.text() != Some("distinct") && a.text() != Some("$null_or"))
                        {
                            return invalid_schema_error(
                                "element constraint can only contain `distinct` annotation",
                            );
                        }

                        // verify whether `distinct`annotation is present or not
                        let require_distinct = value.annotations().contains("distinct");

                        Ok(IslConstraintValue::Element(
                            type_reference,
                            require_distinct,
                        ))
                    }
                }
            }
            "field_names" => {
                let type_reference =
                    IslTypeRef::from_ion_element(isl_version, value, inline_imported_types)?;
                match isl_version {
                    IslVersion::V1_0 => {
                        // for ISL 1.0 `field_names` constraint does not exist hence `field_names` will be considered as open content
                        Ok(IslConstraintValue::Unknown(
                            constraint_name.to_string(),
                            value.to_owned(),
                        ))
                    }
                    IslVersion::V2_0 => {
                        // return error if there are any annotations other than `distinct`
                        if value.annotations().len() > 1
                            || value
                                .annotations()
                                .iter()
                                .any(|a| a.text() != Some("distinct"))
                        {
                            return invalid_schema_error(
                                "field_names constraint can only contain `distinct` annotation",
                            );
                        }

                        Ok(IslConstraintValue::FieldNames(
                            type_reference,
                            value.annotations().contains("distinct"),
                        ))
                    }
                }
            }
            "fields" => {
                let fields: HashMap<String, IslVariablyOccurringTypeRef> =
                    IslConstraintValue::isl_fields_from_ion_element(
                        isl_version,
                        value,
                        inline_imported_types,
                    )?;

                if fields.is_empty() {
                    return invalid_schema_error("fields constraint can not be empty");
                }
                match isl_version {
                    IslVersion::V1_0 => Ok(IslConstraintValue::Fields(fields, false)),
                    IslVersion::V2_0 => {
                        if value.annotations().len() > 1
                            || value
                                .annotations()
                                .iter()
                                .any(|a| a.text() != Some("closed"))
                        {
                            return invalid_schema_error(
                                "fields constraint may only be annotated with 'closed'",
                            );
                        }
                        Ok(IslConstraintValue::Fields(
                            fields,
                            value.annotations().contains("closed"),
                        ))
                    }
                }
            }
            "ieee754_float" => {
                if !value.annotations().is_empty() {
                    return invalid_schema_error(
                        "`ieee_754_float` argument must not have annotations",
                    );
                }
                let string_value =
                    value
                        .as_symbol()
                        .map(|s| s.text().unwrap())
                        .ok_or_else(|| {
                            invalid_schema_error_raw(format!(
                                "expected ieee754_float to be one of 'binary16', 'binary32', or 'binary64', but it was: {value}"))
                        })?;
                Ok(IslConstraintValue::Ieee754Float(string_value.try_into()?))
            }
            "one_of" => {
                let types: Vec<IslTypeRef> =
                    IslConstraintValue::isl_type_references_from_ion_element(
                        isl_version,
                        value,
                        inline_imported_types,
                        "one_of",
                    )?;
                Ok(IslConstraintValue::OneOf(types))
            }
            "not" => {
                let type_reference: IslTypeRef =
                    IslTypeRef::from_ion_element(isl_version, value, inline_imported_types)?;
                Ok(IslConstraintValue::Not(type_reference))
            }
            "type" => {
                let type_reference: IslTypeRef =
                    IslTypeRef::from_ion_element(isl_version, value, inline_imported_types)?;
                Ok(IslConstraintValue::Type(type_reference))
            }
            "ordered_elements" => {
                if value.is_null() {
                    return invalid_schema_error(
                        "ordered_elements constraint was a null instead of a list",
                    );
                }
                isl_require!(value.annotations().is_empty() => "ordered_elements list may not be annotated")?;
                if value.ion_type() != IonType::List {
                    return invalid_schema_error(format!(
                        "ordered_elements constraint was a {:?} instead of a list",
                        value.ion_type()
                    ));
                }

                let types: Vec<IslVariablyOccurringTypeRef> = value
                    .as_sequence()
                    .unwrap()
                    .elements()
                    .map(|e| {
                        IslVariablyOccurringTypeRef::from_ion_element(
                            constraint_name,
                            isl_version,
                            e,
                            inline_imported_types,
                        )
                    })
                    .collect::<IonSchemaResult<Vec<IslVariablyOccurringTypeRef>>>()?;
                Ok(IslConstraintValue::OrderedElements(types))
            }
            "precision" => Ok(IslConstraintValue::Precision(U64Range::from_ion_element(
                value,
                Element::as_u64,
            )?)),
            "regex" => {
                let case_insensitive = value.annotations().contains("i");
                let multi_line = value.annotations().contains("m");

                if value
                    .annotations()
                    .iter()
                    .any(|a| a.text().unwrap() != "i" && a.text().unwrap() != "m")
                {
                    return invalid_schema_error(
                        "regex constraint must only contain 'i' or 'm' annotation",
                    );
                }

                let expression = value.as_string().ok_or_else(|| {
                    invalid_schema_error_raw(format!(
                        "expected regex to contain a string expression but found: {}",
                        value.ion_type()
                    ))
                })?;

                if expression.is_empty() {
                    return invalid_schema_error(
                        "regex constraint must contain a non empty expression",
                    );
                }

                Ok(IslConstraintValue::Regex(IslRegexConstraint::new(
                    case_insensitive,
                    multi_line,
                    expression.to_string(),
                )))
            }
            "scale" => match isl_version {
                IslVersion::V1_0 => Ok(IslConstraintValue::Scale(I64Range::from_ion_element(
                    value,
                    Element::as_i64,
                )?)),
                IslVersion::V2_0 => {
                    // for ISL 2.0 scale constraint does not exist hence `scale` will be considered as open content
                    Ok(IslConstraintValue::Unknown(
                        constraint_name.to_string(),
                        value.to_owned(),
                    ))
                }
            },
            "timestamp_precision" => Ok(IslConstraintValue::TimestampPrecision(
                TimestampPrecisionRange::from_ion_element(value, |e| {
                    let symbol_text = e.as_symbol().and_then(Symbol::text)?;
                    TimestampPrecision::try_from(symbol_text).ok()
                })?,
            )),
            "exponent" => match isl_version {
                IslVersion::V1_0 => {
                    // for ISL 1.0 exponent constraint does not exist hence `exponent` will be considered as open content
                    Ok(IslConstraintValue::Unknown(
                        constraint_name.to_string(),
                        value.to_owned(),
                    ))
                }
                IslVersion::V2_0 => Ok(IslConstraintValue::Exponent(I64Range::from_ion_element(
                    value,
                    Element::as_i64,
                )?)),
            },
            "timestamp_offset" => {
                use IonType::*;
                if value.is_null() {
                    return invalid_schema_error(
                        "expected a list of valid offsets for an `timestamp_offset` constraint, found null",
                    );
                }

                if !value.annotations().is_empty() {
                    return invalid_schema_error("`timestamp_offset` list may not be annotated");
                }

                let valid_offsets: Vec<TimestampOffset> = match value.ion_type() {
                    List => {
                        let list_values = value.as_sequence().unwrap();
                        if list_values.is_empty() {
                            return invalid_schema_error(
                                "`timestamp_offset` constraint must contain at least one offset",
                            );
                        }
                        let list_vec: IonSchemaResult<Vec<TimestampOffset>> = list_values
                            .elements()
                            .map(|e| {
                                if e.is_null() {
                                    return invalid_schema_error(
                                        "`timestamp_offset` values must be non-null strings, found null",
                                    );
                                }

                                if e.ion_type() != IonType::String {
                                    return invalid_schema_error(format!(
                                        "`timestamp_offset` values must be non-null strings, found {e}"
                                    ));
                                }

                                if !e.annotations().is_empty() {
                                    return invalid_schema_error(format!(
                                        "`timestamp_offset` values may not be annotated, found {e}"
                                    ));
                                }

                                // unwrap here will not panic as we have already verified the ion type to be a string
                                let string_value = e.as_string().unwrap();

                                // convert the string to TimestampOffset which stores offset in minutes
                                string_value.try_into()
                            })
                            .collect();
                        list_vec?
                    }
                    _ => {
                        return invalid_schema_error(format!(
                        "`timestamp_offset` requires a list of offset strings, but found: {value}"
                    ))
                    }
                };
                Ok(IslConstraintValue::TimestampOffset(
                    IslTimestampOffsetConstraint::new(valid_offsets),
                ))
            }
            "utf8_byte_length" => Ok(IslConstraintValue::Utf8ByteLength(
                UsizeRange::from_ion_element(value, Element::as_usize)?,
            )),
            "valid_values" => Ok(IslConstraintValue::ValidValues(
                IslValidValuesConstraint::from_ion_element(value, isl_version)?,
            )),
            _ => Ok(IslConstraintValue::Unknown(
                constraint_name.to_string(),
                value.to_owned(),
            )),
        }
    }

    // helper method for from_ion_element to get isl type references from given ion element
    fn isl_type_references_from_ion_element(
        isl_version: IslVersion,
        value: &Element,
        inline_imported_types: &mut Vec<IslImportType>,
        constraint_name: &str,
    ) -> IonSchemaResult<Vec<IslTypeRef>> {
        //TODO: create a method/macro for this ion type check which can be reused
        if value.is_null() {
            return invalid_schema_error(format!(
                "{constraint_name} constraint was a null instead of a list"
            ));
        }
        if value.ion_type() != IonType::List {
            return invalid_schema_error(format!(
                "{} constraint was a {:?} instead of a list",
                constraint_name,
                value.ion_type()
            ));
        }
        value
            .as_sequence()
            .unwrap()
            .elements()
            .map(|e| IslTypeRef::from_ion_element(isl_version, e, inline_imported_types))
            .collect::<IonSchemaResult<Vec<IslTypeRef>>>()
    }

    // helper method for from_ion_element to get isl fields from given ion element
    fn isl_fields_from_ion_element(
        isl_version: IslVersion,
        value: &Element,
        inline_imported_types: &mut Vec<IslImportType>,
    ) -> IonSchemaResult<HashMap<String, IslVariablyOccurringTypeRef>> {
        if value.is_null() {
            return invalid_schema_error("fields constraint was a null instead of a struct");
        }

        if value.ion_type() != IonType::Struct {
            return invalid_schema_error(format!(
                "fields constraint was a {:?} instead of a struct",
                value.ion_type()
            ));
        }

        let fields_map = value
            .as_struct()
            .unwrap()
            .iter()
            .map(|(f, v)| {
                IslVariablyOccurringTypeRef::from_ion_element(
                    "fields",
                    isl_version,
                    v,
                    inline_imported_types,
                )
                .map(|t| (f.text().unwrap().to_owned(), t))
            })
            .collect::<IonSchemaResult<HashMap<String, IslVariablyOccurringTypeRef>>>()?;

        // verify the map length with struct length to check for duplicates
        if fields_map.len() < value.as_struct().unwrap().len() {
            return invalid_schema_error("fields must be a struct with no repeated field names");
        }

        Ok(fields_map)
    }

    pub(crate) fn field_name(&self) -> &str {
        match self {
            IslConstraintValue::AllOf(_) => "all_of",
            IslConstraintValue::Annotations(_) => "annotations",
            IslConstraintValue::AnyOf(_) => "any_of",
            IslConstraintValue::ByteLength(_) => "byte_length",
            IslConstraintValue::CodepointLength(_) => "codepoint_length",
            IslConstraintValue::Contains(_) => "contains",
            IslConstraintValue::ContentClosed => "content",
            IslConstraintValue::ContainerLength(_) => "container_length",
            IslConstraintValue::Element(_, _) => "element",
            IslConstraintValue::Exponent(_) => "exponent",
            IslConstraintValue::Fields(_, _) => "fields",
            IslConstraintValue::FieldNames(_, _) => "field_names",
            IslConstraintValue::Ieee754Float(_) => "ieee754_float",
            IslConstraintValue::Not(_) => "not",
            IslConstraintValue::OneOf(_) => "one_of",
            IslConstraintValue::OrderedElements(_) => "ordered_elements",
            IslConstraintValue::Precision(_) => "precision",
            IslConstraintValue::Regex(_) => "regex",
            IslConstraintValue::Scale(_) => "scale",
            IslConstraintValue::TimestampOffset(_) => "timestamp_offset",
            IslConstraintValue::TimestampPrecision(_) => "timestamp_precision",
            IslConstraintValue::Type(_) => "type",
            IslConstraintValue::Unknown(field_name, _) => field_name.as_str(),
            IslConstraintValue::Utf8ByteLength(_) => "utf8_byte_length",
            IslConstraintValue::ValidValues(_) => "valid_values",
        }
    }
}

impl WriteAsIon for IslConstraintValue {
    fn write_as_ion<V: ValueWriter>(&self, writer: V) -> IonResult<()> {
        match self {
            IslConstraintValue::AllOf(type_refs) => writer.write(type_refs),
            IslConstraintValue::Annotations(annotations) => writer.write(annotations),
            IslConstraintValue::AnyOf(type_refs) => writer.write(type_refs),
            IslConstraintValue::ByteLength(range) => writer.write(range),
            IslConstraintValue::CodepointLength(range) => writer.write(range),
            IslConstraintValue::Contains(elements) => {
                let mut list_writer = writer.list_writer()?;
                for element in elements {
                    list_writer.write(element)?;
                }
                list_writer.close()
            }
            IslConstraintValue::ContentClosed => writer.write_symbol("closed"),
            IslConstraintValue::ContainerLength(range) => writer.write(range),
            IslConstraintValue::Element(type_ref, is_distinct) => {
                if *is_distinct {
                    writer.with_annotations(["distinct"])?.write(type_ref)
                } else {
                    writer.write(type_ref)
                }
            }
            IslConstraintValue::Exponent(range) => writer.write(range),
            IslConstraintValue::Fields(fields, content_closed) => {
                let annotations: &[&'static str] = if *content_closed { &["closed"] } else { &[] };
                let mut struct_writer = writer.with_annotations(annotations)?.struct_writer()?;
                for (field_name, type_ref) in fields.iter() {
                    struct_writer.write(field_name.as_str(), type_ref)?;
                }
                struct_writer.close()
            }
            IslConstraintValue::FieldNames(type_ref, is_distinct) => {
                if *is_distinct {
                    writer.with_annotations(["distinct"])?.write(type_ref)
                } else {
                    writer.write(type_ref)
                }
            }
            IslConstraintValue::Ieee754Float(format) => writer.write(format),
            IslConstraintValue::Not(type_ref) => writer.write(type_ref),
            IslConstraintValue::OneOf(type_refs) => writer.write(type_refs),
            IslConstraintValue::OrderedElements(type_refs) => writer.write(type_refs),
            IslConstraintValue::Precision(range) => writer.write(range),
            IslConstraintValue::Regex(regex) => writer.write(regex),
            IslConstraintValue::Scale(range) => writer.write(range),
            IslConstraintValue::TimestampOffset(timestamp_offset) => writer.write(timestamp_offset),
            IslConstraintValue::TimestampPrecision(range) => writer.write(range),
            IslConstraintValue::Type(type_ref) => writer.write(type_ref),
            IslConstraintValue::Unknown(field_name, value) => writer.write(value),
            IslConstraintValue::Utf8ByteLength(range) => writer.write(range),
            IslConstraintValue::ValidValues(valid_values) => writer.write(valid_values),
        }
    }
}

/// Represents the [annotations] constraint
///
/// [annotations]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#annotations
#[derive(Debug, Clone, PartialEq)]
pub enum IslAnnotationsConstraint {
    SimpleAnnotations(IslSimpleAnnotationsConstraint),
    StandardAnnotations(IslTypeRef),
}

impl WriteAsIon for IslAnnotationsConstraint {
    fn write_as_ion<V: ValueWriter>(&self, writer: V) -> IonResult<()> {
        match self {
            IslAnnotationsConstraint::SimpleAnnotations(ann) => writer.write(ann),
            IslAnnotationsConstraint::StandardAnnotations(ann) => writer.write(ann),
        }
    }
}

/// Represents the [simple syntax] for annotations constraint
/// ```ion
/// Grammar: <ANNOTATIONS> ::= annotations: <ANNOTATIONS_MODIFIER>... [ <SYMBOL>... ]
///          <ANNOTATIONS_MODIFIER> ::= required::
///                                   | closed::
/// ```
///
/// [simple syntax]: https://amazon-ion.github.io/ion-schema/docs/isl-2-0/spec#simple-syntax
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IslSimpleAnnotationsConstraint {
    pub is_closed: bool,
    pub is_ordered: bool,
    pub is_required: bool,
    pub annotations: Vec<Annotation>,
}

impl IslSimpleAnnotationsConstraint {
    pub fn new(
        is_closed: bool,
        is_ordered: bool,
        is_required: bool,
        annotations: Vec<Annotation>,
    ) -> Self {
        Self {
            is_closed,
            is_ordered,
            is_required,
            annotations,
        }
    }

    pub(crate) fn from_ion_element(
        value: &Element,
        isl_version: IslVersion,
    ) -> IonSchemaResult<Self> {
        let annotation_modifiers: Vec<&str> = value
            .annotations()
            .iter()
            .map(|sym| sym.text().unwrap())
            .collect();

        if (annotation_modifiers
            .iter()
            .any(|a| a != &"closed" && a != &"required")
            || annotation_modifiers.is_empty())
            && isl_version == IslVersion::V2_0
        {
            return invalid_schema_error(
                "annotations constraint must only be annotated with 'required' or 'closed' annotation",
            );
        }

        let annotations: Vec<Annotation> = value
            .as_sequence()
            .unwrap()
            .elements()
            .map(|e| {
                if !e.annotations().is_empty() && isl_version == IslVersion::V2_0 {
                    return invalid_schema_error(
                        "annotations constraint must only contain symbols without any annotations",
                    );
                }
                e.as_symbol()
                    .map(|s| {
                        Annotation::new(
                            s.text().unwrap().to_owned(),
                            Annotation::is_annotation_required(
                                e,
                                annotation_modifiers.contains(&"required"),
                            ),
                            isl_version,
                        )
                    })
                    .ok_or(invalid_schema_error_raw(
                        "annotations constraint must only contain symbols",
                    ))
            })
            .collect::<IonSchemaResult<Vec<Annotation>>>()?;

        Ok(IslSimpleAnnotationsConstraint::new(
            annotation_modifiers.contains(&"closed"),
            annotation_modifiers.contains(&"ordered"),
            annotation_modifiers.contains(&"required"),
            annotations,
        ))
    }

    pub(crate) fn convert_to_type_reference(&self) -> IonSchemaResult<IslTypeRef> {
        let mut isl_constraints = vec![];
        if self.is_closed {
            isl_constraints.push(isl::isl_constraint::v_2_0::element(
                isl::isl_type_reference::v_2_0::anonymous_type_ref(vec![
                    isl::isl_constraint::v_2_0::valid_values(
                        self.annotations
                            .iter()
                            .map(|a| ValidValue::Element(Value::Symbol(a.value().into())))
                            .collect(),
                    )?,
                ]),
                false,
            ));
        }

        if self.is_required {
            isl_constraints.push(isl::isl_constraint::v_2_0::contains(
                self.annotations
                    .iter()
                    .map(|a| Element::symbol(a.value()))
                    .collect::<Vec<Element>>(),
            ))
        }

        Ok(isl::isl_type_reference::v_2_0::anonymous_type_ref(
            isl_constraints,
        ))
    }
}

impl WriteAsIon for IslSimpleAnnotationsConstraint {
    fn write_as_ion<V: ValueWriter>(&self, writer: V) -> IonResult<()> {
        let mut annotation_modifiers = vec![];
        if self.is_ordered {
            annotation_modifiers.push("ordered");
        }
        if self.is_closed {
            annotation_modifiers.push("closed");
        }
        if self.is_required {
            annotation_modifiers.push("required");
        }
        writer
            .with_annotations(annotation_modifiers)?
            .write(&self.annotations)
    }
}

/// Represents the [valid_values] constraint
///
/// [valid_values]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#annotations
#[derive(Debug, Clone, PartialEq)]
pub struct IslValidValuesConstraint {
    pub(crate) valid_values: Vec<ValidValue>,
}

impl IslValidValuesConstraint {
    /// Provides a way to programmatically construct valid_values constraint
    pub fn new(valid_values: Vec<ValidValue>) -> IonSchemaResult<Self> {
        Ok(Self { valid_values })
    }

    pub fn values(&self) -> &Vec<ValidValue> {
        &self.valid_values
    }

    pub fn from_ion_element(value: &Element, isl_version: IslVersion) -> IonSchemaResult<Self> {
        let valid_values = if value.annotations().contains("range") {
            vec![ValidValue::from_ion_element(value, isl_version)?]
        } else {
            isl_require!(value.ion_type() == IonType::List && !value.is_null() => "Expected a list of valid values; found: {value}")?;
            let valid_values: Result<Vec<_>, _> = value
                .as_sequence()
                .unwrap()
                .elements()
                .map(|e| ValidValue::from_ion_element(e, isl_version))
                .collect();
            valid_values?
        };
        IslValidValuesConstraint::new(valid_values)
    }
}

impl WriteAsIon for IslValidValuesConstraint {
    fn write_as_ion<V: ValueWriter>(&self, writer: V) -> IonResult<()> {
        let mut list_writer = writer.list_writer()?;
        for vv in self.values() {
            list_writer.write(vv)?;
        }
        list_writer.close()
    }
}

/// Represents the [regex] constraint
///
/// [regex]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#regex
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IslRegexConstraint {
    case_insensitive: bool,
    multi_line: bool,
    expression: String,
}

impl IslRegexConstraint {
    pub(crate) fn new(case_insensitive: bool, multi_line: bool, expression: String) -> Self {
        Self {
            case_insensitive,
            multi_line,
            expression,
        }
    }

    pub fn expression(&self) -> &String {
        &self.expression
    }

    pub fn case_insensitive(&self) -> bool {
        self.case_insensitive
    }

    pub fn multi_line(&self) -> bool {
        self.multi_line
    }
}

impl WriteAsIon for IslRegexConstraint {
    fn write_as_ion<V: ValueWriter>(&self, writer: V) -> IonResult<()> {
        let mut regex_modifiers = vec![];
        if self.case_insensitive {
            regex_modifiers.push("i");
        }
        if self.multi_line {
            regex_modifiers.push("m");
        }
        writer
            .with_annotations(regex_modifiers)?
            .write_string(&self.expression)
    }
}

/// Represents the [timestamp_offset] constraint
///
/// [timestamp_offset]: https://amazon-ion.github.io/ion-schema/docs/isl-1-0/spec#timestamp_offset
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IslTimestampOffsetConstraint {
    valid_offsets: Vec<TimestampOffset>,
}

impl IslTimestampOffsetConstraint {
    pub(crate) fn new(valid_offsets: Vec<TimestampOffset>) -> Self {
        Self { valid_offsets }
    }

    pub fn valid_offsets(&self) -> &[TimestampOffset] {
        &self.valid_offsets
    }
}

impl WriteAsIon for IslTimestampOffsetConstraint {
    fn write_as_ion<V: ValueWriter>(&self, writer: V) -> IonResult<()> {
        let mut list_writer = writer.list_writer()?;
        for timestamp_offset in &self.valid_offsets {
            list_writer.write(timestamp_offset)?;
        }
        list_writer.close()
    }
}