Class NotificationDataService

constructor

• new NotificationDataService(db, expandUserAPI): NotificationDataService

• Parameters

  • db: Db

  • expandUserAPI: Pick<UserDefaultAdapterAPI, "getUserById" | "getUsers">

  Returns NotificationDataService

createMessage

• createMessage(messageInfo): Promise<{
      id: string;
  }>

• Create a message into database

  Parameters

  • messageInfo: defaultNotification.CreateMessageDto

  Returns Promise<{
      id: string;
  }>

  id of created Message

createMessageTemplate

• createMessageTemplate(payload): Promise<{
      id: string;
  }>

• Create message template

  Parameters

  • payload: defaultNotification.CreateMessageTemplateDto

  Returns Promise<{
      id: string;
  }>

  message template id

createSubscription

• createSubscription(subscription): Promise<{
      id: string;
  }>

• Create a subscription into database

  Parameters

  • subscription: defaultNotification.CreateSubscriptionDto

  Returns Promise<{
      id: string;
  }>

  id of created subscription

createTopic

• createTopic(topicInfo): Promise<{
      id: string;
  }>

• Create a topic into database

  Parameters

  • topicInfo: defaultNotification.CreateTopicDto

  Returns Promise<{
      id: string;
  }>

  id of created Topic

createTransmissionsForMessage

• createTransmissionsForMessage(message): Promise<TransmissionEntity[]>

• Create transmissions from one message If message's topic have subscribers, a transmission is the message to the subscriber

  Parameters

  • message: defaultNotification.MessageEntity

  Returns Promise<TransmissionEntity[]>

  TransmissionEntity list

deleteOneMessage

• deleteOneMessage(messageId): Promise<boolean>

• Delete message by Id

  Parameters

  • messageId: string

  Returns Promise<boolean>

  boolean indicate deletion success or not

deleteOneMessageTemplate

• deleteOneMessageTemplate(id): Promise<boolean>

• Delete message template

  Parameters

  • id: string

  Returns Promise<boolean>

  true if success

deleteOneSubscription

• deleteOneSubscription(subscriptionId): Promise<boolean>

• Delete subscription by Id

  Parameters

  • subscriptionId: string

  Returns Promise<boolean>

  boolean indicate deletion success or not

deleteOneTopic

• deleteOneTopic(topicId): Promise<boolean>

• Delete topic by Id

  Parameters

  • topicId: string

  Returns Promise<boolean>

  boolean indicate deletion success or not

expandUser

• expandUser(userId): Promise<undefined | UserResponse>

• Expand the user by userId, return user detail if found, otherwise return userId

  Parameters

  • userId: string

  Returns Promise<undefined | UserResponse>

  user detail

expandUsers

• expandUsers(userIds): Promise<UserResponse[]>

• Expand the user by userIds, return users detail if found, otherwise return userIds

  Parameters

  • userIds: string[]

  Returns Promise<UserResponse[]>

  users detail

getMessageTemplate

• getMessageTemplate(filter): Promise<null | defaultNotification.MessageTemplateEntity>

• Get message template by filter

  Parameters

  • filter: undefined | Expression

  Returns Promise<null | defaultNotification.MessageTemplateEntity>

  message template

getMessageTemplateById

• getMessageTemplateById(id): Promise<null | defaultNotification.MessageTemplateEntity>

• Get message template by Id

  Parameters

  • id: string

  Returns Promise<null | defaultNotification.MessageTemplateEntity>

  message template

getMessageTopicPipeline

• getMessageTopicPipeline(): Document[]

• Returns Document[]

getMessageTopicSubscriptionPipeline

• getMessageTopicSubscriptionPipeline(userId): Document[]

• Parameters

  • userId: string

  Returns Document[]

getOneMessage

• getOneMessage(messageId): Promise<null | defaultNotification.MessageEntity>

• Get message data from messageId

  Parameters

  • messageId: string

    id of topic

  Returns Promise<null | defaultNotification.MessageEntity>

  message data

getOneMessageAndNormalize

• getOneMessageAndNormalize(messageId, fromUserId?, expand?): Promise<undefined | defaultNotification.MessageResponse>

• Get message data and then normalize

  Parameters

  • messageId: string

    id of topic

  • Optional fromUserId: string

    id of user from who to get readStatus

  • Optional expand: Expand

    list of fields to expand on the message (from parsed query)

  Returns Promise<undefined | defaultNotification.MessageResponse>

  message data

