stacjownik/src/typings/api.ts

import { Journal } from '../components/JournalView/typings';
import { Status, Vehicle, VehicleGroup } from './common';

export enum APIDataStatus {
  OK = 'OK',
  WARNING = 'WARNING'
}

export interface APICache {
  lastModified: string;
  name: string;
}

export namespace API {
  export namespace ActiveData {
    export interface APIStatuses {
      stationsAPI: APIDataStatus;
      trainsAPI: APIDataStatus;
      dispatchersAPI: APIDataStatus;
      sceneryRequirementsAPI: APIDataStatus;
    }

    export interface Response {
      activeSceneries?: API.ActiveSceneries.Response;
      trains?: API.ActiveTrains.Response;
      apiStatuses?: APIStatuses;
      caches: APICache[];
    }
  }

  export namespace PlayerActivity {
    export interface Data {
      dispatcher: API.ActiveSceneries.Data[];
      driver: API.ActiveTrains.Data | null;
    }

    export type Response = Data;
  }

  export namespace DispatcherHistory {
    export type Response = Data[];

    export interface Data {
      id: number;
      createdAt: string;
      updatedAt: string;
      currentDuration: number;
      dispatcherId: number;
      dispatcherName: string;
      dispatcherLevel: number | null;
      dispatcherRate: number;
      dispatcherIsSupporter: boolean;
      dispatcherLanguageId: number | null;
      dispatcherStatus?: number;
      isOnline: boolean;
      lastOnlineTimestamp: number;
      region: string;
      stationHash: string;
      stationName: string;
      timestampFrom: number;
      timestampTo?: number;
      statusHistory: string[];
    }
  }

  export namespace DispatcherStats {
    export interface Services {
      count: number;
      durationMax: number;
      durationAvg: number;
    }

    export interface IssuedTimetables {
      count: number;
      distanceMax: number;
      distanceAvg: number;
      distanceSum: number;
    }

    export interface Data {
      dispatcherId: number | null;
      dispatcherName: string | null;
      dispatcherLevel: number | null;
      services: Services | null;
      issuedTimetables: IssuedTimetables | null;
    }

    export type Response = Data;
  }

  export namespace DriverStats {
    export interface Data {
      driverName: string | null;
      driverId: number | null;
      driverLevel: number | null;
      countAll: number;
      countTerminated: number;
      countFulfilled: number;
      routeDistanceTotal: number | null;
      routeDistanceAvg: number | null;
      routeDistanceMax: number | null;
      currentDistanceTotal: number | null;
      confirmedStopsTotal: number | null;
      allStopsTotal: number | null;
    }

    export type Response = Data;
  }

  export namespace PlayerInfo {
    export interface Data {
      currentActivity: PlayerActivity.Data;
      dispatcherStats: DispatcherStats.Data;
      dispatcherStatsLastMonth: DispatcherStats.Data;
      driverStats: DriverStats.Data;
      driverStatsLastMonth: DriverStats.Data;
    }
  }

  export namespace PlayerJournal {
    export interface Data {
      timetables: TimetableHistory.DataShort[];
      issuedTimetables: TimetableHistory.DataShort[];
      duties: DispatcherHistory.Data[];
    }
  }

  export namespace ActiveSceneries {
    export interface Data {
      dispatcherId: number;
      dispatcherName: string;
      dispatcherIsSupporter: boolean;
      dispatcherLanguageId: number;
      stationName: string;
      stationHash: string;
      region: string;
      maxUsers: number;
      currentUsers: number;
      spawn: number;
      lastSeen: number;
      dispatcherExp: number;
      nameFromHeader: string;
      spawnString: string | null;
      networkConnectionString: string;
      isOnline: number;
      dispatcherRate: number;
      dispatcherStatus: Status.ActiveDispatcher | number;
    }

    export type Response = Data[];
  }

  export namespace ActiveTrains {
    export type Response = Data[];

    export interface Data {
      id: string;
      trainNo: number;
      mass: number;
      length: number;
      speed: number;
      stockString: string;

