@apexnative/navigation 1.0.0-alpha.1 → 1.0.0-alpha.2

package/ios/Core/ANNErrorHandler.mm

@@ -1,12 +1,28 @@
 #import "ANNErrorHandler.h"
+#import "ANNErrorTexts.h"
 #import <React/RCTLog.h>
 
 @implementation ANNErrorHandler
 
-+ (void)reject:(RCTPromiseRejectBlock)reject text:(NSString *)text {
+// Calling a nil block ends the app (`EXC_BAD_ACCESS` at 0x10, its invoke field): JavaScript always passes both blocks,
+// so a nil one comes from a caller in native code, and the answer goes to the log.
++ (void)reject:(RCTPromiseRejectBlock)reject of:(NSString *)method text:(NSString *)text {
+    if (!reject) {
+        [self logFailureOf:method text:text];
+        return;
+    }
     reject(nil, text, nil);
 }
 
++ (void)resolve:(RCTPromiseResolveBlock)resolve of:(NSString *)method value:(id)value {
+    if (!resolve) {
+        [self logFailureOf:method
+                      text:[ANNErrorTexts couldNot:@"resolve its promise" reason:@"the command came without one"]];
+        return;
+    }
+    resolve(value);
+}
+
 + (void)logFailureOf:(NSString *)method text:(NSString *)text {
     RCTLogError(@"[ApexNavigation] %@: %@", method, text);
 }

package/ios/Core/ANNEventContract.h

@@ -0,0 +1,246 @@
+// Made by scripts/contract.mjs from the event types of src/interfaces/: change them and run the script again.
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/// The names of the events `ANN.<Name>` (`event`) and the keys of their payloads, as the types of `src/interfaces/`
+/// give them; what each field means is its JSDoc there. The object types a field holds have keys of their own. The
+/// senders take every name and key from here: `ANNEventContract.CommandCompleted.commandId`.
+FOUNDATION_EXPORT const struct ANNEventContractTable {
+    /// `ANN.AppLaunched`.
+    struct {
+        __unsafe_unretained NSString *event;
+    } AppLaunched;
+    /// `ANN.ArrangementChanged`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *placement;
+        __unsafe_unretained NSString *layout;
+        __unsafe_unretained NSString *front;
+        __unsafe_unretained NSString *hidden;
+    } ArrangementChanged;
+    /// `ANN.BottomAccessoryPlacementChanged` (iOS).
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *placement;
+    } BottomAccessoryPlacementChanged;
+    /// `ANN.BottomTabLongPressed`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *selectedTabIndex;
+        __unsafe_unretained NSString *bottomTabsId;
+    } BottomTabLongPressed;
+    /// `ANN.BottomTabPressed`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *tabIndex;
+        __unsafe_unretained NSString *bottomTabsId;
+        /// Optional.
+        __unsafe_unretained NSString *screenId;
+        __unsafe_unretained NSString *wasSelected;
+    } BottomTabPressed;
+    /// `ANN.BottomTabSelected`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *selectedTabIndex;
+        __unsafe_unretained NSString *unselectedTabIndex;
+        __unsafe_unretained NSString *bottomTabsId;
+    } BottomTabSelected;
+    /// `ANN.CommandCompleted`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *commandName;
+        __unsafe_unretained NSString *commandId;
+        __unsafe_unretained NSString *completionTime;
+    } CommandCompleted;
+    /// `ANN.ComponentDidAppear`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *componentName;
+        __unsafe_unretained NSString *componentType;
+    } ComponentDidAppear;
+    /// `ANN.ComponentDidDisappear`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *componentName;
+        __unsafe_unretained NSString *componentType;
+    } ComponentDidDisappear;
+    /// `ANN.ComponentWillAppear`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *componentName;
+        __unsafe_unretained NSString *componentType;
+    } ComponentWillAppear;
+    /// `ANN.DeepLinkDispatched` (iOS).
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *url;
+    } DeepLinkDispatched;
+    /// `ANN.HingeChanged`.
+    struct {
+        __unsafe_unretained NSString *event;
+        /// Optional.
+        __unsafe_unretained NSString *state;
+        /// Optional.
+        __unsafe_unretained NSString *angle;
+    } HingeChanged;
+    /// `ANN.KeyCommandPressed` (iOS).
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *keyCommandId;
+    } KeyCommandPressed;
+    /// `ANN.ModalAttemptedToDismiss`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+    } ModalAttemptedToDismiss;
+    /// `ANN.ModalDismissed`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *componentName;
+        __unsafe_unretained NSString *modalsDismissed;
+    } ModalDismissed;
+    /// `ANN.NativeScreenCall`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *callId;
+        __unsafe_unretained NSString *kind;
+        __unsafe_unretained NSString *name;
+        __unsafe_unretained NSString *args;
+    } NativeScreenCall;
+    /// `ANN.NativeScreenReleased`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+    } NativeScreenReleased;
+    /// `ANN.NavigationButtonPressed`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *buttonId;
+        /// Optional, iOS only.
+        __unsafe_unretained NSString *selected;
+    } NavigationButtonPressed;
+    /// `ANN.NavigationStateChanged`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *screen;
+        __unsafe_unretained NSString *tab;
+    } NavigationStateChanged;
+    /// The object of `ANN.NavigationStateChanged.screen`.
+    struct {
+        __unsafe_unretained NSString *id;
+        __unsafe_unretained NSString *name;
+    } NavigationStateChangedScreen;
+    /// `ANN.PreviewCompleted` (iOS).
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *previewComponentId;
+    } PreviewCompleted;
+    /// `ANN.ScreenInsetsChanged`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *top;
+        __unsafe_unretained NSString *right;
+        __unsafe_unretained NSString *bottom;
+        __unsafe_unretained NSString *left;
+    } ScreenInsetsChanged;
+    /// `ANN.ScreenPopped`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+    } ScreenPopped;
+    /// The object of `ANN.ScreenRegionsChanged.division`.
+    struct {
+        __unsafe_unretained NSString *x;
+        __unsafe_unretained NSString *y;
+        __unsafe_unretained NSString *width;
+        __unsafe_unretained NSString *height;
+    } ScreenRegionRect;
+    /// `ANN.ScreenRegionsChanged`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *division;
+        __unsafe_unretained NSString *occlusion;
+    } ScreenRegionsChanged;
+    /// `ANN.SearchBarCancelPressed`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+    } SearchBarCancelPressed;
+    /// `ANN.SearchBarSubmitted`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *text;
+        /// Optional.
+        __unsafe_unretained NSString *scope;
+        /// Optional, iOS only.
+        __unsafe_unretained NSString *tokens;
+    } SearchBarSubmitted;
+    /// `ANN.SearchBarUpdated`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *text;
+        __unsafe_unretained NSString *isFocused;
+        /// Optional.
+        __unsafe_unretained NSString *scope;
+        /// Optional, iOS only.
+        __unsafe_unretained NSString *tokens;
+    } SearchBarUpdated;
+    /// `ANN.SearchSuggestionPicked`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *suggestionId;
+    } SearchSuggestionPicked;
+    /// `ANN.SheetDetentChanged`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *detent;
+    } SheetDetentChanged;
+    /// `ANN.SlotDestroyed`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+    } SlotDestroyed;
+    /// `ANN.SplitViewColumnsStacked`.
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *stacked;
+    } SplitViewColumnsStacked;
+    /// `ANN.SplitViewDisplayModeChanged` (iOS).
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *displayMode;
+        /// Optional.
+        __unsafe_unretained NSString *inspectorVisible;
+    } SplitViewDisplayModeChanged;
+    /// `ANN.TitleRenamed` (iOS).
+    struct {
+        __unsafe_unretained NSString *event;
+        __unsafe_unretained NSString *componentId;
+        __unsafe_unretained NSString *text;
+    } TitleRenamed;
+} ANNEventContract;
+
+/// The name of every event, `ANN.<Name>`.
+FOUNDATION_EXPORT NSArray<NSString *> *ANNEventContractNames(void);
+
+NS_ASSUME_NONNULL_END

