@capacitor-plus/ios 8.0.0-beta.0

package/Capacitor/Capacitor/CAPPlugin.h

@@ -0,0 +1,60 @@
+#import <Foundation/Foundation.h>
+#import <WebKit/WebKit.h>
+
+@protocol CAPBridgeProtocol;
+@class CAPPluginCall;
+
+@class PluginConfig;
+
+@interface CAPPlugin : NSObject
+
+@property (nonatomic, weak, nullable) WKWebView *webView;
+@property (nonatomic, weak, nullable) id<CAPBridgeProtocol> bridge;
+@property (nonatomic, strong, nonnull) NSString *pluginId;
+@property (nonatomic, strong, nonnull) NSString *pluginName;
+@property (nonatomic, strong, nullable) NSMutableDictionary<NSString *, NSMutableArray<CAPPluginCall *>*> *eventListeners;
+@property (nonatomic, strong, nullable) NSMutableDictionary<NSString *, NSMutableArray<id> *> *retainedEventArguments;
+@property (nonatomic, assign) BOOL shouldStringifyDatesInCalls;
+
+- (instancetype _Nonnull) initWithBridge:(id<CAPBridgeProtocol> _Nonnull) bridge pluginId:(NSString* _Nonnull) pluginId pluginName:(NSString* _Nonnull) pluginName DEPRECATED_MSG_ATTRIBUTE("This initializer is deprecated and is not suggested for use. Any data set through this init method will be overridden when it is loaded on the bridge.");
+- (void)addEventListener:(NSString* _Nonnull)eventName listener:(CAPPluginCall* _Nonnull)listener;
+- (void)removeEventListener:(NSString* _Nonnull)eventName listener:(CAPPluginCall* _Nonnull)listener;
+- (void)notifyListeners:(NSString* _Nonnull)eventName data:(NSDictionary<NSString *, id>* _Nullable)data;
+- (void)notifyListeners:(NSString* _Nonnull)eventName data:(NSDictionary<NSString *, id>* _Nullable)data retainUntilConsumed:(BOOL)retain;
+- (NSArray<CAPPluginCall *>* _Nullable)getListeners:(NSString* _Nonnull)eventName;
+- (BOOL)hasListeners:(NSString* _Nonnull)eventName;
+- (void)addListener:(CAPPluginCall* _Nonnull)call;
+- (void)removeListener:(CAPPluginCall* _Nonnull)call;
+- (void)removeAllListeners:(CAPPluginCall* _Nonnull)call;
+/**
+ * Default implementation of the capacitor 3.0 permission pattern
+ */
+- (void)checkPermissions:(CAPPluginCall* _Nonnull)call;
+- (void)requestPermissions:(CAPPluginCall* _Nonnull)call;
+/**
+ * Give the plugins a chance to take control when a URL is about to be loaded in the WebView.
+ * Returning true causes the WebView to abort loading the URL.
+ * Returning false causes the WebView to continue loading the URL.
+ * Returning nil will defer to the default Capacitor policy
+ */
+- (NSNumber* _Nullable)shouldOverrideLoad:(WKNavigationAction* _Nonnull)navigationAction;
+/**
+ * Allows plugins to hook into and respond to the WebView's URL authentication challenge.
+ * Returning false will defer to the default response of [.rejectProtectionSpace](https://developer.apple.com/documentation/Foundation/URLSession/AuthChallengeDisposition/rejectProtectionSpace).
+ */
+- (BOOL)handleWKWebViewURLAuthenticationChallenge:(NSURLAuthenticationChallenge* _Nonnull)challenge completionHandler:(void (^_Nonnull)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential * _Nullable credential))completionHandler;
+
+// Called after init if the plugin wants to do
+// some loading so the plugin author doesn't
+// need to override init()
+-(void)load;
+-(NSString* _Nonnull)getId;
+-(BOOL)getBool:(CAPPluginCall* _Nonnull) call field:(NSString* _Nonnull)field defaultValue:(BOOL)defaultValue DEPRECATED_MSG_ATTRIBUTE("Use accessors on CAPPluginCall instead. See CAPBridgedJSTypes.h for Obj-C implementations.");
+-(NSString* _Nullable)getString:(CAPPluginCall* _Nonnull)call field:(NSString* _Nonnull)field defaultValue:(NSString* _Nonnull)defaultValue DEPRECATED_MSG_ATTRIBUTE("Use accessors on CAPPluginCall instead. See CAPBridgedJSTypes.h for Obj-C implementations.");
+-(id _Nullable)getConfigValue:(NSString* _Nonnull)key __deprecated_msg("use getConfig() and access config values using the methods available depending on the type.");
+-(PluginConfig* _Nonnull)getConfig;
+-(void)setCenteredPopover:(UIViewController* _Nonnull) vc;
+-(void)setCenteredPopover:(UIViewController* _Nonnull) vc size:(CGSize) size;
+-(BOOL)supportsPopover DEPRECATED_MSG_ATTRIBUTE("All iOS 13+ devices support popover");
+
+@end

