openapi-dependencies.ts

// TODO - split request / response

// TODO - this should be generated
// - in request (builder) XML
const MapNS_Tags: Record<string, string> = {
  'OJPRequest.ServiceRequest': 'siri',
  'ServiceRequest.ServiceRequestContext': 'siri',
  'ServiceRequestContext.Language': 'siri',
  'ServiceRequest.RequestTimestamp': 'siri',
  'ServiceRequest.RequestorRef': 'siri',

  'OJPResponse.ServiceDelivery': 'siri',
  'ServiceDelivery.ResponseTimestamp': 'siri',
  'ServiceDelivery.ProducerRef': 'siri',

  // TRR
  'OJPTripRefineRequest.RequestTimestamp': 'siri',
  
  // FareRequest
  'OJPFareRequest.RequestTimestamp': 'siri',

  // TripInfoRequest  
  'OJPTripInfoRequest.RequestTimestamp': 'siri',

  // TripRequest  
  'OJPTripRequest.RequestTimestamp': 'siri',
 
  // TripResponse
  'OJPTripDelivery.ResponseTimestamp': 'siri',
  'OJPTripDelivery.RequestMessageRef': 'siri',
  'OJPTripDelivery.DefaultLanguage': 'siri',

  'LegBoard.StopPointRef': 'siri',
  'LegIntermediate.StopPointRef': 'siri',
  'LegIntermediates.StopPointRef': 'siri', // OJP v1
  'LegAlight.StopPointRef': 'siri',
  
  'Mode.AirSubmode': 'siri',
  'Mode.BusSubmode': 'siri',
  'Mode.CoachSubmode': 'siri',
  'Mode.FunicularSubmode': 'siri',
  'Mode.MetroSubmode': 'siri',
  'Mode.TramSubmode': 'siri',
  'Mode.TelecabinSubmode': 'siri',
  'Mode.RailSubmode': 'siri',
  'Mode.WaterSubmode': 'siri',

  'ModeAndModeOfOperationFilter.AirSubmode': 'siri',
  'ModeAndModeOfOperationFilter.BusSubmode': 'siri',
  'ModeAndModeOfOperationFilter.CoachSubmode': 'siri',
  'ModeAndModeOfOperationFilter.FunicularSubmode': 'siri',
  'ModeAndModeOfOperationFilter.MetroSubmode': 'siri',
  'ModeAndModeOfOperationFilter.TramSubmode': 'siri',
  'ModeAndModeOfOperationFilter.TelecabinSubmode': 'siri',
  'ModeAndModeOfOperationFilter.RailSubmode': 'siri',
  'ModeAndModeOfOperationFilter.WaterSubmode': 'siri',

  'Service.LineRef': 'siri',
  'Service.OperatorRef': 'siri',
  'Service.DirectionRef': 'siri',

  'TrackSectionStart.StopPointRef': 'siri',
  'TrackSectionEnd.StopPointRef': 'siri',
  
  'Position.Longitude': 'siri',
  'Position.Latitude': 'siri',

  'LegStart.StopPointRef': 'siri',
  'LegEnd.StopPointRef': 'siri',

  // ExpectedDepartureOccupancy
  'LegBoard.ExpectedDepartureOccupancy': 'siri',
  'LegAlight.ExpectedDepartureOccupancy': 'siri',
  'LegIntermediate.ExpectedDepartureOccupancy': 'siri',
  'ExpectedDepartureOccupancy.FareClass': 'siri',
  'ExpectedDepartureOccupancy.OccupancyLevel': 'siri',

  // LIR Request
  'OJPLocationInformationRequest.RequestTimestamp': 'siri',
  'UpperLeft.Longitude': 'siri',
  'UpperLeft.Latitude': 'siri',
  'LowerRight.Longitude': 'siri',
  'LowerRight.Latitude': 'siri',

  // TR Request
  'GeoPosition.Longitude': 'siri',
  'GeoPosition.Latitude': 'siri',
  'Line.LineRef': 'siri',

  // SER Request
  'OJPStopEventRequest.RequestTimestamp': 'siri',
  'PlaceRef.StopPointRef': 'siri',
};

// OJP Legacy(v1): keep same k/v as in MapNS_Tags and override only some
const MapLegacyOverrideNS_Tags: Record<string, string> = {
  'Service.OperatorRef': 'ojp',
}

