@helloao/tools 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/dist/cjs/generation/api.cjs +727 -2
  2. package/dist/cjs/generation/api.cjs.map +2 -2
  3. package/dist/cjs/generation/audio.cjs +52 -5
  4. package/dist/cjs/generation/audio.cjs.map +2 -2
  5. package/dist/cjs/generation/book-order.cjs +1 -1
  6. package/dist/cjs/generation/book-order.cjs.map +2 -2
  7. package/dist/cjs/generation/common-types.cjs +651 -0
  8. package/dist/cjs/generation/common-types.cjs.map +2 -2
  9. package/dist/cjs/generation/dataset.cjs +31 -8
  10. package/dist/cjs/generation/dataset.cjs.map +2 -2
  11. package/dist/cjs/index.cjs.map +1 -1
  12. package/dist/cjs/log.cjs.map +1 -1
  13. package/dist/cjs/parser/codex-parser.cjs.map +1 -1
  14. package/dist/cjs/parser/commentary-csv-parser.cjs.map +1 -1
  15. package/dist/cjs/parser/iterators.cjs.map +1 -1
  16. package/dist/cjs/parser/lockman-parser.cjs +334 -0
  17. package/dist/cjs/parser/lockman-parser.cjs.map +7 -0
  18. package/dist/cjs/parser/tyndale-xml-parser.cjs.map +1 -1
  19. package/dist/cjs/parser/types.cjs.map +1 -1
  20. package/dist/cjs/parser/usfm-parser.cjs.map +1 -1
  21. package/dist/cjs/parser/usx-parser.cjs +24 -7
  22. package/dist/cjs/parser/usx-parser.cjs.map +2 -2
  23. package/dist/cjs/utils.cjs +152 -0
  24. package/dist/cjs/utils.cjs.map +3 -3
  25. package/dist/esm/generation/api.js +696 -2
  26. package/dist/esm/generation/api.js.map +2 -2
  27. package/dist/esm/generation/audio.js +46 -3
  28. package/dist/esm/generation/audio.js.map +2 -2
  29. package/dist/esm/generation/book-order.js +1 -1
  30. package/dist/esm/generation/book-order.js.map +2 -2
  31. package/dist/esm/generation/common-types.js +590 -0
  32. package/dist/esm/generation/common-types.js.map +3 -3
  33. package/dist/esm/generation/dataset.js +29 -8
  34. package/dist/esm/generation/dataset.js.map +2 -2
  35. package/dist/esm/index.js.map +1 -1
  36. package/dist/esm/log.js.map +1 -1
  37. package/dist/esm/parser/codex-parser.js.map +1 -1
  38. package/dist/esm/parser/commentary-csv-parser.js.map +1 -1
  39. package/dist/esm/parser/iterators.js.map +1 -1
  40. package/dist/esm/parser/lockman-parser.js +306 -0
  41. package/dist/esm/parser/lockman-parser.js.map +7 -0
  42. package/dist/esm/parser/tyndale-xml-parser.js.map +1 -1
  43. package/dist/esm/parser/usfm-parser.js.map +1 -1
  44. package/dist/esm/parser/usx-parser.js +24 -7
  45. package/dist/esm/parser/usx-parser.js.map +2 -2
  46. package/dist/esm/utils.js +138 -0
  47. package/dist/esm/utils.js.map +2 -2
  48. package/dist/types/generation/api.d.ts +2515 -470
  49. package/dist/types/generation/audio.d.ts +5 -0
  50. package/dist/types/generation/common-types.d.ts +1222 -413
  51. package/dist/types/generation/dataset.d.ts +1 -0
  52. package/dist/types/parser/codex-parser.d.ts +18 -138
  53. package/dist/types/parser/lockman-parser.d.ts +14 -0
  54. package/dist/types/parser/types.d.ts +4 -0
  55. package/dist/types/parser/usx-parser.d.ts +2 -2
  56. package/dist/types/utils.d.ts +223 -18
  57. package/package.json +5 -3
@@ -1,4 +1,4 @@
1
- import { VerseRef } from '../utils.js';
1
+ import { z } from 'zod';
2
2
  /**
3
3
  * Defines an interface that contains information about a input file.
4
4
  */
@@ -10,7 +10,7 @@ export interface InputFileBase {
10
10
  }
11
11
  export type InputFileMetadata = InputTranslationMetadata | InputCommentaryMetadata;
12
12
  export interface InputTranslationFile extends InputFileBase {
13
- fileType: 'usfm' | 'usx' | 'json';
13
+ fileType: 'usfm' | 'usx' | 'json' | 'lockman';
14
14
  metadata: InputTranslationMetadata;
15
15
  }
