@helloao/tools 0.1.0 → 0.3.0

package/dist/cjs/generation/common-types.cjs

@@ -3,6 +3,10 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -13,5 +17,997 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var common_types_exports = {};
+__export(common_types_exports, {
+  ChapterContentSchema: () => ChapterContentSchema,
+  ChapterDataSchema: () => ChapterDataSchema,
+  ChapterFootnoteSchema: () => ChapterFootnoteSchema,
+  ChapterHeadingSchema: () => ChapterHeadingSchema,
+  ChapterHebrewSubtitleSchema: () => ChapterHebrewSubtitleSchema,
+  ChapterLineBreakSchema: () => ChapterLineBreakSchema,
+  ChapterVerseSchema: () => ChapterVerseSchema,
+  ChapterWordSchema: () => ChapterWordSchema,
+  CommentaryBookChapterSchema: () => CommentaryBookChapterSchema,
+  CommentaryBookSchema: () => CommentaryBookSchema,
+  CommentaryChapterDataSchema: () => CommentaryChapterDataSchema,
+  CommentaryProfileSchema: () => CommentaryProfileSchema,
+  CommentarySchema: () => CommentarySchema,
+  DatasetBookChapterSchema: () => DatasetBookChapterSchema,
+  DatasetBookSchema: () => DatasetBookSchema,
+  DatasetChapterDataSchema: () => DatasetChapterDataSchema,
+  DatasetChapterVerseContentSchema: () => DatasetChapterVerseContentSchema,
+  DatasetSchema: () => DatasetSchema,
+  FormattedTextSchema: () => FormattedTextSchema,
+  InlineHeadingSchema: () => InlineHeadingSchema,
+  InlineLineBreakSchema: () => InlineLineBreakSchema,
+  ScoredVerseRefSchema: () => ScoredVerseRefSchema,
+  SimpleChapterContentSchema: () => SimpleChapterContentSchema,
+  SimpleChapterDataSchema: () => SimpleChapterDataSchema,
+  SimpleChapterHeadingSchema: () => SimpleChapterHeadingSchema,
+  SimpleChapterHebrewSubtitleSchema: () => SimpleChapterHebrewSubtitleSchema,
+  SimpleChapterVerseSchema: () => SimpleChapterVerseSchema,
+  SimpleChapterWordSchema: () => SimpleChapterWordSchema,
+  SimpleCommentaryChapterDataSchema: () => SimpleCommentaryChapterDataSchema,
+  SimpleInlineHeadingSchema: () => SimpleInlineHeadingSchema,
+  SimplePoemRangeSchema: () => SimplePoemRangeSchema,
+  SimpleTextRangeSchema: () => SimpleTextRangeSchema,
+  SimpleTranslationBookChapterSchema: () => SimpleTranslationBookChapterSchema,
+  SimpleTranslationBookChapterWordsSchema: () => SimpleTranslationBookChapterWordsSchema,
+  SimpleVerseFootnoteSchema: () => SimpleVerseFootnoteSchema,
+  TranslationBookChapterAudioLinksSchema: () => TranslationBookChapterAudioLinksSchema,
+  TranslationBookChapterAudioTimingsSchema: () => TranslationBookChapterAudioTimingsSchema,
+  TranslationBookChapterSchema: () => TranslationBookChapterSchema,
+  TranslationBookChapterWordsSchema: () => TranslationBookChapterWordsSchema,
+  TranslationBookSchema: () => TranslationBookSchema,
+  TranslationSchema: () => TranslationSchema,
+  VerseFootnoteReferenceSchema: () => VerseFootnoteReferenceSchema
+});
 module.exports = __toCommonJS(common_types_exports);
