apacuana-sdk-core 0.5.0 → 0.6.0

package/coverage/lcov.info

@@ -28,263 +28,278 @@ BRH:1
 end_of_record
 TN:
 SF:src/api/certs.js
-FN:7,(anonymous_0)
-FN:35,(anonymous_1)
-FN:50,(anonymous_2)
-FN:72,(anonymous_3)
+FN:19,(anonymous_0)
+FN:47,(anonymous_1)
+FN:62,(anonymous_2)
+FN:84,(anonymous_3)
 FNF:4
 FNH:4
 FNDA:4,(anonymous_0)
 FNDA:1,(anonymous_1)
 FNDA:6,(anonymous_2)
 FNDA:1,(anonymous_3)
-DA:7,2
-DA:8,4
-DA:9,4
-DA:11,4
-DA:16,2
-DA:17,2
-DA:18,1
-DA:25,1
-DA:28,3
+DA:19,2
+DA:20,4
+DA:21,4
+DA:23,4
+DA:28,2
 DA:29,2
-DA:31,1
-DA:35,2
-DA:36,1
-DA:50,2
-DA:51,6
-DA:52,6
-DA:53,6
-DA:54,4
-DA:56,2
-DA:57,1
-DA:60,1
-DA:72,2
-DA:73,1
-DA:74,1
-DA:78,1
+DA:30,1
+DA:37,1
+DA:40,3
+DA:41,2
+DA:43,1
+DA:47,2
+DA:48,1
+DA:62,2
+DA:63,6
+DA:64,6
+DA:65,6
+DA:66,4
+DA:68,2
+DA:69,1
+DA:72,1
+DA:84,2
+DA:85,1
+DA:86,1
+DA:90,1
 LF:25
 LH:25
-BRDA:7,0,0,0
-BRDA:17,1,0,1
-BRDA:17,1,1,1
-BRDA:28,2,0,2
-BRDA:28,2,1,1
-BRDA:50,3,0,0
-BRDA:53,4,0,4
-BRDA:53,4,1,2
-BRDA:56,5,0,1
-BRDA:56,5,1,1
-BRDA:72,6,0,0
+BRDA:19,0,0,0
+BRDA:29,1,0,1
+BRDA:29,1,1,1
+BRDA:40,2,0,2
+BRDA:40,2,1,1
+BRDA:62,3,0,0
+BRDA:65,4,0,4
+BRDA:65,4,1,2
+BRDA:68,5,0,1
+BRDA:68,5,1,1
+BRDA:84,6,0,0
 BRF:11
 BRH:8
 end_of_record
 TN:
 SF:src/api/revocations.js
-FN:9,(anonymous_0)
+FN:15,(anonymous_0)
 FNF:1
 FNH:0
 FNDA:0,(anonymous_0)
-DA:9,1
-DA:10,0
-DA:11,0
-DA:15,0
+DA:15,1
 DA:16,0
+DA:17,0
 DA:21,0
 DA:22,0
 DA:27,0
 DA:28,0
-DA:29,0
 DA:33,0
-DA:38,0
+DA:34,0
+DA:35,0
+DA:39,0
+DA:44,0
 LF:12
 LH:1
-BRDA:15,0,0,0
-BRDA:15,0,1,0
-BRDA:28,1,0,0
-BRDA:28,1,1,0
-BRDA:30,2,0,0
-BRDA:30,2,1,0
-BRDA:34,3,0,0
-BRDA:34,3,1,0
+BRDA:21,0,0,0
+BRDA:21,0,1,0
+BRDA:34,1,0,0
+BRDA:34,1,1,0
+BRDA:36,2,0,0
+BRDA:36,2,1,0
+BRDA:40,3,0,0
+BRDA:40,3,1,0
 BRF:8
 BRH:0
 end_of_record
 TN:
 SF:src/api/signatures.js
