Safer B2B response types

.changeset/cold-schools-grab.md

@@ -0,0 +1,5 @@
+---
+'@dgac/nmb2b-client': minor
+---
+
+Response typings should be safer now

package.json

@@ -83,9 +83,9 @@
     "clean": "rimraf dist",
     "build": "tsup-node",
     "release": "pnpm build && changeset publish",
-    "lint": "eslint",
+    "lint": "eslint --max-warnings=0",
     "test": "vitest",
-    "test:ci": "vitest --watch=false --reporter=basic --reporter=junit --outputFile.junit=junit.xml --coverage.enabled",
+    "test:ci": "vitest --watch=false --reporter=basic --reporter=junit --outputFile.junit=junit.xml --coverage.enabled --typecheck",
     "typecheck": "tsc --noEmit"
   },
   "files": [
@@ -97,7 +97,6 @@
     "@eslint/js": "^9.6.0",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/debug": "^4.1.12",
-    "@types/eslint__js": "^8.42.3",
     "@types/invariant": "^2.2.37",
     "@types/node": "^18.19.39",
     "@types/proper-lockfile": "^4.1.4",
@@ -122,7 +121,8 @@
     "proper-lockfile": "^4.1.2",
     "remeda": "^2.5.0",
     "soap": "^1.0.4",
-    "tar": "^7.4.0"
+    "tar": "^7.4.0",
+    "type-fest": "^4.21.0"
   },
   "publishConfig": {
     "provenance": true

src/Airspace/queryCompleteAIXMDatasets.test.ts

@@ -17,12 +17,16 @@ describe('queryCompleteAIXMDatasets', async () => {
       },
     });
 
-    expect(res.data.datasetSummaries).toBeDefined();
+    expect(res.data?.datasetSummaries).toBeDefined();
+    assert(res.data?.datasetSummaries);
     expect(res.data.datasetSummaries.length).toBeGreaterThanOrEqual(1);
+
     const dataset = res.data.datasetSummaries[0];
     assert(dataset);
-    expect(Array.isArray(dataset.files)).toBe(true);
+    assert(Array.isArray(dataset.files));
+
     expect(dataset.files.length).toBeGreaterThan(0);
