Bump version

* XboxOne catalog.js model

* Split Catalog object, bump version

* Minor fixes

* Custom JsonConverter for launchPackage

* Make launchPackage an abstract object

* Don't ignore packages

* Fix field types for Catalog/Package

.github/workflows/build_nupkg.yml

@@ -0,0 +1,43 @@
+name: Nuget Pack
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+        
+    - name: Restore dependencies
+      run: dotnet restore
+      
+    - name: Pack
+      run: dotnet pack
+
+    - name: Upload build
+      uses: actions/upload-artifact@v4
+      with:
+        name: 'Nuget Package'
+        path: 'bin/Release/*.nupkg'
+
+    - name: Upload to rolling
+      uses: ncipollo/release-action@v1.14.0
+      with:
+        allowUpdates: True
+        artifacts: 'bin/Release/*.nupkg'
+        body: 'Last built commit: ${{ github.sha }}'
+        name: 'Rolling Release'
+        prerelease: True
+        replacesArtifacts: True
+        tag: "rolling"
+        updateOnlyUnreleased: True

.github/workflows/check_pr.yml

@@ -0,0 +1,17 @@
+name: Build PR
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+      
+    - name: Build
+      run: dotnet build

Delphi/Constants.cs

@@ -0,0 +1,14 @@
+/// <remarks>
+/// Information sourced from https://stackoverflow.com/questions/18720045/what-are-the-list-of-all-possible-values-for-dvclal
+/// </remarks>
+namespace SabreTools.Models.Delphi
+{
+    public static class Constants
+    {
+        public static readonly byte[] DVCLALStandard = [0x23, 0x78, 0x5D, 0x23, 0xB6, 0xA5, 0xF3, 0x19, 0x43, 0xF3, 0x40, 0x02, 0x26, 0xD1, 0x11, 0xC7];
+
+        public static readonly byte[] DVCLALProfessional = [0xA2, 0x8C, 0xDF, 0x98, 0x7B, 0x3C, 0x3A, 0x79, 0x26, 0x71, 0x3F, 0x09, 0x0F, 0x2A, 0x25, 0x17];
+
+        public static readonly byte[] DVCLALEnterprise = [0x26, 0x3D, 0x4F, 0x38, 0xC2, 0x82, 0x37, 0xB8, 0xF3, 0x24, 0x42, 0x03, 0x17, 0x9B, 0x3A, 0x83];
+    }
+}

Delphi/PackageInfoTable.cs

@@ -0,0 +1,14 @@
+/// <remarks>
+/// Information sourced from https://docwiki.embarcadero.com/Libraries/Alexandria/en/System.PackageInfoTable
+/// </remarks>
+namespace SabreTools.Models.Delphi
+{
+    public class PackageInfoTable
+    {
+        public int UnitCount { get; set; }
+
+        public PackageUnitEntry[]? UnitInfo { get; set; }
+
+        public PackageTypeInfo? TypeInfo { get; set; }
+    }
+}

Delphi/PackageTypeInfo.cs

@@ -0,0 +1,19 @@
+/// <remarks>
+/// Information sourced from https://docwiki.embarcadero.com/Libraries/Sydney/en/System.TPackageTypeInfo
+/// </remarks>
+namespace SabreTools.Models.Delphi
+{
+    public class PackageTypeInfo
+    {
+        public int TypeCount { get; set; }
+
+        /// <remarks>
+        /// System-dependent pointer type, assumed to be encoded for x86
+        /// </remarks>
+        public uint[]? TypeTable { get; set; }
+
+        public int UnitCount { get; set; }
+
+        public string[]? UnitNames { get; set; }
+    }
+}

Delphi/PackageUnitEntry.cs

@@ -0,0 +1,18 @@
+/// <remarks>
+/// Information sourced from https://docwiki.embarcadero.com/Libraries/Alexandria/en/System.PackageUnitEntry
+/// </remarks>
+namespace SabreTools.Models.Delphi
+{
+    public class PackageUnitEntry
+    {
+        /// <remarks>
+        /// System-dependent pointer type, assumed to be encoded for x86
+        /// </remarks>
+        public uint Init { get; set; }
+
+        /// <remarks>
+        /// System-dependent pointer type, assumed to be encoded for x86
+        /// </remarks>
+        public uint FInit { get; set; }
+    }
+}

