mobility-toolbox-js 2.3.9 → 2.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (471) hide show
  1. package/.esdoc.js +18 -0
  2. package/.eslintignore +1 -0
  3. package/.eslintrc.js +25 -0
  4. package/.fixpackrc +20 -0
  5. package/.github/workflows/build.yml +16 -0
  6. package/.github/workflows/conventional-pr-title.yml +16 -0
  7. package/.github/workflows/cypress.yml +101 -0
  8. package/.github/workflows/test.yml +17 -0
  9. package/.husky/commit-msg +4 -0
  10. package/.husky/post-checkout +4 -0
  11. package/.husky/post-merge +4 -0
  12. package/.husky/post-rebase +4 -0
  13. package/.husky/pre-commit +4 -0
  14. package/.lintstagedrc.js +10 -0
  15. package/.nvmrc +1 -0
  16. package/.prettierrc.js +5 -0
  17. package/.stylelintrc.js +4 -0
  18. package/CHANGELOG.md +132 -0
  19. package/LICENSE +21 -0
  20. package/MIGRATION-V2.md +248 -0
  21. package/README.md +42 -0
  22. package/__mocks__/mapbox-gl.js +81 -0
  23. package/__mocks__/maplibre-gl.js +81 -0
  24. package/babel.config.js +9 -0
  25. package/commitlint.config.js +1 -0
  26. package/cypress/e2e/examples/api.cy.js +7 -0
  27. package/cypress/e2e/examples/examples.cy.js +7 -0
  28. package/cypress/e2e/examples/navigation.cy.js +29 -0
  29. package/cypress/fixtures/example.json +5 -0
  30. package/cypress/plugins/index.js +21 -0
  31. package/cypress/support/commands.js +25 -0
  32. package/cypress/support/e2e.js +20 -0
  33. package/cypress.config.ts +15 -0
  34. package/data/fetchRoute.json +292 -0
  35. package/data/fetchTrajectories.json +18 -0
  36. package/data/fetchTrajectoryById.json +3 -0
  37. package/data/fetchTrajectoryStations.json +18 -0
  38. package/data/stopsSearch.json +15 -0
  39. package/dependabot.yml +15 -0
  40. package/doc/.eslintrc.json +1 -0
  41. package/doc/README.md +34 -0
  42. package/doc/next.config.js +16 -0
  43. package/doc/package.json +41 -0
  44. package/doc/pages/404.js +5 -0
  45. package/doc/pages/_app.js +61 -0
  46. package/doc/pages/_document.js +64 -0
  47. package/doc/pages/doc/[...slug].js +23 -0
  48. package/doc/pages/doc.js +23 -0
  49. package/doc/pages/example/[example].js +52 -0
  50. package/doc/pages/examples.js +34 -0
  51. package/doc/pages/index.js +25 -0
  52. package/doc/public/README.md +15 -0
  53. package/doc/public/favicon.ico +0 -0
  54. package/doc/public/static/assets/Lato-Black.ttf +0 -0
  55. package/doc/public/static/assets/Lato-BlackItalic.ttf +0 -0
  56. package/doc/public/static/assets/Lato-Bold.ttf +0 -0
  57. package/doc/public/static/assets/Lato-BoldItalic.ttf +0 -0
  58. package/doc/public/static/assets/Lato-Italic.ttf +0 -0
  59. package/doc/public/static/assets/Lato-Light.ttf +0 -0
  60. package/doc/public/static/assets/Lato-LightItalic.ttf +0 -0
  61. package/doc/public/static/assets/Lato-Regular.ttf +0 -0
  62. package/doc/public/static/assets/Lato-Thin.ttf +0 -0
  63. package/doc/public/static/assets/Lato-ThinItalic.ttf +0 -0
  64. package/doc/public/static/assets/OFL.txt +93 -0
  65. package/doc/public/static/examples/assets/tralis-live-map/index.js +11 -0
  66. package/doc/public/static/examples/assets/tralis-live-map/s1kreis.svg +105 -0
  67. package/doc/public/static/examples/assets/tralis-live-map/s20kreis.svg +101 -0
  68. package/doc/public/static/examples/assets/tralis-live-map/s2kreis.svg +95 -0
  69. package/doc/public/static/examples/assets/tralis-live-map/s3kreis.svg +95 -0
  70. package/doc/public/static/examples/assets/tralis-live-map/s4kreis.svg +95 -0
  71. package/doc/public/static/examples/assets/tralis-live-map/s6kreis.svg +95 -0
  72. package/doc/public/static/examples/assets/tralis-live-map/s7kreis.svg +95 -0
  73. package/doc/public/static/examples/assets/tralis-live-map/s8kreis.svg +93 -0
  74. package/doc/public/static/examples/assets/tralis-live-map/unknown.svg +107 -0
  75. package/doc/public/static/examples/layers.html +11 -0
  76. package/doc/public/static/examples/layers.js +97 -0
  77. package/doc/public/static/examples/mb-copyright.html +26 -0
  78. package/doc/public/static/examples/mb-copyright.js +37 -0
  79. package/doc/public/static/examples/mb-tracker.html +1 -0
  80. package/doc/public/static/examples/mb-tracker.js +40 -0
  81. package/doc/public/static/examples/mb-tracker.md +1 -0
  82. package/doc/public/static/examples/mb-tralis.html +1 -0
  83. package/doc/public/static/examples/mb-tralis.js +34 -0
  84. package/doc/public/static/examples/ol-copyright.html +26 -0
  85. package/doc/public/static/examples/ol-copyright.js +43 -0
  86. package/doc/public/static/examples/ol-mapbox-layer.html +1 -0
  87. package/doc/public/static/examples/ol-mapbox-layer.js +28 -0
  88. package/doc/public/static/examples/ol-mapbox-style-layer.html +12 -0
  89. package/doc/public/static/examples/ol-mapbox-style-layer.js +48 -0
  90. package/doc/public/static/examples/ol-query.html +32 -0
  91. package/doc/public/static/examples/ol-query.js +83 -0
  92. package/doc/public/static/examples/ol-routing.html +26 -0
  93. package/doc/public/static/examples/ol-routing.js +65 -0
  94. package/doc/public/static/examples/ol-routing.md +1 -0
  95. package/doc/public/static/examples/ol-stop-finder.html +15 -0
  96. package/doc/public/static/examples/ol-stop-finder.js +35 -0
  97. package/doc/public/static/examples/ol-stop-finder.md +1 -0
  98. package/doc/public/static/examples/ol-tracker.html +1 -0
  99. package/doc/public/static/examples/ol-tracker.js +41 -0
  100. package/doc/public/static/examples/ol-tracker.md +1 -0
  101. package/doc/public/static/examples/ol-tralis.html +5 -0
  102. package/doc/public/static/examples/ol-tralis.js +62 -0
  103. package/doc/public/static/examples/tralis-live-map.html +1 -0
  104. package/doc/public/static/examples/tralis-live-map.js +67 -0
  105. package/doc/public/static/examples/tralis-live-map.md +3 -0
  106. package/doc/public/static/img/live_tracker_mb.jpg +0 -0
  107. package/doc/public/static/img/live_tracker_munich.jpg +0 -0
  108. package/doc/public/static/img/live_tracker_ol.jpg +0 -0
  109. package/doc/public/static/img/mapbox.jpg +0 -0
  110. package/doc/public/static/img/mapbox_style.jpg +0 -0
  111. package/doc/public/static/img/ol-copyright.png +0 -0
  112. package/doc/public/static/img/query_objects.jpg +0 -0
  113. package/doc/public/static/img/routing.jpg +0 -0
  114. package/doc/public/static/img/simple_map.jpg +0 -0
  115. package/doc/public/static/img/stops.jpg +0 -0
  116. package/doc/public/vercel.svg +4 -0
  117. package/doc/src/components/CodeSandboxButton.js +102 -0
  118. package/doc/src/components/Documentation.js +42 -0
  119. package/doc/src/components/Esdoc/Anchor.js +57 -0
  120. package/doc/src/components/Esdoc/ClassDoc.js +272 -0
  121. package/doc/src/components/Esdoc/DeprecatedHTML.js +16 -0
  122. package/doc/src/components/Esdoc/DetailDocs.js +279 -0
  123. package/doc/src/components/Esdoc/DetailHTML.js +33 -0
  124. package/doc/src/components/Esdoc/DirectSubclassHTML.js +30 -0
  125. package/doc/src/components/Esdoc/DocBuilderUtils.js +697 -0
  126. package/doc/src/components/Esdoc/DocLinkHTML.js +63 -0
  127. package/doc/src/components/Esdoc/DocsLinkHTML.js +38 -0
  128. package/doc/src/components/Esdoc/Esdoc.js +63 -0
  129. package/doc/src/components/Esdoc/EsdocContent.js +56 -0
  130. package/doc/src/components/Esdoc/EsdocNavigation.js +13 -0
  131. package/doc/src/components/Esdoc/EsdocSearch.js +78 -0
  132. package/doc/src/components/Esdoc/ExperimentalHTML.js +17 -0
  133. package/doc/src/components/Esdoc/ExtendsChainHTML.js +32 -0
  134. package/doc/src/components/Esdoc/FileDocLinkHTML.js +62 -0
  135. package/doc/src/components/Esdoc/IdentifiersDoc.js +113 -0
  136. package/doc/src/components/Esdoc/IndirectSubclassHTML.js +30 -0
  137. package/doc/src/components/Esdoc/InheritedSummaryDoc.js +70 -0
  138. package/doc/src/components/Esdoc/InheritedSummaryHTML.js +38 -0
  139. package/doc/src/components/Esdoc/MixinClassesHTML.js +29 -0
  140. package/doc/src/components/Esdoc/NavDoc.js +112 -0
  141. package/doc/src/components/Esdoc/OverrideMethod.js +44 -0
  142. package/doc/src/components/Esdoc/OverrideMethodDescription.js +35 -0
  143. package/doc/src/components/Esdoc/Properties.js +89 -0
  144. package/doc/src/components/Esdoc/README.md +45 -0
  145. package/doc/src/components/Esdoc/SignatureHTML.js +123 -0
  146. package/doc/src/components/Esdoc/SingleDoc.js +31 -0
  147. package/doc/src/components/Esdoc/SummaryDoc.js +160 -0
  148. package/doc/src/components/Esdoc/SummaryHTML.js +96 -0
  149. package/doc/src/components/Esdoc/TypeDocLinkHTML.js +251 -0
  150. package/doc/src/components/Esdoc/index.js +7 -0
  151. package/doc/src/components/Esdoc/taffydb.js +2070 -0
  152. package/doc/src/components/Example.js +200 -0
  153. package/doc/src/components/ExampleCard.js +126 -0
  154. package/doc/src/components/Examples.js +78 -0
  155. package/doc/src/components/Home.js +121 -0
  156. package/doc/src/components/TrackerExample.js +39 -0
  157. package/doc/src/examples.js +117 -0
  158. package/doc/styles/App.scss +53 -0
  159. package/doc/styles/identifiers.css +38 -0
  160. package/doc/styles/search.css +76 -0
  161. package/doc/styles/style.css +603 -0
  162. package/esdoc/README.md +27 -0
  163. package/esdoc/plugins/MyPlugin.js +69 -0
  164. package/esdoc/plugins/dynamic-property-plugin/Plugin.js +50 -0
  165. package/esdoc/plugins/externals-plugin/Plugin.js +45 -0
  166. package/esdoc/plugins/externals-plugin/externals.js +93 -0
  167. package/esdoc/plugins/optional-chaining-plugin/Plugin.js +8 -0
  168. package/global-setup.js +3 -0
  169. package/jest.config.js +24 -0
  170. package/package.json +18 -18
  171. package/pull_request_template.md +17 -0
  172. package/scripts/read-pkg-json.js +22 -0
  173. package/src/api/RealtimeAPI.test.js +144 -0
  174. package/src/api/RealtimeAPI.ts +712 -0
  175. package/src/api/RoutingAPI.test.js +41 -0
  176. package/src/api/RoutingAPI.ts +47 -0
  177. package/src/api/StopsAPI.test.js +34 -0
  178. package/src/api/StopsAPI.ts +45 -0
  179. package/{api → src/api}/typedefs.js +11 -1
  180. package/src/common/api/HttpAPI.test.js +68 -0
  181. package/src/common/api/HttpAPI.ts +77 -0
  182. package/src/common/api/WebSocketAPI.test.js +421 -0
  183. package/src/common/api/WebSocketAPI.ts +515 -0
  184. package/src/common/controls/ControlCommon.test.js +106 -0
  185. package/src/common/controls/ControlCommon.ts +194 -0
  186. package/src/common/controls/CopyrightControlCommon.ts +41 -0
  187. package/src/common/controls/StopFinderControlCommon.ts +192 -0
  188. package/src/common/layers/LayerCommon.test.js +158 -0
  189. package/src/common/layers/LayerCommon.ts +321 -0
  190. package/src/common/mixins/RealtimeLayerMixin.ts +1168 -0
  191. package/src/common/mixins/UserInteractionsLayerMixin.test.js +227 -0
  192. package/src/common/mixins/UserInteractionsLayerMixin.ts +352 -0
  193. package/src/common/styles/realtimeDefaultStyle.ts +436 -0
  194. package/src/common/styles/realtimeDelayStyle.ts +27 -0
  195. package/src/common/styles/realtimeHeadingStyle.ts +138 -0
  196. package/src/common/styles/realtimeSimpleStyle.ts +25 -0
  197. package/{common → src/common}/typedefs.js +1 -1
  198. package/src/common/utils/compareDepartures.ts +46 -0
  199. package/src/common/utils/createCanvas.ts +33 -0
  200. package/src/common/utils/createRealtimeFilters.test.js +100 -0
  201. package/src/common/utils/createRealtimeFilters.ts +96 -0
  202. package/src/common/utils/debounceDeparturesMessages.ts +52 -0
  203. package/src/common/utils/debounceWebsocketMessages.ts +47 -0
  204. package/src/common/utils/getLayersAsFlatArray.ts +17 -0
  205. package/src/common/utils/getMapboxMapCopyrights.test.js +47 -0
  206. package/src/common/utils/getMapboxMapCopyrights.ts +52 -0
  207. package/src/common/utils/getMapboxRender.ts +104 -0
  208. package/src/common/utils/getMaplibreRender.ts +54 -0
  209. package/{common/utils/getRealtimeModeSuffix.d.ts → src/common/utils/getRealtimeModeSuffix.ts} +4 -2
  210. package/src/common/utils/getUrlWithParams.ts +21 -0
  211. package/src/common/utils/getVehiclePosition.ts +92 -0
  212. package/{common → src/common}/utils/index.js +1 -2
  213. package/src/common/utils/realtimeConfig.test.js +57 -0
  214. package/src/common/utils/realtimeConfig.ts +228 -0
  215. package/src/common/utils/removeDuplicate.test.js +22 -0
  216. package/src/common/utils/removeDuplicate.ts +22 -0
  217. package/src/common/utils/renderTrajectories.ts +194 -0
  218. package/src/common/utils/sortAndFilterDepartures.ts +78 -0
  219. package/src/common/utils/sortByDelay.ts +29 -0
  220. package/src/common/utils/timeUtils.test.js +16 -0
  221. package/src/common/utils/timeUtils.ts +45 -0
  222. package/{iife.js → src/iife.js} +3 -1
  223. package/src/index.js +10 -0
  224. package/{mapbox/controls/CopyrightControl.js → src/mapbox/controls/CopyrightControl.ts} +26 -21
  225. package/src/mapbox/layers/Layer.test.js +217 -0
  226. package/src/mapbox/layers/Layer.ts +144 -0
  227. package/src/mapbox/layers/RealtimeLayer.test.js +13 -0
  228. package/src/mapbox/layers/RealtimeLayer.ts +350 -0
  229. package/src/mapbox/utils/getMercatorResolution.ts +21 -0
  230. package/src/mapbox/utils/getSourceCoordinates.ts +34 -0
  231. package/src/ol/README.md +0 -0
  232. package/src/ol/controls/CopyrightControl.test.js +211 -0
  233. package/src/ol/controls/CopyrightControl.ts +82 -0
  234. package/src/ol/controls/RoutingControl.test.js +205 -0
  235. package/src/ol/controls/RoutingControl.ts +869 -0
  236. package/src/ol/controls/StopFinderControl.test.js +59 -0
  237. package/{ol/controls/StopFinderControl.js → src/ol/controls/StopFinderControl.ts} +10 -7
  238. package/src/ol/controls/snapshots/RoutingControlRouteGen10.json +58 -0
  239. package/src/ol/controls/snapshots/RoutingControlRouteGen100.json +292 -0
  240. package/src/ol/controls/snapshots/RoutingControlRouteGen30.json +69 -0
  241. package/src/ol/controls/snapshots/RoutingControlRouteGen5.json +58 -0
  242. package/src/ol/controls/snapshots/RoutingControlRouteOSM.json +759 -0
  243. package/src/ol/controls/snapshots/RoutingControlStation1.json +60 -0
  244. package/src/ol/controls/snapshots/RoutingControlStation2.json +49 -0
  245. package/src/ol/layers/Layer.test.js +212 -0
  246. package/src/ol/layers/Layer.ts +252 -0
  247. package/src/ol/layers/MapGlLayer.ts +294 -0
  248. package/src/ol/layers/MapboxLayer.test.js +190 -0
  249. package/src/ol/layers/MapboxLayer.ts +136 -0
  250. package/src/ol/layers/MapboxStyleLayer.test.js +258 -0
  251. package/src/ol/layers/MapboxStyleLayer.ts +466 -0
  252. package/{ol/layers/MaplibreLayer.d.ts → src/ol/layers/MaplibreLayer.ts} +21 -10
  253. package/src/ol/layers/RealtimeLayer.test.js +84 -0
  254. package/src/ol/layers/RealtimeLayer.ts +465 -0
  255. package/src/ol/layers/RoutingLayer.test.js +48 -0
  256. package/src/ol/layers/RoutingLayer.ts +113 -0
  257. package/src/ol/layers/VectorLayer.test.js +87 -0
  258. package/src/ol/layers/VectorLayer.ts +48 -0
  259. package/src/ol/layers/WMSLayer.test.js +65 -0
  260. package/src/ol/layers/WMSLayer.ts +114 -0
  261. package/src/ol/styles/fullTrajectoryDelayStyle.ts +37 -0
  262. package/src/ol/styles/fullTrajectoryStyle.ts +56 -0
  263. package/{setupTests.js → src/setupTests.js} +12 -7
  264. package/tsconfig.json +23 -0
  265. package/api/RealtimeAPI.d.ts +0 -290
  266. package/api/RealtimeAPI.d.ts.map +0 -1
  267. package/api/RealtimeAPI.js +0 -483
  268. package/api/RoutingAPI.d.ts +0 -37
  269. package/api/RoutingAPI.d.ts.map +0 -1
  270. package/api/RoutingAPI.js +0 -35
  271. package/api/StopsAPI.d.ts +0 -38
  272. package/api/StopsAPI.d.ts.map +0 -1
  273. package/api/StopsAPI.js +0 -36
  274. package/api/index.d.ts +0 -4
  275. package/api/index.d.ts.map +0 -1
  276. package/api/typedefs.d.ts +0 -179
  277. package/api/typedefs.d.ts.map +0 -1
  278. package/common/api/HttpAPI.d.ts +0 -31
  279. package/common/api/HttpAPI.d.ts.map +0 -1
  280. package/common/api/HttpAPI.js +0 -57
  281. package/common/api/WebSocketAPI.d.ts +0 -153
  282. package/common/api/WebSocketAPI.d.ts.map +0 -1
  283. package/common/api/WebSocketAPI.js +0 -341
  284. package/common/controls/ControlCommon.d.ts +0 -76
  285. package/common/controls/ControlCommon.d.ts.map +0 -1
  286. package/common/controls/ControlCommon.js +0 -150
  287. package/common/controls/CopyrightControlCommon.d.ts +0 -13
  288. package/common/controls/CopyrightControlCommon.d.ts.map +0 -1
  289. package/common/controls/CopyrightControlCommon.js +0 -34
  290. package/common/controls/StopFinderControlCommon.d.ts +0 -55
  291. package/common/controls/StopFinderControlCommon.d.ts.map +0 -1
  292. package/common/controls/StopFinderControlCommon.js +0 -144
  293. package/common/index.d.ts +0 -3
  294. package/common/index.d.ts.map +0 -1
  295. package/common/layers/LayerCommon.d.ts +0 -94
  296. package/common/layers/LayerCommon.d.ts.map +0 -1
  297. package/common/layers/LayerCommon.js +0 -244
  298. package/common/mixins/RealtimeLayerMixin.d.ts +0 -288
  299. package/common/mixins/RealtimeLayerMixin.d.ts.map +0 -1
  300. package/common/mixins/RealtimeLayerMixin.js +0 -779
  301. package/common/mixins/UserInteractionsLayerMixin.d.ts +0 -60
  302. package/common/mixins/UserInteractionsLayerMixin.d.ts.map +0 -1
  303. package/common/mixins/UserInteractionsLayerMixin.js +0 -241
  304. package/common/styles/index.d.ts +0 -5
  305. package/common/styles/index.d.ts.map +0 -1
  306. package/common/styles/realtimeDefaultStyle.d.ts +0 -36
  307. package/common/styles/realtimeDefaultStyle.d.ts.map +0 -1
  308. package/common/styles/realtimeDefaultStyle.js +0 -276
  309. package/common/styles/realtimeDelayStyle.d.ts +0 -12
  310. package/common/styles/realtimeDelayStyle.d.ts.map +0 -1
  311. package/common/styles/realtimeDelayStyle.js +0 -13
  312. package/common/styles/realtimeHeadingStyle.d.ts +0 -12
  313. package/common/styles/realtimeHeadingStyle.d.ts.map +0 -1
  314. package/common/styles/realtimeHeadingStyle.js +0 -87
  315. package/common/styles/realtimeSimpleStyle.d.ts +0 -4
  316. package/common/styles/realtimeSimpleStyle.d.ts.map +0 -1
  317. package/common/styles/realtimeSimpleStyle.js +0 -23
  318. package/common/typedefs.d.ts +0 -183
  319. package/common/typedefs.d.ts.map +0 -1
  320. package/common/utils/compareDepartures.d.ts +0 -11
  321. package/common/utils/compareDepartures.d.ts.map +0 -1
  322. package/common/utils/compareDepartures.js +0 -35
  323. package/common/utils/createCanvas.d.ts +0 -11
  324. package/common/utils/createCanvas.d.ts.map +0 -1
  325. package/common/utils/createCanvas.js +0 -28
  326. package/common/utils/createRealtimeFilters.d.ts +0 -13
  327. package/common/utils/createRealtimeFilters.d.ts.map +0 -1
  328. package/common/utils/createRealtimeFilters.js +0 -74
  329. package/common/utils/debounceDeparturesMessages.d.ts +0 -13
  330. package/common/utils/debounceDeparturesMessages.d.ts.map +0 -1
  331. package/common/utils/debounceDeparturesMessages.js +0 -28
  332. package/common/utils/debounceWebsocketMessages.d.ts +0 -12
  333. package/common/utils/debounceWebsocketMessages.d.ts.map +0 -1
  334. package/common/utils/debounceWebsocketMessages.js +0 -30
  335. package/common/utils/getLayersAsFlatArray.d.ts +0 -4
  336. package/common/utils/getLayersAsFlatArray.d.ts.map +0 -1
  337. package/common/utils/getLayersAsFlatArray.js +0 -16
  338. package/common/utils/getMapboxMapCopyrights.d.ts +0 -18
  339. package/common/utils/getMapboxMapCopyrights.d.ts.map +0 -1
  340. package/common/utils/getMapboxMapCopyrights.js +0 -30
  341. package/common/utils/getMapboxRender.d.ts +0 -8
  342. package/common/utils/getMapboxRender.d.ts.map +0 -1
  343. package/common/utils/getMapboxRender.js +0 -88
  344. package/common/utils/getMaplibreRender.d.ts +0 -9
  345. package/common/utils/getMaplibreRender.d.ts.map +0 -1
  346. package/common/utils/getMaplibreRender.js +0 -40
  347. package/common/utils/getRealtimeModeSuffix.d.ts.map +0 -1
  348. package/common/utils/getRealtimeModeSuffix.js +0 -7
  349. package/common/utils/getUrlWithParams.d.ts +0 -9
  350. package/common/utils/getUrlWithParams.d.ts.map +0 -1
  351. package/common/utils/getUrlWithParams.js +0 -18
  352. package/common/utils/getVehiclePosition.d.ts +0 -16
  353. package/common/utils/getVehiclePosition.d.ts.map +0 -1
  354. package/common/utils/getVehiclePosition.js +0 -72
  355. package/common/utils/index.d.ts +0 -18
  356. package/common/utils/index.d.ts.map +0 -1
  357. package/common/utils/realtimeConfig.d.ts +0 -53
  358. package/common/utils/realtimeConfig.d.ts.map +0 -1
  359. package/common/utils/realtimeConfig.js +0 -202
  360. package/common/utils/removeDuplicate.d.ts +0 -10
  361. package/common/utils/removeDuplicate.d.ts.map +0 -1
  362. package/common/utils/removeDuplicate.js +0 -15
  363. package/common/utils/renderTrajectories.d.ts +0 -17
  364. package/common/utils/renderTrajectories.d.ts.map +0 -1
  365. package/common/utils/renderTrajectories.js +0 -110
  366. package/common/utils/sortAndFilterDepartures.d.ts +0 -16
  367. package/common/utils/sortAndFilterDepartures.d.ts.map +0 -1
  368. package/common/utils/sortAndFilterDepartures.js +0 -58
  369. package/common/utils/sortByDelay.d.ts +0 -4
  370. package/common/utils/sortByDelay.d.ts.map +0 -1
  371. package/common/utils/sortByDelay.js +0 -21
  372. package/common/utils/timeUtils.d.ts +0 -24
  373. package/common/utils/timeUtils.d.ts.map +0 -1
  374. package/common/utils/timeUtils.js +0 -39
  375. package/iife.d.ts +0 -3
  376. package/iife.d.ts.map +0 -1
  377. package/index.d.ts +0 -10
  378. package/index.d.ts.map +0 -1
  379. package/index.js +0 -10
  380. package/mapbox/controls/CopyrightControl.d.ts +0 -29
  381. package/mapbox/controls/CopyrightControl.d.ts.map +0 -1
  382. package/mapbox/controls/index.d.ts +0 -2
  383. package/mapbox/controls/index.d.ts.map +0 -1
  384. package/mapbox/index.d.ts +0 -6
  385. package/mapbox/index.d.ts.map +0 -1
  386. package/mapbox/layers/Layer.d.ts +0 -59
  387. package/mapbox/layers/Layer.d.ts.map +0 -1
  388. package/mapbox/layers/Layer.js +0 -101
  389. package/mapbox/layers/RealtimeLayer.d.ts +0 -180
  390. package/mapbox/layers/RealtimeLayer.d.ts.map +0 -1
  391. package/mapbox/layers/RealtimeLayer.js +0 -270
  392. package/mapbox/layers/index.d.ts +0 -3
  393. package/mapbox/layers/index.d.ts.map +0 -1
  394. package/mapbox/utils/getMercatorResolution.d.ts +0 -9
  395. package/mapbox/utils/getMercatorResolution.d.ts.map +0 -1
  396. package/mapbox/utils/getMercatorResolution.js +0 -18
  397. package/mapbox/utils/getSourceCoordinates.d.ts +0 -9
  398. package/mapbox/utils/getSourceCoordinates.d.ts.map +0 -1
  399. package/mapbox/utils/getSourceCoordinates.js +0 -27
  400. package/mapbox/utils/index.d.ts +0 -3
  401. package/mapbox/utils/index.d.ts.map +0 -1
  402. package/mbt.js +0 -64706
  403. package/mbt.js.map +0 -7
  404. package/mbt.min.js +0 -1090
  405. package/mbt.min.js.map +0 -7
  406. package/ol/controls/CopyrightControl.d.ts +0 -31
  407. package/ol/controls/CopyrightControl.d.ts.map +0 -1
  408. package/ol/controls/CopyrightControl.js +0 -68
  409. package/ol/controls/RoutingControl.d.ts +0 -193
  410. package/ol/controls/RoutingControl.d.ts.map +0 -1
  411. package/ol/controls/RoutingControl.js +0 -631
  412. package/ol/controls/StopFinderControl.d.ts +0 -30
  413. package/ol/controls/StopFinderControl.d.ts.map +0 -1
  414. package/ol/controls/index.d.ts +0 -4
  415. package/ol/controls/index.d.ts.map +0 -1
  416. package/ol/index.d.ts +0 -6
  417. package/ol/index.d.ts.map +0 -1
  418. package/ol/layers/Layer.d.ts +0 -86
  419. package/ol/layers/Layer.d.ts.map +0 -1
  420. package/ol/layers/Layer.js +0 -174
  421. package/ol/layers/MapGlLayer.d.ts +0 -67
  422. package/ol/layers/MapGlLayer.d.ts.map +0 -1
  423. package/ol/layers/MapGlLayer.js +0 -218
  424. package/ol/layers/MapboxLayer.d.ts +0 -50
  425. package/ol/layers/MapboxLayer.d.ts.map +0 -1
  426. package/ol/layers/MapboxLayer.js +0 -109
  427. package/ol/layers/MapboxStyleLayer.d.ts +0 -130
  428. package/ol/layers/MapboxStyleLayer.d.ts.map +0 -1
  429. package/ol/layers/MapboxStyleLayer.js +0 -378
  430. package/ol/layers/MaplibreLayer.d.ts.map +0 -1
  431. package/ol/layers/MaplibreLayer.js +0 -34
  432. package/ol/layers/RealtimeLayer.d.ts +0 -202
  433. package/ol/layers/RealtimeLayer.d.ts.map +0 -1
  434. package/ol/layers/RealtimeLayer.js +0 -332
  435. package/ol/layers/RoutingLayer.d.ts +0 -35
  436. package/ol/layers/RoutingLayer.d.ts.map +0 -1
  437. package/ol/layers/RoutingLayer.js +0 -85
  438. package/ol/layers/VectorLayer.d.ts +0 -25
  439. package/ol/layers/VectorLayer.d.ts.map +0 -1
  440. package/ol/layers/VectorLayer.js +0 -38
  441. package/ol/layers/WMSLayer.d.ts +0 -42
  442. package/ol/layers/WMSLayer.d.ts.map +0 -1
  443. package/ol/layers/WMSLayer.js +0 -88
  444. package/ol/layers/index.d.ts +0 -9
  445. package/ol/layers/index.d.ts.map +0 -1
  446. package/ol/styles/fullTrajectoryDelayStyle.d.ts +0 -4
  447. package/ol/styles/fullTrajectoryDelayStyle.d.ts.map +0 -1
  448. package/ol/styles/fullTrajectoryDelayStyle.js +0 -33
  449. package/ol/styles/fullTrajectoryStyle.d.ts +0 -5
  450. package/ol/styles/fullTrajectoryStyle.d.ts.map +0 -1
  451. package/ol/styles/fullTrajectoryStyle.js +0 -44
  452. package/ol/styles/index.d.ts +0 -3
  453. package/ol/styles/index.d.ts.map +0 -1
  454. package/setupTests.d.ts +0 -2
  455. package/setupTests.d.ts.map +0 -1
  456. /package/{api → src/api}/index.js +0 -0
  457. /package/{common → src/common}/index.js +0 -0
  458. /package/{common → src/common}/styles/index.js +0 -0
  459. /package/{mapbox → src/mapbox}/controls/index.js +0 -0
  460. /package/{mapbox → src/mapbox}/index.js +0 -0
  461. /package/{mapbox → src/mapbox}/layers/index.js +0 -0
  462. /package/{mapbox → src/mapbox}/utils/index.js +0 -0
  463. /package/{ol → src/ol}/controls/index.js +0 -0
  464. /package/{ol → src/ol}/index.js +0 -0
  465. /package/{ol → src/ol}/layers/index.js +0 -0
  466. /package/{ol → src/ol}/styles/index.js +0 -0
  467. /package/{types → src/types}/common.d.ts +0 -0
  468. /package/{types → src/types}/index.d.ts +0 -0
  469. /package/{types → src/types}/realtime.d.ts +0 -0
  470. /package/{types → src/types}/routing.d.ts +0 -0
  471. /package/{types → src/types}/stops.d.ts +0 -0
