apacuana-sdk-core 0.3.0 → 0.5.0

package/dist/utils/constant.d.ts

@@ -0,0 +1,18 @@
+export namespace STATUS_CERTIFICATE {
+    let request: string;
+    let generate: string;
+    let current: string;
+    let revoque: string;
+    let expire: string;
+    let request_revoque: string;
+    let certificate_another_device: string;
+    let sign_pending: string;
+}
+export namespace VERIFICATION_STATUS {
+    let IN_REGISTER: number;
+    let APPROVED: number;
+}
+export namespace INTEGRATION_TYPE {
+    let ONBOARDING: string;
+    let ONPREMISE: string;
+}

package/dist/utils/helpers.d.ts

@@ -0,0 +1,21 @@
+declare namespace _default {
+    export { getCertificateStatus };
+    export { exportPrivateKey };
+    export { arrayBufferToBase64 };
+    export { encryptedCsr };
+    export { validateOnBoardingSignerData };
+    export { validateCsr };
+    export { validateGetDocsData };
+    export { validateGetDigestData };
+}
+export default _default;
+declare function getCertificateStatus(userData: any, certificateInDevice: any): string;
+declare function exportPrivateKey(key: any): Promise<string>;
+declare function arrayBufferToBase64(buffer: any): string;
+declare function encryptedCsr(csr: any, encryptKey?: string): {
+    csr: any;
+};
+declare function validateOnBoardingSignerData(signerData: any): void;
+declare function validateCsr(csr: any): void;
+declare function validateGetDocsData(data: any): void;
+declare function validateGetDigestData(signData: any): void;

package/dist/utils/httpClient.d.ts

@@ -0,0 +1,3 @@
+export function initHttpClient(): void;
+export function setAuthToken(token: string): void;
+export function httpRequest(path: string, data?: object, method?: string): Promise<object>;

package/package.json