OfflineList/Infos.cs

@@ -27,6 +27,9 @@ namespace SabreTools.Models.OfflineList
         [XmlElement("releaseNumber")]
         public ReleaseNumber? ReleaseNumber { get; set; }
 
+        [XmlElement("imageNumber")]
+        public ImageNumber? ImageNumber { get; set; }
+
         [XmlElement("languageNumber")]
         public LanguageNumber? LanguageNumber { get; set; }
 

SabreTools.Models.csproj

@@ -7,12 +7,12 @@
     <LangVersion>latest</LangVersion>
     <Nullable>enable</Nullable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>1.3.0</Version>
+    <Version>1.4.2</Version>
 
     <!-- Package Properties -->
     <Authors>Matt Nadareski</Authors>
     <Description>Common models used by other SabreTools projects</Description>
-    <Copyright>Copyright (c) Matt Nadareski 2022-2023</Copyright>
+    <Copyright>Copyright (c) Matt Nadareski 2022-2024</Copyright>
     <PackageProjectUrl>https://github.com/SabreTools/</PackageProjectUrl>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <RepositoryUrl>https://github.com/SabreTools/SabreTools.Models</RepositoryUrl>

SafeDisc/Constants.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace SabreTools.Models.SafeDisc
+{
+    public static class Constants
+    {
+        public const uint EncryptedFileEntrySignature1 = 0xA8726B03;
+
+        public const uint EncryptedFileEntrySignature2 = 0xEF01996C;
+    }
+}

SafeDisc/EncryptedFileEntry.cs

@@ -0,0 +1,31 @@
+namespace SabreTools.Models.SafeDisc
+{
+    /// <see href="http://blog.w4kfu.com/tag/safedisc"/>
+    public class EncryptedFileEntry
+    {
+        /// <summary>
+        /// 0xA8726B03
+        /// </summary>
+        public uint Signature1 { get; set; }
+
+        /// <summary>
+        /// 0xEF01996C
+        /// </summary>
+        public uint Signature2 { get; set; }
+
+        public uint FileNumber { get; set; }
+
+        public uint Offset1 { get; set; }
+
+        public uint Offset2 { get; set; }
+
+        public uint Unknown1 { get; set; }
+
+        public uint Unknown2 { get; set; }
+
+        /// <remarks>
+        /// 0x0D bytes
+        /// </remarks>
+        public byte[]? Name { get; set; }
+    }
+}

SoftwareList/Disk.cs

@@ -21,7 +21,7 @@ namespace SabreTools.Models.SoftwareList
         public string? Status { get; set; }
 
         /// <remarks>(yes|no) "no"</remarks>
-        [XmlAttribute("writeable")]
+        [XmlAttribute("writable")]
         public string? Writeable { get; set; }
 
         #region DO NOT USE IN PRODUCTION

Xbox/Attribute.cs

@@ -0,0 +1,32 @@
+using Newtonsoft.Json;
+
+namespace SabreTools.Models.Xbox
+{
+    /// <summary>
+    /// Extra attributes relating to package, in catalog.js
+    /// </summary>
+    public class Attribute
+    {
+        /// <summary>
+        /// "supports4k":
+        /// True if package supports 4K, false otherwise
+        /// </summary>
+        [JsonProperty("supports4k", NullValueHandling = NullValueHandling.Ignore)]
+        public bool? Supports4K { get; set; }
+
+        /// <summary>
+        /// "supportsHdr":
+        /// True if package supports HDR, false otherwise
+        /// </summary>
+        [JsonProperty("supportsHdr", NullValueHandling = NullValueHandling.Ignore)]
+        public bool? SupportsHDR { get; set; }
+
+        /// <summary>
+        /// "isXboxOneXEnhanced":
+        /// True if package is XboxOne X enhanced, false otherwise
+        /// </summary>
+        [JsonProperty("isXboxOneXEnhanced", NullValueHandling = NullValueHandling.Ignore)]
+        public bool? IsXboxOneXEnhanced { get; set; }
+
+    }
+}

Xbox/Catalog.cs

