stationapi.proto

syntax = "proto3";

package app.trainlcd.grpc;

service StationAPI {
  rpc GetStationById(GetStationByIdRequest) returns (SingleStationResponse) {}
  rpc GetStationByIdList(GetStationByIdListRequest)
      returns (MultipleStationResponse) {}
  rpc GetStationsByGroupId(GetStationByGroupIdRequest)
      returns (MultipleStationResponse) {}
  rpc GetStationsByCoordinates(GetStationByCoordinatesRequest)
      returns (MultipleStationResponse) {}
  rpc GetStationsByLineId(GetStationByLineIdRequest)
      returns (MultipleStationResponse) {}
  rpc GetStationsByLineIdList(GetStationByLineIdListRequest)
      returns (MultipleStationResponse) {}
  rpc GetStationsByName(GetStationsByNameRequest)
      returns (MultipleStationResponse) {}
  rpc GetStationsByLineGroupId(GetStationsByLineGroupIdRequest)
      returns (MultipleStationResponse) {}
  rpc GetStationsByLineGroupIdList(GetStationsByLineGroupIdListRequest)
      returns (MultipleStationResponse) {}
  rpc GetTrainTypesByStationId(GetTrainTypesByStationIdRequest)
      returns (MultipleTrainTypeResponse) {}
  rpc GetRoutes(GetRouteRequest) returns (RouteResponse) {}
  rpc GetRoutesMinimal(GetRouteRequest) returns (RouteMinimalResponse) {}
  rpc GetLineById(GetLineByIdRequest) returns (SingleLineResponse) {}
  rpc GetLinesByIdList(GetLinesByIdListRequest) returns (MultipleLineResponse) {}
  rpc GetLinesByName(GetLinesByNameRequest) returns (MultipleLineResponse) {}
  rpc GetConnectedRoutes(GetConnectedStationsRequest) returns (RouteResponse) {}
  rpc GetRouteTypes(GetRouteRequest) returns (RouteTypeResponse) {}
}

message GetStationByIdRequest {
  uint32 id = 1;
  optional TransportType transport_type = 2; // Unspecified = rail only (default)
}

message GetStationByIdListRequest {
  repeated uint32 ids = 1;
  optional TransportType transport_type = 2; // Unspecified = rail only (default)
}

message GetStationByGroupIdRequest {
  uint32 group_id = 1;
  optional TransportType transport_type = 2; // Filter by transport type. Unspecified = rail only (default)
}

message GetStationByCoordinatesRequest {
  double latitude = 1;
  double longitude = 2;
  optional uint32 limit = 3;
  optional TransportType transport_type = 4;  // Filter by transport type. Unspecified = rail only (default)
}

message GetStationByLineIdRequest {
  uint32 line_id = 1;
  optional uint32 station_id = 2;
  optional uint32 direction_id = 3; // Direction: 0 = default order, 1 or 2 = reverse order
  optional TransportType transport_type = 4; // Unspecified = rail only (default)
}

message GetStationByLineIdListRequest {
  repeated uint32 line_ids = 1;
  optional TransportType transport_type = 2;
}

message GetStationsByNameRequest {
  string station_name = 1;
  optional uint32 limit = 2;
  optional uint32 from_station_group_id = 3;
  optional TransportType transport_type = 4;  // Filter by transport type. Unspecified = rail only (default)
}

message GetRouteRequest {
  uint32 from_station_group_id = 1;
  uint32 to_station_group_id = 2;
  uint32 page_size = 3;
  string page_token = 4;
  optional uint32 via_line_id = 5;
}

message GetStationsByLineGroupIdRequest {
  uint32 line_group_id = 1;
  optional TransportType transport_type = 2; // Unspecified = rail only (default)
  optional uint32 direction_id = 3; // Direction: 0 = default order, 1 or 2 = reverse order
}

message GetStationsByLineGroupIdListRequest {
  repeated uint32 line_group_ids = 1;
  optional TransportType transport_type = 2;
}

