@youversion/platform-react-native 0.7.2

package/src/components/BibleWidgetView.tsx

@@ -0,0 +1,45 @@
+import { requireNativeView } from "expo";
+import { StyleProp, StyleSheet, ViewStyle } from "react-native";
+
+import { BibleReference } from "../types";
+
+const NativeView: React.ComponentType<NativeProps> =
+  requireNativeView("BibleWidgetView");
+
+/**
+ * An opinionated Bible passage display.
+ * It displays the book, chapter and version name above the passage. Below the passage text, it displays copyright information and the YouVersion logo.
+ * @param props - {@link BibleWidgetViewProps}
+ */
+export function BibleWidgetView({ reference, ...props }: BibleWidgetViewProps) {
+  return <NativeView {...(reference || {})} style={styles.view} {...props} />;
+}
+
+const styles = StyleSheet.create({
+  view: {
+    alignSelf: "stretch",
+  },
+});
+
+export interface BibleWidgetViewProps {
+  /** A reference to a passage in the Bible. This could be a single verse, a range of verses or the entire chapter */
+  reference: BibleReference;
+
+  /** The font size to use for the Bible text
+   *
+   * @defaultValue 23
+   */
+  fontSize?: number | null | undefined;
+
+  /**
+   * Controls the color scheme of the button
+   *
+   * * @defaultValue Uses the system color scheme
+   */
+  colorScheme?: "light" | "dark" | null | undefined;
+}
+
+type NativeProps = Omit<BibleWidgetViewProps, "reference"> &
+  BibleReference & {
+    style?: StyleProp<ViewStyle>;
+  };

package/src/components/SignInWithYouVersionButton.tsx

@@ -0,0 +1,70 @@
+import { requireNativeView } from "expo";
+import { StyleProp, ViewStyle } from "react-native";
+
+const NativeView: React.ComponentType<NativeProps> = requireNativeView(
+  "SignInWithYouVersionButton",
+);
+
+type NativeProps = Omit<SignInWithYouVersionButtonProps, "onPress"> & {
+  onTap?: () => void;
+};
+
+export interface SignInWithYouVersionButtonProps {
+  /** Controls the width and text of the button
+   *
+   * @defaultValue "full"
+   */
+  mode?: SignInWithYouVersionButtonMode;
+
+  /** Controls the border radius of the button
+   *
+   * @defaultValue "capsule"
+   */
+  shape?: SignInWithYouVersionButtonShape;
+
+  /** Controls if the button is outlined
+   *
+   * @defaultValue true
+   */
+  isStroked?: boolean;
+
+  /**
+   * Controls the color scheme of the button
+   *
+   * @defaultValue Uses the system color scheme
+   */
+  colorScheme?: "light" | "dark";
+
+  /** Called when the user taps the button. You should call the signIn function in response */
+  onPress?: () => void;
+  style?: StyleProp<ViewStyle>;
+}
+
+export type SignInWithYouVersionButtonMode = "full" | "compact" | "iconOnly";
+export type SignInWithYouVersionButtonShape = "capsule" | "rectangle";
+
+/**
+ * A branded button for signing in with YouVersion.
+ * This button is a lightweight wrapper around the native YouVersion sign-in button. It contains
+ * localized sign-in text and the YouVersion logo.
+ * @param props - {@link SignInWithYouVersionButtonProps}
+ */
+export function SignInWithYouVersionButton({
+  onPress,
+  mode = "full",
+  shape = "capsule",
+  isStroked = true,
+  colorScheme,
+  ...props
+}: SignInWithYouVersionButtonProps) {
+  return (
+    <NativeView
+      {...props}
+      mode={mode}
+      shape={shape}
+      isStroked={isStroked}
+      colorScheme={colorScheme}
+      onTap={onPress}
+    />
+  );
+}

package/src/components/VotdView.tsx

