@deuriib/dgii-ecf

中文文档
0.6.1发布于 2026/11/10MITTypeScriptESM + CJS构建来源已验证近 30 天下载 2444

DGII e-CF electronic invoicing SDK for the Dominican Republic — authenticate, sign (XMLDSig/C14N) and transmit electronic tax documents. Bun-first, native fetch, result-pattern.

原始使用文档
文档目录6 节
  1. Install
  2. Quick start
  3. Result pattern
  4. Resilience & idempotency
  5. Modules
  6. License

@deuriib/dgii-ecf

DGII e-CF electronic invoicing SDK for the Dominican Republic.

Bun-first, native fetch, strict TypeScript, and result-pattern (neverthrow) — no hidden exceptions. Signs XMLDSig documents (inclusive C14N + RSA-SHA256) and transmits them to DGII reliably with retry, circuit breaker, timeout, and idempotent submission.

Install

bun add @deuriib/dgii-ecf
# or
npm install @deuriib/dgii-ecf

Server-side only. Never use in a browser — it handles private keys.

Quick start

import { ECF, Environment, P12Reader, Signature } from '@deuriib/dgii-ecf';

// 1. Read the certificate (.p12)
const reader = new P12Reader(process.env.CERT_PASSWORD ?? '');
const credentials = reader.getKeyFromFile('/secure/identity.p12');
if (credentials.isErr()) throw credentials.error;

// 2. Authenticate against DGII
const ecf = new ECF(credentials.value, Environment.Cert);
const auth = await ecf.authenticate();
if (auth.isErr()) throw auth.error;

// 3. Sign and submit
const signature = new Signature(
  credentials.value.key!,
  credentials.value.cert!,
);
const signed = signature.signXml(xml);
if (signed.isErr()) throw signed.error;

const response = await ecf.sendElectronicDocument(
  signed.value,
  '101672919E3100000001.xml',
);
response.match(
  (invoice) => console.log('trackId', invoice.trackId),
  (error) => console.error('DGII error', error.message),
);

Result pattern

Every fallible operation returns a Result:

const result = await ecf.statusTrackId('some-track-id');
if (result.isOk()) {
  console.log(result.value.estado);
} else {
  console.error(result.error.code, result.error.message);
}

Resilience & idempotency

  • Transient failures (network, timeout, 408/429/5xx) are retried with exponential backoff and guarded by a consecutive-failure circuit breaker.
  • sendElectronicDocument / sendSummary are keyed by RNC + eNCF + SHA-256(signed XML); provide a persistent IdempotencyStore (Redis/Postgres) in production:
const ecf = new ECF(credentials, Environment.Prod, {
  idempotencyStore: myRedisStore, // { get, set, delete }
});

Modules

environment, types, errors, result, resilience, http, certificate, signing, transformer, reception, reconciliation, validation, utils, client.

License

MIT © 2026 Deuri Vasquez

版本与发布记录

@deuriib/dgii-ecf 共发布 14 个版本,首次发布于 2026/11/02;过去 12 个月发布了 14 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.6.1latest2026/11/103 天前
0.6.02026/11/0310 天前
0.5.12026/11/0310 天前
0.5.02026/11/0310 天前
0.4.12026/11/0310 天前
0.4.02026/11/0211 天前

关于 @deuriib/dgii-ecf 的常见问题

@deuriib/dgii-ecf 是什么?

DGII e-CF electronic invoicing SDK for the Dominican Republic — authenticate, sign (XMLDSig/C14N) and transmit electronic tax documents. Bun-first, native fetch, result-pattern.

如何安装 @deuriib/dgii-ecf?

在项目目录运行 npm install @deuriib/dgii-ecf,或使用 pnpm add / yarn add / bun add。

@deuriib/dgii-ecf 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@deuriib/dgii-ecf 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@deuriib/dgii-ecf 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@deuriib/dgii-ecf 可以商用吗?

@deuriib/dgii-ecf 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@deuriib/dgii-ecf 的下载量有多少?

根据 npm 官方下载统计,@deuriib/dgii-ecf 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,444 次,日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@deuriib/dgii-ecf 还在维护吗?

最新版本 0.6.1 发布于 2026/11/10(3 天前);至今共发布 14 个版本,其中过去 12 个月发布了 14 个;首次发布于 2026/11/02。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。