16
16
  export interface InputCommentaryFile extends InputFileBase {
@@ -52,6 +52,10 @@ export interface MetadataBase {
52
52
  * The URL that the license for the translation can be found.
53
53
  */
54
54
  licenseUrl: string;
55
+ /**
56
+ * The notice that should be displayed when displaying content from the translation.
57
+ */
58
+ licenseNotice?: string | null;
55
59
  /**
56
60
  * The ISO 639 letter language tag that the translation is primarily in.
57
61
  */
@@ -84,463 +88,1268 @@ export interface InputCommentaryMetadata extends MetadataBase {
84
88
  id: string;
85
89
  }
86
90
  /**
87
- * Defines an interface that contains information about a translation.
91
+ * Defines a Zod schema for information about a translation.
88
92
  */
89
- export interface Translation {
90
- /**
91
- * The ID of the translation.
92
- */
93
- id: string;
94
- /**
95
- * The name of the translation.
96
- */
97
- name: string;
98
- /**
99
- * The website for the translation.
100
- */
101
- website: string;
102
- /**
103
- * The URL that the license for the translation can be found.
104
- */
105
- licenseUrl: string;
106
- /**
107
- * The API-added notes for the license.
108
- */
109
- licenseNotes?: string | null;
110
- /**
111
- * The short name for the translation.
112
- */
113
- shortName?: string;
114
- /**
115
- * The English name for the translation.
116
- */
117
- englishName: string;
118
- /**
119
- * The ISO 639 3-letter language tag that the translation is primarily in.
120
- */
121
- language: string;
122
- /**
123
- * The direction that the language is written in.
124
- * "ltr" indicates that the text is written from the left side of the page to the right.
125
- * "rtl" indicates that the text is written from the right side of the page to the left.
126
- */
127
- textDirection: 'ltr' | 'rtl';
128
- }
93
+ export declare const TranslationSchema: z.ZodObject<{
94
+ id: z.ZodString;
95
+ name: z.ZodString;
96
+ website: z.ZodString;
97
+ licenseUrl: z.ZodString;
98
+ licenseNotes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
99
+ licenseNotice: z.ZodOptional<z.ZodNullable<z.ZodString>>;
100
+ shortName: z.ZodOptional<z.ZodString>;
101
+ englishName: z.ZodString;
102
+ language: z.ZodString;
103
+ textDirection: z.ZodEnum<{
104
+ ltr: "ltr";
105
+ rtl: "rtl";
106
+ }>;
107
+ }, z.core.$strip>;
108
+ export type Translation = z.infer<typeof TranslationSchema>;
129
109
  /**
130
- * Defines an interface that contains information about a commentary.
110
+ * Defines a Zod schema for information about a commentary.
131
111
  */
132
- export interface Commentary {
133
- /**
134
- * The ID of the commentary.
135
- */
136
- id: string;
137
- /**
138
- * The name of the commentary.
139
- */
140
- name: string;
141
- /**
142
- * The website for the commentary.
143
- */
144
- website: string;
145
- /**
146
- * The URL that the license for the commentary can be found.
147
- */
148
- licenseUrl: string;
149
- /**
150
- * The API-added notes for the license.
151
- */
152
- licenseNotes?: string | null;
153
- /**
154
- * The english name for the commentary.
155
- */
156
- englishName: string;
157
- /**
158
- * The ISO 639 3-letter language tag that the translation is primarily in.
159
- */
160
- language: string;
161
- /**
162
- * The direction that the language is written in.
163
- * "ltr" indicates that the text is written from the left side of the page to the right.
164
- * "rtl" indicates that the text is written from the right side of the page to the left.
165
- */
166
- textDirection: 'ltr' | 'rtl';
167
- }
168
- export interface Dataset {
169
- /**
170
- * The ID of the dataset.
171
- */
172
- id: string;
173
- /**
174
- * The name of the dataset.
175
- */
176
- name: string;
177
- /**
178
- * The website for the dataset.
179
- */
180
- website: string;
181
- /**
182
- * The URL that the license for the dataset can be found.
183
- */
184
- licenseUrl: string;
185
- /**
186
- * The API-added notes for the license.
187
- */
188
- licenseNotes?: string | null;
189
- /**
190
- * The English name for the dataset.
191
- */
192
- englishName: string;
193
- /**
194
- * The ISO 639 3-letter language tag that the dataset is primarily in.
195
- */
196
- language: string;
197
- /**
198
- * The direction that the language is written in.
199
- */
200
- textDirection: 'ltr' | 'rtl';
201
- }
112
+ export declare const CommentarySchema: z.ZodObject<{
113
+ id: z.ZodString;
114
+ name: z.ZodString;
115
+ website: z.ZodString;
116
+ licenseUrl: z.ZodString;
117
+ licenseNotes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
118
+ englishName: z.ZodString;
119
+ language: z.ZodString;
120
+ textDirection: z.ZodEnum<{
121
+ ltr: "ltr";
122
+ rtl: "rtl";
123
+ }>;
124
+ }, z.core.$strip>;
125
+ export type Commentary = z.infer<typeof CommentarySchema>;
126
+ export declare const DatasetSchema: z.ZodObject<{
127
+ id: z.ZodString;
128
+ name: z.ZodString;
129
+ website: z.ZodString;
130
+ licenseUrl: z.ZodString;
131
+ licenseNotes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
132
+ englishName: z.ZodString;
133
+ language: z.ZodString;
134
+ textDirection: z.ZodEnum<{
135
+ ltr: "ltr";
136
+ rtl: "rtl";
137
+ }>;
138
+ }, z.core.$strip>;
139
+ export type Dataset = z.infer<typeof DatasetSchema>;
202
140
  /**
203
- * Defines an interface that contains information about a book.
141
+ * Defines a Zod schema for information about a book.
204
142
  */
205
- export interface TranslationBook {
206
- /**
207
- * The ID of the book. Should match the USFM book ID.
208
- */
209
- id: string;
210
- /**
211
- * The name that the translation provided for the book.
212
- */
213
- name: string;
214
- /**
215
- * The common name for the book.
216
- */
217
- commonName: string;
218
- /**
219
- * The title of the book.
220
- * This is usually a more descriptive version of the book name.
221
- * If not available, then one was not provided by the translation.
222
- */
223
- title: string | null;
224
- /**
225
- * The numerical order of the book in the translation.
226
- */
227
- order: number;
228
- /**
229
- * Whether the book is an apocryphal book.
230
- */
231
- isApocryphal?: boolean;
232
- }
143
+ export declare const TranslationBookSchema: z.ZodObject<{
144
+ id: z.ZodEnum<{
145
+ GEN: "GEN";
146
+ EXO: "EXO";
147
+ LEV: "LEV";
148
+ NUM: "NUM";
149
+ DEU: "DEU";
150
+ JOS: "JOS";
151
+ JDG: "JDG";
152
+ RUT: "RUT";
153
+ "1SA": "1SA";
154
+ "2SA": "2SA";
155
+ "1KI": "1KI";
156
+ "2KI": "2KI";
157
+ "1CH": "1CH";
158
+ "2CH": "2CH";
159
+ EZR: "EZR";
160
+ NEH: "NEH";
161
+ EST: "EST";
162
+ JOB: "JOB";
163
+ PSA: "PSA";
164
+ PRO: "PRO";
165
+ ECC: "ECC";
166
+ SNG: "SNG";
167
+ ISA: "ISA";
168
+ JER: "JER";
169
+ LAM: "LAM";
170
+ EZK: "EZK";
171
+ DAN: "DAN";
172
+ HOS: "HOS";
173
+ JOL: "JOL";
174
+ AMO: "AMO";
175
+ OBA: "OBA";
176
+ JON: "JON";
177
+ MIC: "MIC";
178
+ NAM: "NAM";
179
+ HAB: "HAB";
180
+ ZEP: "ZEP";
181
+ HAG: "HAG";
182
+ ZEC: "ZEC";
183
+ MAL: "MAL";
184
+ MAT: "MAT";
185
+ MRK: "MRK";
186
+ LUK: "LUK";
187
+ JHN: "JHN";
188
+ ACT: "ACT";
189
+ ROM: "ROM";
190
+ "1CO": "1CO";
191
+ "2CO": "2CO";
192
+ GAL: "GAL";
193
+ EPH: "EPH";
194
+ PHP: "PHP";
195
+ COL: "COL";
196
+ "1TH": "1TH";
197
+ "2TH": "2TH";
198
+ "1TI": "1TI";
199
+ "2TI": "2TI";
200
+ TIT: "TIT";
201
+ PHM: "PHM";
202
+ HEB: "HEB";
203
+ JAS: "JAS";
204
+ "1PE": "1PE";
205
+ "2PE": "2PE";
206
+ "1JN": "1JN";
207
+ "2JN": "2JN";
208
+ "3JN": "3JN";
209
+ JUD: "JUD";
210
+ REV: "REV";
211
+ TOB: "TOB";
212
+ JDT: "JDT";
213
+ ESG: "ESG";
214
+ WIS: "WIS";
215
+ SIR: "SIR";
216
+ BAR: "BAR";
217
+ LJE: "LJE";
218
+ S3Y: "S3Y";
219
+ SUS: "SUS";
220
+ BEL: "BEL";
221
+ "1MA": "1MA";
222
+ "2MA": "2MA";
223
+ "3MA": "3MA";
224
+ "4MA": "4MA";
225
+ "1ES": "1ES";
226
+ "2ES": "2ES";
227
+ MAN: "MAN";
228
+ PS2: "PS2";
229
+ ODA: "ODA";
230
+ PSS: "PSS";
231
+ EZA: "EZA";
232
+ "5EZ": "5EZ";
233
+ "6EZ": "6EZ";
234
+ DAG: "DAG";
235
+ PS3: "PS3";
236
+ "2BA": "2BA";
237
+ LBA: "LBA";
238
+ JUB: "JUB";
239
+ ENO: "ENO";
240
+ "1MQ": "1MQ";
241
+ "2MQ": "2MQ";
242
+ "3MQ": "3MQ";
243
+ REP: "REP";
244
+ "4BA": "4BA";
245
+ LAO: "LAO";
246
+ }>;
247
+ name: z.ZodString;
248
+ commonName: z.ZodString;
249
+ title: z.ZodNullable<z.ZodString>;
250
+ order: z.ZodNumber;
251
+ isApocryphal: z.ZodOptional<z.ZodBoolean>;
252
+ }, z.core.$strip>;
253
+ export type TranslationBook = z.infer<typeof TranslationBookSchema>;
233
254
  /**
234
- * Defines an interface that contains information about a book in a commentary.
255
+ * Defines a Zod schema for information about a book in a commentary.
235
256
  */
236
- export interface CommentaryBook {
237
- /**
238
- * The ID of the book. Should match the USFM book ID.
239
- */
240
- id: string;
241
- /**
242
- * The name that the commentary provided for the book.
243
- */
244
- name: string;
245
- /**
246
- * The common name for the book.
247
- */
248
- commonName: string;
249
- /**
250
- * The commentary's introduction for the book.
251
- */
252
- introduction?: string;
253
- /**
254
- * The summary of the commentary's introduction for the book.
255
- */
256
- introductionSummary?: string;
257
- /**
258
- * The order of the book in the Bible.
259
- */
260
- order: number;
261
- }
257
+ export declare const CommentaryBookSchema: z.ZodObject<{
258
+ id: z.ZodEnum<{
259
+ GEN: "GEN";
260
+ EXO: "EXO";
261
+ LEV: "LEV";
262
+ NUM: "NUM";
263
+ DEU: "DEU";
264
+ JOS: "JOS";
265
+ JDG: "JDG";
266
+ RUT: "RUT";
267
+ "1SA": "1SA";
268
+ "2SA": "2SA";
269
+ "1KI": "1KI";
270
+ "2KI": "2KI";
271
+ "1CH": "1CH";
272
+ "2CH": "2CH";
273
+ EZR: "EZR";
274
+ NEH: "NEH";
275
+ EST: "EST";
276
+ JOB: "JOB";
277
+ PSA: "PSA";
278
+ PRO: "PRO";
279
+ ECC: "ECC";
280
+ SNG: "SNG";
281
+ ISA: "ISA";
282
+ JER: "JER";
283
+ LAM: "LAM";
284
+ EZK: "EZK";
285
+ DAN: "DAN";
286
+ HOS: "HOS";
287
+ JOL: "JOL";
288
+ AMO: "AMO";
289
+ OBA: "OBA";
290
+ JON: "JON";
291
+ MIC: "MIC";
292
+ NAM: "NAM";
293
+ HAB: "HAB";
294
+ ZEP: "ZEP";
295
+ HAG: "HAG";
296
+ ZEC: "ZEC";
297
+ MAL: "MAL";
298
+ MAT: "MAT";
299
+ MRK: "MRK";
300
+ LUK: "LUK";
301
+ JHN: "JHN";
302
+ ACT: "ACT";
303
+ ROM: "ROM";
304
+ "1CO": "1CO";
305
+ "2CO": "2CO";
306
+ GAL: "GAL";
307
+ EPH: "EPH";
308
+ PHP: "PHP";
309
+ COL: "COL";
310
+ "1TH": "1TH";
311
+ "2TH": "2TH";
312
+ "1TI": "1TI";
313
+ "2TI": "2TI";
314
+ TIT: "TIT";
315
+ PHM: "PHM";
316
+ HEB: "HEB";
317
+ JAS: "JAS";
318
+ "1PE": "1PE";
319
+ "2PE": "2PE";
320
+ "1JN": "1JN";
321
+ "2JN": "2JN";
322
+ "3JN": "3JN";
323
+ JUD: "JUD";
324
+ REV: "REV";
325
+ TOB: "TOB";
326
+ JDT: "JDT";
327
+ ESG: "ESG";
328
+ WIS: "WIS";
329
+ SIR: "SIR";
330
+ BAR: "BAR";
331
+ LJE: "LJE";
332
+ S3Y: "S3Y";
333
+ SUS: "SUS";
334
+ BEL: "BEL";
335
+ "1MA": "1MA";
336
+ "2MA": "2MA";
337
+ "3MA": "3MA";
338
+ "4MA": "4MA";
339
+ "1ES": "1ES";
340
+ "2ES": "2ES";
341
+ MAN: "MAN";
342
+ PS2: "PS2";
343
+ ODA: "ODA";
344
+ PSS: "PSS";
345
+ EZA: "EZA";
346
+ "5EZ": "5EZ";
347
+ "6EZ": "6EZ";
348
+ DAG: "DAG";
349
+ PS3: "PS3";
350
+ "2BA": "2BA";
351
+ LBA: "LBA";
352
+ JUB: "JUB";
353
+ ENO: "ENO";
354
+ "1MQ": "1MQ";
355
+ "2MQ": "2MQ";
356
+ "3MQ": "3MQ";
357
+ REP: "REP";
358
+ "4BA": "4BA";
359
+ LAO: "LAO";
360
+ }>;
361
+ name: z.ZodString;
362
+ commonName: z.ZodString;
363
+ introduction: z.ZodOptional<z.ZodString>;
364
+ introductionSummary: z.ZodOptional<z.ZodString>;
365
+ order: z.ZodNumber;
366
+ }, z.core.$strip>;
367
+ export type CommentaryBook = z.infer<typeof CommentaryBookSchema>;
262
368
  /**
263
- * Defines an interface that contains information about a dataset book.
369
+ * Defines a Zod schema for information about a dataset book.
264
370
  */
265
- export interface DatasetBook {
266
- /**
267
- * The ID of the book. Should match the USFM book ID.
268
- */
269
- id: string;
270
- /**
271
- * The order of the book in the Bible.
272
- */
273
- order: number;
274
- }
371
+ export declare const DatasetBookSchema: z.ZodObject<{
372
+ id: z.ZodEnum<{
373
+ GEN: "GEN";
374
+ EXO: "EXO";
375
+ LEV: "LEV";
376
+ NUM: "NUM";
377
+ DEU: "DEU";
378
+ JOS: "JOS";
379
+ JDG: "JDG";
380
+ RUT: "RUT";
381
+ "1SA": "1SA";
382
+ "2SA": "2SA";
383
+ "1KI": "1KI";
384
+ "2KI": "2KI";
385
+ "1CH": "1CH";
386
+ "2CH": "2CH";
387
+ EZR: "EZR";
388
+ NEH: "NEH";
389
+ EST: "EST";
390
+ JOB: "JOB";
391
+ PSA: "PSA";
392
+ PRO: "PRO";
393
+ ECC: "ECC";
394
+ SNG: "SNG";
395
+ ISA: "ISA";
396
+ JER: "JER";
397
+ LAM: "LAM";
398
+ EZK: "EZK";
399
+ DAN: "DAN";
400
+ HOS: "HOS";
401
+ JOL: "JOL";
402
+ AMO: "AMO";
403
+ OBA: "OBA";
404
+ JON: "JON";
405
+ MIC: "MIC";
406
+ NAM: "NAM";
407
+ HAB: "HAB";
408
+ ZEP: "ZEP";
409
+ HAG: "HAG";
410
+ ZEC: "ZEC";
411
+ MAL: "MAL";
412
+ MAT: "MAT";
413
+ MRK: "MRK";
414
+ LUK: "LUK";
415
+ JHN: "JHN";
416
+ ACT: "ACT";
417
+ ROM: "ROM";
418
+ "1CO": "1CO";
419
+ "2CO": "2CO";
420
+ GAL: "GAL";
421
+ EPH: "EPH";
422
+ PHP: "PHP";
423
+ COL: "COL";
424
+ "1TH": "1TH";
425
+ "2TH": "2TH";
426
+ "1TI": "1TI";
427
+ "2TI": "2TI";
428
+ TIT: "TIT";
429
+ PHM: "PHM";
430
+ HEB: "HEB";
431
+ JAS: "JAS";
432
+ "1PE": "1PE";
433
+ "2PE": "2PE";
434
+ "1JN": "1JN";
435
+ "2JN": "2JN";
436
+ "3JN": "3JN";
437
+ JUD: "JUD";
438
+ REV: "REV";
439
+ TOB: "TOB";
440
+ JDT: "JDT";
441
+ ESG: "ESG";
442
+ WIS: "WIS";
443
+ SIR: "SIR";
444
+ BAR: "BAR";
445
+ LJE: "LJE";
446
+ S3Y: "S3Y";
447
+ SUS: "SUS";
448
+ BEL: "BEL";
449
+ "1MA": "1MA";
450
+ "2MA": "2MA";
451
+ "3MA": "3MA";
452
+ "4MA": "4MA";
453
+ "1ES": "1ES";
454
+ "2ES": "2ES";
455
+ MAN: "MAN";
456
+ PS2: "PS2";
457
+ ODA: "ODA";
458
+ PSS: "PSS";
459
+ EZA: "EZA";
460
+ "5EZ": "5EZ";
461
+ "6EZ": "6EZ";
462
+ DAG: "DAG";
463
+ PS3: "PS3";
464
+ "2BA": "2BA";
465
+ LBA: "LBA";
466
+ JUB: "JUB";
467
+ ENO: "ENO";
468
+ "1MQ": "1MQ";
469
+ "2MQ": "2MQ";
470
+ "3MQ": "3MQ";
471
+ REP: "REP";
472
+ "4BA": "4BA";
473
+ LAO: "LAO";
474
+ }>;
475
+ order: z.ZodNumber;
476
+ }, z.core.$strip>;
477
+ export type DatasetBook = z.infer<typeof DatasetBookSchema>;
275
478
  /**
276
- * Defines an interface that contains information about a chapter in a dataset.
479
+ * Defines a Zod schema for information about a chapter in a dataset.
277
480
  */
278
- export interface DatasetBookChapter {
279
- /**
280
- * The data for the chapter.
281
- */
282
- chapter: DatasetChapterData;
283
- }
284
- export interface DatasetChapterData {
285
- /**
286
- * The number of the chapter.
287
- */
288
- number: number;
289
- /**
290
- * The content of the chapter.
291
- */
292
- content: DatasetChapterVerseContent[];
293
- }
481
+ export declare const DatasetBookChapterSchema: z.ZodObject<{
482
+ chapter: z.ZodLazy<z.ZodObject<{
483
+ number: z.ZodNumber;
484
+ content: z.ZodArray<z.ZodLazy<z.ZodObject<{
485
+ verse: z.ZodNumber;
486
+ references: z.ZodArray<z.ZodLazy<z.ZodObject<{
487
+ book: z.ZodEnum<{
488
+ GEN: "GEN";
489
+ EXO: "EXO";
490
+ LEV: "LEV";
491
+ NUM: "NUM";
492
+ DEU: "DEU";
493
+ JOS: "JOS";
494
+ JDG: "JDG";
495
+ RUT: "RUT";
496
+ "1SA": "1SA";
497
+ "2SA": "2SA";
498
+ "1KI": "1KI";
499
+ "2KI": "2KI";
500
+ "1CH": "1CH";
501
+ "2CH": "2CH";
502
+ EZR: "EZR";
503
+ NEH: "NEH";
504
+ EST: "EST";
505
+ JOB: "JOB";
506
+ PSA: "PSA";
507
+ PRO: "PRO";
508
+ ECC: "ECC";
509
+ SNG: "SNG";
510
+ ISA: "ISA";
511
+ JER: "JER";
512
+ LAM: "LAM";
513
+ EZK: "EZK";
514
+ DAN: "DAN";
515
+ HOS: "HOS";
516
+ JOL: "JOL";
517
+ AMO: "AMO";
518
+ OBA: "OBA";
519
+ JON: "JON";
520
+ MIC: "MIC";
521
+ NAM: "NAM";
522
+ HAB: "HAB";
523
+ ZEP: "ZEP";
524
+ HAG: "HAG";
525
+ ZEC: "ZEC";
526
+ MAL: "MAL";
527
+ MAT: "MAT";
528
+ MRK: "MRK";
529
+ LUK: "LUK";
530
+ JHN: "JHN";
531
+ ACT: "ACT";
532
+ ROM: "ROM";
533
+ "1CO": "1CO";
534
+ "2CO": "2CO";
535
+ GAL: "GAL";
536
+ EPH: "EPH";
537
+ PHP: "PHP";
538
+ COL: "COL";
539
+ "1TH": "1TH";
540
+ "2TH": "2TH";
541
+ "1TI": "1TI";
542
+ "2TI": "2TI";
543
+ TIT: "TIT";
544
+ PHM: "PHM";
545
+ HEB: "HEB";
546
+ JAS: "JAS";
547
+ "1PE": "1PE";
548
+ "2PE": "2PE";
549
+ "1JN": "1JN";
550
+ "2JN": "2JN";
551
+ "3JN": "3JN";
552
+ JUD: "JUD";
553
+ REV: "REV";
554
+ TOB: "TOB";
555
+ JDT: "JDT";
556
+ ESG: "ESG";
557
+ WIS: "WIS";
558
+ SIR: "SIR";
559
+ BAR: "BAR";
560
+ LJE: "LJE";
561
+ S3Y: "S3Y";
562
+ SUS: "SUS";
563
+ BEL: "BEL";
564
+ "1MA": "1MA";
565
+ "2MA": "2MA";
566
+ "3MA": "3MA";
567
+ "4MA": "4MA";
568
+ "1ES": "1ES";
569
+ "2ES": "2ES";
570
+ MAN: "MAN";
571
+ PS2: "PS2";
572
+ ODA: "ODA";
573
+ PSS: "PSS";
574
+ EZA: "EZA";
575
+ "5EZ": "5EZ";
576
+ "6EZ": "6EZ";
577
+ DAG: "DAG";
578
+ PS3: "PS3";
579
+ "2BA": "2BA";
580
+ LBA: "LBA";
581
+ JUB: "JUB";
582
+ ENO: "ENO";
583
+ "1MQ": "1MQ";
584
+ "2MQ": "2MQ";
585
+ "3MQ": "3MQ";
586
+ REP: "REP";
587
+ "4BA": "4BA";
588
+ LAO: "LAO";
589
+ }>;
590
+ chapter: z.ZodNumber;
591
+ verse: z.ZodNumber;
592
+ content: z.ZodOptional<z.ZodString>;
593
+ endChapter: z.ZodOptional<z.ZodNumber>;
594
+ endVerse: z.ZodOptional<z.ZodNumber>;
595
+ score: z.ZodNumber;
596
+ }, z.core.$strip>>>;
597
+ }, z.core.$strip>>>;
598
+ }, z.core.$strip>>;
599
+ }, z.core.$strip>;
600
+ export type DatasetBookChapter = z.infer<typeof DatasetBookChapterSchema>;
601
+ export declare const DatasetChapterDataSchema: z.ZodObject<{
602
+ number: z.ZodNumber;
603
+ content: z.ZodArray<z.ZodLazy<z.ZodObject<{
604
+ verse: z.ZodNumber;
605
+ references: z.ZodArray<z.ZodLazy<z.ZodObject<{
606
+ book: z.ZodEnum<{
607
+ GEN: "GEN";
608
+ EXO: "EXO";
609
+ LEV: "LEV";
610
+ NUM: "NUM";
611
+ DEU: "DEU";
612
+ JOS: "JOS";
613
+ JDG: "JDG";
614
+ RUT: "RUT";
615
+ "1SA": "1SA";
616
+ "2SA": "2SA";
617
+ "1KI": "1KI";
618
+ "2KI": "2KI";
619
+ "1CH": "1CH";
620
+ "2CH": "2CH";
621
+ EZR: "EZR";
622
+ NEH: "NEH";
623
+ EST: "EST";
624
+ JOB: "JOB";
625
+ PSA: "PSA";
626
+ PRO: "PRO";
627
+ ECC: "ECC";
628
+ SNG: "SNG";
629
+ ISA: "ISA";
630
+ JER: "JER";
631
+ LAM: "LAM";
632
+ EZK: "EZK";
633
+ DAN: "DAN";
634
+ HOS: "HOS";
635
+ JOL: "JOL";
636
+ AMO: "AMO";
637
+ OBA: "OBA";
638
+ JON: "JON";
639
+ MIC: "MIC";
640
+ NAM: "NAM";
641
+ HAB: "HAB";
642
+ ZEP: "ZEP";
643
+ HAG: "HAG";
644
+ ZEC: "ZEC";
645
+ MAL: "MAL";
646
+ MAT: "MAT";
647
+ MRK: "MRK";
648
+ LUK: "LUK";
649
+ JHN: "JHN";
650
+ ACT: "ACT";
651
+ ROM: "ROM";
652
+ "1CO": "1CO";
653
+ "2CO": "2CO";
654
+ GAL: "GAL";
655
+ EPH: "EPH";
656
+ PHP: "PHP";
657
+ COL: "COL";
658
+ "1TH": "1TH";
659
+ "2TH": "2TH";
660
+ "1TI": "1TI";
661
+ "2TI": "2TI";
662
+ TIT: "TIT";
663
+ PHM: "PHM";
664
+ HEB: "HEB";
665
+ JAS: "JAS";
666
+ "1PE": "1PE";
667
+ "2PE": "2PE";
668
+ "1JN": "1JN";
669
+ "2JN": "2JN";
670
+ "3JN": "3JN";
671
+ JUD: "JUD";
672
+ REV: "REV";
673
+ TOB: "TOB";
674
+ JDT: "JDT";
675
+ ESG: "ESG";
676
+ WIS: "WIS";
677
+ SIR: "SIR";
678
+ BAR: "BAR";
679
+ LJE: "LJE";
680
+ S3Y: "S3Y";
681
+ SUS: "SUS";
682
+ BEL: "BEL";
683
+ "1MA": "1MA";
684
+ "2MA": "2MA";
685
+ "3MA": "3MA";
686
+ "4MA": "4MA";
687
+ "1ES": "1ES";
688
+ "2ES": "2ES";
689
+ MAN: "MAN";
690
+ PS2: "PS2";
691
+ ODA: "ODA";
692
+ PSS: "PSS";
693
+ EZA: "EZA";
694
+ "5EZ": "5EZ";
695
+ "6EZ": "6EZ";
696
+ DAG: "DAG";
697
+ PS3: "PS3";
698
+ "2BA": "2BA";
699
+ LBA: "LBA";
700
+ JUB: "JUB";
701
+ ENO: "ENO";
702
+ "1MQ": "1MQ";
703
+ "2MQ": "2MQ";
704
+ "3MQ": "3MQ";
705
+ REP: "REP";
706
+ "4BA": "4BA";
707
+ LAO: "LAO";
708
+ }>;
709
+ chapter: z.ZodNumber;
710
+ verse: z.ZodNumber;
711
+ content: z.ZodOptional<z.ZodString>;
712
+ endChapter: z.ZodOptional<z.ZodNumber>;
713
+ endVerse: z.ZodOptional<z.ZodNumber>;
714
+ score: z.ZodNumber;
715
+ }, z.core.$strip>>>;
716
+ }, z.core.$strip>>>;
717
+ }, z.core.$strip>;
718
+ export type DatasetChapterData = z.infer<typeof DatasetChapterDataSchema>;
294
719
  /**
295
- * Defines an interface that contains information about a verse in a dataset chapter.
720
+ * Defines a Zod schema for information about a verse in a dataset chapter.
296
721
  */
297
- export interface DatasetChapterVerseContent {
298
- /**
299
- * The number of the verse.
300
- */
301
- verse: number;
302
- /**
303
- * The list of references for the verse.
304
- */
305
- references: ScoredVerseRef[];
306
- }
722
+ export declare const DatasetChapterVerseContentSchema: z.ZodObject<{
723
+ verse: z.ZodNumber;
724
+ references: z.ZodArray<z.ZodLazy<z.ZodObject<{
725
+ book: z.ZodEnum<{
726
+ GEN: "GEN";
727
+ EXO: "EXO";
728
+ LEV: "LEV";
729
+ NUM: "NUM";
730
+ DEU: "DEU";
731
+ JOS: "JOS";
732
+ JDG: "JDG";
733
+ RUT: "RUT";
734
+ "1SA": "1SA";
735
+ "2SA": "2SA";
736
+ "1KI": "1KI";
737
+ "2KI": "2KI";
738
+ "1CH": "1CH";
739
+ "2CH": "2CH";
740
+ EZR: "EZR";
741
+ NEH: "NEH";
742
+ EST: "EST";
743
+ JOB: "JOB";
744
+ PSA: "PSA";
745
+ PRO: "PRO";
746
+ ECC: "ECC";
747
+ SNG: "SNG";
748
+ ISA: "ISA";
749
+ JER: "JER";
750
+ LAM: "LAM";
751
+ EZK: "EZK";
752
+ DAN: "DAN";
753
+ HOS: "HOS";
754
+ JOL: "JOL";
755
+ AMO: "AMO";
756
+ OBA: "OBA";
757
+ JON: "JON";
758
+ MIC: "MIC";
759
+ NAM: "NAM";
760
+ HAB: "HAB";
761
+ ZEP: "ZEP";
762
+ HAG: "HAG";
763
+ ZEC: "ZEC";
764
+ MAL: "MAL";
765
+ MAT: "MAT";
766
+ MRK: "MRK";
767
+ LUK: "LUK";
768
+ JHN: "JHN";
769
+ ACT: "ACT";
770
+ ROM: "ROM";
771
+ "1CO": "1CO";
772
+ "2CO": "2CO";
773
+ GAL: "GAL";
774
+ EPH: "EPH";
775
+ PHP: "PHP";
776
+ COL: "COL";
777
+ "1TH": "1TH";
778
+ "2TH": "2TH";
779
+ "1TI": "1TI";
780
+ "2TI": "2TI";
781
+ TIT: "TIT";
782
+ PHM: "PHM";
783
+ HEB: "HEB";
784
+ JAS: "JAS";
785
+ "1PE": "1PE";
786
+ "2PE": "2PE";
787
+ "1JN": "1JN";
788
+ "2JN": "2JN";
789
+ "3JN": "3JN";
790
+ JUD: "JUD";
791
+ REV: "REV";
792
+ TOB: "TOB";
793
+ JDT: "JDT";
794
+ ESG: "ESG";
795
+ WIS: "WIS";
796
+ SIR: "SIR";
797
+ BAR: "BAR";
798
+ LJE: "LJE";
799
+ S3Y: "S3Y";
800
+ SUS: "SUS";
801
+ BEL: "BEL";
802
+ "1MA": "1MA";
803
+ "2MA": "2MA";
804
+ "3MA": "3MA";
805
+ "4MA": "4MA";
806
+ "1ES": "1ES";
807
+ "2ES": "2ES";
808
+ MAN: "MAN";
809
+ PS2: "PS2";
810
+ ODA: "ODA";
811
+ PSS: "PSS";
812
+ EZA: "EZA";
813
+ "5EZ": "5EZ";
814
+ "6EZ": "6EZ";
815
+ DAG: "DAG";
816
+ PS3: "PS3";
817
+ "2BA": "2BA";
818
+ LBA: "LBA";
819
+ JUB: "JUB";
820
+ ENO: "ENO";
821
+ "1MQ": "1MQ";
822
+ "2MQ": "2MQ";
823
+ "3MQ": "3MQ";
824
+ REP: "REP";
825
+ "4BA": "4BA";
826
+ LAO: "LAO";
827
+ }>;
828
+ chapter: z.ZodNumber;
829
+ verse: z.ZodNumber;
830
+ content: z.ZodOptional<z.ZodString>;
831
+ endChapter: z.ZodOptional<z.ZodNumber>;
832
+ endVerse: z.ZodOptional<z.ZodNumber>;
833
+ score: z.ZodNumber;
834
+ }, z.core.$strip>>>;
835
+ }, z.core.$strip>;
836
+ export type DatasetChapterVerseContent = z.infer<typeof DatasetChapterVerseContentSchema>;
307
837
  /**
308
838
  * Defines an interface that contains information about a verse reference that has an arbitrary score attached to it.
309
839
  */
310
- export interface ScoredVerseRef extends VerseRef {
311
- /**
312
- * The score of the verse reference.
313
- */
314
- score: number;
315
- }
840
+ export declare const ScoredVerseRefSchema: z.ZodObject<{
841
+ book: z.ZodEnum<{
842
+ GEN: "GEN";
843
+ EXO: "EXO";
844
+ LEV: "LEV";
845
+ NUM: "NUM";
846
+ DEU: "DEU";
847
+ JOS: "JOS";
848
+ JDG: "JDG";
849
+ RUT: "RUT";
850
+ "1SA": "1SA";
851
+ "2SA": "2SA";
852
+ "1KI": "1KI";
853
+ "2KI": "2KI";
854
+ "1CH": "1CH";
855
+ "2CH": "2CH";
856
+ EZR: "EZR";
857
+ NEH: "NEH";
858
+ EST: "EST";
859
+ JOB: "JOB";
860
+ PSA: "PSA";
861
+ PRO: "PRO";
862
+ ECC: "ECC";
863
+ SNG: "SNG";
864
+ ISA: "ISA";
865
+ JER: "JER";
866
+ LAM: "LAM";
867
+ EZK: "EZK";
868
+ DAN: "DAN";
869
+ HOS: "HOS";
870
+ JOL: "JOL";
871
+ AMO: "AMO";
872
+ OBA: "OBA";
873
+ JON: "JON";
874
+ MIC: "MIC";
875
+ NAM: "NAM";
876
+ HAB: "HAB";
877
+ ZEP: "ZEP";
878
+ HAG: "HAG";
879
+ ZEC: "ZEC";
880
+ MAL: "MAL";
881
+ MAT: "MAT";
882
+ MRK: "MRK";
883
+ LUK: "LUK";
884
+ JHN: "JHN";
885
+ ACT: "ACT";
886
+ ROM: "ROM";
887
+ "1CO": "1CO";
888
+ "2CO": "2CO";
889
+ GAL: "GAL";
890
+ EPH: "EPH";
891
+ PHP: "PHP";
892
+ COL: "COL";
893
+ "1TH": "1TH";
894
+ "2TH": "2TH";
895
+ "1TI": "1TI";
896
+ "2TI": "2TI";
897
+ TIT: "TIT";
898
+ PHM: "PHM";
899
+ HEB: "HEB";
900
+ JAS: "JAS";
901
+ "1PE": "1PE";
902
+ "2PE": "2PE";
903
+ "1JN": "1JN";
904
+ "2JN": "2JN";
905
+ "3JN": "3JN";
906
+ JUD: "JUD";
907
+ REV: "REV";
908
+ TOB: "TOB";
909
+ JDT: "JDT";
910
+ ESG: "ESG";
911
+ WIS: "WIS";
912
+ SIR: "SIR";
913
+ BAR: "BAR";
914
+ LJE: "LJE";
915
+ S3Y: "S3Y";
916
+ SUS: "SUS";
917
+ BEL: "BEL";
918
+ "1MA": "1MA";
919
+ "2MA": "2MA";
920
+ "3MA": "3MA";
921
+ "4MA": "4MA";
922
+ "1ES": "1ES";
923
+ "2ES": "2ES";
924
+ MAN: "MAN";
925
+ PS2: "PS2";
926
+ ODA: "ODA";
927
+ PSS: "PSS";
928
+ EZA: "EZA";
929
+ "5EZ": "5EZ";
930
+ "6EZ": "6EZ";
931
+ DAG: "DAG";
932
+ PS3: "PS3";
933
+ "2BA": "2BA";
934
+ LBA: "LBA";
935
+ JUB: "JUB";
936
+ ENO: "ENO";
937
+ "1MQ": "1MQ";
938
+ "2MQ": "2MQ";
939
+ "3MQ": "3MQ";
940
+ REP: "REP";
941
+ "4BA": "4BA";
942
+ LAO: "LAO";
943
+ }>;
944
+ chapter: z.ZodNumber;
945
+ verse: z.ZodNumber;
946
+ content: z.ZodOptional<z.ZodString>;
947
+ endChapter: z.ZodOptional<z.ZodNumber>;
948
+ endVerse: z.ZodOptional<z.ZodNumber>;
949
+ score: z.ZodNumber;
950
+ }, z.core.$strip>;
951
+ export type ScoredVerseRef = z.infer<typeof ScoredVerseRefSchema>;
316
952
  /**
317
- * Defines an interface that contains information about a profile in a commentary.
953
+ * Defines a Zod schema for information about a profile in a commentary.
318
954
  */
319
- export interface CommentaryProfile {
320
- /**
321
- * The ID of the profile.
322
- */
323
- id: string;
324
- /**
325
- * The subject of the profile.
326
- */
327
- subject: string;
328
- /**
329
- * The Bible reference that the profile is associated with.
330
- */
331
- reference: VerseRef | null;
332
- }
955
+ export declare const CommentaryProfileSchema: z.ZodObject<{
956
+ id: z.ZodString;
957
+ subject: z.ZodString;
958
+ reference: z.ZodNullable<z.ZodObject<{
959
+ book: z.ZodEnum<{
960
+ GEN: "GEN";
961
+ EXO: "EXO";
962
+ LEV: "LEV";
963
+ NUM: "NUM";
964
+ DEU: "DEU";
965
+ JOS: "JOS";
966
+ JDG: "JDG";
967
+ RUT: "RUT";
968
+ "1SA": "1SA";
969
+ "2SA": "2SA";
970
+ "1KI": "1KI";
971
+ "2KI": "2KI";
972
+ "1CH": "1CH";
973
+ "2CH": "2CH";
974
+ EZR: "EZR";
975
+ NEH: "NEH";
976
+ EST: "EST";
977
+ JOB: "JOB";
978
+ PSA: "PSA";
979
+ PRO: "PRO";
980
+ ECC: "ECC";
981
+ SNG: "SNG";
982
+ ISA: "ISA";
983
+ JER: "JER";
984
+ LAM: "LAM";
985
+ EZK: "EZK";
986
+ DAN: "DAN";
987
+ HOS: "HOS";
988
+ JOL: "JOL";
989
+ AMO: "AMO";
990
+ OBA: "OBA";
991
+ JON: "JON";
992
+ MIC: "MIC";
993
+ NAM: "NAM";
994
+ HAB: "HAB";
995
+ ZEP: "ZEP";
996
+ HAG: "HAG";
997
+ ZEC: "ZEC";
998
+ MAL: "MAL";
999
+ MAT: "MAT";
1000
+ MRK: "MRK";
1001
+ LUK: "LUK";
1002
+ JHN: "JHN";
1003
+ ACT: "ACT";
1004
+ ROM: "ROM";
1005
+ "1CO": "1CO";
1006
+ "2CO": "2CO";
1007
+ GAL: "GAL";
1008
+ EPH: "EPH";
1009
+ PHP: "PHP";
1010
+ COL: "COL";
1011
+ "1TH": "1TH";
1012
+ "2TH": "2TH";
1013
+ "1TI": "1TI";
1014
+ "2TI": "2TI";
1015
+ TIT: "TIT";
1016
+ PHM: "PHM";
1017
+ HEB: "HEB";
1018
+ JAS: "JAS";
1019
+ "1PE": "1PE";
1020
+ "2PE": "2PE";
1021
+ "1JN": "1JN";
1022
+ "2JN": "2JN";
1023
+ "3JN": "3JN";
1024
+ JUD: "JUD";
1025
+ REV: "REV";
1026
+ TOB: "TOB";
1027
+ JDT: "JDT";
1028
+ ESG: "ESG";
1029
+ WIS: "WIS";
1030
+ SIR: "SIR";
1031
+ BAR: "BAR";
1032
+ LJE: "LJE";
1033
+ S3Y: "S3Y";
1034
+ SUS: "SUS";
1035
+ BEL: "BEL";
1036
+ "1MA": "1MA";
1037
+ "2MA": "2MA";
1038
+ "3MA": "3MA";
1039
+ "4MA": "4MA";
1040
+ "1ES": "1ES";
1041
+ "2ES": "2ES";
1042
+ MAN: "MAN";
1043
+ PS2: "PS2";
1044
+ ODA: "ODA";
1045
+ PSS: "PSS";
1046
+ EZA: "EZA";
1047
+ "5EZ": "5EZ";
1048
+ "6EZ": "6EZ";
1049
+ DAG: "DAG";
1050
+ PS3: "PS3";
1051
+ "2BA": "2BA";
1052
+ LBA: "LBA";
1053
+ JUB: "JUB";
1054
+ ENO: "ENO";
1055
+ "1MQ": "1MQ";
1056
+ "2MQ": "2MQ";
1057
+ "3MQ": "3MQ";
1058
+ REP: "REP";
1059
+ "4BA": "4BA";
1060
+ LAO: "LAO";
1061
+ }>;
1062
+ chapter: z.ZodNumber;
1063
+ verse: z.ZodNumber;
1064
+ content: z.ZodOptional<z.ZodString>;
1065
+ endChapter: z.ZodOptional<z.ZodNumber>;
1066
+ endVerse: z.ZodOptional<z.ZodNumber>;
1067
+ }, z.core.$strip>>;
1068
+ }, z.core.$strip>;
1069
+ export type CommentaryProfile = z.infer<typeof CommentaryProfileSchema>;
333
1070
  /**
334
- * Defines an interface that contains information about a book chapter.
1071
+ * Defines a Zod schema for information about a book chapter.
335
1072
  */
336
- export interface TranslationBookChapter {
337
- /**
338
- * The information for the chapter.
339
- */
340
- chapter: ChapterData;
341
- /**
342
- * The links to different audio versions for the chapter.
343
- */
344
- thisChapterAudioLinks: TranslationBookChapterAudioLinks;
345
- }
1073
+ export declare const TranslationBookChapterSchema: z.ZodObject<{
1074
+ chapter: z.ZodLazy<z.ZodObject<{
1075
+ number: z.ZodNumber;
1076
+ content: z.ZodArray<z.ZodLazy<z.ZodDiscriminatedUnion<[z.ZodObject<{
1077
+ type: z.ZodLiteral<"heading">;
1078
+ content: z.ZodArray<z.ZodString>;
1079
+ }, z.core.$strip>, z.ZodObject<{
1080
+ type: z.ZodLiteral<"line_break">;
1081
+ }, z.core.$strip>, z.ZodObject<{
1082
+ type: z.ZodLiteral<"verse">;
1083
+ number: z.ZodNumber;
1084
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1085
+ text: z.ZodString;
1086
+ poem: z.ZodOptional<z.ZodNumber>;
1087
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1088
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1089
+ heading: z.ZodString;
1090
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1091
+ lineBreak: z.ZodLiteral<true>;
1092
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1093
+ noteId: z.ZodNumber;
1094
+ }, z.core.$strip>>]>>;
1095
+ }, z.core.$strip>, z.ZodObject<{
1096
+ type: z.ZodLiteral<"hebrew_subtitle">;
1097
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1098
+ text: z.ZodString;
1099
+ poem: z.ZodOptional<z.ZodNumber>;
1100
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1101
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1102
+ noteId: z.ZodNumber;
1103
+ }, z.core.$strip>>]>>;
1104
+ }, z.core.$strip>], "type">>>;
1105
+ footnotes: z.ZodArray<z.ZodLazy<z.ZodObject<{
1106
+ noteId: z.ZodNumber;
1107
+ text: z.ZodString;
1108
+ reference: z.ZodOptional<z.ZodObject<{
1109
+ chapter: z.ZodNumber;
1110
+ verse: z.ZodNumber;
1111
+ }, z.core.$strip>>;
1112
+ caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
1113
+ }, z.core.$strip>>>;
1114
+ }, z.core.$strip>>;
1115
+ thisChapterAudioLinks: z.ZodLazy<z.ZodRecord<z.ZodString, z.ZodString>>;
1116
+ }, z.core.$strip>;
1117
+ export type TranslationBookChapter = z.infer<typeof TranslationBookChapterSchema>;
346
1118
  /**
347
- * Defines an interface that contains information about a book chapter in a commentary.
1119
+ * Defines a Zod schema for information about a book chapter in a commentary.
348
1120
  */
