adobe / aio-cli-plugin-events Goto Github PK

View Code? Open in Web Editor NEW

3.0 23.0 11.0 247 KB

Adobe I/O CLI Plugin to manage Adobe I/O Events

Home Page: https://www.adobe.io

License: Apache License 2.0

JavaScript 99.70% Batchfile 0.30%

adobe-io adobe-io-cli adobe adobe-io-cli-plugin adobe-io-events npm nodejs opendev cli oclif oclif-plugin events

aio-cli-plugin-events's Introduction

Adobe I/O Events CLI Plugin

Adobe I/O Events Plugin for the Adobe I/O CLI

Adobe I/O Events CLI Plugin
Usage
Commands

Usage

$ aio plugins:install -g @adobe/aio-cli-plugin-events
$ # OR
$ aio discover -i
$ aio event --help

Commands

aio event
aio event eventmetadata
aio event eventmetadata create PROVIDERID
aio event eventmetadata delete PROVIDERID [EVENTCODE]
aio event eventmetadata get PROVIDERID EVENTCODE
aio event eventmetadata list PROVIDERID
aio event eventmetadata ls PROVIDERID
aio event eventmetadata update PROVIDERID EVENTCODE
aio event provider
aio event provider create
aio event provider delete PROVIDERID
aio event provider get PROVIDERID
aio event provider list
aio event provider ls
aio event provider update PROVIDERID
aio event reg
aio event reg create BODYJSONFILE
aio event reg delete REGISTRATIONID
aio event reg get REGISTRATIONID
aio event reg list
aio event reg ls
aio event registration
aio event registration create BODYJSONFILE
aio event registration delete REGISTRATIONID
aio event registration get REGISTRATIONID
aio event registration list
aio event registration ls

`aio event`

Manage your Adobe I/O Events