@@ -0,0 +1,36 @@
+import { requireNativeView } from "expo";
+import { StyleProp, StyleSheet, ViewStyle } from "react-native";
+
+const NativeView: React.ComponentType<NativeProps> =
+  requireNativeView("VotdView");
+
+export function VotdView({ bibleVersionId = 111, ...props }: VotdViewProps) {
+  return (
+    <NativeView
+      style={styles.view}
+      bibleVersionId={bibleVersionId}
+      {...props}
+    />
+  );
+}
+
+const styles = StyleSheet.create({
+  view: {
+    alignSelf: "stretch",
+  },
+});
+
+export interface VotdViewProps {
+  bibleVersionId?: number | null | undefined;
+
+  /**
+   * Controls the color scheme of the text. "dark" would mean to use light text on a dark background, and "light" would mean to use dark text on a light background.
+   *
+   * * @defaultValue Uses the system color scheme
+   */
+  colorScheme?: "light" | "dark" | null | undefined;
+}
+
+interface NativeProps extends VotdViewProps {
+  style: StyleProp<ViewStyle>;
+}

package/src/components/index.ts

@@ -0,0 +1,5 @@
+export * from "./SignInWithYouVersionButton";
+export * from "./BibleTextView";
+export * from "./VotdView";
+export * from "./BibleReaderView";
+export * from "./BibleWidgetView";

package/src/index.ts

@@ -0,0 +1,5 @@
+// Exports components and types from here
+export * from "./platform";
+export * from "./api";
+export * from "./types";
+export * from "./components";

package/src/native.ts

@@ -0,0 +1,58 @@
+import { NativeModule, requireNativeModule } from "expo";
+
+import {
+  BibleReference,
+  BibleVersion,
+  HighlightResponse,
+  LanguageOverview,
+  SignInWithYouVersionResult,
+  YouVersionUserInfo,
+  YouVersionVerseOfTheDay,
+} from "./types";
+
+declare class RNYouVersionPlatformModule extends NativeModule {
+  configure(appKey: string): void;
+
+  setApiHost(apiHost: string): void;
+
+  signIn(permissions: string[]): Promise<SignInWithYouVersionResult>;
+
+  signOut(): Promise<void>;
+
+  userInfo(accessToken?: string): Promise<YouVersionUserInfo>;
+
+  verseOfTheDay(dayOfYear: number): Promise<YouVersionVerseOfTheDay>;
+
+  createHighlight(
+    versionId: number,
+    passageId: string,
+    color: string,
+  ): Promise<boolean>;
+
+  getHighlights(
+    versionId: number,
+    passageId: string,
+  ): Promise<HighlightResponse[]>;
+
+  updateHighlight(
+    versionId: number,
+    passageId: string,
+    color: string,
+  ): Promise<boolean>;
+
+  deleteHighlight(versionId: number, passageId: string): Promise<boolean>;
+
+  languages(country?: string): Promise<LanguageOverview[]>;
+
+  versions(languageTag?: string): Promise<BibleVersion[]>;
+
+  version(versionId: number): Promise<BibleVersion>;
+
+  chapter(bibleReference: BibleReference): Promise<string>;
+
+  getAccessToken(): string | null;
+}
+
+export const Module = requireNativeModule<RNYouVersionPlatformModule>(
+  "RNYouVersionPlatform",
+);

package/src/platform.ts

@@ -0,0 +1,30 @@
+import { Module } from "./native";
+
+export const YouVersionPlatform = {
+  /**
+   * Function to configure YouVersionPlatform.
+   * Run this once during your app's initialization.
+   *
+   * @param appKey - The application key provided for your app.
+   *
+   * @example
+   * // During app initialization:
+   * YouVersionPlatform.configure('YOUR_APP_KEY');
+   */
+  configure(appKey: string) {
+    return Module.configure(appKey);
+  },
+
+  setApiHost(apiHost: string) {
+    return Module.setApiHost(apiHost);
+  },
+
+  /**
+   * Retrieves the currently cached access token for the authenticated user.
+   *
+   * @returns The access token as a string, or null if not available.
+   */
+  getAccessToken(): string | null {
+    return Module.getAccessToken();
+  },
+};

package/src/types.ts

