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

package/src/services/getToken/__tests__/GetToken.test.ts

@@ -0,0 +1,82 @@
+/* eslint-disable @typescript-eslint/camelcase */
+import axios from 'axios'
+import qs from 'querystring'
+import { GetToken } from '../GetToken'
+import { ATV } from '@src/ATV'
+import { GetTokenDto } from '../types'
+
+jest.mock('@src/ATV')
+jest.mock('axios')
+jest.mock('querystring')
+
+const fetchResponse = {
+  data: {
+    access_token: 'access_token',
+    expires_in: 3600,
+    refresh_token: 'refresh_token',
+    refresh_expires_in: 1209600,
+    session_state: 'session_state',
+    token_type: 'Bearer',
+    scope: 'openid'
+  }
+}
+describe('GetToken', () => {
+  let atv: ATV
+  let getToken: GetToken
+
+  beforeEach(() => {
+    atv = new ATV()
+    getToken = new GetToken(atv)
+    ;(axios.post as jest.Mock).mockResolvedValue(fetchResponse)
+  })
+
+  afterEach(() => {
+    jest.resetAllMocks()
+  })
+
+  it('should call axios.post with correct parameters', async () => {
+    // Arrange
+    const dto: GetTokenDto = {
+      username: 'testuser',
+      password: 'testpassword'
+    }
+    const expectedUrl = 'https://idp.comprobanteselectronicos.go.cr/auth/realms/rut/protocol/openid-connect/token'
+    const expectedData = qs.stringify({
+      client_id: 'api-stag',
+      grant_type: 'password',
+      client_secret: '',
+      username: 'testuser',
+      password: 'testpassword'
+    })
+    const expectedConfig = {
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded'
+      }
+    }
+
+    // Act
+    await getToken.execute(dto)
+
+    // Assert
+    expect(axios.post).toHaveBeenCalledWith(expectedUrl, expectedData, expectedConfig)
+  })
+
+  it('should return expected response', async () => {
+    // Arrange
+    const expectedResponse = {
+      accessToken: 'access_token',
+      expiresIn: 3600,
+      refreshToken: 'refresh_token',
+      refreshExpiresIn: 1209600,
+      sessionState: 'session_state',
+      tokenType: 'Bearer',
+      scope: 'openid'
+    }
+
+    // Act
+    const result = await getToken.execute({ username: 'testuser', password: 'testpassword' })
+
+    // Assert
+    expect(result).toEqual(expectedResponse)
+  })
+})

package/src/services/getToken/index.ts

@@ -1,6 +1,6 @@
 import axios from 'axios'
 import qs from 'querystring'
-import { postTokenOptions } from './interfaces'
+import { postTokenOptions } from '@src/services/getToken/interfaces'
 
 const MAIN_DOMAIN = 'https://idp.comprobanteselectronicos.go.cr'
 const RUT = (process.env.IS_STG) ? 'rut-stag' : 'rut'

package/src/services/getToken/types.ts

@@ -0,0 +1,30 @@
+export type GetTokenDto = {
+  username: string;
+  password: string;
+}
+
+export type GetTokenInternalProps = {
+  serviceUrl: string;
+  clientId: string;
+};
+
+export type GetTokenRawResponse = {
+  access_token: string;
+  expires_in: number;
+  refresh_expires_in: number;
+  refresh_token: string;
+  token_type: string;
+  'not-before-policy': number;
+  session_state: string;
+  scope: string;
+}
+
+export type GetTokenResponse = {
+  accessToken: string;
+  expiresIn: number;
+  refreshExpiresIn: number;
+  refreshToken: string;
+  tokenType: string;
+  sessionState: string;
+  scope: string;
+}

package/src/services/send/index.ts

@@ -3,8 +3,8 @@ import axios from 'axios'
 const MAIN_DOMAIN = 'https://api.comprobanteselectronicos.go.cr/'
 const RUT = (process.env.IS_STG) ? 'recepcion-sandbox' : 'recepcion'
 const PATH = `${RUT}/v1/recepcion/`
