@youversion/platform-core 1.13.0 → 1.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/.turbo/turbo-build.log +8 -8
  2. package/CHANGELOG.md +12 -0
  3. package/dist/index.cjs +6 -3
  4. package/dist/index.d.cts +10 -4
  5. package/dist/index.d.ts +10 -4
  6. package/dist/index.js +5 -3
  7. package/package.json +1 -1
  8. package/src/bible.ts +8 -8
  9. package/src/utils/constants.ts +7 -0
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @youversion/platform-core@1.13.0 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
2
+ > @youversion/platform-core@1.14.1 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
3
3
  > tsup src/index.ts --format cjs,esm --dts
4
4
 
5
5
  CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
8
8
  CLI Target: es2022
9
9
  CJS Build start
10
10
  ESM Build start
11
- CJS dist/index.cjs 53.41 KB
12
- CJS ⚡️ Build success in 43ms
13
- ESM dist/index.js 50.42 KB
14
- ESM ⚡️ Build success in 43ms
11
+ CJS dist/index.cjs 53.58 KB
12
+ CJS ⚡️ Build success in 51ms
13
+ ESM dist/index.js 50.50 KB
14
+ ESM ⚡️ Build success in 54ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 1826ms
17
- DTS dist/index.d.cts 33.17 KB
18
- DTS dist/index.d.ts 33.17 KB
16
+ DTS ⚡️ Build success in 2011ms
17
+ DTS dist/index.d.cts 33.42 KB
18
+ DTS dist/index.d.ts 33.42 KB
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @youversion/platform-core
2
2
 
3
+ ## 1.14.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 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
8
+
9
+ ## 1.14.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 2d2c597: Added 'system' as an option to YouVersionProvider theme prop that resolves via `prefers-color-scheme` with live OS change listener
14
+
3
15
  ## 1.13.0
4
16
 
5
17
  ### Minor Changes
