free-use-bible-api 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 AO Lab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,139 @@
+# Free Use Bible API
+
+The Free Use Bible API provides access to over 1000 Bible translations in hundreds of languages.
+
+This package is an auto-generated TypeScript and JavaScript client for the public API hosted at:
+
+- https://bible.helloao.org
+
+## Installation
+
+Install with your preferred package manager:
+
+```bash
+npm install free-use-bible-api
+```
+
+```bash
+pnpm add free-use-bible-api
+```
+
+```bash
+yarn add free-use-bible-api
+```
+
+## Quick Start
+
+Create a client and point it at the production API:
+
+```ts
+import { Configuration, DefaultApi } from 'free-use-bible-api';
+
+const config = new Configuration({
+	basePath: 'https://bible.helloao.org',
+});
+
+const api = new DefaultApi(config);
+```
+
+## Translation Usage Guide
+
+This section covers the most common translation flow:
+
+1. Get available translations.
+2. Pick a translation ID.
+3. Get books for that translation.
+4. Fetch a chapter.
+5. Optionally fetch the full translation payload.
+
+### 1. Get Available Translations
+
+```ts
+import { Configuration, FreeUseBibleApi } from 'free-use-bible-api';
+
+const api = new FreeUseBibleApi(
+	new Configuration({ basePath: 'https://bible.helloao.org' })
+);
+
+const result = await api.getAvailableTranslations();
+
+console.log('Total translations:', result.translations.length);
+console.log('First translation:', result.translations[0]);
+```
+
+### 2. Get Books For A Translation
+
+Use a translation ID from the previous step, for example `BSB`:
+
+```ts
+const books = await api.getTranslationBooks({
+	translation: 'BSB',
+});
+
+console.log('Books in translation:', books.books.length);
+console.log('First book:', books.books[0]);
+```
+
+### 3. Get A Translation Chapter
+
+Use a USFM book ID and chapter number:
+
+```ts
+import { BookId } from 'free-use-bible-api';
+
+const chapter = await api.getTranslationBookChapter({
+	translation: 'BSB',
+	book: BookId.GEN,
+	chapter: 1,
+});
+
+console.log('Chapter number:', chapter.chapter.number);
+console.log('Verse count:', chapter.numberOfVerses);
+```
+
+### 4. Get A Complete Translation
+
+Some workflows need the entire translation document in one call:
+
+```ts
+const complete = await api.getTranslationComplete({
+	translation: 'BSB',
+});
+
+console.log('Translation:', complete.translation.id);
+console.log('Book count:', complete.books.length);
+```
+
+## Direct HTTP Examples For Translations
+
+If you do not want to use the SDK, these translation endpoints are available directly:
+
+- GET `/api/available_translations.json`
+- GET `/api/{translation}/books.json`
+- GET `/api/{translation}/{book}/{chapter}.json`
+- GET `/api/{translation}/complete.json`
+
+Example requests:
+
+```bash
+curl https://bible.helloao.org/api/available_translations.json
+curl https://bible.helloao.org/api/BSB/books.json
+curl https://bible.helloao.org/api/BSB/GEN/1.json
+```
+
+## Error Handling
+
+A 404 response usually means one of these values is invalid:
+
+- translation
+- book
+- chapter
+
+Use available translations and books responses to drive your UI selections and reduce bad requests.
+
+## Notes
+
+- This client uses fetch under the hood.
+- In modern Node.js versions, fetch is available globally.
+- For custom environments, pass a custom fetch implementation in `Configuration`.
+

package/dist/cjs/index.cjs

@@ -0,0 +1,27 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var free_use_bible_api_exports = {};
+module.exports = __toCommonJS(free_use_bible_api_exports);
+__reExport(free_use_bible_api_exports, require("./runtime"), module.exports);
+__reExport(free_use_bible_api_exports, require("./apis/index"), module.exports);
+__reExport(free_use_bible_api_exports, require("./models/index"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./runtime"),
+  ...require("./apis/index"),
+  ...require("./models/index")
+});
+//# sourceMappingURL=index.cjs.map

package/dist/esm/apis/DefaultApi.js