-
-const URL = MAIN_DOMAIN + PATH
+const SANBOX_URL = 'https://api-sandbox.comprobanteselectronicos.go.cr/recepcion/v1/recepcion'
+const URL = (process.env.IS_STG) ? SANBOX_URL : MAIN_DOMAIN + PATH
 
 export function send(token: string, postOptions: any): Record<string, any> {
   return axios({

package/src/types/facturaInterfaces.d.ts

@@ -95,6 +95,23 @@ export interface FacturaElectronica {
   };
 }
 
+export interface FacturaElectronicaExportacion {
+  Clave: string;
+  CodigoActividad: string;
+  NumeroConsecutivo: string;
+  FechaEmision?: Date;
+  Emisor: Persona;
+  Receptor: Persona;
+  CondicionVenta?: string;
+  PlazoCredito?: string;
+  MedioPago?: string;
+  DetalleServicio?: DetalleServicio;
+  ResumenFactura: Resumen;
+  Otros?: {
+    OtroTexto: string;
+  };
+}
+
 export interface FacturaElectronicaContenedor {
-  FacturaElectronica: FacturaElectronica;
+  [key: 'FacturaElectronica' | 'FacturaElectronicaExportacion']: FacturaElectronica | FacturaElectronicaExportacion;
 }

package/src/types/globalInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { Persona, LineaDetalle } from './facturaInterfaces'
+import { Persona, LineaDetalle } from '@src/types/facturaInterfaces'
 
 export interface ClientPayload {
   Emisor: Persona;
@@ -14,6 +14,7 @@ export interface ClientPayload {
   total?: number; // deprecated
   impuesto?: number; // deprecated
   LineasDetalle: Array<LineaDetalle>;
+  facturaElectronicaType?: 'FacturaElectronica' | 'FacturaElectronicaExportacion';
 }
 
 export interface ClaveOpts {

package/src/types/xml/notaDeCredito.ts

@@ -1,4 +1,4 @@
-import { Persona, DetalleServicio, Resumen } from '../facturaInterfaces'
+import { Persona, DetalleServicio, Resumen } from '@src/types/facturaInterfaces'
 
 type NotaCreditoElectronica = {
   Clave: string;

package/src/types/xml/notaDeDebito.ts

@@ -1,4 +1,4 @@
-import { Persona, DetalleServicio, Resumen } from '../facturaInterfaces'
+import { Persona, DetalleServicio, Resumen } from '@src/types/facturaInterfaces'
 
 type NotaDebitoElectronica = {
   Clave: string;

package/tools/strToClave.ts

@@ -1,4 +1,4 @@
-import { stringToClave } from '../../src/lib/genClave'
+import { stringToClave } from '@src/lib/genClave'
 
 const output = stringToClave('50608022000310275915700100001010000000006100012313')
 console.log('output', output)

package/tools/xsdToJsonSchema.ts

@@ -0,0 +1,108 @@
+/* ======================================= */
+/* ============== WIP ==================== */
+/* ======================================= */
+/* Util to import ATV xsd and get some info like enums */
+import fs from 'fs'
+import * as Parser from 'fast-xml-parser'
+
+const options = {
+  ignoreAttributes: false,
+  ignoreNameSpace: true,
+  parseNodeValue: false,
+  attrNodeName: 'attributes',
+  attributeNamePrefix: ''
+}
+const sourceURI = process.env.XSD_SOURCE
+const xmlString = fs.readFileSync(sourceURI, 'utf8')
+
+const json = Parser.parse(xmlString, options)
+const originalShema = json?.schema
+const parentElement = originalShema?.element
+
+const complexElements = originalShema?.complexType
+const singleElements = originalShema?.simpleType
+
+function processEnumerations(array: Array<any>): any {
+  return array.map((enumeration) => {
+    return enumeration?.attributes?.value
+  })
+}
+
+function processLoop(array: Array<any>): any {
+  const newObj = {}
+  for (let i = 0; i < array.length; i++) {
+    const element = array[i]
+    const propKey = element?.attributes?.name
+    if (propKey) {
+      newObj[propKey] = {
+        description: element?.annotation?.documentation
+      }
+    }
+  }
+  return newObj
+}
+
+function processObject(object: any): any {
+  const props = processLoop(object?.complexType?.sequence?.element)
+  const newObject = {}
+  newObject[object?.attributes?.name] = {
+    type: 'object',
+    properties: props
+  }
+  return newObject
+}
+
+function processSimpleType(object: any): any {
+  const newObject = {}
+  const enumeration = object.restriction?.enumeration || []
+  const enumationList = processEnumerations(enumeration)
+  newObject[object?.attributes?.name] = {
+    type: object.restriction?.attributes?.base,
+    enum: enumationList,
+    pattern: object.restriction?.pattern
+  }
+  return newObject
+}
+
+function processElementsFromComplexType(array: Array<any>): any {
+  const newObj = {}
+  for (let i = 0; i < array.length; i++) {
+    const element = array[i]
+    const propKey = element?.attributes?.name
+    const simpleType = element?.simpleType ? processSimpleType(element?.simpleType) : {}
+    if (propKey) {
+      newObj[propKey] = {
+        description: element?.annotation?.documentation,
+        simpleType: simpleType
+      }
+    }
+  }
+  return newObj
+}
+
+function processComplexType(object: any): any {
+  const elements = processElementsFromComplexType(object?.sequence?.element)
+  const newObject = {}
+  newObject[object?.attributes?.name] = {
+    elements: elements
+  }
+  return newObject
+}
+
+const schema: Record<string, any> = {
+  $schema: 'https://json-schema.org/draft/2020-12/schema',
+  $id: 'https://facere.cr/schema.json',
+  title: 'undefined',
+  description: 'undefined',
+  type: 'object',
+  properties: {}
+}
+
+schema.properties = processObject(parentElement)
+schema.singleElements = singleElements.map(processSimpleType)
+schema.complexElements = complexElements.map(processComplexType)
+
+const data = JSON.stringify(schema, null, 2)
+fs.writeFile('./out.json', data, (err) => {
+  if (err) throw err
+})

package/tsconfig.json

@@ -19,6 +19,6 @@
       "@test/*": ["__tests__/*"]
     }
   },
-  "include": ["./src/**/*", "./test/**/*", "__tests__/stubs", "examples"],
+  "include": ["./src/**/*", "__tests__/**/*", "__tests__/stubs", "examples"],
   "exclude": ["node_modules/**/*"]
 }

package/dist/src/types/facturaInterfaces.d.ts

@@ -1,88 +0,0 @@
-export interface Impuesto {
-    Codigo: string;
-    CodigoTarifa: string;
-    Tarifa: number;
-    Monto?: number;
-}
-export interface LineaDetalle {
-    NumeroLinea?: string;
-    Codigo?: string;
-    Cantidad?: number;
-    UnidadMedida?: string;
-    Detalle: string;
-    PrecioUnitario: number;
-    MontoTotal?: number;
-    SubTotal?: number;
-    BaseImponible?: number;
-    Impuesto?: Impuesto;
-    MontoTotalLinea?: number;
-}
-export interface DetalleServicio {
-    LineaDetalle: Array<LineaDetalle>;
-}
-export interface Resumen {
-    CodigoTipoMoneda?: {
-        CodigoMoneda: string;
-        TipoCambio: string;
-    };
-    TotalServGravados: number;
-    TotalServExentos: number;
-    TotalServExonerado: number;
-    TotalMercanciasGravadas?: number;
-    TotalMercanciasExentas?: number;
-    TotalGravado?: number;
-    TotalExento: number;
-    TotalExonerado: number;
-    TotalVenta: number;
-    TotalDescuentos?: number;
-    TotalVentaNeta?: number;
-    TotalImpuesto: number;
-    TotalComprobante: number;
-}
-export interface Persona {
-    Nombre: string;
-    Identificacion: {
-        Tipo?: string;
-        Numero: string;
-    };
-    NombreComercial?: string;
-    Ubicacion?: {
-        Provincia?: '1' | '2' | '3' | '4' | '5' | '6' | '7';
-        Canton?: string;
-        Distrito?: string;
-        Barrio?: string;
-        OtrasSenas?: string;
-    };
-    Telefono?: {
-        CodigoPais?: string;
-        NumTelefono?: string;
-    };
-    Fax?: {
-        CodigoPais?: string;
-        NumTelefono?: string;
-    };
-    CorreoElectronico?: string;
-}
-export interface Message {
-    Mensaje: string;
-    DetalleMensaje: string;
-}
-export interface FacturaElectronica {
-    Clave: string;
-    CodigoActividad: string;
-    NumeroConsecutivo: string;
-    FechaEmision?: Date;
-    Emisor: Persona;
-    Receptor: Persona;
-    CondicionVenta?: string;
-    PlazoCredito?: string;
-    MedioPago?: string;
-    DetalleServicio?: DetalleServicio;
-    ResumenFactura: Resumen;
-    Otros?: {
-        OtroTexto: string;
-    };
-}
-export interface FacturaElectronicaContenedor {
-    FacturaElectronica: FacturaElectronica;
-}

package/dist/src/types/facturaInterfaces.js

@@ -1,7 +0,0 @@
-"use strict";
-/* references
-  https://www.hacienda.go.cr/ATV/ComprobanteElectronico/frmAnexosyEstructuras.aspx#
-  https://www.hacienda.go.cr/ATV/ComprobanteElectronico/docs/esquemas/2016/v4/ANEXOS%20Y%20ESTRUCTURAS.pdf
-*/
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=facturaInterfaces.js.map

package/dist/src/types/facturaInterfaces.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"facturaInterfaces.js","sourceRoot":"","sources":["../../../src/types/facturaInterfaces.ts"],"names":[],"mappings":";AAAA;;;EAGE"}