package/Capacitor/Capacitor/CAPPlugin.m

@@ -0,0 +1,180 @@
+#import "CAPPlugin.h"
+#import "CAPBridgedJSTypes.h"
+#import <Capacitor/Capacitor-Swift.h>
+#import <Foundation/Foundation.h>
+
+@implementation CAPPlugin
+
+-(instancetype) initWithBridge:(id<CAPBridgeProtocol>)bridge pluginId:(NSString *)pluginId pluginName:(NSString *)pluginName {
+  self.bridge = bridge;
+  self.webView = bridge.webView;
+  self.pluginId = pluginId;
+  self.pluginName = pluginName;
+  self.eventListeners = [[NSMutableDictionary alloc] init];
+  self.retainedEventArguments = [[NSMutableDictionary alloc] init];
+  self.shouldStringifyDatesInCalls = true;
+  return self;
+}
+
+-(NSString *) getId {
+  return self.pluginName;
+}
+
+- (BOOL)getBool:(CAPPluginCall *)call field:(NSString *)field defaultValue:(BOOL)defaultValue {
+  NSNumber* value = [call getNumber:field defaultValue:[NSNumber numberWithBool:defaultValue]];
+  return [value boolValue];
+}
+
+- (NSString *) getString:(CAPPluginCall *)call field:(NSString *)field defaultValue:(NSString *)defaultValue {
+  return [call getString:field defaultValue:defaultValue];
+}
+
+-(id)getConfigValue:(NSString *)key __deprecated {
+  return [self.bridge.config getPluginConfigValue:self.pluginName :key];
+}
+
+-(PluginConfig*)getConfig {
+    return [self.bridge.config getPluginConfig:self.pluginName];
+}
+
+-(void)load {}
+
+- (void)addEventListener:(NSString *)eventName listener:(CAPPluginCall *)listener {
+  NSMutableArray *listenersForEvent = [self.eventListeners objectForKey:eventName];
+  if(listenersForEvent == nil || [listenersForEvent count] == 0) {
+    listenersForEvent = [[NSMutableArray alloc] initWithObjects:listener, nil];
+    [self.eventListeners setValue:listenersForEvent forKey:eventName];
+    
+    [self sendRetainedArgumentsForEvent:eventName];
+  } else {
+    [listenersForEvent addObject:listener];
+  }
+}
+
+- (void)sendRetainedArgumentsForEvent:(NSString *)eventName {
+    // copy retained args and null source to prevent potential race conditions
+    NSMutableArray *retained = [self.retainedEventArguments objectForKey:eventName];
+    if (retained == nil) {
+        return;
+    }
+    
+    [self.retainedEventArguments removeObjectForKey:eventName];
+    
+    for(id data in retained) {
+        [self notifyListeners:eventName data:data];
+    }
+}
+
+- (void)removeEventListener:(NSString *)eventName listener:(CAPPluginCall *)listener {
+  NSMutableArray *listenersForEvent = [self.eventListeners objectForKey:eventName];
+  if(!listenersForEvent) { return; }
+  NSUInteger listenerIndex = [listenersForEvent indexOfObject:listener];
+  if(listenerIndex == NSNotFound) {
+    return;
+  }
+  [listenersForEvent removeObjectAtIndex:listenerIndex];
+}
+
+- (void)notifyListeners:(NSString *)eventName data:(NSDictionary<NSString *,id> *)data {
+  [self notifyListeners:eventName data:data retainUntilConsumed:NO];
+}
+
+- (void)notifyListeners:(NSString *)eventName data:(NSDictionary<NSString *,id> *)data retainUntilConsumed:(BOOL)retain {
+  NSArray<CAPPluginCall *> *listenersForEvent = [self.eventListeners objectForKey:eventName];
+  if(listenersForEvent == nil || [listenersForEvent count] == 0) {
+    if (retain == YES) {
+        
+        if ([self.retainedEventArguments objectForKey:eventName] == nil) {
+            [self.retainedEventArguments setObject:[[NSMutableArray alloc] init] forKey:eventName];
+        }
+        
+        [[self.retainedEventArguments objectForKey:eventName] addObject:data];
+    }
+    return;
+  }
+
+  for (int i=0; i < listenersForEvent.count; i++) {
+    CAPPluginCall *call = listenersForEvent[i];
+    if (call != nil) {
+      CAPPluginCallResult *result = [[CAPPluginCallResult alloc] init:data];
+      call.successHandler(result, call);
+    }
+  }
+}
+
+- (void)addListener:(CAPPluginCall *)call {
+  NSString *eventName = [call.options objectForKey:@"eventName"];
+  [call setKeepAlive:TRUE];
+  [self addEventListener:eventName listener:call];
+}
+
+- (void)removeListener:(CAPPluginCall *)call {
+  NSString *eventName = [call.options objectForKey:@"eventName"];
+  NSString *callbackId = [call.options objectForKey:@"callbackId"];
+  CAPPluginCall *storedCall = [self.bridge savedCallWithID:callbackId];
+  [self removeEventListener:eventName listener:storedCall];
+  [self.bridge releaseCallWithID:callbackId];
+}
+
+- (void)removeAllListeners:(CAPPluginCall *)call {
+  [self.eventListeners removeAllObjects];
+  [call resolve];
+}
+
+- (NSArray<CAPPluginCall *>*)getListeners:(NSString *)eventName {
+  NSArray<CAPPluginCall *>* listeners = [self.eventListeners objectForKey:eventName];
+  return listeners;
+}
+
+- (BOOL)hasListeners:(NSString *)eventName {
+  NSArray<CAPPluginCall *>* listeners = [self.eventListeners objectForKey:eventName];
+  
+  if (listeners == nil) {
+    return false;
+  }
+  return [listeners count] > 0;
+}
+
+- (void)checkPermissions:(CAPPluginCall *)call {
+  [call resolve];
+}
+
+- (void)requestPermissions:(CAPPluginCall *)call {
+  [call resolve];
+}
+
+/**
+ * Configure popover sourceRect, sourceView and permittedArrowDirections to show it centered
+ */
+-(void)setCenteredPopover:(UIViewController *) vc {
+  if (self.bridge.viewController != nil) {
+    vc.popoverPresentationController.sourceRect = CGRectMake(self.bridge.viewController.view.center.x, self.bridge.viewController.view.center.y, 0, 0);
+    vc.popoverPresentationController.sourceView = self.bridge.viewController.view;
+    vc.popoverPresentationController.permittedArrowDirections = 0;
+  }
+}
+
+-(void)setCenteredPopover:(UIViewController* _Nonnull) vc size:(CGSize) size {
+    if (self.bridge.viewController != nil) {
+      vc.popoverPresentationController.sourceRect = CGRectMake(self.bridge.viewController.view.center.x, self.bridge.viewController.view.center.y, 0, 0);
+      vc.preferredContentSize = size;
+      vc.popoverPresentationController.sourceView = self.bridge.viewController.view;
+      vc.popoverPresentationController.permittedArrowDirections = 0;
+    }
+}
+
+-(BOOL)supportsPopover {
+    return YES;
+}
+
+- (NSNumber*)shouldOverrideLoad:(WKNavigationAction*)navigationAction {
+    return nil;
+}
+
+- (BOOL)handleWKWebViewURLAuthenticationChallenge:(NSURLAuthenticationChallenge* _Nonnull)challenge completionHandler:(void (^_Nonnull)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential * _Nullable credential))completionHandler {
+    return NO;
+}
+
+
+@end
+

