@eten-tech-foundation/scripture-utilities 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2023-2025 ETEN Tech Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,89 @@
+# scripture-utilities
+
+<div align="center">
+
+[![Build Status][github-actions-status]][github-actions-url]
+[![CodeQL][gitghub-codeql-status]][gitghub-codeql-url]
+[![Github Tag][npm-version-image]][npm-version-url]
+
+</div>
+
+Utilities for working with Scripture data.
+
+## Features
+
+For data that conforms to [USX/USJ v3.1](https://docs.usfm.bible/usfm/3.1/):
+
+- USJ to USX converter.
+- USX to USJ converter.
+
+## Install
+
+```sh
+npm install @eten-tech-foundation/scripture-utilities
+```
+
+## Usage
+
+```ts
+import { usxStringToUsj, usjToUsxString } from "@eten-tech-foundation/scripture-utilities";
+
+const emptyUsx = '<usx version="3.1" />';
+const usx = `
+<?xml version="1.0" encoding="utf-8"?>
+<usx version="3.1">
+  <book code="PSA" style="id">World English Bible (WEB)</book>
+  <para style="mt1">The Psalms</para>
+  <chapter number="1" style="c" sid="PSA 1" />
+  <para style="q1">
+    <verse number="1" style="v" sid="PSA 1:1" />Blessed is the man who doesn’t walk in the counsel of the wicked,</para>
+  <para style="q2" vid="PSA 1:1">nor stand on the path of sinners,</para>
+  <para style="q2" vid="PSA 1:1">nor sit in the seat of scoffers;<verse eid="PSA 1:1" /></para>
+</usx>
+`;
+
+const emptyUsj = usxStringToUsj(emptyUsx);
+const usj = usxStringToUsj(usx);
+
+const newUsx = usjToUsxString(usj);
+```
+
+## Building
+
+Run `nx build utilities` to build the library.
+
+## Running unit tests
+
+Run `nx test utilities` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Develop in App
+
+To develop these utilities in a target application you can use [yalc](https://www.npmjs.com/package/yalc) to link the editor in without having to publish to NPM every time something changes.
+
+1. In this monorepo, publish the editor to `yalc`, e.g.:
+   ```bash
+   nx devpub utilities
+   ```
+2. In the target application repo, link from `yalc`:
+   ```bash
+   yalc link @eten-tech-foundation/scripture-utilities
+   ```
+3. In this monorepo, make changes and re-publish the editor (see step 1).
+4. When you have finished developing in the target application repo, unlink from `yalc`:
+   ```bash
+   yalc remove @eten-tech-foundation/scripture-utilities && npm i
+   ```
+
+## License
+
+[MIT][github-license] © [ETEN Tech Foundation](https://missionmutual.org)
+
+<!-- define variables used above -->
+
+[github-actions-status]: https://github.com/eten-tech-foundation/scripture-editors/actions/workflows/test-publish.yml/badge.svg
+[github-actions-url]: https://github.com/eten-tech-foundation/scripture-editors/actions
+[gitghub-codeql-status]: https://github.com/eten-tech-foundation/scripture-editors/actions/workflows/codeql.yml/badge.svg
+[gitghub-codeql-url]: https://github.com/eten-tech-foundation/scripture-editors/actions/workflows/codeql.yml
+[npm-version-image]: https://img.shields.io/npm/v/@eten-tech-foundation/scripture-utilities
+[npm-version-url]: https://github.com/eten-tech-foundation/scripture-editors/releases
+[github-license]: https://github.com/eten-tech-foundation/scripture-editors/blob/main/packages/utilities/LICENSE

package/dist/converters/usj/jsonpath-indexes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Converts a USJ JSONPath string into an array of indexes.
+ *
+ * @param jsonPath - The USJ JSONPath string to convert. It must start with `$` and contain `.content[index]` segments.
+ * @returns An array of numeric indexes extracted from the JSONPath.
+ * @throws Will throw an error if the JSONPath does not start with `$`.
+ */
+export declare function indexesFromUsjJsonPath(jsonPath: string): number[];
+/**
+ * Converts an array of indexes into a USJ JSONPath string.
+ *
+ * @param indexes - An array of numeric indexes to convert.
+ * @returns A USJ JSONPath string constructed from the indexes.
+ */
+export declare function usjJsonPathFromIndexes(indexes: number[]): string;

package/dist/converters/usj/usj-to-usx.d.ts

@@ -0,0 +1,4 @@
+import { Document, Element } from '@xmldom/xmldom';
+import { Usj } from './usj.model';
+export declare function usjToUsxString(usj: Usj): string;
+export declare function usjToUsxDom(usj: Usj, usxDoc: Document): Element | undefined;

package/dist/converters/usj/usj.model.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Unified Scripture JSON (USJ) - The JSON variant of USFM and USX data models.
+ * These types follow this schema:
+ * @see https://github.com/usfm-bible/tcdocs/blob/usj/grammar/usj.js
+ */
+/** The USJ spec type */
+export declare const USJ_TYPE = "USJ";
+/** The USJ spec version */
+export declare const USJ_VERSION = "3.1";
+/** List of known properties of `MarkerObject` */
+export declare const MARKER_OBJECT_PROPS: (keyof MarkerObject)[];
+/** Single piece of Scripture content */
+export type MarkerContent = string | MarkerObject;
+/** A Scripture Marker and its contents */
+export type MarkerObject = {
+    /**
+     * The kind/category of node or element this is, corresponding the USFM marker and USX node
+     * @example `para`, `verse`, `char`
+     */
+    type: string;
+    /**
+     * The corresponding marker in USFM or style in USX
+     * @example `p`, `v`, `nd`
+     */
+    marker: string;
+    /** This marker's contents laid out in order */
+    content?: MarkerContent[];
+    /** Indicates the Book-chapter-verse value in the paragraph based structure */
+    sid?: string;
+    /** Milestone end ID, matches start ID (not currently included in USJ spec) */
+    eid?: string;
+    /** Chapter number or verse number */
+    number?: string;
+    /** The 3-letter book code in ID element */
+    code?: BookCode;
+    /** Alternate chapter number or verse number */
+    altnumber?: string;
+    /** Published character of chapter or verse */
+    pubnumber?: string;
+    /** Caller character for footnotes and cross-refs */
+    caller?: string;
+    /** Alignment of table cells */
+    align?: string;
+    /** Category of extended study bible sections */
+    category?: string;
+};
+/** Scripture data represented in JSON format. Data compatible transformation from USX/USFM */
+export type Usj = {
+    /** The USJ spec type */
+    type: typeof USJ_TYPE;
+    /** The USJ spec version */
+    version: typeof USJ_VERSION;
+    /** The JSON representation of scripture contents from USFM/USX */
+    content: MarkerContent[];
+};
+export declare function isValidBookCode(code: string): boolean;
+/** 3-letter Scripture book code */
+export type BookCode = (typeof VALID_BOOK_CODES)[number];
+declare const VALID_BOOK_CODES: readonly ["GEN", "EXO", "LEV", "NUM", "DEU", "JOS", "JDG", "RUT", "1SA", "2SA", "1KI", "2KI", "1CH", "2CH", "EZR", "NEH", "EST", "JOB", "PSA", "PRO", "ECC", "SNG", "ISA", "JER", "LAM", "EZK", "DAN", "HOS", "JOL", "AMO", "OBA", "JON", "MIC", "NAM", "HAB", "ZEP", "HAG", "ZEC", "MAL", "MAT", "MRK", "LUK", "JHN", "ACT", "ROM", "1CO", "2CO", "GAL", "EPH", "PHP", "COL", "1TH", "2TH", "1TI", "2TI", "TIT", "PHM", "HEB", "JAS", "1PE", "2PE", "1JN", "2JN", "3JN", "JUD", "REV", "TOB", "JDT", "ESG", "WIS", "SIR", "BAR", "LJE", "S3Y", "SUS", "BEL", "1MA", "2MA", "3MA", "4MA", "1ES", "2ES", "MAN", "PS2", "ODA", "PSS", "EZA", "5EZ", "6EZ", "DAG", "PS3", "2BA", "LBA", "JUB", "ENO", "1MQ", "2MQ", "3MQ", "REP", "4BA", "LAO", "FRT", "BAK", "OTH", "INT", "CNC", "GLO", "TDX", "NDX", "XXA", "XXB", "XXC", "XXD", "XXE", "XXF", "XXG"];
+export {};

package/dist/converters/usj/usx-to-usj.d.ts

@@ -0,0 +1,4 @@
+import { Element } from '@xmldom/xmldom';
+import { Usj } from './usj.model';
+export declare function usxStringToUsj(usxString: string): Usj;
+export declare function usxDomToUsj(inputUsxDom: Element | null): Usj;

package/dist/converters/usj/usx.model.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Unified Scripture XML (USX).
+ * These types follow this schema:
+ * @see https://github.com/usfm-bible/tcdocs/blob/main/grammar/usx.rng
+ */
+/** The USX spec type */
+export declare const USX_TYPE = "usx";
+/** The USX spec version */
+export declare const USX_VERSION = "3.1";

package/dist/index.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const O=require("@xmldom/xmldom"),p="USJ",N="3.1",J=["type","marker","content","sid","eid","number","code","altnumber","pubnumber","caller","align","category"];function v(e){return m.includes(e)}const m=["GEN","EXO","LEV","NUM","DEU","JOS","JDG","RUT","1SA","2SA","1KI","2KI","1CH","2CH","EZR","NEH","EST","JOB","PSA","PRO","ECC","SNG","ISA","JER","LAM","EZK","DAN","HOS","JOL","AMO","OBA","JON","MIC","NAM","HAB","ZEP","HAG","ZEC","MAL","MAT","MRK","LUK","JHN","ACT","ROM","1CO","2CO","GAL","EPH","PHP","COL","1TH","2TH","1TI","2TI","TIT","PHM","HEB","JAS","1PE","2PE","1JN","2JN","3JN","JUD","REV","TOB","JDT","ESG","WIS","SIR","BAR","LJE","S3Y","SUS","BEL","1MA","2MA","3MA","4MA","1ES","2ES","MAN","PS2","ODA","PSS","EZA","5EZ","6EZ","DAG","PS3","2BA","LBA","JUB","ENO","1MQ","2MQ","3MQ","REP","4BA","LAO","FRT","BAK","OTH","INT","CNC","GLO","TDX","NDX","XXA","XXB","XXC","XXD","XXE","XXF","XXG"],u="usx",y="3.1";function M(e){const n=new O.DOMParser().parseFromString(e,"text/xml");return R(n.documentElement)}function R(e){const[t]=e?P(e):[{content:[]}];return t.type=p,t.version=N,t}function P(e){const t={};let n=e.tagName,o,s,c="append";if(["row","cell"].includes(n)&&(n="table:"+n),e.attributes)for(const r of Array.from(e.attributes))t[r.name]=r.value;t.style&&(o=t.style,delete t.style),t.vid&&delete t.vid,t.status&&delete t.status;let i={type:n};o&&(i.marker=o),i={...i,...t},e.firstChild&&e.firstChild.nodeType===e.firstChild.TEXT_NODE&&e.firstChild.nodeValue&&E(e.firstChild.nodeValue)!==""&&(s=e.firstChild.nodeValue);const l=Array.from(e.childNodes);i.content=[],s&&i.content.push(s);for(const r of l){if(r.tagName===void 0)continue;const[f,S]=P(r);switch(S){case"append":i.content.push(f);break;case"merge":i.content=i.content.concat(f);break}r.nextSibling&&r.nextSibling.nodeType===r.nextSibling.TEXT_NODE&&r.nextSibling.nodeValue&&(E(r.nextSibling.nodeValue)!==""||r.nextSibling.nodeValue===" ")&&i.content.push(r.nextSibling.nodeValue)}return i.content.length===0&&i.type!==u&&delete i.content,"eid"in i&&["verse","chapter"].includes(n)&&(c="ignore"),[i,c]}function E(e){return e.replace(/(^[ \t\n\r\f\v]+)|([ \t\n\r\f\v]+$)/g,"")}let d,a;function X(e){const t=new O.DOMImplementation().createDocument("",u);return t.documentElement&&(t.documentElement.setAttribute("version",y),_(e,t)),t.toString()}function _(e,t){if(t.documentElement){for(const[n,o]of e.content.entries()){const s=n===e.content.length-1;b(o,t.documentElement,t,s)}return t.documentElement??void 0}}function b(e,t,n,o){let s,c,i;if(typeof e=="string")s=n.createTextNode(e);else if(c=e.type.replace("table:",""),s=n.createElement(c),B(s,e),e.content)for(const[r,f]of e.content.entries()){const S=r===e.content.length-1;b(f,s,n,S)}a&&(c==="verse"||t.tagName==="para"&&o)&&(i=T(n,a),a=void 0),c==="verse"&&typeof e!="string"&&e.sid!==void 0&&(a=e.sid),d&&(c==="chapter"||c==="para"&&o)&&(i=h(n,d),d=void 0),c==="chapter"&&typeof e!="string"&&e.sid!==void 0&&(d=e.sid);const l=t.nodeName===u&&(i==null?void 0:i.tagName)==="verse";i&&(!o||l)&&t.appendChild(i),t.appendChild(s),i&&o&&!l&&t.appendChild(i),o&&t.nodeName===u&&(a&&t.appendChild(T(n,a)),d&&t.appendChild(h(n,d)),a=void 0,d=void 0)}function B(e,t){t.type==="unmatched"?e.setAttribute("marker",t.marker):e.setAttribute("style",t.marker);for(const[n,o]of Object.entries(t))o&&!["type","marker","content"].includes(n)&&e.setAttribute(n,o)}function T(e,t){const n=e.createElement("verse");return n.setAttribute("eid",t),n}function h(e,t){const n=e.createElement("chapter");return n.setAttribute("eid",t),n}const A="$",g=".content[";function I(e){const t=e.split(g);if(t.shift()!==A)throw new Error(`indexesFromJsonPath: jsonPath didn't start with '${A}'`);return t.map(o=>parseInt(o,10))}function C(e){return e.reduce((t,n)=>`${t}${g}${n}]`,A)}exports.MARKER_OBJECT_PROPS=J;exports.USJ_TYPE=p;exports.USJ_VERSION=N;exports.indexesFromUsjJsonPath=I;exports.isValidBookCode=v;exports.usjJsonPathFromIndexes=C;exports.usjToUsxString=X;exports.usxStringToUsj=M;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/converters/usj/usj.model.ts","../src/converters/usj/usx.model.ts","../src/converters/usj/usx-to-usj.ts","../src/converters/usj/usj-to-usx.ts","../src/converters/usj/jsonpath-indexes.ts"],"sourcesContent":["/**\n * Unified Scripture JSON (USJ) - The JSON variant of USFM and USX data models.\n * These types follow this schema:\n * @see https://github.com/usfm-bible/tcdocs/blob/usj/grammar/usj.js\n */\n\n/** The USJ spec type */\nexport const USJ_TYPE = \"USJ\";\n/** The USJ spec version */\nexport const USJ_VERSION = \"3.1\";\n/** List of known properties of `MarkerObject` */\nexport const MARKER_OBJECT_PROPS: (keyof MarkerObject)[] = [\n  \"type\",\n  \"marker\",\n  \"content\",\n  \"sid\",\n  \"eid\",\n  \"number\",\n  \"code\",\n  \"altnumber\",\n  \"pubnumber\",\n  \"caller\",\n  \"align\",\n  \"category\",\n];\n\n/** Single piece of Scripture content */\nexport type MarkerContent = string | MarkerObject;\n\n/** A Scripture Marker and its contents */\nexport type MarkerObject = {\n  /**\n   * The kind/category of node or element this is, corresponding the USFM marker and USX node\n   * @example `para`, `verse`, `char`\n   */\n  type: string;\n  /**\n   * The corresponding marker in USFM or style in USX\n   * @example `p`, `v`, `nd`\n   */\n  marker: string;\n  /** This marker's contents laid out in order */\n  content?: MarkerContent[];\n  /** Indicates the Book-chapter-verse value in the paragraph based structure */\n  sid?: string;\n  /** Milestone end ID, matches start ID (not currently included in USJ spec) */\n  eid?: string;\n  /** Chapter number or verse number */\n  number?: string;\n  /** The 3-letter book code in ID element */\n  code?: BookCode;\n  /** Alternate chapter number or verse number */\n  altnumber?: string;\n  /** Published character of chapter or verse */\n  pubnumber?: string;\n  /** Caller character for footnotes and cross-refs */\n  caller?: string;\n  /** Alignment of table cells */\n  align?: string;\n  /** Category of extended study bible sections */\n  category?: string;\n};\n\n/** Scripture data represented in JSON format. Data compatible transformation from USX/USFM */\nexport type Usj = {\n  /** The USJ spec type */\n  type: typeof USJ_TYPE;\n  /** The USJ spec version */\n  version: typeof USJ_VERSION;\n  /** The JSON representation of scripture contents from USFM/USX */\n  content: MarkerContent[];\n};\n\nexport function isValidBookCode(code: string): boolean {\n  return VALID_BOOK_CODES.includes(code as BookCode);\n}\n\n/** 3-letter Scripture book code */\nexport type BookCode = (typeof VALID_BOOK_CODES)[number];\n\nconst VALID_BOOK_CODES = [\n  // Old Testament\n  \"GEN\",\n  \"EXO\",\n  \"LEV\",\n  \"NUM\",\n  \"DEU\",\n  \"JOS\",\n  \"JDG\",\n  \"RUT\",\n  \"1SA\",\n  \"2SA\",\n  \"1KI\",\n  \"2KI\",\n  \"1CH\",\n  \"2CH\",\n  \"EZR\",\n  \"NEH\",\n  \"EST\",\n  \"JOB\",\n  \"PSA\",\n  \"PRO\",\n  \"ECC\",\n  \"SNG\",\n  \"ISA\",\n  \"JER\",\n  \"LAM\",\n  \"EZK\",\n  \"DAN\",\n  \"HOS\",\n  \"JOL\",\n  \"AMO\",\n  \"OBA\",\n  \"JON\",\n  \"MIC\",\n  \"NAM\",\n  \"HAB\",\n  \"ZEP\",\n  \"HAG\",\n  \"ZEC\",\n  \"MAL\",\n  // New Testament\n  \"MAT\",\n  \"MRK\",\n  \"LUK\",\n  \"JHN\",\n  \"ACT\",\n  \"ROM\",\n  \"1CO\",\n  \"2CO\",\n  \"GAL\",\n  \"EPH\",\n  \"PHP\",\n  \"COL\",\n  \"1TH\",\n  \"2TH\",\n  \"1TI\",\n  \"2TI\",\n  \"TIT\",\n  \"PHM\",\n  \"HEB\",\n  \"JAS\",\n  \"1PE\",\n  \"2PE\",\n  \"1JN\",\n  \"2JN\",\n  \"3JN\",\n  \"JUD\",\n  \"REV\",\n  // Deuterocanon\n  \"TOB\",\n  \"JDT\",\n  \"ESG\",\n  \"WIS\",\n  \"SIR\",\n  \"BAR\",\n  \"LJE\",\n  \"S3Y\",\n  \"SUS\",\n  \"BEL\",\n  \"1MA\",\n  \"2MA\",\n  \"3MA\",\n  \"4MA\",\n  \"1ES\",\n  \"2ES\",\n  \"MAN\",\n  \"PS2\",\n  \"ODA\",\n  \"PSS\",\n  \"EZA\",\n  \"5EZ\",\n  \"6EZ\",\n  \"DAG\",\n  \"PS3\",\n  \"2BA\",\n  \"LBA\",\n  \"JUB\",\n  \"ENO\",\n  \"1MQ\",\n  \"2MQ\",\n  \"3MQ\",\n  \"REP\",\n  \"4BA\",\n  \"LAO\",\n  // Non scripture\n  \"FRT\",\n  \"BAK\",\n  \"OTH\",\n  \"INT\",\n  \"CNC\",\n  \"GLO\",\n  \"TDX\",\n  \"NDX\",\n  \"XXA\",\n  \"XXB\",\n  \"XXC\",\n  \"XXD\",\n  \"XXE\",\n  \"XXF\",\n  \"XXG\",\n] as const;\n","/**\n * Unified Scripture XML (USX).\n * These types follow this schema:\n * @see https://github.com/usfm-bible/tcdocs/blob/main/grammar/usx.rng\n */\n\n/** The USX spec type */\nexport const USX_TYPE = \"usx\";\n/** The USX spec version */\nexport const USX_VERSION = \"3.1\";\n","/**\n * Convert Scripture from USX to USJ.\n * Adapted to TypeScript from this file:\n * @see https://github.com/usfm-bible/usfmtc/blob/0afa385a1f282b286cc6bff7bbc953ae788aa10c/src/usfmtc/usjproc.py\n */\n\nimport { DOMParser, Element } from \"@xmldom/xmldom\";\nimport { MarkerContent, MarkerObject, USJ_TYPE, USJ_VERSION, Usj } from \"./usj.model\";\nimport { USX_TYPE } from \"./usx.model\";\n\ntype Action = \"append\" | \"merge\" | \"ignore\";\ntype Attribs = { [name: string]: string };\n\nexport function usxStringToUsj(usxString: string): Usj {\n  const parser = new DOMParser();\n  const inputUsxDom = parser.parseFromString(usxString, \"text/xml\");\n  return usxDomToUsj(inputUsxDom.documentElement);\n}\n\nexport function usxDomToUsj(inputUsxDom: Element | null): Usj {\n  const [outputJson] = inputUsxDom\n    ? convertUsxRecurse(inputUsxDom)\n    : [{ content: [] as MarkerContent[] } as Usj];\n  outputJson.type = USJ_TYPE;\n  outputJson.version = USJ_VERSION;\n  return outputJson;\n}\n\nfunction convertUsxRecurse<T extends Usj | MarkerObject = Usj>(\n  inputUsxElement: Element,\n): [outputJson: T, action: Action] {\n  const attribs: Attribs = {};\n  let type: string = inputUsxElement.tagName;\n  let marker: string | undefined;\n  let text: string | undefined;\n  let action: Action = \"append\";\n\n  if ([\"row\", \"cell\"].includes(type)) type = \"table:\" + type;\n  if (inputUsxElement.attributes) {\n    for (const attrib of Array.from(inputUsxElement.attributes)) {\n      attribs[attrib.name] = attrib.value;\n    }\n  }\n\n  if (attribs.style) {\n    marker = attribs.style;\n    delete attribs.style;\n  }\n  // dropping because presence of vid in para elements is not consistent in USX\n  if (attribs.vid) delete attribs.vid;\n  // Not dropping `attribs.closed` for backwards compatibility.\n  // dropping because it is nonstandard derived metadata that could get out of date\n  if (attribs.status) delete attribs.status;\n\n  let outObj: T = { type } as T;\n  if (marker) (outObj as MarkerObject).marker = marker;\n  outObj = { ...outObj, ...attribs };\n\n  if (\n    inputUsxElement.firstChild &&\n    inputUsxElement.firstChild.nodeType === inputUsxElement.firstChild.TEXT_NODE &&\n    inputUsxElement.firstChild.nodeValue &&\n    asciiTrim(inputUsxElement.firstChild.nodeValue) !== \"\"\n  ) {\n    text = inputUsxElement.firstChild.nodeValue;\n  }\n\n  const children = Array.from(inputUsxElement.childNodes);\n  outObj.content = [];\n\n  if (text) {\n    outObj.content.push(text);\n  }\n\n  for (const child of children) {\n    // ChildNodes are Elements.\n    if ((child as Element).tagName === undefined) {\n      continue;\n    }\n    // ChildNodes are Elements.\n    const [childDict, whatToDo] = convertUsxRecurse<MarkerObject>(child as Element);\n\n    switch (whatToDo) {\n      case \"append\":\n        outObj.content.push(childDict);\n        break;\n      case \"merge\":\n        outObj.content = outObj.content.concat(childDict);\n        break;\n      case \"ignore\":\n        break;\n      default:\n        break;\n    }\n\n    // Handle tail text\n    if (\n      child.nextSibling &&\n      child.nextSibling.nodeType === child.nextSibling.TEXT_NODE &&\n      child.nextSibling.nodeValue &&\n      (asciiTrim(child.nextSibling.nodeValue) !== \"\" || child.nextSibling.nodeValue === \" \")\n    ) {\n      outObj.content.push(child.nextSibling.nodeValue);\n    }\n  }\n\n  // For backward compatibility, not deleting content for type: chapter, verse, optbreak, ms OR\n  // marker: va, ca, b.\n  if (outObj.content.length === 0 && outObj.type !== USX_TYPE) {\n    delete outObj.content;\n  }\n\n  if (\"eid\" in outObj && [\"verse\", \"chapter\"].includes(type)) {\n    action = \"ignore\";\n  }\n\n  return [outObj, action];\n}\n\n/**\n * Removes leading and trailing ASCII whitespace.\n *\n * Only trim ASCII whitespace characters: space, tab, line feed, carriage return, form feed,\n * vertical tab.\n * @param str - The string to remove whitespace from.\n * @returns the string with leading and trailing whitespace removed.\n */\nfunction asciiTrim(str: string): string {\n  return str.replace(/(^[ \\t\\n\\r\\f\\v]+)|([ \\t\\n\\r\\f\\v]+$)/g, \"\");\n}\n","/**\n * Convert Scripture from USJ to USX.\n * Adapted to TypeScript from this file:\n * @see https://github.com/usfm-bible/usfmtc/blob/0afa385a1f282b286cc6bff7bbc953ae788aa10c/src/usfmtc/usjproc.py\n */\n\nimport { DOMImplementation, Document, Element, Text } from \"@xmldom/xmldom\";\nimport { MarkerContent, MarkerObject, Usj } from \"./usj.model\";\nimport { USX_TYPE, USX_VERSION } from \"./usx.model\";\n\nlet chapterEid: string | undefined;\nlet verseEid: string | undefined;\n\nexport function usjToUsxString(usj: Usj): string {\n  const usxDoc = new DOMImplementation().createDocument(\"\", USX_TYPE);\n  if (usxDoc.documentElement) {\n    usxDoc.documentElement.setAttribute(\"version\", USX_VERSION);\n    usjToUsxDom(usj, usxDoc);\n  }\n  return usxDoc.toString();\n}\n\nexport function usjToUsxDom(usj: Usj, usxDoc: Document): Element | undefined {\n  if (!usxDoc.documentElement) return undefined;\n\n  for (const [index, markerContent] of usj.content.entries()) {\n    const isLastItem = index === usj.content.length - 1;\n    convertUsjRecurse(markerContent, usxDoc.documentElement, usxDoc, isLastItem);\n  }\n  return usxDoc.documentElement ?? undefined;\n}\n\nfunction convertUsjRecurse(\n  markerContent: MarkerContent,\n  parentElement: Element,\n  usxDoc: Document,\n  isLastItem: boolean,\n) {\n  let element: Text | Element;\n  let type: string | undefined;\n  let eidElement: Element | undefined;\n  if (typeof markerContent === \"string\") element = usxDoc.createTextNode(markerContent);\n  else {\n    type = markerContent.type.replace(\"table:\", \"\");\n    element = usxDoc.createElement(type);\n    setAttributes(element, markerContent);\n    if (markerContent.content) {\n      for (const [index, item] of markerContent.content.entries()) {\n        const _isLastItem = index === markerContent.content.length - 1;\n        convertUsjRecurse(item, element, usxDoc, _isLastItem);\n      }\n    }\n  }\n\n  // Create chapter and verse end elements from SID attributes.\n  if (verseEid && (type === \"verse\" || (parentElement.tagName === \"para\" && isLastItem))) {\n    eidElement = createVerseEndElement(usxDoc, verseEid);\n    verseEid = undefined;\n  }\n  if (type === \"verse\" && typeof markerContent !== \"string\" && markerContent.sid !== undefined)\n    verseEid = markerContent.sid;\n\n  if (chapterEid && (type === \"chapter\" || (type === \"para\" && isLastItem))) {\n    eidElement = createChapterEndElement(usxDoc, chapterEid);\n    chapterEid = undefined;\n  }\n  if (type === \"chapter\" && typeof markerContent !== \"string\" && markerContent.sid !== undefined)\n    chapterEid = markerContent.sid;\n\n  // Append to parent.\n  const isVerseInImpliedPara =\n    parentElement.nodeName === USX_TYPE && eidElement?.tagName === \"verse\";\n  if (eidElement && (!isLastItem || isVerseInImpliedPara)) parentElement.appendChild(eidElement);\n  parentElement.appendChild(element);\n  if (eidElement && isLastItem && !isVerseInImpliedPara) parentElement.appendChild(eidElement);\n\n  // Allow for final chapter and verse end elements at the end of an implied para.\n  if (isLastItem && parentElement.nodeName === USX_TYPE) {\n    if (verseEid) parentElement.appendChild(createVerseEndElement(usxDoc, verseEid));\n    if (chapterEid) parentElement.appendChild(createChapterEndElement(usxDoc, chapterEid));\n    verseEid = undefined;\n    chapterEid = undefined;\n  }\n}\n\nfunction setAttributes(element: Element, markerContent: MarkerObject) {\n  if (markerContent.type === \"unmatched\") element.setAttribute(\"marker\", markerContent.marker);\n  else element.setAttribute(\"style\", markerContent.marker);\n  for (const [key, value] of Object.entries(markerContent)) {\n    if (value && ![\"type\", \"marker\", \"content\"].includes(key)) {\n      element.setAttribute(key, value as string);\n    }\n  }\n}\n\nfunction createVerseEndElement(usxDoc: Document, verseEid: string): Element {\n  const eidElement = usxDoc.createElement(\"verse\");\n  eidElement.setAttribute(\"eid\", verseEid);\n  return eidElement;\n}\n\nfunction createChapterEndElement(usxDoc: Document, chapterEid: string): Element {\n  const eidElement = usxDoc.createElement(\"chapter\");\n  eidElement.setAttribute(\"eid\", chapterEid);\n  return eidElement;\n}\n","const JSON_PATH_START = \"$\";\nconst JSON_PATH_CONTENT = \".content[\";\n\n/**\n * Converts a USJ JSONPath string into an array of indexes.\n *\n * @param jsonPath - The USJ JSONPath string to convert. It must start with `$` and contain `.content[index]` segments.\n * @returns An array of numeric indexes extracted from the JSONPath.\n * @throws Will throw an error if the JSONPath does not start with `$`.\n */\nexport function indexesFromUsjJsonPath(jsonPath: string): number[] {\n  const path = jsonPath.split(JSON_PATH_CONTENT);\n  if (path.shift() !== JSON_PATH_START)\n    throw new Error(`indexesFromJsonPath: jsonPath didn't start with '${JSON_PATH_START}'`);\n\n  const indexes = path.map((str) => parseInt(str, 10));\n  return indexes;\n}\n\n/**\n * Converts an array of indexes into a USJ JSONPath string.\n *\n * @param indexes - An array of numeric indexes to convert.\n * @returns A USJ JSONPath string constructed from the indexes.\n */\nexport function usjJsonPathFromIndexes(indexes: number[]): string {\n  return indexes.reduce((path, index) => `${path}${JSON_PATH_CONTENT}${index}]`, JSON_PATH_START);\n}\n"],"names":["USJ_TYPE","USJ_VERSION","MARKER_OBJECT_PROPS","isValidBookCode","code","VALID_BOOK_CODES","USX_TYPE","USX_VERSION","usxStringToUsj","usxString","inputUsxDom","DOMParser","usxDomToUsj","outputJson","convertUsxRecurse","inputUsxElement","attribs","type","marker","text","action","attrib","outObj","asciiTrim","children","child","childDict","whatToDo","str","chapterEid","verseEid","usjToUsxString","usj","usxDoc","DOMImplementation","usjToUsxDom","index","markerContent","isLastItem","convertUsjRecurse","parentElement","element","eidElement","setAttributes","item","_isLastItem","createVerseEndElement","createChapterEndElement","isVerseInImpliedPara","key","value","JSON_PATH_START","JSON_PATH_CONTENT","indexesFromUsjJsonPath","jsonPath","path","usjJsonPathFromIndexes","indexes"],"mappings":"kHAOaA,EAAW,MAEXC,EAAc,MAEdC,EAA8C,CACzD,OACA,SACA,UACA,MACA,MACA,SACA,OACA,YACA,YACA,SACA,QACA,UACF,EAiDO,SAASC,EAAgBC,EAAuB,CACrD,OAAOC,EAAiB,SAASD,CAAgB,CACnD,CAKA,MAAMC,EAAmB,CAEvB,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MAEA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MAEA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MAEA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,MACA,KACF,EClMaC,EAAW,MAEXC,EAAc,MCIpB,SAASC,EAAeC,EAAwB,CAErD,MAAMC,EADS,IAAIC,YAAA,EACQ,gBAAgBF,EAAW,UAAU,EAChE,OAAOG,EAAYF,EAAY,eAAe,CAChD,CAEO,SAASE,EAAYF,EAAkC,CAC5D,KAAM,CAACG,CAAU,EAAIH,EACjBI,EAAkBJ,CAAW,EAC7B,CAAC,CAAE,QAAS,CAAA,EAA8B,EAC9C,OAAAG,EAAW,KAAOb,EAClBa,EAAW,QAAUZ,EACdY,CACT,CAEA,SAASC,EACPC,EACiC,CACjC,MAAMC,EAAmB,CAAA,EACzB,IAAIC,EAAeF,EAAgB,QAC/BG,EACAC,EACAC,EAAiB,SAGrB,GADI,CAAC,MAAO,MAAM,EAAE,SAASH,CAAI,MAAU,SAAWA,GAClDF,EAAgB,WAClB,UAAWM,KAAU,MAAM,KAAKN,EAAgB,UAAU,EACxDC,EAAQK,EAAO,IAAI,EAAIA,EAAO,MAI9BL,EAAQ,QACVE,EAASF,EAAQ,MACjB,OAAOA,EAAQ,OAGbA,EAAQ,KAAK,OAAOA,EAAQ,IAG5BA,EAAQ,QAAQ,OAAOA,EAAQ,OAEnC,IAAIM,EAAY,CAAE,KAAAL,CAAA,EACdC,IAASI,EAAwB,OAASJ,GAC9CI,EAAS,CAAE,GAAGA,EAAQ,GAAGN,CAAA,EAGvBD,EAAgB,YAChBA,EAAgB,WAAW,WAAaA,EAAgB,WAAW,WACnEA,EAAgB,WAAW,WAC3BQ,EAAUR,EAAgB,WAAW,SAAS,IAAM,KAEpDI,EAAOJ,EAAgB,WAAW,WAGpC,MAAMS,EAAW,MAAM,KAAKT,EAAgB,UAAU,EACtDO,EAAO,QAAU,CAAA,EAEbH,GACFG,EAAO,QAAQ,KAAKH,CAAI,EAG1B,UAAWM,KAASD,EAAU,CAE5B,GAAKC,EAAkB,UAAY,OACjC,SAGF,KAAM,CAACC,EAAWC,CAAQ,EAAIb,EAAgCW,CAAgB,EAE9E,OAAQE,EAAA,CACN,IAAK,SACHL,EAAO,QAAQ,KAAKI,CAAS,EAC7B,MACF,IAAK,QACHJ,EAAO,QAAUA,EAAO,QAAQ,OAAOI,CAAS,EAChD,KAIA,CAKFD,EAAM,aACNA,EAAM,YAAY,WAAaA,EAAM,YAAY,WACjDA,EAAM,YAAY,YACjBF,EAAUE,EAAM,YAAY,SAAS,IAAM,IAAMA,EAAM,YAAY,YAAc,MAElFH,EAAO,QAAQ,KAAKG,EAAM,YAAY,SAAS,CACjD,CAKF,OAAIH,EAAO,QAAQ,SAAW,GAAKA,EAAO,OAAShB,GACjD,OAAOgB,EAAO,QAGZ,QAASA,GAAU,CAAC,QAAS,SAAS,EAAE,SAASL,CAAI,IACvDG,EAAS,UAGJ,CAACE,EAAQF,CAAM,CACxB,CAUA,SAASG,EAAUK,EAAqB,CACtC,OAAOA,EAAI,QAAQ,uCAAwC,EAAE,CAC/D,CCvHA,IAAIC,EACAC,EAEG,SAASC,EAAeC,EAAkB,CAC/C,MAAMC,EAAS,IAAIC,EAAAA,kBAAA,EAAoB,eAAe,GAAI5B,CAAQ,EAClE,OAAI2B,EAAO,kBACTA,EAAO,gBAAgB,aAAa,UAAW1B,CAAW,EAC1D4B,EAAYH,EAAKC,CAAM,GAElBA,EAAO,SAAA,CAChB,CAEO,SAASE,EAAYH,EAAUC,EAAuC,CAC3E,GAAKA,EAAO,gBAEZ,UAAW,CAACG,EAAOC,CAAa,IAAKL,EAAI,QAAQ,UAAW,CAC1D,MAAMM,EAAaF,IAAUJ,EAAI,QAAQ,OAAS,EAClDO,EAAkBF,EAAeJ,EAAO,gBAAiBA,EAAQK,CAAU,CAAA,CAE7E,OAAOL,EAAO,iBAAmB,OACnC,CAEA,SAASM,EACPF,EACAG,EACAP,EACAK,EACA,CACA,IAAIG,EACAxB,EACAyB,EACJ,GAAI,OAAOL,GAAkB,SAAUI,EAAUR,EAAO,eAAeI,CAAa,UAElFpB,EAAOoB,EAAc,KAAK,QAAQ,SAAU,EAAE,EAC9CI,EAAUR,EAAO,cAAchB,CAAI,EACnC0B,EAAcF,EAASJ,CAAa,EAChCA,EAAc,QAChB,SAAW,CAACD,EAAOQ,CAAI,IAAKP,EAAc,QAAQ,UAAW,CAC3D,MAAMQ,EAAcT,IAAUC,EAAc,QAAQ,OAAS,EAC7DE,EAAkBK,EAAMH,EAASR,EAAQY,CAAW,CAAA,CAMtDf,IAAab,IAAS,SAAYuB,EAAc,UAAY,QAAUF,KACxEI,EAAaI,EAAsBb,EAAQH,CAAQ,EACnDA,EAAW,QAETb,IAAS,SAAW,OAAOoB,GAAkB,UAAYA,EAAc,MAAQ,SACjFP,EAAWO,EAAc,KAEvBR,IAAeZ,IAAS,WAAcA,IAAS,QAAUqB,KAC3DI,EAAaK,EAAwBd,EAAQJ,CAAU,EACvDA,EAAa,QAEXZ,IAAS,WAAa,OAAOoB,GAAkB,UAAYA,EAAc,MAAQ,SACnFR,EAAaQ,EAAc,KAG7B,MAAMW,EACJR,EAAc,WAAalC,IAAYoC,GAAA,YAAAA,EAAY,WAAY,QAC7DA,IAAe,CAACJ,GAAcU,IAAuBR,EAAc,YAAYE,CAAU,EAC7FF,EAAc,YAAYC,CAAO,EAC7BC,GAAcJ,GAAc,CAACU,GAAsBR,EAAc,YAAYE,CAAU,EAGvFJ,GAAcE,EAAc,WAAalC,IACvCwB,GAAUU,EAAc,YAAYM,EAAsBb,EAAQH,CAAQ,CAAC,EAC3ED,GAAYW,EAAc,YAAYO,EAAwBd,EAAQJ,CAAU,CAAC,EACrFC,EAAW,OACXD,EAAa,OAEjB,CAEA,SAASc,EAAcF,EAAkBJ,EAA6B,CAChEA,EAAc,OAAS,cAAqB,aAAa,SAAUA,EAAc,MAAM,EACtFI,EAAQ,aAAa,QAASJ,EAAc,MAAM,EACvD,SAAW,CAACY,EAAKC,CAAK,IAAK,OAAO,QAAQb,CAAa,EACjDa,GAAS,CAAC,CAAC,OAAQ,SAAU,SAAS,EAAE,SAASD,CAAG,GACtDR,EAAQ,aAAaQ,EAAKC,CAAe,CAG/C,CAEA,SAASJ,EAAsBb,EAAkBH,EAA2B,CAC1E,MAAMY,EAAaT,EAAO,cAAc,OAAO,EAC/C,OAAAS,EAAW,aAAa,MAAOZ,CAAQ,EAChCY,CACT,CAEA,SAASK,EAAwBd,EAAkBJ,EAA6B,CAC9E,MAAMa,EAAaT,EAAO,cAAc,SAAS,EACjD,OAAAS,EAAW,aAAa,MAAOb,CAAU,EAClCa,CACT,CCzGA,MAAMS,EAAkB,IAClBC,EAAoB,YASnB,SAASC,EAAuBC,EAA4B,CACjE,MAAMC,EAAOD,EAAS,MAAMF,CAAiB,EAC7C,GAAIG,EAAK,UAAYJ,EACnB,MAAM,IAAI,MAAM,oDAAoDA,CAAe,GAAG,EAGxF,OADgBI,EAAK,IAAK3B,GAAQ,SAASA,EAAK,EAAE,CAAC,CAErD,CAQO,SAAS4B,EAAuBC,EAA2B,CAChE,OAAOA,EAAQ,OAAO,CAACF,EAAMnB,IAAU,GAAGmB,CAAI,GAAGH,CAAiB,GAAGhB,CAAK,IAAKe,CAAe,CAChG"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export type { Usj, BookCode, MarkerContent, MarkerObject } from './converters/usj/usj.model';
+export { MARKER_OBJECT_PROPS, USJ_TYPE, USJ_VERSION, isValidBookCode, } from './converters/usj/usj.model';
+export { usxStringToUsj } from './converters/usj/usx-to-usj';
+export { usjToUsxString } from './converters/usj/usj-to-usx';
+export { indexesFromUsjJsonPath, usjJsonPathFromIndexes } from './converters/usj/jsonpath-indexes';

package/dist/index.js

@@ -0,0 +1,238 @@
+import { DOMParser as b, DOMImplementation as g } from "@xmldom/xmldom";
+const v = "USJ", J = "3.1", B = [
+  "type",
+  "marker",
+  "content",
+  "sid",
+  "eid",
+  "number",
+  "code",
+  "altnumber",
+  "pubnumber",
+  "caller",
+  "align",
+  "category"
+];
+function H(e) {
+  return P.includes(e);
+}
+const P = [
+  // Old Testament
+  "GEN",
+  "EXO",
+  "LEV",
+  "NUM",
+  "DEU",
+  "JOS",
+  "JDG",
+  "RUT",
+  "1SA",
+  "2SA",
+  "1KI",
+  "2KI",
+  "1CH",
+  "2CH",
+  "EZR",
+  "NEH",
+  "EST",
+  "JOB",
+  "PSA",
+  "PRO",
+  "ECC",
+  "SNG",
+  "ISA",
+  "JER",
+  "LAM",
+  "EZK",
+  "DAN",
+  "HOS",
+  "JOL",
+  "AMO",
+  "OBA",
+  "JON",
+  "MIC",
+  "NAM",
+  "HAB",
+  "ZEP",
+  "HAG",
+  "ZEC",
+  "MAL",
+  // New Testament
+  "MAT",
+  "MRK",
+  "LUK",
+  "JHN",
+  "ACT",
+  "ROM",
+  "1CO",
+  "2CO",
+  "GAL",
+  "EPH",
+  "PHP",
+  "COL",
+  "1TH",
+  "2TH",
+  "1TI",
+  "2TI",
+  "TIT",
+  "PHM",
+  "HEB",
+  "JAS",
+  "1PE",
+  "2PE",
+  "1JN",
+  "2JN",
+  "3JN",
+  "JUD",
+  "REV",
+  // Deuterocanon
+  "TOB",
+  "JDT",
+  "ESG",
+  "WIS",
+  "SIR",
+  "BAR",
+  "LJE",
+  "S3Y",
+  "SUS",
+  "BEL",
+  "1MA",
+  "2MA",
+  "3MA",
+  "4MA",
+  "1ES",
+  "2ES",
+  "MAN",
+  "PS2",
+  "ODA",
+  "PSS",
+  "EZA",
+  "5EZ",
+  "6EZ",
+  "DAG",
+  "PS3",
+  "2BA",
+  "LBA",
+  "JUB",
+  "ENO",
+  "1MQ",
+  "2MQ",
+  "3MQ",
+  "REP",
+  "4BA",
+  "LAO",
+  // Non scripture
+  "FRT",
+  "BAK",
+  "OTH",
+  "INT",
+  "CNC",
+  "GLO",
+  "TDX",
+  "NDX",
+  "XXA",
+  "XXB",
+  "XXC",
+  "XXD",
+  "XXE",
+  "XXF",
+  "XXG"
+], u = "usx", m = "3.1";
+function I(e) {
+  const n = new b().parseFromString(e, "text/xml");
+  return y(n.documentElement);
+}
+function y(e) {
+  const [t] = e ? p(e) : [{ content: [] }];
+  return t.type = v, t.version = J, t;
+}
+function p(e) {
+  const t = {};
+  let n = e.tagName, o, s, c = "append";
+  if (["row", "cell"].includes(n) && (n = "table:" + n), e.attributes)
+    for (const r of Array.from(e.attributes))
+      t[r.name] = r.value;
+  t.style && (o = t.style, delete t.style), t.vid && delete t.vid, t.status && delete t.status;
+  let i = { type: n };
+  o && (i.marker = o), i = { ...i, ...t }, e.firstChild && e.firstChild.nodeType === e.firstChild.TEXT_NODE && e.firstChild.nodeValue && E(e.firstChild.nodeValue) !== "" && (s = e.firstChild.nodeValue);
+  const l = Array.from(e.childNodes);
+  i.content = [], s && i.content.push(s);
+  for (const r of l) {
+    if (r.tagName === void 0)
+      continue;
+    const [f, A] = p(r);
+    switch (A) {
+      case "append":
+        i.content.push(f);
+        break;
+      case "merge":
+        i.content = i.content.concat(f);
+        break;
+    }
+    r.nextSibling && r.nextSibling.nodeType === r.nextSibling.TEXT_NODE && r.nextSibling.nodeValue && (E(r.nextSibling.nodeValue) !== "" || r.nextSibling.nodeValue === " ") && i.content.push(r.nextSibling.nodeValue);
+  }
+  return i.content.length === 0 && i.type !== u && delete i.content, "eid" in i && ["verse", "chapter"].includes(n) && (c = "ignore"), [i, c];
+}
+function E(e) {
+  return e.replace(/(^[ \t\n\r\f\v]+)|([ \t\n\r\f\v]+$)/g, "");
+}
+let d, a;
+function C(e) {
+  const t = new g().createDocument("", u);
+  return t.documentElement && (t.documentElement.setAttribute("version", m), M(e, t)), t.toString();
+}
+function M(e, t) {
+  if (t.documentElement) {
+    for (const [n, o] of e.content.entries()) {
+      const s = n === e.content.length - 1;
+      O(o, t.documentElement, t, s);
+    }
+    return t.documentElement ?? void 0;
+  }
+}
+function O(e, t, n, o) {
+  let s, c, i;
+  if (typeof e == "string") s = n.createTextNode(e);
+  else if (c = e.type.replace("table:", ""), s = n.createElement(c), X(s, e), e.content)
+    for (const [r, f] of e.content.entries()) {
+      const A = r === e.content.length - 1;
+      O(f, s, n, A);
+    }
+  a && (c === "verse" || t.tagName === "para" && o) && (i = h(n, a), a = void 0), c === "verse" && typeof e != "string" && e.sid !== void 0 && (a = e.sid), d && (c === "chapter" || c === "para" && o) && (i = T(n, d), d = void 0), c === "chapter" && typeof e != "string" && e.sid !== void 0 && (d = e.sid);
+  const l = t.nodeName === u && (i == null ? void 0 : i.tagName) === "verse";
+  i && (!o || l) && t.appendChild(i), t.appendChild(s), i && o && !l && t.appendChild(i), o && t.nodeName === u && (a && t.appendChild(h(n, a)), d && t.appendChild(T(n, d)), a = void 0, d = void 0);
+}
+function X(e, t) {
+  t.type === "unmatched" ? e.setAttribute("marker", t.marker) : e.setAttribute("style", t.marker);
+  for (const [n, o] of Object.entries(t))
+    o && !["type", "marker", "content"].includes(n) && e.setAttribute(n, o);
+}
+function h(e, t) {
+  const n = e.createElement("verse");
+  return n.setAttribute("eid", t), n;
+}
+function T(e, t) {
+  const n = e.createElement("chapter");
+  return n.setAttribute("eid", t), n;
+}
+const S = "$", N = ".content[";
+function V(e) {
+  const t = e.split(N);
+  if (t.shift() !== S)
+    throw new Error(`indexesFromJsonPath: jsonPath didn't start with '${S}'`);
+  return t.map((o) => parseInt(o, 10));
+}
+function _(e) {
+  return e.reduce((t, n) => `${t}${N}${n}]`, S);
+}
+export {
+  B as MARKER_OBJECT_PROPS,
+  v as USJ_TYPE,
+  J as USJ_VERSION,
+  V as indexesFromUsjJsonPath,
+  H as isValidBookCode,
+  _ as usjJsonPathFromIndexes,
+  C as usjToUsxString,
+  I as usxStringToUsj
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/converters/usj/usj.model.ts","../src/converters/usj/usx.model.ts","../src/converters/usj/usx-to-usj.ts","../src/converters/usj/usj-to-usx.ts","../src/converters/usj/jsonpath-indexes.ts"],"sourcesContent":["/**\n * Unified Scripture JSON (USJ) - The JSON variant of USFM and USX data models.\n * These types follow this schema:\n * @see https://github.com/usfm-bible/tcdocs/blob/usj/grammar/usj.js\n */\n\n/** The USJ spec type */\nexport const USJ_TYPE = \"USJ\";\n/** The USJ spec version */\nexport const USJ_VERSION = \"3.1\";\n/** List of known properties of `MarkerObject` */\nexport const MARKER_OBJECT_PROPS: (keyof MarkerObject)[] = [\n  \"type\",\n  \"marker\",\n  \"content\",\n  \"sid\",\n  \"eid\",\n  \"number\",\n  \"code\",\n  \"altnumber\",\n  \"pubnumber\",\n  \"caller\",\n  \"align\",\n  \"category\",\n];\n\n/** Single piece of Scripture content */\nexport type MarkerContent = string | MarkerObject;\n\n/** A Scripture Marker and its contents */\nexport type MarkerObject = {\n  /**\n   * The kind/category of node or element this is, corresponding the USFM marker and USX node\n   * @example `para`, `verse`, `char`\n   */\n  type: string;\n  /**\n   * The corresponding marker in USFM or style in USX\n   * @example `p`, `v`, `nd`\n   */\n  marker: string;\n  /** This marker's contents laid out in order */\n  content?: MarkerContent[];\n  /** Indicates the Book-chapter-verse value in the paragraph based structure */\n  sid?: string;\n  /** Milestone end ID, matches start ID (not currently included in USJ spec) */\n  eid?: string;\n  /** Chapter number or verse number */\n  number?: string;\n  /** The 3-letter book code in ID element */\n  code?: BookCode;\n  /** Alternate chapter number or verse number */\n  altnumber?: string;\n  /** Published character of chapter or verse */\n  pubnumber?: string;\n  /** Caller character for footnotes and cross-refs */\n  caller?: string;\n  /** Alignment of table cells */\n  align?: string;\n  /** Category of extended study bible sections */\n  category?: string;\n};\n\n/** Scripture data represented in JSON format. Data compatible transformation from USX/USFM */\nexport type Usj = {\n  /** The USJ spec type */\n  type: typeof USJ_TYPE;\n  /** The USJ spec version */\n  version: typeof USJ_VERSION;\n  /** The JSON representation of scripture contents from USFM/USX */\n  content: MarkerContent[];\n};\n\nexport function isValidBookCode(code: string): boolean {\n  return VALID_BOOK_CODES.includes(code as BookCode);\n}\n\n/** 3-letter Scripture book code */\nexport type BookCode = (typeof VALID_BOOK_CODES)[number];\n\nconst VALID_BOOK_CODES = [\n  // Old Testament\n  \"GEN\",\n  \"EXO\",\n  \"LEV\",\n  \"NUM\",\n  \"DEU\",\n  \"JOS\",\n  \"JDG\",\n  \"RUT\",\n  \"1SA\",\n  \"2SA\",\n  \"1KI\",\n  \"2KI\",\n  \"1CH\",\n  \"2CH\",\n  \"EZR\",\n  \"NEH\",\n  \"EST\",\n  \"JOB\",\n  \"PSA\",\n  \"PRO\",\n  \"ECC\",\n  \"SNG\",\n  \"ISA\",\n  \"JER\",\n  \"LAM\",\n  \"EZK\",\n  \"DAN\",\n  \"HOS\",\n  \"JOL\",\n  \"AMO\",\n  \"OBA\",\n  \"JON\",\n  \"MIC\",\n  \"NAM\",\n  \"HAB\",\n  \"ZEP\",\n  \"HAG\",\n  \"ZEC\",\n  \"MAL\",\n  // New Testament\n  \"MAT\",\n  \"MRK\",\n  \"LUK\",\n  \"JHN\",\n  \"ACT\",\n  \"ROM\",\n  \"1CO\",\n  \"2CO\",\n  \"GAL\",\n  \"EPH\",\n  \"PHP\",\n  \"COL\",\n  \"1TH\",\n  \"2TH\",\n  \"1TI\",\n  \"2TI\",\n  \"TIT\",\n  \"PHM\",\n  \"HEB\",\n  \"JAS\",\n  \"1PE\",\n  \"2PE\",\n  \"1JN\",\n  \"2JN\",\n  \"3JN\",\n  \"JUD\",\n  \"REV\",\n  // Deuterocanon\n  \"TOB\",\n  \"JDT\",\n  \"ESG\",\n  \"WIS\",\n  \"SIR\",\n  \"BAR\",\n  \"LJE\",\n  \"S3Y\",\n  \"SUS\",\n  \"BEL\",\n  \"1MA\",\n  \"2MA\",\n  \"3MA\",\n  \"4MA\",\n  \"1ES\",\n  \"2ES\",\n  \"MAN\",\n  \"PS2\",\n  \"ODA\",\n  \"PSS\",\n  \"EZA\",\n  \"5EZ\",\n  \"6EZ\",\n  \"DAG\",\n  \"PS3\",\n  \"2BA\",\n  \"LBA\",\n  \"JUB\",\n  \"ENO\",\n  \"1MQ\",\n  \"2MQ\",\n  \"3MQ\",\n  \"REP\",\n  \"4BA\",\n  \"LAO\",\n  // Non scripture\n  \"FRT\",\n  \"BAK\",\n  \"OTH\",\n  \"INT\",\n  \"CNC\",\n  \"GLO\",\n  \"TDX\",\n  \"NDX\",\n  \"XXA\",\n  \"XXB\",\n  \"XXC\",\n  \"XXD\",\n  \"XXE\",\n  \"XXF\",\n  \"XXG\",\n] as const;\n","/**\n * Unified Scripture XML (USX).\n * These types follow this schema:\n * @see https://github.com/usfm-bible/tcdocs/blob/main/grammar/usx.rng\n */\n\n/** The USX spec type */\nexport const USX_TYPE = \"usx\";\n/** The USX spec version */\nexport const USX_VERSION = \"3.1\";\n","/**\n * Convert Scripture from USX to USJ.\n * Adapted to TypeScript from this file:\n * @see https://github.com/usfm-bible/usfmtc/blob/0afa385a1f282b286cc6bff7bbc953ae788aa10c/src/usfmtc/usjproc.py\n */\n\nimport { DOMParser, Element } from \"@xmldom/xmldom\";\nimport { MarkerContent, MarkerObject, USJ_TYPE, USJ_VERSION, Usj } from \"./usj.model\";\nimport { USX_TYPE } from \"./usx.model\";\n\ntype Action = \"append\" | \"merge\" | \"ignore\";\ntype Attribs = { [name: string]: string };\n\nexport function usxStringToUsj(usxString: string): Usj {\n  const parser = new DOMParser();\n  const inputUsxDom = parser.parseFromString(usxString, \"text/xml\");\n  return usxDomToUsj(inputUsxDom.documentElement);\n}\n\nexport function usxDomToUsj(inputUsxDom: Element | null): Usj {\n  const [outputJson] = inputUsxDom\n    ? convertUsxRecurse(inputUsxDom)\n    : [{ content: [] as MarkerContent[] } as Usj];\n  outputJson.type = USJ_TYPE;\n  outputJson.version = USJ_VERSION;\n  return outputJson;\n}\n\nfunction convertUsxRecurse<T extends Usj | MarkerObject = Usj>(\n  inputUsxElement: Element,\n): [outputJson: T, action: Action] {\n  const attribs: Attribs = {};\n  let type: string = inputUsxElement.tagName;\n  let marker: string | undefined;\n  let text: string | undefined;\n  let action: Action = \"append\";\n\n  if ([\"row\", \"cell\"].includes(type)) type = \"table:\" + type;\n  if (inputUsxElement.attributes) {\n    for (const attrib of Array.from(inputUsxElement.attributes)) {\n      attribs[attrib.name] = attrib.value;\n    }\n  }\n\n  if (attribs.style) {\n    marker = attribs.style;\n    delete attribs.style;\n  }\n  // dropping because presence of vid in para elements is not consistent in USX\n  if (attribs.vid) delete attribs.vid;\n  // Not dropping `attribs.closed` for backwards compatibility.\n  // dropping because it is nonstandard derived metadata that could get out of date\n  if (attribs.status) delete attribs.status;\n\n  let outObj: T = { type } as T;\n  if (marker) (outObj as MarkerObject).marker = marker;\n  outObj = { ...outObj, ...attribs };\n\n  if (\n    inputUsxElement.firstChild &&\n    inputUsxElement.firstChild.nodeType === inputUsxElement.firstChild.TEXT_NODE &&\n    inputUsxElement.firstChild.nodeValue &&\n    asciiTrim(inputUsxElement.firstChild.nodeValue) !== \"\"\n  ) {\n    text = inputUsxElement.firstChild.nodeValue;\n  }\n\n  const children = Array.from(inputUsxElement.childNodes);\n  outObj.content = [];\n\n  if (text) {\n    outObj.content.push(text);\n  }\n\n  for (const child of children) {\n    // ChildNodes are Elements.\n    if ((child as Element).tagName === undefined) {\n      continue;\n    }\n    // ChildNodes are Elements.\n    const [childDict, whatToDo] = convertUsxRecurse<MarkerObject>(child as Element);\n\n    switch (whatToDo) {\n      case \"append\":\n        outObj.content.push(childDict);\n        break;\n      case \"merge\":\n        outObj.content = outObj.content.concat(childDict);\n        break;\n      case \"ignore\":\n        break;\n      default:\n        break;\n    }\n\n    // Handle tail text\n    if (\n      child.nextSibling &&\n      child.nextSibling.nodeType === child.nextSibling.TEXT_NODE &&\n      child.nextSibling.nodeValue &&\n      (asciiTrim(child.nextSibling.nodeValue) !== \"\" || child.nextSibling.nodeValue === \" \")\n    ) {\n      outObj.content.push(child.nextSibling.nodeValue);\n    }\n  }\n\n  // For backward compatibility, not deleting content for type: chapter, verse, optbreak, ms OR\n  // marker: va, ca, b.\n  if (outObj.content.length === 0 && outObj.type !== USX_TYPE) {\n    delete outObj.content;\n  }\n\n  if (\"eid\" in outObj && [\"verse\", \"chapter\"].includes(type)) {\n    action = \"ignore\";\n  }\n\n  return [outObj, action];\n}\n\n/**\n * Removes leading and trailing ASCII whitespace.\n *\n * Only trim ASCII whitespace characters: space, tab, line feed, carriage return, form feed,\n * vertical tab.\n * @param str - The string to remove whitespace from.\n * @returns the string with leading and trailing whitespace removed.\n */\nfunction asciiTrim(str: string): string {\n  return str.replace(/(^[ \\t\\n\\r\\f\\v]+)|([ \\t\\n\\r\\f\\v]+$)/g, \"\");\n}\n","/**\n * Convert Scripture from USJ to USX.\n * Adapted to TypeScript from this file:\n * @see https://github.com/usfm-bible/usfmtc/blob/0afa385a1f282b286cc6bff7bbc953ae788aa10c/src/usfmtc/usjproc.py\n */\n\nimport { DOMImplementation, Document, Element, Text } from \"@xmldom/xmldom\";\nimport { MarkerContent, MarkerObject, Usj } from \"./usj.model\";\nimport { USX_TYPE, USX_VERSION } from \"./usx.model\";\n\nlet chapterEid: string | undefined;\nlet verseEid: string | undefined;\n\nexport function usjToUsxString(usj: Usj): string {\n  const usxDoc = new DOMImplementation().createDocument(\"\", USX_TYPE);\n  if (usxDoc.documentElement) {\n    usxDoc.documentElement.setAttribute(\"version\", USX_VERSION);\n    usjToUsxDom(usj, usxDoc);\n  }\n  return usxDoc.toString();\n}\n\nexport function usjToUsxDom(usj: Usj, usxDoc: Document): Element | undefined {\n  if (!usxDoc.documentElement) return undefined;\n\n  for (const [index, markerContent] of usj.content.entries()) {\n    const isLastItem = index === usj.content.length - 1;\n    convertUsjRecurse(markerContent, usxDoc.documentElement, usxDoc, isLastItem);\n  }\n  return usxDoc.documentElement ?? undefined;\n}\n\nfunction convertUsjRecurse(\n  markerContent: MarkerContent,\n  parentElement: Element,\n  usxDoc: Document,\n  isLastItem: boolean,\n) {\n  let element: Text | Element;\n  let type: string | undefined;\n  let eidElement: Element | undefined;\n  if (typeof markerContent === \"string\") element = usxDoc.createTextNode(markerContent);\n  else {\n    type = markerContent.type.replace(\"table:\", \"\");\n    element = usxDoc.createElement(type);\n    setAttributes(element, markerContent);\n    if (markerContent.content) {\n      for (const [index, item] of markerContent.content.entries()) {\n        const _isLastItem = index === markerContent.content.length - 1;\n        convertUsjRecurse(item, element, usxDoc, _isLastItem);\n      }\n    }\n  }\n\n  // Create chapter and verse end elements from SID attributes.\n  if (verseEid && (type === \"verse\" || (parentElement.tagName === \"para\" && isLastItem))) {\n    eidElement = createVerseEndElement(usxDoc, verseEid);\n    verseEid = undefined;\n  }\n  if (type === \"verse\" && typeof markerContent !== \"string\" && markerContent.sid !== undefined)\n    verseEid = markerContent.sid;\n\n  if (chapterEid && (type === \"chapter\" || (type === \"para\" && isLastItem))) {\n    eidElement = createChapterEndElement(usxDoc, chapterEid);\n    chapterEid = undefined;\n  }\n  if (type === \"chapter\" && typeof markerContent !== \"string\" && markerContent.sid !== undefined)\n    chapterEid = markerContent.sid;\n\n  // Append to parent.\n  const isVerseInImpliedPara =\n    parentElement.nodeName === USX_TYPE && eidElement?.tagName === \"verse\";\n  if (eidElement && (!isLastItem || isVerseInImpliedPara)) parentElement.appendChild(eidElement);\n  parentElement.appendChild(element);\n  if (eidElement && isLastItem && !isVerseInImpliedPara) parentElement.appendChild(eidElement);\n\n  // Allow for final chapter and verse end elements at the end of an implied para.\n  if (isLastItem && parentElement.nodeName === USX_TYPE) {\n    if (verseEid) parentElement.appendChild(createVerseEndElement(usxDoc, verseEid));\n    if (chapterEid) parentElement.appendChild(createChapterEndElement(usxDoc, chapterEid));\n    verseEid = undefined;\n    chapterEid = undefined;\n  }\n}\n\nfunction setAttributes(element: Element, markerContent: MarkerObject) {\n  if (markerContent.type === \"unmatched\") element.setAttribute(\"marker\", markerContent.marker);\n  else element.setAttribute(\"style\", markerContent.marker);\n  for (const [key, value] of Object.entries(markerContent)) {\n    if (value && ![\"type\", \"marker\", \"content\"].includes(key)) {\n      element.setAttribute(key, value as string);\n    }\n  }\n}\n\nfunction createVerseEndElement(usxDoc: Document, verseEid: string): Element {\n  const eidElement = usxDoc.createElement(\"verse\");\n  eidElement.setAttribute(\"eid\", verseEid);\n  return eidElement;\n}\n\nfunction createChapterEndElement(usxDoc: Document, chapterEid: string): Element {\n  const eidElement = usxDoc.createElement(\"chapter\");\n  eidElement.setAttribute(\"eid\", chapterEid);\n  return eidElement;\n}\n","const JSON_PATH_START = \"$\";\nconst JSON_PATH_CONTENT = \".content[\";\n\n/**\n * Converts a USJ JSONPath string into an array of indexes.\n *\n * @param jsonPath - The USJ JSONPath string to convert. It must start with `$` and contain `.content[index]` segments.\n * @returns An array of numeric indexes extracted from the JSONPath.\n * @throws Will throw an error if the JSONPath does not start with `$`.\n */\nexport function indexesFromUsjJsonPath(jsonPath: string): number[] {\n  const path = jsonPath.split(JSON_PATH_CONTENT);\n  if (path.shift() !== JSON_PATH_START)\n    throw new Error(`indexesFromJsonPath: jsonPath didn't start with '${JSON_PATH_START}'`);\n\n  const indexes = path.map((str) => parseInt(str, 10));\n  return indexes;\n}\n\n/**\n * Converts an array of indexes into a USJ JSONPath string.\n *\n * @param indexes - An array of numeric indexes to convert.\n * @returns A USJ JSONPath string constructed from the indexes.\n */\nexport function usjJsonPathFromIndexes(indexes: number[]): string {\n  return indexes.reduce((path, index) => `${path}${JSON_PATH_CONTENT}${index}]`, JSON_PATH_START);\n}\n"],"names":["USJ_TYPE","USJ_VERSION","MARKER_OBJECT_PROPS","isValidBookCode","code","VALID_BOOK_CODES","USX_TYPE","USX_VERSION","usxStringToUsj","usxString","inputUsxDom","DOMParser","usxDomToUsj","outputJson","convertUsxRecurse","inputUsxElement","attribs","type","marker","text","action","attrib","outObj","asciiTrim","children","child","childDict","whatToDo","str","chapterEid","verseEid","usjToUsxString","usj","usxDoc","DOMImplementation","usjToUsxDom","index","markerContent","isLastItem","convertUsjRecurse","parentElement","element","eidElement","setAttributes","item","_isLastItem","createVerseEndElement","createChapterEndElement","isVerseInImpliedPara","key","value","JSON_PATH_START","JSON_PATH_CONTENT","indexesFromUsjJsonPath","jsonPath","path","usjJsonPathFromIndexes","indexes"],"mappings":";AAOO,MAAMA,IAAW,OAEXC,IAAc,OAEdC,IAA8C;AAAA,EACzD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAiDO,SAASC,EAAgBC,GAAuB;AACrD,SAAOC,EAAiB,SAASD,CAAgB;AACnD;AAKA,MAAMC,IAAmB;AAAA;AAAA,EAEvB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GClMaC,IAAW,OAEXC,IAAc;ACIpB,SAASC,EAAeC,GAAwB;AAErD,QAAMC,IADS,IAAIC,EAAA,EACQ,gBAAgBF,GAAW,UAAU;AAChE,SAAOG,EAAYF,EAAY,eAAe;AAChD;AAEO,SAASE,EAAYF,GAAkC;AAC5D,QAAM,CAACG,CAAU,IAAIH,IACjBI,EAAkBJ,CAAW,IAC7B,CAAC,EAAE,SAAS,CAAA,GAA8B;AAC9C,SAAAG,EAAW,OAAOb,GAClBa,EAAW,UAAUZ,GACdY;AACT;AAEA,SAASC,EACPC,GACiC;AACjC,QAAMC,IAAmB,CAAA;AACzB,MAAIC,IAAeF,EAAgB,SAC/BG,GACAC,GACAC,IAAiB;AAGrB,MADI,CAAC,OAAO,MAAM,EAAE,SAASH,CAAI,UAAU,WAAWA,IAClDF,EAAgB;AAClB,eAAWM,KAAU,MAAM,KAAKN,EAAgB,UAAU;AACxD,MAAAC,EAAQK,EAAO,IAAI,IAAIA,EAAO;AAIlC,EAAIL,EAAQ,UACVE,IAASF,EAAQ,OACjB,OAAOA,EAAQ,QAGbA,EAAQ,OAAK,OAAOA,EAAQ,KAG5BA,EAAQ,UAAQ,OAAOA,EAAQ;AAEnC,MAAIM,IAAY,EAAE,MAAAL,EAAA;AAClB,EAAIC,MAASI,EAAwB,SAASJ,IAC9CI,IAAS,EAAE,GAAGA,GAAQ,GAAGN,EAAA,GAGvBD,EAAgB,cAChBA,EAAgB,WAAW,aAAaA,EAAgB,WAAW,aACnEA,EAAgB,WAAW,aAC3BQ,EAAUR,EAAgB,WAAW,SAAS,MAAM,OAEpDI,IAAOJ,EAAgB,WAAW;AAGpC,QAAMS,IAAW,MAAM,KAAKT,EAAgB,UAAU;AACtD,EAAAO,EAAO,UAAU,CAAA,GAEbH,KACFG,EAAO,QAAQ,KAAKH,CAAI;AAG1B,aAAWM,KAASD,GAAU;AAE5B,QAAKC,EAAkB,YAAY;AACjC;AAGF,UAAM,CAACC,GAAWC,CAAQ,IAAIb,EAAgCW,CAAgB;AAE9E,YAAQE,GAAA;AAAA,MACN,KAAK;AACH,QAAAL,EAAO,QAAQ,KAAKI,CAAS;AAC7B;AAAA,MACF,KAAK;AACH,QAAAJ,EAAO,UAAUA,EAAO,QAAQ,OAAOI,CAAS;AAChD;AAAA,IAIA;AAIJ,IACED,EAAM,eACNA,EAAM,YAAY,aAAaA,EAAM,YAAY,aACjDA,EAAM,YAAY,cACjBF,EAAUE,EAAM,YAAY,SAAS,MAAM,MAAMA,EAAM,YAAY,cAAc,QAElFH,EAAO,QAAQ,KAAKG,EAAM,YAAY,SAAS;AAAA,EACjD;AAKF,SAAIH,EAAO,QAAQ,WAAW,KAAKA,EAAO,SAAShB,KACjD,OAAOgB,EAAO,SAGZ,SAASA,KAAU,CAAC,SAAS,SAAS,EAAE,SAASL,CAAI,MACvDG,IAAS,WAGJ,CAACE,GAAQF,CAAM;AACxB;AAUA,SAASG,EAAUK,GAAqB;AACtC,SAAOA,EAAI,QAAQ,wCAAwC,EAAE;AAC/D;ACvHA,IAAIC,GACAC;AAEG,SAASC,EAAeC,GAAkB;AAC/C,QAAMC,IAAS,IAAIC,EAAA,EAAoB,eAAe,IAAI5B,CAAQ;AAClE,SAAI2B,EAAO,oBACTA,EAAO,gBAAgB,aAAa,WAAW1B,CAAW,GAC1D4B,EAAYH,GAAKC,CAAM,IAElBA,EAAO,SAAA;AAChB;AAEO,SAASE,EAAYH,GAAUC,GAAuC;AAC3E,MAAKA,EAAO,iBAEZ;AAAA,eAAW,CAACG,GAAOC,CAAa,KAAKL,EAAI,QAAQ,WAAW;AAC1D,YAAMM,IAAaF,MAAUJ,EAAI,QAAQ,SAAS;AAClD,MAAAO,EAAkBF,GAAeJ,EAAO,iBAAiBA,GAAQK,CAAU;AAAA,IAAA;AAE7E,WAAOL,EAAO,mBAAmB;AAAA;AACnC;AAEA,SAASM,EACPF,GACAG,GACAP,GACAK,GACA;AACA,MAAIG,GACAxB,GACAyB;AACJ,MAAI,OAAOL,KAAkB,SAAU,CAAAI,IAAUR,EAAO,eAAeI,CAAa;AAAA,WAElFpB,IAAOoB,EAAc,KAAK,QAAQ,UAAU,EAAE,GAC9CI,IAAUR,EAAO,cAAchB,CAAI,GACnC0B,EAAcF,GAASJ,CAAa,GAChCA,EAAc;AAChB,eAAW,CAACD,GAAOQ,CAAI,KAAKP,EAAc,QAAQ,WAAW;AAC3D,YAAMQ,IAAcT,MAAUC,EAAc,QAAQ,SAAS;AAC7D,MAAAE,EAAkBK,GAAMH,GAASR,GAAQY,CAAW;AAAA,IAAA;AAM1D,EAAIf,MAAab,MAAS,WAAYuB,EAAc,YAAY,UAAUF,OACxEI,IAAaI,EAAsBb,GAAQH,CAAQ,GACnDA,IAAW,SAETb,MAAS,WAAW,OAAOoB,KAAkB,YAAYA,EAAc,QAAQ,WACjFP,IAAWO,EAAc,MAEvBR,MAAeZ,MAAS,aAAcA,MAAS,UAAUqB,OAC3DI,IAAaK,EAAwBd,GAAQJ,CAAU,GACvDA,IAAa,SAEXZ,MAAS,aAAa,OAAOoB,KAAkB,YAAYA,EAAc,QAAQ,WACnFR,IAAaQ,EAAc;AAG7B,QAAMW,IACJR,EAAc,aAAalC,MAAYoC,KAAA,gBAAAA,EAAY,aAAY;AACjE,EAAIA,MAAe,CAACJ,KAAcU,MAAuBR,EAAc,YAAYE,CAAU,GAC7FF,EAAc,YAAYC,CAAO,GAC7BC,KAAcJ,KAAc,CAACU,KAAsBR,EAAc,YAAYE,CAAU,GAGvFJ,KAAcE,EAAc,aAAalC,MACvCwB,KAAUU,EAAc,YAAYM,EAAsBb,GAAQH,CAAQ,CAAC,GAC3ED,KAAYW,EAAc,YAAYO,EAAwBd,GAAQJ,CAAU,CAAC,GACrFC,IAAW,QACXD,IAAa;AAEjB;AAEA,SAASc,EAAcF,GAAkBJ,GAA6B;AACpE,EAAIA,EAAc,SAAS,gBAAqB,aAAa,UAAUA,EAAc,MAAM,IACtFI,EAAQ,aAAa,SAASJ,EAAc,MAAM;AACvD,aAAW,CAACY,GAAKC,CAAK,KAAK,OAAO,QAAQb,CAAa;AACrD,IAAIa,KAAS,CAAC,CAAC,QAAQ,UAAU,SAAS,EAAE,SAASD,CAAG,KACtDR,EAAQ,aAAaQ,GAAKC,CAAe;AAG/C;AAEA,SAASJ,EAAsBb,GAAkBH,GAA2B;AAC1E,QAAMY,IAAaT,EAAO,cAAc,OAAO;AAC/C,SAAAS,EAAW,aAAa,OAAOZ,CAAQ,GAChCY;AACT;AAEA,SAASK,EAAwBd,GAAkBJ,GAA6B;AAC9E,QAAMa,IAAaT,EAAO,cAAc,SAAS;AACjD,SAAAS,EAAW,aAAa,OAAOb,CAAU,GAClCa;AACT;ACzGA,MAAMS,IAAkB,KAClBC,IAAoB;AASnB,SAASC,EAAuBC,GAA4B;AACjE,QAAMC,IAAOD,EAAS,MAAMF,CAAiB;AAC7C,MAAIG,EAAK,YAAYJ;AACnB,UAAM,IAAI,MAAM,oDAAoDA,CAAe,GAAG;AAGxF,SADgBI,EAAK,IAAI,CAAC3B,MAAQ,SAASA,GAAK,EAAE,CAAC;AAErD;AAQO,SAAS4B,EAAuBC,GAA2B;AAChE,SAAOA,EAAQ,OAAO,CAACF,GAAMnB,MAAU,GAAGmB,CAAI,GAAGH,CAAiB,GAAGhB,CAAK,KAAKe,CAAe;AAChG;"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@eten-tech-foundation/scripture-utilities",
+  "version": "0.1.1",
+  "description": "Utilities for working with Scripture data.",
+  "license": "MIT",
+  "homepage": "https://github.com/eten-tech-foundation/scripture-editors/tree/main/packages/utilities#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eten-tech-foundation/scripture-editors.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eten-tech-foundation/scripture-editors/issues"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/package.json",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.data.ts"
+  ],
+  "dependencies": {
+    "@xmldom/xmldom": "^0.9.8"
+  },
+  "devDependencies": {
+    "lexical": "^0.33.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "scripts": {
+    "prepublish": "cd ../.. && nx build utilities"
+  }
+}

