Add custom views (#2215)

* Implement custom views backend

* Enhance example project with custom view and manager role

* Implement custom views frontend

* Avoid references in view objects

* Show examples even if no sense fields

* Update verified regression data

* Use project-storage not localStorage for current view

* Move frontend custom-view code into sub-folder

* init project storage in demo api

* Apply cursor-pointer to view labels

* Reset validation error when submitting

* Make custom-views lite-only feature in UI

* Select view after saving

Author: myieye

backend/FwLite/FwLiteShared/Services/MiniLcmJsInvokable.cs

@@ -24,14 +24,14 @@ MiniLcmApiStringNormalizationWrapperFactory normalizationWrapperFactory
 {
     private readonly IMiniLcmApi _wrappedApi = api.WrapWith([normalizationWrapperFactory, validationWrapperFactory, notificationWrapperFactory], project);
 
-    public record MiniLcmFeatures(bool? History, bool? Write, bool? OpenWithFlex, bool? Feedback, bool? Sync, bool? Audio);
+    public record MiniLcmFeatures(bool? History, bool? Write, bool? OpenWithFlex, bool? Feedback, bool? Sync, bool? Audio, bool? CustomViews);
     private bool SupportsSync => project.DataFormat == ProjectDataFormat.Harmony && api is CrdtMiniLcmApi;
     [JSInvokable]
     public MiniLcmFeatures SupportedFeatures()
     {
         var isCrdtProject = project.DataFormat == ProjectDataFormat.Harmony;
         var isFwDataProject = project.DataFormat == ProjectDataFormat.FwData;
-        return new(History: isCrdtProject, Write: CanWrite, OpenWithFlex: isFwDataProject, Feedback: true, Sync: SupportsSync, Audio: true);
+        return new(History: isCrdtProject, Write: CanWrite, OpenWithFlex: isFwDataProject, Feedback: true, Sync: SupportsSync, Audio: true, CustomViews: isCrdtProject);
     }
 
     private bool CanWrite =>
@@ -82,6 +82,19 @@ public ValueTask<ComplexFormType[]> GetComplexFormTypes()
         return _wrappedApi.GetComplexFormTypes().ToArrayAsync();
     }
 
+    [JSInvokable]
+    public ValueTask<CustomView[]> GetCustomViews()
+    {
+        return _wrappedApi.GetCustomViews().ToArrayAsync();
+    }
+
+    [JSInvokable]
+    [TsFunction(Type = "Promise<ICustomView | null>")]
+    public Task<CustomView?> GetCustomView(Guid id)
+    {
+        return _wrappedApi.GetCustomView(id);
+    }
+
     [JSInvokable]
     [TsFunction(Type = "Promise<IComplexFormType | null>")]
     public Task<ComplexFormType?> GetComplexFormType(Guid id)
@@ -231,6 +244,29 @@ public async Task DeleteComplexFormType(Guid id)
         OnDataChanged();
     }
 
