opf-validator 0.0.6 → 0.0.8
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 +10 -15
- package/dist/index.d.ts +6 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +35 -40
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
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 * as opf from "opf-validator";
|
|
23
23
|
|
|
24
|
-
const resultado = validateCreatePixPayment({
|
|
24
|
+
const resultado = opf.payments.validateCreatePixPayment({
|
|
25
25
|
data: {
|
|
26
26
|
endToEndId: "E12345678901234567890123456789",
|
|
27
27
|
date: "2025-01-15",
|
|
@@ -68,35 +68,30 @@ 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
|
|
72
|
-
validateHeader,
|
|
73
|
-
validateHeaderRequired,
|
|
74
|
-
validateHeaderOptional,
|
|
75
|
-
validateHeaders
|
|
76
|
-
} from "opf-validator/utils/validateHeaderParameters";
|
|
71
|
+
import * as opf from "opf-validator";
|
|
77
72
|
|
|
78
73
|
// Forma 1: Com override de obrigatoriedade (customizável por endpoint)
|
|
79
|
-
const result = validateHeader('x-fapi-interaction-id', value, false); // Opcional
|
|
80
|
-
const result = validateHeader('Authorization', token, true); // Obrigatório
|
|
74
|
+
const result = opf.validators.validateHeader('x-fapi-interaction-id', value, false); // Opcional
|
|
75
|
+
const result = opf.validators.validateHeader('Authorization', token, true); // Obrigatório
|
|
81
76
|
|
|
82
77
|
// Forma 2: Sempre obrigatório
|
|
83
|
-
const result = validateHeaderRequired('x-fapi-interaction-id', uuid);
|
|
78
|
+
const result = opf.validators.validateHeaderRequired('x-fapi-interaction-id', uuid);
|
|
84
79
|
|
|
85
80
|
// Forma 3: Sempre opcional
|
|
86
|
-
const result = validateHeaderOptional('X-Idempotency-Key', key);
|
|
81
|
+
const result = opf.validators.validateHeaderOptional('X-Idempotency-Key', key);
|
|
87
82
|
|
|
88
83
|
// Validar todos os headers de uma requisição
|
|
89
|
-
const result = validateHeaders(request.headers);
|
|
84
|
+
const result = opf.validators.validateHeaders(request.headers);
|
|
90
85
|
```
|
|
91
86
|
|
|
92
87
|
**Exemplo com Express:**
|
|
93
88
|
|
|
94
89
|
```typescript
|
|
95
90
|
import express from 'express';
|
|
96
|
-
import
|
|
91
|
+
import * as opf from 'opf-validator';
|
|
97
92
|
|
|
98
93
|
app.post('/api/payments', (req, res) => {
|
|
99
|
-
const validation = validateHeaders(req.headers);
|
|
94
|
+
const validation = opf.validators.validateHeaders(req.headers);
|
|
100
95
|
if (!validation.isValid) {
|
|
101
96
|
return res.status(400).json(validation.errors);
|
|
102
97
|
}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
export * from "./consent";
|
|
2
|
-
export * from "./
|
|
3
|
-
export * from "./payments";
|
|
4
|
-
export
|
|
5
|
-
export
|
|
6
|
-
export
|
|
1
|
+
export * as consent from "./consent";
|
|
2
|
+
export * as payments from "./payments";
|
|
3
|
+
export * as recurringPayments from "./recurring-payments";
|
|
4
|
+
export * as errors from "./utils/openFinanceErrors";
|
|
5
|
+
export * as validators from "./utils/validationHelpers";
|
|
6
|
+
export * as responses from "./utils/successResponses";
|
|
7
7
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAGrC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAGvC,OAAO,KAAK,iBAAiB,MAAM,sBAAsB,CAAC;AAO1D,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AAGpD,OAAO,KAAK,UAAU,MAAM,2BAA2B,CAAC;AAGxD,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// ============================================================================
|
|
3
|
-
//
|
|
3
|
+
// MODULE NAMESPACES
|
|
4
4
|
// ============================================================================
|
|
5
5
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
6
|
if (k2 === undefined) k2 = k;
|
|
@@ -13,48 +13,43 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
|
|
|
13
13
|
if (k2 === undefined) k2 = k;
|
|
14
14
|
o[k2] = m[k];
|
|
15
15
|
}));
|
|
16
|
-
var
|
|
17
|
-
|
|
18
|
-
}
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
19
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
-
exports.
|
|
39
|
+
exports.responses = exports.validators = exports.errors = exports.recurringPayments = exports.payments = exports.consent = void 0;
|
|
21
40
|
// Consent Module
|
|
22
|
-
|
|
23
|
-
// Recurring Payments Module
|
|
24
|
-
__exportStar(require("./recurring-payments"), exports);
|
|
41
|
+
exports.consent = __importStar(require("./consent"));
|
|
25
42
|
// Payments Module
|
|
26
|
-
|
|
43
|
+
exports.payments = __importStar(require("./payments"));
|
|
44
|
+
// Recurring Payments Module
|
|
45
|
+
exports.recurringPayments = __importStar(require("./recurring-payments"));
|
|
46
|
+
// ============================================================================
|
|
47
|
+
// UTILITIES NAMESPACES
|
|
48
|
+
// ============================================================================
|
|
27
49
|
// Error Standards
|
|
28
|
-
|
|
29
|
-
Object.defineProperty(exports, "createError", { enumerable: true, get: function () { return openFinanceErrors_1.createError; } });
|
|
30
|
-
Object.defineProperty(exports, "CommonErrors", { enumerable: true, get: function () { return openFinanceErrors_1.CommonErrors; } });
|
|
31
|
-
Object.defineProperty(exports, "ConsentErrorCodes", { enumerable: true, get: function () { return openFinanceErrors_1.ConsentErrorCodes; } });
|
|
32
|
-
Object.defineProperty(exports, "PaymentConsentErrorCodes", { enumerable: true, get: function () { return openFinanceErrors_1.PaymentConsentErrorCodes; } });
|
|
50
|
+
exports.errors = __importStar(require("./utils/openFinanceErrors"));
|
|
33
51
|
// Validation Helpers
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
Object.defineProperty(exports, "validateDocumentIdentification", { enumerable: true, get: function () { return validationHelpers_1.validateDocumentIdentification; } });
|
|
38
|
-
Object.defineProperty(exports, "validateDocumentType", { enumerable: true, get: function () { return validationHelpers_1.validateDocumentType; } });
|
|
39
|
-
Object.defineProperty(exports, "validateDate", { enumerable: true, get: function () { return validationHelpers_1.validateDate; } });
|
|
40
|
-
Object.defineProperty(exports, "validateDateTime", { enumerable: true, get: function () { return validationHelpers_1.validateDateTime; } });
|
|
41
|
-
Object.defineProperty(exports, "validateTimeFormat", { enumerable: true, get: function () { return validationHelpers_1.validateTimeFormat; } });
|
|
42
|
-
Object.defineProperty(exports, "validateAmount", { enumerable: true, get: function () { return validationHelpers_1.validateAmount; } });
|
|
43
|
-
Object.defineProperty(exports, "validateCurrency", { enumerable: true, get: function () { return validationHelpers_1.validateCurrency; } });
|
|
44
|
-
Object.defineProperty(exports, "validateISPB", { enumerable: true, get: function () { return validationHelpers_1.validateISPB; } });
|
|
45
|
-
Object.defineProperty(exports, "validateAccountNumber", { enumerable: true, get: function () { return validationHelpers_1.validateAccountNumber; } });
|
|
46
|
-
Object.defineProperty(exports, "validateIssuer", { enumerable: true, get: function () { return validationHelpers_1.validateIssuer; } });
|
|
47
|
-
Object.defineProperty(exports, "validateAccountType", { enumerable: true, get: function () { return validationHelpers_1.validateAccountType; } });
|
|
48
|
-
Object.defineProperty(exports, "validateEnum", { enumerable: true, get: function () { return validationHelpers_1.validateEnum; } });
|
|
49
|
-
Object.defineProperty(exports, "validateString", { enumerable: true, get: function () { return validationHelpers_1.validateString; } });
|
|
50
|
-
Object.defineProperty(exports, "validateObjectType", { enumerable: true, get: function () { return validationHelpers_1.validateObjectType; } });
|
|
51
|
-
Object.defineProperty(exports, "validateEndToEndId", { enumerable: true, get: function () { return validationHelpers_1.validateEndToEndId; } });
|
|
52
|
-
Object.defineProperty(exports, "validateTransactionIdentification", { enumerable: true, get: function () { return validationHelpers_1.validateTransactionIdentification; } });
|
|
53
|
-
Object.defineProperty(exports, "validateTimeZoneOffset", { enumerable: true, get: function () { return validationHelpers_1.validateTimeZoneOffset; } });
|
|
54
|
-
Object.defineProperty(exports, "validateScreenDimensions", { enumerable: true, get: function () { return validationHelpers_1.validateScreenDimensions; } });
|
|
55
|
-
Object.defineProperty(exports, "validateHeaders", { enumerable: true, get: function () { return validationHelpers_1.validateHeaders; } });
|
|
56
|
-
Object.defineProperty(exports, "validateHeader", { enumerable: true, get: function () { return validationHelpers_1.validateHeader; } });
|
|
57
|
-
Object.defineProperty(exports, "validateHeaderRequired", { enumerable: true, get: function () { return validationHelpers_1.validateHeaderRequired; } });
|
|
58
|
-
Object.defineProperty(exports, "validateHeaderOptional", { enumerable: true, get: function () { return validationHelpers_1.validateHeaderOptional; } });
|
|
59
|
-
Object.defineProperty(exports, "HEADER_VALIDATION_RULES", { enumerable: true, get: function () { return validationHelpers_1.HEADER_VALIDATION_RULES; } });
|
|
52
|
+
exports.validators = __importStar(require("./utils/validationHelpers"));
|
|
53
|
+
// Success Response Types
|
|
54
|
+
exports.responses = __importStar(require("./utils/successResponses"));
|
|
60
55
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,+EAA+E;AAC/E,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,+EAA+E;AAC/E,oBAAoB;AACpB,+EAA+E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE/E,iBAAiB;AACjB,qDAAqC;AAErC,kBAAkB;AAClB,uDAAuC;AAEvC,4BAA4B;AAC5B,0EAA0D;AAE1D,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E,kBAAkB;AAClB,oEAAoD;AAEpD,qBAAqB;AACrB,wEAAwD;AAExD,yBAAyB;AACzB,sEAAsD"}
|