feat: add support for screenId prop allowing for native screen recognition (#2967)

## Description

Add support for `screenId` prop on native side. At the moment we use
this value only in JS code.
It was brought to my attention, however, that other libs that wanna
integrate might want that
to be exposed also on native side. 

## Changes

Added `screenId` prop & exposed it on both platforms.

## Test code and steps to reproduce

Any example & add a breakpoint at setter method.

## Checklist

- [ ] Ensured that CI passes

Author: kkafar

android/src/main/java/com/swmansion/rnscreens/Screen.kt

@@ -59,6 +59,7 @@ class Screen(
     var isGestureEnabled = true
     var screenOrientation: Int? = null
         private set
+    var screenId: String? = null
     var isStatusBarAnimated: Boolean? = null
     var isBeingRemoved = false
 

android/src/main/java/com/swmansion/rnscreens/ScreenStack.kt

@@ -91,6 +91,11 @@ class ScreenStack(
         }
     }
 
+    /**
+     * Integration function. Allows other solutions to retrieve list of screens owned by this stack.
+     */
+    fun getScreenIds(): List<String?> = screenWrappers.map { it.screen.screenId }
+
     private fun dispatchOnFinishTransitioning() {
         val surfaceId = UIManagerHelper.getSurfaceId(this)
         UIManagerHelper

android/src/main/java/com/swmansion/rnscreens/ScreenViewManager.kt

@@ -376,6 +376,10 @@ open class ScreenViewManager :
         view.sheetInitialDetentIndex = value
     }
 
+    override fun setScreenId(view: Screen, value: String?) {
+        view.screenId = if (value.isNullOrEmpty()) null else value
+    }
+
     override fun getExportedCustomDirectEventTypeConstants(): MutableMap<String, Any> =
         mutableMapOf(
             ScreenDismissedEvent.EVENT_NAME to hashMapOf("registrationName" to "onDismissed"),

android/src/paper/java/com/facebook/react/viewmanagers/RNSScreenManagerDelegate.java

@@ -25,6 +25,9 @@ public RNSScreenManagerDelegate(U viewManager) {
   @Override
   public void setProperty(T view, String propName, @Nullable Object value) {
     switch (propName) {
+      case "screenId":
+        mViewManager.setScreenId(view, value == null ? "" : (String) value);
+        break;
       case "sheetAllowedDetents":
         mViewManager.setSheetAllowedDetents(view, (ReadableArray) value);
         break;

android/src/paper/java/com/facebook/react/viewmanagers/RNSScreenManagerInterface.java

@@ -16,6 +16,7 @@
 
 
 public interface RNSScreenManagerInterface<T extends View>  {
+  void setScreenId(T view, @Nullable String value);
   void setSheetAllowedDetents(T view, @Nullable ReadableArray value);
   void setSheetLargestUndimmedDetent(T view, int value);
   void setSheetGrabberVisible(T view, boolean value);

ios/RNSScreen.h

@@ -78,6 +78,7 @@ namespace react = facebook::react;
 @property (nonatomic, retain) RNSScreen *controller;
 @property (nonatomic, copy) NSDictionary *gestureResponseDistance;
 @property (nonatomic) int activityState;
+@property (nonatomic, nullable) NSString *screenId;
 @property (weak, nonatomic) UIView<RNSScreenContainerDelegate> *reactSuperview;
 
 #if !TARGET_OS_TV

ios/RNSScreen.mm

@@ -1305,6 +1305,10 @@ - (void)updateProps:(react::Props::Shared const &)props oldProps:(react::Props::
     [self setReplaceAnimation:[RNSConvert RNSScreenReplaceAnimationFromCppEquivalent:newScreenProps.replaceAnimation]];
   }
 
+  if (newScreenProps.screenId != oldScreenProps.screenId) {
+    [self setScreenId:RCTNSStringFromStringNilIfEmpty(newScreenProps.screenId)];
+  }
+
   [super updateProps:props oldProps:oldProps];
 }
 
@@ -1344,6 +1348,17 @@ - (void)finalizeUpdates:(RNComponentViewUpdateMask)updateMask
 #pragma mark - Paper specific
 #else
 
+// On Fabric the setter is not needed, because value invariant (empty string to nil translation)
+// is upheld in `- [updateProps:oldProps:]`
+- (void)setScreenId:(NSString *)screenId
+{
+  if (screenId != nil && screenId.length == 0) {
+    _screenId = nil;
+  } else {
+    _screenId = screenId;
+  }
+}
+
 - (void)didSetProps:(NSArray<NSString *> *)changedProps
 {
   [super didSetProps:changedProps];
@@ -1969,6 +1984,7 @@ @implementation RNSScreenManager
 RCT_EXPORT_VIEW_PROPERTY(stackAnimation, RNSScreenStackAnimation)
 RCT_EXPORT_VIEW_PROPERTY(swipeDirection, RNSScreenSwipeDirection)
 RCT_EXPORT_VIEW_PROPERTY(transitionDuration, NSNumber)
+RCT_EXPORT_VIEW_PROPERTY(screenId, NSString);
 
 RCT_EXPORT_VIEW_PROPERTY(onAppear, RCTDirectEventBlock);
 RCT_EXPORT_VIEW_PROPERTY(onDisappear, RCTDirectEventBlock);

ios/RNSScreenStack.h

@@ -36,6 +36,18 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
+#pragma mark-- Integration
+
+@interface RNSScreenStackView ()
+
+/**
+ * \return Arrray with ids of screens owned by this stack. Ids are returned in no particular order. The list might be
+ * empty. The strings inside the list are nullable if the screen has not been assigned an ID.
+ */
+@property (nonatomic, readonly, nonnull) NSArray<NSString *> *screenIds;
+
+@end
+
 @interface RNSScreenStackManager : RCTViewManager <RCTInvalidating>
 
 @end

ios/RNSScreenStack.mm

@@ -1157,6 +1157,15 @@ - (void)finishScreenTransition:(BOOL)canceled
   _interactionController = nil;
 }
 
+- (nonnull NSArray<NSString *> *)screenIds
+{
+  NSMutableArray<NSString *> *ids = [NSMutableArray arrayWithCapacity:_reactSubviews.count];
+  for (RNSScreenView *childScreenView in _reactSubviews) {
+    [ids addObject:childScreenView.screenId];
+  }
+  return ids;
+}
+
 #ifdef RCT_NEW_ARCH_ENABLED
 #pragma mark - Fabric specific
 

src/components/Screen.tsx

@@ -91,6 +91,7 @@ export const InnerScreen = React.forwardRef<View, ScreenProps>(
       sheetElevation = 24,
       sheetInitialDetentIndex = 0,
       // Other
+      screenId,
       stackPresentation,
       // Events for override
       onAppear,
@@ -210,6 +211,7 @@ export const InnerScreen = React.forwardRef<View, ScreenProps>(
             // Detailed information can be found here https://github.com/software-mansion/react-native-screens/pull/2351
             style={[style, { zIndex: undefined }]}
             activityState={activityState}
+            screenId={screenId}
             sheetAllowedDetents={resolvedSheetAllowedDetents}
             sheetLargestUndimmedDetent={resolvedSheetLargestUndimmedDetent}
             sheetElevation={sheetElevation}