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, selectors } from 'kea'

import { downloadBlob } from 'lib/components/ExportButton/exporter'
import { dayjs } from 'lib/dayjs'
import { lemonToast } from 'lib/lemon-ui/LemonToast/LemonToast'
import { permanentlyMount } from 'lib/utils/kea-logic-builders'
import { membershipLevelToName } from 'lib/utils/permissioning'
import { capitalizeFirstLetter, fullName } from 'lib/utils/strings'
import { slugify } from 'lib/utils/strings'
import { organizationLogic } from 'scenes/organizationLogic'

import { membersLogic } from '~/models/membersLogic'
import { OrganizationMemberType } from '~/types'

import type { OrganizationType } from '../../types'

function escapeCsvField(value: string): string {
    if (/[",\n\r]/.test(value)) {
        return `"${value.replace(/"/g, '""')}"`
    }
    return value
}

function yesNo(condition: boolean): string {
    return condition ? 'Yes' : 'No'
}

function buildOrganizationMembersCsv(members: OrganizationMemberType[]): string {
    const headers = [
        'Name',
        'Email',
        'Organization role',
        '2FA enabled',
        'Email verified',
        'Social login',
        'Joined at',
        'Last login',
        'User UUID',
    ]

    const lines = [
        headers.map(escapeCsvField).join(','),
        ...members.map((member) => {
            const roleLabel = capitalizeFirstLetter(
                membershipLevelToName.get(member.level) ?? `unknown (${member.level})`
            )
            const emailVerified = member.has_social_auth || !!member.user.is_email_verified
            const row = [
                fullName(member.user),
                member.user.email,
                roleLabel,
                yesNo(member.is_2fa_enabled),
                yesNo(emailVerified),
                yesNo(member.has_social_auth),
                member.joined_at,
                member.last_login ?? '',
                member.user.uuid,
            ]
            return row.map((cell) => escapeCsvField(String(cell))).join(',')
        }),
    ]

    return lines.join('\r\n')
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface membersExportLogicValues {
    membersLoading: boolean // membersLogic
    sortedMembers: OrganizationMemberType[] | null // membersLogic
    currentOrganization: OrganizationType | null // organizationLogic
    downloadMembersListDisabledReason: string | null
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface membersExportLogicActions {
    downloadMembersList: () => {
        value: true
    }
}

// Generated by kea-typegen. Update if you're an agent, ignore if you're human.
export interface membersExportLogicMeta {
    __keaTypeGenInternalSelectorTypes: {
        downloadMembersListDisabledReason: (
            membersLoading: boolean,
            sortedMembers: OrganizationMemberType[] | null
        ) => string | null
    }
}

export type membersExportLogicType = MakeLogicType<
    membersExportLogicValues,
    membersExportLogicActions,
    Record<string, any>,
    membersExportLogicMeta
>

export const membersExportLogic = kea<membersExportLogicType>([
    path(['scenes', 'organization', 'membersExportLogic']),
    connect(() => ({
        values: [membersLogic, ['sortedMembers', 'membersLoading'], organizationLogic, ['currentOrganization']],
    })),
    actions({
        downloadMembersList: true,
    }),
    selectors({
        downloadMembersListDisabledReason: [
            (s) => [s.membersLoading, s.sortedMembers],
            (membersLoading: boolean, sortedMembers: OrganizationMemberType[] | null): string | null =>
                membersLoading && !sortedMembers?.length
                    ? 'Loading members...'
                    : !sortedMembers?.length
                      ? 'No members to export'
                      : null,
        ],
    }),
    listeners(({ values }) => ({
        downloadMembersList: () => {
            const sortedMembers = values.sortedMembers
            if (!sortedMembers?.length) {
                lemonToast.warning(values.downloadMembersListDisabledReason ?? 'No members to export')
                return
            }

            const csv = buildOrganizationMembersCsv(sortedMembers)
            const slug = slugify(values.currentOrganization?.name ?? 'organization').slice(0, 64)
            const filename = `posthog_organization_members_${slug || 'organization'}_${dayjs().format('YYYY-MM-DD')}.csv`
            const blob = new Blob([csv], { type: 'text/csv' })
            downloadBlob(blob, filename)
            lemonToast.success('Export complete!')
        },
    })),

    permanentlyMount(),
])