message GetTrainTypesByStationIdRequest { uint32 station_id = 1; }

message GetLineByIdRequest { uint32 line_id = 1; }

message GetLinesByIdListRequest { repeated uint32 line_ids = 1; }

message CoordinatesRequest {
  double latitude = 1;
  double longitude = 2;
  optional uint32 line_id = 3;
}

message GetLinesByNameRequest {
  string line_name = 1;
  optional uint32 limit = 2;
}

message GetConnectedStationsRequest {
  uint32 from_station_group_id = 1;
  uint32 to_station_group_id = 2;
}

enum OperationStatus {
  InOperation = 0;
  NotOpened = 1;
  Closed = 2;
}

// Transport type for filtering rail/bus
enum TransportType {
  TransportTypeUnspecified = 0; // Default: rail only
  Rail = 1; // Rail only (stations)
  Bus = 2; // Bus only (bus stops)
  RailAndBus = 3; // Rail + nearby bus stops
}

message StationNumber {
  string line_symbol = 1;
  string line_symbol_color = 2;
  string line_symbol_shape = 3;
  string station_number = 4;
}

enum TtsAlphabet {
  TTS_ALPHABET_UNSPECIFIED = 0;
  TTS_ALPHABET_IPA = 1;
  TTS_ALPHABET_YOMIGANA = 2;
  TTS_ALPHABET_PLAIN = 3;
}

// TTS用の1セグメント。`lang` は "en-US" や "ja-JP" のような BCP-47 言語タグで、
// `surface` / `fallback_text` / `pronunciation` をクライアントがどの言語として
// 解釈するかを示す。`separator` はこのセグメントの後ろにだけ付与する接尾区切りで、
// 次のセグメントとの間に挿入し、セグメント列の末尾では無視する。
message TtsSegment {
  string surface = 1;
  string fallback_text = 2;
  string pronunciation = 3;
  TtsAlphabet alphabet = 4;
  string lang = 5;
  string separator = 6;
}

enum StopCondition {
  All = 0;
  Not = 1;
  Partial = 2;
  Weekday = 3;
  Holiday = 4;
  PartialStop = 5;
}

enum TrainDirection {
  Both = 0;
  Inbound = 1;
  Outbound = 2;
}

enum TrainTypeKind {
  Default = 0;
  Branch = 1;
  Rapid = 2;
  Express = 3;
  LimitedExpress = 4;
  HighSpeedRapid = 5;
}

message TrainType {
  uint32 id = 1;
  uint32 type_id = 2;
  uint32 group_id = 3;
  string name = 4;
  string name_katakana = 5;
  optional string name_roman = 6;
  optional string name_chinese = 7;
  optional string name_korean = 8;
  string color = 9;
  repeated Line lines = 10;
  optional Line line = 11;
  TrainDirection direction = 12;
  TrainTypeKind kind = 13;
  optional string name_ipa = 14; // TTS用カタカナ名のIPA転写
  optional string name_roman_ipa = 15; // TTS用英語名のIPA転写
  repeated TtsSegment name_tts_segments = 16; // TTS用読みセグメント
}

message Station {
  uint32 id = 1;
  uint32 group_id = 2;
  string name = 3;
  string name_katakana = 4;
  optional string name_roman = 5;
  optional string name_chinese = 6;
  optional string name_korean = 7;
  optional string three_letter_code = 8;
  repeated Line lines = 9;
  optional Line line = 10;
  uint32 prefecture_id = 11;
  string postal_code = 12;
  string address = 13;
  double latitude = 14;
  double longitude = 15;
  string opened_at = 16;
  string closed_at = 17;
  OperationStatus status = 18;
  repeated StationNumber station_numbers = 19;
  StopCondition stop_condition = 20;
  optional double distance = 21;
  optional bool has_train_types = 22;
  optional TrainType train_type = 23;
  TransportType transport_type = 24; // Rail or Bus
  optional string name_ipa = 25; // TTS用カタカナ名のIPA転写
  optional string name_roman_ipa = 26; // TTS用英語名のIPA転写
  repeated TtsSegment name_tts_segments = 27; // TTS用読みセグメント
}