-FN:68,(anonymous_0)
-FN:76,(anonymous_1)
-FN:84,(anonymous_2)
-FN:113,(anonymous_3)
-FN:121,(anonymous_4)
-FN:134,(anonymous_5)
-FN:142,(anonymous_6)
-FN:150,(anonymous_7)
-FN:198,(anonymous_8)
-FN:222,(anonymous_9)
-FN:248,(anonymous_10)
+FN:77,(anonymous_0)
+FN:83,(anonymous_1)
+FN:110,(anonymous_2)
+FN:118,(anonymous_3)
+FN:147,(anonymous_4)
+FN:155,(anonymous_5)
+FN:168,(anonymous_6)
+FN:176,(anonymous_7)
+FN:184,(anonymous_8)
+FN:233,(anonymous_9)
+FN:257,(anonymous_10)
 FN:283,(anonymous_11)
-FNF:12
+FN:318,(anonymous_12)
+FNF:13
 FNH:6
 FNDA:0,(anonymous_0)
 FNDA:0,(anonymous_1)
 FNDA:0,(anonymous_2)
 FNDA:0,(anonymous_3)
-FNDA:1,(anonymous_4)
+FNDA:0,(anonymous_4)
 FNDA:1,(anonymous_5)
 FNDA:1,(anonymous_6)
-FNDA:2,(anonymous_7)
-FNDA:0,(anonymous_8)
+FNDA:1,(anonymous_7)
+FNDA:2,(anonymous_8)
 FNDA:0,(anonymous_9)
-FNDA:4,(anonymous_10)
-FNDA:5,(anonymous_11)
-DA:68,2
-DA:69,0
-DA:76,2
-DA:77,0
-DA:84,2
-DA:85,0
-DA:86,0
-DA:93,0
+FNDA:0,(anonymous_10)
+FNDA:4,(anonymous_11)
+FNDA:5,(anonymous_12)
+DA:77,2
+DA:78,0
+DA:79,0
+DA:80,0
+DA:81,0
+DA:83,0
 DA:94,0
-DA:95,0
+DA:99,0
+DA:101,0
 DA:102,0
 DA:104,0
-DA:105,0
-DA:107,0
-DA:113,2
-DA:114,0
-DA:121,2
-DA:122,1
-DA:123,1
-DA:124,1
-DA:125,1
+DA:110,2
+DA:111,0
+DA:118,2
+DA:119,0
+DA:120,0
 DA:127,0
 DA:128,0
-DA:130,0
-DA:134,2
-DA:135,1
-DA:142,2
-DA:143,1
-DA:150,2
-DA:151,2
-DA:152,2
-DA:153,1
-DA:160,1
-DA:161,1
-DA:167,1
-DA:168,1
-DA:171,1
-DA:172,1
-DA:173,1
-DA:179,0
-DA:180,0
-DA:182,0
-DA:198,2
-DA:199,0
-DA:201,0
-DA:202,0
-DA:205,0
-DA:206,0
-DA:209,0
-DA:222,2
-DA:223,0
-DA:225,0
-DA:227,0
-DA:228,0
-DA:231,0
-DA:232,0
-DA:235,0
-DA:248,2
-DA:249,4
-DA:254,1
-DA:260,3
-DA:262,3
-DA:263,1
-DA:266,2
-DA:267,1
-DA:270,1
+DA:129,0
+DA:136,0
+DA:138,0
+DA:139,0
+DA:141,0
+DA:147,2
+DA:148,0
+DA:155,2
+DA:156,1
+DA:157,1
+DA:158,1
+DA:159,1
+DA:161,0
+DA:162,0
+DA:164,0
+DA:168,2
+DA:169,1
+DA:176,2
+DA:177,1
+DA:184,2
+DA:185,2
+DA:186,2
+DA:187,1
+DA:194,1
+DA:195,1
+DA:201,1
+DA:202,1
+DA:205,1
+DA:206,1
+DA:207,1
+DA:213,0
+DA:214,0
+DA:216,0
+DA:233,2
+DA:234,0
+DA:236,0
+DA:237,0
+DA:240,0
+DA:241,0
+DA:244,0
+DA:257,2
+DA:258,0
+DA:260,0
+DA:262,0
+DA:263,0
+DA:266,0
+DA:267,0
+DA:270,0
 DA:283,2
