@thathoff/cordova-plugin-universal-links 0.3.7 → 0.4.0-alpha.0

package/README.md

@@ -1,14 +1,12 @@
 # Cordova Universal Links Plugin
+
 This Cordova plugin adds support for opening an application from the browser when user clicks on the link. Better known as:
 - [Universal Links on iOS](https://developer.apple.com/library/ios/documentation/General/Conceptual/AppSearch/UniversalLinks.html)
 - [Deep Linking on Android](https://developer.android.com/training/app-indexing/deep-linking.html)
 
 ## This Project Is a Fork
 
-This repo is a fork of the deprecated 'nordnet/cordova-universal-links-plugin' cordova plugin. This fork adds un-merged pull requests from the original and un-maintained project.
-
-Original repo with pull requests, forks and issues:
-https://github.com/nordnet/cordova-universal-links-plugin
+This repo is a fork of the deprecated 'nordnet/cordova-universal-links-plugin' and `eldadfux/cordova-plugin-universal-links` cordova plugin. This fork adds support for Cordova 8 and adds some unmerged merge requests and removed some unnecessary dependencies.
 
 ## Getting Started
 
@@ -28,43 +26,58 @@ It is important not only to redirect users to your app from the web, but also pr
 **Note:** At the moment the plugin doesn't support custom url schemes, but they can be added later.
 
 ## Supported Platforms
+
 - Android 4.0.0 or above.
 - iOS 9.0 or above. Xcode 7 is required. To build plugin with Xcode 6 - [read the instructions](#how-to-build-plugin-in-xcode-6) below.
 
 **iOS Note:** you can use this plugin in iOS 8 applications. It will not crash the app, but it also is not gonna handle the links, because this is iOS 9 feature.
 
 ## Documentation
-- [Installation](#installation)
-- [Migrating from previous versions](#migrating-from-previous-versions)
-- [How to build plugin in Xcode 6](#how-to-build-plugin-in-xcode-6)
-- [Cordova config preferences](#cordova-config-preferences)
-- [Application launch handling](#application-launch-handling)
-- [Android web integration](#android-web-integration)
-  - [Modify web pages](#modify-web-pages)
-  - [Verify your website on Webmaster Tools](#verify-your-website-on-webmaster-tools)
-  - [Connect your app in the Google Play console](#connect-your-app-in-the-google-play-console)
-  - [Digital Asset Links support](#digital-asset-links-support)
-- [Testing UL for Android locally](#testing-ul-for-android-locally)
-- [iOS web integration](#ios-web-integration)
-  - [Activate UL support in member center](#activate-ul-support-in-member-center)
-  - [Configure apple-app-site-association file for website](#configure-apple-app-site-association-file-for-website)
-- [Testing iOS application](#testing-ios-application)
-- [Useful notes on Universal Links for iOS](#useful-notes-on-universal-links-for-ios)
-  - [They don't work everywhere](#they-dont-work-everywhere)
-  - [How links handled in Safari](#how-links-handled-in-safari)
-- [Additional documentation links](#additional-documentation-links)
+
+- [Cordova Universal Links Plugin](#cordova-universal-links-plugin)
+  - [This Project Is a Fork](#this-project-is-a-fork)
+  - [Getting Started](#getting-started)
+  - [Supported Platforms](#supported-platforms)
+  - [Documentation](#documentation)
+    - [Installation](#installation)
+    - [Migrating from previous versions](#migrating-from-previous-versions)
+        - [From v1.0.x to v1.1.x](#from-v10x-to-v11x)
+    - [How to build plugin in Xcode 6](#how-to-build-plugin-in-xcode-6)
+    - [Cordova config preferences](#cordova-config-preferences)
+      - [host](#host)
+      - [path](#path)
+      - [ios-team-id](#ios-team-id)
+      - [Prevent Android from creating multiple app instances](#prevent-android-from-creating-multiple-app-instances)
+    - [Application launch handling](#application-launch-handling)
+    - [Android web integration](#android-web-integration)
+      - [Modify web pages](#modify-web-pages)
+      - [Verify your website on Webmaster Tools](#verify-your-website-on-webmaster-tools)
+      - [Connect your app in the Google Play console](#connect-your-app-in-the-google-play-console)
+      - [Digital Asset Links support](#digital-asset-links-support)
+    - [Testing UL for Android locally](#testing-ul-for-android-locally)
+    - [iOS web integration](#ios-web-integration)
+      - [Activate UL support in member center](#activate-ul-support-in-member-center)
+      - [Configure apple-app-site-association file for website](#configure-apple-app-site-association-file-for-website)
+        - [Step 1](#step-1)
+        - [Step 2](#step-2)
+        - [Step 3](#step-3)
+    - [Testing iOS application](#testing-ios-application)
+    - [Useful notes on Universal Links for iOS](#useful-notes-on-universal-links-for-ios)
+      - [They don't work everywhere](#they-dont-work-everywhere)
+      - [How links handled in Safari](#how-links-handled-in-safari)
+    - [Additional documentation links](#additional-documentation-links)
 
 ### Installation
 This requires cordova 5.0+ (current stable 1.2.1)
 
 ```sh
-cordova plugin add cordova-universal-links-plugin
+cordova plugin add @thathoff/cordova-plugin-universal-links
 ```
 
 It is also possible to install via repo url directly (**unstable**)
 
 ```sh
-cordova plugin add https://github.com/nordnet/cordova-universal-links-plugin.git
+cordova plugin add https://github.com/thathoff/cordova-plugin-universal-links.git
 ```
 
 ### Migrating from previous versions

package/hooks/lib/android/webSiteHook.js

@@ -9,7 +9,6 @@ https://developer.android.com/training/app-indexing/enabling-app-indexing.html
 
 var fs = require('fs');
 var path = require('path');
-var mkpath = require('mkpath');
 var ConfigXmlHelper = require('../configXmlHelper.js');
 var WEB_HOOK_FILE_PATH = path.join('ul_web_hooks', 'android', 'android_web_hook.html');
 var WEB_HOOK_TPL_FILE_PATH = path.join('plugins', 'cordova-plugin-universal-links', 'ul_web_hooks', 'android_web_hook_tpl.html');
@@ -153,7 +152,7 @@ function saveWebHook(projectRoot, hookContent) {
  */
 function createDirectoryIfNeeded(dir) {
   try {
-    mkpath.sync(dir);
+    fs.mkdirSync(dir, { recursive: true });
   } catch (err) {
     console.log(err);
   }

package/hooks/lib/ios/appleAppSiteAssociationFile.js

@@ -18,7 +18,6 @@ Additional documentation regarding apple-app-site-association file can be found
 
 
 var path = require('path');
-var mkpath = require('mkpath');
 var fs = require('fs');
 var ConfigXmlHelper = require('../configXmlHelper.js');
 var IOS_TEAM_ID = '<YOUR_TEAM_ID_FROM_MEMBER_CENTER>';
@@ -127,7 +126,7 @@ function saveContentToFile(filePrefix, content) {
  */
 function createDirectoriesIfNeeded(dirPath) {
   try {
-    mkpath.sync(dirPath);
+    fs.mkdirSync(dirPath, { recursive: true });
   } catch (err) {
     console.log(err);
   }

package/hooks/lib/ios/projectEntitlements.js

@@ -9,7 +9,6 @@ Script only generates content. File it self is included in the xcode project in
 var path = require('path');
 var fs = require('fs');
 var plist = require('plist');
-var mkpath = require('mkpath');
 var ConfigXmlHelper = require('../configXmlHelper.js');
 var ASSOCIATED_DOMAINS = 'com.apple.developer.associated-domains';
 var context;
@@ -54,7 +53,7 @@ function saveContentToEntitlementsFile(content, buildType) {
   var filePath = pathToEntitlementsFile();
 
   // ensure that file exists
-  mkpath.sync(path.dirname(filePath));
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
 
   // save it's content
   fs.writeFileSync(filePath, plistContent, 'utf8');
@@ -62,7 +61,7 @@ function saveContentToEntitlementsFile(content, buildType) {
   // cordova-ios 8+ uses App/ as the project source dir, so also write there
   var appResourcesPath = path.join(getProjectRoot(), 'platforms', 'ios', 'App', 'Resources', getProjectName() + '.entitlements');
   if (appResourcesPath !== filePath) {
-    mkpath.sync(path.dirname(appResourcesPath));
+    fs.mkdirSync(path.dirname(appResourcesPath), { recursive: true });
     fs.writeFileSync(appResourcesPath, plistContent, 'utf8');
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thathoff/cordova-plugin-universal-links",
-  "version": "0.3.7",
+  "version": "0.4.0-alpha.0",
   "description": "Cordova plugin to add in your application support for Universal Links (iOS 9) and Deep Links (Android). Basically, open application through the link in the browser.",
   "cordova": {
     "id": "cordova-plugin-universal-links",
@@ -37,7 +37,6 @@
   ],
   "dependencies": {
     "glob": ">=7.0.0",
-    "mkpath": ">=1.0.0",
     "node-version-compare": ">=1.0.1",
     "plist": ">=1.2.0",
     "xcode": ">=3.0.0",

package/plugin.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<plugin id="cordova-plugin-universal-links" version="0.3.7" xmlns="http://apache.org/cordova/ns/plugins/1.0">
+<plugin id="cordova-plugin-universal-links" version="0.4.0" xmlns="http://apache.org/cordova/ns/plugins/1.0">
 
   <name>Universal Links Plugin</name>
   <description>
@@ -45,6 +45,9 @@
     <source-file src="src/ios/AppDelegate+CULPlugin.m"/>
     <header-file src="src/ios/AppDelegate+CULPlugin.h"/>
 
+    <source-file src="src/ios/CDVSceneDelegate+CULPlugin.m"/>
+    <header-file src="src/ios/CDVSceneDelegate+CULPlugin.h"/>
+
 <!-- sources for JS folder -->
     <source-file src="src/ios/JS/CDVPluginResult+CULPlugin.m" target-dir="JS/"/>
     <header-file src="src/ios/JS/CDVPluginResult+CULPlugin.h" target-dir="JS/"/>

package/src/ios/AppDelegate+CULPlugin.h

@@ -12,6 +12,6 @@
  */
 @interface AppDelegate (CULPlugin)
 
-- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *))restorationHandler;
+- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> *))restorationHandler;
 
 @end

package/src/ios/AppDelegate+CULPlugin.m

@@ -14,7 +14,7 @@ static NSString *const PLUGIN_NAME = @"UniversalLinks";
 
 @implementation AppDelegate (CULPlugin)
 
-- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *))restorationHandler {
+- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> *))restorationHandler {
     // ignore activities that are not for Universal Links
     if (![userActivity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb] || userActivity.webpageURL == nil) {
         return NO;

package/src/ios/CDVSceneDelegate+CULPlugin.h

@@ -0,0 +1,15 @@
+//
+//  CDVSceneDelegate+CULPlugin.h
+//
+
+#if __has_include(<Cordova/CDVSceneDelegate.h>)
+
+#import <Cordova/CDVSceneDelegate.h>
+
+@interface CDVSceneDelegate (CULPlugin)
+
+- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity;
+
+@end
+
+#endif

package/src/ios/CDVSceneDelegate+CULPlugin.m

@@ -0,0 +1,39 @@
+//
+//  CDVSceneDelegate+CULPlugin.m
+//
+
+#if __has_include(<Cordova/CDVSceneDelegate.h>)
+
+#import "CDVSceneDelegate+CULPlugin.h"
+#import "CULPlugin.h"
+#import <Cordova/CDVViewController.h>
+
+static NSString *const PLUGIN_NAME = @"UniversalLinks";
+
+@implementation CDVSceneDelegate (CULPlugin)
+
+- (void)scene:(UIScene *)scene continueUserActivity:(NSUserActivity *)userActivity {
+    if (![userActivity.activityType isEqualToString:NSUserActivityTypeBrowsingWeb] || userActivity.webpageURL == nil) {
+        return;
+    }
+
+    if (![scene isKindOfClass:[UIWindowScene class]]) {
+        return;
+    }
+
+    CDVViewController *viewController = (CDVViewController *)self.window.rootViewController;
+    if (![viewController isKindOfClass:[CDVViewController class]]) {
+        return;
+    }
+
+    CULPlugin *plugin = [viewController getCommandInstance:PLUGIN_NAME];
+    if (plugin == nil) {
+        return;
+    }
+
+    [plugin handleUserActivity:userActivity];
+}
+
+@end
+
+#endif

package/CHANGELOG.md

@@ -1,84 +0,0 @@
-# Change Log
-
-## 1.2.1 (2016-10-23)
-
-**Bug fixes:**
-
-- [Issue #79](https://github.com/nordnet/cordova-universal-links-plugin/issues/79). Fixed installation error: header files were added to the compile section of the project.
-- [Issue #77](https://github.com/nordnet/cordova-universal-links-plugin/issues/77). Fixed `before_prepare` hook for iOS that crashed on several systems. Thanks to [@lunchbag](https://github.com/lunchbag) for providing a fix.
-
-**Enhancements:**
-
-- [Issue #93](https://github.com/nordnet/cordova-universal-links-plugin/issues/93). Fixed iOS build warnings.
-
-## 1.2.0 (2016-07-27)
-
-**Enhancements:**
-
-- [Merged pull request #56](https://github.com/nordnet/cordova-universal-links-plugin/pull/56). Adds support for wildcard domains. Thanks to [@schmidt](https://github.com/schmidt) for implementation.
-
-**Docs:**
-
-- [Merged pull request #67](https://github.com/nordnet/cordova-universal-links-plugin/pull/67). Added `Prevent Android from creating multiple app instances` section. Thanks to [@yernandus](https://github.com/yernandus).
-- [Merged pull request #70](https://github.com/nordnet/cordova-universal-links-plugin/pull/70). Added `Digital Asset Links support` section. Thanks to [@ghybs](https://github.com/ghybs).
-
-## 1.1.2 (2016-04-27)
-
-**Bug fixes:**
-
-- [Issue #27](https://github.com/nordnet/cordova-universal-links-plugin/issues/27). From now on dependency packages will be installed in the plugin's folder instead of the project's root folder.
-
-## 1.1.1 (2016-03-17)
-
-**Bug fixes:**
-
-- [Issue #52](https://github.com/nordnet/cordova-universal-links-plugin/issues/52). Fixed `config.xml` file preferences reading. Thanks to [@ikostic](https://github.com/ikostic) for providing fix.
-- [Issue #47](https://github.com/nordnet/cordova-universal-links-plugin/issues/47). If `paths` in `apple-app-site-association` file contains only `*` - we will also add `/`, so that app would be opened from root domain.
-- Merged [PR #42](https://github.com/nordnet/cordova-universal-links-plugin/pull/42). Fixed Android web integration on Android 6.0. Thanks to [@mohamed-ahmed](https://github.com/mohamed-ahmed).
-
-**Docs:**
-
-- Merged [PR #50](https://github.com/nordnet/cordova-universal-links-plugin/pull/50). Fixed typo in documentation. Thanks to [@rafaellop](https://github.com/rafaellop).
-- Merged [PR #43](https://github.com/nordnet/cordova-universal-links-plugin/pull/43). Updated documentation regarding `apple-app-site-association` file. Thanks to [@Chun-Yang](https://github.com/Chun-Yang).
-- Updated `Useful notes on Universal Links for iOS` section. Thanks to [@conor-mac-aoidh](https://github.com/conor-mac-aoidh) for providing information.
-
-## 1.1.0 (2015-12-18)
-
-**Bug fixes:**
-
-- [Issue #26](https://github.com/nordnet/cordova-universal-links-plugin/issues/26). Fixed support for multiple wildcards in path. Thanks to [@tdelmas](https://github.com/tdelmas) for helping with solution.
-- Other minor bug fixes.
-
-**Enhancements:**
-
-- [Issue #18](https://github.com/nordnet/cordova-universal-links-plugin/issues/18). Added JS module through which you can subscribe for launch events. Solves timing issue with the previous `document.addEventListener()` approach.
-- [Issue #20](https://github.com/nordnet/cordova-universal-links-plugin/issues/20). Lowered min iOS version to 8.0. Plugin want work on devices prior to iOS 9, but if your application includes this plugin - it now will run on iOS 8 devices. Before you had to drop iOS 8 support.
-- [Issue #22](https://github.com/nordnet/cordova-universal-links-plugin/issues/22). Plugin now compatible with Cordova v5.4.
-- [Issue #24](https://github.com/nordnet/cordova-universal-links-plugin/issues/24). Now you can define iOS Team ID as plugin preference. It will be used for generation of `apple-app-site-association` files.
-- [Issue #25](https://github.com/nordnet/cordova-universal-links-plugin/issues/25). Plugin now compatible with Cordova iOS platform v4.0.0.
-
-**Docs:**
-
-- Added `Migrating from previous versions` section.
-- Updated `Cordova config preferences` section.
-- Updated `Application launch handling` section.
-- Other minor changes because of new release.
-
-## 1.0.1 (2015-10-23)
-
-**Bug fixes:**
-
-- Android. Fixed [issue #9](https://github.com/nordnet/cordova-universal-links-plugin/issues/9). Now when application is resumed from the link click - appropriate event is dispatched to the JavaScript side.
-
-**Enhancements:**
-
-- iOS. [Issue #6](https://github.com/nordnet/cordova-universal-links-plugin/issues/6). Scheme is now removed from the url matching process, since it is not needed: only hostname and path are used.
-- Merged [pull request #1](https://github.com/nordnet/cordova-universal-links-plugin/pull/1). Now dependency npm packages are taken from the package.json file. Thanks to [@dpa99c](https://github.com/dpa99c).
-
-**Docs:**
-
-- Added `Useful notes on Universal Links for iOS` section.
-- Updated `Android web integration` section. Added more information about web integration process.
-- Added some additional links on the Android documentation.
-- Fixed some broken links inside the docs.
-- Added CHANGELOG.md file.