@youversion/platform-core 1.14.0 → 1.14.1

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @youversion/platform-core@1.14.0 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
+> @youversion/platform-core@1.14.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
@@ -8,11 +8,11 @@
 CLI Target: es2022
 CJS Build start
 ESM Build start
-CJS dist/index.cjs 53.41 KB
-CJS ⚡️ Build success in 41ms
-ESM dist/index.js 50.42 KB
-ESM ⚡️ Build success in 41ms
+CJS dist/index.cjs 53.58 KB
+CJS ⚡️ Build success in 51ms
+ESM dist/index.js 50.50 KB
+ESM ⚡️ Build success in 54ms
 DTS Build start
-DTS ⚡️ Build success in 1812ms
-DTS dist/index.d.cts 33.17 KB
-DTS dist/index.d.ts  33.17 KB
+DTS ⚡️ Build success in 2011ms
+DTS dist/index.d.cts 33.42 KB
+DTS dist/index.d.ts  33.42 KB

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @youversion/platform-core
 
+## 1.14.1
+
+### Patch Changes
+
+- 51d97e5: Standardized our default Bible Version to one that does not require opt-in license to use, so that our components work out of the box by default
+
 ## 1.14.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -24,6 +24,7 @@ __export(index_exports, {
   BOOK_CANON: () => BOOK_CANON,
   BOOK_IDS: () => BOOK_IDS,
   BibleClient: () => BibleClient,
+  DEFAULT_LICENSE_FREE_BIBLE_VERSION: () => DEFAULT_LICENSE_FREE_BIBLE_VERSION,
   HighlightsClient: () => HighlightsClient,
   LanguagesClient: () => LanguagesClient,
   MemoryStorageStrategy: () => MemoryStorageStrategy,
@@ -200,6 +201,7 @@ var import_zod4 = require("zod");
 var import_zod3 = require("zod");
 
 // src/utils/constants.ts
