jsoncompare

type ComparisonResult struct {
	// AreEquivalent indicates if the inputs are considered equal based on the comparison rules.
	AreEquivalent bool
	// Diff provides details if the content differs.
	Diff string
	// IsJSON indicates if the comparison was successfully performed on JSON structures.
	IsJSON bool
	// NormalizedA and NormalizedB are included for enhanced debuggability (only populated if IsJSON is true).
	NormalizedA interface{}
	NormalizedB interface{}
}

type HeuristicRules struct {
	// KeyPatterns identifies map keys that are likely dynamic (e.g., "session_id").
	KeyPatterns []*regexp.Regexp
	// CheckValueForUUID enables detection of UUIDs in string values.
	CheckValueForUUID bool
	// CheckValueForTimestamp enables detection of timestamps (strings or numbers).
	CheckValueForTimestamp bool
	// TimestampFormats defines the layouts to try when parsing string timestamps.
	TimestampFormats []string
	// CheckValueForHighEntropy enables detection of high-entropy strings (e.g., tokens).
	CheckValueForHighEntropy bool
	// EntropyThreshold defines the minimum Shannon entropy to classify a string as dynamic.
	EntropyThreshold float64
}

type JSONComparison interface {
	// Compare performs a semantic comparison of two byte arrays using the service's default options.
	// It handles both JSON and non-JSON content gracefully.
	Compare(bodyA, bodyB []byte) (*ComparisonResult, error)

	// CompareWithOptions performs a semantic comparison using the specified options.
	CompareWithOptions(bodyA, bodyB []byte, opts Options) (*ComparisonResult, error)
}

type Options struct {
	// Rules define how dynamic data (Timestamps, UUIDs, etc.) is identified and normalized.
	Rules HeuristicRules

	// IgnoreArrayOrder enables order-agnostic comparison of arrays.
	IgnoreArrayOrder bool
	// EquateEmpty treats nil (JSON null) and empty slices/maps ({}, []) as equal.
	EquateEmpty bool

	// SpecificValuesToIgnore forces normalization of specific string or numeric values.
	SpecificValuesToIgnore map[string]struct{}
	// NormalizeAllValuesForStructure normalizes all primitive values (leaf nodes)
	// to focus purely on the structural equivalence (keys, nesting).
	NormalizeAllValuesForStructure bool
}