package/Capacitor/Capacitor/CAPPluginCall.h

@@ -0,0 +1,25 @@
+#import <Foundation/Foundation.h>
+
+@class CAPPluginCall;
+@class CAPPluginCallResult;
+@class CAPPluginCallError;
+
+typedef void(^CAPPluginCallSuccessHandler)(CAPPluginCallResult *result, CAPPluginCall* call);
+typedef void(^CAPPluginCallErrorHandler)(CAPPluginCallError *error);
+
+@interface CAPPluginCall : NSObject
+
+@property (nonatomic, assign) BOOL isSaved DEPRECATED_MSG_ATTRIBUTE("Use 'keepAlive' instead.");
+@property (nonatomic, assign) BOOL keepAlive;
+@property (nonatomic, strong) NSString *callbackId;
+@property (nonatomic, strong) NSString *methodName;
+@property (nonatomic, strong) NSDictionary *options;
+@property (nonatomic, copy) CAPPluginCallSuccessHandler successHandler;
+@property (nonatomic, copy) CAPPluginCallErrorHandler errorHandler;
+
+- (instancetype)initWithCallbackId:(NSString *)callbackId options:(NSDictionary *)options success:(CAPPluginCallSuccessHandler)success error:(CAPPluginCallErrorHandler)error DEPRECATED_MSG_ATTRIBUTE("Specify the method name as well.");
+
+- (instancetype)initWithCallbackId:(NSString *)callbackId methodName:(NSString *)methodName options:(NSDictionary *)options success:(CAPPluginCallSuccessHandler)success error:(CAPPluginCallErrorHandler)error;
+
+- (void)save DEPRECATED_MSG_ATTRIBUTE("Use the 'keepAlive' property instead.");
+@end

package/Capacitor/Capacitor/CAPPluginCall.m

@@ -0,0 +1,36 @@
+#import <Foundation/Foundation.h>
+#import "CAPPluginCall.h"
+
+@implementation CAPPluginCall
+
+- (instancetype)initWithCallbackId:(NSString *)callbackId options:(NSDictionary *)options success:(CAPPluginCallSuccessHandler) success error:(CAPPluginCallErrorHandler) error __deprecated {
+  self.callbackId = callbackId;
+  self.methodName = @"";
+  self.options = options;
+  self.successHandler = success;
+  self.errorHandler = error;
+  return self;
+}
+
+- (instancetype)initWithCallbackId:(NSString *)callbackId methodName:(NSString *)methodName options:(NSDictionary *)options success:(CAPPluginCallSuccessHandler) success error:(CAPPluginCallErrorHandler) error {
+  self.callbackId = callbackId;
+  self.methodName = methodName;
+  self.options = options;
+  self.successHandler = success;
+  self.errorHandler = error;
+  return self;
+}
+
+- (BOOL)isSaved {
+    return self.keepAlive;
+}
+
+- (void)setIsSaved:(BOOL)saved {
+    self.keepAlive = saved;
+}
+
+- (void)save {
+  self.keepAlive = true;
+}
+
+@end

package/Capacitor/Capacitor/CAPPluginCall.swift

@@ -0,0 +1,97 @@
+import Foundation
+
+@available(*, deprecated, renamed: "PluginCallResultData")
+public typealias PluginCallErrorData = [String: Any]
+@available(*, deprecated, renamed: "PluginCallResultData")
+public typealias PluginResultData = [String: Any]
+
+/**
+ * Swift niceties for CAPPluginCall
+ */
+
+extension CAPPluginCall: JSValueContainer {
+    public var jsObjectRepresentation: JSObject {
+        return options as? JSObject ?? [:]
+    }
+}
+
+@objc extension CAPPluginCall: BridgedJSValueContainer {
+    public var dictionaryRepresentation: NSDictionary {
+        return options as NSDictionary
+    }
+
+    public static var jsDateFormatter: ISO8601DateFormatter = {
+        return ISO8601DateFormatter()
+    }()
+}
+
+@objc public extension CAPPluginCall {
+    @available(*, deprecated, message: "Presence of a key should not be considered significant. Use typed accessors to check the value instead.")
+    func hasOption(_ key: String) -> Bool {
+        guard let value = options[key] else {
+            return false
+        }
+        return !(value is NSNull)
+    }
+
+    func resolve() {
+        successHandler(CAPPluginCallResult(nil), self)
+    }
+
+    func resolve(_ data: PluginCallResultData = [:]) {
+        successHandler(CAPPluginCallResult(data), self)
+    }
+
+    func reject(_ message: String, _ code: String? = nil, _ error: Error? = nil, _ data: PluginCallResultData? = nil) {
+        errorHandler(CAPPluginCallError(message: message, code: code, error: error, data: data))
+    }
+
+    func unimplemented() {
+        unimplemented("not implemented")
+    }
+
+    func unimplemented(_ message: String) {
+        errorHandler(CAPPluginCallError(message: message, code: "UNIMPLEMENTED", error: nil, data: [:]))
+    }
+
+    func unavailable() {
+        unavailable("not available")
+    }
+
+    func unavailable(_ message: String) {
+        errorHandler(CAPPluginCallError(message: message, code: "UNAVAILABLE", error: nil, data: [:]))
+    }
+}
+
+// MARK: Codable Support
+public extension CAPPluginCall {
+    /// Encodes the given value to a ``JSObject`` and resolves the call. If an error is thrown during encoding, ``reject(_:_:_:_:)`` is called.
+    /// - Parameters:
+    ///   - data: The value to encode
+    ///   - encoder: The encoder to use. Defaults to `JSValueEncoder()`
+    ///   - messageForRejectionFromError: A closure that takes the error thrown from ``JSValueEncoder/encodeJSObject(_:)``
+    ///   and returns a string to be provided to ``reject(_:_:_:_:)``. Defaults to a function that returns "Failed encoding response".
+    func resolve<T: Encodable>(
+        with data: T,
+        encoder: JSValueEncoder = JSValueEncoder(),
+        messageForRejectionFromError: (Error) -> String = { _ in "Failed encoding response" }
+    ) {
+        do {
+            let encoded = try encoder.encodeJSObject(data)
+            resolve(encoded)
+        } catch {
+            let message = messageForRejectionFromError(error)
+            reject(message, nil, error)
+        }
+    }
+
+    /// Decodes the options to the given type.
+    /// - Parameters:
+    ///   - type: The type to decode to.
+    ///   - decoder: The decoder to use. Defaults to `JSValueDecoder()`.
+    /// - Throws: If the options cannot be decoded.
+    /// - Returns: The decoded value.
+    func decode<T: Decodable>(_ type: T.Type, decoder: JSValueDecoder = JSValueDecoder()) throws -> T {
+        try decoder.decode(type, from: options as? JSObject ?? [:])
+    }
+}

package/Capacitor/Capacitor/CAPPluginMethod.h

@@ -0,0 +1,36 @@
+#import "CAPPluginCall.h"
+#import "CAPPlugin.h"
+
+typedef enum {
+  CAPPluginMethodArgumentNotNullable,
+  CAPPluginMethodArgumentNullable
+} CAPPluginMethodArgumentNullability;
+
+typedef NSString CAPPluginReturnType;
+
+/**
+ * Represents a single argument to a plugin method.
+ */
+@interface CAPPluginMethodArgument : NSObject
+
+@property (nonatomic, copy) NSString *name;
+@property (nonatomic, assign) CAPPluginMethodArgumentNullability nullability;
+
+- (instancetype)initWithName:(NSString *)name nullability:(CAPPluginMethodArgumentNullability)nullability type:(NSString *)type;
+
+@end
+
+/**
+ * Represents a method that a plugin supports, with the ability
+ * to compute selectors and invoke the method.
+ */
+@interface CAPPluginMethod : NSObject
+
+@property (nonatomic, assign) SEL selector;
+@property (nonatomic, strong) NSString *name; // Raw method name
+@property (nonatomic, strong) CAPPluginReturnType *returnType; // Return type of method (i.e. callback/promise/sync)
+
+- (instancetype)initWithName:(NSString *)name returnType:(CAPPluginReturnType *)returnType;
+- (instancetype)initWithSelector:(SEL)selector returnType:(CAPPluginReturnType *)returnType;
+
+@end

