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

package/src/lib/genXML/xmlConfig.ts

@@ -1,8 +1,14 @@
 const FE_XML_SCHEMA_NS = 'https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/facturaElectronica'
 const FE_XML_SCHEMA_XSI = 'https://www.hacienda.go.cr/ATV/ComprobanteElectronico/docs/esquemas/2016/v4.3/FacturaElectronica_V4.3.xsd'
+
+const FEE_XML_SCHEMA_NS = 'https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/facturaElectronicaExportacion'
+const FEE_XML_SCHEMA_XSI = 'https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/facturaElectronicaExportacion.xsd'
+
 const MR_XML_SCHEMA_NS = 'https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/mensajeReceptor'
+
 const NC_XML_SCHEMA_NS = 'https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/notaCreditoElectronica'
 const NC_XML_SCHEMA_XSI = 'https://www.hacienda.go.cr/ATV/ComprobanteElectronico/docs/esquemas/2016/v4.3/NotaCreditoElectronica_V4.3.xsd'
+
 const ND_XML_SCHEMA_NS = 'https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/notaDebitoElectronica'
 const ND_XML_SCHEMA_XSI = 'https://www.hacienda.go.cr/ATV/ComprobanteElectronico/docs/esquemas/2016/v4.3/NotaDebitoElectronica_V4.3.xsd'
 
@@ -24,6 +30,12 @@ const FE_XML_ATTRS = { // Factura Electronica
   'xsi:schemaLocation': `${FE_XML_SCHEMA_NS} ${FE_XML_SCHEMA_XSI}`
 }
 
