cordova-mirtech-plugin-universal-links/hooks/lib/ios/appleAppSiteAssociationFile.js

/*
Script generates apple-app-site-association files: one for each domain, defined in config.xml.
It is executed on 'after prepare' stage, usually when you execute 'cordova build'. Files are placed in 'ul_web_hooks/ios/' folder
of your projects root.

Files are created with the following name:
hostname#apple-app-site-association

Prefix 'hostname#' describes on which host this file should be placed. Don't forget to remove it before uploading file on your host.
Also, in the file you need to replace <YOUR_TEAM_ID_FROM_MEMBER_CENTER> with the real team id from the member center, if <ios-team-id> preference was not set in projects config.xml.

In order to activate support for Universal Links on iOS you need to sign them with the valid SSL certificate and place in the root of your domain.

Additional documentation regarding apple-app-site-association file can be found here:
- https://developer.apple.com/library/ios/documentation/General/Conceptual/AppSearch/UniversalLinks.html
- https://developer.apple.com/library/ios/documentation/Security/Reference/SharedWebCredentialsRef/index.html#//apple_ref/doc/uid/TP40014989
*/


var path = require('path');
var mkpath = require('mkpath');
var fs = require('fs');
var rimraf = require('rimraf');
var ConfigXmlHelper = require('../configXmlHelper.js');
var IOS_TEAM_ID = '<YOUR_TEAM_ID_FROM_MEMBER_CENTER>';
var ASSOCIATION_FILE_NAME = 'apple-app-site-association';
var bundleId;
var context;

module.exports = {
  generate: generate
};

// region Public API

/**
 * Generate apple-app-site-association files.
 *
 * @param {Object} cordovaContext - cordova context object
 * @param {Object} pluginPreferences - list of hosts from the config.xml; already parsed
 */
function generate(cordovaContext, pluginPreferences) {
  context = cordovaContext;
  removeOldFiles();
  createNewAssociationFiles(pluginPreferences);
}

// endregion

// region Content generation

/**
 * Remove old files from ul_web_hooks/ios folder.
 */
function removeOldFiles() {
  rimraf.sync(getWebHookDirectory());
}

/**
 * Generate new set of apple-app-site-association files.
 *
 * @param {Object} pluginPreferences - list of hosts from config.xml
 */
function createNewAssociationFiles(pluginPreferences) {
  var teamId = pluginPreferences.iosTeamId;
  if (!teamId) {
    teamId = IOS_TEAM_ID;
  }

  pluginPreferences.hosts.forEach(function(host) {
    var content = generateFileContentForHost(host, teamId);
    saveContentToFile(host.name, content);
  });
}

/**
 * Generate content of the apple-app-site-association file for the specific host.
 *
 * @param {Object} host - host information
 * @return {Object} content of the file as JSON object
 */
function generateFileContentForHost(host, teamId) {
  var appID = teamId + '.' + getBundleId();
  var paths = host.paths.slice();

  // if paths are '*' - we should add '/' to it to support root domains.
  // https://github.com/martindrapeau/cordova-universal-links-plugin/issues/46
  if (paths.length == 1 && paths[0] === '*') {
    paths.push('/');
  }

  return {
    "applinks": {
      "apps": [],
      "details": [{
        "appID": appID,
        "paths": paths
      }]
    }
  };
}

/**
 * Save data to the the apple-app-site-association file.
 *
 * @param {String} filePrefix - prefix for the generated file; usually - hostname
 * @param {Object} content - file content as JSON object
 */
function saveContentToFile(filePrefix, content) {
  var dirPath = getWebHookDirectory();
  var filePath = path.join(dirPath, filePrefix + '#' + ASSOCIATION_FILE_NAME);

  // create all directories from file path
  createDirectoriesIfNeeded(dirPath);

  // write content to the file
  try {
    fs.writeFileSync(filePath, JSON.stringify(content, null, 2), 'utf8');
  } catch (err) {
    console.log(err);
  }
}

/**
 * Create all directories from the given path.
 *
 * @param {String} dirPath - full path to directory
 */
function createDirectoriesIfNeeded(dirPath) {
  try {
    mkpath.sync(dirPath);
  } catch (err) {
    console.log(err);
  }
}

// endregion

// region Support methods

/**
 * Path to the ios web hook directory.
 *
 * @return {String} path to web hook directory
 */
function getWebHookDirectory() {
  return path.join(getProjectRoot(), 'ul_web_hooks', 'ios');
}

/**
 * Project root directory
 *
 * @return {String} absolute path to project root
 */
function getProjectRoot() {
  return context.opts.projectRoot;
}

/**
 * Get bundle id from the config.xml file.
 *
 * @return {String} bundle id
 */
function getBundleId() {
  if (bundleId === undefined) {
    var configXmlHelper = new ConfigXmlHelper(context);
    bundleId = configXmlHelper.getPackageName('ios');
  }

  return bundleId;
}

// endregion