Generate explicit OpenAPI contracts for API routes

This commit is contained in:
Mike Cao committed 2026-09-01 15:09:10 -07:00
1 parent cc5d71d39f
commit e1a4934038
177 files changed
+50955 -1460

No files matched your search

+2 -2
View File
@@ -1,13 +1,13 @@
import clickhouse from '@/lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
import type { PropertyMetric, QueryFilters } from '@/lib/types';
const FUNCTION_NAME = 'getEventDataFields';
export async function getEventDataFields(
...args: [websiteId: string, eventName: string | undefined, filters: QueryFilters]
) {
): Promise<PropertyMetric[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -1,7 +1,7 @@
import clickhouse from '@/lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { EventPropertyFilter, QueryFilters } from '@/lib/types';
import type { EventPropertyFilter, QueryFilters, TimeSeriesValue } from '@/lib/types';
const FUNCTION_NAME = 'getEventDataNumericSeries';
@@ -14,7 +14,7 @@ export async function getEventDataNumericSeries(
filters: QueryFilters,
eventFilters?: EventPropertyFilter[],
]
) {
): Promise<TimeSeriesValue[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+2 -2
View File
@@ -1,7 +1,7 @@
import clickhouse from '@/lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { EventPropertyFilter, QueryFilters } from '@/lib/types';
import type { EventDataPivotRow, EventPropertyFilter, PageResult, QueryFilters } from '@/lib/types';
const FUNCTION_NAME = 'getEventDataPivot';
@@ -12,7 +12,7 @@ export async function getEventDataPivot(
filters: QueryFilters,
eventFilters?: EventPropertyFilter[],
]
) {
): Promise<PageResult<EventDataPivotRow[]>> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -3,11 +3,18 @@ import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
export interface EventDataProperty {
eventName: string;
propertyName: string;
dataType: number;
total: number;
}
const FUNCTION_NAME = 'getEventDataProperties';
export async function getEventDataProperties(
...args: [websiteId: string, filters: QueryFilters & { propertyName?: string }]
) {
): Promise<EventDataProperty[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+5 -4
View File
@@ -1,13 +1,14 @@
import clickhouse from '@/lib/clickhouse';
import { DEFAULT_PAGE_SIZE } from '@/lib/constants';
import { EVENT_TYPE } from '@/lib/constants';
import { DEFAULT_PAGE_SIZE, EVENT_TYPE } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
import type { PageResult, QueryFilters, WebsiteEvent } from '@/lib/types';
const FUNCTION_NAME = 'getWebsiteEvents';
export function getWebsiteEvents(...args: [websiteId: string, filters: QueryFilters]) {
export function getWebsiteEvents(
...args: [websiteId: string, filters: QueryFilters]
): Promise<PageResult<WebsiteEvent[]>> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+5 -2
View File
@@ -2,10 +2,13 @@ import { subMinutes } from 'date-fns';
import clickhouse from '@/lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { ActiveVisitors } from '@/lib/types';
const FUNCTION_NAME = 'getActiveVisitors';
export async function getActiveVisitors(...args: [websiteId: string]) {
export async function getActiveVisitors(
...args: [websiteId: string]
): Promise<ActiveVisitors | null> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -30,7 +33,7 @@ async function relationalQuery(websiteId: string) {
return result?.[0] ?? null;
}
async function clickhouseQuery(websiteId: string): Promise<{ x: number }> {
async function clickhouseQuery(websiteId: string): Promise<ActiveVisitors | null> {
const { rawQuery } = clickhouse;
const startDate = subMinutes(new Date(), 5);
+8 -3
View File
@@ -2,11 +2,13 @@ import clickhouse from '@/lib/clickhouse';
import { EVENT_TYPE } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
import type { QueryFilters, RealtimeActivity } from '@/lib/types';
const FUNCTION_NAME = 'getRealtimeActivity';
export async function getRealtimeActivity(...args: [websiteId: string, filters: QueryFilters]) {
export async function getRealtimeActivity(
...args: [websiteId: string, filters: QueryFilters]
): Promise<RealtimeActivity[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -50,7 +52,10 @@ async function relationalQuery(websiteId: string, filters: QueryFilters) {
);
}
async function clickhouseQuery(websiteId: string, filters: QueryFilters): Promise<{ x: number }> {
async function clickhouseQuery(
websiteId: string,
filters: QueryFilters,
): Promise<RealtimeActivity[]> {
const { rawQuery, parseFilters } = clickhouse;
const { queryParams, filterQuery, cohortQuery, dateQuery } = parseFilters({
...filters,
+11 -9
View File
@@ -1,4 +1,4 @@
import type { QueryFilters } from '@/lib/types';
import type { QueryFilters, RealtimeActivity, RealtimeData, RealtimeEvent } from '@/lib/types';
import { getRealtimeActivity } from '@/queries/sql/getRealtimeActivity';
import { getPageviewStats } from '@/queries/sql/pageviews/getPageviewStats';
import { getSessionStats } from '@/queries/sql/sessions/getSessionStats';
@@ -13,7 +13,10 @@ function increment(data: object, key: string) {
}
}
export async function getRealtimeData(websiteId: string, filters: QueryFilters) {
export async function getRealtimeData(
websiteId: string,
filters: QueryFilters,
): Promise<RealtimeData> {
const [activity, pageviews, sessions] = await Promise.all([
getRealtimeActivity(websiteId, filters),
getPageviewStats(websiteId, filters),
@@ -24,14 +27,13 @@ export async function getRealtimeData(websiteId: string, filters: QueryFilters)
const { countries, urls, referrers, events } = activity.reverse().reduce(
(
obj: { countries: any; urls: any; referrers: any; events: any },
event: {
sessionId: string;
urlPath: string;
referrerDomain: string;
country: string;
eventName: string;
obj: {
countries: Record<string, number>;
urls: Record<string, number>;
referrers: Record<string, number>;
events: RealtimeEvent[];
},
event: RealtimeActivity,
) => {
const { countries, urls, referrers, events } = obj;
const { sessionId, urlPath, referrerDomain, country, eventName } = event;
+4 -1
View File
@@ -2,8 +2,11 @@ import clickhouse from '@/lib/clickhouse';
import { DEFAULT_RESET_DATE } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { WebsiteDateRange } from '@/lib/types';
export async function getWebsiteDateRange(...args: [websiteId: string]) {
export async function getWebsiteDateRange(
...args: [websiteId: string]
): Promise<WebsiteDateRange | null> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+5 -3
View File
@@ -6,7 +6,9 @@ import type { QueryFilters } from '@/lib/types';
const FUNCTION_NAME = 'getWeeklyTraffic';
export async function getWeeklyTraffic(...args: [websiteId: string, filters: QueryFilters]) {
export async function getWeeklyTraffic(
...args: [websiteId: string, filters: QueryFilters]
): Promise<number[][]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -88,8 +90,8 @@ async function clickhouseQuery(websiteId: string, filters: QueryFilters) {
return rawQuery(sql, queryParams, FUNCTION_NAME).then(formatResults);
}
function formatResults(data: any) {
const days = [];
function formatResults(data: any): number[][] {
const days: number[][] = [];
for (let i = 0; i < 7; i++) {
days.push([]);
+2 -2
View File
@@ -1,13 +1,13 @@
import clickhouse from '@/lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
import type { PageResult, QueryFilters, SessionReplaySummary } from '@/lib/types';
const FUNCTION_NAME = 'getSessionReplays';
export function getSessionReplays(
...args: [websiteId: string, filters: QueryFilters, sessionId?: string]
) {
): Promise<PageResult<SessionReplaySummary[]>> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+1 -1
View File
@@ -25,7 +25,7 @@ export interface AttributionResult {
export async function getAttribution(
...args: [websiteId: string, parameters: AttributionParameters, filters: QueryFilters]
) {
): Promise<AttributionResult> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+21 -20
View File
@@ -1,9 +1,5 @@
import clickhouse from '@/lib/clickhouse';
import {
EVENT_TYPE,
FILTER_COLUMNS,
SESSION_COLUMNS,
} from '@/lib/constants';
import { EVENT_TYPE, FILTER_COLUMNS, SESSION_COLUMNS } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
@@ -15,13 +11,17 @@ export interface BreakdownParameters {
}
export interface BreakdownData {
x: string;
y: number;
views: number;
visitors: number;
visits: number;
bounces: number;
totaltime: number;
[field: string]: string | number;
}
export async function getBreakdown(
...args: [websiteId: string, parameters: BreakdownParameters, filters: QueryFilters]
) {
): Promise<BreakdownData[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -35,18 +35,19 @@ async function relationalQuery(
): Promise<BreakdownData[]> {
const { getTimestampDiffSQL, parseFilters, rawQuery } = prisma;
const { startDate, endDate, fields } = parameters;
const { filterQuery, joinSessionQuery, cohortQuery, excludeBounceQuery, queryParams } = parseFilters(
{
...filters,
websiteId,
startDate,
endDate,
eventType: EVENT_TYPE.pageView,
},
{
joinSession: !!fields.find((name: string) => SESSION_COLUMNS.includes(name)),
},
);
const { filterQuery, joinSessionQuery, cohortQuery, excludeBounceQuery, queryParams } =
parseFilters(
{
...filters,
websiteId,
startDate,
endDate,
eventType: EVENT_TYPE.pageView,
},
{
joinSession: !!fields.find((name: string) => SESSION_COLUMNS.includes(name)),
},
);
const needsBounceEvents = filters.excludeBounce !== true;
const bounceQuery = needsBounceEvents
? `sum(case when t.c = 1 and coalesce(e.has_custom_event, 0) = 0 then 1 else 0 end) as "bounces",`
+1 -1
View File
@@ -32,7 +32,7 @@ export interface FunnelResult extends FunnelStep {
export async function getFunnel(
...args: [websiteId: string, parameters: FunnelParameters, filters: QueryFilters]
) {
): Promise<FunnelResult[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+6 -1
View File
@@ -11,9 +11,14 @@ export interface GoalParameters {
value: string;
}
export interface GoalResult {
num: number;
total: number;
}
export async function getGoal(
...args: [websiteId: string, params: GoalParameters, filters: QueryFilters]
) {
): Promise<GoalResult> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+1 -1
View File
@@ -24,7 +24,7 @@ export interface JourneyResult {
export async function getJourney(
...args: [websiteId: string, parameters: JourneyParameters, filters: QueryFilters]
) {
): Promise<JourneyResult[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+1 -1
View File
@@ -19,7 +19,7 @@ export interface RetentionResult {
export async function getRetention(
...args: [websiteId: string, parameters: RetentionParameters, filters: QueryFilters]
) {
): Promise<RetentionResult[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+10 -1
View File
@@ -13,9 +13,18 @@ export interface RevenuParameters {
compare?: string;
}
export interface RevenueChartResult {
chart: {
x: string;
t: string;
y: number;
count: number;
}[];
}
export async function getRevenueChart(
...args: [websiteId: string, parameters: RevenuParameters, filters: QueryFilters]
) {
): Promise<RevenueChartResult> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+1 -1
View File
@@ -30,7 +30,7 @@ export async function getRevenueMetrics(
filters: QueryFilters,
type: RevenueMetricType,
]
) {
): Promise<RevenueMetricsResult[RevenueMetricType]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -2,13 +2,13 @@ import clickhouse from '@/lib/clickhouse';
import { EVENT_TYPE } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
import type { PageResult, QueryFilters, WebsiteSession } from '@/lib/types';
const FUNCTION_NAME = 'getRevenueSessions';
export async function getRevenueSessions(
...args: [websiteId: string, currency: string, filters: QueryFilters]
) {
): Promise<PageResult<WebsiteSession[]>> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
+4 -1
View File
@@ -1,10 +1,13 @@
import clickhouse from '@/lib/clickhouse';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { SessionDataValue } from '@/lib/types';
const FUNCTION_NAME = 'getSessionData';
export async function getSessionData(...args: [websiteId: string, sessionId: string]) {
export async function getSessionData(
...args: [websiteId: string, sessionId: string]
): Promise<SessionDataValue[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -2,7 +2,7 @@ import clickhouse from '@/lib/clickhouse';
import { EVENT_TYPE } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { PropertyFilter, QueryFilters } from '@/lib/types';
import type { PropertyFilter, QueryFilters, TimeSeriesValue } from '@/lib/types';
const FUNCTION_NAME = 'getSessionDataNumericSeries';
@@ -14,7 +14,7 @@ export async function getSessionDataNumericSeries(
filters: QueryFilters,
propertyFilters?: PropertyFilter[],
]
) {
): Promise<TimeSeriesValue[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -2,7 +2,7 @@ import clickhouse from '@/lib/clickhouse';
import { EVENT_TYPE } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { PropertyFilter, QueryFilters } from '@/lib/types';
import type { PropertyFilter, PropertyMetric, QueryFilters } from '@/lib/types';
const FUNCTION_NAME = 'getSessionDataProperties';
@@ -13,7 +13,7 @@ export async function getSessionDataProperties(
propertyFilters?: PropertyFilter[],
propertyName?: string,
]
) {
): Promise<PropertyMetric[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -2,13 +2,13 @@ import clickhouse from '@/lib/clickhouse';
import { DATA_TYPE, EVENT_TYPE } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
import type { PropertyValue, QueryFilters } from '@/lib/types';
const FUNCTION_NAME = 'getSessionDataValues';
export async function getSessionDataValues(
...args: [websiteId: string, filters: QueryFilters & { propertyName?: string; dataType?: number }]
) {
): Promise<PropertyValue[]> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),
@@ -87,7 +87,7 @@ async function relationalQuery(
async function clickhouseQuery(
websiteId: string,
filters: QueryFilters & { propertyName?: string; dataType?: number },
): Promise<{ propertyName: string; dataType: number; propertyValue: string; total: number }[]> {
): Promise<PropertyValue[]> {
const { rawQuery, parseFilters } = clickhouse;
const { dataType } = filters;
const { filterQuery, cohortQuery, queryParams } = parseFilters({ ...filters, websiteId });
@@ -2,14 +2,16 @@ import clickhouse from '@/lib/clickhouse';
import { EVENT_COLUMNS, EVENT_TYPE, FILTER_COLUMNS } from '@/lib/constants';
import { CLICKHOUSE, PRISMA, runQuery } from '@/lib/db';
import prisma from '@/lib/prisma';
import type { QueryFilters } from '@/lib/types';
import type { PageResult, QueryFilters, WebsiteSession } from '@/lib/types';
const FUNCTION_NAME = 'getWebsiteSessions';
const QUALIFIED_FILTER_COLUMNS = Object.fromEntries(
Object.entries(FILTER_COLUMNS).map(([key, value]) => [key, `website_event.${value}`]),
);
export async function getWebsiteSessions(...args: [websiteId: string, filters: QueryFilters]) {
export async function getWebsiteSessions(
...args: [websiteId: string, filters: QueryFilters]
): Promise<PageResult<WebsiteSession[]>> {
return runQuery({
[PRISMA]: () => relationalQuery(...args),
[CLICKHOUSE]: () => clickhouseQuery(...args),