Hide audio writing systems from UI (#1659)

* add `IsAudio` to the writing system

* hide audio writing systems from frontend

* use language tag parsing to determine if it's an audio writing system

* validate that all well known writing systems can be parsed

Author: hahn-kev

backend/FwLite/MiniLcm.Tests/WritingSystemIdTests.cs

@@ -2,16 +2,30 @@
 
 public class WritingSystemIdTests
 {
+    public static IEnumerable<object[]> ValidWritingSystemIds =>
+        WritingSystemCodes.ValidTwoLetterCodes.Select(code => new object[] { code });
+
     [Theory]
+    [MemberData(nameof(ValidWritingSystemIds))]
     [InlineData("en")]
     [InlineData("th")]
+    [InlineData("xba")]
     [InlineData("en-Zxxx-x-audio")]
     public void ValidWritingSystemId_ShouldNotThrow(string code)
     {
         var ws = new WritingSystemId(code);
         ws.Should().NotBe(default);
     }
 
+    [Theory]
+    [InlineData("en-Zxxx-x-audio")]
+    [InlineData("seh-Zxxx-x-audio-var")]
+    public void DetectsAudioWritingSystems(string code)
+    {
+        var ws = new WritingSystemId(code);
+        ws.IsAudio.Should().BeTrue();
+    }
+
     [Theory]
     [InlineData("gx")]
     [InlineData("oo")]

backend/FwLite/MiniLcm/Models/WritingSystem.cs

@@ -6,6 +6,7 @@ public record WritingSystem: IObjectWithId<WritingSystem>
 {
     public required Guid Id { get; set; }
     public virtual required WritingSystemId WsId { get; set; }
+    public bool IsAudio => WsId.IsAudio;
     public virtual required string Name { get; set; }
     public virtual required string Abbreviation { get; set; }
     public virtual required string Font { get; set; }

backend/FwLite/MiniLcm/Models/WritingSystemId.cs

@@ -30,16 +30,27 @@ public override void WriteAsPropertyName(Utf8JsonWriter writer, WritingSystemId
 public readonly record struct WritingSystemId: ISpanFormattable, ISpanParsable<WritingSystemId>
 {
     public string Code { get; init; }
+    public bool IsAudio { get; } = false;
 
     public static readonly WritingSystemId Default = "default";
 
     public WritingSystemId(string code)
     {
         //__key is used by the LfClassicMiniLcmApi to smuggle non guid ids with possibilitie lists
-        if (code == "default" || code == "__key" || IetfLanguageTag.IsValid(code))
+        if (code == "default" || code == "__key")
         {
             Code = code;
         }
+        else if (IetfLanguageTag.TryGetParts(code,
+                     out string? subtag,
+                     out string? script,
+                     out string? region,
+                     out string? variants))
+        {
+            Code = code;
+            IsAudio = script?.Equals(WellKnownSubtags.AudioScript, StringComparison.OrdinalIgnoreCase) == true &&
+                      variants?.Split('-').Any(v => v == WellKnownSubtags.AudioPrivateUse) == true;
+        }
         else
         {
             throw new ArgumentException($"Invalid writing system ID '{code}'", nameof(code));

frontend/viewer/src/SvelteUxProjectView.svelte

@@ -119,7 +119,9 @@
 
   const writingSystemService = initWritingSystemService(deriveAsync(connected, isConnected => {
     if (!isConnected) return Promise.resolve(null);
-    return lexboxApi.getWritingSystems();
+    return lexboxApi.getWritingSystems().then(ws => {
+      return {analysis: ws.analysis.filter(ws => !ws.isAudio), vernacular: ws.vernacular.filter(ws => !ws.isAudio)};
+    });
   }).value);
 
   const trigger = writable(0);

frontend/viewer/src/lib/demo-entry-data.ts

@@ -40,7 +40,8 @@ export const writingSystems: IWritingSystems = {
       'font': '???',
       'exemplars': ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'],
       'type': WritingSystemType.Analysis,
-      'order': 0
+      'order': 0,
+      isAudio: false,
     },
     {
       'id': 'pt',
@@ -50,7 +51,8 @@ export const writingSystems: IWritingSystems = {
       'font': '???',
       'exemplars': ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'],
       'type': WritingSystemType.Analysis,
-      'order': 1
+      'order': 1,
+      isAudio: false,
     }
   ],
   'vernacular': [
@@ -62,7 +64,8 @@ export const writingSystems: IWritingSystems = {
       'font': '???',
       'exemplars': ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'],
       'type': WritingSystemType.Vernacular,
-      'order': 0
+      'order': 0,
+      isAudio: false,
     },
     {
       'id': 'seh-fonipa-x-etic',
@@ -72,7 +75,8 @@ export const writingSystems: IWritingSystems = {
       'font': '???',
       'exemplars': ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z'],
       'type': WritingSystemType.Vernacular,
-      'order': 1
+      'order': 1,
+      isAudio: false,
     }
   ]
 };

frontend/viewer/src/lib/dotnet-types/generated-types/MiniLcm/Models/IWritingSystem.ts

@@ -10,6 +10,7 @@ export interface IWritingSystem extends IObjectWithId
 {
 	id: string;
 	wsId: string;
+	isAudio: boolean;
 	name: string;
 	abbreviation: string;
 	font: string;

frontend/viewer/src/lib/entry-editor/field-editors/MultiOptionEditor.test.svelte.ts

@@ -28,6 +28,7 @@ const context = new Map<string, unknown>([
       exemplars: ['test'],
       order: 0,
       type: WritingSystemType.Vernacular,
+      isAudio: false,
     }],
   }))],
   ['currentView', readable(views[0])],

frontend/viewer/src/lib/sandbox/OptionSandbox.svelte

@@ -18,6 +18,7 @@
       exemplars: [],
       type: WritingSystemType.Analysis,
       order: 0,
+      isAudio: false,
     }],
     vernacular: [],
   }));

frontend/viewer/src/lib/utils.ts

@@ -61,6 +61,7 @@ export function defaultWritingSystem(type: WritingSystemType): IWritingSystem {
   return {
     id: randomId(),
     wsId: 'en',
+    isAudio: false,
     name: 'English',
     abbreviation: 'en',
     font: 'Arial',