initial pass at status support

graph/typeDefs.graphql

@@ -64,8 +64,99 @@ type UserProfile {
   provider: String!
 }
 
-type SuspensionInfo {
+# USER_STATUS_USERNAME is the different states that a username can be in.
+enum USER_STATUS_USERNAME {
+  # UNSET is used when the username can be changed, and does not necessarily
+  # require moderator action to become active. This can be used when the user
+  # signs up with a social login and has the option of setting their own
+  # username.
+  UNSET
+
+  # SET is used when the username has been set for the first time, but cannot
+  # change without the username being rejected by a moderator and that moderator
+  # agreeing that the username should be allowed to change.
+  SET
+
+  # APPROVED is used when the username was changed, and subsequently approved by
+  # said moderator.
+  APPROVED
+
+  # REJECTED is used when the username was changed, and subsequently rejected by
+  # said moderator.
+  REJECTED
+
+  # CHANGED is used after a user has changed their username after it was
+  # rejected.
+  CHANGED
+}
+
+# UserStatusInput describes the queryable components of the UserStatus.
+input UserStatusInput {
+  # username will restrict the returned users to only those with the given
+  # username status's. If not provided, no filtering will be performed.
+  username: [USER_STATUS_USERNAME!]
+
+  # banned will restrict the returned users to only those that are, or are not
+  # banned. If not provided, no filtering will be performed.
+  banned: Boolean
+
+  # suspended will restrict the returned users to only those that are, or are not
+  # suspended. If not provided, no filtering will be performed.
+  suspended: Boolean
+}
+
+type UsernameStatusHistory {
+  status: USER_STATUS_USERNAME!
+  assigned_by: User
+  created_at: Date!
+}
+
+type UsernameStatus {
+  status: USER_STATUS_USERNAME!
+  history: [UsernameStatusHistory!]
+}
+
+type BannedStatusHistory {
+  status: Boolean!
+  assigned_by: User
+  created_at: Date!
+}
+
+type BannedStatus {
+  status: Boolean!
+  history: [BannedStatusHistory!]
+}
+
+type SuspensionStatusHistory {
   until: Date
+  assigned_by: User
+  created_at: Date!
+}
+
+type SuspensionStatus {
+  until: Date
+  history: [SuspensionStatusHistory!]
+}
+
+type UserStatus {
+  # username is the status of the username.
+  username: UsernameStatus!
+
+  # banned is the bool that determines if the user is banned or not.
+  banned: BannedStatus!
+
+  # suspension is the date that the user is suspended until.
+  suspension: SuspensionStatus!
+}
+
+input UserStateInput {
+  status: UserStatusInput
+}
+
+# UserState describes the different permission based details for a user.
+type UserState {
+  # status describes the statuses of different aspects of the user's details.
+  status: UserStatus
 }
 
 # Any person who can author comments, create actions, and view comments on a
@@ -114,11 +205,7 @@ type User {
   reliable: Reliability
 
   # returns user status
-  status: USER_STATUS
-
-  # returns suspension info. Only available to Admins and Moderators
-  # or on own logged in User.
-  suspension: SuspensionInfo
+  state: UserState
 }
 
 # UserConnection represents a paginable subset of a user list.
@@ -143,8 +230,7 @@ input UsersQuery {
   # Users returned will only be ones which have at least one action of this.
   action_type: ACTION_TYPE
 
-  # Current status of a user..
-  statuses: [USER_STATUS!]
+  state: UserStateInput
 
   # Limit the number of results to be returned.
   limit: Int = 10
@@ -261,7 +347,7 @@ enum ACTION_TYPE {
 # CommentsQuery allows the ability to query comments by a specific methods.
 input CommentsQuery {
 
-  # Author of the commente
+  # Author of the comments.
   author_id: ID
 
   # Current status of a comment.
@@ -351,8 +437,8 @@ input UserCountQuery {
   # type.
   action_type: ACTION_TYPE
 
-  # Current status of a user.
-  statuses: [USER_STATUS]
+  # state queries for a specific subset of users with the given state query.
+  state: UserStateInput
 }
 
 type EditInfo {
@@ -810,14 +896,6 @@ enum SORT_COMMENTS_BY {
   REPLIES
 }
 
-# All queries that can be executed.
-enum USER_STATUS {
-  ACTIVE
-  BANNED
-  PENDING
-  APPROVED
-}
-
 # Metrics for the assets.
 enum ASSET_METRICS_SORT {
 
@@ -995,26 +1073,13 @@ input CreateDontAgreeInput {
 }
 
 # Input for suspendUser mutation.
-input SuspendUserInput {
+input SetUserSuspensionStatusInput {
 
   # id of target user.
   id: ID!
 
-  # message to be sent to the user.
-  message: String!
-
   # target user will be suspended until this date.
-  until: Date!
-}
-
-# Input for rejectUsername mutation.
-input RejectUsernameInput {
-
-  # id of target user.
-  id: ID!
-
-  # message to be sent to the user.
-  message: String!
+  until: Date
 }
 
 # Configurable settings that can be overridden for the Asset. You must specify
@@ -1027,7 +1092,7 @@ input AssetSettingsInput {
   # moderation is the moderation mode for the asset.
   moderation: MODERATION_MODE
 
-  # questionBoxEnable will enable the Question Boxs' content to be visable above
+  # questionBoxEnable will enable the Question Boxs' content to be visible above
   # the comment box.
   questionBoxEnable: Boolean
 
@@ -1075,17 +1140,9 @@ type DeleteActionResponse implements Response {
   errors: [UserError!]
 }
 
-# SetUserStatusResponse is the response returned with possibly some errors
-# relating to the delete action attempt.
-type SetUserStatusResponse implements Response {
-
-  # An array of errors relating to the mutation that occurred.
-  errors: [UserError!]
-}
-
-# SuspendUserResponse is the response returned with possibly some errors
-# relating to the suspend action attempt.
-type SuspendUserResponse implements Response {
+# SetUserSuspensionStatusResponse is the response returned with possibly some
+# errors relating to the suspend action attempt.
+type SetUserSuspensionStatusResponse implements Response {
 
   # An array of errors relating to the mutation that occurred.
   errors: [UserError!]
@@ -1218,7 +1275,7 @@ input UpdateSettingsInput {
   # comment is posted that it can still be edited by the author.
   editCommentWindowLength: Int
 
-  # wordlist allows chaninging the available wordlists.
+  # wordlist allows changing the available wordlists.
   wordlist: UpdateWordlistInput
 
   # domains allows changing the available lists of domains.
@@ -1281,6 +1338,29 @@ type RevokeTokenResponse implements Response {
   errors: [UserError!]
 }
 
+# SetUserBanStatusInput contains the input to change the ban status of a given
+# user.
+input SetUserBanStatusInput {
+
+  # id is the user to set the ban status on.
+  id: ID!
+
+  # status is the ban status to set on the target user.
+  status: Boolean!
+}
+
+type SetUserBanStatusResponse implements Response {
+
+  # An array of errors relating to the mutation that occurred.
+  errors: [UserError!]
+}
+
+type SetUsernameStatusResponse implements Response {
+
+  # An array of errors relating to the mutation that occurred.
+  errors: [UserError!]
+}
+
 # All mutations for the application are defined on this object.
 type RootMutation {
 
@@ -1299,17 +1379,21 @@ type RootMutation {
   # Edit a comment
   editComment(id: ID!, asset_id: ID!, edit: EditCommentInput): EditCommentResponse!
 
-  # Sets User status. Requires the `ADMIN` role.
+  # Sets the suspension status on a given user. Requires the `MODERATOR` role.
   # Mutation is restricted.
-  setUserStatus(id: ID!, status: USER_STATUS!): SetUserStatusResponse
+  setUserSuspensionStatus(input: SetUserSuspensionStatusInput!): SetUserSuspensionStatusResponse
 
-  # Suspends a user. Requires the `ADMIN` role.
+  # Sets the ban status on a given user. Requires the `MODERATOR` role.
   # Mutation is restricted.
-  suspendUser(input: SuspendUserInput!): SuspendUserResponse
+  setUserBanStatus(input: SetUserBanStatusInput!): SetUserBanStatusResponse
 
-  # Reject a username. Requires the `ADMIN` role.
-  # Mutation is restricted.
-  rejectUsername(input: RejectUsernameInput!): RejectUsernameResponse
+  # Sets the username status on a given user to `APPROVED`. Requires the
+  # `MODERATOR` role. Mutation is restricted.
+  approveUsername(id: ID!): SetUsernameStatusResponse
+
+  # Sets the username status on a given user to `REJECTED`. Requires the
+  # `MODERATOR` role. Mutation is restricted.
+  rejectUsername(id: ID!): SetUsernameStatusResponse
 
   # Sets Comment status. Requires the `ADMIN` role.
   # Mutation is restricted.
@@ -1327,7 +1411,7 @@ type RootMutation {
 
   # Updates the status of an asset allowing you to close/reopen an asset for
   # commenting.
-    # Mutation is restricted.
+  # Mutation is restricted.
   updateAssetStatus(id: ID!, input: UpdateAssetStatusInput!): UpdateAssetStatusResponse
 
   # updateSettings will update the global settings.