349
- export interface CommentaryBookChapter {
350
- /**
351
- * The information for the chapter.
352
- */
353
- chapter: CommentaryChapterData;
354
- }
1121
+ export declare const CommentaryBookChapterSchema: z.ZodObject<{
1122
+ chapter: z.ZodLazy<z.ZodObject<{
1123
+ number: z.ZodNumber;
1124
+ introduction: z.ZodOptional<z.ZodString>;
1125
+ content: z.ZodArray<z.ZodLazy<z.ZodObject<{
1126
+ type: z.ZodLiteral<"verse">;
1127
+ number: z.ZodNumber;
1128
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1129
+ text: z.ZodString;
1130
+ poem: z.ZodOptional<z.ZodNumber>;
1131
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1132
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1133
+ heading: z.ZodString;
1134
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1135
+ lineBreak: z.ZodLiteral<true>;
1136
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1137
+ noteId: z.ZodNumber;
1138
+ }, z.core.$strip>>]>>;
1139
+ }, z.core.$strip>>>;
1140
+ }, z.core.$strip>>;
1141
+ }, z.core.$strip>;
1142
+ export type CommentaryBookChapter = z.infer<typeof CommentaryBookChapterSchema>;
355
1143
  /**
356
- * Defines an interface that contains the audio links for a book chapter.
1144
+ * Defines a Zod schema for the audio links for a book chapter.
357
1145
  */
