ksef-client-ts 0.2.0 → 0.4.0

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 (10) hide show
  1. package/README.md +21 -14
  2. package/dist/cli.js +1384 -262
  3. package/dist/cli.js.map +1 -1
  4. package/dist/index.cjs +948 -99
  5. package/dist/index.cjs.map +1 -1
  6. package/dist/index.d.cts +311 -6
  7. package/dist/index.d.ts +311 -6
  8. package/dist/index.js +926 -102
  9. package/dist/index.js.map +1 -1
  10. package/package.json +6 -2
package/README.md CHANGED
@@ -2,19 +2,22 @@
2
2
 
3
3
  TypeScript client for the Polish National e-Invoice System (KSeF) API v2.
4
4
 
5
- **[Documentation](https://flopsstuff.github.io/ksef-client-ts)**
5
+ **[Documentation](https://flopsstuff.github.io/ksef-client-ts)** · **[NPM](https://www.npmjs.com/package/ksef-client-ts)**
6
6
 
7
7
  ## Features
8
8
 
9
9
  - **Complete API coverage** — KSeF API v2.3.0, types aligned with the official OpenAPI spec
10
- - **Full-featured CLI** — `ksef` with many command groups and subcommands for day-to-day KSeF workflows
11
- - **Full documentation** — VitePress site: Quick Start, API reference, OpenAPI spec
12
- - **Comprehensive test coverage** — Vitest across HTTP, crypto, services, builders; CI on every change
13
- - **Zero HTTP dependencies** — native `fetch` (Node 18+); dual ESM/CJS via tsup
14
- - **Built-in cryptography** — AES-256-CBC, RSA-OAEP, ECDH, XAdES-B, self-signed certs (Node crypto)
15
- - **Automatic token management** — AuthManager: token injection, 401 refresh with dedup, `loginWithToken` / `loginWithCertificate`
16
- - **High-level workflows** — orchestration functions for auth, online/batch sessions, invoice export with polling and decryption
10
+ - **Full-featured CLI** — `ksef` with 14 command groups for auth, sessions, invoices, batch upload, export, and more
11
+ - **High-level workflows** — auth, online/batch sessions, invoice export — full lifecycle in a single call
12
+ - **Built-in cryptography** — AES-256-CBC, RSA-OAEP, ECDH, XAdES-B signatures, self-signed certs (Node crypto)
13
+ - **External signing** — HSM, EPUAP, and smart card authentication via callback-based signing
14
+ - **Automatic token management** — AuthManager: token injection, 401 refresh with dedup
15
+ - **Streaming batch uploads** — constant-memory batch upload via Web Streams API with ZIP bomb protection
16
+ - **Incremental export** — HWM-based paginated export with file-based state persistence
17
+ - **Multiple document structures** — FA, PEF, PEF_KOR, FA_RR with typed FormCode constants and UPO parsing
17
18
  - **Typed errors & fluent builders** — `KSeFError` hierarchy (401, 403, 429, validation) and request builders
19
+ - **Comprehensive test coverage** — unit + E2E tests across HTTP, crypto, services, workflows; CI on every change
20
+ - **Zero HTTP dependencies** — native `fetch` (Node 18+); dual ESM/CJS via tsup
18
21
 
19
22
  Requires **Node.js 18+**.
20
23
 
@@ -82,12 +85,16 @@ yarn test # Run all tests (vitest)
82
85
  - [ksef-client-csharp](https://github.com/CIRFMF/ksef-client-csharp) — official C# reference client
83
86
  - [ksef-client-java](https://github.com/CIRFMF/ksef-client-java) — official Java reference client
84
87
 
85
- ## Status
86
-
87
- [![Unit Tests](https://github.com/Flopsstuff/ksef-client-ts/actions/workflows/test.yml/badge.svg)](https://github.com/Flopsstuff/ksef-client-ts/actions/workflows/test.yml)
88
-
89
- ![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Fl0p/1558034ac67a11548c7f8f0c05e8d4c0/raw/ksef-client-ts-coverage.json&cacheSeconds=300)
90
-
91
88
  ## License
92
89
 
93
90
  [MIT](LICENSE)
91
+
92
+ ---
93
+
94
+ [![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)
95
+ ![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/Fl0p/1558034ac67a11548c7f8f0c05e8d4c0/raw/ksef-client-ts-coverage.json&cacheSeconds=300)
96
+ ![NPM Version](https://img.shields.io/npm/v/ksef-client-ts?color=green)
97
+ ![NPM Downloads](https://img.shields.io/npm/dm/ksef-client-ts)
98
+ ![GitHub Stars](https://img.shields.io/github/stars/Flopsstuff/ksef-client-ts)
99
+ ![GitHub Forks](https://img.shields.io/github/forks/Flopsstuff/ksef-client-ts)
100
+ ![GitHub License](https://img.shields.io/github/license/Flopsstuff/ksef-client-ts)