@helloao/tools 0.3.0 → 0.4.0

package/dist/types/generation/dataset.d.ts

@@ -1,4 +1,4 @@
-import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, InputFile, Translation, TranslationBook, TranslationBookChapter, Dataset as CommonDataset, DatasetBook, DatasetBookChapter } from './common-types.js';
+import { Commentary, CommentaryBook, CommentaryBookChapter, CommentaryProfile, InputFile, Translation, TranslationBook, TranslationBookChapter, Dataset as CommonDataset, DatasetBook, DatasetBookChapter, DatasetPerson, DatasetPlace, DatasetEvent, DatasetPeopleGroup } from './common-types.js';
 import { ParseMessage } from '../parser/types.js';
 export declare const DATASET_VERSION = 1;
 /**
@@ -69,6 +69,22 @@ export interface DatasetCommentaryProfile extends CommentaryProfile {
 }
 export interface DatasetDataset extends CommonDataset {
     books: DatasetDatasetBook[];
+    /**
+     * The list of people that are contained in the dataset.
+     */
+    people?: DatasetPerson[];
+    /**
+     * The list of places that are contained in the dataset.
+     */
+    places?: DatasetPlace[];
+    /**
+     * The list of events that are contained in the dataset.
+     */
+    events?: DatasetEvent[];
+    /**
+     * The list of people groups that are contained in the dataset.
+     */
+    peopleGroups?: DatasetPeopleGroup[];
 }
 export interface DatasetDatasetBook extends DatasetBook {
     chapters: DatasetBookChapter[];

package/dist/types/generation/theographic.d.ts

@@ -0,0 +1,64 @@
+import { Dataset } from './common-types.js';
+import { DatasetDataset } from './dataset.js';
+/**
+ * The dataset information for the Theographic Bible Metadata dataset.
+ * See https://github.com/robertrouse/theographic-bible-metadata
+ */
+export declare const THEOGRAPHIC_DATASET: Dataset;
+/**
+ * Defines an interface for a raw Theographic record.
+ * The Theographic JSON files are Airtable exports, where each record has an Airtable record ID and a map of fields.
+ */
+export interface TheographicRecord {
+    /**
+     * The Airtable record ID of the record. e.g. "recO5ToygNrV47m4M"
+     */
+    id: string;
+    /**
+     * The fields of the record.
+     */
+    fields: {
+        [key: string]: any;
+    };
+}
+/**
+ * The parsed contents of the Theographic JSON files that are needed
+ * to generate the dataset.
+ */
+export interface TheographicFiles {
+    books: TheographicRecord[];
+    verses: TheographicRecord[];
+    people: TheographicRecord[];
+    places: TheographicRecord[];
+    events: TheographicRecord[];
+    peopleGroups: TheographicRecord[];
+}
+/**
+ * Maps Theographic OSIS book names to USFM book IDs.
+ */
+export declare const osisBookMap: Map<string, "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" | "TOB" | "JDT" | "ESG" | "WIS" | "SIR" | "BAR" | "LJE" | "S3Y" | "SUS" | "BEL" | "1MA" | "2MA" | "3MA" | "4MA" | "1ES" | "2ES" | "MAN" | "PS2" | "ODA" | "PSS" | "EZA" | "5EZ" | "6EZ" | "DAG" | "PS3" | "2BA" | "LBA" | "JUB" | "ENO" | "1MQ" | "2MQ" | "3MQ" | "REP" | "4BA" | "LAO">;
+/**
+ * Slugifies the given string so that it can be used as an entity ID.
+ * @param str The string to slugify.
+ */
+export declare function slugify(str: string): string;
+/**
+ * Removes markdown links from the given text, keeping only the link text.
+ * For example, "[Esther 1:10](/esth#Esth.1.10)" becomes "Esther 1:10".
+ * @param text The text to clean.
+ */
+export declare function stripMarkdownLinks(text: string): string;
+/**
+ * Generates a dataset from the given Theographic Bible Metadata files.
+ *
+ * The returned dataset contains the people, places, events, and people groups
+ * from the Theographic data, with all cross-entity relationships resolved to entity IDs
+ * and all verse links resolved to Bible verse references.
+ *
+ * The transformation is deterministic: the same input always produces the same output.
+ *
+ * @param files The parsed Theographic JSON files.
+ * @param dataset The dataset information to use. Defaults to {@link THEOGRAPHIC_DATASET}.
+ */
+export declare function generateDatasetFromTheographic(files: TheographicFiles, dataset?: Dataset): DatasetDataset;
+//# sourceMappingURL=theographic.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helloao/tools",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A set of tools for managing HelloAO's Free Bible API",
   "type": "module",
   "main": "./dist/cjs/index.cjs",