358
- export interface TranslationBookChapterAudioLinks {
359
- /**
360
- * The reader for the chapter and the URL link to the audio file.
361
- */
362
- [reader: string]: string;
363
- }
1146
+ export declare const TranslationBookChapterAudioLinksSchema: z.ZodRecord<z.ZodString, z.ZodString>;
1147
+ export type TranslationBookChapterAudioLinks = z.infer<typeof TranslationBookChapterAudioLinksSchema>;
364
1148
  /**
365
- * Defines an interface that represents data in a chapter.
1149
+ * Defines a Zod schema for information about data in a chapter.
366
1150
  */
367
- export interface ChapterData {
368
- /**
369
- * The number of the chapter.
370
- */
371
- number: number;
372
- /**
373
- * The content of the chapter.
374
- */
375
- content: ChapterContent[];
376
- /**
377
- * The list of footnotes for the chapter.
378
- */
379
- footnotes: ChapterFootnote[];
380
- }
1151
+ export declare const ChapterDataSchema: z.ZodObject<{
1152
+ number: z.ZodNumber;
1153
+ content: z.ZodArray<z.ZodLazy<z.ZodDiscriminatedUnion<[z.ZodObject<{
1154
+ type: z.ZodLiteral<"heading">;
1155
+ content: z.ZodArray<z.ZodString>;
1156
+ }, z.core.$strip>, z.ZodObject<{
1157
+ type: z.ZodLiteral<"line_break">;
1158
+ }, z.core.$strip>, z.ZodObject<{
1159
+ type: z.ZodLiteral<"verse">;
1160
+ number: z.ZodNumber;
1161
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1162
+ text: z.ZodString;
1163
+ poem: z.ZodOptional<z.ZodNumber>;
1164
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1165
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1166
+ heading: z.ZodString;
1167
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1168
+ lineBreak: z.ZodLiteral<true>;
1169
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1170
+ noteId: z.ZodNumber;
1171
+ }, z.core.$strip>>]>>;
1172
+ }, z.core.$strip>, z.ZodObject<{
1173
+ type: z.ZodLiteral<"hebrew_subtitle">;
1174
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1175
+ text: z.ZodString;
1176
+ poem: z.ZodOptional<z.ZodNumber>;
1177
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1178
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1179
+ noteId: z.ZodNumber;
1180
+ }, z.core.$strip>>]>>;
1181
+ }, z.core.$strip>], "type">>>;
1182
+ footnotes: z.ZodArray<z.ZodLazy<z.ZodObject<{
1183
+ noteId: z.ZodNumber;
1184
+ text: z.ZodString;
1185
+ reference: z.ZodOptional<z.ZodObject<{
1186
+ chapter: z.ZodNumber;
1187
+ verse: z.ZodNumber;
1188
+ }, z.core.$strip>>;
1189
+ caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
1190
+ }, z.core.$strip>>>;
1191
+ }, z.core.$strip>;
1192
+ export type ChapterData = z.infer<typeof ChapterDataSchema>;
381
1193
  /**
382
- * Defines an interface that represents data in a chapter in a commentary.
1194
+ * Defines a Zod schema for information about data in a chapter in a commentary.
383
1195
  */
