@youversion/platform-react-native 0.7.2

package/scripts/release-local.sh

@@ -0,0 +1,224 @@
+#!/bin/bash
+# Local release helper script for branch-protected repositories
+# This script automates the local release workflow while respecting branch protection rules
+
+set -e  # Exit on error
+
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+BLUE='\033[0;34m'
+NC='\033[0m' # No Color
+
+# Configuration
+REPO_URL="https://github.com/youversion/platform-sdk-reactnative"
+
+# Helper functions
+print_step() {
+    echo -e "\n${BLUE}==>${NC} ${GREEN}$1${NC}\n"
+}
+
+print_warning() {
+    echo -e "${YELLOW}⚠️  $1${NC}"
+}
+
+print_error() {
+    echo -e "${RED}❌ Error: $1${NC}"
+}
+
+print_success() {
+    echo -e "${GREEN}✅ $1${NC}"
+}
+
+# Check prerequisites
+check_prerequisites() {
+    print_step "Checking prerequisites..."
+
+    # Check if we're in a git repo
+    if ! git rev-parse --git-dir > /dev/null 2>&1; then
+        print_error "Not in a git repository"
+        exit 1
+    fi
+
+    # Check if GITHUB_TOKEN is set
+    if [ -z "$GITHUB_TOKEN" ]; then
+        print_warning "GITHUB_TOKEN not set"
+        echo "Please set GITHUB_TOKEN environment variable:"
+        echo "  export GITHUB_TOKEN=your_token"
+        exit 1
+    fi
+
+    # Check if NPM_TOKEN is set (optional but recommended)
+    if [ -z "$NPM_TOKEN" ]; then
+        print_warning "NPM_TOKEN not set (you may be prompted for npm login)"
+    fi
+
+    # Check if gh CLI is available
+    if ! command -v gh &> /dev/null; then
+        print_warning "GitHub CLI (gh) not found - you'll need to create PR manually"
+        HAS_GH_CLI=false
+    else
+        HAS_GH_CLI=true
+    fi
+
+    print_success "Prerequisites checked"
+}
+
+# Ensure we're on main and up to date
+ensure_main_updated() {
+    print_step "Ensuring main branch is up to date..."
+
+    git checkout main
+    git pull origin main
+
+    print_success "Main branch updated"
+}
+
+# Preview the release
+preview_release() {
+    print_step "Previewing release (dry-run)..."
+
+    npm run release:dry-run
+
+    echo ""
+    read -p "Continue with this release? (y/N): " -n 1 -r
+    echo
+    if [[ ! $REPLY =~ ^[Yy]$ ]]; then
+        print_warning "Release cancelled"
+        exit 0
+    fi
+}
+
+# Create release branch
+create_release_branch() {
+    print_step "Creating release branch..."
+
+    # Get next version from dry-run output
+    BRANCH_NAME="release/prepare-$(date +%Y%m%d-%H%M%S)"
+
+    git checkout -b "$BRANCH_NAME"
+
+    print_success "Created branch: $BRANCH_NAME"
+}
+
+# Create local release config
+create_local_config() {
+    print_step "Creating local release configuration..."
+
+    cat > .releaserc.local.json << 'EOF'
+{
+  "extends": "./.releaserc.json",
+  "branches": [
+    "main",
+    { "name": "release/*", "channel": false }
+  ]
+}
+EOF
+
+    print_success "Local configuration created"
+}
+
+# Run semantic-release
+run_release() {
+    print_step "Running semantic-release..."
+
+    npx semantic-release --extends ./.releaserc.local.json --no-ci
+
+    print_success "Release completed - package published to npm!"
+}
+
+# Push branch and tags
+push_release() {
+    print_step "Pushing release branch and tags..."
+
+    git push origin "$BRANCH_NAME"
+    git push origin --tags
+
+    print_success "Branch and tags pushed"
+}
+
+# Create PR
+create_pr() {
+    print_step "Creating pull request..."
+
+    # Get version from package.json
+    VERSION=$(node -p "require('./package.json').version")
+
+    if [ "$HAS_GH_CLI" = true ]; then
+        gh pr create \
+            --base main \
+            --head "$BRANCH_NAME" \
+            --title "chore(release): $VERSION" \
+            --body "Release version $VERSION
+
+This PR merges the release commit back to main after publishing to npm.
+
+- Version: $VERSION
+- Published to npm: ✅
+- GitHub release created: ✅
+
+**Merge Instructions:**
+- Use 'Create a merge commit' (preferred) or 'Squash and merge'
+- Do NOT use 'Rebase and merge'
+
+---
+
+Released via local release workflow (branch protection compliant)"
+
+        print_success "Pull request created!"
+        print_success "View PR: $(gh pr view --web 2>&1 | grep -o 'https://.*')"
+    else
+        print_warning "GitHub CLI not available"
+        echo "Please create PR manually:"
+        echo "  $REPO_URL/compare/main...$BRANCH_NAME"
+    fi
+}
+
+# Cleanup
+cleanup() {
+    print_step "Cleaning up..."
+
+    git checkout main
+
+    if [ -f .releaserc.local.json ]; then
+        rm .releaserc.local.json
+        print_success "Removed local config"
+    fi
+
+    echo ""
+    print_success "Release process complete!"
+    echo ""
+    echo "Next steps:"
+    echo "  1. Wait for PR approvals (1 reviewer + code owner)"
+    echo "  2. Resolve any review threads"
+    echo "  3. Merge the PR using 'Create a merge commit' or 'Squash and merge'"
+    echo "  4. Delete the release branch: git branch -D $BRANCH_NAME"
+    echo ""
+    echo "Verify the release:"
+    echo "  npm view @youversion/react-native-sdk"
+    echo "  $REPO_URL/releases"
+}
+
+# Main execution
+main() {
+    echo -e "${GREEN}"
+    echo "╔════════════════════════════════════════════════════════╗"
+    echo "║     YouVersion React Native SDK - Local Release       ║"
+    echo "║          (Branch Protection Compliant)                 ║"
+    echo "╚════════════════════════════════════════════════════════╝"
+    echo -e "${NC}"
+
+    check_prerequisites
+    ensure_main_updated
+    preview_release
+    create_release_branch
+    create_local_config
+    run_release
+    push_release
+    create_pr
+    cleanup
+}
+
+# Run main function
+main

