npm install @adobe/aio-lib-runtime

1. Initialize the SDK

   const sdk = require('@adobe/aio-lib-runtime')
   
   async function sdkTest() {
     //initialize sdk. Takes in OpenwhiskOptions
     const client = await sdk.init({ apihost: 'https://adobeioruntime.net', api_key: 'your_auth_key', namespace: 'your_runtime_namespace' })
   }

2. Call methods using the initialized SDK

   const sdk = require('@adobe/aio-lib-runtime')
   
   async function sdkTest() {
     //initialize sdk. Takes in OpenwhiskOptions
     const client = await sdk.init({ apihost: 'https://adobeioruntime.net', api_key: 'your_auth_key', namespace: 'your_runtime_namespace' })
   
     // call methods
     try {
       // get... something
       const result = await client.getSomething({})
       console.log(result)
   
     } catch (e) {
       console.error(e)
     }
   }

LogForwarding

Log Forwarding management API

LogForwardingLocalDestinationsProvider

Log Forwarding destination provider

RuntimeAPI

This class provides methods to call your RuntimeAPI APIs. Before calling any method initialize the instance by calling the init method on it with valid options argument

Triggers

getWebpackConfigPath(actionPath, root) ⇒ Promise.<string>

Searches for a webpack config file, starting at the action path and working towards the root of the project. Will return the first one it finds.

loadWebpackConfig(configPath, actionPath, tempBuildDir, outBuildFilename) ⇒ Promise.<object>

Loads a Webpack config file from the config path provided. Sets fields required for Runtime actions. Returns an object that can be passed to the Webpack library.

prepareToBuildAction(action, root, dist) ⇒ Promise.<ActionBuild>

Will return data about an action ready to be built.

zipActions(buildsList, lastBuildsPath, distFolder) ⇒ Array.<string>

Will zip actions. By default only actions which were not built before will be zipped. Last built actions data will be used to validate which action needs zipping.

deployActions(config, [deployConfig], [logFunc]) ⇒ Promise.<object>

runs the command

deployWsk(scriptConfig, manifestContent, logFunc, filterEntities, useForce) ⇒ Promise.<object>

init(options) ⇒ Promise.<OpenwhiskClient>

Returns a Promise that resolves with a new RuntimeAPI object.

printActionLogs(config, logger, limit, filterActions, strip, tail, fetchLogsInterval, startTime) ⇒ object

Prints action logs.

undeployActions(config, [logFunc])

undeployWsk(packageName, manifestContent, owOptions, logger) ⇒ Promise.<void>

getIncludesForAction(action) ⇒ Promise.<Array.<IncludeEntry>>

Gets the list of files matching the patterns defined by action.include

printLogs(activation, strip, logger)

Prints activation logs messages.

printFilteredActionLogs(runtime, logger, limit, filterActions, strip, startTime) ⇒ object

Filters and prints action logs.

getActionEntryFile(pkgJsonPath) ⇒ string

returns path to main function as defined in package.json OR default of index.js note: file MUST exist, caller's responsibility, this method will throw if it does not exist

zip(filePath, out, pathInZip) ⇒ Promise

Zip a file/folder using archiver

createKeyValueObjectFromArray(inputsArray) ⇒ object

returns key value pairs in an object from the key value array supplied. Used to create parameters object.

createKeyValueArrayFromObject(object) ⇒ Array

returns key value array from the object supplied.

safeParse(val) ⇒ object

returns JSON.parse of passed object, but handles exceptions, and numeric strings

createKeyValueArrayFromFlag(flag) ⇒ Array

returns key value array from the parameters supplied. Used to create --param and --annotation key value pairs

createKeyValueArrayFromFile(file) ⇒ Array

returns key value array from the json file supplied. Used to create --param-file and annotation-file key value pairs

createKeyValueObjectFromFlag(flag) ⇒ object

returns key value pairs in an object from the parameters supplied. Used to create --param and --annotation key value pairs

parsePackageName(name) ⇒ object

parses a package name string and returns the namespace and entity name for a package

getKeyValueArrayFromMergedParameters(params, paramFilePath) ⇒ Array

returns key value array from the params and/or param-file supplied with more precendence to params.

