apacuana-sdk-core 0.5.0 → 0.6.2

package/README.md

@@ -51,7 +51,7 @@ Inicializa el SDK con la configuración proporcionada.
 
 **Retorna:**
 
-- Promise que se resuelve cuando la inicialización es exitosa
+- `Promise<boolean>` que se resuelve a `true` cuando la inicialización es exitosa.
 
 **Ejemplo:**
 
@@ -79,7 +79,7 @@ Obtiene la configuración actual del SDK.
 
 **Retorna:**
 
-- Object: Configuración actual del SDK
+- `Object`: Configuración actual del SDK
 
 **Ejemplo:**
 
@@ -92,11 +92,11 @@ console.log("Configuración actual:", config);
 
 Obtiene la información del cliente utilizando los datos de configuración.
 
-**Parámetros:** Ninguno (utiliza verificationId y customerId de la configuración)
+**Parámetros:** Ninguno (utiliza `verificationId` y `customerId` de la configuración)
 
 **Retorna:**
 
-- Promise que se resuelve con un objeto que contiene:
+- `Promise<GetCustomerResponse>` que se resuelve con un objeto que contiene:
   - `token` (String): ID de sesión para autenticación.
   - `userData` (Object): Datos del usuario.
   - `success` (Boolean): Indicador de éxito de la operación.
@@ -135,7 +135,7 @@ Si alguna de estas validaciones falla, la función lanzará una `ApacuanaAPIErro
 
 **Retorna:**
 
-- `Promise` que se resuelve con un objeto que contiene:
+- `Promise<GenerateCertResponse>` que se resuelve con un objeto que contiene:
   - `cert` (String): El certificado generado.
   - `success` (Boolean): Indicador de éxito de la operación.
 
@@ -163,11 +163,13 @@ try {
 
 Obtiene el estado actual del certificado del usuario.
 
-**Parámetros:** Ninguno (utiliza la configuración previa y datos del usuario)
+**Parámetros:**
+
+- `isCertificateInDevice` (Boolean, opcional): Indica si el certificado ya se encuentra en el dispositivo. Por defecto es `false`.
 
 **Retorna:**
 
-- Un objeto que contiene:
+- `GetCertStatusResponse`: Un objeto que contiene:
   - `status` (String): El estado del certificado (ver sección de Estados de Certificado).
   - `success` (Boolean): Indicador de éxito de la operación.
 
@@ -186,39 +188,67 @@ try {
 
 ### signDocument(signData)
 
-Esta función está actualmente deshabilitada y lanzará un error si se invoca.
+Firma un documento utilizando un certificado digital y un digest previamente firmado. Esta función es compatible únicamente con el flujo de integración `ONBOARDING`.
 
 **Parámetros:**
 
-- `signData` (Object): Datos para la firma.
+- `signData` (`SignDocumentData`): Un objeto que contiene los datos necesarios para la firma.
+  - `signature` (Object): Objeto con información de la firma.
+    - `id` (String): ID de la firma.
+    - `positions` (Array<Object>): Posiciones de la firma en el documento.
+  - `cert` (String): El certificado del firmante en formato base64.
+  - `signedDigest` (String): El digest del documento, ya firmado.
 
 **Retorna:**
 
-- `Promise<void>`
+- `Promise<object>`: Una promesa que se resuelve con la respuesta de la API tras completar la firma.
 
 **Posibles `ApacuanaAPIError`:**
 
-- `NOT_IMPLEMENTED`: La función no está implementada para el tipo de integración.
+- `NOT_IMPLEMENTED`: Si se invoca con un `integrationType` diferente a `ONBOARDING`.
+- `INVALID_PARAMETER`: Si los datos en `signData` son incorrectos o están incompletos.
+
+**Ejemplo:**
+
+```javascript
+const signData = {
+  signature: {
+    id: "unique-signature-id",
+    positions: [{ page: 1, x: 0.5, y: 0.8 }],
+  },
+  cert: "base64-encoded-certificate",
+  signedDigest: "signed-digest-of-the-document",
+};
+
+try {
+  const response = await apacuana.signDocument(signData);
+  console.log("Documento firmado exitosamente:", response);
+} catch (error) {
+  console.error("Error al firmar el documento:", error.message);
+}
+```
 
 ### getDigest(signData)
 
-Obtiene el digest de un documento que se va a firmar.
+Obtiene el `digest` de un documento que se va a firmar. Este `digest` es un resumen criptográfico del documento que luego debe ser firmado por el cliente.
 
-- **Parámetros:**
+**Parámetros:**
 
-  - `signData` (Object): Objeto que contiene los datos para la firma.
-    - `cert` (String): Certificado en formato PEM.
-    - `signatureId` (String): Identificador único de la firma.
+- `signData` (`GetDigestData`): Objeto que contiene los datos para la firma.
+  - `cert` (String): Certificado del firmante en formato PEM (codificado en base64).
+  - `signatureId` (String): Identificador único del proceso de firma.
 
-- **Retorna:** `Promise<object>` - Un objeto que contiene:
+**Retorna:**
 
+- `Promise<GetDigestResponse>`: Un objeto que contiene:
   - `digest` (String): El digest del documento a firmar.
   - `success` (Boolean): Indicador de éxito de la operación.
 
-- **Posibles `ApacuanaAPIError`:**
-  - `INVALID_PARAMETER`: Si `cert` o `signatureId` no son válidos.
-  - `API_RESPONSE_ERROR`: Si la API no devuelve un digest.
-  - `NOT_IMPLEMENTED`: Si se llama con un `integrationType` no soportado.
+**Posibles `ApacuanaAPIError`:**
+
+- `INVALID_PARAMETER`: Si `cert` o `signatureId` no son válidos.
+- `API_RESPONSE_ERROR`: Si la API no devuelve un digest.
+- `NOT_IMPLEMENTED`: Si se llama con un `integrationType` no soportado (`ONPREMISE`).
 
 ### requestRevocation(reasonCode)
 
@@ -226,11 +256,13 @@ Solicita la revocación de un certificado.
 
 **Parámetros:**
 
-- `reasonCode` (String): Código que indica la razón de la revocación
+- `reasonCode` (String): Código que indica la razón de la revocación (ej. "COMPROMISED").
 
 **Retorna:**
 
-- Promise que se resuelve con la respuesta de la API de revocación
+- `Promise<RequestRevocationResponse>` que se resuelve con un objeto que contiene:
+  - `revocationStatus` (String): El estado de la solicitud (ej. "pending").
+  - `requestId` (String | Number): El ID de la solicitud de revocación.
 
 **Ejemplo:**
 
@@ -243,47 +275,49 @@ try {
 }
 ```
 
