@adobe/aio-cli-plugin-app 10.5.0 → 10.6.0

package/README.md

@@ -71,7 +71,7 @@ DESCRIPTION
   Create, run, test, and deploy Adobe I/O Apps
 ```
 
-_See code: [src/commands/app/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/index.ts)_
+_See code: [src/commands/app/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/index.ts)_
 
 ## `aio app add`
 
@@ -89,7 +89,7 @@ DESCRIPTION
   Add a new component to an existing Adobe I/O App
 ```
 
-_See code: [src/commands/app/add/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/add/index.ts)_
+_See code: [src/commands/app/add/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/add/index.ts)_
 
 ## `aio app add action`
 
@@ -114,7 +114,7 @@ ALIASES
   $ aio app add actions
 ```
 
-_See code: [src/commands/app/add/action.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/add/action.ts)_
+_See code: [src/commands/app/add/action.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/add/action.ts)_
 
 ## `aio app add ci`
 
@@ -132,7 +132,7 @@ DESCRIPTION
   Add CI files
 ```
 
-_See code: [src/commands/app/add/ci.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/add/ci.ts)_
+_See code: [src/commands/app/add/ci.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/add/ci.ts)_
 
 ## `aio app add event`
 
@@ -140,14 +140,16 @@ Add a new Adobe I/O Events action
 
 ```
 USAGE
-  $ aio app add event [-v] [--version] [--install] [-y] [-e <value>]
+  $ aio app add event [-v] [--version] [--install] [-y] [-e <value>] [--experimental-allow-events-templates]
 
 FLAGS
-  -e, --extension=<value>  Add actions to a specific extension
-  -v, --verbose            Verbose output
-  -y, --yes                Skip questions, and use all default values
-  --[no-]install           [default: true] Run npm installation after files are created
-  --version                Show version
+  -e, --extension=<value>                Add events to a specific extension
+  -v, --verbose                          Verbose output
+  -y, --yes                              Skip questions, and use all default values
+  --experimental-allow-events-templates  Feature flag to enable events templates. NOTE: skip-prompt will have no effect
+                                         if this flag is enabled.
+  --[no-]install                         [default: true] Run npm installation after files are created
+  --version                              Show version
 
 DESCRIPTION
   Add a new Adobe I/O Events action
@@ -157,7 +159,7 @@ ALIASES
   $ aio app add events
 ```
 
-_See code: [src/commands/app/add/event.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/add/event.ts)_
+_See code: [src/commands/app/add/event.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/add/event.ts)_
 
 ## `aio app add extension`
 
@@ -183,7 +185,7 @@ ALIASES
   $ aio app add extensions
 ```
 
-_See code: [src/commands/app/add/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/add/extension.ts)_
+_See code: [src/commands/app/add/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/add/extension.ts)_
 
 ## `aio app add service`
 
@@ -207,7 +209,7 @@ ALIASES
   $ aio app add services
 ```
 
-_See code: [src/commands/app/add/service.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/add/service.ts)_
+_See code: [src/commands/app/add/service.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/add/service.ts)_
 
 ## `aio app add web-assets`
 
@@ -228,7 +230,7 @@ DESCRIPTION
   Add web assets support
 ```
 
-_See code: [src/commands/app/add/web-assets.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/add/web-assets.ts)_
+_See code: [src/commands/app/add/web-assets.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/add/web-assets.ts)_
 
 ## `aio app build`
 
@@ -257,7 +259,7 @@ DESCRIPTION
   This will always force a rebuild unless --no-force-build is set.
 ```
 
-_See code: [src/commands/app/build.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/build.ts)_
+_See code: [src/commands/app/build.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/build.ts)_
 
 ## `aio app create [PATH]`
 
@@ -279,7 +281,7 @@ DESCRIPTION
   Create a new Adobe I/O App with default parameters
 ```
 
-_See code: [src/commands/app/create.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/create.ts)_
 
 ## `aio app delete`
 
@@ -297,7 +299,7 @@ DESCRIPTION
   Delete a component from an existing Adobe I/O App
 ```
 