message SingleStationResponse { Station station = 1; }

message MultipleStationResponse { repeated Station stations = 1; }

message MultipleTrainTypeResponse { repeated TrainType train_types = 1; }

message SingleLineResponse { Line line = 1; }

message MultipleLineResponse { repeated Line lines = 1; }

enum DistanceResponseState {
  Away = 0;
  Arrived = 1;
  Approaching = 2;
}

message DistanceResponse {
  uint32 station_id = 1;
  double distance = 2;
  DistanceResponseState state = 3;
}

message RouteResponse {
  repeated Route routes = 1;
  string next_page_token = 2;
 }

 message RouteTypeResponse {
  repeated TrainType train_types = 1;
  string next_page_token = 2;
 }

enum LineType {
  OtherLineType = 0;
  BulletTrain = 1;
  Normal = 2;
  Subway = 3;
  Tram = 4;
  MonorailOrAGT = 5;
}

message LineSymbol {
  string symbol = 1;
  string color = 2;
  string shape = 3;
}

enum CompanyType {
  OtherCompany = 0;
  JR = 1;
  Private = 2;
  Major = 3;
  SemiMajor = 4;
}

message Company {
  uint32 id = 1;
  uint32 railroad_id = 2;
  string name_short = 3;
  string name_katakana = 4;
  string name_full = 5;
  string name_english_short = 6;
  string name_english_full = 7;
  optional string url = 8;
  CompanyType type = 9;
  OperationStatus status = 10;
  string name = 11;
}

message Line {
  uint32 id = 1;
  string name_short = 2;
  string name_katakana = 3;
  string name_full = 4;
  optional string name_roman = 5;
  optional string name_chinese = 6;
  optional string name_korean = 7;
  string color = 8;
  LineType line_type = 9;
  repeated LineSymbol line_symbols = 10;
  OperationStatus status = 11;
  optional Station station = 12;
  optional Company company = 13;
  optional TrainType train_type = 14; // 同一種別のリクエストの場合出力する
  double average_distance = 15;
  TransportType transport_type = 16; // Rail or Bus
  optional string name_ipa = 17; // TTS用カタカナ名のIPA転写
  optional string name_roman_ipa = 18; // TTS用英語名のIPA転写
  repeated TtsSegment name_tts_segments = 19; // TTS用読みセグメント
}

message SingleLine { Line line = 1; }

message MultipleLine { repeated Line lines = 1; }

message Route {
  uint32 id = 1;
  repeated Station stops = 2;
}

// Minimal message definitions for optimized GetRoutesMinimal RPC
message StationMinimal {
  uint32 id = 1;
  uint32 group_id = 2;
  string name = 3;
  string name_katakana = 4;
  optional string name_roman = 5;
  repeated uint32 line_ids = 6; // IDs only, not full Line objects
  repeated StationNumber station_numbers = 7;
  StopCondition stop_condition = 8;
  optional bool has_train_types = 9;
  optional uint32 train_type_id = 10;  // ID only to avoid circular reference
  optional string name_ipa = 11; // TTS用カタカナ名のIPA転写
  optional string name_roman_ipa = 12; // TTS用英語名のIPA転写
  repeated TtsSegment name_tts_segments = 13; // TTS用読みセグメント
}

message LineMinimal {
  uint32 id = 1;
  string name_short = 2;
  string color = 3;
  LineType line_type = 4;
  repeated LineSymbol line_symbols = 5;
}

message RouteMinimal {
  uint32 id = 1;
  repeated StationMinimal stops = 2;
}

message RouteMinimalResponse {
  repeated RouteMinimal routes = 1;
  repeated LineMinimal lines = 2; // Normalized line data (deduplicated)
  string next_page_token = 3;
}