package/dist/index.cjs CHANGED
@@ -24,6 +24,7 @@ __export(index_exports, {
24
24
  BOOK_CANON: () => BOOK_CANON,
25
25
  BOOK_IDS: () => BOOK_IDS,
26
26
  BibleClient: () => BibleClient,
27
+ DEFAULT_LICENSE_FREE_BIBLE_VERSION: () => DEFAULT_LICENSE_FREE_BIBLE_VERSION,
27
28
  HighlightsClient: () => HighlightsClient,
28
29
  LanguagesClient: () => LanguagesClient,
29
30
  MemoryStorageStrategy: () => MemoryStorageStrategy,
@@ -200,6 +201,7 @@ var import_zod4 = require("zod");
200
201
  var import_zod3 = require("zod");
201
202
 
202
203
  // src/utils/constants.ts
204
+ var DEFAULT_LICENSE_FREE_BIBLE_VERSION = 3034;
203
205
  var BOOK_IDS = [
204
206
  "GEN",
205
207
  "EXO",
@@ -793,13 +795,13 @@ var BibleClient = class _BibleClient {
793
795
  * @example
794
796
  * ```ts
795
797
  * // Get a single verse
796
- * const verse = await bibleClient.getPassage(111, "JHN.3.16");
798
+ * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
797
799
  *
798
800
  * // Get a range of verses
799
- * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
801
+ * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
800
802
  *
801
803
  * // Get an entire chapter
802
- * const chapter = await bibleClient.getPassage(111, "GEN.1");
804
+ * const chapter = await bibleClient.getPassage(3034, "GEN.1");
803
805
  * ```
804
806
  */
805
807
  async getPassage(versionId, usfm, format = "html", include_headings, include_notes) {
@@ -1667,6 +1669,7 @@ var YouVersionAPI = class {
1667
1669
  BOOK_CANON,
1668
1670
  BOOK_IDS,
1669
1671
  BibleClient,
1672
+ DEFAULT_LICENSE_FREE_BIBLE_VERSION,
1670
1673
  HighlightsClient,
1671
1674
  LanguagesClient,
1672
1675
  MemoryStorageStrategy,
package/dist/index.d.cts CHANGED
@@ -408,13 +408,13 @@ declare class BibleClient {
408
408
  * @example
409
409
  * ```ts
410
410
  * // Get a single verse
411
- * const verse = await bibleClient.getPassage(111, "JHN.3.16");
411
+ * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
412
412
  *
413
413
  * // Get a range of verses
414
- * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
414
+ * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
415
415
  *
416
416
  * // Get an entire chapter
417
- * const chapter = await bibleClient.getPassage(111, "GEN.1");
417
+ * const chapter = await bibleClient.getPassage(3034, "GEN.1");
418
418
  * ```
419
419
  */
420
420
  getPassage(versionId: number, usfm: string, format?: 'html' | 'text', include_headings?: boolean, include_notes?: boolean): Promise<BiblePassage>;
@@ -718,6 +718,12 @@ declare class YouVersionPlatformConfiguration {
718
718
  static set expiryDateKey(value: string);
719
719
  }
720
720
 
721
+ /**
722
+ * The Berean Standard Bible does not require a license
723
+ * to use via the YouVersion Platform, qualifying it as
724
+ * a good use-case for a default Bible Version.
725
+ */
726
+ declare const DEFAULT_LICENSE_FREE_BIBLE_VERSION: 3034;
721
727
  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"];
722
728
 
723
729
  /**
@@ -725,4 +731,4 @@ declare const BOOK_IDS: readonly ["GEN", "EXO", "LEV", "NUM", "DEU", "JOS", "JDG
725
731
  */
726
732
  declare const BOOK_CANON: Record<BookUsfm, Canon>;
727
733
 
728
- 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 };
734
+ 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 CHANGED
@@ -408,13 +408,13 @@ declare class BibleClient {
408
408
  * @example
409
409
  * ```ts
410
410
  * // Get a single verse
411
- * const verse = await bibleClient.getPassage(111, "JHN.3.16");
411
+ * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
412
412
  *
413
413
  * // Get a range of verses
414
- * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
414
+ * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
415
415
  *
416
416
  * // Get an entire chapter
417
- * const chapter = await bibleClient.getPassage(111, "GEN.1");
417
+ * const chapter = await bibleClient.getPassage(3034, "GEN.1");
418
418
  * ```
419
419
  */
420
420
  getPassage(versionId: number, usfm: string, format?: 'html' | 'text', include_headings?: boolean, include_notes?: boolean): Promise<BiblePassage>;
@@ -718,6 +718,12 @@ declare class YouVersionPlatformConfiguration {
718
718
  static set expiryDateKey(value: string);
719
719
  }
720
720
 
721
+ /**
722
+ * The Berean Standard Bible does not require a license
723
+ * to use via the YouVersion Platform, qualifying it as
724
+ * a good use-case for a default Bible Version.
725
+ */
726
+ declare const DEFAULT_LICENSE_FREE_BIBLE_VERSION: 3034;
721
727
  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"];
722
728
 
723
729
  /**
@@ -725,4 +731,4 @@ declare const BOOK_IDS: readonly ["GEN", "EXO", "LEV", "NUM", "DEU", "JOS", "JDG
725
731
  */
726
732
  declare const BOOK_CANON: Record<BookUsfm, Canon>;
727
733
 
728
- 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 };
734
+ 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 CHANGED
@@ -161,6 +161,7 @@ import { z as z4 } from "zod";
161
161
  import { z as z3 } from "zod";
162
162
 
163
163
  // src/utils/constants.ts
164
+ var DEFAULT_LICENSE_FREE_BIBLE_VERSION = 3034;
164
165
  var BOOK_IDS = [
165
166
  "GEN",
166
167
  "EXO",
@@ -754,13 +755,13 @@ var BibleClient = class _BibleClient {
754
755
  * @example
755
756
  * ```ts
756
757
  * // Get a single verse
757
- * const verse = await bibleClient.getPassage(111, "JHN.3.16");
758
+ * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
758
759
  *
759
760
  * // Get a range of verses
760
- * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
761
+ * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
761
762
  *
762
763
  * // Get an entire chapter
763
- * const chapter = await bibleClient.getPassage(111, "GEN.1");
764
+ * const chapter = await bibleClient.getPassage(3034, "GEN.1");
764
765
  * ```
765
766
  */
766
767
  async getPassage(versionId, usfm, format = "html", include_headings, include_notes) {
@@ -1627,6 +1628,7 @@ export {
1627
1628
  BOOK_CANON,
1628
1629
  BOOK_IDS,
1629
1630
  BibleClient,
1631
+ DEFAULT_LICENSE_FREE_BIBLE_VERSION,
1630
1632
  HighlightsClient,
1631
1633
  LanguagesClient,
1632
1634
  MemoryStorageStrategy,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@youversion/platform-core",
3
- "version": "1.13.0",
3
+ "version": "1.14.1",
4
4
  "type": "module",
5
5
  "publishConfig": {
6
6
  "access": "public",
package/src/bible.ts CHANGED
@@ -1,17 +1,17 @@
1
1
  import { z } from 'zod';
2
2
  import type { ApiClient } from './client';
3
+ import { BibleVersionSchema } from './schemas';
3
4
  import type {
4
5
  BibleBook,
5
6
  BibleChapter,
6
- Collection,
7
+ BibleIndex,
8
+ BiblePassage,
7
9
  BibleVerse,
8
10
  BibleVersion,
9
- BiblePassage,
10
- VOTD,
11
- BibleIndex,
12
11
  CANON,
12
+ Collection,
13
+ VOTD,
13
14
  } from './types';
14
- import { BibleVersionSchema } from './schemas';
15
15
 
16
16
  /**
17
17
  * Client for interacting with Bible API endpoints.
@@ -244,13 +244,13 @@ export class BibleClient {
244
244
  * @example
245
245
  * ```ts
246
246
  * // Get a single verse
247
- * const verse = await bibleClient.getPassage(111, "JHN.3.16");
247
+ * const verse = await bibleClient.getPassage(3034, "JHN.3.16");
248
248
  *
249
249
  * // Get a range of verses
250
- * const verses = await bibleClient.getPassage(111, "JHN.3.1-5");
250
+ * const verses = await bibleClient.getPassage(3034, "JHN.3.1-5");
251
251
  *
252
252
  * // Get an entire chapter
253
- * const chapter = await bibleClient.getPassage(111, "GEN.1");
253
+ * const chapter = await bibleClient.getPassage(3034, "GEN.1");
254
254
  * ```
255
255
  */
256
256
  async getPassage(
package/src/utils/constants.ts CHANGED
@@ -1,3 +1,10 @@
1
+ /**
2
+ * The Berean Standard Bible does not require a license
3
+ * to use via the YouVersion Platform, qualifying it as
4
+ * a good use-case for a default Bible Version.
5
+ */
6
+ export const DEFAULT_LICENSE_FREE_BIBLE_VERSION = 3034 as const;
7
+
1
8
  export const BOOK_IDS = [
2
9
  'GEN',
3
10
  'EXO',