@@ -1,15 +1,18 @@
 {
   "name": "apacuana-sdk-core",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Core SDK para interacciones con las APIs de Apacuana.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
+    "clean": "rimraf dist",
+    "clean-modules": "rimraf node_modules",
     "test": "jest",
     "lint": "eslint src/",
-    "build": "rollup -c",
-    "prepublishOnly": "npm test && npm run build",
+    "build": "npm run clean && tsc && rollup -c",
+    "prepublishOnly": "npm run validate",
     "validate": "npm run lint && npm test && npm run build"
   },
   "keywords": [
@@ -33,7 +36,9 @@
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.29.1",
     "jest": "^29.7.0",
-    "rollup": "^4.18.0"
+    "rollup": "^4.18.0",
+    "rimraf": "^5.0.7",
+    "typescript": "^5.4.5"
   },
   "engines": {
     "node": ">=14.0.0"

package/src/api/certs.js

@@ -42,7 +42,7 @@ const generateCertOnPremise = async () => {
 
 /**
  * Generates a digital certificate.
- * @param {string} [csr] - Optional Certificate Signing Request (CSR).
+ * @param {string} [csr] - Certificate Signing Request (CSR).
  * @returns {Promise<{cert: string, success: boolean}>} Object with the generated certificate and a success indicator.
  * @throws {ApacuanaAPIError} If the CSR is invalid, if the API response does not contain the certificate, or if the integration type is not supported.
  * @throws {Error} If certificate generation fails for another reason.

package/src/api/revocations.js

@@ -1,6 +1,5 @@
-// src/api/revocations.js
-import { httpRequest } from '../utils/httpClient';
-import { ApacuanaAPIError } from '../errors/index';
+import { httpRequest } from "../utils/httpClient";
+import { ApacuanaAPIError } from "../errors/index";
 
 /**
  * Simula la solicitud de revocación de un certificado.
@@ -8,31 +7,31 @@ import { ApacuanaAPIError } from '../errors/index';
  * @returns {Promise<object>} Objeto con el estado de la solicitud de revocación.
  */
 const requestRevocation = async (reasonCode) => {
-  console.log('-> Función \'requestRevocation\' ejecutada.');
-  console.log('Parámetros recibidos para solicitud de revocación:', {
+  console.log("-> Función 'requestRevocation' ejecutada.");
+  console.log("Parámetros recibidos para solicitud de revocación:", {
     reasonCode,
   });
 
   if (!reasonCode) {
     throw new Error(
-      'ID de certificado y motivo son requeridos para requestRevocation.',
+      "ID de certificado y motivo son requeridos para requestRevocation."
     );
   }
 
   try {
     const response = await httpRequest(
-      'users/api/customers/requestcert',
+      "users/api/customers/requestcert",
       { reason: reasonCode },
-      'POST',
+      "POST"
     );
-    console.log('Respuesta del servidor', response);
+    console.log("Respuesta del servidor", response);
     if (!response.success) {
       throw new ApacuanaAPIError(
-        response.message || 'Error desconocido al solicitar revocación.',
+        response.message || "Error desconocido al solicitar revocación."
       );
     }
     return {
-      revocationStatus: response.status || 'pending',
+      revocationStatus: response.status || "pending",
       requestId: response.id,
     };
   } catch (error) {

package/src/api/signatures.js

@@ -5,6 +5,66 @@ import { ApacuanaAPIError } from "../errors";
 import helpers from "../utils/helpers";
 import { INTEGRATION_TYPE } from "../utils/constant";
 
+// =================================================================
+// Type Definitions
+// =================================================================
+
+/**
+ * Define la estructura de un objeto Firmante.
+ * @typedef {object} Signer
+ * @property {string} name - Nombre completo del firmante.
+ * @property {string} email - Correo electrónico del firmante.
+ * @property {string} document - Documento de identidad del firmante.
+ */
+
+/**
+ * Define la estructura de datos para añadir un firmante.
+ * @typedef {object} SignerData
+ * @property {string} docId - Identificador único del documento.
+ * @property {Signer} signer - Objeto con la información del firmante.
+ */
+
+/**
+ * Define la estructura de la respuesta al añadir un firmante.
+ * @typedef {object} AddSignerResponse
+ * @property {string} signer - Identificador de confirmación del firmante añadido.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+/**
+ * Define la estructura de datos para obtener el digest de un documento.
+ * @typedef {object} GetDigestData
+ * @property {string} cert - Certificado del firmante en formato base64.
+ * @property {string} signatureId - Identificador único del proceso de firma.
+ */
+
+/**
+ * Define la estructura de la respuesta al obtener el digest.
+ * @typedef {object} GetDigestResponse
+ * @property {string} digest - El digest del documento que se va a firmar.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+/**
+ * Define la estructura de los parámetros para obtener documentos.
+ * @typedef {object} GetDocsParams
+ * @property {number} page - Número de página para la paginación.
+ * @property {number} size - Cantidad de registros por página.
+ * @property {string} [status] - (Opcional) Estado para filtrar los documentos.
+ */
+
+/**
+ * Define la estructura de la respuesta al obtener documentos.
+ * @typedef {object} GetDocsResponse
+ * @property {number} totalRecords - El número total de registros encontrados.
+ * @property {Array<object>} records - Un arreglo con los registros de los documentos.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
+
+// =================================================================
+// Internal Functions
+// =================================================================
+
 const signDocumentOnBoarding = async () => {
   throw new ApacuanaAPIError(
     "Document signing is not supported for integration type: ONBOARDING",
@@ -21,30 +81,6 @@ const signDocumentOnPremise = async () => {
   );
 };
 
-/**
- * Signs a PDF document with a digital certificate.
- * @param {object} data - Data for the signature. For 'on-boarding', it must contain {documentData, signatureData}. For 'on-premise', it must contain {signature, cert, privateKey}.
- * @returns {Promise<{digest: string}>} Object with the document's digest.
- * @throws {ApacuanaAPIError} If the integration type is not supported or the function is not implemented for the integration type.
- */
-export const signDocument = async () => {
-  const { integrationType } = getConfig();
-
-  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
-    return signDocumentOnBoarding();
-  }
-
-  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
-    return signDocumentOnPremise();
-  }
-
-  throw new ApacuanaAPIError(
-    `Unsupported integration type: ${integrationType}`,
-    400,
-    "UNSUPPORTED_INTEGRATION_TYPE"
-  );
-};
-
 const getDigestToSignOnBoarding = async (signData) => {
   try {
     const response = await httpRequest(
@@ -82,45 +118,16 @@ const getDigestToSignOnPremise = async () => {
   );
 };
 
-/**
- * Gets the digest of a document to be signed.
- * @param {object} signData - Data for the signature. Must contain { cert, signatureId }.
- * @returns {Promise<{digest: string, success: boolean}>} Object with the document's digest.
- * @throws {ApacuanaAPIError} If the input data is invalid, if the API call fails, or if the integration type is not supported.
- */
-export const getDigest = async (signData) => {
-  helpers.validateGetDigestData(signData);
-
-  const { integrationType } = getConfig();
-
-  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
-    return getDigestToSignOnBoarding(signData);
-  }
-
-  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
-    return getDigestToSignOnPremise();
-  }
-
-  throw new ApacuanaAPIError(
-    `Document retrieval is not supported for an unknown integration type: ${integrationType}`,
-    501,
-    "NOT_IMPLEMENTED"
-  );
-};
-
 const addSignerOnBoarding = async (signerData) => {
   helpers.validateOnBoardingSignerData(signerData);
   try {
-    // Current httpRequest logic is moved here
     await httpRequest("services/api/documents/signing", signerData, "POST");
     return { signer: signerData.typedoc + signerData.doc, success: true };
   } catch (error) {
     if (error instanceof ApacuanaAPIError) {
       throw error;
     }
-    throw new Error(
-      `Failed to add signer in On-Boarding: ${error.message}`
-    );
+    throw new Error(`Failed to add signer in On-Boarding: ${error.message}`);
   }
 };
 
@@ -132,45 +139,9 @@ const addSignerOnPremise = async () => {
   );
 };
 
-/**
- * Adds a signer to a document, handling different integration types.
- * @param {object} signerData - Data of the signer to be added.
- * @returns {Promise<{signer: string, success: boolean}>} Object with the result of adding the signer.
- * @throws {ApacuanaAPIError} If the signer data is invalid, if the API call fails, or if the integration type is not supported.
- */
-export const addSigner = async (signerData) => {
-  if (
-    !signerData ||
-    typeof signerData !== "object" ||
-    Object.keys(signerData).length === 0
-  ) {
-    throw new ApacuanaAPIError(
-      "Signer data (signerData) is required and must be a non-empty object.",
-      400,
-      "INVALID_PARAMETER"
-    );
-  }
-
-  const { integrationType } = getConfig();
-
-  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
-    return addSignerOnBoarding(signerData);
-  }
-
-  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
-    return addSignerOnPremise(signerData);
-  }
-
-  throw new ApacuanaAPIError(
-    `Unsupported integration type: ${integrationType}`,
-    400,
-    "UNSUPPORTED_INTEGRATION_TYPE"
-  );
-};
-
 const getDocsOnPremise = async () => {
   throw new ApacuanaAPIError(
-    "Document retrieval is not supported for integration type: ONBOARDING",
+    "Document retrieval is not supported for integration type: ONPREMISE",
     501,
     "NOT_IMPLEMENTED"
   );
@@ -209,16 +180,105 @@ const getDocsOnBoarding = async (data) => {
       throw error;
     }
     throw new ApacuanaAPIError(
-      `Failed to get document list (on-premise): ${error.message}`
+      `Failed to get document list (on-boarding): ${error.message}`
     );
   }
 };
 