getOneSubscription

• getOneSubscription(subscriptionId): Promise<null | defaultNotification.SubscriptionEntity>

• Get subscription data from subscriptionId

  Parameters

  • subscriptionId: string

    id of topic

  Returns Promise<null | defaultNotification.SubscriptionEntity>

  subscription data

getOneSubscriptionAndNormalize

• getOneSubscriptionAndNormalize(subscriptionId, expand?): Promise<undefined | defaultNotification.SubscriptionResponse>

• Get subscription data and then normalize

  Parameters

  • subscriptionId: string

    id of topic

  • Optional expand: Expand

    list of fields to expand on the subscription (from parsed query)

  Returns Promise<undefined | defaultNotification.SubscriptionResponse>

  subscription data

getOneTopic

• getOneTopic(topicId): Promise<null | defaultNotification.TopicEntity>

• Get topic data from topicId

  Parameters

  • topicId: string

    id of topic

  Returns Promise<null | defaultNotification.TopicEntity>

  topic data

getOneTopicAndNormalize

• getOneTopicAndNormalize(topicId, expand?): Promise<null | defaultNotification.TopicResponse>

• Get topic data and then normalize

  Parameters

  • topicId: string

    id of topic

  • Optional expand: Expand

  Returns Promise<null | defaultNotification.TopicResponse>

  topic data

getPaginatedMessageTemplates

