@verifiquemos/sdk 0.1.4 → 0.1.6
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/CHANGELOG.md +21 -0
- package/README.md +30 -5
- package/package.json +7 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to `@verifiquemos/sdk` will be documented here.
|
|
4
4
|
|
|
5
|
+
## [0.1.6] - 2026-05-26
|
|
6
|
+
|
|
7
|
+
Documentation release — no functional changes.
|
|
8
|
+
|
|
9
|
+
### Internal
|
|
10
|
+
- README adds a Requirements section (Node >=20, npm >=10) and documents
|
|
11
|
+
the publish gate explicitly — push a `v*` tag, the Azure pipeline runs
|
|
12
|
+
`npm publish --access public` after `prepublishOnly` (typecheck + test
|
|
13
|
+
+ build). CI invariants unchanged.
|
|
14
|
+
|
|
15
|
+
## [0.1.5] - 2026-05-25
|
|
16
|
+
|
|
17
|
+
Documentation and tooling release — no functional changes.
|
|
18
|
+
|
|
19
|
+
### Fixed
|
|
20
|
+
- README: corrected the `validations.create` example to match the API — `cui` is extracted from the DPI via OCR (not a parameter), `dpiFile` replaces `dpiFront`/`dpiBack`, and `paisOrigenFondos` takes an ISO-3 code (`GTM`).
|
|
21
|
+
|
|
22
|
+
### Internal
|
|
23
|
+
- Added ESLint 10 (flat config) wired into the scripts, `prepublishOnly` and CI; the generated client is ignored.
|
|
24
|
+
- Added a CLAUDE.md agent guide and an `.env.example` for the examples.
|
|
25
|
+
|
|
5
26
|
## [0.1.4] - 2026-05-25
|
|
6
27
|
|
|
7
28
|
Maintenance release — version aligned with the Python SDK (no functional changes).
|
package/README.md
CHANGED
|
@@ -4,6 +4,11 @@ Official TypeScript SDK for the [Verifiquemos](https://verifiquemos.com) complia
|
|
|
4
4
|
|
|
5
5
|
> KYC, RENAP, OFAC, ONU, Lista Engel, PEP, CPE — for Guatemala-specific compliance, in one API call.
|
|
6
6
|
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- Node.js >= 20
|
|
10
|
+
- ESM and CommonJS both supported (the package ships dual `import` / `require` entry points and `.d.ts` types)
|
|
11
|
+
|
|
7
12
|
## Install
|
|
8
13
|
|
|
9
14
|
```bash
|
|
@@ -19,13 +24,12 @@ const client = new VerifiquemosClient({
|
|
|
19
24
|
apiKey: process.env.VERIFIQUEMOS_API_KEY!,
|
|
20
25
|
});
|
|
21
26
|
|
|
22
|
-
// Submit a validation
|
|
27
|
+
// Submit a validation.
|
|
28
|
+
// cui is NOT a parameter — it is extracted from the DPI via OCR.
|
|
23
29
|
const created = await client.validations.create({
|
|
24
|
-
cui: "1234567890101",
|
|
25
30
|
naturalezaCliente: "individual",
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
dpiBack: dpiBackBlob,
|
|
31
|
+
paisOrigenFondos: "GTM",
|
|
32
|
+
dpiFile: dpiBlob, // Blob of the DPI image
|
|
29
33
|
});
|
|
30
34
|
|
|
31
35
|
// Poll until done
|
|
@@ -77,11 +81,32 @@ The SDK follows semver. Major version bumps mirror major API contract changes; m
|
|
|
77
81
|
|
|
78
82
|
- API reference: <https://api.verifiquemos.com/scalar>
|
|
79
83
|
- Developer portal: <https://verifiquemos.com/developers>
|
|
84
|
+
- Runnable examples: [`examples/`](./examples/)
|
|
85
|
+
- Release notes: [`CHANGELOG.md`](./CHANGELOG.md)
|
|
80
86
|
|
|
81
87
|
## Support
|
|
82
88
|
|
|
83
89
|
- Email: <soporte@verifiquemos.com>
|
|
84
90
|
|
|
91
|
+
## Development
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
cd verifiquemos-sdk-typescript
|
|
95
|
+
npm install
|
|
96
|
+
npm test # vitest (mock fetch in-memory)
|
|
97
|
+
npm run lint # eslint 10 (flat config; ignora src/generated.ts)
|
|
98
|
+
npm run typecheck # tsc --noEmit
|
|
99
|
+
npm run build # tsup → dist/ (ESM .js + CJS .cjs + .d.ts)
|
|
100
|
+
|
|
101
|
+
# src/generated.ts se genera desde el OpenAPI del API. No editarlo a mano;
|
|
102
|
+
# regenerar tras cambios de contrato (requiere el repo hermano ../verifiquemos-api):
|
|
103
|
+
npm run regen-types # lee ../verifiquemos-api/openapi.json
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
El hook `prepublishOnly` corre `lint + typecheck + test + build` antes de cada `npm publish`, asi que las publicaciones fallan rapido si alguno falla.
|
|
107
|
+
|
|
108
|
+
Publicacion a npm: el push de un tag git `v<version>` dispara el pipeline (`npm publish --access public`). Ver [`CHANGELOG.md`](./CHANGELOG.md).
|
|
109
|
+
|
|
85
110
|
## License
|
|
86
111
|
|
|
87
112
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@verifiquemos/sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.6",
|
|
4
4
|
"description": "Official TypeScript SDK for the Verifiquemos compliance API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Verifiquemos",
|
|
@@ -26,9 +26,11 @@
|
|
|
26
26
|
"test": "vitest run",
|
|
27
27
|
"test:watch": "vitest",
|
|
28
28
|
"typecheck": "tsc --noEmit",
|
|
29
|
+
"lint": "eslint .",
|
|
30
|
+
"lint:fix": "eslint . --fix",
|
|
29
31
|
"regen-types": "bash scripts/regen-types.sh",
|
|
30
32
|
"example:validation": "tsx examples/create-validation.ts",
|
|
31
|
-
"prepublishOnly": "npm run typecheck && npm run test && npm run build"
|
|
33
|
+
"prepublishOnly": "npm run lint && npm run typecheck && npm run test && npm run build"
|
|
32
34
|
},
|
|
33
35
|
"keywords": [
|
|
34
36
|
"verifiquemos",
|
|
@@ -47,11 +49,14 @@
|
|
|
47
49
|
"openapi-fetch": "^0.13.0"
|
|
48
50
|
},
|
|
49
51
|
"devDependencies": {
|
|
52
|
+
"@eslint/js": "^10.0.1",
|
|
50
53
|
"@types/node": "^22.0.0",
|
|
54
|
+
"eslint": "^10.4.0",
|
|
51
55
|
"openapi-typescript": "^7.4.0",
|
|
52
56
|
"tsup": "^8.3.0",
|
|
53
57
|
"tsx": "^4.19.0",
|
|
54
58
|
"typescript": "^5.7.0",
|
|
59
|
+
"typescript-eslint": "^8.60.0",
|
|
55
60
|
"vitest": "^2.1.0"
|
|
56
61
|
}
|
|
57
62
|
}
|