SF-3505 Add Lynx options in settings and remove feature flag (#3392)

Author: siltomato

src/RealtimeServer/scriptureforge/models/lynx-config.ts

@@ -0,0 +1,6 @@
+export interface LynxConfig {
+  autoCorrectionsEnabled: boolean;
+  assessmentsEnabled: boolean;
+  punctuationCheckerEnabled: boolean;
+  allowedCharacterCheckerEnabled: boolean;
+}

src/RealtimeServer/scriptureforge/models/sf-project-test-data.ts

@@ -44,6 +44,12 @@ function testProjectProfile(ordinal: number): SFProjectProfile {
       biblicalTermsEnabled: false,
       hasRenderings: false
     },
+    lynxConfig: {
+      autoCorrectionsEnabled: false,
+      assessmentsEnabled: false,
+      punctuationCheckerEnabled: false,
+      allowedCharacterCheckerEnabled: false
+    },
     editable: true,
     defaultFontSize: 12,
     defaultFont: 'Charis SIL',

src/RealtimeServer/scriptureforge/models/sf-project.ts

@@ -4,6 +4,7 @@ import { WritingSystem } from '../../common/models/writing-system';
 import { obj } from '../../common/utils/obj-path';
 import { BiblicalTermsConfig } from './biblical-terms-config';
 import { CheckingConfig } from './checking-config';
+import { LynxConfig } from './lynx-config';
 import { NoteTag } from './note-tag';
 import { ParatextUserProfile } from './paratext-user-profile';
 import { Sync } from './sync';
@@ -38,6 +39,7 @@ export interface SFProjectProfile extends Project {
   translateConfig: TranslateConfig;
   checkingConfig: CheckingConfig;
   resourceConfig?: ResourceConfig;
+  lynxConfig: LynxConfig;
   texts: TextInfo[];
   noteTags?: NoteTag[];
   sync: Sync;

src/RealtimeServer/scriptureforge/services/sf-project-migrations.ts

@@ -453,6 +453,30 @@ class SFProjectMigration24 extends DocMigration {
   }
 }
 
+class SFProjectMigration25 extends DocMigration {
+  static readonly VERSION = 25;
+
+  async migrateDoc(doc: Doc): Promise<void> {
+    const ops: Op[] = [];
+    if (doc.data.lynxConfig == null) {
+      ops.push({ p: ['lynxConfig'], oi: {} });
+    }
+    if (doc.data.lynxConfig?.autoCorrectionsEnabled == null) {
+      ops.push({ p: ['lynxConfig', 'autoCorrectionsEnabled'], oi: false });
+    }
+    if (doc.data.lynxConfig?.assessmentsEnabled == null) {
+      ops.push({ p: ['lynxConfig', 'assessmentsEnabled'], oi: false });
+    }
+    if (doc.data.lynxConfig?.punctuationCheckerEnabled == null) {
+      ops.push({ p: ['lynxConfig', 'punctuationCheckerEnabled'], oi: false });
+    }
+    if (doc.data.lynxConfig?.allowedCharacterCheckerEnabled == null) {
+      ops.push({ p: ['lynxConfig', 'allowedCharacterCheckerEnabled'], oi: false });
+    }
+    await submitMigrationOp(SFProjectMigration25.VERSION, doc, ops);
+  }
+}
+
 export const SF_PROJECT_MIGRATIONS: MigrationConstructor[] = monotonicallyIncreasingMigrationList([
   SFProjectMigration1,
   SFProjectMigration2,
@@ -477,5 +501,6 @@ export const SF_PROJECT_MIGRATIONS: MigrationConstructor[] = monotonicallyIncrea
   SFProjectMigration21,
   SFProjectMigration22,
   SFProjectMigration23,
-  SFProjectMigration24
+  SFProjectMigration24,
+  SFProjectMigration25
 ]);

src/RealtimeServer/scriptureforge/services/sf-project-service.ts

@@ -31,6 +31,7 @@ const SF_PROJECT_PROFILE_FIELDS: ShareDB.ProjectionFields = {
   defaultFont: true,
   translateConfig: true,
   checkingConfig: true,
+  lynxConfig: true,
   texts: true,
   syncDisabled: true,
   sync: true,
@@ -391,6 +392,24 @@ export class SFProjectService extends ProjectService<SFProject> {
         },
         additionalProperties: false
       },
+      lynxConfig: {
+        bsonType: 'object',
+        properties: {
+          autoCorrectionsEnabled: {
+            bsonType: 'bool'
+          },
+          assessmentsEnabled: {
+            bsonType: 'bool'
+          },
+          punctuationCheckerEnabled: {
+            bsonType: 'bool'
+          },
+          allowedCharacterCheckerEnabled: {
+            bsonType: 'bool'
+          }
+        },
+        additionalProperties: false
+      },
       resourceConfig: {
         bsonType: 'object',
         properties: {
@@ -586,6 +605,7 @@ export class SFProjectService extends ProjectService<SFProject> {
       this.pathTemplate(p => p.texts),
       this.pathTemplate(p => p.translateConfig),
       this.pathTemplate(p => p.checkingConfig),
+      this.pathTemplate(p => p.lynxConfig),
       this.pathTemplate(p => p.shortName),
       this.pathTemplate(p => p.writingSystem),
       this.pathTemplate(p => p.copyrightBanner),

src/SIL.XForge.Scripture/ClientApp/src/app/core/models/sf-project-settings.ts

@@ -26,4 +26,9 @@ export interface SFProjectSettings {
   communityCheckersShareEnabled?: boolean | null;
   commentersShareEnabled?: boolean | null;
   viewersShareEnabled?: boolean | null;
+
+  lynxAutoCorrectionsEnabled?: boolean | null;
+  lynxAssessmentsEnabled?: boolean | null;
+  lynxPunctuationCheckerEnabled?: boolean | null;
+  lynxAllowedCharacterCheckerEnabled?: boolean | null;
 }

src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.html

@@ -316,6 +316,74 @@ <h4>{{ t("sharing_scripture_forge_guests") }}</h4>
             </div>
           </mat-card-content>
         </mat-card>
+
+        <!-- Lynx Settings Card -->
+        <mat-card>
+          <mat-card-content>
+            <mat-card-title class="lynx-settings-title"
+              >{{ t("lynx_settings_header") }}<span class="beta-tag">{{ t("beta_tag") }}</span></mat-card-title
+            >
+            <p class="helper-text">{{ t("lynx_settings_description") }}</p>
+            <app-notice type="info" icon="info" class="requirements">{{ t("lynx_latin_script_notice") }}</app-notice>
+            <div class="tool-setting">
+              <div class="tool-setting-field checkbox-field">
+                <mat-checkbox formControlName="lynxAutoCorrectionsEnabled" id="checkbox-lynx-auto-corrections">
+                  {{ t("lynx_auto_corrections") }}
+                </mat-checkbox>
+                <app-info [text]="t('lynx_auto_corrections_help')"></app-info>
+                <app-write-status
+                  [state]="getControlState('lynxAutoCorrectionsEnabled')"
+                  [formGroup]="form"
+                  id="lynx-auto-corrections-status"
+                ></app-write-status>
+              </div>
+            </div>
+            <div class="tool-setting">
+              <div class="tool-setting-field checkbox-field">
+                <mat-checkbox formControlName="lynxAssessmentsEnabled" id="checkbox-lynx-assessments">
+                  {{ t("lynx_assessments") }}
+                </mat-checkbox>
+                <app-info [text]="t('lynx_assessments_help')"></app-info>
+                <app-write-status
+                  [state]="getControlState('lynxAssessmentsEnabled')"
+                  [formGroup]="form"
+                  id="lynx-assessments-status"
+                ></app-write-status>
+              </div>
+            </div>
+            @if (isLynxAssessmentsEnabled) {
+              <div class="tool-setting">
+                <div class="tool-setting-field checkbox-field child-setting">
+                  <mat-checkbox formControlName="lynxPunctuationCheckerEnabled" id="checkbox-lynx-punctuation-checker">
+                    {{ t("lynx_punctuation_checker") }}
+                  </mat-checkbox>
+                  <app-info [text]="t('lynx_punctuation_checker_help')"></app-info>
+                  <app-write-status
+                    [state]="getControlState('lynxPunctuationCheckerEnabled')"
+                    [formGroup]="form"
+                    id="lynx-punctuation-checker-status"
+                  ></app-write-status>
+                </div>
+              </div>
+              <div class="tool-setting">
+                <div class="tool-setting-field checkbox-field child-setting">
+                  <mat-checkbox
+                    formControlName="lynxAllowedCharacterCheckerEnabled"
+                    id="checkbox-lynx-allowed-character-checker"
+                  >
+                    {{ t("lynx_allowed_character_checker") }}
+                  </mat-checkbox>
+                  <app-info [text]="t('lynx_allowed_character_checker_help')"></app-info>
+                  <app-write-status
+                    [state]="getControlState('lynxAllowedCharacterCheckerEnabled')"
+                    [formGroup]="form"
+                    id="lynx-allowed-character-checker-status"
+                  ></app-write-status>
+                </div>
+              </div>
+            }
+          </mat-card-content>
+        </mat-card>
       </form>
     </div>
 

src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.scss

@@ -86,6 +86,10 @@ mat-icon {
   align-items: center;
 }
 
+.child-setting {
+  margin-inline-start: 24px;
+}
+
 #btn-log-in-settings {
   background-color: variables.$pt-button-green;
   color: white;
@@ -184,3 +188,18 @@ form {
   flex-direction: column;
   row-gap: 16px;
 }
+
+.lynx-settings-title {
+  display: flex;
+  align-items: center;
+}
+
+.beta-tag {
+  font-size: 0.55em;
+  color: var(--sys-on-primary);
+  background-color: var(--sys-on-primary-container);
+  padding: 0.2em 0.6em;
+  border-radius: 1em;
+  margin-inline-start: 1.5em;
+  line-height: 1.2em;
+}

src/SIL.XForge.Scripture/ClientApp/src/app/settings/settings.component.ts

@@ -29,6 +29,7 @@ import { SFProjectSettings } from '../core/models/sf-project-settings';
 import { ParatextService, SelectableProject } from '../core/paratext.service';
 import { SFProjectService } from '../core/sf-project.service';
 import { DeleteProjectDialogComponent } from './delete-project-dialog/delete-project-dialog.component';
+
 /** Allows user to configure high-level settings of how SF will use their Paratext project. */
 @Component({
   selector: 'app-settings',
@@ -48,6 +49,10 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit {
   communityCheckersShareEnabled = new FormControl(false);
   commentersShareEnabled = new FormControl(false);
   viewersShareEnabled = new FormControl(false);
+  lynxAutoCorrectionsEnabled = new FormControl(false);
+  lynxAssessmentsEnabled = new FormControl(false);
+  lynxPunctuationCheckerEnabled = new FormControl(false);
+  lynxAllowedCharacterCheckerEnabled = new FormControl(false);
 
   // Expose enums to the template
   CheckingAnswerExport = CheckingAnswerExport;
@@ -65,7 +70,11 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit {
     translatorsShareEnabled: this.translatorsShareEnabled,
     communityCheckersShareEnabled: this.communityCheckersShareEnabled,
     commentersShareEnabled: this.commentersShareEnabled,
-    viewersShareEnabled: this.viewersShareEnabled
+    viewersShareEnabled: this.viewersShareEnabled,
+    lynxAutoCorrectionsEnabled: this.lynxAutoCorrectionsEnabled,
+    lynxAssessmentsEnabled: this.lynxAssessmentsEnabled,
+    lynxPunctuationCheckerEnabled: this.lynxPunctuationCheckerEnabled,
+    lynxAllowedCharacterCheckerEnabled: this.lynxAllowedCharacterCheckerEnabled
   });
 
   isActiveSourceProject: boolean = false;
@@ -130,6 +139,10 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit {
     return this.checkingEnabled.value ?? false;
   }
 
+  get isLynxAssessmentsEnabled(): boolean {
+    return this.lynxAssessmentsEnabled.value ?? false;
+  }
+
   get showPreTranslationSettings(): boolean {
     const translateConfig = this.projectDoc?.data?.translateConfig;
     if (translateConfig == null) {
@@ -358,6 +371,9 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit {
     this.updateSharingSetting(newValue, 'communityCheckersShareEnabled', SFProjectRole.CommunityChecker);
     this.updateSharingSetting(newValue, 'commentersShareEnabled', SFProjectRole.Commenter);
     this.updateSharingSetting(newValue, 'viewersShareEnabled', SFProjectRole.Viewer);
+
+    // Update Lynx settings
+    this.updateLynxSettings(newValue);
   }
 
   private settingChanged(
@@ -420,6 +436,48 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit {
     }
   }
 
+  private updateLynxSettings(newValue: SFProjectSettings): void {
+    if (this.settingChanged(newValue, 'lynxAutoCorrectionsEnabled')) {
+      this.updateSetting(newValue, 'lynxAutoCorrectionsEnabled');
+    }
+
+    if (this.settingChanged(newValue, 'lynxAssessmentsEnabled')) {
+      this.updateSetting(newValue, 'lynxAssessmentsEnabled');
+
+      // When 'assessments' is checked, auto-enable punctuation checker
+      if (newValue.lynxAssessmentsEnabled) {
+        this.lynxPunctuationCheckerEnabled.setValue(true, { emitEvent: false });
+        this.updateSetting({ ...newValue, lynxPunctuationCheckerEnabled: true }, 'lynxPunctuationCheckerEnabled');
+      } else {
+        // When 'assessments' is unchecked, auto-disable children
+        this.lynxPunctuationCheckerEnabled.setValue(false, { emitEvent: false });
+        this.updateSetting({ ...newValue, lynxPunctuationCheckerEnabled: false }, 'lynxPunctuationCheckerEnabled');
+        this.lynxAllowedCharacterCheckerEnabled.setValue(false, { emitEvent: false });
+        this.updateSetting(
+          { ...newValue, lynxAllowedCharacterCheckerEnabled: false },
+          'lynxAllowedCharacterCheckerEnabled'
+        );
+      }
+    } else {
+      // If both child settings are disabled, auto-disable assessments (parent setting)
+      if (
+        !newValue.lynxAllowedCharacterCheckerEnabled &&
+        !newValue.lynxPunctuationCheckerEnabled &&
+        newValue.lynxAssessmentsEnabled
+      ) {
+        this.lynxAssessmentsEnabled.setValue(false, { emitEvent: false });
+        this.updateSetting({ ...newValue, lynxAssessmentsEnabled: false }, 'lynxAssessmentsEnabled');
+      }
+
+      if (this.settingChanged(newValue, 'lynxPunctuationCheckerEnabled')) {
+        this.updateSetting(newValue, 'lynxPunctuationCheckerEnabled');
+      }
+      if (this.settingChanged(newValue, 'lynxAllowedCharacterCheckerEnabled')) {
+        this.updateSetting(newValue, 'lynxAllowedCharacterCheckerEnabled');
+      }
+    }
+  }
+
   private checkUpdateStatus(setting: keyof SFProjectSettings, updatePromise: Promise<void>): void {
     this.controlStates.set(setting, ElementState.Submitting);
     updatePromise
@@ -455,7 +513,11 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit {
         this.projectDoc.data.rolePermissions[SFProjectRole.Viewer]?.includes(
           SF_PROJECT_RIGHTS.joinRight(SFProjectDomain.UserInvites, Operation.Create)
         ) === true,
-      checkingAnswerExport: this.projectDoc.data.checkingConfig.answerExportMethod ?? CheckingAnswerExport.All
+      checkingAnswerExport: this.projectDoc.data.checkingConfig.answerExportMethod ?? CheckingAnswerExport.All,
+      lynxAutoCorrectionsEnabled: this.projectDoc.data.lynxConfig.autoCorrectionsEnabled,
+      lynxAssessmentsEnabled: this.projectDoc.data.lynxConfig.assessmentsEnabled,
+      lynxPunctuationCheckerEnabled: this.projectDoc.data.lynxConfig.punctuationCheckerEnabled,
+      lynxAllowedCharacterCheckerEnabled: this.projectDoc.data.lynxConfig.allowedCharacterCheckerEnabled
     };
     this.form.reset(this.previousFormValues);
     this.setIndividualControlDisabledStates();
@@ -489,6 +551,10 @@ export class SettingsComponent extends DataLoadingComponent implements OnInit {
     this.controlStates.set('communityCheckersShareEnabled', ElementState.InSync);
     this.controlStates.set('commentersShareEnabled', ElementState.InSync);
     this.controlStates.set('viewersShareEnabled', ElementState.InSync);
+    this.controlStates.set('lynxAutoCorrectionsEnabled', ElementState.InSync);
+    this.controlStates.set('lynxAssessmentsEnabled', ElementState.InSync);
+    this.controlStates.set('lynxPunctuationCheckerEnabled', ElementState.InSync);
+    this.controlStates.set('lynxAllowedCharacterCheckerEnabled', ElementState.InSync);
   }
 
   private updateNonSelectableProjects(): void {

src/SIL.XForge.Scripture/ClientApp/src/app/shared/text/text.component.html

@@ -1,5 +1,10 @@
-@if (showInsights && editor != null) {
-  <app-lynx-insight-editor-objects [editor]="editor" [lynxTextModelConverter]="viewModel" />
+@if ((lynxInsightsEnabled || lynxAutoCorrectionsEnabled) && editor != null) {
+  <app-lynx-insight-editor-objects
+    [editor]="editor"
+    [lynxTextModelConverter]="viewModel"
+    [insightsEnabled]="lynxInsightsEnabled"
+    [autoCorrectionsEnabled]="lynxAutoCorrectionsEnabled"
+  />
 }
 
 <!-- translate="no" is to prevent tools like Google translate from editing the text -->
@@ -21,7 +26,7 @@
     rtl: isRtl,
     'mark-invalid': markInvalid,
     'selectable-verses': selectableVerses,
-    'custom-local-cursor': showInsights && !isCursorMoveKeyDown
+    'custom-local-cursor': lynxInsightsEnabled && !isCursorMoveKeyDown
   }"
   [dir]="$any(textDirection)"
   [lang]="lang"