schema.graphql

type ActivityLineItem {
  description: String!
  createdAt: DateTime!
}

type ActivityLineItemEdge {
  cursor: String!
  node: ActivityLineItem!
}

type ActivityLineItemConnection {
  edges: [ActivityLineItemEdge]
  pageInfo: PageInfo!
}

type Alert {
  text: String!
  type: AlertType!
  id: String!
}

interface Alertable {
  alerts: [Alert!]!
}

enum AlertType {
  SUCCESS
  WARN
  ERROR
}

scalar Color

input CreateGithubSessionInput {
  clientMutationId: String
  githubAvatarUrl: String!
  githubUsername: String!
  name: String!
  primaryEmail: String!
  serverSecret: String!
}

input CreateGoogleSessionInput {
  clientMutationId: String
  googleAvatarUrl: String!
  googleProfileId: String!
  name: String!
  primaryEmail: String!
  serverSecret: String!
}

type CreateSessionPayload implements Alertable {
  alerts: [Alert!]!
  userEdge: UserEdge
  sessionEdge: SessionEdge
}

scalar DateTime

input DeleteAccountInput {
  clientMutationId: String
  userId: ID!
}

type DeleteAccountPayload implements Alertable {
  alerts: [Alert!]!
  clientMutationId: String
  deletedUserId: ID!
}

input DeleteLinkInput {
  clientMutationId: String
  linkId: String!
  repoId: String!
}

type DeleteLinkPayload {
  clientMutationId: String
  deletedLinkId: String
}

input DeleteSessionInput {
  clientMutationId: String
  sessionId: ID!
}

type DeleteSessionPayload {
  clientMutationId: String
  deletedSessionId: ID
}

input DeleteTopicInput {
  clientMutationId: String
  repoId: String!
  topicId: String!
}

type DeleteTopicPayload {
  clientMutationId: String
  deletedTopicId: String
}

type Link @fetchable(field_name: "id") {
  displayParentTopics(
    first: Int,
    after: String,
    last: Int,
    before: String
  ): TopicConnection!
  displayTitle: String!
  displayUrl: String!
  id: String!
  loading: Boolean!
  newlyAdded: Boolean!
  repoLink(repoId: ID!): RepoLink
  repoLinks: [RepoLink!]!
  sha1: String!
  showRepoOwnership: Boolean!
  viewerCanUpdate: Boolean!
}

type LinkEdge {
  cursor: String!
  node: Link!
}

type LinkConnection {
  edges: [LinkEdge]
  pageInfo: PageInfo!
  totalCount: Int!
}

type LiveSearchTopicsPayload {
  synonyms: [SynonymEntry!]!
}

enum LocaleIdentifier {
  ar
  de
  el
  en
  es
  fa
  fi
  fr
  hi
  it
  ja
  ji
  ko
  la
  nl
  no
  pt
  ru
  sv
  tr
  uk
  zh
}

input RemoveTopicTimerangeInput {
  clientMutationId: String
  repoId: String!
  topicId: String!
}

type RemoveTopicTimerangePayload {
  clientMutationId: String
  updatedRepoTopic: RepoTopic!
  updatedTopic: Topic!
}

type RepoLink {
  availableParentTopics(
    searchString: String,
  ): LiveSearchTopicsPayload!
  createdAt: DateTime!
  # details might be null if the link is a reference to a link in another repo and the details have
  # not been overridden
  details: RepoLinkDetails
  displayColor: Color!
  inWikiRepo: Boolean!
  link: Link!
  linkId: ID!
  parentTopics(
    first: Int,
    after: String,
    last: Int,
    before: String
  ): TopicConnection!
  repo: Repository!
  updatedAt: DateTime!
  viewerCanUpdate: Boolean!
}

type RepoLinkDetails {
  title: String!
  url: String!
}

type SynonymEntry {
  displayName: String!
  id: String!
}