getKeyValueObjectFromMergedParameters(params, paramFilePath) ⇒ object

returns key value object from the params and/or param-file supplied with more precendence to params.

createKeyValueObjectFromFile(file) ⇒ object

returns key value pairs from the parameters supplied. Used to create --param-file and --annotation-file key value pairs

createComponentsFromSequence(sequenceAction) ⇒ object

Creates an object representation of a sequence.

createComponentsFromSequence(sequenceAction) ⇒ object

returnUnion(firstObject, secondObject) ⇒ object

Creates a union of two objects

parsePathPattern(path) ⇒ Array

Parse a path pattern

processInputs(input, params) ⇒ object

Process inputs

createKeyValueInput(input) ⇒ object

Create a key-value object from the input

getDeploymentPath() ⇒ string

Get the deployment yaml file path

getManifestPath() ⇒ string

Get the manifest yaml file path

returnDeploymentTriggerInputs(deploymentPackages) ⇒ object

Get the deployment trigger inputs.

returnAnnotations(action) ⇒ object

Get the annotations for an action

createApiRoutes(pkg, pkgName, apiName, allowedActions, allowedSequences, pathOnly) ⇒ Array.<OpenWhiskEntitiesRoute>

Creates an array of route definitions from the given manifest-based package. See https://github.com/apache/openwhisk-wskdeploy/blob/master/parsers/manifest_parser.go#L1187

createSequenceObject(fullName, manifestSequence, packageName) ⇒ OpenWhiskEntitiesAction

Create a sequence object that is compatible with the OpenWhisk API from a parsed manifest object

checkWebFlags(flag) ⇒ object

Check the web flags

createActionObject(fullName, manifestAction) ⇒ OpenWhiskEntitiesAction

Create an action object compatible with the OpenWhisk API from an action object parsed from the manifest.

processPackage(packages, deploymentPackages, deploymentTriggers, params, [namesOnly], [owOptions]) ⇒ OpenWhiskEntities

Process the manifest and deployment content and returns deployment entities.

setPaths(flags) ⇒ DeploymentFileComponents

Get the deployment file components.

deployPackage(entities, ow, logger, imsOrgId)

Deploy all processed entities: can deploy packages, actions, triggers, rules and apis.

undeployPackage(entities, ow, logger)

Undeploy all processed entities: can undeploy packages, actions, triggers, rules and apis. Entity definitions do not need to be complete, only the names are needed for un-deployment.

syncProject(projectName, manifestPath, manifestContent, entities, ow, logger, imsOrgId, deleteEntities)

Sync a project. This is a higher level function that can be used to sync a local manifest with deployed entities.

syncProject doesn't only deploy entities it might also undeploy entities that are not defined in the manifest. This behavior can be disabled via the deleteEntities boolean parameter.

getProjectEntities(project, isProjectHash, ow) ⇒ Promise.<OpenWhiskEntities>