      signal: string;
      distance: number;
      connectedTrack: string;

      driverName: string;
      driverId: number;
      driverIsSupporter: boolean;
      driverLevel?: number;
      driverLanguageId: number;

      currentStationName: string;
      currentStationHash?: string;

      online: number;
      lastSeen: number;

      region: string;
      isTimeout: boolean;

      timetable?: Timetable;
    }

    export interface TimetableStop {
      stopName: string;
      stopNameRAW: string;
      stopType: string;
      stopDistance: number;

      mainStop: boolean;

      arrivalLine: string | null;
      arrivalTimestamp: number;
      arrivalRealTimestamp: number;
      arrivalDelay: number;

      departureLine: string | null;
      departureTimestamp: number;
      departureRealTimestamp: number;
      departureDelay: number;

      comments?: any;

      beginsHere: boolean;
      terminatesHere: boolean;
      confirmed: number;
      stopped: number;
      stopTime: number | null;
    }

    export interface Timetable {
      timetableId: number;
      category: string;
      route: string;
      stopList: TimetableStop[];
      twr: boolean;
      hasDangerousCargo: boolean;
      hasExtraDeliveries: boolean;
      warningNotes: string | null;
      sceneries: string[];
      path: string;
      trainMaxSpeed: number;
    }
  }

  export namespace TimetableHistory {
    export interface QueryParams {
      driverName?: string;
      trainNo?: string;
      timetableId?: string;
      categoryCode?: string;

      authorName?: string;

      dateFrom?: string;
      dateTo?: string;

      issuedFrom?: string;
      terminatingAt?: string;
      via?: string;
      includesScenery?: string;

      countFrom?: number;
      countLimit?: number;

      fulfilled?: number;
      terminated?: number;

      twr?: number;
      skr?: number;
      pn?: number;
      tn?: number;

      headUnitName?: string;
      headUnitType?: string;

      returnType?: 'all' | 'short' | 'detailed';
      sortBy?: Journal.TimetableSorter['id'];
    }

    export interface Data extends DataShort, DataDetailsOnly {
      updatedAt: string;
    }

    export interface DataShort {
      id: number;
      createdAt: string;
      trainNo: number;
      trainCategoryCode: string;
      timetableId: number;

      driverId: number;
      driverName: string;
      driverLevel: number | null;
      driverIsSupporter: boolean;
      driverLanguageId: number | null;

      route: string;
      twr: number;
      skr: number;
      currentLocation: string[];

      routeDistance: number;
      currentDistance: number;

      confirmedStopsCount: number;
      allStopsCount: number;

      beginDate: string;
      endDate: string;
      scheduledBeginDate: string;
      scheduledEndDate: string;

      terminated: boolean;
      fulfilled: boolean;

      authorName?: string;
      authorId?: number;

      currentSceneryName?: string;
      currentSceneryHash?: string;
      hasDangerousCargo: boolean;
      hasExtraDeliveries: boolean;
    }

    export interface DataDetailsOnly {
      id: number;
      timetableId: number;

      sceneriesString: string;
      stockString?: string;
      stockHistory: string[];

      stockMass?: number;
      stockLength?: number;
      maxSpeed?: number;
      trainMaxSpeed?: number;

      routeSceneries: string;
      checkpointArrivals: string[];
      checkpointDepartures: string[];
      checkpointArrivalsScheduled: string[];
      checkpointDeparturesScheduled: string[];
      checkpointStopTypes: string[];
      checkpointComments: string[];
      visitedSceneries: string[];
      sceneryNames: string[];

      path: string;
      warningNotes: string | null;

      authorId?: number;
      authorName?: string;
      driverId: number;
      driverName: string;
      driverLanguageId: number | null;
    }

    export type Response = Data[];
    export type ResponseShort = DataShort[];
    export type ResponseDetailsOnly = DataDetailsOnly[];
  }

  export namespace DailyStats {
    export interface Response {
      totalTimetables: number;
      distanceSum: number;
      distanceAvg: number;
      maxTimetable: API.TimetableHistory.Data | null;