-_See code: [src/commands/app/delete/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/delete/index.ts)_
+_See code: [src/commands/app/delete/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/delete/index.ts)_
 
 ## `aio app delete action [ACTION-NAME]`
 
@@ -323,7 +325,7 @@ ALIASES
   $ aio app delete actions
 ```
 
-_See code: [src/commands/app/delete/action.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/delete/action.ts)_
+_See code: [src/commands/app/delete/action.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/delete/action.ts)_
 
 ## `aio app delete ci`
 
@@ -342,7 +344,7 @@ DESCRIPTION
   Delete existing CI files
 ```
 
-_See code: [src/commands/app/delete/ci.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/delete/ci.ts)_
+_See code: [src/commands/app/delete/ci.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/delete/ci.ts)_
 
 ## `aio app delete event [EVENT-ACTION-NAME]`
 
@@ -368,7 +370,7 @@ ALIASES
   $ aio app delete events
 ```
 
-_See code: [src/commands/app/delete/event.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/delete/event.ts)_
+_See code: [src/commands/app/delete/event.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/delete/event.ts)_
 
 ## `aio app delete extension`
 
@@ -394,7 +396,7 @@ ALIASES
   $ aio app delete extensions
 ```
 
-_See code: [src/commands/app/delete/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/delete/extension.ts)_
+_See code: [src/commands/app/delete/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/delete/extension.ts)_
 
 ## `aio app delete service`
 
@@ -418,7 +420,7 @@ ALIASES
   $ aio app delete services
 ```
 
-_See code: [src/commands/app/delete/service.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/delete/service.ts)_
+_See code: [src/commands/app/delete/service.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/delete/service.ts)_
 
 ## `aio app delete web-assets`
 
@@ -437,7 +439,7 @@ DESCRIPTION
   Delete existing web assets
 ```
 
-_See code: [src/commands/app/delete/web-assets.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/delete/web-assets.ts)_
+_See code: [src/commands/app/delete/web-assets.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/delete/web-assets.ts)_
 
 ## `aio app deploy`
 
@@ -477,7 +479,7 @@ DESCRIPTION
   This will always force a rebuild unless --no-force-build is set.
 ```
 
-_See code: [src/commands/app/deploy.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/deploy.ts)_
+_See code: [src/commands/app/deploy.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/deploy.ts)_
 
 ## `aio app get-url [ACTION]`
 
@@ -500,7 +502,7 @@ DESCRIPTION
   Get action URLs
 ```
 
-_See code: [src/commands/app/get-url.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/get-url.ts)_
+_See code: [src/commands/app/get-url.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/get-url.ts)_
 
 ## `aio app info`
 
@@ -522,7 +524,7 @@ DESCRIPTION
   Display settings/configuration in use by an Adobe I/O App
 ```
 
-_See code: [src/commands/app/info.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/info.ts)_
+_See code: [src/commands/app/info.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/info.ts)_
 
 ## `aio app init [PATH]`
 
@@ -556,7 +558,7 @@ DESCRIPTION
   Create a new Adobe I/O App
 ```
 
-_See code: [src/commands/app/init.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/init.ts)_
+_See code: [src/commands/app/init.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/init.ts)_
 
 ## `aio app list`
 
@@ -574,7 +576,7 @@ DESCRIPTION
   List components for Adobe I/O App
 ```
 
-_See code: [src/commands/app/list/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/list/index.ts)_
+_See code: [src/commands/app/list/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/list/index.ts)_
 
 ## `aio app list extension`
 
@@ -599,7 +601,7 @@ ALIASES
   $ aio app list extensions
 ```
 
-_See code: [src/commands/app/list/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/list/extension.ts)_
+_See code: [src/commands/app/list/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/list/extension.ts)_
 
 ## `aio app logs`
 
@@ -623,7 +625,7 @@ DESCRIPTION
   Fetch logs for an Adobe I/O App
 ```
 
-_See code: [src/commands/app/logs.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/logs.ts)_
+_See code: [src/commands/app/logs.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/logs.ts)_
 
 ## `aio app run`
 
@@ -646,7 +648,7 @@ DESCRIPTION
   Run an Adobe I/O App
 ```
 