package/src/converters/usj/jsonpath-indexes.ts

@@ -0,0 +1,28 @@
+const JSON_PATH_START = "$";
+const JSON_PATH_CONTENT = ".content[";
+
+/**
+ * Converts a USJ JSONPath string into an array of indexes.
+ *
+ * @param jsonPath - The USJ JSONPath string to convert. It must start with `$` and contain `.content[index]` segments.
+ * @returns An array of numeric indexes extracted from the JSONPath.
+ * @throws Will throw an error if the JSONPath does not start with `$`.
+ */
+export function indexesFromUsjJsonPath(jsonPath: string): number[] {
+  const path = jsonPath.split(JSON_PATH_CONTENT);
+  if (path.shift() !== JSON_PATH_START)
+    throw new Error(`indexesFromJsonPath: jsonPath didn't start with '${JSON_PATH_START}'`);
+
+  const indexes = path.map((str) => parseInt(str, 10));
+  return indexes;
+}
+
+/**
+ * Converts an array of indexes into a USJ JSONPath string.
+ *
+ * @param indexes - An array of numeric indexes to convert.
+ * @returns A USJ JSONPath string constructed from the indexes.
+ */
+export function usjJsonPathFromIndexes(indexes: number[]): string {
+  return indexes.reduce((path, index) => `${path}${JSON_PATH_CONTENT}${index}]`, JSON_PATH_START);
+}

