Add FireGiant Bundle Application Framework documentation

astro.config.mjs

@@ -17,7 +17,7 @@ export default defineConfig({
       filter: (page) => !page.startsWith('https://docs.firegiant.com/wix3/')
     }),
     starlight({
-      title: 'Docs',
+      title: 'FireGiant Docs',
       logo: {
         dark: './src/assets/firegiant-logo-black.svg',
         light: './src/assets/firegiant-logo-standard.svg',
@@ -53,6 +53,7 @@ export default defineConfig({
             'heatwave/build-tools',
             'heatwave/build-tools/firegiant-licensing',
             { label: 'Advanced Harvesting', collapsed: true, autogenerate: { directory: '/heatwave/build-tools/harvesting' } },
+            { label: 'Bundle Application Framework', collapsed: true, autogenerate: { directory: '/heatwave/build-tools/fgba' } },
             { label: 'MSIX', collapsed: true, autogenerate: { directory: '/heatwave/build-tools/msix' } },
             'heatwave/build-tools/driver',
             'heatwave/build-tools/protected-services',
@@ -62,12 +63,11 @@ export default defineConfig({
 
         { label: 'WiX Toolset', collapsed: true, items: [
           'wix',
-
-          { label: 'What\'s new in WiX', collapsed: true, autogenerate: { directory: '/wix/whatsnew' } },
-
           'wix/using-wix',
           'wix/gethelp',
 
+          { label: 'What\'s new in WiX', collapsed: true, autogenerate: { directory: '/wix/whatsnew' } },
+
           { label: 'Tutorial', collapsed: true, items: [
             { label: 'Tutorial Introduction', link: 'wix/tutorial/' },
             { label: 'Sprint 1: Welcome to the team', collapsed: true, autogenerate: { directory: 'wix/tutorial/sprint1' } },
@@ -116,7 +116,10 @@ export default defineConfig({
           ] },
         ] },
 
-        { label: 'API Reference', collapsed: true, autogenerate: { directory: '/wix/api' } },
+        { label: 'API Reference', collapsed: true, items: [
+          { label: 'FireGiant Bundle Application Framework API', collapsed: true, autogenerate: { directory: '/firegiant/api/firegiantbundleapplicationframework' } },
+          { label: 'WiX Toolset API', collapsed: true, autogenerate: { directory: '/wix/api' } },
+          ] },
         { label: 'Schema Reference', collapsed: true, items: [
           { label: 'WiX Core Schema', collapsed: true, autogenerate: { directory: '/wix/schema/wxs' } },
           { label: 'Localization Schema', collapsed: true, autogenerate: { directory: '/wix/schema/wxl' } },

src/components/starlight/SiteTitle.astro

@@ -2,16 +2,15 @@
 import logoDark from '@assets/firegiant-logo-black.svg?raw';
 import logoLight from '@assets/firegiant-logo-standard.svg?raw';
 import docs from '@assets/docs-logo.svg?raw';
-import { type Props } from '@astrojs/starlight/props';
 
-const { siteTitle, siteTitleHref } = Astro.props;
-const www = 'https://www.firegiant.com/';
+const wwwHref = 'https://www.firegiant.com/';
+const docsHref = 'https://docs.firegiant.com/';
 ---
 
 <span class="site-title sl-flex">
-  <a class="firegiant-logo light:sl-hidden print:hidden" href={www} set:html={logoDark} aria-label="FireGiant" />
-  <a class="firegiant-logo dark:sl-hidden print:block" href={www} set:html={logoLight} aria-label="FireGiant" />
-  <a class="docs-logo" href={siteTitleHref} set:html={docs} aria-label="Docs" title={siteTitle} />
+  <a class="firegiant-logo light:sl-hidden print:hidden" href={wwwHref} set:html={logoDark} aria-label="FireGiant" />
+  <a class="firegiant-logo dark:sl-hidden print:block" href={wwwHref} set:html={logoLight} aria-label="FireGiant" />
+  <a class="docs-logo" href={docsHref} set:html={docs} aria-label="Docs" title="FireGiant Docs" />
 </span>
 
 <style>

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleaction.md

@@ -0,0 +1,20 @@
+---
+title: BundleAction Enumeration
+pagefind: false
+---
+Bundle actions.
+## Members
+| Member | Description |
+| ------ | ----------- |
+| Cache | Cache bundle action. |
+| Help | Help bundle action. |
+| Install | Install bundle action. |
+| Layout | Layout bundle action. |
+| Modify | Modify bundle action. |
+| Repair | Repair bundle action. |
+| Uninstall | Uninstall bundle action. |
+| Unknown | Unknown bundle action. |
+| UpdateReplace | Update bundle action. |
+| UpdateReplaceEmbedded | Update using embedded bundle action. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleactionstate.md

@@ -0,0 +1,20 @@
+---
+title: BundleActionState Enumeration
+pagefind: false
+---
+Action state for a package or bundle.
+## Members
+| Member | Description |
+| ------ | ----------- |
+| AdminInstall | Administrative install action state. |
+| Install | Install action state. |
+| MajorUpgrade | Major upgrade action state. |
+| Mend | Mend action state. |
+| MinorUpgrade | Minor upgrade action state. |
+| Modify | Modify action state. |
+| None | No action or do not change the action state. |
+| Patch | Patch action state. |
+| Repair | Repair action state. |
+| Uninstall | Uninstall action state. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleapplyphase.md

@@ -0,0 +1,14 @@
+---
+title: BundleApplyPhase Enumeration
+pagefind: false
+---
+Apply phases of a bundle.
+## Members
+| Member | Description |
+| ------ | ----------- |
+| Acquire | Acquire (download/cache/verify) phase. |
+| Execute | Execute (install/uninstall) phase. |
+| Rollback | Rollback phase. |
+| Unknown | Unknown apply phase. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlecacheoperation.md

@@ -0,0 +1,15 @@
+---
+title: BundleCacheOperation Enumeration
+pagefind: false
+---
+Bundle cache operations.
+## Members
+| Member | Description |
+| ------ | ----------- |
+| Copy | Copy payload to cache. |
+| Download | Download payload to cache. |
+| Extract | Extract payload from containers to cache. |
+| None | Payload source is not available. |
+| Unknown | Unknown cache operation. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlecondition.md

@@ -0,0 +1,26 @@
+---
+title: BundleCondition Class
+pagefind: false
+---
+Condition evaluated during bundle initialization.
+## Properties
+| Property | Description |
+| ------ | ----------- |
+| [Condition](#condition) | Condition to evaluate. If the condition evaluates to false, Message is displayed and executionis blocked. |
+| [Message](#message) | Message to be shown when the Condition fails. |
+### Remarks
+Use the bal:Condition element to add conditions to your bundle.
+
+`FireGiant.BundleApplicationFramework v6.0.1`
+## Condition Property {#condition}
+Condition to evaluate. If the condition evaluates to false, Message is displayed and executionis blocked.
+### Declaration
+```cs
+public string Condition { get; set; } 
+```
+## Message Property {#message}
+Message to be shown when the Condition fails.
+### Declaration
+```cs
+public string Message { get; set; } 
+```

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleerrortype.md

@@ -0,0 +1,16 @@
+---
+title: BundleErrorType Enumeration
+pagefind: false
+---
+Types of error.
+## Members
+| Member | Description |
+| ------ | ----------- |
+| Apply | Failure during apply phase. |
+| Elevate | Failure during elevation. |
+| ExePackage | Failure from an executable package. |
+| HttpProxyAuthentication | Failure to authenticate with an HTTP proxy. |
+| HttpServerAuthentication | Failure to authenticate with an HTTP server. |
+| WindowsInstaller | Failure from Windows Installer. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlefeature.md

@@ -0,0 +1,100 @@
+---
+title: BundleFeature Class
+pagefind: false
+---
+Details about a feature that is part of a Bundle's package.
+## Properties
+| Property | Description |
+| ------ | ----------- |
+| [Attributes](#attributes) | The default remote execution option for the feature. |
+| [Description](#description) | Description of the package. |
+| [Display](#display) | The number in this field specifies the order in which the feature is to be displayed in the user interface.
+            The value also determines whether or not the feature is initially displayed expanded or collapsed. If the value is null or 0 (zero), the record is not displayed.
+            If the value is odd, the feature node is expanded initially.
+            If the value is even, the feature node is collapsed initially. |
+| [Id](#id) | Unique identity of the feature in the package. |
+| [Level](#level) | The installation level of this feature. |
+| [PackageId](#packageid) | Unique identity of the package in the chain. |
+| [ParentId](#parentid) | Optional identity of the parent of a feature in the package. |
+| [RequestState](#requeststate) | Request state for the feature. |
+| [RequestStateSet](#requeststateset) | Indicates whether the request state was explicitly set by the BundleUI. |
+| [Size](#size) | Size of the files contained in the feature. |
+| [State](#state) | Feature state. |
+| [Title](#title) | Title of feature in the package. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`
+## Attributes Property {#attributes}
+The default remote execution option for the feature.
+### Declaration
+```cs
+public int Attributes { get; set; } 
+```
+## Description Property {#description}
+Description of the package.
+### Declaration
+```cs
+public string Description { get; set; } 
+```
+## Display Property {#display}
+The number in this field specifies the order in which the feature is to be displayed in the user interface.
+            The value also determines whether or not the feature is initially displayed expanded or collapsed. If the value is null or 0 (zero), the record is not displayed.
+            If the value is odd, the feature node is expanded initially.
+            If the value is even, the feature node is collapsed initially.
+### Declaration
+```cs
+public int Display { get; set; } 
+```
+## Id Property {#id}
+Unique identity of the feature in the package.
+### Declaration
+```cs
+public string Id { get; set; } 
+```
+## Level Property {#level}
+The installation level of this feature.
+### Declaration
+```cs
+public int Level { get; set; } 
+```
+## PackageId Property {#packageid}
+Unique identity of the package in the chain.
+### Declaration
+```cs
+public string PackageId { get; set; } 
+```
+## ParentId Property {#parentid}
+Optional identity of the parent of a feature in the package.
+### Declaration
+```cs
+public string ParentId { get; set; } 
+```
+## RequestState Property {#requeststate}
+Request state for the feature.
+### Declaration
+```cs
+public BundleFeatureState RequestState { get; set; } 
+```
+## RequestStateSet Property {#requeststateset}
+Indicates whether the request state was explicitly set by the BundleUI.
+### Declaration
+```cs
+public bool RequestStateSet { get; set; } 
+```
+## Size Property {#size}
+Size of the files contained in the feature.
+### Declaration
+```cs
+public int Size { get; set; } 
+```
+## State Property {#state}
+Feature state.
+### Declaration
+```cs
+public BundleFeatureState State { get; set; } 
+```
+## Title Property {#title}
+Title of feature in the package.
+### Declaration
+```cs
+public string Title { get; set; } 
+```

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundlefeaturestate.md

@@ -0,0 +1,15 @@
+---
+title: BundleFeatureState Enumeration
+pagefind: false
+---
+Feature state.
+## Members
+| Member | Description |
+| ------ | ----------- |
+| Absent | Feature is not installed. |
+| Advertised | Feature is advertised. |
+| Local | Feature is installed locally. |
+| Source | Feature is installed run from source. |
+| Unknown | Feature state is unkown. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleinstallmessage.md

@@ -0,0 +1,26 @@
+---
+title: BundleInstallMessage Enumeration
+pagefind: false
+---
+Types of messages sent during apply.
+## Members
+| Member | Description |
+| ------ | ----------- |
+| ActionData | Data from an action. |
+| ActionStart | Start of an action. |
+| CommonData | Data sent by Windows Installer. |
+| Error | Error. |
+| FatalExit | Fatal exit. |
+| FilesInUse | Files in use prompt. |
+| Info | Informational message. |
+| Initialize | Initialize message. |
+| OutOfDiskSpace | Out of disk space error. |
+| Progress | Progress from an action. |
+| ResolveSource | Source resolution prompt. |
+| RMFilesInUse | Restart manager files in use prompt. |
+| ShowDialog | Show dialog prompt. |
+| Terminate | Terminate message. |
+| User | Message requiring user interaction. |
+| Warning | Warning. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`

src/content/docs/firegiant/api/firegiantbundleapplicationframework/bundleoverallprogress.md

@@ -0,0 +1,45 @@
+---
+title: BundleOverallProgress Class
+pagefind: false
+---
+Overall progress during apply.
+## Properties
+| Property | Description |
+| ------ | ----------- |
+| [CachePercentage](#cachepercentage) | Percentage of cache complete. |
+| [ExecutePercentage](#executepercentage) | Percentage of execution complete. |
+| [OverallPercentage](#overallpercentage) | Overall percentage complete. |
+| [RestartRequired](#restartrequired) | Indicates when an restart required. |
+| [ShowUI](#showui) | Indicates whether UI should be displayed. |
+
+`FireGiant.BundleApplicationFramework v6.0.1`
+## CachePercentage Property {#cachepercentage}
+Percentage of cache complete.
+### Declaration
+```cs
+public int CachePercentage { get; set; } 
+```
+## ExecutePercentage Property {#executepercentage}
+Percentage of execution complete.
+### Declaration
+```cs
+public int ExecutePercentage { get; set; } 
+```
+## OverallPercentage Property {#overallpercentage}
+Overall percentage complete.
+### Declaration
+```cs
+public int OverallPercentage { get; set; } 
+```
+## RestartRequired Property {#restartrequired}
+Indicates when an restart required.
+### Declaration
+```cs
+public bool RestartRequired { get; set; } 
+```
+## ShowUI Property {#showui}
+Indicates whether UI should be displayed.
+### Declaration
+```cs
+public bool ShowUI { get; set; } 
+```