+    [JSInvokable]
+    public async Task<CustomView> CreateCustomView(CustomView customView)
+    {
+        var createdCustomView = await _wrappedApi.CreateCustomView(customView);
+        OnDataChanged();
+        return createdCustomView;
+    }
+
+    [JSInvokable]
+    public async Task<CustomView> UpdateCustomView(CustomView customView)
+    {
+        var updatedCustomView = await _wrappedApi.UpdateCustomView(customView);
+        OnDataChanged();
+        return updatedCustomView;
+    }
+
+    [JSInvokable]
+    public async Task DeleteCustomView(Guid id)
+    {
+        await _wrappedApi.DeleteCustomView(id);
+        OnDataChanged();
+    }
+
     [JSInvokable]
     public async Task<Entry> CreateEntry(Entry entry)
     {

backend/FwLite/FwLiteShared/TypeGen/ReinforcedFwLiteTypingConfig.cs

@@ -87,7 +87,9 @@ private static void ConfigureMiniLcmTypes(ConfigurationBuilder builder)
                 typeof(Translation),
 
                 typeof(MediaFile),
-                typeof(LcmFileMetadata)
+                typeof(LcmFileMetadata),
+                typeof(ViewField),
+                typeof(ViewWritingSystem),
             ],
             exportBuilder => exportBuilder.WithPublicNonStaticProperties(exportBuilder =>
         {
@@ -148,6 +150,7 @@ private static void ConfigureFwLiteSharedTypes(ConfigurationBuilder builder)
         builder.ExportAsEnum<SyncStatus>().UseString();
         builder.ExportAsEnum<DownloadProjectByCodeResult>().UseString();
         builder.ExportAsEnum<SyncJobStatusEnum>().UseString();
+        builder.ExportAsEnum<ViewBase>().UseString();
         var serviceTypes = Enum.GetValues<DotnetService>()
             //lcm has it's own dedicated export, config is not a service just a object, and testing needs a custom export below
             .Where(s => s is not (DotnetService.MiniLcmApi or DotnetService.FwLiteConfig or DotnetService.TroubleshootingService))

backend/FwLite/LcmCrdt.Tests/Changes/ChangeDeserializationRegressionData.latest.verified.txt

@@ -698,5 +698,55 @@
     "$type": "SetFirstTranslationIdChange",
     "TranslationId": "349419f8-65f4-1a81-42f4-b641837fa203",
     "EntityId": "d5ddbafb-d417-5df1-f4a4-d1224bdfac42"
+  },
+  {
+    "$type": "CreateCustomViewChange",
+    "Name": "Afghani",
+    "Base": "FieldWorks",
+    "EntryFields": [
+      {
+        "FieldId": "middleware"
+      }
+    ],
+    "SenseFields": [
+      {
+        "FieldId": "SMS"
+      }
+    ],
+    "ExampleFields": [],
+    "Vernacular": [
+      {
+        "WsId": "txq"
+      }
+    ],
+    "Analysis": null,
+    "EntityId": "935d8100-6254-f587-c712-65469362105f"
+  },
+  {
+    "$type": "EditCustomViewChange",
+    "Name": "Rial Omani",
+    "Base": "FieldWorks",
+    "EntryFields": [
+      {
+        "FieldId": "fresh-thinking"
+      }
+    ],
+    "SenseFields": [
+      {
+        "FieldId": "Auto Loan Account"
+      }
+    ],
+    "ExampleFields": [],
+    "Vernacular": [
+      {
+        "WsId": "nrk"
+      }
+    ],
+    "Analysis": null,
+    "EntityId": "99082da6-745e-9aaa-5231-3b83bd84e0e7"
+  },
+  {
+    "$type": "delete:CustomView",
+    "EntityId": "c954bd38-e4b5-ce57-0069-2a6edc91e629"
   }
 ]

backend/FwLite/LcmCrdt.Tests/Changes/UseChangesTests.cs

@@ -259,5 +259,35 @@ private static IEnumerable<ChangeWithDependencies> GetAllChanges()
         yield return new ChangeWithDependencies(
             new RemoteResourceUploadedChange(createRemoteResourcePendingUploadChange.EntityId, "test-remote-id"),
             [createRemoteResourcePendingUploadChange]);
+
+        var customView = new CustomView
+        {
+            Id = Guid.NewGuid(),
+            Name = "Test View",
+            Base = ViewBase.FwLite,
+            EntryFields = [new ViewField { FieldId = "lexemeForm" }],
+            SenseFields = [],
+            ExampleFields = [new ViewField { FieldId = "sentence" }],
+            Vernacular = null,
+            Analysis = [new ViewWritingSystem { WsId = "en" }],
+        };
+        var createCustomViewChange = new CreateCustomViewChange(
+            customView.Id,
+            customView
+        );
+        yield return new ChangeWithDependencies(createCustomViewChange);
+        var editCustomViewChange = new EditCustomViewChange(
+            customView.Id,
+            customView with
+            {
+                Name = "Updated View",
+                Base = ViewBase.FieldWorks,
+                EntryFields = [new ViewField { FieldId = "citationForm" }],
+                SenseFields = [new ViewField { FieldId = "definition" }],
+                ExampleFields = [],
+                Vernacular = [new ViewWritingSystem { WsId = "fr" }],
+                Analysis = null
+            });
+        yield return new ChangeWithDependencies(editCustomViewChange, [createCustomViewChange]);
     }
 }

backend/FwLite/LcmCrdt.Tests/ConfigRegistrationTests.cs

@@ -15,7 +15,8 @@ public class ConfigRegistrationTests
         typeof(ReplaceComplexFormTypeChange), //not currently in use
         typeof(JsonPatchChange<ComplexFormComponent>), //not supported
         typeof(JsonPatchChange<RemoteResource>), //not supported
-        typeof(JsonPatchChange<ExampleSentence>)//replaced by JsonPatchExampleSentenceChange
+        typeof(JsonPatchChange<ExampleSentence>), //replaced by JsonPatchExampleSentenceChange
+        typeof(JsonPatchChange<CustomView>), //not supported. Use EditCustomViewChange
     ];
 
     private readonly CrdtConfig _config;