package/src/converters/usj/usj-to-usx.ts

@@ -0,0 +1,106 @@
+/**
+ * Convert Scripture from USJ to USX.
+ * Adapted to TypeScript from this file:
+ * @see https://github.com/usfm-bible/usfmtc/blob/0afa385a1f282b286cc6bff7bbc953ae788aa10c/src/usfmtc/usjproc.py
+ */
+
+import { DOMImplementation, Document, Element, Text } from "@xmldom/xmldom";
+import { MarkerContent, MarkerObject, Usj } from "./usj.model";
+import { USX_TYPE, USX_VERSION } from "./usx.model";
+
+let chapterEid: string | undefined;
+let verseEid: string | undefined;
+
+export function usjToUsxString(usj: Usj): string {
+  const usxDoc = new DOMImplementation().createDocument("", USX_TYPE);
+  if (usxDoc.documentElement) {
+    usxDoc.documentElement.setAttribute("version", USX_VERSION);
+    usjToUsxDom(usj, usxDoc);
+  }
+  return usxDoc.toString();
+}
+
+export function usjToUsxDom(usj: Usj, usxDoc: Document): Element | undefined {
+  if (!usxDoc.documentElement) return undefined;
+
+  for (const [index, markerContent] of usj.content.entries()) {
+    const isLastItem = index === usj.content.length - 1;
+    convertUsjRecurse(markerContent, usxDoc.documentElement, usxDoc, isLastItem);
+  }
+  return usxDoc.documentElement ?? undefined;
+}
+
+function convertUsjRecurse(
+  markerContent: MarkerContent,
+  parentElement: Element,
+  usxDoc: Document,
+  isLastItem: boolean,
+) {
+  let element: Text | Element;
+  let type: string | undefined;
+  let eidElement: Element | undefined;
+  if (typeof markerContent === "string") element = usxDoc.createTextNode(markerContent);
+  else {
+    type = markerContent.type.replace("table:", "");
+    element = usxDoc.createElement(type);
+    setAttributes(element, markerContent);
+    if (markerContent.content) {
+      for (const [index, item] of markerContent.content.entries()) {
+        const _isLastItem = index === markerContent.content.length - 1;
+        convertUsjRecurse(item, element, usxDoc, _isLastItem);
+      }
+    }
+  }
+
+  // Create chapter and verse end elements from SID attributes.
+  if (verseEid && (type === "verse" || (parentElement.tagName === "para" && isLastItem))) {
+    eidElement = createVerseEndElement(usxDoc, verseEid);
+    verseEid = undefined;
+  }
+  if (type === "verse" && typeof markerContent !== "string" && markerContent.sid !== undefined)
+    verseEid = markerContent.sid;
+
+  if (chapterEid && (type === "chapter" || (type === "para" && isLastItem))) {
+    eidElement = createChapterEndElement(usxDoc, chapterEid);
+    chapterEid = undefined;
+  }
+  if (type === "chapter" && typeof markerContent !== "string" && markerContent.sid !== undefined)
+    chapterEid = markerContent.sid;
+
+  // Append to parent.
+  const isVerseInImpliedPara =
+    parentElement.nodeName === USX_TYPE && eidElement?.tagName === "verse";
+  if (eidElement && (!isLastItem || isVerseInImpliedPara)) parentElement.appendChild(eidElement);
+  parentElement.appendChild(element);
+  if (eidElement && isLastItem && !isVerseInImpliedPara) parentElement.appendChild(eidElement);
+
+  // Allow for final chapter and verse end elements at the end of an implied para.
+  if (isLastItem && parentElement.nodeName === USX_TYPE) {
+    if (verseEid) parentElement.appendChild(createVerseEndElement(usxDoc, verseEid));
+    if (chapterEid) parentElement.appendChild(createChapterEndElement(usxDoc, chapterEid));
+    verseEid = undefined;
+    chapterEid = undefined;
+  }
+}
+
+function setAttributes(element: Element, markerContent: MarkerObject) {
+  if (markerContent.type === "unmatched") element.setAttribute("marker", markerContent.marker);
+  else element.setAttribute("style", markerContent.marker);
+  for (const [key, value] of Object.entries(markerContent)) {
+    if (value && !["type", "marker", "content"].includes(key)) {
+      element.setAttribute(key, value as string);
+    }
+  }
+}
+
+function createVerseEndElement(usxDoc: Document, verseEid: string): Element {
+  const eidElement = usxDoc.createElement("verse");
+  eidElement.setAttribute("eid", verseEid);
+  return eidElement;
+}
+
+function createChapterEndElement(usxDoc: Document, chapterEid: string): Element {
+  const eidElement = usxDoc.createElement("chapter");
+  eidElement.setAttribute("eid", chapterEid);
+  return eidElement;
+}