384
- export interface CommentaryChapterData {
385
- /**
386
- * The number of the chapter.
387
- */
388
- number: number;
389
- /**
390
- * The introduction that the commentary provided to the chapter.
391
- * Not all commentaries provide an introduction to a chapter.
392
- */
393
- introduction?: string;
394
- /**
395
- * The content of the chapter.
396
- */
397
- content: ChapterVerse[];
398
- }
1196
+ export declare const CommentaryChapterDataSchema: z.ZodObject<{
1197
+ number: z.ZodNumber;
1198
+ introduction: z.ZodOptional<z.ZodString>;
1199
+ content: z.ZodArray<z.ZodLazy<z.ZodObject<{
1200
+ type: z.ZodLiteral<"verse">;
1201
+ number: z.ZodNumber;
1202
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1203
+ text: z.ZodString;
1204
+ poem: z.ZodOptional<z.ZodNumber>;
1205
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1206
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1207
+ heading: z.ZodString;
1208
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1209
+ lineBreak: z.ZodLiteral<true>;
1210
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1211
+ noteId: z.ZodNumber;
1212
+ }, z.core.$strip>>]>>;
1213
+ }, z.core.$strip>>>;
1214
+ }, z.core.$strip>;
1215
+ export type CommentaryChapterData = z.infer<typeof CommentaryChapterDataSchema>;
399
1216
  /**
400
- * A union type that represents a single piece of chapter content.
401
- * A piece of chapter content can be one of the following things:
402
- * - A heading.
403
- * - A line break.
404
- * - A verse.
405
- * - A Hebrew Subtitle.
1217
+ * A Zod schema for a heading in a chapter.
406
1218
  */
