@veeroute/[email protected]

Veeroute Monitor API. # Description Server part of the Veeroute Monitor. ## Trip status model | Status Code | Description | Expected Action | |:------------|:-----------------------------------------------------|:---------------------------------------------| | FREE | Trip created, crew not assigned | Operator will assign crew | | ASSIGNED | Crew assigned | Operator will send task to crew | | SENT | Task sent to crew | Crew will acknowledge receipt | | RECEIVED | Crew received trip (fact TRIP_RECEIVED) | Crew will accept or reject trip | | CONFIRMED | Crew agreed to operate trip (fact TRIP_CONFIRMED) | Crew will begin operating trip | | REJECTED | Crew refused to operate trip (fact TRIP_REJECTED) | Operator will assign new crew or cancel trip | | EXECUTING | The crew is executing a trip (fact TRIP_EXECUTED) | The crew will complete all tasks | | FINISHED | The trip is completed - no work remains for the trip | This is the final status | | CANCELLED | The trip has been canceled by the operator | This is the final status | Status transitions: Operator: FREE → ASSIGNED → SENT Crew: RECEIVED → CONFIRMED / REJECTED → EXECUTING Conditions: EXECUTING → FINISHED / CANCELLED ## Facts Depending on the fact type, in addition to the main mandatory fields (described in the API), additional mandatory fields appear: | Fact designation | order_key | demand_key | performer_key | location_key | attributes | |:-----------------|:----------|:-----------|:--------------|:-------------|:-----------| | NEW_LOCATION | | | + | + | | | ORDER_DONE | + | | | | | | DEMAND_START | | + | | | | | DEMAND_DONE | | + | | | | | TRIP_RECEIVED | | | | | | | TRIP_CONFIRMED | | | | | | | TRIP_REJECTED | | | | | | | TRIP_EXECUTED | | | | | | ## Entity relationship diagram

The version of the OpenAPI document: 7.30.3153

Building

To install the required dependencies and to build the typescript sources run:

npm install
npm run build

Publishing

First build the package then run npm publish dist (don't forget to specify the dist folder!)

Consuming

Navigate to the folder of your consuming project and run one of next commands.

published:

npm install @veeroute/[email protected] --save

without publishing (not recommended):

npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save

It's important to take the tgz file, otherwise you'll get trouble with links on windows

using npm link:

In PATH_TO_GENERATED_PACKAGE/dist:

npm link

In your project:

npm link @veeroute/lss-monitor-angular

Note for Windows users: The Angular CLI has troubles to use linked npm packages. Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround. Published packages are not effected by this issue.

General usage

In your Angular project:

import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@veeroute/lss-monitor-angular';

export const appConfig: ApplicationConfig = {
    providers: [
        // ...
        provideHttpClient(),
        provideApi()
    ],
};

NOTE If you're still using AppModule and haven't migrated yet, you can still import an Angular module:

import { LssMonitorApiModule } from '@veeroute/lss-monitor-angular';

If different from the generated base path, during app bootstrap, you can provide the base path to your service.

import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@veeroute/lss-monitor-angular';

export const appConfig: ApplicationConfig = {
    providers: [
        // ...
        provideHttpClient(),
        provideApi('http://localhost:9999')
    ],
};

// with a custom configuration
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi } from '@veeroute/lss-monitor-angular';

export const appConfig: ApplicationConfig = {
    providers: [
        // ...
        provideHttpClient(),
        provideApi({
            withCredentials: true,
            username: 'user',
            password: 'password'
        })
    ],
};

// with factory building a custom configuration
import { ApplicationConfig } from '@angular/core';
import { provideHttpClient } from '@angular/common/http';
import { provideApi, Configuration } from '@veeroute/lss-monitor-angular';

export const appConfig: ApplicationConfig = {
    providers: [
        // ...
        provideHttpClient(),
        {
            provide: Configuration,
            useFactory: (authService: AuthService) => new Configuration({
                    basePath: 'http://localhost:9999',
                    withCredentials: true,
                    username: authService.getUsername(),
                    password: authService.getPassword(),
            }),
            deps: [AuthService],
            multi: false
        }
    ],
};

Using multiple OpenAPI files / APIs

In order to use multiple APIs generated from different OpenAPI files, you can create an alias name when importing the modules in order to avoid naming conflicts:

import { provideApi as provideUserApi } from 'my-user-api-path';
import { provideApi as provideAdminApi } from 'my-admin-api-path';
import { HttpClientModule } from '@angular/common/http';
import { environment } from '../environments/environment';

export const appConfig: ApplicationConfig = {
    providers: [
        // ...
        provideHttpClient(),
        provideUserApi(environment.basePath),
        provideAdminApi(environment.basePath),
    ],
};

Customizing path parameter encoding

Without further customization, only path-parameters of style 'simple' and Dates for format 'date-time' are encoded correctly.

Other styles (e.g. "matrix") are not that easy to encode and thus are best delegated to other libraries (e.g.: @honoluluhenk/http-param-expander).

To implement your own parameter encoding (or call another library), pass an arrow-function or method-reference to the encodeParam property of the Configuration-object (see General Usage above).

Example value for use in your Configuration-Provider:

new Configuration({
    encodeParam: (param: Param) => myFancyParamEncoder(param),
})