package/ios/Core/ANNEventContract.mm

@@ -0,0 +1,225 @@
+// Made by scripts/contract.mjs from the event types of src/interfaces/: change them and run the script again.
+
+#import "ANNEventContract.h"
+
+const struct ANNEventContractTable ANNEventContract = {
+    .AppLaunched = {.event = @"ANN.AppLaunched"},
+    .ArrangementChanged =
+        {
+            .event = @"ANN.ArrangementChanged",
+            .componentId = @"componentId",
+            .placement = @"placement",
+            .layout = @"layout",
+            .front = @"front",
+            .hidden = @"hidden",
+        },
+    .BottomAccessoryPlacementChanged =
+        {
+            .event = @"ANN.BottomAccessoryPlacementChanged",
+            .componentId = @"componentId",
+            .placement = @"placement",
+        },
+    .BottomTabLongPressed =
+        {
+            .event = @"ANN.BottomTabLongPressed",
+            .selectedTabIndex = @"selectedTabIndex",
+            .bottomTabsId = @"bottomTabsId",
+        },
+    .BottomTabPressed =
+        {
+            .event = @"ANN.BottomTabPressed",
+            .tabIndex = @"tabIndex",
+            .bottomTabsId = @"bottomTabsId",
+            .screenId = @"screenId",
+            .wasSelected = @"wasSelected",
+        },
+    .BottomTabSelected =
+        {
+            .event = @"ANN.BottomTabSelected",
+            .selectedTabIndex = @"selectedTabIndex",
+            .unselectedTabIndex = @"unselectedTabIndex",
+            .bottomTabsId = @"bottomTabsId",
+        },
+    .CommandCompleted =
+        {
+            .event = @"ANN.CommandCompleted",
+            .commandName = @"commandName",
+            .commandId = @"commandId",
+            .completionTime = @"completionTime",
+        },
+    .ComponentDidAppear =
+        {
+            .event = @"ANN.ComponentDidAppear",
+            .componentId = @"componentId",
+            .componentName = @"componentName",
+            .componentType = @"componentType",
+        },
+    .ComponentDidDisappear =
+        {
+            .event = @"ANN.ComponentDidDisappear",
+            .componentId = @"componentId",
+            .componentName = @"componentName",
+            .componentType = @"componentType",
+        },
+    .ComponentWillAppear =
+        {
+            .event = @"ANN.ComponentWillAppear",
+            .componentId = @"componentId",
+            .componentName = @"componentName",
+            .componentType = @"componentType",
+        },
+    .DeepLinkDispatched = {.event = @"ANN.DeepLinkDispatched", .url = @"url"},
+    .HingeChanged = {.event = @"ANN.HingeChanged", .state = @"state", .angle = @"angle"},
+    .KeyCommandPressed =
+        {
+            .event = @"ANN.KeyCommandPressed",
+            .componentId = @"componentId",
+            .keyCommandId = @"keyCommandId",
+        },
+    .ModalAttemptedToDismiss =
+        {
+            .event = @"ANN.ModalAttemptedToDismiss",
+            .componentId = @"componentId",
+        },
+    .ModalDismissed =
+        {
+            .event = @"ANN.ModalDismissed",
+            .componentId = @"componentId",
+            .componentName = @"componentName",
+            .modalsDismissed = @"modalsDismissed",
+        },
+    .NativeScreenCall =
+        {
+            .event = @"ANN.NativeScreenCall",
+            .componentId = @"componentId",
+            .callId = @"callId",
+            .kind = @"kind",
+            .name = @"name",
+            .args = @"args",
+        },
+    .NativeScreenReleased = {.event = @"ANN.NativeScreenReleased", .componentId = @"componentId"},
+    .NavigationButtonPressed =
+        {
+            .event = @"ANN.NavigationButtonPressed",
+            .componentId = @"componentId",
+            .buttonId = @"buttonId",
+            .selected = @"selected",
+        },
+    .NavigationStateChanged =
+        {
+            .event = @"ANN.NavigationStateChanged",
+            .screen = @"screen",
+            .tab = @"tab",
+        },
+    .NavigationStateChangedScreen = {.id = @"id", .name = @"name"},
+    .PreviewCompleted =
+        {
+            .event = @"ANN.PreviewCompleted",
+            .componentId = @"componentId",
+            .previewComponentId = @"previewComponentId",
+        },
+    .ScreenInsetsChanged =
+        {
+            .event = @"ANN.ScreenInsetsChanged",
+            .componentId = @"componentId",
+            .top = @"top",
+            .right = @"right",
+            .bottom = @"bottom",
+            .left = @"left",
+        },
+    .ScreenPopped = {.event = @"ANN.ScreenPopped", .componentId = @"componentId"},
+    .ScreenRegionRect = {.x = @"x", .y = @"y", .width = @"width", .height = @"height"},
+    .ScreenRegionsChanged =
+        {
+            .event = @"ANN.ScreenRegionsChanged",
+            .componentId = @"componentId",
+            .division = @"division",
+            .occlusion = @"occlusion",
+        },
+    .SearchBarCancelPressed =
+        {
+            .event = @"ANN.SearchBarCancelPressed",
+            .componentId = @"componentId",
+        },
+    .SearchBarSubmitted =
+        {
+            .event = @"ANN.SearchBarSubmitted",
+            .componentId = @"componentId",
+            .text = @"text",
+            .scope = @"scope",
+            .tokens = @"tokens",
+        },
+    .SearchBarUpdated =
+        {
+            .event = @"ANN.SearchBarUpdated",
+            .componentId = @"componentId",
+            .text = @"text",
+            .isFocused = @"isFocused",
+            .scope = @"scope",
+            .tokens = @"tokens",
+        },
+    .SearchSuggestionPicked =
+        {
+            .event = @"ANN.SearchSuggestionPicked",
+            .componentId = @"componentId",
+            .suggestionId = @"suggestionId",
+        },
+    .SheetDetentChanged =
+        {
+            .event = @"ANN.SheetDetentChanged",
+            .componentId = @"componentId",
+            .detent = @"detent",
+        },
+    .SlotDestroyed = {.event = @"ANN.SlotDestroyed", .componentId = @"componentId"},
+    .SplitViewColumnsStacked =
+        {
+            .event = @"ANN.SplitViewColumnsStacked",
+            .componentId = @"componentId",
+            .stacked = @"stacked",
+        },
+    .SplitViewDisplayModeChanged =
+        {
+            .event = @"ANN.SplitViewDisplayModeChanged",
+            .componentId = @"componentId",
+            .displayMode = @"displayMode",
+            .inspectorVisible = @"inspectorVisible",
+        },
+    .TitleRenamed = {.event = @"ANN.TitleRenamed", .componentId = @"componentId", .text = @"text"},
+};
+
+NSArray<NSString *> *ANNEventContractNames(void) {
+    return @[
+        ANNEventContract.AppLaunched.event,
+        ANNEventContract.ArrangementChanged.event,
+        ANNEventContract.BottomAccessoryPlacementChanged.event,
+        ANNEventContract.BottomTabLongPressed.event,
+        ANNEventContract.BottomTabPressed.event,
+        ANNEventContract.BottomTabSelected.event,
+        ANNEventContract.CommandCompleted.event,
+        ANNEventContract.ComponentDidAppear.event,
+        ANNEventContract.ComponentDidDisappear.event,
+        ANNEventContract.ComponentWillAppear.event,
+        ANNEventContract.DeepLinkDispatched.event,
+        ANNEventContract.HingeChanged.event,
+        ANNEventContract.KeyCommandPressed.event,
+        ANNEventContract.ModalAttemptedToDismiss.event,
+        ANNEventContract.ModalDismissed.event,
+        ANNEventContract.NativeScreenCall.event,
+        ANNEventContract.NativeScreenReleased.event,
+        ANNEventContract.NavigationButtonPressed.event,
+        ANNEventContract.NavigationStateChanged.event,
+        ANNEventContract.PreviewCompleted.event,
+        ANNEventContract.ScreenInsetsChanged.event,
+        ANNEventContract.ScreenPopped.event,
+        ANNEventContract.ScreenRegionsChanged.event,
+        ANNEventContract.SearchBarCancelPressed.event,
+        ANNEventContract.SearchBarSubmitted.event,
+        ANNEventContract.SearchBarUpdated.event,
+        ANNEventContract.SearchSuggestionPicked.event,
+        ANNEventContract.SheetDetentChanged.event,
+        ANNEventContract.SlotDestroyed.event,
+        ANNEventContract.SplitViewColumnsStacked.event,
+        ANNEventContract.SplitViewDisplayModeChanged.event,
+        ANNEventContract.TitleRenamed.event,
+    ];
+}