-DA:284,5
-DA:286,3
-DA:288,3
-DA:289,2
-DA:292,1
-DA:293,1
-DA:296,0
-LF:74
+DA:284,4
+DA:289,1
+DA:295,3
+DA:297,3
+DA:298,1
+DA:301,2
+DA:302,1
+DA:305,1
+DA:318,2
+DA:319,5
+DA:321,3
+DA:323,3
+DA:324,2
+DA:327,1
+DA:328,1
+DA:331,0
+LF:83
 LH:42
-BRDA:93,0,0,0
-BRDA:93,0,1,0
-BRDA:94,1,0,0
-BRDA:94,1,1,0
-BRDA:104,2,0,0
-BRDA:104,2,1,0
-BRDA:127,3,0,0
-BRDA:127,3,1,0
-BRDA:152,4,0,1
-BRDA:152,4,1,1
-BRDA:167,5,0,1
-BRDA:167,5,1,0
-BRDA:179,6,0,0
-BRDA:179,6,1,0
-BRDA:201,7,0,0
+BRDA:101,0,0,0
+BRDA:101,0,1,0
+BRDA:105,1,0,0
+BRDA:105,1,1,0
+BRDA:127,2,0,0
+BRDA:127,2,1,0
+BRDA:128,3,0,0
+BRDA:128,3,1,0
+BRDA:138,4,0,0
+BRDA:138,4,1,0
+BRDA:161,5,0,0
+BRDA:161,5,1,0
+BRDA:186,6,0,1
+BRDA:186,6,1,1
+BRDA:201,7,0,1
 BRDA:201,7,1,0
-BRDA:205,8,0,0
-BRDA:205,8,1,0
-BRDA:227,9,0,0
-BRDA:227,9,1,0
-BRDA:231,10,0,0
-BRDA:231,10,1,0
-BRDA:249,11,0,1
-BRDA:249,11,1,3
-BRDA:250,12,0,4
-BRDA:250,12,1,3
-BRDA:250,12,2,3
-BRDA:262,13,0,1
-BRDA:262,13,1,2
-BRDA:266,14,0,1
-BRDA:266,14,1,1
-BRDA:288,15,0,2
-BRDA:288,15,1,1
-BRDA:292,16,0,1
-BRDA:292,16,1,0
-BRF:35
+BRDA:213,8,0,0
+BRDA:213,8,1,0
+BRDA:236,9,0,0
+BRDA:236,9,1,0
+BRDA:240,10,0,0
+BRDA:240,10,1,0
+BRDA:262,11,0,0
+BRDA:262,11,1,0
+BRDA:266,12,0,0
+BRDA:266,12,1,0
+BRDA:284,13,0,1
+BRDA:284,13,1,3
+BRDA:285,14,0,4
+BRDA:285,14,1,3
+BRDA:285,14,2,3
+BRDA:297,15,0,1
+BRDA:297,15,1,2
+BRDA:301,16,0,1
+BRDA:301,16,1,1
+BRDA:323,17,0,2
+BRDA:323,17,1,1
+BRDA:327,18,0,1
+BRDA:327,18,1,0
+BRF:39
 BRH:15
 end_of_record
 TN:
 SF:src/api/users.js
-FN:14,(anonymous_0)
+FN:21,(anonymous_0)
 FNF:1
 FNH:1
 FNDA:5,(anonymous_0)
-DA:14,1
-DA:15,5
-DA:17,5
-DA:18,1
-DA:25,4
-DA:30,4
-DA:31,4
-DA:37,2
-DA:38,1
+DA:21,1
+DA:22,5
+DA:24,5
+DA:25,1
+DA:32,4
+DA:37,4
+DA:38,4
+DA:44,2
 DA:45,1
