free-use-bible-api 0.1.2 → 0.2.0

package/dist/types/FreeUseBibleApi.d.ts

@@ -0,0 +1,247 @@
+import type { ApiAvailableDatasets, ApiAvailableTranslations, ApiCommentaryBook, ApiCommentaryBookChapter, ApiDatasetBook, ApiDatasetBookChapter, ApiDatasetBooks, ApiTranslationBook, ApiTranslationBookChapter, ApiTranslationBooks, ApiTranslationComplete, ChapterVerse } from './types.gen.js';
+/**
+ * Options for the FreeUseBibleApi class.
+ */
+export interface FreeUseBibleApiOptions {
+    /**
+     * The API endpoint to use for the requests. If not provided, the default endpoint will be used.
+     */
+    endpoint?: string;
+    /**
+     * Whether to cache responses in memory.
+     *
+     * Defaults to `true`.
+     */
+    useCache?: boolean;
+}
+/**
+ * Options for the `getChapterText` method.
+ */
+export interface GetChapterTextOptions {
+    /**
+     * Whether to omit verse numbers from the returned text.
+     * Defaults to `false`.
+     */
+    omitVerseNumbers?: boolean;
+    /**
+     * Whether to omit the chapter reference from the returned text.
+     */
+    omitReference?: boolean;
+}
+/**
+ * Options for the `getVerseText` method.
+ */
+export interface GetVerseTextOptions {
+    /**
+     * Whether to omit the chapter reference from the returned text.
+     */
+    omitReference?: boolean;
+}
+/**
+ * A reference to a specific verse in a Bible translation, commentary, or dataset.
+ */
+export interface VerseReference {
+    /**
+     * The chapter number of the reference. This should be a positive integer.
+     */
+    chapter: number;
+    /**
+     * The verse number of the reference.
+     *
+     * If omitted, then the reference refers to the entire chapter rather than a specific verse.
+     */
+    verse?: number;
+    /**
+     * The ending verse number of the reference, for references that span multiple verses. This should be greater than or equal to the `verse` property if it is provided.
+     */
+    endVerse?: number;
+    /**
+     * The ending chapter number of the reference, for references that span multiple chapters. This should be greater than or equal to the `chapter` property if it is provided.
+     */
+    endChapter?: number;
+}
+/**
+ * A client for interacting with the [Free Use Bible API](https://bible.helloao.org/).
+ *
+ * This API provides access to a large collection of Bible translations, commentaries, and datasets that are free to use.
+ */
+export declare class FreeUseBibleApi {
+    endpoint: string;
+    private _responseCache;
+    private _useCache;
+    constructor(options?: FreeUseBibleApiOptions);
+    /**
+     * Gets the list of available Bible translations from the API.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getAvailableTranslations(endpoint?: string): Promise<ApiAvailableTranslations>;
+    /**
+     * Gets the complete content of a specific Bible translation.
+     *
+     * The results of this endpoint are very large, so the response is not cached.
+     * @param translation The ID of the translation to get the complete content for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getCompleteTranslation(translation: string, endpoint?: string): Promise<ApiTranslationComplete>;
+    /**
+     * Gets the list of available Bible commentaries from the API.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getAvailableCommentaries(endpoint?: string): Promise<ApiAvailableTranslations>;
+    /**
+     * Gets the list of available datasets from the API.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getAvailableDatasets(endpoint?: string): Promise<ApiAvailableDatasets>;
+    /**
+     * Gets the list of books for a given Bible translation.
+     * @param translation The ID of the translation to get the books for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getTranslationBooks(translation: string, endpoint?: string): Promise<ApiTranslationBooks>;
+    /**
+     * Gets the list of books for a given Bible commentary.
+     * @param commentary The ID of the commentary to get the books for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getCommentaryBooks(commentary: string, endpoint?: string): Promise<ApiTranslationBooks>;
+    /**
+     * Gets the list of books for a given dataset.
+     * @param dataset The ID of the dataset to get the books for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getDatasetBooks(dataset: string, endpoint?: string): Promise<ApiDatasetBooks>;
+    /**
+     * Gets the content of a specific chapter of a specific book for a specific Bible translation.
+     * @param translation The ID of the translation to get the chapter for.
+     * @param book The ID of the book to get the chapter for.
+     * @param chapter The chapter number to get.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getTranslationBookChapter(translation: string, book: string, chapter: number | string, endpoint?: string): Promise<ApiTranslationBookChapter>;
+    /**
+     * Gets the content of a specific chapter of a specific book for a specific Bible commentary.
+     * @param commentary The ID of the commentary to get the chapter for.
+     * @param book The ID of the book to get the chapter for.
+     * @param chapter The chapter number to get.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getCommentaryBookChapter(commentary: string, book: string, chapter: number | string, endpoint?: string): Promise<ApiTranslationBookChapter>;
+    /**
+     * Gets the content of a specific chapter of a specific book for a specific dataset.
+     * @param dataset The ID of the dataset to get the chapter for.
+     * @param book The ID of the book to get the chapter for.
+     * @param chapter The chapter number to get.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     */
+    getDatasetBookChapter(dataset: string, book: string, chapter: number | string, endpoint?: string): Promise<ApiDatasetBookChapter>;
+    /**
+     * Gets the next chapter for a given chapter, if available.
+     * @param chapter The chapter to get the next chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The next chapter, or null if there is no next chapter.
+     */
+    getNextChapter(chapter: ApiCommentaryBookChapter, endpoint?: string): Promise<ApiCommentaryBookChapter | null>;
+    /**
+     * Gets the next chapter for a given chapter, if available.
+     * @param chapter The chapter to get the next chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The next chapter, or null if there is no next chapter.
+     */
+    getNextChapter(chapter: ApiTranslationBookChapter, endpoint?: string): Promise<ApiTranslationBookChapter | null>;
+    /**
+     * Gets the next chapter for a given chapter, if available.
+     * @param chapter The chapter to get the next chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The next chapter, or null if there is no next chapter.
+     */
+    getNextChapter(chapter: ApiDatasetBookChapter, endpoint?: string): Promise<ApiDatasetBookChapter | null>;
+    /**
+     * Gets the previous chapter for a given chapter, if available.
+     * @param chapter The chapter to get the previous chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The previous chapter, or null if there is no previous chapter.
+     */
+    getPreviousChapter(chapter: ApiCommentaryBookChapter, endpoint?: string): Promise<ApiCommentaryBookChapter | null>;
+    /**
+     * Gets the previous chapter for a given chapter, if available.
+     * @param chapter The chapter to get the previous chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The previous chapter, or null if there is no previous chapter.
+     */
+    getPreviousChapter(chapter: ApiTranslationBookChapter, endpoint?: string): Promise<ApiTranslationBookChapter | null>;
+    /**
+     * Gets the previous chapter for a given chapter, if available.
+     * @param chapter The chapter to get the previous chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The previous chapter, or null if there is no previous chapter.
+     */
+    getPreviousChapter(chapter: ApiDatasetBookChapter, endpoint?: string): Promise<ApiDatasetBookChapter | null>;
+    /**
+     * Gets the first chapter for a given book, if available.
+     * @param book The book to get the first chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The first chapter, or null if there is no first chapter.
+     */
+    getFirstChapter(book: ApiCommentaryBook, endpoint?: string): Promise<ApiCommentaryBookChapter | null>;
+    /**
+     * Gets the first chapter for a given book, if available.
+     * @param book The book to get the first chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The first chapter, or null if there is no first chapter.
+     */
+    getFirstChapter(book: ApiTranslationBook, endpoint?: string): Promise<ApiTranslationBookChapter>;
+    /**
+     * Gets the first chapter for a given book, if available.
+     * @param book The book to get the first chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The first chapter, or null if there is no first chapter.
+     */
+    getFirstChapter(book: ApiDatasetBook, endpoint?: string): Promise<ApiDatasetBookChapter>;
+    /**
+     * Gets the last chapter for a given book, if available.
+     * @param book The book to get the last chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The last chapter, or null if there is no last chapter.
+     */
+    getLastChapter(book: ApiCommentaryBook, endpoint?: string): Promise<ApiCommentaryBookChapter | null>;
+    /**
+     * Gets the last chapter for a given book, if available.
+     * @param book The book to get the last chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The last chapter, or null if there is no last chapter.
+     */
+    getLastChapter(book: ApiTranslationBook, endpoint?: string): Promise<ApiTranslationBookChapter>;
+    /**
+     * Gets the last chapter for a given book, if available.
+     * @param book The book to get the last chapter for.
+     * @param endpoint The API endpoint to use for the request. If not provided, the default endpoint will be used.
+     * @returns The last chapter, or null if there is no last chapter.
+     */
+    getLastChapter(book: ApiDatasetBook, endpoint?: string): Promise<ApiDatasetBookChapter>;
+    /**
+     * Formats a verse reference as a human-readable string.
+     *
+     * e.g. Genesis 1:1-2, John 3:16, Exodus 20-22, etc.
+     *
+     * @param book The book that the reference is for.
+     * @param reference The reference to format.
+     */
+    formatReference(book: ApiTranslationBook, reference: VerseReference): string;
+    /**
+     * Gets the text for a verse.
+     * @param verse The verse to get the text for.
+     * @param options Options for getting the verse text.
+     */
+    getVerseText(verse: ChapterVerse): string;
+    /**
+     * Gets the verse text for the given chapter.
+     * By default, the returned text includes markers for verse numbers and a reference to the chapter, but these can be omitted by passing options to the `options` parameter.
+     * @param chapter The chapter to get the text for.
+     * @param options Options for getting the chapter text.
+     */
+    getChapterVerseText(chapter: ApiTranslationBookChapter, options?: GetChapterTextOptions): string;
+    private _getJson;
+    private _buildUrl;
+}
+//# sourceMappingURL=FreeUseBibleApi.d.ts.map

package/dist/types/index.d.ts

@@ -1,4 +1,3 @@
-export * from './runtime';
-export * from './apis/index';
-export * from './models/index';
+export * from './FreeUseBibleApi.js';
+export * from './types.gen.js';
 //# sourceMappingURL=index.d.ts.map