engineerapart-branch-cordova-sdk - npm Package Compare versions

Comparing version 4.0.9 to 4.1.1

package.json

@@ -5,3 +5,3 @@ {
   "main": "src/index.js",
-  "version": "4.0.9",
+  "version": "4.1.1",
   "homepage": "https://github.com/BranchMetrics/cordova-ionic-phonegap-branch-deep-linking",
@@ -23,3 +23,3 @@ "repository": {
       "name": "cordova",
-      "version": ">=9.0.0"
+      "version": ">=8.0.0"
     }
@@ -26,0 +26,0 @@ ],

README.md

@@ -58,2 +58,4 @@ <h1 align="center">
   * [Compiling: Errors](#compiling-errors)
+  * [Compiling: Capacitor](#compiling-capacitor)
+  * [AppStore: iOS](#appstore-ios)
 
@@ -731,3 +733,2 @@ ## Getting Started
       <ios-team-debug value="FG35JLLMXX" /> <!-- optional -->
-      <android-prefix value="/WSuf" /> <!-- optional (for bnc.lt link domains) -->
       <android-testmode value="true" /> <!-- optional (simulate installs) -->
@@ -1353,1 +1354,59 @@ </branch-config>
     * Add `<preference name="android-minSdkVersion" value="16" />` to your `config.xml`
+
+  * error
+
+    ```sh
+    Branch.h not found
+    ```
+    If that is the ONLY error you see, this can be fixed by upgrading dependencies.
+    Ensure you are using version 4.0.1 of this plugin or higher and have updated your Xcode, Cordova, and other dependencies (listed below) to the latest versions. This error arose due to an inability in CocoaPods and cordova-ios to resolve dependencies that was later fixed.
+
+    Sometimes this error occurs when a build error occurs in the Pod project; since Branch is usually the first pod alphabetically, it'll show up as the error when attempting to build the main project (since the Pod didn't get built), even though the real error is elsewhere. Make sure to read your build log to find the original error that prevented building the Pod project.
+
+  * error: ios build fails with Pods and CONFIGURATION_BUILD_DIR configured
+
+    Command-line builds result in the above error. Please see the section below [Compiling: Capacitor](#compiling-capacitor) for the full list of up-to-date dependencies needed for CLI builds to work.
+
+* #### Compiling: Capacitor
+
+  * ##### Version 4.0.1 of this plugin works with Ionic 4 + Cordova and Ionic 4 + Capacitor, with the following caveats:
+
+    * We strongly recommend Node >= 10.15. Node 8 might work, but it is not tested.
+    * For BOTH Cordova and Capacitor, you must use Xcode >= 11.1, CocoaPods >= 1.8.4, Cordova >= 9.0.0, Ionic-CLI >= 5.1, cordova-ios >= 5.1.0
+      * Every single one of these dependencies has fixes that allow the command line build, and the pod dependency resolution to work correctly
+    * You MUST use @capacitor/ios >= 1.4.0. Versions prior to that version did not federate the OpenURL notifications to other plugins, including Branch.
+    * `use_frameworks` has been removed from this plugin and will now be statically built. If the other podfile uses `use_frameworks` that is fine but this plugin no longer flags itself as dynamic.
+    * When using Capacitor, you must add the following entries yourself to `ios/App/App/Info.plist`:
+      ```sh
+        <key>CFBundleURLTypes</key>
+        <array>
+          <dict>
+            <key>CFBundleURLName</key>
+            <string>com.getcapacitor.capacitor</string>
+            <key>CFBundleURLSchemes</key>
+            <array>
+              <string>capacitor</string>
+            </array>
+          </dict>
+          <dict>
+            <key>CFBundleURLName</key>
+            <string>branch-cordova-sdk</string>
+            <key>CFBundleURLSchemes</key>
+            <array>
+              <string>[YOUR URL SCHEME HERE]</string>
+            </array>
+          </dict>
+        </array>
+        <key>branch_key</key>
+        <string>[YOUR BRANCH LIVE KEY]</string>
+        <key>branch_app_domain</key>
+        <string>[YOUR DOMAIN].app.link</string>
+      ```
+    * When using Capacitor, you must add your Associated Domains entitlements via the Xcode entitlement editor yourself
+      * This MUST be done using Xcode - this is part of Capacitor's philosophy whereby you are in control of every config file change
+      * Open the "Signing & Entitlements" tab in Xcode, add the Associated Domains entitlement, and add the urls found on your Branch dashboard.
+
+* #### AppStore: iOS
+
+  * #### App rejected because it uses push notification features but does not declare the aps-environment key
+    When branch-cordova-sdk moved to use CocoaPods, a change was introduced in Cordova 9 where the separate entitlement files were no longer flattened together. This issue has been fixed in version 4.0.1 of this plugin.

No alert changes

Improved metrics

Total package byte prevSize

552600

increased by0.83%

Lines of code

3542

increased by0.34%

Number of lines in readme file

1410

increased by4.37%

No dependency changes