NM B2B 27.0.0 (#121)

* NM B2B 27.0.0 * Tweak gitattributes for merge strategy on CHANGELOG.md * Update target NM version * Tweak typings, tweak tests
DGAC · Jun 7, 2024 · 8d39632 · 8d39632
1 parent ec8ad21
commit 8d39632
Show file tree

Hide file tree

Showing 36 changed files with 255 additions and 788 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+CHANGELOG.md merge=union
diff --git a/.github/workflows/test_publish.yml b/.github/workflows/test_publish.yml
@@ -4,7 +4,7 @@ env:
   CI: true
   B2B_FLAVOUR: PREOPS
   B2B_ENDPOINT: https://b2b-proxy.4me.im/
-  B2B_XSD_REMOTE_URL: https://wsdl.b2B-proxy.4me.im/26.0.0.tar.gz
+  B2B_XSD_REMOTE_URL: https://wsdl.b2B-proxy.4me.im/27.0.0.tar.gz
   B2B_API_KEY_ID: ${{ secrets.B2B_API_KEY_ID }}
   B2B_API_SECRET_KEY: ${{ secrets.B2B_API_SECRET_KEY }}
   CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 # Master
 
+- NMB2B v27.0.0
 - Attach the current configuration to the service definition : `xxxxService.config`.
 - Remove moment.js, move to `date-fns`
 - Update dependencies

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 
 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: **26.0.0**
+NM target version: **27.0.0**
 
 ## Simple usage example
 

diff --git a/src/Airspace/types.ts b/src/Airspace/types.ts
@@ -102,6 +102,7 @@ type ADRMessageType = object; // eurocontrol.cfmu.cua.b2b.aixm.ADRMessage
 export interface AUPManualEntries {
   cdrs?: ADRMessageType;
   rsas?: ADRMessageType;
+  radRestrictionActivations?: ADRMessageType;
 }
 
 export interface AUPComputedEntries {

diff --git a/src/Common/types.ts b/src/Common/types.ts
@@ -24,6 +24,8 @@ export type AirNavigationUnitId = string; // (UALPHA|DIGIT|SPECIAL_CHARACTER){1,
 export type UserId = string; // ANY{1,12}
 export type PlanDataId = string; // (O|F|S)(DIGIT){14}(UALPHA|DIGIT){0,40}
 
+export type Colours = string; // TEXT{1,51}
+
 // TODO: Implement proper duration (seconds) parsing
 export type SignedDurationHourMinuteSecond = string; // +hhmmss / -hhmmss
 
@@ -140,6 +142,7 @@ export interface Reply {
 
 export interface Request {
   endUserId?: string;
+  onBehalfOfUnit?: AirNavigationUnitId;
   sendTime: DateTimeSecond;
 }
 

diff --git a/src/Flight/queryFlightsByAerodrome.test.ts b/src/Flight/queryFlightsByAerodrome.test.ts
@@ -20,7 +20,7 @@ describe('queryFlightsByAirspace', async () => {
       trafficType: 'LOAD',
       trafficWindow,
       aerodrome: 'LFPG',
-      aerodromeRole: 'BOTH',
+      aerodromeRole: 'GLOBAL',
     });
 
     /**
@@ -41,7 +41,13 @@ describe('queryFlightsByAirspace', async () => {
       ),
     ).toBeLessThan(60 * 1000);
 
-    expect(res.data?.flights).toEqual(expect.any(Array));
+    if (!res.data.flights) {
+      console.warn('No flights in the response.');
+      return;
+    }
+
+    expect(res.data.flights).toEqual(expect.any(Array));
+
     for (const flight of res.data?.flights) {
       expect(flight).toMatchObject({
         flight: {

diff --git a/src/Flight/queryFlightsByAerodromeSet.test.ts b/src/Flight/queryFlightsByAerodromeSet.test.ts
@@ -20,7 +20,7 @@ describe('queryFlightsByAirspace', async () => {
       trafficType: 'LOAD',
       trafficWindow,
       aerodromeSet: 'LFPG+',
-      aerodromeRole: 'BOTH',
+      aerodromeRole: 'GLOBAL',
     });
 
     /**
@@ -41,8 +41,14 @@ describe('queryFlightsByAirspace', async () => {
       ),
     ).toBeLessThan(60 * 1000);
 
-    expect(res.data?.flights).toEqual(expect.any(Array));
-    for (const flight of res.data?.flights) {
+    if (!res.data.flights) {
+      console.warn('No flights in the response.');
+      return;
+    }
+
+    expect(res.data.flights).toEqual(expect.any(Array));
+
+    for (const flight of res.data.flights) {
       expect(flight).toMatchObject({
         flight: {
           flightId: {

diff --git a/src/Flight/queryFlightsByAircraftOperator.test.ts b/src/Flight/queryFlightsByAircraftOperator.test.ts
@@ -43,8 +43,14 @@ describe('queryFlightsByAircraftOperator', async () => {
         ),
       ).toBeLessThan(60 * 1000);
 
-      expect(res.data?.flights).toEqual(expect.any(Array));
-      for (const flight of res.data?.flights) {
+      if (!res.data.flights) {
+        console.warn('No flights in the response.');
+        return;
+      }
+
+      expect(res.data.flights).toEqual(expect.any(Array));
+
+      for (const flight of res.data.flights) {
         expect(flight).toMatchObject({
           flight: {
             flightId: {

diff --git a/src/Flight/queryFlightsByAirspace.test.ts b/src/Flight/queryFlightsByAirspace.test.ts
@@ -40,8 +40,14 @@ describe('queryFlightsByAirspace', async () => {
       ),
     ).toBeLessThan(60 * 1000);
 
-    expect(res.data?.flights).toEqual(expect.any(Array));
-    for (const flight of res.data?.flights) {
+    if (!res.data.flights) {
+      console.warn('No flights in the response.');
+      return;
+    }
+
+    expect(res.data.flights).toEqual(expect.any(Array));
+
+    for (const flight of res.data.flights) {
       expect(flight).toMatchObject({
         flight: {
           flightId: {

diff --git a/src/Flight/queryFlightsByMeasure.test.ts b/src/Flight/queryFlightsByMeasure.test.ts
@@ -70,8 +70,15 @@ describe('queryFlightsByMeasure', async () => {
       });
 
       expect(res.data.effectiveTrafficWindow).toEqual(measure.applicability);
-      expect(res.data?.flights).toEqual(expect.any(Array));
-      for (const flight of res.data?.flights) {
+
+      if (!res.data.flights) {
+        console.warn('No flights in the response.');
+        return;
+      }
+
+      expect(res.data.flights).toEqual(expect.any(Array));
+
+      for (const flight of res.data.flights) {
         expect(flight).toMatchObject({
           flight: {
             flightId: {

diff --git a/src/Flight/queryFlightsByTrafficVolume.test.ts b/src/Flight/queryFlightsByTrafficVolume.test.ts
@@ -47,8 +47,14 @@ describe('queryFlightsByTrafficVolume', async () => {
       ),
     ).toBeLessThan(60 * 1000);
 
-    expect(res.data?.flights).toEqual(expect.any(Array));
-    for (const flight of res.data?.flights) {
+    if (!res.data.flights) {
+      console.warn('No flights in the response.');
+      return;
+    }
+
+    expect(res.data.flights).toEqual(expect.any(Array));
+
+    for (const flight of res.data.flights) {
       if (!('flight' in flight)) {
         continue;
       }

diff --git a/src/Flight/retrieveFlight.test.ts b/src/Flight/retrieveFlight.test.ts
@@ -3,7 +3,7 @@ import { NMB2BError, makeFlightClient } from '..';
 import b2bOptions from '../../tests/options';
 import type { FlightKeys } from './types';
 import { shouldUseRealB2BConnection } from '../../tests/utils';
-import { expect, beforeAll, test, describe } from 'vitest';
+import { expect, beforeAll, test, describe, assert } from 'vitest';
 import { add, sub } from 'date-fns';
 
 describe('retrieveFlight', async () => {
@@ -27,18 +27,24 @@ describe('retrieveFlight', async () => {
       airspace: 'LFEERMS',
     });
 
-    const flights = res.data.flights.filter((f) => {
-      if ('flightPlan' in f) {
-        return false;
-      }
+    if (!res.data.flights) {
+      console.warn('No flights in the response.');
+      return;
+    }
 
-      return true;
-    });
+    const flights = res.data.flights.filter(
+      (f): f is Extract<typeof f, { flight: any }> => {
+        if ('flightPlan' in f) {
+          return false;
+        }
+
+        return true;
+      },
+    );
 
-    // Second condition is here because TS won't infer that the array contains
-    // only Flight and not FlightPlan anymore
     const flight = flights[0];
-    if (!flight || !('flight' in flight)) {
+
+    if (!flight) {
       console.error('Could not fetch a known flight, test aborted');
       return;
     }
@@ -77,11 +83,11 @@ describe('retrieveFlight', async () => {
           },
           requestedFlightDatasets: ['flight'],
           requestedFlightFields: ['ftfmPointProfile'],
-          requestedDataFormat: 'NM_B2B',
         });
 
-        expect(res.data.flight?.ftfmPointProfile).toBeDefined();
-        res.data.flight?.ftfmPointProfile?.forEach((item) => {
+        assert(res.data.flight?.ftfmPointProfile);
+
+        res.data.flight.ftfmPointProfile.forEach((item) => {
           expect(item).toEqual(
             expect.objectContaining({
               timeOver: expect.any(Date),
@@ -90,7 +96,10 @@ describe('retrieveFlight', async () => {
           );
         });
       } catch (err) {
-        console.error(inspect(err, { depth: 4 }));
+        if (err instanceof NMB2BError) {
+          console.log(inspect(err, { depth: 4 }));
+        }
+
         throw err;
       }
     },
@@ -114,7 +123,6 @@ describe('retrieveFlight', async () => {
           },
           requestedFlightDatasets: ['flight'],
           requestedFlightFields: ['aircraftType', 'delay'],
-          requestedDataFormat: 'NM_B2B',
         });
 
         const flight = res.data?.flight;