waha-shared 1.0.1

package/data/typescript/bibleBookNames.ts

@@ -0,0 +1,97 @@
+import { z } from "zod"
+
+export const bibleBookNames = z.record(z.union([z.record(z.string()), z.record(z.union([z.string().describe("Localized name for the book ID (e.g., 'GEN' -> 'Génesis')"), z.string().describe("Localized name of the bible book")])).superRefine((value, ctx) => {
+for (const key in value) {
+let evaluated = false
+if (key.match(new RegExp("^[A-Z0-9]{3}$"))) {
+evaluated = true
+const result = z.string().describe("Localized name for the book ID (e.g., 'GEN' -> 'Génesis')").safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: Key matching regex /${key}/ must match schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+if (!evaluated) {
+const result = z.string().describe("Localized name of the bible book").safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: must match catchall schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+}
+}).describe("A mapping of Bible book IDs to their localized names for this translation")])).superRefine((value, ctx) => {
+for (const key in value) {
+let evaluated = false
+if (key.match(new RegExp("^[A-Z0-9]+$"))) {
+evaluated = true
+const result = z.record(z.string()).safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: Key matching regex /${key}/ must match schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+if (!evaluated) {
+const result = z.record(z.union([z.string().describe("Localized name for the book ID (e.g., 'GEN' -> 'Génesis')"), z.string().describe("Localized name of the bible book")])).superRefine((value, ctx) => {
+for (const key in value) {
+let evaluated = false
+if (key.match(new RegExp("^[A-Z0-9]{3}$"))) {
+evaluated = true
+const result = z.string().describe("Localized name for the book ID (e.g., 'GEN' -> 'Génesis')").safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: Key matching regex /${key}/ must match schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+if (!evaluated) {
+const result = z.string().describe("Localized name of the bible book").safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: must match catchall schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+}
+}).describe("A mapping of Bible book IDs to their localized names for this translation").safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: must match catchall schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+}
+}).describe("A mapping of bible translation IDs to their localized book names")
+export type BibleBookNames = z.infer<typeof bibleBookNames>

package/data/typescript/bibleBooks.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod'
+
+export const bibleBooks = z.array(
+  z.object({
+    name: z.string().describe('The name of the book.'),
+    title: z.string().describe('The title of the book.'),
+    bookId: z
+      .string()
+      .describe('The book identifier from the second JSON file.'),
+    chapters: z
+      .array(z.object({ id: z.string(), verses: z.number() }))
+      .describe('An array of chapter identifiers for the book.'),
+    englishDivision: z
+      .string()
+      .describe(
+        "The English division of the book (e.g., 'Pentateuch', 'Wisdom')."
+      ),
+    hebrewDivision: z
+      .union([
+        z
+          .string()
+          .describe(
+            "The Hebrew division of the book (e.g., 'Torah', 'Ketuvim')."
+          ),
+        z
+          .null()
+          .describe(
+            "The Hebrew division of the book (e.g., 'Torah', 'Ketuvim')."
+          ),
+      ])
+      .describe("The Hebrew division of the book (e.g., 'Torah', 'Ketuvim').")
+      .optional(),
+    hebrewOrder: z
+      .union([
+        z.number().int().describe('The order of the book in the Hebrew Bible.'),
+        z.null().describe('The order of the book in the Hebrew Bible.'),
+      ])
+      .describe('The order of the book in the Hebrew Bible.')
+      .optional(),
+    isNt: z
+      .boolean()
+      .describe('Indicates if the book is in the New Testament.'),
+    lowercase: z.string().describe('The lowercase title of the book.'),
+    lowercase_dashes: z
+      .string()
+      .describe('The lowercase title of the book with dashes.'),
+    number: z
+      .number()
+      .int()
+      .describe('The numeric order of the book in the Bible.'),
+    order: z.number().int().describe('The order of the book in the Bible.'),
+    testament: z
+      .string()
+      .describe("The testament of the book ('old' or 'new')."),
+    title_dashes: z.string().describe('The title of the book with dashes.'),
+    usfm: z.string().describe('The USFM code for the book.'),
+    nameAlternates: z
+      .array(z.string())
+      .describe('Alternative names for the book.')
+      .optional(),
+  })
+)
+export type BibleBooks = z.infer<typeof bibleBooks>

package/data/typescript/bibleChapters.ts

@@ -0,0 +1,40 @@
+import { z } from 'zod'
+
+export const bibleChapters = z.array(
+  z
+    .object({
+      bookName: z.string(),
+      chapterId: z
+        .string()
+        .regex(
+          new RegExp(
+            '^(GEN|EXO|LEV|NUM|DEU|JOS|JDG|RUT|1SA|2SA|1KI|2KI|1CH|2CH|EZR|NEH|EST|JOB|PSA|PRO|ECC|SNG|ISA|JER|LAM|EZK|DAN|HOS|JOL|AMO|OBA|JON|MIC|NAM|HAB|ZEP|HAG|ZEC|MAL|MAT|MRK|LUK|JHN|ACT|ROM|1CO|2CO|GAL|EPH|PHP|COL|1TH|2TH|1TI|2TI|TIT|PHM|HEB|JAS|1PE|2PE|1JN|2JN|3JN|JUD|REV)\\.[0-9]+$'
+          )
+        ),
+      reference: z.string().optional(),
+      titles: z.union([z.record(z.string()), z.null()]).optional(),
+      translationId: z.string(),
+      verses: z
+        .array(
+          z
+            .object({
+              text: z.string(),
+              timings: z
+                .union([z.tuple([z.number(), z.number()]), z.null()])
+                .optional(),
+              uroman: z.union([z.string(), z.null()]).optional(),
+              verseId: z
+                .string()
+                .regex(
+                  new RegExp(
+                    '^(GEN|EXO|LEV|NUM|DEU|JOS|JDG|RUT|1SA|2SA|1KI|2KI|1CH|2CH|EZR|NEH|EST|JOB|PSA|PRO|ECC|SNG|ISA|JER|LAM|EZK|DAN|HOS|JOL|AMO|OBA|JON|MIC|NAM|HAB|ZEP|HAG|ZEC|MAL|MAT|MRK|LUK|JHN|ACT|ROM|1CO|2CO|GAL|EPH|PHP|COL|1TH|2TH|1TI|2TI|TIT|PHM|HEB|JAS|1PE|2PE|1JN|2JN|3JN|JUD|REV)\\.[0-9]+\\.[0-9]+(-[0-9]+)?$'
+                  )
+                ),
+            })
+            .strict()
+        )
+        .min(1),
+    })
+    .strict()
+)
+export type BibleChapters = z.infer<typeof bibleChapters>

package/data/typescript/bibleStatuses.ts

@@ -0,0 +1,54 @@
+import { z } from 'zod'
+
+export const bibleStatuses = z
+  .record(
+    z
+      .object({
+        text: z.array(
+          z.string().regex(new RegExp('^([A-Z0-9]{3}(\\.[0-9]+)?|OT|NT)$'))
+        ),
+        audio: z.array(
+          z.string().regex(new RegExp('^([A-Z0-9]{3}(\\.[0-9]+)?|OT|NT)$'))
+        ),
+        timings: z.array(
+          z.string().regex(new RegExp('^([A-Z0-9]{3}(\\.[0-9]+)?|OT|NT)$'))
+        ),
+        bookNames: z.record(z.string()),
+      })
+      .strict()
+  )
+  .superRefine((value, ctx) => {
+    for (const key in value) {
+      if (key.match(new RegExp('^[A-Z0-9]+$'))) {
+        const result = z
+          .object({
+            text: z.array(
+              z.string().regex(new RegExp('^([A-Z0-9]{3}(\\.[0-9]+)?|OT|NT)$'))
+            ),
+            audio: z.array(
+              z.string().regex(new RegExp('^([A-Z0-9]{3}(\\.[0-9]+)?|OT|NT)$'))
+            ),
+            timings: z.array(
+              z.string().regex(new RegExp('^([A-Z0-9]{3}(\\.[0-9]+)?|OT|NT)$'))
+            ),
+            bookNames: z.record(z.string()),
+          })
+          .strict()
+          .safeParse(value[key])
+        if (!result.success) {
+          ctx.addIssue({
+            path: [...ctx.path, key],
+            code: 'custom',
+            message: `Invalid input: Key matching regex /${key}/ must match schema`,
+            params: {
+              issues: result.error.issues,
+            },
+          })
+        }
+      }
+    }
+  })
+  .describe(
+    "Consolidated bible data containing text chapters, audio chapters, timings, and book names for each translation. Entries can be testament IDs ('OT', 'NT'), book IDs (e.g., 'GEN') for complete books, or chapter IDs (e.g., 'GEN.1') for individual chapters."
+  )
+export type BibleStatuses = z.infer<typeof bibleStatuses>

package/data/typescript/bibleTextAvailableChapters.ts

@@ -0,0 +1,35 @@
+import { z } from "zod"
+
+export const bibleTextAvailableChapters = z.record(z.union([z.array(z.string().regex(new RegExp("^[A-Z0-9]{3}\\.[0-9]+$"))), z.array(z.string().regex(new RegExp("^[A-Z0-9]{3}\\.[0-9]+$")).describe("Chapter identifier in the format 'BOOK.CHAPTER' (e.g., 'GEN.1', 'REV.22')")).describe("Array of available text chapter identifiers for this translation")])).superRefine((value, ctx) => {
+for (const key in value) {
+let evaluated = false
+if (key.match(new RegExp("^[A-Z0-9]+$"))) {
+evaluated = true
+const result = z.array(z.string().regex(new RegExp("^[A-Z0-9]{3}\\.[0-9]+$"))).safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: Key matching regex /${key}/ must match schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+if (!evaluated) {
+const result = z.array(z.string().regex(new RegExp("^[A-Z0-9]{3}\\.[0-9]+$")).describe("Chapter identifier in the format 'BOOK.CHAPTER' (e.g., 'GEN.1', 'REV.22')")).describe("Array of available text chapter identifiers for this translation").safeParse(value[key])
+if (!result.success) {
+ctx.addIssue({
+          path: [...ctx.path, key],
+          code: 'custom',
+          message: `Invalid input: must match catchall schema`,
+          params: {
+            issues: result.error.issues
+          }
+        })
+}
+}
+}
+}).describe("A mapping of bible translation IDs to their available text chapters")
+export type BibleTextAvailableChapters = z.infer<typeof bibleTextAvailableChapters>

package/data/typescript/bibleTexts.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod'
+
+export const bibleTexts = z.array(
+  z
+    .object({
+      bibleTextId: z.string(),
+      name: z
+        .string()
+        .describe('The name of the bible translation in its own language.'),
+      alternativeFull: z
+        .string()
+        .describe(
+          "If a bible isn't available for the full Bible due to licensing restrictions, define an alternative Bible that does support full Bible here."
+        )
+        .optional(),
+      audioId: z
+        .string()
+        .describe(
+          'The bibleAudioId of the corresponding audio bible translation, if available.'
+        )
+        .optional(),
+      copyright: z
+        .string()
+        .describe(
+          'The copyright attribution text required to be shown in-app for this translation.'
+        )
+        .optional(),
+      copyrightImage: z
+        .string()
+        .describe('The image to display with the copyright.')
+        .optional(),
+      language: z
+        .string()
+        .regex(new RegExp('^[a-z]{3}$'))
+        .describe('The language of the translation.'),
+      nameEnglish: z
+        .string()
+        .describe('The name of the bible translation in English.')
+        .optional(),
+      textSource: z
+        .object({
+          includeSectionTitles: z
+            .boolean()
+            .describe('Whether or not to include section titles in the text.')
+            .optional(),
+          source: z.enum([
+            'dbl',
+            'bibleBrain',
+            'usfm',
+            'usfx',
+            'yvp',
+            'custom',
+          ]),
+          sourceId: z.string().optional(),
+        })
+        .strict()
+        .describe(
+          "Information about how to retrieve the text. Ideally, text is  available on the DBL via API.Bible when the license is granted, but there are a few other options. We have access to translations available on BibleBrain as well as being able to parse USFX files. Some translations may be available on the YouVersion Platform (yvp). If none of these work, 'custom' can be used and some custom code added to leviathan to retrieve and parse the text."
+        ),
+    })
+    .strict()
+)
+export type BibleTexts = z.infer<typeof bibleTexts>

package/data/typescript/clones.ts

@@ -0,0 +1,35 @@
+import { z } from 'zod'
+
+export const clones = z.array(
+  z
+    .object({
+      appId: z.string().regex(new RegExp('^[a-z]*$')),
+      appIdCaps: z.string().regex(new RegExp('^[A-Z]*$')),
+      appName: z.string(),
+      color: z.string().regex(new RegExp('^#[0-9A-Fa-f]{6}$')),
+      icon: z
+        .string()
+        .regex(new RegExp('^src\\/assets\\/clones/[A-Za-z\\-\\_]*\\.png$')),
+      iconNoBg: z
+        .string()
+        .regex(new RegExp('^src\\/assets\\/clones/[A-Za-z\\-\\_]*\\.png$')),
+      languages: z.any().optional(),
+      linkAndroid: z
+        .string()
+        .describe(
+          'URL to the app in the Google Play Store. Just `https://play.google.com/store/apps/details?id=com.kingdomstrategies.` + the clone appId.'
+        ),
+      linkIos: z
+        .string()
+        .describe(
+          'URL to the app in the Apple App Store. After creating app on ASC, go to App Store Connect > App Information > Additional Information > App Store ID.'
+        ),
+      removeTraining: z
+        .boolean()
+        .describe(
+          'If true, the training section and content will be removed from the clone.'
+        ),
+    })
+    .strict()
+)
+export type Clones = z.infer<typeof clones>

package/data/typescript/countries.ts

@@ -0,0 +1,152 @@
+import { z } from 'zod'
+
+export const countries = z
+  .record(
+    z.union([
+      z
+        .object({
+          name: z.string().describe('The display name of the country'),
+          areaId: z
+            .enum([
+              'north-america',
+              'latin-america-caribbean',
+              'sub-saharan-africa',
+              'middle-east-north-africa',
+              'western-asia',
+              'western-europe',
+              'eastern-europe',
+              'southern-asia',
+              'central-asia',
+              'eastern-asia',
+              'southeast-asia',
+              'oceania',
+            ])
+            .describe('The geographical area identifier'),
+          boundingBox: z
+            .object({
+              ne: z
+                .object({
+                  lat: z
+                    .number()
+                    .gte(-90)
+                    .lte(90)
+                    .describe('Northeast latitude coordinate'),
+                  lon: z
+                    .number()
+                    .gte(-180)
+                    .lte(180)
+                    .describe('Northeast longitude coordinate'),
+                })
+                .strict(),
+              sw: z
+                .object({
+                  lat: z
+                    .number()
+                    .gte(-90)
+                    .lte(90)
+                    .describe('Southwest latitude coordinate'),
+                  lon: z
+                    .number()
+                    .gte(-180)
+                    .lte(180)
+                    .describe('Southwest longitude coordinate'),
+                })
+                .strict(),
+            })
+            .strict()
+            .describe('Bounding box coordinates for the country'),
+        })
+        .strict(),
+      z.never(),
+    ])
+  )
+  .superRefine((value, ctx) => {
+    for (const key in value) {
+      let evaluated = false
+      if (key.match(new RegExp('^[A-Z]{2}$'))) {
+        evaluated = true
+        const result = z
+          .object({
+            name: z.string().describe('The display name of the country'),
+            areaId: z
+              .enum([
+                'north-america',
+                'latin-america-caribbean',
+                'sub-saharan-africa',
+                'middle-east-north-africa',
+                'western-asia',
+                'western-europe',
+                'eastern-europe',
+                'southern-asia',
+                'central-asia',
+                'eastern-asia',
+                'southeast-asia',
+                'oceania',
+              ])
+              .describe('The geographical area identifier'),
+            boundingBox: z
+              .object({
+                ne: z
+                  .object({
+                    lat: z
+                      .number()
+                      .gte(-90)
+                      .lte(90)
+                      .describe('Northeast latitude coordinate'),
+                    lon: z
+                      .number()
+                      .gte(-180)
+                      .lte(180)
+                      .describe('Northeast longitude coordinate'),
+                  })
+                  .strict(),
+                sw: z
+                  .object({
+                    lat: z
+                      .number()
+                      .gte(-90)
+                      .lte(90)
+                      .describe('Southwest latitude coordinate'),
+                    lon: z
+                      .number()
+                      .gte(-180)
+                      .lte(180)
+                      .describe('Southwest longitude coordinate'),
+                  })
+                  .strict(),
+              })
+              .strict()
+              .describe('Bounding box coordinates for the country'),
+          })
+          .strict()
+          .safeParse(value[key])
+        if (!result.success) {
+          ctx.addIssue({
+            path: [...ctx.path, key],
+            code: 'custom',
+            message: `Invalid input: Key matching regex /${key}/ must match schema`,
+            params: {
+              issues: result.error.issues,
+            },
+          })
+        }
+      }
+      if (!evaluated) {
+        const result = z.never().safeParse(value[key])
+        if (!result.success) {
+          ctx.addIssue({
+            path: [...ctx.path, key],
+            code: 'custom',
+            message: `Invalid input: must match catchall schema`,
+            params: {
+              issues: result.error.issues,
+            },
+          })
+        }
+      }
+    }
+  })
+  .describe(
+    'A mapping of country codes to country information including name, area, and bounding box coordinates'
+  )
+export type Countries = z.infer<typeof countries>

package/data/typescript/foundationsCurriculums.ts

@@ -0,0 +1,15 @@
+import { z } from 'zod'
+
+export const foundationsCurriculums = z.array(
+  z
+    .object({
+      curriculumId: z.string(),
+      sets: z
+        .array(z.string())
+        .describe(
+          'An array of set ids that make up this foundations curriculum. Set ids must be linked to valid sets present in data/sets.json.'
+        ),
+    })
+    .strict()
+)
+export type FoundationsCurriculums = z.infer<typeof foundationsCurriculums>

package/data/typescript/introductionTranslations.ts

@@ -0,0 +1,60 @@
+import { z } from 'zod'
+
+export const introductionTranslations = z
+  .record(
+    z
+      .object({
+        introduction: z.string(),
+        introductions: z
+          .object({
+            '03.005.001': z.string().min(1),
+            '03.005.002': z.string().min(1),
+            '03.005.003': z.string().min(1),
+            '03.005.004': z.string().min(1),
+            '03.005.005': z.string().min(1),
+            '03.005.006': z.string().min(1),
+            '03.005.007': z.string().min(1),
+            '03.005.008': z.string().min(1),
+            '03.005.009': z.string().min(1),
+            '03.005.010': z.string().min(1),
+            '03.005.011': z.string().min(1),
+            '03.005.012': z.string().min(1),
+            '03.006.001': z.string().min(1),
+            '03.006.002': z.string().min(1),
+            '03.006.003': z.string().min(1),
+            '03.006.004': z.string().min(1),
+            '03.006.005': z.string().min(1),
+            '03.006.006': z.string().min(1),
+            '03.006.007': z.string().min(1),
+            '03.006.008': z.string().min(1),
+            '03.006.009': z.string().min(1),
+            '03.006.010': z.string().min(1),
+            '03.006.011': z.string().min(1),
+            '03.006.012': z.string().min(1),
+            '03.007.001': z.string().min(1),
+            '03.007.002': z.string().min(1),
+            '03.007.003': z.string().min(1),
+            '03.007.004': z.string().min(1),
+            '03.007.005': z.string().min(1),
+            '03.007.006': z.string().min(1),
+            '03.007.007': z.string().min(1),
+            '03.007.008': z.string().min(1),
+            '03.007.009': z.string().min(1),
+            '03.007.010': z.string().min(1),
+            '03.007.011': z.string().min(1),
+            '03.007.012': z.string().min(1),
+            eq: z.string().min(1),
+          })
+          .describe(
+            "Mapping of lesson identifiers (NN.NNN.NNN) or 'eq' to translated strings."
+          ),
+      })
+      .strict()
+      .describe(
+        'Translations for a single language (identified by a 3-letter code).'
+      )
+  )
+  .describe(
+    "Schema for introductionTranslations_json. Root keys are 3-letter language identifiers (ISO-639 style). Each language object contains an 'introduction' string and an 'introductions' object mapping lesson identifiers (e.g. 03.005.001) or the key 'eq' to localized string content."
+  )
+export type IntroductionTranslations = z.infer<typeof introductionTranslations>