mobility-toolbox-js 2.0.0-beta.3 → 2.0.0-beta.33

package/types/stops.d.ts

@@ -0,0 +1,143 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface Paths {
+  '/': {
+    /** Returns a stop (or multiple) as GeoJSON FeatureCollection */
+    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)
+           */
+          prefagencies?: 'sbb' | 'db';
+          /**
+           * comma seperated list of mot's which should be available
+           * at the stop
+           */
+          mots?:
+            | 'bus'
+            | 'ferry'
+            | 'gondola'
+            | 'tram'
+            | 'rail'
+            | 'funicular'
+            | 'cable_car'
+            | 'subway';
+          /**
+           * left,bottom,right,up coordinates in WGS84 wherein the
+           * station should lie
+           */
+          bbox?: string;
+          /** which field to look up, default: all of them */
+          field?: 'id' | 'name' | 'coords';
+          /**
+           * Coordinates in WGS84 (in lat,lon order) used to rank stops close to
+           * this position higher
+           */
+          ref_location?: string;
+        };
+      };
+      responses: {
+        /** stop(s) */
+        200: {
+          schema: {
+            /** @enum {string} */
+            type?: 'FeatureCollection';
+            features?: {
+              /** @enum {string} */
+              type?: 'Feature';
+              properties?: {
+                /** @description internal ID */
+                uid?: string;
+                /**
+                 * @description name of the stop
+                 * @example Bern
+                 */
+                name?: 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
+                 */
+                rank?: number;
+                /**
+                 * @description array of translations of the stopname
+                 * @default []
+                 */
+                translated_names?: {
+                  value?: string;
+                  /** @enum {string} */
+                  language?: 'de' | 'en' | 'fr' | 'it';
+                }[];
+                /** @description Means of transport that are available at this station */
+                mot?: {
+                  bus?: boolean;
+                  ferry?: boolean;
+                  gondola?: boolean;
+                  tram?: boolean;
+                  rail?: boolean;
+                  funicular?: boolean;
+                  cable_car?: boolean;
+                  subway?: boolean;
+                };
+                /**
+                 * @description source agency for id and code (see below)
+                 * @example sbb
+                 */
+                ident_source?: string;
+                /**
+                 * @description uic number
+                 * @example 8507000
+                 */
+                id?: string;
+                /**
+                 * @description Abbreviation code from the transport agency (e.g. DS100 for Deutsche Bahn)
+                 *
+                 * @example BN
+                 */
+                code?: string;
+                /** @description ifopt identifier, if available */
+                ifopt?: string;
+              };
+              /** @description the coordinates of the stop */
+              geometry?: {
+                /** @enum {string} */
+                type?: 'Point';
+                /**
+                 * @example [
+                 *   7.439119,
+                 *   46.94882
+                 * ]
+                 */
+                coordinates?: number[];
+              };
+            }[];
+          };
+        };
+        /** limit parameter too high */
+        400: {
+          schema: {
+            /** @enum {string} */
+            error?: '400 Bad Request: Limit has to be an integer between 1 and 500';
+          };
+        };
+      };
+    };
+  };
+}
+
+export interface Operations {}
+
+export interface External {}

package/api/index.js

@@ -1,3 +0,0 @@
-// eslint-disable-next-line import/prefer-default-export
-export { default as StopsAPI } from './stops/StopsAPI';
-export { default as TralisAPI, TralisModes } from './tralis/TralisAPI';

package/api/routing/RoutingAPI.js

