schema.graphql

# Comments/messages between voters for proposals
type Comment {
  # Message/body of the comment.
  #  This is `null` if this message is deleted.
  body: String

  # Date when the comment was published
  createdAt: ISO8601DateTime!

  # Comment ID
  id: ID!

  # A flag to indicate if the current user liked this comment
  liked: Boolean!

  # Number of user who liked this comment
  likes: Int!

  # Replies/comments about this comment
  replies(
    # Returns the elements in the list that come after the specified cursor.
    after: String

    # Returns the elements in the list that come before the specified cursor.
    before: String

    # Returns the first _n_ elements from the list.
    first: Int

    # Returns the last _n_ elements from the list.
    last: Int
  ): CommentConnection!

  # Stage/phase the comment was published
  stage: Stage!

  # Poster of this comment
  user: User!
}

# The connection type for Comment.
type CommentConnection {
  # A list of edges.
  edges: [CommentEdge]

  # A list of nodes.
  nodes: [Comment]

  # Information to aid in pagination.
  pageInfo: PageInfo!
}

# An edge in a connection.
type CommentEdge {
  # A cursor for use in pagination.
  cursor: String!

  # The item at the end of the edge.
  node: Comment
}

# An ISO 8601-encoded datetime
scalar ISO8601DateTime

type Mutation {
  # An example field added by the generator
  testField: String!
}

# Information about pagination in a connection.
type PageInfo {
  # When paginating forwards, the cursor to continue.
  endCursor: String

  # When paginating forwards, are there more items?
  hasNextPage: Boolean!

  # When paginating backwards, are there more items?
  hasPreviousPage: Boolean!

  # When paginating backwards, the cursor to continue.
  startCursor: String
}

# DAO proposals/projects to be voted and funded for
type Proposal {
  # Date when the proposal was published
  createdAt: ISO8601DateTime!

  # A flag to indicate if the current user liked this proposal
  liked: Boolean!

  # Number of user who liked this proposal
  likes: Int!

  # Eth contract address of the proposal
  proposalId: String!

  # Stage/phase the proposal is in
  stage: Stage!

  # Publisher of this proposal
  user: User!
}

type Query {
  # Proposals
  searchCommentThreads(
    # Returns the elements in the list that come after the specified cursor.
    after: String

    # Returns the elements in the list that come before the specified cursor.
    before: String

    # Search comment replies by its id.
    #
    # This is required or proposal id.
    commentId: String

    # Returns the first _n_ elements from the list.
    first: Int

    # Returns the last _n_ elements from the list.
    last: Int

    # Search proposal threads by proposal id address.
    #
    # This is required or the comment id.
    # Also this takes precedence if both exists.
    proposalId: String

    # Sorting options for the threads
    sortBy: ThreadSortBy = LATEST

    # Filter comments by stage/phase.
    #
    # If not specified, it defaults to the current stage.
    stage: Stage
  ): CommentConnection!

  # Search for proposals/projects
  searchProposals(
    # Filter proposals if it is liked or not by the current user
    liked: Boolean

    # Filter proposals by a list of proposal id addresses
    proposalIds: [String!]

    # Sorting options for the proposals
    sortBy: SortBy = DESC

    # Filter proposals by its stage/phase
    stage: Stage
  ): [Proposal!]!
}

enum SortBy {
  # Sort in ascending creation time
  ASC

  # Sort in descending creation time
  DESC
}

enum Stage {
  # Closed, finished or rejected
  ARCHIVED

  # To be voted on
  DRAFT

  # To be endorsed by a moderator
  IDEA
}

enum ThreadSortBy {
  # Sort in descending creation time
  LATEST

  # Sort in ascending creation time
  OLDEST
}

# DAO users who publish proposals and vote for them
type User {
  # Eth address of the user 
  address: String!

  # User ID
  id: ID!
}