@youversion/platform-core 1.20.1 → 1.21.0

package/dist/index.d.cts

@@ -1,4 +1,34 @@
 import { z } from 'zod';
+export { a as TransformBibleHtmlOptions, T as TransformedBibleHtml, t as transformBibleHtml } from './browser-DzQ1yOHv.cjs';
+
+declare const SignInWithYouVersionPermission: {
+    readonly bibles: "bibles";
+    readonly highlights: "highlights";
+    readonly votd: "votd";
+    readonly demographics: "demographics";
+    readonly bibleActivity: "bible_activity";
+};
+type SignInWithYouVersionResultProps = {
+    accessToken?: string;
+    expiresIn?: number;
+    refreshToken?: string;
+    idToken?: string;
+    yvpUserId?: string;
+    name?: string;
+    profilePicture?: string;
+    email?: string;
+};
+declare class SignInWithYouVersionResult {
+    readonly accessToken: string | undefined;
+    readonly expiryDate: Date | undefined;
+    readonly refreshToken: string | undefined;
+    readonly idToken: string | undefined;
+    readonly yvpUserId: string | undefined;
+    readonly name: string | undefined;
+    readonly profilePicture: string | undefined;
+    readonly email: string | undefined;
+    constructor({ accessToken, expiresIn, refreshToken, idToken, yvpUserId, name, profilePicture, email, }: SignInWithYouVersionResultProps);
+}
 
 declare const BibleVersionSchema: z.ZodObject<{
     id: z.ZodNumber;
@@ -22,15 +52,12 @@ declare const CanonSchema: z.ZodEnum<{
     new_testament: "new_testament";
     deuterocanon: "deuterocanon";
 }>;
-type Canon = Readonly<z.infer<typeof CanonSchema>>;
 declare const BibleBookIntroSchema: z.ZodObject<{
     id: z.ZodString;
     passage_id: z.ZodString;
     title: z.ZodString;
 }, z.core.$strip>;
 type BibleBookIntro = Readonly<z.infer<typeof BibleBookIntroSchema>>;
-declare const BookUsfmSchema: z.ZodUnion<readonly [...z.ZodLiteral<"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" | "3ES" | "EZA" | "5EZ" | "6EZ" | "DAG" | "PS3" | "2BA" | "LBA" | "JUB" | "ENO" | "1MQ" | "2MQ" | "3MQ" | "REP" | "4BA" | "LAO" | "LKA">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
-type BookUsfm = z.infer<typeof BookUsfmSchema>;
 declare const BibleBookSchema: z.ZodObject<{
     id: z.ZodUnion<readonly [...z.ZodLiteral<"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" | "3ES" | "EZA" | "5EZ" | "6EZ" | "DAG" | "PS3" | "2BA" | "LBA" | "JUB" | "ENO" | "1MQ" | "2MQ" | "3MQ" | "REP" | "4BA" | "LAO" | "LKA">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
     title: z.ZodString;
@@ -207,36 +234,6 @@ interface ApiConfig {
     installationId?: string;
     redirectUri?: string;
 }
-
-declare const SignInWithYouVersionPermission: {
-    readonly bibles: "bibles";
-    readonly highlights: "highlights";
-    readonly votd: "votd";
-    readonly demographics: "demographics";
-    readonly bibleActivity: "bible_activity";
-};
-type SignInWithYouVersionResultProps = {
-    accessToken?: string;
-    expiresIn?: number;
-    refreshToken?: string;
-    idToken?: string;
-    yvpUserId?: string;
-    name?: string;
-    profilePicture?: string;
-    email?: string;
-};
-declare class SignInWithYouVersionResult {
-    readonly accessToken: string | undefined;
-    readonly expiryDate: Date | undefined;
-    readonly refreshToken: string | undefined;
-    readonly idToken: string | undefined;
-    readonly yvpUserId: string | undefined;
-    readonly name: string | undefined;
-    readonly profilePicture: string | undefined;
-    readonly email: string | undefined;
-    constructor({ accessToken, expiresIn, refreshToken, idToken, yvpUserId, name, profilePicture, email, }: SignInWithYouVersionResultProps);
-}
-
 type SignInWithYouVersionPermissionValues = (typeof SignInWithYouVersionPermission)[keyof typeof SignInWithYouVersionPermission];
 interface AuthenticationState {
     readonly isAuthenticated: boolean;
@@ -247,11 +244,6 @@ interface AuthenticationState {
     readonly error: Error | null;
 }
 type AuthenticationScopes = 'profile' | 'email';
-
-/**
- * Legacy type for highlight colors (constants only)
- * Not an API response, so no schema needed
- */
 interface HighlightColor {
     id: number;
     color: string;
@@ -399,12 +391,18 @@ declare class BibleClient {
     /**
      * Fetches a passage (range of verses) from the Bible using the passages endpoint.
      * This is the new API format that returns HTML-formatted content.
+     *
+     * Note: The HTML returned from the API contains inline footnote content that should
+     * be transformed before rendering. Use `transformBibleHtml()` or
+     * `transformBibleHtmlForBrowser()` to clean up the HTML and extract footnotes.
+     *
      * @param versionId The version ID.
      * @param usfm The USFM reference (e.g., "JHN.3.1-2", "GEN.1", "JHN.3.16").
      * @param format The format to return ("html" or "text", default: "html").
      * @param include_headings Whether to include headings in the content.
      * @param include_notes Whether to include notes in the content.
      * @returns The requested BiblePassage object with HTML content.
+     *
      * @example
      * ```ts
      * // Get a single verse
@@ -415,6 +413,10 @@ declare class BibleClient {
      *
      * // Get an entire chapter
      * const chapter = await bibleClient.getPassage(3034, "GEN.1");
+     *
+     * // Transform HTML before rendering
+     * const passage = await bibleClient.getPassage(3034, "JHN.3.16", "html", true, true);
+     * const transformed = transformBibleHtmlForBrowser(passage.content);
      * ```
      */
     getPassage(versionId: number, usfm: string, format?: 'html' | 'text', include_headings?: boolean, include_notes?: boolean): Promise<BiblePassage>;
@@ -724,12 +726,14 @@ declare class YouVersionPlatformConfiguration {
  * a good use-case for a default Bible Version.
  */
 declare const DEFAULT_LICENSE_FREE_BIBLE_VERSION: 3034;
+declare const CANON_IDS: readonly ["old_testament", "new_testament", "deuterocanon"];
 declare const BOOK_IDS: readonly ["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", "3ES", "EZA", "5EZ", "6EZ", "DAG", "PS3", "2BA", "LBA", "JUB", "ENO", "1MQ", "2MQ", "3MQ", "REP", "4BA", "LAO", "LKA"];
-
+type CanonId = (typeof CANON_IDS)[number];
+type KnownBookUsfm = (typeof BOOK_IDS)[number];
 /**
  * @see https://github.com/youversion/usfm-references/blob/main/usfm_references/books.py
  */
-declare const BOOK_CANON: Record<BookUsfm, Canon>;
+declare const BOOK_CANON: Record<KnownBookUsfm, CanonId>;
 
 type AdjacentChapterResult = {
     bookId: string;
@@ -746,4 +750,4 @@ type AdjacentChapterResult = {
  */
 declare function getAdjacentChapter(books: BibleBook[], currentBookId: string, currentChapterId: string, direction: 'next' | 'previous'): AdjacentChapterResult;
 
-export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, DEFAULT_LICENSE_FREE_BIBLE_VERSION, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON, getAdjacentChapter };
+export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, CANON_IDS, type Collection, type CreateHighlight, DEFAULT_LICENSE_FREE_BIBLE_VERSION, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON, getAdjacentChapter };

package/dist/index.d.ts

@@ -1,4 +1,34 @@
 import { z } from 'zod';
+export { a as TransformBibleHtmlOptions, T as TransformedBibleHtml, t as transformBibleHtml } from './browser-DzQ1yOHv.js';
+
+declare const SignInWithYouVersionPermission: {
+    readonly bibles: "bibles";
+    readonly highlights: "highlights";
+    readonly votd: "votd";
+    readonly demographics: "demographics";
+    readonly bibleActivity: "bible_activity";
+};
+type SignInWithYouVersionResultProps = {
+    accessToken?: string;
+    expiresIn?: number;
+    refreshToken?: string;
+    idToken?: string;
+    yvpUserId?: string;
+    name?: string;
+    profilePicture?: string;
+    email?: string;
+};
+declare class SignInWithYouVersionResult {
+    readonly accessToken: string | undefined;
+    readonly expiryDate: Date | undefined;
+    readonly refreshToken: string | undefined;
+    readonly idToken: string | undefined;
+    readonly yvpUserId: string | undefined;
+    readonly name: string | undefined;
+    readonly profilePicture: string | undefined;
+    readonly email: string | undefined;
+    constructor({ accessToken, expiresIn, refreshToken, idToken, yvpUserId, name, profilePicture, email, }: SignInWithYouVersionResultProps);
+}
 
 declare const BibleVersionSchema: z.ZodObject<{
     id: z.ZodNumber;
@@ -22,15 +52,12 @@ declare const CanonSchema: z.ZodEnum<{
     new_testament: "new_testament";
     deuterocanon: "deuterocanon";
 }>;
-type Canon = Readonly<z.infer<typeof CanonSchema>>;
 declare const BibleBookIntroSchema: z.ZodObject<{
     id: z.ZodString;
     passage_id: z.ZodString;
     title: z.ZodString;
 }, z.core.$strip>;
 type BibleBookIntro = Readonly<z.infer<typeof BibleBookIntroSchema>>;
-declare const BookUsfmSchema: z.ZodUnion<readonly [...z.ZodLiteral<"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" | "3ES" | "EZA" | "5EZ" | "6EZ" | "DAG" | "PS3" | "2BA" | "LBA" | "JUB" | "ENO" | "1MQ" | "2MQ" | "3MQ" | "REP" | "4BA" | "LAO" | "LKA">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
-type BookUsfm = z.infer<typeof BookUsfmSchema>;
 declare const BibleBookSchema: z.ZodObject<{
     id: z.ZodUnion<readonly [...z.ZodLiteral<"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" | "3ES" | "EZA" | "5EZ" | "6EZ" | "DAG" | "PS3" | "2BA" | "LBA" | "JUB" | "ENO" | "1MQ" | "2MQ" | "3MQ" | "REP" | "4BA" | "LAO" | "LKA">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
     title: z.ZodString;
@@ -207,36 +234,6 @@ interface ApiConfig {
     installationId?: string;
     redirectUri?: string;
 }
-
-declare const SignInWithYouVersionPermission: {
-    readonly bibles: "bibles";
-    readonly highlights: "highlights";
-    readonly votd: "votd";
-    readonly demographics: "demographics";
-    readonly bibleActivity: "bible_activity";
-};
-type SignInWithYouVersionResultProps = {
-    accessToken?: string;
-    expiresIn?: number;
-    refreshToken?: string;
-    idToken?: string;
-    yvpUserId?: string;
-    name?: string;
-    profilePicture?: string;
-    email?: string;
-};
-declare class SignInWithYouVersionResult {
-    readonly accessToken: string | undefined;
-    readonly expiryDate: Date | undefined;
-    readonly refreshToken: string | undefined;
-    readonly idToken: string | undefined;
-    readonly yvpUserId: string | undefined;
-    readonly name: string | undefined;
-    readonly profilePicture: string | undefined;
-    readonly email: string | undefined;
-    constructor({ accessToken, expiresIn, refreshToken, idToken, yvpUserId, name, profilePicture, email, }: SignInWithYouVersionResultProps);
-}
-
 type SignInWithYouVersionPermissionValues = (typeof SignInWithYouVersionPermission)[keyof typeof SignInWithYouVersionPermission];
 interface AuthenticationState {
     readonly isAuthenticated: boolean;
@@ -247,11 +244,6 @@ interface AuthenticationState {
     readonly error: Error | null;
 }
 type AuthenticationScopes = 'profile' | 'email';
-
-/**
- * Legacy type for highlight colors (constants only)
- * Not an API response, so no schema needed
- */
 interface HighlightColor {
     id: number;
     color: string;
@@ -399,12 +391,18 @@ declare class BibleClient {
     /**
      * Fetches a passage (range of verses) from the Bible using the passages endpoint.
      * This is the new API format that returns HTML-formatted content.
+     *
+     * Note: The HTML returned from the API contains inline footnote content that should
+     * be transformed before rendering. Use `transformBibleHtml()` or
+     * `transformBibleHtmlForBrowser()` to clean up the HTML and extract footnotes.
+     *
      * @param versionId The version ID.
      * @param usfm The USFM reference (e.g., "JHN.3.1-2", "GEN.1", "JHN.3.16").
      * @param format The format to return ("html" or "text", default: "html").
      * @param include_headings Whether to include headings in the content.
      * @param include_notes Whether to include notes in the content.
      * @returns The requested BiblePassage object with HTML content.
+     *
      * @example
      * ```ts
      * // Get a single verse
@@ -415,6 +413,10 @@ declare class BibleClient {
      *
      * // Get an entire chapter
      * const chapter = await bibleClient.getPassage(3034, "GEN.1");
+     *
+     * // Transform HTML before rendering
+     * const passage = await bibleClient.getPassage(3034, "JHN.3.16", "html", true, true);
+     * const transformed = transformBibleHtmlForBrowser(passage.content);
      * ```
      */
     getPassage(versionId: number, usfm: string, format?: 'html' | 'text', include_headings?: boolean, include_notes?: boolean): Promise<BiblePassage>;
@@ -724,12 +726,14 @@ declare class YouVersionPlatformConfiguration {
  * a good use-case for a default Bible Version.
  */
 declare const DEFAULT_LICENSE_FREE_BIBLE_VERSION: 3034;
+declare const CANON_IDS: readonly ["old_testament", "new_testament", "deuterocanon"];
 declare const BOOK_IDS: readonly ["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", "3ES", "EZA", "5EZ", "6EZ", "DAG", "PS3", "2BA", "LBA", "JUB", "ENO", "1MQ", "2MQ", "3MQ", "REP", "4BA", "LAO", "LKA"];
-
+type CanonId = (typeof CANON_IDS)[number];
+type KnownBookUsfm = (typeof BOOK_IDS)[number];
 /**
  * @see https://github.com/youversion/usfm-references/blob/main/usfm_references/books.py
  */
-declare const BOOK_CANON: Record<BookUsfm, Canon>;
+declare const BOOK_CANON: Record<KnownBookUsfm, CanonId>;
 
 type AdjacentChapterResult = {
     bookId: string;
@@ -746,4 +750,4 @@ type AdjacentChapterResult = {
  */
 declare function getAdjacentChapter(books: BibleBook[], currentBookId: string, currentChapterId: string, direction: 'next' | 'previous'): AdjacentChapterResult;
 
-export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, DEFAULT_LICENSE_FREE_BIBLE_VERSION, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON, getAdjacentChapter };
+export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, CANON_IDS, type Collection, type CreateHighlight, DEFAULT_LICENSE_FREE_BIBLE_VERSION, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON, getAdjacentChapter };

package/dist/index.js

@@ -1,3 +1,7 @@
+import {
+  transformBibleHtml
+} from "./chunk-2Z2S2WY3.js";
+
 // src/client.ts
 var ApiClient = class {
   baseURL;
@@ -162,6 +166,7 @@ import { z as z3 } from "zod";
 
 // src/utils/constants.ts
 var DEFAULT_LICENSE_FREE_BIBLE_VERSION = 3034;
+var CANON_IDS = ["old_testament", "new_testament", "deuterocanon"];
 var BOOK_IDS = [
   "GEN",
   "EXO",
@@ -403,7 +408,7 @@ var BibleChapterSchema = z2.object({
 });
 
 // src/schemas/book.ts
-var CanonSchema = z3.enum(["old_testament", "new_testament", "deuterocanon"]);
+var CanonSchema = z3.enum(CANON_IDS);
 var BibleBookIntroSchema = z3.object({
   /** Intro identifier */
   id: z3.string(),
@@ -746,12 +751,18 @@ var BibleClient = class _BibleClient {
   /**
    * Fetches a passage (range of verses) from the Bible using the passages endpoint.
    * This is the new API format that returns HTML-formatted content.
+   *
+   * Note: The HTML returned from the API contains inline footnote content that should
+   * be transformed before rendering. Use `transformBibleHtml()` or
+   * `transformBibleHtmlForBrowser()` to clean up the HTML and extract footnotes.
+   *
    * @param versionId The version ID.
    * @param usfm The USFM reference (e.g., "JHN.3.1-2", "GEN.1", "JHN.3.16").
    * @param format The format to return ("html" or "text", default: "html").
    * @param include_headings Whether to include headings in the content.
    * @param include_notes Whether to include notes in the content.
    * @returns The requested BiblePassage object with HTML content.
+   *
    * @example
    * ```ts
    * // Get a single verse
@@ -762,6 +773,10 @@ var BibleClient = class _BibleClient {
    *
    * // Get an entire chapter
    * const chapter = await bibleClient.getPassage(3034, "GEN.1");
+   *
+   * // Transform HTML before rendering
+   * const passage = await bibleClient.getPassage(3034, "JHN.3.16", "html", true, true);
+   * const transformed = transformBibleHtmlForBrowser(passage.content);
    * ```
    */
   async getPassage(versionId, usfm, format = "html", include_headings, include_notes) {
@@ -1694,6 +1709,7 @@ export {
   BOOK_CANON,
   BOOK_IDS,
   BibleClient,
+  CANON_IDS,
   DEFAULT_LICENSE_FREE_BIBLE_VERSION,
   HighlightsClient,
   LanguagesClient,
@@ -1705,5 +1721,6 @@ export {
   YouVersionAPIUsers,
   YouVersionPlatformConfiguration,
   YouVersionUserInfo,
-  getAdjacentChapter
+  getAdjacentChapter,
+  transformBibleHtml
 };

package/dist/server.cjs

@@ -0,0 +1,275 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/server.ts
+var server_exports = {};
+__export(server_exports, {
+  transformBibleHtml: () => transformBibleHtml2
+});
+module.exports = __toCommonJS(server_exports);
+
+// src/bible-html-transformer-server.ts
+var import_linkedom = require("linkedom");
+
+// src/bible-html-transformer.ts
+var NON_BREAKING_SPACE = "\xA0";
+var FOOTNOTE_KEY_ATTR = "data-footnote-key";
+var NEEDS_SPACE_BEFORE = /^[^\s.,;:!?)}\]'"'»›]/;
+var ALLOWED_TAGS = /* @__PURE__ */ new Set([
+  "DIV",
+  "P",
+  "SPAN",
+  "SUP",
+  "SUB",
+  "EM",
+  "STRONG",
+  "I",
+  "B",
+  "SMALL",
+  "BR",
+  "SECTION",
+  "TABLE",
+  "THEAD",
+  "TBODY",
+  "TR",
+  "TD",
+  "TH"
+]);
+var DROP_ENTIRELY_TAGS = /* @__PURE__ */ new Set([
+  "SCRIPT",
+  "STYLE",
+  "IFRAME",
+  "OBJECT",
+  "EMBED",
+  "SVG",
+  "MATH",
+  "FORM",
+  "INPUT",
+  "BUTTON",
+  "TEXTAREA",
+  "SELECT",
+  "TEMPLATE",
+  "LINK",
+  "META",
+  "BASE",
+  "NOSCRIPT"
+]);
+var ALLOWED_ATTRS = /* @__PURE__ */ new Set(["class", "v", "colspan", "rowspan", "dir", "usfm"]);
+function sanitizeBibleHtmlDocument(doc) {
+  const root = doc.body ?? doc.documentElement;
+  for (const el of Array.from(root.querySelectorAll("*"))) {
+    const tag = el.tagName;
+    if (DROP_ENTIRELY_TAGS.has(tag)) {
+      el.remove();
+      continue;
+    }
+    if (!ALLOWED_TAGS.has(tag)) {
+      el.replaceWith(...Array.from(el.childNodes));
+      continue;
+    }
+    for (const attr of Array.from(el.attributes)) {
+      const name = attr.name.toLowerCase();
+      if (name.startsWith("on")) {
+        el.removeAttribute(attr.name);
+        continue;
+      }
+      if (!ALLOWED_ATTRS.has(name) && !name.startsWith("data-")) {
+        el.removeAttribute(attr.name);
+      }
+    }
+  }
+}
+function wrapVerseContent(doc) {
+  function wrapParagraphContent(doc2, paragraph, verseNum) {
+    const children = Array.from(paragraph.childNodes);
+    if (children.length === 0) return;
+    const wrapper = doc2.createElement("span");
+    wrapper.className = "yv-v";
+    wrapper.setAttribute("v", verseNum);
+    const firstChild = children[0];
+    if (firstChild) {
+      paragraph.insertBefore(wrapper, firstChild);
+    }
+    children.forEach((child) => {
+      wrapper.appendChild(child);
+    });
+  }
+  function wrapParagraphsUntilBoundary(doc2, verseNum, startParagraph, endParagraph) {
+    if (!startParagraph) return;
+    let currentParagraph = startParagraph.nextElementSibling;
+    while (currentParagraph && currentParagraph !== endParagraph) {
+      const isHeading = currentParagraph.classList.contains("yv-h") || currentParagraph.matches(
+        ".s1, .s2, .s3, .s4, .ms, .ms1, .ms2, .ms3, .ms4, .mr, .sp, .sr, .qa, .r"
+      );
+      if (isHeading) {
+        currentParagraph = currentParagraph.nextElementSibling;
+        continue;
+      }
+      if (currentParagraph.querySelector(".yv-v[v]")) break;
+      if (currentParagraph.classList.contains("p") || currentParagraph.tagName === "P") {
+        wrapParagraphContent(doc2, currentParagraph, verseNum);
+      }
+      currentParagraph = currentParagraph.nextElementSibling;
+    }
+  }
+  function handleParagraphWrapping(doc2, currentParagraph, nextParagraph, verseNum) {
+    if (!currentParagraph) return;
+    if (!nextParagraph) {
+      wrapParagraphsUntilBoundary(doc2, verseNum, currentParagraph);
+      return;
+    }
+    if (currentParagraph !== nextParagraph) {
+      wrapParagraphsUntilBoundary(doc2, verseNum, currentParagraph, nextParagraph);
+    }
+  }
+  function processVerseMarker(marker, index, markers) {
+    const verseNum = marker.getAttribute("v");
+    if (!verseNum) return;
+    const nextMarker = markers[index + 1];
+    const nodesToWrap = collectNodesBetweenMarkers(marker, nextMarker);
+    if (nodesToWrap.length === 0) return;
+    const currentParagraph = marker.closest(".p, p, div.p");
+    const nextParagraph = nextMarker?.closest(".p, p, div.p") || null;
+    const doc2 = marker.ownerDocument;
+    wrapNodesInVerse(marker, verseNum, nodesToWrap);
+    handleParagraphWrapping(doc2, currentParagraph, nextParagraph, verseNum);
+  }
+  function wrapNodesInVerse(marker, verseNum, nodes) {
+    const wrapper = marker.ownerDocument.createElement("span");
+    wrapper.className = "yv-v";
+    wrapper.setAttribute("v", verseNum);
+    const firstNode = nodes[0];
+    if (firstNode) {
+      marker.parentNode?.insertBefore(wrapper, firstNode);
+    }
+    nodes.forEach((node) => {
+      wrapper.appendChild(node);
+    });
+    marker.remove();
+  }
+  function shouldStopCollecting(node, endMarker) {
+    if (node === endMarker) return true;
+    if (endMarker && node.nodeType === 1 && node.contains(endMarker)) return true;
+    return false;
+  }
+  function shouldSkipNode(node) {
+    return node.nodeType === 1 && node.classList.contains("yv-h");
+  }
+  function collectNodesBetweenMarkers(startMarker, endMarker) {
+    const nodes = [];
+    let current = startMarker.nextSibling;
+    while (current && !shouldStopCollecting(current, endMarker)) {
+      if (shouldSkipNode(current)) {
+        current = current.nextSibling;
+        continue;
+      }
+      nodes.push(current);
+      current = current.nextSibling;
+    }
+    return nodes;
+  }
+  const verseMarkers = Array.from(doc.querySelectorAll(".yv-v[v]"));
+  verseMarkers.forEach(processVerseMarker);
+}
+function assignFootnoteKeys(doc) {
+  let introIdx = 0;
+  doc.querySelectorAll(".yv-n.f").forEach((fn) => {
+    const verseNum = fn.closest(".yv-v[v]")?.getAttribute("v");
+    fn.setAttribute(FOOTNOTE_KEY_ATTR, verseNum ?? `intro-${introIdx++}`);
+  });
+}
+function replaceFootnotesWithAnchors(doc, footnotes) {
+  for (const fn of footnotes) {
+    const key = fn.getAttribute(FOOTNOTE_KEY_ATTR);
+    if (!key) continue;
+    const prev = fn.previousSibling;
+    const next = fn.nextSibling;
+    const prevText = prev?.textContent ?? "";
+    const nextText = next?.textContent ?? "";
+    const prevNeedsSpace = prevText.length > 0 && !/\s$/.test(prevText);
+    const nextNeedsSpace = nextText.length > 0 && NEEDS_SPACE_BEFORE.test(nextText);
+    if (prevNeedsSpace && nextNeedsSpace && fn.parentNode) {
+      fn.parentNode.insertBefore(doc.createTextNode(" "), fn);
+    }
+    const anchor = doc.createElement("span");
+    anchor.setAttribute("data-verse-footnote", key);
+    anchor.setAttribute("data-verse-footnote-content", fn.innerHTML);
+    fn.replaceWith(anchor);
+  }
+}
+function addNbspToVerseLabels(doc) {
+  doc.querySelectorAll(".yv-vlbl").forEach((label) => {
+    const text = label.textContent || "";
+    if (!text.endsWith(NON_BREAKING_SPACE)) {
+      label.textContent = text + NON_BREAKING_SPACE;
+    }
+  });
+}
+function fixIrregularTables(doc) {
+  doc.querySelectorAll("table").forEach((table) => {
+    const rows = table.querySelectorAll("tr");
+    if (rows.length === 0) return;
+    let maxColumns = 0;
+    rows.forEach((row) => {
+      let count = 0;
+      row.querySelectorAll("td, th").forEach((cell) => {
+        count += parseInt(cell.getAttribute("colspan") || "1", 10);
+      });
+      maxColumns = Math.max(maxColumns, count);
+    });
+    if (maxColumns > 1) {
+      rows.forEach((row) => {
+        const cells = row.querySelectorAll("td, th");
+        if (cells.length === 1) {
+          const existing = parseInt(cells[0].getAttribute("colspan") || "1", 10);
+          if (existing < maxColumns) {
+            cells[0].setAttribute("colspan", maxColumns.toString());
+          }
+        }
+      });
+    }
+  });
+}
+function transformBibleHtml(html, options) {
+  const doc = options.parseHtml(html);
+  sanitizeBibleHtmlDocument(doc);
+  wrapVerseContent(doc);
+  assignFootnoteKeys(doc);
+  const footnotes = Array.from(doc.querySelectorAll(".yv-n.f"));
+  replaceFootnotesWithAnchors(doc, footnotes);
+  addNbspToVerseLabels(doc);
+  fixIrregularTables(doc);
+  const transformedHtml = options.serializeHtml(doc);
+  return { html: transformedHtml };
+}
+
+// src/bible-html-transformer-server.ts
+function transformBibleHtml2(html) {
+  return transformBibleHtml(html, {
+    parseHtml: (h) => new import_linkedom.DOMParser().parseFromString(
+      `<html><body>${h}</body></html>`,
+      "text/html"
+    ),
+    serializeHtml: (doc) => doc.body.innerHTML
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  transformBibleHtml
+});