ksef-client-ts 0.4.0 → 0.5.1
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 +3 -0
- package/dist/cli.js +4764 -6740
- package/dist/cli.js.map +1 -1
- package/dist/index.cjs +1930 -4712
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +149 -3
- package/dist/index.d.ts +149 -3
- package/dist/index.js +1920 -4731
- package/dist/index.js.map +1 -1
- package/package.json +18 -4
package/README.md
CHANGED
|
@@ -15,8 +15,10 @@ TypeScript client for the Polish National e-Invoice System (KSeF) API v2.
|
|
|
15
15
|
- **Streaming batch uploads** — constant-memory batch upload via Web Streams API with ZIP bomb protection
|
|
16
16
|
- **Incremental export** — HWM-based paginated export with file-based state persistence
|
|
17
17
|
- **Multiple document structures** — FA, PEF, PEF_KOR, FA_RR with typed FormCode constants and UPO parsing
|
|
18
|
+
- **Invoice XML validation** — three-level client-side validation (well-formedness, XSD schema via Zod, NIP/PESEL checksums, future date rejection) with auto-detection for all 6 invoice types
|
|
18
19
|
- **Typed errors & fluent builders** — `KSeFError` hierarchy (401, 403, 429, validation) and request builders
|
|
19
20
|
- **Comprehensive test coverage** — unit + E2E tests across HTTP, crypto, services, workflows; CI on every change
|
|
21
|
+
- **Interactive setup wizard** — `ksef setup` guides through environment selection, authentication, and token generation in one flow
|
|
20
22
|
- **Zero HTTP dependencies** — native `fetch` (Node 18+); dual ESM/CJS via tsup
|
|
21
23
|
|
|
22
24
|
Requires **Node.js 18+**.
|
|
@@ -80,6 +82,7 @@ yarn test # Run all tests (vitest)
|
|
|
80
82
|
|
|
81
83
|
## Related
|
|
82
84
|
|
|
85
|
+
- [KSeF Web Portal](https://ap.ksef.mf.gov.pl/web/) — official KSeF web application (token management, permissions, invoices)
|
|
83
86
|
- [KSeF official docs](https://github.com/CIRFMF/ksef-docs) — official documentation (Polish)
|
|
84
87
|
- [KSeF docs translated](https://flopsstuff.github.io/ksef-docs/) — translated documentation (EN/RU/UK)
|
|
85
88
|
- [ksef-client-csharp](https://github.com/CIRFMF/ksef-client-csharp) — official C# reference client
|