appium-mac2-driver 1.17.5 → 1.18.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.18.1](https://github.com/appium/appium-mac2-driver/compare/v1.18.0...v1.18.1) (2024-07-20)
+
+
+### Bug Fixes
+
+* Add a test for the keyboard input and perform related fixes ([#311](https://github.com/appium/appium-mac2-driver/issues/311)) ([af826e8](https://github.com/appium/appium-mac2-driver/commit/af826e83f60dd278f44042e2ef36b81390f3ef19))
+
+## [1.18.0](https://github.com/appium/appium-mac2-driver/compare/v1.17.5...v1.18.0) (2024-07-18)
+
+
+### Features
+
+* Add support of W3C key actions ([#309](https://github.com/appium/appium-mac2-driver/issues/309)) ([f83ff9f](https://github.com/appium/appium-mac2-driver/commit/f83ff9f41c972b64b45c88bd5a66d441d307267d))
+
 ## [1.17.5](https://github.com/appium/appium-mac2-driver/compare/v1.17.4...v1.17.5) (2024-07-09)
 
 

package/WebDriverAgentMac/IntegrationTests/AMW3CActionsTests.m

@@ -261,6 +261,18 @@
     },
     ],
 
+    // Keys are not balanced
+    @[@{
+      @"type": @"key",
+      @"id": @"keyboard",
+      @"actions": @[
+        @{@"type": @"keyDown", @"value": @"n"},
+        @{@"type": @"keyUp", @"value": @"n"},
+        @{@"type": @"keyUp", @"value": @"b"},
+      ],
+    },
+    ],
+
   ];
 
   for (NSArray<NSDictionary<NSString *, id> *> *invalidGesture in invalidGestures) {
@@ -274,6 +286,7 @@
 
 - (void)testClick
 {
+  [self switchToButtonsTab];
   XCUIElement *checkbox = self.testedApplication.checkBoxes.firstMatch;
   NSNumber *value = checkbox.value;
 
@@ -300,6 +313,7 @@
 
 - (void)testRightClick
 {
+  [self switchToButtonsTab];
   XCUIElement *checkbox = self.testedApplication.checkBoxes.firstMatch;
   NSNumber *value = checkbox.value;
 
@@ -324,5 +338,36 @@
   XCTAssertTrue([checkbox.value boolValue] == [value boolValue]);
 }
 
+- (void)testKeys
+{
+  [self switchToEditsTab];
+  XCUIElement *edit = self.testedApplication.textFields.firstMatch;
+  [edit click];
+
+  NSArray<NSDictionary<NSString *, id> *> *gesture =
+  @[@{
+    @"type": @"key",
+    @"id": @"keyboard",
+    @"actions": @[
+      @{@"type": @"keyDown", @"value": @"\uE008"},
+      @{@"type": @"pause", @"duration": @500},
+      @{@"type": @"keyDown", @"value": @"n"},
+      @{@"type": @"keyUp", @"value": @"n"},
+      @{@"type": @"keyDown", @"value": @"b"},
+      @{@"type": @"keyUp", @"value": @"b"},
+      @{@"type": @"keyDown", @"value": @"a"},
+      @{@"type": @"keyUp", @"value": @"a"},
+      @{@"type": @"pause", @"duration": @500},
+      @{@"type": @"keyUp", @"value": @"\uE008"},
+    ],
+  },
+  ];
+  NSError *error;
+  XCTAssertTrue([self.testedApplication fb_performW3CActions:gesture
+                                                elementCache:nil
+                                                       error:&error]);
+  XCTAssertNil(error);
+  XCTAssertEqualObjects(edit.value, @"NBA");
+}
 
 @end

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/FBW3CActionsHelpers.h

@@ -34,20 +34,22 @@ NSString *_Nullable FBRequireValue(NSDictionary<NSString *, id> *actionItem, NSE
 NSNumber *_Nullable FBOptDuration(NSDictionary<NSString *, id> *actionItem, NSNumber *_Nullable defaultValue, NSError **error);
 
 /**
- * Checks whether the given key action value is a W3C meta modifier
+ * Maps W3C meta modifier to XCTest compatible-one
+ * See https://w3c.github.io/webdriver/#actions
+ *
  * @param value key action value
- * @returns YES if the value is a meta modifier
+ * @returns the mapped modifier value or nil
  */
-BOOL FBIsMetaModifier(NSString *value);
+NSNumber *_Nullable AMToMetaModifier(NSString *value);
 
 /**
- * Maps W3C meta modifier to XCTest compatible-one
+ * Maps W3C special key to XCTest compatible-one
+ * See https://w3c.github.io/webdriver/#actions
  *
  * @param value key action value
- * @param reverse whether to reverse the modifier value, so it cancels the previusly set one
- * @returns the mapped modifier value or 0 in case of failure
+ * @returns the mapped modifier value or nil
  */
-NSUInteger FBToMetaModifier(NSString *value, BOOL reverse);
+NSString *_Nullable AMToSpecialKey(NSString *value);
 
 /**
  * Maps W3C button code to a XCTest compatible-one

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/FBW3CActionsHelpers.m

@@ -64,39 +64,153 @@ BOOL FBIsMetaModifier(NSString *value)
     || charCode == 0xE008;
 }
 
-NSUInteger FBToMetaModifier(NSString *value, BOOL reverse)
+NSNumber* AMToMetaModifier(NSString *value)
 {
-  if (!FBIsMetaModifier(value)) {
-    return 0;
+  if (0 == value.length) {
+    return nil;
   }
 
   unichar charCode = [value characterAtIndex:0];
-  NSUInteger result = 0;
   switch (charCode) {
     case 0xE000:
-      result = XCUIKeyModifierNone;
-      break;
+      return @(XCUIKeyModifierNone);
     case 0xE03D:
-      result = XCUIKeyModifierCommand;
-      break;
+      return @(XCUIKeyModifierCommand);
     case 0xE009:
-      result = XCUIKeyModifierControl;
-      break;
+      return @(XCUIKeyModifierControl);
     case 0xE00A:
-      result = XCUIKeyModifierOption;
-      break;
+      return @(XCUIKeyModifierOption);
     case 0xE008:
-      result = XCUIKeyModifierShift;
-      break;
+      return @(XCUIKeyModifierShift);
     default:
-      [FBLogger logFmt:@"Skipping the unsupported meta modifier with code %@", @(charCode)];
-      result = 0;
-      break;
+      return nil;
+  }
+}
+
+NSString* AMToSpecialKey(NSString *value)
+{
+  if (0 == [value length]) {
+    return nil;
   }
-  if (reverse) {
-    result = ~result;
+
+  unichar charCode = [value characterAtIndex:0];
+  switch (charCode) {
+    case 0xE000:
+      return @"";
+    case 0xE002:
+      return XCUIKeyboardKeyHelp;
+    case 0xE003:
+      return XCUIKeyboardKeyDelete;
+    case 0xE004:
+      return XCUIKeyboardKeyTab;
+    case 0xE005:
+      return XCUIKeyboardKeyClear;
+    case 0xE006:
+      return XCUIKeyboardKeyReturn;
+    case 0xE007:
+      return XCUIKeyboardKeyEnter;
+    case 0xE00C:
+      return XCUIKeyboardKeyEscape;
+    case 0xE00D:
+      return @" ";
+    case 0xE00E:
+    case 0xE054:
+      return XCUIKeyboardKeyPageUp;
+    case 0xE00F:
+    case 0xE055:
+      return XCUIKeyboardKeyPageDown;
+    case 0xE010:
+    case 0xE056:
+      return XCUIKeyboardKeyEnd;
+    case 0xE011:
+    case 0xE057:
+      return XCUIKeyboardKeyHome;
+    case 0xE012:
+    case 0xE058:
+      return XCUIKeyboardKeyLeftArrow;
+    case 0xE013:
+    case 0xE059:
+      return XCUIKeyboardKeyUpArrow;
+    case 0xE014:
+    case 0xE05A:
+      return XCUIKeyboardKeyRightArrow;
+    case 0xE015:
+    case 0xE05B:
+      return XCUIKeyboardKeyDownArrow;
+    case 0xE017:
+    case 0xE05D:
+      return XCUIKeyboardKeyForwardDelete;
+    case 0xE018:
+      return @";";
+    case 0xE019:
+      return @"=";
+    case 0xE01A:
+      return @"0";
+    case 0xE01B:
+      return @"1";
+    case 0xE01C:
+      return @"2";
+    case 0xE01D:
+      return @"3";
+    case 0xE01E:
+      return @"4";
+    case 0xE01F:
+      return @"5";
+    case 0xE020:
+      return @"6";
+    case 0xE021:
+      return @"7";
+    case 0xE022:
+      return @"8";
+    case 0xE023:
+      return @"9";
+    case 0xE024:
+      return @"*";
+    case 0xE025:
+      return @"+";
+    case 0xE026:
+      return @",";
+    case 0xE027:
+      return @"-";
+    case 0xE028:
+      return @".";
+    case 0xE029:
+      return @"/";
+    case 0xE031:
+      return XCUIKeyboardKeyF1;
+    case 0xE032:
+      return XCUIKeyboardKeyF2;
+    case 0xE033:
+      return XCUIKeyboardKeyF3;
+    case 0xE034:
+      return XCUIKeyboardKeyF4;
+    case 0xE035:
+      return XCUIKeyboardKeyF5;
+    case 0xE036:
+      return XCUIKeyboardKeyF6;
+    case 0xE037:
+      return XCUIKeyboardKeyF7;
+    case 0xE038:
+      return XCUIKeyboardKeyF8;
+    case 0xE039:
+      return XCUIKeyboardKeyF9;
+    case 0xE03A:
+      return XCUIKeyboardKeyF10;
+    case 0xE03B:
+      return XCUIKeyboardKeyF11;
+    case 0xE03C:
+      return XCUIKeyboardKeyF12;
+    case 0xE050:
+      return XCUIKeyboardKeyShift;
+    case 0xE051:
+      return XCUIKeyboardKeyControl;
+    case 0xE052:
+      return XCUIKeyboardKeyOption;
+    case 0xE053:
+      return XCUIKeyboardKeyCommand;
+    default:
+      return charCode >= 0xE000 && charCode <= 0xE05D ? @"" : nil;
   }
-  return result;
 }
 
 NSUInteger AMToXCTestButtonCode(NSUInteger w3cButtonCode)

package/WebDriverAgentMac/WebDriverAgentLib/Utilities/FBW3CActionsSynthesizer.m

@@ -76,6 +76,32 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
 
 @end
 
+@interface FBW3CKeyItem : FBBaseActionItem
+
+@property (nullable, readonly, nonatomic) FBW3CKeyItem *previousItem;
+
+- (NSUInteger)calculateModifiersForChain:(NSArray *)allItems
+                          lastItemIndex:(NSUInteger)lastItemIndex;
+
+@end
+
+@interface FBKeyUpItem : FBW3CKeyItem
+
+@property (readonly, nonatomic) NSString *value;
+
+@end
+
+@interface FBKeyDownItem : FBW3CKeyItem
+
+@property (readonly, nonatomic) NSString *value;
+
+@end
+
+@interface FBKeyPauseItem : FBW3CKeyItem
+
+@property (readonly, nonatomic) double duration;
+
+@end
 
 
 @implementation FBW3CGestureItem
@@ -392,6 +418,277 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
 @end
 
 
+@implementation FBW3CKeyItem
+
+- (nullable instancetype)initWithActionItem:(NSDictionary<NSString *, id> *)actionItem
+                                application:(XCUIApplication *)application
+                               previousItem:(nullable FBW3CKeyItem *)previousItem
+                                     offset:(double)offset
+                                      error:(NSError **)error
+{
+  self = [super init];
+  if (self) {
+    self.actionItem = actionItem;
+    self.application = application;
+    self.offset = offset;
+    _previousItem = previousItem;
+  }
+  return self;
+}
+
+- (NSUInteger)calculateModifiersForChain:(NSArray *)allItems
+                          lastItemIndex:(NSUInteger)lastItemIndex
+{
+  NSUInteger result = 0;
+  for (NSUInteger index = 0; index <= lastItemIndex; index++) {
+    FBW3CKeyItem *item = [allItems objectAtIndex:index];
+    NSNumber *modifier = nil;
+    BOOL isKeyDown = [item isKindOfClass:FBKeyDownItem.class];
+    BOOL isKeyUp = !isKeyDown && [item isKindOfClass:FBKeyUpItem.class];
+    if (isKeyDown || isKeyUp) {
+      NSString *value = [item performSelector:@selector(value)];
+      modifier = AMToMetaModifier(value);
+    }
+    if (nil == modifier) {
+      continue;
+    }
+    if (isKeyDown) {
+      result |= [modifier unsignedIntValue];
+    } else {
+      result &= ~[modifier unsignedIntValue];
+    }
+  }
+  return result;
+}
+
+@end
+
+
+@implementation FBKeyUpItem : FBW3CKeyItem
+
+- (nullable instancetype)initWithActionItem:(NSDictionary<NSString *, id> *)actionItem
+                                application:(XCUIApplication *)application
+                               previousItem:(nullable FBW3CKeyItem *)previousItem
+                                     offset:(double)offset
+                                      error:(NSError **)error
+{
+  self = [super initWithActionItem:actionItem
+                       application:application
+                      previousItem:previousItem
+                            offset:offset
+                             error:error];
+  if (self) {
+    NSString *value = FBRequireValue(actionItem, error);
+    if (nil == value) {
+      return nil;
+    }
+    _value = value;
+  }
+  return self;
+}
+
++ (NSString *)actionName
+{
+  return FB_ACTION_ITEM_TYPE_KEY_UP;
+}
+
+- (BOOL)hasDownPairInItems:(NSArray *)allItems
+          currentItemIndex:(NSUInteger)currentItemIndex
+{
+  NSInteger balance = 1;
+  for (NSInteger index = currentItemIndex - 1; index >= 0; index--) {
+    FBW3CKeyItem *item = [allItems objectAtIndex:index];
+    BOOL isKeyDown = [item isKindOfClass:FBKeyDownItem.class];
+    BOOL isKeyUp = !isKeyDown && [item isKindOfClass:FBKeyUpItem.class];
+    if (!isKeyUp && !isKeyDown) {
+      continue;
+    }
+
+    NSString *value = [item performSelector:@selector(value)];
+    if (isKeyDown && [value isEqualToString:self.value]) {
+      balance--;
+    }
+    if (isKeyUp && [value isEqualToString:self.value]) {
+      balance++;
+    }
+  }
+  return 0 == balance;
+}
+
++ (NSUInteger)defaultTypingFrequency
+{
+  NSInteger defaultFreq = [[NSUserDefaults standardUserDefaults]
+                           integerForKey:@"com.apple.xctest.iOSMaximumTypingFrequency"];
+  return defaultFreq > 0 ? defaultFreq : 60;
+}
+
+- (NSArray<XCPointerEventPath *> *)addToEventPath:(XCPointerEventPath *)eventPath
+                                         allItems:(NSArray *)allItems
+                                 currentItemIndex:(NSUInteger)currentItemIndex
+                                            error:(NSError **)error
+{
+  if (![self hasDownPairInItems:allItems currentItemIndex:currentItemIndex]) {
+    NSString *description = [NSString stringWithFormat:@"Key Up action '%@' is not balanced with a preceding Key Down one in '%@'", self.value, self.actionItem];
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:description] build];
+    }
+    return nil;
+  }
+
+  NSNumber *modifier = AMToMetaModifier(self.value);
+  if (nil != modifier) {
+    return @[];
+  }
+
+  NSTimeInterval offsetSeconds = FBMillisToSeconds(self.offset);
+  XCPointerEventPath *result = nil == eventPath ? [[XCPointerEventPath alloc] initForTextInput] : eventPath;
+
+  NSString *specialKey = AMToSpecialKey(self.value);
+  NSUInteger modifiers = [self calculateModifiersForChain:allItems lastItemIndex:currentItemIndex];
+  if (nil != specialKey) {
+    if (specialKey.length > 0) {
+      [result typeKey:specialKey
+            modifiers:modifiers
+             atOffset:offsetSeconds];
+    }
+    return @[result];
+  }
+
+  NSUInteger len = [self.value length];
+  unichar buffer[len + 1];
+  [self.value getCharacters:buffer range:NSMakeRange(0, len)];
+  for (int i = 0; i < 1; i++) {
+    unichar charCode = buffer[i];
+    NSString *oneChar = [NSString stringWithFormat:@"%C", charCode];
+    // 0x7F is the end of the first half of the ASCII table, where (almoust) all
+    // chars have their own key representations
+    if (charCode <= 0x7F) {
+      [result typeKey:oneChar
+            modifiers:modifiers
+             atOffset:offsetSeconds];
+    } else {
+      // The typeText API does not respect modifiers
+      // while the typeKey API can only enter keys
+      [result typeText:oneChar
+              atOffset:offsetSeconds
+           typingSpeed:[self.class defaultTypingFrequency]
+          shouldRedact:NO];
+    }
+  }
+
+  return @[result];
+}
+
+@end
+
+@implementation FBKeyDownItem : FBW3CKeyItem
+
+- (nullable instancetype)initWithActionItem:(NSDictionary<NSString *, id> *)actionItem
+                                application:(XCUIApplication *)application
+                               previousItem:(nullable FBW3CKeyItem *)previousItem
+                                     offset:(double)offset
+                                      error:(NSError **)error
+{
+  self = [super initWithActionItem:actionItem
+                       application:application
+                      previousItem:previousItem
+                            offset:offset
+                             error:error];
+  if (self) {
+    NSString *value = FBRequireValue(actionItem, error);
+    if (nil == value) {
+      return nil;
+    }
+    _value = value;
+  }
+  return self;
+}
+
++ (NSString *)actionName
+{
+  return FB_ACTION_ITEM_TYPE_KEY_DOWN;
+}
+
+- (BOOL)hasUpPairInItems:(NSArray *)allItems
+        currentItemIndex:(NSUInteger)currentItemIndex
+{
+  NSInteger balance = 1;
+  for (NSUInteger index = currentItemIndex + 1; index < allItems.count; index++) {
+    FBW3CKeyItem *item = [allItems objectAtIndex:index];
+    BOOL isKeyDown = [item isKindOfClass:FBKeyDownItem.class];
+    BOOL isKeyUp = !isKeyDown && [item isKindOfClass:FBKeyUpItem.class];
+    if (!isKeyUp && !isKeyDown) {
+      continue;
+    }
+
+    NSString *value = [item performSelector:@selector(value)];
+    if (isKeyUp && [value isEqualToString:self.value]) {
+      balance--;
+    }
+    if (isKeyDown && [value isEqualToString:self.value]) {
+      balance++;
+    }
+  }
+  return 0 == balance;
+}
+
+- (NSArray<XCPointerEventPath *> *)addToEventPath:(XCPointerEventPath *)eventPath
+                                         allItems:(NSArray *)allItems
+                                 currentItemIndex:(NSUInteger)currentItemIndex
+                                            error:(NSError **)error
+{
+  if (![self hasUpPairInItems:allItems currentItemIndex:currentItemIndex]) {
+    NSString *description = [NSString stringWithFormat:@"Key Down action '%@' must have a closing Key Up successor in '%@'", self.value, self.actionItem];
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:description] build];
+    }
+    return nil;
+  }
+
+  return @[];
+}
+
+@end
+
+@implementation FBKeyPauseItem
+
+- (nullable instancetype)initWithActionItem:(NSDictionary<NSString *, id> *)actionItem
+                                application:(XCUIApplication *)application
+                               previousItem:(nullable FBW3CKeyItem *)previousItem
+                                     offset:(double)offset
+                                      error:(NSError **)error
+{
+  self = [super initWithActionItem:actionItem
+                       application:application
+                      previousItem:previousItem
+                            offset:offset
+                             error:error];
+  if (self) {
+    NSNumber *duration = FBOptDuration(actionItem, nil, error);
+    if (nil == duration) {
+      return nil;
+    }
+    _duration = [duration doubleValue];
+  }
+  return self;
+}
+
++ (NSString *)actionName
+{
+  return FB_ACTION_ITEM_TYPE_PAUSE;
+}
+
+- (NSArray<XCPointerEventPath *> *)addToEventPath:(XCPointerEventPath *)eventPath
+                                         allItems:(NSArray *)allItems
+                                 currentItemIndex:(NSUInteger)currentItemIndex
+                                            error:(NSError **)error
+{
+  return @[];
+}
+
+@end
+
+
 @interface FBW3CGestureItemsChain : FBBaseActionItemsChain
 
 @end
@@ -474,7 +771,74 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
   return [[result reverseObjectEnumerator] allObjects];
 }
 
-- (nullable NSArray<XCPointerEventPath *> *)eventPathsWithGestureAction:(NSDictionary<NSString *, id> *)actionDescription forActionId:(NSString *)actionId error:(NSError **)error
+- (nullable NSArray<XCPointerEventPath *> *)eventPathsWithKeyAction:(NSDictionary<NSString *, id> *)actionDescription
+                                                        forActionId:(NSString *)actionId
+                                                              error:(NSError **)error
+{
+  static NSDictionary<NSString *, Class> *keyItemsMapping;
+  static NSArray<NSString *> *supportedActionItemTypes;
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    NSMutableDictionary<NSString *, Class> *itemsMapping = [NSMutableDictionary dictionary];
+    for (Class cls in @[FBKeyDownItem.class,
+                        FBKeyPauseItem.class,
+                        FBKeyUpItem.class]) {
+      [itemsMapping setObject:cls forKey:[cls actionName]];
+    }
+    keyItemsMapping = itemsMapping.copy;
+    supportedActionItemTypes = @[FB_ACTION_ITEM_TYPE_PAUSE,
+                                 FB_ACTION_ITEM_TYPE_KEY_UP,
+                                 FB_ACTION_ITEM_TYPE_KEY_DOWN];
+  });
+
+  NSArray<NSDictionary<NSString *, id> *> *actionItems = [actionDescription objectForKey:FB_KEY_ACTIONS];
+  if (nil == actionItems || 0 == actionItems.count) {
+    NSString *description = [NSString stringWithFormat:@"It is mandatory to have at least one item defined for each action. Action with id '%@' contains none", actionId];
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:description] build];
+    }
+    return nil;
+  }
+
+  FBW3CKeyItemsChain *chain = [[FBW3CKeyItemsChain alloc] init];
+  NSArray<NSDictionary<NSString *, id> *> *processedItems = [self preprocessedActionItemsWith:actionItems];
+  for (NSDictionary<NSString *, id> *actionItem in processedItems) {
+    id actionItemType = [actionItem objectForKey:FB_ACTION_ITEM_KEY_TYPE];
+    if (![actionItemType isKindOfClass:NSString.class]) {
+      NSString *description = [NSString stringWithFormat:@"The %@ property is mandatory to set for '%@' action item", FB_ACTION_ITEM_KEY_TYPE, actionItem];
+      if (error) {
+        *error = [[FBErrorBuilder.builder withDescription:description] build];
+      }
+      return nil;
+    }
+
+    Class keyItemClass = [keyItemsMapping objectForKey:actionItemType];
+    if (nil == keyItemClass) {
+      NSString *description = [NSString stringWithFormat:@"'%@' action item type '%@' is not supported. Only the following action item types are supported: %@", actionId, actionItemType, supportedActionItemTypes];
+      if (error) {
+        *error = [[FBErrorBuilder.builder withDescription:description] build];
+      }
+      return nil;
+    }
+
+    FBW3CKeyItem *keyItem = [[keyItemClass alloc] initWithActionItem:actionItem
+                                                         application:self.application
+                                                        previousItem:[chain.items lastObject]
+                                                              offset:chain.durationOffset
+                                                               error:error];
+    if (nil == keyItem) {
+      return nil;
+    }
+
+    [chain addItem:keyItem];
+  }
+
+  return [chain asEventPathsWithError:error];
+}
+
+- (nullable NSArray<XCPointerEventPath *> *)eventPathsWithGestureAction:(NSDictionary<NSString *, id> *)actionDescription
+                                                            forActionId:(NSString *)actionId
+                                                                  error:(NSError **)error
 {
   static NSDictionary<NSString *, Class> *gestureItemsMapping;
   static NSArray<NSString *> *supportedActionItemTypes;
@@ -559,16 +923,19 @@ static NSString *const FB_KEY_ACTIONS = @"actions";
 {
   id actionType = [actionDescription objectForKey:FB_KEY_TYPE];
   if (![actionType isKindOfClass:NSString.class] ||
-      !([actionType isEqualToString:FB_ACTION_TYPE_POINTER])) {
-    NSString *description = [NSString stringWithFormat:@"Only actions of '%@' types are supported. '%@' is given instead for action with id '%@'",
-                             @[FB_ACTION_TYPE_POINTER], actionType, actionId];
+      !([actionType isEqualToString:FB_ACTION_TYPE_POINTER] || [actionType isEqualToString:FB_ACTION_TYPE_KEY])) {
+    NSString *description = [NSString stringWithFormat:@"Only actions of '%@' types are supported. '%@' is given instead for action with id '%@'", @[FB_ACTION_TYPE_POINTER, FB_ACTION_TYPE_KEY], actionType, actionId];
     if (error) {
       *error = [[FBErrorBuilder.builder withDescription:description] build];
     }
     return nil;
   }
 
-  return [self eventPathsWithGestureAction:actionDescription forActionId:actionId error:error];
+  if ([actionType isEqualToString:FB_ACTION_TYPE_POINTER]) {
+    return [self eventPathsWithGestureAction:actionDescription forActionId:actionId error:error];
+  }
+
+  return [self eventPathsWithKeyAction:actionDescription forActionId:actionId error:error];
 }
 
 - (nullable XCSynthesizedEventRecord *)synthesizeWithError:(NSError **)error

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "appium-mac2-driver",
-  "version": "1.17.5",
+  "version": "1.18.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "appium-mac2-driver",
-      "version": "1.17.5",
+      "version": "1.18.1",
       "license": "Apache-2.0",
       "dependencies": {
         "@appium/strongbox": "^0.x",
@@ -50,12 +50,13 @@
       }
     },
     "node_modules/@appium/logger": {
-      "version": "1.5.0",
-      "resolved": "https://registry.npmjs.org/@appium/logger/-/logger-1.5.0.tgz",
-      "integrity": "sha512-wij7z6RgCxiu66jgpySQHxj0dcuGfSn7v97MBwZ9+IEiqFDrbZR1+ExrXpbmqNXkVWOqWvNFXCYROW0g5dfKuA==",
+      "version": "1.6.0",
+      "resolved": "https://registry.npmjs.org/@appium/logger/-/logger-1.6.0.tgz",
+      "integrity": "sha512-zUIeVUWmIDyInSHYUa4+TK6Bd/dL3kBJHVDZhAAKGsqzNLaaRESCSVmKVOYNGqZVqNe/wPKa+aRW9Z3iRTGE5Q==",
       "dependencies": {
         "console-control-strings": "1.1.0",
         "lodash": "4.17.21",
+        "lru-cache": "10.3.0",
         "set-blocking": "2.0.0"
       },
       "engines": {
@@ -78,9 +79,9 @@
       }
     },
     "node_modules/@appium/strongbox": {
-      "version": "0.3.2",
-      "resolved": "https://registry.npmjs.org/@appium/strongbox/-/strongbox-0.3.2.tgz",
-      "integrity": "sha512-3UJi5MP+MBfDomaBtzuXtCzYJCSTpYKfM2bcFp4yl8AWpfSzZLgszOY31Gg8/u1R3LZ9irdBGYxb5wqyaQbYLw==",
+      "version": "0.3.3",
+      "resolved": "https://registry.npmjs.org/@appium/strongbox/-/strongbox-0.3.3.tgz",
+      "integrity": "sha512-p9muLFz7Xl+DgUZQgLTQ8HBwhkuZOrODBTADGACJbfMKT8FcOGr+guM12yCjPwucqVFa7SrM5qDUKxf4rkQDTw==",
       "dependencies": {
         "env-paths": "2.2.1",
         "slugify": "1.6.6"
@@ -91,13 +92,13 @@
       }
     },
     "node_modules/@appium/support": {
-      "version": "5.1.1",
-      "resolved": "https://registry.npmjs.org/@appium/support/-/support-5.1.1.tgz",
-      "integrity": "sha512-YwludQ+V5mgGYJQjkuDJ29X0LSJehBeC5IwvaZxKdv/VKLKAbOl3QZqv3RKIGJqQInP6ZOD+doG3OVP64Y/txQ==",
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/@appium/support/-/support-5.1.2.tgz",
+      "integrity": "sha512-KwaCiwKOLaAPLpZYWbWFnoFjUwRiFMXgtLE9a7lWC0a7fZfT59HTu78HNoDu7WvgMaiGVyDxOYjrkI+MeONKiw==",
       "dependencies": {
-        "@appium/logger": "^1.5.0",
+        "@appium/logger": "^1.6.0",
         "@appium/tsconfig": "^0.3.3",
-        "@appium/types": "^0.21.0",
+        "@appium/types": "^0.21.1",
         "@colors/colors": "1.6.0",
         "@types/archiver": "6.0.2",
         "@types/base64-stream": "1.0.5",
@@ -142,8 +143,8 @@
         "shell-quote": "1.8.1",
         "source-map-support": "0.5.21",
         "supports-color": "8.1.1",
-        "teen_process": "2.1.6",
-        "type-fest": "4.20.1",
+        "teen_process": "2.2.0",
+        "type-fest": "4.21.0",
         "uuid": "10.0.0",
         "which": "4.0.0",
         "yauzl": "3.1.3"
@@ -156,19 +157,15 @@
         "sharp": "0.33.4"
       }
     },
-    "node_modules/@appium/support/node_modules/teen_process": {
-      "version": "2.1.6",
-      "resolved": "https://registry.npmjs.org/teen_process/-/teen_process-2.1.6.tgz",
-      "integrity": "sha512-VCbxLX0EMjnq3kYS+UJBlqAIJJeNfAxDExLLX0jvWa8KyRPbVLzc+CHFwigwR8fTWIdsVOXR2f7owrSq1xtYrw==",
-      "dependencies": {
-        "bluebird": "^3.7.2",
-        "lodash": "^4.17.21",
-        "shell-quote": "^1.8.1",
-        "source-map-support": "^0.x"
+    "node_modules/@appium/support/node_modules/semver": {
+      "version": "7.6.2",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz",
+      "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==",
+      "bin": {
+        "semver": "bin/semver.js"
       },
       "engines": {
-        "node": "^16.13.0 || >=18.0.0",
-        "npm": ">=8"
+        "node": ">=10"
       }
     },
     "node_modules/@appium/tsconfig": {
@@ -184,16 +181,16 @@
       }
     },
     "node_modules/@appium/types": {
-      "version": "0.21.0",
-      "resolved": "https://registry.npmjs.org/@appium/types/-/types-0.21.0.tgz",
-      "integrity": "sha512-Z2kx1W6oLwXTzu/aETBJ1AivdjTSWtlT5xBPckR9Nzh+JpGboBJtJsiAhmPHeEBLhEB/pqXKxKVlh9NV8eKGaw==",
+      "version": "0.21.1",
+      "resolved": "https://registry.npmjs.org/@appium/types/-/types-0.21.1.tgz",
+      "integrity": "sha512-xQRIWEYOe5ldItXhYiIxNT+0tt00p0g76YPgzOtFNDj73MWSuKGZfjfM3sl7RcK2wwLvVXc4aixK0QcLwN+UUA==",
       "dependencies": {
-        "@appium/logger": "^1.5.0",
+        "@appium/logger": "^1.6.0",
         "@appium/schema": "^0.6.1",
         "@appium/tsconfig": "^0.3.3",
         "@types/express": "4.17.21",
         "@types/ws": "8.5.10",
-        "type-fest": "4.20.1"
+        "type-fest": "4.21.0"
       },
       "engines": {
         "node": "^14.17.0 || ^16.13.0 || >=18.0.0",
@@ -531,9 +528,9 @@
       "integrity": "sha512-Q8oFIHJHr+htLrTXN2FuZfg+WXVHQRwU/hC2GpUu+Q8e3FUM9EDkS2pE3R2AO1ZGu56f479ybdMCNF1DAu8cAQ=="
     },
     "node_modules/@types/lodash": {
-      "version": "4.17.6",
-      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.6.tgz",
-      "integrity": "sha512-OpXEVoCKSS3lQqjx9GGGOapBeuW5eUboYHRlHP9urXPX25IKZ6AnP5ZRxtVf63iieUbsHxLn8NQ5Nlftc6yzAA=="
+      "version": "4.17.7",
+      "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.7.tgz",
+      "integrity": "sha512-8wTvZawATi/lsmNu10/j2hk1KEP0IvjubqPE3cu1Xz7xfXXt5oCq3SNUz4fMIP4XGF9Ky+Ue2tBA3hcS7LSBlA=="
     },
     "node_modules/@types/mime": {
       "version": "1.3.5",
@@ -554,9 +551,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.14.10",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.10.tgz",
-      "integrity": "sha512-MdiXf+nDuMvY0gJKxyfZ7/6UFsETO7mGKF54MVD/ekJS6HdFtpZFBgrh6Pseu64XTb2MLyFPlbW6hj8HYRQNOQ==",
+      "version": "20.14.11",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.14.11.tgz",
+      "integrity": "sha512-kprQpL8MMeszbz6ojB5/tU8PLN4kesnN8Gjzw349rDlNgsSzg90lAVj3llK99Dh7JON+t9AuscPPFW6mPbTnSA==",
       "dependencies": {
         "undici-types": "~5.26.4"
       }
@@ -691,9 +688,9 @@
       }
     },
     "node_modules/appium-xcode": {
-      "version": "5.2.16",
-      "resolved": "https://registry.npmjs.org/appium-xcode/-/appium-xcode-5.2.16.tgz",
-      "integrity": "sha512-Ig+MygLJzEEDv0AEF/hWyntJUuikC/olcLdkALpZrmKkRnUgnMNkoQ7ahZK/owGrLrg2Xeol65egRwYsUR26/A==",
+      "version": "5.2.17",
+      "resolved": "https://registry.npmjs.org/appium-xcode/-/appium-xcode-5.2.17.tgz",
+      "integrity": "sha512-9pxQNGw5MZFJs9yfdjCFrIe+2DEaMEupMz5/DXzGffVGod315pTKpSDe2HJZaPpH/ztRtlrxmg67rccS6GzbNw==",
       "dependencies": {
         "@appium/support": "^5.0.3",
         "@types/lodash": "^4.14.192",
@@ -1435,9 +1432,9 @@
       "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg=="
     },
     "node_modules/is-core-module": {
-      "version": "2.14.0",
-      "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.14.0.tgz",
-      "integrity": "sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A==",
+      "version": "2.15.0",
+      "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.15.0.tgz",
+      "integrity": "sha512-Dd+Lb2/zvk9SKy1TGCt1wFJFo/MWBPMX5x7KcvLajWTGuomczdQX61PvY5yK6SVACwpoexWo81IfFyoKY2QnTA==",
       "dependencies": {
         "hasown": "^2.0.2"
       },
@@ -1495,15 +1492,12 @@
       }
     },
     "node_modules/jackspeak": {
-      "version": "3.4.2",
-      "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.2.tgz",
-      "integrity": "sha512-qH3nOSj8q/8+Eg8LUPOq3C+6HWkpUioIjDsq1+D4zY91oZvpPttw8GwtF1nReRYKXl+1AORyFqtm2f5Q1SB6/Q==",
+      "version": "3.4.3",
+      "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz",
+      "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==",
       "dependencies": {
         "@isaacs/cliui": "^8.0.2"
       },
-      "engines": {
-        "node": "14 >=14.21 || 16 >=16.20 || >=18"
-      },
       "funding": {
         "url": "https://github.com/sponsors/isaacs"
       },
@@ -2207,9 +2201,9 @@
       }
     },
     "node_modules/semver": {
-      "version": "7.6.2",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.2.tgz",
-      "integrity": "sha512-FNAIBWCx9qcRhoHcgcJ0gvU7SN1lYU2ZXuSfl04bSC5OpvDHFyJCjdNHomPXxjQlCBU67YW64PzY7/VIEH7F2w==",
+      "version": "7.6.3",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz",
+      "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==",
       "bin": {
         "semver": "bin/semver.js"
       },
@@ -2559,9 +2553,9 @@
       "extraneous": true
     },
     "node_modules/type-fest": {
-      "version": "4.20.1",
-      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.20.1.tgz",
-      "integrity": "sha512-R6wDsVsoS9xYOpy8vgeBlqpdOyzJ12HNfQhC/aAKWM3YoCV9TtunJzh/QpkMgeDhkoynDcw5f1y+qF9yc/HHyg==",
+      "version": "4.21.0",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.21.0.tgz",
+      "integrity": "sha512-ADn2w7hVPcK6w1I0uWnM//y1rLXZhzB9mr0a3OirzclKF1Wp6VzevUmzz/NRAWunOT6E8HrnpGY7xOfc6K57fA==",
       "engines": {
         "node": ">=16"
       },
@@ -2717,9 +2711,9 @@
       "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="
     },
     "node_modules/ws": {
-      "version": "8.17.1",
-      "resolved": "https://registry.npmjs.org/ws/-/ws-8.17.1.tgz",
-      "integrity": "sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ==",
+      "version": "8.18.0",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.0.tgz",
+      "integrity": "sha512-8VbfWfHLbbwu3+N6OKsOMpBdT4kXPDDB9cJk2bJ6mh9ucxdlnNvH1e+roYkKmN9Nxw2yjz7VzeO9oOz2zJ04Pw==",
       "extraneous": true,
       "engines": {
         "node": ">=10.0.0"

package/package.json

@@ -6,7 +6,7 @@
     "mac",
     "XCTest"
   ],
-  "version": "1.17.5",
+  "version": "1.18.1",
   "author": "Appium Contributors",
   "license": "Apache-2.0",
   "repository": {