type Mutation {
  createGithubSession(input: CreateGithubSessionInput!): CreateSessionPayload
  createGoogleSession(input: CreateGoogleSessionInput!): CreateSessionPayload
  deleteAccount(input: DeleteAccountInput!): DeleteAccountPayload
  deleteLink(input: DeleteLinkInput!): DeleteLinkPayload
  deleteSession(input: DeleteSessionInput!): DeleteSessionPayload
  deleteTopic(input: DeleteTopicInput!): DeleteTopicPayload
  removeTopicTimerange(input: RemoveTopicTimerangeInput!): RemoveTopicTimerangePayload
  selectRepository(input: SelectRepositoryInput!): SelectRepositoryPayload
  updateLinkParentTopics(input: UpdateLinkParentTopicsInput!): UpdateLinkParentTopicsPayload
  updateTopicParentTopics(input: UpdateTopicParentTopicsInput!): UpdateTopicParentTopicsPayload
  updateTopicSynonyms(input: UpdateTopicSynonymsInput!): UpdateTopicSynonymsPayload
  upsertLink(input: UpsertLinkInput!): UpsertLinkPayload
  upsertTopic(input: UpsertTopicInput!): UpsertTopicPayload
  upsertTopicTimerange(input: UpsertTopicTimerangeInput!): UpsertTopicTimerangePayload
}

enum OnMatchingSynonym {
  ASK
  CREATE_DISTINCT
  UPDATE
}

type Organization {
  createdAt: DateTime!
  defaultRepository: Repository!
  id: ID
  login: String!
  name: String!
  public: Boolean!
  updatedAt: DateTime!
}

type PageInfo {
  hasNextPage: Boolean!
  hasPreviousPage: Boolean!
  startCursor: String
  endCursor: String
}

type QueryInfo {
  topics: [Topic!]!
  phrases: [String!]!
}

type Query {
  # Workaround for Relay Modern weirdness
  alerts: [Alert!]!
  fakeError: String
  view(
    repoIds: [ID!],
    searchString: String,
    viewerId: ID!
  ): View!
}

input ReorderSynonymsInput {
  clientMutationId: String
  synonymIds: [ID!]!
  topicId: String!
}

type ReorderSynonymsPayload {
  clientMutationId: String
}

type Repository {
  displayColor: Color!
  displayName: String!
  fullName: String!
  id: String
  isPrivate: Boolean!
  name: String!
  organization: Organization!
  owner: User!
  rootTopic: Topic!
}

type RepositoryConnection {
  edges: [RepositoryEdge]
}

type RepositoryEdge {
  cursor: String!
  node: Repository!
  isSelected: Boolean!
}

type RepoTopic @fetchable(field_name: "repoId") {
  availableParentTopics(
    searchString: String,
  ): LiveSearchTopicsPayload!
  color: Color!
  createdAt: DateTime!
  details: RepoTopicDetails
  displayColor: Color!
  displayName: String!
  id: String!
  inWikiRepo: Boolean!
  parentTopics(
    first: Int,
    after: String,
    last: Int,
    before: String
  ): TopicConnection!
  repo: Repository!
  repoId: ID!
  timerangePrefix: String!
  topicId: String!
  updatedAt: DateTime!
  viewerCanDeleteSynonyms: Boolean!
  viewerCanUpdate: Boolean!
}

type RepoTopicDetails {
  synonyms: [Synonym!]!
  timerange: Timerange
}

input SelectRepositoryInput {
  clientMutationId: String
  currentTopicId: ID
  repoId: ID
}

type SelectRepositoryPayload {
  currentTopic: Topic
  repo: Repository
  viewer: User!
}

type Synonym {
  locale: LocaleIdentifier!
  name: String!
}

union SearchMatch = Topic | Link

type SearchMatchEdge {
  cursor: String!
  node: SearchMatch!
}

type SearchResultConnection {
  edges: [SearchMatchEdge]
  pageInfo: PageInfo!
}

enum TimerangePrefixFormat {
  NONE
  START_YEAR
  START_YEAR_MONTH
}

type Topic {
  activity(
    first: Int,
    after: String,
    last: Int,
    before: String
  ): ActivityLineItemConnection!
  children(
    searchString: String,
    first: Int,
    after: String,
    last: Int,
    before: String
  ): SearchResultConnection!
  repoTopic(repoId: ID!): RepoTopic
  repoTopics: [RepoTopic!]!
  displayName: String!
  displayParentTopics(
    first: Int,
    after: String,
    last: Int,
    before: String
  ): TopicConnection!
  displaySynonyms: [Synonym!]!
  displayTimerange: Timerange
  id: String!
  loading: Boolean!
  newlyAdded: Boolean!
  showRepoOwnership: Boolean!
  viewerCanUpdate: Boolean!
}

