Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

6.0 KB
Raw Blame
import { getDefaultEventLabel, getDefaultEventName } from 'lib/utils/getAppContext'

import { STEP_SOURCE_PRESETS } from '~/queries/nodes/InsightQuery/stepSourcePresets'
import {
    FunnelsQuery,
    InsightQueryNode,
    LifecycleQuery,
    NodeKind,
    PathsQuery,
    PathsV2Query,
    RetentionQuery,
    StickinessComputationModes,
    StickinessQuery,
    TrendsQuery,
} from '~/queries/schema/schema-general'
import { BaseMathType, ChartDisplayType, FunnelVizType, InsightType, PathType, RetentionPeriod } from '~/types'

function getTrendsQueryDefault(): TrendsQuery {
    const defaultEvent = getDefaultEventName()
    const defaultLabel = getDefaultEventLabel()
    return {
        kind: NodeKind.TrendsQuery,
        series: [
            {
                kind: NodeKind.EventsNode,
                name: defaultLabel,
                event: defaultEvent,
                math: BaseMathType.TotalCount,
            },
        ],
        trendsFilter: {},
    }
}

function getCalendarHeatmapQueryDefault(): TrendsQuery {
    const defaultEvent = getDefaultEventName()
    const defaultLabel = getDefaultEventLabel()
    return {
        kind: NodeKind.TrendsQuery,
        series: [
            {
                kind: NodeKind.EventsNode,
                name: defaultLabel,
                event: defaultEvent,
                math: BaseMathType.TotalCount,
            },
        ],
        trendsFilter: {
            display: ChartDisplayType.CalendarHeatmap,
        },
    }
}

function getFunnelsQueryDefault(): FunnelsQuery {
    const defaultEvent = getDefaultEventName()
    const defaultLabel = getDefaultEventLabel()
    return {
        kind: NodeKind.FunnelsQuery,
        series: [
            {
                kind: NodeKind.EventsNode,
                name: defaultLabel,
                event: defaultEvent,
            },
        ],
        funnelsFilter: {
            funnelVizType: FunnelVizType.Steps,
        },
    }
}

function getRetentionQueryDefault(): RetentionQuery {
    const defaultEvent = getDefaultEventName()
    const defaultLabel = getDefaultEventLabel()
    return {
        kind: NodeKind.RetentionQuery,
        retentionFilter: {
            period: RetentionPeriod.Day,
            totalIntervals: 8,
            targetEntity: {
                id: defaultEvent ?? undefined,
                name: defaultLabel,
                type: 'events',
            },
            returningEntity: {
                id: defaultEvent ?? undefined,
                name: defaultLabel,
                type: 'events',
            },
            retentionType: 'retention_first_time',
            meanRetentionCalculation: 'simple',
        },
    }
}

function getPathsQueryDefault(): PathsQuery {
    const defaultEvent = getDefaultEventName()
    let pathType: PathType
    if (defaultEvent === '$screen') {
        pathType = PathType.Screen
    } else if (defaultEvent === null) {
        pathType = PathType.CustomEvent
    } else {
        pathType = PathType.PageView
    }
    return {
        kind: NodeKind.PathsQuery,
        pathsFilter: {
            includeEventTypes: [pathType],
            pathReplacements: true,
            showFullUrls: true,
        },
    }
}

function getPathsV2QueryDefault(): PathsV2Query {
    const preset = getDefaultEventName() === '$screen' ? STEP_SOURCE_PRESETS.screenViews : STEP_SOURCE_PRESETS.pageViews
    return {
        kind: NodeKind.PathsV2Query,
        pathsV2Filter: {
            stepSources: preset.stepSources,
        },
    }
}

function getStickinessQueryDefault(): StickinessQuery {
    const defaultEvent = getDefaultEventName()
    const defaultLabel = getDefaultEventLabel()
    return {
        kind: NodeKind.StickinessQuery,
        series: [
            {
                kind: NodeKind.EventsNode,
                name: defaultLabel,
                event: defaultEvent,
                math: BaseMathType.UniqueUsers,
            },
        ],
        stickinessFilter: {
            computedAs: StickinessComputationModes.NonCumulative,
        },
    }
}

function getLifecycleQueryDefault(): LifecycleQuery {
    const defaultEvent = getDefaultEventName()
    const defaultLabel = getDefaultEventLabel()
    return {
        kind: NodeKind.LifecycleQuery,
        series: [
            {
                kind: NodeKind.EventsNode,
                name: defaultLabel,
                event: defaultEvent,
            },
        ],
    }
}

/** Product Analytics insight node kinds that support tab switching in the insight UI */
export type ProductAnalyticsInsightNodeKind = Exclude<
    InsightQueryNode['kind'],
    NodeKind.WebStatsTableQuery | NodeKind.WebOverviewQuery
>

export const nodeKindToInsightType: Record<ProductAnalyticsInsightNodeKind, InsightType> = {
    [NodeKind.TrendsQuery]: InsightType.TRENDS,
    [NodeKind.FunnelsQuery]: InsightType.FUNNELS,
    [NodeKind.RetentionQuery]: InsightType.RETENTION,
    [NodeKind.PathsQuery]: InsightType.PATHS,
    [NodeKind.PathsV2Query]: InsightType.JOURNEYS,
    [NodeKind.StickinessQuery]: InsightType.STICKINESS,
    [NodeKind.LifecycleQuery]: InsightType.LIFECYCLE,
}

/** Legacy exports for backwards compatibility - use getNodeKindToDefaultQuery() instead */
export const trendsQueryDefault = getTrendsQueryDefault()
export const calendarHeatmapQueryDefault = getCalendarHeatmapQueryDefault()
export const funnelsQueryDefault = getFunnelsQueryDefault()

export function getNodeKindToDefaultQuery(): Record<ProductAnalyticsInsightNodeKind, InsightQueryNode> {
    return {
        [NodeKind.TrendsQuery]: getTrendsQueryDefault(),
        [NodeKind.FunnelsQuery]: getFunnelsQueryDefault(),
        [NodeKind.RetentionQuery]: getRetentionQueryDefault(),
        [NodeKind.PathsQuery]: getPathsQueryDefault(),
        [NodeKind.PathsV2Query]: getPathsV2QueryDefault(),
        [NodeKind.StickinessQuery]: getStickinessQueryDefault(),
        [NodeKind.LifecycleQuery]: getLifecycleQueryDefault(),
    }
}

/** @deprecated Use getNodeKindToDefaultQuery() instead */
export const nodeKindToDefaultQuery = getNodeKindToDefaultQuery()