adserver-dashboard 1.0.0

package/PCM/src/validators/lineItemValidator.js

@@ -0,0 +1,489 @@
+import Joi from 'joi';
+
+// Common pacing schema - used for both DIRECT and PROGRAMMATIC modes
+const pacingSchema = Joi.object({
+  type: Joi.string().valid('even', 'asap', 'front-loaded', 'back-loaded').optional(),
+  dailyCap: Joi.number().integer().min(0).optional(),
+  hourlyCap: Joi.number().integer().min(0).optional()
+}).optional();
+
+// Custom fee schema - array of fee objects
+const customFeeSchema = Joi.object({
+  name: Joi.string().required(),
+  amount: Joi.number().min(0).required(),
+  type: Joi.string().valid('fixed', 'percentage').required(),
+  invoiced: Joi.boolean().default(false)
+}).custom((value, helpers) => {
+  if (value.type === 'percentage' && value.amount > 100) {
+    return helpers.error('any.invalid', { message: 'Percentage amount cannot exceed 100' });
+  }
+  return value;
+});
+
+const customFeesSchema = Joi.array().items(customFeeSchema).optional();
+
+// Frequency cap schema
+const frequencyCapSchema = Joi.object({
+  period: Joi.string().valid('hour', 'day', 'week', 'month', 'lifetime').required(),
+  target: Joi.number().min(0).required()
+}).optional();
+
+const planningSchema = Joi.object({
+  capacity: Joi.object({
+    campaignDays: Joi.number().integer().optional(),
+    available: Joi.object({
+      slots: Joi.number().integer().optional(),
+      playTimeSec: Joi.number().optional(),
+      maxImpressions: Joi.number().integer().optional()
+    }).optional()
+  }).optional(),
+  allocation: Joi.object({
+    slots: Joi.number().integer().optional(),
+    playTimeSec: Joi.number().optional(),
+    sov: Joi.number().optional(),
+    sot: Joi.number().optional()
+  }).optional(),
+  estimates: Joi.object({
+    impressions: Joi.number().integer().optional(),
+    reach: Joi.number().integer().optional(),
+    frequency: Joi.number().optional()
+  }).optional(),
+  pricing: Joi.object({
+    cpm: Joi.number().optional(),
+    estimatedCost: Joi.number().optional(),
+    cpmBase: Joi.number().optional(),
+    estimatedCostBase: Joi.number().optional()
+  }).optional()
+}).optional();
+
+// DIRECT mode targeting schema with demographics, venueTypes, geofencing
+const targetingSchema = Joi.object({
+  demographics: Joi.object({
+    ageGroups: Joi.array().items(Joi.string()).optional(),
+    genders: Joi.array().items(Joi.string().valid('male', 'female', 'other')).optional(),
+    incomeGroups: Joi.array().items(Joi.string()).optional(),
+    interests: Joi.array().items(Joi.string()).optional(),
+    audienceBehaviour: Joi.array().items(Joi.string()).optional()
+  }).optional(),
+  venueTypes: Joi.array().items(Joi.string()).optional(),
+  geofencing: Joi.object({
+    geometrics: Joi.array().items(Joi.object({
+      type: Joi.string().valid('Point', 'LineString', 'Polygon', 'MultiPoint', 'MultiLineString', 'MultiPolygon').required(),
+      coordinates: Joi.array().required(),
+      included: Joi.boolean().default(true),
+      pois: Joi.array().items(Joi.object({
+        type: Joi.string().required(),
+        label: Joi.string().required()
+      })).optional()
+    })).optional(),
+    locations: Joi.array().items(Joi.object({
+      name: Joi.string().optional(),
+      lat: Joi.number().required(),
+      lng: Joi.number().required(),
+      radius: Joi.number().min(0).optional(),
+      address: Joi.string().optional(),
+      metadata: Joi.object({
+        type: Joi.string().valid('circle', 'place', 'isochrone', 'drive-time').optional()
+      }).optional(),
+      included: Joi.boolean().default(true),
+      pois: Joi.array().items(Joi.object({
+        type: Joi.string().required(),
+        label: Joi.string().required()
+      })).optional()
+    })).optional()
+  }).optional()
+}).optional();
+
+// Delivery targeting schema for real-time signals
+const deliveryTargetingSchema = Joi.object({
+  signals: Joi.object({
+    weather: Joi.object({
+      conditions: Joi.array().items(Joi.string()).optional(),
+      temperature: Joi.object({
+        min: Joi.number().optional(),
+        max: Joi.number().optional(),
+        unit: Joi.string().valid('celsius', 'fahrenheit').optional()
+      }).optional()
+    }).optional(),
+    traffic: Joi.object().optional(),
+    aqi: Joi.object().optional(),
+    footfall: Joi.object().optional()
+  }).optional()
+}).optional();
+
+// Targeting metadata schema with version tracking
+const targetingMetadataSchema = Joi.object({
+  inventoryFilteredBy: Joi.array().items(Joi.string().valid('demographics', 'venueTypes', 'geofencing')).optional(),
+  deliveryTriggeredBy: Joi.array().items(Joi.string()).optional(),
+  venueTaxonomyFormat: Joi.string().valid('dot-notation', 'nested', 'flat').optional(),
+  version: Joi.string().optional()
+}).optional();
+
+const directSchema = Joi.object({
+  budgetSetup: Joi.object().optional(),
+  campaignGoal: Joi.object().optional(),
+  targeting: targetingSchema,
+  planning: planningSchema
+}).optional();
+
+const programmaticSchema = Joi.object({
+  auctionType: Joi.number().integer().min(1).max(3).optional(),
+  impressionType: Joi.string().valid('SPOT', 'AUDIENCE').optional(),
+  thresholdCountPerDay: Joi.number().integer().optional(),
+  deliveryGoal: Joi.number().integer().optional(),
+  costType: Joi.string().valid('CPD', 'CPM', 'CPS').optional(),
+  bidFloor: Joi.number().optional(),
+  bidFloorBase: Joi.number().optional(),
+  netCost: Joi.number().optional(),
+  netCostPerDay: Joi.number().optional(),
+  impressions: Joi.number().integer().optional(),
+  admCreativeSync: Joi.boolean().optional(),
+  nonBillable: Joi.boolean().optional(),
+  stopBidRequests: Joi.boolean().optional(),
+  impMultiplier: Joi.object({
+    type: Joi.string().valid('ALL_TIME', 'HOURLY').optional(),
+    source: Joi.string().allow('').optional()
+  }).optional()
+}).optional();
+
+export const lineItemSchema = Joi.object({
+  id: Joi.string().optional(),
+  source: Joi.string().optional(),
+  externalId: Joi.string().allow(null, '').optional(),
+  name: Joi.string().optional(),
+  // dealType is derived from parent deal - not a user input (read-only in responses)
+  creativeType: Joi.string().valid('DISPLAY', 'VIDEO', 'AUDIO').optional(),
+  duration: Joi.number().integer().optional(), // Common field for both DIRECT and PROGRAMMATIC
+  timezoneId: Joi.string().optional(),
+  startDate: Joi.date().iso().optional(),
+  endDate: Joi.date().iso().min(Joi.ref('startDate')).optional(),
+  
+  // thresholdCountPerDay required for GUARANTEED line items (validated in route handler based on deal's dealType)
+  thresholdCountPerDay: Joi.number().integer().optional(),
+  sizes: Joi.array().items(Joi.string()).optional(),
+  resolutions: Joi.array().items(Joi.string()).optional(),
+  schedule: Joi.array().items(Joi.object({
+    type: Joi.string().valid('DEFAULT', 'CUSTOM', 'WEEKDAY', 'WEEKEND').required(),
+    date: Joi.string().when('type', { is: 'CUSTOM', then: Joi.required(), otherwise: Joi.optional() }),
+    priority: Joi.number().integer().optional(),
+    daysOfWeek: Joi.array().items(Joi.number().integer().min(1).max(7)).optional(),
+    validity: Joi.object({
+      startDate: Joi.string().required(),
+      endDate: Joi.string().required()
+    }).optional(),
+    hours: Joi.array().items(Joi.object({
+      start: Joi.number().integer().min(0).max(23).required(),
+      end: Joi.number().integer().min(0).max(23).required()
+    })).required()
+  })).optional(),
+  currency: Joi.string().optional(),
+  publisherId: Joi.string().optional(),
+  creativeRotationType: Joi.string().valid('EVEN', 'OPTIMIZED', 'MANUAL', 'SEQUENTIAL').optional(),
+  creativeSource: Joi.string().valid('PUBLISHER', 'ADVERTISER').optional(),
+  totalInventories: Joi.number().integer().optional(),
+  isPlaying: Joi.boolean().optional(),
+  status: Joi.string().valid('DRAFT', 'GENERATED', 'PENDING', 'APPROVED', 'LIVE', 'COMPLETED', 'REOPENED', 'ARCHIVED', 'EXPIRED', 'REQUESTED').optional(),
+  inventories: Joi.array().items(Joi.object({
+    id: Joi.string().required(),
+    adUnitCode: Joi.string().optional(),
+    name: Joi.string().optional(),
+    referenceId: Joi.string().optional(),
+    deviceId: Joi.string().optional(),
+    size: Joi.string().optional(),
+    publisher: Joi.object({
+      id: Joi.string().optional(),
+      name: Joi.string().optional(),
+      externalId: Joi.string().allow(null, '').optional()
+    }).optional(),
+    publisherId: Joi.string().optional(),
+    publisherName: Joi.string().optional(),
+    latitude: Joi.number().optional(),
+    longitude: Joi.number().optional(),
+    venueType: Joi.string().optional(),
+    venueTypeIds: Joi.alternatives().try(
+      Joi.array().items(Joi.string()),
+      Joi.string()
+    ).optional(),
+    thumbnail: Joi.string().optional(),
+    timezone: Joi.string().optional(),
+    countryIso2: Joi.string().max(2).optional(),
+    countryIso3: Joi.string().max(3).optional(),
+    spotsPerHour: Joi.number().integer().optional(),
+    spotDuration: Joi.number().integer().optional(),
+    clients: Joi.number().integer().optional(),
+    group: Joi.string().optional(),
+    networkId: Joi.string().optional(),
+    packageId: Joi.string().optional(),
+    bcat: Joi.array().items(Joi.object({
+      name: Joi.string().optional(),
+      code: Joi.string().optional()
+    })).optional(),
+    transit: Joi.array().items(Joi.string()).optional(),
+    publisherDomain: Joi.string().optional(),
+    enableAspectRatio: Joi.boolean().optional(),
+    displayAspectRatio: Joi.string().optional(),
+    planning: planningSchema,
+    metadata: Joi.object({
+      externalRefIds: Joi.array().items(Joi.object({
+        source: Joi.string().required(),
+        externalRefId: Joi.string().required()
+      })).optional()
+    }).unknown(true).optional()
+  })).optional(),
+  
+  // Nested mode-specific objects
+  programmatic: programmaticSchema,
+  direct: directSchema,
+  
+  // Common pacing field (for both DIRECT and PROGRAMMATIC)
+  pacing: pacingSchema,
+  
+  // Legacy flat DIRECT fields (for backward compatibility)
+  budgetSetup: Joi.object().optional(),
+  campaignGoal: Joi.object().optional(),
+  targeting: targetingSchema,
+  deliveryTargeting: deliveryTargetingSchema,
+  metadata: targetingMetadataSchema,
+  planning: planningSchema,
+  pricing: Joi.object({
+    cpm: Joi.number().optional(),
+    estimatedCost: Joi.number().optional(),
+    cpmBase: Joi.number().optional(),
+    estimatedCostBase: Joi.number().optional()
+  }).optional(),
+  
+  // Legacy flat fields (for backward compatibility) + flattened programmatic fields
+  auctionType: Joi.number().integer().min(1).max(3).optional(),
+  duration: Joi.number().integer().optional(),
+  impressionType: Joi.string().valid('SPOT', 'AUDIENCE').optional(),
+  deliveryGoal: Joi.number().integer().optional(),
+  costType: Joi.string().valid('CPD', 'CPM', 'CPS').optional(),
+  bidFloor: Joi.number().optional(),
+  bidFloorBase: Joi.number().optional(),
+  netCost: Joi.number().optional(),
+  netCostPerDay: Joi.number().optional(),
+  impressions: Joi.number().integer().optional(),
+  admCreativeSync: Joi.boolean().optional(),
+  nonBillable: Joi.boolean().optional(),
+  stopBidRequests: Joi.boolean().optional(),
+  impMultiplier: Joi.object({
+    type: Joi.string().valid('ALL_TIME', 'HOURLY').optional(),
+    source: Joi.string().allow('').optional()
+  }).optional(),
+  
+  // New line item fields
+  priority: Joi.number().integer().min(1).max(10).optional(),
+  customFees: customFeesSchema,
+  frequencyCap: frequencyCapSchema,
+  trafficAllocation: Joi.number().min(0).max(100).optional(),
+  inventorySource: Joi.string().optional()
+});
+
+export const lineItemUpdateSchema = Joi.object({
+  name: Joi.string().optional(),
+  thresholdCountPerDay: Joi.number().integer().optional(),
+  deliveryGoal: Joi.number().integer().optional(),
+  netCost: Joi.number().optional(),
+  netCostPerDay: Joi.number().optional(),
+  impressions: Joi.number().integer().optional(),
+  bidFloor: Joi.number().optional(),
+  bidFloorBase: Joi.number().optional(),
+  costType: Joi.string().valid('CPD', 'CPM', 'CPS').optional(),
+  auctionType: Joi.number().integer().min(1).max(3).optional(),
+  duration: Joi.number().integer().optional(),
+  admCreativeSync: Joi.boolean().optional(),
+  nonBillable: Joi.boolean().optional(),
+  stopBidRequests: Joi.boolean().optional(),
+  impMultiplier: Joi.object({
+    type: Joi.string().valid('ALL_TIME', 'HOURLY').optional(),
+    source: Joi.string().allow('').optional()
+  }).optional(),
+  isPlaying: Joi.boolean().optional(),
+  status: Joi.string().valid('DRAFT', 'GENERATED', 'PENDING', 'APPROVED', 'LIVE', 'COMPLETED', 'REOPENED', 'ARCHIVED', 'EXPIRED', 'REQUESTED').optional(),
+  resolutions: Joi.array().items(Joi.string()).optional(),
+  creativeSource: Joi.string().valid('PUBLISHER', 'ADVERTISER').optional(),
+  totalInventories: Joi.number().integer().optional(),
+  metadata: Joi.object().optional(),
+  schedule: Joi.array().items(Joi.object({
+    type: Joi.string().valid('DEFAULT', 'CUSTOM', 'WEEKDAY', 'WEEKEND').required(),
+    date: Joi.string().when('type', { is: 'CUSTOM', then: Joi.required(), otherwise: Joi.optional() }),
+    priority: Joi.number().integer().optional(),
+    daysOfWeek: Joi.array().items(Joi.number().integer().min(1).max(7)).optional(),
+    validity: Joi.object({
+      startDate: Joi.string().required(),
+      endDate: Joi.string().required()
+    }).optional(),
+    hours: Joi.array().items(Joi.object({
+      start: Joi.number().integer().min(0).max(23).required(),
+      end: Joi.number().integer().min(0).max(23).required()
+    })).required()
+  })).optional(),
+  
+  // Programmatic fields update (duration is now a common field at root level)
+  programmatic: Joi.object({
+    thresholdCountPerDay: Joi.number().integer().optional(),
+    deliveryGoal: Joi.number().integer().optional(),
+    netCost: Joi.number().optional(),
+    netCostPerDay: Joi.number().optional(),
+    impressions: Joi.number().integer().optional(),
+    bidFloor: Joi.number().optional(),
+    bidFloorBase: Joi.number().optional(),
+    costType: Joi.string().valid('CPD', 'CPM', 'CPS').optional(),
+    auctionType: Joi.number().integer().min(1).max(3).optional(),
+    admCreativeSync: Joi.boolean().optional(),
+    nonBillable: Joi.boolean().optional(),
+    stopBidRequests: Joi.boolean().optional(),
+    impMultiplier: Joi.object({
+      type: Joi.string().valid('ALL_TIME', 'HOURLY').optional(),
+      source: Joi.string().allow('').optional()
+    }).optional()
+  }).optional(),
+  
+  // Direct fields update
+  direct: Joi.object({
+    budgetSetup: Joi.object().optional(),
+    campaignGoal: Joi.object().optional(),
+    targeting: targetingSchema,
+    planning: planningSchema,
+    pricing: Joi.object({
+      cpm: Joi.number().optional(),
+      estimatedCost: Joi.number().optional(),
+      cpmBase: Joi.number().optional(),
+      estimatedCostBase: Joi.number().optional()
+    }).optional()
+  }).optional(),
+  
+  // Common pacing field (for both DIRECT and PROGRAMMATIC)
+  pacing: pacingSchema,
+  
+  // Legacy flat DIRECT fields
+  budgetSetup: Joi.object().optional(),
+  campaignGoal: Joi.object().optional(),
+  targeting: targetingSchema,
+  deliveryTargeting: deliveryTargetingSchema,
+  metadata: targetingMetadataSchema,
+  planning: planningSchema,
+  pricing: Joi.object({
+    cpm: Joi.number().optional(),
+    estimatedCost: Joi.number().optional(),
+    cpmBase: Joi.number().optional(),
+    estimatedCostBase: Joi.number().optional()
+  }).optional(),
+  
+  // Inventory updates
+  inventories: Joi.array().items(Joi.object({
+    id: Joi.string().required(),
+    adUnitCode: Joi.string().optional(),
+    name: Joi.string().optional(),
+    referenceId: Joi.string().optional(),
+    deviceId: Joi.string().optional(),
+    size: Joi.string().optional(),
+    publisher: Joi.object({
+      id: Joi.string().optional(),
+      name: Joi.string().optional(),
+      externalId: Joi.string().allow(null, '').optional()
+    }).optional(),
+    publisherId: Joi.string().optional(),
+    publisherName: Joi.string().optional(),
+    latitude: Joi.number().optional(),
+    longitude: Joi.number().optional(),
+    venueType: Joi.string().optional(),
+    venueTypeIds: Joi.alternatives().try(
+      Joi.array().items(Joi.string()),
+      Joi.string()
+    ).optional(),
+    thumbnail: Joi.string().optional(),
+    timezone: Joi.string().optional(),
+    countryIso2: Joi.string().max(2).optional(),
+    countryIso3: Joi.string().max(3).optional(),
+    spotsPerHour: Joi.number().integer().optional(),
+    spotDuration: Joi.number().integer().optional(),
+    clients: Joi.number().integer().optional(),
+    group: Joi.string().optional(),
+    networkId: Joi.string().optional(),
+    packageId: Joi.string().optional(),
+    bcat: Joi.array().items(Joi.object({
+      name: Joi.string().optional(),
+      code: Joi.string().optional()
+    })).optional(),
+    transit: Joi.array().items(Joi.string()).optional(),
+    publisherDomain: Joi.string().optional(),
+    enableAspectRatio: Joi.boolean().optional(),
+    displayAspectRatio: Joi.string().optional(),
+    planning: planningSchema,
+    metadata: Joi.object({
+      externalRefIds: Joi.array().items(Joi.object({
+        source: Joi.string().required(),
+        externalRefId: Joi.string().required()
+      })).optional()
+    }).unknown(true).optional()
+  })).optional(),
+  
+  // Date updates
+  startDate: Joi.date().iso().optional(),
+  endDate: Joi.date().iso().optional(),
+  timezoneId: Joi.string().optional(),
+  currency: Joi.string().optional(),
+  creativeType: Joi.string().valid('DISPLAY', 'VIDEO', 'AUDIO').optional(),
+  creativeRotationType: Joi.string().valid('EVEN', 'OPTIMIZED', 'MANUAL', 'SEQUENTIAL').optional(),
+  publisherId: Joi.string().optional(),
+  
+  // New line item fields
+  priority: Joi.number().integer().min(1).max(10).optional(),
+  customFees: customFeesSchema,
+  frequencyCap: frequencyCapSchema,
+  trafficAllocation: Joi.number().min(0).max(100).optional(),
+  inventorySource: Joi.string().optional()
+}).min(1);
+
+const inventoryItemSchema = Joi.object({
+  id: Joi.string().required(),
+  adUnitCode: Joi.string().optional(),
+  name: Joi.string().optional(),
+  referenceId: Joi.string().optional(),
+  deviceId: Joi.string().optional(),
+  size: Joi.string().optional(),
+  publisher: Joi.object({
+    id: Joi.string().optional(),
+    name: Joi.string().optional(),
+    externalId: Joi.string().allow(null, '').optional()
+  }).optional(),
+  publisherId: Joi.string().optional(),
+  publisherName: Joi.string().optional(),
+  latitude: Joi.number().optional(),
+  longitude: Joi.number().optional(),
+  venueType: Joi.string().optional(),
+  venueTypeIds: Joi.alternatives().try(
+    Joi.array().items(Joi.string()),
+    Joi.string()
+  ).optional(),
+  thumbnail: Joi.string().optional(),
+  timezone: Joi.string().optional(),
+  countryIso2: Joi.string().max(2).optional(),
+  countryIso3: Joi.string().max(3).optional(),
+  spotsPerHour: Joi.number().integer().optional(),
+  spotDuration: Joi.number().integer().optional(),
+  clients: Joi.number().integer().optional(),
+  group: Joi.string().optional(),
+  networkId: Joi.string().optional(),
+  packageId: Joi.string().optional(),
+  bcat: Joi.array().items(Joi.object({
+    name: Joi.string().optional(),
+    code: Joi.string().optional()
+  })).optional(),
+  transit: Joi.array().items(Joi.string()).optional(),
+  publisherDomain: Joi.string().optional(),
+  enableAspectRatio: Joi.boolean().optional(),
+  displayAspectRatio: Joi.string().optional(),
+  planning: planningSchema,
+  metadata: Joi.object({
+    externalRefIds: Joi.array().items(Joi.object({
+      source: Joi.string().required(),
+      externalRefId: Joi.string().required()
+    })).optional()
+  }).unknown(true).optional()
+});
+
+export const inventoriesBulkUpdateSchema = Joi.object({
+  inventories: Joi.array().items(inventoryItemSchema).required()
+});