@middy/http-partial-response 3.0.0-alpha.3 → 3.0.0-alpha.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -16
- package/index.js +2 -31
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,26 +1,36 @@
|
|
|
1
|
-
# Middy http-partial-response middleware
|
|
2
|
-
|
|
3
|
-
<div align="center">
|
|
4
|
-
<img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.png"/>
|
|
5
|
-
</div>
|
|
6
|
-
|
|
7
1
|
<div align="center">
|
|
2
|
+
<h1>Middy http-partial-response middleware</h1>
|
|
3
|
+
<img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
|
|
8
4
|
<p><strong>HTTP partial response middleware for the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
|
|
9
|
-
</div>
|
|
10
|
-
|
|
11
|
-
<div align="center">
|
|
12
5
|
<p>
|
|
13
|
-
<a href="
|
|
6
|
+
<a href="https://www.npmjs.com/package/@middy/http-partial-response?activeTab=versions">
|
|
14
7
|
<img src="https://badge.fury.io/js/%40middy%2Fhttp-partial-response.svg" alt="npm version" style="max-width:100%;">
|
|
15
8
|
</a>
|
|
9
|
+
<a href="https://packagephobia.com/result?p=@middy/http-partial-response">
|
|
10
|
+
<img src="https://packagephobia.com/badge?p=@middy/http-partial-response" alt="npm install size" style="max-width:100%;">
|
|
11
|
+
</a>
|
|
12
|
+
<a href="https://github.com/middyjs/middy/actions">
|
|
13
|
+
<img src="https://github.com/middyjs/middy/workflows/Tests/badge.svg" alt="GitHub Actions test status badge" style="max-width:100%;">
|
|
14
|
+
</a>
|
|
15
|
+
<br/>
|
|
16
|
+
<a href="https://standardjs.com/">
|
|
17
|
+
<img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style" style="max-width:100%;">
|
|
18
|
+
</a>
|
|
16
19
|
<a href="https://snyk.io/test/github/middyjs/middy">
|
|
17
20
|
<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%;">
|
|
18
21
|
</a>
|
|
19
|
-
<a href="https://
|
|
20
|
-
<img src="https://img.shields.io/
|
|
22
|
+
<a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
|
|
23
|
+
<img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
|
|
21
24
|
</a>
|
|
25
|
+
<a href="https://bestpractices.coreinfrastructure.org/projects/5280">
|
|
26
|
+
<img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices" style="max-width:100%;">
|
|
27
|
+
</a>
|
|
28
|
+
<br/>
|
|
22
29
|
<a href="https://gitter.im/middyjs/Lobby">
|
|
23
|
-
<img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter"
|
|
30
|
+
<img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
|
|
31
|
+
</a>
|
|
32
|
+
<a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
|
|
33
|
+
<img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
|
|
24
34
|
</a>
|
|
25
35
|
</p>
|
|
26
36
|
</div>
|
|
@@ -40,9 +50,7 @@ npm install --save @middy/http-partial-response
|
|
|
40
50
|
|
|
41
51
|
|
|
42
52
|
## Options
|
|
43
|
-
|
|
44
|
-
This middleware does not have any option
|
|
45
|
-
|
|
53
|
+
None
|
|
46
54
|
|
|
47
55
|
## Sample usage
|
|
48
56
|
|
package/index.js
CHANGED
|
@@ -1,32 +1,3 @@
|
|
|
1
|
-
import mask from
|
|
2
|
-
import { normalizeHttpResponse, jsonSafeParse } from '@middy/util'
|
|
1
|
+
import mask from'json-mask';import{normalizeHttpResponse,jsonSafeParse}from'@middy/util';const defaults={filteringKeyName:'fields'};const httpPartialResponseMiddleware=(opts={})=>{const options={...defaults,...opts};const{filteringKeyName}=options;const httpPartialResponseMiddlewareAfter=async request=>{const fields=request.event?.queryStringParameters?.[filteringKeyName];if(!fields)return;normalizeHttpResponse(request);const body=request.response.body;const bodyIsString=typeof body==='string';const parsedBody=jsonSafeParse(body);if(typeof parsedBody!=='object')return;const filteredBody=mask(parsedBody,fields);request.response.body=bodyIsString?JSON.stringify(filteredBody):filteredBody};return{after:httpPartialResponseMiddlewareAfter}};export default httpPartialResponseMiddleware
|
|
3
2
|
|
|
4
|
-
|
|
5
|
-
filteringKeyName: 'fields'
|
|
6
|
-
}
|
|
7
|
-
|
|
8
|
-
const httpPartialResponseMiddleware = (opts = {}) => {
|
|
9
|
-
const options = { ...defaults, ...opts }
|
|
10
|
-
const { filteringKeyName } = options
|
|
11
|
-
|
|
12
|
-
const httpPartialResponseMiddlewareAfter = async (request) => {
|
|
13
|
-
const fields = request.event?.queryStringParameters?.[filteringKeyName]
|
|
14
|
-
if (!fields) return
|
|
15
|
-
|
|
16
|
-
normalizeHttpResponse(request)
|
|
17
|
-
const body = request.response.body
|
|
18
|
-
const bodyIsString = typeof body === 'string'
|
|
19
|
-
|
|
20
|
-
const parsedBody = jsonSafeParse(body)
|
|
21
|
-
if (typeof parsedBody !== 'object') return
|
|
22
|
-
|
|
23
|
-
const filteredBody = mask(parsedBody, fields)
|
|
24
|
-
|
|
25
|
-
request.response.body = bodyIsString ? JSON.stringify(filteredBody) : filteredBody
|
|
26
|
-
}
|
|
27
|
-
|
|
28
|
-
return {
|
|
29
|
-
after: httpPartialResponseMiddlewareAfter
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
export default httpPartialResponseMiddleware
|
|
3
|
+
//# sourceMappingURL=index.js.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@middy/http-partial-response",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.7",
|
|
4
4
|
"description": "Http partial response middleware for the middy framework",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"engines": {
|
|
@@ -49,11 +49,11 @@
|
|
|
49
49
|
},
|
|
50
50
|
"homepage": "https://github.com/middyjs/middy#readme",
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@middy/util": "^3.0.0-alpha.
|
|
52
|
+
"@middy/util": "^3.0.0-alpha.7",
|
|
53
53
|
"json-mask": "1.0.4"
|
|
54
54
|
},
|
|
55
|
-
"gitHead": "
|
|
55
|
+
"gitHead": "5cef39ebe49c201f97d71bb0680004de4b82cb91",
|
|
56
56
|
"devDependencies": {
|
|
57
|
-
"@middy/core": "^3.0.0-alpha.
|
|
57
|
+
"@middy/core": "^3.0.0-alpha.7"
|
|
58
58
|
}
|
|
59
59
|
}
|