@@ -0,0 +1,416 @@
+"use strict";
+import * as runtime from "../runtime";
+import {
+  ApiAvailableCommentariesFromJSON
+} from "../models/ApiAvailableCommentaries";
+import {
+  ApiAvailableDatasetsFromJSON
+} from "../models/ApiAvailableDatasets";
+import {
+  ApiAvailableTranslationsFromJSON
+} from "../models/ApiAvailableTranslations";
+import {
+  ApiCommentaryBookChapterFromJSON
+} from "../models/ApiCommentaryBookChapter";
+import {
+  ApiCommentaryBooksFromJSON
+} from "../models/ApiCommentaryBooks";
+import {
+  ApiDatasetBookChapterFromJSON
+} from "../models/ApiDatasetBookChapter";
+import {
+  ApiDatasetBooksFromJSON
+} from "../models/ApiDatasetBooks";
+import {
+  ApiTranslationBookChapterFromJSON
+} from "../models/ApiTranslationBookChapter";
+import {
+  ApiTranslationBooksFromJSON
+} from "../models/ApiTranslationBooks";
+import {
+  ApiTranslationCompleteFromJSON
+} from "../models/ApiTranslationComplete";
+export class DefaultApi extends runtime.BaseAPI {
+  /**
+   * Creates request options for getAvailableCommentaries without sending the request
+   */
+  async getAvailableCommentariesRequestOpts() {
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/available_commentaries.json`;
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the list of available commentaries.
+   */
+  async getAvailableCommentariesRaw(initOverrides) {
+    const requestOptions = await this.getAvailableCommentariesRequestOpts();
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiAvailableCommentariesFromJSON(jsonValue));
+  }
+  /**
+   * Get the list of available commentaries.
+   */
+  async getAvailableCommentaries(initOverrides) {
+    const response = await this.getAvailableCommentariesRaw(initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getAvailableDatasets without sending the request
+   */
+  async getAvailableDatasetsRequestOpts() {
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/available_datasets.json`;
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the list of available datasets.
+   */
+  async getAvailableDatasetsRaw(initOverrides) {
+    const requestOptions = await this.getAvailableDatasetsRequestOpts();
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiAvailableDatasetsFromJSON(jsonValue));
+  }
+  /**
+   * Get the list of available datasets.
+   */
+  async getAvailableDatasets(initOverrides) {
+    const response = await this.getAvailableDatasetsRaw(initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getAvailableTranslations without sending the request
+   */
+  async getAvailableTranslationsRequestOpts() {
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/available_translations.json`;
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the list of available Bible translations.
+   */
+  async getAvailableTranslationsRaw(initOverrides) {
+    const requestOptions = await this.getAvailableTranslationsRequestOpts();
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiAvailableTranslationsFromJSON(jsonValue));
+  }
+  /**
+   * Get the list of available Bible translations.
+   */
+  async getAvailableTranslations(initOverrides) {
+    const response = await this.getAvailableTranslationsRaw(initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getCommentaryBookChapter without sending the request
+   */
+  async getCommentaryBookChapterRequestOpts(requestParameters) {
+    if (requestParameters["commentary"] == null) {
+      throw new runtime.RequiredError(
+        "commentary",
+        'Required parameter "commentary" was null or undefined when calling getCommentaryBookChapter().'
+      );
+    }
+    if (requestParameters["book"] == null) {
+      throw new runtime.RequiredError(
+        "book",
+        'Required parameter "book" was null or undefined when calling getCommentaryBookChapter().'
+      );
+    }
+    if (requestParameters["chapter"] == null) {
+      throw new runtime.RequiredError(
+        "chapter",
+        'Required parameter "chapter" was null or undefined when calling getCommentaryBookChapter().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/c/{commentary}/{book}/{chapter}.json`;
+    urlPath = urlPath.replace("{commentary}", encodeURIComponent(String(requestParameters["commentary"])));
+    urlPath = urlPath.replace("{book}", encodeURIComponent(String(requestParameters["book"])));
+    urlPath = urlPath.replace("{chapter}", encodeURIComponent(String(requestParameters["chapter"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the content of a specific chapter of a specific book for a specific commentary.
+   */
+  async getCommentaryBookChapterRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.getCommentaryBookChapterRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiCommentaryBookChapterFromJSON(jsonValue));
+  }
+  /**
+   * Get the content of a specific chapter of a specific book for a specific commentary.
+   */
+  async getCommentaryBookChapter(requestParameters, initOverrides) {
+    const response = await this.getCommentaryBookChapterRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getCommentaryBooks without sending the request
+   */
+  async getCommentaryBooksRequestOpts(requestParameters) {
+    if (requestParameters["commentary"] == null) {
+      throw new runtime.RequiredError(
+        "commentary",
+        'Required parameter "commentary" was null or undefined when calling getCommentaryBooks().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/c/{commentary}/books.json`;
+    urlPath = urlPath.replace("{commentary}", encodeURIComponent(String(requestParameters["commentary"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the list of books available for a specific commentary.
+   */
+  async getCommentaryBooksRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.getCommentaryBooksRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiCommentaryBooksFromJSON(jsonValue));
+  }
+  /**
+   * Get the list of books available for a specific commentary.
+   */
+  async getCommentaryBooks(requestParameters, initOverrides) {
+    const response = await this.getCommentaryBooksRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getDatasetBookChapter without sending the request
+   */
+  async getDatasetBookChapterRequestOpts(requestParameters) {
+    if (requestParameters["dataset"] == null) {
+      throw new runtime.RequiredError(
+        "dataset",
+        'Required parameter "dataset" was null or undefined when calling getDatasetBookChapter().'
+      );
+    }
+    if (requestParameters["book"] == null) {
+      throw new runtime.RequiredError(
+        "book",
+        'Required parameter "book" was null or undefined when calling getDatasetBookChapter().'
+      );
+    }
+    if (requestParameters["chapter"] == null) {
+      throw new runtime.RequiredError(
+        "chapter",
+        'Required parameter "chapter" was null or undefined when calling getDatasetBookChapter().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/d/{dataset}/{book}/{chapter}.json`;
+    urlPath = urlPath.replace("{dataset}", encodeURIComponent(String(requestParameters["dataset"])));
+    urlPath = urlPath.replace("{book}", encodeURIComponent(String(requestParameters["book"])));
+    urlPath = urlPath.replace("{chapter}", encodeURIComponent(String(requestParameters["chapter"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the content of a specific chapter of a specific book for a specific dataset.
+   */
+  async getDatasetBookChapterRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.getDatasetBookChapterRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiDatasetBookChapterFromJSON(jsonValue));
+  }
+  /**
+   * Get the content of a specific chapter of a specific book for a specific dataset.
+   */
+  async getDatasetBookChapter(requestParameters, initOverrides) {
+    const response = await this.getDatasetBookChapterRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getDatasetBooks without sending the request
+   */
+  async getDatasetBooksRequestOpts(requestParameters) {
+    if (requestParameters["dataset"] == null) {
+      throw new runtime.RequiredError(
+        "dataset",
+        'Required parameter "dataset" was null or undefined when calling getDatasetBooks().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/d/{dataset}/books.json`;
+    urlPath = urlPath.replace("{dataset}", encodeURIComponent(String(requestParameters["dataset"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the list of books available for a specific dataset.
+   */
+  async getDatasetBooksRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.getDatasetBooksRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiDatasetBooksFromJSON(jsonValue));
+  }
+  /**
+   * Get the list of books available for a specific dataset.
+   */
+  async getDatasetBooks(requestParameters, initOverrides) {
+    const response = await this.getDatasetBooksRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getTranslationBookChapter without sending the request
+   */
+  async getTranslationBookChapterRequestOpts(requestParameters) {
+    if (requestParameters["translation"] == null) {
+      throw new runtime.RequiredError(
+        "translation",
+        'Required parameter "translation" was null or undefined when calling getTranslationBookChapter().'
+      );
+    }
+    if (requestParameters["book"] == null) {
+      throw new runtime.RequiredError(
+        "book",
+        'Required parameter "book" was null or undefined when calling getTranslationBookChapter().'
+      );
+    }
+    if (requestParameters["chapter"] == null) {
+      throw new runtime.RequiredError(
+        "chapter",
+        'Required parameter "chapter" was null or undefined when calling getTranslationBookChapter().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/{translation}/{book}/{chapter}.json`;
+    urlPath = urlPath.replace("{translation}", encodeURIComponent(String(requestParameters["translation"])));
+    urlPath = urlPath.replace("{book}", encodeURIComponent(String(requestParameters["book"])));
+    urlPath = urlPath.replace("{chapter}", encodeURIComponent(String(requestParameters["chapter"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the content of a specific chapter of a specific book for a specific translation.
+   */
+  async getTranslationBookChapterRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.getTranslationBookChapterRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiTranslationBookChapterFromJSON(jsonValue));
+  }
+  /**
+   * Get the content of a specific chapter of a specific book for a specific translation.
+   */
+  async getTranslationBookChapter(requestParameters, initOverrides) {
+    const response = await this.getTranslationBookChapterRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getTranslationBooks without sending the request
+   */
+  async getTranslationBooksRequestOpts(requestParameters) {
+    if (requestParameters["translation"] == null) {
+      throw new runtime.RequiredError(
+        "translation",
+        'Required parameter "translation" was null or undefined when calling getTranslationBooks().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/{translation}/books.json`;
+    urlPath = urlPath.replace("{translation}", encodeURIComponent(String(requestParameters["translation"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the list of books available for a specific translation.
+   */
+  async getTranslationBooksRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.getTranslationBooksRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiTranslationBooksFromJSON(jsonValue));
+  }
+  /**
+   * Get the list of books available for a specific translation.
+   */
+  async getTranslationBooks(requestParameters, initOverrides) {
+    const response = await this.getTranslationBooksRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for getTranslationComplete without sending the request
+   */
+  async getTranslationCompleteRequestOpts(requestParameters) {
+    if (requestParameters["translation"] == null) {
+      throw new runtime.RequiredError(
+        "translation",
+        'Required parameter "translation" was null or undefined when calling getTranslationComplete().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/api/{translation}/complete.json`;
+    urlPath = urlPath.replace("{translation}", encodeURIComponent(String(requestParameters["translation"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Get the complete content of a specific translation.
+   */
+  async getTranslationCompleteRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.getTranslationCompleteRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ApiTranslationCompleteFromJSON(jsonValue));
+  }
+  /**
+   * Get the complete content of a specific translation.
+   */
+  async getTranslationComplete(requestParameters, initOverrides) {
+    const response = await this.getTranslationCompleteRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
+}
+//# sourceMappingURL=DefaultApi.js.map