@@ -0,0 +1,173 @@
+using Newtonsoft.Json;
+
+namespace SabreTools.Models.Xbox
+{
+    /// <summary>
+    /// Contains metadata information about XboxOne and XboxSX discs
+    /// Stored in a JSON file on the disc at /MSXC/Metadata/catalog.js
+    /// </summary>
+    [JsonObject]
+    public class Catalog
+    {
+        /// <summary>
+        /// "version":
+        /// Version of this catalog.js file
+        /// Known values: 1.0, 2.0, 2.1, 4.0, 4.1 (4.1 not confirmed on a disc)
+        /// </summary>
+        [JsonProperty("version")]
+        public string? Version { get; set; }
+
+        /// <summary>
+        /// "discNumber":
+        /// Varies for each disc in set
+        /// 0 is reserved and shouldnt be used
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("discNumber", NullValueHandling = NullValueHandling.Ignore)]
+        public int? DiscNumber { get; set; }
+
+        /// <summary>
+        /// "discCount":
+        /// Total number of discs in set
+        /// Same value for each disc in the set
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("discCount", NullValueHandling = NullValueHandling.Ignore)]
+        public int? DiscCount { get; set; }
+
+        /// <summary>
+        /// "discSetId":
+        /// 8 hex character ID for the set itself
+        /// Same value for each disc in the set
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("discSetId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? DiscSetID { get; set; }
+
+        /// <summary>
+        /// "bundle":
+        /// Package details for the bundle itself
+        /// Known fields used: ProductID, XboxProductID,
+        ///     OneStoreProductID, Titles, VUI, Images
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("bundle", NullValueHandling = NullValueHandling.Ignore)]
+        public Package? Bundle { get; set; }
+
+        /// <summary>
+        /// "launchPackage":
+        /// Package name to use as launch package
+        /// Before 4.0, object=Package with only ContentID filled
+        /// For 4.0 onwards, object=String, representing filename
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("launchPackage", NullValueHandling = NullValueHandling.Ignore)]
+        public object? LaunchPackage { get; set; }
+
+        /// <summary>
+        /// "packages":
+        /// Package details for each package on disc
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("packages")]
+        public Package[]? Packages { get; set; }
+
+        /// <summary>
+        /// "siblings":
+        /// List of Package Names that are related to this disc
+        /// The console picks the correct one to use
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("siblings", NullValueHandling = NullValueHandling.Ignore)]
+        public string[][]? Siblings { get; set; }
+
+        #region v1.0 only
+
+        // The below fields are usually present in a Package sub-field
+        // but for v1.0 catalog.js files, they are at the root Catalog object
+
+        /// <summary>
+        /// "productId":
+        /// Hex identifier for package Product ID
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].ProductID for v2.0 onwards
+        /// </summary>
+        [JsonProperty("productId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? ProductID { get; set; }
+
+        /// <summary>
+        /// "contentId":
+        /// Hex content identifier
+        /// Known Versions present: 1.0
+        /// Exists within Packages[].ContentID for v2.0 onwards
+        /// </summary>
+        [JsonProperty("contentId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? ContentID { get; set; }
+
+        /// <summary>
+        /// "titleId":
+        /// 8 hex character package Title ID
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].TitleID for v2.0 onwards
+        /// </summary>
+        [JsonProperty("titleId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? TitleID { get; set; }
+
+        /// <summary>
+        /// "titles"
+        /// List of name of package for each locale
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].Titles for v2.0 onwards
+        /// </summary>
+        [JsonProperty("titles", NullValueHandling = NullValueHandling.Ignore)]
+        public Title[]? Titles { get; set; }
+
+        /// <summary>
+        /// "vui":
+        /// List of Voice User Interface packages titles for each locale
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].VUI for v2.0 onwards
+        /// </summary>
+        [JsonProperty("vui", NullValueHandling = NullValueHandling.Ignore)]
+        public Title[]? VUI { get; set; }
+
+        /// <summary>
+        /// "images":
+        /// List of paths to each image in MSXC/Metadata/<PackageName>/
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].Images for v2.0 onwards
+        /// </summary>
+        [JsonProperty("images", NullValueHandling = NullValueHandling.Ignore)]
+        public Image[]? Images { get; set; }
+
+        /// <summary>
+        /// "ratings":
+        /// List of package age ratings for each relevant rating system
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].Ratings for v2.0 onwards
+        /// </summary>
+        [JsonProperty("ratings", NullValueHandling = NullValueHandling.Ignore)]
+        public Rating[]? Ratings { get; set; }
+
+        /// <summary>
+        /// "size":
+        /// Size of package in bytes
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].Size for v2.0 onwards
+        /// </summary>
+        [JsonProperty("size", NullValueHandling = NullValueHandling.Ignore)]
+        public long? Size { get; set; }
+
+        /// <summary>
+        /// "type":
+        /// Package Type
+        /// Known values: "Game" (Game package), "Durable" (DLC package)
+        /// Known Versions Present: 1.0
+        /// Exists within Packages[].Type for v2.0 onwards
+        /// </summary>
+        [JsonProperty("type", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Type { get; set; }
+
+        #endregion
+    }
+}

