ksef-client-ts 0.9.1 → 0.10.0

package/README.md

@@ -2,58 +2,18 @@
 
 TypeScript client for the Polish National e-Invoice System (KSeF) API v2.
 
-**[Documentation](https://flopsstuff.github.io/ksef-client-ts)** · **[NPM](https://www.npmjs.com/package/ksef-client-ts)**
-
-## Features
-
-- **Complete API coverage** — KSeF API v2.6.1, types aligned with the official OpenAPI spec
-- **Offline invoice mode** — full lifecycle for all 4 KSeF offline modes with QR KOD I + KOD II signing, deadline tracking, local storage, and technical correction
-- **Full-featured CLI** — `ksef` with 15 command groups for auth, sessions, invoices, offline, 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
-- **Opt-in circuit breaker** — pauses outgoing requests for a short cooldown window after consecutive upstream failures
-- **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 serialization (FA2/FA3/PEF/PEF_KOR)** — build XSD-compliant invoice XML from typed TypeScript objects with correct element ordering (including the FA3 per-VAT-rate interleave) and namespace injection; `ksef invoice build` exposes the same pipeline to shell workflows with JSON/YAML input and optional XSD validation
-- **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
-- **Typed errors with RFC 7807 Problem Details** — `KSeFError` hierarchy with dedicated classes for 400/401/403/410/429 carrying structured diagnostic context; exhaustive dispatch via the `KSeFApiProblem` union and `assertNever`; fluent request builders
-- **Comprehensive test coverage** — unit + E2E tests across HTTP, crypto, services, workflows; CI on every change
-- **Interactive setup wizard** — `ksef setup` guides through environment selection, authentication, and token generation in one flow
-- **Zero HTTP dependencies** — native `fetch` (Node 18+); dual ESM/CJS via tsup
-
-Requires **Node.js 18+**.
+**[Documentation](https://flopsstuff.github.io/ksef-client-ts)** · **[GitHub](https://github.com/Flopsstuff/ksef-client-ts)**
 
 ## Install
 
-Install CLI globally:
-
-```bash
-npm i -g ksef-client-ts
-ksef --help
-```
-
-Install in a project:
-
 ```bash
-# Choose one package manager:
-# npm
-npm i ksef-client-ts
-# Yarn
-yarn add ksef-client-ts
-# pnpm
-pnpm add ksef-client-ts
+npm i ksef-client-ts      # library
+npm i -g ksef-client-ts   # ksef CLI
 ```
 
-For local development, clone and build:
+Requires **Node.js 18+**. Dual ESM/CJS output via tsup.
 
-```bash
-git clone https://github.com/Flopsstuff/ksef-client-ts.git
-cd ksef-client-ts
-yarn install && yarn build
-```
+## Quick start
 
 ```ts
 import { KSeFClient } from 'ksef-client-ts';
@@ -62,7 +22,7 @@ const client = new KSeFClient({ environment: 'TEST' });
 await client.crypto.init();
 
 const challenge = await client.auth.getChallenge();
-// ... authenticate, open session, send invoices
+// ... authenticate, open a session, send invoices
 ```
 
 ```bash
@@ -70,38 +30,19 @@ ksef auth login --token "$KSEF_TOKEN" --nip "$KSEF_NIP"
 ksef session open              # 1. Open online session (required)
 ksef invoice send invoice.xml  # 2. Send invoice
 ksef session invoices          # 3. Verify invoice status
-ksef session close             # 4. Close session (optional)
 ```
 
-See the [documentation](https://flopsstuff.github.io/ksef-client-ts) for full usage, [API reference](https://flopsstuff.github.io/ksef-client-ts/api-reference), and [CLI reference](https://flopsstuff.github.io/ksef-client-ts/cli).
-
-## Development
+Node-only helpers (filesystem storage, native XSD validation) are available from the `ksef-client-ts/node` entry point.
 
-```bash
-yarn install      # Install dependencies (yarn 4.x via Corepack)
-yarn build        # Build ESM + CJS + DTS via tsup
-yarn lint         # Type-check (tsc --noEmit)
-yarn test         # Run all tests (vitest)
-```
+## Documentation
 
-## Related
+The full feature list, guides, API and CLI reference, and the v0.10 migration guide live in the **[documentation](https://flopsstuff.github.io/ksef-client-ts)** and the **[GitHub README](https://github.com/Flopsstuff/ksef-client-ts)**:
 
-- [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), [source on GitHub](https://github.com/Flopsstuff/ksef-docs)
-- [ksef-client-csharp](https://github.com/CIRFMF/ksef-client-csharp) — official C# reference client
-- [ksef-client-java](https://github.com/CIRFMF/ksef-client-java) — official Java reference client
+- [Quick start](https://flopsstuff.github.io/ksef-client-ts/quick-start)
+- [API reference](https://flopsstuff.github.io/ksef-client-ts/api-reference)
+- [CLI reference](https://flopsstuff.github.io/ksef-client-ts/cli)
+- [Migration guide (v0.10)](https://flopsstuff.github.io/ksef-client-ts/migration-v0.10)
 
 ## License
 
 [MIT](LICENSE)
-
----
-
-[![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?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)
-![GitHub License](https://img.shields.io/github/license/Flopsstuff/ksef-client-ts)

package/dist/cli.js

@@ -256,14 +256,6 @@ var init_ksef_auth_status_error = __esm({
   }
 });
 
-// src/errors/ksef-session-expired-error.ts
-var init_ksef_session_expired_error = __esm({
-  "src/errors/ksef-session-expired-error.ts"() {
-    "use strict";
-    init_ksef_error();
-  }
-});
-
 // src/errors/ksef-validation-error.ts
 var ksef_validation_error_exports = {};
 __export(ksef_validation_error_exports, {
@@ -292,14 +284,6 @@ var init_ksef_validation_error = __esm({
   }
 });
 
-// src/errors/ksef-metadata-pagination-error.ts
-var init_ksef_metadata_pagination_error = __esm({
-  "src/errors/ksef-metadata-pagination-error.ts"() {
-    "use strict";
-    init_ksef_error();
-  }
-});
-
 // src/errors/error-codes.ts
 function hasErrorCode(body, code) {
   return !!body?.exception?.exceptionDetailList?.some((d) => d.exceptionCode === code);
@@ -416,13 +400,6 @@ var init_ksef_xsd_validation_error = __esm({
   }
 });
 
-// src/errors/assert-never.ts
-var init_assert_never = __esm({
-  "src/errors/assert-never.ts"() {
-    "use strict";
-  }
-});
-
 // src/errors/index.ts
 var init_errors = __esm({
   "src/errors/index.ts"() {
@@ -434,16 +411,7 @@ var init_errors = __esm({
     init_ksef_forbidden_error();
     init_ksef_gone_error();
     init_ksef_bad_request_error();
-    init_ksef_auth_status_error();
-    init_ksef_session_expired_error();
     init_ksef_validation_error();
-    init_ksef_metadata_pagination_error();
-    init_ksef_batch_timeout_error();
-    init_ksef_unknown_public_key_error();
-    init_ksef_circuit_open_error();
-    init_ksef_xsd_validation_error();
-    init_error_codes();
-    init_assert_never();
   }
 });
 
@@ -500,7 +468,6 @@ var init_options = __esm({
 var init_config = __esm({
   "src/config/index.ts"() {
     "use strict";
-    init_environments();
     init_options();
   }
 });
@@ -2861,6 +2828,7 @@ var init_verification_link_service = __esm({
       constructor(baseQrUrl) {
         this.baseQrUrl = baseQrUrl;
       }
+      baseQrUrl;
       /**
        * Build invoice verification URL (Code I).
        * Format: {baseQrUrl}/invoice/{NIP}/{DD-MM-YYYY}/{hash_base64url}
@@ -3171,6 +3139,7 @@ var init_offline_invoice_workflow = __esm({
       constructor(qrService) {
         this.qrService = qrService;
       }
+      qrService;
       async generate(input, options) {
         if (!input.invoiceXml || input.invoiceXml.trim().length === 0) {
           throw new Error("invoiceXml must not be empty");
@@ -4718,11 +4687,6 @@ var init_xml = __esm({
   "src/xml/index.ts"() {
     "use strict";
     init_upo_parser();
-    init_invoice_field_extractor();
-    init_xml_engine();
-    init_order_map();
-    init_faktura_builder();
-    init_pef_builder();
     init_invoice_serializer();
   }
 });
@@ -6200,11 +6164,6 @@ var SCHEMA_TYPES, NAMESPACE_MAP;
 var init_schemas = __esm({
   "src/validation/schemas/index.ts"() {
     "use strict";
-    init_fa3();
-    init_fa2();
-    init_fa_rr1();
-    init_pef3();
-    init_pef_kor3();
     SCHEMA_TYPES = ["FA3", "FA2", "FA_RR1", "PEF3", "PEF_KOR3"];
     NAMESPACE_MAP = {
       "http://crd.gov.pl/wzor/2025/06/25/13775/": "FA3",
@@ -7320,7 +7279,6 @@ function clearCredentials() {
 
 // src/workflows/auth-workflow.ts
 init_polling();
-init_auth_xml_builder();
 init_with_key_rotation_retry();
 init_ksef_auth_status_error();
 var AUTH_STATUS_SUCCESS = 200;
@@ -8369,6 +8327,7 @@ var FileHwmStore = class {
   constructor(filePath) {
     this.filePath = filePath;
   }
+  filePath;
   async load() {
     try {
       const data = await fs7.readFile(this.filePath, "utf-8");
@@ -8386,8 +8345,6 @@ var FileHwmStore = class {
 };
 
 // src/workflows/invoice-export-workflow.ts
-init_zip();
-init_targz();
 init_polling();
 init_with_key_rotation_retry();