angelmadames / dgii-rnc-api

An open-source, community-driven API for the DGII National Taxpayer Registry (RNC) in the Dominican Republic.

DGII RNC ― API

Contents

• Overview
• Commands
• Database
  • Migrations
• Installation
• Running the API
• How to contribute
• License

Overview

An Open-source Community-driven API for the National Taxpayer Registry (RNC) of the Dominican Republic.

Created using Nest.

Commands

The DGII RNC API uses two commands:

• download-rnc-file: downloads the DGII RNC zip file that will be processed by the API.

  To run the download-rnc-file command, you can use:

  npm run download-rnc-file
  # which executes the shell command: `ts-node ./src/cli.ts download-rnc-file`

• process-rnc-file: ingests the unzipped RNC file (txt format by sending jobs to the queue. If the API server is running, it will begin processing the jobs right away.

  To run the process-rnc-file command, you can use:

  npm run process-rnc-file
  # which executes the shell command: `ts-node ./src/cli.ts process-rnc-file`

Database

The supported relational database for this project is PostgreSQL >= 16.x.

Migrations

To run the database migrations, first build the project, and then run:

npm run migration:run

Installation

npm ci

Running the API

npm run start # development mode
npm run dev # watch mode
npm run production # production mode

How to contribute

Read the contribution guidelines.

License

The DGII RNC API is MIT licensed.

dgii-rnc-api's Issues

Set up guidelines for contributions

Summary

• We need to set up some guidelines for contributions, as we are going open-source soon!

References

• https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Implement release-it

Summary

• We don't do manual stuff over here, with release-it with can generate automatic versioning and releases, as well as changelogs!

Remove unused or unnecessary code

Summary

• A good code base needs to be free of unnecessary or unused code. We have to get rid of everything not in use, to avoid confusion and keep simplicity as a core value.

Add pagination to RNC endpoint

Summary

The root endpoint for the RNC module returns all DB records without pagination.

Expected behavior

The root endpoint for the RNC module returns DB records with pagination.

Parse RNC CSV file with proper line endings and encoding

Summary

• When parsing the DGII RNC file, avoid inserting unknown characters into the database.

Implement Renovate

Summary

• Gotta keep those dependencies secure and up to date! 🔒

Use appropiate entity/schema types for RNC table

Summary

• All columns in the RNC entity schema use string as type. By using TypeScript and TypeORM, we are not taking advantage of the default validations and benefits proper data types would be for parsing and processing correctly the RNC file.

Suggested changes

• creationDate -> Date
• paymentSystem -> Enum
• status -> Enum

Add code of conduct

Summary

• We need to set up the repository code of conduct, as we are going open-source soon!

References

• https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project

Test database migrations on every Pull Request

Summary

• Database migrations should be tested on every PR.

Enable local development environment with Docker + Compose

Summary

• Ensuring a working setup locally is essential for a welcoming open-source community. This issue tracks the effort of enabling Docker and Docker Compose for such purpose, also documenting how to use it in the README.md file.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• chore(deps): update dependency @nestjs/cli to v10.4.4
• fix(deps): update dependency nest-commander to v3.15.0
• 🔐 Create all rate-limited PRs at once 🔐

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update dependency axios to v1.7.4 [security]
• chore(deps): update dependency ts-jest to v29.2.5
• chore(deps): update dependency typescript to v5.5.4
• fix(deps): update dependency @nestjs/mapped-types to v2.0.5
• chore(deps): update dependency @types/node to v20.16.1
• chore(deps): update dependency node to v20.17.0
• fix(deps): update dependency @inquirer/prompts to v5.3.8
• fix(deps): update dependency @nestjs/bull to v10.2.1
• fix(deps): update dependency bull to v4.16.0
• fix(deps): update nest monorepo (@nestjs/common, @nestjs/core, @nestjs/platform-express, @nestjs/schematics, @nestjs/testing)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

asdf

.tool-versions

• node 20.15.0

docker-compose

docker-compose.yml

dockerfile

Dockerfile

• node 20-alpine
• node 20-alpine

github-actions

.github/workflows/tests.yml

• actions/checkout v4
• actions/setup-node v4
• postgres 16-alpine

npm

package.json

• @inquirer/prompts ^5.1.2
• @nestjs/bull ^10.1.1
• @nestjs/common ^10.3.10
• @nestjs/config ^3.2.3
• @nestjs/core ^10.3.10
• @nestjs/mapped-types *
• @nestjs/platform-express ^10.3.10
• @nestjs/typeorm ^10.0.2
• axios ^1.7.2
• bull ^4.15.1
• chalk ^5.3.0
• dotenv ^16.4.5
• nest-commander ^3.14.0
• pg ^8.12.0
• rxjs ^7.8.1
• typeorm ^0.3.20
• @biomejs/biome ^1.8.3
• @nestjs/cli ^10.4.2
• @nestjs/schematics ^10.1.2
• @nestjs/testing ^10.3.10
• @types/express ^4.17.21
• @types/jest ^29.5.12
• @types/node ^20.14.10
• @types/supertest ^6.0.2
• jest ^29.7.0
• source-map-support ^0.5.21
• supertest ^7.0.0
• ts-jest ^29.2.2
• ts-loader ^9.5.1
• ts-node ^10.9.2
• tsconfig-paths ^4.2.0
• typescript ^5.5.3

---

• Check this box to trigger a request for Renovate to run again on this repository

RNC download file command should overwrite existing files

Current behavior

• The current RNC download command does not update the unzipped file if it already exists.

Expected behavior

• The current RNC download command should overwrite the existing file if the user agrees to do so.
• If the user uses a command flag (ie. --overwrite) the command should overwrite the file without interactivity inputs.

Add basic Unit tests

Summary

• We need some basic unit tests for our controller, commands, and utilities!