backend/FwLite/LcmCrdt.Tests/Data/SnapshotDeserializationRegressionData.latest.verified.txt

@@ -1,4 +1,4 @@
-[
+[
   {
     "$type": "MiniLcmCrdtAdapter",
     "Obj": {
@@ -1585,5 +1585,34 @@
     "Id": "fce4cb31-93bd-f380-fd73-3fb0d09c0fa5",
     "DeletedAt": "2025-09-17T23:53:03.6147633+02:00",
     "RemoteId": "end-to-end"
+  },
+  {
+    "$type": "MiniLcmCrdtAdapter",
+    "Obj": {
+      "$type": "CustomView",
+      "Id": "72bcb2dd-4d73-486c-d5df-e5d7b9a6a3eb",
+      "DeletedAt": null,
+      "Name": "Mountain",
+      "Base": "FieldWorks",
+      "EntryFields": [
+        {
+          "FieldId": "spidy"
+        }
+      ],
+      "SenseFields": [
+        {
+          "FieldId": "Division"
+        }
+      ],
+      "ExampleFields": [],
+      "Vernacular": [
+        {
+          "WsId": "kup"
+        }
+      ],
+      "Analysis": null
+    },
+    "Id": "72bcb2dd-4d73-486c-d5df-e5d7b9a6a3eb",
+    "DeletedAt": null
   }
 ]

backend/FwLite/LcmCrdt.Tests/DataModelSnapshotTests.VerifyChangeModels.verified.txt

@@ -180,6 +180,18 @@
       DerivedType: CreateComplexFormType,
       TypeDiscriminator: CreateComplexFormType
     },
+    {
+      DerivedType: CreateCustomViewChange,
+      TypeDiscriminator: CreateCustomViewChange
+    },
+    {
+      DerivedType: EditCustomViewChange,
+      TypeDiscriminator: EditCustomViewChange
+    },
+    {
+      DerivedType: DeleteChange<CustomView>,
+      TypeDiscriminator: delete:CustomView
+    },
     {
       DerivedType: SetOrderChange<Sense>,
       TypeDiscriminator: SetOrderChange:Sense

backend/FwLite/LcmCrdt.Tests/DataModelSnapshotTests.VerifyDbModel.verified.txt

@@ -100,6 +100,42 @@
       Relational:TableName: ComplexFormType
       Relational:ViewName: 
       Relational:ViewSchema: 
+  EntityType: CustomView
+    Properties: 
+      Id (Guid) Required PK AfterSave:Throw ValueGenerated.OnAdd
+      Analysis (ViewWritingSystem[])
+        Annotations: 
+          Relational:ColumnType: jsonb
+      Base (ViewBase) Required
+      DeletedAt (DateTimeOffset?)
+      EntryFields (ViewField[]) Required
+        Annotations: 
+          Relational:ColumnType: jsonb
+      ExampleFields (ViewField[]) Required
+        Annotations: 
+          Relational:ColumnType: jsonb
+      Name (string) Required
+      SenseFields (ViewField[]) Required
+        Annotations: 
+          Relational:ColumnType: jsonb
+      SnapshotId (no field, Guid?) Shadow FK Index
+      Vernacular (ViewWritingSystem[])
+        Annotations: 
+          Relational:ColumnType: jsonb
+    Keys: 
+      Id PK
+    Foreign keys: 
+      CustomView {'SnapshotId'} -> ObjectSnapshot {'Id'} Unique SetNull
+    Indexes: 
+      SnapshotId Unique
+    Annotations: 
+      DiscriminatorProperty: 
+      Relational:FunctionName: 
+      Relational:Schema: 
+      Relational:SqlQuery: 
+      Relational:TableName: CustomView
+      Relational:ViewName: 
+      Relational:ViewSchema: 
   EntityType: Entry
     Properties: 
       Id (Guid) Required PK AfterSave:Throw ValueGenerated.OnAdd

backend/FwLite/LcmCrdt.Tests/DataModelSnapshotTests.VerifyIObjectWithIdModels.verified.txt

@@ -35,6 +35,10 @@
     {
       DerivedType: ComplexFormComponent,
       TypeDiscriminator: ComplexFormComponent
+    },
+    {
+      DerivedType: CustomView,
+      TypeDiscriminator: CustomView
     }
   ],
   IgnoreUnrecognizedTypeDiscriminators: false,