Re-export package content in index

Author: ihadabs

CONTRIBUTING.md

@@ -1 +1,64 @@
 # ZATCA (Fatoorah) QR-Code Implementation
+
+[![npm version](https://badge.fury.io/js/recht.svg)](https://badge.fury.io/js/recht)
+[![build](https://travis-ci.org/user/project.svg?branch=master)](https://travis-ci.org/user/project)
+[![Coverage Status](https://coveralls.io/repos/github/user/project/badge.svg?branch=master)](https://coveralls.io/github/user/project?branch=master)
+[![dependencies Status](https://david-dm.org/user/project/status.svg)](https://david-dm.org/user/project)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/user/project/master/LICENSE)
+
+An unofficial package to help developers implement ZATCA (Fatoora) QR code easily which is required for e-invoicing in
+Saudi Arabia.
+
+## Installation
+
+```bash
+npm i --save @axenda/zatca
+```
+
+## Usage
+
+### Generate TLV
+
+```typescript
+```
+
+### Generate Base64
+
+```typescript
+```
+
+### Render QR Code
+
+You can generate image data (png) from base64 string and render it in browser.
+
+```typescript
+```
+
+## Documentation
+
+| Argument      | Description                                                                      | Mandatory      | Type                    |  Rules                                                                                                     |
+|:-------------:|:---------------------------------------------------------------------------------|:--------------:|:-----------------------:|:----------------------------------------------------------------------------------------------------------:|
+| 1             | Description of argument 1                                                        | True / False   | Type                    |                                                                                                            | 
+| 2             | Description of argument 2                                                        | True / False   | Type                    |                                                                                                            | 
+| 3             | Description of argument 3                                                        | True / False   | Type                    |                                                                                                            | 
+
+## Package roadmap
+
+-   [x] Feature 1.
+-   [ ] Feature 2.
+-   [ ] Feature 3.
+-   [ ] Feature 4.
+-   [ ] Feature 5.
+-   [ ] Feature 6.
+
+## Contributing
+
+**https://github.com/user/project**
+
+## Bibliography
+
+- It is always a good practise to support your work with scientific/ademic literature.
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

README.md

@@ -1,11 +1,13 @@
 {
 	"name": "@axenda/zatca",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
+	"type": "module",
 	"files": [
-		"lib/**/*"
+		"lib",
+		"src"
 	],
 	"dependencies": {
 		"qrcode": "^1.4.4"

package.json

@@ -1,32 +1,7 @@
-import { Tag } from './models/tag';
-import { Invoice } from './models/invoice';
-import { toTlv } from './utils/to-tlv';
-import { tagsToBase64, toBase64 } from './utils/to-base64';
-import { renderTags } from './utils/render-tags';
+export { Invoice } from './models/invoice';
+export { Tag } from './models/tag';
 
-const tags: Tag[] = [
-	new Tag(1, 'Salla'),
-	new Tag(2, '1234567891'),
-	new Tag(3, '2021-07-12T14:25:09Z'),
-	new Tag(4, '100.00'),
-	new Tag(5, '15.00'),
-];
-
-const tlv = toTlv(tags);
-toBase64(tlv);
-tagsToBase64(tags);
-renderTags(tags);
-
-const invoice = new Invoice({
-	sellerName: 'Salla',
-	vatRegistrationNumber: '1234567891',
-	invoiceTimestamp: '2021-12-04T00:00:00Z',
-	invoiceTotal: '100.00',
-	invoiceVatTotal: '15.00',
-});
-
-console.log(invoice.toTlv());
-//console.log(invoice.toBase64());
-//invoice.render().then((qrcode) => {
-//	console.log(qrcode);
-//});
+export { renderTags } from './utils/render-tags';
+export { toBase64, tagsToBase64 } from './utils/to-base64';
+export { toHex } from './utils/to-hex';
+export { toTlv } from './utils/to-tlv';

src/index.ts

@@ -0,0 +1,32 @@
+import { Tag } from './models/tag';
+import { Invoice } from './models/invoice';
+import { toTlv } from './utils/to-tlv';
+import { tagsToBase64, toBase64 } from './utils/to-base64';
+import { renderTags } from './utils/render-tags';
+
+const tags: Tag[] = [
+	new Tag(1, 'Salla'),
+	new Tag(2, '1234567891'),
+	new Tag(3, '2021-07-12T14:25:09Z'),
+	new Tag(4, '100.00'),
+	new Tag(5, '15.00'),
+];
+
+const tlv = toTlv(tags);
+toBase64(tlv);
+tagsToBase64(tags);
+renderTags(tags);
+
+const invoice = new Invoice({
+	sellerName: 'Salla',
+	vatRegistrationNumber: '1234567891',
+	invoiceTimestamp: '2021-12-04T00:00:00Z',
+	invoiceTotal: '100.00',
+	invoiceVatTotal: '15.00',
+});
+
+console.log(invoice.toTlv());
+//console.log(invoice.toBase64());
+//invoice.render().then((qrcode) => {
+//	console.log(qrcode);
+//});

src/internal.ts

@@ -1,4 +1,4 @@
-import { Invoice } from '../src/models/invoice';
+import { Invoice } from '../src';
 
 test('Invoice.toBase64() returns a valid base64 string', () => {
 	const invoice = new Invoice({

tests/invoice.test.ts

@@ -1,6 +1,4 @@
-import { Tag } from '../src/models/tag';
-import { tagsToBase64 } from '../src/utils/to-base64';
-import { renderTags } from '../src/utils/render-tags';
+import { renderTags, Tag, tagsToBase64 } from '../src';
 
 test('tagsToBase64() generates a valid base64 string from tags', () => {
 	const tags: Tag[] = [

tests/tag.test.ts

@@ -4,7 +4,7 @@
 	],
 	"exclude": [
 		"node_modules",
-		"**/__tests__/*"
+		"tests"
 	],
 	"compilerOptions": {
 		/* Visit https://aka.ms/tsconfig.json to read more about this file */
@@ -36,7 +36,8 @@
 		/* Specify what module code is generated. */
 		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
 		// "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
-		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+		"baseUrl": ".",
+		/* Specify the base directory to resolve non-relative module names. */
 		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
 		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
 		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */