chore: remove getApiKey function and update README for environment variable usage

Author: lposen

android/src/main/java/expo/modules/adapters/iterable/ExpoAdapterIterableModule.kt

@@ -7,15 +7,5 @@ import android.content.pm.PackageManager
 class ExpoAdapterIterableModule() : Module() {
   override fun definition() = ModuleDefinition {
     Name("ExpoAdapterIterable")
-
-    /**
-     * Get the Iterable API key from the AndroidManifest.xml file.
-     * @return The Iterable API key.
-     */
-    Function("getApiKey") {
-      val applicationInfo = appContext?.reactContext?.packageManager?.getApplicationInfo(appContext?.reactContext?.packageName.toString(), PackageManager.GET_META_DATA)
-
-      return@Function applicationInfo?.metaData?.getString("ITERABLE_API_KEY")
-    }
   }
 }

example/.env

@@ -0,0 +1,2 @@
+EXPO_PUBLIC_ITERABLE_API_KEY=YOUR_ITERABLE_API_KEY
+EXPO_PUBLIC_ITERABLE_EMAIL=YOUR_ITERABLE_EMAIL

example/README.md

@@ -40,8 +40,8 @@ Expo.
     yarn install
     ```
 3. Configure your Iterable API key:
-   - Open `app.json`
-   - Replace `YOUR_API_KEY` with your actual Iterable API key
+   - Copy `.env` to `.env.local`
+   - Replace `YOUR_ITERABLE_API_KEY` with your actual Iterable API key
 
 4. For Android push notifications:
    - Place your `google-services.json` file in the root of the example directory

example/app.json

@@ -67,7 +67,6 @@
       [
         "../app.plugin.js",
         {
-          "apiKey": "YOUR_ITERABLE_API_KEY",
           "appEnvironment": "development",
           "autoConfigurePushNotifications": true,
           "enableInAppMessages": true,

example/src/Login.tsx

@@ -1,4 +1,3 @@
-import { getApiKey } from '@iterable/expo-plugin';
 import {
   Iterable,
   IterableConfig,
@@ -44,7 +43,10 @@ export const Login = ({ onLoggedIn = () => {} }: LoginProps) => {
 
     config.inAppHandler = () => IterableInAppShowResponse.show;
 
-    Iterable.initialize(getApiKey(), config).finally(() => {
+    Iterable.initialize(
+      process.env.EXPO_PUBLIC_ITERABLE_API_KEY as string,
+      config
+    ).finally(() => {
       setInitialized(true);
     });
   }, []);

ios/ExpoAdapterIterableModule.swift

@@ -3,13 +3,5 @@ import ExpoModulesCore
 public class ExpoAdapterIterableModule: Module {
   public func definition() -> ModuleDefinition {
     Name("ExpoAdapterIterable")
-
-    /**
-     * Get the Iterable API key from the Info.plist file.
-     * @return The Iterable API key.
-     */
-    Function("getApiKey") {
-     return Bundle.main.object(forInfoDictionaryKey: "ITERABLE_API_KEY") as? String
-    }
   }
-}
+}

plugin/src/index.ts

@@ -12,7 +12,6 @@ const withIterable: ConfigPlugin<ConfigPluginProps> = (config, props = {}) => {
   // Set default values for props
   const propsWithDefaults: ConfigPluginPropsWithDefaults = {
     ...props,
-    apiKey: props.apiKey ?? '',
     appEnvironment: props.appEnvironment ?? 'development',
     autoConfigurePushNotifications:
       props.autoConfigurePushNotifications ?? true,

plugin/src/withIterable.types.ts

@@ -1,8 +1,4 @@
 export interface ConfigPluginProps {
-  /**
-   * The api key for the Iterable project.
-   */
-  apiKey?: string;
   /**
    * The environment of the app.
    * @default 'development'

plugin/src/withStoreConfigValues.ts

@@ -15,7 +15,7 @@ import { type ConfigPluginPropsWithDefaults } from './withIterable.types';
  */
 type JsKey = keyof Pick<
   ConfigPluginPropsWithDefaults,
-  'apiKey' | 'requestPermissionsForPushNotifications' | 'enableInAppMessages'
+  'requestPermissionsForPushNotifications' | 'enableInAppMessages'
 >;
 
 /**
@@ -32,7 +32,6 @@ type NativeKey = string;
  * Info.plist file or the AndroidManifest.xml file.
  */
 const nativeKeyMap: Record<JsKey, NativeKey> = {
-  apiKey: 'ITERABLE_API_KEY',
   requestPermissionsForPushNotifications:
     'ITERABLE_REQUEST_PERMISSIONS_FOR_PUSH_NOTIFICATIONS',
   enableInAppMessages: 'ITERABLE_ENABLE_IN_APP_MESSAGES',

src/ExpoAdapterIterableModule.ts

@@ -1,12 +1,6 @@
 import { NativeModule, requireNativeModule } from 'expo';
 
-declare class ExpoAdapterIterableModule extends NativeModule {
-  /**
-   * Get the Iterable API key set in the expo config.
-   * @return The Iterable API key.
-   */
-  getApiKey(): string;
-}
+declare class ExpoAdapterIterableModule extends NativeModule {}
 
 // This call loads the native module object from the JSI.
 export default requireNativeModule<ExpoAdapterIterableModule>(