-#### `getDocs(data)`
+### getDocs(data)
 
 Obtiene una lista de documentos paginada. El comportamiento de esta función varía según el `integrationType` configurado.
 
-- **Parámetros:**
+**Parámetros:**
 
-  - `data` (object): Objeto que contiene los parámetros para la consulta.
-    - `page` (number): Número de página para la paginación.
-    - `size` (number): Cantidad de resultados por página.
-    - `status` (number, opcional): Filtra los documentos por su estado. Los valores permitidos son:
-      - `-1`: Rechazado
-      - `0`: Pendiente
-      - `1`: Firmado
-      - `2`: En proceso
+- `data` (`GetDocsParams`): Objeto que contiene los parámetros para la consulta.
+  - `page` (Number): Número de página para la paginación.
+  - `size` (Number): Cantidad de resultados por página.
+  - `status` (Number, opcional): Filtra los documentos por su estado. Los valores permitidos son:
+    - `-1`: Rechazado
+    - `0`: Pendiente
+    - `1`: Firmado
+    - `2`: En proceso
 
-- **Retorna:** `Promise<object>` - Un objeto que contiene:
+**Retorna:**
 
+- `Promise<GetDocsResponse>`: Un objeto que contiene:
   - `totalRecords` (Number): El número total de documentos que coinciden con la consulta.
-  - `records` (Array): Un array de objetos, donde cada objeto es un documento.
+  - `records` (Array<Object>): Un array de objetos, donde cada objeto es un documento.
   - `success` (Boolean): Indicador de éxito de la operación.
 
-- **Comportamiento por `integrationType`:**
+**Comportamiento por `integrationType`:**
 
