stats/packages/validation/src/track.validation.ts

import { RESERVED_EVENT_NAMES } from '@openpanel/constants';
import { z } from 'zod';
import { isBlockedEventName } from './event-blocklist';

export const zGroupPayload = z.object({
  id: z.string().min(1),
  type: z.string().min(1),
  name: z.string().min(1),
  properties: z.record(z.unknown()).optional(),
});

export const zAssignGroupPayload = z.object({
  groupIds: z.array(z.string().min(1)),
  profileId: z.union([z.string().min(1), z.number()]).optional(),
});

export const zTrackPayload = z
  .object({
    name: z.string().min(1),
    properties: z.record(z.string(), z.unknown()).optional(),
    profileId: z.union([z.string().min(1), z.number()]).optional(),
    groups: z.array(z.string().min(1)).optional(),
  })
  .refine((data) => !RESERVED_EVENT_NAMES.includes(data.name as any), {
    message: `Event name cannot be one of the reserved names: ${RESERVED_EVENT_NAMES.join(', ')}`,
    path: ['name'],
  })
  .refine((data) => !isBlockedEventName(data.name), {
    message: 'Event name contains blocked content',
    path: ['name'],
  })
  .refine(
    (data) => {
      if (data.name !== 'revenue') {
        return true;
      }
      const revenue = data.properties?.__revenue;
      if (revenue === undefined || revenue === null) {
        return true;
      }
      const isInt = Number.isInteger(revenue);
      if (isInt && Number(revenue) < 0) {
        return false;
      }
      return isInt;
    },
    {
      message: '__revenue must be an integer (no floats or strings)',
      path: ['properties', '__revenue'],
    }
  );

export const zIdentifyPayload = z.object({
  profileId: z.string().min(1),
  firstName: z.string().optional(),
  lastName: z.string().optional(),
  email: z.string().email().optional(),
  avatar: z.string().url().optional(),
  properties: z.record(z.unknown()).optional(),
});

export const zIncrementPayload = z.object({
  profileId: z.string().min(1),
  property: z.string().min(1),
  value: z.number().positive().optional(),
});

export const zDecrementPayload = z.object({
  profileId: z.string().min(1),
  property: z.string().min(1),
  value: z.number().positive().optional(),
});

export const zAliasPayload = z.object({
  profileId: z.string().min(1),
  alias: z.string().min(1),
});

export const zReplayPayload = z.object({
  chunk_index: z.number().int().min(0).max(65_535),
  events_count: z.number().int().min(1),
  is_full_snapshot: z.boolean(),
  started_at: z.string().datetime(),
  ended_at: z.string().datetime(),
  payload: z.string().max(1_048_576 * 2), // 2MB max
});

export const zTrackHandlerPayload = z.discriminatedUnion('type', [
  z.object({
    type: z.literal('track'),
    payload: zTrackPayload,
  }),
  z.object({
    type: z.literal('identify'),
    payload: zIdentifyPayload,
  }),
  z.object({
    type: z.literal('increment'),
    payload: zIncrementPayload,
  }),
  z.object({
    type: z.literal('decrement'),
    payload: zDecrementPayload,
  }),
  z.object({
    type: z.literal('alias'),
    payload: zAliasPayload,
  }),
  z.object({
    type: z.literal('replay'),
    payload: zReplayPayload,
  }),
  z.object({
    type: z.literal('group'),
    payload: zGroupPayload,
  }),
  z.object({
    type: z.literal('assign_group'),
    payload: zAssignGroupPayload,
  }),
]);

export type ITrackPayload = z.infer<typeof zTrackPayload>;
export type IIdentifyPayload = z.infer<typeof zIdentifyPayload>;
export type IIncrementPayload = z.infer<typeof zIncrementPayload>;
export type IDecrementPayload = z.infer<typeof zDecrementPayload>;
export type IAliasPayload = z.infer<typeof zAliasPayload>;
export type IReplayPayload = z.infer<typeof zReplayPayload>;
export type IGroupPayload = z.infer<typeof zGroupPayload>;
export type IAssignGroupPayload = z.infer<typeof zAssignGroupPayload>;
export type ITrackHandlerPayload = z.infer<typeof zTrackHandlerPayload>;

// Deprecated types for beta version of the SDKs

export interface DeprecatedOpenpanelEventOptions {
  profileId?: string;
}

export interface DeprecatedPostEventPayload {
  name: string;
  timestamp: string;
  profileId?: string;
  properties?: Record<string, unknown> & DeprecatedOpenpanelEventOptions;
}

export interface DeprecatedUpdateProfilePayload {
  profileId: string;
  firstName?: string;
  lastName?: string;
  email?: string;
  avatar?: string;
  properties?: Record<string, unknown>;
}

export interface DeprecatedIncrementProfilePayload {
  profileId: string;
  property: string;
  value: number;
}

export interface DeprecatedDecrementProfilePayload {
  profileId?: string;
  property: string;
  value: number;
}