mobility-toolbox-js 3.0.0-beta.3 → 3.0.0-beta.32

package/types/realtime.d.ts

@@ -1,8 +1,8 @@
 import { Feature, FeatureCollection, Point } from 'geojson';
 
-export declare type RealtimeMode = 'topographic' | 'schematic' | 'raw';
+export declare type RealtimeMode = 'raw' | 'schematic' | 'topographic';
 
-export declare type RealtimeChannelModeSuffix = '' | '_schematic';
+export declare type RealtimeChannelModeSuffix = '_schematic' | '';
 
 export type RealtimeTrainId = string;
 
@@ -10,38 +10,38 @@ export type RealtimeStationId = number;
 
 export type RealtimeService =
   | 'redis_websocket_api'
-  | 'tralis_stations'
   | 'tralis_fzo'
-  | 'tralis_worker'
-  | 'tralis_vdv'
-  | 'tralis_newsticker'
   | 'tralis_geofox'
+  | 'tralis_newsticker'
+  | 'tralis_stations'
+  | 'tralis_vdv'
+  | 'tralis_worker'
   | string;
 
-export type RealtimeTenant = 'sbb' | 'sbh' | 'sbm' | '' | string;
+export type RealtimeTenant = '' | 'sbb' | 'sbh' | 'sbm' | string;
 
 export type RealtimeElevatorState = 'ALL_OPERABLE' | string;
 
-export type RealtimeStopState = 'LEAVING' | 'BOARDING' | string;
+export type RealtimeStopState = 'BOARDING' | 'LEAVING' | string;
 
 export type RealtimeTrajectoryState =
-  | 'HIDDEN'
   | 'BOARDING'
-  | 'STOP_CANCELLED'
-  | 'JOURNEY_CANCELLED';
+  | 'HIDDEN'
+  | 'JOURNEY_CANCELLED'
+  | 'STOP_CANCELLED';
 
-export type RealtimeGeneralizationLevel = 5 | 10 | 30 | 100;
+export type RealtimeGeneralizationLevel = 10 | 100 | 30 | 5;
 
 export type RealtimeMot =
-  | 'tram'
-  | 'subway'
-  | 'rail'
   | 'bus'
-  | 'ferry'
   | 'cablecar'
-  | 'gondola'
+  | 'coach'
+  | 'ferry'
   | 'funicular'
