ojp-sdk-v1
v0.18.6
Published
OJP (Open Journey Planner) Javascript SDK
Maintainers
Readme
OJP Javascript SDK
Note 2.Apr 2025: The main branch of this repo is freezed for development / releases, see below table for reference
Current Development Status
Javascript SDK branches
| OJP | Branch | NPM | Demo App | Description |
|-|-|-|-|-|
| v1.0 | ojp-js#ojp-v1 | ojp-sdk-v1 | PRODBETA v1 | original SDK, receives bug fixes or critical features needed for OJP 1.0 |
| v2.0 | ojp-js#ojp-v2 | Github branch | BETA v2 | original SDK, receives all features until ojp-sdk-next branch is merged to main |
| v2.0 | ojp-js#ojp-sdk-next | ojp-sdk-next - temporarely, long-term will be published under ojp-sdk | under development | new SDK code with models derived from XSD schema, this will be the main development reference for OJP JS SDK |
Code / Demo App Implementation
| Code Place | LIR | SER | TR | TIR | FR | TRR | Comments |
| - | - | - | - | - | - | - | - |
| ojp-js (legacy SDK) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | - | - | TRR is only available for OJP v2.0 |
| ojp-sdk-next (new SDK) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | |
| DemoApp Beta | legacy | legacy | legacy | ojp-sdk-next | ojp-sdk-next | ojp-sdk-next | legacy is the old SDK (OJP v1 and v2, see above) |
- LIR - LocationInformationRequest
- SER - StopEventRequest
- TR - TripRequest
- TIR - TripInfoRequest
- FR - FareRequest
- TRR - TripRefineRequest
OJP Javascript SDK is a Javascript/Typescript package used for communication with OJP APIs.
See Reference and examples for usage.
Resources
- OJP Demo App: https://opentdatach.github.io/ojp-demo-app/ - web application this SDK
- CHANGELOG for latest changes
- npm
ojp-sdkpackage: https://www.npmjs.com/package/ojp-sdk
Install
- include the
ojp-sdk-v1package in the./package.jsondependencies of your project
"dependencies": {
"ojp-sdk-v1": "0.18.6"
}Usage
- update project dependencies
$ npm install- include OJP SDK in the Typescript / Javascript code
import * as OJP from 'ojp-sdk-v1'- for more details check:
- this repo reference
- this repo examples
- OJP Demo App source code
License
The project is released under a MIT license.
Copyright (c) 2021 - 2025 Open Data Platform Mobility Switzerland - opentransportdata.swiss.
