@youversion/platform-react-native 0.7.2 → 0.8.0

package/src/api/bible.ts

@@ -1,9 +1,9 @@
 import { Module } from "../native";
-import { BibleReference, BibleVersion } from "../types";
+import { BibleReferenceBase, BibleVersion } from "../types";
 
 export const BibleAPI = {
   /**
-   * Retrieves a list of Bible versions available for a specified language code (like "en").
+   * Retrieves a list of Bible versions available for a specified language tag (like "eng").
    *
    * @param languageTag - An optional language code per BCP 47 for filtering available Bible versions. If `nil`
    *     the function returns versions for all languages.
@@ -26,10 +26,10 @@ export const BibleAPI = {
   /**
    * Retrieves the content of a single Bible chapter from the server as an HTML string.
    *
-   * @param bibleReference - A {@link BibleReference} object specifying the reference to retrieve.
+   * @param bibleReference - A {@link BibleReferenceBase} object specifying the reference to retrieve.
    * @returns The chapter content as an HTML string.
    */
-  getChapter(bibleReference: BibleReference): Promise<string> {
+  getChapter(bibleReference: BibleReferenceBase): Promise<string> {
     return Module.chapter(bibleReference);
   },
 };

package/src/api/users.ts

@@ -26,10 +26,9 @@ export const UsersAPI = {
   /**
    * Retrieves user information for the authenticated user using the provided access token.
    *
-   * @param accessToken - Optionally provide an accessToken, or use the one stored in the SDK after the user signs in
    * @returns A promise that resolves to the user information as a {@link YouVersionUserInfo} object.
    */
-  userInfo(accessToken?: string): Promise<YouVersionUserInfo> {
-    return Module.userInfo(accessToken);
+  userInfo(): Promise<YouVersionUserInfo> {
+    return Module.userInfo();
   },
 };

package/src/native.ts

@@ -1,7 +1,7 @@
 import { NativeModule, requireNativeModule } from "expo";
 
 import {
-  BibleReference,
+  BibleReferenceBase,
   BibleVersion,
   HighlightResponse,
   LanguageOverview,
@@ -19,7 +19,7 @@ declare class RNYouVersionPlatformModule extends NativeModule {
 
   signOut(): Promise<void>;
 
-  userInfo(accessToken?: string): Promise<YouVersionUserInfo>;
+  userInfo(): Promise<YouVersionUserInfo>;
 
   verseOfTheDay(dayOfYear: number): Promise<YouVersionVerseOfTheDay>;
 
@@ -48,7 +48,7 @@ declare class RNYouVersionPlatformModule extends NativeModule {
 
   version(versionId: number): Promise<BibleVersion>;
 
-  chapter(bibleReference: BibleReference): Promise<string>;
+  chapter(bibleReference: BibleReferenceBase): Promise<string>;
 
   getAccessToken(): string | null;
 }

package/src/types.ts

@@ -9,20 +9,16 @@ export type SignInWithYouVersionResult = {
   name?: string;
   profilePicture?: string;
   email?: string;
+  idToken?: string;
 };
 
-export type SignInWithYouVersionPermission =
-  | "bibles"
-  | "highlights"
-  | "votd"
-  | "demographics"
-  | "bible_activity";
+export type SignInWithYouVersionPermission = "openid" | "email" | "profile";
 
 export interface YouVersionUserInfo {
-  firstName?: string;
-  lastName?: string;
-  userId?: string;
-  avatarUrl?: string;
+  name?: string;
+  email?: string;
+  id?: string;
+  profilePicture?: string;
 }
 
 export interface YouVersionVerseOfTheDay {
@@ -88,9 +84,14 @@ export interface BibleTextOptions {
   renderVerseNumbers?: boolean | null | undefined;
 }
 
-export type BibleTextFootnoteMode = "none" | "inline" | "marker";
+export type BibleTextFootnoteMode =
+  | "none"
+  | "inline"
+  | "marker"
+  | "letters"
+  | "image";
 
-interface BibleReferenceBase {
+export interface BibleReferenceBase {
   /** The ID of the Bible version */
   versionId: number;
 
@@ -139,12 +140,9 @@ export type BibleReference =
 export interface OnBibleTextPressEvent {
   /** A reference to the Bible verse that was pressed */
   bibleReference: BibleReferenceVerse;
-
-  /** The coordinates of the press event */
-  point: {
-    x: number;
-    y: number;
-  };
+  urlScheme: string;
+  /** Not implemented yet */
+  footnotes: unknown[];
 }
 
 export interface LanguageOverview {
@@ -222,7 +220,7 @@ export interface LanguageOverview {
    *
    * @example 111
    */
-  defaultBibleVersionId?: number;
+  defaultBibleId?: number;
 }
 
 export interface HighlightResponse {
@@ -273,14 +271,14 @@ export interface BibleVersion {
    *
    * @example "<p>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. </p> <p>At 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. </p> <p>To learn more, visit <a href="https://www.biblica.com/privacy-policy/">biblica.com</a> and <a href="http://facebook.com/Biblica">facebook.com/Biblica</a>.</p> <p> </p>"
    */
-  copyrightLong?: string;
+  promotionalContent?: string;
 
   /**
    * Short version of the copyright text provided by the publisher for the given Bible version.
    *
    * @example "The Holy Bible, New International Version® NIV® Copyright © 1973, 1978, 1984, 2011 by Biblica, Inc.® Used by Permission of Biblica, Inc.® All rights reserved worldwide."
    */
-  copyrightShort?: string;
+  copyright?: string;
 
   /**
    * BCP47 canonical language tag for this Bible version
@@ -329,15 +327,18 @@ export interface BibleVersion {
    * @example "ltr"
    */
   textDirection?: string;
+
+  /** uuid */
+  organizationId?: string;
 }
 
 export interface BibleBook {
   /**
-   * Standard book identifier for the Unified Scripture Format Markup (USFM) used in Scripture text processing
+   * Book identifier
    *
    * @example "GEN"
    */
-  usfm?: string;
+  id?: string;
 
   /**
    * Book name abbreviation if provided by the publisher
@@ -352,19 +353,31 @@ export interface BibleBook {
    * @example "Genesis"
    */
   title?: string;
-  titleLong?: string;
+
+  /**
+   * Full book title if available
+   *
+   * @example "The Book of Genesis"
+   */
+  fullTitle?: string;
+
+  /**
+   * Indicates if this is Old Testament, New Testament, or Deuterocanonical
+   *
+   * @example "new_testament"
+   */
+  canon?: "new_testament" | "old_testament" | "deuterocanon";
+
   chapters?: BibleChapter[];
 }
 
 export interface BibleChapter {
   /**
-   * Book identifier
+   * Chapter identifier based off the USFM reference
    *
-   * @example "GEN"
+   * @example 1
    */
-  bookUSFM?: string;
-
-  isCanonical?: boolean;
+  id?: string;
 
   /**
    * Canonical representation of the passage