type Timerange {
  startsAt: DateTime!
  endsAt: DateTime
  prefixFormat: TimerangePrefixFormat!
}

type TopicEdge {
  cursor: String!
  node: Topic!
}

type TimerangeEdge {
  cursor: String!
  node: Timerange!
}

type TopicConnection {
  edges: [TopicEdge]
  pageInfo: PageInfo!
}

type User {
  avatarUrl: String!
  createdAt: DateTime!
  defaultRepo: Repository
  id: ID
  isGuest: Boolean!
  name: String!
  primaryEmail: String!
  repos(
    first: Int,
    after: String,
    last: Int,
    before: String
  ): RepositoryConnection!
  selectedRepo: Repository
  selectedRepoId: ID
  updatedAt: DateTime!
}

type UserEdge {
  cursor: String!
  node: User!
}

type Session {
  id: ID!
}

type SessionEdge {
  cursor: String!
  node: Session!
}

input SynonymInput {
  name: String!
  locale: String!
}

input UpdateTopicSynonymsInput {
  clientMutationId: String
  repoId: String!
  synonyms: [SynonymInput!]!
  topicId: String!
}

type UpdateTopicSynonymsPayload {
  alerts: [Alert!]!
  clientMutationId: String
  updatedRepoTopic: RepoTopic!
  updatedTopic: Topic!
}

input UpdateLinkParentTopicsInput {
  clientMutationId: String
  linkId: String!
  parentTopicIds: [String!]
  repoId: String!
}

type UpdateLinkParentTopicsPayload {
  link: Link!
}

input UpdateTopicParentTopicsInput {
  clientMutationId: String
  repoId: String!,
  topicId: String!
  parentTopicIds: [String!]
}

type UpdateTopicParentTopicsPayload implements Alertable {
  alerts: [Alert!]!
  topic: Topic!
}

input UpsertLinkInput {
  # This mutation is used in two contexts:
  #   - Updating a link that is known to exist.  Pass no parent topics in order to keep the existing
  #     ones.
  #   - Upserting a link that might exist.  Pass the topic under which the link is being upserted.
  # TODO: Refactor so that there's an UpsertLink mutation, which requires at least one topic, and an
  # UpdateLink mutation, which has a required link id field and doesn't modify the parent topics.
  addParentTopicId: String
  clientMutationId: String
  linkId: String
  repoId: String!
  title: String
  url: String!
}

type UpsertLinkPayload implements Alertable {
  alerts: [Alert!]!
  linkEdge: LinkEdge
}

input UpsertTopicInput {
  clientMutationId: String
  description: String
  name: String!
  onMatchingSynonym: OnMatchingSynonym!
  parentTopicId: String!
  repoId: String!
  updateTopicId: String,
}

input UpsertTopicTimerangeInput {
  clientMutationId: String
  endsAt: DateTime
  prefixFormat: TimerangePrefixFormat!
  repoId: String!
  startsAt: DateTime!
  topicId: String!
}

type UpsertTopicPayload implements Alertable {
  alerts: [Alert!]!
  topicEdge: TopicEdge
  matchingTopics: [Topic!]!
  updatedParentTopic: Topic!
}

type UpsertTopicTimerangePayload implements Alertable {
  alerts: [Alert!]!
  timerangeEdge: TimerangeEdge
  updatedRepoTopic: RepoTopic!
  updatedTopic: Topic!
}

type ViewStats {
  calculating: Boolean!
  linkCount: Int
  topicCount: Int
}

type View {
  activity(
    first: Int,
    after: String,
    last: Int,
    before: String
    topicId: String,
  ): ActivityLineItemConnection!
  currentRepository: Repository
  defaultOrganization: Organization!
  link(id: ID!): Link
  links(
    searchString: String,
    first: Int,
    after: String,
    last: Int,
    before: String,
  ): LinkConnection!
  queryInfo: QueryInfo!
  searchString: String
  stats: ViewStats!
  topic(id: ID!): Topic
  topicGraph: String
  topicLiveSearch(
    searchString: String,
  ): LiveSearchTopicsPayload!
  viewer: User!
}