Split API to other project + major rework

.github/workflows/deployment.yml

@@ -15,28 +15,33 @@ jobs:
     name: "NuGet Deployment"
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-      name: Checkout Repository
-      with:
-        fetch-depth: 0
+    - uses: actions/checkout@v3
     - name: Setup .NET
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 5.0.x
+        dotnet-version: 6.0.x
     - name: Install dependencies
       run: dotnet restore
+
+    - name: API Update version
+      run: "sed -i \"s#<Version>0.0.0</Version>#<Version>${{ github.event.inputs.version }}</Version>#\" Kits.API/Kits.API.csproj"  
+    - name: API Update package version
+      run: "sed -i \"s#<PackageVersion>0.0.0</PackageVersion>#<PackageVersion>${{ github.event.inputs.version }}</PackageVersion>#\" Kits.API/Kits.API.csproj"  
+    - name: API Update informational version
+      run: "sed -i \"s#<InformationalVersion>0.0.0</InformationalVersion>#<InformationalVersion>${{ github.event.inputs.version }}</InformationalVersion>#\" Kits.API/Kits.API.csproj"    
+
     - name: Update version
       run: "sed -i \"s#<Version>0.0.0</Version>#<Version>${{ github.event.inputs.version }}</Version>#\" Kits/Kits.csproj"  
     - name: Update package version
       run: "sed -i \"s#<PackageVersion>0.0.0</PackageVersion>#<PackageVersion>${{ github.event.inputs.version }}</PackageVersion>#\" Kits/Kits.csproj"  
     - name: Update informational version
-      run: "sed -i \"s#<InformationalVersion>0.0.0</InformationalVersion>#<InformationalVersion>${{ github.event.inputs.version }}</InformationalVersion>#\" Kits/Kits.csproj"              
-    - name: Build
+      run: "sed -i \"s#<InformationalVersion>0.0.0</InformationalVersion>#<InformationalVersion>${{ github.event.inputs.version }}</InformationalVersion>#\" Kits/Kits.csproj"   
+    - name: Build API
+      run: dotnet build Kits.API/Kits.API.csproj --configuration Release --no-restore
+    - name: Build Kits
       run: dotnet build Kits/Kits.csproj --configuration Release --no-restore
     - name: Deploy to NuGet
