Skip to content

Commit

Permalink
feat: add notifications overview
Browse files Browse the repository at this point in the history 
See: BEDS-335
  • Loading branch information
@benji-bitfly @marcel-bitfly
benji-bitfly authored and marcel-bitfly committed Sep 20, 2024
1 parent 17918e6 commit e0f0a76
Show file tree
Hide file tree
Showing 7 changed files with 374 additions and 2 deletions.
35 changes: 35 additions & 0 deletions frontend/components/BcFeatureFlag.vue
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<script setup lang="ts">
import { warn } from 'vue'
type Feature = 'feature-account_dashboards'
type Environment = 'development' | 'production' | 'staging'
const currentEnvironment = useRuntimeConfig().public.deploymentType as Environment
if (!currentEnvironment) {
warn('Environment variable `deploymentType` is not set.')
}
const staging: Feature[] = []
const activeFeatures: Record<Environment, Feature[]> = {
development: [
...staging,
'feature-account_dashboards',
],
production: [],
staging,
}
const props = defineProps<{
feature: Feature,
}>()
const isEnabled = computed(
() => activeFeatures[currentEnvironment]?.includes(props.feature),
)
</script>

<template>
<slot v-if="isEnabled" />
</template>

<style scoped></style>
19 changes: 19 additions & 0 deletions frontend/components/bc/BcButtonText.vue
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<script setup lang="ts"></script>

<template>
<button class="bc-button-text">
<slot />
</button>
</template>

<style scoped lang="scss">
.bc-button-text {
background: none;
border: none;
padding: 0;
color: inherit;
font-family: inherit;
font-weight: inherit;
font-size: inherit;
}
</style>
247 changes: 247 additions & 0 deletions frontend/components/notifications/NotificationsOverview.vue
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,247 @@
<script lang="ts" setup>
import { FontAwesomeIcon } from '@fortawesome/vue-fontawesome'
import {
faDesktop, faUser,
} from '@fortawesome/pro-solid-svg-icons'
import { faInfoCircle } from '@fortawesome/pro-regular-svg-icons'
const { t: $t } = useTranslation()
const {
overview,
refreshOverview,
} = useNotificationsDashboardOverviewStore()
refreshOverview()
const hasEmail = computed(() => overview.value?.is_email_notifications_enabled)
const hasPushNotifications = computed(() => overview.value?.is_push_notifications_enabled)
const vdbMostNotifiedGroups = computed(() => overview.value?.vdb_most_notified_groups || [])
const adbMostNotifiedGroups = computed(() => overview.value?.adb_most_notified_groups || [])
const last24hEmailsCount = computed(() => overview.value?.last_24h_emails_count ?? 0)
const last24hPushCount = computed(() => overview.value?.last_24h_push_count ?? 0)
const last24hWebhookCount = computed(() => overview.value?.last_24h_webhook_count ?? 0)
const notificationsTotal = computed(() => {
return last24hEmailsCount.value + last24hWebhookCount.value + last24hPushCount.value
})
const userLimitMail = useUserStore()
const mailLimit = computed(() => userLimitMail.user.value?.premium_perks.email_notifications_per_day ?? 0)
// TODO: replace with actual hours value when we get the endpoint.
const resetHours = ref(12)
const tooltipEmail = computed(() => {
return $t('notifications.overview.email_tooltip', {
hours: resetHours.value,
limit: mailLimit.value,
})
})
const emit = defineEmits<{
(e: 'openDialog'): void,
}>()
</script>

<template>
<div class="container">
<div class="box">
<section class="box-item">
<h3 class="overwrite-h3 big_text_label">
{{ $t('notifications.overview.headers.email_notifications') }}
</h3>
<div
class="big_text"
>
{{ hasEmail ? $t('common.active') : $t('common.inactive') }}
</div>
<div v-if="hasEmail" class="inline-items">
<span class="small_text">{{ last24hEmailsCount }}/{{ mailLimit }} {{ $t('common.units.per_day') }}</span>
<BcTooltip
tooltip-width="220px"
:text="tooltipEmail"
>
<FontAwesomeIcon :icon="faInfoCircle" />
</BcTooltip>
<BcPremiumGem class="gem" />
</div>
<div v-else class="premium-invitation small_text">
<BcTranslation
keypath="notifications.overview.notifications_activate_premium.template"
linkpath="notifications.overview.notifications_activate_premium._link"
to="https://discord.com/developers/docs/resources/webhook"
>
<template #_link>
<BcButtonText
class="link"
:aria-label="$t('notifications.overview.email_activate')"
@click="emit('openDialog')"
>
{{ $t('notifications.overview.notifications_activate_premium._link') }}
</BcButtonText>
</template>
</BcTranslation>
</div>
</section>
<section class="box-item">
<h3 class="overwrite-h3 big_text_label">
{{ $t('notifications.overview.headers.push_notifications') }}
</h3>
<div class="big_text">
{{ hasPushNotifications ? $t('common.active') : $t('common.inactive') }}
</div>
<div v-if="!hasPushNotifications" class="push-invitation small_text">
<BcTranslation
keypath="notifications.overview.notifications_download_app.template"
linkpath="notifications.overview.notifications_download_app._link"
to="/mobile"
/>
</div>
</section>
<section class="box-item">
<h3 class="overwrite-h3 big_text_label">
{{ $t('notifications.overview.headers.most_notifications_30d') }}
</h3>
<div class="lists-container">
<h4 class="sr-only">
{{ $t('notifications.overview.headers.validator_groups') }}
</h4>
<ol class="icon-list">
<li v-for="group in vdbMostNotifiedGroups" :key="group" class="small_text list-item">
<FontAwesomeIcon :icon="faDesktop" />
<span class="list-text">
{{ group }}
</span>
</li>
</ol>
<BcFeatureFlag feature="feature-account_dashboards">
<h4 class="sr-only">
{{ $t('notifications.overview.headers.account_groups') }}
</h4>
<ol
class="icon-list"
>
<li v-for="group in adbMostNotifiedGroups" :key="group" class="small_text list-item">
<FontAwesomeIcon :icon="faUser" />
<span class="list-text">
{{ group }}
</span>
</li>
</ol>
</BcFeatureFlag>
</div>
</section>
<section class="box-item">
<h3 class="overwrite-h3 big_text_label">
{{ $t('notifications.overview.headers.most_notifications_24h') }}
</h3>
<div class="big_text">
{{ notificationsTotal }}
</div>
<div class="small_text">
{{ last24hEmailsCount }} {{ $t('common.email') }} | {{ last24hWebhookCount }} {{ $t('common.webhook') }} | {{ last24hPushCount }} {{ $t('notifications.overview.push') }}
</div>
</section>
</div>
</div>
</template>