Get deployed entities for a managed project. This methods retrieves all the deployed entities for a given project name or project hash. This only works if the project was deployed using the whisk-managed annotation. This annotation can be set pre-deployement using [addManagedProjectAnnotations](#addmanagedprojectannotations).

Note that returned apis will always be empty as they don't support annotations and hence are not managed as part of a project.

addManagedProjectAnnotations(entities, manifestPath, projectName, projectHash)

Add the whisk-managed annotation to processed entities. This is needed for syncing managed projects.

getProjectHash(manifestContent) ⇒ string

Compute the project hash based on the manifest content string. This is used for syncing managed projects.

findProjectHashOnServer(ow, projectName) ⇒ Promise.<string>

Retrieve the project hash from a deployed managed project.

findProjectHashOnServer(ow, projectName) ⇒ Promise.<string>

Retrieve the project hash from a deployed managed project.

_relApp(root, p) ⇒ string

Path relative to the root

_absApp(root, p) ⇒ string

Absolute path

checkOpenWhiskCredentials(config)

Checks the existence of required openwhisk credentials

getActionUrls(appConfig, isRemoteDev, isLocalDev, legacy) ⇒ object

Returns action URLs based on the manifest config

urlJoin(...args) ⇒ string

Joins url path parts

removeProtocolFromURL(url) ⇒ string

replacePackagePlaceHolder(config) ⇒ object

validateActionRuntime(action)

Checks the validity of nodejs version in action definition and throws an error if invalid.

isSupportedActionKind(action) ⇒ boolean

Checks the validity of nodejs version in action definition returns true if valid.

getActionZipFileName(pkgName, actionName, defaultPkg) ⇒ string

Returns the action's build file name without the .zip extension

getActionNameFromZipFile(zipFile) ⇒ string

Returns the action name based on the zipFile name.

activationLogBanner(logFunc, activation, activationLogs)

Creates an info banner for an activation.

dumpActionsBuiltInfo(lastBuiltActionsPath, actionBuildData, prevBuildData) ⇒ Promise.<boolean>

Will dump the previously actions built data information.

getSupportedServerRuntimes(apihost) ⇒ Array.<string>

Gets a list of the supported runtime kinds from the apihost.

ActionBuild : object

OpenwhiskOptions : object

OpenwhiskRetryOptions : object

OpenwhiskClient : object

ManifestPackages : Array.<ManifestPackage>

The entry point to the information read from the manifest, this can be extracted using setPaths.

ManifestPackage : object

The manifest package definition

ManifestAction : object

The manifest action definition

IncludeEntry : object

ManifestSequence : object

The manifest sequence definition TODO: see https://github.com/apache/openwhisk-wskdeploy/blob/master/specification/html/spec_sequences.md

ManifestTrigger : object

The manifest trigger definition TODO: see https://github.com/apache/openwhisk-wskdeploy/blob/master/specification/html/spec_triggers.md

ManifestRule : object

The manifest rule definition TODO: see https://github.com/apache/openwhisk-wskdeploy/blob/master/specification/html/spec_rules.md

ManifestDependency : object

The manifest dependency definition TODO

OpenWhiskEntities : object

The OpenWhisk entities definitions, which are compatible with the openwhisk node client module. Can be obtained using (processpackage)[#processpackage] (with onlyNames=true for un-deployment)

OpenWhiskEntitiesRoute : object

The api entity definition

OpenWhiskEntitiesAction : object

The action entity definition TODO

OpenWhiskEntitiesRule : object

The rule entity definition TODO

OpenWhiskEntitiesTrigger : object

The trigger entity definition TODO

OpenWhiskEntitiesPackage : object

The package entity definition TODO

DeploymentPackages : Array.<object>

The entry point to the information read from the deployment file, this can be extracted using setPaths. TODO

DeploymentFileComponents : object

Log Forwarding management API

Kind: global class

• LogForwarding
  • .get() ⇒ Promise.<*>
  • .setAdobeIoRuntime() ⇒ Promise.<(*|undefined)>
  • .setAzureLogAnalytics(customerId, sharedKey, logType) ⇒ Promise.<(*|undefined)>
  • .setSplunkHec(host, port, index, hecToken) ⇒ Promise.<(*|undefined)>
  • .getSupportedDestinations() ⇒ Array.<object>
  • .getDestinationSettings(destination) ⇒ Array.<object>
  • .setDestination(destination, config) ⇒ Promise.<*>
  • .getErrors() ⇒ object

Get current Log Forwarding settings

Kind: instance method of LogForwarding
Returns: Promise.<*> - response from get API

Deprecated

Set Log Forwarding to Adobe I/O Runtime (default behavior)

Kind: instance method of LogForwarding
Returns: Promise.<(*|undefined)> - response from set API

Deprecated

Set Log Forwarding to Azure Log Analytics

Kind: instance method of LogForwarding
Returns: Promise.<(*|undefined)> - response from set API

Deprecated

Set Log Forwarding to Splunk HEC

Kind: instance method of LogForwarding
Returns: Promise.<(*|undefined)> - response from set API

Get supported destinations

Kind: instance method of LogForwarding
Returns: Array.<object> - in format: { value: , name: }

Get destination settings

Kind: instance method of LogForwarding
Returns: Array.<object> - in format: { name: , message: [, type: ] }

Configure destination

Kind: instance method of LogForwarding
Returns: Promise.<*> - response from set API

Get log forwarding errors

Kind: instance method of LogForwarding
Returns: object - Errors in format { destination: '', errors: [] }

Log Forwarding destination provider

Kind: global class

• LogForwardingLocalDestinationsProvider
  • .getSupportedDestinations() ⇒ Array.<object>
  • .getDestinationSettings(destination) ⇒ Array.<object>

Get supported destinations

Kind: instance method of LogForwardingLocalDestinationsProvider
Returns: Array.<object> - in format: { value: , name: }

Get destination settings

Kind: instance method of LogForwardingLocalDestinationsProvider
Returns: Array.<object> - in format: { name: , message: [, type: ] }

This class provides methods to call your RuntimeAPI APIs. Before calling any method initialize the instance by calling the init method on it with valid options argument

Kind: global class

Initializes a RuntimeAPI object and returns it.

Kind: instance method of RuntimeAPI
Returns: Promise.<OpenwhiskClient> - a RuntimeAPI object

Kind: global class

• Triggers
  • new Triggers()
  • .create(options) ⇒ Promise.<object>
  • .delete(options) ⇒ Promise.<object>

A class to manage triggers

Creates a trigger and associated feeds

Kind: instance method of Triggers
Returns: Promise.<object> - the result of the create operation

Deletes a trigger and associated feeds

Kind: instance method of Triggers
Returns: Promise.<object> - the result of the delete operation

Searches for a webpack config file, starting at the action path and working towards the root of the project. Will return the first one it finds.

Kind: global function
Returns: Promise.<string> - Webpack config file path, will be 'null' if not found

Loads a Webpack config file from the config path provided. Sets fields required for Runtime actions. Returns an object that can be passed to the Webpack library.

Kind: global function
Returns: Promise.<object> - Webpack config, can be passed to the Webpack library

Will return data about an action ready to be built.

Kind: global function
Returns: Promise.<ActionBuild> - Relevant data for the zip process..

Will zip actions. By default only actions which were not built before will be zipped. Last built actions data will be used to validate which action needs zipping.

Kind: global function
Returns: Array.<string> - Array of zipped actions.

runs the command

Kind: global function
Returns: Promise.<object> - deployedEntities

Kind: global function
Returns: Promise.<object> - deployedEntities

Kind: inner method of deployWsk
Returns: object - package object containing only the filterItems

Returns a Promise that resolves with a new RuntimeAPI object.

Kind: global function
Returns: Promise.<OpenwhiskClient> - a Promise with a RuntimeAPI object

Prints action logs.

Kind: global function
Returns: object - activation timestamp of the last retrieved activation or null

Kind: global function

Kind: global function
Returns: Promise.<void> - void

Gets the list of files matching the patterns defined by action.include

Kind: global function
Returns: Promise.<Array.<IncludeEntry>> - list of files matching the patterns defined by action.include

Prints activation logs messages.

Kind: global function

Filters and prints action logs.

Kind: global function
Returns: object - activation timestamp of the last retrieved activation or null

• printFilteredActionLogs(runtime, logger, limit, filterActions, strip, startTime) ⇒ object
  • ~isSequenceActivation(activation) ⇒ boolean
  • ~printActivationLogs(activation, runtime)
  • ~printSequenceLogs(activation, runtime)
  • ~printLogs(activation, runtime)

Check if an activation entry is for a sequence.

Kind: inner method of printFilteredActionLogs
Returns: boolean - isSequenceActivation

Print activation logs

Kind: inner method of printFilteredActionLogs

Print sequence logs

Kind: inner method of printFilteredActionLogs

Print logs

Kind: inner method of printFilteredActionLogs

returns path to main function as defined in package.json OR default of index.js note: file MUST exist, caller's responsibility, this method will throw if it does not exist

Kind: global function
Returns: string - path to the entry file

Zip a file/folder using archiver

Kind: global function
Returns: Promise - returns with a blank promise when done

returns key value pairs in an object from the key value array supplied. Used to create parameters object.

Kind: global function
Returns: object - An object of key value pairs in this format : {Your key1 : 'Your Value 1' , Your key2: 'Your value 2'}

returns key value array from the object supplied.

Kind: global function
Returns: Array - An array of key value pairs in this format : [{key : 'Your key 1' , value: 'Your value 1'}, {key : 'Your key 2' , value: 'Your value 2'} ]

returns JSON.parse of passed object, but handles exceptions, and numeric strings

Kind: global function
Returns: object - the parsed object

returns key value array from the parameters supplied. Used to create --param and --annotation key value pairs

Kind: global function
Returns: Array - An array of key value pairs in this format : [{key : 'Your key 1' , value: 'Your value 1'}, {key : 'Your key 2' , value: 'Your value 2'} ]

returns key value array from the json file supplied. Used to create --param-file and annotation-file key value pairs

Kind: global function
Returns: Array - An array of key value pairs in this format : [{key : 'Your key 1' , value: 'Your value 1'}, {key : 'Your key 2' , value: 'Your value 2'} ]

returns key value pairs in an object from the parameters supplied. Used to create --param and --annotation key value pairs

Kind: global function
Returns: object - An object of key value pairs in this format : {Your key1 : 'Your Value 1' , Your key2: 'Your value 2'}

parses a package name string and returns the namespace and entity name for a package

Kind: global function
Returns: object - An object { namespace: string, name: string }

returns key value array from the params and/or param-file supplied with more precendence to params.

Kind: global function
Returns: Array - An array of key value pairs in this format : [{key : 'Your key 1' , value: 'Your value 1'}, {key : 'Your key 2' , value: 'Your value 2'} ]

returns key value object from the params and/or param-file supplied with more precendence to params.

Kind: global function
Returns: object - An object of key value pairs in this format : {Your key1 : 'Your Value 1' , Your key2: 'Your value 2'}

returns key value pairs from the parameters supplied. Used to create --param-file and --annotation-file key value pairs

Kind: global function
Returns: object - An object of key value pairs in this format : {Your key1 : 'Your Value 1' , Your key2: 'Your value 2'}

Creates an object representation of a sequence.

Kind: global function
Returns: object - the object representation of the sequence

Deprecated

Kind: global function
Returns: object - the object representation of the sequence

Creates a union of two objects

Kind: global function
Returns: object - the union of both objects

Parse a path pattern

Kind: global function
Returns: Array - array of matches

Process inputs

Kind: global function
Returns: object - the processed inputs

Create a key-value object from the input

Kind: global function
Returns: object - the processed input as a key-value object

Get the deployment yaml file path

Kind: global function
Returns: string - the deployment yaml path

Get the manifest yaml file path

Kind: global function
Returns: string - the manifest yaml path

Get the deployment trigger inputs.

Kind: global function
Returns: object - the deployment trigger inputs

Get the annotations for an action

Kind: global function
Returns: object - the action annotation entities

Creates an array of route definitions from the given manifest-based package. See https://github.com/apache/openwhisk-wskdeploy/blob/master/parsers/manifest_parser.go#L1187

Kind: global function
Returns: Array.<OpenWhiskEntitiesRoute> - the array of route entities

Create a sequence object that is compatible with the OpenWhisk API from a parsed manifest object

Kind: global function
Returns: OpenWhiskEntitiesAction - a sequence object describing the action entity

Check the web flags

Kind: global function
Returns: object - object with the appropriate web flags for an action

Create an action object compatible with the OpenWhisk API from an action object parsed from the manifest.

Kind: global function
Returns: OpenWhiskEntitiesAction - the action entity object

Process the manifest and deployment content and returns deployment entities.

Kind: global function
Returns: OpenWhiskEntities - deployment entities

Get the deployment file components.

Kind: global function
Returns: DeploymentFileComponents - fileComponents

Deploy all processed entities: can deploy packages, actions, triggers, rules and apis.

Kind: global function

Undeploy all processed entities: can undeploy packages, actions, triggers, rules and apis. Entity definitions do not need to be complete, only the names are needed for un-deployment.

Kind: global function

Sync a project. This is a higher level function that can be used to sync a local manifest with deployed entities.

syncProject doesn't only deploy entities it might also undeploy entities that are not defined in the manifest. This behavior can be disabled via the deleteEntities boolean parameter.

Kind: global function

Get deployed entities for a managed project. This methods retrieves all the deployed entities for a given project name or project hash. This only works if the project was deployed using the whisk-managed annotation. This annotation can be set pre-deployement using [addManagedProjectAnnotations](#addmanagedprojectannotations).

Note that returned apis will always be empty as they don't support annotations and hence are not managed as part of a project.

Kind: global function
Returns: Promise.<OpenWhiskEntities> - the deployed project entities

Add the whisk-managed annotation to processed entities. This is needed for syncing managed projects.

Kind: global function

Compute the project hash based on the manifest content string. This is used for syncing managed projects.

Kind: global function
Returns: string - the project hash

Retrieve the project hash from a deployed managed project.

Kind: global function
Returns: Promise.<string> - the project hash, or '' if not found

Deprecated

Retrieve the project hash from a deployed managed project.

Kind: global function
Returns: Promise.<string> - the project hash, or '' if not found

Path relative to the root

Kind: global function
Returns: string - relative path

Absolute path

Kind: global function
Returns: string - absolute path

Checks the existence of required openwhisk credentials

Kind: global function

Returns action URLs based on the manifest config

Kind: global function
Returns: object - urls of actions

Joins url path parts

Kind: global function
Returns: string - joined url

Kind: global function
Returns: string - url

Kind: global function
Returns: object - sanitized config

Deprecated

Checks the validity of nodejs version in action definition and throws an error if invalid.

Kind: global function

Checks the validity of nodejs version in action definition returns true if valid.

Kind: global function
Returns: boolean - true if action kind is supported

Returns the action's build file name without the .zip extension

Kind: global function
Returns: string - name of zip file for the action contents

Returns the action name based on the zipFile name.

Kind: global function
Returns: string - name of the action or empty string.

Creates an info banner for an activation.

Kind: global function

Will dump the previously actions built data information.

Kind: global function
Returns: Promise.<boolean> - If the contentHash already belongs to the deploymentLogs file

Gets a list of the supported runtime kinds from the apihost.

Kind: global function
Returns: Array.<string> - a list of runtime kinds supported by the runtime apihost

Kind: global typedef
Properties

Kind: global typedef
Properties

Kind: global typedef
Properties

Kind: global typedef
Properties

The entry point to the information read from the manifest, this can be extracted using setPaths.

Kind: global typedef

The manifest package definition

Kind: global typedef
Properties

The manifest action definition

Kind: global typedef
Properties

Kind: global typedef
Properties

The manifest sequence definition TODO: see https://github.com/apache/openwhisk-wskdeploy/blob/master/specification/html/spec_sequences.md

Kind: global typedef
Properties

The manifest trigger definition TODO: see https://github.com/apache/openwhisk-wskdeploy/blob/master/specification/html/spec_triggers.md

Kind: global typedef
Properties

The manifest rule definition TODO: see https://github.com/apache/openwhisk-wskdeploy/blob/master/specification/html/spec_rules.md

Kind: global typedef
Properties

The manifest dependency definition TODO

Kind: global typedef
Properties

The OpenWhisk entities definitions, which are compatible with the openwhisk node client module. Can be obtained using (processpackage)[#processpackage] (with onlyNames=true for un-deployment)

Kind: global typedef
Properties

The api entity definition

Kind: global typedef
Properties

The action entity definition TODO

Kind: global typedef
Properties

The rule entity definition TODO

Kind: global typedef
Properties

The trigger entity definition TODO

Kind: global typedef
Properties

The package entity definition TODO

Kind: global typedef
Properties

The entry point to the information read from the deployment file, this can be extracted using setPaths. TODO

Kind: global typedef

Kind: global typedef
Properties

NODE_TLS_REJECT_UNAUTHORIZED=0 <your_call_here>

Prepend the NODE_TLS_REJECT_UNAUTHORIZED environment variable and 0 value to the call that invokes your function, on the command line. This will ignore any certificate errors when connecting to the Openwhisk server. Usage of this is not recommended, but may be necessary in certain corporate environments.

LOG_LEVEL=debug <your_call_here>

Prepend the LOG_LEVEL environment variable and debug value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.

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

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