-  - **`ONBOARDING`**: Obtiene los documentos asociados al `customerId` configurado.
-  - **`ONPREMISE`**: No soportado. Lanza un `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
+- **`ONBOARDING`**: Obtiene los documentos asociados al `customerId` configurado.
+- **`ONPREMISE`**: No soportado. Lanza un `ApacuanaAPIError` con el código `NOT_IMPLEMENTED`.
 
-- **Ejemplo (`ONBOARDING`):**
+**Ejemplo (`ONBOARDING`):**
 
-  ```javascript
-  try {
-    const documents = await apacuana.getDocs({ page: 1, size: 10, status: 1 });
-    console.log("Documentos:", documents);
-  } catch (error) {
-    console.error("Error al obtener documentos:", error.message);
-  }
-  ```
+```javascript
+try {
+  const documents = await apacuana.getDocs({ page: 1, size: 10, status: 1 });
+  console.log("Documentos:", documents);
+} catch (error) {
+  console.error("Error al obtener documentos:", error.message);
+}
+```
+
+**Posibles `ApacuanaAPIError`:**
 
-- **Posibles `ApacuanaAPIError`:**
-  - `INVALID_PARAMETER`: Si `page`, `size` o `status` no son válidos.
-  - `CONFIGURATION_ERROR`: Si el `customerId` no está configurado en la inicialización.
-  - `NOT_IMPLEMENTED`: Si se llama con `integrationType` igual a `ONPREMISE`.
+- `INVALID_PARAMETER`: Si `page`, `size` o `status` no son válidos.
+- `CONFIGURATION_ERROR`: Si el `customerId` no está configurado en la inicialización.
+- `NOT_IMPLEMENTED`: Si se llama con `integrationType` igual a `ONPREMISE`.
 
 ### addSigner(signerData)
 
@@ -336,7 +370,9 @@ Si alguna validación falla, se lanzará una `ApacuanaAPIError` con el código `
 
 **Retorna:**
 
-- `Promise` que se resuelve con un objeto que contiene el ID del firmante (`signerId`) y el estado (`status`) si la operación es exitosa.
+- `Promise<AddSignerResponse>` que se resuelve con un objeto que contiene:
+  - `signer` (String): Un identificador del firmante, construido a partir de `typedoc` y `doc`.
+  - `success` (Boolean): Indicador de éxito de la operación.
 
 **Ejemplo (ONBOARDING):**
 
@@ -375,9 +411,8 @@ El SDK utiliza los siguientes estados para los certificados:
 
 El SDK soporta los siguientes tipos de integración:
 
-- `ONBOARDING`: Proceso de registro inicial y generación de certificado
-- `AUTHENTICATION`: Proceso de autenticación con certificado existente
-- `SIGNATURE`: Proceso de firma de documentos
+- `ONBOARDING`: Proceso de registro inicial y generación de certificado.
+- `ONPREMISE`: Integración donde el cliente gestiona su propia infraestructura. Algunas funcionalidades no están soportadas en este modo.
 
 ## Manejo de Errores
 
@@ -409,3 +444,41 @@ El SDK implementa las siguientes medidas de seguridad:
 ## Licencia
 
 Este SDK está licenciado bajo términos propietarios. Consulte el acuerdo de licencia para más detalles.
+
+#### `generateCert(encryptedCSR)`
+
+Genera un nuevo certificado para un usuario ya existente.
+
+-   **Parámetros:**
+    -   `encryptedCSR` (Object): Un objeto que contiene la Solicitud de Firma de Certificado (CSR) encriptada. Este objeto debe tener la siguiente estructura:
+        ```json
+        {
+          "csr": "string"
+        }
+        ```
+        Donde el valor de `csr` es la cadena de texto resultante de la encriptación.
+
+-   **Retorna:** `Promise<Object>`
+  - `Promise<GenerateCertResponse>` que se resuelve con un objeto que contiene:
+    - `cert` (String): El certificado generado.
+    - `success` (Boolean): Indicador de éxito de la operación.
+
+**Ejemplo:**
+
+```javascript
+// Asumiendo que 'myBase64Csr' es una variable que contiene tu CSR en formato Base64
+const myBase64Csr = "MIIC...==";
+
+try {
+  const { cert, success } = await apacuana.generateCert(myBase64Csr);
+  if (success) {
+    console.log("Certificado generado exitosamente:", cert);
+  }
+} catch (error) {
+  if (error.name === "ApacuanaAPIError") {
+    console.error(`Error de API (${error.code}):`, error.message);
+  } else {
+    console.error("Ocurrió un error inesperado:", error);
+  }
+}
+```

package/babel.config.cjs

@@ -0,0 +1,11 @@
+module.exports = {
+  presets: [
+    '@babel/preset-env',
+    '@babel/preset-flow'
+  ],
+  plugins: [
+    ['@babel/plugin-transform-class-properties', { loose: true }],
+    ['@babel/plugin-transform-private-methods', { loose: true }],
+    ['@babel/plugin-transform-private-property-in-object', { loose: true }]
+  ]
+};