407
- export type ChapterContent = ChapterHeading | ChapterLineBreak | ChapterVerse | ChapterHebrewSubtitle;
1219
+ export declare const ChapterHeadingSchema: z.ZodObject<{
1220
+ type: z.ZodLiteral<"heading">;
1221
+ content: z.ZodArray<z.ZodString>;
1222
+ }, z.core.$strip>;
1223
+ export type ChapterHeading = z.infer<typeof ChapterHeadingSchema>;
408
1224
  /**
409
- * A heading in a chapter.
1225
+ * A Zod schema for a line break in a chapter.
410
1226
  */
411
- export interface ChapterHeading {
412
- /**
413
- * Indicates that the content represents a heading.
414
- */
415
- type: 'heading';
416
- /**
417
- * The content for the heading.
418
- * If multiple strings are included in the array, they should be concatenated with a space.
419
- */
420
- content: string[];
421
- }
422
- /**
423
- * A line break in a chapter.
424
- */
425
- export interface ChapterLineBreak {
426
- /**
427
- * Indicates that the content represents a line break.
428
- */
429
- type: 'line_break';
430
- }
1227
+ export declare const ChapterLineBreakSchema: z.ZodObject<{
1228
+ type: z.ZodLiteral<"line_break">;
1229
+ }, z.core.$strip>;
1230
+ export type ChapterLineBreak = z.infer<typeof ChapterLineBreakSchema>;
431
1231
  /**
432
- * A Hebrew Subtitle in a chapter.
1232
+ * A Zod schema for a Hebrew Subtitle in a chapter.
433
1233
  * These are often used included as informational content that appeared in the original manuscripts.
434
1234
  * For example, Psalms 49 has the Hebrew Subtitle "To the choirmaster. A Psalm of the Sons of Korah."
435
1235
  */
