mobility-toolbox-js 3.0.0-beta.8 → 3.0.0

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 */