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.

4.7 KB
Raw Blame
import { MakeLogicType, actions, connect, kea, listeners, path, reducers, selectors } from 'kea'

import { userLogic } from 'scenes/userLogic'

import { UserUIConfiguration } from '~/queries/schema/schema-general'
import { UserType } from '~/types'

/** Version stamped onto the configuration whenever this client persists it. */
export const UI_CONFIGURATION_VERSION = 1

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface uiCustomizationLogicValues {
    user: UserType | null // userLogic
    userLoading: boolean // userLogic
    pendingUiConfiguration: UserUIConfiguration | null
    uiConfiguration: UserUIConfiguration | null
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface uiCustomizationLogicActions {
    updateUser: (
        user: Partial<UserType>,
        successCallback?: (() => void) | undefined,
        failureCallback?: (() => void) | undefined
    ) => {
        failureCallback: (() => void) | undefined
        successCallback: (() => void) | undefined
        user: Partial<UserType>
    } // userLogic
    updateUserSuccess: (
        user: UserType,
        payload?:
            | {
                  failureCallback: (() => void) | undefined
                  successCallback: (() => void) | undefined
                  user: Partial<UserType>
              }
            | undefined
    ) => {
        payload?: {
            failureCallback: (() => void) | undefined
            successCallback: (() => void) | undefined
            user: Partial<UserType>
        }
        user: UserType
    } // userLogic
    clearPendingUiConfiguration: (configuration: UserUIConfiguration) => {
        configuration: UserUIConfiguration
    }
    setPendingUiConfiguration: (configuration: UserUIConfiguration | null) => {
        configuration: UserUIConfiguration | null
    }
    updateUiConfiguration: (
        configuration: UserUIConfiguration,
        successCallback?: () => void,
        failureCallback?: () => void
    ) => {
        configuration: UserUIConfiguration
        failureCallback: (() => void) | undefined
        successCallback: (() => void) | undefined
    }
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface uiCustomizationLogicMeta {
    __keaTypeGenInternalSelectorTypes: {
        uiConfiguration: (
            user: UserType | null,
            pendingUiConfiguration: UserUIConfiguration | null
        ) => UserUIConfiguration | null
    }
}

export type uiCustomizationLogicType = MakeLogicType<
    uiCustomizationLogicValues,
    uiCustomizationLogicActions,
    Record<string, any>,
    uiCustomizationLogicMeta
>

/** Per-user UI customization, persisted as `User.ui_configuration` (see the UserUIConfiguration schema). */
export const uiCustomizationLogic = kea<uiCustomizationLogicType>([
    path(['layout', 'uiCustomizationLogic']),
    connect(() => ({
        values: [userLogic, ['user', 'userLoading']],
        actions: [userLogic, ['updateUser', 'updateUserSuccess']],
    })),
    actions({
        setPendingUiConfiguration: (configuration: UserUIConfiguration | null) => ({ configuration }),
        clearPendingUiConfiguration: (configuration: UserUIConfiguration) => ({ configuration }),
        updateUiConfiguration: (
            configuration: UserUIConfiguration,
            successCallback?: () => void,
            failureCallback?: () => void
        ) => ({ configuration, successCallback, failureCallback }),
    }),
    reducers({
        // Optimistic copy held while the user PATCH is in flight, so toggles apply instantly.
        pendingUiConfiguration: [
            null as UserUIConfiguration | null,
            {
                setPendingUiConfiguration: (_, { configuration }) => configuration,
                clearPendingUiConfiguration: (state, { configuration }) => (state === configuration ? null : state),
                updateUserSuccess: (state, { payload }) => (payload?.user.ui_configuration === state ? null : state),
            },
        ],
    }),
    selectors({
        uiConfiguration: [
            (s) => [s.user, s.pendingUiConfiguration],
            (user: UserType | null, pendingUiConfiguration: UserUIConfiguration | null): UserUIConfiguration | null =>
                pendingUiConfiguration ?? user?.ui_configuration ?? null,
        ],
    }),
    listeners(({ actions }) => ({
        updateUiConfiguration: ({ configuration, successCallback, failureCallback }) => {
            actions.setPendingUiConfiguration(configuration)
            actions.updateUser({ ui_configuration: configuration }, successCallback, () => {
                actions.clearPendingUiConfiguration(configuration)
                failureCallback?.()
            })
        },
    })),
])