Fixed using Paratext and 3.0 markers maps. Exported only 3.0 markers map from PBU becuase we know we will use it long-term

Author: tjcouch-sil

extensions/src/platform-scripture-editor/src/comments.ts

@@ -2,6 +2,7 @@ import { Comments } from '@eten-tech-foundation/platform-editor';
 import { MarkerContent, MarkerObject, Usj } from '@eten-tech-foundation/scripture-utilities';
 import {
   CHAPTER_TYPE,
+  USFM_MARKERS_MAP_PARATEXT_3_0,
   UsfmVerseLocation,
   UsjNodeAndDocumentLocation,
   UsjReaderWriter,
@@ -256,7 +257,7 @@ function insertAnchorIfNeeded(
  * @returns True if some comment anchors were inserted, false if no comment anchors were inserted
  */
 export function insertCommentAnchorsIntoUsj(usj: Usj, legacyComments: LegacyComment[]): boolean {
-  const usjRW = new UsjReaderWriter(usj);
+  const usjRW = new UsjReaderWriter(usj, { markersMap: USFM_MARKERS_MAP_PARATEXT_3_0 });
   let usjChanged = false;
 
   const threads = convertLegacyCommentsToEditorThreads(legacyComments);

extensions/src/platform-scripture-editor/src/main.ts

@@ -13,7 +13,7 @@ import {
   LanguageStrings,
   LocalizeKey,
   serialize,
-  USFM_MARKERS_MAP_3_1,
+  USFM_MARKERS_MAP_PARATEXT_3_0,
   UsjReaderWriter,
 } from 'platform-bible-utils';
 import {
@@ -317,27 +317,7 @@ class ScriptureEditorWebViewFactory extends WebViewFactory<typeof scriptureEdito
             );
 
           const usjRW = new UsjReaderWriter(usjChapter, {
-            markersMap: {
-              ...USFM_MARKERS_MAP_3_1,
-              // 3.0
-              version: '3.0',
-              // Paratext
-              isSpaceAfterAttributeMarkersContent: true,
-              shouldOptionalClosingMarkersBePresent: true,
-              // 3.0
-              markers: Object.fromEntries(
-                Object.entries(USFM_MARKERS_MAP_3_1.markers).map(([markerName, markerInfo]) => {
-                  if (!markerInfo) return [markerName, markerInfo];
-
-                  const newMarkerInfo = { ...markerInfo };
-
-                  if (newMarkerInfo.defaultAttribute === 'href')
-                    newMarkerInfo.defaultAttribute = 'link-href';
-                  if (markerName === 'k') delete newMarkerInfo.defaultAttribute;
-                  return [markerName, newMarkerInfo];
-                }),
-              ),
-            },
+            markersMap: USFM_MARKERS_MAP_PARATEXT_3_0,
           });
 
           // Convert the range now - easy conversion if already jsonPath, but need to run conversion

extensions/src/platform-scripture-editor/src/platform-scripture-editor.web-view.tsx

@@ -33,6 +33,7 @@ import {
   isPlatformError,
   LocalizeKey,
   serialize,
+  USFM_MARKERS_MAP_PARATEXT_3_0,
   UsjReaderWriter,
 } from 'platform-bible-utils';
 import {
@@ -329,7 +330,7 @@ globalThis.webViewComponent = function PlatformScriptureEditor({
 
       // Remove the milestones that we inserted before writing back to the PDP
       const clonedUsj = deepClone(newUsj);
-      const usjRW = new UsjReaderWriter(clonedUsj);
+      const usjRW = new UsjReaderWriter(clonedUsj, { markersMap: USFM_MARKERS_MAP_PARATEXT_3_0 });
       usjRW.removeContentNodes((node: MarkerContent) => {
         if (typeof node === 'string') return false;
         if (node.type !== 'ms') return false;
@@ -409,7 +410,9 @@ globalThis.webViewComponent = function PlatformScriptureEditor({
       legacyCommentsFromPdp.forEach((existingComment) => legacyCommentIds.add(existingComment.id));
 
       // Determine which "new" comments are actually new
-      const usjRW = new UsjReaderWriter(usjWithAnchors);
+      const usjRW = new UsjReaderWriter(usjWithAnchors, {
+        markersMap: USFM_MARKERS_MAP_PARATEXT_3_0,
+      });
       const newLegacyComments = convertEditorCommentsToLegacyComments(newComments, usjRW, scrRef);
       const legacyCommentsToAdd: LegacyComment[] = [];
       newLegacyComments.forEach((newComment) => {
@@ -509,9 +512,9 @@ globalThis.webViewComponent = function PlatformScriptureEditor({
 
         let nextTextLocationJsonPath = '';
         try {
-          nextTextLocationJsonPath = new UsjReaderWriter(usjFromPdp).verseRefToNextTextLocation(
-            scrRef,
-          ).documentLocation.jsonPath;
+          nextTextLocationJsonPath = new UsjReaderWriter(usjFromPdp, {
+            markersMap: USFM_MARKERS_MAP_PARATEXT_3_0,
+          }).verseRefToNextTextLocation(scrRef).documentLocation.jsonPath;
         } catch (e) {
           logger.debug(`Could not get next text location for verse ref ${serialize(scrRef)}`);
         }

extensions/src/platform-scripture/src/project-data-provider/platform-scripture-finder-pdpe.model.ts

@@ -8,6 +8,7 @@ import {
   escapeStringRegexp,
   getErrorMessage,
   newGuid,
+  USFM_MARKERS_MAP_PARATEXT_3_0,
   UsjReaderWriter,
 } from 'platform-bible-utils';
 import {
@@ -193,7 +194,7 @@ export class ScriptureFinderProjectDataProviderEngine
     if (!usx) throw new Error(`No scripture found for: ${JSON.stringify(scope)}`);
     const scripture: Usj | undefined = usxStringToUsj(usx);
 
-    const usj = new UsjReaderWriter(scripture);
+    const usj = new UsjReaderWriter(scripture, { markersMap: USFM_MARKERS_MAP_PARATEXT_3_0 });
     const regexString = job.options.useRegex
       ? job.options.searchString
       : escapeStringRegexp(job.options.searchString);

lib/platform-bible-utils/dist/index.cjs

@@ -2183,6 +2183,11 @@ export type MarkersMap = {
  * file
  */
 declare const USFM_MARKERS_MAP: MarkersMap;
+/**
+ * A map of all USFM/USX/USJ markers and some information about them. Generated from a `usx.rng`
+ * file and adjusted to reflect the way Paratext 9.4 handles USFM.
+ */
+declare const USFM_MARKERS_MAP_PARATEXT: MarkersMap;
 /** USJ content node type for a chapter */
 export declare const CHAPTER_TYPE = "chapter";
 /** USJ content node type for a verse */
@@ -2414,6 +2419,12 @@ export type UsjReaderWriterOptions = {
 	/**
 	 * A map of all USFM/USX/USJ markers and some information about them. Used for translating between
 	 * the formats
+	 *
+	 * Defaults to trying to use a built-in markers map that matches the version of the USJ passed in.
+	 *
+	 * Currently supported built-in USFM versions:
+	 *
+	 * - 3.0/3.0.x
 	 */
 	markersMap?: MarkersMap;
 	/**
@@ -4719,7 +4730,8 @@ export declare class UsjReaderWriter implements IUsjReaderWriter {
 }
 
 export {
-	USFM_MARKERS_MAP as USFM_MARKERS_MAP_3_1,
+	USFM_MARKERS_MAP as USFM_MARKERS_MAP_3_0,
+	USFM_MARKERS_MAP_PARATEXT as USFM_MARKERS_MAP_PARATEXT_3_0,
 };
 
 export {};