: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.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import { z } from 'zod'
import { ApiError } from 'lib/api-error'
import {
experimentResultsWidgetConfigSchema,
experimentResultsWidgetFormSchema,
experimentsWidgetConfigSchema,
experimentsWidgetFormSchema,
type ExperimentResultsWidgetConfig,
type ExperimentsWidgetConfig,
} from '../../generated/widget-configs.zod'
import { fieldErrorsFromZodError, parseWidgetConfig } from '../widgetConfigValidation'
export const EXPERIMENTS_WIDGET_FORM_FIELD_NAMES = Object.keys(
experimentsWidgetFormSchema.shape
) as (keyof typeof experimentsWidgetFormSchema.shape)[]
type ExperimentsListWidgetFormField = keyof z.infer<typeof experimentsWidgetFormSchema>
export type ExperimentsListWidgetFieldErrors = Partial<Record<ExperimentsListWidgetFormField, string>>
export type ExperimentsListWidgetStatus = NonNullable<ExperimentsWidgetConfig['status']>
export type ExperimentsListWidgetOrderBy = NonNullable<ExperimentsWidgetConfig['orderBy']>
export type ExperimentsListWidgetOrderDirection = NonNullable<ExperimentsWidgetConfig['orderDirection']>
export const EXPERIMENTS_WIDGET_STATUS_OPTIONS: { value: ExperimentsListWidgetStatus; label: string }[] = [
{ value: 'all', label: 'Any status' },
{ value: 'draft', label: 'Draft' },
{ value: 'running', label: 'Running' },
{ value: 'paused', label: 'Paused' },
{ value: 'exposure_frozen', label: 'Exposure frozen' },
{ value: 'stopped', label: 'Complete' },
]
export const EXPERIMENTS_WIDGET_ORDER_BY_OPTIONS: { value: ExperimentsListWidgetOrderBy; label: string }[] = [
{ value: 'created_at', label: 'Created date' },
{ value: 'name', label: 'Name' },
{ value: 'start_date', label: 'Start date' },
]
export const EXPERIMENTS_WIDGET_ORDER_DIRECTION_OPTIONS: {
value: ExperimentsListWidgetOrderDirection
label: string
}[] = [
{ value: 'DESC', label: 'Descending' },
{ value: 'ASC', label: 'Ascending' },
]
const experimentsConfigDefaults = experimentsWidgetConfigSchema.parse({})
export function parseExperimentsListWidgetConfig(config: Record<string, unknown>): ExperimentsWidgetConfig {
return parseWidgetConfig(experimentsWidgetConfigSchema, config)
}
/** Merge a partial status/creator change into an existing config, returning the full validated config. */
export function patchExperimentsListWidgetConfig(
config: Record<string, unknown>,
patch: { status?: ExperimentsListWidgetStatus; createdBy?: number | null }
): ExperimentsWidgetConfig {
const parsed = parseExperimentsListWidgetConfig(config)
return experimentsWidgetConfigSchema.parse({
...parsed,
...(patch.status !== undefined ? { status: patch.status } : {}),
...(patch.createdBy !== undefined ? { createdBy: patch.createdBy } : {}),
})
}
export function validateExperimentsListWidgetConfigInput(input: {
limit: number
orderBy: ExperimentsListWidgetOrderBy
orderDirection: ExperimentsListWidgetOrderDirection
status: ExperimentsListWidgetStatus
createdBy: number | null
}):
| { success: true; config: ExperimentsWidgetConfig }
| { success: false; fieldErrors: ExperimentsListWidgetFieldErrors } {
const parsed = experimentsWidgetFormSchema.safeParse({
limit: input.limit,
orderBy: input.orderBy,
orderDirection: input.orderDirection,
status: input.status,
createdBy: input.createdBy,
})
if (!parsed.success) {
return { success: false, fieldErrors: fieldErrorsFromZodError(parsed.error) }
}
return { success: true, config: experimentsWidgetConfigSchema.parse(parsed.data) }
}
export function parseExperimentsListWidgetConfigApiError(
error: unknown,
config: Record<string, unknown>
): ExperimentsListWidgetFieldErrors | null {
if (!(error instanceof ApiError)) {
return null
}
const parsedConfig = experimentsWidgetConfigSchema.safeParse(config)
if (parsedConfig.success) {
return null
}
const parsedForm = experimentsWidgetFormSchema.safeParse({
limit: (config.limit as number) ?? experimentsConfigDefaults.limit ?? 0,
orderBy: (config.orderBy as ExperimentsListWidgetOrderBy) ?? experimentsConfigDefaults.orderBy ?? 'created_at',
orderDirection:
(config.orderDirection as ExperimentsListWidgetOrderDirection) ??
experimentsConfigDefaults.orderDirection ??
'DESC',
status: (config.status as ExperimentsListWidgetStatus) ?? experimentsConfigDefaults.status ?? 'all',
createdBy: (config.createdBy as number | null) ?? null,
})
if (!parsedForm.success) {
return fieldErrorsFromZodError(parsedForm.error)
}
return fieldErrorsFromZodError(parsedConfig.error)
}
type ExperimentResultsWidgetFormField = keyof z.infer<typeof experimentResultsWidgetFormSchema>
export type ExperimentResultsWidgetFieldErrors = Partial<Record<ExperimentResultsWidgetFormField, string>>
export function parseExperimentResultsWidgetConfig(config: Record<string, unknown>): ExperimentResultsWidgetConfig {
return parseWidgetConfig(experimentResultsWidgetConfigSchema, config)
}
/** Set the selected experiment on an existing config, returning the full validated config. */
export function patchExperimentResultsWidgetConfig(
config: Record<string, unknown>,
experimentId: number | null
): ExperimentResultsWidgetConfig {
const parsed = parseExperimentResultsWidgetConfig(config)
return experimentResultsWidgetConfigSchema.parse({ ...parsed, experimentId })
}
export function validateExperimentResultsWidgetConfigInput(input: {
experimentId: number | null
}):
| { success: true; config: ExperimentResultsWidgetConfig }
| { success: false; fieldErrors: ExperimentResultsWidgetFieldErrors } {
const parsed = experimentResultsWidgetFormSchema.safeParse({ experimentId: input.experimentId })
if (!parsed.success) {
return { success: false, fieldErrors: fieldErrorsFromZodError(parsed.error) }
}
return { success: true, config: experimentResultsWidgetConfigSchema.parse(parsed.data) }
}
export function parseExperimentResultsWidgetConfigApiError(
error: unknown,
config: Record<string, unknown>
): ExperimentResultsWidgetFieldErrors | null {
if (!(error instanceof ApiError)) {
return null
}
const parsedConfig = experimentResultsWidgetConfigSchema.safeParse(config)
if (parsedConfig.success) {
return null
}
return fieldErrorsFromZodError(parsedConfig.error)
}