@verifiquemos/sdk 0.1.5 → 0.1.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/CHANGELOG.md +22 -0
- package/README.md +16 -7
- package/dist/index.d.mts +301 -301
- package/dist/index.d.ts +301 -301
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,28 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to `@verifiquemos/sdk` will be documented here.
|
|
4
4
|
|
|
5
|
+
## [0.1.7] - 2026-05-28
|
|
6
|
+
|
|
7
|
+
Generated-types release — no functional changes.
|
|
8
|
+
|
|
9
|
+
### Internal
|
|
10
|
+
- `src/generated.ts` regenerated from `verifiquemos-api/openapi.json`
|
|
11
|
+
(api 0.22.4). The api cycle 0.22.0 → 0.22.4 made no endpoint
|
|
12
|
+
signature or response-shape changes; the +1031/-1031 diff is fully
|
|
13
|
+
symmetric — `openapi-typescript` re-emits types in source order after
|
|
14
|
+
the OpenAPI top-level keys were reordered upstream. No consumer
|
|
15
|
+
should see a behavior change.
|
|
16
|
+
|
|
17
|
+
## [0.1.6] - 2026-05-26
|
|
18
|
+
|
|
19
|
+
Documentation release — no functional changes.
|
|
20
|
+
|
|
21
|
+
### Internal
|
|
22
|
+
- README adds a Requirements section (Node >=20, npm >=10) and documents
|
|
23
|
+
the publish gate explicitly — push a `v*` tag, the Azure pipeline runs
|
|
24
|
+
`npm publish --access public` after `prepublishOnly` (typecheck + test
|
|
25
|
+
+ build). CI invariants unchanged.
|
|
26
|
+
|
|
5
27
|
## [0.1.5] - 2026-05-25
|
|
6
28
|
|
|
7
29
|
Documentation and tooling release — 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
|
|
@@ -76,6 +81,8 @@ The SDK follows semver. Major version bumps mirror major API contract changes; m
|
|
|
76
81
|
|
|
77
82
|
- API reference: <https://api.verifiquemos.com/scalar>
|
|
78
83
|
- Developer portal: <https://verifiquemos.com/developers>
|
|
84
|
+
- Runnable examples: [`examples/`](./examples/)
|
|
85
|
+
- Release notes: [`CHANGELOG.md`](./CHANGELOG.md)
|
|
79
86
|
|
|
80
87
|
## Support
|
|
81
88
|
|
|
@@ -84,19 +91,21 @@ The SDK follows semver. Major version bumps mirror major API contract changes; m
|
|
|
84
91
|
## Development
|
|
85
92
|
|
|
86
93
|
```bash
|
|
87
|
-
|
|
94
|
+
cd verifiquemos-sdk-typescript
|
|
88
95
|
npm install
|
|
89
|
-
npm test # vitest
|
|
90
|
-
npm run lint # eslint
|
|
91
|
-
npm run typecheck
|
|
92
|
-
npm run build # tsup → dist/ (ESM + CJS +
|
|
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)
|
|
93
100
|
|
|
94
101
|
# src/generated.ts se genera desde el OpenAPI del API. No editarlo a mano;
|
|
95
|
-
# regenerar tras cambios de contrato:
|
|
102
|
+
# regenerar tras cambios de contrato (requiere el repo hermano ../verifiquemos-api):
|
|
96
103
|
npm run regen-types # lee ../verifiquemos-api/openapi.json
|
|
97
104
|
```
|
|
98
105
|
|
|
99
|
-
|
|
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).
|
|
100
109
|
|
|
101
110
|
## License
|
|
102
111
|
|