mobility-toolbox-js 2.0.0-beta.8 → 2.0.0-beta.80
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.
- package/api/RealtimeAPI.d.ts +279 -0
- package/api/RealtimeAPI.d.ts.map +1 -0
- package/api/RealtimeAPI.js +466 -0
- package/api/RoutingAPI.d.ts +37 -0
- package/api/RoutingAPI.d.ts.map +1 -0
- package/api/RoutingAPI.js +35 -0
- package/api/StopsAPI.d.ts +38 -0
- package/api/StopsAPI.d.ts.map +1 -0
- package/api/StopsAPI.js +36 -0
- package/api/index.d.ts +4 -0
- package/api/index.d.ts.map +1 -0
- package/api/index.js +3 -0
- package/api/typedefs.d.ts +179 -0
- package/api/typedefs.d.ts.map +1 -0
- package/{src/api/tralis → api}/typedefs.js +4 -10
- package/common/api/HttpAPI.d.ts +31 -0
- package/common/api/HttpAPI.d.ts.map +1 -0
- package/common/api/HttpAPI.js +57 -0
- package/common/api/WebSocketAPI.d.ts +153 -0
- package/common/api/WebSocketAPI.d.ts.map +1 -0
- package/common/api/WebSocketAPI.js +341 -0
- package/common/controls/ControlCommon.d.ts +76 -0
- package/common/controls/ControlCommon.d.ts.map +1 -0
- package/common/controls/ControlCommon.js +150 -0
- package/common/controls/CopyrightControlCommon.d.ts +13 -0
- package/common/controls/CopyrightControlCommon.d.ts.map +1 -0
- package/common/controls/CopyrightControlCommon.js +34 -0
- package/common/controls/StopFinderControlCommon.d.ts +55 -0
- package/common/controls/StopFinderControlCommon.d.ts.map +1 -0
- package/common/controls/StopFinderControlCommon.js +144 -0
- package/common/index.d.ts +3 -0
- package/common/index.d.ts.map +1 -0
- package/common/index.js +2 -0
- package/common/layers/LayerCommon.d.ts +94 -0
- package/common/layers/LayerCommon.d.ts.map +1 -0
- package/common/layers/LayerCommon.js +244 -0
- package/common/mixins/RealtimeLayerMixin.d.ts +286 -0
- package/common/mixins/RealtimeLayerMixin.d.ts.map +1 -0
- package/common/mixins/RealtimeLayerMixin.js +776 -0
- package/common/mixins/UserInteractionsLayerMixin.d.ts +60 -0
- package/common/mixins/UserInteractionsLayerMixin.d.ts.map +1 -0
- package/common/mixins/UserInteractionsLayerMixin.js +241 -0
- package/common/styles/index.d.ts +5 -0
- package/common/styles/index.d.ts.map +1 -0
- package/common/styles/index.js +4 -0
- package/common/styles/realtimeDefaultStyle.d.ts +36 -0
- package/common/styles/realtimeDefaultStyle.d.ts.map +1 -0
- package/common/styles/realtimeDefaultStyle.js +275 -0
- package/{src/common/styles/trackerDelayStyle.js → common/styles/realtimeDelayStyle.d.ts} +4 -9
- package/common/styles/realtimeDelayStyle.d.ts.map +1 -0
- package/common/styles/realtimeDelayStyle.js +13 -0
- package/common/styles/realtimeHeadingStyle.d.ts +12 -0
- package/common/styles/realtimeHeadingStyle.d.ts.map +1 -0
- package/common/styles/realtimeHeadingStyle.js +85 -0
- package/common/styles/realtimeSimpleStyle.d.ts +4 -0
- package/common/styles/realtimeSimpleStyle.d.ts.map +1 -0
- package/common/styles/realtimeSimpleStyle.js +23 -0
- package/common/typedefs.d.ts +111 -0
- package/common/typedefs.d.ts.map +1 -0
- package/common/typedefs.js +52 -0
- package/common/utils/compareDepartures.d.ts +11 -0
- package/common/utils/compareDepartures.d.ts.map +1 -0
- package/common/utils/compareDepartures.js +35 -0
- package/common/utils/createCanvas.d.ts +10 -0
- package/common/utils/createCanvas.d.ts.map +1 -0
- package/common/utils/createCanvas.js +27 -0
- package/common/utils/createRealtimeFilters.d.ts +13 -0
- package/common/utils/createRealtimeFilters.d.ts.map +1 -0
- package/common/utils/createRealtimeFilters.js +74 -0
- package/common/utils/debounceDeparturesMessages.d.ts +12 -0
- package/common/utils/debounceDeparturesMessages.d.ts.map +1 -0
- package/common/utils/debounceDeparturesMessages.js +24 -0
- package/common/utils/debounceWebsocketMessages.d.ts +11 -0
- package/common/utils/debounceWebsocketMessages.d.ts.map +1 -0
- package/common/utils/debounceWebsocketMessages.js +29 -0
- package/common/utils/getLayersAsFlatArray.d.ts +3 -0
- package/common/utils/getLayersAsFlatArray.d.ts.map +1 -0
- package/common/utils/getLayersAsFlatArray.js +15 -0
- package/common/utils/getMapboxMapCopyrights.d.ts +18 -0
- package/common/utils/getMapboxMapCopyrights.d.ts.map +1 -0
- package/common/utils/getMapboxMapCopyrights.js +30 -0
- package/common/utils/getMapboxRender.d.ts +7 -0
- package/common/utils/getMapboxRender.d.ts.map +1 -0
- package/common/utils/getMapboxRender.js +87 -0
- package/common/utils/getMaplibreRender.d.ts +7 -0
- package/common/utils/getMaplibreRender.d.ts.map +1 -0
- package/common/utils/getMaplibreRender.js +38 -0
- package/common/utils/getRealtimeModeSuffix.d.ts +10 -0
- package/common/utils/getRealtimeModeSuffix.d.ts.map +1 -0
- package/common/utils/getRealtimeModeSuffix.js +7 -0
- package/common/utils/getUrlWithParams.d.ts +9 -0
- package/common/utils/getUrlWithParams.d.ts.map +1 -0
- package/common/utils/getUrlWithParams.js +18 -0
- package/common/utils/getVehiclePosition.d.ts +16 -0
- package/common/utils/getVehiclePosition.d.ts.map +1 -0
- package/common/utils/getVehiclePosition.js +72 -0
- package/common/utils/index.d.ts +17 -0
- package/common/utils/index.d.ts.map +1 -0
- package/common/utils/index.js +17 -0
- package/common/utils/realtimeConfig.d.ts +49 -0
- package/common/utils/realtimeConfig.d.ts.map +1 -0
- package/common/utils/realtimeConfig.js +173 -0
- package/common/utils/removeDuplicate.d.ts +10 -0
- package/common/utils/removeDuplicate.d.ts.map +1 -0
- package/common/utils/removeDuplicate.js +15 -0
- package/common/utils/renderTrajectories.d.ts +17 -0
- package/common/utils/renderTrajectories.d.ts.map +1 -0
- package/common/utils/renderTrajectories.js +110 -0
- package/common/utils/sortAndFilterDepartures.d.ts +16 -0
- package/common/utils/sortAndFilterDepartures.d.ts.map +1 -0
- package/common/utils/sortAndFilterDepartures.js +58 -0
- package/common/utils/sortByDelay.d.ts +3 -0
- package/common/utils/sortByDelay.d.ts.map +1 -0
- package/common/utils/sortByDelay.js +20 -0
- package/common/utils/timeUtils.d.ts +24 -0
- package/common/utils/timeUtils.d.ts.map +1 -0
- package/{src/common → common}/utils/timeUtils.js +13 -18
- package/iife.d.ts +3 -0
- package/iife.d.ts.map +1 -0
- package/{src/iife.js → iife.js} +1 -3
- package/index.d.ts +10 -0
- package/index.d.ts.map +1 -0
- package/index.js +10 -0
- package/mapbox/controls/CopyrightControl.d.ts +29 -0
- package/mapbox/controls/CopyrightControl.d.ts.map +1 -0
- package/mapbox/controls/CopyrightControl.js +48 -0
- package/mapbox/controls/index.d.ts +2 -0
- package/mapbox/controls/index.d.ts.map +1 -0
- package/mapbox/index.d.ts +6 -0
- package/mapbox/index.d.ts.map +1 -0
- package/{src/mapbox → mapbox}/index.js +1 -0
- package/mapbox/layers/Layer.d.ts +59 -0
- package/mapbox/layers/Layer.d.ts.map +1 -0
- package/mapbox/layers/Layer.js +101 -0
- package/mapbox/layers/RealtimeLayer.d.ts +181 -0
- package/mapbox/layers/RealtimeLayer.d.ts.map +1 -0
- package/mapbox/layers/RealtimeLayer.js +276 -0
- package/mapbox/layers/index.d.ts +3 -0
- package/mapbox/layers/index.d.ts.map +1 -0
- package/mapbox/layers/index.js +2 -0
- package/mapbox/utils/getMercatorResolution.d.ts +9 -0
- package/mapbox/utils/getMercatorResolution.d.ts.map +1 -0
- package/mapbox/utils/getMercatorResolution.js +18 -0
- package/mapbox/utils/getSourceCoordinates.d.ts +9 -0
- package/mapbox/utils/getSourceCoordinates.d.ts.map +1 -0
- package/mapbox/utils/getSourceCoordinates.js +27 -0
- package/mapbox/utils/index.d.ts +3 -0
- package/mapbox/utils/index.d.ts.map +1 -0
- package/mapbox/utils/index.js +2 -0
- package/mbt.js +59981 -0
- package/mbt.js.map +7 -0
- package/mbt.min.js +1084 -0
- package/mbt.min.js.map +7 -0
- package/ol/controls/CopyrightControl.d.ts +31 -0
- package/ol/controls/CopyrightControl.d.ts.map +1 -0
- package/ol/controls/CopyrightControl.js +68 -0
- package/ol/controls/RoutingControl.d.ts +193 -0
- package/ol/controls/RoutingControl.d.ts.map +1 -0
- package/ol/controls/RoutingControl.js +631 -0
- package/ol/controls/StopFinderControl.d.ts +30 -0
- package/ol/controls/StopFinderControl.d.ts.map +1 -0
- package/{src/ol → ol}/controls/StopFinderControl.js +10 -16
- package/ol/controls/index.d.ts +4 -0
- package/ol/controls/index.d.ts.map +1 -0
- package/ol/index.d.ts +6 -0
- package/ol/index.d.ts.map +1 -0
- package/ol/layers/Layer.d.ts +86 -0
- package/ol/layers/Layer.d.ts.map +1 -0
- package/ol/layers/Layer.js +160 -0
- package/ol/layers/MapGlLayer.d.ts +67 -0
- package/ol/layers/MapGlLayer.d.ts.map +1 -0
- package/ol/layers/MapGlLayer.js +218 -0
- package/ol/layers/MapboxLayer.d.ts +50 -0
- package/ol/layers/MapboxLayer.d.ts.map +1 -0
- package/ol/layers/MapboxLayer.js +109 -0
- package/ol/layers/MapboxStyleLayer.d.ts +129 -0
- package/ol/layers/MapboxStyleLayer.d.ts.map +1 -0
- package/ol/layers/MapboxStyleLayer.js +374 -0
- package/ol/layers/MaplibreLayer.d.ts +28 -0
- package/ol/layers/MaplibreLayer.d.ts.map +1 -0
- package/ol/layers/MaplibreLayer.js +34 -0
- package/ol/layers/RealtimeLayer.d.ts +202 -0
- package/ol/layers/RealtimeLayer.d.ts.map +1 -0
- package/ol/layers/RealtimeLayer.js +340 -0
- package/ol/layers/RoutingLayer.d.ts +34 -0
- package/ol/layers/RoutingLayer.d.ts.map +1 -0
- package/ol/layers/RoutingLayer.js +85 -0
- package/ol/layers/VectorLayer.d.ts +25 -0
- package/ol/layers/VectorLayer.d.ts.map +1 -0
- package/ol/layers/VectorLayer.js +38 -0
- package/ol/layers/WMSLayer.d.ts +42 -0
- package/ol/layers/WMSLayer.d.ts.map +1 -0
- package/ol/layers/WMSLayer.js +88 -0
- package/ol/layers/index.d.ts +9 -0
- package/ol/layers/index.d.ts.map +1 -0
- package/{src/ol → ol}/layers/index.js +1 -1
- package/ol/styles/fullTrajectoryDelayStyle.d.ts +4 -0
- package/ol/styles/fullTrajectoryDelayStyle.d.ts.map +1 -0
- package/ol/styles/fullTrajectoryDelayStyle.js +33 -0
- package/ol/styles/fullTrajectoryStyle.d.ts +5 -0
- package/ol/styles/fullTrajectoryStyle.d.ts.map +1 -0
- package/ol/styles/fullTrajectoryStyle.js +44 -0
- package/ol/styles/index.d.ts +3 -0
- package/ol/styles/index.d.ts.map +1 -0
- package/package.json +96 -189
- package/setupTests.d.ts +2 -0
- package/setupTests.d.ts.map +1 -0
- package/{src/setupTests.js → setupTests.js} +13 -2
- package/types/common.d.ts +122 -0
- package/types/index.d.ts +11 -0
- package/types/realtime.d.ts +320 -0
- package/types/routing.d.ts +206 -0
- package/types/stops.d.ts +143 -0
- package/.babelrc +0 -6
- package/.esdoc.json +0 -17
- package/.eslintignore +0 -1
- package/.github/workflows/conventional-pr-title.yml +0 -21
- package/.github/workflows/cypress.yml +0 -29
- package/.github/workflows/nodejs.yml +0 -28
- package/.husky/commit-msg +0 -4
- package/.husky/post-checkout +0 -4
- package/.husky/post-merge +0 -4
- package/.husky/post-rebase +0 -4
- package/.husky/pre-commit +0 -4
- package/.neutrinorc.js +0 -176
- package/.nvmrc +0 -1
- package/CHANGELOG.md +0 -10
- package/LICENSE +0 -21
- package/README.md +0 -23
- package/__mocks__/mapbox-gl.js +0 -81
- package/__mocks__/maplibre-gl.js +0 -81
- package/commitlint.config.js +0 -1
- package/cypress/fixtures/example.json +0 -5
- package/cypress/integration/examples/api.spec.js +0 -7
- package/cypress/integration/examples/examples.spec.js +0 -7
- package/cypress/integration/examples/navigation.spec.js +0 -29
- package/cypress/plugins/index.js +0 -21
- package/cypress/support/commands.js +0 -25
- package/cypress/support/index.js +0 -20
- package/cypress.json +0 -4
- package/data/fetchRoute.json +0 -292
- package/data/fetchTrajectories.json +0 -18
- package/data/fetchTrajectoryById.json +0 -3
- package/data/fetchTrajectoryStations.json +0 -18
- package/data/stopsSearch.json +0 -15
- package/documentation.yml +0 -4
- package/esdoc/README.md +0 -27
- package/esdoc/plugins/MyPlugin.js +0 -69
- package/esdoc/plugins/dynamic-property-plugin/Plugin.js +0 -50
- package/esdoc/plugins/externals-plugin/Plugin.js +0 -45
- package/esdoc/plugins/externals-plugin/externals.js +0 -96
- package/global-setup.js +0 -3
- package/index.html +0 -0
- package/indexweb.html +0 -49
- package/jest.config.js +0 -5
- package/pull_request_template.md +0 -17
- package/renovate.json +0 -4
- package/scripts/read-pkg-json.js +0 -22
- package/src/api/index.js +0 -3
- package/src/api/routing/RoutingAPI.js +0 -44
- package/src/api/routing/RoutingAPI.test.js +0 -41
- package/src/api/stops/StopsAPI.js +0 -41
- package/src/api/stops/StopsAPI.test.js +0 -34
- package/src/api/tralis/TralisAPI.js +0 -731
- package/src/api/tralis/TralisAPI.test.js +0 -75
- package/src/api/tralis/TralisAPIUtils.js +0 -73
- package/src/api/tralis/WebSocketConnector.js +0 -338
- package/src/api/tralis/WebSocketConnector.test.js +0 -356
- package/src/assets/Lato-Black.ttf +0 -0
- package/src/assets/Lato-BlackItalic.ttf +0 -0
- package/src/assets/Lato-Bold.ttf +0 -0
- package/src/assets/Lato-BoldItalic.ttf +0 -0
- package/src/assets/Lato-Italic.ttf +0 -0
- package/src/assets/Lato-Light.ttf +0 -0
- package/src/assets/Lato-LightItalic.ttf +0 -0
- package/src/assets/Lato-Regular.ttf +0 -0
- package/src/assets/Lato-Thin.ttf +0 -0
- package/src/assets/Lato-ThinItalic.ttf +0 -0
- package/src/assets/OFL.txt +0 -93
- package/src/common/Tracker.js +0 -197
- package/src/common/api/api.js +0 -64
- package/src/common/api/api.test.js +0 -68
- package/src/common/controls/Control.js +0 -146
- package/src/common/controls/Control.test.js +0 -98
- package/src/common/index.js +0 -5
- package/src/common/layers/Layer.js +0 -404
- package/src/common/layers/Layer.test.js +0 -585
- package/src/common/mixins/CopyrightMixin.js +0 -48
- package/src/common/mixins/SearchMixin.js +0 -176
- package/src/common/mixins/TralisLayerMixin.js +0 -930
- package/src/common/styles/index.js +0 -4
- package/src/common/styles/trackerDefaultStyle.js +0 -333
- package/src/common/styles/trackerSimpleStyle.js +0 -22
- package/src/common/trackerConfig.js +0 -190
- package/src/common/trackerConfig.test.js +0 -25
- package/src/common/typedefs.js +0 -23
- package/src/common/utils/createTrackerFilters.js +0 -87
- package/src/common/utils/createTrackerFilters.test.js +0 -95
- package/src/common/utils/getMapboxMapCopyrights.js +0 -32
- package/src/common/utils/getMapboxMapCopyrights.test.js +0 -47
- package/src/common/utils/getMapboxStyleUrl.js +0 -32
- package/src/common/utils/getVehiclePosition.js +0 -72
- package/src/common/utils/index.js +0 -5
- package/src/common/utils/removeDuplicate.js +0 -22
- package/src/common/utils/removeDuplicate.test.js +0 -22
- package/src/common/utils/sortByDelay.js +0 -23
- package/src/common/utils/timeUtils.test.js +0 -16
- package/src/doc/App.js +0 -116
- package/src/doc/App.scss +0 -51
- package/src/doc/_redirects +0 -2
- package/src/doc/components/CodeSandboxButton.js +0 -103
- package/src/doc/components/Documentation.js +0 -40
- package/src/doc/components/Esdoc/Anchor.js +0 -57
- package/src/doc/components/Esdoc/ClassDoc.js +0 -272
- package/src/doc/components/Esdoc/DeprecatedHTML.js +0 -16
- package/src/doc/components/Esdoc/DetailDocs.js +0 -281
- package/src/doc/components/Esdoc/DetailHTML.js +0 -33
- package/src/doc/components/Esdoc/DirectSubclassHTML.js +0 -30
- package/src/doc/components/Esdoc/DocBuilderUtils.js +0 -694
- package/src/doc/components/Esdoc/DocLinkHTML.js +0 -62
- package/src/doc/components/Esdoc/DocsLinkHTML.js +0 -38
- package/src/doc/components/Esdoc/Esdoc.js +0 -63
- package/src/doc/components/Esdoc/EsdocContent.js +0 -51
- package/src/doc/components/Esdoc/EsdocNavigation.js +0 -13
- package/src/doc/components/Esdoc/EsdocSearch.js +0 -81
- package/src/doc/components/Esdoc/ExperimentalHTML.js +0 -17
- package/src/doc/components/Esdoc/ExtendsChainHTML.js +0 -32
- package/src/doc/components/Esdoc/FileDocLinkHTML.js +0 -60
- package/src/doc/components/Esdoc/IdentifiersDoc.js +0 -113
- package/src/doc/components/Esdoc/IndirectSubclassHTML.js +0 -30
- package/src/doc/components/Esdoc/InheritedSummaryDoc.js +0 -70
- package/src/doc/components/Esdoc/InheritedSummaryHTML.js +0 -38
- package/src/doc/components/Esdoc/MixinClassesHTML.js +0 -29
- package/src/doc/components/Esdoc/NavDoc.js +0 -112
- package/src/doc/components/Esdoc/OverrideMethod.js +0 -44
- package/src/doc/components/Esdoc/OverrideMethodDescription.js +0 -35
- package/src/doc/components/Esdoc/Properties.js +0 -89
- package/src/doc/components/Esdoc/README.md +0 -45
- package/src/doc/components/Esdoc/SignatureHTML.js +0 -123
- package/src/doc/components/Esdoc/SingleDoc.js +0 -31
- package/src/doc/components/Esdoc/SummaryDoc.js +0 -160
- package/src/doc/components/Esdoc/SummaryHTML.js +0 -96
- package/src/doc/components/Esdoc/TypeDocLinkHTML.js +0 -249
- package/src/doc/components/Esdoc/css/identifiers.css +0 -38
- package/src/doc/components/Esdoc/css/search.css +0 -76
- package/src/doc/components/Esdoc/css/style.css +0 -603
- package/src/doc/components/Esdoc/index.js +0 -7
- package/src/doc/components/Example.js +0 -153
- package/src/doc/components/Examples.js +0 -183
- package/src/doc/components/Home.js +0 -106
- package/src/doc/components/TrackerExample.js +0 -38
- package/src/doc/examples/assets/tralis-live-map/index.js +0 -11
- package/src/doc/examples/assets/tralis-live-map/s1kreis.svg +0 -105
- package/src/doc/examples/assets/tralis-live-map/s20kreis.svg +0 -101
- package/src/doc/examples/assets/tralis-live-map/s2kreis.svg +0 -95
- package/src/doc/examples/assets/tralis-live-map/s3kreis.svg +0 -95
- package/src/doc/examples/assets/tralis-live-map/s4kreis.svg +0 -95
- package/src/doc/examples/assets/tralis-live-map/s6kreis.svg +0 -95
- package/src/doc/examples/assets/tralis-live-map/s7kreis.svg +0 -95
- package/src/doc/examples/assets/tralis-live-map/s8kreis.svg +0 -93
- package/src/doc/examples/assets/tralis-live-map/unknown.svg +0 -107
- package/src/doc/examples/mb-copyright.html +0 -26
- package/src/doc/examples/mb-copyright.js +0 -37
- package/src/doc/examples/mb-tracker.html +0 -1
- package/src/doc/examples/mb-tracker.js +0 -39
- package/src/doc/examples/mb-tracker.md +0 -1
- package/src/doc/examples/mb-tralis.html +0 -1
- package/src/doc/examples/mb-tralis.js +0 -34
- package/src/doc/examples/ol-copyright.html +0 -26
- package/src/doc/examples/ol-copyright.js +0 -43
- package/src/doc/examples/ol-mapbox-layer.html +0 -1
- package/src/doc/examples/ol-mapbox-layer.js +0 -28
- package/src/doc/examples/ol-mapbox-layer.md +0 -0
- package/src/doc/examples/ol-mapbox-style-layer.html +0 -12
- package/src/doc/examples/ol-mapbox-style-layer.js +0 -44
- package/src/doc/examples/ol-query.html +0 -32
- package/src/doc/examples/ol-query.js +0 -83
- package/src/doc/examples/ol-routing.html +0 -26
- package/src/doc/examples/ol-routing.js +0 -59
- package/src/doc/examples/ol-routing.md +0 -1
- package/src/doc/examples/ol-stop-finder.html +0 -15
- package/src/doc/examples/ol-stop-finder.js +0 -31
- package/src/doc/examples/ol-stop-finder.md +0 -1
- package/src/doc/examples/ol-tracker.html +0 -1
- package/src/doc/examples/ol-tracker.js +0 -44
- package/src/doc/examples/ol-tracker.md +0 -1
- package/src/doc/examples/ol-tralis.html +0 -5
- package/src/doc/examples/ol-tralis.js +0 -57
- package/src/doc/examples/tralis-live-map.html +0 -1
- package/src/doc/examples/tralis-live-map.js +0 -51
- package/src/doc/examples/tralis-live-map.md +0 -3
- package/src/doc/examples.js +0 -107
- package/src/doc/img/examples/live_tracker_mb.jpg +0 -0
- package/src/doc/img/examples/live_tracker_munich.jpg +0 -0
- package/src/doc/img/examples/live_tracker_ol.jpg +0 -0
- package/src/doc/img/examples/mapbox.jpg +0 -0
- package/src/doc/img/examples/mapbox_style.jpg +0 -0
- package/src/doc/img/examples/ol-copyright.png +0 -0
- package/src/doc/img/examples/query_objects.jpg +0 -0
- package/src/doc/img/examples/routing.jpg +0 -0
- package/src/doc/img/examples/simple_map.jpg +0 -0
- package/src/doc/img/examples/stops.jpg +0 -0
- package/src/doc/img/favico.ico +0 -0
- package/src/doc/index.js +0 -21
- package/src/index.js +0 -10
- package/src/mapbox/controls/CopyrightControl.js +0 -58
- package/src/mapbox/layers/Layer.js +0 -118
- package/src/mapbox/layers/Layer.test.js +0 -202
- package/src/mapbox/layers/TralisLayer.js +0 -329
- package/src/mapbox/layers/TralisLayer.test.js +0 -40
- package/src/mapbox/layers/index.js +0 -2
- package/src/mapbox/utils.js +0 -46
- package/src/ol/README.md +0 -0
- package/src/ol/controls/CopyrightControl.js +0 -80
- package/src/ol/controls/CopyrightControl.test.js +0 -211
- package/src/ol/controls/RoutingControl.js +0 -752
- package/src/ol/controls/RoutingControl.test.js +0 -216
- package/src/ol/controls/StopFinderControl.test.js +0 -59
- package/src/ol/controls/snapshots/RoutingControlRouteGen10.json +0 -58
- package/src/ol/controls/snapshots/RoutingControlRouteGen100.json +0 -292
- package/src/ol/controls/snapshots/RoutingControlRouteGen30.json +0 -69
- package/src/ol/controls/snapshots/RoutingControlRouteGen5.json +0 -58
- package/src/ol/controls/snapshots/RoutingControlRouteOSM.json +0 -759
- package/src/ol/controls/snapshots/RoutingControlStation1.json +0 -60
- package/src/ol/controls/snapshots/RoutingControlStation2.json +0 -49
- package/src/ol/layers/Layer.js +0 -193
- package/src/ol/layers/Layer.test.js +0 -197
- package/src/ol/layers/MapboxLayer.js +0 -378
- package/src/ol/layers/MapboxLayer.test.js +0 -186
- package/src/ol/layers/MapboxStyleLayer.js +0 -417
- package/src/ol/layers/MapboxStyleLayer.test.js +0 -262
- package/src/ol/layers/MaplibreLayer.js +0 -280
- package/src/ol/layers/RoutingLayer.js +0 -91
- package/src/ol/layers/RoutingLayer.test.js +0 -49
- package/src/ol/layers/TralisLayer.js +0 -359
- package/src/ol/layers/TralisLayer.test.js +0 -97
- package/src/ol/layers/VectorLayer.js +0 -43
- package/src/ol/layers/VectorLayer.test.js +0 -98
- package/src/ol/layers/WMSLayer.js +0 -80
- package/src/ol/layers/WMSLayer.test.js +0 -84
- package/src/ol/styles/fullTrajectoryDelayStyle.js +0 -35
- package/src/ol/styles/fullTrajectoryStyle.js +0 -51
- package/webpack.config.js +0 -6
- /package/{src/mapbox → mapbox}/controls/index.js +0 -0
- /package/{src/ol → ol}/controls/index.js +0 -0
- /package/{src/ol → ol}/index.js +0 -0
- /package/{src/ol → ol}/styles/index.js +0 -0
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
export default dummy;
|
|
2
|
+
export type Departure = {
|
|
3
|
+
/**
|
|
4
|
+
* Timestamp in ms.
|
|
5
|
+
*/
|
|
6
|
+
time: number;
|
|
7
|
+
no_stop_between: boolean;
|
|
8
|
+
train_number: number;
|
|
9
|
+
to: string[];
|
|
10
|
+
/**
|
|
11
|
+
* Timestamp in ms.
|
|
12
|
+
*/
|
|
13
|
+
ris_aimed_time: number;
|
|
14
|
+
/**
|
|
15
|
+
* Timestamp in ms.
|
|
16
|
+
*/
|
|
17
|
+
updated_at: number;
|
|
18
|
+
new_to: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* Timestamp in ms.
|
|
21
|
+
*/
|
|
22
|
+
min_arrival_time: number;
|
|
23
|
+
/**
|
|
24
|
+
* List of next stops. Like value in at_station_ds100.
|
|
25
|
+
*/
|
|
26
|
+
next_stoppoints: string[];
|
|
27
|
+
/**
|
|
28
|
+
* Timestamp in ms.
|
|
29
|
+
*/
|
|
30
|
+
ris_estimated_time: number;
|
|
31
|
+
line: NetworkLine;
|
|
32
|
+
/**
|
|
33
|
+
* if true this departure has realtime data.
|
|
34
|
+
*/
|
|
35
|
+
has_fzo: boolean;
|
|
36
|
+
train_id: number;
|
|
37
|
+
platform: string;
|
|
38
|
+
state: any | null;
|
|
39
|
+
/**
|
|
40
|
+
* Timestamp in ms.
|
|
41
|
+
*/
|
|
42
|
+
fzo_estimated_time: number;
|
|
43
|
+
formation: any | null;
|
|
44
|
+
no_stop_till: any | null;
|
|
45
|
+
train_type: number;
|
|
46
|
+
call_id: number;
|
|
47
|
+
/**
|
|
48
|
+
* Timestamp in ms.
|
|
49
|
+
*/
|
|
50
|
+
created_at: string;
|
|
51
|
+
at_station_ds100: string;
|
|
52
|
+
/**
|
|
53
|
+
* Timestamp in ms.
|
|
54
|
+
*/
|
|
55
|
+
timediff: number;
|
|
56
|
+
};
|
|
57
|
+
export type Station = GeoJSONFeature;
|
|
58
|
+
export type StationProperties = {
|
|
59
|
+
transfers: Transfer[];
|
|
60
|
+
elevatorOutOfOrder: boolean;
|
|
61
|
+
uic: number;
|
|
62
|
+
name: string;
|
|
63
|
+
networkLines: NetworkLine[];
|
|
64
|
+
hasElevator: boolean;
|
|
65
|
+
hasZOB: boolean;
|
|
66
|
+
hasAccessibility: boolean;
|
|
67
|
+
type: string;
|
|
68
|
+
};
|
|
69
|
+
export type NetworkLine = {
|
|
70
|
+
/**
|
|
71
|
+
* Identifier of the line.
|
|
72
|
+
*/
|
|
73
|
+
id: number;
|
|
74
|
+
/**
|
|
75
|
+
* Color of the line (CSS color string).
|
|
76
|
+
*/
|
|
77
|
+
color: string;
|
|
78
|
+
/**
|
|
79
|
+
* Stroke color of the line (CSS color string).
|
|
80
|
+
*/
|
|
81
|
+
stroke: string;
|
|
82
|
+
/**
|
|
83
|
+
* Name of the line.
|
|
84
|
+
*/
|
|
85
|
+
name: string;
|
|
86
|
+
/**
|
|
87
|
+
* Text color of the line (CSS color string).
|
|
88
|
+
*/
|
|
89
|
+
text_color: string;
|
|
90
|
+
};
|
|
91
|
+
export type Transfer = {
|
|
92
|
+
/**
|
|
93
|
+
* Mode of transportation (ex: U-Bahn).
|
|
94
|
+
*/
|
|
95
|
+
mot: string;
|
|
96
|
+
/**
|
|
97
|
+
* Array of lines name (ex: ["U4", "U5"]).
|
|
98
|
+
*/
|
|
99
|
+
lines: string[];
|
|
100
|
+
};
|
|
101
|
+
export type StopSequence = GeoJSONFeature;
|
|
102
|
+
export type RealtimeTrajectory = GeoJSONFeature;
|
|
103
|
+
export type FullTrajectory = GeoJSONFeature;
|
|
104
|
+
export type Vehicle = GeoJSONFeature;
|
|
105
|
+
export type ExtraGeom = GeoJSONFeature;
|
|
106
|
+
/**
|
|
107
|
+
* @typedef {Object} Departure
|
|
108
|
+
* @property {number} time Timestamp in ms.
|
|
109
|
+
* @property {boolean} no_stop_between
|
|
110
|
+
* @property {number} train_number
|
|
111
|
+
* @property {string[]} to
|
|
112
|
+
* @property {number} ris_aimed_time Timestamp in ms.
|
|
113
|
+
* @property {number} updated_at Timestamp in ms.
|
|
114
|
+
* @property {boolean} new_to
|
|
115
|
+
* @property {number} min_arrival_time Timestamp in ms.
|
|
116
|
+
* @property {string[]} next_stoppoints List of next stops. Like value in at_station_ds100.
|
|
117
|
+
* @property {number} ris_estimated_time Timestamp in ms.
|
|
118
|
+
* @property {NetworkLine} line
|
|
119
|
+
* @property {boolean} has_fzo if true this departure has realtime data.
|
|
120
|
+
* @property {number} train_id
|
|
121
|
+
* @property {string} platform
|
|
122
|
+
* @property {?*} state
|
|
123
|
+
* @property {number} fzo_estimated_time Timestamp in ms.
|
|
124
|
+
* @property {?*} formation
|
|
125
|
+
* @property {?*} no_stop_till
|
|
126
|
+
* @property {number} train_type
|
|
127
|
+
* @property {number} call_id
|
|
128
|
+
* @property {string} created_at Timestamp in ms.
|
|
129
|
+
* @property {string} at_station_ds100
|
|
130
|
+
* @property {number} timediff Timestamp in ms.
|
|
131
|
+
*
|
|
132
|
+
*/
|
|
133
|
+
/**
|
|
134
|
+
* @typedef {GeoJSONFeature} Station
|
|
135
|
+
* @property {StationProperties} properties Returns the station's properties.
|
|
136
|
+
* @property {GeoJSONPoint} geometry Returns a point.
|
|
137
|
+
*/
|
|
138
|
+
/**
|
|
139
|
+
* @typedef {Object} StationProperties
|
|
140
|
+
* @property {Transfer[]} transfers
|
|
141
|
+
* @property {boolean} elevatorOutOfOrder
|
|
142
|
+
* @property {number} uic
|
|
143
|
+
* @property {string} name
|
|
144
|
+
* @property {NetworkLine[]} networkLines
|
|
145
|
+
* @property {boolean} hasElevator
|
|
146
|
+
* @property {boolean} hasZOB
|
|
147
|
+
* @property {boolean} hasAccessibility
|
|
148
|
+
* @property {string} type
|
|
149
|
+
*/
|
|
150
|
+
/**
|
|
151
|
+
* @typedef {Object} NetworkLine
|
|
152
|
+
* @property {number} id Identifier of the line.
|
|
153
|
+
* @property {string} color Color of the line (CSS color string).
|
|
154
|
+
* @property {string} stroke Stroke color of the line (CSS color string).
|
|
155
|
+
* @property {string} name Name of the line.
|
|
156
|
+
* @property {string} text_color Text color of the line (CSS color string).
|
|
157
|
+
*/
|
|
158
|
+
/**
|
|
159
|
+
* @typedef {Object} Transfer
|
|
160
|
+
* @property {string} mot Mode of transportation (ex: U-Bahn).
|
|
161
|
+
* @property {string[]} lines Array of lines name (ex: ["U4", "U5"]).
|
|
162
|
+
*/
|
|
163
|
+
/**
|
|
164
|
+
* @typedef {GeoJSONFeature} StopSequence
|
|
165
|
+
*/
|
|
166
|
+
/**
|
|
167
|
+
* @typedef {GeoJSONFeature} RealtimeTrajectory
|
|
168
|
+
*/
|
|
169
|
+
/**
|
|
170
|
+
* @typedef {GeoJSONFeature} FullTrajectory
|
|
171
|
+
*/
|
|
172
|
+
/**
|
|
173
|
+
* @typedef {GeoJSONFeature} Vehicle
|
|
174
|
+
*/
|
|
175
|
+
/**
|
|
176
|
+
* @typedef {GeoJSONFeature} ExtraGeom
|
|
177
|
+
*/
|
|
178
|
+
declare function dummy(): void;
|
|
179
|
+
//# sourceMappingURL=typedefs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"typedefs.d.ts","sourceRoot":"","sources":["../../src/api/typedefs.js"],"names":[],"mappings":";;;;;UAEc,MAAM;qBACN,OAAO;kBACP,MAAM;QACN,MAAM,EAAE;;;;oBACR,MAAM;;;;gBACN,MAAM;YACN,OAAO;;;;sBACP,MAAM;;;;qBACN,MAAM,EAAE;;;;wBACR,MAAM;UACN,WAAW;;;;aACX,OAAO;cACP,MAAM;cACN,MAAM;;;;;wBAEN,MAAM;;;gBAGN,MAAM;aACN,MAAM;;;;gBACN,MAAM;sBACN,MAAM;;;;cACN,MAAM;;;;eAYN,QAAQ,EAAE;wBACV,OAAO;SACP,MAAM;UACN,MAAM;kBACN,WAAW,EAAE;iBACb,OAAO;YACP,OAAO;sBACP,OAAO;UACP,MAAM;;;;;;QAKN,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;UACN,MAAM;;;;gBACN,MAAM;;;;;;SAKN,MAAM;;;;WACN,MAAM,EAAE;;;;;;;AA3DtB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;GAIG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;GAOG;AAEH;;;;GAIG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;GAEG;AAEH;;GAEG;AAGH,+BAAsB"}
|
|
@@ -25,13 +25,11 @@
|
|
|
25
25
|
* @property {number} timediff Timestamp in ms.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
|
-
|
|
29
28
|
/**
|
|
30
29
|
* @typedef {GeoJSONFeature} Station
|
|
31
30
|
* @property {StationProperties} properties Returns the station's properties.
|
|
32
31
|
* @property {GeoJSONPoint} geometry Returns a point.
|
|
33
32
|
*/
|
|
34
|
-
|
|
35
33
|
/**
|
|
36
34
|
* @typedef {Object} StationProperties
|
|
37
35
|
* @property {Transfer[]} transfers
|
|
@@ -44,7 +42,6 @@
|
|
|
44
42
|
* @property {boolean} hasAccessibility
|
|
45
43
|
* @property {string} type
|
|
46
44
|
*/
|
|
47
|
-
|
|
48
45
|
/**
|
|
49
46
|
* @typedef {Object} NetworkLine
|
|
50
47
|
* @property {number} id Identifier of the line.
|
|
@@ -53,29 +50,26 @@
|
|
|
53
50
|
* @property {string} name Name of the line.
|
|
54
51
|
* @property {string} text_color Text color of the line (CSS color string).
|
|
55
52
|
*/
|
|
56
|
-
|
|
57
53
|
/**
|
|
58
54
|
* @typedef {Object} Transfer
|
|
59
55
|
* @property {string} mot Mode of transportation (ex: U-Bahn).
|
|
60
56
|
* @property {string[]} lines Array of lines name (ex: ["U4", "U5"]).
|
|
61
57
|
*/
|
|
62
|
-
|
|
63
58
|
/**
|
|
64
59
|
* @typedef {GeoJSONFeature} StopSequence
|
|
65
60
|
*/
|
|
66
|
-
|
|
67
61
|
/**
|
|
68
|
-
* @typedef {GeoJSONFeature}
|
|
62
|
+
* @typedef {GeoJSONFeature} RealtimeTrajectory
|
|
69
63
|
*/
|
|
70
|
-
|
|
71
64
|
/**
|
|
72
65
|
* @typedef {GeoJSONFeature} FullTrajectory
|
|
73
66
|
*/
|
|
74
|
-
|
|
75
67
|
/**
|
|
76
68
|
* @typedef {GeoJSONFeature} Vehicle
|
|
77
69
|
*/
|
|
78
|
-
|
|
79
70
|
/**
|
|
80
71
|
* @typedef {GeoJSONFeature} ExtraGeom
|
|
81
72
|
*/
|
|
73
|
+
// These lines is to block TypeScript to add "use strict;" in the outputed file.
|
|
74
|
+
const dummy = () => { };
|
|
75
|
+
export default dummy;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import BaseObject from 'ol/Object';
|
|
2
|
+
export type HttpAPIOptions = {
|
|
3
|
+
url: string;
|
|
4
|
+
apiKey?: string;
|
|
5
|
+
};
|
|
6
|
+
/**
|
|
7
|
+
* Common class to access to a geOps api using http.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* import { API } from 'mobility-toolbox-js/api';
|
|
11
|
+
*
|
|
12
|
+
* const api = new HttpApi({
|
|
13
|
+
* url: [yourUrl],
|
|
14
|
+
* apiKey: [yourApiKey]
|
|
15
|
+
* });
|
|
16
|
+
*
|
|
17
|
+
* @classproperty {string} url Url of the service.
|
|
18
|
+
* @classproperty {string} apiKey Api key to access the service.
|
|
19
|
+
*/
|
|
20
|
+
declare class HttpAPI extends BaseObject {
|
|
21
|
+
url: string;
|
|
22
|
+
apiKey?: string;
|
|
23
|
+
constructor(options: HttpAPIOptions);
|
|
24
|
+
/**
|
|
25
|
+
* Append the apiKey before sending the request.
|
|
26
|
+
* @ignore
|
|
27
|
+
*/
|
|
28
|
+
fetch(path: string, params: Object, config: RequestInit): Promise<any>;
|
|
29
|
+
}
|
|
30
|
+
export default HttpAPI;
|
|
31
|
+
//# sourceMappingURL=HttpAPI.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"HttpAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/HttpAPI.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,WAAW,CAAC;AAGnC,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF;;;;;;;;;;;;;GAaG;AACH,cAAM,OAAQ,SAAQ,UAAU;IAC9B,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEJ,OAAO,EAAE,cAAc;IASnC;;;OAGG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;CAmCvE;AAED,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import BaseObject from 'ol/Object';
|
|
2
|
+
import getUrlWithParams from '../utils/getUrlWithParams';
|
|
3
|
+
/**
|
|
4
|
+
* Common class to access to a geOps api using http.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* import { API } from 'mobility-toolbox-js/api';
|
|
8
|
+
*
|
|
9
|
+
* const api = new HttpApi({
|
|
10
|
+
* url: [yourUrl],
|
|
11
|
+
* apiKey: [yourApiKey]
|
|
12
|
+
* });
|
|
13
|
+
*
|
|
14
|
+
* @classproperty {string} url Url of the service.
|
|
15
|
+
* @classproperty {string} apiKey Api key to access the service.
|
|
16
|
+
*/
|
|
17
|
+
class HttpAPI extends BaseObject {
|
|
18
|
+
constructor(options) {
|
|
19
|
+
super();
|
|
20
|
+
/** @ignore */
|
|
21
|
+
this.url = options.url;
|
|
22
|
+
/** @ignore */
|
|
23
|
+
this.apiKey = options.apiKey;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Append the apiKey before sending the request.
|
|
27
|
+
* @ignore
|
|
28
|
+
*/
|
|
29
|
+
fetch(path, params, config) {
|
|
30
|
+
if (!this.url) {
|
|
31
|
+
// eslint-disable-next-line no-console
|
|
32
|
+
return Promise.reject(new Error(`No url defined for request to ${this.url}/${path}`));
|
|
33
|
+
}
|
|
34
|
+
if (!this.url && !this.apiKey && !/key=/.test(this.url)) {
|
|
35
|
+
// eslint-disable-next-line no-console
|
|
36
|
+
return Promise.reject(new Error(`No apiKey defined for request to ${this.url}`));
|
|
37
|
+
}
|
|
38
|
+
// Clean requets parameters, removing undefined and null values.
|
|
39
|
+
const searchParams = params || {};
|
|
40
|
+
const url = getUrlWithParams(`${this.url}${path || ''}`, Object.assign({ key: this.apiKey }, searchParams));
|
|
41
|
+
// We use toString because of TYpeScript bug that only accept a string in fetch method.
|
|
42
|
+
return fetch(url.toString(), config).then((response) => {
|
|
43
|
+
try {
|
|
44
|
+
return response.json().then((data) => {
|
|
45
|
+
if (data.error) {
|
|
46
|
+
throw new Error(data.error);
|
|
47
|
+
}
|
|
48
|
+
return data;
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
catch (err) {
|
|
52
|
+
return Promise.reject(new Error(err));
|
|
53
|
+
}
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
export default HttpAPI;
|
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
import { RealtimeTrajectoryResponse } from '../../types';
|
|
2
|
+
export declare type WebSocketAPIParameters = {
|
|
3
|
+
channel?: string;
|
|
4
|
+
args?: string | number;
|
|
5
|
+
id?: string | number;
|
|
6
|
+
};
|
|
7
|
+
export declare type WebSocketAPIMessageEventData<T> = {
|
|
8
|
+
timestamp: number;
|
|
9
|
+
source: string;
|
|
10
|
+
content: T;
|
|
11
|
+
client_reference: string | number | null;
|
|
12
|
+
};
|
|
13
|
+
export type WebSocketAPIBufferMessageEventData = WebSocketAPIMessageEventData<RealtimeTrajectoryResponse[]> & {
|
|
14
|
+
source: 'buffer';
|
|
15
|
+
};
|
|
16
|
+
export type WebSocketAPIMessageEvent = Event & {
|
|
17
|
+
data: string;
|
|
18
|
+
};
|
|
19
|
+
export interface WebSocketAPIMessageEventListener {
|
|
20
|
+
(evt: WebSocketAPIMessageEvent): void;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* This type represents a function that has been call with each feature returned by the websocket.
|
|
24
|
+
*/
|
|
25
|
+
export interface WebSocketAPIMessageCallback<T> {
|
|
26
|
+
(data: WebSocketAPIMessageEventData<T>): void;
|
|
27
|
+
}
|
|
28
|
+
export declare type WebSocketAPISubscription = {
|
|
29
|
+
params: WebSocketAPIParameters;
|
|
30
|
+
cb: WebSocketAPIMessageCallback<any>;
|
|
31
|
+
errorCb?: EventListener;
|
|
32
|
+
onMessageCb: WebSocketAPIMessageEventListener;
|
|
33
|
+
onErrorCb?: EventListener;
|
|
34
|
+
quiet: boolean;
|
|
35
|
+
};
|
|
36
|
+
export declare type WebSocketAPISubscribed = {
|
|
37
|
+
[index: string]: boolean;
|
|
38
|
+
};
|
|
39
|
+
export declare type WebSocketAPIRequest = {
|
|
40
|
+
params: WebSocketAPIParameters;
|
|
41
|
+
cb: WebSocketAPIMessageCallback<any>;
|
|
42
|
+
errorCb?: EventListener;
|
|
43
|
+
onMessageCb: WebSocketAPIMessageEventListener;
|
|
44
|
+
onErrorCb?: EventListener;
|
|
45
|
+
requestString: String;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Class used to facilitate connection to a WebSocketAPI and
|
|
49
|
+
* also to manage properly messages send to the WebSocketAPI.
|
|
50
|
+
* This class must not contain any specific implementation.
|
|
51
|
+
*/
|
|
52
|
+
declare class WebSocketAPI {
|
|
53
|
+
websocket?: WebSocket;
|
|
54
|
+
closed?: boolean;
|
|
55
|
+
closing?: boolean;
|
|
56
|
+
connecting?: boolean;
|
|
57
|
+
open?: boolean;
|
|
58
|
+
messagesOnOpen: Array<string>;
|
|
59
|
+
subscriptions: Array<WebSocketAPISubscription>;
|
|
60
|
+
subscribed: WebSocketAPISubscribed;
|
|
61
|
+
requests: Array<WebSocketAPIRequest>;
|
|
62
|
+
constructor();
|
|
63
|
+
defineProperties(): void;
|
|
64
|
+
/**
|
|
65
|
+
* Get the websocket request string.
|
|
66
|
+
*
|
|
67
|
+
* @param {string} method Request mehtod {GET, SUB}.
|
|
68
|
+
* @param {WebSocketParameters} params Request parameters.
|
|
69
|
+
* @param {string} params.channel Channel name
|
|
70
|
+
* @param {string} [params.args] Request arguments
|
|
71
|
+
* @param {Number|string} [params.id] Request identifier
|
|
72
|
+
* @return {string} request string
|
|
73
|
+
* @private
|
|
74
|
+
*/
|
|
75
|
+
static getRequestString(method: string, params?: WebSocketAPIParameters): string;
|
|
76
|
+
/**
|
|
77
|
+
* (Re)connect the websocket.
|
|
78
|
+
*
|
|
79
|
+
* @param {string} url Websocket url.
|
|
80
|
+
* @param {function} onOpen Callback called when the websocket connection is opened and before subscriptions of previous subscriptions.
|
|
81
|
+
* @private
|
|
82
|
+
*/
|
|
83
|
+
connect(url: string, onOpen?: () => void): void;
|
|
84
|
+
/**
|
|
85
|
+
* Close the websocket definitively.
|
|
86
|
+
*
|
|
87
|
+
* @private
|
|
88
|
+
*/
|
|
89
|
+
close(): void;
|
|
90
|
+
/**
|
|
91
|
+
* Sends a message to the websocket.
|
|
92
|
+
*
|
|
93
|
+
* @param {message} message Message to send.
|
|
94
|
+
* @private
|
|
95
|
+
*/
|
|
96
|
+
send(message: string): void;
|
|
97
|
+
addEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
|
|
98
|
+
removeEvents(onMessage: WebSocketAPIMessageEventListener, onError?: EventListener): void;
|
|
99
|
+
/**
|
|
100
|
+
* Listen to websocket messages.
|
|
101
|
+
*
|
|
102
|
+
* @param {WebSocketParameters} params Parameters for the websocket get request
|
|
103
|
+
* @param {function} cb callback on listen
|
|
104
|
+
* @param {function} errorCb Callback on error
|
|
105
|
+
* @return {{onMessage: function, errorCb: function}} Object with onMessage and error callbacks
|
|
106
|
+
* @private
|
|
107
|
+
*/
|
|
108
|
+
listen(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): {
|
|
109
|
+
onMessageCb: WebSocketAPIMessageEventListener;
|
|
110
|
+
onErrorCb?: EventListener;
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
* Unlisten websocket messages.
|
|
114
|
+
*
|
|
115
|
+
* @param {Object} params Parameters for the websocket get request.
|
|
116
|
+
* @param {function} cb Callback used when listen.
|
|
117
|
+
* @private
|
|
118
|
+
*/
|
|
119
|
+
unlisten(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>): void;
|
|
120
|
+
/**
|
|
121
|
+
* Sends a get request to the websocket.
|
|
122
|
+
* The callback is called only once, when the response is received or when the call returns an error.
|
|
123
|
+
*
|
|
124
|
+
* @param {Object} params Parameters for the websocket get request
|
|
125
|
+
* @param {function} onMessage callback on message event
|
|
126
|
+
* @param {function} onError Callback on error and close event
|
|
127
|
+
* @private
|
|
128
|
+
*/
|
|
129
|
+
get(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener): void;
|
|
130
|
+
/**
|
|
131
|
+
* Subscribe to a given channel.
|
|
132
|
+
*
|
|
133
|
+
* @param {Object} params Parameters for the websocket get request
|
|
134
|
+
* @param {function} cb callback on listen
|
|
135
|
+
* @param {function} errorCb Callback on error
|
|
136
|
+
* @param {boolean} quiet if false, no GET or SUB requests are send, only the callback is registered.
|
|
137
|
+
* @private
|
|
138
|
+
*/
|
|
139
|
+
subscribe(params: WebSocketAPIParameters, cb: WebSocketAPIMessageCallback<any>, errorCb?: EventListener, quiet?: boolean): void;
|
|
140
|
+
/**
|
|
141
|
+
* Unsubscribe from a channel.
|
|
142
|
+
* @param {string} source source to unsubscribe from
|
|
143
|
+
* @param {function} cb Callback function to unsubscribe. If null all subscriptions for the channel will be unsubscribed.
|
|
144
|
+
* @private
|
|
145
|
+
*/
|
|
146
|
+
unsubscribe(source: string, cb?: WebSocketAPIMessageCallback<any>): void;
|
|
147
|
+
/**
|
|
148
|
+
* After an auto reconnection we need to re-subscribe to the channels.
|
|
149
|
+
*/
|
|
150
|
+
subscribePreviousSubscriptions(): void;
|
|
151
|
+
}
|
|
152
|
+
export default WebSocketAPI;
|
|
153
|
+
//# sourceMappingURL=WebSocketAPI.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"WebSocketAPI.d.ts","sourceRoot":"","sources":["../../../src/common/api/WebSocketAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,CAAC,OAAO,MAAM,sBAAsB,GAAG;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,4BAA4B,CAAC,CAAC,IAAI;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,CAAC,CAAC;IAYX,gBAAgB,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,kCAAkC,GAAG,4BAA4B,CAC3E,0BAA0B,EAAE,CAC7B,GAAG;IACF,MAAM,EAAE,QAAQ,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,KAAK,GAAG;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,gCAAgC;IAC/C,CAAC,GAAG,EAAE,wBAAwB,GAAG,IAAI,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,CAAC;IAC5C,CAAC,IAAI,EAAE,4BAA4B,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG;IAC7C,MAAM,EAAE,sBAAsB,CAAC;IAC/B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,WAAW,EAAE,gCAAgC,CAAC;IAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,sBAAsB,GAAG;IAC3C,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,OAAO,MAAM,mBAAmB,GAAG;IACxC,MAAM,EAAE,sBAAsB,CAAC;IAC/B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,WAAW,EAAE,gCAAgC,CAAC;IAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AACF;;;;GAIG;AACH,cAAM,YAAY;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,cAAc,EAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE/B,aAAa,EAAG,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEhD,UAAU,EAAG,sBAAsB,CAAC;IAEpC,QAAQ,EAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;;IAMtC,gBAAgB;IA4DhB;;;;;;;;;;OAUG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,sBAA2B;IAO3E;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,aAAW;IAkCtC;;;;OAIG;IACH,KAAK;IAQL;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM;IAwBpB,SAAS,CACP,SAAS,EAAE,gCAAgC,EAC3C,OAAO,CAAC,EAAE,aAAa;IAYzB,YAAY,CACV,SAAS,EAAE,gCAAgC,EAC3C,OAAO,CAAC,EAAE,aAAa;IAYzB;;;;;;;;OAQG;IACH,MAAM,CACJ,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa,GACtB;QACD,WAAW,EAAE,gCAAgC,CAAC;QAC9C,SAAS,CAAC,EAAE,aAAa,CAAC;KAC3B;IA4CD;;;;;;OAMG;IACH,QAAQ,CACN,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC;IAWtC;;;;;;;;OAQG;IACH,GAAG,CACD,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa;IAiDzB;;;;;;;;OAQG;IACH,SAAS,CACP,MAAM,EAAE,sBAAsB,EAC9B,EAAE,EAAE,2BAA2B,CAAC,GAAG,CAAC,EACpC,OAAO,CAAC,EAAE,aAAa,EACvB,KAAK,UAAQ;IAwBf;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,2BAA2B,CAAC,GAAG,CAAC;IA0BjE;;OAEG;IACH,8BAA8B;CAa/B;AAED,eAAe,YAAY,CAAC"}
|