Helper to turn a OpenWhisk web action into a express request which can be handled with normal\nexpress handlers.
\nExpressify maps the query and most of action params to req.query.\nThe original action params are available under req.owActionParams.
Usage:
\nconst { expressify, errorHandler } = require('@adobe/openwhisk-action-utils');\n\nasync function main(params) {\n const app = express();\n app.use(cookieParser());\n app.use(express.static('static'));\n app.get('/', homepageHandler);\n app.get('/ping', pingHandler);\n app.use(errorHandler(log));\n\n return expressify(app)(params);\n}Helper functions for expressified actions.
\nUsage:
\nconst {\n expressify, logRequest, errorHandler, asyncHandler, cacheControl, createBunyanLogger,\n} = require('@adobe/openwhisk-action-utils');\n\nasync function startHandler(params, req, res) {\n res.send('Hello, world.');\n}\nasync function main(params) {\n const log = createBunyanLogger();\n const app = express();\n app.use(logRequest(log));\n app.use(cacheControl());\n app.get('/', asyncHandler(startHandler));\n app.get('/ping', asyncHandler(pingHandler));\n app.use(errorHandler(log));\n\n return expressify(app)(params);\n}Helper function to easily chain OpenWhisk actions.
\nUsage:
\nconst { wrap } = require('@adobe/openwhisk-action-utils');\n\nasync main(params) {\n // …my action code…\n}\n\nmodule.exports.main = wrap(main)\n .with(epsagon)\n .with(status)\n .with(logger);Helper class that uses the information in the x-ow-version-lock header to lock the version\nof an openwhisk action.
BunyanLoggerSets up a bunyan logger suitable to use with an openwhisk action. The bunyan logger will\nstream to the given helix logger.
\nActionFunction](#module_wrap..ActionFunction)\nCreates an OpenWhisk action function that uses the express framework to handle the invocation.\n\n**Kind**: inner method of [expressify](#module_expressify) \n**Returns**: [ActionFunction](#module_wrap..ActionFunction) - An action function. \n**See**: https://expressjs.com/en/4x/api.html#app \n\n| Param | Type | Description |\n| --- | --- | --- |\n| app | ExpressApp | The express application |\n\n\n\n## middleware\nHelper functions for expressified actions.\n\n**Usage:**\n\n```js\nconst {\n expressify, logRequest, errorHandler, asyncHandler, cacheControl, createBunyanLogger,\n} = require('@adobe/openwhisk-action-utils');\n\nasync function startHandler(params, req, res) {\n res.send('Hello, world.');\n}\nasync function main(params) {\n const log = createBunyanLogger();\n const app = express();\n app.use(logRequest(log));\n app.use(cacheControl());\n app.get('/', asyncHandler(startHandler));\n app.get('/ping', asyncHandler(pingHandler));\n app.use(errorHandler(log));\n\n return expressify(app)(params);\n}\n```\n\n\n* [middleware](#module_middleware)\n * [~errorHandler(log)](#module_middleware..errorHandler) ⇒ ExpressMiddleware\n * [~cacheControl([value])](#module_middleware..cacheControl) ⇒ ExpressMiddleware\n * [~hideHeaders(headerNames)](#module_middleware..hideHeaders) ⇒ ExpressMiddleware\n * [~logRequest(logger, [level])](#module_middleware..logRequest) ⇒ ExpressMiddleware\n * [~asyncHandler(fn)](#module_middleware..asyncHandler) ⇒ ExpressMiddleware\n * [~ActionMiddlewareFunction](#module_middleware..ActionMiddlewareFunction) : function\n\n\n\n### middleware~errorHandler(log) ⇒ ExpressMiddleware\nError handler. Reports errors that happen during the request processing and responds\nwith a `500` if not already set.\n\n**Kind**: inner method of [middleware](#module_middleware) \n**Returns**: ExpressMiddleware - an express middleware function. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| log | BunyanLogger | The logger to use for reporting errors. |\n\n**Example** \n\n```js\n// install last\napp.use(errorHandler(log));\n```\n\n\n### middleware~cacheControl([value]) ⇒ ExpressMiddleware\nEnsures cache control. Sets cache control headers.\n\n**Kind**: inner method of [middleware](#module_middleware) \n**Returns**: ExpressMiddleware - an express middleware function. \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [value] | string | "no-store, private, must-revalidate" | Cache control header value. |\n\n**Example** \n\n```\napp.use(cacheControl());\n```\n\n\n### middleware~hideHeaders(headerNames) ⇒ ExpressMiddleware\nHides headers from enumeration.\n\n**Kind**: inner method of [middleware](#module_middleware) \n**Returns**: ExpressMiddleware - an express middleware function. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| headerNames | Array.<string> | Names of headers to make un-enumerable |\n\n**Example** \n\n```js\n// install first\napp.use(hideHeaders(['x-token', 'authentication'));\napp.use(logRequest(log));\n```\n\n\n### middleware~logRequest(logger, [level]) ⇒ ExpressMiddleware\nCreates a bunyan child logger for the request and adds it to the request. This ensures that\nimportant header values, like `x-request-id` are included in every log entry. It also\nlogs the request and response lines.\n\n**Kind**: inner method of [middleware](#module_middleware) \n**Returns**: ExpressMiddleware - an express middleware function. \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| logger | BunyanLogger | | the bunyan logger |\n| [level] | string | "debug" | the log level to use for logging the request information. |\n\n**Example** \n\n```js\n// install first\napp.use(logRequest(log));\n```\n\n\n### middleware~asyncHandler(fn) ⇒ ExpressMiddleware\nWraps the route middleware so it can catch potential promise rejections\nduring the async invocation.\n\n**Kind**: inner method of [middleware](#module_middleware) \n**Returns**: ExpressMiddleware - an express middleware function. \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fn | ExpressMiddleware | an extended express middleware function |\n\n\n\n### middleware~ActionMiddlewareFunction : function\nExtended middleware function to be use with the [asyncHandler](#module_middleware..asyncHandler).\n\n**Kind**: inner typedef of [middleware](#module_middleware) \n**See**: https://expressjs.com/en/4x/api.html#middleware-callback-function-examples \n\n| Param | Type | Description |\n| --- | --- | --- |\n| params | \\* | The action params |\n| req | ExpressRequest | The express request |\n| res | ExpressResponse | The express response |\n| next | ExpressMiddleware | The next handler in chain. |\n\n\n\n## wrap\nHelper function to easily chain OpenWhisk actions.\n\n**Usage:**\n\n```js\nconst { wrap } = require('@adobe/openwhisk-action-utils');\n\nasync main(params) {\n // …my action code…\n}\n\nmodule.exports.main = wrap(main)\n .with(epsagon)\n .with(status)\n .with(logger);\n```\n\n\n* [wrap](#module_wrap)\n * [~wrap(main)](#module_wrap..wrap) ⇒ WrappableActionFunction\n * [~ActionFunction](#module_wrap..ActionFunction) ⇒ object\n * [~WrappableActionFunction](#module_wrap..WrappableActionFunction) ⇒ object\n * [~WrapFunction](#module_wrap..WrapFunction) ⇒ ActionFunction\n\n\n\n### wrap~wrap(main) ⇒ WrappableActionFunction\nA function that makes your action function (i.e. `main`) wrappable,\nso that using `with` a number of wrappers can be applied. This allows\nyou to export the result as a new function.\n\n**Kind**: inner method of [wrap](#module_wrap) \n**Returns**: WrappableActionFunction - the same main function, now including a `with` method \n\n| Param | Type | Description |\n| --- | --- | --- |\n| main | ActionFunction | the `main` function to prepare for wrapping |\n\n**Example** \n\n```js\nasync main(params) {\n //…my action code…\n}\n\nmodule.exports.main = wrap(main)\n.with(epsagon)\n.with(status)\n.with(logger);\n```\n\nNote: the execution order is that the last wrapper added will be executed first.\n\n\n### wrap~ActionFunction ⇒ object\nThe `main` function of an OpenWhisk action.\n\n**Kind**: inner typedef of [wrap](#module_wrap) \n**Returns**: object - a result \n\n| Param | Type | Description |\n| --- | --- | --- |\n| params | object | the parameters of the action function |\n\n\n\n### wrap~WrappableActionFunction ⇒ object\nAn `ActionFunction` that has been augmented to become wrappable using the `with` method.\n\n**Kind**: inner typedef of [wrap](#module_wrap) \n**Returns**: object - a result \n\n| Param | Type | Description |\n| --- | --- | --- |\n| params | object | the parameters of the action function |\n\n\n\n### wrap~WrapFunction ⇒ ActionFunction\nA function that wraps (and invokes your main function). It can be used\nto decorate inputs or outputs, or to provide additional functionality\nlike logging, tracing, debugging, etc.\n\n**Kind**: inner typedef of [wrap](#module_wrap) \n**Returns**: ActionFunction - a new function with the same signature as your original main function \n\n| Param | Type | Description |\n| --- | --- | --- |\n| main | ActionFunction | your main function |\n| ...opts | \\* | configuration options for the wrapping function |\n\n**Example** \n\n```js\nfunction tracer(fn, level) {\n return (params) => {\n log[level]('enter');\n const ret = fn(params);\n log[level]('exit');\n return ret;\n }\n}\n```\n\n\n## VersionLock\nHelper class that uses the information in the `x-ow-version-lock` header to lock the version\nof an openwhisk action.\n\n**Kind**: global class \n\n* [VersionLock](#VersionLock)\n * [new VersionLock(params, defaults)](#new_VersionLock_new)\n * _instance_\n * [.transformActionURL(url)](#VersionLock+transformActionURL)\n * [.wrapOpenwhisk(ow)](#VersionLock+wrapOpenwhisk) ⇒ OpenWhisk\n * _static_\n * [.X_OW_VERSION_LOCK](#VersionLock.X_OW_VERSION_LOCK) ⇒ string\n\n\n\n### new VersionLock(params, defaults)\nCreates a version lock class.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| params | object | the openwhisk action params |\n| defaults | object | the action name defaults. |\n\n\n\n### versionLock.transformActionURL(url)\nTransforms an action url according to the lock information.\n\n**Kind**: instance method of [VersionLock](#VersionLock) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| url | string | the action url. |\n\n\n\n### versionLock.wrapOpenwhisk(ow) ⇒ OpenWhisk\nEnhances an openwhisk client by wrapping the `invoke` method for automatic action name\nreplacement.\n\n**Kind**: instance method of [VersionLock](#VersionLock) \n**Returns**: OpenWhisk - the wrapped client \n\n| Param | Type | Description |\n| --- | --- | --- |\n| ow | OpenWhisk | openwhisk client |\n\n\n\n### VersionLock.X\\_OW\\_VERSION\\_LOCK ⇒ string\nThe name of the version lock header.\n\n**Kind**: static property of [VersionLock](#VersionLock) \n**Returns**: string - 'x-ow-version-lock' \n\n\n## createBunyanLogger([logger]) ⇒ BunyanLogger\nSets up a bunyan logger suitable to use with an openwhisk action. The bunyan logger will\nstream to the given helix logger.\n\n**Kind**: global function \n**Returns**: BunyanLogger - A bunyan logger \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [logger] | Logger | rootLogger | a helix multi logger. defaults to the helix `rootLogger`. |\n\n","readmeFilename":"README.md"}