<style lang="scss" scoped>
@use '~/assets/css/main.scss';
@use "~/assets/css/utils.scss";
.container {
@include main.container;
padding: 17px 20px;
position: relative;
}
.overwrite-h3 {
margin-block: unset;
}
.info-section, .action-section {
display: flex;
align-items: center;
justify-content: center;
gap: 10px;
}
.icon {
font-size: 24px;
}
.text {
font-size: 18px;
font-weight: 500;
}
.list-item {
display: flex;
gap: 10px;
.list-text {
@include utils.truncate-text;
}
}
.box {
display: flex;
justify-content: space-between;
overflow: auto;
scrollbar-width: none;
gap: 1.25rem;
&::-webkit-scrollbar {
display: none;
}
.box-item {
flex-shrink: 0;
max-width: 17rem;
}
}
.box-item {
display: flex;
flex-direction: column;
gap: 10px;
}
.inline-items {
display: flex;
align-items: center;
gap: 10px;
}
a:hover {
color: var(--light-blue);
}
.lists-container {
display: flex;
gap: 20px;
}
.icon-list {
min-width: 0;
list-style-type: none;
padding: 0;
margin: 0;
display: flex;
flex-direction: column;
gap: 10px;
}
.icon {
font-size: 16px;
}
.inline-link,
.gem {
display: inline-block;
}
.premium-invitation {
display: flex;
align-items: center;
gap: 5px; /* Adjust the gap as needed */
}
.push-invitation {
display: flex;
align-items: center;
gap: 5px; /* Adjust the gap as needed */
flex-wrap: wrap;
}
@media (max-width: 600px) {
.box {
flex-direction: row;
gap: 20px;
}
.box-item {
min-width: 250px; /* Adjust based on content width */
}
}
</style>
30 changes: 29 additions & 1 deletion frontend/locales/en.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
},
"common": {
"account": "Account | Accounts",
"active": "Active",
"address": "Address | Addresses",
"age": "Age",
"and_more": "and {count} more",
Expand All @@ -34,6 +35,7 @@
"deselected": "Not selected",
"earned": "Earned",
"edit": "Edit",
"email": "Email",
"ens_address": "ENS address | ENS addresses",
"epoch": "Epoch | Epochs",
"erc20token": "ERC-20 Token | ERC-20 Tokens",
Expand All @@ -45,6 +47,7 @@
"graffiti": "Graffiti | Graffitis",
"id": "ID",
"in_day": "In one day | In {count} days",
"inactive": "Inactive",
"index": "Index",
"last_x": "Last {duration}",
"live": "Live",
Expand All @@ -68,8 +71,12 @@
"true": "True",
"tx_batch": "Tx Batch | Tx Batches",
"unavailable": "Unavailable",
"units": {
"per_day": "per day"
},
"upcoming": "Upcoming",
"validator": "Validator | Validators"
"validator": "Validator | Validators",
"webhook": "Webhook"
},
"cookies": {
"accept_all": "Accept All",
Expand Down Expand Up @@ -692,6 +699,27 @@
"subscriptions": "Network ({count} Subscription) | Validators ({count} Subscriptions)"
}
},
"overview": {
"email_activate": "Click here to activate Email notifications",
"email_tooltip": "Your current limit is { limit } emails per day. Your email limit resets in { hours } hours. Upgrade to premium for more.",
"headers": {
"account_groups": "Most notified account groups",
"email_notifications": "Email Notifications",
"most_notifications_24h": "Most Notifications in 24h",
"most_notifications_30d": "Most Notifications in 30d",
"push_notifications": "Push Notifications",
"validator_groups": "Most notified validator groups"
},
"notifications_activate_premium": {
"_link": "here",
"template": "Click {_link} to activate"
},
"notifications_download_app": {
"_link": "mobile app",
"template": "Download the {_link} to activate"
},
"push": "Push"
},
"subscriptions": {
"accounts": {
"all": {
Expand Down
4 changes: 3 additions & 1 deletion frontend/pages/notifications.vue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ const openManageNotifications = () => {
<template #top>
<DashboardHeader :dashboard-title="$t('notifications.title')" />
<div class="overview">
TODO: Overview
<NotificationsOverview
@open-dialog="openManageNotifications"
/>
</div>
</template>
<NotificationsManagementModal
Expand Down
Loading

0 comments on commit e0f0a76

Please sign in to comment.