@verifiquemos/sdk 0.1.4 → 0.1.5

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.
Files changed (3) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +21 -5
  3. package/package.json +7 -2
package/CHANGELOG.md CHANGED
@@ -2,6 +2,17 @@
2
2
 
3
3
  All notable changes to `@verifiquemos/sdk` will be documented here.
4
4
 
5
+ ## [0.1.5] - 2026-05-25
6
+
7
+ Documentation and tooling release — no functional changes.
8
+
9
+ ### Fixed
10
+ - 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`).
11
+
12
+ ### Internal
13
+ - Added ESLint 10 (flat config) wired into the scripts, `prepublishOnly` and CI; the generated client is ignored.
14
+ - Added a CLAUDE.md agent guide and an `.env.example` for the examples.
15
+
5
16
  ## [0.1.4] - 2026-05-25
6
17
 
7
18
  Maintenance release — version aligned with the Python SDK (no functional changes).
package/README.md CHANGED
@@ -19,13 +19,12 @@ const client = new VerifiquemosClient({
19
19
  apiKey: process.env.VERIFIQUEMOS_API_KEY!,
20
20
  });
21
21
 
22
- // Submit a validation
22
+ // Submit a validation.
23
+ // cui is NOT a parameter — it is extracted from the DPI via OCR.
23
24
  const created = await client.validations.create({
24
- cui: "1234567890101",
25
25
  naturalezaCliente: "individual",
26
- paisOrigen: "GT",
27
- dpiFront: dpiFrontBlob,
28
- dpiBack: dpiBackBlob,
26
+ paisOrigenFondos: "GTM",
27
+ dpiFile: dpiBlob, // Blob of the DPI image
29
28
  });
30
29
 
31
30
  // Poll until done
@@ -82,6 +81,23 @@ The SDK follows semver. Major version bumps mirror major API contract changes; m
82
81
 
83
82
  - Email: <soporte@verifiquemos.com>
84
83
 
84
+ ## Development
85
+
86
+ ```bash
87
+ git clone <repo-url> && cd verifiquemos-sdk-typescript
88
+ npm install
89
+ npm test # vitest
90
+ npm run lint # eslint
91
+ npm run typecheck
92
+ npm run build # tsup → dist/ (ESM + CJS + types)
93
+
94
+ # src/generated.ts se genera desde el OpenAPI del API. No editarlo a mano;
95
+ # regenerar tras cambios de contrato:
96
+ npm run regen-types # lee ../verifiquemos-api/openapi.json
97
+ ```
98
+
99
+ Publicacion a npm: el push de un tag git `v<version>` dispara el pipeline. Ver `CHANGELOG.md`.
100
+
85
101
  ## License
86
102
 
87
103
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@verifiquemos/sdk",
3
- "version": "0.1.4",
3
+ "version": "0.1.5",
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
  }