@messenger-box/platform-server 10.0.3-alpha.6 → 10.0.3-alpha.62

package/lib/graphql/schema/channel.graphql

@@ -1,139 +1,432 @@
-type Channel implements IBaseRepo {
-    id: String!
-    title: String
-    topic: String
-    orgName: String
-    purpose: String
-    description: String
-    displayName: String
-    team: AccountTeam
-    lastPostAt: DateTime
-    totalMsgCount: Int
-    totalMsgCountRoot: Int
-    creator: UserAccount
-    members: [ChannelMember]
-    type: String
-    createdAt: DateTime
-    updatedAt: DateTime
-    deletedAt: DateTime
+"""
+Channel: A communication channel within an organization or team.
+"""
+type Channel implements IBaseRepo @entity {
+    """
+    Unique identifier for the channel
+    """
+    id: String! @id
+    
+    """
+    Channel title/name
+    """
+    title: String @column
+    
+    """
+    Channel topic
+    """
+    topic: String @column
+    
+    """
+    Organization name
+    """
+    orgName: String @column
+    
+    """
+    Channel purpose
+    """
+    purpose: String @column
+    
+    """
+    Channel description
+    """
+    description: String @column
+    
+    """
+    Display name
+    """
+    displayName: String @column
+    
+    """
+    Associated team
+    """
+    team: AccountTeam @column(overrideType: "ObjectId")
+    
+    """
+    Last post timestamp
+    """
+    lastPostAt: DateTime @column(overrideType: "Date")
+    
+    """
+    Total message count
+    """
+    totalMsgCount: Int @column
+    
+    """
+    Total root message count
+    """
+    totalMsgCountRoot: Int @column
+    
+    """
+    Channel creator
+    """
+    creator: UserAccount @column(overrideType: "ObjectId")
+    
+    """
+    Channel members
+    """
+    members: [ChannelMember] @column(overrideType: "ObjectId[]")
+    
+    """
+    Channel type
+    """
+    type: String @column
+    
+    """
+    Last message in the channel
+    """
+    lastMessage: Post @column(overrideType: "ObjectId")
+    
+    """
+    Creation timestamp
+    """
+    createdAt: DateTime @column(overrideType: "Date")
+    
+    """
+    Last update timestamp
+    """
+    updatedAt: DateTime @column(overrideType: "Date")
+    
+    """
+    Deletion timestamp
+    """
+    deletedAt: DateTime @column(overrideType: "Date")
 }
 
+"""
+Channel unread message information
+"""
 type ChannelUnread {
-    teamId:           String
-    channelId:        String
-    msgCount:         Int
-    mentionCount:     Int
+    """
+    Team identifier
+    """
+    teamId: String
+    
+    """
+    Channel identifier
+    """
+    channelId: String
+    
+    """
+    Unread message count
+    """
+    msgCount: Int
+    
+    """
+    Mention count
+    """
+    mentionCount: Int
+    
+    """
+    Root mention count
+    """
     mentionCountRoot: Int
-    msgCountRoot:     Int
-    notifyProps:      AnyObject
+    
+    """
+    Root message count
+    """
+    msgCountRoot: Int
+    
+    """
+    Notification properties
+    """
+    notifyProps: AnyObject
 }
 
-
+"""
+Channel filter input for queries
+"""
 input ChannelFilterInput {
+    """
+    Filter by name
+    """
     nameFilter: String
+    
+    """
+    Filter by privacy level
+    """
     privacy: ChannelPrivacy
+    
+    """
+    Filter joined channels only
+    """
     joinedChannels: Boolean
+    
+    """
+    Sort order
+    """
     storyBy: ChannelSort
 }
 
+"""
+Channel name and direct message input
+"""
 input ChannelNameAndDirect {
+    """
+    Channel name
+    """
     name: String!
+    
+    """
+    Is direct message
+    """
     direct: Boolean!
 }
 
+"""
+Channel create request input
+"""
+input ChannelCreateRequest {
+    """
+    Channel name
+    """
+    name: String!
+    
+    """
+    Channel description
+    """
+    description: String!
+    
+    """
+    Channel type
+    """
+    type: RoomType
+    
+    """
+    Associated team
+    """
+    team: String
+}
+
+"""
+Channel update request input
+"""
+input ChannelUpdateRequest {
+    """
+    Channel ID
+    """
+    id: ID!
+    
+    """
+    Channel title
+    """
+    title: String
+    
+    """
+    Channel description
+    """
+    description: String
+    
+    """
+    Channel type
+    """
+    type: RoomType
+}
+
+"""
+Direct channel create request input
+"""
+input DirectChannelCreateRequest {
+    """
+    Receiver user IDs
+    """
+    receiver: [ID]!
+    
+    """
+    Display name
+    """
+    displayName: String!
+    
+    """
+    Channel options
+    """
+    channelOptions: AnyObject
+}
+
+"""
+Channel sorting options
+"""
 enum ChannelSort {
+    """
+    Sort by name
+    """
     NAME
+    
+    """
+    Sort by number of messages
+    """
     NUMBER_OF_MESSAGES
 }
 
+"""
+Channel privacy levels
+"""
 enum ChannelPrivacy {
+    """
+    Private channels
+    """
     PRIVATE
+    
+    """
+    Public channels
+    """
     PUBLIC
+    
+    """
+    All channels
+    """
     ALL
 }
 
+"""
+Room/Channel types
+"""
 enum RoomType {
     """
     SERVICE Channel with number of users - Only members from same organization
     """
     SERVICE
+    
     """
     Normal Channel with number of users - Only members from same organization
     """
     CHANNEL
+    
     """
     Direct User to User conversations, with two or more participants - Only members from same organization
     """
     DIRECT
+    
     """
     Channels with Private Visibility - Only members from same organization
     """
     PRIVATE
+    
     """
     Channels with Public Visibility - Members from other organizations can join
     """
     PUBLIC
 
-    #   Concept needs clarification
+    """
+    Group channels
+    """
     GROUP
+    
+    """
+    Visitor channels
+    """
     VISITOR
 }
 
 extend type Query {
+    """
+    Get channel by name
+    """
     channelByName(name: String!): Channel @addAccountContext @isAuthenticated
+    
+    """
+    Get channels with filtering
+    """
     channels(filter: ChannelFilterInput = {
         privacy: ALL,
         joinedChannels: false,
         sortyBy: NAME
     }): [Channel] @addAccountContext @isAuthenticated
+    
+    """
+    Get channels by user with criteria
+    """
     channelsByUser(
         role: String
-        criteria:AnyObject,
-        limit:Int,
-        skip:Int,
-        sort:Sort
+        criteria: AnyObject,
+        limit: Int,
+        skip: Int,
+        sort: Sort
     ): [Channel] @addAccountContext @isAuthenticated
+    
+    """
+    Get support service channels
+    """
     supportServiceChannels(
         role: String
-        criteria:AnyObject,
-        limit:Int,
-        skip:Int,
-        sort:Sort
+        criteria: AnyObject,
+        limit: Int,
+        skip: Int,
+        sort: Sort
     ): [Channel] @addAccountContext @isAuthenticated
+    
+    """
+    Get direct channel by ID
+    """
     directChannel(id: ID!): Channel @addAccountContext @isAuthenticated
+    
+    """
+    View channel detail
+    """
     viewChannelDetail(id: String): Channel @addAccountContext @isAuthenticated
-    # viewChannelDetail(id: String!): Channel @addAccountContext @isAuthenticated
 }
 
 extend type Mutation {
+    """
+    Create a new channel
+    """
     createChannel(
         name: String!,
-        description:String!
+        description: String!
         type: RoomType
         team: String
     ): Channel @addAccountContext @isAuthenticated
 
+    """
+    Add member to channel
+    """
     addMemberToChannel(
         channelId: String!,
         memberId: String!
     ): Channel @addAccountContext @isAuthenticated
 
+    """
+    Save multiple members to channel
+    """
     saveMembersToChannel(
         membersIds: [String]!
         channelId: String!,
     ): Channel @addAccountContext @isAuthenticated
 
+    """
+    Create direct message channel
+    """
     createDirectChannel(
         receiver: [ID]!
         displayName: String!
-        channelOptions:AnyObject
+        channelOptions: AnyObject
     ): Channel @addAccountContext @isAuthenticated
 
+    """
+    Hide channel from user view
+    """
     hideChannel(id: ID!): Boolean @isAuthenticated
 
+    """
+    Leave channel
+    """
     leaveChannel(id: ID!): Boolean @isAuthenticated
 
-    viewChannel(id:ID!): Boolean! @isAuthenticated @addAccountContext
+    """
+    View/mark channel as read
+    """
+    viewChannel(id: ID!): Boolean! @isAuthenticated @addAccountContext
 
+    """
+    Delete channel
+    """
     deleteChannel(id: ID!): Boolean @isAuthenticated
+    
+    """
+    Send notification of unread messages
+    """
+    sendNotificationOfUnreadMessages(
+        unit: String!
+        value: Int!
+    ): Boolean @addAccountContext @isAuthenticated
 }

package/lib/graphql/schema/channel.graphql.js

@@ -1 +1 @@
-var channelSchema = "type Channel implements IBaseRepo {\n    id: String!\n    title: String\n    topic: String\n    orgName: String\n    purpose: String\n    description: String\n    displayName: String\n    team: AccountTeam\n    lastPostAt: DateTime\n    totalMsgCount: Int\n    totalMsgCountRoot: Int\n    creator: UserAccount\n    members: [ChannelMember]\n    type: String\n    createdAt: DateTime\n    updatedAt: DateTime\n    deletedAt: DateTime\n}\n\ntype ChannelUnread {\n    teamId:           String\n    channelId:        String\n    msgCount:         Int\n    mentionCount:     Int\n    mentionCountRoot: Int\n    msgCountRoot:     Int\n    notifyProps:      AnyObject\n}\n\n\ninput ChannelFilterInput {\n    nameFilter: String\n    privacy: ChannelPrivacy\n    joinedChannels: Boolean\n    storyBy: ChannelSort\n}\n\ninput ChannelNameAndDirect {\n    name: String!\n    direct: Boolean!\n}\n\nenum ChannelSort {\n    NAME\n    NUMBER_OF_MESSAGES\n}\n\nenum ChannelPrivacy {\n    PRIVATE\n    PUBLIC\n    ALL\n}\n\nenum RoomType {\n    \"\"\"\n    SERVICE Channel with number of users - Only members from same organization\n    \"\"\"\n    SERVICE\n    \"\"\"\n    Normal Channel with number of users - Only members from same organization\n    \"\"\"\n    CHANNEL\n    \"\"\"\n    Direct User to User conversations, with two or more participants - Only members from same organization\n    \"\"\"\n    DIRECT\n    \"\"\"\n    Channels with Private Visibility - Only members from same organization\n    \"\"\"\n    PRIVATE\n    \"\"\"\n    Channels with Public Visibility - Members from other organizations can join\n    \"\"\"\n    PUBLIC\n\n    #   Concept needs clarification\n    GROUP\n    VISITOR\n}\n\nextend type Query {\n    channelByName(name: String!): Channel @addAccountContext @isAuthenticated\n    channels(filter: ChannelFilterInput = {\n        privacy: ALL,\n        joinedChannels: false,\n        sortyBy: NAME\n    }): [Channel] @addAccountContext @isAuthenticated\n    channelsByUser(\n        role: String\n        criteria:AnyObject,\n        limit:Int,\n        skip:Int,\n        sort:Sort\n    ): [Channel] @addAccountContext @isAuthenticated\n    supportServiceChannels(\n        role: String\n        criteria:AnyObject,\n        limit:Int,\n        skip:Int,\n        sort:Sort\n    ): [Channel] @addAccountContext @isAuthenticated\n    directChannel(id: ID!): Channel @addAccountContext @isAuthenticated\n    viewChannelDetail(id: String): Channel @addAccountContext @isAuthenticated\n    # viewChannelDetail(id: String!): Channel @addAccountContext @isAuthenticated\n}\n\nextend type Mutation {\n    createChannel(\n        name: String!,\n        description:String!\n        type: RoomType\n        team: String\n    ): Channel @addAccountContext @isAuthenticated\n\n    addMemberToChannel(\n        channelId: String!,\n        memberId: String!\n    ): Channel @addAccountContext @isAuthenticated\n\n    saveMembersToChannel(\n        membersIds: [String]!\n        channelId: String!,\n    ): Channel @addAccountContext @isAuthenticated\n\n    createDirectChannel(\n        receiver: [ID]!\n        displayName: String!\n        channelOptions:AnyObject\n    ): Channel @addAccountContext @isAuthenticated\n\n    hideChannel(id: ID!): Boolean @isAuthenticated\n\n    leaveChannel(id: ID!): Boolean @isAuthenticated\n\n    viewChannel(id:ID!): Boolean! @isAuthenticated @addAccountContext\n\n    deleteChannel(id: ID!): Boolean @isAuthenticated\n}\n";export{channelSchema as default};//# sourceMappingURL=channel.graphql.js.map
+var channelSchema = "\"\"\"\nChannel: A communication channel within an organization or team.\n\"\"\"\ntype Channel implements IBaseRepo @entity {\n    \"\"\"\n    Unique identifier for the channel\n    \"\"\"\n    id: String! @id\n    \n    \"\"\"\n    Channel title/name\n    \"\"\"\n    title: String @column\n    \n    \"\"\"\n    Channel topic\n    \"\"\"\n    topic: String @column\n    \n    \"\"\"\n    Organization name\n    \"\"\"\n    orgName: String @column\n    \n    \"\"\"\n    Channel purpose\n    \"\"\"\n    purpose: String @column\n    \n    \"\"\"\n    Channel description\n    \"\"\"\n    description: String @column\n    \n    \"\"\"\n    Display name\n    \"\"\"\n    displayName: String @column\n    \n    \"\"\"\n    Associated team\n    \"\"\"\n    team: AccountTeam @column(overrideType: \"ObjectId\")\n    \n    \"\"\"\n    Last post timestamp\n    \"\"\"\n    lastPostAt: DateTime @column(overrideType: \"Date\")\n    \n    \"\"\"\n    Total message count\n    \"\"\"\n    totalMsgCount: Int @column\n    \n    \"\"\"\n    Total root message count\n    \"\"\"\n    totalMsgCountRoot: Int @column\n    \n    \"\"\"\n    Channel creator\n    \"\"\"\n    creator: UserAccount @column(overrideType: \"ObjectId\")\n    \n    \"\"\"\n    Channel members\n    \"\"\"\n    members: [ChannelMember] @column(overrideType: \"ObjectId[]\")\n    \n    \"\"\"\n    Channel type\n    \"\"\"\n    type: String @column\n    \n    \"\"\"\n    Last message in the channel\n    \"\"\"\n    lastMessage: Post @column(overrideType: \"ObjectId\")\n    \n    \"\"\"\n    Creation timestamp\n    \"\"\"\n    createdAt: DateTime @column(overrideType: \"Date\")\n    \n    \"\"\"\n    Last update timestamp\n    \"\"\"\n    updatedAt: DateTime @column(overrideType: \"Date\")\n    \n    \"\"\"\n    Deletion timestamp\n    \"\"\"\n    deletedAt: DateTime @column(overrideType: \"Date\")\n}\n\n\"\"\"\nChannel unread message information\n\"\"\"\ntype ChannelUnread {\n    \"\"\"\n    Team identifier\n    \"\"\"\n    teamId: String\n    \n    \"\"\"\n    Channel identifier\n    \"\"\"\n    channelId: String\n    \n    \"\"\"\n    Unread message count\n    \"\"\"\n    msgCount: Int\n    \n    \"\"\"\n    Mention count\n    \"\"\"\n    mentionCount: Int\n    \n    \"\"\"\n    Root mention count\n    \"\"\"\n    mentionCountRoot: Int\n    \n    \"\"\"\n    Root message count\n    \"\"\"\n    msgCountRoot: Int\n    \n    \"\"\"\n    Notification properties\n    \"\"\"\n    notifyProps: AnyObject\n}\n\n\"\"\"\nChannel filter input for queries\n\"\"\"\ninput ChannelFilterInput {\n    \"\"\"\n    Filter by name\n    \"\"\"\n    nameFilter: String\n    \n    \"\"\"\n    Filter by privacy level\n    \"\"\"\n    privacy: ChannelPrivacy\n    \n    \"\"\"\n    Filter joined channels only\n    \"\"\"\n    joinedChannels: Boolean\n    \n    \"\"\"\n    Sort order\n    \"\"\"\n    storyBy: ChannelSort\n}\n\n\"\"\"\nChannel name and direct message input\n\"\"\"\ninput ChannelNameAndDirect {\n    \"\"\"\n    Channel name\n    \"\"\"\n    name: String!\n    \n    \"\"\"\n    Is direct message\n    \"\"\"\n    direct: Boolean!\n}\n\n\"\"\"\nChannel create request input\n\"\"\"\ninput ChannelCreateRequest {\n    \"\"\"\n    Channel name\n    \"\"\"\n    name: String!\n    \n    \"\"\"\n    Channel description\n    \"\"\"\n    description: String!\n    \n    \"\"\"\n    Channel type\n    \"\"\"\n    type: RoomType\n    \n    \"\"\"\n    Associated team\n    \"\"\"\n    team: String\n}\n\n\"\"\"\nChannel update request input\n\"\"\"\ninput ChannelUpdateRequest {\n    \"\"\"\n    Channel ID\n    \"\"\"\n    id: ID!\n    \n    \"\"\"\n    Channel title\n    \"\"\"\n    title: String\n    \n    \"\"\"\n    Channel description\n    \"\"\"\n    description: String\n    \n    \"\"\"\n    Channel type\n    \"\"\"\n    type: RoomType\n}\n\n\"\"\"\nDirect channel create request input\n\"\"\"\ninput DirectChannelCreateRequest {\n    \"\"\"\n    Receiver user IDs\n    \"\"\"\n    receiver: [ID]!\n    \n    \"\"\"\n    Display name\n    \"\"\"\n    displayName: String!\n    \n    \"\"\"\n    Channel options\n    \"\"\"\n    channelOptions: AnyObject\n}\n\n\"\"\"\nChannel sorting options\n\"\"\"\nenum ChannelSort {\n    \"\"\"\n    Sort by name\n    \"\"\"\n    NAME\n    \n    \"\"\"\n    Sort by number of messages\n    \"\"\"\n    NUMBER_OF_MESSAGES\n}\n\n\"\"\"\nChannel privacy levels\n\"\"\"\nenum ChannelPrivacy {\n    \"\"\"\n    Private channels\n    \"\"\"\n    PRIVATE\n    \n    \"\"\"\n    Public channels\n    \"\"\"\n    PUBLIC\n    \n    \"\"\"\n    All channels\n    \"\"\"\n    ALL\n}\n\n\"\"\"\nRoom/Channel types\n\"\"\"\nenum RoomType {\n    \"\"\"\n    SERVICE Channel with number of users - Only members from same organization\n    \"\"\"\n    SERVICE\n    \n    \"\"\"\n    Normal Channel with number of users - Only members from same organization\n    \"\"\"\n    CHANNEL\n    \n    \"\"\"\n    Direct User to User conversations, with two or more participants - Only members from same organization\n    \"\"\"\n    DIRECT\n    \n    \"\"\"\n    Channels with Private Visibility - Only members from same organization\n    \"\"\"\n    PRIVATE\n    \n    \"\"\"\n    Channels with Public Visibility - Members from other organizations can join\n    \"\"\"\n    PUBLIC\n\n    \"\"\"\n    Group channels\n    \"\"\"\n    GROUP\n    \n    \"\"\"\n    Visitor channels\n    \"\"\"\n    VISITOR\n}\n\nextend type Query {\n    \"\"\"\n    Get channel by name\n    \"\"\"\n    channelByName(name: String!): Channel @addAccountContext @isAuthenticated\n    \n    \"\"\"\n    Get channels with filtering\n    \"\"\"\n    channels(filter: ChannelFilterInput = {\n        privacy: ALL,\n        joinedChannels: false,\n        sortyBy: NAME\n    }): [Channel] @addAccountContext @isAuthenticated\n    \n    \"\"\"\n    Get channels by user with criteria\n    \"\"\"\n    channelsByUser(\n        role: String\n        criteria: AnyObject,\n        limit: Int,\n        skip: Int,\n        sort: Sort\n    ): [Channel] @addAccountContext @isAuthenticated\n    \n    \"\"\"\n    Get support service channels\n    \"\"\"\n    supportServiceChannels(\n        role: String\n        criteria: AnyObject,\n        limit: Int,\n        skip: Int,\n        sort: Sort\n    ): [Channel] @addAccountContext @isAuthenticated\n    \n    \"\"\"\n    Get direct channel by ID\n    \"\"\"\n    directChannel(id: ID!): Channel @addAccountContext @isAuthenticated\n    \n    \"\"\"\n    View channel detail\n    \"\"\"\n    viewChannelDetail(id: String): Channel @addAccountContext @isAuthenticated\n}\n\nextend type Mutation {\n    \"\"\"\n    Create a new channel\n    \"\"\"\n    createChannel(\n        name: String!,\n        description: String!\n        type: RoomType\n        team: String\n    ): Channel @addAccountContext @isAuthenticated\n\n    \"\"\"\n    Add member to channel\n    \"\"\"\n    addMemberToChannel(\n        channelId: String!,\n        memberId: String!\n    ): Channel @addAccountContext @isAuthenticated\n\n    \"\"\"\n    Save multiple members to channel\n    \"\"\"\n    saveMembersToChannel(\n        membersIds: [String]!\n        channelId: String!,\n    ): Channel @addAccountContext @isAuthenticated\n\n    \"\"\"\n    Create direct message channel\n    \"\"\"\n    createDirectChannel(\n        receiver: [ID]!\n        displayName: String!\n        channelOptions: AnyObject\n    ): Channel @addAccountContext @isAuthenticated\n\n    \"\"\"\n    Hide channel from user view\n    \"\"\"\n    hideChannel(id: ID!): Boolean @isAuthenticated\n\n    \"\"\"\n    Leave channel\n    \"\"\"\n    leaveChannel(id: ID!): Boolean @isAuthenticated\n\n    \"\"\"\n    View/mark channel as read\n    \"\"\"\n    viewChannel(id: ID!): Boolean! @isAuthenticated @addAccountContext\n\n    \"\"\"\n    Delete channel\n    \"\"\"\n    deleteChannel(id: ID!): Boolean @isAuthenticated\n    \n    \"\"\"\n    Send notification of unread messages\n    \"\"\"\n    sendNotificationOfUnreadMessages(\n        unit: String!\n        value: Int!\n    ): Boolean @addAccountContext @isAuthenticated\n}\n";export{channelSchema as default};//# sourceMappingURL=channel.graphql.js.map