-  | 'coach';
+  | 'gondola'
+  | 'rail'
+  | 'subway'
+  | 'tram';
 
 /**
  * @type RealtimeBbox
@@ -60,56 +60,56 @@ export type RealtimeBbox = (number | string)[];
 export type RealtimeBuffer = [number, number];
 
 export type RealtimeChannelName =
-  | 'websocket'
   | 'buffer'
-  | 'line'
   | 'extra_geoms'
   | 'healthcheck'
-  | `timetable_${RealtimeStationId}`
-  | `trajectory${RealtimeChannelModeSuffix}`
+  | 'line'
+  | 'websocket'
   | `deleted_vehicles${RealtimeChannelModeSuffix}`
+  | `full_trajectory${RealtimeChannelModeSuffix}_${RealtimeTenant}_${RealtimeTrainId}`
   | `stopsequence_${RealtimeTenant}_${RealtimeTrainId}`
-  | `full_trajectory${RealtimeChannelModeSuffix}_${RealtimeTenant}_${RealtimeTrainId}`;
+  | `timetable_${RealtimeStationId}`
+  | `trajectory${RealtimeChannelModeSuffix}`;
 
 export interface RealtimeTrajectoryProperties {
   // Tralis and trafimage
   bounds: [number, number, number, number];
-  delay: number | null;
+  delay: null | number;
+  // Tralis
+  event?: string;
+  event_delay?: number;
   event_timestamp: number;
+  event_timestamp?: number;
   gen_level?: RealtimeGeneralizationLevel;
   gen_range: [number, number];
   has_journey: boolean;
   has_realtime: boolean;
   has_realtime_journey: boolean;
   line?: RealtimeLine;
-  operator_provides_realtime_journey: 'unknown' | 'yes' | 'no';
+  name?: string; // deprecated, name is an old property, use line.name instead.
+  operator?: string; // deprecated, operator is an old property, use tenant instead.
+  operator_provides_realtime_journey: 'no' | 'unknown' | 'yes';
+  original_line?: RealtimeLine;
+  original_rake?: string;
+  original_train_number?: number;
+  position_correction?: number;
   rake?: string;
+  raw_coordinates?: [number, number];
+
   raw_time?: string;
+  ride_state?: string;
+
   route_identifier: string;
+  routeIdentifier?: string;
   state: RealtimeTrajectoryState;
   tenant: string;
-  time_intervals?: Array<Array<number>>;
+  time_intervals?: number[][];
   time_since_update?: string;
   timestamp: number;
   train_id?: RealtimeTrainId;
   train_number?: number;
-  type: RealtimeMots;
-
-  operator?: string; // deprecated, operator is an old property, use tenant instead.
-  name?: string; // deprecated, name is an old property, use line.name instead.
-
-  // Tralis
-  event?: string;
-  event_delay?: number;
-  event_timestamp?: number;
-  original_line?: RealtimeLine;
-  original_rake?: string;
-  original_train_number?: number;
-  position_correction?: number;
-  raw_coordinates?: [number, number];
-  ride_state?: string;
-  routeIdentifier?: string;
   transmitting_vehicle?: string;
+  type: RealtimeMots;
 }
 
 export interface RealtimeTrajectory extends Feature {
@@ -174,7 +174,7 @@ export interface RealtimeStopSequence {
 }
 
 export interface RealtimeExtraGeomProperties {
-  ref: string | number;
+  ref: number | string;
 }
 
 export interface RealtimeExtraGeom extends Feature {
@@ -182,40 +182,38 @@ export interface RealtimeExtraGeom extends Feature {
 }
 
 export interface RealtimeExtraGeomDeleted {
-  type: 'Deleted';
   properties: RealtimeExtraGeomProperties;
+  type: 'Deleted';
 }
 
-export type RealtimeExtraGeoms = {
-  [index: string]: Feature[];
-};
+export type RealtimeExtraGeoms = Record<string, Feature[]>;
 
 export interface RealtimeLine {
-  id: number;
   color: string;
-  stroke: string;
+  id: number;
   name: string;
+  stroke: string;
   text_color: string;
 }
 
 export interface RealtimeTransfer {
-  mot: RealtimeMot;
   lines: string[];
+  mot: RealtimeMot;
 }
 
 export interface RealtimeStationproperties extends Feature {
-  transfers: RealtimeTransfer[];
   elevatorOutOfOrder: boolean;
-  elevatorState: RealtimeElevatorState;
   elevators: object;
-  uic: RealtimeStationId;
-  name: string;
-  networkLines: RealtimeLine[];
-  hasElevator: boolean;
-  hasZOB: boolean;
+  elevatorState: RealtimeElevatorState;
   hasAccessibility: boolean;
   hasAirport: boolean;
+  hasElevator: boolean;
+  hasZOB: boolean;
+  name: string;
+  networkLines: RealtimeLine[];
   tenant: RealtimeTenant;
+  transfers: RealtimeTransfer[];
+  uic: RealtimeStationId;
 }
 
 export interface RealtimeStation extends Feature {
@@ -224,30 +222,30 @@ export interface RealtimeStation extends Feature {
 }
 
 export interface RealtimeDeparture {
-  to: string[];
-  time: number;
-  no_stop_between: boolean;
-  new_to: boolean;
+  at_station_ds100: string;
+  call_id: number;
+  created_at: string;
+  formation: any;
+  fzo_estimated_time: number;
   has_fzo: boolean;
+  line: RealtimeLine;
+  min_arrival_time: number;
+  new_to: boolean;
   next_stoppoints: string[];
+  no_stop_between: boolean;
+  no_stop_till: any;
   platform: string;
-  created_at: string;
-  at_station_ds100: string;
-  train_number: number;
   ris_aimed_time: number;
-  updated_at: number;
-  min_arrival_time: number;
   ris_estimated_time: number;
-  train_id: RealtimeTrainId;
-  fzo_estimated_time: number;
-  train_type: number;
-  call_id: number;
-  line: RealtimeLine;
   state: string; /// (BOARDING|STOP_CANCELLED|JOURNEY_CANCELLED|HIDDEN)/
-  formation: any;
-  no_stop_till: any;
-  timestamp: number; // This property seems to never exists
+  time: number;
   timediff: number; // This property seems to alawy been 0
+  timestamp: number; // This property seems to never exists
+  to: string[];
+  train_id: RealtimeTrainId;
+  train_number: number;
+  train_type: number;
+  updated_at: number;
 }
 
 export interface RealtimeDepartureExtended extends RealtimeDeparture {
@@ -269,68 +267,68 @@ export interface RealtimeNews {
 export interface RealtimeHealth {
   heathly: boolean;
   service: RealtimeService;
-  tenant: string | null;
+  tenant: null | string;
 }
 
 export interface RealtimeExtraGeomsResponse {
-  source: `extra_geoms`;
-  timestamp: number;
   client_reference: null;
   content: RealtimeExtraGeom | RealtimeExtraGeomDeleted;
+  source: `extra_geoms`;
+  timestamp: number;
 }
 
 export interface RealtimeStationResponse {
-  source: `station_${RealtimeStationId}`;
-  timestamp: number;
   client_reference: null;
   content: RealtimeNews;
+  source: `station_${RealtimeStationId}`;
+  timestamp: number;
 }
 
 export interface RealtimeNewsTickerResponse {
-  source: `${RealtimeTenant}_newsticker`;
-  timestamp: number;
   client_reference: null;
   content: RealtimeNews;
+  source: `${RealtimeTenant}_newsticker`;
+  timestamp: number;
 }
 
 export interface RealtimeTimetableResponse {
-  source: `timetable_${RealtimeStationId}`;
-  timestamp: number;
   client_reference: null;
   content: RealtimeDeparture;
+  source: `timetable_${RealtimeStationId}`;
+  timestamp: number;
 }
 
 export interface RealtimeTrajectoryResponse {
-  source: `trajectory${RealtimeChannelModeSuffix}`;
-  timestamp: number;
   client_reference: '';
   content: RealtimeTrajectory;
+  source: `trajectory${RealtimeChannelModeSuffix}`;
+  timestamp: number;
 }
 
 export interface RealtimeStopSequenceResponse {
+  client_reference: '';
+  content: RealtimeStopSequence[];
   source: `stopsequence_${RealtimeTenant}_${RealtimeTrainId}`;
   timestamp: number;
-  client_reference: '';
-  content: Array<RealtimeStopSequence>;
 }
 
 export interface RealtimeBufferResponse {
-  source: 'buffer';
-  timestamp: number;
   client_reference: '';
   content: RealtimeTrajectoryResponse[];
+  source: 'buffer';
+  timestamp: number;
 }
 
 export interface RealtimeDeletedVehiclesResponse {
-  source: `deleted_vehicles${RealtimeChannelModeSuffix}`;
-  timestamp: number;
   client_reference: null;
   content: string;
+  source: `deleted_vehicles${RealtimeChannelModeSuffix}`;
+  timestamp: number;
 }
 
 export interface RealtimeHealthCheckResponse {
-  source: 'healthcheck';
-  timestamp: number;
   client_reference: null;
   content: RealtimeHealth;
+  source: 'healthcheck';
+  timestamp: number;
 }

package/types/routing.d.ts

@@ -9,6 +9,58 @@ export interface Paths {
     get: {
       parameters: {
         query: {
+          /**
+           * Whether to use beelines (line strings with 2 points) between
+           * mutually unreachable hops as a fallback for "Route not found"
+           * errors. "true", "on", "yes", "y", "1" will enable the
+           * fallback. Default: enabled
+           */
+          'beeline-fallback'?: string;
+          /**
+           * Distance punishment factor for edge snapping of coordinates (see
+           * "Note on coordinates" at the top). Large: prefer close edge. Small:
+           * prefer short total route. Negative value: like worst edge
+           * category. Default: -1.0
+           */
+          'coord-punish'?: number;
+          /**
+           * Search radius for candidate edges during snapping of coordinates
+           * (see "Note on coordinates" at the top) Default: -1.0
+           */
+          'coord-radius'?: number;
+          /** Only for mot=rail. Default is a detailed network based on OpenStreetMap. gen1 to gen4 provide rail networks with increasing levels of generalization */
+          graph?: 'gen1' | 'gen2' | 'gen3' | 'gen4';
+          /**
+           * Whether to include intermediate hops (stations/stops) found on the
+           * route to the response. "true", "on", "yes", "y", "1" will enable
+           * intermediate hops. Default: disabled
+           */
+          hops?: string;
+          /** A line name that should be preferred */
+          line?: string;
+          /** Name of origin of the preferred line */
+          'line-from'?: string;
+          /** Name of destination of the preferred line */
+          'line-to'?: string;
+          /**
+           * Maximum allowed ratio of hops to skip if not found. Only non-start
+           * and non-end hops are counted in ratio numerator and denominator.
+           */
+          'max-skip-hop-ratio'?: number;
+          /** Mode of transport */
+          mot:
+            | 'bus'
+            | 'car'
+            | 'coach'
+            | 'ferry'
+            | 'foot'
+            | 'funicular'
+            | 'gondola'
+            | 'rail'
+            | 'subway'
+            | 'tram';
+          /** Douglas-Peucker distance parameter for simplification. Default 0.5 in Mercator units */
+          simplify?: number;
           /**
            * A pipe separated list of hops. A hop describes a station with either
            *  - a name or abbreviation
@@ -52,58 +104,6 @@ export interface Paths {
            *  - `freiburg|basel%20sbb|bern` - from Freiburg (Breisgau) Hbf via Basel SBB to Bern
            */
           via: string;
