Revert "BREAKING CHANGE: use JSONPath indexes (#268)" (#273)

- This partially reverts commit d8ebcfc.
- `README.md`, `App.tsx`, & `selection.model.ts` were reverted,  other files modified to suit.

Author: irahopkinson

packages/platform/README.md

@@ -59,15 +59,15 @@ const nodeOptions: UsjNodeOptions = { [immutableNoteCallerNodeName]: { onClick:
 const options: EditorOptions = { isReadonly: false, textDirection: "ltr", nodes: nodeOptions };
 // Word "man" inside first q1 of PSA 1:1.
 const annotationRange1 = {
-  start: { jsonPathIndexes: [3, 1], offset: 15 },
-  end: { jsonPathIndexes: [3, 1], offset: 18 },
+  start: { jsonPath: "$.content[3].content[1]", offset: 15 },
+  end: { jsonPath: "$.content[3].content[1]", offset: 18 },
 };
 // Phrase "man who" inside first q1 of PSA 1:1.
 const annotationRange2 = {
-  start: { jsonPathIndexes: [3, 1], offset: 15 },
-  end: { jsonPathIndexes: [3, 1], offset: 22 },
+  start: { jsonPath: "$.content[3].content[1]", offset: 15 },
+  end: { jsonPath: "$.content[3].content[1]", offset: 22 },
 };
-const cursorLocation = { start: { jsonPathIndexes: [3, 1], offset: 15 } };
+const cursorLocation = { start: { jsonPath: "$.content[3].content[1]", offset: 15 } };
 
 export default function App() {
   const marginalRef = useRef<MarginalRef | null>(null);

packages/platform/src/App.tsx

@@ -36,18 +36,18 @@ const nodeOptions: UsjNodeOptions = {
 };
 // Word "man" inside first q1 of PSA 1:1.
 const annotationRange1 = {
-  start: { jsonPathIndexes: [10, 2], offset: 15 },
-  end: { jsonPathIndexes: [10, 2], offset: 18 },
+  start: { jsonPath: "$.content[10].content[2]", offset: 15 },
+  end: { jsonPath: "$.content[10].content[2]", offset: 18 },
 };
 // Phrase "man who" inside first q1 of PSA 1:1.
 const annotationRange2 = {
-  start: { jsonPathIndexes: [10, 2], offset: 15 },
-  end: { jsonPathIndexes: [10, 2], offset: 22 },
+  start: { jsonPath: "$.content[10].content[2]", offset: 15 },
+  end: { jsonPath: "$.content[10].content[2]", offset: 22 },
 };
 // Word "stand" inside first q2 of PSA 1:1.
 const annotationRange3 = {
-  start: { jsonPathIndexes: [11, 0], offset: 4 },
-  end: { jsonPathIndexes: [11, 0], offset: 9 },
+  start: { jsonPath: "$.content[11].content[0]", offset: 4 },
+  end: { jsonPath: "$.content[11].content[0]", offset: 9 },
 };
 const defaultAnnotations: Annotations = {
   annotation1: {

packages/shared-react/annotation/selection.model.ts

@@ -1,7 +1,5 @@
 export type UsjLocation = {
-  /* JsonPath indexes of the location in the USJ, e.g. JsonPath "$.content[1].content[2]" has indexes `[1, 2]` */
-  jsonPathIndexes: number[];
-  /* Offset of the location in the text */
+  jsonPath: string;
   offset: number;
 };
 

packages/shared-react/annotation/selection.utils.ts

@@ -1,3 +1,7 @@
+import {
+  indexesFromUsjJsonPath,
+  usjJsonPathFromIndexes,
+} from "@biblionexus-foundation/scripture-utilities";
 import {
   $createPoint,
   $createRangeSelection,
@@ -48,8 +52,9 @@ function $findTextNodeInMarks(
 function $getNodeFromLocation(
   location: UsjLocation,
 ): [LexicalNode | undefined, number | undefined] {
+  const jsonPathIndexes = indexesFromUsjJsonPath(location.jsonPath);
   let currentNode: LexicalNode | undefined = $getRoot();
-  for (const index of location.jsonPathIndexes) {
+  for (const index of jsonPathIndexes) {
     if (!currentNode || !$isElementNode(currentNode)) return [undefined, undefined];
 
     currentNode = currentNode.getChildAtIndex(index) ?? undefined;
@@ -111,7 +116,7 @@ function getLocationFromNode(node: LexicalNode, offset: number): UsjLocation {
     }
     current = parent;
   }
-  return { jsonPathIndexes, offset };
+  return { jsonPath: usjJsonPathFromIndexes(jsonPathIndexes), offset };
 }
 
 /**

packages/shared-react/package.json

@@ -16,6 +16,7 @@
     "react-dom": ">=18.3.1"
   },
   "dependencies": {
+    "@biblionexus-foundation/scripture-utilities": "workspace:*",
     "@floating-ui/dom": "^1.6.13",
     "@lexical/react": "^0.27.2",
     "@lexical/utils": "^0.27.2",