@@ -0,0 +1,382 @@
+import { ColorValue } from "react-native";
+
+export type SignInWithYouVersionResult = {
+  accessToken?: string;
+  permissions: SignInWithYouVersionPermission[];
+  yvpUserId?: string;
+  expiryDate?: string;
+  refreshToken?: string;
+  name?: string;
+  profilePicture?: string;
+  email?: string;
+};
+
+export type SignInWithYouVersionPermission =
+  | "bibles"
+  | "highlights"
+  | "votd"
+  | "demographics"
+  | "bible_activity";
+
+export interface YouVersionUserInfo {
+  firstName?: string;
+  lastName?: string;
+  userId?: string;
+  avatarUrl?: string;
+}
+
+export interface YouVersionVerseOfTheDay {
+  passageId: string;
+  day: number;
+}
+
+export interface BibleTextOptions {
+  /**
+   * Controls the font family of the Bible text
+   *
+   * @defaultValue "Times New Roman"
+   */
+  fontFamily?: string | null | undefined;
+
+  /**
+   * Controls the font size of the Bible text
+   *
+   * @defaultValue 16
+   */
+  fontSize?: number | null | undefined;
+
+  /**
+   * Controls the line spacing of the Bible text
+   *
+   * @defaultValue `fontSize` / 2
+   */
+  lineSpacing?: number | null | undefined;
+
+  /**
+   * Controls the spacing between paragraphs in the Bible text
+   *
+   * @defaultValue `fontSize` / 2
+   */
+  paragraphSpacing?: number | null | undefined;
+
+  /**
+   * Controls the text color of the Bible text
+   *
+   * @defaultValue Theme dependent text color
+   */
+  textColor?: ColorValue | null | undefined;
+
+  /**
+   * Controls the color of the words of Christ (WOC) in the Bible text
+   *
+   * @defaultValue "#FF3D4D" in light mode, "#F04C59" in dark mode
+   */
+  wocColor?: ColorValue | null | undefined;
+
+  /**
+   * Controls how footnotes are displayed in the Bible text
+   *
+   * @defaultValue "none"
+   */
+  footnoteMode?: BibleTextFootnoteMode | null | undefined;
+
+  /**
+   * Controls whether verse numbers are rendered in the Bible text
+   *
+   * @defaultValue true
+   */
+  renderVerseNumbers?: boolean | null | undefined;
+}
+
+export type BibleTextFootnoteMode = "none" | "inline" | "marker";
+
+interface BibleReferenceBase {
+  /** The ID of the Bible version */
+  versionId: number;
+
+  /** The book identifier */
+  bookUSFM: string;
+
+  /** The chapter number */
+  chapter: number;
+}
+
+/**
+ * A reference to a range of verses
+ */
+export interface BibleReferenceVerseRange extends BibleReferenceBase {
+  type: "range";
+  verseStart: number;
+  verseEnd: number;
+  verse?: never;
+}
+
+/**
+ * A reference to an entire chapter in the Bible
+ */
+export interface BibleReferenceChapter extends BibleReferenceBase {
+  type: "chapter";
+  verse?: never;
+  verseStart?: never;
+  verseEnd?: never;
+}
+
+/**
+ * A reference to a single verse in the Bible
+ */
+export interface BibleReferenceVerse extends BibleReferenceBase {
+  type: "verse";
+  verse: number;
+  verseStart?: never;
+  verseEnd?: never;
+}
+
+export type BibleReference =
+  | BibleReferenceVerseRange
+  | BibleReferenceChapter
+  | BibleReferenceVerse;
+
+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;
+  };
+}
+
+export interface LanguageOverview {
+  /**
+   * Canonical BCP 47 id limited to language or language+script. Region, variants, and extensions are not allowed.
+   *
+   * @example "en"
+   */
+  id: string;
+
+  /**
+   * ISO 639 canonical language subtag
+   *
+   * @example "sr"
+   */
+  language: string;
+
+  /**
+   * ISO 15924 script code if present in id
+   *
+   * @example "Latn"
+   */
+  script?: string;
+
+  /**
+   * The English name for the script
+   *
+   * @example "Latin"
+   */
+  scriptName?: string;
+
+  /**
+   * Deprecated or legacy subtags mapped during canonicalization for this language.
+   *
+   * @example []
+   */
+  aliases: string[];
+
+  /**
+   * Localized display names for the language/script combination
+   * @example { "en": "Chechen" }
+   */
+  displayNames: Record<string, string>;
+
+  /**
+   * All scripts known for this language (CLDR/ISO-15924)
+   *
+   * @example ["Cyrl", "Latn"]
+   */
+  scripts: string[];
+
+  /**
+   * Variants associated with this language (not part of the id)
+   *
+   * @example ["1996","fonipa"]
+   */
+  variants: string[];
+
+  /**
+   * Ids of countries where this language is used or supported. Extended details can be retrieved from the countries API with the provided id.
+   *
+   * @example ["RS","BA","ME"]
+   */
+  countries: string[];
+
+  /**
+   * Default text direction for this language. ltr is left to right and rtl is right to left.
+   *
+   * @example "ltr"
+   */
+  textDirection: string;
+
+  /**
+   * The chosen default Bible version for this language.
+   *
+   * @example 111
+   */
+  defaultBibleVersionId?: number;
+}
+
+export interface HighlightResponse {
+  id?: string;
+
+  /**
+   * Bible version identifier
+   *
+   * @example 111
+   */
+  bibleId: number;
+
+  /**
+   * The passage identifier (verse USFM format)
+   *
+   * @example "MAT.1.1"
+   */
+  passageId: string;
+
+  /**
+   * The highlight color in hex format
+   *
+   * @example "#44aa44"
+   */
+  color: string;
+  userId?: string;
+  createTime?: string;
+  updateTime?: string;
+}
+
+export interface BibleVersion {
+  /**
+   * Bible version identifier
+   *
+   * @example 111
+   */
+  id: number;
+
+  /**
+   * Bible version abbreviation
+   *
+   * @example "NIV"
+   */
+  abbreviation?: string;
+
+  /**
+   * Longer form of copyright text provided by the publisher for the given Bible version.
+   *
+   * @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;
+
+  /**
+   * 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;
+
+  /**
+   * BCP47 canonical language tag for this Bible version
+   *
+   * @example "en"
+   */
+  languageTag?: string;
+
+  /**
+   * Localized Bible version abbreviation
+   *
+   * @example "NIV"
+   */
+  localizedAbbreviation?: string;
+
+  /**
+   * Localized title of Bible version
+   *
+   * @example "New International Version"
+   */
+  localizedTitle?: string;
+
+  readerFooter?: string;
+  readerFooterUrl?: string;
+
+  /**
+   * English title of Bible version
+   *
+   * @example "New International Version 2011"
+   */
+  title?: string;
+
+  /**
+   * Array of book codes for this Bible version
+   *
+   * @example ["GEN","EXO","LEV"]
+   */
+  bookCodes?: string[];
+
+  /** Array of Bible books for this Bible version */
+  books?: BibleBook[];
+
+  /**
+   * Default text direction for this language. ltr is left to right and rtl is right to left.
+   *
+   * @example "ltr"
+   */
+  textDirection?: string;
+}
+
+export interface BibleBook {
+  /**
+   * Standard book identifier for the Unified Scripture Format Markup (USFM) used in Scripture text processing
+   *
+   * @example "GEN"
+   */
+  usfm?: string;
+
+  /**
+   * Book name abbreviation if provided by the publisher
+   *
+   * @example "Gen"
+   */
+  abbreviation?: string;
+
+  /**
+   * Book title
+   *
+   * @example "Genesis"
+   */
+  title?: string;
+  titleLong?: string;
+  chapters?: BibleChapter[];
+}
+
+export interface BibleChapter {
+  /**
+   * Book identifier
+   *
+   * @example "GEN"
+   */
+  bookUSFM?: string;
+
+  isCanonical?: boolean;
+
+  /**
+   * Canonical representation of the passage
+   *
+   * @example "GEN.1"
+   */
+  passageId?: string;
+
+  /**
+   * Human readable chapter title
+   *
+   * @example "1"
+   */
+  title?: string;
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+// @generated by expo-module-scripts
+{
+  "extends": "expo-module-scripts/tsconfig.base",
+  "compilerOptions": {
+    "outDir": "./build"
+  },
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*", "**/__rsc_tests__/*"]
+}