Skip to content

armgit / umami

Public Imported from GitHub
0

Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.

Initial Typescript models.

Brian Cao0aaba8cbd1f7
diff --git a/db/clickhouse/schema.sql b/db/clickhouse/schema.sql
index 0579d13da..64d31c042 100644
--- a/db/clickhouse/schema.sql
+++ b/db/clickhouse/schema.sql
@@ -19,6 +19,7 @@ CREATE TABLE event
url String,
referrer String,
--event
+ event_type UInt32,
event_name String,
event_data JSON,
created_at DateTime('UTC')
@@ -41,6 +42,7 @@ CREATE TABLE event_queue (
screen LowCardinality(String),
language LowCardinality(String),
country LowCardinality(String),
+ event_type UInt32,
event_name String,
event_data String,
created_at DateTime('UTC')
@@ -67,6 +69,7 @@ SELECT website_id,
screen,
language,
country,
+ event_type,
event_name,
event_data,
created_at
diff --git a/db/postgresql/schema.prisma b/db/postgresql/schema.prisma
index 58b28a8ba..b2cb4662c 100644
--- a/db/postgresql/schema.prisma
+++ b/db/postgresql/schema.prisma
@@ -69,8 +69,9 @@ model WebsiteEvent {
createdAt DateTime? @default(now()) @map("created_at") @db.Timestamptz(6)
url String @db.VarChar(500)
referrer String? @db.VarChar(500)
- eventName String @map("event_name") @db.VarChar(50)
- eventData Json @map("event_data")
+ eventType Int @default(1) @map("event_type") @db.Integer
+ eventName String? @map("event_name") @db.VarChar(50)
+ eventData Json? @map("event_data")
@@index([createdAt])
@@index([sessionId])
diff --git a/interface/api/auth.d.ts b/interface/api/auth.d.ts
new file mode 100644
index 000000000..6e4e34940
--- /dev/null
+++ b/interface/api/auth.d.ts
@@ -0,0 +1,8 @@
+export interface Auth {
+ user: {
+ id: string;
+ username: string;
+ isAdmin: boolean;
+ };
+ shareToken: string;
+}
diff --git a/interface/api/models.d.ts b/interface/api/models.d.ts
new file mode 100644
index 000000000..6251a1495
--- /dev/null
+++ b/interface/api/models.d.ts
@@ -0,0 +1,73 @@
+export interface User {
+ id: string;
+ username: string;
+ isAdmin: boolean;
+ createdAt: string;
+}
+
+export interface Website {
+ id: string;
+ userId: string;
+ revId: number;
+ name: string;
+ domain: string;
+ shareId: string;
+ createdAt: Date;
+}
+
+export interface Share {
+ id: string;
+ token: string;
+}
+
+export interface Empty {}
+
+export interface WebsiteActive {
+ x: number;
+}
+
+export interface WebsiteEventDataMetric {
+ [key: string]: number;
+}
+
+export interface WebsiteMetric {
+ x: string;
+ y: number;
+}
+
+export interface WebsiteEventMetric {
+ x: string;
+ t: string;
+ y: number;
+}
+
+export interface WebsitePageviews {
+ pageviews: {
+ t: string;
+ y: number;
+ };
+ sessions: {
+ t: string;
+ y: number;
+ };
+}
+
+export interface WebsiteStats {
+ pageviews: { value: number; change: number };
+ uniques: { value: number; change: number };
+ bounces: { value: number; change: number };
+ totalTime: { value: number; change: number };
+}
+
+export interface RealtimeInit {
+ websites: Website[];
+ token: string;
+ data: RealtimeUpdate;
+}
+
+export interface RealtimeUpdate {
+ pageviews: any[];
+ sessions: any[];
+ events: any[];
+ timestamp: number;
+}
diff --git a/interface/api/nextApi.d.ts b/interface/api/nextApi.d.ts
new file mode 100644
index 000000000..c5a54515f
--- /dev/null
+++ b/interface/api/nextApi.d.ts
@@ -0,0 +1,14 @@
+import { NextApiRequest } from 'next';
+import { Auth } from './auth';
+
+export interface NextApiRequestQueryBody<TQuery = any, TBody = any> extends NextApiRequest {
+ auth?: Auth;
+ query: TQuery & { [key: string]: string | string[] };
+ body: TBody;
+ headers: any;
+}
+
+export interface NextApiRequestAuth extends NextApiRequest {
+ auth?: Auth;
+ headers: any;
+}
diff --git a/interface/auth.d.ts b/interface/auth.d.ts
deleted file mode 100644
index 36d3041e5..000000000
--- a/interface/auth.d.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-export interface Auth {
- id: number;
- email?: string;
- teams?: string[];
-}
diff --git a/interface/base.d.ts b/interface/base.d.ts
deleted file mode 100644
index 5d498ebf9..000000000
--- a/interface/base.d.ts
+++ /dev/null
@@ -1,22 +0,0 @@
-import { NextApiRequest } from 'next';
-import { Auth } from './auth';
-
-export interface NextApiRequestQueryBody<TQuery, TBody> extends NextApiRequest {
- auth: Auth;
- query: TQuery;
- body: TBody;
-}
-
-export interface NextApiRequestQuery<TQuery> extends NextApiRequest {
- auth: Auth;
- query: TQuery;
-}
-
-export interface NextApiRequestBody<TBody> extends NextApiRequest {
- auth: Auth;
- body: TBody;
-}
-
-export interface ObjectAny {
- [key: string]: any;
-}
diff --git a/interface/enum.d.ts b/interface/enum.d.ts
new file mode 100644
index 000000000..8b09039ca
--- /dev/null
+++ b/interface/enum.d.ts
@@ -0,0 +1,7 @@
+/* eslint-disable no-unused-vars */
+export namespace UmamiApi {
+ enum EventType {
+ Pageview = 1,
+ Event = 2,
+ }
+}
diff --git a/interface/index.d.ts b/interface/index.d.ts
index 5d498ebf9..e69de29bb 100644
--- a/interface/index.d.ts
+++ b/interface/index.d.ts
@@ -1,22 +0,0 @@
-import { NextApiRequest } from 'next';
-import { Auth } from './auth';
-
-export interface NextApiRequestQueryBody<TQuery, TBody> extends NextApiRequest {
- auth: Auth;
- query: TQuery;
- body: TBody;
-}
-
-export interface NextApiRequestQuery<TQuery> extends NextApiRequest {
- auth: Auth;
- query: TQuery;
-}
-
-export interface NextApiRequestBody<TBody> extends NextApiRequest {
- auth: Auth;
- body: TBody;
-}
-
-export interface ObjectAny {
- [key: string]: any;
-}
diff --git a/lib/clickhouse.js b/lib/clickhouse.js
index 3d44daacb..b28694b6f 100644
--- a/lib/clickhouse.js
+++ b/lib/clickhouse.js
@@ -106,7 +106,7 @@ function getEventDataFilterQuery(column, filters) {
return query.join('\nand ');
}
-function getFilterQuery(column, filters = {}, params = []) {
+function getFilterQuery(filters = {}, params = []) {
const query = Object.keys(filters).reduce((arr, key) => {
const filter = filters[key];
@@ -146,7 +146,7 @@ function getFilterQuery(column, filters = {}, params = []) {
return query.join('\n');
}
-function parseFilters(column, filters = {}, params = []) {
+function parseFilters(filters = {}, params = []) {
const { domain, url, event_url, referrer, os, browser, device, country, event_name, query } =
filters;
@@ -159,9 +159,7 @@ function parseFilters(column, filters = {}, params = []) {
sessionFilters,
eventFilters,
event: { event_name },
- pageviewQuery: getFilterQuery(column, pageviewFilters, params),
- sessionQuery: getFilterQuery(column, sessionFilters, params),
- eventQuery: getFilterQuery(column, eventFilters, params),
+ filterQuery: getFilterQuery(filters, params),
};
}
diff --git a/lib/prisma.js b/lib/prisma.ts
similarity index 70%
rename from lib/prisma.js
rename to lib/prisma.ts
index ab1e6ebfc..08cfb0e09 100644
--- a/lib/prisma.js
+++ b/lib/prisma.ts
@@ -4,6 +4,7 @@ import moment from 'moment-timezone';
import debug from 'debug';
import { PRISMA, MYSQL, POSTGRESQL, getDatabaseType } from 'lib/db';
import { FILTER_IGNORED } from 'lib/constants';
+import { PrismaClientOptions } from '@prisma/client/runtime';
const MYSQL_DATE_FORMATS = {
minute: '%Y-%m-%d %H:%i:00',
@@ -37,7 +38,8 @@ function logQuery(e) {
}
function getClient(options) {
- const prisma = new PrismaClient(options);
+ const prisma: PrismaClient<PrismaClientOptions, 'query' | 'error' | 'info' | 'warn'> =
+ new PrismaClient(options);
if (process.env.LOG_QUERY) {
prisma.$on('query', logQuery);
@@ -52,7 +54,7 @@ function getClient(options) {
return prisma;
}
-function getDateQuery(field, unit, timezone) {
+function getDateQuery(field, unit, timezone?): string {
const db = getDatabaseType(process.env.DATABASE_URL);
if (db === POSTGRESQL) {
@@ -73,7 +75,7 @@ function getDateQuery(field, unit, timezone) {
}
}
-function getTimestampInterval(field) {
+function getTimestampInterval(field): string {
const db = getDatabaseType(process.env.DATABASE_URL);
if (db === POSTGRESQL) {
@@ -85,7 +87,7 @@ function getTimestampInterval(field) {
}
}
-function getJsonField(column, property, isNumber) {
+function getJsonField(column, property, isNumber): string {
const db = getDatabaseType(process.env.DATABASE_URL);
if (db === POSTGRESQL) {
@@ -103,7 +105,7 @@ function getJsonField(column, property, isNumber) {
}
}
-function getEventDataColumnsQuery(column, columns) {
+function getEventDataColumnsQuery(column, columns): string {
const query = Object.keys(columns).reduce((arr, key) => {
const filter = columns[key];
@@ -121,7 +123,7 @@ function getEventDataColumnsQuery(column, columns) {
return query.join(',\n');
}
-function getEventDataFilterQuery(column, filters) {
+function getEventDataFilterQuery(column, filters): string {
const query = Object.keys(filters).reduce((arr, key) => {
const filter = filters[key];
@@ -143,7 +145,7 @@ function getEventDataFilterQuery(column, filters) {
return query.join('\nand ');
}
-function getFilterQuery(table, column, filters = {}, params = []) {
+function getFilterQuery(filters = {}, params = []): string {
const query = Object.keys(filters).reduce((arr, key) => {
const filter = filters[key];
@@ -153,48 +155,25 @@ function getFilterQuery(table, column, filters = {}, params = []) {
switch (key) {
case 'url':
- if (table === 'pageview' || table === 'event') {
- arr.push(`and ${table}.${key}=$${params.length + 1}`);
- params.push(decodeURIComponent(filter));
- }
- break;
-
case 'os':
case 'browser':
case 'device':
case 'country':
- if (table === 'session') {
- arr.push(`and ${table}.${key}=$${params.length + 1}`);
- params.push(decodeURIComponent(filter));
- }
- break;
-
case 'event_name':
- if (table === 'event') {
- arr.push(`and ${table}.${key}=$${params.length + 1}`);
- params.push(decodeURIComponent(filter));
- }
+ arr.push(`and ${key}=$${params.length + 1}`);
+ params.push(decodeURIComponent(filter));
break;
-
case 'referrer':
- if (table === 'pageview' || table === 'event') {
- arr.push(`and ${table}.referrer like $${params.length + 1}`);
- params.push(`%${decodeURIComponent(filter)}%`);
- }
+ arr.push(`and referrer like $${params.length + 1}`);
+ params.push(`%${decodeURIComponent(filter)}%`);
break;
-
case 'domain':
- if (table === 'pageview') {
- arr.push(`and ${table}.referrer not like $${params.length + 1}`);
- arr.push(`and ${table}.referrer not like '/%'`);
- params.push(`%://${filter}/%`);
- }
+ arr.push(`and referrer not like $${params.length + 1}`);
+ arr.push(`and referrer not like '/%'`);
+ params.push(`%://${filter}/%`);
break;
-
case 'query':
- if (table === 'pageview') {
- arr.push(`and ${table}.url like '%?%'`);
- }
+ arr.push(`and url like '%?%'`);
}
return arr;
@@ -203,7 +182,11 @@ function getFilterQuery(table, column, filters = {}, params = []) {
return query.join('\n');
}
-function parseFilters(table, column, filters = {}, params = [], sessionKey = 'session_id') {
+function parseFilters(
+ filters: { [key: string]: any } = {},
+ params = [],
+ sessionKey = 'session_id',
+) {
const { domain, url, event_url, referrer, os, browser, device, country, event_name, query } =
filters;
@@ -218,15 +201,13 @@ function parseFilters(table, column, filters = {}, params = [], sessionKey = 'se
event: { event_name },
joinSession:
os || browser || device || country
- ? `inner join session on ${table}.${sessionKey} = session.${sessionKey}`
+ ? `inner join session on ${sessionKey} = session.${sessionKey}`
: '',
- pageviewQuery: getFilterQuery('pageview', column, pageviewFilters, params),
- sessionQuery: getFilterQuery('session', column, sessionFilters, params),
- eventQuery: getFilterQuery('event', column, eventFilters, params),
+ filterQuery: getFilterQuery(filters, params),
};
}
-async function rawQuery(query, params = []) {
+async function rawQuery(query, params = []): Promise<any> {
const db = getDatabaseType(process.env.DATABASE_URL);
if (db !== POSTGRESQL && db !== MYSQL) {
@@ -238,12 +219,13 @@ async function rawQuery(query, params = []) {
return prisma.$queryRawUnsafe.apply(prisma, [sql, ...params]);
}
-async function transaction(queries) {
+async function transaction(queries): Promise<any> {
return prisma.$transaction(queries);
}
// Initialization
-const prisma = global[PRISMA] || getClient(PRISMA_OPTIONS);
+const prisma: PrismaClient<PrismaClientOptions, 'query' | 'error' | 'info' | 'warn'> =
+ global[PRISMA] || getClient(PRISMA_OPTIONS);
export default {
client: prisma,
diff --git a/pages/api/auth/login.js b/pages/api/auth/login.ts
similarity index 65%
rename from pages/api/auth/login.js
rename to pages/api/auth/login.ts
index a54e80132..321fb3ab6 100644
--- a/pages/api/auth/login.js
+++ b/pages/api/auth/login.ts
@@ -10,8 +10,24 @@ import {
import { getUser } from 'queries';
import { secret } from 'lib/crypto';
import redis from 'lib/redis';
-
-export default async (req, res) => {
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
+import { User } from 'interface/api/models';
+
+export interface LoginRequestBody {
+ username: string;
+ password: string;
+}
+
+export interface LoginResponse {
+ token: string;
+ user: User;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<any, LoginRequestBody>,
+ res: NextApiResponse<LoginResponse>,
+) => {
if (req.method === 'POST') {
const { username, password } = req.body;
@@ -19,7 +35,7 @@ export default async (req, res) => {
return badRequest(res);
}
- const user = await getUser({ username });
+ const user = await getUser({ username }, true);
if (user && checkPassword(password, user.password)) {
if (redis.enabled) {
diff --git a/pages/api/auth/logout.js b/pages/api/auth/logout.ts
similarity index 74%
rename from pages/api/auth/logout.js
rename to pages/api/auth/logout.ts
index 37f117be4..c05a05deb 100644
--- a/pages/api/auth/logout.js
+++ b/pages/api/auth/logout.ts
@@ -2,8 +2,9 @@ import { methodNotAllowed, ok } from 'next-basics';
import { useAuth } from 'lib/middleware';
import redis from 'lib/redis';
import { getAuthToken } from 'lib/auth';
+import { NextApiRequest, NextApiResponse } from 'next';
-export default async (req, res) => {
+export default async (req: NextApiRequest, res: NextApiResponse) => {
await useAuth(req, res);
if (req.method === 'POST') {
diff --git a/pages/api/auth/verify.js b/pages/api/auth/verify.js
deleted file mode 100644
index 670480b15..000000000
--- a/pages/api/auth/verify.js
+++ /dev/null
@@ -1,8 +0,0 @@
-import { useAuth } from 'lib/middleware';
-import { ok } from 'next-basics';
-
-export default async (req, res) => {
- await useAuth(req, res);
-
- return ok(res, req.auth);
-};
diff --git a/pages/api/auth/verify.ts b/pages/api/auth/verify.ts
new file mode 100644
index 000000000..024cd96a8
--- /dev/null
+++ b/pages/api/auth/verify.ts
@@ -0,0 +1,10 @@
+import { NextApiRequestAuth } from 'interface/api/nextApi';
+import { useAuth } from 'lib/middleware';
+import { NextApiResponse } from 'next';
+import { ok } from 'next-basics';
+
+export default async (req: NextApiRequestAuth, res: NextApiResponse) => {
+ await useAuth(req, res);
+
+ return ok(res, req.auth);
+};
diff --git a/pages/api/collect.js b/pages/api/collect.ts
similarity index 83%
rename from pages/api/collect.js
rename to pages/api/collect.ts
index 87e516cc2..2aa2bde14 100644
--- a/pages/api/collect.js
+++ b/pages/api/collect.ts
@@ -6,8 +6,23 @@ import { savePageView, saveEvent } from 'queries';
import { useCors, useSession } from 'lib/middleware';
import { getJsonBody, getIpAddress } from 'lib/request';
import { secret } from 'lib/crypto';
-
-export default async (req, res) => {
+import { NextApiRequest, NextApiResponse } from 'next';
+
+export interface NextApiRequestCollect extends NextApiRequest {
+ session: {
+ id: string;
+ websiteId: string;
+ hostname: string;
+ browser: string;
+ os: string;
+ device: string;
+ screen: string;
+ language: string;
+ country: string;
+ };
+}
+
+export default async (req: NextApiRequestCollect, res: NextApiResponse) => {
await useCors(req, res);
if (isbot(req.headers['user-agent']) && !process.env.DISABLE_BOT_CHECK) {
@@ -74,6 +89,7 @@ export default async (req, res) => {
await saveEvent({
...session,
url,
+ referrer,
eventName,
eventData,
});
diff --git a/pages/api/config.js b/pages/api/config.ts
similarity index 57%
rename from pages/api/config.js
rename to pages/api/config.ts
index faf94c0bc..e5ae318ac 100644
--- a/pages/api/config.js
+++ b/pages/api/config.ts
@@ -1,6 +1,15 @@
+import { NextApiRequest, NextApiResponse } from 'next';
import { ok, methodNotAllowed } from 'next-basics';
-export default async (req, res) => {
+export interface ConfigResponse {
+ basePath: string;
+ trackerScriptName: string;
+ updatesDisabled: boolean;
+ telemetryDisabled: boolean;
+ adminDisabled: boolean;
+}
+
+export default async (req: NextApiRequest, res: NextApiResponse<ConfigResponse>) => {
if (req.method === 'GET') {
return ok(res, {
basePath: process.env.BASE_PATH || '',
diff --git a/pages/api/heartbeat.js b/pages/api/heartbeat.js
deleted file mode 100644
index a4ee59238..000000000
--- a/pages/api/heartbeat.js
+++ /dev/null
@@ -1,5 +0,0 @@
-import { ok } from 'next-basics';
-
-export default async (req, res) => {
- return ok(res);
-};
diff --git a/pages/api/heartbeat.ts b/pages/api/heartbeat.ts
new file mode 100644
index 000000000..1b515d39c
--- /dev/null
+++ b/pages/api/heartbeat.ts
@@ -0,0 +1,6 @@
+import { NextApiRequest, NextApiResponse } from 'next';
+import { ok } from 'next-basics';
+
+export default async (req: NextApiRequest, res: NextApiResponse) => {
+ return ok(res);
+};
diff --git a/pages/api/realtime/init.js b/pages/api/realtime/init.ts
similarity index 60%
rename from pages/api/realtime/init.js
rename to pages/api/realtime/init.ts
index 16e7cad3a..b1d1f32f7 100644
--- a/pages/api/realtime/init.js
+++ b/pages/api/realtime/init.ts
@@ -1,10 +1,13 @@
import { subMinutes } from 'date-fns';
-import { ok, methodNotAllowed, createToken } from 'next-basics';
-import { useAuth } from 'lib/middleware';
-import { getUserWebsites, getRealtimeData } from 'queries';
+import { RealtimeInit } from 'interface/api/models';
+import { NextApiRequestAuth } from 'interface/api/nextApi';
import { secret } from 'lib/crypto';
+import { useAuth } from 'lib/middleware';
+import { NextApiResponse } from 'next';
+import { createToken, methodNotAllowed, ok } from 'next-basics';
+import { getRealtimeData, getUserWebsites } from 'queries';
-export default async (req, res) => {
+export default async (req: NextApiRequestAuth, res: NextApiResponse<RealtimeInit>) => {
await useAuth(req, res);
if (req.method === 'GET') {
diff --git a/pages/api/realtime/update.js b/pages/api/realtime/update.ts
similarity index 64%
rename from pages/api/realtime/update.js
rename to pages/api/realtime/update.ts
index 9b91663d8..239ab1e6f 100644
--- a/pages/api/realtime/update.js
+++ b/pages/api/realtime/update.ts
@@ -3,8 +3,18 @@ import { useAuth } from 'lib/middleware';
import { getRealtimeData } from 'queries';
import { SHARE_TOKEN_HEADER } from 'lib/constants';
import { secret } from 'lib/crypto';
-
-export default async (req, res) => {
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
+import { RealtimeUpdate } from 'interface/api/models';
+
+export interface InitUpdateRequestQuery {
+ start_at: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<InitUpdateRequestQuery>,
+ res: NextApiResponse<RealtimeUpdate>,
+) => {
await useAuth(req, res);
if (req.method === 'GET') {
diff --git a/pages/api/share/[id].js b/pages/api/share/[id].ts
similarity index 52%
rename from pages/api/share/[id].js
rename to pages/api/share/[id].ts
index 6fb197396..51385beeb 100644
--- a/pages/api/share/[id].js
+++ b/pages/api/share/[id].ts
@@ -1,8 +1,22 @@
-import { getWebsite } from 'queries';
-import { ok, notFound, methodNotAllowed, createToken } from 'next-basics';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
import { secret } from 'lib/crypto';
+import { NextApiResponse } from 'next';
+import { createToken, methodNotAllowed, notFound, ok } from 'next-basics';
+import { getWebsite } from 'queries';
+
+export interface ShareRequestQuery {
+ id: string;
+}
+
+export interface ShareResponse {
+ id: string;
+ token: string;
+}
-export default async (req, res) => {
+export default async (
+ req: NextApiRequestQueryBody<ShareRequestQuery>,
+ res: NextApiResponse<ShareResponse>,
+) => {
const { id: shareId } = req.query;
if (req.method === 'GET') {
diff --git a/pages/api/users/[id]/index.js b/pages/api/users/[id]/index.ts
similarity index 77%
rename from pages/api/users/[id]/index.js
rename to pages/api/users/[id]/index.ts
index a373bbd11..870ff68a3 100644
--- a/pages/api/users/[id]/index.js
+++ b/pages/api/users/[id]/index.ts
@@ -1,8 +1,23 @@
import { badRequest, hashPassword, methodNotAllowed, ok, unauthorized } from 'next-basics';
import { getUser, deleteUser, updateUser } from 'queries';
import { useAuth } from 'lib/middleware';
-
-export default async (req, res) => {
+import { NextApiResponse } from 'next';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { User } from 'interface/api/models';
+
+export interface UserReqeustQuery {
+ id: string;
+}
+
+export interface UserReqeustBody {
+ username: string;
+ password: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<UserReqeustQuery, UserReqeustBody>,
+ res: NextApiResponse<User>,
+) => {
await useAuth(req, res);
const {
@@ -29,7 +44,7 @@ export default async (req, res) => {
const user = await getUser({ id });
- const data = {};
+ const data: any = {};
if (password) {
data.password = hashPassword(password);
diff --git a/pages/api/users/[id]/password.js b/pages/api/users/[id]/password.ts
similarity index 65%
rename from pages/api/users/[id]/password.js
rename to pages/api/users/[id]/password.ts
index 6cad82edf..4b00d7d5d 100644
--- a/pages/api/users/[id]/password.js
+++ b/pages/api/users/[id]/password.ts
@@ -10,8 +10,23 @@ import {
} from 'next-basics';
import { allowQuery } from 'lib/auth';
import { TYPE_USER } from 'lib/constants';
-
-export default async (req, res) => {
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
+import { User } from 'interface/api/models';
+
+export interface UserPasswordRequestQuery {
+ id: string;
+}
+
+export interface UserPasswordRequestBody {
+ current_password: string;
+ new_password: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<UserPasswordRequestQuery, UserPasswordRequestBody>,
+ res: NextApiResponse<User>,
+) => {
await useAuth(req, res);
const { current_password, new_password } = req.body;
diff --git a/pages/api/users/index.js b/pages/api/users/index.ts
similarity index 70%
rename from pages/api/users/index.js
rename to pages/api/users/index.ts
index f4a5010af..6b942287c 100644
--- a/pages/api/users/index.js
+++ b/pages/api/users/index.ts
@@ -2,8 +2,20 @@ import { ok, unauthorized, methodNotAllowed, badRequest, hashPassword } from 'ne
import { useAuth } from 'lib/middleware';
import { uuid } from 'lib/crypto';
import { createUser, getUser, getUsers } from 'queries';
-
-export default async (req, res) => {
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
+import { User } from 'interface/api/models';
+
+export interface UsersRequestBody {
+ username: string;
+ password: string;
+ id: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<UsersRequestBody>,
+ res: NextApiResponse<User[] | User>,
+) => {
await useAuth(req, res);
const {
diff --git a/pages/api/websites/[id]/active.js b/pages/api/websites/[id]/active.ts
similarity index 62%
rename from pages/api/websites/[id]/active.js
rename to pages/api/websites/[id]/active.ts
index 59af938ed..b50c29e7d 100644
--- a/pages/api/websites/[id]/active.js
+++ b/pages/api/websites/[id]/active.ts
@@ -3,8 +3,18 @@ import { allowQuery } from 'lib/auth';
import { useAuth, useCors } from 'lib/middleware';
import { getActiveVisitors } from 'queries';
import { TYPE_WEBSITE } from 'lib/constants';
+import { WebsiteActive } from 'interface/api/models';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
-export default async (req, res) => {
+export interface WebsiteActiveRequestQuery {
+ id: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsiteActiveRequestQuery>,
+ res: NextApiResponse<WebsiteActive>,
+) => {
await useCors(req, res);
await useAuth(req, res);
diff --git a/pages/api/websites/[id]/eventdata.js b/pages/api/websites/[id]/eventdata.ts
similarity index 61%
rename from pages/api/websites/[id]/eventdata.js
rename to pages/api/websites/[id]/eventdata.ts
index 0e6ad2e9d..646b2920d 100644
--- a/pages/api/websites/[id]/eventdata.js
+++ b/pages/api/websites/[id]/eventdata.ts
@@ -4,8 +4,27 @@ import { ok, badRequest, methodNotAllowed, unauthorized } from 'next-basics';
import { allowQuery } from 'lib/auth';
import { useAuth, useCors } from 'lib/middleware';
import { TYPE_WEBSITE } from 'lib/constants';
-
-export default async (req, res) => {
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
+import { WebsiteMetric } from 'interface/api/models';
+
+export interface WebsiteEventDataRequestQuery {
+ id: string;
+}
+
+export interface WebsiteEventDataRequestBody {
+ start_at: string;
+ end_at: string;
+ timezone: string;
+ event_name: string;
+ columns: { [key: string]: 'count' | 'max' | 'min' | 'avg' | 'sum' };
+ filters?: { [key: string]: any };
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsiteEventDataRequestQuery, WebsiteEventDataRequestBody>,
+ res: NextApiResponse<WebsiteMetric>,
+) => {
await useCors(req, res);
await useAuth(req, res);
diff --git a/pages/api/websites/[id]/events.js b/pages/api/websites/[id]/events.ts
similarity index 53%
rename from pages/api/websites/[id]/events.js
rename to pages/api/websites/[id]/events.ts
index da88794e2..efbf5a39f 100644
--- a/pages/api/websites/[id]/events.js
+++ b/pages/api/websites/[id]/events.ts
@@ -1,13 +1,29 @@
-import moment from 'moment-timezone';
-import { getEventMetrics } from 'queries';
-import { ok, badRequest, methodNotAllowed, unauthorized } from 'next-basics';
+import { WebsiteMetric } from 'interface/api/models';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
import { allowQuery } from 'lib/auth';
-import { useAuth, useCors } from 'lib/middleware';
import { TYPE_WEBSITE } from 'lib/constants';
+import { useAuth, useCors } from 'lib/middleware';
+import moment from 'moment-timezone';
+import { NextApiResponse } from 'next';
+import { badRequest, methodNotAllowed, ok, unauthorized } from 'next-basics';
+import { getEventMetrics } from 'queries';
const unitTypes = ['year', 'month', 'hour', 'day'];
-export default async (req, res) => {
+export interface WebsiteEventsRequestQuery {
+ id: string;
+ start_at: string;
+ end_at: string;
+ unit: string;
+ tz: string;
+ url: string;
+ event_name: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsiteEventsRequestQuery>,
+ res: NextApiResponse<WebsiteMetric>,
+) => {
await useCors(req, res);
await useAuth(req, res);
@@ -24,9 +40,15 @@ export default async (req, res) => {
const startDate = new Date(+start_at);
const endDate = new Date(+end_at);
- const events = await getEventMetrics(websiteId, startDate, endDate, tz, unit, {
- url,
- eventName: event_name,
+ const events = await getEventMetrics(websiteId, {
+ startDate,
+ endDate,
+ timezone: tz,
+ unit,
+ filters: {
+ url,
+ eventName: event_name,
+ },
});
return ok(res, events);
diff --git a/pages/api/websites/[id]/index.js b/pages/api/websites/[id]/index.ts
similarity index 72%
rename from pages/api/websites/[id]/index.js
rename to pages/api/websites/[id]/index.ts
index 090568654..834b17325 100644
--- a/pages/api/websites/[id]/index.js
+++ b/pages/api/websites/[id]/index.ts
@@ -3,8 +3,24 @@ import { useAuth, useCors } from 'lib/middleware';
import { methodNotAllowed, ok, serverError, unauthorized } from 'next-basics';
import { deleteWebsite, getWebsite, updateWebsite } from 'queries';
import { TYPE_WEBSITE } from 'lib/constants';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
+import { Website } from 'interface/api/models';
-export default async (req, res) => {
+export interface WebsiteReqeustQuery {
+ id: string;
+}
+
+export interface WebsiteReqeustBody {
+ name: string;
+ domain: string;
+ shareId: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsiteReqeustQuery, WebsiteReqeustBody>,
+ res: NextApiResponse<Website | any>,
+) => {
await useCors(req, res);
await useAuth(req, res);
diff --git a/pages/api/websites/[id]/metrics.js b/pages/api/websites/[id]/metrics.ts
similarity index 85%
rename from pages/api/websites/[id]/metrics.js
rename to pages/api/websites/[id]/metrics.ts
index 97216273e..f3bf38aa2 100644
--- a/pages/api/websites/[id]/metrics.js
+++ b/pages/api/websites/[id]/metrics.ts
@@ -1,6 +1,9 @@
+import { WebsiteMetric } from 'interface/api/models';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
import { allowQuery } from 'lib/auth';
import { FILTER_IGNORED, TYPE_WEBSITE } from 'lib/constants';
import { useAuth, useCors } from 'lib/middleware';
+import { NextApiResponse } from 'next';
import { badRequest, methodNotAllowed, ok, unauthorized } from 'next-basics';
import { getPageviewMetrics, getSessionMetrics, getWebsite } from 'queries';
@@ -33,7 +36,23 @@ function getColumn(type) {
return type;
}
-export default async (req, res) => {
+export interface WebsiteMetricsReqeustQuery {
+ id: string;
+ type: string;
+ start_at: number;
+ end_at: number;
+ url: string;
+ referrer: string;
+ os: string;
+ browser: string;
+ device: string;
+ country: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsiteMetricsReqeustQuery>,
+ res: NextApiResponse<WebsiteMetric[]>,
+) => {
await useCors(req, res);
await useAuth(req, res);
diff --git a/pages/api/websites/[id]/pageviews.js b/pages/api/websites/[id]/pageviews.ts
similarity index 67%
rename from pages/api/websites/[id]/pageviews.js
rename to pages/api/websites/[id]/pageviews.ts
index 5b628e3a8..c85a1a979 100644
--- a/pages/api/websites/[id]/pageviews.js
+++ b/pages/api/websites/[id]/pageviews.ts
@@ -1,13 +1,34 @@
-import moment from 'moment-timezone';
-import { getPageviewStats } from 'queries';
-import { ok, badRequest, methodNotAllowed, unauthorized } from 'next-basics';
+import { WebsitePageviews } from 'interface/api/models';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
import { allowQuery } from 'lib/auth';
-import { useAuth, useCors } from 'lib/middleware';
import { TYPE_WEBSITE } from 'lib/constants';
+import { useAuth, useCors } from 'lib/middleware';
+import moment from 'moment-timezone';
+import { NextApiResponse } from 'next';
+import { badRequest, methodNotAllowed, ok, unauthorized } from 'next-basics';
+import { getPageviewStats } from 'queries';
const unitTypes = ['year', 'month', 'hour', 'day'];
-export default async (req, res) => {
+export interface WebsitePageviewReqeustQuery {
+ id: string;
+ websiteId: string;
+ start_at: number;
+ end_at: number;
+ unit: string;
+ tz: string;
+ url?: string;
+ referrer?: string;
+ os?: string;
+ browser?: string;
+ device?: string;
+ country?: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsitePageviewReqeustQuery>,
+ res: NextApiResponse<WebsitePageviews>,
+) => {
await useCors(req, res);
await useAuth(req, res);
@@ -39,8 +60,8 @@ export default async (req, res) => {
const [pageviews, sessions] = await Promise.all([
getPageviewStats(websiteId, {
- start_at: startDate,
- end_at: endDate,
+ startDate,
+ endDate,
timezone: tz,
unit,
count: '*',
@@ -54,8 +75,8 @@ export default async (req, res) => {
},
}),
getPageviewStats(websiteId, {
- start_at: startDate,
- end_at: endDate,
+ startDate,
+ endDate,
timezone: tz,
unit,
count: 'distinct pageview.',
diff --git a/pages/api/websites/[id]/reset.js b/pages/api/websites/[id]/reset.ts
similarity index 66%
rename from pages/api/websites/[id]/reset.js
rename to pages/api/websites/[id]/reset.ts
index 0dde02dfb..6d2ffceaf 100644
--- a/pages/api/websites/[id]/reset.js
+++ b/pages/api/websites/[id]/reset.ts
@@ -3,8 +3,17 @@ import { methodNotAllowed, ok, unauthorized } from 'next-basics';
import { allowQuery } from 'lib/auth';
import { useAuth, useCors } from 'lib/middleware';
import { TYPE_WEBSITE } from 'lib/constants';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
-export default async (req, res) => {
+export interface WebsiteResetReqeustQuery {
+ id: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsiteResetReqeustQuery>,
+ res: NextApiResponse,
+) => {
await useCors(req, res);
await useAuth(req, res);
diff --git a/pages/api/websites/[id]/stats.js b/pages/api/websites/[id]/stats.ts
similarity index 76%
rename from pages/api/websites/[id]/stats.js
rename to pages/api/websites/[id]/stats.ts
index 2c5b01568..0ba65bf21 100644
--- a/pages/api/websites/[id]/stats.js
+++ b/pages/api/websites/[id]/stats.ts
@@ -3,8 +3,27 @@ import { methodNotAllowed, ok, unauthorized } from 'next-basics';
import { allowQuery } from 'lib/auth';
import { useAuth, useCors } from 'lib/middleware';
import { TYPE_WEBSITE } from 'lib/constants';
+import { WebsiteStats } from 'interface/api/models';
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
-export default async (req, res) => {
+export interface WebsiteStatsReqeustQuery {
+ id: string;
+ type: string;
+ start_at: number;
+ end_at: number;
+ url: string;
+ referrer: string;
+ os: string;
+ browser: string;
+ device: string;
+ country: string;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsiteStatsReqeustQuery>,
+ res: NextApiResponse<WebsiteStats>,
+) => {
await useCors(req, res);
await useAuth(req, res);
diff --git a/pages/api/websites/index.js b/pages/api/websites/index.ts
similarity index 68%
rename from pages/api/websites/index.js
rename to pages/api/websites/index.ts
index 3966ad70b..1b0b0586b 100644
--- a/pages/api/websites/index.js
+++ b/pages/api/websites/index.ts
@@ -2,8 +2,23 @@ import { createWebsite, getAllWebsites, getUserWebsites } from 'queries';
import { ok, methodNotAllowed, getRandomChars } from 'next-basics';
import { useAuth, useCors } from 'lib/middleware';
import { uuid } from 'lib/crypto';
-
-export default async (req, res) => {
+import { NextApiRequestQueryBody } from 'interface/api/nextApi';
+import { NextApiResponse } from 'next';
+
+export interface WebsitesReqeustQuery {
+ include_all?: boolean;
+}
+
+export interface WebsitesReqeustBody {
+ name: string;
+ domain: string;
+ enableShareUrl: boolean;
+}
+
+export default async (
+ req: NextApiRequestQueryBody<WebsitesReqeustQuery, WebsitesReqeustBody>,
+ res: NextApiResponse,
+) => {
await useCors(req, res);
await useAuth(req, res);
diff --git a/queries/admin/user/createUser.js b/queries/admin/user/createUser.js
deleted file mode 100644
index 54e008fe7..000000000
--- a/queries/admin/user/createUser.js
+++ /dev/null
@@ -1,7 +0,0 @@
-import prisma from 'lib/prisma';
-
-export async function createUser(data) {
- return prisma.client.user.create({
- data,
- });
-}
diff --git a/queries/admin/user/createUser.ts b/queries/admin/user/createUser.ts
new file mode 100644
index 000000000..c16040441
--- /dev/null
+++ b/queries/admin/user/createUser.ts
@@ -0,0 +1,20 @@
+import prisma from 'lib/prisma';
+
+export async function createUser(data: {
+ id: string;
+ username: string;
+ password: string;
+}): Promise<{
+ id: string;
+ username: string;
+ isAdmin: boolean;
+}> {
+ return prisma.client.user.create({
+ data,
+ select: {
+ id: true,
+ username: true,
+ isAdmin: true,
+ },
+ });
+}
diff --git a/queries/admin/user/deleteUser.js b/queries/admin/user/deleteUser.ts
similarity index 83%
rename from queries/admin/user/deleteUser.js
rename to queries/admin/user/deleteUser.ts
index 5970d2a5e..bb5562255 100644
--- a/queries/admin/user/deleteUser.js
+++ b/queries/admin/user/deleteUser.ts
@@ -1,7 +1,10 @@
import prisma from 'lib/prisma';
import cache from 'lib/cache';
+import { Prisma, User } from '@prisma/client';
-export async function deleteUser(userId) {
+export async function deleteUser(
+ userId: string,
+): Promise<[Prisma.BatchPayload, Prisma.BatchPayload, Prisma.BatchPayload, User]> {
const { client } = prisma;
const websites = await client.website.findMany({
diff --git a/queries/admin/user/getUser.js b/queries/admin/user/getUser.js
deleted file mode 100644
index 6c9ebd884..000000000
--- a/queries/admin/user/getUser.js
+++ /dev/null
@@ -1,7 +0,0 @@
-import prisma from 'lib/prisma';
-
-export async function getUser(where) {
- return prisma.client.user.findUnique({
- where,
- });
-}
diff --git a/queries/admin/user/getUser.ts b/queries/admin/user/getUser.ts
new file mode 100644
index 000000000..c353886e9
--- /dev/null
+++ b/queries/admin/user/getUser.ts
@@ -0,0 +1,25 @@
+import prisma from 'lib/prisma';
+import { Prisma } from '@prisma/client';
+
+export interface User {
+ id: string;
+ username: string;
+ isAdmin: boolean;
+ password?: string;
+ createdAt?: Date;
+}
+
+export async function getUser(
+ where: Prisma.UserWhereUniqueInput,
+ includePassword = false,
+): Promise<User> {
+ return prisma.client.user.findUnique({
+ where,
+ select: {
+ id: true,
+ username: true,
+ isAdmin: true,
+ password: includePassword,
+ },
+ });
+}
diff --git a/queries/admin/user/getUsers.js b/queries/admin/user/getUsers.ts
similarity index 76%
rename from queries/admin/user/getUsers.js
rename to queries/admin/user/getUsers.ts
index 2fc473cbf..e196d2320 100644
--- a/queries/admin/user/getUsers.js
+++ b/queries/admin/user/getUsers.ts
@@ -1,6 +1,7 @@
import prisma from 'lib/prisma';
+import { User } from './getUser';
-export async function getUsers() {
+export async function getUsers(): Promise<User[]> {
return prisma.client.user.findMany({
orderBy: [
{ isAdmin: 'desc' },
diff --git a/queries/admin/user/updateUser.js b/queries/admin/user/updateUser.js
deleted file mode 100644
index ea80cf434..000000000
--- a/queries/admin/user/updateUser.js
+++ /dev/null
@@ -1,8 +0,0 @@
-import prisma from 'lib/prisma';
-
-export async function updateUser(data, where) {
- return prisma.client.user.update({
- where,
- data,
- });
-}
diff --git a/queries/admin/user/updateUser.ts b/queries/admin/user/updateUser.ts
new file mode 100644
index 000000000..f5a64e512
--- /dev/null
+++ b/queries/admin/user/updateUser.ts
@@ -0,0 +1,19 @@
+import { Prisma } from '@prisma/client';
+import prisma from 'lib/prisma';
+import { User } from './getUser';
+
+export async function updateUser(
+ data: Prisma.UserUpdateArgs,
+ where: Prisma.UserWhereUniqueInput,
+): Promise<User> {
+ return prisma.client.user.update({
+ where,
+ data,
+ select: {
+ id: true,
+ username: true,
+ isAdmin: true,
+ createdAt: true,
+ },
+ });
+}
diff --git a/queries/admin/website/createWebsite.js b/queries/admin/website/createWebsite.ts
similarity index 63%
rename from queries/admin/website/createWebsite.js
rename to queries/admin/website/createWebsite.ts
index 0afe0beae..51aa2e3fa 100644
--- a/queries/admin/website/createWebsite.js
+++ b/queries/admin/website/createWebsite.ts
@@ -1,7 +1,16 @@
-import prisma from 'lib/prisma';
+import { Website } from '@prisma/client';
import cache from 'lib/cache';
+import prisma from 'lib/prisma';
-export async function createWebsite(userId, data) {
+export async function createWebsite(
+ userId: string,
+ data: {
+ id: string;
+ name: string;
+ domain: string;
+ shareId?: string;
+ },
+): Promise<Website> {
return prisma.client.website
.create({
data: {
diff --git a/queries/admin/website/deleteWebsite.js b/queries/admin/website/deleteWebsite.ts
similarity index 52%
rename from queries/admin/website/deleteWebsite.js
rename to queries/admin/website/deleteWebsite.ts
index 685cee8a5..a3c57e671 100644
--- a/queries/admin/website/deleteWebsite.js
+++ b/queries/admin/website/deleteWebsite.ts
@@ -1,22 +1,25 @@
import prisma from 'lib/prisma';
import cache from 'lib/cache';
+import { Prisma, Website } from '@prisma/client';
-export async function deleteWebsite(id) {
+export async function deleteWebsite(
+ websiteId: string,
+): Promise<[Prisma.BatchPayload, Prisma.BatchPayload, Website]> {
const { client, transaction } = prisma;
return transaction([
client.websiteEvent.deleteMany({
- where: { websiteId: id },
+ where: { websiteId },
}),
client.session.deleteMany({
- where: { websiteId: id },
+ where: { websiteId },
}),
client.website.delete({
- where: { id },
+ where: { id: websiteId },
}),
]).then(async data => {
if (cache.enabled) {
- await cache.deleteWebsite(id);
+ await cache.deleteWebsite(websiteId);
}
return data;
diff --git a/queries/admin/website/getAllWebsites.js b/queries/admin/website/getAllWebsites.js
deleted file mode 100644
index f9ad262c7..000000000
--- a/queries/admin/website/getAllWebsites.js
+++ /dev/null
@@ -1,23 +0,0 @@
-import prisma from 'lib/prisma';
-
-export async function getAllWebsites() {
- let data = await prisma.client.website.findMany({
- orderBy: [
- {
- userId: 'asc',
- },
- {
- name: 'asc',
- },
- ],
- include: {
- user: {
- select: {
- username: true,
- },
- },
- },
- });
-
- return data.map(i => ({ ...i, user: i.user.username }));
-}
diff --git a/queries/admin/website/getAllWebsites.ts b/queries/admin/website/getAllWebsites.ts
new file mode 100644
index 000000000..1e68693a5
--- /dev/null
+++ b/queries/admin/website/getAllWebsites.ts
@@ -0,0 +1,24 @@
+import { Website } from '@prisma/client';
+import prisma from 'lib/prisma';
+
+export async function getAllWebsites(): Promise<(Website & { user: string })[]> {
+ return await prisma.client.website
+ .findMany({
+ orderBy: [
+ {
+ userId: 'asc',
+ },
+ {
+ name: 'asc',
+ },
+ ],
+ include: {
+ user: {
+ select: {
+ username: true,
+ },
+ },
+ },
+ })
+ .then(data => data.map(i => ({ ...i, user: i.user.username })));
+}
diff --git a/queries/admin/website/getUserWebsites.js b/queries/admin/website/getUserWebsites.ts
similarity index 59%
rename from queries/admin/website/getUserWebsites.js
rename to queries/admin/website/getUserWebsites.ts
index c1a9d5597..f4fa27b9a 100644
--- a/queries/admin/website/getUserWebsites.js
+++ b/queries/admin/website/getUserWebsites.ts
@@ -1,6 +1,7 @@
import prisma from 'lib/prisma';
+import { Website } from '@prisma/client';
-export async function getUserWebsites(userId) {
+export async function getUserWebsites(userId): Promise<Website[]> {
return prisma.client.website.findMany({
where: {
userId,
diff --git a/queries/admin/website/getWebsite.js b/queries/admin/website/getWebsite.js
deleted file mode 100644
index 83c3e83a9..000000000
--- a/queries/admin/website/getWebsite.js
+++ /dev/null
@@ -1,7 +0,0 @@
-import prisma from 'lib/prisma';
-
-export async function getWebsite(where) {
- return prisma.client.website.findUnique({
- where,
- });
-}
diff --git a/queries/admin/website/getWebsite.ts b/queries/admin/website/getWebsite.ts
new file mode 100644
index 000000000..9ec27cb92
--- /dev/null
+++ b/queries/admin/website/getWebsite.ts
@@ -0,0 +1,8 @@
+import prisma from 'lib/prisma';
+import { Prisma, Website } from '@prisma/client';
+
+export async function getWebsite(where: Prisma.WebsiteWhereUniqueInput): Promise<Website> {
+ return prisma.client.website.findUnique({
+ where,
+ });
+}
diff --git a/queries/admin/website/resetWebsite.js b/queries/admin/website/resetWebsite.ts
similarity index 51%
rename from queries/admin/website/resetWebsite.js
rename to queries/admin/website/resetWebsite.ts
index f4d685cb9..05116f8aa 100644
--- a/queries/admin/website/resetWebsite.js
+++ b/queries/admin/website/resetWebsite.ts
@@ -1,20 +1,23 @@
+import { Prisma, Website } from '@prisma/client';
+import cache from 'lib/cache';
import prisma from 'lib/prisma';
import { getWebsite } from 'queries';
-import cache from 'lib/cache';
-export async function resetWebsite(id) {
+export async function resetWebsite(
+ websiteId,
+): Promise<[Prisma.BatchPayload, Prisma.BatchPayload, Website]> {
const { client, transaction } = prisma;
- const { revId } = await getWebsite({ id });
+ const { revId } = await getWebsite({ id: websiteId });
return transaction([
client.websiteEvent.deleteMany({
- where: { websiteId: id },
+ where: { websiteId },
}),
client.session.deleteMany({
- where: { websiteId: id },
+ where: { websiteId },
}),
- client.website.update({ where: { id }, data: { revId: revId + 1 } }),
+ client.website.update({ where: { id: websiteId }, data: { revId: revId + 1 } }),
]).then(async data => {
if (cache.enabled) {
await cache.storeWebsite(data[2]);
diff --git a/queries/admin/website/updateWebsite.js b/queries/admin/website/updateWebsite.js
deleted file mode 100644
index 5ac70a61f..000000000
--- a/queries/admin/website/updateWebsite.js
+++ /dev/null
@@ -1,10 +0,0 @@
-import prisma from 'lib/prisma';
-
-export async function updateWebsite(id, data) {
- return prisma.client.website.update({
- where: {
- id,
- },
- data,
- });
-}
diff --git a/queries/admin/website/updateWebsite.ts b/queries/admin/website/updateWebsite.ts
new file mode 100644
index 000000000..51787222a
--- /dev/null
+++ b/queries/admin/website/updateWebsite.ts
@@ -0,0 +1,11 @@
+import { Prisma, Website } from '@prisma/client';
+import prisma from 'lib/prisma';
+
+export async function updateWebsite(websiteId, data: Prisma.WebsiteUpdateInput): Promise<Website> {
+ return prisma.client.website.update({
+ where: {
+ id: websiteId,
+ },
+ data,
+ });
+}
diff --git a/queries/analytics/event/getEventData.js b/queries/analytics/event/getEventData.ts
similarity index 54%
rename from queries/analytics/event/getEventData.js
rename to queries/analytics/event/getEventData.ts
index f7d725c18..2e776f52d 100644
--- a/queries/analytics/event/getEventData.js
+++ b/queries/analytics/event/getEventData.ts
@@ -2,8 +2,21 @@ import clickhouse from 'lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
import prisma from 'lib/prisma';
import cache from 'lib/cache';
+import { WebsiteMetric } from 'interface/api/models';
+import { UmamiApi } from 'interface/enum';
-export async function getEventData(...args) {
+export async function getEventData(
+ ...args: [
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ event_name: string;
+ columns: any;
+ filters: object;
+ },
+ ]
+): Promise<WebsiteMetric[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -14,31 +27,48 @@ export async function getEventData(...args) {
});
}
-async function relationalQuery(websiteId, { startDate, endDate, event_name, columns, filters }) {
+async function relationalQuery(
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ event_name: string;
+ columns: any;
+ filters: object;
+ },
+) {
+ const { startDate, endDate, event_name, columns, filters } = data;
const { rawQuery, getEventDataColumnsQuery, getEventDataFilterQuery } = prisma;
const params = [startDate, endDate];
return rawQuery(
`select
- ${getEventDataColumnsQuery('event_data.event_data', columns)}
- from event
- join website
- on event.website_id = website.website_id
- join event_data
- on event.event_id = event_data.event_id
- where website.website_id ='${websiteId}'
- and event.created_at between $1 and $2
+ ${getEventDataColumnsQuery('event_data', columns)}
+ from website_event
+ where website_id ='${websiteId}'
+ and created_at between $1 and $2
+ and event_type = ${UmamiApi.EventType.Event}
${event_name ? `and event_name = ${event_name}` : ''}
${
Object.keys(filters).length > 0
- ? `and ${getEventDataFilterQuery('event_data.event_data', filters)}`
+ ? `and ${getEventDataFilterQuery('event_data', filters)}`
: ''
}`,
params,
);
}
-async function clickhouseQuery(websiteId, { startDate, endDate, event_name, columns, filters }) {
+async function clickhouseQuery(
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ event_name: string;
+ columns: any;
+ filters: object;
+ },
+) {
+ const { startDate, endDate, event_name, columns, filters } = data;
const { rawQuery, getBetweenDates, getEventDataColumnsQuery, getEventDataFilterQuery } =
clickhouse;
const website = await cache.fetchWebsite(websiteId);
@@ -50,6 +80,7 @@ async function clickhouseQuery(websiteId, { startDate, endDate, event_name, colu
from event
where website_id = $1
and rev_id = $2
+ and event_type = ${UmamiApi.EventType.Event}
${event_name ? `and event_name = ${event_name}` : ''}
and ${getBetweenDates('created_at', startDate, endDate)}
${
diff --git a/queries/analytics/event/getEventMetrics.js b/queries/analytics/event/getEventMetrics.js
deleted file mode 100644
index 27ee6d041..000000000
--- a/queries/analytics/event/getEventMetrics.js
+++ /dev/null
@@ -1,68 +0,0 @@
-import prisma from 'lib/prisma';
-import clickhouse from 'lib/clickhouse';
-import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-import cache from 'lib/cache';
-
-export async function getEventMetrics(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-async function relationalQuery(
- websiteId,
- start_at,
- end_at,
- timezone = 'utc',
- unit = 'day',
- filters = {},
-) {
- const { rawQuery, getDateQuery, getFilterQuery } = prisma;
- const params = [start_at, end_at];
-
- return rawQuery(
- `select
- event_name x,
- ${getDateQuery('event.created_at', unit, timezone)} t,
- count(*) y
- from event
- join website
- on event.website_id = website.website_id
- where website.website_id='${websiteId}'
- and event.created_at between $1 and $2
- ${getFilterQuery('event', filters, params)}
- group by 1, 2
- order by 2`,
- params,
- );
-}
-
-async function clickhouseQuery(
- websiteId,
- start_at,
- end_at,
- timezone = 'UTC',
- unit = 'day',
- filters = {},
-) {
- const { rawQuery, getDateQuery, getBetweenDates, getFilterQuery } = clickhouse;
- const website = await cache.fetchWebsite(websiteId);
- const params = [websiteId, website?.revId || 0];
-
- return rawQuery(
- `select
- event_name x,
- ${getDateQuery('created_at', unit, timezone)} t,
- count(*) y
- from event
- where event_name != ''
- and website_id = $1
- and rev_id = $2
- and ${getBetweenDates('created_at', start_at, end_at)}
- ${getFilterQuery('event', filters, params)}
- group by x, t
- order by t`,
- params,
- );
-}
diff --git a/queries/analytics/event/getEventMetrics.ts b/queries/analytics/event/getEventMetrics.ts
new file mode 100644
index 000000000..c2e819c49
--- /dev/null
+++ b/queries/analytics/event/getEventMetrics.ts
@@ -0,0 +1,105 @@
+import prisma from 'lib/prisma';
+import clickhouse from 'lib/clickhouse';
+import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
+import cache from 'lib/cache';
+import { WebsiteEventMetric } from 'interface/api/models';
+import { UmamiApi } from 'interface/enum';
+
+export async function getEventMetrics(
+ ...args: [
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ timezone: string;
+ unit: string;
+ filters: {
+ url: string;
+ eventName: string;
+ };
+ },
+ ]
+): Promise<WebsiteEventMetric[]> {
+ return runQuery({
+ [PRISMA]: () => relationalQuery(...args),
+ [CLICKHOUSE]: () => clickhouseQuery(...args),
+ });
+}
+
+async function relationalQuery(
+ websiteId: string,
+ {
+ startDate,
+ endDate,
+ timezone = 'utc',
+ unit = 'day',
+ filters,
+ }: {
+ startDate: Date;
+ endDate: Date;
+ timezone: string;
+ unit: string;
+ filters: {
+ url: string;
+ eventName: string;
+ };
+ },
+) {
+ const { rawQuery, getDateQuery, getFilterQuery } = prisma;
+ const params = [startDate, endDate];
+
+ return rawQuery(
+ `select
+ event_name x,
+ ${getDateQuery('created_at', unit, timezone)} t,
+ count(*) y
+ from website_event
+ where website_id='${websiteId}'
+ and created_at between $1 and $2
+ and event_type = ${UmamiApi.EventType.Event}
+ ${getFilterQuery(filters, params)}
+ group by 1, 2
+ order by 2`,
+ params,
+ );
+}
+
+async function clickhouseQuery(
+ websiteId: string,
+ {
+ startDate,
+ endDate,
+ timezone = 'utc',
+ unit = 'day',
+ filters,
+ }: {
+ startDate: Date;
+ endDate: Date;
+ timezone: string;
+ unit: string;
+ filters: {
+ url: string;
+ eventName: string;
+ };
+ },
+) {
+ const { rawQuery, getDateQuery, getBetweenDates, getFilterQuery } = clickhouse;
+ const website = await cache.fetchWebsite(websiteId);
+ const params = [websiteId, website?.revId || 0];
+
+ return rawQuery(
+ `select
+ event_name x,
+ ${getDateQuery('created_at', unit, timezone)} t,
+ count(*) y
+ from event
+ where website_id = $1
+ and rev_id = $2
+ and event_type = ${UmamiApi.EventType.Event}
+ and ${getBetweenDates('created_at', startDate, endDate)}
+ ${getFilterQuery(filters, params)}
+ group by x, t
+ order by t`,
+ params,
+ );
+}
diff --git a/queries/analytics/event/getEvents.js b/queries/analytics/event/getEvents.js
deleted file mode 100644
index 81a187cec..000000000
--- a/queries/analytics/event/getEvents.js
+++ /dev/null
@@ -1,45 +0,0 @@
-import prisma from 'lib/prisma';
-import clickhouse from 'lib/clickhouse';
-import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-
-export function getEvents(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-function relationalQuery(websites, start_at) {
- return prisma.client.event.findMany({
- where: {
- websiteId: {
- in: websites,
- },
- createdAt: {
- gte: start_at,
- },
- },
- });
-}
-
-function clickhouseQuery(websites, start_at) {
- const { rawQuery, getDateFormat, getCommaSeparatedStringFormat } = clickhouse;
-
- return rawQuery(
- `select
- event_id,
- website_id,
- session_id,
- created_at,
- url,
- event_name
- from event
- where event_name != ''
- and ${
- websites && websites.length > 0
- ? `website_id in (${getCommaSeparatedStringFormat(websites)})`
- : '0 = 0'
- }
- and created_at >= ${getDateFormat(start_at)}`,
- );
-}
diff --git a/queries/analytics/event/saveEvent.js b/queries/analytics/event/saveEvent.js
deleted file mode 100644
index 3bb3b0bf3..000000000
--- a/queries/analytics/event/saveEvent.js
+++ /dev/null
@@ -1,62 +0,0 @@
-import { EVENT_NAME_LENGTH, URL_LENGTH } from 'lib/constants';
-import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
-import kafka from 'lib/kafka';
-import prisma from 'lib/prisma';
-import { uuid } from 'lib/crypto';
-import cache from 'lib/cache';
-
-export async function saveEvent(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-async function relationalQuery(data) {
- const { websiteId, sessionId, url, eventName, eventData } = data;
- const eventId = uuid();
-
- const params = {
- id: eventId,
- websiteId,
- sessionId,
- url: url?.substring(0, URL_LENGTH),
- eventName: eventName?.substring(0, EVENT_NAME_LENGTH),
- };
-
- if (eventData) {
- params.eventData = {
- create: {
- id: eventId,
- eventData: eventData,
- },
- };
- }
-
- return prisma.client.event.create({
- data: params,
- });
-}
-
-async function clickhouseQuery(data) {
- const { websiteId, id: sessionId, url, eventName, eventData, country, ...args } = data;
- const { getDateFormat, sendMessage } = kafka;
- const website = await cache.fetchWebsite(websiteId);
-
- const params = {
- website_id: websiteId,
- session_id: sessionId,
- event_id: uuid(),
- url: url?.substring(0, URL_LENGTH),
- event_name: eventName?.substring(0, EVENT_NAME_LENGTH),
- event_data: eventData ? JSON.stringify(eventData) : null,
- rev_id: website?.revId || 0,
- created_at: getDateFormat(new Date()),
- country: country ? country : null,
- ...args,
- };
-
- await sendMessage(params, 'event');
-
- return data;
-}
diff --git a/queries/analytics/event/saveEvent.ts b/queries/analytics/event/saveEvent.ts
new file mode 100644
index 000000000..6bb44ef57
--- /dev/null
+++ b/queries/analytics/event/saveEvent.ts
@@ -0,0 +1,91 @@
+import { EVENT_NAME_LENGTH, URL_LENGTH } from 'lib/constants';
+import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
+import kafka from 'lib/kafka';
+import prisma from 'lib/prisma';
+import { uuid } from 'lib/crypto';
+import cache from 'lib/cache';
+import { UmamiApi } from 'interface/enum';
+
+export async function saveEvent(args: {
+ id: string;
+ websiteId: string;
+ url: string;
+ referrer?: string;
+ eventName?: string;
+ eventData?: any;
+ hostname?: string;
+ browser?: string;
+ os?: string;
+ device?: string;
+ screen?: string;
+ language?: string;
+ country?: string;
+}) {
+ return runQuery({
+ [PRISMA]: () => relationalQuery(args),
+ [CLICKHOUSE]: () => clickhouseQuery(args),
+ });
+}
+
+async function relationalQuery(data: {
+ id: string;
+ websiteId: string;
+ url: string;
+ referrer?: string;
+ eventName?: string;
+ eventData?: any;
+}) {
+ const { websiteId, id: sessionId, url, eventName, eventData, referrer } = data;
+
+ const params = {
+ id: uuid(),
+ websiteId,
+ sessionId,
+ url: url?.substring(0, URL_LENGTH),
+ referrer: referrer?.substring(0, URL_LENGTH),
+ eventType: UmamiApi.EventType.Event,
+ eventName: eventName?.substring(0, EVENT_NAME_LENGTH),
+ eventData,
+ };
+
+ return prisma.client.websiteEvent.create({
+ data: params,
+ });
+}
+
+async function clickhouseQuery(data: {
+ id: string;
+ websiteId: string;
+ url: string;
+ referrer?: string;
+ eventName?: string;
+ eventData?: any;
+ hostname?: string;
+ browser?: string;
+ os?: string;
+ device?: string;
+ screen?: string;
+ language?: string;
+ country?: string;
+}) {
+ const { websiteId, id: sessionId, url, eventName, eventData, country, ...args } = data;
+ const { getDateFormat, sendMessage } = kafka;
+ const website = await cache.fetchWebsite(websiteId);
+
+ const params = {
+ website_id: websiteId,
+ session_id: sessionId,
+ event_id: uuid(),
+ url: url?.substring(0, URL_LENGTH),
+ event_name: eventName?.substring(0, EVENT_NAME_LENGTH),
+ event_data: eventData ? JSON.stringify(eventData) : null,
+ rev_id: website?.revId || 0,
+ created_at: getDateFormat(new Date()),
+ country: country ? country : null,
+ ...args,
+ };
+
+ await sendMessage(params, 'event');
+
+ return data;
+}
diff --git a/queries/analytics/pageview/getPageviewMetrics.js b/queries/analytics/pageview/getPageviewMetrics.js
deleted file mode 100644
index 8dfd6595e..000000000
--- a/queries/analytics/pageview/getPageviewMetrics.js
+++ /dev/null
@@ -1,59 +0,0 @@
-import prisma from 'lib/prisma';
-import clickhouse from 'lib/clickhouse';
-import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-import cache from 'lib/cache';
-
-export async function getPageviewMetrics(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-async function relationalQuery(websiteId, { startDate, endDate, column, table, filters = {} }) {
- const { rawQuery, parseFilters } = prisma;
- const params = [startDate, endDate];
- const { pageviewQuery, sessionQuery, eventQuery, joinSession } = parseFilters(
- table,
- column,
- filters,
- params,
- );
-
- return rawQuery(
- `select ${column} x, count(*) y
- from ${table}
- ${` join website on ${table}.website_id = website.website_id`}
- ${joinSession}
- where website.website_id='${websiteId}'
- and ${table}.created_at between $1 and $2
- ${pageviewQuery}
- ${joinSession && sessionQuery}
- ${eventQuery}
- group by 1
- order by 2 desc`,
- params,
- );
-}
-
-async function clickhouseQuery(websiteId, { startDate, endDate, column, filters = {} }) {
- const { rawQuery, parseFilters, getBetweenDates } = clickhouse;
- const website = await cache.fetchWebsite(websiteId);
- const params = [websiteId, website?.revId || 0];
- const { pageviewQuery, sessionQuery, eventQuery } = parseFilters(column, filters, params);
-
- return rawQuery(
- `select ${column} x, count(*) y
- from event
- where website_id = $1
- and rev_id = $2
- ${column !== 'event_name' ? `and event_name = ''` : `and event_name != ''`}
- and ${getBetweenDates('created_at', startDate, endDate)}
- ${pageviewQuery}
- ${sessionQuery}
- ${eventQuery}
- group by x
- order by y desc`,
- params,
- );
-}
diff --git a/queries/analytics/pageview/getPageviewMetrics.ts b/queries/analytics/pageview/getPageviewMetrics.ts
new file mode 100644
index 000000000..106d14a95
--- /dev/null
+++ b/queries/analytics/pageview/getPageviewMetrics.ts
@@ -0,0 +1,82 @@
+import prisma from 'lib/prisma';
+import clickhouse from 'lib/clickhouse';
+import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
+import cache from 'lib/cache';
+import { Prisma } from '@prisma/client';
+import { UmamiApi } from 'interface/enum';
+
+export async function getPageviewMetrics(
+ ...args: [
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ column: Prisma.WebsiteEventScalarFieldEnum | Prisma.SessionScalarFieldEnum;
+ table: string;
+ filters: object;
+ },
+ ]
+) {
+ return runQuery({
+ [PRISMA]: () => relationalQuery(...args),
+ [CLICKHOUSE]: () => clickhouseQuery(...args),
+ });
+}
+
+async function relationalQuery(
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ column: Prisma.WebsiteEventScalarFieldEnum | Prisma.SessionScalarFieldEnum;
+ filters: object;
+ },
+) {
+ const { startDate, endDate, column, filters = {} } = data;
+ const { rawQuery, parseFilters } = prisma;
+ const params = [startDate, endDate];
+ const { filterQuery, joinSession } = parseFilters(filters, params);
+
+ return rawQuery(
+ `select ${column} x, count(*) y
+ from website_event
+ ${joinSession}
+ where website_id='${websiteId}'
+ and website_event.created_at between $1 and $2
+ and event_type = ${UmamiApi.EventType.Pageview}
+ ${filterQuery}
+ group by 1
+ order by 2 desc`,
+ params,
+ );
+}
+
+async function clickhouseQuery(
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ column: Prisma.WebsiteEventScalarFieldEnum | Prisma.SessionScalarFieldEnum;
+ filters: object;
+ },
+) {
+ const { startDate, endDate, column, filters = {} } = data;
+ const { rawQuery, parseFilters, getBetweenDates } = clickhouse;
+ const website = await cache.fetchWebsite(websiteId);
+ const params = [websiteId, website?.revId || 0];
+ const { filterQuery } = parseFilters(filters, params);
+
+ return rawQuery(
+ `select ${column} x, count(*) y
+ from event
+ where website_id = $1
+ and rev_id = $2
+ and event_type = ${UmamiApi.EventType.Pageview}
+ ${column !== 'event_name' ? `and event_name = ''` : `and event_name != ''`}
+ and ${getBetweenDates('created_at', startDate, endDate)}
+ ${filterQuery}
+ group by x
+ order by y desc`,
+ params,
+ );
+}
diff --git a/queries/analytics/pageview/getPageviewParams.js b/queries/analytics/pageview/getPageviewParams.js
deleted file mode 100644
index ce96c25b9..000000000
--- a/queries/analytics/pageview/getPageviewParams.js
+++ /dev/null
@@ -1,41 +0,0 @@
-import prisma from 'lib/prisma';
-import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-
-export async function getPageviewParams(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-async function relationalQuery(websiteId, start_at, end_at, column, table, filters = {}) {
- const { parseFilters, rawQuery } = prisma;
- const params = [start_at, end_at];
- const { pageviewQuery, sessionQuery, eventQuery, joinSession } = parseFilters(
- table,
- column,
- filters,
- params,
- );
-
- return rawQuery(
- `select url x,
- count(*) y
- from ${table}
- ${` join website on ${table}.website_id = website.website_id`}
- ${joinSession}
- where website.website_id='${websiteId}'
- and ${table}.created_at between $1 and $2
- and ${table}.url like '%?%'
- ${pageviewQuery}
- ${joinSession && sessionQuery}
- ${eventQuery}
- group by 1
- order by 2 desc`,
- params,
- );
-}
-
-function clickhouseQuery() {
- return Promise.reject(new Error('Not implemented.'));
-}
diff --git a/queries/analytics/pageview/getPageviewStats.js b/queries/analytics/pageview/getPageviewStats.js
deleted file mode 100644
index c711d448a..000000000
--- a/queries/analytics/pageview/getPageviewStats.js
+++ /dev/null
@@ -1,78 +0,0 @@
-import prisma from 'lib/prisma';
-import clickhouse from 'lib/clickhouse';
-import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-import cache from 'lib/cache';
-
-export async function getPageviewStats(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-async function relationalQuery(
- websiteId,
- {
- start_at,
- end_at,
- timezone = 'utc',
- unit = 'day',
- count = '*',
- filters = {},
- sessionKey = 'session_id',
- },
-) {
- const { getDateQuery, parseFilters, rawQuery } = prisma;
- const params = [start_at, end_at];
- const { pageviewQuery, sessionQuery, joinSession } = parseFilters(
- 'pageview',
- null,
- filters,
- params,
- );
-
- return rawQuery(
- `select ${getDateQuery('pageview.created_at', unit, timezone)} t,
- count(${count !== '*' ? `${count}${sessionKey}` : count}) y
- from pageview
- join website
- on pageview.website_id = website.website_id
- ${joinSession}
- where website.website_id='${websiteId}'
- and pageview.created_at between $1 and $2
- ${pageviewQuery}
- ${sessionQuery}
- group by 1`,
- params,
- );
-}
-
-async function clickhouseQuery(
- websiteId,
- { start_at, end_at, timezone = 'UTC', unit = 'day', count = '*', filters = {} },
-) {
- const { parseFilters, rawQuery, getDateStringQuery, getDateQuery, getBetweenDates } = clickhouse;
- const website = await cache.fetchWebsite(websiteId);
- const params = [websiteId, website?.revId || 0];
- const { pageviewQuery, sessionQuery } = parseFilters(null, filters, params);
-
- return rawQuery(
- `select
- ${getDateStringQuery('g.t', unit)} as t,
- g.y as y
- from
- (select
- ${getDateQuery('created_at', unit, timezone)} t,
- count(${count !== '*' ? 'distinct session_id' : count}) y
- from event
- where event_name = ''
- and website_id = $1
- and rev_id = $2
- and ${getBetweenDates('created_at', start_at, end_at)}
- ${pageviewQuery}
- ${sessionQuery}
- group by t) g
- order by t`,
- params,
- );
-}
diff --git a/queries/analytics/pageview/getPageviewStats.ts b/queries/analytics/pageview/getPageviewStats.ts
new file mode 100644
index 000000000..4a7a7782c
--- /dev/null
+++ b/queries/analytics/pageview/getPageviewStats.ts
@@ -0,0 +1,102 @@
+import cache from 'lib/cache';
+import clickhouse from 'lib/clickhouse';
+import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
+import prisma from 'lib/prisma';
+import { UmamiApi } from 'interface/enum';
+
+export async function getPageviewStats(
+ ...args: [
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ timezone?: string;
+ unit?: string;
+ count?: string;
+ filters: object;
+ sessionKey?: string;
+ },
+ ]
+) {
+ return runQuery({
+ [PRISMA]: () => relationalQuery(...args),
+ [CLICKHOUSE]: () => clickhouseQuery(...args),
+ });
+}
+
+async function relationalQuery(
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ timezone?: string;
+ unit?: string;
+ count?: string;
+ filters: object;
+ sessionKey?: string;
+ },
+) {
+ const {
+ startDate,
+ endDate,
+ timezone = 'utc',
+ unit = 'day',
+ count = '*',
+ filters = {},
+ sessionKey = 'session_id',
+ } = data;
+ const { getDateQuery, parseFilters, rawQuery } = prisma;
+ const params = [startDate, endDate];
+ const { filterQuery, joinSession } = parseFilters(filters, params);
+
+ return rawQuery(
+ `select ${getDateQuery('website_event.created_at', unit, timezone)} t,
+ count(${count !== '*' ? `${count}${sessionKey}` : count}) y
+ from website_event
+ ${joinSession}
+ where website.website_id='${websiteId}'
+ and pageview.created_at between $1 and $2
+ and event_type = ${UmamiApi.EventType.Pageview}
+ ${filterQuery}
+ group by 1`,
+ params,
+ );
+}
+
+async function clickhouseQuery(
+ websiteId: string,
+ data: {
+ startDate: Date;
+ endDate: Date;
+ timezone?: string;
+ unit?: string;
+ count?: string;
+ filters: object;
+ sessionKey?: string;
+ },
+) {
+ const { startDate, endDate, timezone = 'UTC', unit = 'day', count = '*', filters = {} } = data;
+ const { parseFilters, rawQuery, getDateStringQuery, getDateQuery, getBetweenDates } = clickhouse;
+ const website = await cache.fetchWebsite(websiteId);
+ const params = [websiteId, website?.revId || 0];
+ const { filterQuery } = parseFilters(filters, params);
+
+ return rawQuery(
+ `select
+ ${getDateStringQuery('g.t', unit)} as t,
+ g.y as y
+ from
+ (select
+ ${getDateQuery('created_at', unit, timezone)} t,
+ count(${count !== '*' ? 'distinct session_id' : count}) y
+ from event
+ where website_id = $1
+ and rev_id = $2
+ and event_type = ${UmamiApi.EventType.Pageview}
+ and ${getBetweenDates('created_at', startDate, endDate)}
+ ${filterQuery}
+ group by t) g
+ order by t`,
+ params,
+ );
+}
diff --git a/queries/analytics/pageview/getPageviews.js b/queries/analytics/pageview/getPageviews.js
deleted file mode 100644
index 2bf41b0b2..000000000
--- a/queries/analytics/pageview/getPageviews.js
+++ /dev/null
@@ -1,43 +0,0 @@
-import prisma from 'lib/prisma';
-import clickhouse from 'lib/clickhouse';
-import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-
-export async function getPageviews(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-async function relationalQuery(websites, start_at) {
- return prisma.client.pageview.findMany({
- where: {
- websiteId: {
- in: websites,
- },
- createdAt: {
- gte: start_at,
- },
- },
- });
-}
-
-async function clickhouseQuery(websites, start_at) {
- const { rawQuery, getCommaSeparatedStringFormat } = clickhouse;
-
- return rawQuery(
- `select
- website_id,
- session_id,
- created_at,
- url
- from event
- where event_name = ''
- and ${
- websites && websites.length > 0
- ? `website_id in (${getCommaSeparatedStringFormat(websites)})`
- : '0 = 0'
- }
- and created_at >= ${clickhouse.getDateFormat(start_at)}`,
- );
-}
diff --git a/queries/analytics/pageview/savePageView.js b/queries/analytics/pageview/savePageView.ts
similarity index 60%
rename from queries/analytics/pageview/savePageView.js
rename to queries/analytics/pageview/savePageView.ts
index adcb4b3fd..134dfd098 100644
--- a/queries/analytics/pageview/savePageView.js
+++ b/queries/analytics/pageview/savePageView.ts
@@ -4,23 +4,43 @@ import kafka from 'lib/kafka';
import prisma from 'lib/prisma';
import cache from 'lib/cache';
import { uuid } from 'lib/crypto';
+import { UmamiApi } from 'interface/enum';
-export async function savePageView(...args) {
+export async function savePageView(args: {
+ id: string;
+ websiteId: string;
+ url: string;
+ referrer?: string;
+ hostname?: string;
+ browser?: string;
+ os?: string;
+ device?: string;
+ screen?: string;
+ language?: string;
+ country?: string;
+}) {
return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
+ [PRISMA]: () => relationalQuery(args),
+ [CLICKHOUSE]: () => clickhouseQuery(args),
});
}
-async function relationalQuery(data) {
- const { websiteId, sessionId, url, referrer } = data;
- return prisma.client.pageview.create({
+async function relationalQuery(data: {
+ id: string;
+ websiteId: string;
+ url: string;
+ referrer?: string;
+}) {
+ const { websiteId, id: sessionId, url, referrer } = data;
+
+ return prisma.client.websiteEvent.create({
data: {
id: uuid(),
websiteId,
sessionId,
url: url?.substring(0, URL_LENGTH),
referrer: referrer?.substring(0, URL_LENGTH),
+ eventType: UmamiApi.EventType.Pageview,
},
});
}
diff --git a/queries/analytics/session/createSession.js b/queries/analytics/session/createSession.ts
similarity index 63%
rename from queries/analytics/session/createSession.js
rename to queries/analytics/session/createSession.ts
index f401a20f5..fe15f11c4 100644
--- a/queries/analytics/session/createSession.js
+++ b/queries/analytics/session/createSession.ts
@@ -2,11 +2,12 @@ import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
import kafka from 'lib/kafka';
import prisma from 'lib/prisma';
import cache from 'lib/cache';
+import { Prisma } from '@prisma/client';
-export async function createSession(...args) {
+export async function createSession(args: Prisma.SessionCreateInput) {
return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
+ [PRISMA]: () => relationalQuery(args),
+ [CLICKHOUSE]: () => clickhouseQuery(args),
}).then(async data => {
if (cache.enabled) {
await cache.storeSession(data);
@@ -16,11 +17,21 @@ export async function createSession(...args) {
});
}
-async function relationalQuery(data) {
+async function relationalQuery(data: Prisma.SessionCreateInput) {
return prisma.client.session.create({ data });
}
-async function clickhouseQuery(data) {
+async function clickhouseQuery(data: {
+ id: string;
+ websiteId: string;
+ hostname?: string;
+ browser?: string;
+ os?: string;
+ device?: string;
+ screen?: string;
+ language?: string;
+ country?: string;
+}) {
const { id, websiteId, hostname, browser, os, device, screen, language, country } = data;
const { getDateFormat, sendMessage } = kafka;
const website = await cache.fetchWebsite(websiteId);
diff --git a/queries/analytics/session/getSession.js b/queries/analytics/session/getSession.ts
similarity index 64%
rename from queries/analytics/session/getSession.js
rename to queries/analytics/session/getSession.ts
index adc9acd86..198751176 100644
--- a/queries/analytics/session/getSession.js
+++ b/queries/analytics/session/getSession.ts
@@ -1,21 +1,22 @@
import clickhouse from 'lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from 'lib/db';
import prisma from 'lib/prisma';
+import { Prisma } from '@prisma/client';
-export async function getSession(...args) {
+export async function getSession(args: { id: string }) {
return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
+ [PRISMA]: () => relationalQuery(args),
+ [CLICKHOUSE]: () => clickhouseQuery(args),
});
}
-async function relationalQuery(where) {
+async function relationalQuery(where: Prisma.SessionWhereUniqueInput) {
return prisma.client.session.findUnique({
where,
});
}
-async function clickhouseQuery({ id: sessionId }) {
+async function clickhouseQuery({ id: sessionId }: { id: string }) {
const { rawQuery, findFirst } = clickhouse;
const params = [sessionId];
diff --git a/queries/analytics/session/getSessionMetrics.js b/queries/analytics/session/getSessionMetrics.ts
similarity index 63%
rename from queries/analytics/session/getSessionMetrics.js
rename to queries/analytics/session/getSessionMetrics.ts
index 6e74e9b69..77bc5a634 100644
--- a/queries/analytics/session/getSessionMetrics.js
+++ b/queries/analytics/session/getSessionMetrics.ts
@@ -3,17 +3,26 @@ import clickhouse from 'lib/clickhouse';
import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
import cache from 'lib/cache';
-export async function getSessionMetrics(...args) {
+export async function getSessionMetrics(
+ ...args: [
+ websiteId: string,
+ data: { startDate: Date; endDate: Date; field: string; filters: object },
+ ]
+) {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
});
}
-async function relationalQuery(websiteId, { startDate, endDate, field, filters = {} }) {
+async function relationalQuery(
+ websiteId: string,
+ data: { startDate: Date; endDate: Date; field: string; filters: object },
+) {
+ const { startDate, endDate, field, filters = {} } = data;
const { parseFilters, rawQuery } = prisma;
const params = [startDate, endDate];
- const { pageviewQuery, sessionQuery, joinSession } = parseFilters(null, filters, params);
+ const { filterQuery, joinSession } = parseFilters(filters, params);
return rawQuery(
`select ${field} x, count(*) y
@@ -26,8 +35,7 @@ async function relationalQuery(websiteId, { startDate, endDate, field, filters =
${joinSession}
where website.website_id='${websiteId}'
and pageview.created_at between $1 and $2
- ${pageviewQuery}
- ${sessionQuery}
+ ${filterQuery}
)
group by 1
order by 2 desc`,
@@ -35,11 +43,15 @@ async function relationalQuery(websiteId, { startDate, endDate, field, filters =
);
}
-async function clickhouseQuery(websiteId, { startDate, endDate, field, filters = {} }) {
+async function clickhouseQuery(
+ websiteId: string,
+ data: { startDate: Date; endDate: Date; field: string; filters: object },
+) {
+ const { startDate, endDate, field, filters = {} } = data;
const { parseFilters, getBetweenDates, rawQuery } = clickhouse;
const website = await cache.fetchWebsite(websiteId);
const params = [websiteId, website?.revId || 0];
- const { pageviewQuery, sessionQuery } = parseFilters(null, filters, params);
+ const { filterQuery } = parseFilters(filters, params);
return rawQuery(
`select ${field} x, count(*) y
@@ -48,8 +60,7 @@ async function clickhouseQuery(websiteId, { startDate, endDate, field, filters =
and rev_id = $2
and event_name = ''
and ${getBetweenDates('created_at', startDate, endDate)}
- ${pageviewQuery}
- ${sessionQuery}
+ ${filterQuery}
group by x
order by y desc`,
params,
diff --git a/queries/analytics/session/getSessions.js b/queries/analytics/session/getSessions.js
deleted file mode 100644
index c5fed4854..000000000
--- a/queries/analytics/session/getSessions.js
+++ /dev/null
@@ -1,52 +0,0 @@
-import prisma from 'lib/prisma';
-import clickhouse from 'lib/clickhouse';
-import { runQuery, PRISMA, CLICKHOUSE } from 'lib/db';
-
-export async function getSessions(...args) {
- return runQuery({
- [PRISMA]: () => relationalQuery(...args),
- [CLICKHOUSE]: () => clickhouseQuery(...args),
- });
-}
-
-async function relationalQuery(websites, start_at) {
- return prisma.client.session.findMany({
- where: {
- ...(websites && websites.length > 0
- ? {
- websiteId: {
- in: websites,
- },
- }
- : {}),
- createdAt: {
- gte: start_at,
- },
- },
- });
-}
-
-async function clickhouseQuery(websites, start_at) {
- const { rawQuery, getDateFormat, getCommaSeparatedStringFormat } = clickhouse;
-
- return rawQuery(
- `select distinct
- session_id,
- website_id,
- created_at,
- hostname,
- browser,
- os,
- device,
- screen,
- language,
- country
- from event
- where ${
- websites && websites.length > 0
- ? `website_id in (${getCommaSeparatedStringFormat(websites)})`
- : '0 = 0'
- }
- and created_at >= ${getDateFormat(start_at)}`,
- );
-}
diff --git a/queries/analytics/stats/getActiveVisitors.js b/queries/analytics/stats/getActiveVisitors.ts
similarity index 83%
rename from queries/analytics/stats/getActiveVisitors.js
rename to queries/analytics/stats/getActiveVisitors.ts
index c7592e5bf..0b07574d4 100644
--- a/queries/analytics/stats/getActiveVisitors.js
+++ b/queries/analytics/stats/getActiveVisitors.ts
@@ -3,14 +3,14 @@ import prisma from 'lib/prisma';
import clickhouse from 'lib/clickhouse';
import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
-export async function getActiveVisitors(...args) {
+export async function getActiveVisitors(...args: [websiteId: string]) {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
});
}
-async function relationalQuery(websiteId) {
+async function relationalQuery(websiteId: string) {
const date = subMinutes(new Date(), 5);
const params = [date];
@@ -25,7 +25,7 @@ async function relationalQuery(websiteId) {
);
}
-async function clickhouseQuery(websiteId) {
+async function clickhouseQuery(websiteId: string) {
const { rawQuery, getDateFormat } = clickhouse;
const params = [websiteId];
diff --git a/queries/analytics/stats/getRealtimeData.js b/queries/analytics/stats/getRealtimeData.js
deleted file mode 100644
index 659f61455..000000000
--- a/queries/analytics/stats/getRealtimeData.js
+++ /dev/null
@@ -1,30 +0,0 @@
-import { getPageviews } from '../pageview/getPageviews';
-import { getSessions } from '../session/getSessions';
-import { getEvents } from '../event/getEvents';
-
-export async function getRealtimeData(websites, time) {
- const [pageviews, sessions, events] = await Promise.all([
- getPageviews(websites, time),
- getSessions(websites, time),
- getEvents(websites, time),
- ]);
-
- return {
- pageviews: pageviews.map(({ id, ...props }) => ({
- __id: `p${id}`,
- pageviewId: id,
- ...props,
- })),
- sessions: sessions.map(({ id, ...props }) => ({
- __id: `s${id}`,
- sessionId: id,
- ...props,
- })),
- events: events.map(({ id, ...props }) => ({
- __id: `e${id}`,
- eventId: id,
- ...props,
- })),
- timestamp: Date.now(),
- };
-}
diff --git a/queries/analytics/stats/getRealtimeData.ts b/queries/analytics/stats/getRealtimeData.ts
new file mode 100644
index 000000000..042bcc469
--- /dev/null
+++ b/queries/analytics/stats/getRealtimeData.ts
@@ -0,0 +1,3 @@
+export async function getRealtimeData() {
+ throw new Error('Not Implemented');
+}
diff --git a/queries/analytics/stats/getWebsiteStats.js b/queries/analytics/stats/getWebsiteStats.ts
similarity index 70%
rename from queries/analytics/stats/getWebsiteStats.js
rename to queries/analytics/stats/getWebsiteStats.ts
index 002d8a9c1..bf5cdd962 100644
--- a/queries/analytics/stats/getWebsiteStats.js
+++ b/queries/analytics/stats/getWebsiteStats.ts
@@ -3,22 +3,23 @@ import clickhouse from 'lib/clickhouse';
import { runQuery, CLICKHOUSE, PRISMA } from 'lib/db';
import cache from 'lib/cache';
-export async function getWebsiteStats(...args) {
+export async function getWebsiteStats(
+ ...args: [websiteId: string, data: { startDate: Date; endDate: Date; filters: object }]
+) {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
});
}
-async function relationalQuery(websiteId, { start_at, end_at, filters = {} }) {
+async function relationalQuery(
+ websiteId: string,
+ data: { startDate: Date; endDate: Date; filters: object },
+) {
+ const { startDate, endDate, filters = {} } = data;
const { getDateQuery, getTimestampInterval, parseFilters, rawQuery } = prisma;
- const params = [start_at, end_at];
- const { pageviewQuery, sessionQuery, joinSession } = parseFilters(
- 'pageview',
- null,
- filters,
- params,
- );
+ const params = [startDate, endDate];
+ const { filterQuery, joinSession } = parseFilters(filters, params);
return rawQuery(
`select sum(t.c) as "pageviews",
@@ -36,19 +37,22 @@ async function relationalQuery(websiteId, { start_at, end_at, filters = {} }) {
${joinSession}
where website.website_id='${websiteId}'
and pageview.created_at between $1 and $2
- ${pageviewQuery}
- ${sessionQuery}
+ ${filterQuery}
group by 1, 2
) t`,
params,
);
}
-async function clickhouseQuery(websiteId, { start_at, end_at, filters = {} }) {
+async function clickhouseQuery(
+ websiteId: string,
+ data: { startDate: Date; endDate: Date; filters: object },
+) {
+ const { startDate, endDate, filters = {} } = data;
const { rawQuery, getDateQuery, getBetweenDates, parseFilters } = clickhouse;
const website = await cache.fetchWebsite(websiteId);
const params = [websiteId, website?.revId || 0];
- const { pageviewQuery, sessionQuery } = parseFilters(null, filters, params);
+ const { filterQuery } = parseFilters(filters, params);
return rawQuery(
`select
@@ -66,9 +70,8 @@ async function clickhouseQuery(websiteId, { start_at, end_at, filters = {} }) {
where event_name = ''
and website_id = $1
and rev_id = $2
- and ${getBetweenDates('created_at', start_at, end_at)}
- ${pageviewQuery}
- ${sessionQuery}
+ and ${getBetweenDates('created_at', startDate, endDate)}
+ ${filterQuery}
group by session_id, time_series
) t;`,
params,
diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644
index 000000000..cbb5413f8
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,28 @@
+{
+ "compilerOptions": {
+ "target": "es5",
+ "outDir": "./build",
+ "module": "esnext",
+ "moduleResolution": "node",
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ "incremental": true,
+ "lib": ["dom", "dom.iterable", "esnext"],
+ "skipLibCheck": true,
+ "esModuleInterop": true,
+ "noImplicitAny": false,
+ "preserveConstEnums": true,
+ "removeComments": true,
+ "sourceMap": true,
+ "allowSyntheticDefaultImports": true,
+ "forceConsistentCasingInFileNames": true,
+ "allowJs": true,
+ "strict": true,
+ "baseUrl": ".",
+ "strictNullChecks": false,
+ "noEmit": true,
+ "jsx": "preserve"
+ },
+ "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", "queries/admin/website/getAllWebsites.ts"],
+ "exclude": ["node_modules"]
+}