Appx package management DTO/model WIP commit.

Author: mjr4077au

src/PSADT/PSADT/AppManagement/AppxPackage.cs

@@ -0,0 +1,159 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+
+namespace PSADT.AppManagement
+{
+    /// <summary>
+    /// Represents an app package in the system.
+    /// </summary>
+    public sealed record AppxPackage
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AppxPackage"/> class.
+        /// </summary>
+        /// <param name="name">The display name of the app package.</param>
+        /// <param name="publisher">The publisher of the app package.</param>
+        /// <param name="publisherId">The publisher ID of the app package.</param>
+        /// <param name="architecture">The architecture of the app package.</param>
+        /// <param name="resourceId">The resource ID of the app package.</param>
+        /// <param name="version">The version of the app package.</param>
+        /// <param name="packageFamilyName">The package family name of the app package.</param>
+        /// <param name="packageFullName">The full name of the app package.</param>
+        /// <param name="installLocation">The install location of the app package.</param>
+        /// <param name="isFramework">Indicates whether the app package is a framework.</param>
+        /// <param name="packageUserInformation">The user information of the app package.</param>
+        /// <param name="isResourcePackage">Indicates whether the app package is a resource package.</param>
+        /// <param name="isBundle">Indicates whether the app package is a bundle.</param>
+        /// <param name="isDevelopmentMode">Indicates whether the app package is in development mode.</param>
+        /// <param name="nonRemovable">Indicates whether the app package is non-removable.</param>
+        /// <param name="dependencies">The dependencies of the app package.</param>
+        /// <param name="isPartiallyStaged">Indicates whether the app package is partially staged.</param>
+        /// <param name="signatureKind">The signature kind of the app package.</param>
+        /// <param name="status">The status of the app package.</param>
+        public AppxPackage(string name, string publisher, string publisherId, PackageArchitecture architecture, string resourceId, Version version, string packageFamilyName, string packageFullName, string installLocation, bool isFramework, ReadOnlyCollection<PackageUserInformation> packageUserInformation, bool isResourcePackage, bool isBundle, bool isDevelopmentMode, bool nonRemovable, ReadOnlyCollection<AppxPackage> dependencies, bool isPartiallyStaged, PackageSignatureKind signatureKind, PackageStatus status)
+        {
+            ArgumentException.ThrowIfNullOrWhiteSpace(name);
+            ArgumentException.ThrowIfNullOrWhiteSpace(publisher);
+            ArgumentException.ThrowIfNullOrWhiteSpace(publisherId);
+            ArgumentException.ThrowIfNullOrWhiteSpace(resourceId);
+            ArgumentException.ThrowIfNullOrWhiteSpace(packageFamilyName);
+            ArgumentException.ThrowIfNullOrWhiteSpace(packageFullName);
+            ArgumentException.ThrowIfNullOrWhiteSpace(installLocation);
+            DisplayName = name;
+            Publisher = publisher;
+            PublisherId = publisherId;
+            Architecture = architecture;
+            ResourceId = resourceId;
+            Version = version;
+            PackageFamilyName = packageFamilyName;
+            PackageFullName = packageFullName;
+            InstallLocation = installLocation;
+            IsFramework = isFramework;
+            PackageUserInformation = packageUserInformation;
+            IsResourcePackage = isResourcePackage;
+            IsBundle = isBundle;
+            IsDevelopmentMode = isDevelopmentMode;
+            NonRemovable = nonRemovable;
+            Dependencies = dependencies;
+            IsPartiallyStaged = isPartiallyStaged;
+            SignatureKind = signatureKind;
+            Status = status;
+        }
+
+        /// <summary>
+        /// Gets the name of the package.
+        /// </summary>
+        public string DisplayName { get; }
+
+        /// <summary>
+        /// Gets the publisher of the app package.
+        /// </summary>
+        public string Publisher { get; }
+
+        /// <summary>
+        /// Gets the publisher ID of the app package.
+        /// </summary>
+        public string PublisherId { get; }
+
+        /// <summary>
+        /// Gets the architecture of the app package.
+        /// </summary>
+        public PackageArchitecture Architecture { get; }
+
+        /// <summary>
+        /// Gets the resource ID of the app package.
+        /// </summary>
+        public string ResourceId { get; }
+
+        /// <summary>
+        /// Gets the version of the app package.
+        /// </summary>
+        public Version Version { get; }
+
+        /// <summary>
+        /// Gets the package family name of the app package.
+        /// </summary>
+        public string PackageFamilyName { get; }
+
+        /// <summary>
+        /// Gets the full name of the app package.
+        /// </summary>
+        public string PackageFullName { get; }
+
+        /// <summary>
+        /// Gets the install location of the app package.
+        /// </summary>
+        public string InstallLocation { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the app package is a framework package.
+        /// </summary>
+        public bool IsFramework { get; }
+
+        /// <summary>
+        /// Gets the user information of the app package.
+        /// </summary>
+        public IReadOnlyList<PackageUserInformation> PackageUserInformation { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the app package is a resource package.
+        /// </summary>
+        public bool IsResourcePackage { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the app package is a bundle package.
+        /// </summary>
+        public bool IsBundle { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the app package is in development mode.
+        /// </summary>
+        public bool IsDevelopmentMode { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the app package is non-removable.
+        /// </summary>
+        public bool NonRemovable { get; }
+
+        /// <summary>
+        /// Gets the dependencies of the app package.
+        /// </summary>
+        public IReadOnlyList<AppxPackage> Dependencies { get; }
+
+        /// <summary>
+        /// Gets a value indicating whether the app package is partially staged.
+        /// </summary>
+        public bool IsPartiallyStaged { get; }
+
+        /// <summary>
+        /// Gets the signature kind of the app package.
+        /// </summary>
+        public PackageSignatureKind SignatureKind { get; }
+
+        /// <summary>
+        /// Gets the status of the app package.
+        /// </summary>
+        public PackageStatus Status { get; }
+    }
+}

src/PSADT/PSADT/AppManagement/AppxProvisionedPackage.cs

@@ -0,0 +1,82 @@
+using System;
+
+namespace PSADT.AppManagement
+{
+    /// <summary>
+    /// Represents a provisioned package in the system.
+    /// </summary>
+    public sealed record AppxProvisionedPackage
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AppxProvisionedPackage"/> class.
+        /// </summary>
+        /// <param name="packageName">The package name of the provisioned package.</param>
+        /// <param name="displayName">The display name of the provisioned package.</param>
+        /// <param name="publisherId">The publisher ID of the provisioned package.</param>
+        /// <param name="majorVersion">The major version of the provisioned package.</param>
+        /// <param name="minorVersion">The minor version of the provisioned package.</param>
+        /// <param name="build">The build number of the provisioned package.</param>
+        /// <param name="revision">The revision number of the provisioned package.</param>
+        /// <param name="architecture">The architecture of the provisioned package.</param>
+        /// <param name="resourceId">The resource ID of the provisioned package.</param>
+        /// <param name="installLocation">The install location of the provisioned package.</param>
+        /// <param name="regions">The regions where the provisioned package is available.</param>
+        public AppxProvisionedPackage(string packageName, string displayName, string publisherId, uint majorVersion, uint minorVersion, uint build, uint revision, PackageArchitecture architecture, string resourceId, string installLocation, string regions)
+        {
+            ArgumentException.ThrowIfNullOrWhiteSpace(packageName);
+            ArgumentException.ThrowIfNullOrWhiteSpace(displayName);
+            ArgumentException.ThrowIfNullOrWhiteSpace(publisherId);
+            ArgumentException.ThrowIfNullOrWhiteSpace(resourceId);
+            ArgumentException.ThrowIfNullOrWhiteSpace(installLocation);
+            ArgumentException.ThrowIfNullOrWhiteSpace(regions);
+            Version = new((int)majorVersion, (int)minorVersion, (int)build, (int)revision);
+            PackageName = packageName;
+            DisplayName = displayName;
+            PublisherId = publisherId;
+            Architecture = architecture;
+            ResourceId = resourceId;
+            InstallLocation = installLocation;
+            Regions = regions;
+        }
+
+        /// <summary>
+        /// Gets the package name of the provisioned package.
+        /// </summary>
+        public string PackageName { get; }
+
+        /// <summary>
+        /// Gets the display name of the provisioned package.
+        /// </summary>
+        public string DisplayName { get; }
+
+        /// <summary>
+        /// Gets the publisher ID of the provisioned package.
+        /// </summary>
+        public string PublisherId { get; }
+
+        /// <summary>
+        /// Gets the version of the provisioned package.
+        /// </summary>
+        public Version Version { get; }
+
+        /// <summary>
+        /// Gets the architecture of the provisioned package.
+        /// </summary>
+        public PackageArchitecture Architecture { get; }
+
+        /// <summary>
+        /// Gets the resource ID of the provisioned package.
+        /// </summary>
+        public string ResourceId { get; }
+
+        /// <summary>
+        /// Gets the install location of the provisioned package.
+        /// </summary>
+        public string InstallLocation { get; }
+
+        /// <summary>
+        /// Gets the regions where the provisioned package is available.
+        /// </summary>
+        public string Regions { get; }
+    }
+}

src/PSADT/PSADT/AppManagement/PackageArchitecture.cs

@@ -0,0 +1,34 @@
+namespace PSADT.AppManagement
+{
+    /// <summary>
+    /// Specifies the processor architectures supported by a package.
+    /// </summary>
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1712:Do not prefix enum values with type name", Justification = "This is how it's named in the Win32 API.")]
+    public enum PackageArchitecture
+    {
+        /// <summary>
+        /// The x86 processor architecture.
+        /// </summary>
+        x86 = Windows.Win32.Storage.Packaging.Appx.APPX_PACKAGE_ARCHITECTURE.APPX_PACKAGE_ARCHITECTURE_X86,
+
+        /// <summary>
+        /// The ARM processor architecture.
+        /// </summary>
+        ARM = Windows.Win32.Storage.Packaging.Appx.APPX_PACKAGE_ARCHITECTURE.APPX_PACKAGE_ARCHITECTURE_ARM,
+
+        /// <summary>
+        /// The x64 processor architecture.
+        /// </summary>
+        x64 = Windows.Win32.Storage.Packaging.Appx.APPX_PACKAGE_ARCHITECTURE.APPX_PACKAGE_ARCHITECTURE_X64,
+
+        /// <summary>
+        /// Any processor architecture.
+        /// </summary>
+        Neutral = Windows.Win32.Storage.Packaging.Appx.APPX_PACKAGE_ARCHITECTURE.APPX_PACKAGE_ARCHITECTURE_NEUTRAL,
+
+        /// <summary>
+        /// The 64-bit ARM processor architecture.
+        /// </summary>
+        ARM64 = Windows.Win32.Storage.Packaging.Appx.APPX_PACKAGE_ARCHITECTURE.APPX_PACKAGE_ARCHITECTURE_ARM64,
+    }
+}

src/PSADT/PSADT/AppManagement/PackageSignatureKind.cs

@@ -0,0 +1,33 @@
+namespace PSADT.AppManagement
+{
+    /// <summary>
+    /// Specifies the ways that an app package may be signed.
+    /// </summary>
+    public enum PackageSignatureKind
+    {
+        /// <summary>
+        /// Not signed.
+        /// </summary>
+        None = 0,
+
+        /// <summary>
+        /// Deployed in your development environment. The package is signed with a private certificate.
+        /// </summary>
+        Developer = 1,
+
+        /// <summary>
+        /// Signed using a certificate used in enterprises.
+        /// </summary>
+        Enterprise = 2,
+
+        /// <summary>
+        /// Signed by the Windows Store.
+        /// </summary>
+        Store = 3,
+
+        /// <summary>
+        /// Built-in system app.
+        /// </summary>
+        System = 4,
+    }
+}

src/PSADT/PSADT/AppManagement/PackageStatus.cs

@@ -0,0 +1,76 @@
+using System;
+
+namespace PSADT.AppManagement
+{
+    /// <summary>
+    /// Provides info about the status of a Package.
+    /// </summary>
+    [Flags]
+    public enum PackageStatus
+    {
+        /// <summary>
+        /// The package is usable.
+        /// </summary>
+        Ok = 0 << 0,
+
+        /// <summary>
+        /// Indicates whether there is a problem with the license for this package.
+        /// </summary>
+        LicenseIssue = 1 << 0,
+
+        /// <summary>
+        /// Indicates whether the package is missing files, system information, etc.
+        /// </summary>
+        Modified = 1 << 1,
+
+        /// <summary>
+        /// Indicates whether the package may have been tampered with.
+        /// </summary>
+        Tampered = 1 << 2,
+
+        /// <summary>
+        /// Indicates whether the package has been disabled.
+        /// </summary>
+        Disabled = 1 << 3,
+
+        /// <summary>
+        /// The package is not available for use and cannot be serviced.
+        /// </summary>
+        PackageOffline = 1 << 4,
+
+        /// <summary>
+        /// Indicates whether the package is offline and cannot be used.
+        /// </summary>
+        DeploymentInProgress = 1 << 5,
+
+        /// <summary>
+        /// Indicates whether this package depends on a package that can't be used.
+        /// </summary>
+        DependencyIssue = 1 << 6,
+
+        /// <summary>
+        /// Indicates whether the data for the package is offline.
+        /// </summary>
+        DataOffline = 1 << 7,
+
+        /// <summary>
+        /// Indicates whether the package is partially staged.
+        /// </summary>
+        IsPartiallyStaged = 1 << 8,
+
+        /// <summary>
+        /// Indicates whether the package is available.
+        /// </summary>
+        NotAvailable = 1 << 9,
+
+        /// <summary>
+        /// Indicates whether the package is being serviced.
+        /// </summary>
+        Servicing = 1 << 10,
+
+        /// <summary>
+        /// Indicates whether the package is unusable.
+        /// </summary>
+        NeedsRemediation = 1 << 11,
+    }
+}