evatr-api 0.3.0 → 0.3.2

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 CHANGED
@@ -8,14 +8,11 @@
8
8
 
9
9
  > Checks a VAT-ID using the eVatR REST-API of the German Federal Central Tax Office (Bundeszentralamt für Steuern, BZSt)
10
10
 
11
- > [!CAUTION]
12
- > This package is in early development and is not yet ready for production use. It is currently being tested and may undergo significant changes.
13
-
14
11
  > [!IMPORTANT]
15
12
  > This is an unofficial wrapper for the eVatR API. For official documentation and terms of use, please refer to the [German Federal Central Tax Office (BZSt)](https://www.bzst.de/DE/Unternehmen/Identifikationsnummern/Umsatzsteuer-Identifikationsnummer/umsatzsteuer-identifikationsnummer_node.html) website.
16
13
 
17
14
  > [!NOTE]
18
- > This package uses the new REST-API released in July 2025. The old XML-RPC API is being discontinued and will be sunset on **November 30th, 2025** (based on information from BZSt-Newsletter USTKV 01/2025 dated July 1st, 2025).
15
+ > This package uses the new REST-API released in July 2025. The old XML-RPC API is being discontinued and was sunset on **November 30th, 2025** (based on information from BZSt-Newsletter USTKV 01/2025 dated July 1st, 2025).
19
16
 
20
17
  ## Installation
21
18
 
@@ -49,7 +46,7 @@ const result = await client.validateQualified({
49
46
  vatIdOwn: 'DE123456789',
50
47
  vatIdForeign: 'ATU12345678',
51
48
  company: 'Musterhaus GmbH & Co KG',
52
- location: 'musterort'
49
+ location: 'Musterort'
53
50
  });
54
51
 
55
52
  console.log(result);
@@ -109,7 +106,7 @@ await client.validateQualified({
109
106
  vatIdOwn: 'DE123456789', // Your German VAT-ID (required)
110
107
  vatIdForeign: 'ATU12345678', // VAT-ID to validate (required)
111
108
  company: 'Musterhaus GmbH & Co KG', // Company name (required)
112
- location: 'musterort', // City (required)
109
+ location: 'Musterort', // City (required)
113
110
  street: 'Musterstrasse 22', // Street address (optional)
114
111
  zip: '12345', // Postal code (optional)
115
112
  includeRaw: true, // Include raw response (optional)
@@ -245,7 +242,7 @@ const testIds = EvatrUtils.getTestVatIds();
245
242
  For users migrating from the [evatr](https://github.com/qqilihq/evatr) library, we provide a migration helper that maintains API compatibility.
246
243
 
247
244
  > [!IMPORTANT]
248
- > The migration helper was introduced because the German Federal Central Tax Office is **sunsetting the XML-RPC API on November 30th, 2025**. This helper allows existing code to work with minimal changes while using the new REST API under the hood.
245
+ > The migration helper was introduced because the German Federal Central Tax Office **sunset the XML-RPC API on November 30th, 2025**. This helper allows existing code to work with minimal changes while using the new REST API under the hood.
249
246
 
250
247
  ### Why the Migration Helper?
251
248
 
@@ -274,7 +271,7 @@ const qualifiedResult = await evatr.checkQualified({
274
271
  companyName: 'Musterhaus GmbH & Co KG',
275
272
  street: 'Musterstrasse 22',
276
273
  zip: '12345',
277
- city: 'musterort',
274
+ city: 'Musterort',
278
275
  });
279
276
  ```
280
277
 
@@ -402,17 +399,17 @@ The library includes test VAT-IDs and information that can be used for testing.
402
399
 
403
400
  ```typescript
404
401
  const testRequest = {
405
- anfragendeUstid: 'DE123456789',
406
- angefragteUstid: 'ATU12345678',
402
+ vatIdOwn: 'DE123456789',
403
+ vatIdForeign: 'ATU12345678',
407
404
  };
408
405
 
409
406
  const qualifiedTestRequest = {
410
- anfragendeUstid: 'DE123456789',
411
- angefragteUstid: 'ATU12345678',
412
- firmenname: 'Musterhaus GmbH & Co KG',
413
- strasse: 'Musterstrasse 22',
414
- plz: '12345',
415
- ort: 'musterort',
407
+ vatIdOwn: 'DE123456789',
408
+ vatIdForeign: 'ATU12345678',
409
+ company: 'Musterhaus GmbH & Co KG',
410
+ location: 'Musterort',
411
+ street: 'Musterstrasse 22',
412
+ zip: '12345',
416
413
  };
417
414
  ```
418
415
 
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Migration helper for backward compatibility with the evatr library
3
- * The XML-RPC eVatR is planned to be sunset on 2025-11-30
3
+ * The XML-RPC eVatR was sunset on 2025-11-30
4
4
  *
5
5
  * Provides a similar API as https://github.com/qqilihq/evatr
6
6
  *
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  /**
3
3
  * Migration helper for backward compatibility with the evatr library
4
- * The XML-RPC eVatR is planned to be sunset on 2025-11-30
4
+ * The XML-RPC eVatR was sunset on 2025-11-30
5
5
  *
6
6
  * Provides a similar API as https://github.com/qqilihq/evatr
7
7
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "evatr-api",
3
- "version": "0.3.0",
3
+ "version": "0.3.2",
4
4
  "description": "Checks a VAT-ID using the eVatR REST-API of the German Federal Central Tax Office (Bundeszentralamt für Steuern, BZSt)",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -22,7 +22,7 @@
22
22
  "lint:fix": "eslint src/**/*.ts --fix",
23
23
  "lint": "eslint src/**/*.ts",
24
24
  "prepublishOnly": "npm run build",
25
- "test:ci": "jest --coverage --reporters=jest-junit --watchAll=false",
25
+ "test:ci": "jest --coverage --reporters=default --reporters=jest-junit --watchAll=false --testPathIgnorePatterns='/*.external.test.ts' --runInBand --detectOpenHandles --logHeapUsage",
26
26
  "test:coverage": "jest --coverage",
27
27
  "test:external": "jest --testPathPatterns='/*.external.test.ts'",
28
28
  "test:smoke": "jest --silent --verbose=false --testPathIgnorePatterns='/*.external.test.ts'",
@@ -54,11 +54,11 @@
54
54
  "@eslint/eslintrc": "^3.3.1",
55
55
  "@eslint/js": "^9.33.0",
56
56
  "@types/jest": "^30.0.0",
57
- "@types/node": "^24.0.0",
57
+ "@types/node": "^25.0.0",
58
58
  "@typescript-eslint/eslint-plugin": "^8.38.0",
59
59
  "@typescript-eslint/parser": "^8.38.0",
60
60
  "eslint": "^9.33.0",
61
- "globals": "^16.3.0",
61
+ "globals": "^17.0.0",
62
62
  "jest": "^30.0.0",
63
63
  "jest-junit": "^16.0.0",
64
64
  "prettier": "^3.0.0",
@@ -67,7 +67,7 @@
67
67
  "typescript": "^5.8.0"
68
68
  },
69
69
  "dependencies": {
70
- "axios": "^1.6.0"
70
+ "axios": "^1.12.0"
71
71
  },
72
72
  "overrides": {
73
73
  "glob": "^10.0"