@youversion/platform-core 0.4.1

package/dist/index.d.ts

@@ -0,0 +1,737 @@
+import { z } from 'zod';
+
+declare const BibleVersionSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    abbreviation: z.ZodString;
+    copyright_long: z.ZodString;
+    copyright_short: z.ZodString;
+    info: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    publisher_url: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
+    language_tag: z.ZodString;
+    local_abbreviation: z.ZodString;
+    local_title: z.ZodString;
+    title: z.ZodString;
+    books: z.ZodArray<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>>]>>;
+    youversion_deep_link: z.ZodURL;
+}, z.core.$strip>;
+type BibleVersion = z.infer<typeof BibleVersionSchema>;
+
+declare const CanonSchema: z.ZodEnum<{
+    ot: "ot";
+    nt: "nt";
+    dc: "dc";
+}>;
+type Canon = z.infer<typeof CanonSchema>;
+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;
+    abbreviation: z.ZodOptional<z.ZodString>;
+    canon: z.ZodEnum<{
+        ot: "ot";
+        nt: "nt";
+        dc: "dc";
+    }>;
+    chapters: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+type BibleBook = z.infer<typeof BibleBookSchema>;
+type CANON = z.infer<typeof CanonSchema>;
+
+declare const BibleChapterSchema: z.ZodObject<{
+    id: z.ZodString;
+    book_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>>]>;
+    passage_id: z.ZodString;
+    title: z.ZodString;
+    verses: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<`${number}`, string>>>>;
+}, z.core.$strip>;
+type BibleChapter = z.infer<typeof BibleChapterSchema>;
+
+declare const BibleVerseSchema: z.ZodObject<{
+    id: z.ZodString;
+    book_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>>]>;
+    chapter_id: z.ZodString;
+    passage_id: z.ZodString;
+    reference: z.ZodString;
+}, z.core.$strip>;
+type BibleVerse = z.infer<typeof BibleVerseSchema>;
+
+declare const BiblePassageSchema: z.ZodObject<{
+    id: z.ZodString;
+    content: z.ZodString;
+    bible_id: z.ZodNumber;
+    human_reference: z.ZodString;
+}, z.core.$strip>;
+type BiblePassage = z.infer<typeof BiblePassageSchema>;
+
+declare const VOTDSchema: z.ZodObject<{
+    day: z.ZodNumber;
+    passage_id: z.ZodString;
+}, z.core.$strip>;
+type VOTD = z.infer<typeof VOTDSchema>;
+
+declare const BibleIndexVerseSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+}, z.core.$strip>;
+type BibleIndexVerse = z.infer<typeof BibleIndexVerseSchema>;
+declare const BibleIndexChapterSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+    verses: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type BibleIndexChapter = z.infer<typeof BibleIndexChapterSchema>;
+declare const BibleIndexBookSchema: 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;
+    full_title: z.ZodString;
+    abbreviation: z.ZodString;
+    canon: z.ZodEnum<{
+        ot: "ot";
+        nt: "nt";
+        dc: "dc";
+    }>;
+    chapters: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+        verses: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type BibleIndexBook = z.infer<typeof BibleIndexBookSchema>;
+declare const _BibleIndexSchema: z.ZodObject<{
+    text_direction: z.ZodString;
+    books: z.ZodArray<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;
+        full_title: z.ZodString;
+        abbreviation: z.ZodString;
+        canon: z.ZodEnum<{
+            ot: "ot";
+            nt: "nt";
+            dc: "dc";
+        }>;
+        chapters: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+            verses: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                title: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type BibleIndex = z.infer<typeof _BibleIndexSchema>;
+
+declare const LanguageSchema: z.ZodObject<{
+    id: z.ZodString;
+    language: z.ZodString;
+    script: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    script_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    aliases: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    display_names: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    scripts: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    variants: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    countries: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    text_direction: z.ZodOptional<z.ZodEnum<{
+        ltr: "ltr";
+        rtl: "rtl";
+    }>>;
+    writing_population: z.ZodOptional<z.ZodNumber>;
+    speaking_population: z.ZodOptional<z.ZodNumber>;
+    default_bible_version_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+type Language = z.infer<typeof LanguageSchema>;
+
+declare const _UserSchema: z.ZodObject<{
+    avatar_url: z.ZodString;
+    first_name: z.ZodString;
+    id: z.ZodUUID;
+    last_name: z.ZodString;
+}, z.core.$strip>;
+type User = z.infer<typeof _UserSchema>;
+
+declare const _HighlightSchema: z.ZodObject<{
+    version_id: z.ZodNumber;
+    passage_id: z.ZodString;
+    color: z.ZodString;
+}, z.core.$strip>;
+type Highlight = z.infer<typeof _HighlightSchema>;
+declare const _CreateHighlightSchema: z.ZodObject<{
+    version_id: z.ZodNumber;
+    passage_id: z.ZodString;
+    color: z.ZodString;
+}, z.core.$strip>;
+type CreateHighlight = z.infer<typeof _CreateHighlightSchema>;
+
+/**
+ * Generic Collection type for paginated responses
+ */
+type Collection<T> = {
+    data: T[];
+    next_page_token: string | null;
+    total_size?: number;
+};
+
+interface ApiConfig {
+    baseUrl?: string;
+    appId: string;
+    timeout?: number;
+    hostEnv?: string;
+    version?: string;
+    installationId?: string;
+    redirectUri?: string;
+}
+
+declare const SignInWithYouVersionPermission: {
+    readonly bibles: "bibles";
+    readonly highlights: "highlights";
+    readonly votd: "votd";
+    readonly demographics: "demographics";
+    readonly bibleActivity: "bible_activity";
+};
+declare class SignInWithYouVersionResult {
+    readonly accessToken: string | null;
+    readonly permissions: SignInWithYouVersionPermissionValues[];
+    readonly errorMsg: string | null;
+    readonly yvpUserId: string | null;
+    constructor(url: URL);
+}
+
+type SignInWithYouVersionPermissionValues = (typeof SignInWithYouVersionPermission)[keyof typeof SignInWithYouVersionPermission];
+interface AuthenticationState {
+    isAuthenticated: boolean;
+    isLoading: boolean;
+    accessToken: string | null;
+    result: SignInWithYouVersionResult | null;
+    error: Error | null;
+}
+
+/**
+ * Legacy type for highlight colors (constants only)
+ * Not an API response, so no schema needed
+ */
+interface HighlightColor {
+    id: number;
+    color: string;
+    label: string;
+}
+
+type QueryParams = Record<string, string | number | boolean>;
+type RequestData = Record<string, string | number | boolean | object>;
+type RequestHeaders = Record<string, string>;
+/**
+ * ApiClient is a lightweight HTTP client for interacting with the API using fetch.
+ * It provides convenient methods for GET and POST requests with typed responses.
+ */
+declare class ApiClient {
+    private baseURL;
+    private timeout;
+    private defaultHeaders;
+    config: ApiConfig;
+    /**
+     * Creates an instance of ApiClient.
+     *
+     * @param config - The API configuration object containing baseUrl, timeout, and appId.
+     */
+    constructor(config: ApiConfig);
+    /**
+     * Builds the query string from parameters
+     */
+    private buildQueryString;
+    /**
+     * Makes an HTTP request with timeout support
+     */
+    private request;
+    /**
+     * Sends a GET request to the specified API path with optional query parameters.
+     *
+     * @typeParam T - The expected response type.
+     * @param path - The API endpoint path (relative to baseURL).
+     * @param params - Optional query parameters to include in the request.
+     * @returns A promise resolving to the response data of type T.
+     */
+    get<T>(path: string, params?: QueryParams, headers?: RequestHeaders): Promise<T>;
+    /**
+     * Sends a POST request to the specified API path with optional data and query parameters.
+     *
+     * @typeParam T - The expected response type.
+     * @param path - The API endpoint path (relative to baseURL).
+     * @param data - Optional request body data to send.
+     * @param params - Optional query parameters to include in the request.
+     * @returns A promise resolving to the response data of type T.
+     */
+    post<T>(path: string, data?: RequestData, params?: QueryParams): Promise<T>;
+    /**
+     * Sends a DELETE request to the specified API path with optional query parameters.
+     *
+     * @typeParam T - The expected response type.
+     * @param path - The API endpoint path (relative to baseURL).
+     * @param params - Optional query parameters to include in the request.
+     * @returns A promise resolving to the response data of type T (may be empty for 204 responses).
+     */
+    delete<T>(path: string, params?: QueryParams): Promise<T>;
+}
+
+/**
+ * Client for interacting with Bible API endpoints.
+ */
+declare class BibleClient {
+    private client;
+    private versionIdSchema;
+    private bookSchema;
+    private chapterSchema;
+    private verseSchema;
+    private languageRangesSchema;
+    private booleanSchema;
+    /**
+     * Creates a new BibleClient instance.
+     * @param client The API client to use for requests.
+     */
+    constructor(client: ApiClient);
+    private get rootPath();
+    /**
+     * Fetches a collection of Bible versions filtered by language ranges.
+     *
+     * @param language_ranges - A comma-separated list of language codes or ranges to filter the versions (required).
+     * @param license_id - Optional license ID to filter versions by license.
+     * @returns A promise that resolves to a collection of BibleVersion objects.
+     */
+    getVersions(language_ranges: string, license_id?: string | number): Promise<Collection<BibleVersion>>;
+    /**
+     * Fetches a Bible version by its ID.
+     * @param id The version ID.
+     * @returns The requested BibleVersion object.
+     */
+    getVersion(id: number): Promise<BibleVersion>;
+    /**
+     * Fetches all books for a given Bible version.
+     * @param versionId The version ID.
+     * @param canon Optional canon filter ('ot', 'nt', 'deuterocanon').
+     * @returns An array of BibleBook objects.
+     */
+    getBooks(versionId: number, canon?: CANON): Promise<Collection<BibleBook>>;
+    /**
+     * Fetches a specific book by USFM code for a given version.
+     * @param versionId The version ID.
+     * @param book The Book Identifier code of the book.
+     * @returns The requested BibleBook object.
+     */
+    getBook(versionId: number, book: string): Promise<BibleBook>;
+    /**
+     * Fetches all chapters for a specific book in a version.
+     * @param versionId The version ID.
+     * @param book The Book Identifier code of the book.
+     * @returns An array of BibleChapter objects.
+     */
+    getChapters(versionId: number, book: string): Promise<Collection<BibleChapter>>;
+    /**
+     * Fetches a specific chapter for a book in a version.
+     * @param versionId The version ID.
+     * @param book The Book Identifier code of the book (3 characters, e.g., "MAT").
+     * @param chapter The chapter number
+     * @returns The requested BibleChapter object.
+     */
+    getChapter(versionId: number, book: string, chapter: number): Promise<BibleChapter>;
+    /**
+     * Fetches all verses for a specific chapter in a book and version.
+     * @param versionId The version ID.
+     * @param book The Book Identifier code of the book (3 characters, e.g., "MAT").
+     * @param chapter The chapter number.
+     * @returns An array of BibleVerse objects.
+     */
+    getVerses(versionId: number, book: string, chapter: number): Promise<Collection<BibleVerse>>;
+    /**
+     * Fetches a specific verse from a chapter, book, and version.
+     * @param versionId The version ID.
+     * @param book The Book Identifier code of the book (3 characters, e.g., "MAT").
+     * @param chapter The chapter number.
+     * @param verse The verse number.
+     * @returns The requested BibleVerse object.
+     */
+    getVerse(versionId: number, book: string, chapter: number, verse: number): Promise<BibleVerse>;
+    /**
+     * Fetches a passage (range of verses) from the Bible using the passages endpoint.
+     * This is the new API format that returns HTML-formatted content.
+     * @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
+     * const verse = await bibleClient.getPassage(111, "JHN.3.16");
+     *
+     * // Get a range of verses
+     * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
+     *
+     * // Get an entire chapter
+     * const chapter = await bibleClient.getPassage(111, "GEN.1");
+     * ```
+     */
+    getPassage(versionId: number, usfm: string, format?: 'html' | 'text', include_headings?: boolean, include_notes?: boolean): Promise<BiblePassage>;
+    /**
+     * Fetches the indexing structure for a Bible version.
+     * @param versionId The version ID.
+     * @returns The BibleIndex object containing full hierarchy of books, chapters, and verses.
+     */
+    getIndex(versionId: number): Promise<BibleIndex>;
+    /**
+     * Fetches the verse of the day calendar for an entire year.
+     * @returns A collection of VOTD objects for all days of the year.
+     */
+    getAllVOTDs(): Promise<Collection<VOTD>>;
+    /**
+     * Fetches the passage_id for the Verse Of The Day.
+     * @param day The day of the year (1-366).
+     * @returns The day of the year and the passage_id for that day of the year
+     * @example
+     * ```ts
+     * // Get the passageId for the verse of the first day of the year.
+     * const passageId = await bibleClient.getVOTD(1);
+     *
+     * // Get the passageId for the verse of the 100th day of the year.
+     * const passageId = await bibleClient.getVOTD(100);
+     * ```
+     */
+    getVOTD(day: number): Promise<VOTD>;
+}
+
+/**
+ * Options for getting languages collection.
+ */
+type GetLanguagesOptions = {
+    page_size?: number;
+    page_token?: string;
+    country: string;
+};
+/**
+ * Client for interacting with Languages API endpoints.
+ */
+declare class LanguagesClient {
+    private client;
+    private languageIdSchema;
+    private countrySchema;
+    /**
+     * Creates a new LanguagesClient instance.
+     * @param client The API client to use for requests.
+     */
+    constructor(client: ApiClient);
+    private get rootPath();
+    /**
+     * Fetches a collection of languages supported in the Platform.
+     * @param options Query parameters for pagination and filtering (country is required).
+     * @returns A collection of Language objects.
+     */
+    getLanguages(options: GetLanguagesOptions): Promise<Collection<Language>>;
+    /**
+     * Fetches details about a specific language in the Platform.
+     * @param languageId The BCP 47 language code (optionally including script, e.g., "en" or "sr-Latn").
+     * @returns The requested Language object.
+     */
+    getLanguage(languageId: string): Promise<Language>;
+}
+
+/**
+ * Options for getting highlights.
+ */
+type GetHighlightsOptions = {
+    version_id?: number;
+    passage_id?: string;
+};
+/**
+ * Options for deleting highlights.
+ */
+type DeleteHighlightOptions = {
+    version_id?: number;
+};
+/**
+ * Client for interacting with Highlights API endpoints.
+ * Note: All endpoints require OAuth authentication with appropriate scopes.
+ */
+declare class HighlightsClient {
+    private client;
+    private versionIdSchema;
+    private passageIdSchema;
+    private colorSchema;
+    /**
+     * Creates a new HighlightsClient instance.
+     * @param client The API client to use for requests.
+     */
+    constructor(client: ApiClient);
+    private get rootPath();
+    /**
+     * Gets the authentication token, either from the provided parameter or from the platform configuration.
+     * @param lat Optional explicit long access token. If not provided, retrieves from YouVersionPlatformConfiguration.
+     * @returns The authentication token.
+     * @throws Error if no token is available.
+     */
+    private getAuthToken;
+    private validateVersionId;
+    private validatePassageId;
+    private validateColor;
+    /**
+     * Fetches a collection of highlights for a user.
+     * The response will return a color per verse without ranges.
+     * Requires OAuth with read_highlights scope.
+     * @param options Query parameters for filtering highlights.
+     * @param lat Optional long access token. If not provided, retrieves from YouVersionPlatformConfiguration.
+     * @returns A collection of Highlight objects.
+     */
+    getHighlights(options?: GetHighlightsOptions, lat?: string): Promise<Collection<Highlight>>;
+    /**
+     * Creates or updates a highlight on a passage.
+     * Verse ranges may be used in the passage_id attribute.
+     * Requires OAuth with write_highlights scope.
+     * @param data The highlight data to create or update.
+     * @param lat Optional long access token. If not provided, retrieves from YouVersionPlatformConfiguration.
+     * @returns The created or updated Highlight object.
+     */
+    createHighlight(data: CreateHighlight, lat?: string): Promise<Highlight>;
+    /**
+     * Clears highlights for a passage.
+     * Requires OAuth with write_highlights scope.
+     * @param passageId The passage identifier (USFM format, e.g., "MAT.1.1" or "MAT.1.1-5").
+     * @param options Optional query parameters including bible_id.
+     * @param lat Optional long access token. If not provided, retrieves from YouVersionPlatformConfiguration.
+     * @returns Promise that resolves when highlights are deleted (204 response).
+     */
+    deleteHighlight(passageId: string, options?: DeleteHighlightOptions, lat?: string): Promise<void>;
+}
+
+/**
+ * Client for authentication-related API calls.
+ */
+declare class AuthClient {
+    private client;
+    /**
+     * Creates an instance of AuthClient.
+     * @param client - The ApiClient instance to use for requests.
+     */
+    constructor(client: ApiClient);
+    /**
+     * Retrieves the current authenticated user.
+     *
+     * @param lat - The long access token (LAT) used for authentication.
+     * @returns A promise that resolves to the authenticated User.
+     */
+    getUser(lat: string): Promise<User>;
+}
+
+/**
+ * Platform-agnostic authentication strategy interface
+ *
+ * Implementations should handle platform-specific authentication flows
+ * and return the callback URL containing the authentication result.
+ */
+interface AuthenticationStrategy {
+    /**
+     * Opens the authentication flow and returns the callback URL
+     *
+     * @param authUrl - The YouVersion authorization URL to open
+     * @returns Promise that resolves to the callback URL with auth result
+     * @throws Error if authentication fails or is cancelled
+     */
+    authenticate(authUrl: URL): Promise<URL>;
+}
+/**
+ * Registry for platform-specific authentication strategies
+ *
+ * This singleton registry manages the current authentication strategy
+ * and ensures only one strategy is active at a time.
+ */
+declare class AuthenticationStrategyRegistry {
+    private static strategy;
+    /**
+     * Registers a platform-specific authentication strategy
+     *
+     * @param strategy - The authentication strategy to register
+     * @throws Error if strategy is null, undefined, or missing required methods
+     */
+    static register(strategy: AuthenticationStrategy): void;
+    /**
+     * Gets the currently registered authentication strategy
+     *
+     * @returns The registered authentication strategy
+     * @throws Error if no strategy has been registered
+     */
+    static get(): AuthenticationStrategy;
+    /**
+     * Checks if a strategy is currently registered
+     *
+     * @returns true if a strategy is registered, false otherwise
+     */
+    static isRegistered(): boolean;
+    /**
+     * Resets the registry by removing the current strategy
+     *
+     * This method is primarily intended for testing scenarios
+     * where you need to clean up between test cases.
+     */
+    static reset(): void;
+}
+
+/**
+ * Abstract storage strategy for auth-related data (callbacks, return URLs).
+ * Implementations can use different mechanisms (sessionStorage, memory, etc.)
+ *
+ * WARNING: Session storage has known XSS vulnerabilities. An attacker that gains
+ * script execution access (via XSS) can read all values in sessionStorage. Consider
+ * using a secure, HTTP-only cookie mechanism for production applications.
+ */
+interface StorageStrategy {
+    setItem(key: string, value: string): void;
+    getItem(key: string): string | null;
+    removeItem(key: string): void;
+    clear(): void;
+}
+/**
+ * Default storage strategy using the browser's sessionStorage.
+ * This provides temporary storage for authentication state during a single session.
+ *
+ * SECURITY WARNING: SessionStorage is vulnerable to XSS attacks. If an attacker
+ * can inject JavaScript into your application, they can access all sessionStorage values.
+ * For production applications handling sensitive authentication tokens, consider:
+ * 1. Using secure, HTTP-only cookies instead
+ * 2. Storing tokens in memory only (with redirection to re-authenticate on page reload)
+ * 3. Using a custom storage backend that implements additional security measures
+ */
+declare class SessionStorageStrategy implements StorageStrategy {
+    setItem(key: string, value: string): void;
+    getItem(key: string): string | null;
+    removeItem(key: string): void;
+    clear(): void;
+}
+/**
+ * In-memory storage strategy that stores data in a Map.
+ * This storage is cleared when the page is refreshed.
+ * Provides better XSS protection than sessionStorage but requires re-authentication on page reload.
+ */
+declare class MemoryStorageStrategy implements StorageStrategy {
+    private store;
+    setItem(key: string, value: string): void;
+    getItem(key: string): string | null;
+    removeItem(key: string): void;
+    clear(): void;
+}
+
+declare class WebAuthenticationStrategy implements AuthenticationStrategy {
+    private redirectUri;
+    private callbackPath;
+    private timeout;
+    private storage;
+    private static pendingAuthResolve;
+    private static pendingAuthReject;
+    private static timeoutId;
+    constructor(options?: {
+        redirectUri?: string;
+        callbackPath?: string;
+        timeout?: number;
+        storage?: StorageStrategy;
+    });
+    authenticate(authUrl: URL): Promise<URL>;
+    /**
+     * Call this method when your app loads to handle the redirect callback
+     */
+    static handleCallback(callbackPath?: string): boolean;
+    /**
+     * Clean up pending authentication state
+     */
+    static cleanup(): void;
+    /**
+     * Retrieve stored callback result if available
+     */
+    static getStoredCallback(): URL | null;
+    private authenticateWithRedirect;
+}
+
+interface YouVersionUserInfoJSON {
+    first_name?: string;
+    last_name?: string;
+    id?: string;
+    avatar_url?: string;
+}
+declare class YouVersionUserInfo {
+    readonly firstName?: string;
+    readonly lastName?: string;
+    readonly userId?: string;
+    readonly avatarUrlFormat?: string;
+    constructor(data: YouVersionUserInfoJSON);
+    getAvatarUrl(width?: number, height?: number): URL | null;
+    get avatarUrl(): URL | null;
+}
+
+declare class YouVersionAPIUsers {
+    /**
+     * Presents the YouVersion login flow to the user and returns the login result upon completion.
+     *
+     * This function authenticates the user with YouVersion, requesting the specified required and optional permissions.
+     * The function returns a promise that resolves when the user completes or cancels the login flow,
+     * returning the login result containing the authorization code and granted permissions.
+     *
+     * @param requiredPermissions - The set of permissions that must be granted by the user for successful login.
+     * @param optionalPermissions - The set of permissions that will be requested from the user but are not required for successful login.
+     * @returns A Promise resolving to a SignInWithYouVersionResult containing the authorization code and granted permissions upon successful login.
+     * @throws An error if authentication fails or is cancelled by the user.
+     */
+    static signIn(requiredPermissions: Set<SignInWithYouVersionPermissionValues>, optionalPermissions: Set<SignInWithYouVersionPermissionValues>): Promise<SignInWithYouVersionResult>;
+    static signOut(): void;
+    /**
+     * Retrieves user information for the authenticated user using the provided access token.
+     *
+     * This function fetches the user's profile information from the YouVersion API, decoding it into a YouVersionUserInfo model.
+     *
+     * @param accessToken - The access token obtained from the login process.
+     * @returns A Promise resolving to a YouVersionUserInfo object containing the user's profile information.
+     * @throws An error if the URL is invalid, the network request fails, or the response cannot be decoded.
+     */
+    static userInfo(accessToken: string): Promise<YouVersionUserInfo>;
+}
+
+declare class YouVersionAPI {
+    static addStandardHeaders(url: URL): Request;
+}
+
+declare class URLBuilder {
+    private static get baseURL();
+    static authURL(appId: string, requiredPermissions?: Set<SignInWithYouVersionPermissionValues>, optionalPermissions?: Set<SignInWithYouVersionPermissionValues>): URL;
+    static userURL(accessToken: string): URL;
+}
+
+declare class YouVersionPlatformConfiguration {
+    private static _appId;
+    private static _installationId;
+    private static _accessToken;
+    private static _apiHost;
+    private static _isPreviewMode;
+    private static _previewUserInfo;
+    private static getOrSetInstallationId;
+    static get appId(): string | null;
+    static set appId(value: string | null);
+    static get installationId(): string;
+    static set installationId(value: string | null);
+    static setAccessToken(token: string | null): void;
+    static get accessToken(): string | null;
+    static get apiHost(): string;
+    static set apiHost(value: string);
+    static get isPreviewMode(): boolean;
+    static set isPreviewMode(value: boolean);
+    static get previewUserInfo(): YouVersionUserInfo | null;
+    static set previewUserInfo(value: YouVersionUserInfo | null);
+}
+
+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"];
+
+/**
+ * @see https://github.com/youversion/usfm-references/blob/main/usfm_references/books.py
+ */
+declare const BOOK_CANON: Record<BookUsfm, Canon>;
+
+export { ApiClient, type ApiConfig, AuthClient, type AuthenticationState, type AuthenticationStrategy, AuthenticationStrategyRegistry, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, URLBuilder, type User, type VOTD, WebAuthenticationStrategy, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON };