Skip to content

Commit 7d448ef

Browse files
author
Moussa Iskounene
authored
Merge pull request #16 from tictactrip/docs/api
docs(api): Describe API and add new field called address to StopGroup
2 parents 3d58d1c + 82e6647 commit 7d448ef

33 files changed

+753
-56
lines changed

‎README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,34 @@
77

88
## Description
99

10-
This repository offers powerful JSON file manipulation methods for Ground places use.
10+
This package offers the possibility to precisely manipulate a set of places, change their name, give them a new location, merge them together, etc.
11+
12+
The main goal is to easily manage groups of places by creating **Groups** or **Clusters** (Groups of groups) around points of interest that you have defined.
13+
14+
To ensure the proper usage of the package, the file of places provided must respect an specific interface that you can find [here](https://github.com/tictactrip/ground-place-sdk/blob/master/docs/ground_places_file_scheme.md).
1115

1216
## Install
1317

1418
```
1519
yarn add @tictactrip/ground-place-sdk
1620
```
1721

22+
## API
23+
24+
A documentation of the API is available [here](https://github.com/tictactrip/ground-place-sdk/blob/master/docs/api.md).
25+
1826
## How to use it?
1927

28+
Here is an usage example of the package that allows you to add and modify your ground places file.
29+
2030
```ts
2131
import { GroundPlacesController, GroundPlacesFile } from '@tictactrip/ground-places-sdk';
2232
import * as GroundPlacesFileJSON from './GroundPlacesFile.json';
2333

2434
// Create new instance of the GroundPlacesController
2535
const groundPlacesService: GroundPlacesController = new GroundPlacesController();
2636

27-
// Initialize the instance with your JSON file
37+
// Initialize the package with your JSON file
2838
groundPlacesService.init(GroundPlacesFileJSON as GroundPlacesFile);
2939

3040
// And now you can make manipulation on this file with all methods provided by the package
@@ -33,10 +43,10 @@ groundPlacesService.mergeStopGroup('g|FRstrasbou@u0tkru', 'g|FRststbi__@u0tkxd')
3343
groundPlacesService.deleteStopGroup('g|FRstrasbou@u0tkru');
3444
...
3545

36-
// You can get all the Ground places
37-
groundPlacesService.getGroundPlaces();
46+
// After your changes, you can retrieve all your Ground places modified in an JSON file like the input one.
47+
groundPlacesService.getGroundPlacesFile();
3848

39-
// And also get the history of all actions performed on the Ground places
49+
// You can also get the history of all actions performed on the Ground places
4050
groundPlacesService.getGroundPlacesActionHistory();
4151
```
4252

‎__tests__/groundplaces/addStopGroupToStopCluster.spec.ts

+5
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ describe('#addStopGroupToStopCluster', () => {
2727
{
2828
gpuid: 'g|FRststbi__@u0tkxd',
2929
childs: [],
30+
address: '99999 Rue du Triage, 67800 Bischheim, France',
3031
name: 'Strasbourg, Strasbourg - Bischheim',
3132
longitude: 7.719863,
3233
serviced: 'False',
@@ -51,6 +52,7 @@ describe('#addStopGroupToStopCluster', () => {
5152
id: '23',
5253
},
5354
],
55+
address: '22 Place de la Gare, 67000 Strasbourg, France',
5456
name: 'Strasbourg',
5557
longitude: 7.73417,
5658
serviced: 'False',
@@ -75,6 +77,7 @@ describe('#addStopGroupToStopCluster', () => {
7577
id: 'FRBUK',
7678
},
7779
],
80+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
7881
name: 'Strasbourg Roethig',
7982
longitude: 7.704,
8083
serviced: 'False',
@@ -113,6 +116,7 @@ describe('#addStopGroupToStopCluster', () => {
113116
id: '19518',
114117
},
115118
],
119+
address: '6 Avenue de Bourgogne, 54500 Vandœuvre-lès-Nancy, France',
116120
name: 'Nancy, Vandoeuvre-les-Nancy',
117121
longitude: 6.144364,
118122
serviced: 'True',
@@ -140,6 +144,7 @@ describe('#addStopGroupToStopCluster', () => {
140144
{
141145
gpuid: 'g|FRnancy___@u0skux',
142146
childs: [],
147+
address: 'Gare de Nancy-Ville, Avenue Foch, 54100 Nancy, France',
143148
name: 'Nancy',
144149
longitude: 6.1744,
145150
serviced: 'True',

‎__tests__/groundplaces/applyGroundPlacesActionHistory.spec.ts

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ describe('#applyGroundPlacesActionHistory', () => {
4343
id: '19528',
4444
},
4545
],
46+
address: 'Strasbourg, France',
4647
latitude: 49,
4748
longitude: 7.8,
4849
name: 'Strasbourg, Grand-Nord',

‎__tests__/groundplaces/autocomplete.spec.ts

+11
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ describe('#autocomplete', () => {
2727
{
2828
gpuid: 'g|FRststbi__@u0tkxd',
2929
childs: [],
30+
address: 'Route Forestière de la Mattstahl, 67500 Haguenau, France',
3031
name: 'Strasbourg, Strasbourg - Bischheim',
3132
longitude: 7.719863,
3233
serviced: 'False',
@@ -51,6 +52,7 @@ describe('#autocomplete', () => {
5152
id: '23',
5253
},
5354
],
55+
address: '22 Place de la Gare, 67000 Strasbourg, France',
5456
name: 'Strasbourg',
5557
longitude: 7.73417,
5658
serviced: 'False',
@@ -76,6 +78,7 @@ describe('#autocomplete', () => {
7678
},
7779
],
7880
name: 'Strasbourg Roethig',
81+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
7982
longitude: 7.704,
8083
serviced: 'False',
8184
has_been_modified: false,
@@ -111,6 +114,7 @@ describe('#autocomplete', () => {
111114
{
112115
gpuid: 'g|FRststbi__@u0tkxd',
113116
childs: [],
117+
address: 'Route Forestière de la Mattstahl, 67500 Haguenau, France',
114118
name: 'Strasbourg, Strasbourg - Bischheim',
115119
longitude: 7.719863,
116120
serviced: 'False',
@@ -135,6 +139,7 @@ describe('#autocomplete', () => {
135139
id: '23',
136140
},
137141
],
142+
address: '22 Place de la Gare, 67000 Strasbourg, France',
138143
name: 'Strasbourg',
139144
longitude: 7.73417,
140145
serviced: 'False',
@@ -159,6 +164,7 @@ describe('#autocomplete', () => {
159164
id: 'FRBUK',
160165
},
161166
],
167+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
162168
name: 'Strasbourg Roethig',
163169
longitude: 7.704,
164170
serviced: 'False',
@@ -202,6 +208,7 @@ describe('#autocomplete', () => {
202208
{
203209
gpuid: 'g|FRststbi__@u0tkxd',
204210
childs: [],
211+
address: 'Route Forestière de la Mattstahl, 67500 Haguenau, France',
205212
name: 'Strasbourg, Strasbourg - Bischheim',
206213
longitude: 7.719863,
207214
serviced: 'False',
@@ -236,6 +243,7 @@ describe('#autocomplete', () => {
236243
{
237244
gpuid: 'g|FRststbi__@u0tkxd',
238245
childs: [],
246+
address: 'Route Forestière de la Mattstahl, 67500 Haguenau, France',
239247
name: 'Strasbourg, Strasbourg - Bischheim',
240248
longitude: 7.719863,
241249
serviced: 'False',
@@ -302,6 +310,7 @@ describe('#autocomplete', () => {
302310
{
303311
gpuid: 'g|FRststbi__@u0tkxd',
304312
childs: [],
313+
address: 'Route Forestière de la Mattstahl, 67500 Haguenau, France',
305314
name: 'Strasbourg, Strasbourg - Bischheim',
306315
longitude: 7.719863,
307316
serviced: 'False',
@@ -326,6 +335,7 @@ describe('#autocomplete', () => {
326335
id: '23',
327336
},
328337
],
338+
address: '22 Place de la Gare, 67000 Strasbourg, France',
329339
name: 'Strasbourg',
330340
longitude: 7.73417,
331341
serviced: 'False',
@@ -350,6 +360,7 @@ describe('#autocomplete', () => {
350360
id: 'FRBUK',
351361
},
352362
],
363+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
353364
name: 'Strasbourg Roethig',
354365
longitude: 7.704,
355366
serviced: 'False',

‎__tests__/groundplaces/createStopCluster.spec.ts

+3
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ describe('#createStopCluster', () => {
4747
id: '19528',
4848
},
4949
],
50+
address: '99999 Rue du Triage, 67800 Bischheim, France',
5051
name: 'Strasbourg, Strasbourg - Bischheim',
5152
longitude: 7.719863,
5253
serviced: 'True',
@@ -66,6 +67,7 @@ describe('#createStopCluster', () => {
6667
longitude: 7.6275127,
6768
latitude: 48.5857122,
6869
type: 'cluster',
70+
unique_name: null,
6971
},
7072
]);
7173
expect(groundPlacesService.getGroundPlacesActionHistory()).toStrictEqual([
@@ -74,6 +76,7 @@ describe('#createStopCluster', () => {
7476
type: 'createStopCluster',
7577
params: {
7678
countryCode: 'fr',
79+
gpuid: 'c|FRstrawolf@u0tkm',
7780
name: 'Strasbourg - Wolfisheim',
7881
latitude: 48.5857122,
7982
longitude: 7.6275127,

‎__tests__/groundplaces/createStopGroup.spec.ts

+5
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ describe('#createStopGroup', () => {
1313
name: 'Strasbourg - Wolfisheim',
1414
latitude: 48.5857122,
1515
longitude: 7.6275127,
16+
address: 'Strasbourg, France',
1617
};
1718
const fromStopGroupGpuid = 'g|FRststbi__@u0tkxd';
1819
const segmentProviderStopId = '19528';
@@ -36,6 +37,7 @@ describe('#createStopGroup', () => {
3637
},
3738
{
3839
gpuid: 'g|FRststbi__@u0tkxd',
40+
address: '99999 Rue du Triage, 67800 Bischheim, France',
3941
name: 'Strasbourg, Strasbourg - Bischheim',
4042
longitude: 7.719863,
4143
serviced: 'True',
@@ -49,6 +51,7 @@ describe('#createStopGroup', () => {
4951
},
5052
{
5153
gpuid: 'g|FRstrawolf@u0tkms',
54+
address: 'Strasbourg, France',
5255
name: 'Strasbourg - Wolfisheim',
5356
longitude: 7.6275127,
5457
latitude: 48.5857122,
@@ -76,9 +79,11 @@ describe('#createStopGroup', () => {
7679
params: {
7780
segmentProviderStopId: '19528',
7881
countryCode: 'fr',
82+
gpuid: 'g|FRstrawolf@u0tkms',
7983
name: 'Strasbourg - Wolfisheim',
8084
latitude: 48.5857122,
8185
longitude: 7.6275127,
86+
address: 'Strasbourg, France',
8287
},
8388
},
8489
},

‎__tests__/groundplaces/deleteStopCluster.spec.ts

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ describe('#deleteStopCluster', () => {
2727
{
2828
gpuid: 'g|FRststbi__@u0tkxd',
2929
childs: [],
30+
address: 'Route Forestière de la Mattstahl, 67500 Haguenau, France',
3031
name: 'Strasbourg, Strasbourg - Bischheim',
3132
longitude: 7.719863,
3233
serviced: 'False',
@@ -39,6 +40,7 @@ describe('#deleteStopCluster', () => {
3940
},
4041
{
4142
gpuid: 'g|FRstrasbou@u0tkru',
43+
address: '22 Place de la Gare, 67000 Strasbourg, France',
4244
childs: [
4345
{
4446
unique_name: null,
@@ -63,6 +65,7 @@ describe('#deleteStopCluster', () => {
6365
},
6466
{
6567
gpuid: 'g|FRstraroet@u0tkr3',
68+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
6669
childs: [
6770
{
6871
unique_name: null,

‎__tests__/groundplaces/deleteStopGroup.spec.ts

+2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ describe('#deleteStopGroup', () => {
3838
id: '23',
3939
},
4040
],
41+
address: '22 Place de la Gare, 67000 Strasbourg, France',
4142
name: 'Strasbourg',
4243
longitude: 7.73417,
4344
serviced: 'False',
@@ -62,6 +63,7 @@ describe('#deleteStopGroup', () => {
6263
id: 'FRBUK',
6364
},
6465
],
66+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
6567
name: 'Strasbourg Roethig',
6668
longitude: 7.704,
6769
serviced: 'False',

‎__tests__/groundplaces/getGroundPlacesFile.spec.ts

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ describe('#getGroundPlacesFile', () => {
3535
id: '19528',
3636
},
3737
],
38+
address: '99999 Rue du Triage, 67800 Bischheim, France',
3839
name: 'Strasbourg, Strasbourg - Bischheim',
3940
longitude: 7.719863,
4041
serviced: 'True',

‎__tests__/groundplaces/mergeStopCluster.spec.ts

+5
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ describe('#mergeStopCluster', () => {
3131
{
3232
gpuid: 'g|FRststbi__@u0tkxd',
3333
childs: [],
34+
address: '99999 Rue du Triage, 67800 Bischheim, France',
3435
name: 'Strasbourg, Strasbourg - Bischheim',
3536
longitude: 7.719863,
3637
serviced: 'False',
@@ -55,6 +56,7 @@ describe('#mergeStopCluster', () => {
5556
id: '23',
5657
},
5758
],
59+
address: '22 Place de la Gare, 67000 Strasbourg, France',
5860
name: 'Strasbourg',
5961
longitude: 7.73417,
6062
serviced: 'False',
@@ -79,6 +81,7 @@ describe('#mergeStopCluster', () => {
7981
id: 'FRBUK',
8082
},
8183
],
84+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
8285
name: 'Strasbourg Roethig',
8386
longitude: 7.704,
8487
serviced: 'False',
@@ -117,6 +120,7 @@ describe('#mergeStopCluster', () => {
117120
id: '19518',
118121
},
119122
],
123+
address: '6 Avenue de Bourgogne, 54500 Vandœuvre-lès-Nancy, France',
120124
name: 'Nancy, Vandoeuvre-les-Nancy',
121125
longitude: 6.144364,
122126
serviced: 'True',
@@ -144,6 +148,7 @@ describe('#mergeStopCluster', () => {
144148
{
145149
gpuid: 'g|FRnancy___@u0skux',
146150
childs: [],
151+
address: 'Gare de Nancy-Ville, Avenue Foch, 54100 Nancy, France',
147152
name: 'Nancy',
148153
longitude: 6.1744,
149154
serviced: 'True',

‎__tests__/groundplaces/mergeStopGroup.spec.ts

+5
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ describe('#mergeStopGroup', () => {
4242
id: '23',
4343
},
4444
],
45+
address: '99999 Rue du Triage, 67800 Bischheim, France',
4546
name: 'Strasbourg, Strasbourg - Bischheim',
4647
longitude: 7.719863,
4748
serviced: 'False',
@@ -55,6 +56,7 @@ describe('#mergeStopGroup', () => {
5556
{
5657
gpuid: 'g|FRstrasbou@u0tkru',
5758
childs: [],
59+
address: '22 Place de la Gare, 67000 Strasbourg, France',
5860
name: 'Strasbourg',
5961
longitude: 7.73417,
6062
serviced: 'False',
@@ -79,6 +81,7 @@ describe('#mergeStopGroup', () => {
7981
id: 'FRBUK',
8082
},
8183
],
84+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
8285
name: 'Strasbourg Roethig',
8386
longitude: 7.704,
8487
serviced: 'False',
@@ -117,6 +120,7 @@ describe('#mergeStopGroup', () => {
117120
id: '19518',
118121
},
119122
],
123+
address: '6 Avenue de Bourgogne, 54500 Vandœuvre-lès-Nancy, France',
120124
name: 'Nancy, Vandoeuvre-les-Nancy',
121125
longitude: 6.144364,
122126
serviced: 'True',
@@ -144,6 +148,7 @@ describe('#mergeStopGroup', () => {
144148
{
145149
gpuid: 'g|FRnancy___@u0skux',
146150
childs: [],
151+
address: 'Gare de Nancy-Ville, Avenue Foch, 54100 Nancy, France',
147152
name: 'Nancy',
148153
longitude: 6.1744,
149154
serviced: 'True',

‎__tests__/groundplaces/moveSegmentProviderStop.spec.ts

+3
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ describe('#moveSegmentProviderStop', () => {
3333
{
3434
gpuid: 'g|FRststbi__@u0tkxd',
3535
childs: [],
36+
address: 'Route Forestière de la Mattstahl, 67500 Haguenau, France',
3637
name: 'Strasbourg, Strasbourg - Bischheim',
3738
longitude: 7.719863,
3839
serviced: 'False',
@@ -67,6 +68,7 @@ describe('#moveSegmentProviderStop', () => {
6768
id: 'FRBUK',
6869
},
6970
],
71+
address: '22 Place de la Gare, 67000 Strasbourg, France',
7072
name: 'Strasbourg',
7173
longitude: 7.73417,
7274
serviced: 'False',
@@ -80,6 +82,7 @@ describe('#moveSegmentProviderStop', () => {
8082
{
8183
gpuid: 'g|FRstraroet@u0tkr3',
8284
childs: [],
85+
address: '1 Quai du Roethig, 67000 Strasbourg, France',
8386
name: 'Strasbourg Roethig',
8487
longitude: 7.704,
8588
serviced: 'False',

0 commit comments

Comments
 (0)