+var DEFAULT_LICENSE_FREE_BIBLE_VERSION = 3034;
 var BOOK_IDS = [
   "GEN",
   "EXO",
@@ -793,13 +795,13 @@ var BibleClient = class _BibleClient {
    * @example
    * ```ts
    * // Get a single verse
-   * const verse = await bibleClient.getPassage(111, "JHN.3.16");
+   * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
    *
    * // Get a range of verses
-   * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
+   * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
    *
    * // Get an entire chapter
-   * const chapter = await bibleClient.getPassage(111, "GEN.1");
+   * const chapter = await bibleClient.getPassage(3034, "GEN.1");
    * ```
    */
   async getPassage(versionId, usfm, format = "html", include_headings, include_notes) {
@@ -1667,6 +1669,7 @@ var YouVersionAPI = class {
   BOOK_CANON,
   BOOK_IDS,
   BibleClient,
+  DEFAULT_LICENSE_FREE_BIBLE_VERSION,
   HighlightsClient,
   LanguagesClient,
   MemoryStorageStrategy,

package/dist/index.d.cts

@@ -408,13 +408,13 @@ declare class BibleClient {
      * @example
      * ```ts
      * // Get a single verse
-     * const verse = await bibleClient.getPassage(111, "JHN.3.16");
+     * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
      *
      * // Get a range of verses
-     * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
+     * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
      *
      * // Get an entire chapter
-     * const chapter = await bibleClient.getPassage(111, "GEN.1");
+     * const chapter = await bibleClient.getPassage(3034, "GEN.1");
      * ```
      */
     getPassage(versionId: number, usfm: string, format?: 'html' | 'text', include_headings?: boolean, include_notes?: boolean): Promise<BiblePassage>;
@@ -718,6 +718,12 @@ declare class YouVersionPlatformConfiguration {
     static set expiryDateKey(value: string);
 }
 
+/**
+ * The Berean Standard Bible does not require a license
+ * to use via the YouVersion Platform, qualifying it as
+ * a good use-case for a default Bible Version.
+ */
+declare const DEFAULT_LICENSE_FREE_BIBLE_VERSION: 3034;
 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"];
 
 /**
@@ -725,4 +731,4 @@ declare const BOOK_IDS: readonly ["GEN", "EXO", "LEV", "NUM", "DEU", "JOS", "JDG
  */
 declare const BOOK_CANON: Record<BookUsfm, Canon>;
 
-export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON };
+export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, DEFAULT_LICENSE_FREE_BIBLE_VERSION, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON };

package/dist/index.d.ts

@@ -408,13 +408,13 @@ declare class BibleClient {
      * @example
      * ```ts
      * // Get a single verse
-     * const verse = await bibleClient.getPassage(111, "JHN.3.16");
+     * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
      *
      * // Get a range of verses
-     * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
+     * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
      *
      * // Get an entire chapter
-     * const chapter = await bibleClient.getPassage(111, "GEN.1");
+     * const chapter = await bibleClient.getPassage(3034, "GEN.1");
      * ```
      */
     getPassage(versionId: number, usfm: string, format?: 'html' | 'text', include_headings?: boolean, include_notes?: boolean): Promise<BiblePassage>;
@@ -718,6 +718,12 @@ declare class YouVersionPlatformConfiguration {
     static set expiryDateKey(value: string);
 }
 
+/**
+ * The Berean Standard Bible does not require a license
+ * to use via the YouVersion Platform, qualifying it as
+ * a good use-case for a default Bible Version.
+ */
+declare const DEFAULT_LICENSE_FREE_BIBLE_VERSION: 3034;
 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"];
 
 /**
@@ -725,4 +731,4 @@ declare const BOOK_IDS: readonly ["GEN", "EXO", "LEV", "NUM", "DEU", "JOS", "JDG
  */
 declare const BOOK_CANON: Record<BookUsfm, Canon>;
 
-export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON };
+export { ApiClient, type ApiConfig, type AuthenticationScopes, type AuthenticationState, BOOK_CANON, BOOK_IDS, type BibleBook, type BibleBookIntro, type BibleChapter, BibleClient, type BibleIndex, type BibleIndexBook, type BibleIndexChapter, type BibleIndexVerse, type BiblePassage, type BibleVerse, type BibleVersion, type CANON, type Collection, type CreateHighlight, DEFAULT_LICENSE_FREE_BIBLE_VERSION, type DeleteHighlightOptions, type GetHighlightsOptions, type GetLanguagesOptions, type Highlight, type HighlightColor, HighlightsClient, type Language, LanguagesClient, MemoryStorageStrategy, SessionStorageStrategy, SignInWithYouVersionPermission, type SignInWithYouVersionPermissionValues, SignInWithYouVersionResult, type StorageStrategy, type User, type VOTD, YouVersionAPI, YouVersionAPIUsers, YouVersionPlatformConfiguration, YouVersionUserInfo, type YouVersionUserInfoJSON };

package/dist/index.js

@@ -161,6 +161,7 @@ import { z as z4 } from "zod";
 import { z as z3 } from "zod";
 
 // src/utils/constants.ts
+var DEFAULT_LICENSE_FREE_BIBLE_VERSION = 3034;
 var BOOK_IDS = [
   "GEN",
   "EXO",
@@ -754,13 +755,13 @@ var BibleClient = class _BibleClient {
    * @example
    * ```ts
    * // Get a single verse
-   * const verse = await bibleClient.getPassage(111, "JHN.3.16");
+   * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
    *
    * // Get a range of verses
-   * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
+   * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
    *
    * // Get an entire chapter
-   * const chapter = await bibleClient.getPassage(111, "GEN.1");
+   * const chapter = await bibleClient.getPassage(3034, "GEN.1");
    * ```
    */
   async getPassage(versionId, usfm, format = "html", include_headings, include_notes) {
@@ -1627,6 +1628,7 @@ export {
   BOOK_CANON,
   BOOK_IDS,
   BibleClient,
+  DEFAULT_LICENSE_FREE_BIBLE_VERSION,
   HighlightsClient,
   LanguagesClient,
   MemoryStorageStrategy,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@youversion/platform-core",
-  "version": "1.14.0",
+  "version": "1.14.1",
   "type": "module",
   "publishConfig": {
     "access": "public",

package/src/bible.ts

@@ -1,17 +1,17 @@
 import { z } from 'zod';
 import type { ApiClient } from './client';
+import { BibleVersionSchema } from './schemas';
 import type {
   BibleBook,
   BibleChapter,
-  Collection,
+  BibleIndex,
+  BiblePassage,
   BibleVerse,
   BibleVersion,
-  BiblePassage,
-  VOTD,
-  BibleIndex,
   CANON,
+  Collection,
+  VOTD,
 } from './types';
-import { BibleVersionSchema } from './schemas';
 
 /**
  * Client for interacting with Bible API endpoints.
@@ -244,13 +244,13 @@ export class BibleClient {
    * @example
    * ```ts
    * // Get a single verse
-   * const verse = await bibleClient.getPassage(111, "JHN.3.16");
+   * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
    *
    * // Get a range of verses
-   * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
+   * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
    *
    * // Get an entire chapter
-   * const chapter = await bibleClient.getPassage(111, "GEN.1");
+   * const chapter = await bibleClient.getPassage(3034, "GEN.1");
    * ```
    */
   async getPassage(

package/src/utils/constants.ts

@@ -1,3 +1,10 @@
+/**
+ * The Berean Standard Bible does not require a license
+ * to use via the YouVersion Platform, qualifying it as
+ * a good use-case for a default Bible Version.
+ */
+export const DEFAULT_LICENSE_FREE_BIBLE_VERSION = 3034 as const;
+
 export const BOOK_IDS = [
   'GEN',
   'EXO',