@capacitor/ios 4.0.0-nightly-c3aa3d6c.0 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,44 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.0.0](https://github.com/ionic-team/capacitor/compare/4.0.0-beta.2...4.0.0) (2022-07-27)
+
+
+### Bug Fixes
+
+* **ios:** error data is optional ([#5782](https://github.com/ionic-team/capacitor/issues/5782)) ([da48d79](https://github.com/ionic-team/capacitor/commit/da48d798c3463de9de188ae6a6475fd6afba6091))
+
+
+### Features
+
+* **android:** Add Optional Data Param for Error Object ([#5719](https://github.com/ionic-team/capacitor/issues/5719)) ([174172b](https://github.com/ionic-team/capacitor/commit/174172b6c64dc9117c48ed0e20c25e0b6c2fb625))
+* **android:** Use addWebMessageListener where available ([#5427](https://github.com/ionic-team/capacitor/issues/5427)) ([c2dfe80](https://github.com/ionic-team/capacitor/commit/c2dfe808446717412b35e82713d123b7a052f264))
+* **ios:** Add overrideable router var for CAPWebView. ([#5743](https://github.com/ionic-team/capacitor/issues/5743)) ([c1de1c0](https://github.com/ionic-team/capacitor/commit/c1de1c0138aad188a760118e35983d10d257f8e7))
+* **iOS:** post install script for deployment target ([#5783](https://github.com/ionic-team/capacitor/issues/5783)) ([f5afa94](https://github.com/ionic-team/capacitor/commit/f5afa94b3b9c246d87b2af03359840f503bace90))
+* Add option for custom error page ([#5723](https://github.com/ionic-team/capacitor/issues/5723)) ([e8bdef3](https://github.com/ionic-team/capacitor/commit/e8bdef3b4634e4ad45fa8fc34c7c0ab8dfa383f3))
+
+
+
+
+
+# [4.0.0-beta.2](https://github.com/ionic-team/capacitor/compare/4.0.0-beta.1...4.0.0-beta.2) (2022-07-08)
+
+
+### Bug Fixes
+
+* **ios:** Add check for both serverURL and localURL in navigation ([#5736](https://github.com/ionic-team/capacitor/issues/5736)) ([8e824f3](https://github.com/ionic-team/capacitor/commit/8e824f33ad4df898fb8c0936a8f5e9041832a5c5))
+* **ios:** properly deliver retained events after listener re-add [#5732](https://github.com/ionic-team/capacitor/issues/5732) ([c5d6328](https://github.com/ionic-team/capacitor/commit/c5d632831924a1bcc868bc46b42f7ff619408752))
+
+
+### Features
+
+* **ios:** Add `setServerBasePath(path:)` to CAPWebView ([#5742](https://github.com/ionic-team/capacitor/issues/5742)) ([1afbf8a](https://github.com/ionic-team/capacitor/commit/1afbf8a9dd0b8f7b1ac439d24e5d8ba26f786318))
+* Add CapWebView  ([#5715](https://github.com/ionic-team/capacitor/issues/5715)) ([143d266](https://github.com/ionic-team/capacitor/commit/143d266ef0a818bac59dbbdaeda3b5c382ebfa1d))
+
+
+
+
+
 # [4.0.0-beta.1](https://github.com/ionic-team/capacitor/compare/4.0.0-beta.0...4.0.0-beta.1) (2022-06-27)
 
 

package/Capacitor/Capacitor/CAPInstanceConfiguration.h

@@ -13,6 +13,7 @@ NS_SWIFT_NAME(InstanceConfiguration)
 @property (nonatomic, readonly, nonnull) NSArray<NSString*> *allowedNavigationHostnames;
 @property (nonatomic, readonly, nonnull) NSURL *localURL;
 @property (nonatomic, readonly, nonnull) NSURL *serverURL;
+@property (nonatomic, readonly, nullable) NSString *errorPath;
 @property (nonatomic, readonly, nonnull) NSDictionary *pluginConfigurations;
 @property (nonatomic, readonly) BOOL loggingEnabled;
 @property (nonatomic, readonly) BOOL scrollingEnabled;

package/Capacitor/Capacitor/CAPInstanceConfiguration.m

@@ -46,6 +46,7 @@
         else {
             _serverURL = _localURL;
         }
+        _errorPath = descriptor.errorPath;
         // extract the one value we care about from the cordova configuration
         _cordovaDeployDisabled = [descriptor cordovaDeployDisabled];
     }
@@ -60,6 +61,7 @@
         _allowedNavigationHostnames = [[configuration allowedNavigationHostnames] copy];
         _localURL = [[configuration localURL] copy];
         _serverURL = [[configuration serverURL] copy];
+        _errorPath = [[configuration errorPath] copy];
         _pluginConfigurations = [[configuration pluginConfigurations] copy];
         _loggingEnabled = configuration.loggingEnabled;
         _scrollingEnabled = configuration.scrollingEnabled;

package/Capacitor/Capacitor/CAPInstanceConfiguration.swift

@@ -15,6 +15,14 @@ extension InstanceConfiguration {
         return serverURL
     }
 
+    @objc var errorPathURL: URL? {
+        guard let errorPath = errorPath else {
+            return nil
+        }
+
+        return localURL.appendingPathComponent(errorPath)
+    }
+
     @available(*, deprecated, message: "Use getPluginConfig")
     @objc public func getPluginConfigValue(_ pluginId: String, _ configKey: String) -> Any? {
         return (pluginConfigurations as? JSObject)?[keyPath: KeyPath("\(pluginId).\(configKey)")]

package/Capacitor/Capacitor/CAPInstanceDescriptor.h

@@ -53,6 +53,11 @@ NS_SWIFT_NAME(InstanceDescriptor)
  @discussion Defaults to @c capacitor. Set by @c server.iosScheme in the configuration file.
  */
 @property (nonatomic, copy, nullable) NSString *urlScheme;
+/**
+ @brief The path to a local html page to display in case of errors.
+ @discussion Defaults to nil.
+ */
+@property (nonatomic, copy, nullable) NSString *errorPath;
 /**
  @brief The hostname that will be used for the server URL.
  @discussion Defaults to @c localhost. Set by @c server.hostname in the configuration file.

package/Capacitor/Capacitor/CAPInstanceDescriptor.swift

@@ -96,6 +96,9 @@ internal extension InstanceDescriptor {
             if let urlString = config[keyPath: "server.url"] as? String {
                 serverURL = urlString
             }
+            if let errorPathString = (config[keyPath: "server.errorPath"] as? String) {
+                errorPath = errorPathString
+            }
             if let insetBehavior = config[keyPath: "ios.contentInset"] as? String {
                 let availableInsets: [String: UIScrollView.ContentInsetAdjustmentBehavior] = ["automatic": .automatic,
                                                                                               "scrollableAxes": .scrollableAxes,

package/Capacitor/Capacitor/CAPPlugin.m

@@ -41,7 +41,7 @@
 
 - (void)addEventListener:(NSString *)eventName listener:(CAPPluginCall *)listener {
   NSMutableArray *listenersForEvent = [self.eventListeners objectForKey:eventName];
-  if(!listenersForEvent) {
+  if(listenersForEvent == nil || [listenersForEvent count] == 0) {
     listenersForEvent = [[NSMutableArray alloc] initWithObjects:listener, nil];
     [self.eventListeners setValue:listenersForEvent forKey:eventName];
     

package/Capacitor/Capacitor/CAPPluginCall.swift

@@ -57,7 +57,7 @@ extension CAPPluginCall: JSValueContainer {
         errorHandler(CAPPluginCallError(message: message, code: nil, error: error, data: data))
     }
 
-    func reject(_ message: String, _ code: String? = nil, _ error: Error? = nil, _ data: PluginCallResultData = [:]) {
+    func reject(_ message: String, _ code: String? = nil, _ error: Error? = nil, _ data: PluginCallResultData? = nil) {
         errorHandler(CAPPluginCallError(message: message, code: code, error: error, data: data))
     }
 

package/Capacitor/Capacitor/CAPWebView.swift

@@ -0,0 +1,242 @@
+import Foundation
+import WebKit
+import UIKit
+
+open class CAPWebView: UIView {
+    lazy var webView: WKWebView = createWebView(
+        with: configuration,
+        assetHandler: assetHandler,
+        delegationHandler: delegationHandler
+    )
+
+    private lazy var capacitorBridge = CapacitorBridge(
+        with: configuration,
+        delegate: self,
+        cordovaConfiguration: configDescriptor.cordovaConfiguration,
+        assetHandler: assetHandler,
+        delegationHandler: delegationHandler
+    )
+
+    public final var bridge: CAPBridgeProtocol {
+        return capacitorBridge
+    }
+
+    private lazy var configDescriptor = instanceDescriptor()
+    private lazy var configuration = InstanceConfiguration(with: configDescriptor, isDebug: CapacitorBridge.isDevEnvironment)
+
+    private lazy var assetHandler: WebViewAssetHandler = {
+        let handler = WebViewAssetHandler(router: router)
+        handler.setAssetPath(configuration.appLocation.path)
+        return handler
+    }()
+
+    private lazy var delegationHandler = WebViewDelegationHandler()
+
+    open var router: Router { _Router() }
+
+    public required init?(coder: NSCoder) {
+        super.init(coder: coder)
+        setup()
+    }
+
+    public init() {
+        super.init(frame: .zero)
+        setup()
+    }
+
+    private func setup() {
+        CAPLog.enableLogging = configuration.loggingEnabled
+        logWarnings(for: configDescriptor)
+
+        if configDescriptor.instanceType == .fixed { updateBinaryVersion() }
+
+        addSubview(webView)
+        webView.translatesAutoresizingMaskIntoConstraints = false
+        NSLayoutConstraint.activate([
+            webView.topAnchor.constraint(equalTo: topAnchor),
+            webView.bottomAnchor.constraint(equalTo: bottomAnchor),
+            webView.leadingAnchor.constraint(equalTo: leadingAnchor),
+            webView.trailingAnchor.constraint(equalTo: trailingAnchor)
+        ])
+
+        guard FileManager.default.fileExists(atPath: bridge.config.appStartFileURL.path) else { fatalLoadError() }
+        capacitorDidLoad()
+
+        let url = bridge.config.appStartServerURL
+        CAPLog.print("⚡️  Loading app at \(url.absoluteString)")
+        capacitorBridge.webViewDelegationHandler.willLoadWebview(webView)
+        _ = webView.load(URLRequest(url: url))
+    }
+
+    public lazy final var isNewBinary: Bool = {
+        if let curVersionCode = Bundle.main.infoDictionary?["CFBundleVersion"] as? String,
+           let curVersionName = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String {
+            if let lastVersionCode = UserDefaults.standard.string(forKey: "lastBinaryVersionCode"),
+               let lastVersionName = UserDefaults.standard.string(forKey: "lastBinaryVersionName") {
+                return (curVersionCode.isEqual(lastVersionCode) == false || curVersionName.isEqual(lastVersionName) == false)
+            }
+        }
+        return false
+    }()
+
+    open func instanceDescriptor() -> InstanceDescriptor {
+        let descriptor = InstanceDescriptor.init()
+        if !isNewBinary && !descriptor.cordovaDeployDisabled {
+            if let persistedPath = UserDefaults.standard.string(forKey: "serverBasePath"), !persistedPath.isEmpty {
+                if let libPath = NSSearchPathForDirectoriesInDomains(.libraryDirectory, .userDomainMask, true).first {
+                    descriptor.appLocation = URL(fileURLWithPath: libPath, isDirectory: true)
+                        .appendingPathComponent("NoCloud")
+                        .appendingPathComponent("ionic_built_snapshots")
+                        .appendingPathComponent(URL(fileURLWithPath: persistedPath, isDirectory: true).lastPathComponent)
+                }
+            }
+        }
+        return descriptor
+    }
+
+    /**
+     Allows any additional configuration to be performed. The `webView` and `bridge` properties will be set by this point.
+
+     - Note: This is called before the webview has been added to the view hierarchy. Not all operations may be possible at
+     this time.
+     */
+    open func capacitorDidLoad() {
+    }
+
+    open func loadInitialContext(_ userContentController: WKUserContentController) {
+        CAPLog.print("in loadInitialContext base")
+    }
+
+    public func setServerBasePath(path: String) {
+        let url = URL(fileURLWithPath: path, isDirectory: true)
+        guard FileManager.default.fileExists(atPath: url.path) else { return }
+
+        capacitorBridge.config = capacitorBridge.config.updatingAppLocation(url)
+        capacitorBridge.webViewAssetHandler.setAssetPath(url.path)
+
+        DispatchQueue.main.async { [weak self] in
+            guard let self = self else { return }
+            _ = self.webView.load(URLRequest(url: self.capacitorBridge.config.serverURL))
+        }
+    }
+}
+
+extension CAPWebView {
+
+    open func webViewConfiguration(for instanceConfiguration: InstanceConfiguration) -> WKWebViewConfiguration {
+        let webViewConfiguration = WKWebViewConfiguration()
+        webViewConfiguration.allowsInlineMediaPlayback = true
+        webViewConfiguration.suppressesIncrementalRendering = false
+        webViewConfiguration.allowsAirPlayForMediaPlayback = true
+        webViewConfiguration.mediaTypesRequiringUserActionForPlayback = []
+        if let appendUserAgent = instanceConfiguration.appendedUserAgentString {
+            if let appName = webViewConfiguration.applicationNameForUserAgent {
+                webViewConfiguration.applicationNameForUserAgent = "\(appName)  \(appendUserAgent)"
+            } else {
+                webViewConfiguration.applicationNameForUserAgent = appendUserAgent
+            }
+        }
+        return webViewConfiguration
+    }
+
+    private func createWebView(with configuration: InstanceConfiguration, assetHandler: WebViewAssetHandler, delegationHandler: WebViewDelegationHandler) -> WKWebView {
+        // set the cookie policy
+        HTTPCookieStorage.shared.cookieAcceptPolicy = HTTPCookie.AcceptPolicy.always
+        // setup the web view configuration
+        let webViewConfig = webViewConfiguration(for: configuration)
+        webViewConfig.setURLSchemeHandler(assetHandler, forURLScheme: configuration.localURL.scheme ?? InstanceDescriptorDefaults.scheme)
+        webViewConfig.userContentController = delegationHandler.contentController
+        // create the web view and set its properties
+        loadInitialContext(webViewConfig.userContentController)
+        let webView = WKWebView(frame: .zero, configuration: webViewConfig)
+        webView.scrollView.bounces = false
+        webView.scrollView.contentInsetAdjustmentBehavior = configuration.contentInsetAdjustmentBehavior
+        webView.allowsLinkPreview = configuration.allowLinkPreviews
+        webView.configuration.preferences.setValue(true, forKey: "allowFileAccessFromFileURLs")
+        webView.scrollView.isScrollEnabled = configuration.scrollingEnabled
+
+        if let overrideUserAgent = configuration.overridenUserAgentString {
+            webView.customUserAgent = overrideUserAgent
+        }
+
+        if let backgroundColor = configuration.backgroundColor {
+            self.backgroundColor = backgroundColor
+            webView.backgroundColor = backgroundColor
+            webView.scrollView.backgroundColor = backgroundColor
+        } else {
+            // Use the system background colors if background is not set by user
+            self.backgroundColor = UIColor.systemBackground
+            webView.backgroundColor = UIColor.systemBackground
+            webView.scrollView.backgroundColor = UIColor.systemBackground
+        }
+
+        // set our delegates
+        webView.uiDelegate = delegationHandler
+        webView.navigationDelegate = delegationHandler
+        return webView
+    }
+
+    private func logWarnings(for descriptor: InstanceDescriptor) {
+        if descriptor.warnings.contains(.missingAppDir) {
+            CAPLog.print("⚡️  ERROR: Unable to find application directory at: \"\(descriptor.appLocation.absoluteString)\"!")
+        }
+        if descriptor.instanceType == .fixed {
+            if descriptor.warnings.contains(.missingFile) {
+                CAPLog.print("Unable to find capacitor.config.json, make sure it exists and run npx cap copy.")
+            }
+            if descriptor.warnings.contains(.invalidFile) {
+                CAPLog.print("Unable to parse capacitor.config.json. Make sure it's valid JSON.")
+            }
+            if descriptor.warnings.contains(.missingCordovaFile) {
+                CAPLog.print("Unable to find config.xml, make sure it exists and run npx cap copy.")
+            }
+            if descriptor.warnings.contains(.invalidCordovaFile) {
+                CAPLog.print("Unable to parse config.xml. Make sure it's valid XML.")
+            }
+        }
+    }
+
+    private func updateBinaryVersion() {
+        guard isNewBinary else {
+            return
+        }
+        guard let versionCode = Bundle.main.infoDictionary?["CFBundleVersion"] as? String,
+              let versionName = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String else {
+            return
+        }
+        let prefs = UserDefaults.standard
+        prefs.set(versionCode, forKey: "lastBinaryVersionCode")
+        prefs.set(versionName, forKey: "lastBinaryVersionName")
+        prefs.set("", forKey: "serverBasePath")
+        prefs.synchronize()
+    }
+
+    private func fatalLoadError() -> Never {
+        printLoadError()
+        exit(1)
+    }
+
+    private func printLoadError() {
+        let fullStartPath = capacitorBridge.config.appStartFileURL.path
+
+        CAPLog.print("⚡️  ERROR: Unable to load \(fullStartPath)")
+        CAPLog.print("⚡️  This file is the root of your web app and must exist before")
+        CAPLog.print("⚡️  Capacitor can run. Ensure you've run capacitor copy at least")
+        CAPLog.print("⚡️  or, if embedding, that this directory exists as a resource directory.")
+    }
+}
+
+extension CAPWebView: CAPBridgeDelegate {
+    internal var bridgedWebView: WKWebView? {
+        return webView
+    }
+
+    internal var bridgedViewController: UIViewController? {
+        // search for the parent view controller
+        var object = self.next
+        while !(object is UIViewController) && object != nil {
+            object = object?.next
+        }
+        return object as? UIViewController
+    }
+}

package/Capacitor/Capacitor/JSTypes.swift

@@ -125,6 +125,15 @@ public protocol JSValueContainer: JSStringContainer, JSBoolContainer, JSIntConta
 }
 
 extension JSValueContainer {
+    public func getValue(_ key: String) -> JSValue? {
+        return jsObjectRepresentation[key]
+    }
+
+    @available(*, message: "All values returned conform to JSValue, use getValue(_:) instead.", renamed: "getValue(_:)")
+    public func getAny(_ key: String) -> Any? {
+        return getValue(key)
+    }
+
     public func getString(_ key: String) -> String? {
         return jsObjectRepresentation[key] as? String
     }

package/Capacitor/Capacitor/PluginCallResult.swift

@@ -98,7 +98,7 @@ public enum PluginCallResult {
         self.code = code
         self.error = error
         if let data = data {
-            resultData = .dictionary(data)
+            resultData = .dictionary(["data": data])
         } else {
             resultData = nil
         }

package/Capacitor/Capacitor/WebViewDelegationHandler.swift

@@ -102,7 +102,12 @@ internal class WebViewDelegationHandler: NSObject, WKNavigationDelegate, WKUIDel
 
         // otherwise, is this a new window or a main frame navigation but to an outside source
         let toplevelNavigation = (navigationAction.targetFrame == nil || navigationAction.targetFrame?.isMainFrame == true)
-        if navURL.absoluteString.contains(bridge.config.serverURL.absoluteString) == false, toplevelNavigation {
+
+        // Check if the url being navigated to is configured as an application url (whether local or remote)
+        let isApplicationNavigation = navURL.absoluteString.starts(with: bridge.config.serverURL.absoluteString) ||
+            navURL.absoluteString.starts(with: bridge.config.localURL.absoluteString)
+
+        if !isApplicationNavigation, toplevelNavigation {
             // disallow and let the system handle it
             if UIApplication.shared.applicationState == .active {
                 UIApplication.shared.open(navURL, options: [:], completionHandler: nil)
@@ -132,6 +137,11 @@ internal class WebViewDelegationHandler: NSObject, WKNavigationDelegate, WKUIDel
             webView.isOpaque = isOpaque
             webViewLoadingState = .subsequentLoad
         }
+
+        if let errorURL = bridge?.config.errorPathURL {
+            webView.load(URLRequest(url: errorURL))
+        }
+
         CAPLog.print("⚡️  WebView failed to load")
         CAPLog.print("⚡️  Error: " + error.localizedDescription)
     }
@@ -139,6 +149,10 @@ internal class WebViewDelegationHandler: NSObject, WKNavigationDelegate, WKUIDel
     // The force unwrap is part of the protocol declaration, so we should keep it.
     // swiftlint:disable:next implicitly_unwrapped_optional
     public func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError error: Error) {
+        if let errorURL = bridge?.config.errorPathURL {
+            webView.load(URLRequest(url: errorURL))
+        }
+
         CAPLog.print("⚡️  WebView failed provisional navigation")
         CAPLog.print("⚡️  Error: " + error.localizedDescription)
     }

package/Capacitor/Capacitor/assets/native-bridge.js

@@ -384,10 +384,18 @@ const nativeBridge = (function (exports) {
                 }
                 return null;
             };
+            if (win === null || win === void 0 ? void 0 : win.androidBridge) {
+                win.androidBridge.onmessage = function (event) {
+                    returnResult(JSON.parse(event.data));
+                };
+            }
             /**
              * Process a response from the native layer.
              */
             cap.fromNative = result => {
+                returnResult(result);
+            };
+            const returnResult = (result) => {
                 var _a, _b;
                 if (cap.isLoggingEnabled && result.pluginId !== 'Console') {
                     cap.logFromNative(result);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/ios",
-  "version": "4.0.0-nightly-c3aa3d6c.0",
+  "version": "4.0.0",
   "description": "Capacitor: Cross-platform apps with JavaScript and the web",
   "homepage": "https://capacitorjs.com",
   "author": "Ionic Team <hi@ionic.io> (https://ionic.io)",
@@ -24,10 +24,10 @@
     "xc:build:CapacitorCordova": "cd CapacitorCordova && xcodebuild && cd .."
   },
   "peerDependencies": {
-    "@capacitor/core": "^4.0.0-beta.1"
+    "@capacitor/core": "next"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c3aa3d6cbc6dc17d4c580038047ed3a4d8e168a2"
+  "gitHead": "434b1a0ff32f513973ef35258032a4df0cb331c1"
 }