@middy/ws-response 3.0.0-alpha.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2022 Luciano Mammino, will Farrell and the [Middy team](https://github.com/middyjs/middy/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+# Middy ws-response middleware
+
+<div align="center">
+  <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
+</div>
+
+<div align="center">
+  <p><strong>WebSocket (ws) response middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
+</div>
+
+<div align="center">
+<p>
+  <a href="http://badge.fury.io/js/%40middy%2Fws-response">
+    <img src="https://badge.fury.io/js/%40middy%2Fws-response.svg" alt="npm version" style="max-width:100%;">
+  </a>
+  <a href="https://snyk.io/test/github/middyjs/middy">
+    <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
+  </a>
+  <a href="https://standardjs.com/">
+    <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style"  style="max-width:100%;">
+  </a>
+  <a href="https://gitter.im/middyjs/Lobby">
+    <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"  style="max-width:100%;">
+  </a>
+</p>
+</div>
+
+Post message to WebSocket connection.
+
+## Install
+
+To install this middleware you can use NPM:
+
+```bash
+npm install --save @middy/ws-responder
+```
+
+## Options
+- `AwsClient` (object) (default `AWS.ApiGatewayManagementApi`): AWS.ApiGatewayManagementApi class constructor (e.g. that has been instrumented with AWS XRay). Must be from `aws-sdk` v2.
+- `awsClientOptions` (object) (optional): Options to pass to AWS.ApiGatewayManagementApi class constructor.
+- `awsClientAssumeRole` (string) (optional): Internal key where secrets are stored. See [@middy/sts](/packages/sts/README.md) on to set this.
+- `awsClientCapture` (function) (optional): Enable XRay by passing `captureAWSClient` from `aws-xray-sdk` in.
+- `disablePrefetch` (boolean) (default `false`): On cold start requests will trigger early if they can. Setting `awsClientAssumeRole` disables prefetch.
+
+NOTES:
+- Lambda is required to have IAM permission for `execute-api:ManageConnections`
+- If `awsClientOptions.endpoint` is not set it will be set using `event.requestContext.{domainName,stage}`
+- If response does not contain `ConnectId`, it will be set from `event.requestContext.connectionId`
+
+## Sample usage
+### API Gateway
+```javascript
+import middy from '@middy/core'
+import wsResonse from '@middy/ws-responder'
+
+export const handler = middy((event, context) => {
+  return 'message'
+})
+
+handler
+  .use(wsResonse())
+```
+
+### General
+```javascript
+import middy from '@middy/core'
+import wsResonse from '@middy/ws-responder'
+
+export const handler = middy((event, context) => {
+  return {
+    ConnectionId: '...',
+    Data: 'message'
+  }
+})
+
+handler
+  .use(wsResonse({
+    awsClientOptions: {
+      endpoint: '...'
+    }
+  }))
+```
+
+
+
+## Middy documentation and examples
+
+For more documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).
+
+
+## Contributing
+
+Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).
+
+
+## License
+
+Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 Luciano Mammino, will Farrell, and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
+
+<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
+  <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status"  style="max-width:100%;">
+</a>

package/index.d.ts

@@ -0,0 +1,12 @@
+import { ApiGatewayManagementApi } from 'aws-sdk'
+import middy from '@middy/core'
+import { Options as MiddyOptions } from '@middy/util'
+
+interface Options<S = ApiGatewayManagementApi>
+  extends Pick<MiddyOptions<S, ApiGatewayManagementApi.Types.ClientConfiguration>,
+  'AwsClient' | 'awsClientOptions' | 'awsClientAssumeRole' | 'awsClientCapture' | 'disablePrefetch'> {
+}
+
+declare function wsResponse (options?: Options): middy.MiddlewareObj
+
+export default wsResponse

package/index.js

@@ -0,0 +1,67 @@
+import ApiGatewayManagementApi from 'aws-sdk/clients/apigatewaymanagementapi.js';
+import { canPrefetch, createClient, createPrefetchClient } from '@middy/util';
+const defaults = {
+  AwsClient: ApiGatewayManagementApi,
+  awsClientOptions: {},
+  awsClientAssumeRole: undefined,
+  awsClientCapture: undefined,
+  disablePrefetch: false
+};
+
+const wsResponderMiddleware = opts => {
+  const options = { ...defaults,
+    ...opts
+  };
+  let client;
+
+  if (canPrefetch(options) && options.awsClientOptions.endpoint) {
+    client = createPrefetchClient(options);
+  }
+
+  const wsResponderMiddlewareAfter = async request => {
+    normalizeWsResponse(request);
+    const {
+      response
+    } = request;
+    if (!response.ConnectionId) return;
+
+    if (!options.awsClientOptions.endpoint && request.event.requestContext) {
+      options.awsClientOptions.endpoint = request.event.requestContext.domainName + '/' + request.event.requestContext.stage;
+    }
+
+    if (!client) {
+      client = await createClient(options, request);
+    }
+
+    await client.postToConnection(response).promise();
+    request.response = {
+      statusCode: 200
+    };
+  };
+
+  return {
+    after: wsResponderMiddlewareAfter
+  };
+};
+
+const normalizeWsResponse = request => {
+  var _response, _response2, _response3, _request$event$reques;
+
+  let {
+    response
+  } = request;
+
+  if (response === undefined) {
+    response = {};
+  } else if (((_response = response) === null || _response === void 0 ? void 0 : _response.Data) === undefined && ((_response2 = response) === null || _response2 === void 0 ? void 0 : _response2.ConnectionId) === undefined) {
+    response = {
+      Data: response
+    };
+  }
+
+  (_response3 = response).ConnectionId ?? (_response3.ConnectionId = (_request$event$reques = request.event.requestContext) === null || _request$event$reques === void 0 ? void 0 : _request$event$reques.connectionId);
+  request.response = response;
+  return response;
+};
+
+export default wsResponderMiddleware;

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@middy/ws-response",
+  "version": "3.0.0-alpha.6",
+  "description": "WebSocket response handling middleware for the middy framework",
+  "type": "module",
+  "engines": {
+    "node": ">=14"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": "./index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "test": "npm run test:unit",
+    "test:unit": "ava"
+  },
+  "license": "MIT",
+  "keywords": [
+    "Lambda",
+    "Middleware",
+    "Serverless",
+    "Framework",
+    "AWS",
+    "AWS Lambda",
+    "Middy",
+    "API Gateway",
+    "WebSocket",
+    "PostToConnection"
+  ],
+  "author": {
+    "name": "Middy contributors",
+    "url": "https://github.com/middyjs/middy/graphs/contributors"
+  },
+  "repository": {
+    "type": "git",
+    "url": "github:middyjs/middy",
+    "directory": "packages/sts"
+  },
+  "bugs": {
+    "url": "https://github.com/middyjs/middy/issues"
+  },
+  "homepage": "https://github.com/middyjs/middy#readme",
+  "dependencies": {
+    "@middy/util": "^3.0.0-alpha.6"
+  },
+  "devDependencies": {
+    "@middy/core": "^3.0.0-alpha.6",
+    "aws-sdk": "^2.939.0",
+    "aws-xray-sdk": "^3.3.3"
+  },
+  "gitHead": "176660ed3e0716d6bfb635c77251b301e0e24720"
+}