waha-shared 1.0.263 → 1.0.264

package/README.md

@@ -1,10 +1,67 @@
-# Waha Shared Assets
+# Waha Shared
 
-Several of Waha's other projects require data, types, functions, and translations from the main repo. Specifically:
+Shared data, types, functions, and assets used across multiple Waha projects:
 
 - [waha-upload](https://github.com/kingdomstrategies/waha-upload)
 - [waha-web](https://github.com/kingdomstrategies/waha-web)
 - [waha-website](https://github.com/kingdomstrategies/waha-website)
 - [waha-dashboard](https://github.com/kingdomstrategies/waha-dashboard)
+- [waha-video-generation](https://github.com/kingdomstrategies/waha-video-generation)
 
-This package contains all of that shared data in one place so it can be easily imported into those projects.
+This package is published to npm as `waha-shared` and consumed by those projects as a dependency.
+
+## Directory Structure
+
+```
+shared/
+├── types/          # TypeScript type definitions (Zod-based)
+├── functions/      # Utility functions (language info, Bible data, sets, etc.)
+├── data/           # JSON data files with Zod validation schemas
+├── assets/         # Fonts, icons, and React components (logos, set icons)
+├── translations/   # Raw translation JSON files from Crowdin
+├── dist/           # Built output (do not edit directly)
+└── package.json
+```
+
+## How Data Works
+
+Each subdirectory in `data/` follows a consistent pattern:
+
+```
+data/languages/
+├── languages.json        # Raw data
+├── languages.zod.ts      # Zod schema defining the shape
+├── languages.schema.json # JSON Schema (auto-generated)
+└── index.ts              # Validates JSON against Zod and exports typed data (auto-generated)
+```
+
+## Type Generation Pipeline
+
+Types flow through a pipeline managed by `yarn prep`:
+
+```
+Zod schema (.zod.ts) and raw data file (.json)
+  → JSON Schema (.schema.json)
+  → Python Pydantic models
+  → Python data constants
+  → TypeScript index.ts
+```
+
+When you modify a `.zod.ts` file, run `yarn prep` from the repo root to regenerate everything downstream.
+
+## Building & Publishing
+
+```bash
+yarn update
+```
+
+This will update the `dist` folder, commit changes, and publish to the npm registry.
+
+The `dist/` directory is the build output — never edit files in it directly.
+
+## Adding New Data
+
+1. Create a new directory under `data/`, e.g. `data/myNewData/`
+2. Add the raw JSON file: `myNewData.json`
+3. Define the Zod schema: `myNewData.zod.ts`
+4. Run `yarn prep` to auto-generate the JSON schema, Python types, Python data, and index file

package/dist/data/areas/areas.schema.json

@@ -1,10 +1,9 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "minItems": 1,
@@ -48,20 +47,12 @@
             "description": "Longitude coordinate for the area center point"
           }
         },
-        "required": [
-          "name",
-          "id",
-          "lat",
-          "lng"
-        ],
+        "required": ["name", "id", "lat", "lng"],
         "additionalProperties": false,
         "description": "A geographic area with identification, coordinates, and display information"
       },
       "description": "Schema for geographic areas with coordinates and metadata"
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/areas/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.areas = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const areas_zod_1 = require("./areas.zod");
 const data = require('./areas.json');
 exports.areas = areas_zod_1.Areas.parse(data.data);

package/dist/data/aslTimestamps/aslTimestamps.schema.json

@@ -1,10 +1,9 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "array",
@@ -30,9 +29,7 @@
             "minItems": 2,
             "maxItems": 2,
             "type": "array",
-            "items": {
-              "type": "string"
-            },
+            "items": { "type": "string" },
             "description": "The start and end verse IDs for this section (e.g., GEN.1.1, GEN.2.4)"
           },
           "verses": {
@@ -61,29 +58,16 @@
                   "description": "The verse ID (e.g., GEN.1.1)"
                 }
               },
-              "required": [
-                "chapter",
-                "timestamp",
-                "verse",
-                "verseId"
-              ],
+              "required": ["chapter", "timestamp", "verse", "verseId"],
               "additionalProperties": false
             },
             "description": "Array of verse timing information"
           }
         },
-        "required": [
-          "bookId",
-          "chapters",
-          "section",
-          "verses"
-        ],
+        "required": ["bookId", "chapters", "section", "verses"],
         "additionalProperties": false
       }
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/aslTimestamps/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.aslTimestamps = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const aslTimestamps_zod_1 = require("./aslTimestamps.zod");
 const data = require('./aslTimestamps.json');
 exports.aslTimestamps = aslTimestamps_zod_1.AslTimestamps.parse(data.data);