package/Capacitor/Capacitor/CAPPluginMethod.m

@@ -0,0 +1,44 @@
+#import <Capacitor/Capacitor-Swift.h>
+#import "CAPPluginMethod.h"
+
+typedef void(^CAPCallback)(id _arg, NSInteger index);
+
+@implementation CAPPluginMethodArgument
+
+- (instancetype)initWithName:(NSString *)name nullability:(CAPPluginMethodArgumentNullability)nullability type:(NSString *)type {
+  self.name = name;
+  self.nullability = nullability;
+  return self;
+}
+
+@end
+
+@implementation CAPPluginMethod {
+  // NSInvocation's retainArguments doesn't work with our arguments
+  // so we have to retain args manually
+  NSMutableArray *_manualRetainArgs;
+  // Retain invocation instance
+  NSInvocation *_invocation;
+  NSMutableArray *_methodArgumentCallbacks;
+  CAPPluginCall *_call;
+  SEL _selector;
+}
+
+-(instancetype)initWithName:(NSString *)name returnType:(CAPPluginReturnType *)returnType {
+  self.name = name;
+  self.selector = NSSelectorFromString([name stringByAppendingString:@":"]);
+  self.returnType = returnType;
+  return self;
+}
+
+-(instancetype)initWithSelector:(SEL) selector returnType:(CAPPluginReturnType *)returnType {
+    // need to drop the : from the selector string
+    NSString* rawSelString = NSStringFromSelector(selector);
+    self.name = [rawSelString substringToIndex:[rawSelString length] - 1];
+    self.selector = selector;
+    self.returnType = returnType;
+    return self;
+}
+
+@end
+

package/Capacitor/Capacitor/CAPPluginMethod.swift

@@ -0,0 +1,17 @@
+//
+//  CAPPluginMethod.swift
+//  Capacitor
+//
+//  Created by Steven Sherry on 4/18/24.
+//  Copyright © 2024 Drifty Co. All rights reserved.
+//
+
+extension CAPPluginMethod {
+    public enum ReturnType: String {
+        case promise, callback, none
+    }
+
+    public convenience init(_ selector: Selector, returnType: ReturnType = .promise) {
+        self.init(selector: selector, returnType: returnType.rawValue)
+    }
+}

package/Capacitor/Capacitor/Capacitor.h

@@ -0,0 +1,15 @@
+#import <UIKit/UIKit.h>
+
+//! Project version number for bridge.
+FOUNDATION_EXPORT double CapacitorVersionNumber;
+
+//! Project version string for bridge.
+FOUNDATION_EXPORT const unsigned char CapacitorVersionString[];
+
+#import <Capacitor/CAPPlugin.h>
+#import <Capacitor/CAPPluginCall.h>
+#import <Capacitor/CAPBridgedPlugin.h>
+#import <Capacitor/CAPPluginMethod.h>
+#import <Capacitor/CAPInstanceDescriptor.h>
+#import <Capacitor/CAPInstanceConfiguration.h>
+

package/Capacitor/Capacitor/Capacitor.modulemap

@@ -0,0 +1,8 @@
+framework module Capacitor {
+  umbrella header "Capacitor.h"
+  exclude header "CAPBridgedJSTypes.h"
+  exclude header "CAPBridgeViewController+CDVScreenOrientationDelegate.h"
+
+  export *
+  module * { export * }
+}