Merge branch 'languageChoices'

onset · May 4, 2024 · 6ce9de1 · 6ce9de1
2 parents fc6a6ed + 68a876c
commit 6ce9de1
Show file tree

Hide file tree

Showing 26 changed files with 886 additions and 232 deletions.
diff --git a/archive-configurations/ELAR/fields.json5 b/archive-configurations/ELAR/fields.json5
@@ -1,9 +1,6 @@
 {
   project: [
-    { key: "collectionSubjectLanguages", visibility: "always" },
-    { key: "collectionWorkingLanguages", visibility: "always" },
-
-    { key: "collectionName", visibility: "always" },
+    //    { key: "collectionName", visibility: "always" },
     { key: "collectionTitle", visibility: "always" },
     { key: "collectionDescription", visibility: "always" },
     {

diff --git a/archive-configurations/lameta/fields.json5 b/archive-configurations/lameta/fields.json5
@@ -17,20 +17,22 @@
       key: "vernacularIso3CodeAndName",
       englishLabel: "Subject Language",
       xmlTag: "VernacularISO3CodeAndName",
+      visibility: "never", // replaced by collectionWorkingLanguages
       type: "language",
       tabIndex: 1
     },
     {
       key: "analysisIso3CodeAndName",
       englishLabel: "Working Language",
       xmlTag: "AnalysisISO3CodeAndName",
+      visibility: "never", // replaced by collectionSubjectLanguages
       type: "language",
       tabIndex: 2
     },
     {
       key: "collectionSubjectLanguages",
       englishLabel: "Subject Languages",
-      visibility: "never",
+      xmlTag: "CollectionSubjectLanguages",
       form: "primary",
       type: "languageChoices",
       controlProps: {
@@ -40,8 +42,8 @@
     },
     {
       key: "collectionWorkingLanguages",
+      xmlTag: "CollectionWorkingLanguages",
       englishLabel: "Working Languages",
-      visibility: "never",
       form: "primary",
       type: "languageChoices",
       tabIndex: 2

diff --git a/package.json b/package.json
@@ -73,7 +73,7 @@
     "@typescript-eslint/eslint-plugin": "^6.12.0",
     "@typescript-eslint/parser": "^6.12.0",
     "@vitejs/plugin-react": "^4.2.1",
-    "@vitest/ui": "^0.34.6",
+    "@vitest/ui": "^1.6.0",
     "babel-core": "^7.0.0-bridge.0",
     "babel-eslint": "10.1.0",
     "babel-loader": "^8.1.0",
@@ -122,7 +122,7 @@
     "vite-plugin-electron-renderer": "^0.12.1",
     "vite-plugin-environment": "^1.1.3",
     "vite-plugin-time-reporter": "^2.1.0",
-    "vitest": "^0.34.6",
+    "vitest": "^1.6.0",
     "webdriverio": "^4.14.0"
   },
   "dependencies": {
@@ -262,15 +262,15 @@
   },
   "//remember to match this with github actions in main.yml": "",
   "engines": {
-    "node": "18.16.0"
+    "node": "20.12.2"
   },
   "debug": {
     "env": {
       "VITE_DEV_SERVER_URL": "http://127.0.0.1:7777"
     }
   },
   "volta": {
-    "node": "18.16.0",
+    "node": "20.12.2",
     "yarn": "1.22.19"
   },
   "packageManager": "[email protected]"

diff --git a/src/components/FieldLabel.tsx b/src/components/FieldLabel.tsx
@@ -10,7 +10,7 @@ import {
 import { translateFieldLabel, translateTip } from "../other/localization";
 import { observer } from "mobx-react";
 import { tooltipBackground } from "../containers/theme";
-import { Project } from "../model/Project/Project";
+import { GetOtherConfigurationSettings } from "../model/Project/OtherConfigurationSettings";
 
 export const FieldLabel: React.FunctionComponent<{
   fieldDef: FieldDefinition;
@@ -81,7 +81,7 @@ export const FieldInfoAffordances: React.FunctionComponent<{
         </CommaSeparatedIndicator>
       )}
 
-      {Project.OtherConfigurationSettings.showImdiPreview &&
+      {GetOtherConfigurationSettings().showImdiPreview &&
         props.fieldDef.omitFromImdi && <NotConsumedByArchiveIndicator />}
     </div>
   );

diff --git a/src/components/FolderPane.tsx b/src/components/FolderPane.tsx
@@ -37,6 +37,7 @@ import {
 import { useEffect } from "react";
 import { ErrorBoundary } from "./ErrorBoundary";
 import { useLingui } from "@lingui/react";
+import { GetOtherConfigurationSettings } from "../model/Project/OtherConfigurationSettings";
 
 export interface IProps {
   folder: Folder;
@@ -152,7 +153,7 @@ const FileTabs: React.FunctionComponent<
       />
     </TabPanel>
   );
-  const imdiTab = Project.OtherConfigurationSettings.showImdiPreview ? (
+  const imdiTab = GetOtherConfigurationSettings().showImdiPreview ? (
     <Tab>IMDI {/* don't translate  */}</Tab>
   ) : (
     <></>
@@ -164,7 +165,7 @@ const FileTabs: React.FunctionComponent<
     <></>
   );
 
-  const imdiPanel = Project.OtherConfigurationSettings.showImdiPreview ? (
+  const imdiPanel = GetOtherConfigurationSettings().showImdiPreview ? (
     <TabPanel>
       <ErrorBoundary>
         <ImdiView

diff --git a/src/components/LanguageChoicesEditor.tsx b/src/components/LanguageChoicesEditor.tsx
@@ -69,13 +69,23 @@ export const LanguageChoicesEditor: React.FunctionComponent<
   };
 
   const currentValueArray = props.field.text
-    .split(";")
+    .split(";") // TODO: move this serialization logic into the Field class
     .filter((c) => c.length > 0)
     .map((c) => c.trim())
-    .map((code) => ({
-      value: code,
-      label: getName(props.languageFinder, code)
-    }));
+    .map((code) => {
+      if (code.indexOf("|") > 0) {
+        const parts = code.split("|");
+        console.log("parts: " + JSON.stringify(parts));
+        return {
+          value: parts[0],
+          label: parts[1]
+        };
+      }
+      return {
+        value: code,
+        label: getName(props.languageFinder, code)
+      };
+    });
 
   const loadMatchingOptions = (inputValue, callback) => {
     const matches =
@@ -107,10 +117,24 @@ export const LanguageChoicesEditor: React.FunctionComponent<
     loadOptions: _.debounce(loadMatchingOptions, 100),
     value: currentValueArray,
     styles: customStyles,
-    onChange: (v: any[]) => {
-      // if you delete the last member, you get null instead of []
-      const newChoices = v ? v : [];
-      const s: string = newChoices.map((o) => o.value).join(";");
+    onChange: (
+      v: Array<{ value: string; label: string; __isNew__: boolean }>
+    ) => {
+      console.log("onChange: " + JSON.stringify(v));
+      // if any are new, change the value to "new"
+      const newChoices = v
+        ? v.map((o) =>
+            o.__isNew__ ? { label: o.label, value: `qaa-x-${o.label}` } : o
+          )
+        : []; // if you delete the last member, you get null instead of []
+
+      // TODO: move this serialization logic into the Field class
+      const s: string = newChoices
+        .map((o) => {
+          return o.value;
+        })
+        .join(";"); // why semicolong instead of comma? The particpants field as used semicolon for years.
+      console.log("saving: " + s);
       props.field.setValueFromString(s);
     },
     isMulti: true
@@ -120,7 +144,12 @@ export const LanguageChoicesEditor: React.FunctionComponent<
     <div className={"field " + (props.className ? props.className : "")}>
       <label>{props.field.labelInUILanguage}</label>
       {props.canCreateNew ? (
-        <CreatableAsyncSelect {...selectProps}></CreatableAsyncSelect>
+        <CreatableAsyncSelect
+          {...selectProps}
+          onCreatableOptionCreate={(newOption) => {
+            window.alert("You created " + newOption.label);
+          }}
+        ></CreatableAsyncSelect>
       ) : (
         <AsyncSelect {...selectProps} />
       )}

diff --git a/src/components/Notes.tsx b/src/components/Notes.tsx
@@ -5,7 +5,7 @@ import { TextFieldEdit } from "./TextFieldEdit";
 import { InfoIndicator } from "./FieldIndicators";
 import { css } from "@emotion/react";
 import { Trans, t } from "@lingui/macro";
-import { Project } from "../model/Project/Project";
+import { GetOtherConfigurationSettings } from "../model/Project/OtherConfigurationSettings";
 
 export const Notes: React.FunctionComponent<{
   field: Field;
@@ -19,7 +19,7 @@ export const Notes: React.FunctionComponent<{
         overflow: auto;
       `}
     >
-      {Project.OtherConfigurationSettings.showImdiPreview && (
+      {GetOtherConfigurationSettings().showImdiPreview && (
         <InfoIndicator
           css={css`
             margin-left: auto;

diff --git a/src/components/lametaXmlView.tsx b/src/components/lametaXmlView.tsx
@@ -0,0 +1,59 @@
+import * as React from "react";
+import { css } from "@emotion/react";
+import { Folder } from "../model/Folder/Folder";
+import { Project } from "../model/Project/Project";
+import SyntaxHighlighter, {
+  registerLanguage
+} from "react-syntax-highlighter/light";
+import xmlLang from "react-syntax-highlighter/languages/hljs/xml";
+import syntaxStyle from "./ImdiSyntaxStyle";
+registerLanguage("xml", xmlLang);
+
+export const LametaXmlView: React.FunctionComponent<{
+  target: any;
+
+  // note, folder will equal project if we're generating at the project level
+  // otherwise, folder will be a session or person
+  project: Project;
+
+  folder: Folder;
+}> = (props) => {
+  const [xml, setXml] = React.useState<string>("");
+
+  React.useEffect(() => {
+    if (props.target instanceof Project) {
+      setXml(props.project.metadataFile?.getXml(false) || "");
+    }
+  }, [props.target, props.project, props.folder]);
+
+  return (
+    <div
+      css={css`
+        // Enhance: the size and scrolling of this got all messed up with the switch to electron 6
+        // (though it could have been anything). It's currently a hack.
+        height: 500px;
+        width: 100%;
+
+        display: flex;
+        flex-direction: column;
+        flex-grow: 1; // <--  grow to fit available space and then...
+        overflow: hidden; // <-- ... show scroll if too big, instead of just going off the screen.
+        code,
+        code * {
+          font-family: sans-serif;
+          white-space: pre-wrap;
+        }
+        pre {
+          flex: 1; // fill space
+        }
+      `}
+    >
+      <SyntaxHighlighter
+        language="xml"
+        style={{ ...syntaxStyle, marginTop: 0, paddingTop: 0 }}
+      >
+        {xml}
+      </SyntaxHighlighter>
+    </div>
+  );
+};
diff --git a/src/components/project/ProjectTab.tsx b/src/components/project/ProjectTab.tsx
@@ -10,10 +10,13 @@ import { AuthorityLists } from "../../model/Project/AuthorityLists/AuthorityList
 import { ArchiveConfigurationForm } from "./ArchiveConfigurationForm";
 import { ImdiView } from "../ImdiView";
 import "./ProjectTab.scss";
-import { ParadisecView } from "../ParadisecView";
+import userSettings from "../../other/UserSettings";
 import { ThemeProvider } from "@mui/material";
 import { useState } from "react";
 import { createProjectTheme } from "../../containers/theme";
+import { ParadisecView } from "../ParadisecView";
+import { LametaXmlView } from "../lametaXmlView";
+import { GetOtherConfigurationSettings } from "../../model/Project/OtherConfigurationSettings";
 
 interface IProps {
   project: Project;
@@ -71,20 +74,27 @@ export const ProjectTab: React.FunctionComponent<IProps> = observer((props) => {
           <Tab className={"tab-project-other-docs"}>
             <Trans>Other Documents</Trans>
           </Tab>
-          {Project.OtherConfigurationSettings.showImdiPreview ? (
+          {GetOtherConfigurationSettings().showImdiPreview ? (
             <Tab className={"tab-project-imdi"}>
               IMDI {/* don't translate  */}
             </Tab>
           ) : (
             <></>
           )}
-          {Project.OtherConfigurationSettings.showParadisec ? (
+          {GetOtherConfigurationSettings().showParadisec ? (
             <Tab className={"tab-project-paradisec"}>
               PARADISEC {/* don't translate  */}
             </Tab>
           ) : (
             <></>
           )}
+          {userSettings.DeveloperMode ? (
+            <Tab className={"tab-project-lameta"}>
+              LaMeta {/* don't translate  */}
+            </Tab>
+          ) : (
+            <></>
+          )}
         </TabList>
         <TabPanel>
           <AutoForm
@@ -159,7 +169,7 @@ export const ProjectTab: React.FunctionComponent<IProps> = observer((props) => {
             <br />
           </FolderPane>
         </TabPanel>
-        {Project.OtherConfigurationSettings.showImdiPreview ? (
+        {GetOtherConfigurationSettings().showImdiPreview ? (
           <TabPanel>
             <ImdiView
               target={props.project}
@@ -170,7 +180,7 @@ export const ProjectTab: React.FunctionComponent<IProps> = observer((props) => {
         ) : (
           <></>
         )}
-        {Project.OtherConfigurationSettings.showParadisec ? (
+        {GetOtherConfigurationSettings().showParadisec ? (
           <TabPanel>
             <ParadisecView
               target={props.project}
@@ -181,6 +191,18 @@ export const ProjectTab: React.FunctionComponent<IProps> = observer((props) => {
         ) : (
           <></>
         )}
+        {/* if in developer mode, show LametaXmlView */}
+        {userSettings.DeveloperMode ? (
+          <TabPanel>
+            <LametaXmlView
+              target={props.project}
+              project={props.project}
+              folder={props.project}
+            />
+          </TabPanel>
+        ) : (
+          <></>
+        )}
       </Tabs>
     </ThemeProvider>
   );

diff --git a/src/export/ImdiBundler.ts b/src/export/ImdiBundler.ts
@@ -157,7 +157,7 @@ export default class ImdiBundler {
               imdiMode === IMDIMode.OPEX
                 ? Path.basename(session.directory)
                 : "", // with opex, the metadata file goes into the folder it describes. Else, on the level above.
-              sanitizeForArchive(imdiFileName, true)
+              sanitizeForArchive(imdiFileName, "ASCII")
             ),
             sessionImdi
           );
@@ -234,7 +234,7 @@ export default class ImdiBundler {
               // that renames that change the link name are used.
               sanitizeForArchive(
                 f.getNameToUseWhenExportingUsingTheActualFile(),
-                true
+                "ASCII"
               )
             ),
             (progressMessage) => {}
@@ -327,7 +327,7 @@ export default class ImdiBundler {
     fs.writeFileSync(
       Path.join(
         directoryForMetadataXmlFile,
-        sanitizeForArchive(imdiFileName, true)
+        sanitizeForArchive(imdiFileName, "ASCII")
       ),
       imdiXml
     );

diff --git a/src/export/corpusImdi.spec.ts → ...t/ImdiGenerator-corpus-corpusLink.spec.ts b/src/export/corpusImdi.spec.ts → ...t/ImdiGenerator-corpus-corpusLink.spec.ts