436
- export interface ChapterHebrewSubtitle {
437
- /**
438
- * Indicates that the content represents a Hebrew Subtitle.
439
- */
440
- type: 'hebrew_subtitle';
441
- /**
442
- * The list of content that is contained in the subtitle.
443
- * Each element in the list could be a string, formatted text, or a footnote reference.
444
- */
445
- content: (string | FormattedText | VerseFootnoteReference)[];
446
- }
1236
+ export declare const ChapterHebrewSubtitleSchema: z.ZodObject<{
1237
+ type: z.ZodLiteral<"hebrew_subtitle">;
1238
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1239
+ text: z.ZodString;
1240
+ poem: z.ZodOptional<z.ZodNumber>;
1241
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1242
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1243
+ noteId: z.ZodNumber;
1244
+ }, z.core.$strip>>]>>;
1245
+ }, z.core.$strip>;
1246
+ export type ChapterHebrewSubtitle = z.infer<typeof ChapterHebrewSubtitleSchema>;
447
1247
  /**
448
- * A verse in a chapter.
1248
+ * A Zod schema for a verse in a chapter.
449
1249
  */
450
- export interface ChapterVerse {
451
- /**
452
- * Indicates that the content is a verse.
453
- */
454
- type: 'verse';
455
- /**
456
- * The number of the verse.
457
- */
458
- number: number;
459
- /**
460
- * The list of content for the verse.
461
- * Each element in the list could be a string, formatted text, or a footnote reference.
462
- */
463
- content: (string | FormattedText | InlineHeading | InlineLineBreak | VerseFootnoteReference)[];
464
- }
1250
+ export declare const ChapterVerseSchema: z.ZodObject<{
1251
+ type: z.ZodLiteral<"verse">;
1252
+ number: z.ZodNumber;
1253
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1254
+ text: z.ZodString;
1255
+ poem: z.ZodOptional<z.ZodNumber>;
1256
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1257
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1258
+ heading: z.ZodString;
1259
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1260
+ lineBreak: z.ZodLiteral<true>;
1261
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1262
+ noteId: z.ZodNumber;
1263
+ }, z.core.$strip>>]>>;
1264
+ }, z.core.$strip>;
1265
+ export type ChapterVerse = z.infer<typeof ChapterVerseSchema>;
465
1266
  /**
466
- * Formatted text. That is, text that is formated in a particular manner.
1267
+ * A union type that represents a single piece of chapter content.
1268
+ * A piece of chapter content can be one of the following things:
1269
+ * - A heading.
1270
+ * - A line break.
1271
+ * - A verse.
1272
+ * - A Hebrew Subtitle.
467
1273
  */
