@facturacr/atv-sdk 0.0.0-beta → 0.0.2-beta

package/.env.example

@@ -0,0 +1,7 @@
+USERNAME_TEST=USER@stag.comprobanteselectronicos.go.cr
+PASSWORD_TEST=PASSWORD_PROVIDED_BY_ATV
+IS_STG="1"
+SOURCE_P12_URI=$PATH/#####.p12
+SOURCE_P12_PASSPORT=1234
+SOURCE_URI_XML_OUTPUT=$PATH/__test__/output/output.xml
+XML_TO_CONFIRM=$PATH/__test__/input/Comprobante_Electronico_####_####.xml

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/pull_request_template.md

@@ -0,0 +1,7 @@
+Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
+- [ ] Make sure to open an issue as a [bug/issue](https://github.com/facturacr/facturar-costa-rica-lib/issues/new/choose) before writing your code!  That way we can discuss the change, evaluate designs, and agree on the general idea
+- [ ] Ensure the tests and linter pass
+- [ ] Code coverage does not decrease (if any source code was changed)
+- [ ] Appropriate docs were updated (if necessary)
+
+Fixes #<issue_number_goes_here> 🦕

package/.github/workflows/ci.yml

@@ -13,13 +13,13 @@ jobs:
           uses: actions/checkout@v2
         - name: Install modules
           run: yarn
-        - name: Run Unit testing
-          run: yarn test:unit
+        - name: Run testing
+          run: yarn test
   run-on-ubuntu:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [10, 12, 14, 15]
+        node: [12, 14, 16, 18]
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 facturacr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,7 +1,14 @@
+
+> 🛑 **Librería aún no es estable.** 🛑
+
 # Librería Javascript - API de Administración Tributaria Virtual (ATV) del Ministerio de Hacienda.
 
 ## Descripción
 Este proyecto tiene como fin facilitar la creación de la factura electrónica de Costa Rica. El proposito es simplificar el proceso y que está librería pueda ser utilizada como ayuda en otros proyectos que requieran el acceso al sistema de hacienda. Para esto ofrece herramienta para conectarse al API del Ministerio de Hacienda de Costa Rica.
 
 
-Buscando colaboradores
+Buscando colaboración
+
+-------
+
+Para probar localmente leer [enlace](/examples/README.md).

package/__tests__/stubs/dummyKeys/README.md

@@ -0,0 +1,19 @@
+## Steps for generating P12 dummy key
+
+1. Generate 2048-bit RSA private key:
+
+    ``` openssl genrsa -out key.pem 2048 ```
+
+2. Generate a Certificate Signing Request:
+
+    ``` openssl req -new -sha256 -key key.pem -out csr.csr ```
+
+3. Generate a self-signed x509 certificate suitable for use on web servers:
+
+    ``` openssl req -x509 -sha256 -days 365 -key key.pem -in csr.csr -out certificate.pem ```
+
+4. Create SSL identity file in PKCS12 using pasword 1234:
+
+    ``` openssl pkcs12 -export -out client-identity.p12 -inkey key.pem -in certificate.pem ```
+
+Source: https://stackoverflow.com/a/65709104/2272082

package/__tests__/stubs/frontendRequest.stub.ts

@@ -1,5 +1,5 @@
-import { Impuesto, LineaDetalle, Persona } from '../../src/types/facturaInterfaces'
-import { FrontEndRequest } from '../../src/types/globalInterfaces'
+import { Impuesto, LineaDetalle, Persona } from '@src/types/facturaInterfaces'
+import { ClientPayload } from '@src/types/globalInterfaces'
 
 const impuestoStub: Impuesto = {
   Codigo: '01',
@@ -48,18 +48,19 @@ const receiverStub: Persona = {
   }
 }
 
-const requestStub: FrontEndRequest = {
+const requestStub: ClientPayload = {
   Emisor: transmitterStub,
   Receptor: receiverStub,
   sucursal: '001',
   terminal: '00001',
   tipoDocumento: 'FE',
   codigoPais: '506',
-  consecutivo: '0000000009',
+  consecutivo: '18', // In the examples this prop needs to be changed
   codigoSeguridad: '00000001',
   situationEC: '1',
   actividad: '4',
-  LineasDetalle: [lineaDetalleStub]
+  LineasDetalle: [lineaDetalleStub],
+  facturaElectronicaType: 'FacturaElectronicaExportacion'
 }
 
 export default requestStub

package/__tests__/stubs/token.stub.ts

@@ -0,0 +1,18 @@
+export const postTokenOptions = {
+  client_id: 'api-stag', // eslint-disable-line @typescript-eslint/camelcase
+  client_secret: '', // eslint-disable-line @typescript-eslint/camelcase
+  grant_type: 'password', // eslint-disable-line @typescript-eslint/camelcase
+  username: 'cpj-1-111-654321@stag.comprobanteselectronicos.go.cr',
+  password: 'Rg-OQS)]Y00987654321'
+}
+
+export const tokenStub = {
+  access_token: 'eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ4WERpTElEdW1DNUlKYkViZDRFRDlrMy1NS0Z6eUh4QW4xUWZYeEtSOWt3In0.eyJqdGkiOiIwMWE1NzY0Yy1lZGExLTRlNmEtOTg4MS1kNWJiYWQ5MTE3MjQiLCJleHAiOjE2MjE4MTIzNTcsIm5iZiI6MCwiaWF0IjoxNjIxODEyMDU3LCJpc3MiOiJodHRwOi8vaWRwLmNvbXByb2JhbnRlc2VsZWN0cm9uaWNvcy5nby5jci9hdXRoL3JlYWxtcy9ydXQtc3RhZyIsImF1ZCI6ImFjY291bnQiLCJzdWIiOiJiZDAyZmFiNS1hMjMwLTRlY2YtOWI3Zi1lMjA1NGM3YjhhMGYiLCJ0eXAiOiJCZWFyZXIiLCJhenAiOiJhcGktc3RhZyIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGF0ZSI6IjQ3Y2UyYzBhLTU2MDAtNDA0NS1hNDllLTQ1NDQwM2VmYzg2YiIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoiIiwibmFtZSI6IkNJRU5DSUEgREVMIFNBQk9SIFNPQ0lFREFEIERFIFJFU1BPTlNBQklMSURBRCBMSU1JVEFEQSIsInByZWZlcnJlZF91c2VybmFtZSI6ImNwai0zLTEwMi03NTkxNTdAc3RhZy5jb21wcm9iYW50ZXNlbGVjdHJvbmljb3MuZ28uY3IiLCJnaXZlbl9uYW1lIjoiQ0lFTkNJQSBERUwgU0FCT1IgU09DSUVEQUQgREUgUkVTUE9OU0FCSUxJREFEIExJTUlUQURBIiwicG9sIjoiNWI4MGI0NDc5ZWNlMzYwMzJiMDdkMmViIiwicG9saWN5LWlkIjoiNThhNjIwMzM3NmVhZTE0MDhjZTVlN2RkIiwiZW1haWwiOiJjcGotMy0xMDItNzU5MTU3QHN0YWcuY29tcHJvYmFudGVzZWxlY3Ryb25pY29zLmdvLmNyIn0.GBhbEkVQFGKgKr28H2SaB0QHMLIXcn8jmCj-VVTvSDGKmF7CLp7Dwi94oXiW72AoZAqvNBRnRr4hDJb7s8HZedhtD965O9x_pKPVYjgc6B_xXwczNqL6o4I2o3GKZ_1dY7E9KZgUTqv-dbZ3LmKmvB5dk_icRw-Kh5tGheUaF5cSdzIYa4VHy-ZgMcacdBnvl-G9mixkYlBShMJyszIQ-k2T9z4FFvOUdNstBiehwFiCBi7CS7HP_wn1w04O2uClyq-zHk9U8Qb25YROquFtZHV9IPrgg3LMA4MuLS6OhnKRjYHbqf0j4Elh_ucNYDs7Whz5Y76Ya33d3VhooUuDKA', // eslint-disable-line @typescript-eslint/camelcase
+  expires_in: 300, // eslint-disable-line @typescript-eslint/camelcase
+  refresh_expires_in: 1200, // eslint-disable-line @typescript-eslint/camelcase
+  refresh_token: 'eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJmOThjMTk2Mi02ZGJkLTRjNDAtOTM5Ni00YTVmMDdjYTYxZTQifQ.eyJqdGkiOiJiZDMyMWYyNC02MGFlLTRiMmYtYWJlZS01ZDI1NWNlMDAyMDYiLCJleHAiOjE2MjE4MTMyNTcsIm5iZiI6MCwiaWF0IjoxNjIxODEyMDU3LCJpc3MiOiJodHRwOi8vaWRwLmNvbXByb2JhbnRlc2VsZWN0cm9uaWNvcy5nby5jci9hdXRoL3JlYWxtcy9ydXQtc3RhZyIsImF1ZCI6Imh0dHA6Ly9pZHAuY29tcHJvYmFudGVzZWxlY3Ryb25pY29zLmdvLmNyL2F1dGgvcmVhbG1zL3J1dC1zdGFnIiwic3ViIjoiYmQwMmZhYjUtYTIzMC00ZWNmLTliN2YtZTIwNTRjN2I4YTBmIiwidHlwIjoiUmVmcmVzaCIsImF6cCI6ImFwaS1zdGFnIiwiYXV0aF90aW1lIjowLCJzZXNzaW9uX3N0YXRlIjoiNDdjZTJjMGEtNTYwMC00MDQ1LWE0OWUtNDU0NDAzZWZjODZiIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iXX0sInJlc291cmNlX2FjY2VzcyI6eyJhY2NvdW50Ijp7InJvbGVzIjpbIm1hbmFnZS1hY2NvdW50IiwibWFuYWdlLWFjY291bnQtbGlua3MiLCJ2aWV3LXByb2ZpbGUiXX19LCJzY29wZSI6IiJ9.aQzWy0NHyizDSZwYz14oOXrwekSPlHOrkjiRdo_BvP4', // eslint-disable-line @typescript-eslint/camelcase
+  token_type: 'bearer', // eslint-disable-line @typescript-eslint/camelcase
+  'not-before-policy': 0,
+  session_state: '47ce2c0a-5600-4045-a49e-454403efc86b', // eslint-disable-line @typescript-eslint/camelcase
+  scope: ''
+}

package/__tests__/tests/electronicBill.test.ts

@@ -0,0 +1,28 @@
+import { tokenStub } from '@test/stubs/token.stub'
+import requestStub from '@test/stubs/frontendRequest.stub'
+import eletronicBill from '@src/electronicBill'
+import { send } from '@src/services/send/index'
+import fs from 'fs'
+import path from 'path'
+const SOURCE_P12_URI = path.join(__dirname, '../stubs/dummyKeys/client-identity.p12')
+
+jest.mock('@src/services/send/index')
+
+const mockedSend = send as jest.MockedFunction<typeof send>
+const pem = fs.readFileSync(SOURCE_P12_URI, 'binary')
+
+describe('Get Token', () => {
+  it('should return a valid token', async () => {
+    mockedSend.mockImplementation(() => {
+      return Promise.resolve('')
+    })
+    const bill = await eletronicBill(tokenStub, requestStub, {
+      buffer: pem,
+      password: '1234'
+    })
+
+    console.log('bill', bill)
+
+    expect(bill).toEqual('')
+  })
+})

package/__tests__/{unit → tests}/getClave.test.ts

@@ -1,10 +1,10 @@
 import { getClave } from '../../src/lib/genClave'
 import fe from '../stubs/frontendRequest.stub'
-import { FrontEndRequest } from '../../src/types/globalInterfaces'
+import { ClientPayload } from '../../src/types/globalInterfaces'
 
 describe('GET CLAVE', () => {
   it('should create a new key with 50 characters', () => {
-    const frontEndRequest: FrontEndRequest = fe
+    const frontEndRequest: ClientPayload = fe
     const result = getClave(frontEndRequest)
     expect(result.length).toBe(50)
   })

package/__tests__/tests/lib/getClave.test.ts

@@ -0,0 +1,11 @@
+import { getClave } from '../../../src/lib/genClave'
+import fe from '../../stubs/frontendRequest.stub'
+import { ClientPayload } from '../../../src/types/globalInterfaces'
+
+describe('GET CLAVE', () => {
+  it('should create a new key with 50 characters', () => {
+    const frontEndRequest: ClientPayload = fe
+    const result = getClave(frontEndRequest)
+    expect(result.length).toBe(50)
+  })
+})

package/__tests__/tests/services/getToken.test.ts

@@ -0,0 +1,15 @@
+import axios from 'axios'
+import { tokenStub, postTokenOptions } from '@test/stubs/token.stub'
+import getToken from '@src/services/getToken'
+
+jest.mock('axios')
+const mockedAxios = axios as jest.Mocked<typeof axios>
+
+describe('Get Token', () => {
+  it('should return a valid token', async () => {
+    mockedAxios.post.mockResolvedValue({ data: tokenStub })
+    const token = await getToken(postTokenOptions)
+
+    expect(token).toEqual({ data: tokenStub })
+  })
+})