Xbox/Image.cs

@@ -0,0 +1,25 @@
+using Newtonsoft.Json;
+
+namespace SabreTools.Models.Xbox
+{
+    /// <summary>
+    /// List of image files associated with a package in catalog.js
+    /// </summary>
+    public class Image
+    {
+        /// <summary>
+        /// "size":
+        /// String representing image size
+        /// Known values: "100x100", "208x208", "480x480"
+        /// </summary>
+        [JsonProperty("size", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Size { get; set; }
+
+        /// <summary>
+        /// "image":
+        /// File name of image within MSXC/Metadata/<PackageName>/
+        /// </summary>
+        [JsonProperty("image", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Name { get; set; }
+    }
+}

Xbox/Package.cs

@@ -0,0 +1,162 @@
+using Newtonsoft.Json;
+
+namespace SabreTools.Models.Xbox
+{
+    /// <summary>
+    /// Metadata about each package on disc, in catalog.js
+    /// Packages are stored within /MSXC/
+    /// </summary>
+    public class Package
+    {
+        /// <summary>
+        /// "packageName":
+        /// Package name of variant
+        /// Matches MSXC/<PackageName> and MSXC/Metdata/<PackageName>
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("packageName", NullValueHandling = NullValueHandling.Ignore)]
+        public string? PackageName { get; set; }
+
+        /// <summary>
+        /// "productId":
+        /// Hex identifier for package Product ID
+        /// Known Versions Present: 2.0, 2.1
+        /// </summary>
+        [JsonProperty("productId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? ProductID { get; set; }
+
+        /// <summary>
+        /// "contentId":
+        /// Hex content identifier
+        /// Known Versions present: 2.0, 2.1
+        /// </summary>
+        [JsonProperty("contentId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? ContentID { get; set; }
+
+        /// <summary>
+        /// "xboxProductId":
+        /// Hex product identifier
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("xboxProductId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? XboxProductID { get; set; }
+
+        /// <summary>
+        /// "oneStoreProductId":
+        /// Partner Center Product ID
+        /// 12 character uppercase alphanumeric
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("oneStoreProductId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? OneStoreProductID { get; set; }
+
+        /// <summary>
+        /// "allowedOneStoreProductIds":
+        /// List of OneStoreProductID that this package is associated with
+        /// Used for DLC packages only (Type = "Durable")
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("allowedOneStoreProductIds", NullValueHandling = NullValueHandling.Ignore)]
+        public string[]? AllowedOneStoreProductIDs { get; set; }
+
+        /// <summary>
+        /// "franchiseGameHubId":
+        /// Hex identifier
+        /// Optionally used to mark package as game hub
+        /// Known Versions Present: 4.1
+        /// </summary>
+        [JsonProperty("franchiseGameHubId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? FranchiseGameHubID { get; set; }
+
+        /// <summary>
+        /// "associatedFranchiseGameHubId":
+        /// Hex identifier
+        /// Marks corresponding FranchiseGameHubID that this package is launched with
+        /// Known Versions Present: 4.1
+        /// </summary>
+        [JsonProperty("associatedFranchiseGameHubId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? AssociatedFranchiseGameHubID { get; set; }
+
+        /// <summary>
+        /// "titleId":
+        /// 8 hex character package Title ID
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("titleId", NullValueHandling = NullValueHandling.Ignore)]
+        public string? TitleID { get; set; }
+
+        /// <summary>
+        /// "titles"
+        /// List of name of package for each locale
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("titles", NullValueHandling = NullValueHandling.Ignore)]
+        public Title[]? Titles { get; set; }
+
+        /// <summary>
+        /// "vui":
+        /// List of Voice User Interface packages titles for each locale
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("vui", NullValueHandling = NullValueHandling.Ignore)]
+        public Title[]? VUI { get; set; }
+
+        /// <summary>
+        /// "images":
+        /// List of paths to each image in MSXC/Metadata/<PackageName>/
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("images", NullValueHandling = NullValueHandling.Ignore)]
+        public Image[]? Images { get; set; }
+
+        /// <summary>
+        /// "ratings":
+        /// List of package age ratings for each relevant rating system
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("ratings", NullValueHandling = NullValueHandling.Ignore)]
+        public Rating[]? Ratings { get; set; }
+
+        /// <summary>
+        /// "attributes":
+        /// Extra attributes associated with this package
+        /// Known Versions Present: 2.1, 4.0
+        /// </summary>
+        [JsonProperty("attributes", NullValueHandling = NullValueHandling.Ignore)]
+        public Attribute[]? Attributes { get; set; }
+
+        /// <summary>
+        /// "variants":
+        /// Alternative packages
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("variants", NullValueHandling = NullValueHandling.Ignore)]
+        public Package[]? Variants { get; set; }
+
+        /// <summary>
+        /// "generation":
+        /// Console generation the package is for
+        /// Known values: "8" (XboxOne), "9" (Xbox Series X|S)
+        /// Known Versions Present: 4.0
+        /// </summary>
+        [JsonProperty("generation", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Generation { get; set; }
+
+        /// <summary>
+        /// "size":
+        /// Size of package in bytes
+        /// Known Versions Present: 2.0, 2.1
+        /// </summary>
+        [JsonProperty("size", NullValueHandling = NullValueHandling.Ignore)]
+        public long? Size { get; set; }
+
+        /// <summary>
+        /// "type":
+        /// Package Type
+        /// Known values: "Game" (Game package), "Durable" (DLC package)
+        /// Known Versions Present: 2.0, 2.1, 4.0
+        /// </summary>
+        [JsonProperty("type", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Type { get; set; }
+    }
+}

Xbox/Rating.cs

@@ -0,0 +1,26 @@
+using Newtonsoft.Json;
+
+namespace SabreTools.Models.Xbox
+{
+    /// <summary>
+    /// Package rating for each rating system, in catalog.js
+    /// </summary>
+    public class Rating
+    {
+        /// <summary>
+        /// "system":
+        /// Name of rating system
+        /// Known values: COB-AU, PEGI, PCBP, USK, China, CERO, ESRB, GCAM, CSRR,
+        ///     COB, DJCTQ, GRB, OFLC, OFLC-NZ, PEGIPortugal, FPB, Microsoft
+        /// </summary>
+        [JsonProperty("system", NullValueHandling = NullValueHandling.Ignore)]
+        public string? System { get; set; }
+
+        /// <summary>
+        /// "value":
+        /// String representing rating value, depends on rating system
+        /// </summary>
+        [JsonProperty("value", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Value { get; set; }
+    }
+}

Xbox/Title.cs

@@ -0,0 +1,26 @@
+using Newtonsoft.Json;
+
+namespace SabreTools.Models.Xbox
+{
+    /// <summary>
+    /// Package Title for each locale, for catalog.js
+    /// </summary>
+    public class Title
+    {
+        /// <summary>
+        /// "locale":
+        /// String representing locale that this title is in
+        /// Known values: "default", "en", "de", "fr", "ar", "zh-hans",
+        ///     "zh-hant", "zh-TW", "zh-HK", "zh-CN", "zh-SG", etc
+        /// </summary>
+        [JsonProperty("locale", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Locale { get; set; }
+
+        /// <summary>
+        /// "title":
+        /// Package title
+        /// </summary>
+        [JsonProperty("title", NullValueHandling = NullValueHandling.Ignore)]
+        public string? Name { get; set; }
+    }
+}