usfm-grammar-web 3.0.0-alpha.1 → 3.0.0-alpha.9

package/README.md

@@ -1,37 +1,78 @@
 # USFM Grammar
 
 ## Description
-USFM Grammar is a JavaScript library for parsing and converting USFM (Unified Standard Format Markers) to/from USJ (Unified Standard JSON) format. This library provides functionalities to parse USFM strings into a syntax tree and convert them into a JSON-like structure (USJ), and vice versa.
+This is the web alternative to the (USFM-Grammar 3.x)[https://www.npmjs.com/package/usfm-grammar] library to be used from HTML, react etc. USFM Grammar is a JavaScript library for parsing and converting USFM (Unified Standard Format Markers) to/from USJ (Unified Standard JSON) format. This library provides functionalities to parse USFM strings into a syntax tree and convert them into a JSON-like structure (USJ), and vice versa.
 
 ## Installation
 You can install USFM Grammar via npm:
 
-```bash
-npm install usfm-grammar
-```
 
 ## Usage
-Here's how you can use USFM Grammar in your JavaScript/TypeScript projects:
+Here's how you can use USFM Grammar in your react projects:
+```bash
+npm install usfm-grammar-web
+```
 
 ```javascript
-const { USFMParser}  = require('usfm-grammar');
+import React, { useState, useEffect } from 'react';
+import { USFMParser } from 'usfm-grammar-web';
+
+function App() {
+  const [result, setResult] = useState(null);
+  const [result2, setResult2] = useState(null);
+
+  useEffect(() => {
+    const initParser = async () => {
+      await USFMParser.init("https://cdn.jsdelivr.net/npm/usfm-grammar-web@3.0.0-alpha.1/tree-sitter-usfm.wasm",
+                            "https://cdn.jsdelivr.net/npm/usfm-grammar-web@3.0.0-alpha.1/tree-sitter.wasm");
+    };
+    initParser();
+  }, []);
+
+  const calculateValue = async () => {
+    const usfmParser = new USFMParser('\\id GEN\n\\c 1\n\\p\n\\v 1 In the begining..\\v 2 more text');
+    const output = usfmParser.toUSJ();
+    setResult(JSON.stringify(output));
+
+    const usfmParser2 = new USFMParser(null, output) //initialse from USJ
+    const usfm = usfmParser2.usfm;
+    setResult2(usfm);
+  };
+
+  return (
+    <div className="App">
+      <div>
+        <button onClick={calculateValue}>Test</button>
+        <p>USJ: {result}</p>
+        <p>USFM: {result2}</p>
+      </div>
+    </div>
+  );
+}
+
+export default App;
+```
 
-(async () => {
-  await USFMParser.init();
-  const usfmParser = new USFMParser()
-  const output = usfmParser.usfmToUsj('\\id GEN\n\\c 1\n\\p\n\\v 1 In the begining..\\v 2 more text')
+It can be used directly in the HTML script tag too.
+
+```html
+<script type="module">
+  import { USFMParser } from 'https://cdn.jsdelivr.net/npm/usfm-grammar-web@3.0.0-alpha.2/dist/bundle.mjs';
+  console.log('Hello world');
+  (async () => {
+  await USFMParser.init("https://cdn.jsdelivr.net/npm/usfm-grammar-web@3.0.0-alpha.2/tree-sitter-usfm.wasm",
+                            "https://cdn.jsdelivr.net/npm/usfm-grammar-web@3.0.0-alpha.2/tree-sitter.wasm");
+  const usfmParser = new USFMParser('\\id GEN\n\\c 1\n\\p\n\\v 1 In the begining..\\v 2 more text')
+  const output = usfmParser.toUSJ()
   console.log({ output })
-  const usfm = usfmParser.usjToUsfm(output)
+
+  const usfmParser2 = new USFMParser(null, output);
+  const usfm = usfmParser2.usfm;
   console.log({ usfm })
-})();
+  })();
+</script>
 ```
 
-If the above import cause issue in an esm project use the below format:
-```javascript
-import pkg from 'usfm-grammar';
-const USFMParser = pkg.USFMParser;
-
-```
 
 If using from react, please refer the instructions for it [here](../docs/react-usage.md).
 
@@ -40,19 +81,19 @@ If using from react, please refer the instructions for it [here](../docs/react-u
 ### `USFMParser.init()`
 Initializes the USFMParser. This function must be called before creating instances of `USFMParser`. And can take the grammar and the tree-sitter  files (in wasm format) as arguments, that is included in the package.
 
-### `USFMParser.usfmToUsj(usfmString: string): Object`
+### `USFMParser.toUSJ(usfmString: string): Object`
 Converts a USFM string to a USJ object.
 
 - `usfmString`: The input USFM string.
 
 Returns: A JSON-like object representing the USJ.
 
-### `USFMParser.usjToUsfm(usjObject: Object): string`
-Converts a USJ object to a USFM string.
+### `new USFMParser(null, usjObject: Object)`
+Initialize a parser object from USJ and also converts it to USFM.
 
 - `usjObject`: The input USJ object.
 
-Returns: The converted USFM string.
+Returns: The parser object. To obtain the USFM generated from USJ use `parserObject.usfm`.
 
 ## Contributing
 Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request on [GitHub](https://github.com/your-username/usfm-grammar).

package/dist/{esm/index.mjs → bundle.mjs}

@@ -2422,23 +2422,41 @@ class $236d01ba6f80be5e$var$USFMParser {
         });
         $236d01ba6f80be5e$var$USFMParser.language = await (0, (/*@__PURE__*/$parcel$interopDefault($dc2P8))).Language.load(grammarPath);
     }
-    constructor(){
+    constructor(usfmString = null, fromUsj = null, fromUsx = null){
+        let inputsGiven = 0;
+        if (usfmString !== null) inputsGiven += 1;
+        if (fromUsj !== null) inputsGiven += 1;
+        if (fromUsx !== null) inputsGiven += 1;
+        if (inputsGiven > 1) throw new Error(`Found more than one input!
+Only one of USFM, USJ or USX is supported in one object.`);
+        if (inputsGiven === 0) throw Error("Missing input! Either USFM, USJ or USX is to be provided.");
+        if (usfmString !== null) {
+            if (typeof usfmString !== "string" || usfmString === null) throw new Error("Invalid input for USFM. Expected a string.");
+            this.usfm = usfmString;
+        } else if (fromUsj !== null) {
+            this.usj = fromUsj;
+            this.usfm = this.convertUSJToUSFM();
+        } else if (fromUsx !== null) this.usx = fromUsx;
         this.parser = null;
-        this.usfm = null;
-        this.usj = null;
+        this.initializeParser();
         this.syntaxTree = null;
+        this.errors = [];
+        this.warnings = [];
+        this.parseUSFM();
     }
     initializeParser() {
         if (!$236d01ba6f80be5e$var$USFMParser.language) throw new Error("USFMParser not initialized. Call USFMParser.init() before creating instances.");
         this.parser = new (0, (/*@__PURE__*/$parcel$interopDefault($dc2P8)))();
         this.parser.setLanguage($236d01ba6f80be5e$var$USFMParser.language);
+        this.parserOptions = (0, (/*@__PURE__*/$parcel$interopDefault($dc2P8))).Options = {
+            bufferSize: 1048576
+        };
     }
-    usfmToUsj(usfmString) {
-        if (typeof usfmString !== "string" || usfmString === null) throw new Error("Invalid input for USFM. Expected a string.");
-        if (!this.parser) this.initializeParser();
-        this.usfm = usfmString;
-        this.parseUSFM();
-        this.usj = this.convertUSFMToUSJ();
+    toSyntaxTree() {
+        return this.syntaxTree.toString();
+    }
+    toUSJ(excludeMarkers = null, includeMarkers = null, ignoreErrors = false, combineTexts = true) {
+        this.usj = this.convertUSFMToUSJ(excludeMarkers, includeMarkers, ignoreErrors, combineTexts);
         return this.usj;
     }
     usjToUsfm(usjObject) {
@@ -2451,12 +2469,17 @@ class $236d01ba6f80be5e$var$USFMParser {
     parseUSFM() {
         let tree = null;
         try {
-            tree = this.parser.parse(this.usfm);
+            if (this.usfm.length > 25000) tree = this.parser.parse(this.usfm, null, this.parserOptions);
+            else tree = this.parser.parse(this.usfm);
         } catch (err) {
-            console.log(err.toString());
+            throw err;
+        // console.log("Error in parser.parse()");
+        // console.log(err.toString());
+        // console.log(this.usfm);
         }
-        const error = this.checkForErrors(tree);
-        if (error) throw error;
+        this.checkForErrors(tree);
+        this.checkforMissing(tree.rootNode);
+        // if (error) throw error;
         this.syntaxTree = tree.rootNode;
     }
     checkForErrors(tree) {
@@ -2468,32 +2491,35 @@ class $236d01ba6f80be5e$var$USFMParser {
         }
         return null;
     }
+    checkforMissing(node) {
+        for (let n of node.children){
+            if (n.isMissing) this.errors.push(`At ${n.startPosition.row + 1}:${n.startPosition.column}, Error: Missing ${n.type}`);
+            this.checkforMissing(n);
+        }
+    }
     convertUSJToUSFM() {
         const outputUSFM = new (0, $ce44dcc4919407eb$export$2e2bcd8739ae039)().usjToUsfm(this.usj); // Simulated conversion
         return outputUSFM;
     }
-    convertUSFMToUSJ({ excludeMarkers: excludeMarkers = null, includeMarkers: includeMarkers = null, ignoreErrors: ignoreErrors = false, combineTexts: combineTexts = true } = {}) {
-        if (!ignoreErrors && this.errors) {
-            let errorString = this.errors.map((err)=>err.join(":")).join("\n	");
+    convertUSFMToUSJ(excludeMarkers = null, includeMarkers = null, ignoreErrors = false, combineTexts = true) {
+        if (!ignoreErrors && this.errors.length > 0) {
+            let errorString = this.errors.join("\n	");
             throw new Error(`Errors present:\n\t${errorString}\nUse ignoreErrors = true to generate output despite errors.`);
         }
-        let jsonRootObj = {
-            type: "USJ",
-            version: "0.2.0",
-            content: []
-        };
         let outputUSJ;
         try {
-            let usjGenerator = new (0, $1bdca1468aa54399$export$2e2bcd8739ae039)($236d01ba6f80be5e$var$USFMParser.language, this.usfm, jsonRootObj);
-            usjGenerator.nodeToUSJ(this.syntaxTree, jsonRootObj);
+            let usjGenerator = new (0, $1bdca1468aa54399$export$2e2bcd8739ae039)($236d01ba6f80be5e$var$USFMParser.language, this.usfm);
+            usjGenerator.nodeToUSJ(this.syntaxTree, usjGenerator.jsonRootObj);
             outputUSJ = usjGenerator.jsonRootObj;
         } catch (err) {
             let message = "Unable to do the conversion. ";
             if (this.errors) {
-                let errorString = this.errors.map((err)=>err.join(":")).join("\n	");
+                let errorString = this.errors.join("\n	");
                 message += `Could be due to an error in the USFM\n\t${errorString}`;
-            }
-            return null;
+            } else message = err.message;
+            return {
+                error: message
+            };
         }
         if (includeMarkers) outputUSJ = (0, $ab5c81e737a0c6a6$export$88c58c54200c5b2)(outputUSJ, [
             ...includeMarkers,
@@ -2506,8 +2532,7 @@ class $236d01ba6f80be5e$var$USFMParser {
 var $236d01ba6f80be5e$export$2e2bcd8739ae039 = $236d01ba6f80be5e$var$USFMParser;
 
 
-console.log("COmes in index.js");
 
 
 export {$236d01ba6f80be5e$export$2e2bcd8739ae039 as USFMParser};
-//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=bundle.mjs.map