+var import_zod = require("zod");
+var import_utils = require("../utils.js");
+const TranslationSchema = import_zod.z.object({
+  /**
+   * The ID of the translation.
+   */
+  id: import_zod.z.string().meta({
+    description: "The ID of the translation."
+  }),
+  /**
+   * The name of the translation.
+   */
+  name: import_zod.z.string().meta({
+    description: "The name of the translation."
+  }),
+  /**
+   * The website for the translation.
+   */
+  website: import_zod.z.string().meta({
+    description: "The website for the translation."
+  }),
+  /**
+   * The URL that the license for the translation can be found.
+   */
+  licenseUrl: import_zod.z.string().meta({
+    description: "The URL that the license for the translation can be found."
+  }),
+  /**
+   * The API-added notes for the license.
+   */
+  licenseNotes: import_zod.z.string().nullable().optional().meta({
+    description: "The API-added notes for the license."
+  }),
+  /**
+   * The notice that should be displayed when displaying content from the translation.
+   */
+  licenseNotice: import_zod.z.string().nullable().optional().meta({
+    description: "The notice that should be displayed when displaying content from the translation."
+  }),
+  /**
+   * The short name for the translation.
+   */
+  shortName: import_zod.z.string().optional().meta({
+    description: "The short name for the translation."
+  }),
+  /**
+   * The English name for the translation.
+   */
+  englishName: import_zod.z.string().meta({
+    description: "The English name for the translation."
+  }),
+  /**
+   * The ISO 639 3-letter language tag that the translation is primarily in.
+   */
+  language: import_zod.z.string().meta({
+    description: "The ISO 639 3-letter language tag that the translation is primarily in."
+  }),
+  /**
+   * The direction that the language is written in.
+   * "ltr" indicates that the text is written from the left side of the page to the right.
+   * "rtl" indicates that the text is written from the right side of the page to the left.
+   */
+  textDirection: import_zod.z.enum(["ltr", "rtl"]).meta({
+    description: "The direction that the language is written in. `ltr` indicates that the text is written from the left side of the page to the right. `rtl` indicates that the text is written from the right side of the page to the left."
+  })
+});
+const CommentarySchema = import_zod.z.object({
+  /**
+   * The ID of the commentary.
+   */
+  id: import_zod.z.string().meta({
+    description: "The ID of the commentary."
+  }),
+  /**
+   * The name of the commentary.
+   */
+  name: import_zod.z.string().meta({
+    description: "The name of the commentary."
+  }),
+  /**
+   * The website for the commentary.
+   */
+  website: import_zod.z.string().meta({
+    description: "The website for the commentary."
+  }),
+  /**
+   * The URL that the license for the commentary can be found.
+   */
+  licenseUrl: import_zod.z.string().meta({
+    description: "The URL that the license for the commentary can be found."
+  }),
+  /**
+   * The API-added notes for the license.
+   */
+  licenseNotes: import_zod.z.string().nullable().optional().meta({
+    description: "The API-added notes for the license."
+  }),
+  /**
+   * The english name for the commentary.
+   */
+  englishName: import_zod.z.string().meta({
+    description: "The English name for the commentary."
+  }),
+  /**
+   * The ISO 639 3-letter language tag that the translation is primarily in.
+   */
+  language: import_zod.z.string().meta({
+    description: "The ISO 639 3-letter language tag that the translation is primarily in."
+  }),
+  /**
+   * The direction that the language is written in.
+   * "ltr" indicates that the text is written from the left side of the page to the right.
+   * "rtl" indicates that the text is written from the right side of the page to the left.
+   */
+  textDirection: import_zod.z.enum(["ltr", "rtl"]).meta({
+    description: "The direction that the language is written in. `ltr` indicates that the text is written from the left side of the page to the right. `rtl` indicates that the text is written from the right side of the page to the left."
+  })
+});
+const DatasetSchema = import_zod.z.object({
+  /**
+   * The ID of the dataset.
+   */
+  id: import_zod.z.string().meta({
+    description: "The ID of the dataset."
+  }),
+  /**
+   * The name of the dataset.
+   */
+  name: import_zod.z.string().meta({
+    description: "The name of the dataset."
+  }),
+  /**
+   * The website for the dataset.
+   */
+  website: import_zod.z.string().meta({
+    description: "The website for the dataset."
+  }),
+  /**
+   * The URL that the license for the dataset can be found.
+   */
+  licenseUrl: import_zod.z.string().meta({
+    description: "The URL that the license for the dataset can be found."
+  }),
+  /**
+   * The API-added notes for the license.
+   */
+  licenseNotes: import_zod.z.string().nullable().optional().meta({
+    description: "The API-added notes for the license."
+  }),
+  /**
+   * The English name for the dataset.
+   */
+  englishName: import_zod.z.string().meta({
+    description: "The English name for the dataset."
+  }),
+  /**
+   * The ISO 639 3-letter language tag that the dataset is primarily in.
+   */
+  language: import_zod.z.string().meta({
+    description: "The ISO 639 3-letter language tag that the dataset is primarily in."
+  }),
+  /**
+   * The direction that the language is written in.
+   */
+  textDirection: import_zod.z.enum(["ltr", "rtl"]).meta({
+    description: "The direction that the language is written in."
+  })
+});
+const TranslationBookSchema = import_zod.z.object({
+  /**
+   * The ID of the book. Should match the USFM book ID.
+   */
+  id: import_utils.BookIdSchema,
+  /**
+   * The name that the translation provided for the book.
+   */
+  name: import_zod.z.string().meta({
+    description: "The name that the translation provided for the book."
+  }),
+  /**
+   * The common name for the book.
+   */
+  commonName: import_zod.z.string().meta({
+    description: "The common name for the book."
+  }),
+  /**
+   * The title of the book.
+   * This is usually a more descriptive version of the book name.
+   * If not available, then one was not provided by the translation.
+   */
+  title: import_zod.z.string().nullable().meta({
+    description: "The title of the book. This is usually a more descriptive version of the book name. If not available, then one was not provided by the translation."
+  }),
+  /**
+   * The numerical order of the book in the translation.
+   */
+  order: import_zod.z.number().meta({
+    description: "The numerical order of the book in the translation."
+  }),
+  /**
+   * Whether the book is an apocryphal book.
+   */
+  isApocryphal: import_zod.z.boolean().optional().meta({
+    description: "Whether the book is an apocryphal book."
+  })
+}).meta({
+  id: "TranslationBook",
+  description: "Defines the schema for information about a book."
+});
+const CommentaryBookSchema = import_zod.z.object({
+  /**
+   * The ID of the book. Should match the USFM book ID.
+   */
+  id: import_utils.BookIdSchema,
+  /**
+   * The name that the commentary provided for the book.
+   */
+  name: import_zod.z.string().meta({
+    description: "The name that the commentary provided for the book."
+  }),
+  /**
+   * The common name for the book.
+   */
+  commonName: import_zod.z.string().meta({
+    description: "The common name for the book."
+  }),
+  /**
+   * The commentary's introduction for the book.
+   */
+  introduction: import_zod.z.string().nullable().transform((x) => x ?? void 0).optional().pipe(import_zod.z.string().optional()).meta({
+    description: "The commentary's introduction for the book. Undefined if the commentary didn't provide an introduction for the book."
+  }),
+  /**
+   * The summary of the commentary's introduction for the book.
+   */
+  introductionSummary: import_zod.z.string().nullable().transform((x) => x ?? void 0).optional().pipe(import_zod.z.string().optional()).meta({
+    description: "The summary of the commentary's introduction for the book. Undefined if the commentary didn't provide a summary for the book."
+  }),
+  /**
+   * The order of the book in the Bible.
+   */
+  order: import_zod.z.number().meta({
+    description: "The order of the book in the Bible."
+  })
+}).meta({
+  id: "CommentaryBook",
+  description: "Defines the schema for information about a book in a commentary."
+});
+const DatasetBookSchema = import_zod.z.object({
+  /**
+   * The ID of the book. Should match the USFM book ID.
+   */
+  id: import_utils.BookIdSchema,
+  /**
+   * The order of the book in the Bible.
+   */
+  order: import_zod.z.number().meta({
+    description: "The order of the book in the Bible."
+  })
+}).meta({
+  id: "DatasetBook",
+  description: "Defines the schema for information about a book in a dataset."
+});
+const DatasetBookChapterSchema = import_zod.z.object({
+  /**
+   * The data for the chapter.
+   */
+  chapter: import_zod.z.lazy(() => DatasetChapterDataSchema).meta({
+    description: "The data for the chapter."
+  })
+}).meta({
+  id: "DatasetBookChapter",
+  description: "Defines the schema for information about a chapter in a dataset."
+});
+const DatasetChapterDataSchema = import_zod.z.object({
+  /**
+   * The number of the chapter.
+   */
+  number: import_zod.z.number().meta({
+    description: "The number of the chapter."
+  }),
+  /**
+   * The content of the chapter.
+   */
+  content: import_zod.z.array(import_zod.z.lazy(() => DatasetChapterVerseContentSchema)).meta({
+    description: "The content of the chapter."
+  })
+}).meta({
+  id: "DatasetChapterData",
+  description: "Defines the schema for information about a chapter in a dataset."
+});
+const DatasetChapterVerseContentSchema = import_zod.z.object({
+  /**
+   * The number of the verse.
+   */
+  verse: import_zod.z.number().meta({
+    description: "The number of the verse."
+  }),
+  /**
+   * The list of references for the verse.
+   */
+  references: import_zod.z.array(import_zod.z.lazy(() => ScoredVerseRefSchema)).meta({
+    description: "The list of references for the verse."
+  })
+}).meta({
+  id: "DatasetChapterVerseContent",
+  description: "Defines the schema for information about a verse in a dataset chapter."
+});
+const ScoredVerseRefSchema = import_utils.VerseRefSchema.extend({
+  score: import_zod.z.number().meta({
+    description: "The score for the verse reference. The meaning of the score is arbitrary and is determined by the dataset."
+  })
+}).meta({
+  id: "ScoredVerseRef",
+  description: "Defines the schema for information about a verse reference that has an arbitrary score attached to it."
+});
+const CommentaryProfileSchema = import_zod.z.object({
+  /**
+   * The ID of the profile.
+   */
+  id: import_zod.z.string().meta({
+    description: "The ID of the profile."
+  }),
+  /**
+   * The subject of the profile.
+   */
+  subject: import_zod.z.string().meta({
+    description: "The subject of the profile."
+  }),
+  /**
+   * The Bible reference that the profile is associated with.
+   */
+  reference: import_utils.VerseRefSchema.nullable().meta({
+    description: "The Bible reference that the profile is associated with. Null if the profile isn't associated with a specific Bible reference."
+  })
+});
+const TranslationBookChapterSchema = import_zod.z.object({
+  /**
+   * The information for the chapter.
+   */
+  chapter: import_zod.z.lazy(() => ChapterDataSchema).meta({
+    description: "The information for the chapter."
+  }),
+  /**
+   * The links to different audio versions for the chapter.
+   */
+  thisChapterAudioLinks: import_zod.z.lazy(() => TranslationBookChapterAudioLinksSchema).meta({
+    description: "The links to different audio versions for the chapter."
+  }),
+  /**
+   * The audio timings (per-verse start times, in seconds) for different audio versions for the chapter.
+   */
+  thisChapterAudioTimings: import_zod.z.lazy(() => TranslationBookChapterAudioTimingsSchema).meta({
+    description: "The audio timings (per-verse start times, in seconds) for different audio versions for the chapter."
+  }),
+  /**
+   * The word-level annotations for the chapter's verses.
+   * Omitted if the translation doesn't have any word-level annotations for the chapter.
+   */
+  thisChapterWords: import_zod.z.lazy(() => TranslationBookChapterWordsSchema).optional().meta({
+    description: "The word-level annotations (Strong's numbers and related source data) for the chapter's verses. Omitted if the translation doesn't have any word-level annotations for the chapter."
+  })
+}).meta({
+  id: "TranslationBookChapter",
+  description: "Defines the schema for information about a book chapter."
+});
+const CommentaryBookChapterSchema = import_zod.z.object({
+  /**
+   * The information for the chapter.
+   */
+  chapter: import_zod.z.lazy(() => CommentaryChapterDataSchema).meta({
+    description: "The information for the chapter."
+  })
+}).meta({
+  id: "CommentaryBookChapter",
+  description: "Defines the schema for information about a book chapter in a commentary."
+});
+const TranslationBookChapterAudioLinksSchema = import_zod.z.record(import_zod.z.string(), import_zod.z.string()).meta({
+  id: "TranslationBookChapterAudioLinks",
+  description: "Defines the schema for the audio links for a book chapter."
+});
+const TranslationBookChapterAudioTimingsSchema = import_zod.z.record(import_zod.z.string(), import_zod.z.array(import_zod.z.number())).meta({
+  id: "TranslationBookChapterAudioTimings",
+  description: "Defines the schema for the audio timings for a book chapter. Maps a reader ID to the list of times (in seconds) that each verse starts, in verse order."
+});
+const ChapterWordSchema = import_zod.z.object({
+  /**
+   * The index of the item in the verse's content array that the annotation applies to.
+   */
+  contentIndex: import_zod.z.number().meta({
+    description: "The index of the item in the verse's content array that the annotation applies to."
+  }),
+  /**
+   * The index of the first character of the annotated word.
+   */
+  start: import_zod.z.number().meta({
+    description: "The index of the first character of the annotated word in the content item's text."
+  }),
+  /**
+   * The index after the last character of the annotated word.
+   */
+  end: import_zod.z.number().meta({
+    description: "The index after the last character of the annotated word in the content item's text. That is, text.slice(start, end) is the annotated word."
+  }),
+  /**
+   * The Strong's number(s) for the word.
+   */
+  strongs: import_zod.z.array(import_zod.z.string()).optional().meta({
+    description: "The Strong's number(s) for the word. Omitted if the translation only provided other annotations for the word."
+  }),
+  /**
+   * The dictionary (citation) form of the word.
+   */
+  lemma: import_zod.z.string().optional().meta({
+    description: "The dictionary (citation) form of the word. Omitted if the translation did not provide one."
+  }),
+  /**
+   * The morphology parse code for the word.
+   */
+  morph: import_zod.z.string().optional().meta({
+    description: "The morphology parse code for the word. Omitted if the translation did not provide one."
+  }),
+  /**
+   * The pointer to the word in the source text.
+   */
+  srcloc: import_zod.z.string().optional().meta({
+    description: "The pointer to the word in the source text, in the <sourceName>:<location> format. Omitted if the translation did not provide one."
+  }),
+  /**
+   * Which occurrence of the source word this word is.
+   */
+  occurrence: import_zod.z.number().optional().meta({
+    description: "Which occurrence of the source word this word is. 1-based. Omitted if the translation did not provide one."
+  }),
+  /**
+   * The total number of times that the source word occurs.
+   */
+  occurrences: import_zod.z.number().optional().meta({
+    description: "The total number of times that the source word occurs. Omitted if the translation did not provide one."
+  })
+}).meta({
+  id: "ChapterWord",
+  description: "Defines the schema for a word-level annotation in a chapter. The annotation is anchored to a range of characters in a single item of a verse's content."
+});
+const TranslationBookChapterWordsSchema = import_zod.z.record(import_zod.z.string(), import_zod.z.array(import_zod.z.lazy(() => ChapterWordSchema))).meta({
+  id: "TranslationBookChapterWords",
+  description: "Defines the schema for the word-level annotations for a book chapter. Maps a verse number to the list of annotated words in the verse, in order."
+});
+const ChapterDataSchema = import_zod.z.object({
+  /**
+   * The number of the chapter.
+   */
+  number: import_zod.z.number().meta({
+    description: "The number of the chapter."
+  }),
+  /**
+   * The content of the chapter.
+   */
+  content: import_zod.z.array(import_zod.z.lazy(() => ChapterContentSchema)).meta({
+    description: "The content of the chapter."
+  }),
+  /**
+   * The list of footnotes for the chapter.
+   */
+  footnotes: import_zod.z.array(import_zod.z.lazy(() => ChapterFootnoteSchema)).meta({
+    description: "The list of footnotes for the chapter."
+  })
+});
+const CommentaryChapterDataSchema = import_zod.z.object({
+  /**
+   * The number of the chapter.
+   */
+  number: import_zod.z.number().meta({
+    description: "The number of the chapter."
+  }),
+  /**
+   * The introduction that the commentary provided to the chapter.
+   * Not all commentaries provide an introduction to a chapter.
+   */
+  introduction: import_zod.z.string().optional().meta({
+    description: "The introduction that the commentary provided to the chapter. Not all commentaries provide an introduction to a chapter."
+  }),
+  /**
+   * The content of the chapter.
+   */
+  content: import_zod.z.array(import_zod.z.lazy(() => ChapterVerseSchema)).meta({
+    description: "The content of the chapter."
+  })
+});
+const ChapterHeadingSchema = import_zod.z.object({
+  /**
+   * Indicates that the content represents a heading.
+   */
+  type: import_zod.z.literal("heading"),
+  /**
+   * The content for the heading.
+   * If multiple strings are included in the array, they should be concatenated with a space.
+   */
+  content: import_zod.z.array(import_zod.z.string()).meta({
+    description: "The content for the heading. If multiple strings are included in the array, they should be concatenated with a space."
+  })
+}).meta({
+  id: "ChapterHeading",
+  description: "Defines the schema for a heading in a chapter."
+});
+const ChapterLineBreakSchema = import_zod.z.object({
+  /**
+   * Indicates that the content represents a line break.
+   */
+  type: import_zod.z.literal("line_break")
+}).meta({
+  id: "ChapterLineBreak",
+  description: "Defines the schema for a line break in a chapter."
+});
+const ChapterHebrewSubtitleSchema = import_zod.z.object({
+  /**
+   * Indicates that the content represents a Hebrew Subtitle.
+   */
+  type: import_zod.z.literal("hebrew_subtitle"),
+  /**
+   * The list of content that is contained in the subtitle.
+   * Each element in the list could be a string, formatted text, or a footnote reference.
+   */
+  content: import_zod.z.array(
+    import_zod.z.union([
+      import_zod.z.string(),
+      import_zod.z.lazy(() => FormattedTextSchema),
+      import_zod.z.lazy(() => VerseFootnoteReferenceSchema)
+    ])
+  ).meta({
+    description: "The content that is contained in the subtitle. Each element in the list could be a string, formatted text, or a footnote reference."
+  })
+}).meta({
+  id: "ChapterHebrewSubtitle",
+  description: "Defines the schema for a Hebrew Subtitle in a chapter."
+});
+const ChapterVerseSchema = import_zod.z.object({
+  /**
+   * Indicates that the content is a verse.
+   */
+  type: import_zod.z.literal("verse"),
+  /**
+   * The number of the verse.
+   */
+  number: import_zod.z.number().meta({
+    description: "The number of the verse."
+  }),
+  /**
+   * The list of content for the verse.
+   * Each element in the list could be a string, formatted text, or a footnote reference.
+   */
+  content: import_zod.z.array(
+    import_zod.z.union([
+      import_zod.z.string(),
+      import_zod.z.lazy(() => FormattedTextSchema),
+      import_zod.z.lazy(() => InlineHeadingSchema),
+      import_zod.z.lazy(() => InlineLineBreakSchema),
+      import_zod.z.lazy(() => VerseFootnoteReferenceSchema)
+    ])
+  ).meta({
+    description: "The list of content for the verse. Each element in the list could be a string, formatted text, or a footnote reference."
+  })
+}).meta({
+  id: "ChapterVerse",
+  description: "Defines the schema for a verse in a chapter."
+});
+const ChapterContentSchema = import_zod.z.discriminatedUnion("type", [
+  ChapterHeadingSchema,
+  ChapterLineBreakSchema,
+  ChapterVerseSchema,
+  ChapterHebrewSubtitleSchema
+]).meta({
+  id: "ChapterContent",
+  description: "Defines a union type that represents a single piece of chapter content. A piece of chapter content can be one of the following things: A heading, a line break, a verse, or a Hebrew Subtitle."
+});
+const FormattedTextSchema = import_zod.z.object({
+  /**
+   * The text that is formatted.
+   */
+  text: import_zod.z.string().meta({
+    description: "The text that is formatted."
+  }),
+  /**
+   * Whether the text represents a poem.
+   * The number indicates the level of indent.
+   *
+   * Common in Psalms.
+   */
+  poem: import_zod.z.number().optional().meta({
+    description: "Whether the text represents a poem. The number indicates the level of indent. Common in Psalms."
+  }),
+  /**
+   * Whether the text represents the Words of Jesus.
+   */
+  wordsOfJesus: import_zod.z.boolean().optional().meta({
+    description: "Whether the text represents the Words of Jesus."
+  })
+}).meta({
+  id: "FormattedText",
+  description: "Defines the schema for formatted text. That is, text that is formatted in a particular manner."
+});
+const InlineHeadingSchema = import_zod.z.object({
+  /**
+   * The text of the heading.
+   */
+  heading: import_zod.z.string().meta({
+    description: "The text of the heading."
+  })
+}).meta({
+  id: "InlineHeading",
+  description: "Defines the schema for a heading that is embedded in a verse."
+});
+const InlineLineBreakSchema = import_zod.z.object({
+  lineBreak: import_zod.z.literal(true)
+}).meta({
+  id: "InlineLineBreak",
+  description: "Defines the schema for a line break that is embedded in a verse."
+});
+const VerseFootnoteReferenceSchema = import_zod.z.object({
+  /**
+   * The ID of the note.
+   */
+  noteId: import_zod.z.number().meta({
+    description: "The ID of the note."
+  })
+}).meta({
+  id: "VerseFootnoteReference",
+  description: "Defines the schema for a footnote reference in a verse or a Hebrew Subtitle."
+});
+const ChapterFootnoteSchema = import_zod.z.object({
+  /**
+   * The ID of the note that is referenced.
+   */
+  noteId: import_zod.z.number().meta({
+    description: "The ID of the note that is referenced."
+  }),
+  /**
+   * The text of the footnote.
+   */
+  text: import_zod.z.string().meta({
+    description: "The text of the footnote."
+  }),
+  /**
+   * The verse reference for the footnote.
+   */
+  reference: import_zod.z.object({
+    chapter: import_zod.z.number(),
+    verse: import_zod.z.number()
+  }).optional().meta({
+    description: "The verse reference for the footnote. Undefined if the footnote isn't associated with a specific verse."
+  }),
+  /**
+   * The caller that should be used for the footnote.
+   * For footnotes, a "caller" is the character that is used in the text to reference to footnote.
+   *
+   * For example, in the text:
+   * Hello (a) World
+   *
+   * ----
+   * (a) This is a footnote.
+   *
+   * The "(a)" is the caller.
+   *
+   * If "+", then the caller should be autogenerated.
+   * If null, then the caller should be empty.
+   * If a string, then the caller should be that string.
+   */
+  caller: import_zod.z.union([import_zod.z.literal("+"), import_zod.z.string(), import_zod.z.null()]).meta({
+    description: 'The caller that should be used for the footnote. For footnotes, a "caller" is the character that is used in the text to reference to footnote. For example, in the text: Hello (a) World ---- (a) This is a footnote. The "(a)" is the caller. If "+", then the caller should be autogenerated. If null, then the caller should be empty. If a string, then the caller should be that string.'
+  })
+}).meta({
+  id: "ChapterFootnote",
+  description: "Defines the schema for information about a footnote."
+});
+const SimpleTextRangeSchema = import_zod.z.object({
+  /**
+   * The index of the first character in the range.
+   */
+  start: import_zod.z.number().meta({
+    description: "The index of the first character of the range in the verse text. Measured in UTF-16 code units."
+  }),
+  /**
+   * The index after the last character in the range.
+   */
+  end: import_zod.z.number().meta({
+    description: "The index after the last character of the range in the verse text. Measured in UTF-16 code units."
+  })
+}).meta({
+  id: "SimpleTextRange",
+  description: "Defines the schema for a range of text inside a simplified verse. Ranges are expressed as offsets into the text of the verse that contains them, measured in UTF-16 code units."
+});
+const SimplePoemRangeSchema = SimpleTextRangeSchema.extend({
+  /**
+   * The level of indent that the poem line should be displayed with.
+   */
+  level: import_zod.z.number().meta({
+    description: "The level of indent that the line of poetry should be displayed with."
+  })
+}).meta({
+  id: "SimplePoemRange",
+  description: "Defines the schema for a range of text inside a simplified verse that represents a line of poetry."
+});
+const SimpleVerseFootnoteSchema = import_zod.z.object({
+  /**
+   * The ID of the note.
+   */
+  noteId: import_zod.z.number().meta({
+    description: "The ID of the note."
+  }),
+  /**
+   * The index in the verse text that the footnote caller should be inserted at.
+   */
+  offset: import_zod.z.number().meta({
+    description: "The index in the verse text that the footnote caller should be inserted at. Measured in UTF-16 code units."
+  }),
+  /**
+   * The text of the footnote.
+   */
+  text: import_zod.z.string().meta({
+    description: "The text of the footnote."
+  }),
+  /**
+   * The caller that should be used for the footnote.
+   * See ChapterFootnote for more information.
+   */
+  caller: import_zod.z.union([import_zod.z.literal("+"), import_zod.z.string(), import_zod.z.null()]).meta({
+    description: 'The caller that should be used for the footnote. If "+", then the caller should be autogenerated. If null, then the caller should be empty. If a string, then the caller should be that string.'
+  })
+}).meta({
+  id: "SimpleVerseFootnote",
+  description: "Defines the schema for a footnote in a simplified verse. Unlike the footnotes in the regular chapter format, simplified footnotes include the position that they occur at in the verse text."
+});
+const SimpleInlineHeadingSchema = import_zod.z.object({
+  /**
+   * The index in the verse text that the heading occurs at.
+   */
+  offset: import_zod.z.number().meta({
+    description: "The index in the verse text that the heading occurs at. Measured in UTF-16 code units."
+  }),
+  /**
+   * The text of the heading.
+   */
+  text: import_zod.z.string().meta({
+    description: "The text of the heading."
+  })
+}).meta({
+  id: "SimpleInlineHeading",
+  description: "Defines the schema for a heading that is embedded in a simplified verse."
+});
+const SimpleChapterVerseSchema = import_zod.z.object({
+  /**
+   * Indicates that the content is a verse.
+   */
+  type: import_zod.z.literal("verse"),
+  /**
+   * The number of the verse.
+   */
+  number: import_zod.z.number().meta({
+    description: "The number of the verse."
+  }),
+  /**
+   * The text of the verse.
+   */
+  text: import_zod.z.string().meta({
+    description: "The text of the verse. Lines of poetry and line breaks are separated by newline (\\n) characters."
+  }),
+  /**
+   * The footnotes that occur in the verse.
+   */
+  footnotes: import_zod.z.array(SimpleVerseFootnoteSchema).meta({
+    description: "The footnotes that occur in the verse."
+  }),
+  /**
+   * The headings that occur in the verse.
+   */
+  headings: import_zod.z.array(SimpleInlineHeadingSchema).optional().meta({
+    description: "The headings that occur in the middle of the verse. Omitted if the verse contains no inline headings."
+  }),
+  /**
+   * The ranges of text that represent the Words of Jesus.
+   */
+  wordsOfJesus: import_zod.z.array(SimpleTextRangeSchema).optional().meta({
+    description: "The ranges of the verse text that represent the Words of Jesus. Omitted if the verse contains none."
+  }),
+  /**
+   * The ranges of text that represent lines of poetry.
+   */
+  poem: import_zod.z.array(SimplePoemRangeSchema).optional().meta({
+    description: "The ranges of the verse text that represent lines of poetry. Omitted if the verse contains none."
+  })
+}).meta({
+  id: "SimpleChapterVerse",
+  description: "Defines the schema for a verse in a simplified chapter."
+});
+const SimpleChapterHebrewSubtitleSchema = SimpleChapterVerseSchema.omit({
+  type: true,
+  number: true
+}).extend({
+  /**
+   * Indicates that the content represents a Hebrew Subtitle.
+   */
+  type: import_zod.z.literal("hebrew_subtitle")
+}).meta({
+  id: "SimpleChapterHebrewSubtitle",
+  description: "Defines the schema for a Hebrew Subtitle in a simplified chapter."
+});
+const SimpleChapterHeadingSchema = import_zod.z.object({
+  /**
+   * Indicates that the content represents a heading.
+   */
+  type: import_zod.z.literal("heading"),
+  /**
+   * The text of the heading.
+   */
+  text: import_zod.z.string().meta({
+    description: "The text of the heading."
+  })
+}).meta({
+  id: "SimpleChapterHeading",
+  description: "Defines the schema for a heading in a simplified chapter."
+});
+const SimpleChapterContentSchema = import_zod.z.discriminatedUnion("type", [
+  SimpleChapterHeadingSchema,
+  ChapterLineBreakSchema,
+  SimpleChapterVerseSchema,
+  SimpleChapterHebrewSubtitleSchema
+]).meta({
+  id: "SimpleChapterContent",
+  description: "Defines a union type that represents a single piece of content in a simplified chapter. A piece of chapter content can be one of the following things: A heading, a line break, a verse, or a Hebrew Subtitle."
+});
+const SimpleChapterDataSchema = import_zod.z.object({
+  /**
+   * The number of the chapter.
+   */
+  number: import_zod.z.number().meta({
+    description: "The number of the chapter."
+  }),
+  /**
+   * The content of the chapter.
+   */
+  content: import_zod.z.array(SimpleChapterContentSchema).meta({
+    description: "The content of the chapter."
+  }),
+  /**
+   * The footnotes that could not be associated with a verse.
+   */
+  footnotes: import_zod.z.array(ChapterFootnoteSchema).meta({
+    description: "The list of footnotes that could not be associated with a verse. Footnotes that belong to a verse are included on the verse itself, so this list is usually empty."
+  })
+}).meta({
+  id: "SimpleChapterData",
+  description: "Defines the schema for the data in a simplified chapter. Unlike the regular chapter format, each verse contains a single text string and the footnotes/formatting are represented by offsets into that string."
+});
+const SimpleCommentaryChapterDataSchema = import_zod.z.object({
+  /**
+   * The number of the chapter.
+   */
+  number: import_zod.z.number().meta({
+    description: "The number of the chapter."
+  }),
+  /**
+   * The introduction that the commentary provided to the chapter.
+   */
+  introduction: import_zod.z.string().optional().meta({
+    description: "The introduction that the commentary provided to the chapter. Not all commentaries provide an introduction to a chapter."
+  }),
+  /**
+   * The content of the chapter.
+   */
+  content: import_zod.z.array(SimpleChapterVerseSchema).meta({
+    description: "The content of the chapter."
+  })
+}).meta({
+  id: "SimpleCommentaryChapterData",
+  description: "Defines the schema for the data in a simplified commentary chapter."
+});
+const SimpleTranslationBookChapterSchema = TranslationBookChapterSchema.extend({
+  /**
+   * The simplified information for the chapter.
+   */
+  chapter: import_zod.z.lazy(() => SimpleChapterDataSchema).meta({
+    description: "The simplified information for the chapter."
+  }),
+  /**
+   * The word-level annotations for the chapter's verses, using the simplified format.
+   */
+  thisChapterWords: import_zod.z.lazy(() => SimpleTranslationBookChapterWordsSchema).optional().meta({
+    description: "The word-level annotations (Strong's numbers and related source data) for the chapter's verses, with their offsets remapped onto the simplified verse text. Omitted if the translation doesn't have any word-level annotations for the chapter."
+  })
+}).meta({
+  id: "SimpleTranslationBookChapter",
+  description: "Defines the schema for information about a book chapter, using the simplified chapter format."
+});
+const SimpleChapterWordSchema = ChapterWordSchema.omit({
+  contentIndex: true
+}).meta({
+  id: "SimpleChapterWord",
+  description: "Defines the schema for a word-level annotation in a simplified chapter. The annotation is anchored to a range of characters in the verse's text."
+});
+const SimpleTranslationBookChapterWordsSchema = import_zod.z.record(import_zod.z.string(), import_zod.z.array(import_zod.z.lazy(() => SimpleChapterWordSchema))).meta({
+  id: "SimpleTranslationBookChapterWords",
+  description: "Defines the schema for the word-level annotations for a book chapter, using the simplified format. Maps a verse number to the list of annotated words in the verse, in order."
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ChapterContentSchema,
+  ChapterDataSchema,
+  ChapterFootnoteSchema,
+  ChapterHeadingSchema,
+  ChapterHebrewSubtitleSchema,
+  ChapterLineBreakSchema,
+  ChapterVerseSchema,
+  ChapterWordSchema,
+  CommentaryBookChapterSchema,
+  CommentaryBookSchema,
+  CommentaryChapterDataSchema,
+  CommentaryProfileSchema,
+  CommentarySchema,
+  DatasetBookChapterSchema,
+  DatasetBookSchema,
+  DatasetChapterDataSchema,
+  DatasetChapterVerseContentSchema,
+  DatasetSchema,
+  FormattedTextSchema,
+  InlineHeadingSchema,
+  InlineLineBreakSchema,
+  ScoredVerseRefSchema,
+  SimpleChapterContentSchema,
+  SimpleChapterDataSchema,
+  SimpleChapterHeadingSchema,
+  SimpleChapterHebrewSubtitleSchema,
+  SimpleChapterVerseSchema,
+  SimpleChapterWordSchema,
+  SimpleCommentaryChapterDataSchema,
+  SimpleInlineHeadingSchema,
+  SimplePoemRangeSchema,
+  SimpleTextRangeSchema,
+  SimpleTranslationBookChapterSchema,
+  SimpleTranslationBookChapterWordsSchema,
+  SimpleVerseFootnoteSchema,
+  TranslationBookChapterAudioLinksSchema,
+  TranslationBookChapterAudioTimingsSchema,
+  TranslationBookChapterSchema,
+  TranslationBookChapterWordsSchema,
+  TranslationBookSchema,
+  TranslationSchema,
+  VerseFootnoteReferenceSchema
+});
 //# sourceMappingURL=common-types.cjs.map