-          /** Mode of transport */
-          mot:
-            | 'rail'
-            | 'bus'
-            | 'coach'
-            | 'foot'
-            | 'tram'
-            | 'subway'
-            | 'gondola'
-            | 'funicular'
-            | 'ferry'
-            | 'car';
-          /** Only for mot=rail. Default is a detailed network based on OpenStreetMap. gen1 to gen4 provide rail networks with increasing levels of generalization */
-          graph?: 'gen1' | 'gen2' | 'gen3' | 'gen4';
-          /** A line name that should be preferred */
-          line?: string;
-          /** Name of origin of the preferred line */
-          'line-from'?: string;
-          /** Name of destination of the preferred line */
-          'line-to'?: string;
-          /** Douglas-Peucker distance parameter for simplification. Default 0.5 in Mercator units */
-          simplify?: number;
-          /**
-           * Maximum allowed ratio of hops to skip if not found. Only non-start
-           * and non-end hops are counted in ratio numerator and denominator.
-           */
-          'max-skip-hop-ratio'?: number;
-          /**
-           * Whether to include intermediate hops (stations/stops) found on the
-           * route to the response. "true", "on", "yes", "y", "1" will enable
-           * intermediate hops. Default: disabled
-           */
-          hops?: string;
-          /**
-           * Whether to use beelines (line strings with 2 points) between
-           * mutually unreachable hops as a fallback for "Route not found"
-           * errors. "true", "on", "yes", "y", "1" will enable the
-           * fallback. Default: enabled
-           */
-          'beeline-fallback'?: string;
-          /**
-           * Search radius for candidate edges during snapping of coordinates
-           * (see "Note on coordinates" at the top) Default: -1.0
-           */
-          'coord-radius'?: number;
-          /**
-           * Distance punishment factor for edge snapping of coordinates (see
-           * "Note on coordinates" at the top). Large: prefer close edge. Small:
-           * prefer short total route. Negative value: like worst edge
-           * category. Default: -1.0
-           */
-          'coord-punish'?: number;
           /**
            * Whether to output OSM way ids in Feature properties.
            * "true", "on", "yes", "y", "1" will enable output. Default: disabled
@@ -147,14 +147,14 @@ export interface Paths {
                  * @example
                  */
                 id?: string;
