@iwpnd/valhalla-ts 1.0.0

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@iwpnd/valhalla-ts",
+  "version": "1.0.0",
+  "description": "A nodejs client and helper utilities for valhalla routing engine",
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "typings": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iwpnd/valhalla-ts.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "B. Ramser <iwpnd@posteo.de>",
+  "contributors": [],
+  "license": "MIT",
+  "keywords": [
+    "valhalla",
+    "routing",
+    "http-client"
+  ],
+  "engines": {
+    "node": ">=20.x",
+    "yarn": "^1.22.x"
+  },
+  "private": false,
+  "scripts": {
+    "prepublishOnly": "pinst --disable && yarn run build",
+    "postpublish": "pinst --enable",
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "clean": "rimraf {dist,tsconfig.tsbuildinfo,yarn-error.log,coverage}",
+    "lint": "eslint --ext .ts ./src",
+    "test": "jest --runInBand --verbose --testMatch '**/*test.ts' --coverage",
+    "format": "prettier --write src/{*.ts,**/*.ts}",
+    "u": "yarn upgrade-interactive --latest",
+    "up": "docker-compose up",
+    "down": "docker-compose down",
+    "coverage": "FILE=./coverage/lcov-report/index.html; test -f $FILE && open $FILE || echo 'no coverage yet, run yarn test'",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@iwpnd/rip-ts": "1.0.3",
+    "@types/geojson": "7946.0.14"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "18.4.4",
+    "@commitlint/config-conventional": "18.4.4",
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "9.2.6",
+    "@semantic-release/npm": "11.0.2",
+    "@semantic-release/release-notes-generator": "12.1.0",
+    "@types/chance": "1.1.6",
+    "@types/jest": "29.5.12",
+    "@typescript-eslint/eslint-plugin": "7.0.1",
+    "@typescript-eslint/parser": "7.0.1",
+    "chance": "1.1.11",
+    "conventional-changelog-conventionalcommits": "7.0.2",
+    "devmoji": "2.3.0",
+    "eslint": "8.56.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-import-resolver-typescript": "3.6.1",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-prettier": "5.1.3",
+    "husky": "9.0.10",
+    "jest": "29.7.0",
+    "lint-staged": "15.2.2",
+    "pinst": "3.0.0",
+    "prettier": "3.2.5",
+    "rimraf": "5.0.5",
+    "semantic-release": "23.0.2",
+    "ts-jest": "29.1.2",
+    "typescript": "5.3.3"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}

package/readme.md

@@ -0,0 +1,81 @@
+<br />
+<div align="center">
+  <h3 align="center">valhalla-ts</h3>
+
+  <p align="center">
+    valhalla api client
+    <br />
+    <a href="https://github.com/ipwnd/valhalla-ts/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/iwpnd/valhalla-ts/issues">Request Feature</a>
+  </p>
+</div>
+
+## About The Project
+
+Easy to use, fully typed http client for [valhalla routing service](https://github.com/valhalla/valhalla).
+
+### Installation
+
+```sh
+yarn install @iwpnd/valhalla-ts
+
+# or
+
+npm install @iwpnd/valhalla-ts
+```
+
+## Usage
+
+```typescript
+import { Valhalla } from '@iwpnd/valhalla-ts';
+
+const valhalla = new Valhalla('https://localhost:8002');
+
+const route = await valhalla.route({
+    locations: [
+        { lat: 52.25, lon: 13.37 },
+        { lat: 52.25, lon: 13.36 },
+    ],
+    costing: 'bicycle',
+});
+```
+
+## Roadmap
+
+-   [x] valhalla client
+-   [x] fully typed
+-   [ ] finish documentation
+-   [ ] request helper
+-   [ ] load balancing
+
+## Contributing
+
+Contributions are neither expected nor encouraged. If you for whatever
+reason you want to contribute here, create an issue describing your problem first.
+Unsolicited PRs are going to be deleted straight up.
+
+If we evaluated that you're in the right repository,
+are of a clear state of mind and have cause to do what you wanna do, please
+follow the steps below.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feat/my-amazing-feature`)
+3. Commit your Changes (`git commit -m 'feat: some amazing feature'`)
+4. Push to the Branch (`git push origin feat/my-amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+## Contact
+
+Benjamin Ramser - [@iwpnd](https://twitter.com/iwpnd) - iwpnd@posteo.com
+
+Project Link: [https://github.com/iwpnd/valhalla-ts](https://github.com/iwpnd/valhalla-ts)
+
+## Acknowledgments
+
+-   [valhalla](https://github.com/valhalla/valhalla)
+-   [gis-ops](https://github.com/gis-ops/valhalla)