refactor: extract common utils to fbw-common (#8073)

* refactor: extract common utils to fbw-common * refactor: move instruments shared code to fbw-common, re-organise structure * refactor: remove old instruments shared code, port usages, fix build * fix: enum * fix: tests * fix: lint * fix build
flybywiresim · Jun 24, 2023 · f9e4d66 · f9e4d66
1 parent f3dc175
commit f9e4d66
Show file tree

Hide file tree

Showing 286 changed files with 1,311 additions and 706 deletions.
diff --git a/...neo/html_ui/Pages/VCockpit/Instruments/Airliners/FlyByWire_A320_Neo/CDU/A320_Neo_CDU.html b/...neo/html_ui/Pages/VCockpit/Instruments/Airliners/FlyByWire_A320_Neo/CDU/A320_Neo_CDU.html
@@ -1,3 +1,7 @@
+<!-- //Copyright (c) 2021-2023 FlyByWire Simulations -->
+<!-- // -->
+<!-- //SPDX-License-Identifier: GPL-3.0 -->
+
 <link rel="stylesheet" href="A320_Neo_CDU.css"/>
 
 <script type="text/html" id="A320_Neo_CDU">
@@ -31,7 +35,6 @@
 <script type="text/html" import-script="/JS/fbw-a32nx/atsu/fmsclient.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/sentry-client/sentry-client.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/simbridge-client/simbridge-client.js"></script>
-<script type="text/html" import-script="/JS/fbw-a32nx/fmgc/LzUtf8.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/fmgc/fmgc.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/A32NX_Simvars.js"></script>
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/NavSystems/Shared/LogicElements/SearchField.js"></script>

diff --git a/...html_ui/Pages/VCockpit/Instruments/Airliners/FlyByWire_A320_Neo/EICAS/A320_Neo_EICAS.html b/...html_ui/Pages/VCockpit/Instruments/Airliners/FlyByWire_A320_Neo/EICAS/A320_Neo_EICAS.html
@@ -1,4 +1,8 @@
-<link rel="stylesheet" href="A320_Neo_EICAS.css" xmlns=""/>
+<!-- //Copyright (c) 2021-2023 FlyByWire Simulations -->
+<!-- // -->
+<!-- //SPDX-License-Identifier: GPL-3.0 -->
+
+<link rel="stylesheet" href="A320_Neo_EICAS.css" xmlns=""/>
 <link rel="stylesheet" href="/CSS/A32NX_Display_Common.css"/>
 
 <script type="text/html" id="A320_Neo_EICAS">
@@ -69,7 +73,6 @@
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/Shared/FlightElements/Approach.js"></script>
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/FlightElements/A32NX_WaypointLoader.js"></script>
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/Shared/FlightElements/GeoCalc.js"></script>
-<script type="text/html" import-script="/JS/fbw-a32nx/fmgc/LzUtf8.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/fmgc/fmgc.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/sentry-client/sentry-client.js"></script>
 

diff --git a/...neo/html_ui/Pages/VCockpit/Instruments/Airliners/FlyByWire_A320_Neo/FCU/A320_Neo_FCU.html b/...neo/html_ui/Pages/VCockpit/Instruments/Airliners/FlyByWire_A320_Neo/FCU/A320_Neo_FCU.html
@@ -99,6 +99,7 @@
 <script type="text/html" import-script="/JS/fbw-a32nx/A32NX_Util.js" import-async="false"></script>
 
 <script type="text/html" import-script="/JS/SimPlane.js"></script>
+<script type="text/html" import-script="/JS/dataStorage.js"></script>
 
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/Shared/Utils/RadioNav.js"></script>
 
@@ -109,7 +110,6 @@
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/Shared/FlightElements/Approach.js"></script>
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/FlightElements/A32NX_Runway.js"></script>
 <script type="text/html" import-script="/Pages/VCockpit/Instruments/Shared/FlightElements/GeoCalc.js"></script>
-<script type="text/html" import-script="/JS/fbw-a32nx/fmgc/LzUtf8.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/fmgc/fmgc.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/A32NX_Simvars.js"></script>
 <script type="text/html" import-script="/JS/fbw-a32nx/sentry-client/sentry-client.js"></script>

diff --git a/fbw-a32nx/src/systems/atsu/common/build.js b/fbw-a32nx/src/systems/atsu/common/build.js
@@ -1,3 +1,7 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 'use strict';
 
 const esbuild = require('esbuild');
@@ -13,7 +17,7 @@ esbuild.build({
 
     define: { DEBUG: 'false' },
 
-    entryPoints: [ path.join(rootDir,  '../fbw-common/src/systems/datalink/common/src/index.ts')],
+    entryPoints: [path.join(rootDir, '../fbw-common/src/systems/datalink/common/src/index.ts')],
     bundle: true,
     treeShaking: false,
     minify: isProductionBuild,
@@ -23,7 +27,7 @@ esbuild.build({
     format: 'iife',
     globalName: 'AtsuCommon',
 
-    sourcemap: isProductionBuild ? undefined : 'linked',
+    sourcemap: isProductionBuild ? 'linked' : undefined,
 
     // Target approximate CoherentGT WebKit version
     target: 'safari11',

diff --git a/fbw-a32nx/src/systems/atsu/fmsclient/build.js b/fbw-a32nx/src/systems/atsu/fmsclient/build.js
@@ -1,3 +1,7 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 'use strict';
 
 const esbuild = require('esbuild');
@@ -23,7 +27,7 @@ esbuild.build({
     format: 'iife',
     globalName: 'AtsuFmsClient',
 
-    sourcemap: isProductionBuild ? undefined : 'linked',
+    sourcemap: isProductionBuild ? 'linked' : undefined,
 
     // Target approximate CoherentGT WebKit version
     target: 'safari11',

diff --git a/fbw-a32nx/src/systems/atsu/fmsclient/src/FlightPlanSynchronization.ts b/fbw-a32nx/src/systems/atsu/fmsclient/src/FlightPlanSynchronization.ts
@@ -6,7 +6,7 @@ import { Waypoint } from '@datalink/common';
 import { FlightPhaseManager } from '@fmgc/flightphase';
 import { WaypointStats } from '@fmgc/flightplanning/data/flightplan';
 import { FlightPlanManager, ManagedFlightPlan } from '@fmgc/wtsdk';
-import { Arinc429Word } from '@shared/arinc429';
+import { Arinc429Word } from '@flybywiresim/fbw-sdk';
 import { FmgcFlightPhase } from '@shared/flightphase';
 import { EventBus, Publisher } from '@microsoft/msfs-sdk';
 

diff --git a/fbw-a32nx/src/systems/extras-host/build.js b/fbw-a32nx/src/systems/extras-host/build.js
@@ -0,0 +1,33 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
+'use strict';
+
+const esbuild = require('esbuild');
+const path = require('path');
+
+const rootDir = path.join(__dirname, '..', '..', '..');
+const outFile = 'out/flybywire-aircraft-a320-neo/html_ui/Pages/VCockpit/Instruments/A32NX/ExtrasHost';
+
+const isProductionBuild = process.env.A32NX_PRODUCTION_BUILD === '1';
+
+esbuild.build({
+    absWorkingDir: __dirname,
+
+    define: { DEBUG: 'false' },
+
+    entryPoints: ['./index.ts'],
+    bundle: true,
+    treeShaking: false,
+    minify: isProductionBuild,
+
+    outdir: path.join(rootDir, outFile),
+
+    format: 'iife',
+
+    sourcemap: isProductionBuild ? 'linked' : undefined,
+
+    // Target approximate CoherentGT WebKit version
+    target: 'safari11',
+});
diff --git a/fbw-a32nx/src/systems/extras-host/index.tsx → fbw-a32nx/src/systems/extras-host/index.ts b/fbw-a32nx/src/systems/extras-host/index.tsx → fbw-a32nx/src/systems/extras-host/index.ts
@@ -2,12 +2,11 @@
 // SPDX-License-Identifier: GPL-3.0
 
 import { EventBus, HEventPublisher } from '@microsoft/msfs-sdk';
-import { NotificationManager } from '@shared/notification';
+import { NotificationManager } from '@flybywiresim/fbw-sdk';
 import { ExtrasSimVarPublisher } from 'extras-host/modules/common/ExtrasSimVarPublisher';
 import { PushbuttonCheck } from 'extras-host/modules/pushbutton_check/PushbuttonCheck';
 import { KeyInterceptor } from './modules/key_interceptor/KeyInterceptor';
 import { VersionCheck } from './modules/version_check/VersionCheck';
-import './style.scss';
 
 /**
  * This is the main class for the extras-host instrument.

diff --git a/fbw-a32nx/src/systems/extras-host/modules/key_interceptor/KeyInterceptor.ts b/fbw-a32nx/src/systems/extras-host/modules/key_interceptor/KeyInterceptor.ts
@@ -2,8 +2,7 @@
 // SPDX-License-Identifier: GPL-3.0
 
 import { EventBus, KeyEvents, KeyEventManager } from '@microsoft/msfs-sdk';
-import { NotificationManager, NotificationType } from '@shared/notification';
-import { PopUpDialog } from '@shared/popup';
+import { NotificationManager, NotificationType, PopUpDialog } from '@flybywiresim/fbw-sdk';
 import { AircraftPresetsList } from '../common/AircraftPresetsList';
 
 /**

diff --git a/fbw-a32nx/src/systems/extras-host/modules/pushbutton_check/PushbuttonCheck.ts b/fbw-a32nx/src/systems/extras-host/modules/pushbutton_check/PushbuttonCheck.ts
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: GPL-3.0
 
 import { ConsumerSubject, DebounceTimer, EventBus, MappedSubject } from '@microsoft/msfs-sdk';
-import { NotificationManager, NotificationTheme } from '@shared/notification';
+import { NotificationManager, NotificationTheme } from '@flybywiresim/fbw-sdk';
 import { ExtrasSimVarEvents } from 'extras-host/modules/common/ExtrasSimVarPublisher';
 
 /**

diff --git a/fbw-a32nx/src/systems/extras-host/rollup.config.js b/fbw-a32nx/src/systems/extras-host/rollup.config.js
diff --git a/fbw-a32nx/src/systems/extras-host/style.scss b/fbw-a32nx/src/systems/extras-host/style.scss
diff --git a/fbw-a32nx/src/systems/failures/src/failures-orchestrator.ts b/fbw-a32nx/src/systems/failures/src/failures-orchestrator.ts
@@ -1,4 +1,8 @@
-import { AtaChapterNumber } from '@shared/ata';
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
+import { AtaChapterNumber } from '@flybywiresim/fbw-sdk';
 import { QueuedSimVarWriter, SimVarReaderWriter } from './communication';
 import { getActivateFailureSimVarName, getDeactivateFailureSimVarName } from './sim-vars';
 

diff --git a/fbw-a32nx/src/systems/fmgc/build.js b/fbw-a32nx/src/systems/fmgc/build.js
@@ -0,0 +1,34 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
+'use strict';
+
+const esbuild = require('esbuild');
+const path = require('path');
+
+const rootDir = path.join(__dirname, '..', '..', '..');
+const outFile = 'out/flybywire-aircraft-a320-neo/html_ui/JS/fbw-a32nx/fmgc/fmgc.js';
+
+const isProductionBuild = process.env.A32NX_PRODUCTION_BUILD === '1';
+
+esbuild.build({
+    absWorkingDir: __dirname,
+
+    define: { DEBUG: 'false' },
+
+    entryPoints: ['src/index.ts'],
+    bundle: true,
+    treeShaking: false,
+    minify: isProductionBuild,
+
+    outfile: path.join(rootDir, outFile),
+
+    format: 'iife',
+    globalName: 'Fmgc',
+
+    sourcemap: isProductionBuild ? 'linked' : undefined,
+
+    // Target approximate CoherentGT WebKit version
+    target: 'safari11',
+});
diff --git a/fbw-a32nx/src/systems/fmgc/rollup.config.js b/fbw-a32nx/src/systems/fmgc/rollup.config.js
diff --git a/fbw-a32nx/src/systems/fmgc/src/components/FcuSync.ts b/fbw-a32nx/src/systems/fmgc/src/components/FcuSync.ts
@@ -1,5 +1,9 @@
-import { Arinc429Word } from '@shared/arinc429';
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 import { LateralMode } from '@shared/autopilot';
+import { Arinc429Word } from '@flybywiresim/fbw-sdk';
 import { FmgcComponent } from './FmgcComponent';
 
 // Note the logic for this is different on A330/350/380

diff --git a/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/GpsPrimaryLost.ts b/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/GpsPrimaryLost.ts
@@ -1,5 +1,9 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 import { FMMessage, FMMessageTypes } from '@shared/FmMessages';
-import { ConfirmationNode, Trigger } from '@shared/logic';
+import { ConfirmationNode, Trigger } from '@flybywiresim/fbw-sdk';
 import { FMMessageSelector, FMMessageUpdate } from './FmsMessages';
 
 /**

diff --git a/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/MapPartlyDisplayed.ts b/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/MapPartlyDisplayed.ts
@@ -1,5 +1,9 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 import { FMMessage, FMMessageTypes } from '@shared/FmMessages';
-import { Trigger } from '@shared/logic';
+import { Trigger } from '@flybywiresim/fbw-sdk';
 import { FMMessageSelector, FMMessageUpdate } from './FmsMessages';
 
 abstract class MapPartlyDisplayed implements FMMessageSelector {

diff --git a/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/RwyLsMismatch.ts b/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/RwyLsMismatch.ts
@@ -1,6 +1,10 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 import { NavaidTuner } from '@fmgc/navigation/NavaidTuner';
 import { FMMessage, FMMessageTypes } from '@shared/FmMessages';
-import { Trigger } from '@shared/logic';
+import { Trigger } from '@flybywiresim/fbw-sdk';
 import { FMMessageSelector, FMMessageUpdate } from './FmsMessages';
 
 abstract class RwyLsMismatch implements FMMessageSelector {

diff --git a/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/SpecifiedNdbUnavailable.ts b/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/SpecifiedNdbUnavailable.ts
@@ -1,6 +1,10 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 import { NavaidTuner } from '@fmgc/navigation/NavaidTuner';
 import { FMMessage, FMMessageTypes } from '@shared/FmMessages';
-import { Trigger } from '@shared/logic';
+import { Trigger } from '@flybywiresim/fbw-sdk';
 import { FMMessageSelector, FMMessageUpdate } from './FmsMessages';
 
 abstract class SpecifiedNdbUnavailable implements FMMessageSelector {

diff --git a/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/SpecifiedVorUnavailable.ts b/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/SpecifiedVorUnavailable.ts
@@ -1,6 +1,10 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 import { NavaidTuner } from '@fmgc/navigation/NavaidTuner';
 import { FMMessage, FMMessageTypes } from '@shared/FmMessages';
-import { Trigger } from '@shared/logic';
+import { Trigger } from '@flybywiresim/fbw-sdk';
 import { FMMessageSelector, FMMessageUpdate } from './FmsMessages';
 
 abstract class SpecifiedVorUnavailable implements FMMessageSelector {

diff --git a/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/TuneNavaid.ts b/fbw-a32nx/src/systems/fmgc/src/components/fms-messages/TuneNavaid.ts
@@ -1,6 +1,10 @@
+// Copyright (c) 2021-2023 FlyByWire Simulations
+//
+// SPDX-License-Identifier: GPL-3.0
+
 import { NavaidTuner } from '@fmgc/navigation/NavaidTuner';
 import { FMMessage, FMMessageTypes } from '@shared/FmMessages';
-import { Trigger } from '@shared/logic';
+import { Trigger } from '@flybywiresim/fbw-sdk';
 import { FMMessageSelector, FMMessageUpdate } from './FmsMessages';
 
 abstract class TuneNavaid implements FMMessageSelector {