@adobe/aio-app-scripts/index.js

Utility tooling scripts to build, deploy and run an Adobe I/O App

/*
Copyright 2019 Adobe. All rights reserved.
This file is licensed to you 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 REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/
const loadConfig = require('./lib/config-loader')

const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-app-scripts:index', { provider: 'debug' })
const BuildUI = require('./scripts/build.ui')
const BuildActions = require('./scripts/build.actions')
const DeployUI = require('./scripts/deploy.ui')
const DeployActions = require('./scripts/deploy.actions')
const UndeployUI = require('./scripts/undeploy.ui')
const UndeployActions = require('./scripts/undeploy.actions')
const RunDev = require('./scripts/dev')
const Logs = require('./scripts/logs')
const GetUrl = require('./scripts/get.url')

/**
 * Adobe I/O application scripts
 * @module adobe/aio-app-scripts
 */

/**
 * @typedef AppScripts
 * @type {object}
 * @property {function(object):Promise<undefined>} buildUI - bundles the application's static files
 * @property {function(object):Promise<undefined>} buildActions - zips and/or bundles the application's serverless functions
 * @property {function(object):Promise<string>} deployUI - deploys the static files to a CDN, returns the URL
 * @property {function(object):Promise<undefined>} deployActions - deploys the serverless functions to OpenWhisk
 * @property {function(object):Promise<undefined>} undeployUI - removes the deployed static files
 * @property {function(object):Promise<undefined>} undeployActions - deletes the deployed OpenWhisk actions
 * @property {function(object):Promise<undefined>} runDev - runs the app in a local development server, set env
 * REMOTE_ACTIONS=true to use remotely deployed actions
 * @property {function(object, object):Promise<boolean>} logs - shows action logs
 * @property {function(object, object):Promise<Object>} getUrls - shows action urls
 */

/**
 * Returns application scripts functions
 * @function
 * @param {object} [options]
 * @param {object} [options.listeners]
 * @param {function} [options.listeners.onStart]
 * @param {function} [options.listeners.onEnd]
 * @param {function} [options.listeners.onProgress]
 * @param {function} [options.listeners.onResource]
 * @param {function} [options.listeners.onWarning]
 * @returns {AppScripts} With all script functions
 */
module.exports = function (options) {
  aioLogger.debug('exportScripts')

  options = options || {}
  const listeners = options.listeners || {}

  const appConfig = loadConfig()

  const instantiate = (ClassDesc) => {
    const instance = new ClassDesc(appConfig)

    if (listeners.onStart) {
      instance.on('start', listeners.onStart)
    }
    if (listeners.onEnd) {
      instance.on('end', listeners.onEnd)
    }
    if (listeners.onProgress) {
      instance.on('progress', listeners.onProgress)
    }
    if (listeners.onResource) {
      instance.on('resource', listeners.onResource)
    }
    if (listeners.onWarning) {
      instance.on('warning', listeners.onWarning)
    }
    // todo: refactor this away
    return instance.run.bind(instance)
  }
  // interface
  return {
    buildUI: instantiate(BuildUI),
    buildActions: instantiate(BuildActions),
    deployUI: instantiate(DeployUI),
    deployActions: instantiate(DeployActions),
    undeployUI: instantiate(UndeployUI),
    undeployActions: instantiate(UndeployActions),
    runDev: instantiate(RunDev),
    logs: instantiate(Logs),
    getUrls: instantiate(GetUrl),
    // for unit testing
    _config: appConfig
  }
}