468
- export interface FormattedText {
469
- /**
470
- * The text that is formatted.
471
- */
472
- text: string;
473
- /**
474
- * Whether the text represents a poem.
475
- * The number indicates the level of indent.
476
- *
477
- * Common in Psalms.
478
- */
479
- poem?: number;
480
- /**
481
- * Whether the text represents the Words of Jesus.
482
- */
483
- wordsOfJesus?: boolean;
484
- }
1274
+ export declare const ChapterContentSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
1275
+ type: z.ZodLiteral<"heading">;
1276
+ content: z.ZodArray<z.ZodString>;
1277
+ }, z.core.$strip>, z.ZodObject<{
1278
+ type: z.ZodLiteral<"line_break">;
1279
+ }, z.core.$strip>, z.ZodObject<{
1280
+ type: z.ZodLiteral<"verse">;
1281
+ number: z.ZodNumber;
1282
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1283
+ text: z.ZodString;
1284
+ poem: z.ZodOptional<z.ZodNumber>;
1285
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1286
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1287
+ heading: z.ZodString;
1288
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1289
+ lineBreak: z.ZodLiteral<true>;
1290
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1291
+ noteId: z.ZodNumber;
1292
+ }, z.core.$strip>>]>>;
1293
+ }, z.core.$strip>, z.ZodObject<{
1294
+ type: z.ZodLiteral<"hebrew_subtitle">;
1295
+ content: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodLazy<z.ZodObject<{
1296
+ text: z.ZodString;
1297
+ poem: z.ZodOptional<z.ZodNumber>;
1298
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1299
+ }, z.core.$strip>>, z.ZodLazy<z.ZodObject<{
1300
+ noteId: z.ZodNumber;
1301
+ }, z.core.$strip>>]>>;
1302
+ }, z.core.$strip>], "type">;
485
1303
  /**
486
- * Defines an interface that represents a heading that is embedded in a verse.
1304
+ * A union type that represents a single piece of chapter content.
1305
+ * A piece of chapter content can be one of the following things:
1306
+ * - A heading.
1307
+ * - A line break.
1308
+ * - A verse.
1309
+ * - A Hebrew Subtitle.
487
1310
  */
488
- export interface InlineHeading {
489
- /**
490
- * The text of the heading.
491
- */
492
- heading: string;
493
- }
1311
+ export type ChapterContent = z.infer<typeof ChapterContentSchema>;
494
1312
  /**
495
- * Defines an interface that represents a line break that is embedded in a verse.
1313
+ * A Zod schema for formatted text. That is, text that is formatted in a particular manner.
496
1314
  */
497
- export interface InlineLineBreak {
498
- lineBreak: true;
499
- }
1315
+ export declare const FormattedTextSchema: z.ZodObject<{
1316
+ text: z.ZodString;
1317
+ poem: z.ZodOptional<z.ZodNumber>;
1318
+ wordsOfJesus: z.ZodOptional<z.ZodBoolean>;
1319
+ }, z.core.$strip>;
1320
+ export type FormattedText = z.infer<typeof FormattedTextSchema>;
500
1321
  /**
501
- * A footnote reference in a verse or a Hebrew Subtitle.
1322
+ * A Zod schema for a heading that is embedded in a verse.
502
1323
  */
503
- export interface VerseFootnoteReference {
504
- /**
505
- * The ID of the note.
506
- */
507
- noteId: number;
508
- }
1324
+ export declare const InlineHeadingSchema: z.ZodObject<{
1325
+ heading: z.ZodString;
1326
+ }, z.core.$strip>;
1327
+ export type InlineHeading = z.infer<typeof InlineHeadingSchema>;
509
1328
  /**
510
- * Information about a footnote.
1329
+ * A Zod schema for a line break that is embedded in a verse.
511
1330
  */
512
- export interface ChapterFootnote {
513
- /**
514
- * The ID of the note that is referenced.
515
- */
516
- noteId: number;
517
- /**
518
- * The text of the footnote.
519
- */
520
- text: string;
521
- /**
522
- * The verse reference for the footnote.
523
- */
524
- reference?: {
525
- chapter: number;
526
- verse: number;
527
- };
528
- /**
529
- * The caller that should be used for the footnote.
530
- * For footnotes, a "caller" is the character that is used in the text to reference to footnote.
531
- *
532
- * For example, in the text:
533
- * Hello (a) World
534
- *
535
- * ----
536
- * (a) This is a footnote.
537
- *
538
- * The "(a)" is the caller.
539
- *
540
- * If "+", then the caller should be autogenerated.
541
- * If null, then the caller should be empty.
542
- * If a string, then the caller should be that string.
543
- */
544
- caller: '+' | string | null;
545
- }
1331
+ export declare const InlineLineBreakSchema: z.ZodObject<{
1332
+ lineBreak: z.ZodLiteral<true>;
1333
+ }, z.core.$strip>;
1334
+ export type InlineLineBreak = z.infer<typeof InlineLineBreakSchema>;
1335
+ /**
1336
+ * A Zod schema for a footnote reference in a verse or a Hebrew Subtitle.
1337
+ */
1338
+ export declare const VerseFootnoteReferenceSchema: z.ZodObject<{
1339
+ noteId: z.ZodNumber;
1340
+ }, z.core.$strip>;
1341
+ export type VerseFootnoteReference = z.infer<typeof VerseFootnoteReferenceSchema>;
1342
+ /**
1343
+ * A Zod schema for information about a footnote.
1344
+ */
1345
+ export declare const ChapterFootnoteSchema: z.ZodObject<{
1346
+ noteId: z.ZodNumber;
1347
+ text: z.ZodString;
1348
+ reference: z.ZodOptional<z.ZodObject<{
1349
+ chapter: z.ZodNumber;
1350
+ verse: z.ZodNumber;
1351
+ }, z.core.$strip>>;
1352
+ caller: z.ZodUnion<readonly [z.ZodLiteral<"+">, z.ZodString, z.ZodNull]>;
1353
+ }, z.core.$strip>;
1354
+ export type ChapterFootnote = z.infer<typeof ChapterFootnoteSchema>;
546
1355
  //# sourceMappingURL=common-types.d.ts.map