USAGE
  $ aio event [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events

See code: src/commands/event/index.js

`aio event eventmetadata`

Manage your Adobe I/O Events Providers' Event Metadata

USAGE
  $ aio event eventmetadata [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events Providers' Event Metadata

See code: src/commands/event/eventmetadata/index.js

`aio event eventmetadata create PROVIDERID`

Create an Event Metadata for a Provider

USAGE
  $ aio event eventmetadata create PROVIDERID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested eventmetadata event code

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Create an Event Metadata for a Provider

See code: src/commands/event/eventmetadata/create.js

`aio event eventmetadata delete PROVIDERID [EVENTCODE]`

Delete Event Metadata for a Provider

USAGE
  $ aio event eventmetadata delete PROVIDERID [EVENTCODE] [--help] [-v] [--version]

ARGUMENTS
  PROVIDERID  The requested provider ID
  EVENTCODE   The requested eventmetadata event code

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Delete Event Metadata for a Provider

See code: src/commands/event/eventmetadata/delete.js

`aio event eventmetadata get PROVIDERID EVENTCODE`

Get details of an Event Code of a Provider

USAGE
  $ aio event eventmetadata get PROVIDERID EVENTCODE [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID
  EVENTCODE   The requested eventmetadata event code

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Get details of an Event Code of a Provider

See code: src/commands/event/eventmetadata/get.js

`aio event eventmetadata list PROVIDERID`

List all Event Metadata for a Provider

USAGE
  $ aio event eventmetadata list PROVIDERID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List all Event Metadata for a Provider

ALIASES
  $ aio event eventmetadata ls

See code: src/commands/event/eventmetadata/list.js

`aio event eventmetadata ls PROVIDERID`

List all Event Metadata for a Provider

USAGE
  $ aio event eventmetadata ls PROVIDERID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List all Event Metadata for a Provider

ALIASES
  $ aio event eventmetadata ls

`aio event eventmetadata update PROVIDERID EVENTCODE`

Update an Event Metadata for a Provider

USAGE
  $ aio event eventmetadata update PROVIDERID EVENTCODE [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID
  EVENTCODE   The requested eventmetadata event code

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Update an Event Metadata for a Provider

See code: src/commands/event/eventmetadata/update.js

`aio event provider`

Manage your Adobe I/O Events Providers

USAGE
  $ aio event provider [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events Providers

See code: src/commands/event/provider/index.js

`aio event provider create`

Create a new Provider

USAGE
  $ aio event provider create [--help] [-v] [--version] [-j | -y]

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Create a new Provider

See code: src/commands/event/provider/create.js

`aio event provider delete PROVIDERID`

Delete Provider by id

USAGE
  $ aio event provider delete PROVIDERID [--help] [-v] [--version]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Delete Provider by id

See code: src/commands/event/provider/delete.js

`aio event provider get PROVIDERID`

Get details of Provider by id

USAGE
  $ aio event provider get PROVIDERID [--help] [-v] [--version] [--fetchEventMetadata] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -j, --json            Output json
  -v, --verbose         Verbose output
  -y, --yml             Output yml
  --fetchEventMetadata  Fetch event metadata with provider
  --help                Show help
  --version             Show version

DESCRIPTION
  Get details of Provider by id

See code: src/commands/event/provider/get.js

`aio event provider list`

Get list of all Providers for the Organization

USAGE
  $ aio event provider list [--help] [-v] [--version] [--fetchEventMetadata] [--providerMetadataId <value> | -p <value>]
    [--instanceId <value>] [-j | -y]

FLAGS
  -j, --json                            Output json
  -p, --providerMetadataIds=<value>...  Filter providers for org by list of provider metadata ids
  -v, --verbose                         Verbose output
  -y, --yml                             Output yml
  --fetchEventMetadata                  Fetch event metadata with provider
  --help                                Show help
  --instanceId=<value>                  Filter providers for org by provider metadata id (and instance id if applicable)
  --providerMetadataId=<value>          Filter providers for org by provider metadata id (and instance id if applicable)
  --version                             Show version

DESCRIPTION
  Get list of all Providers for the Organization

ALIASES
  $ aio event provider ls

See code: src/commands/event/provider/list.js

`aio event provider ls`

Get list of all Providers for the Organization

USAGE
  $ aio event provider ls [--help] [-v] [--version] [--fetchEventMetadata] [--providerMetadataId <value> | -p <value>]
    [--instanceId <value>] [-j | -y]

FLAGS
  -j, --json                            Output json
  -p, --providerMetadataIds=<value>...  Filter providers for org by list of provider metadata ids
  -v, --verbose                         Verbose output
  -y, --yml                             Output yml
  --fetchEventMetadata                  Fetch event metadata with provider
  --help                                Show help
  --instanceId=<value>                  Filter providers for org by provider metadata id (and instance id if applicable)
  --providerMetadataId=<value>          Filter providers for org by provider metadata id (and instance id if applicable)
  --version                             Show version

DESCRIPTION
  Get list of all Providers for the Organization

ALIASES
  $ aio event provider ls

`aio event provider update PROVIDERID`

Update an existing Provider

USAGE
  $ aio event provider update PROVIDERID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  PROVIDERID  The requested provider ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Update an existing Provider

See code: src/commands/event/provider/update.js

`aio event reg`

Manage your Adobe I/O Events Registrations

USAGE
  $ aio event reg [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events Registrations

ALIASES
  $ aio event reg

`aio event reg create BODYJSONFILE`

Create a new Event Registration in your Workspace

USAGE
  $ aio event reg create BODYJSONFILE [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  BODYJSONFILE
      Path to a file in JSON format with the information to create a new Event Registration.
      The JSON should follow the following format:
      {
      "name": "<event registration name>",
      "description": "<event registration description>",
      "delivery_type": "webhook|webhook_batch|journal",
      "webhook_url": "<webhook URL responding to challenge>",
      "events_of_interest": [{
      "provider_id": "<event provider id>",
      "event_code": "<event provider event_code metadata>"
      }, { /* ...more events */ }]
      }

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Create a new Event Registration in your Workspace

ALIASES
  $ aio event reg create

`aio event reg delete REGISTRATIONID`

Delete Registration

USAGE
  $ aio event reg delete REGISTRATIONID [--help] [-v] [--version]

ARGUMENTS
  REGISTRATIONID  The requested registration ID

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Delete Registration

ALIASES
  $ aio event reg delete

`aio event reg get REGISTRATIONID`

Get an Event Registration in your Workspace

USAGE
  $ aio event reg get REGISTRATIONID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  REGISTRATIONID  The requested registration ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Get an Event Registration in your Workspace

ALIASES
  $ aio event reg get

`aio event reg list`

List your Event Registrations in your Workspace

USAGE
  $ aio event reg list [--help] [-v] [--version] [-j | -y]

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List your Event Registrations in your Workspace

ALIASES
  $ aio event registration ls
  $ aio event reg list
  $ aio event reg ls

`aio event reg ls`

List your Event Registrations in your Workspace

USAGE
  $ aio event reg ls [--help] [-v] [--version] [-j | -y]

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List your Event Registrations in your Workspace

ALIASES
  $ aio event registration ls
  $ aio event reg list
  $ aio event reg ls

`aio event registration`

Manage your Adobe I/O Events Registrations

USAGE
  $ aio event registration [--help] [-v] [--version]

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Manage your Adobe I/O Events Registrations

ALIASES
  $ aio event reg

See code: src/commands/event/registration/index.js

`aio event registration create BODYJSONFILE`

Create a new Event Registration in your Workspace

USAGE
  $ aio event registration create BODYJSONFILE [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  BODYJSONFILE
      Path to a file in JSON format with the information to create a new Event Registration.
      The JSON should follow the following format:
      {
      "name": "<event registration name>",
      "description": "<event registration description>",
      "delivery_type": "webhook|webhook_batch|journal",
      "webhook_url": "<webhook URL responding to challenge>",
      "events_of_interest": [{
      "provider_id": "<event provider id>",
      "event_code": "<event provider event_code metadata>"
      }, { /* ...more events */ }]
      }

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Create a new Event Registration in your Workspace

ALIASES
  $ aio event reg create

See code: src/commands/event/registration/create.js

`aio event registration delete REGISTRATIONID`

Delete Registration

USAGE
  $ aio event registration delete REGISTRATIONID [--help] [-v] [--version]

ARGUMENTS
  REGISTRATIONID  The requested registration ID

FLAGS
  -v, --verbose  Verbose output
  --help         Show help
  --version      Show version

DESCRIPTION
  Delete Registration

ALIASES
  $ aio event reg delete

See code: src/commands/event/registration/delete.js

`aio event registration get REGISTRATIONID`

Get an Event Registration in your Workspace

USAGE
  $ aio event registration get REGISTRATIONID [--help] [-v] [--version] [-j | -y]

ARGUMENTS
  REGISTRATIONID  The requested registration ID

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  Get an Event Registration in your Workspace

ALIASES
  $ aio event reg get

See code: src/commands/event/registration/get.js

`aio event registration list`

List your Event Registrations in your Workspace

USAGE
  $ aio event registration list [--help] [-v] [--version] [-j | -y]

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List your Event Registrations in your Workspace

ALIASES
  $ aio event registration ls
  $ aio event reg list
  $ aio event reg ls

See code: src/commands/event/registration/list.js

`aio event registration ls`

List your Event Registrations in your Workspace

USAGE
  $ aio event registration ls [--help] [-v] [--version] [-j | -y]

FLAGS
  -j, --json     Output json
  -v, --verbose  Verbose output
  -y, --yml      Output yml
  --help         Show help
  --version      Show version

DESCRIPTION
  List your Event Registrations in your Workspace

ALIASES
  $ aio event registration ls
  $ aio event reg list
  $ aio event reg ls

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.

aio-cli-plugin-events's People

Contributors

Stargazers

Watchers

Forkers

moritzraho sangeetha5491 isabella232 fe-lix- shikhartanwar ghas-results

aio-cli-plugin-events's Issues

add instruction to install plugin in README

aio plugins:install @adobe/aio-cli-plugin-events

documentation of delivery_type and webhoook_url

I don't get the point of

 BODYJSONFILE
      Path to a file in JSON format with the information to create a new Event Registration.
      The JSON should follow the following format:
      {
         "name": "<event registration name>",
         "description": "<event registration description>",
         "delivery_type": "WEBHOOK|WEBHOOK_BATCH|JOURNAL",
         "webhook_url": "<webhook URL responding to challenge>"
         "events_of_interest": [{
           "provider_id": "<event provider id>"
           "event_code": "<event provider event_code metadata>"
         }, { <...more events> }]
      }

When I choose "JOURNAL" is "webhoook_url" optional (if so.. please document)
I thought that each provider registration implicitly creates a Journal. Where is the point in creating a Journal Event Registration?

`TypeError: Help is not a constructor` on all event command.

Expected Behaviour

Running aio event should print the help page of the aio event plugin.

Actual Behaviour

$ aio event
    TypeError: Help is not a constructor

Steps to Reproduce

$ npm install -g @adobe/aio-cli 
[...]
$  aio plugins install @adobe/aio-cli-plugin-events
Installing plugin @adobe/aio-cli-plugin-events... installed v1.1.5
$ aio event
    TypeError: Help is not a constructor
$ aio plugins
@adobe/aio-cli-plugin-events 1.1.

Platform and Version

$ npm -v
8.5.1
$ node -v
v17.6.0

Logs taken while reproducing problem

TypeError: Help is not a constructor
(node:74901) WARNING: Exited the environment with code 1
    at exit (node:internal/process/per_thread:194:13)
    at /opt/homebrew/lib/node_modules/@adobe/aio-cli/node_modules/@oclif/errors/lib/handle.js:28:37

@adobe/aio-lib-ims will require node-12 or greater starting July 14th, 2021

Your module is dependent on @adobe/aio-lib-ims.

Adobe IMS is retiring TLS 1.0 and TLS 1.1 support on July 14th, 2021.
TLSv1.2 is the default for node-12 or higher: https://nodejs.org/api/cli.html#cli_tls_min_v1_2

Therefore any calls to Adobe IMS using @adobe/aio-lib-ims using node-10 will fail after the retirement date above.

This module should impose a minimum requirement of node-12 going forward.

Add this to your package.json:

{
   "engineStrict": true, 
   "engines" : { 
         "node" : ">=12" 
    }
}

needs a `description` field in package.json for `aio discover`

Right now it looks like this:

@adobe/aio-cli-plugin-events        1.1.0     <!-- Copyright 2020 Adobe. Al… July 6, 2020

codecov in Github Action needs to be updated

File .github/workflows/node.js.yml. See https://github.com/adobe/aio-cli-plugin-app/blob/5670908e7ef7ba63c903ee924520eeb018a9e448/.github/workflows/node.js.yml#L32-L36

Better feedback when commands fail

I would suggest, to make the cli commands a bit more consistent, verbose and failsafe.

Consistency: Some aio-cli commands take "json" files as input, some are interactive. It's better to have both options in all commands. If I had to choose, I'd prefer the non-interactive way - because that can be scripted (e.g. for ci/cd)

Failsafe: If Event-Metadata is mandatory, why not have it created with aio event provider create in one command? If there is a usecase for metadata-less providers, this could be done with a flag in the command (--nometadata) .. everything else will yield an error ("please provide metadata")..

Verboseness: The provider create command could create a hint ("Don't forget to register metadata"); the provider list could have a column for "metadata" or "metadata missing".

Verboseness: When registering an event (listener) and the provider does not have metadata or the event-code to be registered is not provided we should not return a 400-bad request but what specifically went wrong. If the underlying API does not provide that information, the client could provide some hints ("please check if the provider has metadata and it aligns with the event metadata you are registering for")

tests are breaking starting with the [email protected] release

Test results: https://github.com/adobe/aio-cli-plugin-events/runs/3750833638?check_suite_focus=true

events plugin: code links in README point to a .ts file

Description

Click on any command link in the README
At the bottom of the command, the See code: link points to .ts file

Expected:

It should point to the actual code file, which ends with a .js file extension

error: credential already exists

Failed to add event to app ..
aio app init
aio app add events

✔ Finished running template @adobe/generator-add-events-generic
 ›   Error: [CoreConsoleAPISDK:ERROR_CREATE_OAUTH_SERVER_TO_SERVER_CREDENTIAL] 409 - Conflict 
 ›   ({"id":"XwuODNm97cd5Nrpw1vtgtfbEhCXQ6RFn","messages":[{"template":"ERR_MSG_CONFLICT","message":"Credential already exists"}]})

npm publish failing

via Github Actions token publish. Most probably 2FA needs to be turned off for the repo.

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.