@helloao/tools 0.0.9 → 0.0.11

package/dist/types/parser/codex-parser.d.ts

@@ -20,6 +20,26 @@ export declare const chapterHeadingSchema: z.ZodObject<{
         chapter: number;
     };
 }>;
+export declare const verseSchema: z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "text";
+}, {
+    id: string;
+    type: "text";
+}>;
+export declare const paratextSchema: z.ZodObject<{
+    type: z.ZodLiteral<"paratext">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "paratext";
+}, {
+    id: string;
+    type: "paratext";
+}>;
 export declare const metadataSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<"chapter-heading">;
     data: z.ZodObject<{
@@ -39,10 +59,29 @@ export declare const metadataSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObjec
     data: {
         chapter: number;
     };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "text";
+}, {
+    id: string;
+    type: "text";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"paratext">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    type: "paratext";
+}, {
+    id: string;
+    type: "paratext";
 }>]>;
 export declare const codexSchema: z.ZodObject<{
     cells: z.ZodArray<z.ZodObject<{
-        language: z.ZodString;
+        kind: z.ZodNumber;
+        languageId: z.ZodString;
         value: z.ZodString;
         metadata: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             type: z.ZodString;
@@ -52,30 +91,34 @@ export declare const codexSchema: z.ZodObject<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough">>>>;
     }, "strip", z.ZodTypeAny, {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectOutputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
     }, {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectInputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     cells: {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectOutputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
     }[];
 }, {
     cells: {
+        kind: number;
         value: string;
-        language: string;
+        languageId: string;
         metadata?: z.objectInputType<{
             type: z.ZodString;
         }, z.ZodTypeAny, "passthrough"> | null | undefined;
@@ -87,9 +130,9 @@ export declare const codexSchema: z.ZodObject<{
 export declare class CodexParser {
     private _noteCounter;
     /**
-     * Parses the specified USX content.
+     * Parses the specified codex content.
      *
-     * @param usx The USX content to parse.
+     * @param codex The codex content to parse.
      * @returns The parse tree that was generated.
      */
     parse(codex: string): ParseTree;

package/dist/types/parser/commentary-csv-parser.d.ts

@@ -0,0 +1,12 @@
+import { CommentaryParseTree } from './types';
+export interface CsvLine {
+    book: string;
+    chapter: string;
+    verse: string;
+    commentaries: string;
+}
+export declare class CommentaryCsvParser {
+    parse(data: string): CommentaryParseTree;
+    parseLines(data: CsvLine[]): CommentaryParseTree;
+}
+//# sourceMappingURL=commentary-csv-parser.d.ts.map

package/dist/types/parser/index.d.ts

@@ -2,6 +2,7 @@ export * from './types.js';
 export * from './usfm-parser.js';
 export * from './usx-parser.js';
 export * from './codex-parser.js';
+export * from './commentary-csv-parser.js';
 import * as iterators from './iterators.js';
 export { iterators };
 //# sourceMappingURL=index.d.ts.map

package/dist/types/parser/tyndale-xml-parser.d.ts

@@ -0,0 +1,8 @@
+import { CommentaryParseTree } from './types';
+export declare class TyndaleXmlParser {
+    private _domParser;
+    constructor(domParser: DOMParser);
+    parse(xml: string): CommentaryParseTree;
+}
+export declare function toKebabCase(camelCase: string): string;
+//# sourceMappingURL=tyndale-xml-parser.d.ts.map

package/dist/types/parser/types.d.ts

@@ -1,3 +1,4 @@
+import { VerseRef } from '../utils.js';
 /**
  * The parse tree that is gathered.
  */
@@ -24,7 +25,7 @@ export interface Heading {
     type: 'heading';
     content: string[];
 }
-export type ChapterContent = (Heading | Verse | HebrewSubtitle | LineBreak);
+export type ChapterContent = Heading | Verse | HebrewSubtitle | LineBreak;
 export type VerseContent = string | FootnoteReference | Text;
 /**
  * Defines an interface that represents a chapter.
@@ -141,4 +142,55 @@ export interface Footnote {
 export interface LineBreak {
     type: 'line_break';
 }
+/**
+ * The parse tree that is gathered.
+ */
+export interface CommentaryParseTree {
+    type: 'commentary/root';
+    /**
+     * The books that are contained in the commentary.
+     */
+    books: CommentaryBookNode[];
+    /**
+     * The profiles that are contained in the commentary.
+     */
+    profiles?: CommentaryProfileNode[];
+}
+export interface CommentaryBookNode {
+    type: 'book';
+    book: string;
+    introduction: string | null;
+    introductionSummary?: string | null;
+    chapters: CommentaryChapterNode[];
+}
+export interface CommentaryProfileNode {
+    /**
+     * The ID of the profile.
+     * Used to identify the profile within a commentary.
+     */
+    id: string;
+    /**
+     * The subject(s) of the profile.
+     */
+    subject: string;
+    /**
+     * The Bible reference that the profile is associated with.
+     */
+    reference: VerseRef | null;
+    /**
+     * The content of the profile.
+     */
+    content: string[];
+}
+export interface CommentaryChapterNode {
+    type: 'chapter';
+    number: number;
+    introduction: string | null;
+    verses: CommentaryVerseNode[];
+}
+export interface CommentaryVerseNode {
+    type: 'verse';
+    number: number;
+    content: string[];
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types/parser/usx-parser.d.ts

@@ -4,7 +4,7 @@ import { RewindableIterator } from './iterators.js';
  * The version of the parser.
  * Used to determine whether input files need to be re-parsed.
  */
-export declare const PARSER_VERSION = "1";
+export declare const PARSER_VERSION = "2";
 /**
  * Defines a class that is able to parse USX content.
  */

package/dist/types/utils.d.ts

@@ -18,6 +18,14 @@ export interface VerseRef {
      * The rest of the content of the verse.
      */
     content?: string;
+    /**
+     * The chapter that the verse reference ends at.
+     */
+    endChapter?: number;
+    /**
+     * The verse that the verse reference ends at.
+     */
+    endVerse?: number;
 }
 /**
  * Parses the given verse reference.
@@ -26,4 +34,10 @@ export interface VerseRef {
  * @param text The reference to parse.
  */
 export declare function parseVerseReference(text: string): VerseRef | null;
+/**
+ * Gets the ID of the given book.
+ * Returns null if the ID could not be found.
+ * @param book The name/ID of the book.
+ */
+export declare function getBookId(book: string): string | null;
 //# sourceMappingURL=utils.d.ts.map

package/package.json

@@ -1,34 +1,57 @@
 {
   "name": "@helloao/tools",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "A set of tools for managing HelloAO's Free Bible API",
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.js",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.cjs"
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.cjs"
+      }
     },
     "./*.js": {
-      "types": "./dist/types/*.d.ts",
-      "import": "./dist/esm/*.js",
-      "require": "./dist/cjs/*.cjs"
+      "import": {
+        "types": "./dist/types/*.d.ts",
+        "default": "./dist/esm/*.js"
+      },
+      "require": {
+        "types": "./dist/types/*.d.ts",
+        "default": "./dist/cjs/*.cjs"
+      }
     },
     "./parser/*.js": {
-      "types": "./dist/types/parser/*.d.ts",
-      "import": "./dist/esm/parser/*.js",
-      "require": "./dist/cjs/parser/*.cjs"
+      "import": {
+        "types": "./dist/types/parser/*.d.ts",
+        "default": "./dist/esm/parser/*.js"
+      },
+      "require": {
+        "types": "./dist/types/parser/*.d.ts",
+        "default": "./dist/cjs/parser/*.cjs"
+      }
     },
     "./generation/*.js": {
-      "types": "./dist/types/generation/*.d.ts",
-      "import": "./dist/esm/generation/*.js",
-      "require": "./dist/cjs/generation/*.cjs"
+      "import": {
+        "types": "./dist/types/generation/*.d.ts",
+        "default": "./dist/esm/generation/*.js"
+      },
+      "require": {
+        "types": "./dist/types/generation/*.d.ts",
+        "default": "./dist/cjs/generation/*.cjs"
+      }
     }
   },
   "author": "Kallyn Gowdy <kal@helloao.org>",
   "license": "MIT",
   "dependencies": {
     "lodash": "4.17.21",
-    "zod": "^3.23.8"
+    "zod": "^3.23.8",
+    "papaparse": "5.4.1"
   },
   "devDependencies": {
     "linkedom": "0.18.4",