# @haulsuite/driverplan-js

> Driverplan APIs wrapper

Latest version **0.1.1** (published 2022-04-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @haulsuite/driverplan-js
pnpm add @haulsuite/driverplan-js
yarn add @haulsuite/driverplan-js
bun add @haulsuite/driverplan-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2022-04-07 |
| First published | 2022-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10.13.0 |
| Dependencies | 8 |
| Unpacked size | 47.7 KB |
| Known vulnerabilities | 0 (+24 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | sumanoptym |
| Keywords | driverplan, haulsuite, optym, api |

## Links

- npm: https://www.npmjs.com/package/@haulsuite/driverplan-js
- Homepage: http://~
- npm.io page: https://npm.io/package/@haulsuite/driverplan-js

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) ^0.25.0
- [rimraf](https://npm.io/package/rimraf.md) 3.0.2
- [node-emoji](https://npm.io/package/node-emoji.md) 1.11.0
- [typescript](https://npm.io/package/typescript.md) 4.6.2
- [tsconfig-paths](https://npm.io/package/tsconfig-paths.md) 3.13.0
- [class-validator](https://npm.io/package/class-validator.md) 0.13.2
- [source-map-support](https://npm.io/package/source-map-support.md) 0.5.21
- [tsconfig-paths-webpack-plugin](https://npm.io/package/tsconfig-paths-webpack-plugin.md) 3.5.2

## Recent versions

- 0.1.1 (latest) — 2022-04-07
- 0.1.0 — 2022-04-07

## README

# Introduction 
The `driverplan/node` package is a utility library which provides wrapper around DriverPlan APIs.
It will help in quickly getting started to consume DriverPlan APIs and also expose APIs which DriverPlan can consume.
This wrapper uses `class-validator` to validate the input data. This will help in quickly checking the expectation of DriverPlan exposed APIs.
It provides wrapper around these APIs:
- Schedule Update Event
- Driver Update Event
- Link Update Event
- Terminal Update Event
- Tractor Update Event
- Publish Success/Failure Update

In addition, it also provides the schema (dtos) which DriverPlan expects client to expose as 'Select' using Rest APIs.
- Select Schedule
- Select Driver
- Select Link
- Select Terminal
- Select Tractor
- Post Updated Schedule

Please refer examples for more details

# Getting Started
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
1.	Installation process
2.	Software dependencies
3.	Latest releases
4.	API references

# Build and Test
TODO: Describe and show how to build your code and run the tests.

---
_Source: https://npm.io/package/@haulsuite/driverplan-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._