platform.bible extension poc

backend/FwLite/FwDataMiniLcmBridge/Api/FwDataMiniLcmApi.cs

@@ -1,4 +1,5 @@
 using System.Collections.Frozen;
+using System.Globalization;
 using System.Reflection;
 using System.Text;
 using FwDataMiniLcmBridge.Api.UpdateProxy;
@@ -521,8 +522,9 @@ public IAsyncEnumerable<Entry> GetEntries(
                 if (value is null || value.Length < exemplar.Length) return false;
                 //exemplar is normalized, so we can use StartsWith
                 //there may still be cases where value.StartsWith(value[0].ToString()) == false (e.g. "آبراهام")
+                //another example is "เพือ" does not start with "เ"
                 //but I don't have the data to test that
-                return value.StartsWith(exemplar, StringComparison.InvariantCultureIgnoreCase);
+                return CultureInfo.InvariantCulture.CompareInfo.IsPrefix(value, exemplar, CompareOptions.IgnoreCase);
             });
         }
 

backend/FwLite/FwDataMiniLcmBridge/Api/LcmHelpers.cs

@@ -1,3 +1,4 @@
+using System.Globalization;
 using SIL.LCModel.Core.KernelInterfaces;
 
 namespace FwDataMiniLcmBridge.Api;
@@ -62,7 +63,9 @@ internal static void ContributeExemplars(ITsMultiString multiString, IReadOnlyDi
             var value = tsString.Text.AsSpan().Trim(WhitespaceAndFormattingChars);
             if (!value.IsEmpty && wsExemplars.TryGetValue(ws, out var exemplars))
             {
-                exemplars.Add(char.ToUpperInvariant(value[0]));
+                //some cases the first character is not a prefix.
+                if (CultureInfo.InvariantCulture.CompareInfo.IsPrefix(value, value[0..1], CompareOptions.IgnoreCase))
+                    exemplars.Add(char.ToUpperInvariant(value[0]));
             }
         }
     }

backend/FwLite/LocalWebApp/LocalAppKernel.cs

