@helloao/tools 0.1.0 → 0.2.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,652 @@ 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,
+  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,
+  TranslationBookChapterAudioLinksSchema: () => TranslationBookChapterAudioLinksSchema,
+  TranslationBookChapterSchema: () => TranslationBookChapterSchema,
+  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().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().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."
+  })
+}).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 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."
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ChapterContentSchema,
+  ChapterDataSchema,
+  ChapterFootnoteSchema,
+  ChapterHeadingSchema,
+  ChapterHebrewSubtitleSchema,
+  ChapterLineBreakSchema,
+  ChapterVerseSchema,
+  CommentaryBookChapterSchema,
+  CommentaryBookSchema,
+  CommentaryChapterDataSchema,
+  CommentaryProfileSchema,
+  CommentarySchema,
+  DatasetBookChapterSchema,
+  DatasetBookSchema,
+  DatasetChapterDataSchema,
+  DatasetChapterVerseContentSchema,
+  DatasetSchema,
+  FormattedTextSchema,
+  InlineHeadingSchema,
+  InlineLineBreakSchema,
+  ScoredVerseRefSchema,
+  TranslationBookChapterAudioLinksSchema,
+  TranslationBookChapterSchema,
+  TranslationBookSchema,
+  TranslationSchema,
+  VerseFootnoteReferenceSchema
+});
 //# sourceMappingURL=common-types.cjs.map