+const FEE_XML_ATTRS = { // Factura Electronica Exportación
+  xmlns: FE_XML_SCHEMA_NS,
+  ...COMMON_STRUCTURE,
+  'xsi:schemaLocation': `${FEE_XML_SCHEMA_NS} ${FEE_XML_SCHEMA_XSI}`
+}
+
 const NC_XML_ATTRS = { // Nota Credito Electronica
   xmlns: NC_XML_SCHEMA_NS,
   ...COMMON_STRUCTURE,
@@ -43,7 +55,8 @@ const MR_XML_ATTRS = { // Mensaje Receptor
 }
 
 export const xmlExtructures = {
-  FE: FE_XML_ATTRS,
+  FacturaElectronica: FE_XML_ATTRS,
+  FacturaElectronicaExportacion: FEE_XML_ATTRS,
   NC: NC_XML_ATTRS,
   ND: ND_XML_ATTRS,
   CCE: MR_XML_ATTRS,

package/src/services/getToken/GetToken.ts

@@ -0,0 +1,54 @@
+import axios from 'axios'
+import qs from 'querystring'
+import { GetTokenDto, GetTokenInternalProps, GetTokenRawResponse, GetTokenResponse } from './types'
+import { ATV } from '@src/ATV'
+
+const MAIN_DOMAIN = 'https://idp.comprobanteselectronicos.go.cr'
+const options: { [key: string]: GetTokenInternalProps} = {
+  prod: {
+    serviceUrl: `${MAIN_DOMAIN}/auth/realms/rut/protocol/openid-connect/token`,
+    clientId: 'api'
+  },
+  stg: {
+    serviceUrl: `${MAIN_DOMAIN}/auth/realms/rut-stag/protocol/openid-connect/token`,
+    clientId: 'api-stag'
+  }
+}
+
+export class GetToken {
+  private readonly props: GetTokenInternalProps;
+  constructor(scope: ATV) {
+    this.props = this.initProps(scope.mode)
+  }
+
+  public async execute({ username, password }: GetTokenDto): Promise<GetTokenResponse> {
+    const fetchResponse = await axios.post<GetTokenRawResponse>(this.props.serviceUrl, qs.stringify({
+      // eslint-disable-next-line @typescript-eslint/camelcase
+      client_id: this.props.clientId,
+      // eslint-disable-next-line @typescript-eslint/camelcase
+      grant_type: 'password',
+      // eslint-disable-next-line @typescript-eslint/camelcase
+      client_secret: '',
+      username,
+      password
+    }), {
+      headers: {
+        'Content-Type': 'application/x-www-form-urlencoded'
+      }
+    })
+    const data = fetchResponse.data
+    return {
+      accessToken: data.access_token,
+      expiresIn: data.expires_in,
+      refreshToken: data.refresh_token,
+      refreshExpiresIn: data.refresh_expires_in,
+      sessionState: data.session_state,
+      tokenType: data.token_type,
+      scope: data.scope
+    }
+  }
+
+  private initProps(mode: string): GetTokenInternalProps {
+    return options[mode] || options.prod
+  }
+}

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.ts → 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,6 +1,6 @@
-import { Persona, LineaDetalle } from './facturaInterfaces'
+import { Persona, LineaDetalle } from '@src/types/facturaInterfaces'
 
-export interface FrontEndRequest {
+export interface ClientPayload {
   Emisor: Persona;
   Receptor: Persona;
   sucursal?: string;
@@ -11,7 +11,10 @@ export interface FrontEndRequest {
   consecutivo: string;
   situationEC: string;
   actividad: string;
+  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/{test/tools → 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

@@ -4,18 +4,21 @@
     "esModuleInterop": true,
     "target": "es6",
     "moduleResolution": "node",
+    "declaration": true,
     "module": "commonjs",
     "sourceMap": true,
     "rootDir": ".",
     "outDir": "dist",
     "baseUrl": ".",
+    "skipLibCheck": true,
     "lib": [
       "esnext", "dom"
     ],
     "paths": {
       "@src/*": ["src/*"],
-      "@test/*": ["test/*"]
+      "@test/*": ["__tests__/*"]
     }
   },
-  "include": ["./src/**/*", "./test/**/*", "__tests__/stubs"]
+  "include": ["./src/**/*", "__tests__/**/*", "__tests__/stubs", "examples"],
+  "exclude": ["node_modules/**/*"]
 }

package/test/examples/README.md

@@ -1,43 +0,0 @@
-# Ejemplos con implementaciones para pruebas
-
-Para probar crear y enviar factura
-```
-ts-node -r tsconfig-paths/register test/examples/createAndSend.ts
---require dotenv/config test/examples/createAndSend.ts
-```
-
-Para probar genJson HeaderXML
-```
-ts-node -r tsconfig-paths/register test/examples/createAndSend.ts
---require dotenv/config test/examples/genBasicXML.ts
-```
-
-Generar la clave
-```
-ts-node -r tsconfig-paths/register test/examples/createAndSend.ts
- --require dotenv/config test/examples/getClave.ts
-```
-
-Para crear una nota de credito
-```
-ts-node -r tsconfig-paths/register test/examples/createAndSend.ts
- --require dotenv/config test/examples/createCreditNote.ts
-```
-
-## Testing
-Para probar las funcionalidades se recomienda crear un .env en donde se especifiquen datos de prueba.
-```
-USERNAME_TEST=
-PASSWORD_TEST=
-IS_STG=1
-SOURCE_P12_URI=
-SOURCE_P12_PASSPORT=
-SOURCE_URI_XML_OUTPUT=
-XML_TO_CONFIRM=
-```
-
-## Tools
-Para usar readXML establecer en .env
-```
-SOURCE_URI=
-```

package/test/examples/getToken.ts

@@ -1,18 +0,0 @@
-import getToken from '@src/services/getToken'
-
-const IS_STG = process.env.IS_STG
-const USERNAME_TEST = process.env.USERNAME_TEST
-const PASSWORD_TEST = process.env.PASSWORD_TEST
-console.log('process.env.IS_STG', IS_STG)
-
-getToken({
-  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: USERNAME_TEST,
-  password: PASSWORD_TEST
-}).then((result) => {
-  console.log('res', result.data)
-}).catch((e) => {
-  console.log('e', e.response.data)
-})