adserver-dashboard 1.0.0

package/shared/direct-io-schema.ts

@@ -0,0 +1,383 @@
+import { z } from "zod";
+
+// ============================================================================
+// DIRECT I/O CAMPAIGN API SCHEMAS
+// ============================================================================
+
+// Campaign Status Enum
+export const directCampaignStatusEnum = z.enum([
+  "draft",
+  "active",
+  "paused",
+  "completed",
+  "cancelled"
+]);
+
+// Client Type Enum
+export const clientTypeEnum = z.enum([
+  "buyer",
+  "agency"
+]);
+
+// Goal Type Enum
+export const goalTypeEnum = z.enum([
+  "impressions",
+  "reach",
+  "engagement"
+]);
+
+// Criteria Type Enum
+export const criteriaTypeEnum = z.enum([
+  "demographics",
+  "venue",
+  "geofencing",
+  "weather",
+  "search_behavior",
+  "footfall_patterns",
+  "time_based",
+  "local_events"
+]);
+
+// Schedule Type Enum
+export const scheduleTypeEnum = z.enum([
+  "preset",
+  "custom",
+  "advanced"
+]);
+
+// Creative Type Enum
+export const creativeTypeEnum = z.enum([
+  "image",
+  "video",
+  "html5",
+  "dynamic"
+]);
+
+// Creative Status Enum
+export const creativeStatusEnum = z.enum([
+  "active",
+  "paused",
+  "expired"
+]);
+
+// Inventory Type Enum
+export const inventoryTypeEnum = z.enum([
+  "billboard",        // Classic inventory
+  "digital_screen",   // Digital inventory
+  "transit",          // Transit displays
+  "street_furniture", // Bus shelters, kiosks
+  "place_based",      // Retail, venues
+  "other"             // Other OOH types
+]);
+
+// Inventory Status Enum
+export const inventoryStatusEnum = z.enum([
+  "scheduled",
+  "active",
+  "paused",
+  "completed"
+]);
+
+// Campaign Schema
+export const directCampaignSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  start_date: z.string(),
+  end_date: z.string(),
+  client_type: clientTypeEnum,
+  buyer_name: z.string().optional(),
+  agency_name: z.string().optional(),
+  brand: z.string(),
+  status: directCampaignStatusEnum,
+  publisher_ids: z.array(z.string()).optional(),
+  publishers: z.array(z.object({
+    id: z.string(),
+    name: z.string(),
+  })).optional(),
+  is_external: z.boolean().optional(),  // Flag to indicate if campaign is from external source
+  external_id: z.string().optional(),   // External system ID
+  source: z.string().optional(),        // Source system name (e.g., "PLANNER", "ACTIVATE")
+  no_of_inventories: z.number().optional(),  // Number of inventories assigned to campaign
+  created_at: z.string(),
+  updated_at: z.string(),
+});
+
+export const insertDirectCampaignSchema = directCampaignSchema.omit({
+  id: true,
+  created_at: true,
+  updated_at: true,
+  publisher_ids: true,
+}).extend({
+  status: directCampaignStatusEnum.optional(),
+});
+
+// Budget Schema
+export const directBudgetSchema = z.object({
+  id: z.string(),
+  campaign_id: z.string(),
+  country_code: z.string(),
+  currency: z.string(),
+  total_budget: z.number(),
+  daily_budget: z.number().optional(),
+  goal_type: goalTypeEnum,
+  target_value: z.number(),
+});
+
+export const insertDirectBudgetSchema = directBudgetSchema.omit({
+  id: true,
+  campaign_id: true,
+});
+
+// Targeting Schema
+export const directTargetingSchema = z.object({
+  id: z.string(),
+  campaign_id: z.string(),
+  criteria_type: criteriaTypeEnum,
+  criteria_config: z.record(z.any()),
+  created_at: z.string(),
+  updated_at: z.string(),
+});
+
+export const insertDirectTargetingSchema = directTargetingSchema.omit({
+  id: true,
+  campaign_id: true,
+  created_at: true,
+  updated_at: true,
+});
+
+// Schedule Schema
+export const directScheduleSchema = z.object({
+  id: z.string(),
+  campaign_id: z.string(),
+  schedule_type: scheduleTypeEnum,
+  preset_id: z.string().optional(),
+  custom_schedule: z.record(z.any()).optional(),
+  created_at: z.string(),
+});
+
+export const insertDirectScheduleSchema = directScheduleSchema.omit({
+  id: true,
+  campaign_id: true,
+  created_at: true,
+});
+
+// Inventory Schema
+export const directInventorySchema = z.object({
+  id: z.string(),
+  campaign_id: z.string(),
+  inventory_id: z.string(),
+  type: inventoryTypeEnum,
+  name: z.string().optional(),
+  size: z.string().optional(),
+  publisher_id: z.string().optional(),
+  publisher_name: z.string().optional(),
+  latitude: z.number().optional(),
+  longitude: z.number().optional(),
+  venue_type: z.string().optional(),
+  thumbnail: z.string(),
+  timezone: z.string().optional(),
+  transit: z.array(z.string()).optional(),
+  status: inventoryStatusEnum,
+  created_at: z.string(),
+});
+
+export const insertDirectInventorySchema = directInventorySchema.omit({
+  id: true,
+  campaign_id: true,
+  created_at: true,
+}).extend({
+  status: inventoryStatusEnum.optional(),
+});
+
+// Creative Schema
+export const directCreativeSchema = z.object({
+  id: z.string(),
+  campaign_id: z.string(),
+  creative_name: z.string(),
+  creative_type: creativeTypeEnum,
+  asset_url: z.string(),
+  thumbnail_url: z.string().optional(),
+  duration_seconds: z.number().optional(),
+  dimensions: z.record(z.any()).optional(),
+  metadata: z.record(z.any()).optional(),
+  status: creativeStatusEnum,
+  content_hub_id: z.string().optional(), // Reference to Content Hub creative
+  created_at: z.string(),
+  updated_at: z.string(),
+});
+
+export const insertDirectCreativeSchema = directCreativeSchema.omit({
+  id: true,
+  campaign_id: true,
+  created_at: true,
+  updated_at: true,
+}).extend({
+  status: creativeStatusEnum.optional(),
+  // thumbnail_url must be a valid URL or undefined (API rejects empty strings)
+  thumbnail_url: z.string().url().min(1).optional().or(z.literal("").transform(() => undefined)),
+});
+
+// API Response Wrapper
+export const directApiResponseSchema = z.object({
+  requestId: z.string(),
+  status: z.number(),
+  result: z.any(),
+  message: z.string().optional(),
+  pagination: z.object({
+    page: z.number(),
+    limit: z.number(),
+    total: z.number(),
+    pages: z.number(),
+  }).optional(),
+});
+
+// API Error Response
+export const directApiErrorSchema = z.object({
+  requestId: z.string().optional(),
+  status: z.number(),
+  error: z.string(),
+  message: z.string(),
+  details: z.array(z.any()).optional(),
+});
+
+// ============================================================================
+// BILLBOARD SEARCH API SCHEMAS
+// ============================================================================
+
+// Billboard Display Format
+export const billboardDisplayFormatEnum = z.enum([
+  "LED",
+  "LCD",
+  "STATIC",
+  "DIGITAL"
+]);
+
+// Billboard Environment
+export const billboardEnvironmentEnum = z.enum([
+  "outdoor",
+  "indoor"
+]);
+
+// Billboard Orientation
+export const billboardOrientationEnum = z.enum([
+  "landscape",
+  "portrait",
+  "square"
+]);
+
+// Geometry Types for Location Search
+export const geometryTypeEnum = z.enum([
+  "Circle",
+  "Polygon",
+  "BoundingBox"
+]);
+
+// Billboard Panel Schema
+export const billboardPanelSchema = z.object({
+  billboardId: z.string().optional(),
+  createdAt: z.string().optional(),
+  createdBy: z.string().optional(),
+  id: z.string().optional(),
+  panelCount: z.number().optional(),
+  physicalHeight: z.number().optional(),
+  physicalWidth: z.number().optional(),
+  pixelHeight: z.number().optional(),
+  pixelWidth: z.number().optional(),
+  updatedAt: z.string().optional(),
+  updatedBy: z.string().optional(),
+});
+
+// Billboard Tag Schema
+export const billboardTagSchema = z.object({
+  createdAt: z.string().optional(),
+  createdBy: z.string().optional(),
+  hexColor: z.string().optional(),
+  id: z.string(),
+  mediaOwnerId: z.string().optional(),
+  name: z.string(),
+  updatedAt: z.string().optional(),
+  updatedBy: z.string().optional(),
+});
+
+// Billboard Search Response Item
+export const billboardSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  address: z.string().optional(),
+  adminLevel0Id: z.string().optional(),
+  adminLevel0Name: z.string().optional(),
+  adminLevel1Id: z.string().optional(),
+  adminLevel1Name: z.string().optional(),
+  adminLevel2Id: z.string().optional(),
+  adminLevel2Name: z.string().optional(),
+  adminLevel3Id: z.string().optional(),
+  adminLevel3Name: z.string().optional(),
+  adminLevel4Id: z.string().optional(),
+  adminLevel4Name: z.string().optional(),
+  archived: z.boolean().optional(),
+  description: z.string().optional(),
+  displayFormatId: z.number().optional(),
+  displayFormatName: z.string().optional(),
+  environment: billboardEnvironmentEnum.optional(),
+  geom: z.string().optional(),
+  mediaOwnerId: z.string().optional(),
+  mediaOwnerName: z.string().optional(),
+  orientation: billboardOrientationEnum.optional(),
+  panels: z.array(billboardPanelSchema).optional(),
+  requiresContentApproval: z.boolean().optional(),
+  tags: z.array(billboardTagSchema).optional(),
+  thumbnailUrl: z.string().optional(),
+  timeZone: z.string().optional(),
+  typeName: z.string().optional(),
+  typePath: z.string().optional(),
+  url: z.string().optional(),
+  createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
+});
+
+// Billboard Search Request
+export const billboardSearchRequestSchema = z.object({
+  adminLevel0Ids: z.array(z.string()).optional(),
+  adminLevel1Ids: z.array(z.string()).optional(),
+  adminLevel2Ids: z.array(z.string()).optional(),
+  adminLevel3Ids: z.array(z.string()).optional(),
+  adminLevel4Ids: z.array(z.string()).optional(),
+  archived: z.boolean().optional(),
+  billboardIds: z.array(z.string()).optional(),
+  displayFormats: z.array(z.string()).optional(),
+  environment: billboardEnvironmentEnum.optional(),
+  geometry: z.object({
+    boundingBox: z.array(z.number()).optional(),
+    center: z.array(z.number()).optional(),
+    coordinates: z.string().optional(),
+    radius: z.number().optional(),
+    type: geometryTypeEnum.optional(),
+  }).optional(),
+  mediaOwnerIds: z.array(z.string()).optional(),
+  orientation: billboardOrientationEnum.optional(),
+  requiresContentApproval: z.boolean().optional(),
+  searchText: z.string().optional(),
+  tagIds: z.array(z.string()).optional(),
+  typePaths: z.array(z.string()).optional(),
+  typePathsHierarchical: z.array(z.string()).optional(),
+});
+
+// Types
+export type DirectCampaign = z.infer<typeof directCampaignSchema>;
+export type InsertDirectCampaign = z.infer<typeof insertDirectCampaignSchema>;
+export type DirectBudget = z.infer<typeof directBudgetSchema>;
+export type InsertDirectBudget = z.infer<typeof insertDirectBudgetSchema>;
+export type DirectTargeting = z.infer<typeof directTargetingSchema>;
+export type InsertDirectTargeting = z.infer<typeof insertDirectTargetingSchema>;
+export type DirectSchedule = z.infer<typeof directScheduleSchema>;
+export type InsertDirectSchedule = z.infer<typeof insertDirectScheduleSchema>;
+export type DirectInventory = z.infer<typeof directInventorySchema>;
+export type InsertDirectInventory = z.infer<typeof insertDirectInventorySchema>;
+export type DirectCreative = z.infer<typeof directCreativeSchema>;
+export type InsertDirectCreative = z.infer<typeof insertDirectCreativeSchema>;
+export type DirectApiResponse = z.infer<typeof directApiResponseSchema>;
+export type DirectApiError = z.infer<typeof directApiErrorSchema>;
+export type Billboard = z.infer<typeof billboardSchema>;
+export type BillboardSearchRequest = z.infer<typeof billboardSearchRequestSchema>;
+export type BillboardPanel = z.infer<typeof billboardPanelSchema>;
+export type BillboardTag = z.infer<typeof billboardTagSchema>;