@ssddo/ecf-sdk 0.1.0

package/dist/index.js

@@ -0,0 +1,420 @@
+// src/client.ts
+import createClient from "openapi-fetch";
+
+// src/polling.ts
+var PollingTimeoutError = class extends Error {
+  constructor(message = "Polling timed out") {
+    super(message);
+    this.name = "PollingTimeoutError";
+  }
+};
+var PollingMaxRetriesError = class extends Error {
+  constructor(retries) {
+    super(`Polling exceeded maximum retries (${retries})`);
+    this.name = "PollingMaxRetriesError";
+  }
+};
+async function pollUntilComplete(fn, isComplete, options) {
+  const {
+    initialDelay = 1e3,
+    maxDelay = 3e4,
+    maxRetries = 60,
+    backoffMultiplier = 2,
+    timeout,
+    signal
+  } = options ?? {};
+  const startTime = Date.now();
+  let delay = initialDelay;
+  let retries = 0;
+  while (true) {
+    if (signal?.aborted) {
+      throw new DOMException("Polling was aborted", "AbortError");
+    }
+    const result = await fn();
+    if (isComplete(result)) {
+      return result;
+    }
+    retries++;
+    if (retries >= maxRetries) {
+      throw new PollingMaxRetriesError(maxRetries);
+    }
+    if (timeout !== void 0 && Date.now() - startTime >= timeout) {
+      throw new PollingTimeoutError();
+    }
+    await sleep(delay, signal);
+    delay = Math.min(delay * backoffMultiplier, maxDelay);
+  }
+}
+function sleep(ms, signal) {
+  return new Promise((resolve, reject) => {
+    if (signal?.aborted) {
+      reject(new DOMException("Polling was aborted", "AbortError"));
+      return;
+    }
+    const timer = setTimeout(resolve, ms);
+    signal?.addEventListener(
+      "abort",
+      () => {
+        clearTimeout(timer);
+        reject(new DOMException("Polling was aborted", "AbortError"));
+      },
+      { once: true }
+    );
+  });
+}
+
+// src/client.ts
+var ENVIRONMENT_URLS = {
+  test: "https://api.test.ecfx.ssd.com.do",
+  cert: "https://api.cert.ecfx.ssd.com.do",
+  prod: "https://api.prod.ecfx.ssd.com.do"
+};
+var ECF_TYPE_ROUTE_MAP = {
+  FacturaDeCreditoFiscalElectronica: "31",
+  FacturaDeConsumoElectronica: "32",
+  NotaDeDebitoElectronica: "33",
+  NotaDeCreditoElectronica: "34",
+  ComprasElectronico: "41",
+  GastosMenoresElectronico: "43",
+  RegimenesEspecialesElectronico: "44",
+  GubernamentalElectronico: "45",
+  ComprobanteDeExportacionesElectronico: "46",
+  ComprobanteParaPagosAlExteriorElectronico: "47"
+};
+var EcfError = class extends Error {
+  response;
+  constructor(message, response) {
+    super(message);
+    this.name = "EcfError";
+    this.response = response;
+  }
+};
+var EcfClient = class {
+  /** The underlying openapi-fetch client for direct endpoint access. */
+  raw;
+  constructor(config) {
+    const baseUrl = config.baseUrl ?? ENVIRONMENT_URLS[config.environment ?? "test"];
+    const authMiddleware = {
+      async onRequest({ request }) {
+        request.headers.set("Authorization", `Bearer ${config.apiKey}`);
+        return request;
+      }
+    };
+    this.raw = createClient({ baseUrl });
+    this.raw.use(authMiddleware);
+  }
+  // ---------------------------------------------------------------------------
+  // ECF send + poll
+  // ---------------------------------------------------------------------------
+  /**
+   * Send an ECF and poll until processing completes.
+   *
+   * Determines the correct endpoint from `ecf.encabezado.idDoc.tipoeCF`,
+   * posts the ECF, then polls until `progress` is `Finished` or `Error`.
+   */
+  async sendEcf(ecf, pollingOptions) {
+    const tipoeCF = ecf.encabezado?.idDoc?.tipoeCF;
+    if (!tipoeCF) {
+      throw new Error("ECF must have encabezado.idDoc.tipoeCF");
+    }
+    const route = ECF_TYPE_ROUTE_MAP[tipoeCF];
+    if (!route) {
+      throw new Error(`Unknown tipoeCF: ${tipoeCF}`);
+    }
+    const rnc = ecf.encabezado?.emisor?.rncEmisor;
+    if (!rnc) {
+      throw new Error("ECF must have encabezado.emisor.rncEmisor");
+    }
+    const encf = ecf.encabezado?.idDoc?.encf;
+    if (!encf) {
+      throw new Error("ECF must have encabezado.idDoc.encf");
+    }
+    const response = await this.postEcf(route, ecf);
+    const result = await pollUntilComplete(
+      async () => {
+        const { data: queryData, error: queryError } = await this.raw.GET("/ecf/{rnc}/{encf}", {
+          params: { path: { rnc, encf } }
+        });
+        if (queryError) {
+          throw new Error(`Failed to query ECF status: ${JSON.stringify(queryError)}`);
+        }
+        const results = queryData;
+        const match = results.find((r) => r.messageId === response.messageId) ?? results[0];
+        if (!match) {
+          throw new Error("No ECF response found for the given rnc/encf");
+        }
+        return match;
+      },
+      (r) => r.progress === "Finished" || r.progress === "Error",
+      pollingOptions
+    );
+    if (result.progress === "Error") {
+      throw new EcfError(
+        result.errors ?? result.mensaje ?? "ECF processing failed",
+        result
+      );
+    }
+    return result;
+  }
+  async postEcf(route, body) {
+    const path = `/ecf/${route}`;
+    const { data, error } = await this.raw.POST(path, { body });
+    if (error) {
+      throw new Error(`Failed to send ECF: ${JSON.stringify(error)}`);
+    }
+    return data;
+  }
+  // ---------------------------------------------------------------------------
+  // Company operations
+  // ---------------------------------------------------------------------------
+  /** List companies with optional filters. */
+  async getCompanies(params) {
+    return this.raw.GET("/company", { params: { query: params } });
+  }
+  /** Get a company by RNC. */
+  async getCompanyByRnc(rnc) {
+    return this.raw.GET("/company/{rnc}", { params: { path: { rnc } } });
+  }
+  /** Create or update a company. */
+  async upsertCompany(body) {
+    return this.raw.PUT("/company", { body });
+  }
+  /** Delete a company by RNC. */
+  async deleteCompany(rnc) {
+    return this.raw.DELETE("/company/{rnc}", { params: { path: { rnc } } });
+  }
+  // ---------------------------------------------------------------------------
+  // Certificate operations
+  // ---------------------------------------------------------------------------
+  /** Get the current certificate for a company. */
+  async getCertificate(rnc) {
+    return this.raw.GET("/company/{rnc}/certificate", { params: { path: { rnc } } });
+  }
+  /** Update a company's certificate. Pass a FormData with 'certificate' file and 'password' field. */
+  async updateCertificate(rnc, body) {
+    const formData = new FormData();
+    formData.append("certificate", body.certificate);
+    formData.append("password", body.password);
+    return this.raw.PUT("/company/{rnc}/certificate", {
+      params: { path: { rnc } },
+      body: formData,
+      bodySerializer: (b) => b
+    });
+  }
+  // ---------------------------------------------------------------------------
+  // ECF query operations
+  // ---------------------------------------------------------------------------
+  /** Query ECFs by RNC and eNCF. */
+  async queryEcf(rnc, encf) {
+    return this.raw.GET("/ecf/{rnc}/{encf}", { params: { path: { rnc, encf } } });
+  }
+  /** Search ECFs for a specific RNC. */
+  async searchEcfs(rnc, params) {
+    return this.raw.GET("/ecf/{rnc}", {
+      params: { path: { rnc }, query: params }
+    });
+  }
+  /** Search all ECFs across all companies. */
+  async searchAllEcfs(params) {
+    return this.raw.GET("/ecf", { params: { query: params } });
+  }
+  /** Get a specific ECF by message ID. */
+  async getEcfById(rnc, id) {
+    return this.raw.GET("/ecf/{rnc}/message/{id}", { params: { path: { rnc, id } } });
+  }
+  // ---------------------------------------------------------------------------
+  // Aprobacion comercial
+  // ---------------------------------------------------------------------------
+  /** Send aprobacion comercial for an ECF. */
+  async aprobacionComercial(rnc, encf, body) {
+    return this.raw.POST("/ecf/aprobacioncomercial/{rnc}/{encf}", {
+      params: { path: { rnc, encf } },
+      body
+    });
+  }
+  // ---------------------------------------------------------------------------
+  // Anulacion rangos
+  // ---------------------------------------------------------------------------
+  /** Request range annulment. */
+  async anulacionRangos(rnc, body) {
+    return this.raw.POST("/ecf/anularrango/{rnc}", {
+      params: { path: { rnc } },
+      body
+    });
+  }
+  /** List annulments. */
+  async listAnulaciones(params) {
+    return this.raw.GET("/ecf/anulaciones", { params: { query: params } });
+  }
+  // ---------------------------------------------------------------------------
+  // Firmar semilla
+  // ---------------------------------------------------------------------------
+  /** Sign a seed for a company. */
+  async firmarSemilla(rnc, body) {
+    const formData = new FormData();
+    formData.append("xml", body.xml);
+    return this.raw.POST("/ecf/FirmarSemilla/{rnc}", {
+      params: { path: { rnc } },
+      body: formData,
+      bodySerializer: (b) => b
+    });
+  }
+  // ---------------------------------------------------------------------------
+  // Recepcion operations
+  // ---------------------------------------------------------------------------
+  /** Search ECF reception requests. */
+  async searchEcfReceptionRequests(params) {
+    return this.raw.GET("/recepcion/ecf", { params: { query: params } });
+  }
+  /** Search ACECF reception requests. */
+  async searchAcecfReceptionRequests(params) {
+    return this.raw.GET("/recepcion/acecf", { params: { query: params } });
+  }
+  /** Search ECF reception requests by RNC. */
+  async searchEcfReceptionRequestsByRnc(rnc, params) {
+    return this.raw.GET("/recepcion/{rnc}/ecf", {
+      params: { path: { rnc }, query: params }
+    });
+  }
+  /** Get a specific ECF reception request. */
+  async getEcfReceptionRequest(rnc, messageId) {
+    return this.raw.GET("/recepcion/{rnc}/ecf/{messageId}", {
+      params: { path: { rnc, messageId } }
+    });
+  }
+  /** Search ACECF reception requests by RNC. */
+  async searchAcecfReceptionRequestsByRnc(rnc, params) {
+    return this.raw.GET("/recepcion/{rnc}/acecf", {
+      params: { path: { rnc }, query: params }
+    });
+  }
+  /** Get a specific ACECF reception request. */
+  async getAcecfReceptionRequest(rnc, messageId) {
+    return this.raw.GET("/recepcion/{rnc}/acecf/{messageId}", {
+      params: { path: { rnc, messageId } }
+    });
+  }
+  // ---------------------------------------------------------------------------
+  // DGII operations
+  // ---------------------------------------------------------------------------
+  /** Consulta directorio - listado. */
+  async consultaDirectorioListado(rnc) {
+    return this.raw.GET("/dgii/{rnc}/consultadirectorio/listado", {
+      params: { path: { rnc } }
+    });
+  }
+  /** Consulta directorio - obtener directorio por RNC. */
+  async consultaDirectorioPorRnc(rnc, query) {
+    return this.raw.GET("/dgii/{rnc}/consultadirectorio/obtener-directorio-por-rnc", {
+      params: { path: { rnc }, query }
+    });
+  }
+  /** Consulta estado. */
+  async consultaEstado(rnc, query) {
+    return this.raw.GET("/dgii/{rnc}/consultaestado/estado", {
+      params: { path: { rnc }, query }
+    });
+  }
+  /** Consulta resultado. */
+  async consultaResultado(rnc, query) {
+    return this.raw.GET("/dgii/{rnc}/consultaresultado/estado", {
+      params: { path: { rnc }, query }
+    });
+  }
+  /** Consulta RFCE. */
+  async consultaRFCE(rnc, query) {
+    return this.raw.GET("/dgii/{rnc}/consultarfce/consulta", {
+      params: { path: { rnc }, query }
+    });
+  }
+  /** Consulta timbre. */
+  async consultaTimbre(rnc, query) {
+    return this.raw.GET("/dgii/{rnc}/consultatimbre", {
+      params: { path: { rnc }, query }
+    });
+  }
+  /** Consulta timbre FC. */
+  async consultaTimbreFC(rnc, query) {
+    return this.raw.GET("/dgii/{rnc}/consultatimbrefc", {
+      params: { path: { rnc }, query }
+    });
+  }
+  /** Consulta track IDs. */
+  async consultaTrackId(rnc, query) {
+    return this.raw.GET("/dgii/{rnc}/consultatrackids/consulta", {
+      params: { path: { rnc }, query }
+    });
+  }
+  /** Estatus servicios - obtener estatus. */
+  async estatusServicios(rnc) {
+    return this.raw.GET("/dgii/{rnc}/estatusservicios/obtener-estatus", {
+      params: { path: { rnc } }
+    });
+  }
+  /** Estatus servicios - obtener ventanas de mantenimiento. */
+  async ventanasMantenimiento(rnc) {
+    return this.raw.GET("/dgii/{rnc}/estatusservicios/obtener-ventanas-mantenimiento", {
+      params: { path: { rnc } }
+    });
+  }
+  // ---------------------------------------------------------------------------
+  // ApiKey operations
+  // ---------------------------------------------------------------------------
+  /** Create a new API key. */
+  async createApiKey(body) {
+    return this.raw.POST("/apiKey", { body });
+  }
+};
+var EcfFrontendClient = class {
+  /** The underlying openapi-fetch client for direct endpoint access. */
+  raw;
+  constructor(config) {
+    const baseUrl = config.baseUrl ?? ENVIRONMENT_URLS[config.environment ?? "test"];
+    const authMiddleware = {
+      async onRequest({ request }) {
+        request.headers.set("Authorization", `Bearer ${config.apiKey}`);
+        return request;
+      }
+    };
+    this.raw = createClient({ baseUrl });
+    this.raw.use(authMiddleware);
+  }
+  /** Query ECFs by RNC and eNCF. */
+  async queryEcf(rnc, encf) {
+    return this.raw.GET("/ecf/{rnc}/{encf}", { params: { path: { rnc, encf } } });
+  }
+  /** Search ECFs for a specific RNC. */
+  async searchEcfs(rnc, params) {
+    return this.raw.GET("/ecf/{rnc}", {
+      params: { path: { rnc }, query: params }
+    });
+  }
+  /** Search all ECFs across all companies. */
+  async searchAllEcfs(params) {
+    return this.raw.GET("/ecf", { params: { query: params } });
+  }
+  /** Get a specific ECF by message ID. */
+  async getEcfById(rnc, id) {
+    return this.raw.GET("/ecf/{rnc}/message/{id}", { params: { path: { rnc, id } } });
+  }
+  /** List companies with optional filters. */
+  async getCompanies(params) {
+    return this.raw.GET("/company", { params: { query: params } });
+  }
+  /** Get a company by RNC. */
+  async getCompanyByRnc(rnc) {
+    return this.raw.GET("/company/{rnc}", { params: { path: { rnc } } });
+  }
+};
+function createFrontendClient(config) {
+  return new EcfFrontendClient(config);
+}
+export {
+  EcfClient,
+  EcfError,
+  EcfFrontendClient,
+  PollingMaxRetriesError,
+  PollingTimeoutError,
+  createFrontendClient,
+  pollUntilComplete
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@ssddo/ecf-sdk",
+  "version": "0.1.0",
+  "description": "SDK de TypeScript para la API de ECF DGII (comprobantes fiscales electrónicos de República Dominicana)",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "openapi-fetch": "^0.13.0"
+  },
+  "devDependencies": {
+    "openapi-typescript": "^7.6.1",
+    "tsup": "^8.3.0",
+    "typescript": "^5.7.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "author": {
+    "name": "SSD Smart Software Development SRL",
+    "email": "contacto@ssd.com.do",
+    "url": "https://ssd.com.do"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SSD-Smart-Software-Development-SRL/ecf_dgii",
+    "directory": "typescript"
+  },
+  "homepage": "https://github.com/SSD-Smart-Software-Development-SRL/ecf_dgii/tree/main/typescript#readme",
+  "bugs": {
+    "url": "https://github.com/SSD-Smart-Software-Development-SRL/ecf_dgii/issues"
+  },
+  "keywords": [
+    "ecf",
+    "dgii",
+    "factura-electronica",
+    "comprobante-fiscal",
+    "republica-dominicana",
+    "typescript",
+    "openapi",
+    "ssd"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "generate": "openapi-typescript ../ecf_dgii/src/Apis/ECF_DGII.EcfApi/wwwroot/openapi/v1.json -o src/generated/v1.d.ts",
+    "build": "tsup"
+  }
+}