chore: move a32nx and FSLTL injector to fragmenter releases (#44)

* fix: update typedefs * chore: move a32nx tracks to fragmenter release * chore: move FSLTL injector tracks to fragmenter release
flybywiresim · Oct 26, 2024 · 8ab28fc · 8ab28fc
1 parent 297d91c
commit 8ab28fc
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 19 deletions.
diff --git a/config/config.ts b/config/config.ts
@@ -96,7 +96,7 @@ const config: Configuration = {
                                 'with each major patch from MSFS.',
                             isExperimental: false,
                             releaseModel: {
-                                type: 'githubRelease',
+                                type: 'fragmenter',
                             },
                         },
                         {
@@ -121,8 +121,7 @@ const config: Configuration = {
                                 'branch on Github. Please visit our discord for support.',
                             isExperimental: false,
                             releaseModel: {
-                                type: 'githubBranch',
-                                branch: 'master',
+                                type: 'fragmenter',
                             },
                         },
                     ],
@@ -307,7 +306,7 @@ const config: Configuration = {
                     backgroundImageUrls: ['https://flybywirecdn.com/installer/media-assets/addon-headers/fbw-simbridge/0.png'],
                     backgroundImageShadow: false,
                     shortDescription: 'Airbus A380-800',
-                    description: `<span style="color: rgb(255, 106, 0);">&#9888; Important: Starting with version 0.6.0, custom resources such as PDF Charts and Company Routes must be stored in the Documents folder (typically located at \`C:\\Users\\<Username>\\Documents\\FlyByWireSim\\Simbridge\\resources)\`. <br> Please ensure you back up your files before updating. After the update, transfer your files to this new location to keep them safe from future updates. You can also use the Resources button in the About section of the installer to locate the folder.</span> \n\nSimBridge is an external app that enables FlyByWire Simulations aircraft to communicate outside your simulator. From remote displays to external terrain display rendering, it is used for a variety of optional features.`,                    
+                    description: `<span style="color: rgb(255, 106, 0);">&#9888; Important: Starting with version 0.6.0, custom resources such as PDF Charts and Company Routes must be stored in the Documents folder (typically located at \`C:\\Users\\<Username>\\Documents\\FlyByWireSim\\Simbridge\\resources)\`. <br> Please ensure you back up your files before updating. After the update, transfer your files to this new location to keep them safe from future updates. You can also use the Resources button in the About section of the installer to locate the folder.</span> \n\nSimBridge is an external app that enables FlyByWire Simulations aircraft to communicate outside your simulator. From remote displays to external terrain display rendering, it is used for a variety of optional features.`,
                     targetDirectory: 'flybywire-externaltools-simbridge',
                     tracks: [
                         {
@@ -322,7 +321,7 @@ const config: Configuration = {
                                 'https://cdn.flybywiresim.com/addons/simbridge/release/',
                             ],
                             isExperimental: false,
-                            description: `<span style="color: rgb(255, 106, 0);">&#9888; Important: Starting with version 0.6.0, custom resources such as PDF Charts and Company Routes must be stored in the Documents folder (typically located at \`C:\\Users\\<Username>\\Documents\\FlyByWireSim\\Simbridge\\resources)\`. <br> Please ensure you back up your files before updating. After the update, transfer your files to this new location to keep them safe from future updates. You can also use the Resources button in the About section of the installer to locate the folder.</span> \n\nSimBridge is an external app that enables FlyByWire Simulations aircraft to communicate outside your simulator. From remote displays to external terrain display rendering, it is used for a variety of optional features.`,                    
+                            description: `<span style="color: rgb(255, 106, 0);">&#9888; Important: Starting with version 0.6.0, custom resources such as PDF Charts and Company Routes must be stored in the Documents folder (typically located at \`C:\\Users\\<Username>\\Documents\\FlyByWireSim\\Simbridge\\resources)\`. <br> Please ensure you back up your files before updating. After the update, transfer your files to this new location to keep them safe from future updates. You can also use the Resources button in the About section of the installer to locate the folder.</span> \n\nSimBridge is an external app that enables FlyByWire Simulations aircraft to communicate outside your simulator. From remote displays to external terrain display rendering, it is used for a variety of optional features.`,
                         },
                     ],
                     disallowedRunningExternalApps: ['@/simbridge-app'],
@@ -529,19 +528,19 @@ const config: Configuration = {
                             url: 'https://github.com/FSLiveTrafficLiveries/FSLTL_Injector_Releases/releases/latest/download/',
                             isExperimental: false,
                             releaseModel: {
-                                type: 'CDN',
+                                type: 'fragmenter',
                             },
                             description: 'Stable version of the FSLTL Traffic Injector for use on stable versions of MSFS.\n\n'+
                             'Follow the user guide at https://www.fslivetrafficliveries.com/user-guide/ before use.',
                         },
-						{
+				            		{
                             name: 'Experimental',
                             key: 'development',
                             url: 'https://github.com/FSLiveTrafficLiveries/FSLTL_Injector_Releases/releases/download/beta/',
                             isExperimental: true,
                             warningContent: 'No support is offered for this release, it is a preview of features that may be included in future releases.',
                             releaseModel: {
-                                type: 'CDN',
+                                type: 'fragmenter',
                             },
                             description: 'Experimental Release that includes features that are not yet ready for stable release.\n\n'+
                             'You can provide feedback on these new features in the FSLTL Discord.\n\n'+

diff --git a/lib.d.ts b/lib.d.ts
@@ -14,26 +14,27 @@ export interface NamedDirectoryDefinition extends DirectoryDefinition {
     title: string,
 }
 
-export type AddonVersion = {
-    title: string,
-    date: Date,
-    type: 'major' | 'minor' | 'patch'
+export type FragmenterReleaseModel = {
+    type: 'fragmenter',
 }
 
 export type GithubReleaseReleaseModel = {
+    /** @deprecated */
     type: 'githubRelease',
 }
 
 export type GithubBranchReleaseModel = {
+    /** @deprecated */
     type: 'githubBranch',
     branch: string,
 }
 
 export type CDNReleaseModel = {
+    /** @deprecated */
     type: 'CDN',
 }
 
-export type ReleaseModel = GithubReleaseReleaseModel | GithubBranchReleaseModel | CDNReleaseModel
+export type ReleaseModel = FragmenterReleaseModel | GithubReleaseReleaseModel | GithubBranchReleaseModel | CDNReleaseModel
 
 type BaseAddonTrack = {
     name: string,
@@ -151,28 +152,41 @@ export interface AddonDependency {
 }
 
 /**
- * fields from the addon's manifest.json
+ * Fields from the addon's manifest.json
  */
 export interface AddonIncompatibleAddon {
     /**
-     * Fields from the addon's manifest.json
+     * Field from the addon's manifest.json
      * This need to be configured identically to the addon's manifest.json
      * Leaving a field empty ignores it for the search.
      */
     title?: string,
+
+    /**
+     * Field from the addon's manifest.json
+     * This need to be configured identically to the addon's manifest.json
+     * Leaving a field empty ignores it for the search.
+     */
     creator?: string,
+
     /**
-     * packageVersion syntax follows: https://www.npmjs.com/package/semver
+     * Field from the addon's manifest.json
+     * This need to be configured identically to the addon's manifest.json
+     * Leaving a field empty ignores it for the search.
+     *
+     * This supports semver notation.
      */
     packageVersion?: string,
+
     /**
      * folder name in community - added later to show the user the corresponding folder name - not used for searching
      */
     folder?: string,
+
     /**
      * Description of the nature of the incompatibility to display to the user in a warning dialog
      */
-    description?: string
+    description?: string,
 }
 
 export interface AddonTechSpec {
@@ -202,7 +216,7 @@ export interface ConfigurationAspect {
     /**
      * The title of the page containing the choices
      */
-    title: string
+    title: string,
 
     /**
      * What to apply the list of desired choices to
@@ -255,7 +269,7 @@ export type AddonCategoryDefinition = DefinitionBase & {
     kind: 'addonCategory',
     key: string,
     title?: string,
-    styles?: ('align-bottom')[],
+    styles?: 'align-bottom'[],
 }
 
 export type ExternalApplicationDefinition = DefinitionBase & {