@dgac/nmb2b-client
Version:
EUROCONTROL Network Manager B2B SOAP client
242 lines (179 loc) • 6.74 kB
Markdown
# Network Manager B2B Client
[](https://npmjs.com/package/@dgac/nmb2b-client)
[](https://codecov.io/gh/DGAC/nmb2b-client-js)
Exposes a general purpose Javascript library to interact with NM B2B web services. The idea is to abstract pain points while offering an API that maps the NM B2B WS API.
NM target version: **27.0.0**
## Simple usage example
https://github.com/DGAC/nmb2b-client-js-example
# Features
- No WSDL/XSD dependency. The library will download and cache those on start up.
- Natural serialization/deserialization of certain types.
For instance, the Flow.retrieveOTMVPlan query expects a `day` attribute with the XSD type `DateYearMonthDay`. This type is a string, representing a date in the `YYYY-MM-DD` format. This library allows you to pass a traditional JS Date object instead.
```typescript
const res = await Flow.retrieveOTMVPlan({
dataset: { type: 'OPERATIONAL' },
day: new Date(),
otmvsWithDuration: { item: [{ trafficVolume: 'LFERMS' }] },
});
```
- Request object key reordering when needed.
In SOAP, key order matters.
```typescript
// OK
await Flow.retrieveOTMVPlan({
dataset: { type: 'OPERATIONAL' },
day: moment.utc().toDate(),
otmvsWithDuration: { item: [{ trafficVolume: 'LFERMS' }] },
});
// Would normally fail
await const Flow.retrieveOTMVPlan({
day: moment.utc().toDate(),
dataset: { type: 'OPERATIONAL' },
otmvsWithDuration: { item: [{ trafficVolume: 'LFERMS' }] },
});
```
The library reorder request object keys to match what's expressed in the XSD/WSDL. Therefore, the second example works fine.
- TypeScript support.
The following example will raise a type error.
```typescript
// Raises a type error
await Flow.retrieveOTMVPlan({
dataset: { type: 'OPERATIONNAL' }, // Notice the typo
day: moment.utc().toDate(),
otmvsWithDuration: { item: [{ trafficVolume: 'LFERMS' }] },
});
```
- Debug output
Debug output is controlled via the [`debug`](https://npmjs.com/package/debug) package. All debug output from this library is scoped under `@dgac/nmb2b-client` namespace.
Just set a `DEBUG=@dgac/nmb2b-client*` environment variable :
[](https://asciinema.org/a/xWovjkKlkqePBolRl3OqAFBi8)
- Hooks
Custom user provided callbacks to be executed when a SOAP query is either started or completed.
# Usage
## Main service
```typescript
import { createB2BClient } from '@dgac/nmb2b-client';
// See below for more information about the security argument
const client = await createB2BClient({ security });
const res = await client.Airspace.queryCompleteAIXMDatasets();
```
## Per domain service
```typescript
import { createAirspaceClient } from '@dgac/nmb2b-client';
// See below for more information about the security argument
const Airspace = await createAirspaceClient({ security });
const res = await Airspace.queryCompleteAIXMDatasets();
```
## Error handling
```typescript
import { createAirspaceClient, NMB2BError } from '@dgac/nmb2b-client';
try {
const Airspace = await createAirspaceClient({ security });
const res = await Airspace.queryCompleteAIXMDatasets();
} catch (err) {
if (err instanceof NMB2BError) {
if (err.status === 'OBJECT_NOT_FOUND') {
// ...
}
}
// ...
}
```
## B2B Security
Every request to the NM B2B web services must be authenticated using a client certificate. This library needs to be initialized with a `security` object, containing the certificate, key and passphrase associated.
### With P12 certificate
```javascript
import fs from 'fs';
const security = {
pfx: fs.readFileSync('/path/to/cert.p12'),
passphrase: 'your-passphrase',
};
createB2BClient({ security }).then((client) => {
client.Airspace.queryCompleteAIXMDatasets().then(() => {});
});
```
### With PEM certificate
```javascript
import fs from 'fs';
const security = {
pem: fs.readFileSync('/path/to/cert.pem'),
key: fs.readFileSync('/path/to/cert.key'),
passphrase: 'your-passphrase',
};
createB2BClient({ security }).then((client) => {
client.Airspace.queryCompleteAIXMDatasets().then(() => {});
});
```
## Hooks
Hooks are user provided callbacks which will be executed during the SOAP query process.
Basic example :
```typescript
const client = await createB2BClient({
// ... other options,
hooks: [
function onRequestStart({ service, query, input }) {
console.log(`Query ${query} of service ${service} was invoked with input`, input)
}
]
})
```
A hook can return an optional object containing success / error hooks :
```typescript
const client = await createB2BClient({
// ... other options,
hooks: [
function onRequestStart({ service, query, input }) {
const startTime = new Date();
console.log(
`Query ${query} of service ${service} was invoked with input:`,
input,
);
return {
onRequestSuccess: ({ response }) => {
const durationMs = new Date().valueOf() - startTime;
console.log(`Query took ${durationMs}ms`);
console.log(`Query responded with`, response);
},
onRequestError: ({ error }) => {
const durationMs = new Date().valueOf() - startTime;
console.log(`Query took ${durationMs}ms`);
console.log(`Query failed with error ${error.message}`);
},
};
},
],
});
```
Hooks can also be async :
```typescript
const client = await createB2BClient({
// ... other options,
hooks: [
async function onRequestStart({ service, query, input }) {
await sendLog(`Query ${query} of service ${service} was invoked`);
},
],
});
```
To get proper typescript support when creating custom hooks, a `createHook()` function helper is now exported :
```typescript
import { createHook } from '@dgac/nmb2b-client';
const withPrometheusMetrics = createHook(({ service, query }) => {
prometheusCounter.inc({ service, query, status: 'started' });
return {
onRequestSuccess: () =>
prometheusCounter.inc({ service, query, status: 'completed' }),
onRequestError: () =>
prometheusCounter.inc({ service, query, status: 'completed' }),
};
});
// ... in another file
const b2bClient = await createB2BClient({
// ... other options
hooks: [withPrometheusMetrics],
});
```