@expo/cli
Version:
255 lines (254 loc) • 9.18 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
function _export(target, all) {
for(var name in all)Object.defineProperty(target, name, {
enumerable: true,
get: all[name]
});
}
_export(exports, {
assertValidBundleId: function() {
return assertValidBundleId;
},
assertValidPackage: function() {
return assertValidPackage;
},
getBundleIdWarningAsync: function() {
return getBundleIdWarningAsync;
},
getBundleIdWarningInternalAsync: function() {
return getBundleIdWarningInternalAsync;
},
getPackageNameWarningAsync: function() {
return getPackageNameWarningAsync;
},
getPackageNameWarningInternalAsync: function() {
return getPackageNameWarningInternalAsync;
},
getSanitizedBundleIdentifier: function() {
return getSanitizedBundleIdentifier;
},
getSanitizedPackage: function() {
return getSanitizedPackage;
},
validateBundleId: function() {
return validateBundleId;
},
validatePackage: function() {
return validatePackage;
},
validatePackageWithWarning: function() {
return validatePackageWithWarning;
}
});
function _assert() {
const data = /*#__PURE__*/ _interop_require_default(require("assert"));
_assert = function() {
return data;
};
return data;
}
function _chalk() {
const data = /*#__PURE__*/ _interop_require_default(require("chalk"));
_chalk = function() {
return data;
};
return data;
}
const _env = require("./env");
const _fn = require("./fn");
const _link = require("./link");
const _url = require("./url");
const _log = require("../log");
function _interop_require_default(obj) {
return obj && obj.__esModule ? obj : {
default: obj
};
}
const debug = require('debug')('expo:utils:validateApplicationId');
// TODO: Adjust to indicate that the bundle identifier must start with a letter, period, or hyphen.
const IOS_BUNDLE_ID_REGEX = /^[a-zA-Z0-9-.]+$/;
const ANDROID_PACKAGE_REGEX = /^[a-zA-Z][a-zA-Z0-9_]*(\.[a-zA-Z][a-zA-Z0-9_]*)+$/;
function validateBundleId(value) {
return IOS_BUNDLE_ID_REGEX.test(value);
}
function validatePackage(value) {
return validatePackageWithWarning(value) === true;
}
function validatePackageWithWarning(value) {
const parts = value.split('.');
for (const segment of parts){
if (RESERVED_ANDROID_PACKAGE_NAME_SEGMENTS.includes(segment)) {
return `"${segment}" is a reserved Java keyword.`;
}
}
if (parts.length < 2) {
return `Package name must contain more than one segment, separated by ".", e.g. com.${value}`;
}
if (!ANDROID_PACKAGE_REGEX.test(value)) {
return 'Invalid characters in Android package name. Only alphanumeric characters, "." and "_" are allowed, and each segment start with a letter.';
}
return true;
}
function getSanitizedPackage(value) {
// It's common to use dashes in your node project name, strip them from the suggested package name.
let output = value// Oracle recommends package names are "legalized" by converting hyphen to an underscore and removing unsupported characters
// https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html
// However, life is much nicer when the bundle identifier and package name are the same and iOS has the inverse rule— converting underscores to hyphens.
// So we'll simply remove hyphens and illegal characters for Android.
.replace(/[^a-zA-Z0-9_.]/g, '')// Prevent multiple '.' in a row (e.g. no zero-length segments).
.replace(/\.+/g, '.')// Prevent '.' from the start or end.
.replace(/^\.|\.$/g, '');
output ||= 'app';
// Prepend extra segments
let segments = output.split('.').length;
while(segments < 2){
output = `com.${output}`;
segments += 1;
}
// Ensure each dot has a letter or number after it
output = output.split('.').map((segment)=>{
segment = /^[a-zA-Z]/.test(segment) ? segment : 'x' + segment;
if (RESERVED_ANDROID_PACKAGE_NAME_SEGMENTS.includes(segment)) {
segment = 'x' + segment;
}
return segment;
}).join('.');
return output;
}
function getSanitizedBundleIdentifier(value) {
// According to the behavior observed when using the UI in Xcode.
// Must start with a letter, period, or hyphen (not number).
// Can only contain alphanumeric characters, periods, and hyphens.
// Can have empty segments (e.g. com.example..app).
return value.replace(/(^[^a-zA-Z.-]|[^a-zA-Z0-9-.])/g, '-');
}
// https://en.wikipedia.org/wiki/List_of_Java_keywords
// Running the following in the console and pruning the "Reserved Identifiers" section:
// [...document.querySelectorAll('dl > dt > code')].map(node => node.innerText)
const RESERVED_ANDROID_PACKAGE_NAME_SEGMENTS = [
// List of Java keywords
'_',
'abstract',
'assert',
'boolean',
'break',
'byte',
'case',
'catch',
'char',
'class',
'const',
'continue',
'default',
'do',
'double',
'else',
'enum',
'extends',
'final',
'finally',
'float',
'for',
'goto',
'if',
'implements',
'import',
'instanceof',
'int',
'interface',
'long',
'native',
'new',
'package',
'private',
'protected',
'public',
'return',
'short',
'static',
'super',
'switch',
'synchronized',
'this',
'throw',
'throws',
'transient',
'try',
'void',
'volatile',
'while',
// Reserved words for literal values
'true',
'false',
'null',
// Unused
'const',
'goto',
'strictfp'
];
function assertValidBundleId(value) {
_assert().default.match(value, IOS_BUNDLE_ID_REGEX, `The ios.bundleIdentifier defined in your Expo config is not formatted properly. Only alphanumeric characters, '.', '-', and '_' are allowed, and each '.' must be followed by a letter.`);
}
function assertValidPackage(value) {
_assert().default.match(value, ANDROID_PACKAGE_REGEX, `Invalid format of Android package name. Only alphanumeric characters, '.' and '_' are allowed, and each '.' must be followed by a letter. Reserved Java keywords are not allowed.`);
}
async function getBundleIdWarningInternalAsync(bundleId) {
if (_env.env.EXPO_OFFLINE) {
_log.Log.warn('Skipping Apple bundle identifier reservation validation in offline-mode.');
return null;
}
if (!await (0, _url.isUrlAvailableAsync)('itunes.apple.com')) {
debug(`Couldn't connect to iTunes Store to check bundle ID ${bundleId}. itunes.apple.com may be down.`);
// If no network, simply skip the warnings since they'll just lead to more confusion.
return null;
}
const url = `http://itunes.apple.com/lookup?bundleId=${bundleId}`;
try {
debug(`Checking iOS bundle ID '${bundleId}' at: ${url}`);
const response = await fetch(url);
const json = await response.json();
if (json.resultCount > 0) {
const firstApp = json.results[0];
return formatInUseWarning(firstApp.trackName, firstApp.sellerName, bundleId);
}
} catch (error) {
debug(`Error checking bundle ID ${bundleId}: ${error.message}`);
// Error fetching itunes data.
}
return null;
}
const getBundleIdWarningAsync = (0, _fn.memoize)(getBundleIdWarningInternalAsync);
async function getPackageNameWarningInternalAsync(packageName) {
if (_env.env.EXPO_OFFLINE) {
_log.Log.warn('Skipping Android package name reservation validation in offline-mode.');
return null;
}
if (!await (0, _url.isUrlAvailableAsync)('play.google.com')) {
debug(`Couldn't connect to Play Store to check package name ${packageName}. play.google.com may be down.`);
// If no network, simply skip the warnings since they'll just lead to more confusion.
return null;
}
const url = `https://play.google.com/store/apps/details?id=${packageName}`;
try {
debug(`Checking Android package name '${packageName}' at: ${url}`);
const response = await fetch(url);
// If the page exists, then warn the user.
if (response.status === 200) {
// There is no JSON API for the Play Store so we can't concisely
// locate the app name and developer to match the iOS warning.
return `⚠️ The package ${_chalk().default.bold(packageName)} is already in use. ${_chalk().default.dim((0, _link.learnMore)(url))}`;
}
} catch (error) {
// Error fetching play store data or the page doesn't exist.
debug(`Error checking package name ${packageName}: ${error.message}`);
}
return null;
}
function formatInUseWarning(appName, author, id) {
return `⚠️ The app ${_chalk().default.bold(appName)} by ${_chalk().default.italic(author)} is already using ${_chalk().default.bold(id)}`;
}
const getPackageNameWarningAsync = (0, _fn.memoize)(getPackageNameWarningInternalAsync);
//# sourceMappingURL=validateApplicationId.js.map