@@ -1,483 +0,0 @@
1
- import WebSocketAPI from '../common/api/WebSocketAPI';
2
- import debounceWebsocketMessages from '../common/utils/debounceWebsocketMessages';
3
- import getModeSuffix from '../common/utils/getRealtimeModeSuffix';
4
- /**
5
- * Enum for Realtime modes.
6
- * @readonly
7
- * @typedef {string} RealtimeMode
8
- * @property {string} RAW "raw"
9
- * @property {string} SCHEMATIC "schematic"
10
- * @property {string} TOPOGRAPHIC "topographic"
11
- * @enum {RealtimeMode}
12
- */
13
- export const RealtimeModes = {
14
- RAW: 'raw',
15
- TOPOGRAPHIC: 'topographic',
16
- SCHEMATIC: 'schematic',
17
- };
18
- /**
19
- * This class provides convenience methods to access to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
20
- *
21
- * @example
22
- * import { RealtimeAPI } from 'mobility-toolbox-js/api';
23
- *
24
- * const api = new RealtimeAPI({
25
- * url: "yourUrl",
26
- * apiKey: "yourApiKey"
27
- * });
28
- *
29
- * @example
30
- * import { RealtimeAPI } from 'mobility-toolbox-js/api';
31
- *
32
- * const api = new RealtimeAPI("yourUrl");
33
- */
34
- class RealtimeAPI {
35
- /**
36
- * Constructor
37
- *
38
- * @param {Object|string} options A string representing the url of the service or an object containing the url and the apiKey.
39
- * @param {string} options.url Url to the [geOps realtime api](https://developer.geops.io/apis/realtime/).
40
- * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
41
- * @param {number[5]} [options.bbox=[minX, minY, maxX, maxY, zoom, tenant] The bounding box to receive data from.
42
- */
43
- constructor(options = {}) {
44
- this.version = '2';
45
- this.defineProperties(options);
46
- /** @private */
47
- this.onOpen = this.onOpen.bind(this);
48
- }
49
- /* @private */
50
- defineProperties(options = {}) {
51
- let opt = options || {};
52
- if (typeof options === 'string') {
53
- opt = { url: options };
54
- }
55
- const { apiKey, version } = opt;
56
- let { url, bbox, buffer = [100, 100] } = opt;
57
- const wsApi = new WebSocketAPI();
58
- if (!url) {
59
- url = 'wss://api.geops.io/tracker-ws/v1/';
60
- }
61
- if (apiKey) {
62
- url = `${url}?key=${apiKey}`;
63
- }
64
- Object.defineProperties(this, {
65
- url: {
66
- get: () => url,
67
- set: (newUrl) => {
68
- if (url !== newUrl) {
69
- url = newUrl;
70
- // Update the websocket only if the url has changed and the websocket is already open or is opening.
71
- if (this.wsApi.open || this.wsApi.connecting) {
72
- this.open();
73
- }
74
- }
75
- },
76
- },
77
- bbox: {
78
- get: () => bbox,
79
- set: (newBbox) => {
80
- if (JSON.stringify(newBbox) !== JSON.stringify(bbox)) {
81
- bbox = newBbox;
82
- if (this.wsApi && bbox) {
83
- this.wsApi.send(`BBOX ${bbox.join(' ')}`);
84
- }
85
- }
86
- },
87
- },
88
- buffer: {
89
- get: () => buffer,
90
- set: (newBuffer) => {
91
- if (JSON.stringify(newBuffer) !== JSON.stringify(buffer)) {
92
- buffer = newBuffer;
93
- if (this.wsApi) {
94
- this.wsApi.send(`BUFFER ${buffer.join(' ')}`);
95
- }
96
- }
97
- },
98
- },
99
- /**
100
- * The RealtimeApi version
101
- */
102
- version: {
103
- value: version,
104
- writable: true,
105
- },
106
- /**
107
- * The websocket helper class to connect the websocket.
108
- *
109
- * @private
110
- */
111
- wsApi: {
112
- value: wsApi,
113
- writable: true,
114
- },
115
- /**
116
- * Interval between PING request in ms.
117
- * If equal to 0, no PING request are sent.
118
- * @type {number}
119
- * @private
120
- */
121
- pingIntervalMs: {
122
- value: options.pingIntervalMs || 10000,
123
- writable: true,
124
- },
125
- /**
126
- * Timeout in ms after an automatic reconnection when the websoscket has been closed by the server.
127
- * @type {number}
128
- */
129
- reconnectTimeoutMs: {
130
- value: options.pingIntervalMs || 100,
131
- writable: true,
132
- },
133
- });
134
- }
135
- open() {
136
- this.wsApi.connect(this.url, this.onOpen);
137
- // Register reconnection on close.
138
- if (this.wsApi.websocket) {
139
- this.wsApi.websocket.onclose = () => {
140
- this.onClose();
141
- };
142
- }
143
- }
144
- /**
145
- * Close the websocket connection without reconnection.
146
- */
147
- close() {
148
- this.wsApi.close();
149
- }
150
- /**
151
- * Unsubscribe trajectory and deleted_vehicles channels. To resubscribe you have to set a new BBOX.
152
- */
153
- // eslint-disable-next-line class-methods-use-this
154
- reset() {
155
- this.wsApi.send('RESET');
156
- }
157
- /**
158
- * Callback when the websocket is opened and ready.
159
- * It applies the bbox and the projection.
160
- */
161
- onOpen() {
162
- if (this.bbox) {
163
- this.wsApi.send(`BBOX ${this.bbox.join(' ')}`);
164
- }
165
- if (this.buffer) {
166
- this.wsApi.send(`BUFFER ${this.buffer.join(' ')}`);
167
- }
168
- /**
169
- * Keep websocket alive
170
- */
171
- if (this.pingIntervalMs) {
172
- window.clearInterval(this.pingInterval);
173
- /** @private */
174
- this.pingInterval = window.setInterval(() => {
175
- this.wsApi.send('PING');
176
- }, this.pingIntervalMs);
177
- }
178
- }
179
- /**
180
- * Callback when the websocket is closed by the server.
181
- * It auto reconnects after a timeout.
182
- */
183
- onClose() {
184
- window.clearTimeout(this.pingInterval);
185
- window.clearTimeout(this.reconnectTimeout);
186
- if (this.reconnectTimeoutMs) {
187
- /** @private */
188
- this.reconnectTimeout = window.setTimeout(() => this.open(), this.reconnectTimeoutMs);
189
- }
190
- }
191
- /**
192
- * Send GET to a channel.
193
- *
194
- * @param {string | WebSocketAPIParameters} channelOrParams Name of the websocket channel to send GET or an object representing parameters to send
195
- * @return {Promise<WebSocketAPIMessageEventData<?>>} A websocket response.
196
- */
197
- get(channelOrParams) {
198
- let params = channelOrParams;
199
- if (typeof channelOrParams === 'string') {
200
- params = { channel: channelOrParams };
201
- }
202
- return new Promise((resolve, reject) => {
203
- this.wsApi.get(params, resolve, reject);
204
- });
205
- }
206
- /**
207
- * Subscribe to a channel.
208
- *
209
- * @param {string} channel Name of the websocket channel to subscribe.
210
- * @param {function} onSuccess Callback when the subscription succeeds.
211
- * @param {function} onError Callback when the subscription fails.
212
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
213
- * @private
214
- */
215
- subscribe(channel, onSuccess, onError = () => { }, quiet = false) {
216
- if (!channel || !onSuccess) {
217
- return;
218
- }
219
- this.wsApi.subscribe({ channel }, onSuccess, onError, quiet);
220
- }
221
- /**
222
- * Unsubscribe both modes of a channel.
223
- *
224
- * @param {string} channel Name of the websocket channel to unsubscribe.
225
- * @param {string} suffix Suffix to add to the channel name.
226
- * @param {function} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
227
- * @private
228
- */
229
- unsubscribe(channel, suffix = '', onMessage) {
230
- const suffixSchenatic = getModeSuffix(RealtimeModes.SCHEMATIC, RealtimeModes);
231
- const suffixTopographic = getModeSuffix(RealtimeModes.TOPOGRAPHIC, RealtimeModes);
232
- this.wsApi.unsubscribe(`${channel}${suffixSchenatic}${suffix || ''}`, onMessage);
233
- this.wsApi.unsubscribe(`${channel}${suffixTopographic}${suffix || ''}`, onMessage);
234
- }
235
- /**
236
- * Subscribe to departures channel of a given station.
237
- *
238
- * @param {number} stationId UIC of the station.
239
- * @param {Boolean} sortByMinArrivalTime Sort by minimum arrival time
240
- * @param {function(departures:Departure[])} onMessage Function called on each message of the channel.
241
- * @param {function} onError Callback when the subscription fails.
242
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
243
- */
244
- subscribeDepartures(stationId, onMessage, onError = () => { }, quiet = false) {
245
- this.subscribe(`timetable_${stationId}`, onMessage, onError, quiet);
246
- }
247
- /**
248
- * Unsubscribe from current departures channel.
249
- * @param {RealtimeStationId} id Station's id
250
- * @param {function(data: { content: RealtimeDeparture[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
251
- */
252
- unsubscribeDepartures(id, onMessage) {
253
- this.unsubscribe(`timetable_${id}`, '', onMessage);
254
- }
255
- /**
256
- * Subscribe to the disruptions channel for tenant.
257
- *
258
- * @param {function(data: { content: RealtimeNews[] })} onMessage Function called on each message of the channel.
259
- * @param {function} onError Callback when the subscription fails.
260
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
261
- */
262
- subscribeDisruptions(tenant, onMessage, onError = () => { }, quiet = false) {
263
- this.subscribe(`${tenant}_newsticker`, onMessage, onError, quiet);
264
- }
265
- /**
266
- * Unsubscribe disruptions.
267
- *
268
- * @param {function(data: { content: RealtimeNews[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
269
- */
270
- unsubscribeDisruptions(tenant, onMessage) {
271
- this.unsubscribe(`${tenant}_newsticker`, '', onMessage);
272
- }
273
- /**
274
- * Return a station with a given uic number and a mode.
275
- *
276
- * @param {number} uic UIC of the station.
277
- * @param {RealtimeMode} mode Realtime mode.
278
- * @return {Promise<{data: { content: RealtimeStation }}>} A station.
279
- */
280
- getStation(uic, mode) {
281
- const params = {
282
- channel: `station${getModeSuffix(mode, RealtimeModes)}`,
283
- args: uic,
284
- };
285
- return this.get(params);
286
- }
287
- /**
288
- * Get the list of ststions available for a specifc mode. The promise is resolved every 100ms
289
- * @param {RealtimeMode} mode Realtime mode.
290
- * @param {number} timeout = 100 Duration in ms between each promise resolve calls.
291
- * @return {Promise<RealtimeStation[]>} An array of stations.
292
- */
293
- getStations(mode, timeout = 100) {
294
- return new Promise((resolve) => {
295
- this.get(`station${getModeSuffix(mode, RealtimeModes)}`).then(debounceWebsocketMessages(resolve, undefined, timeout));
296
- });
297
- }
298
- /**
299
- * Subscribe to stations channel.
300
- * One message pro station.
301
- *
302
- * @param {RealtimeMode} mode Realtime mode.
303
- * @param {function(data: { content: RealtimeStation })} onMessage Function called on each message of the channel.
304
- * @param {function} onError Callback when the subscription fails.
305
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
306
- */
307
- subscribeStations(mode, onMessage, onError = () => { }, quiet = false) {
308
- this.subscribe(`station${getModeSuffix(mode, RealtimeModes)}`, onMessage, onError, quiet);
309
- }
310
- /**
311
- * Unsubscribe to stations channel.
312
- * @param {function(data: { content: RealtimeStation })} onMessage The listener callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribe.
313
- */
314
- unsubscribeStations(onMessage) {
315
- this.unsubscribe('station', '', onMessage);
316
- }
317
- /**
318
- * Subscribe to extra_geoms channel.
319
- *
320
- * @param {function(data: { content: RealtimeExtraGeom })} onMessage Function called on each message of the channel.
321
- * @param {function} onError Callback when the subscription fails.
322
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
323
- */
324
- subscribeExtraGeoms(onMessage, onError = () => { }, quiet = false) {
325
- this.subscribe('extra_geoms', onMessage, onError, quiet);
326
- }
327
- /**
328
- * Unsubscribe to extra_geoms channel.
329
- * @param {function(data: { content: RealtimeExtraGeom })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
330
- */
331
- unsubscribeExtraGeoms(onMessage) {
332
- this.unsubscribe('extra_geoms', '', onMessage);
333
- }
334
- /**
335
- * Return a partial trajectory with a given id and a mode.
336
- *
337
- * @param {number} trainId The identifier of a trajectory.
338
- * @param {RealtimeMode} mode Realtime mode.
339
- * @return {Promise<{data: { content: RealtimeTrajectory }}>} A trajectory.
340
- */
341
- getTrajectory(id, mode) {
342
- return this.get(`partial_trajectory${getModeSuffix(mode, RealtimeModes)}_${id}`);
343
- }
344
- /**
345
- * Subscribe to trajectory channel.
346
- *
347
- * @param {RealtimeMode} mode Realtime mode.
348
- * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Function called on each message of the channel.
349
- * @param {function} onError Callback when the subscription fails.
350
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
351
- */
352
- subscribeTrajectory(mode, onMessage, onError = () => { }, quiet = false) {
353
- this.unsubscribeTrajectory(onMessage);
354
- let suffix = '';
355
- if (this.version === '1') {
356
- suffix = getModeSuffix(mode, RealtimeModes);
357
- }
358
- this.subscribe(`trajectory${suffix}`, onMessage, onError, quiet);
359
- }
360
- /**
361
- * Unsubscribe to trajectory channels.
362
- * @param {function(data: { content: RealtimeTrajectoryResponse[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
363
- */
364
- unsubscribeTrajectory(onMessage) {
365
- this.unsubscribe(`trajectory`, '', onMessage);
366
- }
367
- /**
368
- * Subscribe to deleted_vhicles channel.
369
- *
370
- * @param {RealtimeMode} mode Realtime mode.
371
- * @param {function(data: { content: RealtimeTrainId })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
372
- * @param {function} onError Callback when the subscription fails.
373
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
374
- */
375
- subscribeDeletedVehicles(mode, onMessage, onError = () => { }, quiet = false) {
376
- this.unsubscribeDeletedVehicles(onMessage);
377
- let suffix = '';
378
- if (this.version === '1') {
379
- suffix = getModeSuffix(mode, RealtimeModes);
380
- }
381
- this.subscribe(`deleted_vehicles${suffix}`, onMessage, onError, quiet);
382
- }
383
- /**
384
- * Unsubscribe to deleted_vhicles channels.
385
- * @param {function(data: { content: RealtimeTrainId })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
386
- */
387
- unsubscribeDeletedVehicles(onMessage) {
388
- this.unsubscribe('deleted_vehicles', '', onMessage);
389
- }
390
- /**
391
- * Get a full trajectory of a vehicule .
392
- *
393
- * @param {string} id A vehicle id.
394
- * @param {RealtimeMode} mode Realtime mode.
395
- * @param {string} generalizationLevel The generalization level to request. Can be one of 5 (more generalized), 10, 30, 100, undefined (less generalized).
396
- * @return {Promise<{ data: { content: RealtimeFullTrajectory } }>} Return a full trajectory.
397
- */
398
- getFullTrajectory(id, mode, generalizationLevel) {
399
- let suffix = '';
400
- if (this.version === '1') {
401
- suffix = getModeSuffix(mode, RealtimeModes);
402
- }
403
- const channel = [`full_trajectory${suffix}`];
404
- if (id) {
405
- channel.push(id);
406
- }
407
- if ((!mode || mode === RealtimeModes.TOPOGRAPHIC) && generalizationLevel) {
408
- channel.push(`gen${generalizationLevel}`);
409
- }
410
- return this.get(channel.join('_'));
411
- }
412
- /**
413
- * Subscribe to full_trajectory channel of a given vehicle.
414
- *
415
- * @param {string} id A vehicle id.
416
- * @param {RealtimeMode} mode Realtime mode.
417
- * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Function called on each message of the channel.
418
- * @param {function} onError Callback when the subscription fails.
419
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
420
- */
421
- subscribeFullTrajectory(id, mode, onMessage, onError = () => { }, quiet = false) {
422
- let suffix = '';
423
- if (this.version === '1') {
424
- suffix = getModeSuffix(mode, RealtimeModes);
425
- }
426
- this.subscribe(`full_trajectory${suffix}_${id}`, onMessage, onError, quiet);
427
- }
428
- /**
429
- * Unsubscribe from full_trajectory channel
430
- *
431
- * @param {string} id A vehicle id.
432
- * @param {function(data: { content: RealtimeFullTrajectory })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
433
- */
434
- unsubscribeFullTrajectory(id, onMessage) {
435
- this.unsubscribe('full_trajectory', `_${id}`, onMessage);
436
- }
437
- /**
438
- * Get the list of stops for this vehicle.
439
- *
440
- * @param {string} id A vehicle id.
441
- * @return {Promise<{ data: { content: StopSequence[] } }>} Returns a stop sequence object.
442
- */
443
- getStopSequence(id) {
444
- return this.get(`stopsequence_${id}`);
445
- }
446
- /**
447
- * Subscribe to stopsequence channel of a given vehicle.
448
- *
449
- * @param {string} id A vehicle id.
450
- * @param {function(data: { content: StopSequence[] })} onMessage Function called on each message of the channel.
451
- * @param {function} onError Callback when the subscription fails.
452
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
453
- */
454
- subscribeStopSequence(id, onMessage, onError = () => { }, quiet = false) {
455
- this.subscribe(`stopsequence_${id}`, onMessage, onError, quiet);
456
- }
457
- /**
458
- * Unsubscribe from stopsequence channel
459
- *
460
- * @param {string} id A vehicle id.
461
- * @param {function(data: { content: StopSequence[] })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
462
- */
463
- unsubscribeStopSequence(id, onMessage) {
464
- this.unsubscribe(`stopsequence`, `_${id}`, onMessage);
465
- }
466
- /**
467
- * Subscribe to healthcheck channel.
468
- * @param {function(data: { content: string })} onMessage Callback when the subscribe to healthcheck channel succeeds.
469
- * @param {function} onError Callback when the subscription fails.
470
- * @param {boolean} [quiet=false] If true avoid to store the subscription in the subscriptions list.
471
- */
472
- subscribeHealthCheck(onMessage, onError = () => { }, quiet = false) {
473
- this.subscribe('healthcheck', onMessage, onError, quiet);
474
- }
475
- /**
476
- * Unsubscribe to healthcheck channel.
477
- * @param {function(data: { content: string })} onMessage Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
478
- */
479
- unsubscribeHealthCheck(onMessage) {
480
- this.unsubscribe('healthcheck', '', onMessage);
481
- }
482
- }
483
- export default RealtimeAPI;
@@ -1,37 +0,0 @@
1
- import HttpAPI from '../common/api/HttpAPI';
2
- import { RoutingParameters, RoutingResponse } from '../types';
3
- export type RoutingAPIOptions = {
4
- url?: string;
5
- apiKey?: string;
6
- };
7
- /**
8
- * Access to the [geOps Routing service](https://developer.geops.io/apis/routing).
9
- *
10
- * @example
11
- * import { RoutingAPI } from 'mobility-toolbox-js';
12
- *
13
- * const api = new RoutingAPI({
14
- * apiKey: [yourApiKey]
15
- * });
16
- *
17
- */
18
- declare class RoutingAPI extends HttpAPI {
19
- /**
20
- * Constructor
21
- *
22
- * @param {RoutingAPIOptions} options Options.
23
- * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
24
- * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
25
- */
26
- constructor(options?: RoutingAPIOptions);
27
- /**
28
- * Route.
29
- *
30
- * @param {RoutingParameters} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
31
- * @param {RequestInit} config Options for the fetch request.
32
- * @return {Promise<RoutingResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
33
- */
34
- route(params: RoutingParameters, config: RequestInit): Promise<RoutingResponse>;
35
- }
36
- export default RoutingAPI;
37
- //# sourceMappingURL=RoutingAPI.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"RoutingAPI.d.ts","sourceRoot":"","sources":["../../src/api/RoutingAPI.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,uBAAuB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE9D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,cAAM,UAAW,SAAQ,OAAO;IAC9B;;;;;;OAMG;gBACS,OAAO,GAAE,iBAAsB;IAI3C;;;;;;OAMG;IACH,KAAK,CACH,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,eAAe,CAAC;CAG5B;AAED,eAAe,UAAU,CAAC"}
package/api/RoutingAPI.js DELETED
@@ -1,35 +0,0 @@
1
- import HttpAPI from '../common/api/HttpAPI';
2
- /**
3
- * Access to the [geOps Routing service](https://developer.geops.io/apis/routing).
4
- *
5
- * @example
6
- * import { RoutingAPI } from 'mobility-toolbox-js';
7
- *
8
- * const api = new RoutingAPI({
9
- * apiKey: [yourApiKey]
10
- * });
11
- *
12
- */
13
- class RoutingAPI extends HttpAPI {
14
- /**
15
- * Constructor
16
- *
17
- * @param {RoutingAPIOptions} options Options.
18
- * @param {string} [options.url='https://api.geops.io/routing/v1/'] Service url.
19
- * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
20
- */
21
- constructor(options = {}) {
22
- super(Object.assign({ url: 'https://api.geops.io/routing/v1/' }, options));
23
- }
24
- /**
25
- * Route.
26
- *
27
- * @param {RoutingParameters} params Request parameters. See [Routing service documentation](https://developer.geops.io/apis/routing/).
28
- * @param {RequestInit} config Options for the fetch request.
29
- * @return {Promise<RoutingResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
30
- */
31
- route(params, config) {
32
- return this.fetch('', params, config);
33
- }
34
- }
35
- export default RoutingAPI;
package/api/StopsAPI.d.ts DELETED
@@ -1,38 +0,0 @@
1
- import HttpAPI from '../common/api/HttpAPI';
2
- import { StopsParameters, StopsResponse } from '../types';
3
- export type StopsAPIOptions = {
4
- url?: string;
5
- apiKey?: string;
6
- };
7
- /**
8
- * Access to the [Stops service](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
9
- *
10
- * @example
11
- * import { StopsAPI } from 'mobility-toolbox-js/api';
12
- *
13
- * const api = new StopsAPI({
14
- * url: 'https://api.geops.io/stops/v1/',
15
- * apiKey: [yourApiKey]
16
- * });
17
- *
18
- */
19
- declare class StopsAPI extends HttpAPI {
20
- /**
21
- * Constructor
22
- *
23
- * @param {StopsAPIOptions} options Options.
24
- * @param {string} [options.url='https://api.geops.io/stops/v1/'] Service url.
25
- * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
26
- */
27
- constructor(options?: StopsAPIOptions);
28
- /**
29
- * Search fo stops.
30
- *
31
- * @param {StopsParameters} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/stops).
32
- * @param {RequestInit} config Options for the fetch request.
33
- * @return {Promise<StopsResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
34
- */
35
- search(params: StopsParameters, config: RequestInit): Promise<StopsResponse>;
36
- }
37
- export default StopsAPI;
38
- //# sourceMappingURL=StopsAPI.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"StopsAPI.d.ts","sourceRoot":"","sources":["../../src/api/StopsAPI.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,uBAAuB,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE1D,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,cAAM,QAAS,SAAQ,OAAO;IAC5B;;;;;;OAMG;gBACS,OAAO,GAAE,eAAoB;IAIzC;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;CAG7E;AAED,eAAe,QAAQ,CAAC"}
package/api/StopsAPI.js DELETED
@@ -1,36 +0,0 @@
1
- import HttpAPI from '../common/api/HttpAPI';
2
- /**
3
- * Access to the [Stops service](https://developer.geops.io/apis/5dcbd702a256d90001cf1361/).
4
- *
5
- * @example
6
- * import { StopsAPI } from 'mobility-toolbox-js/api';
7
- *
8
- * const api = new StopsAPI({
9
- * url: 'https://api.geops.io/stops/v1/',
10
- * apiKey: [yourApiKey]
11
- * });
12
- *
13
- */
14
- class StopsAPI extends HttpAPI {
15
- /**
16
- * Constructor
17
- *
18
- * @param {StopsAPIOptions} options Options.
19
- * @param {string} [options.url='https://api.geops.io/stops/v1/'] Service url.
20
- * @param {string} options.apiKey Access key for [geOps services](https://developer.geops.io/).
21
- */
22
- constructor(options = {}) {
23
- super(Object.assign({ url: 'https://api.geops.io/stops/v1/' }, options));
24
- }
25
- /**
26
- * Search fo stops.
27
- *
28
- * @param {StopsParameters} params Request parameters. See [Stops service documentation](https://developer.geops.io/apis/stops).
29
- * @param {RequestInit} config Options for the fetch request.
30
- * @return {Promise<StopsResponse>} An GeoJSON feature collection with coordinates in [EPSG:4326](http://epsg.io/4326).
31
- */
32
- search(params, config) {
33
- return this.fetch('', params, config);
34
- }
35
- }
36
- export default StopsAPI;
package/api/index.d.ts DELETED
@@ -1,4 +0,0 @@
1
- export { default as RoutingAPI } from "./RoutingAPI";
2
- export { default as StopsAPI } from "./StopsAPI";
3
- export { default as RealtimeAPI, RealtimeModes } from "./RealtimeAPI";
4
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.js"],"names":[],"mappings":""}