-DA:51,3
-DA:52,2
-DA:54,1
+DA:52,1
+DA:58,3
+DA:59,2
+DA:61,1
 LF:13
 LH:13
-BRDA:17,0,0,1
-BRDA:17,0,1,4
-BRDA:17,1,0,5
-BRDA:17,1,1,5
-BRDA:37,2,0,1
-BRDA:37,2,1,1
-BRDA:37,3,0,2
-BRDA:37,3,1,1
-BRDA:51,4,0,2
-BRDA:51,4,1,1
-BRDA:56,5,0,1
-BRDA:56,5,1,0
+BRDA:24,0,0,1
+BRDA:24,0,1,4
+BRDA:24,1,0,5
+BRDA:24,1,1,5
+BRDA:44,2,0,1
+BRDA:44,2,1,1
+BRDA:44,3,0,2
+BRDA:44,3,1,1
+BRDA:58,4,0,2
+BRDA:58,4,1,1
+BRDA:63,5,0,1
+BRDA:63,5,1,0
 BRF:12
 BRH:11
 end_of_record
@@ -365,7 +380,8 @@ FN:113,(anonymous_5)
 FN:146,(anonymous_6)
 FN:174,(anonymous_7)
 FN:199,(anonymous_8)
-FNF:9
+FN:215,(anonymous_9)
+FNF:10
 FNH:0
 FNDA:0,(anonymous_0)
 FNDA:0,(anonymous_1)
@@ -376,6 +392,7 @@ FNDA:0,(anonymous_5)
 FNDA:0,(anonymous_6)
 FNDA:0,(anonymous_7)
 FNDA:0,(anonymous_8)
+FNDA:0,(anonymous_9)
 DA:6,2
 DA:8,2
 DA:9,0
@@ -439,8 +456,20 @@ DA:191,0
 DA:199,2
 DA:200,0
 DA:207,0
-LF:63
-LH:8
+DA:215,2
+DA:216,0
+DA:217,0
+DA:224,0
+DA:226,0
+DA:227,0
+DA:234,0
+DA:235,0
+DA:242,0
+DA:243,0
+DA:250,0
+DA:251,0
+LF:75
+LH:9
 BRDA:9,0,0,0
 BRDA:9,0,1,0
 BRDA:12,1,0,0
@@ -527,7 +556,26 @@ BRDA:201,38,1,0
 BRDA:201,38,2,0
 BRDA:201,38,3,0
 BRDA:201,38,4,0
-BRF:86
+BRDA:216,39,0,0
+BRDA:216,39,1,0
+BRDA:216,40,0,0
+BRDA:216,40,1,0
+BRDA:226,41,0,0
+BRDA:226,41,1,0
+BRDA:226,42,0,0
+BRDA:226,42,1,0
+BRDA:226,42,2,0
+BRDA:234,43,0,0
+BRDA:234,43,1,0
+BRDA:242,44,0,0
+BRDA:242,44,1,0
+BRDA:242,45,0,0
+BRDA:242,45,1,0
+BRDA:250,46,0,0
+BRDA:250,46,1,0
+BRDA:250,47,0,0
+BRDA:250,47,1,0
+BRF:105
 BRH:0
 end_of_record
 TN:

package/dist/api/certs.d.ts