// TODO - this should be generated
// - this is used by the parser.isArrayHandler - to always return arrays even when there is only one result
// - in response (parser) XML
const MapArrayTags: Record<string, boolean> = {
  // Shared
  'places.place': true,
  'linkProjection.position': true,

  // PSituation Refs
  'situationFullRefs.situationFullRef': true,
  'situations.ptSituation': true,

  // PtSituation OJP v2
  'ptSituation.validityPeriod': true,
  'publishingActions.publishingAction': true,
  'publishingAction.passengerInformationAction': true,
  'passengerInformationAction.textualContent': true,
  'textualContent.descriptionContent': true,
  'textualContent.consequenceContent': true,
  'textualContent.recommendationContent': true,
  'textualContent.remarkContent': true,
  'textualContent.infoLink': true,
  // technically these are also arrays - but the OJP repsonse never returned it as such
  // 'descriptionContent.descriptionText': true,
  // 'consequenceContent.consequenceText': true,
  // 'recommendationContent.recommendationText': true,
  // 'remarkContent.remark': true,
  
  'itModeAndModeOfOperation.personalModeOfOperation': true,

  // Service
  'service.attribute': true,

  // TR Request
  'origin.individualTransportOption': true,
  'destination.individualTransportOption': true,

  // TR Response
  'OJPTripDelivery.tripResult': true,
  'trip.leg': true,
  'timedLeg.legIntermediate': true,
  'legTrack.trackSection': true,
  'pathGuidance.pathGuidanceSection': true,

  // TR Response, ExpectedDepartureOccupancy
  'legBoard.expectedDepartureOccupancy': true,
  'legIntermediate.expectedDepartureOccupancy': true,
  'legAlight.expectedDepartureOccupancy': true,

  // LIR Response
  'OJPLocationInformationDelivery.placeResult': true,
  'place.mode': true,
  'place.attribute': true,
  
  // LIR Response POI
  'pointOfInterest.pointOfInterestCategory': true,
  'pointOfInterestCategory.osmTag': true,
  'pointOfInterestCategory.pointOfInterestClassification': true,
  'pOIAdditionalInformation.pOIAdditionalInformation': true,

  // Fare Response
  'OJPFareDelivery.fareResult': true,
  'fareResult.tripFareResult': true, // TODO - this is not in the current schema (v2)
  'tripFareResult.fareProduct': true,

  // StopEvent Response
  'OJPStopEventDelivery.stopEventResult': true,
  'stopEvent.previousCall': true,
  'stopEvent.onwardCall': true,

  // TripInfoResult
  'OJPTripInfoDelivery.tripInfoResult': true,
  'tripInfoResult.previousCall': true,
  'tripInfoResult.onwardCall': true,
  'journeyTrack.trackSection': true,

  // TripRefineResult
  'OJPTripRefineDelivery.tripResult': true,
};

// OJP v1.0
// - this is used by the parser.isArrayHandler - to always return arrays even when there is only one result
// - in response (parser) XML
const MapLegacyArrayTags: Record<string, boolean> = {
  'places.location': true,

  'trip.tripLeg': true,

  // PtSituation OJP v1
  'callAtStop.situationFullRef': true,
  'ptSituation.description': true,
  'ptSituation.detail': true,
  'stopPoints.affectedStopPoint': true,
  'vehicleJourneys.affectedVehicleJourney': true,
  
  // in OJPv1 there is no <SituationFullRefs> wrapper, the <SituationFullRef> are directly under <Service>
  'service.situationFullRef': true,

  'timedLeg.legIntermediates': true,

  'OJPLocationInformationDelivery.location': true,
  'location.mode': true,
  'location.attribute': true,
};

// TODO - this should be generated
// - in response (parser) XML
const MapStringValues: Record<string, boolean> = {
  'stopPlace.stopPlaceRef': true,
  'publishedServiceName.text': true,
  'service.operatorRef': true,
};

export const OpenAPI_Dependencies = {
  MapNS_Tags: MapNS_Tags,
  MapLegacyOverrideNS_Tags: MapLegacyOverrideNS_Tags,
  MapArrayTags: MapArrayTags,
  MapLegacyArrayTags: MapLegacyArrayTags,
  MapStringValues: MapStringValues,
} as const;