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.

2.6 KB
Raw Blame
import type { DashboardTile } from '~/types'

import { dashboardsPartialUpdate } from './generated/api'
import type { PatchedPatchedDashboardOpenApiApi } from './generated/api.schemas'
import { parseDashboardWidgetConfigApiError } from './widgets/registry'

export type WidgetFieldErrors = Record<string, string | undefined>

export class WidgetConfigValidationError extends Error {
    fieldErrors: WidgetFieldErrors

    constructor(fieldErrors: WidgetFieldErrors) {
        super('Widget config validation failed')
        this.name = 'WidgetConfigValidationError'
        this.fieldErrors = fieldErrors
    }
}

export function isWidgetConfigValidationError(error: unknown): error is WidgetConfigValidationError {
    return error instanceof WidgetConfigValidationError
}

export async function updateDashboardWidgetTile({
    teamId,
    dashboardId,
    tile,
    config,
    name,
    description,
    showDescription,
}: {
    teamId: number
    dashboardId: number
    tile: DashboardTile
    config?: Record<string, unknown>
    name?: string | null
    description?: string
    showDescription?: boolean
}): Promise<DashboardTile> {
    if (!tile.widget) {
        throw new Error('Tile has no widget')
    }

    const widgetPatch: Record<string, unknown> = {}
    if (config !== undefined) {
        widgetPatch.config = config
    }
    if (name !== undefined) {
        widgetPatch.name = name || null
    }
    if (description !== undefined) {
        widgetPatch.description = description
    }

    const tilePatch: Record<string, unknown> = {
        id: tile.id,
    }
    if (showDescription !== undefined) {
        tilePatch.show_description = showDescription
    }
    if (Object.keys(widgetPatch).length > 0) {
        tilePatch.widget = {
            id: tile.widget.id,
            ...widgetPatch,
        }
    }

    try {
        const dashboard = await dashboardsPartialUpdate(String(teamId), dashboardId, {
            tiles: [tilePatch],
        } as PatchedPatchedDashboardOpenApiApi)
        const updatedTile = dashboard.tiles?.find((existingTile) => existingTile.id === tile.id)
        if (!updatedTile) {
            throw new Error('Updated tile not found in dashboard response')
        }
        return updatedTile as unknown as DashboardTile
    } catch (error) {
        if (config !== undefined) {
            const fieldErrors = parseDashboardWidgetConfigApiError(tile.widget.widget_type, error, config)
            if (fieldErrors && Object.keys(fieldErrors).length > 0) {
                throw new WidgetConfigValidationError(fieldErrors)
            }
        }
        throw error
    }
}