-                /** @example Freiburg Littenweiler */
-                name?: string;
-                /** @example 1 */
-                platform?: string;
                 /** @description Latitude of the stop, in WGS84 */
                 latitude?: number;
                 /** @description Latitude of the stop, in WGS84 */
                 longitude?: number;
+                /** @example Freiburg Littenweiler */
+                name?: string;
+                /** @example 1 */
+                platform?: string;
               };
               station_to?: {
                 /**
@@ -162,14 +162,14 @@ export interface Paths {
                  * @example 8004158
                  */
                 id?: string;
-                /** @example Muenchen Pasing */
-                name?: string;
-                /** @example 4 */
-                platform?: string;
                 /** @description Latitude of the stop, in WGS84 */
                 latitude?: number;
                 /** @description Latitude of the stop, in WGS84 */
                 longitude?: number;
+                /** @example Muenchen Pasing */
+                name?: string;
+                /** @example 4 */
+                platform?: string;
               };
               /** @enum {string} */
               type?: 'Feature';

package/types/stops.d.ts

@@ -9,35 +9,35 @@ export interface Paths {
     get: {
       parameters: {
         query: {
-          /** Control how many matches will be returned */
-          limit?: number;
-          /** Anything you'd like to search for */
-          q: string;
           /**
-           * comma seperated list, order chooses which agency will be preferred
-           * as ident_source (for id and code fields)
+           * left,bottom,right,up coordinates in WGS84 wherein the
+           * station should lie
            */
-          prefagencies?: 'sbb' | 'db';
+          bbox?: string;
+          /** which field to look up, default: all of them */
+          field?: 'coords' | 'id' | 'name';
+          /** Control how many matches will be returned */
+          limit?: number;
           /**
            * comma seperated list of mot's which should be available
            * at the stop
            */
           mots?:
             | 'bus'
+            | 'cable_car'
             | 'ferry'
+            | 'funicular'
             | 'gondola'
-            | 'tram'
             | 'rail'
-            | 'funicular'
-            | 'cable_car'
-            | 'subway';
+            | 'subway'
+            | 'tram';
           /**
-           * left,bottom,right,up coordinates in WGS84 wherein the
-           * station should lie
+           * comma seperated list, order chooses which agency will be preferred
+           * as ident_source (for id and code fields)
            */
-          bbox?: string;
-          /** which field to look up, default: all of them */
-          field?: 'id' | 'name' | 'coords';
+          prefagencies?: 'db' | 'sbb';
+          /** Anything you'd like to search for */
+          q: string;
           /**
            * Coordinates in WGS84 (in lat,lon order) used to rank stops close to
            * this position higher
@@ -49,81 +49,81 @@ export interface Paths {
         /** stop(s) */
         200: {
           schema: {
-            /** @enum {string} */
-            type?: 'FeatureCollection';
             features?: {
-              /** @enum {string} */
-              type?: 'Feature';
+              /** @description the coordinates of the stop */
+              geometry?: {
+                /**
+                 * @example [
+                 *   7.439119,
+                 *   46.94882
+                 * ]
+                 */
+                coordinates?: number[];
+                /** @enum {string} */
+                type?: 'Point';
+              };
               properties?: {
-                /** @description internal ID */
-                uid?: string;
                 /**
-                 * @description name of the stop
-                 * @example Bern
+                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
+                 *
+                 * @example BN
                  */
-                name?: string;
+                code?: string;
                 /**
                  * @description 2 letter country code where the station is located
                  * @example CH
                  */
                 country_code?: string;
                 /**
-                 * @description how well the result matches your query, 0
-                 * means best
+                 * @description uic number
+                 * @example 8507000
                  */
-                rank?: number;
+                id?: string;
                 /**
-                 * @description array of translations of the stopname
-                 * @default []
+                 * @description source agency for id and code (see below)
+                 * @example sbb
                  */
-                translated_names?: {
-                  value?: string;
-                  /** @enum {string} */
-                  language?: 'de' | 'en' | 'fr' | 'it';
-                }[];
+                ident_source?: string;
+                /** @description ifopt identifier, if available */
+                ifopt?: string;
                 /** @description Means of transport that are available at this station */
                 mot?: {
                   bus?: boolean;
+                  cable_car?: boolean;
                   ferry?: boolean;
+                  funicular?: boolean;
                   gondola?: boolean;
-                  tram?: boolean;
                   rail?: boolean;
-                  funicular?: boolean;
-                  cable_car?: boolean;
                   subway?: boolean;
+                  tram?: boolean;
                 };
                 /**
-                 * @description source agency for id and code (see below)
-                 * @example sbb
-                 */
-                ident_source?: string;
-                /**
-                 * @description uic number
-                 * @example 8507000
+                 * @description name of the stop
+                 * @example Bern
                  */
-                id?: string;
+                name?: string;
                 /**
-                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
-                 *
-                 * @example BN
+                 * @description how well the result matches your query, 0
+                 * means best
                  */
-                code?: string;
-                /** @description ifopt identifier, if available */
-                ifopt?: string;
-              };
-              /** @description the coordinates of the stop */
-              geometry?: {
-                /** @enum {string} */
-                type?: 'Point';
+                rank?: number;
                 /**
-                 * @example [
-                 *   7.439119,
-                 *   46.94882
-                 * ]
+                 * @description array of translations of the stopname
+                 * @default []
                  */
-                coordinates?: number[];
+                translated_names?: {
+                  /** @enum {string} */
+                  language?: 'de' | 'en' | 'fr' | 'it';
+                  value?: string;
+                }[];
+                /** @description internal ID */
+                uid?: string;
               };
+              /** @enum {string} */
+              type?: 'Feature';
             }[];
+            /** @enum {string} */
+            type?: 'FeatureCollection';
           };
         };
         /** limit parameter too high */