package/scripts/sync-android-version.js

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+
+/**
+ * Sync Android build.gradle version with package.json
+ * This script is called by semantic-release during the release process
+ */
+
+const fs = require("fs");
+const path = require("path");
+
+// Get version from command line argument (passed by semantic-release)
+const newVersion = process.argv[2];
+
+if (!newVersion) {
+  console.error("❌ Error: Version argument is required");
+  console.error("Usage: node sync-android-version.js <version>");
+  process.exit(1);
+}
+
+// Validate version format (semantic versioning)
+const versionRegex = /^\d+\.\d+\.\d+(-[a-zA-Z0-9.-]+)?$/;
+if (!versionRegex.test(newVersion)) {
+  console.error(`❌ Error: Invalid version format: ${newVersion}`);
+  console.error("Expected format: X.Y.Z or X.Y.Z-prerelease");
+  process.exit(1);
+}
+
+// Path to Android build.gradle
+const buildGradlePath = path.join(__dirname, "..", "android", "build.gradle");
+
+try {
+  // Read the build.gradle file
+  let buildGradleContent = fs.readFileSync(buildGradlePath, "utf8");
+
+  // Find and replace the group-level version line
+  // Looking for: version = "X.Y.Z" or version = 'X.Y.Z' at the start of a line
+  const versionLineRegex = /^version\s*=\s*["'][\d.]+(-[a-zA-Z0-9.-]+)?["']/m;
+
+  if (!versionLineRegex.test(buildGradleContent)) {
+    console.error(
+      "❌ Error: Could not find version line in android/build.gradle",
+    );
+    console.error('Expected format: version = "X.Y.Z"');
+    process.exit(1);
+  }
+
+  // Replace the group-level version
+  let updatedContent = buildGradleContent.replace(
+    versionLineRegex,
+    `version = '${newVersion}'`,
+  );
+
+  // Also update versionName in defaultConfig if it exists
+  // Looking for: versionName "X.Y.Z"
+  const versionNameRegex = /versionName\s+["'][\d.]+(-[a-zA-Z0-9.-]+)?["']/;
+
+  if (versionNameRegex.test(updatedContent)) {
+    updatedContent = updatedContent.replace(
+      versionNameRegex,
+      `versionName "${newVersion}"`,
+    );
+    console.log(`✅ Updated versionName to ${newVersion}`);
+  }
+
+  // Write back to file
+  fs.writeFileSync(buildGradlePath, updatedContent, "utf8");
+
+  console.log(
+    `✅ Successfully updated android/build.gradle version to ${newVersion}`,
+  );
+  process.exit(0);
+} catch (error) {
+  console.error(`❌ Error updating android/build.gradle:`, error.message);
+  process.exit(1);
+}

package/src/api/bible.ts

@@ -0,0 +1,35 @@
+import { Module } from "../native";
+import { BibleReference, BibleVersion } from "../types";
+
+export const BibleAPI = {
+  /**
+   * Retrieves a list of Bible versions available for a specified language code (like "en").
+   *
+   * @param languageTag - An optional language code per BCP 47 for filtering available Bible versions. If `nil`
+   *     the function returns versions for all languages.
+   * @returns An array of {@link BibleVersion} objects.
+   */
+  getVersions(languageTag?: string): Promise<Omit<BibleVersion, "books">[]> {
+    return Module.versions(languageTag);
+  },
+
+  /**
+   * Retrieves a single Bible version by its unique identifier.
+   *
+   * @param versionId -  The id of the Bible version
+   * @returns A {@link BibleVersion} object
+   */
+  getVersion(versionId: number): Promise<BibleVersion> {
+    return Module.version(versionId);
+  },
+
+  /**
+   * 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.
+   * @returns The chapter content as an HTML string.
+   */
+  getChapter(bibleReference: BibleReference): Promise<string> {
+    return Module.chapter(bibleReference);
+  },
+};

package/src/api/highlights.ts

@@ -0,0 +1,145 @@
+import { Module } from "../native";
+import { HighlightResponse } from "../types";
+
+export const HighlightsAPI = {
+  /**
+   * Creates a new Bible highlight for the user in YouVersion.
+   *
+   * @param params - An object ({@link CreateHighlightParams}) containing the parameters for creating the highlight.
+   * @param params.bibleId - The Bible version identifier.
+   * @param params.passageId - The passage identifier (e.g., "JHN.5.1").
+   * @param params.color - The highlight color in hex format (e.g., "#eeeeff").
+   * @returns A boolean indicating success or failure.
+   */
+  createHighlight({
+    bibleId,
+    passageId,
+    color,
+  }: CreateHighlightParams): Promise<boolean> {
+    return Module.createHighlight(bibleId, passageId, color);
+  },
+
+  /**
+   * Retrieves the user's highlights for a specific Bible chapter from YouVersion.
+   * @param params - An object ({@link GetHighlightsParams}) containing the parameters for retrieving highlights.
+   * @param params.bibleId - The Bible version identifier.
+   * @param params.passageId - The passage identifier (e.g., "JHN.5.1").
+   * @returns `HighlightResponse[]` - An array of {@link HighlightResponse} objects
+   */
+  getHighlights({
+    bibleId,
+    passageId,
+  }: GetHighlightsParams): Promise<HighlightResponse[]> {
+    return Module.getHighlights(bibleId, passageId);
+  },
+
+  /**
+   * Updates an existing Bible highlight for the user in YouVersion.
+   *
+   * @param params - An object ({@link UpdateHighlightParams}) containing the parameters for updating the highlight.
+   * @param params.bibleId - The Bible version identifier.
+   * @param params.passageId - The passage identifier (e.g., "JHN.5.1").
+   * @param params.color - The new highlight color in hex format (e.g., "#eeeeff").
+   * @returns A boolean indicating success or failure.
+   */
+  updateHighlight({
+    bibleId,
+    passageId,
+    color,
+  }: UpdateHighlightParams): Promise<boolean> {
+    return Module.updateHighlight(bibleId, passageId, color);
+  },
+
+  /**
+   * Deletes a Bible highlight for the user in YouVersion.
+   *
+   * @param params - An object ({@link DeleteHighlightParams}) containing the parameters for deleting the highlight.
+   * @param params.bibleId - The Bible version identifier.
+   * @param params.passageId - The passage identifier (e.g., "JHN.5.1").
+   * @returns A boolean indicating success or failure.
+   */
+  deleteHighlight({
+    bibleId,
+    passageId,
+  }: DeleteHighlightParams): Promise<boolean> {
+    return Module.deleteHighlight(bibleId, passageId);
+  },
+};
+
+export interface CreateHighlightParams {
+  /**
+   * The 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;
+}
+
+export interface GetHighlightsParams {
+  /**
+   * The Bible version identifier
+   *
+   * @example 111
+   */
+  bibleId: number;
+
+  /**
+   * The passage identifier (e.g., "JHN.5.1")
+   *
+   * @example "JHN.5.1"
+   */
+  passageId: string;
+}
+
+export interface UpdateHighlightParams {
+  /**
+   * The 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;
+}
+
+export interface DeleteHighlightParams {
+  /**
+   * The Bible version identifier
+   *
+   * @example 111
+   */
+  bibleId: number;
+
+  /**
+   * The passage identifier (e.g., "JHN.5.1")
+   *
+   * @example "JHN.5.1"
+   */
+  passageId: string;
+}

package/src/api/index.ts

@@ -0,0 +1,13 @@
+import { BibleAPI } from "./bible";
+import { HighlightsAPI } from "./highlights";
+import { LanguagesAPI } from "./languages";
+import { UsersAPI } from "./users";
+import { VotdAPI } from "./votd";
+
+export const YouVersionAPI = {
+  Users: UsersAPI,
+  VOTD: VotdAPI,
+  Bible: BibleAPI,
+  Languages: LanguagesAPI,
+  Highlights: HighlightsAPI,
+};

package/src/api/languages.ts

@@ -0,0 +1,14 @@
+import { Module } from "../native";
+import { LanguageOverview } from "../types";
+
+export const LanguagesAPI = {
+  /**
+   * Retrieves a list of languages supported in the Platform.
+   *
+   * @param country  - An optional country code for filtering languages. If provided, only languages used in that country will be returned. For example, "US" for the United States.
+   * @returns An array of {@link LanguageOverview} objects.
+   */
+  getLanguages(country?: string): Promise<LanguageOverview[]> {
+    return Module.languages(country);
+  },
+};

package/src/api/users.ts

@@ -0,0 +1,35 @@
+import { Module } from "../native";
+import {
+  SignInWithYouVersionPermission,
+  SignInWithYouVersionResult,
+  YouVersionUserInfo,
+} from "../types";
+
+export const UsersAPI = {
+  /**
+   * Presents the YouVersion login flow to the user and returns the login result upon completion.
+   *
+   * @param permissions - An array of permissions to request during sign-in.
+   * @returns A promise that resolves to the login result as a {@link SignInWithYouVersionResult} object.
+   */
+  signIn: (
+    permissions: SignInWithYouVersionPermission[] = [],
+  ): Promise<SignInWithYouVersionResult> => {
+    return Module.signIn(permissions);
+  },
+
+  /** Signs out the current user by clearing the access token from local storage */
+  signOut(): Promise<void> {
+    return Module.signOut();
+  },
+
+  /**
+   * 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);
+  },
+};

package/src/api/votd.ts

@@ -0,0 +1,20 @@
+import { Module } from "../native";
+import { YouVersionVerseOfTheDay } from "../types";
+
+type VerseOfTheDayOptions = {
+  dayOfYear: number;
+};
+
+export const VotdAPI = {
+  /**
+   *  Retrieves the Verse of the Day from YouVersion for a specified day of the year.
+   *  A valid `YouVersionPlatformConfiguration.appKey` must be set before calling this function.
+   * @param dayOfYear  - The day of the year (1-366) to retrieve the verse for
+   * @returns A promise that resolves to a {@link YouVersionVerseOfTheDay} object.
+   */
+  verseOfTheDay(
+    { dayOfYear = 1 }: VerseOfTheDayOptions = { dayOfYear: 1 },
+  ): Promise<YouVersionVerseOfTheDay> {
+    return Module.verseOfTheDay(dayOfYear);
+  },
+};

package/src/components/BibleReaderView.tsx

@@ -0,0 +1,52 @@
+import { requireNativeView } from "expo";
+import { StyleProp, StyleSheet, ViewStyle } from "react-native";
+
+import { BibleReference } from "../types";
+
+const NativeView: React.ComponentType<NativeProps> =
+  requireNativeView("BibleReaderView");
+
+/**
+ * A full-featured Bible reader component.
+ * It allows the user to control font customizations, switch Bible versions and access their verse highlights.
+ * It is designed after the YouVersion Bible reader experience found in the YouVersion app.
+ * @param props - {@link BibleReaderViewProps}
+ */
+export function BibleReaderView({ reference, ...props }: BibleReaderViewProps) {
+  return (
+    <NativeView
+      style={styles.view}
+      hasReference={!!reference}
+      {...(reference || {})}
+      {...props}
+    />
+  );
+}
+
+const styles = StyleSheet.create({
+  view: {
+    flex: 1,
+  },
+});
+
+export interface BibleReaderViewProps {
+  /** A reference to a passage in the Bible the reader should open to. This could be a single verse, a range of verses or the entire chapter */
+  reference?: BibleReference | null | undefined;
+
+  /**
+   * Name of your app.
+   * The SDK will use this in various places when prompting the user to sign in to their YouVersion account. This will let the user know which app is requesting their information.
+   */
+  appName: string;
+
+  /**
+   * A custom message to display to the user from the sign-in sheet, letting them know why they should sign in.
+   */
+  signInMessage: string;
+}
+
+type NativeProps = Omit<BibleReaderViewProps, "reference"> &
+  Partial<BibleReference> & {
+    style: StyleProp<ViewStyle>;
+    hasReference: boolean;
+  };

package/src/components/BibleTextView.tsx

@@ -0,0 +1,63 @@
+import { requireNativeView } from "expo";
+import { StyleProp, StyleSheet, View, ViewStyle } from "react-native";
+
+import {
+  BibleReference,
+  BibleTextOptions,
+  OnBibleTextPressEvent,
+} from "../types";
+
+const NativeView: React.ComponentType<NativeProps> =
+  requireNativeView("BibleTextView");
+
+/**
+ * A minimal text view for displaying a Bible passage.
+ * The component supports font customizations and accepts an `onPress` handler
+ * that provides information about which verse was pressed.
+ *
+ * @param props - {@link BibleTextViewProps}
+ */
+export function BibleTextView({
+  bibleReference,
+  style,
+  onPress,
+  ...props
+}: BibleTextViewProps) {
+  return (
+    <View style={[styles.wrapper, style]}>
+      <NativeView
+        {...bibleReference}
+        {...props}
+        onTap={(e: NativeEvent) => onPress?.(e.nativeEvent)}
+        style={styles.component}
+      />
+    </View>
+  );
+}
+
+const styles = StyleSheet.create({
+  wrapper: {
+    flexDirection: "row",
+    alignItems: "stretch",
+  },
+  component: {
+    flexGrow: 1,
+  },
+});
+
+type NativeProps = Omit<BibleTextViewProps, "bibleReference"> &
+  BibleReference & {
+    onTap?: (e: NativeEvent) => any | null | undefined;
+  };
+
+type NativeEvent = { nativeEvent: OnBibleTextPressEvent };
+
+export interface BibleTextViewProps extends BibleTextOptions {
+  /** A reference to a passage in the Bible. This could be a single verse, a range of verses or the entire chapter */
+  bibleReference: BibleReference;
+
+  style?: StyleProp<ViewStyle>;
+
+  /** Called when the user presses on the Bible text */
+  onPress?: (e: OnBibleTextPressEvent) => void | null | undefined;
+}