@@ -30,6 +30,8 @@ public static IServiceCollection AddLocalAppServices(this IServiceCollection ser
         services.AddFwLiteProjectSync();
         services.AddFwDataBridge();
 
+        services.AddOptions<LocalWebAppConfig>().BindConfiguration("LocalWebApp");
+
         services.AddOptions<JsonOptions>().PostConfigure<IOptions<CrdtConfig>>((jsonOptions, crdtConfig) =>
         {
             jsonOptions.SerializerOptions.TypeInfoResolver = crdtConfig.Value.MakeJsonTypeResolver();

backend/FwLite/LocalWebApp/LocalWebApp.csproj

@@ -24,6 +24,7 @@
         <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="8.0.10" />
         <PackageReference Include="Microsoft.Extensions.FileProviders.Embedded" Version="8.0.10" />
         <PackageReference Include="Microsoft.Identity.Client.Extensions.Msal" Version="4.64.0" />
+        <PackageReference Include="NReco.Logging.File" Version="1.2.1" />
         <PackageReference Include="Swashbuckle.AspNetCore" Version="6.7.3" />
         <PackageReference Include="System.Reactive" Version="6.0.1" />
     </ItemGroup>

backend/FwLite/LocalWebApp/LocalWebAppConfig.cs

@@ -0,0 +1,8 @@
+namespace LocalWebApp;
+
+public class LocalWebAppConfig
+{
+    public bool CorsAllowAny { get; init; } = false;
+    public bool OpenBrowser { get; init; } = true;
+    public string? LogFileName { get; init; } = null;
+}

backend/FwLite/LocalWebApp/LocalWebAppServer.cs

@@ -9,6 +9,8 @@
 using Microsoft.AspNetCore.SignalR;
 using Microsoft.AspNetCore.StaticFiles.Infrastructure;
 using Microsoft.Extensions.FileProviders;
+using Microsoft.Extensions.Options;
+using NReco.Logging.File;
 
 namespace LocalWebApp;
 
@@ -17,7 +19,7 @@ public static class LocalWebAppServer
     public static WebApplication SetupAppServer(WebApplicationOptions options, Action<WebApplicationBuilder>? configure = null)
     {
         var builder = WebApplication.CreateBuilder(options);
-        if (!builder.Environment.IsDevelopment())
+        if (!builder.Environment.IsDevelopment() && options.Args?.Contains("--urls") != true)
             builder.WebHost.UseUrls("http://127.0.0.1:0");
         if (builder.Environment.IsDevelopment())
         {
@@ -35,6 +37,11 @@ public static WebApplication SetupAppServer(WebApplicationOptions options, Actio
             config.LexboxServers = [new(new("https://staging.languagedepot.org"), "Lexbox Staging")]);
         builder.Services.Configure<AuthConfig>(c => c.ClientId = "becf2856-0690-434b-b192-a4032b72067f");
         builder.Logging.AddDebug();
+        if (builder.Configuration.GetValue<string>("LocalWebApp:LogFileName") is { Length: > 0 } logFileName)
+        {
+            builder.Logging.AddFile(logFileName);
+        }
+        builder.Services.AddCors();
         builder.Services.AddLocalAppServices(builder.Environment);
         builder.Services.AddEndpointsApiExplorer();
         builder.Services.AddSwaggerGen();
@@ -54,7 +61,15 @@ public static WebApplication SetupAppServer(WebApplicationOptions options, Actio
             app.UseSwaggerUI();
         }
 
-//configure dotnet to serve static files from the embedded resources
+        if (app.Services.GetRequiredService<IOptions<LocalWebAppConfig>>().Value.CorsAllowAny)
+        {
+            app.UseCors(policyBuilder =>
+            {
+                policyBuilder.AllowAnyOrigin().AllowAnyMethod().AllowAnyHeader();
+            });
+        }
+
+        //configure dotnet to serve static files from the embedded resources
         SharedOptions sharedOptions;
         try
         {

backend/FwLite/LocalWebApp/Program.cs

@@ -1,12 +1,14 @@
 
 using LocalWebApp;
+using Microsoft.Extensions.Options;
 
 var app = LocalWebAppServer.SetupAppServer(new() {Args = args});
 await using (app)
 {
     await app.StartAsync();
+    var openBrowser = app.Services.GetRequiredService<IOptions<LocalWebAppConfig>>().Value.OpenBrowser;
 
-    if (!app.Environment.IsDevelopment())
+    if (openBrowser)
     {
         var url = app.Urls.First();
         LocalAppLauncher.LaunchBrowser(url);

backend/FwLite/LocalWebApp/appsettings.Development.json

@@ -4,5 +4,10 @@
       "Default": "Information",
       "LocalWebApp.Auth.LoggerAdapter": "Warning",
     }
+  },
+  "LocalWebApp": {
+    "CorsAllowAny": false,
+    "OpenBrowser": true,
+    "LogFileName": null
   }
 }

frontend/.dockerignore

@@ -9,3 +9,4 @@ node_modules
 viewer/node_modules
 tests
 test-results
+platform.bible-extension

frontend/eslint.config.js

@@ -22,6 +22,7 @@ export default [
       '**/generated/**',
       'viewer/',
       'https-proxy/',
+      'platform.bible-extension/'
     ],
   },
   js.configs.recommended,

frontend/platform.bible-extension/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+
+[*.md]
+trim_trailing_whitespace = false

frontend/platform.bible-extension/.eslintignore

@@ -0,0 +1,31 @@
+# Please keep this file in sync with .prettierignore and .stylelintignore
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+
+# OSX
+.DS_Store
+
+.idea
+npm-debug.log.*
+*.css.d.ts
+*.sass.d.ts
+*.scss.d.ts
+
+# Packager output
+dist
+release
+temp-build
+
+# generated files
+package-lock.json

frontend/platform.bible-extension/.eslintrc.js

@@ -0,0 +1,135 @@
+module.exports = {
+  extends: [
+    // https://github.com/electron-react-boilerplate/eslint-config-erb/blob/main/index.js
+    // airbnb rules are embedded in erb https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb
+    'erb',
+  ],
+
+  rules: {
+    // #region From paranext-core root .eslintrc.js
+    // Some rules are commented out since they have overrides in the
+    // 'Overrides from paranext-core extension .eslintrc.cjs' section
+
+    // #region ERB rules
+
+    'import/extensions': 'off',
+    // A temporary hack related to IDE not resolving correct package.json
+    'import/no-extraneous-dependencies': 'off',
+    'import/no-import-module-exports': 'off',
+    // 'import/no-unresolved': 'error',
+    'react/jsx-filename-extension': 'off',
+    'react/react-in-jsx-scope': 'off',
+
+    // #endregion
+
+    // #region Paranext rules
+
+    // Rules in each section are generally in alphabetical order. However, several
+    // `@typescript-eslint` rules require disabling the equivalent ESLint rule. So in these cases
+    // each ESLint rule is turned off immediately above the corresponding `@typescript-eslint` rule.
+    'import/no-anonymous-default-export': ['error', { allowCallExpression: false }],
+    '@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
+    'lines-between-class-members': 'off',
+    '@typescript-eslint/lines-between-class-members': [
+      'error',
+      'always',
+      { exceptAfterSingleLine: true, exceptAfterOverload: true },
+    ],
+    '@typescript-eslint/member-ordering': 'error',
+    'no-empty-function': 'off',
+    '@typescript-eslint/no-empty-function': [
+      'error',
+      {
+        allow: ['arrowFunctions', 'functions', 'methods'],
+      },
+    ],
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'error',
+    'no-redeclare': 'off',
+    '@typescript-eslint/no-redeclare': 'error',
+    'no-shadow': 'off',
+    '@typescript-eslint/no-shadow': 'error',
+    'no-use-before-define': 'off',
+    '@typescript-eslint/no-use-before-define': [
+      'error',
+      { functions: false, allowNamedExports: true, typedefs: false, ignoreTypeReferences: true },
+    ],
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
+    'no-useless-constructor': 'off',
+    '@typescript-eslint/no-useless-constructor': 'error',
+    'comma-dangle': ['error', 'always-multiline'],
+    indent: 'off',
+    'jsx-a11y/label-has-associated-control': [
+      'error',
+      {
+        assert: 'either',
+      },
+    ],
+    // Should use our logger anytime you want logs that persist. Otherwise use console only in testing
+    'no-console': 'warn',
+    'no-null/no-null': 2,
+    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+    'no-restricted-imports': [
+      'error',
+      {
+        patterns: [
+          {
+            group: ['shared/*', 'renderer/*', 'extension-host/*', 'node/*', 'client/*', 'main/*'],
+            message: `Importing from this path is not allowed. Try importing from @papi/core. Imports from paths like 'shared', 'renderer', 'node', 'client' and 'main' are not allowed to prevent unnecessary import break.`,
+          },
+        ],
+      },
+    ],
+    'prettier/prettier': ['warn', { tabWidth: 2, trailingComma: 'all' }],
+    'react/jsx-indent-props': ['warn', 2],
+    'react/jsx-props-no-spreading': ['error', { custom: 'ignore' }],
+    'react/require-default-props': 'off',
+
+    // #endregion
+
+    // #endregion
+
+    // #region Overrides from paranext-core extension .eslintrc.cjs
+
+    'import/no-unresolved': ['error', { ignore: ['@papi'] }],
+
+    // #endregion
+  },
+  globals: {
+    globalThis: 'readonly',
+  },
+  overrides: [
+    {
+      files: ['*.js'],
+      rules: {
+        strict: 'off',
+      },
+    },
+    {
+      // Don't require extensions to have a default export for "activate()"
+      files: ['*.ts'],
+      rules: {
+        'import/prefer-default-export': 'off',
+      },
+    },
+  ],
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    project: './tsconfig.json',
+    tsconfigRootDir: __dirname,
+    createDefaultProgram: true,
+  },
+  plugins: ['@typescript-eslint', 'no-null'],
+  settings: {
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true,
+      },
+    },
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx'],
+    },
+  },
+};

frontend/platform.bible-extension/.gitignore

@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+release
+dist-ssr
+*.local
+
+# formatting and linting
+.eslintcache
+
+# Editor directories and files
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Temporary intermediate build files
+temp-build
+public/fw-lite

frontend/platform.bible-extension/.prettierignore

@@ -0,0 +1,31 @@
+# Please keep this file in sync with .eslintignore and .stylelintignore
+
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+
+# OSX
+.DS_Store
+
+.idea
+npm-debug.log.*
+*.css.d.ts
+*.sass.d.ts
+*.scss.d.ts
+
+# Packager output
+dist
+release
+temp-build
+
+# generated files
+package-lock.json