@facturacr/atv-sdk 0.0.7-beta → 0.0.9-beta

package/examples/confirmXML.ts

@@ -43,7 +43,7 @@ async function main(): Promise<void> {
     }
     const data = await confirmXML({
       token: token.data.access_token,
-      consecutivo: consecutivo,
+      consecutivo,
       xmlStr: xml,
       tipoDocKey: 'CCE',
       pemOpt: {

package/examples/createAndSend.ts

@@ -1,8 +1,6 @@
-import { ClientPayload } from '@src/types/globalInterfaces'
-import requestStub from '@test/stubs/frontendRequest.stub'
-import { eletronicBill, sendToCustomURL } from '@src/index'
 import fs from 'fs'
 import { ATV } from '@src/ATV'
+import { createDocumentInputStub } from '@test/stubs/createDocument.stub'
 
 const IS_STG = process.env.IS_STG
 const USERNAME_TEST = process.env.USERNAME_TEST
@@ -18,22 +16,22 @@ if (!SOURCE_P12_PASSPORT || !SOURCE_P12_URI) {
 
 const pem = fs.readFileSync(SOURCE_P12_URI, 'binary')
 
-const frontEndRequest: ClientPayload = requestStub
+console.log('requestStub consecutivo', createDocumentInputStub.consecutiveIdentifier)
 
-console.log('requestStub consecutivo', requestStub.consecutivo)
+// TODO: dynamic param --identifier 1 args[x]
+createDocumentInputStub.consecutiveIdentifier = '1'
 
-function decodeBase64(encodedStr: string): string {
-  const buff = Buffer.from(encodedStr, 'base64')
-  return buff.toString('ascii')
-}
-
-function getConfimation(token: string, data: any, ms: number): Promise<any> {
+function getConfimation(atv: ATV, token: string, location: string, ms: number): Promise<any> {
   return new Promise((resolve, reject): any => {
     setTimeout(() => {
-      const location = data?.headers?.location
       console.log('location', location)
-      sendToCustomURL(token, location)
-        .then(data => resolve(data))
+      atv.sendConfirmation({
+        url: location,
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: 'bearer ' + token
+        }
+      }).then(data => resolve(data))
         .catch(err => reject(err))
     }, ms)
   })
@@ -45,26 +43,23 @@ async function main(): Promise<void> {
     username: USERNAME_TEST,
     password: PASSWORD_TEST
   })
-  const token = tokenData.accessToken
-  const data = await eletronicBill(token, frontEndRequest, {
-    buffer: pem,
-    password: SOURCE_P12_PASSPORT
-  })
-  if (data) {
-    const secondResponse = await getConfimation(token, data, 5000)
-      .catch(err => {
-        const response = err.response || {}
-        console.log('response', response)
-      })
-    const XMLResponse = secondResponse.data['respuesta-xml']
-    if (!XMLResponse) {
-      const state = secondResponse.data['ind-estado']
-      console.log('state', state)
-      return
+  const { command, extraData } = await atv.createDocumentCommand({
+    document: createDocumentInputStub,
+    token: tokenData.accessToken,
+    signatureOptions: {
+      buffer: pem,
+      password: SOURCE_P12_PASSPORT
     }
-    const text = decodeBase64(XMLResponse)
-    console.log('secondResponse', text)
+  })
+  // console.log('command', command)
+  // console.log('extraData', extraData)
+  const response = await atv.sendDocument(command)
+  if (response.errorCause) {
+    console.log('error response', response)
+    return
   }
+  const confirmationResponse = await getConfimation(atv, tokenData.accessToken, response.location, 1000)
+  console.log({ MensajeHacienda: confirmationResponse.confirmation })
 }
 
 main()

package/examples/getToken.ts

@@ -4,8 +4,9 @@ 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)
-
-const atv = new ATV({}, 'stg')
+console.log('password', PASSWORD_TEST)
+const mode = IS_STG ? 'stg' : undefined
+const atv = new ATV({}, mode)
 const tokenData = atv.getToken({
   username: USERNAME_TEST,
   password: PASSWORD_TEST

package/jest-setup.js

@@ -0,0 +1,5 @@
+module.exports = async function (globalConfig, projectConfig) {
+    process.env.TZ = 'UTC';
+  };
+  
+  

package/jest.config.js

@@ -10,15 +10,16 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      statements: 58,
-      branches: 35,
-      functions: 58,
-      lines: 58
+      statements: 54,
+      branches: 38,
+      functions: 65,
+      lines: 54
     }
   },
   restoreMocks: true,
   collectCoverage: true,
   collectCoverageFrom: [
     'src/**/*.{ts,js}'
-  ]
+  ],
+  globalSetup: './jest-setup.js'
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@facturacr/atv-sdk",
-  "version": "0.0.7-beta",
+  "version": "0.0.9-beta",
   "description": "Librería (SDK) de Javascript/NodeJS para acceder al API de Administración Tributaria Virtual (ATV) del Ministerio de Hacienda.",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -10,11 +10,13 @@
     "test": "__test__"
   },
   "scripts": {
-    "test": "npx jest",
+    "test": "npx jest --no-coverage",
+    "test:cov": "npx jest",
     "dev": "dotenv -- nodemon -e ts,graphql -x 'yarn lint & ts-node -r tsconfig-paths/register src/index.ts'",
     "build": "yarn lint & tsc",
     "lint": "eslint --ext .ts, --ignore-path .gitignore .",
-    "publish": "yarn build & npm publish"
+    "publish": "yarn build & npm publish",
+    "test:createAndSend": "yarn ts-node -r tsconfig-paths/register --require dotenv/config examples/createAndSend.ts"
   },
   "repository": {
     "type": "git",
@@ -31,28 +33,30 @@
   },
   "homepage": "https://github.com/facturacr/facturar-costa-rica-lib#readme",
   "devDependencies": {
-    "@types/jest": "^26.0.15",
+    "@types/jest": "^29.5",
     "@types/node": "^14.14.39",
-    "@typescript-eslint/eslint-plugin": "^2.3.0",
-    "@typescript-eslint/parser": "^2.3.0",
+    "@typescript-eslint/eslint-plugin": "^7.4.0",
+    "@typescript-eslint/parser": "^7.4.0",
     "dotenv-cli": "^4.0.0",
-    "eslint": "^6.4.0",
-    "eslint-config-standard": "^14.1.0",
-    "eslint-plugin-import": "^2.18.2",
+    "eslint": "^8.57.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.3.1",
+    "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-standard": "^5.0.0",
-    "jest": "^26.6.3",
+    "jest": "^29.7",
+    "jest-xml-matcher": "^1.2.0",
     "nodemon": "^2.0.19",
-    "ts-jest": "^26.5.6",
+    "ts-jest": "^29.1",
     "ts-node": "10.9.1",
     "tsc": "^1.20150623.0",
-    "tsconfig-paths": "^3.9.0",
+    "tsconfig-paths": "^4.2.0",
     "typescript": "^4.2.4"
   },
   "dependencies": {
     "@peculiar/webcrypto": "^1.1.6",
-    "axios": "^0.21.1",
+    "axios": "^0.28.0",
     "fast-xml-parser": "^3.19.0",
     "node-forge": "^1.3.0",
     "xadesjs": "^2.1.2",

package/src/ATV/core/Clave.ts

@@ -0,0 +1,41 @@
+import { genClaveObj, genString } from '@src/lib/genClave'
+
+type ClaveProps = {
+  countryCode: string; // codigoPais
+  docKeyType: string; // tipoDocKey
+  identifierType: string; // tipoCedula
+  emitterIdentifier: string; // cedulaEmisor
+  ceSituation: string; // situacionCE
+  consecutiveIdentifier: string; // consecutivo
+  securityCode: string; // codigoSeguridad
+  branch: string; // sucursal
+  terminal: string; // terminal
+}
+
+export class Clave {
+  private props: ClaveProps
+
+  get value(): string {
+    const claveObj = genClaveObj({
+      cedulaEmisor: this.props.emitterIdentifier,
+      codigoPais: this.props.countryCode,
+      codigoSeguridad: this.props.securityCode,
+      consecutivo: this.props.consecutiveIdentifier,
+      situacionCE: this.props.ceSituation,
+      sucursal: this.props.branch,
+      terminal: this.props.terminal,
+      tipoCedula: this.props.identifierType,
+      tipoDocKey: this.props.docKeyType
+    })
+    const claveStr = genString(claveObj)
+    return claveStr
+  }
+
+  constructor(props: ClaveProps) {
+    this.props = props
+  }
+
+  public static create(props: ClaveProps): Clave {
+    return new Clave(props)
+  }
+}

package/src/ATV/core/Document.ts

@@ -0,0 +1,123 @@
+import { Clave } from './Clave'
+import { FullConsecutive } from './FullConsecutive'
+import { OrderLine } from './OrderLine'
+import { Person } from './Person'
+import { SummaryProps } from './Summary.type'
+
+export type InvoiceProps = {
+  clave: Clave;
+  fullConsecutive: FullConsecutive;
+  activityCode: string; // CodigoActividad
+  issueDate: Date; // FechaEmision
+  emitter: Person; // Emisor
+  receiver: Person; // Receptor
+  orderLines: OrderLine[];
+  conditionSale?: string; // CondicionVenta
+  deadlineCredit?: string; // PlazoCredito
+  paymentMethod?: string; // MedioPago
+  summaryInvoice?: SummaryProps; // ResumenFactura
+  others?: { // Otros
+    OtroTexto: string;
+  };
+}
+
+type OrderLineSum = {
+  totalAmount: number;
+  totalTaxes: number;
+}
+
+export class Document {
+  public readonly props: InvoiceProps
+  constructor(props: InvoiceProps) {
+    this.props = props
+  }
+
+  get clave(): string {
+    return this.props.clave.value
+  }
+
+  get fullConsecutive(): string {
+    return this.props.fullConsecutive.value
+  }
+
+  get activityCode(): string {
+    return this.props.activityCode
+  }
+
+  get issueDate(): Date {
+    return this.props.issueDate
+  }
+
+  get emitter(): Person {
+    return this.props.emitter
+  }
+
+  get receiver(): Person {
+    return this.props.receiver
+  }
+
+  get orderLines(): OrderLine[] {
+    return this.props.orderLines
+  }
+
+  get conditionSale(): string | undefined {
+    return this.props.conditionSale
+  }
+
+  get deadlineCredit(): string | undefined {
+    return this.props.deadlineCredit
+  }
+
+  get paymentMethod(): string | undefined {
+    return this.props.paymentMethod
+  }
+
+  get others(): { OtroTexto: string } | undefined {
+    return this.props.others
+  }
+
+  get summaryInvoice(): SummaryProps {
+    if (this.props.summaryInvoice) {
+      return this.props.summaryInvoice
+    }
+    const orderLineSumResult = this.sumCreditLines()
+    const summary = {
+      currency: {
+        code: 'CRC',
+        exchangeRate: '585.69'
+      },
+      totalExemptServices: 0,
+      totalEncumberedServices: 0,
+      totalExonerated: 0,
+      totalTaxedServices: 0,
+      totalTaxes: orderLineSumResult.totalTaxes,
+      totalDiscounts: 0,
+      totalEncumberedMerchandise: orderLineSumResult.totalAmount,
+      totalTaxed: orderLineSumResult.totalTaxes,
+      totalExemptMerchandise: 0,
+      totalExempt: 0,
+      totalNetSale: orderLineSumResult.totalAmount,
+      totalEncumbered: orderLineSumResult.totalAmount
+    }
+    const totalSale = summary.totalEncumbered + summary.totalExempt + summary.totalExonerated
+    return {
+      ...summary,
+      totalSale,
+      totalNetSale: totalSale - summary.totalDiscounts,
+      totalVoucher: summary.totalNetSale + summary.totalTaxed
+    }
+  }
+
+  sumCreditLines(): OrderLineSum {
+    return this.orderLines.reduce<OrderLineSum>((previousValue, currentValue) => {
+      return {
+        totalAmount: previousValue.totalAmount + currentValue.totalAmount,
+        totalTaxes: previousValue.totalTaxes + currentValue.tax.amount
+      }
+    }, { totalAmount: 0, totalTaxes: 0 })
+  }
+
+  public static create(props: InvoiceProps): Document {
+    return new Document(props)
+  }
+}

package/src/ATV/core/DocumentType.ts

@@ -0,0 +1,23 @@
+import { DocumentNames } from './documentNames.types'
+
+const map: {[key: string]: DocumentTypeValues} = {
+  FacturaElectronica: 'FE',
+  FacturaElectronicaExportacion: 'FE',
+  NotaCreditoElectronica: 'NC',
+  NotaDebitoElectronica: 'NC'
+}
+
+type DocumentTypeValues = 'FE' | 'ND' | 'NC' | 'TE'
+
+export class DocumentType {
+  value: DocumentTypeValues
+
+  constructor(value: DocumentTypeValues) {
+    this.value = value
+  }
+
+  static create(documentName: DocumentNames): DocumentType {
+    const value = map[documentName]
+    return new DocumentType(value)
+  }
+}

package/src/ATV/core/FullConsecutive.ts

@@ -0,0 +1,29 @@
+import { consecutivoStr } from '@src/lib/genClave'
+
+type FullConsecutiveProps = {
+  consecutiveIdentifier: string;
+  documentType?: string;
+  branch?: string;
+  terminal?: string;
+}
+
+export class FullConsecutive {
+  private props: FullConsecutiveProps
+
+  get value(): string {
+    return consecutivoStr({
+      tipoDocKey: this.props.documentType,
+      sucursal: this.props.branch,
+      terminal: this.props.terminal,
+      consecutivo: this.props.consecutiveIdentifier
+    })
+  }
+
+  constructor(props: FullConsecutiveProps) {
+    this.props = props
+  }
+
+  public static create(props: FullConsecutiveProps): FullConsecutive {
+    return new FullConsecutive(props)
+  }
+}

package/src/ATV/core/OrderLine.ts

@@ -0,0 +1,95 @@
+type TaxProps = {
+  code: string;
+  rateCode: string;
+  rate: number;
+  amount?: number;
+}
+
+type OrderLineProps = {
+  detail: string;
+  unitaryPrice: number;
+  lineNumber?: string;
+  code?: string; // CAByS - https://www.bccr.fi.cr/seccion-indicadores-economicos/cat%C3%A1logo-de-bienes-y-servicios
+  quantity?: number;
+  measureUnit?: string;
+  totalAmount?: number;
+  subTotal?: number;
+  tax?: TaxProps;
+  totalOrderLineAmount?: number;
+  // BaseImponible?: number;
+}
+
+export class OrderLine {
+  props: OrderLineProps
+
+  constructor(props: OrderLineProps) {
+    this.props = props
+  }
+
+  get detail(): string {
+    return this.props.detail
+  }
+
+  get unitaryPrice(): number {
+    return this.props.unitaryPrice
+  }
+
+  get lineNumber(): string | undefined {
+    return this.props.lineNumber
+  }
+
+  get code(): string | undefined {
+    return this.props.code
+  }
+
+  get quantity(): number {
+    return this.props.quantity || 1
+  }
+
+  get measureUnit(): string {
+    return this.props.measureUnit || 'Sp'
+  }
+
+  get subTotal(): number {
+    return this.props.subTotal || this.props.unitaryPrice * this.quantity // subtract discounts
+  }
+
+  get totalAmount(): number {
+    return this.props.totalAmount || this.props.unitaryPrice * this.quantity
+  }
+
+  get totalOrderLineAmount(): number {
+    return this.props.totalOrderLineAmount || this.subTotal + this.tax.amount
+  }
+
+  get tax(): TaxProps {
+    const rate = this.props.tax.rate
+    return {
+      rate,
+      code: this.props.tax.code,
+      rateCode: this.props.tax.rateCode,
+      amount: this.subTotal * (rate / 100)
+    }
+  }
+
+  public static create(props: OrderLineProps): OrderLine {
+    const orderLineProps = {
+      lineNumber: props.lineNumber,
+      code: props.code,
+      quantity: props.quantity || 1,
+      measureUnit: props.measureUnit || 'Sp',
+      detail: props.detail,
+      unitaryPrice: props.unitaryPrice,
+      totalAmount: props.totalAmount
+    }
+    const tax: TaxProps = {
+      code: props.tax.code,
+      rate: props.tax.rate || 13,
+      rateCode: props.tax.rateCode
+    }
+    return new OrderLine({
+      ...orderLineProps,
+      tax
+    })
+  }
+}

package/src/ATV/core/Person.ts

@@ -0,0 +1,68 @@
+export type LocationProps = {
+  province: '1' | '2' | '3' | '4' | '5' | '6' | '7';
+  canton: string;
+  district: string;
+  neighborhood: string;
+  details?: string;
+}
+
+export type PhoneProps = {
+  countryCode: string;
+  number: string;
+}
+
+export type PersonProps = {
+  fullName: string;
+  identifier: {
+    type: '01' | '02';
+    id: string;
+  };
+  commercialName: string;
+  location?: LocationProps;
+  phone?: PhoneProps;
+  fax?: PhoneProps;
+  email?: string;
+}
+
+export class Person {
+  props: PersonProps
+  constructor(props: PersonProps) {
+    this.props = props
+  }
+
+  get fullName(): string {
+    return this.props.fullName
+  }
+
+  get identifierType(): string | undefined {
+    return this.props.identifier.type
+  }
+
+  get identifierId(): string {
+    return this.props.identifier.id
+  }
+
+  get commercialName(): string {
+    return this.props.commercialName
+  }
+
+  get location(): LocationProps | undefined {
+    return this.props.location
+  }
+
+  get phone(): PhoneProps | undefined {
+    return this.props.phone
+  }
+
+  get fax(): PhoneProps | undefined {
+    return this.props.fax
+  }
+
+  get email(): string | undefined {
+    return this.props.email
+  }
+
+  public static create(props: PersonProps): Person {
+    return new Person(props)
+  }
+}

package/src/ATV/core/Summary.type.ts

@@ -0,0 +1,20 @@
+export type SummaryProps = {
+  currency?: {
+    code: string;
+    exchangeRate: string;
+  };
+  totalTaxedServices: number; // TotalServGravados
+  totalExemptServices: number; // TotalServExentos
+  totalEncumberedServices: number; // TotalServExonerado
+  totalExemptMerchandise?: number; // TotalMercanciasGravadas
+  totalEncumberedMerchandise?: number; // TotalMercanciasExentas
+  totalEncumbered: number; // TotalGravado
+  totalTaxed?: number;
+  totalExempt: number; // TotalExento
+  totalExonerated: number; // TotalExonerado
+  totalSale: number; // TotalVenta
+  totalDiscounts?: number; // TotalDescuentos
+  totalNetSale?: number; // TotalVentaNeta
+  totalTaxes: number; // TotalImpuesto
+  totalVoucher: number; // TotalComprobante
+}

package/src/ATV/core/documentNames.types.ts

@@ -0,0 +1,5 @@
+export type DocumentNames =
+  'FacturaElectronica' |
+  'FacturaElectronicaExportacion' |
+  'NotaCreditoElectronica' |
+  'NotaDebitoElectronica'