@youversion/platform-core 0.4.1

package/.env.example

@@ -0,0 +1,7 @@
+YVP_API_BASE_URL=https://api-dev.youversion.com
+
+# Your application ID from YouVersion Platform
+YVP_APP_ID=""
+
+# Optional: Authentication token for endpoints that require it
+YVP_AUTH_TOKEN=""

package/.env.local

@@ -0,0 +1,10 @@
+YVP_API_BASE_URL=https://api-dev.youversion.com
+
+# Your application ID from YouVersion Platform
+YVP_APP_ID=Or8moGBK6GSh61OUOX7fUHgEsBsmVGMqAweZbydAgXnWj3nF
+
+# Your installation ID
+YVP_INSTALLATION_ID=a93b6749-7932-4bac-92ad-3e308f8a4bc4
+
+# Optional: Authentication token for endpoints that require it
+YVP_AUTH_TOKEN=

package/.turbo/turbo-build.log

@@ -0,0 +1,18 @@
+
+> @youversion/platform-core@0.4.1 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
+> tsup src/index.ts --format cjs,esm --dts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+CLI Target: es2022
+CJS Build start
+ESM Build start
+CJS dist/index.cjs 39.89 KB
+CJS ⚡️ Build success in 34ms
+ESM dist/index.js 37.89 KB
+ESM ⚡️ Build success in 35ms
+DTS Build start
+DTS ⚡️ Build success in 2125ms
+DTS dist/index.d.cts 34.20 KB
+DTS dist/index.d.ts  34.20 KB

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @youversion/platform-core
+
+## 0.4.1
+
+### Patch Changes
+
+- 28b10ed: Configuring initial publish workflow.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,369 @@
+# @youversion/platform-core
+
+A powerful, type-safe TypeScript library for interacting with Bible data. This package provides a comprehensive API client for fetching Bible versions, books, chapters, verses, and user authentication from the YouVersion Bible API.
+
+## 🚀 Features
+
+- **🔒 Type-safe API** - Full TypeScript support with comprehensive type definitions
+- **🌐 Multi-language support** - Access Bible versions in multiple languages
+- **📚 Complete Bible data** - Versions, books, chapters, verses, and metadata
+- **🔐 User authentication** - Secure user authentication with Long Access Tokens (LAT)
+- **⚡ Lightweight** - Minimal dependencies with tree-shaking support
+- **🎯 Easy to use** - Simple, intuitive API design
+- **📦 Modern packaging** - CommonJS and ES Module support
+
+## 📦 Installation
+
+```bash
+# npm
+npm install @youversion/platform-core
+
+# yarn
+yarn add @youversion/platform-core
+
+# pnpm
+pnpm add @youversion/platform-core
+```
+
+## 🔑 Getting Started
+
+Before using the library, you'll need to obtain an App ID from the [YouVersion Developer Portal](https://developers.youversion.com/). This is required for API authentication.
+
+## 🏃 Quick Start
+
+```ts
+import { ApiClient, BibleClient } from '@youversion/platform-core'
+
+// Initialize the API client
+const apiClient = new ApiClient({
+  appId: 'YOUR_APP_ID', // Required: Get your App ID from https://developers.youversion.com/
+})
+
+// Create a Bible client
+const bibleClient = new BibleClient(apiClient)
+
+// Fetch Bible versions
+const versions = await bibleClient.getVersions('en*')
+
+// Get a specific version
+const version = await bibleClient.getVersion(206) // ESV
+
+// Fetch books for a version
+const books = await bibleClient.getBooks(206)
+
+// Get a specific chapter
+const chapter = await bibleClient.getChapter(206, 'GEN', 1)
+const chapterContent = await bibleClient.getPassage(206, chapter.passage_id)
+```
+
+## 🔧 Configuration
+
+### API Configuration
+
+```ts
+import { ApiClient } from '@youversion/platform-core'
+
+const apiClient = new ApiClient({
+  appId: 'YOUR_APP_ID', // Required: Get your App ID from https://developers.youversion.com/
+  baseUrl: 'https://api.youversion.com', // Optional: API base URL
+  timeout: 10000, // Optional: Request timeout in ms (default: 10000)
+  version: 'v1', // Optional: API version (default: "v1")
+})
+```
+
+### Configuration Options
+
+| Option           | Type     | Default                            | Description                                                                               |
+| ---------------- | -------- | ---------------------------------- | ----------------------------------------------------------------------------------------- |
+| `appId`          | `string` | **Required**                       | Your application ID for API authentication. Get one at https://developers.youversion.com/ |
+| `baseUrl`        | `string` | `"https://api-dev.youversion.com"` | Base URL for the API                                                                      |
+| `timeout`        | `number` | `10000`                            | Request timeout in milliseconds                                                           |
+| `version`        | `string` | `"v1"`                             | API version to use                                                                        |
+
+## 📖 API Reference
+
+### BibleClient
+
+The main client for interacting with Bible data.
+
+#### Methods
+
+##### `getVersions(language_ranges: string): Promise<Collection<Version>>`
+
+Fetch available Bible versions filtered by language. The `language_ranges` parameter is required.
+
+```ts
+// Get all English versions
+const englishVersions = await bibleClient.getVersions('en*')
+
+// Get specific language versions
+const spanishVersions = await bibleClient.getVersions('es*')
+
+// Get multiple language versions
+const multiLangVersions = await bibleClient.getVersions('en*,es*,fr*')
+```
+
+##### `getVersion(id: number): Promise<Version>`
+
+Fetch a specific Bible version by ID.
+
+```ts
+const esv = await bibleClient.getVersion(111)
+console.log(esv.title) // "English Standard Version"
+```
+
+##### `getBooks(versionId: number): Promise<Collection<Book>>`
+
+Fetch all books for a specific Bible version.
+
+```ts
+const books = await bibleClient.getBooks(206)
+```
+
+##### `getBook(versionId: number, book: string): Promise<BibleBook>`
+
+Fetch a specific book by its USFM identifier.
+
+```ts
+const genesis = await bibleClient.getBook(111, 'GEN')
+console.log(genesis.title) // "Genesis"
+```
+
+##### `getChapters(versionId: number, book: string): Promise<Collection<BibleChapter>>`
+
+Fetch all chapters for a specific book.
+
+```ts
+const chapters = await bibleClient.getChapters(206, 'GEN')
+```
+
+##### `getChapter(versionId: number, book: string, chapter: number): Promise<BibleChapter>`
+
+Fetch a specific chapter.
+
+```ts
+const genesis1 = await bibleClient.getChapter(206, 'GEN', 1)
+const content = await bibleClient.getPassage(206, genesis1.passage_id)
+```
+
+##### `getVerses(versionId: number, book: string, chapter: number): Promise<Collection<BibleVerse>>`
+
+Fetch all verses for a specific chapter.
+
+```ts
+const verses = await bibleClient.getVerses(111, 'GEN', 1)
+verses.data.forEach((verse) => {
+  const passage = await bibleClient.getPassage(206, verse.passage_id)
+})
+```
+
+##### `getVerse(versionId: number, book: string, chapter: number, verse: number): Promise<BibleVerse>`
+
+Fetch a specific verse.
+
+```ts
+const verse = await bibleClient.getVerse(111, 'GEN', 1, 1)
+console.log('Verse reference:', verse.reference)
+const passage = await bibleClient.getPassage(111, verse.passage_id)
+console.log('Content:', passage.content) // "In the beginning, God created the heavens and the earth."
+```
+
+### AuthClient
+
+Client for user authentication and user data.
+
+#### Methods
+
+##### `getUser(lat: string): Promise<User>`
+
+Retrieve the current authenticated user using a Long Access Token.
+
+```ts
+import { AuthClient } from '@youversion/platform-core'
+
+const authClient = new AuthClient(apiClient)
+const user = await authClient.getUser('YOUR_LONG_ACCESS_TOKEN')
+```
+
+## 🔍 TypeScript Types
+
+The library provides comprehensive TypeScript types for all API responses:
+
+### Core Types
+
+```ts
+type BibleVersion = {
+  id: number
+  abbreviation: string
+  copyright_long: string
+  copyright_short: string
+  info: string
+  publisher_url: string
+  language_tag: string
+  local_abbreviation: string
+  local_title: string
+  title: string
+  books: Array<string>
+}
+
+interface BibleBook {
+  id: string
+  title: string
+  abbreviation: string
+  canon: string
+  chapters: Array<string>
+}
+
+interface BibleChapter {
+  id: string
+  book_id: string
+  passage_id: string
+  title: string
+  // ... additional fields
+}
+
+interface BibleVerse {
+  id: string
+  book_id: string
+  chapter_id: string
+  passage_id: string
+  reference: string
+  // ... additional fields
+}
+
+interface Collection<T> {
+  data: T[]
+  // ... pagination and metadata
+}
+```
+
+## 🎯 Common Use Cases
+
+### 1. Building a Bible Reading App
+
+```ts
+import { ApiClient, BibleClient } from '@youversion/platform-core'
+
+class BibleApp {
+  private bibleClient: BibleClient
+
+  constructor(appId: string) {
+    const apiClient = new ApiClient({ appId })
+    this.bibleClient = new BibleClient(apiClient)
+  }
+
+  async loadChapter(versionId: number, bookUsfm: string, chapterNum: number) {
+    const chapter = await this.bibleClient.getChapter(versionId, bookUsfm, chapterNum)
+    const verses = await this.bibleClient.getVerses(versionId, bookUsfm, chapterNum)
+
+    return {
+      chapter,
+      verses: verses.data,
+    }
+  }
+
+  async searchVersions(languageCode: string) {
+    const versions = await this.bibleClient.getVersions(`${languageCode}*`)
+    return versions.data
+  }
+}
+```
+
+### 2. Creating a Verse Reference Tool
+
+```ts
+async function getVerseReference(reference: string, versionId: number) {
+  // Parse reference like "GEN 1:1"
+  const [book, chapterVerse] = reference.split(' ')
+  const [chapter, verse] = chapterVerse.split(':')
+
+  const verseData = await bibleClient.getVerse(versionId, book, parseInt(chapter), parseInt(verse))
+  const passage = await bibleClient.getPassage(versionId, verseData.passage_id)
+
+  return {
+    reference,
+    content: passage.content,
+    version: await bibleClient.getVersion(versionId),
+  }
+}
+```
+
+### 3. Multi-language Bible Comparison
+
+```ts
+async function compareVerses(book: string, chapter: number, verse: number, versionIds: number[]) {
+  const comparisons = await Promise.all(
+    versionIds.map(async (versionId) => {
+      const [version, verseData] = await Promise.all([
+        bibleClient.getVersion(versionId),
+        bibleClient.getVerse(versionId, book, chapter, verse),
+      ])
+
+      const passage = await bibleClient.getPassage(versionId, verseData.passage_id)
+      return {
+        version: version.title,
+        language: version.language_tag,
+        content: passage.content,
+      }
+    })
+  )
+
+  return comparisons
+}
+```
+
+## 🚦 Error Handling
+
+The library uses standard HTTP status codes and provides meaningful error messages:
+
+```ts
+import { ApiClient, BibleClient } from '@youversion/platform-core'
+
+try {
+  const bibleClient = new BibleClient(new ApiClient({ appId: 'YOUR_APP_ID' })) // Get App ID from https://developers.youversion.com/
+  const version = await bibleClient.getVersion(999999) // Non-existent version
+} catch (error) {
+  if (error.response?.status === 404) {
+    console.error('Version not found')
+  } else if (error.response?.status === 401) {
+    console.error('Authentication failed - check your App ID')
+  } else {
+    console.error('An error occurred:', error.message)
+  }
+}
+```
+
+## 🔧 Development
+
+### Prerequisites
+
+- Node.js 18+
+- TypeScript 4.8+
+
+### Building
+
+```bash
+# Install dependencies
+npm install
+
+# Build the library
+npm run build
+
+# Run tests (from monorepo root for consistency)
+pnpm test
+
+# Run linting
+npm run lint
+```
+
+## 📄 License
+
+This package is part of the YouVersion Bible SDK and is subject to YouVersion's terms of service.
+
+## 🤝 Contributing
+
+This is an internal YouVersion package. For issues or feature requests, please contact the YouVersion development team.
+
+## 📚 Related Packages
+
+- `@youversion/platform-react-ui` - React UI components for Bible applications