configure(config)

Native Kotlin data class. Used by NitroPushSdk.shared.configure() in Kotlin.

data class NlConfig(
  val serverUrl: String,
  val deploymentKey: String,
  /** Public root of the storage bucket. Joined with each
   *  `objectKey` in the SDK manifest at fetch time. */
  val storageBaseUrl: String,
  /** Falls back to BuildConfig.VERSION_NAME if null. */
  val appVersion: String? = null,
  /** Falls back to a persisted UUID if null. */
  val clientUniqueId: String? = null,
)

TypeScript interface for the JS configureWith() helper. The no-arg configure() takes no argument and reads the same keys from Info.plist / AndroidManifest meta-data.

// Explicit config — returns a client you call every other method on.
configureWith(config: NitroPushConfig): NitroPushClient;

// No-arg — reads NITROPUSH_* from Info.plist (iOS) /
// AndroidManifest <meta-data> (Android). Same return type.
configure(): NitroPushClient;

interface NitroPushConfig {
  /** NitroPush API base URL. */
  serverUrl: string;

  /** The environment's deployment key. */
  deploymentKey: string;

  /**
   * Public root of the storage bucket your CLI uploads to.
   * Joined with each `objectKey` in the SDK manifest at fetch time.
   */
  storageBaseUrl: string;

  /**
   * Native binary version this build targets. Falls back to the
   * binary's CFBundleShortVersionString (iOS) / versionName (Android)
   * if omitted.
   */
  appVersion?: string;

  /**
   * Stable per-device id for deterministic rollout bucketing.
   * Falls back to identifierForVendor (iOS) / persisted UUID
   * (Android). Recommended: leave unset.
   */
  clientUniqueId?: string;
}

Call from MainApplication.onCreate, immediately after NitroPushSdk.install(this).

import com.nitropush.sdk.NitroPushSdk
import com.nitropush.sdk.NlConfig

override fun onCreate() {
  super.onCreate()
  NitroPushSdk.install(this)            // creates the singleton
  NitroPushSdk.shared.configure(
    NlConfig(
      serverUrl      = "https://app.nitropush.org",
      deploymentKey  = BuildConfig.NL_KEY,
      storageBaseUrl = "https://your-bucket.s3.amazonaws.com"
    )
  )
  // Optional: turn on the SDK's debug log stream (tagged "NitroPush") while
  // you're wiring this up.
  // NitroPushSdk.shared.setEnableLogs(true)
}

Call once at module load, at the very top of your app entry. Capture the returned client and use it for every subsequent call.

import { configureWith, type NitroPushClient } from '@nitropush/react-native';

// Build the client once at module scope, then use it everywhere.
export const client: NitroPushClient = configureWith({
  serverUrl:       process.env.EXPO_PUBLIC_NITROPUSH_SERVER_URL!,
  deploymentKey:   process.env.EXPO_PUBLIC_NITROPUSH_DEPLOYMENT_KEY!,
  storageBaseUrl:  process.env.EXPO_PUBLIC_NITROPUSH_STORAGE_BASE_URL!,
});

// Alternative — if you've put the same values in Info.plist (iOS) /
// AndroidManifest <meta-data> (Android), no JS-side config needed:
//
//   import { configure } from '@nitropush/react-native';
//   export const client = configure();

Inject via BuildConfig fields from Gradle product flavors. Or put NITROPUSH_* under <application> <meta-data> in AndroidManifest.xml and use configFromManifest().

// Option A: have the SDK read NITROPUSH_* keys from AndroidManifest meta-data.
NitroPushSdk.shared.configure(NitroPushSdk.configFromManifest())

// Option B: read whatever values you've injected via Gradle and build NlConfig.
//   In app/build.gradle.kts:
//     buildConfigField("String", "NL_DEPLOYMENT_KEY", "\"PROD-KEY-…\"")
NitroPushSdk.shared.configure(
  NlConfig(
    serverUrl      = "https://app.nitropush.org",
    deploymentKey  = BuildConfig.NL_DEPLOYMENT_KEY,
    storageBaseUrl = "https://your-bucket.s3.amazonaws.com"
  )
)

EXPO_PUBLIC_* are inlined at build time. For bare RN, use react-native-config.

// Explicit config from env (the most common pattern).
export const client = configureWith({
  serverUrl:       process.env.NITROPUSH_SERVER_URL!,
  deploymentKey:   process.env.NITROPUSH_DEPLOYMENT_KEY!,
  storageBaseUrl:  process.env.NITROPUSH_STORAGE_BASE_URL!,
});

// Or — when the same values are already in Info.plist / AndroidManifest:
// export const client = configure();