opf-validator 0.0.8 → 0.0.9
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 +15 -10
- package/package.json +2 -51
package/README.md
CHANGED
|
@@ -19,9 +19,9 @@ npm install opf-validator
|
|
|
19
19
|
## Uso Rápido
|
|
20
20
|
|
|
21
21
|
```typescript
|
|
22
|
-
import
|
|
22
|
+
import { validateCreatePixPayment } from "opf-validator/payments";
|
|
23
23
|
|
|
24
|
-
const resultado =
|
|
24
|
+
const resultado = validateCreatePixPayment({
|
|
25
25
|
data: {
|
|
26
26
|
endToEndId: "E12345678901234567890123456789",
|
|
27
27
|
date: "2025-01-15",
|
|
@@ -68,30 +68,35 @@ if (resultado.isValid) {
|
|
|
68
68
|
Os headers são validados conforme especificações da Open Finance Brasil. Há três formas de validação:
|
|
69
69
|
|
|
70
70
|
```typescript
|
|
71
|
-
import
|
|
71
|
+
import {
|
|
72
|
+
validateHeader,
|
|
73
|
+
validateHeaderRequired,
|
|
74
|
+
validateHeaderOptional,
|
|
75
|
+
validateHeaders
|
|
76
|
+
} from "opf-validator/utils/validateHeaderParameters";
|
|
72
77
|
|
|
73
78
|
// Forma 1: Com override de obrigatoriedade (customizável por endpoint)
|
|
74
|
-
const result =
|
|
75
|
-
const result =
|
|
79
|
+
const result = validateHeader('x-fapi-interaction-id', value, false); // Opcional
|
|
80
|
+
const result = validateHeader('Authorization', token, true); // Obrigatório
|
|
76
81
|
|
|
77
82
|
// Forma 2: Sempre obrigatório
|
|
78
|
-
const result =
|
|
83
|
+
const result = validateHeaderRequired('x-fapi-interaction-id', uuid);
|
|
79
84
|
|
|
80
85
|
// Forma 3: Sempre opcional
|
|
81
|
-
const result =
|
|
86
|
+
const result = validateHeaderOptional('X-Idempotency-Key', key);
|
|
82
87
|
|
|
83
88
|
// Validar todos os headers de uma requisição
|
|
84
|
-
const result =
|
|
89
|
+
const result = validateHeaders(request.headers);
|
|
85
90
|
```
|
|
86
91
|
|
|
87
92
|
**Exemplo com Express:**
|
|
88
93
|
|
|
89
94
|
```typescript
|
|
90
95
|
import express from 'express';
|
|
91
|
-
import
|
|
96
|
+
import { validateHeaders } from 'opf-validator/utils/validateHeaderParameters';
|
|
92
97
|
|
|
93
98
|
app.post('/api/payments', (req, res) => {
|
|
94
|
-
const validation =
|
|
99
|
+
const validation = validateHeaders(req.headers);
|
|
95
100
|
if (!validation.isValid) {
|
|
96
101
|
return res.status(400).json(validation.errors);
|
|
97
102
|
}
|
package/package.json
CHANGED
|
@@ -1,58 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "opf-validator",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.9",
|
|
4
4
|
"main": "dist/index.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
|
-
"files": [
|
|
7
|
-
"dist"
|
|
8
|
-
],
|
|
9
|
-
"exports": {
|
|
10
|
-
".": {
|
|
11
|
-
"import": "./dist/index.js",
|
|
12
|
-
"require": "./dist/index.js",
|
|
13
|
-
"types": "./dist/index.d.ts"
|
|
14
|
-
},
|
|
15
|
-
"./utils": {
|
|
16
|
-
"import": "./dist/utils/index.js",
|
|
17
|
-
"require": "./dist/utils/index.js",
|
|
18
|
-
"types": "./dist/utils/index.d.ts"
|
|
19
|
-
},
|
|
20
|
-
"./utils/*": {
|
|
21
|
-
"import": "./dist/utils/*.js",
|
|
22
|
-
"require": "./dist/utils/*.js",
|
|
23
|
-
"types": "./dist/utils/*.d.ts"
|
|
24
|
-
},
|
|
25
|
-
"./consent": {
|
|
26
|
-
"import": "./dist/consent/index.js",
|
|
27
|
-
"require": "./dist/consent/index.js",
|
|
28
|
-
"types": "./dist/consent/index.d.ts"
|
|
29
|
-
},
|
|
30
|
-
"./consent/*": {
|
|
31
|
-
"import": "./dist/consent/*.js",
|
|
32
|
-
"require": "./dist/consent/*.js",
|
|
33
|
-
"types": "./dist/consent/*.d.ts"
|
|
34
|
-
},
|
|
35
|
-
"./payments": {
|
|
36
|
-
"import": "./dist/payments/index.js",
|
|
37
|
-
"require": "./dist/payments/index.js",
|
|
38
|
-
"types": "./dist/payments/index.d.ts"
|
|
39
|
-
},
|
|
40
|
-
"./payments/*": {
|
|
41
|
-
"import": "./dist/payments/*.js",
|
|
42
|
-
"require": "./dist/payments/*.js",
|
|
43
|
-
"types": "./dist/payments/*.d.ts"
|
|
44
|
-
},
|
|
45
|
-
"./recurring-payments": {
|
|
46
|
-
"import": "./dist/recurring-payments/index.js",
|
|
47
|
-
"require": "./dist/recurring-payments/index.js",
|
|
48
|
-
"types": "./dist/recurring-payments/index.d.ts"
|
|
49
|
-
},
|
|
50
|
-
"./recurring-payments/*": {
|
|
51
|
-
"import": "./dist/recurring-payments/*.js",
|
|
52
|
-
"require": "./dist/recurring-payments/*.js",
|
|
53
|
-
"types": "./dist/recurring-payments/*.d.ts"
|
|
54
|
-
}
|
|
55
|
-
},
|
|
6
|
+
"files": ["dist"],
|
|
56
7
|
"scripts": {
|
|
57
8
|
"build": "tsc",
|
|
58
9
|
"test": "jest",
|