+
     dataset.files.forEach((f) => {
       expect(f).toMatchObject({
         id: expect.stringMatching(/BASELINE\.zip$/),

src/Airspace/queryCompleteAIXMDatasets.ts

@@ -4,25 +4,20 @@ import { injectSendTime, responseStatusHandler } from '../utils/internals';
 import { prepareSerializer } from '../utils/transformers';
 import type { AirspaceClient } from './';
 import type { AiracIdentifier, AIXMFile } from './types';
-import type { CollapseEmptyObjectsToNull } from '../utils/types';
 
 import type {
   DateYearMonthDay,
   DateYearMonthDayPeriod,
-  Reply,
+  ReplyWithData,
 } from '../Common/types';
 
 export interface CompleteAIXMDatasetRequest {
   queryCriteria: CompleteDatasetQueryCriteria;
 }
 
-export type CompleteAIXMDatasetReply = CollapseEmptyObjectsToNull<
-  Reply & {
-    data: {
-      datasetSummaries: CompleteDatasetSummary[];
-    };
-  }
->;
+export type CompleteAIXMDatasetReply = ReplyWithData<{
+  datasetSummaries: CompleteDatasetSummary[];
+}>;
 
 type Values = CompleteAIXMDatasetRequest;
 type Result = CompleteAIXMDatasetReply;

src/Airspace/retrieveAUP.test.ts

@@ -2,42 +2,40 @@ import { assert, beforeAll, describe, expect, test } from 'vitest';
 import { makeAirspaceClient } from '..';
 import b2bOptions from '../../tests/options';
 import { shouldUseRealB2BConnection } from '../../tests/utils';
-import type { AUPSummary } from './types';
 
 describe('retrieveAUP', async () => {
   const Airspace = await makeAirspaceClient(b2bOptions);
 
-  let AUPSummaries: AUPSummary[] = [];
+  let AUPSummaryIds: Array<string> = [];
   beforeAll(async () => {
     // Find some AUP id
     const res = await Airspace.retrieveAUPChain({
       amcIds: ['LFFAZAMC'],
       chainDate: new Date(),
     });
 
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- TODO: Check if this condition is necessary ?
-    if (res.data) {
-      assert(res.data.chains[0]);
-      AUPSummaries = res.data.chains[0].aups.filter(
-        ({ aupState }) => aupState === 'RELEASED',
-      );
-
-      AUPSummaries.sort(
-        (a, b) =>
-          (a.lastUpdate?.timestamp.valueOf() ?? 0) -
-          (b.lastUpdate?.timestamp.valueOf() ?? 0),
-      );
-    }
+    assert(res.data?.chains?.[0]?.aups);
+
+    const summaries = res.data.chains[0].aups.filter(
+      ({ aupState }) => aupState === 'RELEASED',
+    );
+    summaries.sort(
+      (a, b) =>
+        (a.lastUpdate?.timestamp.valueOf() ?? 0) -
+        (b.lastUpdate?.timestamp.valueOf() ?? 0),
+    );
+
+    AUPSummaryIds = summaries.map(({ id }) => id);
   });
 
   test.runIf(shouldUseRealB2BConnection)('AUP Retrieval', async () => {
-    if (!AUPSummaries[0]) {
+    if (!AUPSummaryIds[0]) {
       console.warn('AUPChainRetrieval did not yield any AUP id');
       return;
     }
 
     const res = await Airspace.retrieveAUP({
-      aupId: AUPSummaries[0].id,
+      aupId: AUPSummaryIds[0],
       returnComputed: true,
     });
 

src/Airspace/retrieveAUP.ts

@@ -1,11 +1,10 @@
-import type { AirspaceClient } from './';
-import { injectSendTime, responseStatusHandler } from '../utils/internals';
+import type { ReplyWithData } from '../Common/types';
 import type { SoapOptions } from '../soap';
-import { prepareSerializer } from '../utils/transformers';
 import { instrument } from '../utils/instrumentation';
-import type { AUPId, AUP } from './types';
-import type { Reply } from '../Common/types';
-import type { CollapseEmptyObjectsToNull } from '../utils/types';
+import { injectSendTime, responseStatusHandler } from '../utils/internals';
+import { prepareSerializer } from '../utils/transformers';
+import type { AirspaceClient } from './';
+import type { AUP, AUPId } from './types';
 
 type Values = AUPRetrievalRequest;
 type Result = AUPRetrievalReply;
@@ -44,10 +43,6 @@ export interface AUPRetrievalRequest {
   returnComputed?: boolean;
 }
 
-export type AUPRetrievalReply = CollapseEmptyObjectsToNull<
-  Reply & {
-    data: {
-      aup: AUP;
-    };
-  }
->;
+export type AUPRetrievalReply = ReplyWithData<{
+  aup: AUP;
+}>;

src/Airspace/retrieveAUPChain.test.ts

@@ -12,6 +12,6 @@ describe('retrieveAUPChain', async () => {
       chainDate: new Date(),
     });
 
-    expect(Array.isArray(res.data.chains)).toBe(true);
+    expect(Array.isArray(res.data?.chains)).toBe(true);
   });
 });

src/Airspace/retrieveAUPChain.ts

@@ -1,16 +1,15 @@
+import type {
+  AirNavigationUnitId,
+  DateYearMonthDay,
+  ReplyWithData,
+} from '../Common/types';
 import type { SoapOptions } from '../soap';
 import { instrument } from '../utils/instrumentation';
 import { injectSendTime, responseStatusHandler } from '../utils/internals';
 import { prepareSerializer } from '../utils/transformers';
 import type { AirspaceClient } from './';
-import type {
-  AirNavigationUnitId,
-  DateYearMonthDay,
-  Reply,
-} from '../Common/types';
 
 import type { AUPChain } from './types';
-import type { CollapseEmptyObjectsToNull } from '../utils/types';
 
 type Values = AUPChainRetrievalRequest;
 type Result = AUPChainRetrievalReply;
@@ -51,10 +50,6 @@ export interface AUPChainRetrievalRequest {
   amcIds?: AirNavigationUnitId[];
 }
 
-export type AUPChainRetrievalReply = CollapseEmptyObjectsToNull<
-  Reply & {
-    data: {
-      chains: AUPChain[];
-    };
-  }
->;
+export type AUPChainRetrievalReply = ReplyWithData<{
+  chains: AUPChain[];
+}>;

src/Airspace/retrieveEAUPChain.test.ts

@@ -16,7 +16,7 @@ describe('retrieveEAUPChain', async () => {
       eaups: expect.any(Array),
     });
 
-    for (const eaup of res.data.chain.eaups) {
+    for (const eaup of res.data.chain.eaups ?? []) {
       expect(eaup).toEqual({
         releaseTime: expect.any(Date),
         validityPeriod: {

src/Airspace/retrieveEAUPChain.ts

@@ -1,11 +1,10 @@
+import type { DateYearMonthDay, ReplyWithData } from '../Common/types';
 import type { SoapOptions } from '../soap';
 import { instrument } from '../utils/instrumentation';
 import { injectSendTime, responseStatusHandler } from '../utils/internals';
 import { prepareSerializer } from '../utils/transformers';
 import type { AirspaceClient } from './';
-import type { DateYearMonthDay, Reply } from '../Common/types';
 
-import type { CollapseEmptyObjectsToNull } from '../utils/types';
 import type { EAUPChain } from './types';
 
 type Values = EAUPChainRetrievalRequest;
@@ -46,10 +45,6 @@ export interface EAUPChainRetrievalRequest {
   chainDate: DateYearMonthDay;
 }
 
-export type EAUPChainRetrievalReply = CollapseEmptyObjectsToNull<
-  Reply & {
-    data: {
-      chain: EAUPChain;
-    };
-  }
->;
+export type EAUPChainRetrievalReply = ReplyWithData<{
+  chain: EAUPChain;
+}>;

src/Common/types.ts

@@ -1,3 +1,5 @@
+import type { SoapDeserializer } from '../utils/types';
+
 export type DateYearMonthDay = Date;
 export type DateTimeMinute = Date;
 export type DateTimeSecond = Date;
@@ -128,7 +130,7 @@ export type ReplyStatus =
   | 'CONFLICTING_UPDATE'
   | 'INVALID_DATASET';
 
-export type Reply = {
+export interface Reply {
   requestReceptionTime?: DateTimeSecond;
   requestId?: string;
   sendTime?: DateTimeSecond;
@@ -140,6 +142,10 @@ export type Reply = {
   reason?: string;
 }
 
+export type ReplyWithData<TData = never> = Reply & {
+  data: SoapDeserializer<TData>;
+};
+
 export type Request = {
   endUserId?: string;
   onBehalfOfUnit?: AirNavigationUnitId;