linear-api 0.1.0

//! Typed comparators and entity filters mirroring Linear's GraphQL filter
//! inputs. These serialize into query *variables*, so the schema-validation
//! harness cannot check their field names — they were extracted from the SDL
//! by hand and pinned by snapshot tests.

use bon::Builder;
use serde::Serialize;

/// Comparator for `String` fields.
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct StringComparator {
    /// Equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq: Option<String>,
    /// Not equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq: Option<String>,
    /// Value is in the given list.
    #[serde(rename = "in", skip_serializing_if = "Option::is_none")]
    pub r#in: Option<Vec<String>>,
    /// Value is not in the given list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub nin: Option<Vec<String>>,
    /// Contains the given substring (case-sensitive).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contains: Option<String>,
    /// Does not contain the given substring.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub not_contains: Option<String>,
    /// Contains the given substring, ignoring case.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contains_ignore_case: Option<String>,
    /// Starts with the given prefix.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub starts_with: Option<String>,
    /// Ends with the given suffix.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ends_with: Option<String>,
    /// Equals, ignoring case.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq_ignore_case: Option<String>,
    /// Not equals, ignoring case.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq_ignore_case: Option<String>,
}

/// Comparator for `ID` fields.
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct IdComparator {
    /// Equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq: Option<String>,
    /// Not equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq: Option<String>,
    /// Value is in the given list.
    #[serde(rename = "in", skip_serializing_if = "Option::is_none")]
    pub r#in: Option<Vec<String>>,
    /// Value is not in the given list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub nin: Option<Vec<String>>,
}

/// Comparator for non-nullable number fields.
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct NumberComparator {
    /// Equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq: Option<f64>,
    /// Not equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq: Option<f64>,
    /// Less than.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lt: Option<f64>,
    /// Less than or equal.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lte: Option<f64>,
    /// Greater than.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gt: Option<f64>,
    /// Greater than or equal.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gte: Option<f64>,
    /// Value is in the given list.
    #[serde(rename = "in", skip_serializing_if = "Option::is_none")]
    pub r#in: Option<Vec<f64>>,
    /// Value is not in the given list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub nin: Option<Vec<f64>>,
}

/// Comparator for nullable number fields (e.g. `priority`, `estimate`).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct NullableNumberComparator {
    /// Equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq: Option<f64>,
    /// Not equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq: Option<f64>,
    /// Less than.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lt: Option<f64>,
    /// Less than or equal.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lte: Option<f64>,
    /// Greater than.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gt: Option<f64>,
    /// Greater than or equal.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gte: Option<f64>,
    /// Value is in the given list.
    #[serde(rename = "in", skip_serializing_if = "Option::is_none")]
    pub r#in: Option<Vec<f64>>,
    /// Value is not in the given list.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub nin: Option<Vec<f64>>,
    /// Whether the value is null.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub null: Option<bool>,
}

/// Comparator for date fields. Values are strings: ISO-8601 instants
/// (`"2026-07-01T00:00:00Z"`) **or** relative durations like `"-P2W"`.
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct DateComparator {
    /// Equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq: Option<String>,
    /// Not equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq: Option<String>,
    /// Before.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lt: Option<String>,
    /// Before or at.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lte: Option<String>,
    /// After.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gt: Option<String>,
    /// After or at.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub gte: Option<String>,
}

/// Comparator for boolean fields.
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct BooleanComparator {
    /// Equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq: Option<bool>,
    /// Not equals.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq: Option<bool>,
}

/// Comparator asserting the existence (or absence) of a relation.
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct RelationExistsComparator {
    /// The relation exists.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub eq: Option<bool>,
    /// The relation does not exist.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub neq: Option<bool>,
}

/// Filter for issues (`IssueFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct IssueFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<IssueFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<IssueFilter>>,
    /// Filter by title.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<StringComparator>,
    /// Filter by description.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<StringComparator>,
    /// Filter by issue number.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub number: Option<NumberComparator>,
    /// Filter by priority (0–4; nullable).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<NullableNumberComparator>,
    /// Filter by estimate (nullable).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub estimate: Option<NullableNumberComparator>,
    /// Filter by due date.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub due_date: Option<DateComparator>,
    /// Filter by creation time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<DateComparator>,
    /// Filter by last update time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<DateComparator>,
    /// Filter by completion time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub completed_at: Option<DateComparator>,
    /// Filter by workflow state.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<WorkflowStateFilter>,
    /// Filter by team.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub team: Option<TeamFilter>,
    /// Filter by assignee.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub assignee: Option<UserFilter>,
    /// Filter by creator.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub creator: Option<UserFilter>,
    /// Filter by labels.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub labels: Option<IssueLabelFilter>,
    /// Filter by project.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub project: Option<ProjectFilter>,
    /// Filter by project milestone.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub project_milestone: Option<ProjectMilestoneFilter>,
    /// Filter by parent issue.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(into)]
    pub parent: Option<Box<IssueFilter>>,
    /// Whether the issue has blocked-by relations.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_blocked_by_relations: Option<RelationExistsComparator>,
    /// Whether the issue has blocking relations.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_blocking_relations: Option<RelationExistsComparator>,
    /// Whether the issue has duplicate relations.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_duplicate_relations: Option<RelationExistsComparator>,
    /// Whether the issue has related relations.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub has_related_relations: Option<RelationExistsComparator>,
}

