jspm/api.js

/*
 *   Copyright 2014-2016 Guy Bedford (http://guybedford.com)
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
var EventEmitter = require('events').EventEmitter;
var API = module.exports = new EventEmitter();

var install = require('./lib/install');
var bundle = require('./lib/bundle');
var link = require('./lib/link');
var core = require('./lib/core');
var ui = require('./lib/ui');
var SystemJSLoader = require('systemjs').constructor;
var config = require('./lib/config');
var path = require('path');

API.version = config.version;

API.setPackagePath = function(packagePath) {
  if (config.loaded && process.env.jspmConfigPath !== path.resolve(packagePath, 'package.json'))
    throw new Error('Configuration has already been loaded. Call setPackagePath before using other APIs.');
  process.env.jspmConfigPath = path.resolve(packagePath, 'package.json');
};
API.setPackagePath('.');

/*
 * jspm.on('log', function(type, msg) { console.log(msg); });
 * jspm.on('prompt', function(prompt, callback) {
 *   if (prompt.type == 'confirm')
 *     callback({ confirm: true });
 *   if (prompt.type == 'input')
 *     callback({ input: value });
 * });
 *
 * Prompt as defined in https://github.com/SBoudrias/Inquirer.js/tree/master#question
 * Callback answer defined in https://github.com/SBoudrias/Inquirer.js/tree/master#answers
 */
ui.setResolver(API);
ui.useDefaults();

API.promptDefaults = function(_useDefaults) {
  ui.useDefaults(_useDefaults);
};

API.version = require('./package.json').version;

/*
 * Loader API
 */
var apiLoader;
API.normalize = function(name, parentName) {
  apiLoader = apiLoader || new API.Loader();
  return apiLoader.normalize(name, parentName);
};

API.import = function(name, parentName) {
  apiLoader = apiLoader || new API.Loader();
  return apiLoader.import(name, parentName);
};

API.Loader = function() {
  config.loadSync();

  var cfg = config.getLoaderConfig();

  var loader = new SystemJSLoader();
  loader.config(cfg);

  return loader;
};

/*
 * Builder API
 */
API.Builder = bundle.Builder;

// deprecated:
function builderDeprecationMsg(method) {
  return Promise.reject(new TypeError('jspm.' + method + ' is deprecated for the Builder API:\n\tvar Builder = require(\'jspm\').Builder;\n\tvar builder = new Builder();\n\tbuilder.' + method + '(...).then(...)'));
}


API.bundle = builderDeprecationMsg.bind(API, 'bundle');
API.build = builderDeprecationMsg.bind(API, 'build');
API.bundleSFX = builderDeprecationMsg.bind(API, 'bundleSFX');
API.unbundle = function() {
  return bundle.unbundle();
};

/*
 * Package Management API
 *

/*
 * Installs a library in the current folder
 * returns a promise
 *
 * jspm.install('jquery')
 * jspm.install('jquery', 'github:components/jquery@^2.0.0')
 * jspm.install('jquery', '2')
 * jspm.install('jquery', 'github:components/jquery')
 * jspm.install('jquery', { force: true });
 * jspm.install({ jquery: '1.2.3' }, { force: true })
 * jspm.install(true, options) // install from package.json
 *
 */
API.install = function(name, target, options) {
  return install.install(name, target, options);
};

/* Uninstalls a library in the current folder.
 * returns a promise
 *
 * jspm.uninstall('jquery')
 * jspm.uninstall(['jquery', 'handlebars'])
 *
 */
API.uninstall = function(names) {
  return install.uninstall(names);
};

API.dlLoader = function(transpiler) {
  return core.checkDlLoader(transpiler);
};

/**
 * Link a local folder as an installable package
 * @param {string} linkTargetDir Filesystem path to package source directory
 * @param {string} linkName Uncanonical package name used to register the link target (the version before map/path rules are applied)
 * @param {object} options
 * @param {boolean} options.force
 * @param {boolean} options.quick
 * @returns {Promise}
 */
API.link = function(linkTargetDir, linkName, options) {
  return link.link(linkTargetDir, linkName, options || {});
};