@@ -1,44 +0,0 @@
-import API from '../../common/api/api';
-
-/**
- * Access to the [Routing service](https://developer.geops.io/apis/routing).
- *
- * @example
- * import { RoutingAPI } from 'mobility-toolbox-js/api';
- *
- * const api = new RoutingAPI({
- *   apiKey: [yourApiKey]
- * });
- *
- */
-class RoutingAPI extends API {
-  /**
-   * Constructor
-   *
-   * @param {Object} options Options.
-   * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
-   * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
-   * @param {string} options.mot Mean of transport on load.
-   */
-  constructor(options = {}) {
-    super({
-      ...options,
-      url: options.url || 'https://api.geops.io/routing/v1/',
-    });
-  }
-
-  /**
-   * Route.
-   *
-   * @param {RoutingSearchParams} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
-   * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @return {Promise<GeoJSONFeatureCollection>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
-   */
-  route(params, abortController = new AbortController()) {
-    return this.fetch('', params, {
-      signal: abortController.signal,
-    });
-  }
-}
-
-export default RoutingAPI;

package/api/routing/RoutingAPI.test.js

@@ -1,41 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import RoutingAPI from './RoutingAPI';
-
-let api;
-
-describe('RoutingAPI', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    api = new RoutingAPI({ apiKey: 'apiKey' });
-  });
-
-  describe('#route', () => {
-    test('should success', (done) => {
-      fetch.mockResponseOnce(JSON.stringify(global.fetchRouteResponse));
-
-      return api
-        .route({
-          mot: 'bus',
-          via: '47.3739194713294,8.538274823394632|47.37595378493421,8.537490375951839',
-        })
-        .then((featureCollection) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://api.geops.io/routing/v1/?key=apiKey&mot=bus&via=47.3739194713294%2C8.538274823394632%7C47.37595378493421%2C8.537490375951839',
-          );
-
-          // Correct search result (for bus mot)
-          expect(featureCollection.features[0].geometry.type).toEqual(
-            'LineString',
-          );
-          expect(featureCollection.features[0].properties.lines).toBeDefined();
-          expect(
-            featureCollection.features[0].properties.station_to,
-          ).toBeDefined();
-          done();
-        });
-    });
-  });
-});

package/api/stops/StopsAPI.js

@@ -1,41 +0,0 @@
-import API from '../../common/api/api';
-
-/**
- * Access to the [Stops service](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
- *
- * @example
- * import { StopsAPI } from 'mobility-toolbox-js/api';
- *
- * const api = new StopsAPI({
- *   url: 'https://api.geops.io/stops/v1/',
- *   apiKey: [yourApiKey]
- * });
- *
- */
-class StopsAPI extends API {
-  /**
-   * Constructor
-   *
-   * @param {Object} options Options.
-   * @param {string} [options.url='https://api.geops.io/stops/v1/'] Service url.
-   * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
-   */
-  constructor(options = {}) {
-    super({ url: 'https://api.geops.io/stops/v1/', ...options });
-  }
-
-  /**
-   * Search.
-   *
-   * @param {StopsSearchParams} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
-   * @param {AbortController} abortController Abort controller used to cancel the request.
-   * @return {Promise<Array<GeoJSONFeature>>} An array of GeoJSON features with coordinates in [EPSG:4326](http://epsg.io/4326).
-   */
-  search(params, abortController = {}) {
-    return this.fetch('', params, {
-      signal: abortController.signal,
-    }).then((featureCollection) => featureCollection.features);
-  }
-}
-
-export default StopsAPI;

package/api/stops/StopsAPI.test.js

@@ -1,34 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import StopsAPI from './StopsAPI';
-
-let api;
-
-describe('StopsAPI', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    api = new StopsAPI({ apiKey: 'apiKey' });
-  });
-
-  describe('#search', () => {
-    test('should success', (done) => {
-      fetch.mockResponseOnce(JSON.stringify(global.stopsSearchResponse));
-
-      return api
-        .search({
-          q: 'Bern',
-        })
-        .then((features) => {
-          // Correct url
-          expect(fetch.mock.calls[0][0]).toEqual(
-            'https://api.geops.io/stops/v1/?key=apiKey&q=Bern',
-          );
-
-          // Correct search result
-          expect(features[0].properties.name).toEqual('Bern');
-          done();
-        });
-    });
-  });
-});