package/ios/Core/ANNEventEmitter.h

@@ -22,7 +22,8 @@ NS_ASSUME_NONNULL_BEGIN
 /// Whether the JavaScript of this emitter still runs: its events go only then. Any thread.
 @property(nonatomic, readonly) BOOL isCurrent;
 
-/// Sends `ANN.<name>` with the payload as it is. From another queue it moves to the main queue first.
+/// Sends the event `name` (`ANNEventContract.<Event>.event`, `ANN.<Event>`) with the payload as it is, its keys from
+/// `ANNEventContract` too. From another queue it moves to the main queue first.
 - (void)sendEvent:(NSString *)name body:(nullable NSDictionary<NSString *, id> *)body;
 
 #pragma mark - The contract
@@ -85,6 +86,9 @@ NS_ASSUME_NONNULL_BEGIN
 
 - (void)sendSlotDestroyed:(NSString *)componentId;
 
+/// `ANN.DeepLinkDispatched { url }` (iOS only): a link React Native's `Linking` didn't take, for JavaScript to hand it.
+- (void)sendDeepLinkDispatched:(NSURL *)url;
+
 /// `ANN.TitleRenamed { componentId, text }` (EVT-TitleRenamed).
 - (void)sendTitleRenamed:(NSString *)componentId text:(NSString *)text;