package/dist/data/bibleAudios/bibleAudios.schema.json

@@ -1,38 +1,26 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "bibleAudioId": {
-            "type": "string"
-          },
+          "bibleAudioId": { "type": "string" },
           "audioSource": {
             "type": "object",
             "properties": {
               "source": {
                 "type": "string",
-                "enum": [
-                  "dbl",
-                  "youVersion",
-                  "bibleBrain",
-                  "custom"
-                ]
+                "enum": ["dbl", "youVersion", "bibleBrain", "custom"]
               },
-              "sourceId": {
-                "type": "string"
-              }
+              "sourceId": { "type": "string" }
             },
-            "required": [
-              "source"
-            ],
+            "required": ["source"],
             "additionalProperties": false
           },
           "canDownload": {
@@ -48,17 +36,10 @@
             "description": "Star refers to adding a <star> string before the first line passed to mms forced alignment. Disabling it means that there is not any content read out before the start of verse 1. Most translations read out names of chapters or section headings, which is why adding <star> is the default behavior."
           }
         },
-        "required": [
-          "bibleAudioId",
-          "audioSource",
-          "canDownload"
-        ],
+        "required": ["bibleAudioId", "audioSource", "canDownload"],
         "additionalProperties": false
       }
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/bibleAudios/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bibleAudios = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const bibleAudios_zod_1 = require("./bibleAudios.zod");
 const data = require('./bibleAudios.json');
 exports.bibleAudios = bibleAudios_zod_1.BibleAudios.parse(data.data);

package/dist/data/bibleBooks/bibleBooks.schema.json

@@ -1,20 +1,16 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "name": {
-            "type": "string",
-            "description": "The name of the book."
-          },
+          "name": { "type": "string", "description": "The name of the book." },
           "title": {
             "type": "string",
             "description": "The title of the book."
@@ -28,17 +24,10 @@
             "items": {
               "type": "object",
               "properties": {
-                "id": {
-                  "type": "string"
-                },
-                "verses": {
-                  "type": "number"
-                }
+                "id": { "type": "string" },
+                "verses": { "type": "number" }
               },
-              "required": [
-                "id",
-                "verses"
-              ],
+              "required": ["id", "verses"],
               "additionalProperties": false
             },
             "description": "An array of chapter identifiers for the book."
@@ -113,9 +102,7 @@
           },
           "nameAlternates": {
             "type": "array",
-            "items": {
-              "type": "string"
-            },
+            "items": { "type": "string" },
             "description": "Alternative names for the book."
           }
         },
@@ -138,8 +125,5 @@
       }
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/bibleBooks/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bibleBooks = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const bibleBooks_zod_1 = require("./bibleBooks.zod");
 const data = require('./bibleBooks.json');
 exports.bibleBooks = bibleBooks_zod_1.BibleBooks.parse(data.data);

package/dist/data/bibleChaptersList/bibleChaptersList.schema.json

@@ -1,10 +1,9 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "array",
@@ -15,8 +14,5 @@
       "description": "List of all Bible chapter IDs"
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/bibleChaptersList/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bibleChaptersList = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const bibleChaptersList_zod_1 = require("./bibleChaptersList.zod");
 const data = require('./bibleChaptersList.json');
 exports.bibleChaptersList = bibleChaptersList_zod_1.BibleChaptersList.parse(data.data);

package/dist/data/bibleStatuses/bibleStatuses.schema.json

@@ -1,16 +1,13 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "object",
-      "propertyNames": {
-        "type": "string"
-      },
+      "propertyNames": { "type": "string" },
       "additionalProperties": {
         "type": "object",
         "properties": {
@@ -37,28 +34,15 @@
           },
           "bookNames": {
             "type": "object",
-            "propertyNames": {
-              "type": "string",
-              "pattern": "^[A-Z0-9]{3}$"
-            },
-            "additionalProperties": {
-              "type": "string"
-            }
+            "propertyNames": { "type": "string", "pattern": "^[A-Z0-9]{3}$" },
+            "additionalProperties": { "type": "string" }
           }
         },
-        "required": [
-          "text",
-          "audio",
-          "timings",
-          "bookNames"
-        ],
+        "required": ["text", "audio", "timings", "bookNames"],
         "additionalProperties": false
       },
       "description": "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."
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/bibleStatuses/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bibleStatuses = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const bibleStatuses_zod_1 = require("./bibleStatuses.zod");
 const data = require('./bibleStatuses.json');
 exports.bibleStatuses = bibleStatuses_zod_1.BibleStatuses.parse(data.data);

