@keystrokehq/posthog 0.0.1

package/dist/schemas.mjs

@@ -0,0 +1,302 @@
+import { z } from "zod";
+
+//#region src/schemas.ts
+/**
+* posthog/schemas.ts
+*
+* Shared Zod schemas and inferred types for PostHog resources.
+* Types are inferred from schemas, never duplicated.
+*
+* In Zod v4 objects already allow unknown keys, so provider-opaque
+* properties parse naturally without needing `.passthrough()`.
+*/
+/**
+* PostHog's standard cursor-paginated list envelope: `next`/`previous` are
+* absolute URLs, `count` is the total, and `results` carries the page.
+*/
+const paginatedResponseSchema = (itemSchema) => z.object({
+	next: z.string().nullable(),
+	previous: z.string().nullable(),
+	count: z.number().int(),
+	results: z.array(itemSchema)
+});
+/** Optional project id override parameter used by most management operations. */
+const projectIdInputShape = { projectId: z.union([z.string(), z.number().int()]).optional() };
+/** `properties` bag — provider-opaque; we intentionally parse as unknown. */
+const propertiesBagSchema = z.record(z.string(), z.unknown());
+const personSchema = z.object({
+	id: z.union([z.number().int(), z.string()]).optional(),
+	uuid: z.string().optional(),
+	distinct_ids: z.array(z.string()).optional(),
+	properties: propertiesBagSchema.optional(),
+	name: z.string().nullable().optional(),
+	created_at: z.string().optional(),
+	is_identified: z.boolean().optional()
+});
+const cohortSchema = z.object({
+	id: z.number().int().optional(),
+	name: z.string().optional(),
+	description: z.string().nullable().optional(),
+	groups: z.array(z.record(z.string(), z.unknown())).optional(),
+	is_static: z.boolean().optional(),
+	is_calculating: z.boolean().optional(),
+	count: z.number().int().nullable().optional(),
+	created_at: z.string().optional(),
+	deleted: z.boolean().optional()
+});
+const featureFlagFiltersSchema = z.object({
+	groups: z.array(z.record(z.string(), z.unknown())).optional(),
+	multivariate: z.record(z.string(), z.unknown()).nullable().optional(),
+	payloads: z.record(z.string(), z.unknown()).optional()
+});
+const featureFlagSchema = z.object({
+	id: z.number().int().optional(),
+	key: z.string(),
+	name: z.string().optional(),
+	filters: featureFlagFiltersSchema.optional(),
+	deleted: z.boolean().optional(),
+	active: z.boolean().optional(),
+	created_at: z.string().optional(),
+	created_by: z.record(z.string(), z.unknown()).nullable().optional(),
+	ensure_experience_continuity: z.boolean().optional(),
+	rollout_percentage: z.number().nullable().optional(),
+	version: z.number().int().optional()
+});
+const featureFlagRoleAccessSchema = z.object({
+	id: z.number().int().optional(),
+	feature_flag: z.number().int().optional(),
+	role: z.number().int().optional(),
+	added_at: z.string().optional()
+});
+const experimentSchema = z.object({
+	id: z.number().int().optional(),
+	name: z.string().optional(),
+	description: z.string().nullable().optional(),
+	start_date: z.string().nullable().optional(),
+	end_date: z.string().nullable().optional(),
+	feature_flag_key: z.string().optional(),
+	parameters: z.record(z.string(), z.unknown()).nullable().optional(),
+	filters: z.record(z.string(), z.unknown()).optional(),
+	archived: z.boolean().optional(),
+	created_at: z.string().optional()
+});
+const insightSchema = z.object({
+	id: z.number().int().optional(),
+	short_id: z.string().optional(),
+	name: z.string().nullable().optional(),
+	description: z.string().nullable().optional(),
+	filters: z.record(z.string(), z.unknown()).optional(),
+	query: z.record(z.string(), z.unknown()).nullable().optional(),
+	result: z.unknown().optional(),
+	last_refresh: z.string().nullable().optional(),
+	favorited: z.boolean().optional(),
+	saved: z.boolean().optional(),
+	created_at: z.string().optional(),
+	created_by: z.record(z.string(), z.unknown()).nullable().optional(),
+	deleted: z.boolean().optional(),
+	dashboards: z.array(z.number().int()).optional(),
+	tags: z.array(z.string()).optional()
+});
+const dashboardSchema = z.object({
+	id: z.number().int().optional(),
+	name: z.string().optional(),
+	description: z.string().nullable().optional(),
+	pinned: z.boolean().optional(),
+	created_at: z.string().optional(),
+	created_by: z.record(z.string(), z.unknown()).nullable().optional(),
+	deleted: z.boolean().optional(),
+	tags: z.array(z.string()).optional(),
+	tiles: z.array(z.record(z.string(), z.unknown())).optional(),
+	filters: z.record(z.string(), z.unknown()).optional()
+});
+const dashboardTemplateSchema = z.object({
+	id: z.string().optional(),
+	template_name: z.string().optional(),
+	dashboard_description: z.string().nullable().optional(),
+	dashboard_filters: z.record(z.string(), z.unknown()).nullable().optional(),
+	tags: z.array(z.string()).optional(),
+	tiles: z.array(z.record(z.string(), z.unknown())).optional(),
+	variables: z.array(z.record(z.string(), z.unknown())).nullable().optional(),
+	deleted: z.boolean().optional()
+});
+const dashboardCollaboratorSchema = z.object({
+	id: z.number().int().optional(),
+	dashboard_id: z.number().int().optional(),
+	user_uuid: z.string().optional(),
+	access_level: z.enum(["can_view", "can_edit"]).optional(),
+	added_at: z.string().optional()
+});
+const sharingConfigurationSchema = z.object({
+	enabled: z.boolean().optional(),
+	access_token: z.string().nullable().optional(),
+	created_at: z.string().nullable().optional()
+});
+const annotationSchema = z.object({
+	id: z.number().int().optional(),
+	content: z.string().optional(),
+	date_marker: z.string().optional(),
+	creation_type: z.string().optional(),
+	dashboard_item: z.number().int().nullable().optional(),
+	insight_short_id: z.string().nullable().optional(),
+	insight_name: z.string().nullable().optional(),
+	created_at: z.string().optional(),
+	updated_at: z.string().optional(),
+	scope: z.enum([
+		"dashboard_item",
+		"project",
+		"organization"
+	]).optional(),
+	deleted: z.boolean().optional()
+});
+const sessionRecordingSchema = z.object({
+	id: z.string().optional(),
+	distinct_id: z.string().optional(),
+	viewed: z.boolean().optional(),
+	recording_duration: z.number().optional(),
+	start_time: z.string().optional(),
+	end_time: z.string().optional(),
+	click_count: z.number().int().nullable().optional(),
+	keypress_count: z.number().int().nullable().optional(),
+	mouse_activity_count: z.number().int().nullable().optional(),
+	person: personSchema.nullable().optional()
+});
+const sessionRecordingPlaylistSchema = z.object({
+	id: z.number().int().optional(),
+	short_id: z.string().optional(),
+	name: z.string().nullable().optional(),
+	description: z.string().nullable().optional(),
+	pinned: z.boolean().optional(),
+	deleted: z.boolean().optional(),
+	filters: z.record(z.string(), z.unknown()).optional(),
+	created_at: z.string().optional(),
+	created_by: z.record(z.string(), z.unknown()).nullable().optional()
+});
+const surveySchema = z.object({
+	id: z.string().optional(),
+	name: z.string().optional(),
+	description: z.string().nullable().optional(),
+	type: z.enum([
+		"popover",
+		"api",
+		"widget",
+		"button",
+		"full_screen",
+		"email"
+	]).optional(),
+	questions: z.array(z.record(z.string(), z.unknown())).optional(),
+	conditions: z.record(z.string(), z.unknown()).nullable().optional(),
+	appearance: z.record(z.string(), z.unknown()).nullable().optional(),
+	targeting_flag: z.record(z.string(), z.unknown()).nullable().optional(),
+	start_date: z.string().nullable().optional(),
+	end_date: z.string().nullable().optional(),
+	responses_limit: z.number().int().nullable().optional(),
+	archived: z.boolean().optional(),
+	created_at: z.string().optional(),
+	created_by: z.record(z.string(), z.unknown()).nullable().optional()
+});
+const actionStepSchema = z.object({
+	event: z.string().nullable().optional(),
+	url: z.string().nullable().optional(),
+	url_matching: z.enum([
+		"contains",
+		"regex",
+		"exact"
+	]).nullable().optional(),
+	text: z.string().nullable().optional(),
+	href: z.string().nullable().optional(),
+	selector: z.string().nullable().optional(),
+	properties: z.array(z.record(z.string(), z.unknown())).nullable().optional()
+});
+const actionSchema = z.object({
+	id: z.number().int().optional(),
+	name: z.string().nullable().optional(),
+	description: z.string().nullable().optional(),
+	post_to_slack: z.boolean().optional(),
+	slack_message_format: z.string().nullable().optional(),
+	steps: z.array(actionStepSchema).optional(),
+	created_at: z.string().optional(),
+	created_by: z.record(z.string(), z.unknown()).nullable().optional(),
+	deleted: z.boolean().optional(),
+	is_calculating: z.boolean().optional()
+});
+const analyticsEventSchema = z.object({
+	id: z.string().optional(),
+	uuid: z.string().optional(),
+	distinct_id: z.string().optional(),
+	event: z.string().optional(),
+	properties: propertiesBagSchema.optional(),
+	timestamp: z.string().optional(),
+	person: personSchema.nullable().optional(),
+	elements: z.array(z.record(z.string(), z.unknown())).optional(),
+	elements_chain: z.string().nullable().optional()
+});
+const eventDefinitionSchema = z.object({
+	id: z.string().optional(),
+	name: z.string().optional(),
+	description: z.string().nullable().optional(),
+	tags: z.array(z.string()).optional(),
+	owner: z.record(z.string(), z.unknown()).nullable().optional(),
+	verified: z.boolean().optional(),
+	verified_at: z.string().nullable().optional(),
+	created_at: z.string().optional()
+});
+const projectSchema = z.object({
+	id: z.number().int().optional(),
+	uuid: z.string().optional(),
+	organization: z.string().optional(),
+	name: z.string().optional(),
+	api_token: z.string().optional(),
+	created_at: z.string().optional(),
+	app_urls: z.array(z.string()).optional(),
+	slack_incoming_webhook: z.string().nullable().optional(),
+	anonymize_ips: z.boolean().optional(),
+	completed_snippet_onboarding: z.boolean().optional(),
+	test_account_filters: z.array(z.record(z.string(), z.unknown())).optional(),
+	is_demo: z.boolean().optional(),
+	timezone: z.string().optional(),
+	access_control: z.boolean().optional()
+});
+const projectMemberSchema = z.object({
+	id: z.number().int().optional(),
+	user: z.record(z.string(), z.unknown()).optional(),
+	level: z.number().int().optional(),
+	parent_level: z.number().int().nullable().optional(),
+	joined_at: z.string().optional(),
+	updated_at: z.string().optional()
+});
+const organizationSchema = z.object({
+	id: z.string().optional(),
+	name: z.string().optional(),
+	slug: z.string().optional(),
+	created_at: z.string().optional(),
+	updated_at: z.string().optional(),
+	membership_level: z.number().int().nullable().optional(),
+	plugins_access_level: z.number().int().optional(),
+	teams: z.array(z.record(z.string(), z.unknown())).optional()
+});
+const captureResponseSchema = z.object({ status: z.union([
+	z.literal(1),
+	z.literal("ok"),
+	z.number().int(),
+	z.string()
+]).optional() });
+const decideResponseSchema = z.object({
+	config: z.record(z.string(), z.unknown()).optional(),
+	featureFlags: z.record(z.string(), z.union([
+		z.boolean(),
+		z.string(),
+		z.number()
+	])).optional(),
+	featureFlagPayloads: z.record(z.string(), z.unknown()).optional(),
+	errorsWhileComputingFlags: z.boolean().optional(),
+	toolbarParams: z.record(z.string(), z.unknown()).optional(),
+	sessionRecording: z.union([z.boolean(), z.record(z.string(), z.unknown())]).optional()
+});
+const localEvaluationResponseSchema = z.object({
+	flags: z.array(featureFlagSchema).optional(),
+	group_type_mapping: z.record(z.string(), z.unknown()).optional(),
+	cohorts: z.record(z.string(), z.unknown()).optional()
+});
+
+//#endregion
+export { actionSchema, actionStepSchema, analyticsEventSchema, annotationSchema, captureResponseSchema, cohortSchema, dashboardCollaboratorSchema, dashboardSchema, dashboardTemplateSchema, decideResponseSchema, eventDefinitionSchema, experimentSchema, featureFlagFiltersSchema, featureFlagRoleAccessSchema, featureFlagSchema, insightSchema, localEvaluationResponseSchema, organizationSchema, paginatedResponseSchema, personSchema, projectIdInputShape, projectMemberSchema, projectSchema, propertiesBagSchema, sessionRecordingPlaylistSchema, sessionRecordingSchema, sharingConfigurationSchema, surveySchema };