add ApiPermissions, add info about required API version

Author: hyperblast

ChangeLog.md

@@ -2,6 +2,7 @@
 - Add support for UpDown volume type and new volume commands
 - Add support for output device configuration
 - Add support for PlayOrPause command
+- Add support for API permissions
 
 # Changes in v0.2 (released 2025-02-14)
 - First official release

src/Client/ApiPermissions.cs

@@ -0,0 +1,22 @@
+namespace Beefweb.Client;
+
+/// <summary>
+/// Specifies which operations are allowed by current configuration.
+/// </summary>
+public sealed class ApiPermissions
+{
+    /// <summary>
+    /// True, if changing playlists is allowed.
+    /// </summary>
+    public bool ChangePlaylists { get; set; }
+
+    /// <summary>
+    /// True, if changing output device is allowed.
+    /// </summary>
+    public bool ChangeOutput { get; set; }
+
+    /// <summary>
+    /// True, if changing client configuration is allowed.
+    /// </summary>
+    public bool ChangeClientConfig { get; set; }
+}

src/Client/IPlayerClient.cs

@@ -104,6 +104,9 @@ ValueTask<PlayerState> GetPlayerState(
     /// </summary>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>Request task.</returns>
+    /// <remarks>
+    /// This method is available since Beefweb v0.10
+    /// </remarks>
     ValueTask PlayOrPause(CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -144,20 +147,29 @@ ValueTask<PlayerState> GetPlayerState(
     /// <param name="volume">New volume value.</param>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>Request task.</returns>
+    /// <remarks>
+    /// This method is available since Beefweb v0.10
+    /// </remarks>
     ValueTask SetVolumeRelative(double volume, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Increases volume.
     /// </summary>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>Request task.</returns>
+    /// <remarks>
+    /// This method is available since Beefweb v0.10
+    /// </remarks>
     ValueTask VolumeUp(CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Decreases volume.
     /// </summary>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>Request task.</returns>
+    /// <remarks>
+    /// This method is available since Beefweb v0.10
+    /// </remarks>
     ValueTask VolumeDown(CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -404,6 +416,9 @@ ValueTask SortPlaylist(
     /// </summary>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>Request task.</returns>
+    /// <remarks>
+    /// This method is available since Beefweb v0.10
+    /// </remarks>
     ValueTask<OutputsInfo> GetOutputs(CancellationToken cancellationToken = default);
 
     /// <summary>
@@ -413,6 +428,9 @@ ValueTask SortPlaylist(
     /// <param name="deviceId">Output device id.</param>
     /// <param name="cancellationToken">Cancellation token.</param>
     /// <returns>Request task.</returns>
+    /// <remarks>
+    /// This method is available since Beefweb v0.10
+    /// </remarks>
     ValueTask SetOutputDevice(string? typeId, string deviceId, CancellationToken cancellationToken = default);
 
     // File browser API

src/Client/PlayerState.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Linq;
 
 namespace Beefweb.Client;
 
@@ -48,6 +47,15 @@ public sealed class PlayerState
     /// </summary>
     public VolumeInfo Volume { get; set; } = null!;
 
+    /// <summary>
+    /// Current permissions.
+    /// </summary>
+    /// <remarks>
+    /// This property is available since Beefweb v0.10
+    /// For earlier value is null.
+    /// </remarks>
+    public ApiPermissions? Permissions { get; set; }
+
     /// <summary>
     /// Gets option with specified <paramref name="id"/>.
     /// </summary>

src/Client/SetPlayerStateRequest.cs

@@ -17,6 +17,9 @@ public sealed class SetPlayerStateRequest
     /// <summary>
     /// New relative volume value.
     /// </summary>
+    /// <remarks>
+    /// This property is available since Beefweb v0.10
+    /// </remarks>
     public double? RelativeVolume { get; set; }
 
     /// <summary>

src/CommandLineTool/Commands/StatusCommand.cs

@@ -29,6 +29,9 @@ public class StatusCommand(IClientProvider clientProvider, ITabularWriter writer
     [Option(T.Playlist, Description = "Display playlist information")]
     public bool Playlist { get; set; }
 
+    [Option("-m|--permissions", Description = "Display permissions")]
+    public bool Permissions { get; set; }
+
     [Option("-r|--version", Description = "Display version information")]
     public bool Version { get; set; }
 
@@ -48,7 +51,7 @@ public override async Task OnExecuteAsync(CancellationToken ct)
         var baseIndex = IndicesFrom0 ? 0 : 1;
         var properties = new List<string[]>();
 
-        if (Playback || All || !(Playlist || Volume || Options || Version))
+        if (Playback || All || !(Playlist || Volume || Options || Permissions || Version))
         {
             var isStopped = state.PlaybackState == PlaybackState.Stopped;
             var track = isStopped ? "none" : activeItem.Columns[0];
@@ -95,6 +98,23 @@ public override async Task OnExecuteAsync(CancellationToken ct)
                 ["", o.Name.CapitalizeFirstChar(), o.FormatValue(IndicesFrom0)]));
         }
 
+        if (Permissions || All)
+        {
+            AddEmptyLine();
+            properties.Add(["Permissions:"]);
+
+            if (state.Permissions == null)
+            {
+                properties.Add(["", "No available"]);
+            }
+            else
+            {
+                properties.Add(["", "Change playlists", state.Permissions.ChangePlaylists.ToString()]);
+                properties.Add(["", "Change output device", state.Permissions.ChangeOutput.ToString()]);
+                properties.Add(["", "Change client configuration", state.Permissions.ChangeClientConfig.ToString()]);
+            }
+        }
+
         if (Version || All)
         {
             AddEmptyLine();