2
0
Files
bot/packages/schemas/features/telemetry.ts
Baptiste Arnaud 84b9aca40b 🧑‍💻 (folders) Add folder trpc endpoints (#1218)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced folder management capabilities including creation,
deletion, update, listing, and retrieval within workspaces.
- Added telemetry tracking for client events, Typebot publish events,
and analytics page views.
	- Enhanced settings to track client events under specific conditions.
- Implemented server-side logic for analytics tracking with PostHog
integration.
- Added API documentation for folder operations (create, delete, get,
list, update).
- **Refactor**
	- Updated `onConfirm` function's return type in `ConfirmModal`.
	- Simplified folder creation process in tests.
- Refactored logic for handling file upload blocks and parsing publish
events in Typebot publishing.
	- Migrated handler functions to TRPC endpoints for folder operations.
- **Documentation**
- Introduced documentation for new folder and telemetry functionalities.
- **Chores**
- Added new schemas for folders and telemetry events, including event
tracking and folder structure.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-02-05 12:14:03 +01:00

199 lines
4.4 KiB
TypeScript

import { Plan } from '@typebot.io/prisma'
import { z } from '../zod'
const userEvent = z.object({
userId: z.string(),
})
const workspaceEvent = userEvent.merge(
z.object({
workspaceId: z.string(),
})
)
const typebotEvent = workspaceEvent.merge(
z.object({
typebotId: z.string(),
})
)
const workspaceCreatedEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Workspace created'),
data: z.object({
name: z.string().optional(),
plan: z.nativeEnum(Plan),
}),
})
)
const userCreatedEventSchema = userEvent.merge(
z.object({
name: z.literal('User created'),
data: z.object({
email: z.string(),
name: z.string().optional(),
}),
})
)
const userUpdatedEventSchema = userEvent.merge(
z.object({
name: z.literal('User updated'),
data: z.object({
name: z.string().optional(),
onboardingCategories: z.array(z.string()).optional(),
referral: z.string().optional(),
company: z.string().optional(),
}),
})
)
const typebotCreatedEventSchema = typebotEvent.merge(
z.object({
name: z.literal('Typebot created'),
data: z.object({
name: z.string(),
template: z.string().optional(),
}),
})
)
const publishedTypebotEventSchema = typebotEvent.merge(
z.object({
name: z.literal('Typebot published'),
data: z.object({
name: z.string(),
isFirstPublish: z.literal(true).optional(),
}),
})
)
const customDomainAddedEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Custom domain added'),
data: z.object({
domain: z.string(),
}),
})
)
const whatsAppCredentialsCreatedEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('WhatsApp credentials created'),
})
)
const subscriptionUpdatedEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Subscription updated'),
data: z.object({
plan: z.nativeEnum(Plan),
}),
})
)
const subscriptionAutoUpdatedEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Subscription automatically updated'),
data: z.object({
plan: z.nativeEnum(Plan),
}),
})
)
const newResultsCollectedEventSchema = typebotEvent.merge(
z.object({
name: z.literal('New results collected'),
data: z.object({
total: z.number(),
isFirstOfKind: z.literal(true).optional(),
}),
})
)
const workspaceLimitReachedEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Workspace limit reached'),
data: z.object({
chatsLimit: z.number(),
totalChatsUsed: z.number(),
}),
})
)
const workspaceAutoQuarantinedEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Workspace automatically quarantined'),
data: z.object({
chatsLimit: z.number(),
totalChatsUsed: z.number(),
}),
})
)
export const workspacePastDueEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Workspace past due'),
})
)
export const workspaceNotPastDueEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Workspace past due status removed'),
})
)
export const removedBrandingEventSchema = typebotEvent.merge(
z.object({
name: z.literal('Branding removed'),
})
)
export const createdFolderEventSchema = workspaceEvent.merge(
z.object({
name: z.literal('Folder created'),
})
)
export const publishedFileUploadBlockEventSchema = typebotEvent.merge(
z.object({
name: z.literal('File upload block published'),
})
)
export const visitedAnalyticsEventSchema = typebotEvent.merge(
z.object({
name: z.literal('Analytics visited'),
})
)
export const clientSideEvents = [removedBrandingEventSchema] as const
export const eventSchema = z.discriminatedUnion('name', [
workspaceCreatedEventSchema,
userCreatedEventSchema,
typebotCreatedEventSchema,
publishedTypebotEventSchema,
subscriptionUpdatedEventSchema,
newResultsCollectedEventSchema,
workspaceLimitReachedEventSchema,
workspaceAutoQuarantinedEventSchema,
subscriptionAutoUpdatedEventSchema,
workspacePastDueEventSchema,
workspaceNotPastDueEventSchema,
userUpdatedEventSchema,
customDomainAddedEventSchema,
whatsAppCredentialsCreatedEventSchema,
createdFolderEventSchema,
publishedFileUploadBlockEventSchema,
visitedAnalyticsEventSchema,
...clientSideEvents,
])
export const clientSideCreateEventSchema = removedBrandingEventSchema.omit({
userId: true,
})
export type TelemetryEvent = z.infer<typeof eventSchema>