      globalDiff: GlobalDiff;
      globalMax: GlobalMax;

      mostActiveDispatchers: MostActiveDispatcher[];
      mostActiveDrivers: MostActiveDriver[];

      longestDuties: LongestDuty[];
    }

    export interface MostActiveDispatcher {
      name: string;
      count: number;
    }

    export interface MostActiveDriver {
      name: string;
      distance: number;
    }

    export interface LongestDuty {
      name: string;
      duration: number;
      station: string;
    }

    export interface GlobalDiff {
      rippedSwitches: number;
      derailments: number;
      skippedStopSignals: number;
      radioStops: number;
      kills: number;
      drivenKilometers: number;
      routedTrains: number;
    }

    export interface GlobalMax {
      _max: {
        drivers: number;
        dispatchers: number;
        timetables: number;
      };
    }
  }

  export namespace Donators {
    export type Response = string[];
  }

  export namespace VehiclesData {
    export interface VehicleObject {
      id: number;
      name: string;
      type: string;
      cabinName: string | null;
      restrictions: Record<string, any> | null;
      vehicleGroupsId: number;
    }

    export interface VehicleGroupObject {
      id: number;
      name: string;
      speed: number;
      speedLoaded?: number;
      speedLoco?: number;
      length: number;
      weight: number;
      cargoTypes: VehicleCargo[] | null;

      locoProps: {
        coldStart: boolean;
        doubleManned: boolean;
      } | null;

      massSpeeds: VehicleGroupMassSpeeds | null;
    }

    export interface VehicleGroupMassSpeeds {
      passenger: Record<string, number> | null;
      cargo: Record<string, number> | null;
      none: number | null;
    }

    export interface VehicleCargo {
      id: string;
      weight: number;
    }

    export interface Data {
      vehicles: VehicleObject[];
      vehicleGroups: VehicleGroupObject[];
    }

    export type Response = Data;
  }
}

export namespace GithubAPI {
  export namespace Release {
    export interface Author {
      login: string;
      id: number;
      node_id: string;
      avatar_url: string;
      gravatar_id: string;
      url: string;
      html_url: string;
      followers_url: string;
      following_url: string;
      gists_url: string;
      starred_url: string;
      subscriptions_url: string;
      organizations_url: string;
      repos_url: string;
      events_url: string;
      received_events_url: string;
      type: string;
      site_admin: boolean;
    }

    export interface Response {
      url: string;
      assets_url: string;
      upload_url: string;
      html_url: string;
      id: number;
      author: Author;
      node_id: string;
      tag_name: string;
      target_commitish: string;
      name: string;
      draft: boolean;
      prerelease: boolean;
      created_at: Date;
      published_at: Date;
      assets: any[];
      tarball_url: string;
      zipball_url: string;
      body: string;
    }
  }
}

export namespace Td2API {
  export namespace UsersInfoByName {
    export interface UserStat {
      variable: string;
      value: number;
      position: number;
      server_total: number;
      server_max: number;
      server_min: number;
      server_avg: number;
    }

    export interface Levels {
      driver: number;
      dispatcher: number;
    }

    export interface UserGroup {
      id_group: number;
      group_name: string;
      description: string;
      online_color: string;
      min_posts: number;
      max_messages: number;
      stars: string;
      group_type: number;
      hidden: number;
      id_parent: number;
    }

    export interface UserInfo {
      id_member: number;
      id_group: number;
      additional_groups: string;
      member_name: string;
      karma_bad: number;
      karma_good: number;
      date_registered: number;
      last_login: number;
      avatar: number;
      lngfile: string;
      user_stats: UserStat[];
      levels: Levels;
      user_groups: UserGroup[];
    }

    export type Message = UserInfo[];

    export interface Response {
      success: boolean;
      respCode: number;
      message: Message;
    }
  }
}

export namespace Websocket {
  export interface Payload {
    activeSceneries: API.ActiveSceneries.Response;
    activeTrains: API.ActiveTrains.Response;
    connectedSocketCount: number;
  }
}