@youversion/platform-core 1.0.0 → 1.1.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @youversion/platform-core@1.0.0 build /home/runner/work/platform-sdk-react/platform-sdk-react/packages/core
+> @youversion/platform-core@1.1.0 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
@@ -9,10 +9,10 @@
 CJS Build start
 ESM Build start
 CJS dist/index.cjs 42.47 KB
-CJS ⚡️ Build success in 33ms
+CJS ⚡️ Build success in 31ms
 ESM dist/index.js 40.66 KB
-ESM ⚡️ Build success in 34ms
+ESM ⚡️ Build success in 31ms
 DTS Build start
-DTS ⚡️ Build success in 1790ms
-DTS dist/index.d.cts 31.83 KB
-DTS dist/index.d.ts  31.83 KB
+DTS ⚡️ Build success in 1861ms
+DTS dist/index.d.cts 32.01 KB
+DTS dist/index.d.ts  32.01 KB

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @youversion/platform-core
 
+## 1.1.0
+
+### Minor Changes
+
+- efb1030: feat(core): make data objects that should be immutable readonly
+  - changed data types that come from api responses and should not
+    be mutated to be readonly.
+  - See the documentation on these types, https://developers.youversion.com/sdks/react#referenced-types
+
+## 1.0.1
+
+### Patch Changes
+
+- 0ae8237: fix: update version apis
+  - change copyright_short -> copyright in version apis
+  - change copyright_long -> promotional_content in version apis
+  - add stories that hit real apis for local testing api changes
+
 ## 1.0.0
 
 ### Major Changes

package/dist/index.d.cts

