@iwpnd/valhalla-ts 1.0.0 → 1.0.1

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 (6) hide show
  1. package/dist/valhalla.d.ts +1 -1
  2. package/dist/valhalla.d.ts.map +1 -1
  3. package/dist/valhalla.js +1 -1
  4. package/dist/valhalla.js.map +1 -1
  5. package/package.json +4 -4
  6. package/readme.md +57 -3
package/dist/valhalla.d.ts CHANGED
@@ -56,7 +56,7 @@ export declare class Valhalla extends RestClient {
56
56
  *
57
57
  * @returns {@link MapMatchingTraceRouteResponse}
58
58
  */
59
- mapmatching<T extends Leg>(query: MapMatchingShapeRequest | MapMatchingPolylineRequest): Promise<MapMatchingTraceRouteResponse<T>>;
59
+ traceRoute<T extends Leg>(query: MapMatchingShapeRequest | MapMatchingPolylineRequest): Promise<MapMatchingTraceRouteResponse<T>>;
60
60
  /**
61
61
  *
62
62
  * Get the valhalla server status
package/dist/valhalla.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"valhalla.d.ts","sourceRoot":"","sources":["../src/valhalla.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3D,OAAO,EACH,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,oBAAoB,EACpB,GAAG,EACH,0BAA0B,EAC1B,uBAAuB,EACvB,6BAA6B,EAC7B,qBAAqB,EACrB,cAAc,EACd,IAAI,EACJ,YAAY,EACZ,sBAAsB,EACzB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAS,SAAQ,UAAU;gBACxB,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAUlD;;;;;;;;;;;;OAYG;IACG,KAAK,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,EAC3B,KAAK,EAAE,sBAAsB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAUnB;;;;;;;;;;;;OAYG;IACG,cAAc,CAAC,CAAC,SAAS,GAAG,EAC9B,KAAK,EAAE,qBAAqB,GAC7B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAS3B;;;;;;;;;;;OAWG;IACG,SAAS,CACX,KAAK,EAAE,oBAAoB,GAAG,wBAAwB,GACvD,OAAO,CAAC,iBAAiB,CAAC;IAS7B;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,CAAC,SAAS,GAAG,EAC3B,KAAK,EAAE,uBAAuB,GAAG,0BAA0B,GAC5D,OAAO,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC;IAY5C;;;;;;;;;;;;;OAaG;IACG,MAAM,CACR,OAAO,UAAQ,GAChB,OAAO,CAAC,cAAc,GAAG,sBAAsB,CAAC;CAMtD"}
1
+ {"version":3,"file":"valhalla.d.ts","sourceRoot":"","sources":["../src/valhalla.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3D,OAAO,EACH,sBAAsB,EACtB,wBAAwB,EACxB,iBAAiB,EACjB,oBAAoB,EACpB,GAAG,EACH,0BAA0B,EAC1B,uBAAuB,EACvB,6BAA6B,EAC7B,qBAAqB,EACrB,cAAc,EACd,IAAI,EACJ,YAAY,EACZ,sBAAsB,EACzB,MAAM,SAAS,CAAC;AAEjB,qBAAa,QAAS,SAAQ,UAAU;gBACxB,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc;IAUlD;;;;;;;;;;;;OAYG;IACG,KAAK,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,EAC3B,KAAK,EAAE,sBAAsB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAUnB;;;;;;;;;;;;OAYG;IACG,cAAc,CAAC,CAAC,SAAS,GAAG,EAC9B,KAAK,EAAE,qBAAqB,GAC7B,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAS3B;;;;;;;;;;;OAWG;IACG,SAAS,CACX,KAAK,EAAE,oBAAoB,GAAG,wBAAwB,GACvD,OAAO,CAAC,iBAAiB,CAAC;IAS7B;;;;;;;;;;;;OAYG;IACG,UAAU,CAAC,CAAC,SAAS,GAAG,EAC1B,KAAK,EAAE,uBAAuB,GAAG,0BAA0B,GAC5D,OAAO,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC;IAY5C;;;;;;;;;;;;;OAaG;IACG,MAAM,CACR,OAAO,UAAQ,GAChB,OAAO,CAAC,cAAc,GAAG,sBAAsB,CAAC;CAMtD"}
package/dist/valhalla.js CHANGED
@@ -85,7 +85,7 @@ class Valhalla extends rip_ts_1.RestClient {
85
85
  *
86
86
  * @returns {@link MapMatchingTraceRouteResponse}
87
87
  */
88
- async mapmatching(query) {
88
+ async traceRoute(query) {
89
89
  const options = {
90
90
  method: 'POST',
91
91
  body: query,
package/dist/valhalla.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"valhalla.js","sourceRoot":"","sources":["../src/valhalla.ts"],"names":[],"mappings":";;;AAAA,0CAA2D;AAiB3D,MAAa,QAAS,SAAQ,mBAAU;IACpC,YAAY,GAAY,EAAE,OAAwB;QAC9C,KAAK,CAAC,GAAG,IAAK,OAAO,CAAC,GAAG,CAAC,YAAuB,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE;gBACL,MAAM,EAAE,kBAAkB;gBAC1B,GAAG,OAAO,EAAE,OAAO;aACtB;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACP,KAA6B;QAE7B,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAkB,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,cAAc,CAChB,KAA4B;QAE5B,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAkB,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CACX,KAAsD;QAEtD,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAoB,YAAY,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CACb,KAA2D;QAE3D,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CACf,cAAc,EACd,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACR,OAAO,GAAG,KAAK;QAEf,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAC3B,MAAM,EAAE,KAAK;YACb,GAAG,CAAC,OAAO,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;SAClE,CAAC,CAAC;IACP,CAAC;CACJ;AApID,4BAoIC"}
1
+ {"version":3,"file":"valhalla.js","sourceRoot":"","sources":["../src/valhalla.ts"],"names":[],"mappings":";;;AAAA,0CAA2D;AAiB3D,MAAa,QAAS,SAAQ,mBAAU;IACpC,YAAY,GAAY,EAAE,OAAwB;QAC9C,KAAK,CAAC,GAAG,IAAK,OAAO,CAAC,GAAG,CAAC,YAAuB,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE;gBACL,MAAM,EAAE,kBAAkB;gBAC1B,GAAG,OAAO,EAAE,OAAO;aACtB;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,KAAK,CACP,KAA6B;QAE7B,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAkB,QAAQ,EAAE,OAAO,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,cAAc,CAChB,KAA4B;QAE5B,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAkB,kBAAkB,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,SAAS,CACX,KAAsD;QAEtD,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CAAoB,YAAY,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,CACZ,KAA2D;QAE3D,MAAM,OAAO,GAAG;YACZ,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,IAAI,CAAC,OAAO,CACf,cAAc,EACd,OAAO,CACV,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CACR,OAAO,GAAG,KAAK;QAEf,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAC3B,MAAM,EAAE,KAAK;YACb,GAAG,CAAC,OAAO,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;SAClE,CAAC,CAAC;IACP,CAAC;CACJ;AApID,4BAoIC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@iwpnd/valhalla-ts",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "A nodejs client and helper utilities for valhalla routing engine",
5
5
  "main": "dist/index.js",
6
6
  "files": [
@@ -56,8 +56,8 @@
56
56
  "@semantic-release/release-notes-generator": "12.1.0",
57
57
  "@types/chance": "1.1.6",
58
58
  "@types/jest": "29.5.12",
59
- "@typescript-eslint/eslint-plugin": "7.0.1",
60
- "@typescript-eslint/parser": "7.0.1",
59
+ "@typescript-eslint/eslint-plugin": "7.0.2",
60
+ "@typescript-eslint/parser": "7.0.2",
61
61
  "chance": "1.1.11",
62
62
  "conventional-changelog-conventionalcommits": "7.0.2",
63
63
  "devmoji": "2.3.0",
@@ -67,7 +67,7 @@
67
67
  "eslint-import-resolver-typescript": "3.6.1",
68
68
  "eslint-plugin-import": "2.29.1",
69
69
  "eslint-plugin-prettier": "5.1.3",
70
- "husky": "9.0.10",
70
+ "husky": "9.0.11",
71
71
  "jest": "29.7.0",
72
72
  "lint-staged": "15.2.2",
73
73
  "pinst": "3.0.0",
package/readme.md CHANGED
@@ -27,17 +27,71 @@ npm install @iwpnd/valhalla-ts
27
27
 
28
28
  ## Usage
29
29
 
30
+ Either use your own valhalla instances url, pull
31
+ an image of valhalla that includes Andorra routing tiles.
32
+
33
+ ```bash
34
+ docker run --rm -p 8002:8002 ghcr.io/iwpnd/valhalla-andorra:latest
35
+ ```
36
+
30
37
  ```typescript
31
38
  import { Valhalla } from '@iwpnd/valhalla-ts';
32
39
 
33
40
  const valhalla = new Valhalla('https://localhost:8002');
34
41
 
42
+ /*
43
+ * Request a route for a specific modality
44
+ * traversing each of the provided `locations`
45
+ * in order.
46
+ */
35
47
  const route = await valhalla.route({
36
48
  locations: [
37
- { lat: 52.25, lon: 13.37 },
38
- { lat: 52.25, lon: 13.36 },
49
+ { lat: 42.505497, lon: 1.528883 },
50
+ { lat: 42.51276, lon: 1.53527 },
51
+ ],
52
+ costing: 'bicycle',
53
+ });
54
+
55
+ /*
56
+ * Request a route for a specific modality
57
+ * traversing each of the provided `locations`
58
+ * in an optimized order.
59
+ */
60
+ const optimizedRoute = await valhalla.optimizedRoute({
61
+ locations: [
62
+ { lat: 42.505497, lon: 1.528883 },
63
+ { lat: 42.505497, lon: 1.528884 },
64
+ { lat: 42.51276, lon: 1.53527 },
65
+ ],
66
+ costing: 'auto',
67
+ });
68
+
69
+ /*
70
+ * Request to match a set of input coordinates to
71
+ * a corresponding node on the road network.
72
+ */
73
+ const traceRoute = await valhalla.traceRoute({
74
+ shape: [
75
+ { lat: 42.505497, lon: 1.528883 },
76
+ { lat: 42.51276, lon: 1.53527 },
39
77
  ],
78
+ shape_match: 'map_snap',
79
+ costing: 'taxi',
80
+ });
81
+
82
+ /*
83
+ * Request to generate isochrones around a
84
+ * request location.
85
+ */
86
+ const isochrone = await valhalla.isochrone({
87
+ locations: [{ lat: 42.505497, lon: 1.528883 }],
40
88
  costing: 'bicycle',
89
+ contours: [
90
+ { time: 5, color: '2596be' },
91
+ { time: 10, color: 'be2596' },
92
+ { time: 15, color: '96be25' },
93
+ ],
94
+ polygons: true,
41
95
  });
42
96
  ```
43
97
 
@@ -45,7 +99,7 @@ const route = await valhalla.route({
45
99
 
46
100
  - [x] valhalla client
47
101
  - [x] fully typed
48
- - [ ] finish documentation
102
+ - [x] add usage section to docs
49
103
  - [ ] request helper
50
104
  - [ ] load balancing
51
105