@@ -1,8 +1,22 @@
-export function generateCert(csr?: string): Promise<{
+export function generateCert(csr?: string): Promise<GenerateCertResponse>;
+export function getCertStatus(isCertificateInDevice?: boolean): GetCertStatusResponse;
+export type GenerateCertResponse = {
+    /**
+     * - El certificado generado en formato string.
+     */
     cert: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
     success: boolean;
-}>;
-export function getCertStatus(isCertificateInDevice?: boolean): {
+};
+export type GetCertStatusResponse = {
+    /**
+     * - El estado actual del certificado del usuario.
+     */
     status: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
     success: boolean;
 };

package/dist/api/revocations.d.ts

@@ -1,7 +1,22 @@
 export default requestRevocation;
+export type RequestRevocationResponse = {
+    /**
+     * - El estado de la solicitud de revocación (e.g., "pending").
+     */
+    revocationStatus: string;
+    /**
+     * - El ID de la solicitud de revocación.
+     */
+    requestId: string | number;
+};
+/**
+ * @typedef {object} RequestRevocationResponse
+ * @property {string} revocationStatus - El estado de la solicitud de revocación (e.g., "pending").
+ * @property {string|number} requestId - El ID de la solicitud de revocación.
+ */
 /**
  * Simula la solicitud de revocación de un certificado.
  * @param {string} reasonCode - Código o descripción del motivo de la revocación.
- * @returns {Promise<object>} Objeto con el estado de la solicitud de revocación.
+ * @returns {Promise<RequestRevocationResponse>} Objeto con el estado de la solicitud de revocación.
  */
-declare function requestRevocation(reasonCode: string): Promise<object>;
+declare function requestRevocation(reasonCode: string): Promise<RequestRevocationResponse>;

package/dist/api/signatures.d.ts

@@ -1,4 +1,4 @@
-export function signDocument(): Promise<object>;
+export function signDocument(signData: SignDocumentData): Promise<object>;
 export function getDigest(signData: GetDigestData): Promise<GetDigestResponse>;
 export function addSigner(signerData: SignerData): Promise<AddSignerResponse>;
 export function getDocs(data: GetDocsParams): Promise<GetDocsResponse>;
@@ -105,3 +105,20 @@ export type GetDocsResponse = {
      */
     success: boolean;
 };
+export type SignDocumentData = {
+    /**
+     * - Objeto con información de la firma.
+     */
+    signature: {
+        id: string;
+        positions: Array<object>;
+    };
+    /**
+     * - Certificado en base64.
+     */
+    cert: string;
+    /**
+     * - Digest firmado.
+     */
+    signedDigest: string;
+};

package/dist/api/users.d.ts

@@ -1,15 +1,31 @@
 export default getCustomer;
+export type GetCustomerResponse = {
+    /**
+     * - El token de sesión del usuario.
+     */
+    token: string;
+    /**
+     * - Los datos del usuario obtenidos.
+     */
+    userData: object;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};
+/**
+ * @typedef {object} GetCustomerResponse
+ * @property {string} token - El token de sesión del usuario.
+ * @property {object} userData - Los datos del usuario obtenidos.
+ * @property {boolean} success - Indica si la operación fue exitosa.
+ */
 /**
  * Obtiene el token de un usuario a través de una petición POST.
  * Este método es útil para endpoints que requieren datos en el cuerpo de la petición
  * para buscar un usuario, como un ID de sesión o un token de acceso.
  *
- * @returns {Promise<{token: string, userData: object, success: boolean}>} Objeto con el token de sesión, los datos del usuario y un indicador de éxito.
+ * @returns {Promise<GetCustomerResponse>} Objeto con el token de sesión, los datos del usuario y un indicador de éxito.
  * @throws {Error} Si los parámetros de entrada son inválidos.
  * @throws {ApacuanaAPIError} Si ocurre un error en la API de Apacuana.
  */
-declare function getCustomer(): Promise<{
-    token: string;
-    userData: object;
-    success: boolean;
-}>;
+declare function getCustomer(): Promise<GetCustomerResponse>;

package/dist/index.d.ts

@@ -15,6 +15,8 @@ declare namespace apacuana {
     export { addSigner };
     export { getDocs };
     export { generateCert };
+    export { signDocument };
+    export { getDigest };
 }
 import { getConfig } from "./config/index";
 import requestRevocation from "./api/revocations";
@@ -23,3 +25,5 @@ import getCustomer from "./api/users";
 import { addSigner } from "./api/signatures";
 import { getDocs } from "./api/signatures";
 import { generateCert } from "./api/certs";
+import { signDocument } from "./api/signatures";
+import { getDigest } from "./api/signatures";