package/dist/data/bibleTexts/bibleTexts.schema.json

@@ -1,19 +1,16 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "bibleTextId": {
-            "type": "string"
-          },
+          "bibleTextId": { "type": "string" },
           "name": {
             "type": "string",
             "description": "The name of the bible translation in its own language."
@@ -62,29 +59,17 @@
                   "usx"
                 ]
               },
-              "sourceId": {
-                "type": "string"
-              }
+              "sourceId": { "type": "string" }
             },
-            "required": [
-              "source"
-            ],
+            "required": ["source"],
             "additionalProperties": false,
             "description": "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."
           }
         },
-        "required": [
-          "bibleTextId",
-          "name",
-          "languageId",
-          "textSource"
-        ],
+        "required": ["bibleTextId", "name", "languageId", "textSource"],
         "additionalProperties": false
       }
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/bibleTexts/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bibleTexts = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const bibleTexts_zod_1 = require("./bibleTexts.zod");
 const data = require('./bibleTexts.json');
 exports.bibleTexts = bibleTexts_zod_1.BibleTexts.parse(data.data);

package/dist/data/clones/clones.schema.json

@@ -1,31 +1,19 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "array",
       "items": {
         "type": "object",
         "properties": {
-          "appId": {
-            "type": "string",
-            "pattern": "^[a-z]*$"
-          },
-          "appIdCaps": {
-            "type": "string",
-            "pattern": "^[A-Z]*$"
-          },
-          "appName": {
-            "type": "string"
-          },
-          "color": {
-            "type": "string",
-            "pattern": "^#[0-9A-Fa-f]{6}$"
-          },
+          "appId": { "type": "string", "pattern": "^[a-z]*$" },
+          "appIdCaps": { "type": "string", "pattern": "^[A-Z]*$" },
+          "appName": { "type": "string" },
+          "color": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" },
           "icon": {
             "type": "string",
             "pattern": "^src\\/assets\\/clones\\/[A-Za-z\\-\\_]*\\.png$"
@@ -36,10 +24,7 @@
           },
           "languages": {
             "type": "array",
-            "items": {
-              "type": "string",
-              "pattern": "^[a-z]{3}$"
-            }
+            "items": { "type": "string", "pattern": "^[a-z]{3}$" }
           },
           "linkAndroid": {
             "type": "string",
@@ -69,8 +54,5 @@
       }
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/clones/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.clones = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const clones_zod_1 = require("./clones.zod");
 const data = require('./clones.json');
 exports.clones = clones_zod_1.Clones.parse(data.data);

package/dist/data/countries/countries.schema.json

@@ -1,17 +1,13 @@
 {
+  "description": "This file is auto-generated by scripts/prep. Do not edit manually.",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
   "properties": {
-    "$schema": {
-      "type": "string"
-    },
+    "$schema": { "type": "string" },
     "data": {
       "$schema": "https://json-schema.org/draft/2020-12/schema",
       "type": "object",
-      "propertyNames": {
-        "type": "string",
-        "pattern": "^[A-Z]{2}$"
-      },
+      "propertyNames": { "type": "string", "pattern": "^[A-Z]{2}$" },
       "additionalProperties": {
         "type": "object",
         "properties": {
@@ -56,10 +52,7 @@
                     "description": "Northeast longitude coordinate"
                   }
                 },
-                "required": [
-                  "lat",
-                  "lon"
-                ],
+                "required": ["lat", "lon"],
                 "additionalProperties": false
               },
               "sw": {
@@ -78,33 +71,20 @@
                     "description": "Southwest longitude coordinate"
                   }
                 },
-                "required": [
-                  "lat",
-                  "lon"
-                ],
+                "required": ["lat", "lon"],
                 "additionalProperties": false
               }
             },
-            "required": [
-              "ne",
-              "sw"
-            ],
+            "required": ["ne", "sw"],
             "additionalProperties": false,
             "description": "Bounding box coordinates for the country"
           }
         },
-        "required": [
-          "name",
-          "areaId",
-          "boundingBox"
-        ],
+        "required": ["name", "areaId", "boundingBox"],
         "additionalProperties": false
       },
       "description": "A mapping of country codes to country information including name, area, and bounding box coordinates"
     }
   },
-  "required": [
-    "$schema",
-    "data"
-  ]
+  "required": ["$schema", "data"]
 }

package/dist/data/countries/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.countries = void 0;
+// This file is auto-generated by scripts/prep. Do not edit manually.
 const countries_zod_1 = require("./countries.zod");
 const data = require('./countries.json');
 exports.countries = countries_zod_1.Countries.parse(data.data);