@helloao/tools 0.0.5 → 0.0.6

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 AO Lab
-
-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.
+MIT License
+
+Copyright (c) 2022 AO Lab
+
+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

@@ -1,98 +1,98 @@
-## Hello AO Tools
-
-Tools for the [Free Use Bible API](https://bible.helloao.org).
-
-### Features
-
--   Parse [USFM](https://ubsicap.github.io/usfm/), [USX](https://ubsicap.github.io/usx/), and Codex (JSON) files and understand some basic structure.
--   Generate JSON from USFM, USX, and other formats.
-
-### Installation
-
-```
-$ npm install @helloao/tools
-```
-
-### Usage
-
-#### Parse a USX File
-```typescript
-import { parser } from '@helloao/tools';
-// Used to parse XML
-const parser = new DOMParser();
-const usx = new parser.USXParser(parser);
-const parseTree = usx.parse('YOUR USX');
-console.log(parseTree);
-```
-
-#### Generate the API Files for a translation
-
-```typescript
-import { parser, generation } from '@helloao/tools';
-
-// Used to parse XML
-const domParser = new DOMParser();
-
-// Each input file needs some metadata about the translation that it is associated with
-const translation: generation.ParseTreeMetadata = {
-    translation: {
-
-        // The ID of the translation
-        // this should be unique for the translation
-        id: 'my translation id',
-
-        // The name of the translation in the translation's language
-        name: 'my translation name',
-
-        // The name of the translation in English
-        englishName: 'my translation name',
-
-        // The website that hosts information about the translation
-        website: 'translation website',
-
-        // The URL that hosts information about the license that the
-        // translation is shared under
-        licenseUrl: 'translation license',
-
-        // The ISO 639 letter language tag that the translation is primarily in.
-        language: 'eng',
-
-        // The direction that the text is written in.
-        // "ltr" means "left to right" and "rtl" means "right to left"
-        direction: 'ltr',
-    }
-};
-
-// The list of files that should be processed.
-const files: generation.InputFile[] = [
-    {
-        // the metadata about the translation for this file
-        metadata: translation,
-
-        // The content contained in the file
-        content: 'YOUR USX',
-
-        // The type of the file.
-        // One of "usx", "usfm", and "json"
-        fileType: 'usx'
-    }
-];
-
-// Generate a dataset from the files
-// Datasets organize all the files and their content
-// by translation, book, chapter, and verse
-const dataset = generation.dataset.generateDataset(files, domParser);
-
-// Generate an API representation from the files
-// This adds links between chapters and additional metadata.
-const api = generation.api.generateApiForDataset(dataset);
-
-// Generate output files from the API representation.
-// This will give us a list of files and file paths that represent
-// the entire API.
-const outputFiles = generation.api.generateFilesForApi(api);
-
-for (let file of outputFiles) {
-    console.log(file.path, file.content);
-}
-```
+## Hello AO Tools
+
+Tools for the [Free Use Bible API](https://bible.helloao.org).
+
+### Features
+
+-   Parse [USFM](https://ubsicap.github.io/usfm/), [USX](https://ubsicap.github.io/usx/), and Codex (JSON) files and understand some basic structure.
+-   Generate JSON from USFM, USX, and other formats.
+
+### Installation
+
+```
+$ npm install @helloao/tools
+```
+
+### Usage
+
+#### Parse a USX File
+
+```typescript
+import { parser } from '@helloao/tools';
+// Used to parse XML
+const parser = new DOMParser();
+const usx = new parser.USXParser(parser);
+const parseTree = usx.parse('YOUR USX');
+console.log(parseTree);
+```
+
+#### Generate the API Files for a translation
+
+```typescript
+import { parser, generation } from '@helloao/tools';
+
+// Used to parse XML
+const domParser = new DOMParser();
+
+// Each input file needs some metadata about the translation that it is associated with
+const translation: generation.ParseTreeMetadata = {
+    translation: {
+        // The ID of the translation
+        // this should be unique for the translation
+        id: 'my translation id',
+
+        // The name of the translation in the translation's language
+        name: 'my translation name',
+
+        // The name of the translation in English
+        englishName: 'my translation name',
+
+        // The website that hosts information about the translation
+        website: 'translation website',
+
+        // The URL that hosts information about the license that the
+        // translation is shared under
+        licenseUrl: 'translation license',
+
+        // The ISO 639 letter language tag that the translation is primarily in.
+        language: 'eng',
+
+        // The direction that the text is written in.
+        // "ltr" means "left to right" and "rtl" means "right to left"
+        direction: 'ltr',
+    },
+};
+
+// The list of files that should be processed.
+const files: generation.InputFile[] = [
+    {
+        // the metadata about the translation for this file
+        metadata: translation,
+
+        // The content contained in the file
+        content: 'YOUR USX',
+
+        // The type of the file.
+        // One of "usx", "usfm", and "json"
+        fileType: 'usx',
+    },
+];
+
+// Generate a dataset from the files
+// Datasets organize all the files and their content
+// by translation, book, chapter, and verse
+const dataset = generation.dataset.generateDataset(files, domParser);
+
+// Generate an API representation from the files
+// This adds links between chapters and additional metadata.
+const api = generation.api.generateApiForDataset(dataset);
+
+// Generate output files from the API representation.
+// This will give us a list of files and file paths that represent
+// the entire API.
+const outputFiles = generation.api.generateFilesForApi(api);
+
+for (let file of outputFiles) {
+    console.log(file.path, file.content);
+}
+```

package/generation/api.d.ts

@@ -1,5 +1,5 @@
-import { OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from "./common-types";
-import { DatasetOutput } from "./dataset";
+import { OutputFile, Translation, TranslationBook, TranslationBookChapter, TranslationBookChapterAudioLinks } from './common-types';
+import { DatasetOutput } from './dataset';
 /**
  * Defines the output of the API generation.
  */
@@ -189,6 +189,18 @@ export interface GenerateApiOptions {
      * Defaults to false.
      */
     generateAudioFiles?: boolean;
+    /**
+     * Gets the english name of the given language.
+     * If not provided, then the english name for the language will be unknown and omitted.
+     * @param language The language to get the english name for.
+     */
+    getEnglishName?: (language: string) => string | null | undefined;
+    /**
+     * Gets the native name of the given language.
+     * If not provided, then the native name for the language will be unknown and omitted.
+     * @param language The language to get the native name for.
+     */
+    getNativeName?: (language: string) => string | null | undefined;
     /**
      * The prefix that should be added to paths that are generated.
      */

package/generation/api.js

@@ -9,7 +9,6 @@ exports.bookChapterAudioApiLink = bookChapterAudioApiLink;
 exports.jsonFile = jsonFile;
 exports.downloadedFile = downloadedFile;
 exports.replaceSpacesWithUnderscores = replaceSpacesWithUnderscores;
-const all_iso_language_codes_1 = require("all-iso-language-codes");
 /**
  * Generates the API output for the given dataset.
  * @param dataset The dataset to generate the API for.
@@ -25,8 +24,10 @@ function generateApiForDataset(dataset, options = {}) {
         translationBooks: [],
         translationBookChapters: [],
         translationBookChapterAudio: [],
-        pathPrefix: apiPathPrefix
+        pathPrefix: apiPathPrefix,
     };
+    const getNativeName = options.getNativeName;
+    const getEnglishName = options.getEnglishName;
     for (let { books, ...translation } of dataset.translations) {
         const apiTranslation = {
             ...translation,
@@ -35,8 +36,12 @@ function generateApiForDataset(dataset, options = {}) {
             numberOfBooks: books.length,
             totalNumberOfChapters: 0,
             totalNumberOfVerses: 0,
-            languageName: (0, all_iso_language_codes_1.getNativeName)(translation.language) ?? undefined,
-            languageEnglishName: (0, all_iso_language_codes_1.getEnglishName)(translation.language) ?? undefined,
+            languageName: getNativeName
+                ? getNativeName(translation.language) ?? undefined
+                : undefined,
+            languageEnglishName: getEnglishName
+                ? getEnglishName(translation.language) ?? undefined
+                : undefined,
         };
         const translationBooks = {
             translation: apiTranslation,
@@ -94,12 +99,15 @@ function generateApiForDataset(dataset, options = {}) {
         }
         for (let i = 0; i < translationChapters.length; i++) {
             if (i > 0) {
-                translationChapters[i].previousChapterApiLink = bookChapterApiLink(translation.id, getBookLink(translationChapters[i - 1].book), translationChapters[i - 1].chapter.number, 'json', apiPathPrefix);
-                translationChapters[i].previousChapterAudioLinks = translationChapters[i - 1].thisChapterAudioLinks;
+                translationChapters[i].previousChapterApiLink =
+                    bookChapterApiLink(translation.id, getBookLink(translationChapters[i - 1].book), translationChapters[i - 1].chapter.number, 'json', apiPathPrefix);
+                translationChapters[i].previousChapterAudioLinks =
+                    translationChapters[i - 1].thisChapterAudioLinks;
             }
             if (i < translationChapters.length - 1) {
                 translationChapters[i].nextChapterApiLink = bookChapterApiLink(translation.id, getBookLink(translationChapters[i + 1].book), translationChapters[i + 1].chapter.number, 'json', apiPathPrefix);
-                translationChapters[i].nextChapterAudioLinks = translationChapters[i + 1].thisChapterAudioLinks;
+                translationChapters[i].nextChapterAudioLinks =
+                    translationChapters[i + 1].thisChapterAudioLinks;
             }
         }
         api.availableTranslations.translations.push(apiTranslation);
@@ -165,13 +173,13 @@ function jsonFile(path, content, mergable) {
     return {
         path,
         content,
-        mergable
+        mergable,
     };
 }
 function downloadedFile(path, url) {
     return {
         path,
-        content: () => fetch(url).then(response => response.body),
+        content: () => fetch(url).then((response) => response.body),
     };
 }
 function replaceSpacesWithUnderscores(str) {