-_See code: [src/commands/app/run.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/run.ts)_
+_See code: [src/commands/app/run.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/run.ts)_
 
 ## `aio app test`
 
@@ -674,7 +676,7 @@ DESCRIPTION
   If the extension has a hook called 'test' in its 'ext.config.yaml', the script specified will be run instead.
 ```
 
-_See code: [src/commands/app/test.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/test.ts)_
+_See code: [src/commands/app/test.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/test.ts)_
 
 ## `aio app undeploy`
 
@@ -699,7 +701,7 @@ DESCRIPTION
   Undeploys an Adobe I/O App
 ```
 
-_See code: [src/commands/app/undeploy.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/undeploy.ts)_
+_See code: [src/commands/app/undeploy.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/undeploy.ts)_
 
 ## `aio app use [CONFIG_FILE_PATH]`
 
@@ -747,5 +749,5 @@ DESCRIPTION
   page in https://developer.adobe.com/console/
 ```
 
-_See code: [src/commands/app/use.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.5.0/src/commands/app/use.ts)_
+_See code: [src/commands/app/use.ts](https://github.com/adobe/aio-cli-plugin-app/blob/10.6.0/src/commands/app/use.ts)_
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "10.5.0",
+  "version": "10.6.0",
   "commands": {
     "app:build": {
       "id": "app:build",
@@ -1104,8 +1104,14 @@
           "name": "extension",
           "type": "option",
           "char": "e",
-          "description": "Add actions to a specific extension",
+          "description": "Add events to a specific extension",
           "multiple": false
+        },
+        "experimental-allow-events-templates": {
+          "name": "experimental-allow-events-templates",
+          "type": "boolean",
+          "description": "Feature flag to enable events templates. NOTE: skip-prompt will have no effect if this flag is enabled.",
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@adobe/aio-cli-plugin-app",
   "description": "Create, Build and Deploy Adobe I/O Applications",
-  "version": "10.5.0",
+  "version": "10.6.0",
   "author": "Adobe Inc.",
   "bugs": "https://github.com/adobe/aio-cli-plugin-app/issues",
   "dependencies": {
-    "@adobe/aio-cli-lib-app-config": "^1.0.1",
+    "@adobe/aio-cli-lib-app-config": "^1.1.0",
     "@adobe/aio-cli-lib-console": "^4.1.0",
     "@adobe/aio-lib-core-config": "^4.0.0",
     "@adobe/aio-lib-core-logging": "^2.0.0",

package/src/BaseCommand.js

@@ -118,6 +118,22 @@ class BaseCommand extends Command {
     return configData
   }
 
+  getEventsConfigFile (implName) {
+    let configKey
+    if (implName === APPLICATION_CONFIG_KEY) {
+      configKey = APPLICATION_CONFIG_KEY
+    } else {
+      configKey = `${EXTENSIONS_CONFIG_KEY}.${implName}`
+    }
+    let configData = this.getConfigFileForKey(`${configKey}.events`)
+    if (!configData.file) {
+      // first events manifest is not defined
+      configData = this.getConfigFileForKey(`${configKey}`)
+      configData.key = configData.key + '.events'
+    }
+    return configData
+  }
+
   getConfigFileForKey (fullKey) {
     // NOTE: the index returns undefined if the key is loaded from a legacy configuration file
     const fullConfig = this.getFullConfig()

package/src/commands/app/add/event.js

@@ -10,14 +10,16 @@ governing permissions and limitations under the License.
 */
 
 const AddCommand = require('../../../AddCommand')
+const TemplatesCommand = require('../../../TemplatesCommand')
 const yeoman = require('yeoman-environment')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:add:event', { provider: 'debug' })
 const { Flags } = require('@oclif/core')
 const ora = require('ora')
 const path = require('path')
 const generators = require('@adobe/generator-aio-app')
+const TemplateRegistryAPI = require('@adobe/aio-lib-templates')
 
-class AddEventCommand extends AddCommand {
+class AddEventCommand extends TemplatesCommand {
   async run () {
     const { flags } = await this.parse(AddEventCommand)
 
@@ -29,27 +31,63 @@ class AddEventCommand extends AddCommand {
     if (entries.length > 1) {
       this.error('Please use the \'-e\' flag to specify to which implementation you want to add events to.')
     }
+
     const configName = entries[0][0]
     const config = entries[0][1]
     const actionFolder = path.relative(config.root, config.actions.src)
-    const configData = this.getRuntimeManifestConfigFile(configName)
+    const runtimeManifestData = this.getRuntimeManifestConfigFile(configName)
+
+    const templateOptions = {
+      'skip-prompt': false,
+      'action-folder': actionFolder,
+      'config-path': runtimeManifestData.file,
+      'full-key-to-manifest': runtimeManifestData.key
+    }
 
-    const env = yeoman.createEnv()
-    // by default yeoman runs the install, we control installation from the app plugin
-    env.options = { skipInstall: true }
-    const eventsGen = env.instantiate(generators['add-events'], {
-      options: {
-        'skip-prompt': flags.yes,
-        'action-folder': actionFolder,
-        'config-path': configData.file,
-        'full-key-to-manifest': configData.key,
-        // force overwrites, no useless prompts, this is a feature exposed by yeoman itself
-        force: true
+    if (flags['experimental-allow-events-templates']) {
+      const eventsData = this.getEventsConfigFile(configName)
+      templateOptions['full-key-to-events-manifest'] = eventsData.key
+      const [searchCriteria, orderByCriteria] = await this.getSearchCriteria()
+      const templates = await this.selectTemplates(searchCriteria, orderByCriteria)
+      if (templates.length === 0) {
+        this.error('No events templates were chosen to be installed.')
+      } else {
+        await this.installTemplates({
+          useDefaultValues: flags.yes,
+          installNpm: flags.install,
+          templateOptions,
+          templates
+        })
       }
-    })
-    await env.runGenerator(eventsGen)
+      // by default yeoman runs the install, we control installation from the app plugin
+    } else {
+      templateOptions['skip-prompt'] = flags.yes
+      templateOptions.force = true
+      const env = yeoman.createEnv()
+      env.options = { skipInstall: true }
+      const eventsGen = env.instantiate(generators['add-events'], {
+        options: templateOptions
+      })
+      await env.runGenerator(eventsGen)
 
-    await this.runInstallPackages(flags, spinner)
+      await this.runInstallPackages(flags, spinner)
+    }
+  }
+
+  async getSearchCriteria () {
+    const TEMPLATE_CATEGORIES = ['events', 'helper-template']
+    const searchCriteria = {
+      [TemplateRegistryAPI.SEARCH_CRITERIA_STATUSES]: TemplateRegistryAPI.TEMPLATE_STATUS_APPROVED,
+      [TemplateRegistryAPI.SEARCH_CRITERIA_CATEGORIES]: TEMPLATE_CATEGORIES,
+      [TemplateRegistryAPI.SEARCH_CRITERIA_EXTENSIONS]: TemplateRegistryAPI.SEARCH_CRITERIA_FILTER_NONE
+    }
+
+    // an optional OrderBy Criteria object
+    const orderByCriteria = {
+      [TemplateRegistryAPI.ORDER_BY_CRITERIA_PUBLISH_DATE]: TemplateRegistryAPI.ORDER_BY_CRITERIA_SORT_DESC
+    }
+
+    return [searchCriteria, orderByCriteria]
   }
 }
 
@@ -63,11 +101,15 @@ AddEventCommand.flags = {
     char: 'y'
   }),
   extension: Flags.string({
-    description: 'Add actions to a specific extension',
+    description: 'Add events to a specific extension',
     char: 'e',
     multiple: false,
     parse: str => [str]
   }),
+  'experimental-allow-events-templates': Flags.boolean({
+    description: 'Feature flag to enable events templates. NOTE: skip-prompt will have no effect if this flag is enabled.',
+    default: false
+  }),
   ...AddCommand.flags
 }