feat(MBL-2652): make inApp.siteId optional with a pk_ key

README.md

@@ -78,7 +78,7 @@ useEffect(() => {
     logLevel: CioLogLevel.debug,
     trackApplicationLifecycleEvents: true,
     inApp: {
-      siteId: 'your-site-id', // Required for in-app messaging
+      siteId: 'your-site-id', // Optional with a pk_ key
     },
     push: {
       android: {

__tests__/in-app-site-id.test.ts

@@ -1,6 +1,6 @@
 /**
- * `inApp.siteId` stays required, even with a workspace public (`pk_`) key, until the native SDKs
- * and the in-app renderer support key-only setup. The JavaScript layer forwards the config as given.
+ * `inApp.siteId` is optional with a workspace public (`pk_`) key. The JavaScript layer forwards the
+ * config as given, and the native SDKs start in-app without a site ID when it is left out.
  */
 
 jest.mock('react-native', () => ({
@@ -56,4 +56,21 @@ describe('in-app site ID', () => {
       expect.anything()
     );
   });
+
+  it('forwards an empty inApp config with a pk_ key', async () => {
+    const config: CioConfig = {
+      cdpApiKey: 'pk_eu_test-key',
+      inApp: {},
+    };
+
+    await CustomerIO.initialize(config);
+
+    expect(nativeInitialize).toHaveBeenCalledWith(
+      expect.objectContaining({
+        cdpApiKey: 'pk_eu_test-key',
+        inApp: {},
+      }),
+      expect.anything()
+    );
+  });
 });

android/src/main/java/io/customer/reactnative/sdk/messaginginapp/NativeMessagingInAppModule.kt

@@ -265,15 +265,16 @@ class NativeMessagingInAppModule(
             builder: CustomerIOBuilder,
             config: Map<String, Any>
         ) {
-            // Site ID is still required. Native in-app reads the key and region from the CustomerIO setup.
+            // Site ID is optional with a public (pk_) key. Native in-app reads the key and region from the CustomerIO setup.
             val siteId = config.getTypedValue<String>(Keys.Config.SITE_ID)
-            if (siteId.isNullOrBlank()) {
-                SDKComponent.logger.error("Site ID is required to initialize InAppMessaging module")
-                return
+            val configBuilder = if (siteId.isNullOrBlank()) {
+                MessagingInAppModuleConfig.Builder()
+            } else {
+                MessagingInAppModuleConfig.Builder(siteId = siteId)
             }
 
             val module = ModuleMessagingInApp(
-                MessagingInAppModuleConfig.Builder(siteId = siteId).apply {
+                configBuilder.apply {
                     setEventListener(eventListener = ReactInAppEventListener.instance)
                     colorSchemeFromConfig(config)?.let { colorScheme ->
                         setColorScheme(colorScheme)

api-extractor-output/customerio-reactnative.api.md

@@ -36,7 +36,7 @@ export type CioConfig = {
     trackApplicationLifecycleEvents?: boolean;
     autoTrackDeviceAttributes?: boolean;
     inApp?: {
-        siteId: string;
+        siteId?: string;
         colorScheme?: CioColorScheme;
         notificationInboxAccessibilityLabels?: NotificationInboxAccessibilityLabels;
     };

package.json

@@ -19,7 +19,7 @@
     },
     "./package.json": "./package.json"
   },
-  "cioNativeiOSSdkVersion": "= 5.0.0",
+  "cioNativeiOSSdkVersion": "= 5.1.0",
   "files": [
     "src",
     "lib",

src/types/data-pipelines.ts

@@ -68,7 +68,11 @@ export type CioConfig = {
   trackApplicationLifecycleEvents?: boolean;
   autoTrackDeviceAttributes?: boolean;
   inApp?: {
-    siteId: string;
+    /**
+     * Workspace site ID. Optional when `cdpApiKey` is a public `pk_` key, which identifies the
+     * workspace. Pass `inApp: {}` to turn on in-app messaging without one.
+     */
+    siteId?: string;
     /**
      * Color scheme used to render in-app messages. Defaults to `CioColorScheme.Auto`, which
      * follows the device appearance. Set it when the app has its own appearance setting that