Translatable Access description in consent documents

Author: hatton

src/export/ExportStringDefinitions.ts

@@ -13,7 +13,7 @@ export interface ExportStringDefinition {
   /** Context to help translators understand what this string is for */
   context: string;
   /** Category for grouping in the UI */
-  category: "bundle-title" | "bundle-description";
+  category: "bundle-title" | "bundle-description" | "bundle-access-description";
 }
 
 /**
@@ -54,6 +54,11 @@ export const EXPORT_STRING_DEFINITIONS: ExportStringDefinition[] = [
       "This bundle contains media demonstrating informed consent for sessions in this collection.",
     context: "Description for the Consent Documents bundle.",
     category: "bundle-description"
+  },
+  {
+    english: "Consent documents",
+    context: "Access description used on each consent file in the Consent Documents bundle.",
+    category: "bundle-access-description"
   }
 ];
 
@@ -88,6 +93,7 @@ export const ExportStrings = {
   ConsentDocuments: {
     title: "Documentation of consent for the contributors to this collection",
     description:
-      "This bundle contains media demonstrating informed consent for sessions in this collection."
+      "This bundle contains media demonstrating informed consent for sessions in this collection.",
+    accessDescription: "Consent documents"
   }
 } as const;

src/export/ImdiBundler.ts

@@ -507,7 +507,13 @@ export default class ImdiBundler {
       "ELAR"
     ) {
       dummySession.properties.setText("access", "S");
-      dummySession.properties.setText("accessDescription", "Consent documents");
+      dummySession.properties.setText(
+        "accessDescription",
+        buildMultilingualExportString(
+          ExportStrings.ConsentDocuments.accessDescription,
+          project
+        )
+      );
     }
 
     const originalConsentFiles = ImdiBundler.addDummyFileForConsentActors(

src/export/consentImdi.spec.ts

@@ -66,6 +66,9 @@ describe("Consent in OPEX+Files export", () => {
   it("If ELAR, it should have an Access of 'S'", () => {
     expect("//MediaFile/Access/Availability").toMatch("S");
     expect("//MediaFile/Access/Description").toMatch("Consent documents");
+    expect(
+      "//MediaFile/Access/Description[@LanguageId='ISO639-3:spa']"
+    ).toMatch("Documentos de consentimiento");
   });
 
   // per Notion #241
@@ -118,6 +121,20 @@ async function doExport(
 
   const project = Project.fromDirectory(projectDir);
 
+  // Set up multiple metadata languages so multilingual fields are emitted
+  project.properties.setText("metadataLanguages", "en:English;es:Spanish");
+
+  // Provide a project translation for the access description used by the consent bundle
+  project.vocabularyTranslations?.ensureExportStringEntry(
+    "Consent documents",
+    ["en", "es"]
+  );
+  project.vocabularyTranslations?.updateExportStringTranslation(
+    "Consent documents",
+    "es",
+    "Documentos de consentimiento"
+  );
+
   // NB: this is to test the access protocol used for consent bundles,
   // which has a hard-coded knowledge of the access protocol used for
   // ELAR currently. If/when we add knowledge of what other archives