tsv-quote-converters 1.1.0

package/README.md

@@ -0,0 +1,109 @@
+# TSV Quote Converters package (tsv-quote-converters)
+
+A Node.js package for converting quotes between original biblical languages (Greek/Hebrew) and Gateway Languages in TSV files.
+
+## Installation
+
+```bash
+npm install tsv-quote-converters
+```
+
+## Features
+
+- Convert original language quotes to Gateway Language quotes (`addGLQuoteCols`)
+- Convert Gateway Language quotes back to original language quotes (`convertGLQuotes2OLQuotes`)
+- Handles complex quote alignments and multiple occurrences
+- Supports multiple target Gateway Language Bibles
+- Maintains TSV format integrity
+
+## Usage
+
+### Adding Gateway Language Quote Columns
+
+Convert original language quotes to Gateway Language quotes by adding new columns:
+
+```javascript
+import { addGLQuoteCols } from 'tsv-quote-converters';
+
+const params = {
+  // Required parameters
+  bibleLinks: ['unfoldingWord/en_ult/master'],  // Array of Bible repos to use
+  bookCode: 'eph',                              // Bible book code (e.g., 'eph', 'gen')
+  tsvContent: yourTsvString,                    // TSV content with 'Quote' column
+
+  // Optional parameters
+  trySeparatorsAndOccurrences: true,           // Try different quote separators
+};
+
+const result = await addGLQuoteCols(params);
+console.log(result.output);  // Modified TSV with new GLQuote/GLOccurrence columns
+console.log(result.errors);  // Array of any errors encountered
+```
+
+### Converting Gateway Language Quotes to Original Language
+
+Convert Gateway Language quotes in the Quote column back to original language:
+
+```javascript
+import { convertGLQuotes2OLQuotes } from 'tsv-quote-converters';
+
+const params = {
+  // Required parameters
+  bibleLinks: ['unfoldingWord/en_ult/master'],  // Bible used for current quotes
+  bookCode: 'eph',                              // Bible book code
+  tsvContent: yourTsvString,                    // TSV content with GL quotes
+
+  // Optional parameters
+  trySeparatorsAndOccurrences: true,           // Try different quote separators
+};
+
+const result = await convertGLQuotes2OLQuotes(params);
+console.log(result.output);  // Modified TSV with original language quotes
+console.log(result.errors);  // Array of any errors encountered
+```
+
+## Input TSV Format
+
+Your input TSV must include these columns:
+- `Reference` - Chapter:verse reference
+- `Quote` - The quote to convert
+- `Occurrence` - Occurrence number of the quote
+
+Example input:
+```
+Reference	ID	Tags	SupportReference	Quote	Occurrence	Note
+1:1	abc1			Παῦλος	1	Note text here
+```
+
+## Output Format
+
+### addGLQuoteCols
+Adds two columns per target Bible:
+- `GLQuote` - The converted Gateway Language quote
+- `GLOccurrence` - The occurrence number in the Gateway Language
+
+### convertGLQuotes2OLQuotes
+Updates existing columns:
+- `Quote` - Replaced with original language quote
+- `Occurrence` - Updated to match original language occurrence
+
+## Error Handling
+
+Both functions return an object with:
+- `output` - The modified TSV content (string)
+- `errors` - Array of error messages for any failed conversions
+
+## Live Demo
+
+Try it out in our [interactive documentation](https://unfoldingword.github.io/tsv-quote-converters/)
+
+## Contributing
+
+Visit our [GitHub repository](https://github.com/unfoldingWord/tsv-quote-converters) to contribute.
+
+## License
+
+ISC
+
+See: [LICENSE.md](https://github.com/unfoldingWord/tsv-quote-converters/blob/main/LICENSE.md)
+```

package/dist/favicon.svg

@@ -0,0 +1 @@
+<svg height="64" viewBox="0 0 64 64" width="64" xmlns="http://www.w3.org/2000/svg"><g fill="none" fill-rule="evenodd" transform="translate(7 9)"><g fill="#fff"><path d="m0 45c0 1.656 1.343 3 3 3h9v-12h-12z"/><path d="m0 36h12v-12h-12z"/><path d="m12 48h12v-12h-12z"/><path d="m24 48h12v-12h-12z"/><path d="m12 36h12v-12h-12z"/><path d="m24 36h12v-12h-12z"/><path d="m36 36h12v-12h-12z"/><path d="m0 24h12v-12h-12z"/><path d="m12 24h12v-12h-12z"/><path d="m24 24h12v-12h-12z"/><path d="m36 24h12v-12h-12z"/></g><path d="m45 0h-42c-1.657 0-3 1.344-3 3v9h48v-9c0-1.656-1.343-3-3-3" fill="#4baadc"/><path d="m36 36v12h9c1.657 0 3-1.344 3-3v-9z" fill="#fff"/><path d="m45 0h-42c-1.657 0-3 1.343-3 3v42c0 1.657 1.343 3 3 3h42c1.657 0 3-1.343 3-3v-42c0-1.657-1.343-3-3-3z" stroke="#1e69a0" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/><path d="m0 12h48" stroke="#1e69a0" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/><path d="m0 24h48" stroke="#1e69a0" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/><path d="m0 36h48" stroke="#1e69a0" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/><path d="m24 12v36" stroke="#1e69a0" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/><path d="m36 12v36" stroke="#1e69a0" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/><path d="m12 12v36" stroke="#1e69a0" stroke-linecap="round" stroke-linejoin="round" stroke-width="2"/></g></svg>