package/src/converters/usj/usj.model.ts

@@ -0,0 +1,202 @@
+/**
+ * Unified Scripture JSON (USJ) - The JSON variant of USFM and USX data models.
+ * These types follow this schema:
+ * @see https://github.com/usfm-bible/tcdocs/blob/usj/grammar/usj.js
+ */
+
+/** The USJ spec type */
+export const USJ_TYPE = "USJ";
+/** The USJ spec version */
+export const USJ_VERSION = "3.1";
+/** List of known properties of `MarkerObject` */
+export const MARKER_OBJECT_PROPS: (keyof MarkerObject)[] = [
+  "type",
+  "marker",
+  "content",
+  "sid",
+  "eid",
+  "number",
+  "code",
+  "altnumber",
+  "pubnumber",
+  "caller",
+  "align",
+  "category",
+];
+
+/** Single piece of Scripture content */
+export type MarkerContent = string | MarkerObject;
+
+/** A Scripture Marker and its contents */
+export type MarkerObject = {
+  /**
+   * The kind/category of node or element this is, corresponding the USFM marker and USX node
+   * @example `para`, `verse`, `char`
+   */
+  type: string;
+  /**
+   * The corresponding marker in USFM or style in USX
+   * @example `p`, `v`, `nd`
+   */
+  marker: string;
+  /** This marker's contents laid out in order */
+  content?: MarkerContent[];
+  /** Indicates the Book-chapter-verse value in the paragraph based structure */
+  sid?: string;
+  /** Milestone end ID, matches start ID (not currently included in USJ spec) */
+  eid?: string;
+  /** Chapter number or verse number */
+  number?: string;
+  /** The 3-letter book code in ID element */
+  code?: BookCode;
+  /** Alternate chapter number or verse number */
+  altnumber?: string;
+  /** Published character of chapter or verse */
+  pubnumber?: string;
+  /** Caller character for footnotes and cross-refs */
+  caller?: string;
+  /** Alignment of table cells */
+  align?: string;
+  /** Category of extended study bible sections */
+  category?: string;
+};
+
+/** Scripture data represented in JSON format. Data compatible transformation from USX/USFM */
+export type Usj = {
+  /** The USJ spec type */
+  type: typeof USJ_TYPE;
+  /** The USJ spec version */
+  version: typeof USJ_VERSION;
+  /** The JSON representation of scripture contents from USFM/USX */
+  content: MarkerContent[];
+};
+
+export function isValidBookCode(code: string): boolean {
+  return VALID_BOOK_CODES.includes(code as BookCode);
+}
+
+/** 3-letter Scripture book code */
+export type BookCode = (typeof VALID_BOOK_CODES)[number];
+
+const VALID_BOOK_CODES = [
+  // Old Testament
+  "GEN",
+  "EXO",
+  "LEV",
+  "NUM",
+  "DEU",
+  "JOS",
+  "JDG",
+  "RUT",
+  "1SA",
+  "2SA",
+  "1KI",
+  "2KI",
+  "1CH",
+  "2CH",
+  "EZR",
+  "NEH",
+  "EST",
+  "JOB",
+  "PSA",
+  "PRO",
+  "ECC",
+  "SNG",
+  "ISA",
+  "JER",
+  "LAM",
+  "EZK",
+  "DAN",
+  "HOS",
+  "JOL",
+  "AMO",
+  "OBA",
+  "JON",
+  "MIC",
+  "NAM",
+  "HAB",
+  "ZEP",
+  "HAG",
+  "ZEC",
+  "MAL",
+  // New Testament
+  "MAT",
+  "MRK",
+  "LUK",
+  "JHN",
+  "ACT",
+  "ROM",
+  "1CO",
+  "2CO",
+  "GAL",
+  "EPH",
+  "PHP",
+  "COL",
+  "1TH",
+  "2TH",
+  "1TI",
+  "2TI",
+  "TIT",
+  "PHM",
+  "HEB",
+  "JAS",
+  "1PE",
+  "2PE",
+  "1JN",
+  "2JN",
+  "3JN",
+  "JUD",
+  "REV",
+  // Deuterocanon
+  "TOB",
+  "JDT",
+  "ESG",
+  "WIS",
+  "SIR",
+  "BAR",
+  "LJE",
+  "S3Y",
+  "SUS",
+  "BEL",
+  "1MA",
+  "2MA",
+  "3MA",
+  "4MA",
+  "1ES",
+  "2ES",
+  "MAN",
+  "PS2",
+  "ODA",
+  "PSS",
+  "EZA",
+  "5EZ",
+  "6EZ",
+  "DAG",
+  "PS3",
+  "2BA",
+  "LBA",
+  "JUB",
+  "ENO",
+  "1MQ",
+  "2MQ",
+  "3MQ",
+  "REP",
+  "4BA",
+  "LAO",
+  // Non scripture
+  "FRT",
+  "BAK",
+  "OTH",
+  "INT",
+  "CNC",
+  "GLO",
+  "TDX",
+  "NDX",
+  "XXA",
+  "XXB",
+  "XXC",
+  "XXD",
+  "XXE",
+  "XXF",
+  "XXG",
+] as const;

