ground-place-sdk

Description

This package offers the possibility to precisely manipulate a set of places, change their name, give them a new location, merge them together, etc.

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.

To ensure the proper usage of the package, the file of places provided must respect an specific interface that you can find here.

Install

yarn add @tictactrip/ground-place-sdk

API

A documentation of the API is available here.

How to use it?

Here is an usage example of the package that allows you to add and modify your ground places file.

import { GroundPlacesController, GroundPlacesFile } from '@tictactrip/ground-places-sdk';
import * as GroundPlacesFileJSON from './GroundPlacesFile.json';

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

// Initialize the package with your JSON file
groundPlacesService.init(GroundPlacesFileJSON as GroundPlacesFile);

// And now you can make manipulation on this file with all methods provided by the package
groundPlacesService.updateStopCluster('c|FRstrasbou@u0ts2', { name: 'Strasbourg, Est, France' });
groundPlacesService.mergeStopGroup('g|FRstrasbou@u0tkru', 'g|FRststbi__@u0tkxd');
groundPlacesService.deleteStopGroup('g|FRstrasbou@u0tkru');
...

// After your changes, you can retrieve all your Ground places modified in an JSON file like the input one.
groundPlacesService.getGroundPlacesFile();

// You can also get the history of all actions performed on the Ground places
groundPlacesService.getGroundPlacesActionHistory();

Scripts

Run using yarn run <script> command.

clean       - Remove temporarily folders.
build       - Compile source files.
build:watch - Interactive watch mode, compile sources on change.
lint        - Lint source files.
lint:fix    - Fix lint source files.
test        - Runs all tests with coverage.
test:watch  - Interactive watch mode, runs tests on change.

License

GPL-3.0 © Tictactrip