zata-vsdc-sdk 1.0.1 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +12 -21
  2. package/package.json +40 -38
package/README.md CHANGED
@@ -1,26 +1,17 @@
1
- ## Usage (TypeScript)
1
+ # zata-vsdc-sdk
2
2
 
3
- ```ts
4
- import ZataClient from 'zata-sdk';
3
+ TypeScript SDK for Zata API – E-Invoicing & Tax Compliance (Rwanda)
5
4
 
6
- const client = new ZataClient({
7
- apiKey: 'your-api-key-here',
8
- baseUrl: 'https://ebm.zata.rw/v1' // if sandbox exists
9
- });
5
+ **Installation Guide:** [https://zata.lovable.app](https://zata.lovable.app)
10
6
 
11
- async function main() {
12
- try {
13
- const companies = await client.getCompanies();
14
- console.log('Companies:', companies);
7
+ **Official Website:** [https://zata.rw](https://zata.rw)
8
+ **API Documentation:** [https://docs.zata.rw](https://docs.zata.rw)
9
+ **npm Package:** [zata-vsdc-sdk on npm](https://www.npmjs.com/package/zata-vsdc-sdk)
10
+ **GitHub Repository:** [HiQ-Africa/zata-npm](https://github.com/HiQ-Africa/zata-npm)
15
11
 
16
- const newCompany = await client.createCompany({
17
- name: 'Example Ltd',
18
- tin: '102345678'
19
- });
20
- console.log('Created:', newCompany);
21
- } catch (err) {
22
- console.error('Error:', (err as Error).message);
23
- }
24
- }
12
+ Zata provides a developer-friendly REST API for Rwanda Revenue Authority (RRA) compliant e-invoicing, EBM/VSDC integration, real-time transaction validation, signed PDFs, and more. This SDK simplifies integration with full TypeScript support.
25
13
 
26
- main();
14
+ ## Installation
15
+
16
+ ```bash
17
+ npm install zata-vsdc-sdk
package/package.json CHANGED
@@ -1,39 +1,41 @@
1
1
  {
2
- "name": "zata-vsdc-sdk",
3
- "version": "1.0.1",
4
- "description": "TypeScript SDK for Zata API – E-Invoicing & Tax Compliance (Rwanda)",
5
- "main": "dist/index.js",
6
- "types": "dist/index.d.ts",
7
- "scripts": {
8
- "build": "tsc",
9
- "prepublishOnly": "npm run build"
10
- },
11
- "keywords": [
12
- "zata",
13
- "e-invoicing",
14
- "rra",
15
- "rwanda",
16
- "typescript",
17
- "api-sdk",
18
- "ebm",
19
- "vsdc"
20
- ],
21
- "author": "Joshua",
22
- "license": "MIT",
23
- "dependencies": {
24
- "axios": "^1.7.2"
25
- },
26
- "devDependencies": {
27
- "typescript": "^5.5.4"
28
- },
29
- "files": [
30
- "dist"
31
- ],
32
- "repository": {
33
- "type": "git",
34
- "url": "https://github.com/HiQ-Africa/zata-npm.git"
35
- },
36
- "publishConfig": {
37
- "access": "public"
38
- }
39
- }
2
+ "name": "zata-vsdc-sdk",
3
+ "version": "1.0.2",
4
+ "description": "TypeScript SDK for Zata API – E-Invoicing & Tax Compliance (Rwanda)",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "homepage": "https://zata.rw",
8
+ "scripts": {
9
+ "build": "tsc",
10
+ "prepublishOnly": "npm run build"
11
+ },
12
+ "keywords": [
13
+ "zata",
14
+ "e-invoicing",
15
+ "rra",
16
+ "rwanda",
17
+ "typescript",
18
+ "api-sdk",
19
+ "ebm",
20
+ "vsdc"
21
+ ],
22
+ "author": "Joshua Mwamba",
23
+ "license": "MIT",
24
+ "dependencies": {
25
+ "axios": "^1.7.2"
26
+ },
27
+ "devDependencies": {
28
+ "typescript": "^5.5.4"
29
+ },
30
+ "files": [
31
+ "dist"
32
+ ],
33
+ "repository": {
34
+ "type": "git",
35
+ "url": "https://github.com/HiQ-Africa/zata-npm.git"
36
+ },
37
+ "publishConfig": {
38
+ "access": "public"
39
+ },
40
+ "readme": "README.md"
41
+ }