@@ -3,8 +3,8 @@ import { z } from 'zod';
 declare const BibleVersionSchema: z.ZodObject<{
     id: z.ZodNumber;
     abbreviation: z.ZodString;
-    copyright_long: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    copyright_short: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    promotional_content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    copyright: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     info: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     publisher_url: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
     language_tag: z.ZodString;
@@ -15,14 +15,14 @@ declare const BibleVersionSchema: z.ZodObject<{
     books: z.ZodArray<z.ZodUnion<readonly [...z.ZodLiteral<"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">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>>;
     youversion_deep_link: z.ZodURL;
 }, z.core.$strip>;
-type BibleVersion = z.infer<typeof BibleVersionSchema>;
+type BibleVersion = Readonly<z.infer<typeof BibleVersionSchema>>;
 
 declare const CanonSchema: z.ZodEnum<{
     old_testament: "old_testament";
     new_testament: "new_testament";
     deuterocanon: "deuterocanon";
 }>;
-type Canon = z.infer<typeof CanonSchema>;
+type Canon = Readonly<z.infer<typeof CanonSchema>>;
 declare const BookUsfmSchema: z.ZodUnion<readonly [...z.ZodLiteral<"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">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
 type BookUsfm = z.infer<typeof BookUsfmSchema>;
 declare const BibleBookSchema: z.ZodObject<{
@@ -46,8 +46,8 @@ declare const BibleBookSchema: z.ZodObject<{
         }, z.core.$strip>>>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
-type BibleBook = z.infer<typeof BibleBookSchema>;
-type CANON = z.infer<typeof CanonSchema>;
+type BibleBook = Readonly<z.infer<typeof BibleBookSchema>>;
+type CANON = Readonly<z.infer<typeof CanonSchema>>;
 
 declare const BibleChapterSchema: z.ZodObject<{
     id: z.ZodString;
@@ -59,33 +59,33 @@ declare const BibleChapterSchema: z.ZodObject<{
         title: z.ZodString;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
-type BibleChapter = z.infer<typeof BibleChapterSchema>;
+type BibleChapter = Readonly<z.infer<typeof BibleChapterSchema>>;
 
 declare const BibleVerseSchema: z.ZodObject<{
     id: z.ZodString;
     passage_id: z.ZodString;
     title: z.ZodString;
 }, z.core.$strip>;
-type BibleVerse = z.infer<typeof BibleVerseSchema>;
+type BibleVerse = Readonly<z.infer<typeof BibleVerseSchema>>;
 
 declare const BiblePassageSchema: z.ZodObject<{
     id: z.ZodString;
     content: z.ZodString;
     reference: z.ZodString;
 }, z.core.$strip>;
-type BiblePassage = z.infer<typeof BiblePassageSchema>;
+type BiblePassage = Readonly<z.infer<typeof BiblePassageSchema>>;
 
 declare const VOTDSchema: z.ZodObject<{
     day: z.ZodNumber;
     passage_id: z.ZodString;
 }, z.core.$strip>;
-type VOTD = z.infer<typeof VOTDSchema>;
+type VOTD = Readonly<z.infer<typeof VOTDSchema>>;
 
 declare const BibleIndexVerseSchema: z.ZodObject<{
     id: z.ZodString;
     title: z.ZodString;
 }, z.core.$strip>;
-type BibleIndexVerse = z.infer<typeof BibleIndexVerseSchema>;
+type BibleIndexVerse = Readonly<z.infer<typeof BibleIndexVerseSchema>>;
 declare const BibleIndexChapterSchema: z.ZodObject<{
     id: z.ZodString;
     title: z.ZodString;
@@ -94,7 +94,7 @@ declare const BibleIndexChapterSchema: z.ZodObject<{
         title: z.ZodString;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-type BibleIndexChapter = z.infer<typeof BibleIndexChapterSchema>;
+type BibleIndexChapter = Readonly<z.infer<typeof BibleIndexChapterSchema>>;
 declare const BibleIndexBookSchema: z.ZodObject<{
     id: z.ZodUnion<readonly [...z.ZodLiteral<"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">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
     title: z.ZodString;
@@ -114,7 +114,7 @@ declare const BibleIndexBookSchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-type BibleIndexBook = z.infer<typeof BibleIndexBookSchema>;
+type BibleIndexBook = Readonly<z.infer<typeof BibleIndexBookSchema>>;
 declare const _BibleIndexSchema: z.ZodObject<{
     text_direction: z.ZodString;
     books: z.ZodArray<z.ZodObject<{
@@ -137,7 +137,7 @@ declare const _BibleIndexSchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-type BibleIndex = z.infer<typeof _BibleIndexSchema>;
+type BibleIndex = Readonly<z.infer<typeof _BibleIndexSchema>>;
 
 declare const LanguageSchema: z.ZodObject<{
     id: z.ZodString;
@@ -157,7 +157,7 @@ declare const LanguageSchema: z.ZodObject<{
     speaking_population: z.ZodOptional<z.ZodNumber>;
     default_bible_version_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
-type Language = z.infer<typeof LanguageSchema>;
+type Language = Readonly<z.infer<typeof LanguageSchema>>;
 
 declare const _UserSchema: z.ZodObject<{
     avatar_url: z.ZodString;
@@ -183,11 +183,11 @@ type CreateHighlight = z.infer<typeof _CreateHighlightSchema>;
 /**
  * Generic Collection type for paginated responses
  */
-type Collection<T> = {
+type Collection<T> = Readonly<{
     data: T[];
     next_page_token: string | null;
     total_size?: number;
-};
+}>;
 
 interface ApiConfig {
     apiHost?: string;
@@ -228,12 +228,12 @@ declare class SignInWithYouVersionResult {
 
 type SignInWithYouVersionPermissionValues = (typeof SignInWithYouVersionPermission)[keyof typeof SignInWithYouVersionPermission];
 interface AuthenticationState {
-    isAuthenticated: boolean;
-    isLoading: boolean;
-    accessToken: string | null;
-    idToken: string | null;
-    result: SignInWithYouVersionResult | null;
-    error: Error | null;
+    readonly isAuthenticated: boolean;
+    readonly isLoading: boolean;
+    readonly accessToken: string | null;
+    readonly idToken: string | null;
+    readonly result: SignInWithYouVersionResult | null;
+    readonly error: Error | null;
 }
 type AuthenticationScopes = 'profile' | 'email';
 

package/dist/index.d.ts

@@ -3,8 +3,8 @@ import { z } from 'zod';
 declare const BibleVersionSchema: z.ZodObject<{
     id: z.ZodNumber;
     abbreviation: z.ZodString;
-    copyright_long: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-    copyright_short: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    promotional_content: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    copyright: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     info: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     publisher_url: z.ZodOptional<z.ZodNullable<z.ZodURL>>;
     language_tag: z.ZodString;
@@ -15,14 +15,14 @@ declare const BibleVersionSchema: z.ZodObject<{
     books: z.ZodArray<z.ZodUnion<readonly [...z.ZodLiteral<"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">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>>;
     youversion_deep_link: z.ZodURL;
 }, z.core.$strip>;
-type BibleVersion = z.infer<typeof BibleVersionSchema>;
+type BibleVersion = Readonly<z.infer<typeof BibleVersionSchema>>;
 
 declare const CanonSchema: z.ZodEnum<{
     old_testament: "old_testament";
     new_testament: "new_testament";
     deuterocanon: "deuterocanon";
 }>;
-type Canon = z.infer<typeof CanonSchema>;
+type Canon = Readonly<z.infer<typeof CanonSchema>>;
 declare const BookUsfmSchema: z.ZodUnion<readonly [...z.ZodLiteral<"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">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
 type BookUsfm = z.infer<typeof BookUsfmSchema>;
 declare const BibleBookSchema: z.ZodObject<{
@@ -46,8 +46,8 @@ declare const BibleBookSchema: z.ZodObject<{
         }, z.core.$strip>>>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
-type BibleBook = z.infer<typeof BibleBookSchema>;
-type CANON = z.infer<typeof CanonSchema>;
+type BibleBook = Readonly<z.infer<typeof BibleBookSchema>>;
+type CANON = Readonly<z.infer<typeof CanonSchema>>;
 
 declare const BibleChapterSchema: z.ZodObject<{
     id: z.ZodString;
@@ -59,33 +59,33 @@ declare const BibleChapterSchema: z.ZodObject<{
         title: z.ZodString;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
-type BibleChapter = z.infer<typeof BibleChapterSchema>;
+type BibleChapter = Readonly<z.infer<typeof BibleChapterSchema>>;
 
 declare const BibleVerseSchema: z.ZodObject<{
     id: z.ZodString;
     passage_id: z.ZodString;
     title: z.ZodString;
 }, z.core.$strip>;
-type BibleVerse = z.infer<typeof BibleVerseSchema>;
+type BibleVerse = Readonly<z.infer<typeof BibleVerseSchema>>;
 
 declare const BiblePassageSchema: z.ZodObject<{
     id: z.ZodString;
     content: z.ZodString;
     reference: z.ZodString;
 }, z.core.$strip>;
-type BiblePassage = z.infer<typeof BiblePassageSchema>;
+type BiblePassage = Readonly<z.infer<typeof BiblePassageSchema>>;
 
 declare const VOTDSchema: z.ZodObject<{
     day: z.ZodNumber;
     passage_id: z.ZodString;
 }, z.core.$strip>;
-type VOTD = z.infer<typeof VOTDSchema>;
+type VOTD = Readonly<z.infer<typeof VOTDSchema>>;
 
 declare const BibleIndexVerseSchema: z.ZodObject<{
     id: z.ZodString;
     title: z.ZodString;
 }, z.core.$strip>;
-type BibleIndexVerse = z.infer<typeof BibleIndexVerseSchema>;
+type BibleIndexVerse = Readonly<z.infer<typeof BibleIndexVerseSchema>>;
 declare const BibleIndexChapterSchema: z.ZodObject<{
     id: z.ZodString;
     title: z.ZodString;
@@ -94,7 +94,7 @@ declare const BibleIndexChapterSchema: z.ZodObject<{
         title: z.ZodString;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-type BibleIndexChapter = z.infer<typeof BibleIndexChapterSchema>;
+type BibleIndexChapter = Readonly<z.infer<typeof BibleIndexChapterSchema>>;
 declare const BibleIndexBookSchema: z.ZodObject<{
     id: z.ZodUnion<readonly [...z.ZodLiteral<"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">[], z.ZodType<string & {}, unknown, z.core.$ZodTypeInternals<string & {}, unknown>>]>;
     title: z.ZodString;
@@ -114,7 +114,7 @@ declare const BibleIndexBookSchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-type BibleIndexBook = z.infer<typeof BibleIndexBookSchema>;
+type BibleIndexBook = Readonly<z.infer<typeof BibleIndexBookSchema>>;
 declare const _BibleIndexSchema: z.ZodObject<{
     text_direction: z.ZodString;
     books: z.ZodArray<z.ZodObject<{
@@ -137,7 +137,7 @@ declare const _BibleIndexSchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
-type BibleIndex = z.infer<typeof _BibleIndexSchema>;
+type BibleIndex = Readonly<z.infer<typeof _BibleIndexSchema>>;
 
 declare const LanguageSchema: z.ZodObject<{
     id: z.ZodString;
@@ -157,7 +157,7 @@ declare const LanguageSchema: z.ZodObject<{
     speaking_population: z.ZodOptional<z.ZodNumber>;
     default_bible_version_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
-type Language = z.infer<typeof LanguageSchema>;
+type Language = Readonly<z.infer<typeof LanguageSchema>>;
 
 declare const _UserSchema: z.ZodObject<{
     avatar_url: z.ZodString;
@@ -183,11 +183,11 @@ type CreateHighlight = z.infer<typeof _CreateHighlightSchema>;
 /**
  * Generic Collection type for paginated responses
  */
-type Collection<T> = {
+type Collection<T> = Readonly<{
     data: T[];
     next_page_token: string | null;
     total_size?: number;
-};
+}>;
 
 interface ApiConfig {
     apiHost?: string;
@@ -228,12 +228,12 @@ declare class SignInWithYouVersionResult {
 
 type SignInWithYouVersionPermissionValues = (typeof SignInWithYouVersionPermission)[keyof typeof SignInWithYouVersionPermission];
 interface AuthenticationState {
-    isAuthenticated: boolean;
-    isLoading: boolean;
-    accessToken: string | null;
-    idToken: string | null;
-    result: SignInWithYouVersionResult | null;
-    error: Error | null;
+    readonly isAuthenticated: boolean;
+    readonly isLoading: boolean;
+    readonly accessToken: string | null;
+    readonly idToken: string | null;
+    readonly result: SignInWithYouVersionResult | null;
+    readonly error: Error | null;
 }
 type AuthenticationScopes = 'profile' | 'email';
 

package/package.json

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

package/src/__tests__/MockVersions.ts

@@ -3,9 +3,9 @@ import type { BibleVersion } from '@/types';
 export const mockVersionKJV: BibleVersion = {
   id: 1,
   abbreviation: 'KJV',
-  copyright_long:
+  promotional_content:
     " King James Version (KJV)  The King James Version (KJV) of the holy Bible was first printed in 1611, but the main edition used today is the 1769 version. The King James Version (KJV) is also known as the Authorized (or Authorised) Version (AV) because it was authorized to be read in churches. For over 300 years it was the main English translation used in the English speaking world, and is much admired and respected. About 400 words and phrases coined or popularised by the King James Version are part the English language today.   Revision  The King James Version of the Bible was not a new translation but a revision of the English Bible which was commissioned by King James I of Great Britain, following the Church of England Hampton Court Conference in 1604. 54 scholars from London, Oxford and Cambridge worked on the project. They were all from the Church of England (Anglicans), but included those of traditional and Puritan views. Officially the 1586 Bishop’s Bible was used as the base for the revision, but the scholars referenced all existing Bible translations in English, such as the Geneva Bible and Tyndale, and also editions in other languages. The completed Bible was first printed in 1611, and included the Apocrypha, which is omitted from this edition.   1769 edition  In 1611 English spelling and punctuation were not in standard forms, and the Bible underwent a mainly-orthographic revision by Oxford and Cambridge universities in 1769, which is the version most people use today. The rights of the King James Version of the Bible were, and still are, protected under British law and are vested in the Crown.   Bible Society edition  In 1804 the British and Foreign Bible Society (BFBS) was founded and they printed millions of cheap copies of the Bible for people to buy and read. Through the work of the Bible Societies the King James Version (KJV) became the most printed and most widely read book in the world.   1954 Paragraphed Edition  The King James Version was printed with each new verse starting on a new line. In 1954 the British and Foreign Bible Society produced a new edition of the KJV, keeping the original 1769 text, but adding sub-titles and paragraphs, making it easier to read. In 2011 this was reprinted in a special edition, with other appendices such as a Glossary, and concordance, to mark the 400th anniversary of the King James Version. This is the text used in this on-line edition. The paragraphing, sub-headings from 1954, and other additions from 2011, are copyright the British and Foreign Bible Society.  Copyright Information  Rights in the Authorized (King James) Version of the Bible are vested in the Crown. Published by permission of the Crown's patentee, Cambridge University Press.  This edition  This edition of the King James Authorised Version was paragraphed with sub-headings added by the British and Foreign Bible Society in 1954 and released again as a special edition in 2011. BFBS additions © 2011 British and Foreign Bible Society This text is maintained by the British and Foreign Bible Society If you are interested in obtaining a printed copy, please contact the British and Foreign Bible Society at www.biblesociety.org.uk",
-  copyright_short:
+  copyright:
     'Rights in the Authorized (King James) Version in the United Kingdom are vested in the Crown. Published by permission of the Crown’s patentee, Cambridge University Press.',
   info: null,
   publisher_url: null,
@@ -88,9 +88,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 110,
     abbreviation: 'NIrV',
-    copyright_long:
+    promotional_content:
       'Biblica is a global Bible ministry inspired by radical generosity. We are motivated by the belief that God’s Word radically changes lives, and that everyone everywhere deserves to experience its truth for themselves. To that end, we pioneer ways to break down barriers to the Bible, doing whatever it takes to activate Scripture where needed most.\nNow in its third century of ministry, Biblica continues to produce relevant, reliable Scripture translations and innovative resources that power the Bible ministry of hundreds of global mission organizations. Together, we invite millions to discover the love of Jesus Christ through our three core pillars of ministry:\nGateway Translation\nWe translate God’s Word for the world’s most strategic languages, catalyzing greater reach to Bibleless language communities.\nFrontline Church\nWe equip the frontlines of Gospel ministry with Scripture resources that serve the unreached, unengaged, and unseen.\nKids in Crisis\nWe develop and deploy Bible programs that bring the love of Jesus to children and youth in the world’s hardest places.',
-    copyright_short:
+    copyright:
       'Holy Bible, New International Reader’s Version®, NIrV®\nCopyright © 1995, 1996, 1998, 2014 by Biblica, Inc.®\nUsed by permission. All rights reserved worldwide.',
     info: null,
     publisher_url: 'https://www.biblica.com/yv-learn-more/',
@@ -172,9 +172,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 111,
     abbreviation: 'NIV11',
-    copyright_long:
+    promotional_content:
       'Biblica is the worldwide publisher and translation sponsor of the New International Version—one of the most widely read contemporary English versions of the Bible.\nAt Biblica, we believe that with God, all things are possible. Partnering with other ministries and people like you, we are reaching the world with God’s Word, providing Bibles that are easier to understand and faster to receive. When God’s Word is put into someone’s hands, it has the power to change everything.\nTo learn more, visit biblica.com and facebook.com/Biblica.',
-    copyright_short:
+    copyright:
       'The Holy Bible, New International Version® NIV®\nCopyright © 1973, 1978, 1984, 2011 by Biblica, Inc.®\nUsed by Permission of Biblica, Inc.® All rights reserved worldwide.',
     info: null,
     publisher_url: 'https://www.biblica.com/yv-learn-more/',
@@ -256,9 +256,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 113,
     abbreviation: 'NIVUK11',
-    copyright_long:
+    promotional_content:
       'Biblica is the worldwide publisher and translation sponsor of the New International Version – one of the most widely read contemporary English versions of the Bible.\nAt Biblica, we believe that with God, all things are possible. Partnering with other ministries and people like you, we are reaching the world with God’s Word, providing Bibles that are easier to understand and faster to receive. When God’s Word is put into someone’s hands, it has the power to change everything.\nTo learn more, visit biblica.com and facebook.com/Biblica.',
-    copyright_short:
+    copyright:
       'The Holy Bible, New International Version® (Anglicised), NIV®\nCopyright © 1979, 1984, 2011 by Biblica, Inc.®\nUsed by permission of Biblica, Inc.® All rights reserved worldwide.',
     info: null,
     publisher_url: 'https://www.biblica.com/yv-learn-more/',
@@ -340,9 +340,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 1588,
     abbreviation: 'AMP',
-    copyright_long:
+    promotional_content:
       'The Amplified Bible is a Literal Equivalent translation that, by using synonyms and definitions, both explains and expands the meaning of words in the text by placing amplification in parentheses, brackets, and after key words. This unique system of translation allows the reader to more completely and clearly grasp the meaning as it was understood in the original languages. Additionally, amplifications may provide further theological, historical, and other details for a better understanding of the text.',
-    copyright_short:
+    copyright:
       'Amplified® Bible\nCopyright © 2015 by\nThe Lockman Foundation, La Habra, CA 90631\nAll rights reserved. http://www.lockman.org',
     info: null,
     publisher_url: null,
@@ -424,9 +424,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 100,
     abbreviation: 'NASB1995',
-    copyright_long:
+    promotional_content:
       'NEW AMERICAN STANDARD BIBLE® Copyright © 1960, 1962, 1963, 1968, 1971, 1972, 1973, 1975, 1977, 1995 by THE LOCKMAN FOUNDATION A Corporation Not for Profit LA HABRA, CA All Rights Reserved http://www.lockman.org',
-    copyright_short:
+    copyright:
       'NEW AMERICAN STANDARD BIBLE® Copyright © 1960, 1962, 1963, 1968, 1971, 1972, 1973, 1975, 1977, 1995 by THE LOCKMAN FOUNDATION A Corporation Not for Profit LA HABRA, CA All Rights Reserved http://www.lockman.org',
     info: null,
     publisher_url: null,
@@ -508,9 +508,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 2692,
     abbreviation: 'NASB2020',
-    copyright_long:
+    promotional_content:
       'The NASB 2020 is an update of the NASB 1995 that further improves accuracy where possible, modernizes language, and improves readability. These refinements maintain faithful accuracy to the original texts and provide a clear understanding of God’s Word to those who prefer more modern English standards. The long-established translation standard for the NASB remains the same as it always has been, that is to accurately translate the inspired Word of God from the Hebrew, Aramaic, and Greek texts into modern English that is clearly understandable today.',
-    copyright_short:
+    copyright:
       'NEW AMERICAN STANDARD BIBLE® NASB®\nCopyright © 1960, 1971, 1977,1995, 2020 by The Lockman Foundation\nA Corporation Not for Profit\nLa Habra, CA\nAll Rights Reserved\nwww.lockman.org',
     info: null,
     publisher_url: null,
@@ -592,8 +592,8 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 12,
     abbreviation: 'ASV',
-    copyright_long: null,
-    copyright_short: null,
+    promotional_content: null,
+    copyright: null,
     info: null,
     publisher_url: null,
     language_tag: 'en',
@@ -674,8 +674,8 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 42,
     abbreviation: 'CPDV',
-    copyright_long: null,
-    copyright_short: null,
+    promotional_content: null,
+    copyright: null,
     info: null,
     publisher_url: null,
     language_tag: 'en',
@@ -763,9 +763,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 130,
     abbreviation: 'TOJB2011',
-    copyright_long:
+    promotional_content:
       'THE ORTHODOX JEWISH TANAKH\nArtists For Israel Intl Inc.\nThis version also appears with the Orthodox Yiddish Triglot which presents the Hebrew Yiddish script in Latin script and an English word for word translation, available at afii.org/Torah\nTo donate PayPal.Me',
-    copyright_short:
+    copyright:
       'THE ORTHODOX JEWISH BIBLE\nFOURTH EDITION REVISED © Artists For Israel Intl Inc., 2002-2011, 2021, 2024.',
     info: null,
     publisher_url: null,
@@ -847,8 +847,8 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 206,
     abbreviation: 'engWEBUS',
-    copyright_long: 'This Public Domain Bible text is courtesy of eBible.org.',
-    copyright_short: 'PUBLIC DOMAIN (not copyrighted)',
+    promotional_content: 'This Public Domain Bible text is courtesy of eBible.org.',
+    copyright: 'PUBLIC DOMAIN (not copyrighted)',
     info: null,
     publisher_url: null,
     language_tag: 'en',
@@ -943,9 +943,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 1932,
     abbreviation: 'FBV',
-    copyright_long:
+    promotional_content:
       'FBV: this translation is directly from the Hebrew and Greek text. It is licensed under a Creative Commons Attribution-ShareAlike 4.0 Unported License. This means this work can be copied and used as long as it is identified as the Free Bible Version and any adaptations are identified. Any derivative work is to be released under the same license. (A full description of the license is at https://creativecommons.org/licenses/by-sa/4.0/legalcode). The intent is to be as faithful as possible to the original meaning without being awkward or misleading. The style is contemporary English, avoiding slang or colloquialisms, speaking to our modern society in a way people will understand. The Free Bible Version is a project of Free Bible Ministry www.freebibleministry.org',
-    copyright_short:
+    copyright:
       'Dr. Jonathan Gallagher. Released under Creative Commons Attribution-ShareAlike 4.0 Unported License. Version 4.3. For corrections send email to jonathangallagherfbv@gmail.com',
     info: null,
     publisher_url: null,
@@ -1027,9 +1027,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 2660,
     abbreviation: 'LSV',
-    copyright_long:
+    promotional_content:
       'The Literal Standard Version of The Holy Bible is a registered copyright of Covenant Press and the Covenant Christian Coalition (© 2020), but has been subsequently released under the Creative Commons Attribution-ShareAlike license (CC BY-SA) per our desire to provide God’s word freely. Covenant Press requests that the text remain unaltered in the English language and that translations based on the LSV maintain the same spirit of faithfulness to the original Hebrew, Aramaic, and Greek text. Attribution of minor citations for personal or non-commercial use can be provided as simply “LSV” or “Literal Standard Version.” Citations for commercial use, or distribution of the entire LSV Bible or entire book(s) of the LSV Bible, must be fully attributed and include both “Literal Standard Version (LSV)” and the name of our organization. Covenant Press is soliciting partnerships with Bible publishers that are interested in the LSV project. For queries about partnering with us, please email the translation team at covenantpress@ccc.one. To learn more, visit lsvbible.com. The purpose behind the LSV is to provide readers with a modern, easy-to-read, literal, and accurate translation of the Bible that is free to read, distribute, and translate from. We pray that God will use the LSV to illuminate the hearts and minds of multitudes with the good news that His Son Jesus Christ came in the flesh, died for our sins as a substitutionary sacrifice, rose bodily from the dead, and is coming back again.',
-    copyright_short:
+    copyright:
       'The Literal Standard Version of The Holy Bible is a registered copyright of Covenant Press and the Covenant Christian Coalition (© 2020), but has been subsequently released under the Creative Commons Attribution-ShareAlike license (CC BY-SA) per our desire to provide God’s word freely. Covenant Press requests that the text remain unaltered in the English language and that translations based on the LSV maintain the same spirit of faithfulness to the original Hebrew, Aramaic, and Greek text. Attribution of minor citations for personal or non-commercial use can be provided as simply “LSV” or “Literal Standard Version.” Citations for commercial use, or distribution of the entire LSV Bible or entire book(s) of the LSV Bible, must be fully attributed and include both “Literal Standard Version (LSV)” and the name of our organization. Covenant Press is soliciting partnerships with Bible publishers that are interested in the LSV project. For queries about partnering with us, please email the translation team at covenantpress@ccc.one. To learn more, visit lsvbible.com. The purpose behind the LSV is to provide readers with a modern, easy-to-read, literal, and accurate translation of the Bible that is free to read, distribute, and translate from. We pray that God will use the LSV to illuminate the hearts and minds of multitudes with the good news that His Son Jesus Christ came in the flesh, died for our sins as a substitutionary sacrifice, rose bodily from the dead, and is coming back again.',
     info: null,
     publisher_url: null,
@@ -1111,8 +1111,8 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 3034,
     abbreviation: 'BSB',
-    copyright_long: 'https://berean.bible/',
-    copyright_short:
+    promotional_content: 'https://berean.bible/',
+    copyright:
       "The Holy Bible, Berean Standard Bible, BSB is produced in cooperation with Bible Hub, Discovery Bible, OpenBible.com, and the Berean Bible Translation Committee. This text of God's Word has been dedicated to the public domain.",
     info: null,
     publisher_url: null,
@@ -1194,9 +1194,9 @@ export const mockVersions: BibleVersion[] = [
   {
     id: 3427,
     abbreviation: 'TCENT',
-    copyright_long:
+    promotional_content:
       'Copyright © 2022 Robert Adam Boyd\nThe Text-Critical English New Testament and the Byzantine Text Version are made available to you under the terms of the Creative Commons Attribution license 4.0.\nYou are free to:\nShare — copy and redistribute the material in any medium or format\nAdapt — remix, transform, and build upon the material for any purpose, even commercially,\nUnder the following terms:\nAttribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.\nNo additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.\n"The Text-Critical English New Testament" and "Byzantine Text Version" are trademarks of Robert Adam Boyd. If you adapt, remix, transform, or in any other way change the translation or footnotes, you may not call it "The Text-Critical English New Testament" or "Byzantine Text Version".',
-    copyright_short: 'Copyright © 2022 Robert Adam Boyd',
+    copyright: 'Copyright © 2022 Robert Adam Boyd',
     info: null,
     publisher_url: null,
     language_tag: 'en',

package/src/schemas/bible-index.ts

@@ -8,7 +8,7 @@ const BibleIndexVerseSchema = z.object({
   title: z.string(),
 });
 
-export type BibleIndexVerse = z.infer<typeof BibleIndexVerseSchema>;
+export type BibleIndexVerse = Readonly<z.infer<typeof BibleIndexVerseSchema>>;
 
 const BibleIndexChapterSchema = z.object({
   /** Chapter identifier */
@@ -19,7 +19,7 @@ const BibleIndexChapterSchema = z.object({
   verses: z.array(BibleIndexVerseSchema),
 });
 
-export type BibleIndexChapter = z.infer<typeof BibleIndexChapterSchema>;
+export type BibleIndexChapter = Readonly<z.infer<typeof BibleIndexChapterSchema>>;
 
 const BibleIndexBookSchema = z.object({
   /** Book identifier */
@@ -36,7 +36,7 @@ const BibleIndexBookSchema = z.object({
   chapters: z.array(BibleIndexChapterSchema),
 });
 
-export type BibleIndexBook = z.infer<typeof BibleIndexBookSchema>;
+export type BibleIndexBook = Readonly<z.infer<typeof BibleIndexBookSchema>>;
 
 const _BibleIndexSchema = z.object({
   /** Text direction (e.g., "ltr") */
@@ -45,4 +45,4 @@ const _BibleIndexSchema = z.object({
   books: z.array(BibleIndexBookSchema),
 });
 
-export type BibleIndex = z.infer<typeof _BibleIndexSchema>;
+export type BibleIndex = Readonly<z.infer<typeof _BibleIndexSchema>>;

package/src/schemas/book.ts

@@ -3,7 +3,7 @@ import { BOOK_IDS } from '../utils/constants';
 import { BibleChapterSchema } from './chapter';
 
 export const CanonSchema = z.enum(['old_testament', 'new_testament', 'deuterocanon']);
-export type Canon = z.infer<typeof CanonSchema>;
+export type Canon = Readonly<z.infer<typeof CanonSchema>>;
 
 // https://github.com/colinhacks/zod/discussions/4934#discussioncomment-13858053
 export const BookUsfmSchema = z.union([
@@ -27,5 +27,5 @@ export const BibleBookSchema = z.object({
   chapters: z.array(BibleChapterSchema).optional(),
 });
 
-export type BibleBook = z.infer<typeof BibleBookSchema>;
-export type CANON = z.infer<typeof CanonSchema>;
+export type BibleBook = Readonly<z.infer<typeof BibleBookSchema>>;
+export type CANON = Readonly<z.infer<typeof CanonSchema>>;

package/src/schemas/chapter.ts

@@ -12,4 +12,4 @@ export const BibleChapterSchema = z.object({
   verses: z.array(BibleVerseSchema).optional(),
 });
 
-export type BibleChapter = z.infer<typeof BibleChapterSchema>;
+export type BibleChapter = Readonly<z.infer<typeof BibleChapterSchema>>;

package/src/schemas/collection.ts

@@ -21,8 +21,8 @@ const _CollectionSchema = <T extends z.ZodTypeAny>(
 /**
  * Generic Collection type for paginated responses
  */
-export type Collection<T> = {
+export type Collection<T> = Readonly<{
   data: T[];
   next_page_token: string | null;
   total_size?: number;
-};
+}>;

package/src/schemas/language.ts

@@ -35,4 +35,4 @@ export const LanguageSchema = z.object({
   default_bible_version_id: z.number().int().nullable().optional(),
 });
 
-export type Language = z.infer<typeof LanguageSchema>;
+export type Language = Readonly<z.infer<typeof LanguageSchema>>;

package/src/schemas/passage.ts

@@ -9,4 +9,4 @@ export const BiblePassageSchema = z.object({
   reference: z.string(),
 });
 
-export type BiblePassage = z.infer<typeof BiblePassageSchema>;
+export type BiblePassage = Readonly<z.infer<typeof BiblePassageSchema>>;

package/src/schemas/verse.ts

@@ -9,4 +9,4 @@ export const BibleVerseSchema = z.object({
   title: z.string(),
 });
 
-export type BibleVerse = z.infer<typeof BibleVerseSchema>;
+export type BibleVerse = Readonly<z.infer<typeof BibleVerseSchema>>;

package/src/schemas/version.ts

@@ -7,9 +7,9 @@ export const BibleVersionSchema = z.object({
   /** Bible version abbreviation */
   abbreviation: z.string(),
   /** Long copyright text */
-  copyright_long: z.string().nullable().optional(),
+  promotional_content: z.string().nullable().optional(),
   /** Short copyright text */
-  copyright_short: z.string().nullable().optional(),
+  copyright: z.string().nullable().optional(),
   /** Bible information text */
   info: z.string().nullable().optional(),
   /** Publisher URL */
@@ -30,4 +30,4 @@ export const BibleVersionSchema = z.object({
   youversion_deep_link: z.url(),
 });
 
-export type BibleVersion = z.infer<typeof BibleVersionSchema>;
+export type BibleVersion = Readonly<z.infer<typeof BibleVersionSchema>>;

package/src/schemas/votd.ts

@@ -7,4 +7,4 @@ export const VOTDSchema = z.object({
   passage_id: z.string(),
 });
 
-export type VOTD = z.infer<typeof VOTDSchema>;
+export type VOTD = Readonly<z.infer<typeof VOTDSchema>>;

package/src/types/auth.ts

@@ -7,12 +7,12 @@ export type SignInWithYouVersionPermissionValues =
   (typeof SignInWithYouVersionPermission)[keyof typeof SignInWithYouVersionPermission];
 
 export interface AuthenticationState {
-  isAuthenticated: boolean;
-  isLoading: boolean;
-  accessToken: string | null;
-  idToken: string | null;
-  result: SignInWithYouVersionResult | null;
-  error: Error | null;
+  readonly isAuthenticated: boolean;
+  readonly isLoading: boolean;
+  readonly accessToken: string | null;
+  readonly idToken: string | null;
+  readonly result: SignInWithYouVersionResult | null;
+  readonly error: Error | null;
 }
 
 export type AuthenticationScopes = 'profile' | 'email';

package/src/types/book.ts

@@ -1,11 +1,11 @@
-export type BibleBook = {
+export type BibleBook = Readonly<{
   id: BOOK_ID; // Book identifier (USFM)
   title: string;
   abbreviation?: string; // Book name abbreviation if provided by publisher
   canon: CANON;
   // eslint-disable-next-line @typescript-eslint/array-type -- Array<> syntax required for template literal type to represent chapter references
   chapters?: Array<`${BOOK_ID}.${number | `INTRO${number}`}`>; // Ordered list of chapter ids for given Bible and book (e.g., ["GEN.1", "GEN.2", "3JN.INTRO1", "3JN.1"])
-};
+}>;
 
 export type BOOK_ID =
   | 'GEN'

package/src/types/chapter.ts

@@ -1,5 +1,5 @@
-export type BibleChapter = {
+export type BibleChapter = Readonly<{
   usfm: string;
   title: string;
   content?: string;
-};
+}>;