ksef-client-ts 0.3.0 → 0.5.0

package/README.md

@@ -7,14 +7,18 @@ TypeScript client for the Polish National e-Invoice System (KSeF) API v2.
 ## Features
 
 - **Complete API coverage** — KSeF API v2.3.0, types aligned with the official OpenAPI spec
-- **Full-featured CLI** — `ksef` with many command groups and subcommands for day-to-day KSeF workflows
-- **Full documentation** — VitePress site: Quick Start, API reference, OpenAPI spec
-- **Comprehensive test coverage** — Vitest across HTTP, crypto, services, builders; CI on every change
-- **Zero HTTP dependencies** — native `fetch` (Node 18+); dual ESM/CJS via tsup
-- **Built-in cryptography** — AES-256-CBC, RSA-OAEP, ECDH, XAdES-B, self-signed certs (Node crypto)
-- **Automatic token management** — AuthManager: token injection, 401 refresh with dedup, `loginWithToken` / `loginWithCertificate`
-- **High-level workflows** — orchestration functions for auth, online/batch sessions, invoice export with polling and decryption
+- **Full-featured CLI** — `ksef` with 14 command groups for auth, sessions, invoices, batch upload, export, and more
+- **High-level workflows** — auth, online/batch sessions, invoice export — full lifecycle in a single call
+- **Built-in cryptography** — AES-256-CBC, RSA-OAEP, ECDH, XAdES-B signatures, self-signed certs (Node crypto)
+- **External signing** — HSM, EPUAP, and smart card authentication via callback-based signing
+- **Automatic token management** — AuthManager: token injection, 401 refresh with dedup
+- **Streaming batch uploads** — constant-memory batch upload via Web Streams API with ZIP bomb protection
+- **Incremental export** — HWM-based paginated export with file-based state persistence
+- **Multiple document structures** — FA, PEF, PEF_KOR, FA_RR with typed FormCode constants and UPO parsing
+- **Invoice XML validation** — three-level client-side validation (well-formedness, XSD schema via Zod, NIP/PESEL checksums) with auto-detection for all 6 invoice types
 - **Typed errors & fluent builders** — `KSeFError` hierarchy (401, 403, 429, validation) and request builders
+- **Comprehensive test coverage** — unit + E2E tests across HTTP, crypto, services, workflows; CI on every change
+- **Zero HTTP dependencies** — native `fetch` (Node 18+); dual ESM/CJS via tsup
 
 Requires **Node.js 18+**.
 
@@ -77,6 +81,7 @@ yarn test         # Run all tests (vitest)
 
 ## Related
 
+- [KSeF Web Portal](https://ap.ksef.mf.gov.pl/web/) — official KSeF web application (token management, permissions, invoices)
 - [KSeF official docs](https://github.com/CIRFMF/ksef-docs) — official documentation (Polish)
 - [KSeF docs translated](https://flopsstuff.github.io/ksef-docs/) — translated documentation (EN/RU/UK)
 - [ksef-client-csharp](https://github.com/CIRFMF/ksef-client-csharp) — official C# reference client
@@ -90,7 +95,7 @@ yarn test         # Run all tests (vitest)
 
 [![Tests](https://github.com/Flopsstuff/ksef-client-ts/actions/workflows/ci.yml/badge.svg)](https://github.com/Flopsstuff/ksef-client-ts/actions/workflows/ci.yml)
 ![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Fl0p/1558034ac67a11548c7f8f0c05e8d4c0/raw/ksef-client-ts-coverage.json&cacheSeconds=300)
-![NPM Version](https://img.shields.io/npm/v/ksef-client-ts)
+![NPM Version](https://img.shields.io/npm/v/ksef-client-ts?color=green)
 ![NPM Downloads](https://img.shields.io/npm/dm/ksef-client-ts)
 ![GitHub Stars](https://img.shields.io/github/stars/Flopsstuff/ksef-client-ts)
 ![GitHub Forks](https://img.shields.io/github/forks/Flopsstuff/ksef-client-ts)