package/src/converters/usj/usx-to-usj.ts

@@ -0,0 +1,130 @@
+/**
+ * Convert Scripture from USX to USJ.
+ * Adapted to TypeScript from this file:
+ * @see https://github.com/usfm-bible/usfmtc/blob/0afa385a1f282b286cc6bff7bbc953ae788aa10c/src/usfmtc/usjproc.py
+ */
+
+import { DOMParser, Element } from "@xmldom/xmldom";
+import { MarkerContent, MarkerObject, USJ_TYPE, USJ_VERSION, Usj } from "./usj.model";
+import { USX_TYPE } from "./usx.model";
+
+type Action = "append" | "merge" | "ignore";
+type Attribs = { [name: string]: string };
+
+export function usxStringToUsj(usxString: string): Usj {
+  const parser = new DOMParser();
+  const inputUsxDom = parser.parseFromString(usxString, "text/xml");
+  return usxDomToUsj(inputUsxDom.documentElement);
+}
+
+export function usxDomToUsj(inputUsxDom: Element | null): Usj {
+  const [outputJson] = inputUsxDom
+    ? convertUsxRecurse(inputUsxDom)
+    : [{ content: [] as MarkerContent[] } as Usj];
+  outputJson.type = USJ_TYPE;
+  outputJson.version = USJ_VERSION;
+  return outputJson;
+}
+
+function convertUsxRecurse<T extends Usj | MarkerObject = Usj>(
+  inputUsxElement: Element,
+): [outputJson: T, action: Action] {
+  const attribs: Attribs = {};
+  let type: string = inputUsxElement.tagName;
+  let marker: string | undefined;
+  let text: string | undefined;
+  let action: Action = "append";
+
+  if (["row", "cell"].includes(type)) type = "table:" + type;
+  if (inputUsxElement.attributes) {
+    for (const attrib of Array.from(inputUsxElement.attributes)) {
+      attribs[attrib.name] = attrib.value;
+    }
+  }
+
+  if (attribs.style) {
+    marker = attribs.style;
+    delete attribs.style;
+  }
+  // dropping because presence of vid in para elements is not consistent in USX
+  if (attribs.vid) delete attribs.vid;
+  // Not dropping `attribs.closed` for backwards compatibility.
+  // dropping because it is nonstandard derived metadata that could get out of date
+  if (attribs.status) delete attribs.status;
+
+  let outObj: T = { type } as T;
+  if (marker) (outObj as MarkerObject).marker = marker;
+  outObj = { ...outObj, ...attribs };
+
+  if (
+    inputUsxElement.firstChild &&
+    inputUsxElement.firstChild.nodeType === inputUsxElement.firstChild.TEXT_NODE &&
+    inputUsxElement.firstChild.nodeValue &&
+    asciiTrim(inputUsxElement.firstChild.nodeValue) !== ""
+  ) {
+    text = inputUsxElement.firstChild.nodeValue;
+  }
+
+  const children = Array.from(inputUsxElement.childNodes);
+  outObj.content = [];
+
+  if (text) {
+    outObj.content.push(text);
+  }
+
+  for (const child of children) {
+    // ChildNodes are Elements.
+    if ((child as Element).tagName === undefined) {
+      continue;
+    }
+    // ChildNodes are Elements.
+    const [childDict, whatToDo] = convertUsxRecurse<MarkerObject>(child as Element);
+
+    switch (whatToDo) {
+      case "append":
+        outObj.content.push(childDict);
+        break;
+      case "merge":
+        outObj.content = outObj.content.concat(childDict);
+        break;
+      case "ignore":
+        break;
+      default:
+        break;
+    }
+
+    // Handle tail text
+    if (
+      child.nextSibling &&
+      child.nextSibling.nodeType === child.nextSibling.TEXT_NODE &&
+      child.nextSibling.nodeValue &&
+      (asciiTrim(child.nextSibling.nodeValue) !== "" || child.nextSibling.nodeValue === " ")
+    ) {
+      outObj.content.push(child.nextSibling.nodeValue);
+    }
+  }
+
+  // For backward compatibility, not deleting content for type: chapter, verse, optbreak, ms OR
+  // marker: va, ca, b.
+  if (outObj.content.length === 0 && outObj.type !== USX_TYPE) {
+    delete outObj.content;
+  }
+
+  if ("eid" in outObj && ["verse", "chapter"].includes(type)) {
+    action = "ignore";
+  }
+
+  return [outObj, action];
+}
+
+/**
+ * Removes leading and trailing ASCII whitespace.
+ *
+ * Only trim ASCII whitespace characters: space, tab, line feed, carriage return, form feed,
+ * vertical tab.
+ * @param str - The string to remove whitespace from.
+ * @returns the string with leading and trailing whitespace removed.
+ */
+function asciiTrim(str: string): string {
+  return str.replace(/(^[ \t\n\r\f\v]+)|([ \t\n\r\f\v]+$)/g, "");
+}

package/src/converters/usj/usx.model.ts

@@ -0,0 +1,10 @@
+/**
+ * Unified Scripture XML (USX).
+ * These types follow this schema:
+ * @see https://github.com/usfm-bible/tcdocs/blob/main/grammar/usx.rng
+ */
+
+/** The USX spec type */
+export const USX_TYPE = "usx";
+/** The USX spec version */
+export const USX_VERSION = "3.1";

package/src/index.ts

@@ -0,0 +1,10 @@
+export type { Usj, BookCode, MarkerContent, MarkerObject } from "./converters/usj/usj.model";
+export {
+  MARKER_OBJECT_PROPS,
+  USJ_TYPE,
+  USJ_VERSION,
+  isValidBookCode,
+} from "./converters/usj/usj.model";
+export { usxStringToUsj } from "./converters/usj/usx-to-usj";
+export { usjToUsxString } from "./converters/usj/usj-to-usx";
+export { indexesFromUsjJsonPath, usjJsonPathFromIndexes } from "./converters/usj/jsonpath-indexes";