• getPaginatedMessageTemplates(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultNotification.MessageTemplateEntity>>

• Get pagination message templates

  Parameters

  • filter: undefined | Expression

  • orderParams: OrderParam<string>[]

  • paginationOptions: PaginationOptions

  Returns Promise<PaginatedFindResult<defaultNotification.MessageTemplateEntity>>

  paginated MessageTemplateEntity list

getPaginatedMessages

• getPaginatedMessages(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultNotification.MessageEntity>>

• Get paginated messages from by filtering

  Parameters

  • filter: undefined | Expression

    to filter the message list

  • orderParams: OrderParam<string>[]

    to order the message list

  • paginationOptions: PaginationOptions

    pagination options

  Returns Promise<PaginatedFindResult<defaultNotification.MessageEntity>>

  message list with pagination information

getPaginatedPublicMessages

• getPaginatedPublicMessages(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultNotification.MessageEntity & {
      messageTopic: defaultNotification.TopicEntity;
  }>>

• Get public message with pagination

  Parameters

  • filter: undefined | Expression

  • orderParams: OrderParam<string>[]

  • paginationOptions: PaginationOptions

  Returns Promise<PaginatedFindResult<defaultNotification.MessageEntity & {
      messageTopic: defaultNotification.TopicEntity;
  }>>

  paginated MessageEntity list

getPaginatedSubscriptions

• getPaginatedSubscriptions(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultNotification.SubscriptionEntity>>

• Get subscription with pagination

  Parameters

  • filter: undefined | Expression

  • orderParams: OrderParam<string>[]

  • paginationOptions: PaginationOptions

  Returns Promise<PaginatedFindResult<defaultNotification.SubscriptionEntity>>

  paginated SubscriptionEntity list

getPaginatedTopics

• getPaginatedTopics(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultNotification.TopicEntity>>

• Parameters

  • filter: undefined | Expression

  • orderParams: OrderParam<string>[]

  • paginationOptions: PaginationOptions

  Returns Promise<PaginatedFindResult<defaultNotification.TopicEntity>>

getPaginatedUserMessages

• getPaginatedUserMessages(userId, filter, orderParams, paginationOptions): Promise<PaginatedFindResult<defaultNotification.MessageEntity & {
      messageSubscriptions: defaultNotification.SubscriptionEntity[];
      messageTopic?: defaultNotification.TopicEntity;
  }>>

• Get user message with pagination

  Parameters

  • userId: string

  • filter: undefined | Expression

  • orderParams: OrderParam<string>[]

  • paginationOptions: PaginationOptions

  Returns Promise<PaginatedFindResult<defaultNotification.MessageEntity & {
      messageSubscriptions: defaultNotification.SubscriptionEntity[];
      messageTopic?: defaultNotification.TopicEntity;
  }>>

  paginated MessageEntity list

getSubscriptions

• getSubscriptions(filter): Promise<defaultNotification.SubscriptionEntity[]>

• Get subscription list by filter

  Parameters

  • filter: Filter<defaultNotification.SubscriptionEntity>

  Returns Promise<defaultNotification.SubscriptionEntity[]>

  subscription list

isPublicMessage

• isPublicMessage(message): Promise<boolean>

• Check if message is public

  Parameters

  • message: defaultNotification.MessageEntity

  Returns Promise<boolean>

  true if message's topic isPublic field is true

markMessageRead

• markMessageRead(userId, messageId): Promise<number>

• Parameters

  • userId: string

  • messageId: string

  Returns Promise<number>

normalizeMessageList

• normalizeMessageList(messages, fromUserId?, expand?): Promise<defaultNotification.MessageResponse[]>

• Normalize message list

  Parameters

  • messages: defaultNotification.MessageEntity[]

  • Optional fromUserId: string

    id of user from who to get readStatus

  • Optional expand: Expand

    list of fields to expand on the message (from parsed query)

  Returns Promise<defaultNotification.MessageResponse[]>

  normalized message or undefined

normalizeMessageTemplate

• normalizeMessageTemplate(messageTemplate): undefined | defaultNotification.MessageTemplateResponse

• Parameters

  • messageTemplate: undefined | null | defaultNotification.MessageTemplateEntity

  Returns undefined | defaultNotification.MessageTemplateResponse

normalizeOneMessage

• normalizeOneMessage(message, fromUserId?, expand?): Promise<undefined | defaultNotification.MessageResponse>

• Normalize message

  Parameters

  • message: undefined | null | defaultNotification.MessageEntity

  • Optional fromUserId: string

    id of user from who to get readStatus

  • Optional expand: Expand

    list of fields to expand on the message (from parsed query)

  Returns Promise<undefined | defaultNotification.MessageResponse>

  normalized message or undefined

normalizeOneSubscription

• normalizeOneSubscription(subscription, expand?): Promise<undefined | defaultNotification.SubscriptionResponse>

• Normalize subscription

  Parameters

  • subscription: undefined | null | defaultNotification.SubscriptionEntity

  • Optional expand: Expand

    list of fields to expand on the subscription (from parsed query)

  Returns Promise<undefined | defaultNotification.SubscriptionResponse>

  normalized subscription or undefined

normalizeOneTopic

• normalizeOneTopic(topic, expand?): Promise<null | defaultNotification.TopicResponse>

• Normalize topic

  Parameters

  • topic: null | defaultNotification.TopicEntity

  • Optional expand: Expand

    list of fields to expand on the topic (from parsed query)

  Returns Promise<null | defaultNotification.TopicResponse>

  normalized topic or undefined

normalizeSubscriptionList

• normalizeSubscriptionList(subscriptions, expand?): Promise<defaultNotification.SubscriptionResponse[]>

• Normalize subscription list

  Parameters

  • subscriptions: defaultNotification.SubscriptionEntity[]

  • Optional expand: Expand

    list of fields to expand on the subscription (from parsed query)

  Returns Promise<defaultNotification.SubscriptionResponse[]>

  normalized subscription list

normalizeTopicList

• normalizeTopicList(topics, expand?): Promise<defaultNotification.TopicResponse[]>

• Normalize topic list

  Parameters

  • topics: defaultNotification.TopicEntity[]

  • Optional expand: Expand

    list of fields to expand on the topic (from parsed query)

  Returns Promise<defaultNotification.TopicResponse[]>

  normalized topic list

setLogger

• setLogger(logger): NotificationDataService

• Parameters

  • logger: Logger

  Returns NotificationDataService

updateMessageTemplate

• updateMessageTemplate(id, payload): Promise<{
      id: string;
  }>

• Update message template

  Parameters

  • id: string

  • payload: defaultNotification.UpdateMessageTemplateDto

  Returns Promise<{
      id: string;
  }>

  message template id

updateOneMessage

• updateOneMessage(messageId, payload): Promise<{
      id: string;
  }>

• Update message by Id

  Parameters

  • messageId: string

    id of message want to update

  • payload: defaultNotification.UpdateMessageDto

    content to overwrite

  Returns Promise<{
      id: string;
  }>

  id of updated message

updateOneTopic

• updateOneTopic(topicId, payload): Promise<{
      id: string;
  }>

• Update topic by Id

  Parameters

  • topicId: string

    id of topic want to update

  • payload: Partial<defaultNotification.CreateTopicDto>

    content to overwrite

  Returns Promise<{
      id: string;
  }>

  id of updated topic

getMessageTemplateAndNormalize

getMessageTemplateByIdAndNormalize