+// =================================================================
+// Exported Functions
+// =================================================================
+
+/**
+ * Firma un documento PDF con un certificado digital.
+ * NOTA: Esta función no está implementada actualmente para ningún tipo de integración.
+ * @returns {Promise<object>}
+ * @throws {ApacuanaAPIError} Arroja un error 'NOT_IMPLEMENTED' para cualquier tipo de integración.
+ */
+export const signDocument = async () => {
+  const { integrationType } = getConfig();
+
+  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
+    return signDocumentOnBoarding();
+  }
+
+  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
+    return signDocumentOnPremise();
+  }
+
+  throw new ApacuanaAPIError(
+    `Unsupported integration type: ${integrationType}`,
+    400,
+    "UNSUPPORTED_INTEGRATION_TYPE"
+  );
+};
+
+/**
+ * Obtiene el digest de un documento para ser firmado.
+ * @param {GetDigestData} signData - Datos requeridos para obtener el digest.
+ * @returns {Promise<GetDigestResponse>} Una promesa que resuelve a un objeto con el digest del documento.
+ * @throws {ApacuanaAPIError} Si los datos de entrada son inválidos, la llamada a la API falla, o el tipo de integración no es soportado.
+ */
+export const getDigest = async (signData) => {
+  helpers.validateGetDigestData(signData);
+
+  const { integrationType } = getConfig();
+
+  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
+    return getDigestToSignOnBoarding(signData);
+  }
+
+  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
+    return getDigestToSignOnPremise();
+  }
+
+  throw new ApacuanaAPIError(
+    `Document retrieval is not supported for an unknown integration type: ${integrationType}`,
+    501,
+    "NOT_IMPLEMENTED"
+  );
+};
+
+/**
+ * Añade un firmante a un documento.
+ * @param {SignerData} signerData - Los datos del firmante que se va a añadir.
+ * @returns {Promise<AddSignerResponse>} Una promesa que resuelve a un objeto con el resultado de la operación.
+ * @throws {ApacuanaAPIError} Si los datos del firmante son inválidos, la llamada a la API falla, o el tipo de integración no es soportado.
+ */
+export const addSigner = async (signerData) => {
+  if (
+    !signerData ||
+    typeof signerData !== "object" ||
+    Object.keys(signerData).length === 0
+  ) {
+    throw new ApacuanaAPIError(
+      "Signer data (signerData) is required and must be a non-empty object.",
+      400,
+      "INVALID_PARAMETER"
+    );
+  }
+  const { integrationType } = getConfig();
+
+  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
+    return addSignerOnBoarding(signerData);
+  }
+
+  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
+    return addSignerOnPremise();
+  }
+
+  throw new ApacuanaAPIError(
+    `Unsupported integration type: ${integrationType}`,
+    400,
+    "UNSUPPORTED_INTEGRATION_TYPE"
+  );
+};
+
 /**
- * Gets a list of documents.
- * @param {object} data - Object with pagination parameters. Must contain {page, size}.
- * @returns {Promise<{totalRecords: number, records:any[], success: boolean}>} Object with the list of documents.
- * @throws {ApacuanaAPIError} If pagination parameters are invalid, if 'customerId' is not configured, if the API call fails, or if the integration type is not supported.
+ * Obtiene una lista de documentos basada en los filtros especificados.
+ * @param {GetDocsParams} data - Objeto con parámetros de paginación y filtros.
+ * @returns {Promise<GetDocsResponse>} Una promesa que resuelve a un objeto con la lista de documentos.
+ * @throws {ApacuanaAPIError} Si los parámetros de paginación son inválidos, 'customerId' no está configurado, la llamada a la API falla, o el tipo de integración no es soportado.
  */
 export const getDocs = async (data) => {
   helpers.validateGetDocsData(data);

package/src/index.js

@@ -2,7 +2,7 @@ import { setConfig, getConfig } from "./config/index";
 import { initHttpClient, setAuthToken } from "./utils/httpClient";
 import getCustomer from "./api/users";
 import requestRevocation from "./api/revocations";
-import { getCertStatus } from "./api/certs";
+import { generateCert, getCertStatus } from "./api/certs";
 import { addSigner, getDocs } from "./api/signatures";
 
 const apacuana = {
@@ -65,6 +65,7 @@ const apacuana = {
   getCustomer,
   addSigner,
   getDocs,
+  generateCert,
 };
 
 export default apacuana;

package/tests/api/signatures.test.js

@@ -1,7 +1,12 @@
 import { getConfig } from "../../src/config";
 import { httpRequest } from "../../src/utils/httpClient";
 import { ApacuanaAPIError } from "../../src/errors";
-import { addSigner, getDocs, getDigest, signDocument } from "../../src/api/signatures";
+import {
+  addSigner,
+  getDocs,
+  getDigest,
+  signDocument,
+} from "../../src/api/signatures";
 import helpers from "../../src/utils/helpers";
 import { INTEGRATION_TYPE } from "../../src/utils/constant";
 
@@ -23,7 +28,9 @@ describe("API - Signatures", () => {
 
   describe("addSigner", () => {
     it("should call addSignerOnBoarding for ONBOARDING integration", async () => {
-      getConfig.mockReturnValue({ integrationType: INTEGRATION_TYPE.ONBOARDING });
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONBOARDING,
+      });
       const signerData = { typedoc: "V", doc: "12345678" };
       httpRequest.mockResolvedValue({ success: true });
 
@@ -106,7 +113,7 @@ describe("API - Signatures", () => {
       httpRequest.mockResolvedValue({ docs: [] });
 
       await expect(getDocs(paginationData)).rejects.toThrow(
-        "Document retrieval is not supported for integration type: ONBOARDING"
+        "Document retrieval is not supported for integration type: ONPREMISE"
       );
     });
 
@@ -151,4 +158,4 @@ describe("API - Signatures", () => {
       );
     });
   });
-});
+});

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "esnext",
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "./dist",
+    "strict": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "tests"]
+}