-      run: dotnet nuget push Kits/bin/Release/*.nupkg
-             --api-key ${{ secrets.NUGET_DEPLOY_KEY }}
-             --source https://api.nuget.org/v3/index.json
+      run: dotnet nuget push *.nupkg --api-key ${{ secrets.NUGET_DEPLOY_KEY }} --source https://api.nuget.org/v3/index.json
     - name: Release to GitHub
       uses: actions/create-release@master
       env:
@@ -48,4 +53,4 @@ jobs:
           Changelog:
             ${{ github.event.inputs.update_notes }}
         release_name: DiFFoZ.Kits v${{ github.event.inputs.version }}
-        tag_name: v${{ github.event.inputs.version }}
+        tag_name: v${{ github.event.inputs.version }}

Kits.API/Configuration/GenericOptions.cs

@@ -0,0 +1,46 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Kits.API.Configuration;
+public class GenericOptions<TProvider> where TProvider : class
+{
+    private readonly List<(Type implementationService, string name)> m_KitProviders = new();
+    public IReadOnlyCollection<(Type implementationService, string name)> KitProviders => m_KitProviders.AsReadOnly();
+
+    public void AddProvider<T>(string name) where T : TProvider
+    {
+        AddProvider(typeof(T), name);
+    }
+
+    public void AddProvider(Type type, string name)
+    {
+        if (!typeof(TProvider).IsAssignableFrom(type))
+        {
+            throw new Exception($"Type {type} must be an instance of {typeof(TProvider).Name}!");
+        }
+
+        if (m_KitProviders.Any(x => x.name.Equals(name, StringComparison.OrdinalIgnoreCase)))
+        {
+            return;
+        }
+
+        m_KitProviders.Add((type, name));
+    }
+
+    public void RemoveProvider<T>() where T : TProvider
+    {
+        RemoveProvider(typeof(T));
+    }
+
+    public void RemoveProvider(Type type)
+    {
+        m_KitProviders.RemoveAll(c => c.implementationService == type);
+    }
+
+    public Type? FindType(string type)
+    {
+        return m_KitProviders.Find(x => x.name.Equals(type, StringComparison.OrdinalIgnoreCase))
+            .implementationService;
+    }
+}

Kits.API/Cooldowns/IKitCooldownStore.cs

@@ -0,0 +1,14 @@
+using OpenMod.API.Ioc;
+using OpenMod.API.Permissions;
+using System;
+using System.Threading.Tasks;
+
+namespace Kits.API.Cooldowns;
+
+[Service]
+public interface IKitCooldownStore
+{
+    Task<TimeSpan?> GetLastCooldownAsync(IPermissionActor actor, string kitName);
+
+    Task RegisterCooldownAsync(IPermissionActor actor, string kitName, DateTime time);
+}

Kits.API/Cooldowns/IKitCooldownStoreProvider.cs

@@ -0,0 +1,7 @@
+using System.Threading.Tasks;
+
+namespace Kits.API.Cooldowns;
+public interface IKitCooldownStoreProvider : IKitCooldownStore
+{
+    Task InitAsync();
+}

Kits.API/Cooldowns/KitCooldownOptions.cs

@@ -0,0 +1,6 @@
+using Kits.API.Configuration;
+
+namespace Kits.API.Cooldowns;
+public class KitCooldownOptions : GenericOptions<IKitCooldownStoreProvider>
+{
+}

Kits.API/Databases/IKitStoreProvider.cs

@@ -0,0 +1,8 @@
+using System.Threading.Tasks;
+
+namespace Kits.API.Databases;
+
+public interface IKitStoreProvider : IKitStore
+{
+    Task InitAsync();
+}

Kits.API/Databases/KitStoreOptions.cs

@@ -0,0 +1,6 @@
+using Kits.API.Configuration;
+
+namespace Kits.API.Databases;
+public class KitStoreOptions : GenericOptions<IKitStoreProvider>
+{
+}

Kits.API/IKitManager.cs

@@ -0,0 +1,18 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Kits.API.Models;
+using OpenMod.API.Commands;
+using OpenMod.API.Ioc;
+using OpenMod.Extensions.Games.Abstractions.Players;
+
+namespace Kits.API;
+
+[Service]
+public interface IKitManager
+{
+    Task GiveKitAsync(IPlayerUser user, string name, ICommandActor? instigator = null, bool forceGiveKit = false);
+
+    Task GiveKitAsync(IPlayerUser user, Kit kit, ICommandActor? instigator = null, bool forceGiveKit = false);
+
+    Task<IReadOnlyCollection<Kit>> GetAvailableKitsForPlayerAsync(IPlayerUser player);
+}

Kits.API/IKitStore.cs

@@ -0,0 +1,30 @@
+using Kits.API.Databases;
+using Kits.API.Models;
+using OpenMod.API.Ioc;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Kits.API;
+
+/// <summary>
+/// The service for getting kits
+/// </summary>
+[Service]
+public interface IKitStore
+{
+    /// <summary>
+    /// Gets the kits from <see cref="IKitStoreProvider"/>
+    /// </summary>
+    /// <returns>Kits list</returns>
+    Task<IReadOnlyCollection<Kit>> GetKitsAsync();
+
+    Task<Kit?> FindKitByNameAsync(string name);
+
+    Task<bool> IsKitExists(string name);
+
+    Task AddKitAsync(Kit kit);
+
+    Task RemoveKitAsync(string name);
+
+    Task UpdateKitAsync(Kit kit);
+}

Kits.API/Kits.API.csproj

@@ -0,0 +1,37 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<TargetFrameworks>netstandard2.0</TargetFrameworks>
+		<PackageLicenseExpression>EUPL-1.2</PackageLicenseExpression>
+		<RootNamespace>Kits.API</RootNamespace>
+		<AssemblyName>Kits.API</AssemblyName>
+		<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+		<GenerateNugetPackage>true</GenerateNugetPackage>
+		<Product>Kits.API</Product>
+		<LangVersion>10</LangVersion>
+		<Nullable>enable</Nullable>
+		<WarningsAsErrors>nullable</WarningsAsErrors>
+		<Version>0.0.0</Version>
+		<InformationalVersion>0.0.0</InformationalVersion>
+		<PackageVersion>0.0.0</PackageVersion>
+		<Authors>EvolutionPlugins</Authors>
+		<Company>EvolutionPlugins</Company>
+		<PackageId>DiFFoZ.Kits.API</PackageId>
+		<Description>API of OpenMod kits plugin</Description>
+		<RepositoryUrl>https://github.com/DiFFoZ/Kits</RepositoryUrl>
+		<RepositoryType>git</RepositoryType>
+		<PackageProjectUrl>https://github.com/DiFFoZ/Kits</PackageProjectUrl>
+		<PackageReadmeFile>README.md</PackageReadmeFile>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<PackageReference Include="OpenMod.Core" Version="3.3.15" />
+		<PackageReference Include="OpenMod.Extensions.Economy.Abstractions" Version="3.3.15" />
+		<PackageReference Include="OpenMod.Extensions.Games.Abstractions" Version="3.3.15" />
+	</ItemGroup>
+
+	<ItemGroup>
+		<None Include="..\README.md" Pack="true" PackagePath="\"/>
+	</ItemGroup>
+
+</Project>

Kits.API/Models/Kit.cs

@@ -0,0 +1,82 @@
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Localization;
+using Microsoft.Extensions.Logging;
+using OpenMod.Extensions.Economy.Abstractions;
+using OpenMod.Extensions.Games.Abstractions.Items;
+using OpenMod.Extensions.Games.Abstractions.Players;
+using OpenMod.Extensions.Games.Abstractions.Vehicles;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations;
+using System.ComponentModel.DataAnnotations.Schema;
+using System.Threading.Tasks;
+using YamlDotNet.Serialization;
+
+namespace Kits.API.Models;
+
+public sealed class Kit
+{
+    [YamlIgnore]
+    [Key]
+    [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
+    public int Id { get; set; }
+
+    [StringLength(25)]
+    [Required]
+    public string Name { get; set; } = string.Empty;
+
+    public float Cooldown { get; set; }
+
+    [Column(TypeName = "decimal(18,2)")] // by default it creates decimal(65, 30)
+    public decimal Cost { get; set; }
+
+    [Column(TypeName = "decimal(18,2)")] // by default it creates decimal(65, 30)
+    public decimal Money { get; set; }
+
+    [StringLength(5)]
+    public string? VehicleId { get; set; }
+
+    [MaxLength(ushort.MaxValue)]
+    [Column(TypeName = "blob")] // by default it creates longblob (2^32 - 1), we need only ushort.MaxValue length ( 65535 )
+    public List<KitItem>? Items { get; set; }
+
+    public async Task GiveKitToPlayer(IPlayerUser playerUser, IServiceProvider serviceProvider)
+    {
+        var stringLocalizer = serviceProvider.GetRequiredService<IStringLocalizer>();
+        var logger = serviceProvider.GetRequiredService<ILogger<Kit>>();
+
+        if (Items != null && playerUser.Player is IHasInventory hasInventory && hasInventory.Inventory != null)
+        {
+            var itemSpawner = serviceProvider.GetRequiredService<IItemSpawner>();
+
+            foreach (var item in Items)
+            {
+                var result = await itemSpawner.GiveItemAsync(hasInventory.Inventory, item.ItemAssetId,
+                        item.State);
+                if (result == null)
+                {
+                    logger.LogWarning("Item {Id} was unable to give to player {Name})", item.ItemAssetId, playerUser.FullActorName);
+                }
+            }
+        }
+
+        if (!string.IsNullOrEmpty(VehicleId))
+        {
+            var vehicleSpawner = serviceProvider.GetRequiredService<IVehicleSpawner>();
+
+            var result = await vehicleSpawner.SpawnVehicleAsync(playerUser.Player, VehicleId!);
+            if (result == null)
+            {
+                logger.LogWarning("Vehicle {Id} was unable to give to player {Name})", VehicleId, playerUser.FullActorName);
+            }
+        }
+
+        if (Money != 0)
+        {
+            var economyProvider = serviceProvider.GetRequiredService<IEconomyProvider>();
+
+            await economyProvider.UpdateBalanceAsync(playerUser.Id, playerUser.Type, Money,
+                stringLocalizer["commands:kit:balanceUpdateReason:got"]);
+        }
+    }
+}

Kits.API/Models/KitItem.cs

@@ -0,0 +1,45 @@
+using OpenMod.Extensions.Games.Abstractions.Items;
+using System;
+using System.IO;
+using System.Linq;
+
+namespace Kits.API.Models;
+
+public class KitItem
+{
+    public string ItemAssetId { get; set; }
+
+    public KitItemState State { get; set; }
+
+    public KitItem() : this(null, null)
+    {
+    }
+
+    public KitItem(string? itemAssetId, IItemState? itemState)
+    {
+        ItemAssetId = itemAssetId ?? string.Empty;
+        State = new KitItemState(itemState);
+    }
+
+    public void Serialize(BinaryWriter bw)
+    {
+        bw.Write(ItemAssetId);
+        State.Serialize(bw);
+    }
+
+    public void Deserialize(BinaryReader br)
+    {
+        ItemAssetId = br.ReadString();
+        State.Deserialize(br);
+    }
+
+    public override int GetHashCode()
+    {
+        var itemStateDataHash = State.StateData.Aggregate(new HashCode(), (hash, i) =>
+        {
+            hash.Add(i);
+            return hash;
+        }).ToHashCode();
+        return HashCode.Combine(ItemAssetId, State.ItemAmount, State.ItemQuality, State.ItemDurability, itemStateDataHash);
+    }
+}