📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!
TypeScript chartsclickhousedockergdprgoogle-analyticsmetricsmonitoringmysqlnestjsprivacyredisself-hostedselfhostedstatisticstailwindcssweb-analyticswebanalyticswebsite
import { t as i18nextT } from 'i18next'
import _endsWith from 'lodash/endsWith'
import { Role } from '~/lib/models/Organisation'
const displayDateOptions: Intl.DateTimeFormatOptions = {
year: 'numeric',
month: 'short',
day: 'numeric',
}
const getCustomLabel = (
dates: Date[],
t: typeof i18nextT,
language?: string,
): string => {
if (dates) {
let from: string
let to: string
if (language) {
from = dates[0].toLocaleDateString(language, displayDateOptions)
to = dates[1].toLocaleDateString(language, displayDateOptions)
} else {
from = dates[0].toLocaleDateString()
to = dates[1].toLocaleDateString()
}
if (from === to) {
return from
}
return `${from} - ${to}`
}
return t('project.custom')
}
export interface TBPeriodPairsProps {
label: string
period: Period
tbs: TimeBucket[]
countDays?: number
dropdownLabel?: string
isCustomDate?: boolean
}
export const VALID_PERIODS = [
'1h',
'today',
'yesterday',
'1d',
'7d',
'4w',
'3M',
'12M',
'24M',
'all',
// Extended periods
'custom',
'compare',
] as const
export const VALID_TIME_BUCKETS = [
'minute',
'hour',
'day',
'month',
'year',
] as const
export type Period = (typeof VALID_PERIODS)[number]
export type TimeBucket = (typeof VALID_TIME_BUCKETS)[number]
// Maps each period to its valid time buckets (must stay in sync with tbPeriodPairs)
const PERIOD_TO_VALID_TIME_BUCKETS: Record<Period, TimeBucket[]> = {
'1h': ['minute'],
today: ['hour'],
yesterday: ['hour'],
'1d': ['hour'],
'7d': ['hour', 'day'],
'4w': ['day'],
'3M': ['day', 'month'],
'12M': ['day', 'month'],
'24M': ['month'],
all: ['month', 'year'],
custom: ['hour', 'day', 'month'],
compare: ['hour', 'day', 'month'],
}
export const getValidTimeBucket = (
period: Period,
requestedTimeBucket?: string | null,
from?: string,
to?: string,
): TimeBucket => {
let validBuckets = PERIOD_TO_VALID_TIME_BUCKETS[period] || ['day']
if ((period === 'custom' || period === 'compare') && from && to) {
const days = Math.ceil(
Math.abs(new Date(to).getTime() - new Date(from).getTime()) /
(1000 * 3600 * 24),
)
for (const entry of timeBucketToDays) {
if (entry.lt >= days) {
validBuckets = entry.tb
break
}
}
}
if (
requestedTimeBucket &&
validBuckets.includes(requestedTimeBucket as TimeBucket)
) {
return requestedTimeBucket as TimeBucket
}
return validBuckets[0]
}
export const tbPeriodPairs = (
t: typeof i18nextT,
tbs?: TimeBucket[] | null,
dates?: Date[] | null,
language?: string,
): TBPeriodPairsProps[] => [
{
label: t('project.thisHour'),
period: '1h',
tbs: ['minute'],
},
{
label: t('project.today'),
period: 'today',
tbs: ['hour'],
},
{
label: t('project.yesterday'),
period: 'yesterday',
tbs: ['hour'],
},
{
label: t('project.last24h'),
period: '1d',
countDays: 1,
tbs: ['hour'],
},
{
label: t('project.lastXDays', { amount: 7 }),
period: '7d',
tbs: ['hour', 'day'],
countDays: 7,
},
{
label: t('project.lastXWeeks', { amount: 4 }),
period: '4w',
tbs: ['day'],
countDays: 28,
},
{
label: t('project.lastXMonths', { amount: 3 }),
period: '3M',
tbs: ['day', 'month'],
countDays: 90,
},
{
label: t('project.lastXMonths', { amount: 12 }),
period: '12M',
tbs: ['day', 'month'],
countDays: 365,
},
{
label: t('project.lastXMonths', { amount: 24 }),
period: '24M',
tbs: ['month'],
},
{
label: t('project.all'),
period: 'all',
tbs: ['month', 'year'],
},
{
label: dates ? getCustomLabel(dates, t, language) : t('project.custom'),
dropdownLabel: t('project.custom'),
isCustomDate: true,
period: 'custom',
tbs: tbs || ['month'],
},
{
label: t('project.compare'),
period: 'compare',
tbs: tbs || ['month'],
},
]
export const tbPeriodPairsCompare = (
t: typeof i18nextT,
dates?: Date[],
language?: string,
): {
label: string
period: string
}[] => [
{
label: t('project.previousPeriod'),
period: 'previous',
},
{
label: dates ? getCustomLabel(dates, t, language) : t('project.custom'),
period: 'custom',
},
{
label: t('project.disableCompare'),
period: 'disable',
},
]
export const PERIOD_PAIRS_COMPARE = {
COMPARE: 'compare',
PREVIOS: 'previous',
CUSTOM: 'custom',
DISABLE: 'disable',
} as const
// the maximum amount of months user can go back when picking a date in flat picker (project view)
export const MAX_MONTHS_IN_PAST = 24
export const timeBucketToDays: {
lt: number
tb: TimeBucket[]
}[] = [
// { lt: 0, tb: ['minute'] }, // 1 hour
{ lt: 1, tb: ['hour'] }, // 1 days
{ lt: 7, tb: ['hour', 'day'] }, // 7 days
{ lt: 28, tb: ['day'] }, // 4 weeks
{ lt: 366, tb: ['day', 'month'] }, // 12 months
{ lt: 732, tb: ['month'] }, // 24 months
]
export const tbsFormatMapper = {
minute: '%I:%M %p',
hour: '%I %p',
day: '%d %b',
month: '%b %Y',
year: '%Y',
} as Record<string, string>
export const tbsFormatMapperTooltip = {
minute: '%I:%M %p',
hour: '%d %b %I %p',
day: '%a, %d %b',
month: '%b %Y',
year: '%Y',
} as Record<string, string>
export const tbsFormatMapperTooltip24h = {
minute: '%H:%M',
hour: '%d %b %H:%M',
day: '%a, %d %b',
month: '%b %Y',
year: '%Y',
} as Record<string, string>
export const tbsFormatMapper24h = {
minute: '%H:%M',
hour: '%H:%M',
day: '%d %b',
month: '%b %Y',
year: '%Y',
} as Record<string, string>
export const TimeFormat = {
'12-hour': '12-hour',
'24-hour': '24-hour',
} as const
export const PADDLE_JS_URL = 'https://cdn.paddle.com/paddle/paddle.js'
export const PADDLE_VENDOR_ID = 139393
export const reportFrequencies = ['weekly', 'monthly', 'quarterly', 'never']
export const reportFrequencyForEmailsOptions: {
value: string
label: string
}[] = [
{ value: 'quarterly', label: 'Quarterly' },
{ value: 'monthly', label: 'Monthly' },
{ value: 'weekly', label: 'Weekly' },
{ value: 'never', label: 'Never' },
]
export const SHOW_BANNER_AT_PERC = 85 // show banner when 85% of events in tier are used
export const LS_THEME_SETTING = 'colour-theme'
export const LS_CAPTCHA_VIEW_PREFS_SETTING = 'captcha-view-preferences'
export const DEFAULT_TIMEZONE = 'Etc/GMT'
export const DONATE_URL = 'https://github.com/sponsors/Swetrix'
export const HAVE_I_BEEN_PWNED_URL = 'https://haveibeenpwned.com/passwords'
export const LINKEDIN_URL = 'https://www.linkedin.com/company/swetrix/'
export const GITHUB_URL = 'https://github.com/Swetrix/swetrix'
export const TWITTER_URL = 'https://twitter.com/intent/user?screen_name=swetrix'
export const TWITTER_USERNAME = '@swetrix'
export const DISCORD_URL = 'https://discord.gg/ZVK8Tw2E8j'
export const STATUSPAGE_URL = 'https://status.swetrix.com/'
export const MAIN_URL = 'https://swetrix.com'
export const DEMO_PROJECT_ID = 'DEMODEMODEMO'
export const LIVE_DEMO_URL = '/demo'
/** The cal.com link slug (without origin) used by the @calcom/embed-react inline widget. */
export const BOOK_A_CALL_CAL_LINK = 'swetrix/30min'
export const PERFORMANCE_LIVE_DEMO_URL = '/demo?tab=performance'
export const ERROR_TRACKING_LIVE_DEMO_URL = '/demo?tab=errors'
export const DOCS_URL = 'https://swetrix.com/docs'
export const INTEGRATIONS_URL = 'https://swetrix.com/docs/integrations'
export const ERROR_TRACKING_DOCS_URL = 'https://swetrix.com/docs/error-tracking'
export const isBrowser =
typeof window !== 'undefined' && typeof document !== 'undefined'
export type ThemeType = 'dark' | 'light'
export const SUPPORTED_THEMES = ['light', 'dark']
export const CONTACT_EMAIL = '[email protected]'
export const LIVE_VISITORS_UPDATE_INTERVAL = 40000
// Environment variables
// Using optional chaining for REMIX_ENV?. to avoid errors when running some unit tests
const isStaging = isBrowser ? window.REMIX_ENV?.STAGING : process.env.STAGING
const STAGING_API_URL = isBrowser
? window.REMIX_ENV?.API_STAGING_URL
: process.env.API_STAGING_URL
const PRODUCTION_API_URL = isBrowser
? window.REMIX_ENV?.API_URL
: process.env.API_URL
const SELFHOSTED_API_URL = isBrowser
? `${window.REMIX_ENV?.BASE_URL}/backend`
: process.env.API_ORIGIN || `${process.env.BASE_URL}/backend`
export const COOKIE_DOMAIN =
(isBrowser ? window.REMIX_ENV?.COOKIE_DOMAIN : process.env.COOKIE_DOMAIN) ||
'swetrix.com'
export const isSelfhosted = Boolean(
isBrowser ? window.REMIX_ENV?.SELFHOSTED : process.env.__SELFHOSTED,
)
export const isDisableMarketingPages =
(isBrowser
? window.REMIX_ENV?.DISABLE_MARKETING_PAGES
: process.env.DISABLE_MARKETING_PAGES) === 'true'
const apiUrlUnprocessed = isSelfhosted
? SELFHOSTED_API_URL
: isStaging
? STAGING_API_URL
: PRODUCTION_API_URL
export const TITLE_SUFFIX = isSelfhosted
? '| Swetrix Community Edition'
: '| Swetrix'
export const API_URL = _endsWith(apiUrlUnprocessed, '/')
? apiUrlUnprocessed
: `${apiUrlUnprocessed}/`
const NODE_ENV = isBrowser ? window.REMIX_ENV?.NODE_ENV : process.env.NODE_ENV
export const isDevelopment = !NODE_ENV || NODE_ENV === 'development'
const FRONTEND_ORIGIN = isSelfhosted
? (isBrowser ? window.REMIX_ENV?.BASE_URL : process.env.BASE_URL) || ''
: MAIN_URL
export const getOgImageUrl = (title: string, description?: string) => {
return `${FRONTEND_ORIGIN}/api/og-image.png?title=${encodeURIComponent(title)}&description=${encodeURIComponent(description || '')}`
}
export const getProjectOgImageUrl = (projectId: string) => {
return `${FRONTEND_ORIGIN}/api/og-image.png?projectId=${encodeURIComponent(projectId)}`
}
// Cookies
export const CONFIRMATION_TIMEOUT = 'confirmation_timeout'
export const LOW_EVENTS_WARNING = 'low_events_warning'
// LocalStorage
export const LS_PROJECTS_PROTECTED_KEY = 'projects_protected'
export const LS_IS_ACTIVE_COMPARE_KEY = 'is-active-compare'
// Funnels
export const MIN_FUNNEL_STEPS = 2
export const MAX_FUNNEL_STEPS = 10
// List of languages with translations available
export const whitelist = ['de', 'en', 'fr', 'pl', 'pt', 'uk']
export const whitelistWithCC = {
de: 'de-DE',
en: 'en-GB',
fr: 'fr-FR',
pl: 'pl-PL',
pt: 'pt-BR',
uk: 'uk-UA',
} as Record<string, string>
export const defaultLanguage = 'en'
export const languages = {
de: 'Deutsch',
en: 'English',
fr: 'Français',
pl: 'Polski',
pt: 'Português (Brasil)',
uk: 'Українська',
} as Record<string, string>
export const languageFlag = {
de: 'DE',
en: 'GB',
fr: 'FR',
pl: 'PL',
pt: 'BR',
uk: 'UA',
} as Record<string, string>
export const paddleLanguageMapping = {
uk: 'en',
} as Record<string, string>
// Languages that get a URL prefix (/{lang}/...). The default language is served unprefixed.
export const localisedLanguages = whitelist.filter(
(lng) => lng !== defaultLanguage,
)
// Pathname patterns that should NEVER receive a language prefix.
// Blog and blog-style content (rendered through routes/$.tsx) stays unlocalised,
// as do API routes and other internal endpoints.
const UNLOCALISED_PATH_PATTERNS: RegExp[] = [
/^\/admin(\/|$)/,
/^\/blog(\/|$)/,
/^\/glossary(\/|$)/,
/^\/comparison(\/|$)/,
/^\/(privacy|imprint|security|dpa|cookie-policy|terms|data-policy|how-to-measure-core-web-vitals)(\/|$)/,
/^\/api(\/|$)/,
/^\/backend(\/|$)/,
/^\/_internal_data/,
/^\/sitemap[^/]*\.xml$/,
/^\/robots\.txt$/,
/^\/ping$/,
/^\/favicon/,
/^\/locales\//,
/^\/assets\//,
]
export const isUnlocalisedPath = (pathname: string): boolean =>
UNLOCALISED_PATH_PATTERNS.some((re) => re.test(pathname))
// If the pathname starts with /{whitelisted-lang}, return that language code,
// otherwise null. The default language is never present in the path.
export const getLangFromPath = (pathname: string): string | null => {
const match = pathname.match(/^\/([^/]+)(?:\/|$)/)
if (!match) return null
const candidate = match[1]
if (candidate === defaultLanguage) return null
if (localisedLanguages.includes(candidate)) return candidate
return null
}
export const stripLangFromPath = (pathname: string): string => {
const lang = getLangFromPath(pathname)
if (!lang) return pathname
const stripped = pathname.slice(`/${lang}`.length)
return stripped.length === 0 ? '/' : stripped
}
// Build the canonical URL pathname for a given language. The default language
// is served unprefixed; other languages get a /{lang} prefix unless the path
// is one of the always-unprefixed routes (blog, api, etc.).
export const localisePath = (pathname: string, lang: string): string => {
if (!pathname.startsWith('/')) return pathname
const unprefixed = stripLangFromPath(pathname)
if (isUnlocalisedPath(unprefixed)) return unprefixed
if (lang === defaultLanguage || !localisedLanguages.includes(lang)) {
return unprefixed
}
if (unprefixed === '/') return `/${lang}`
return `/${lang}${unprefixed}`
}
// Increase this counter every time some major change is done within localisation files
// This will prevent cached version or raw locale strings being displayed in production
export const I18N_CACHE_BREAKER = 49
export const roles: Role[] = ['admin', 'viewer']
export const FUNNELS_PERIOD_PAIRS = [
'1h',
'1d',
'7d',
'4w',
'3M',
'12M',
'all',
'custom',
]
const SELFHOSTED_PROJECT_TABS = {
traffic: 'traffic',
performance: 'performance',
seo: 'seo',
journeys: 'journeys',
funnels: 'funnels',
profiles: 'profiles',
sessions: 'sessions',
replays: 'replays',
errors: 'errors',
goals: 'goals',
experiments: 'experiments',
featureFlags: 'featureFlags',
captcha: 'captcha',
} as const
const PRODUCTION_PROJECT_TABS = {
traffic: 'traffic',
performance: 'performance',
seo: 'seo',
profiles: 'profiles',
journeys: 'journeys',
funnels: 'funnels',
sessions: 'sessions',
replays: 'replays',
errors: 'errors',
goals: 'goals',
experiments: 'experiments',
featureFlags: 'featureFlags',
captcha: 'captcha',
ai: 'ai',
} as const
export const PROJECT_TABS = (
isSelfhosted ? SELFHOSTED_PROJECT_TABS : PRODUCTION_PROJECT_TABS
) as typeof PRODUCTION_PROJECT_TABS
export const QUERY_METRIC = {
PAGE_VIEWS: 'page_views',
UNIQUE_PAGE_VIEWS: 'unique_page_views',
ONLINE_USERS: 'online_users',
CUSTOM_EVENTS: 'custom_events',
ERRORS: 'errors',
} as const
export const QUERY_CONDITION = {
GREATER_THAN: 'greater_than',
GREATER_EQUAL_THAN: 'greater_equal_than',
LESS_THAN: 'less_than',
LESS_EQUAL_THAN: 'less_equal_than',
} as const
export const QUERY_TIME = {
LAST_15_MINUTES: 'last_15_minutes',
LAST_30_MINUTES: 'last_30_minutes',
LAST_1_HOUR: 'last_1_hour',
LAST_4_HOURS: 'last_4_hours',
LAST_24_HOURS: 'last_24_hours',
LAST_48_HOURS: 'last_48_hours',
} as const
export const INVITATION_EXPIRES_IN = 48 // hours
export const ENTRIES_PER_PAGE_DASHBOARD = 11
export const DEFAULT_ALERTS_TAKE = 100
const EUR = {
symbol: '€',
code: 'EUR',
}
const USD = {
symbol: '$',
code: 'USD',
}
const GBP = {
symbol: '£',
code: 'GBP',
}
type ICurrencies = Record<
'EUR' | 'USD' | 'GBP',
{
symbol: string
code: string
}
>
export const CURRENCIES: ICurrencies = {
EUR,
USD,
GBP,
}
export { PLAN_LIMITS } from '../pricing/catalog'
export const TRIAL_DAYS = 14
export const chartTypes = Object.freeze({
line: 'line',
bar: 'bar',
})
export const SSO_PROVIDERS = Object.freeze({
GOOGLE: 'google',
GITHUB: 'github',
})
export const BROWSER_LOGO_MAP = {
Brave: '/assets/browsers/brave_48x48.png',
Chrome: '/assets/browsers/chrome_48x48.png',
'Mobile Chrome': '/assets/browsers/chrome_48x48.png',
Firefox: '/assets/browsers/firefox_48x48.png',
'Mobile Firefox': '/assets/browsers/firefox_48x48.png',
Safari: '/assets/browsers/safari_48x48.png',
'Mobile Safari': '/assets/browsers/safari-ios_48x48.png',
Edge: '/assets/browsers/edge_48x48.png',
'Samsung Browser': '/assets/browsers/samsung-internet_48x48.png',
'Samsung Internet': '/assets/browsers/samsung-internet_48x48.png',
'Chrome WebView': '/assets/browsers/android-webview_48x48.png',
Opera: '/assets/browsers/opera_48x48.png',
'Opera GX': '/assets/browsers/opera-gx_48x48.png',
'Opera Air': '/assets/browsers/opera_48x48.png',
GSA: '/assets/browsers/chrome_48x48.png',
WebKit: '/assets/browsers/safari_48x48.png',
Yandex: '/assets/browsers/yandex_48x48.png',
'Android Browser': '/assets/browsers/android-webview_48x48.png',
Silk: '/assets/browsers/silk_48x48.png',
'Opera Touch': '/assets/browsers/opera-touch_48x48.png',
Electron: '/assets/browsers/electron_48x48.png',
'Coc Coc': '/assets/browsers/coc-coc_48x48.png',
SeaMonkey: '/assets/browsers/seamonkey_48x48.png',
PaleMoon: '/assets/browsers/pale-moon_48x48.png',
Falkon: '/assets/browsers/falkon_48x48.png',
Chromium: '/assets/browsers/chromium_48x48.png',
'Chrome Headless': '/assets/browsers/chromium_48x48.png',
Vivaldi: '/assets/browsers/vivaldi_48x48.png',
Whale: '/assets/browsers/whale_48x48.png',
Puffin: '/assets/browsers/puffin_48x48.png',
'Opera Mini': '/assets/browsers/opera-mini_48x48.png',
Mozilla: '/assets/browsers/firefox_48x48.png',
UCBrowser: '/assets/browsers/uc_48x48.png',
Midori: '/assets/browsers/midori_48x48.png',
Maxthon: '/assets/browsers/maxthon_48x48.png',
Konqueror: '/assets/browsers/konqueror_48x48.png',
Epiphany: '/assets/browsers/web_48x48.png',
Fennec: '/assets/browsers/firefox_48x48.png',
Basilisk: '/assets/browsers/basilisk_48x48.png',
GameVault: '/assets/browsers/gamevault_43x48.png',
DuckDuckGo: '/assets/duckduckgo.png',
Facebook: '/assets/facebook.svg',
MetaSr: '/assets/facebook.svg',
'Oculus Browser': '/assets/facebook.svg',
Instagram: '/assets/instagram.svg',
LinkedIn: '/assets/linkedin.svg',
Twitter: '/assets/twitter.svg',
TikTok: '/assets/tiktok.svg',
}
export const OS_LOGO_MAP = {
Windows: '/assets/os/WIN.png',
Android: '/assets/os/AND.png',
iOS: '/assets/os/apple.svg',
'Mac OS': '/assets/os/apple.svg',
macOS: '/assets/os/apple.svg',
Mac: '/assets/os/apple.svg',
Linux: '/assets/os/LIN.png',
'Linux x86_64': '/assets/os/LIN.png',
Ubuntu: '/assets/os/UBT.png',
'Chrome OS': '/assets/os/COS.png',
Fedora: '/assets/os/FED.png',
HarmonyOS: '/assets/os/HAR.png',
PlayStation: '/assets/os/PS3.png',
FreeBSD: '/assets/os/BSD.png',
Tizen: '/assets/os/TIZ.png',
OpenBSD: '/assets/os/OBS.png',
Chromecast: '/assets/os/COS.png',
Kubuntu: '/assets/os/KBT.png',
Xbox: '/assets/os/XBX.png',
NetBSD: '/assets/os/NBS.png',
Nintendo: '/assets/os/WII.png',
KAIOS: '/assets/os/KOS.png',
BSD: '/assets/os/BSD.png',
'Windows Phone': '/assets/os/WIN.png',
'Windows Mobile': '/assets/os/WIN.png',
}
export const OS_LOGO_MAP_DARK = {
iOS: '/assets/os/apple-dark.svg',
'Mac OS': '/assets/os/apple-dark.svg',
macOS: '/assets/os/apple-dark.svg',
Mac: '/assets/os/apple-dark.svg',
}