/// Filter for teams (`TeamFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct TeamFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<TeamFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<TeamFilter>>,
    /// Filter by team ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<IdComparator>,
    /// Filter by team key (e.g. `"ENG"`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub key: Option<StringComparator>,
    /// Filter by team name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<StringComparator>,
}

/// Filter for users (`UserFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct UserFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<UserFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<UserFilter>>,
    /// Filter by user ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<IdComparator>,
    /// Filter by full name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<StringComparator>,
    /// Filter by display name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub display_name: Option<StringComparator>,
    /// Filter by email address.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub email: Option<StringComparator>,
    /// Filter by active status.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active: Option<BooleanComparator>,
}

/// Filter for workflow states (`WorkflowStateFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct WorkflowStateFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<WorkflowStateFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<WorkflowStateFilter>>,
    /// Filter by state ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<IdComparator>,
    /// Filter by state name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<StringComparator>,
    /// Filter by state type (`"triage"`, `"backlog"`, `"unstarted"`,
    /// `"started"`, `"completed"`, `"canceled"`).
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub r#type: Option<StringComparator>,
    /// Filter by owning team.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub team: Option<TeamFilter>,
}

/// Filter for issue labels (`IssueLabelFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct IssueLabelFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<IssueLabelFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<IssueLabelFilter>>,
    /// Filter by label ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<IdComparator>,
    /// Filter by label name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<StringComparator>,
    /// Filter by owning team.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub team: Option<TeamFilter>,
    /// Filter by creator.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub creator: Option<UserFilter>,
}

/// Filter for projects (`ProjectFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ProjectFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<ProjectFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<ProjectFilter>>,
    /// Filter by project ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<IdComparator>,
    /// Filter by project name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<StringComparator>,
    /// Filter by project state.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<StringComparator>,
    /// Filter by project health (`"onTrack"`, `"atRisk"`, `"offTrack"`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub health: Option<StringComparator>,
    /// Filter by priority (nullable).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub priority: Option<NullableNumberComparator>,
    /// Filter by start date.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_date: Option<DateComparator>,
    /// Filter by target date.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_date: Option<DateComparator>,
    /// Filter by creation time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<DateComparator>,
    /// Filter by last update time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<DateComparator>,
    /// Filter by project lead.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lead: Option<UserFilter>,
}

/// Filter for project milestones (`ProjectMilestoneFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct ProjectMilestoneFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<ProjectMilestoneFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<ProjectMilestoneFilter>>,
    /// Filter by milestone ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<IdComparator>,
    /// Filter by milestone name.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<StringComparator>,
    /// Filter by target date.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_date: Option<DateComparator>,
}

/// Filter for comments (`CommentFilter` input).
#[derive(Debug, Clone, Default, Serialize, Builder)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct CommentFilter {
    /// All sub-filters must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub and: Option<Vec<CommentFilter>>,
    /// At least one sub-filter must match.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub or: Option<Vec<CommentFilter>>,
    /// Filter by comment ID.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<IdComparator>,
    /// Filter by comment body.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub body: Option<StringComparator>,
    /// Filter by author.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<UserFilter>,
    /// Filter by parent issue.
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(into)]
    pub issue: Option<Box<IssueFilter>>,
    /// Filter by creation time.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub created_at: Option<DateComparator>,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn filters_skip_unset_fields_and_rename_in() {
        let filter = IssueFilter::builder()
            .title(
                StringComparator::builder()
                    .contains("bug".to_string())
                    .build(),
            )
            .state(
                WorkflowStateFilter::builder()
                    .r#type(
                        StringComparator::builder()
                            .r#in(vec!["started".to_string(), "unstarted".to_string()])
                            .build(),
                    )
                    .build(),
            )
            .parent(IssueFilter::default())
            .build();
        let value = serde_json::to_value(&filter).unwrap();
        assert_eq!(
            value,
            serde_json::json!({
                "title": { "contains": "bug" },
                "state": { "type": { "in": ["started", "unstarted"] } },
                "parent": {},
            })
        );
    }
}