apacuana-sdk-core 0.5.0 → 0.6.2

package/dist/api/certs.d.ts

@@ -1,8 +1,22 @@
-export function generateCert(csr?: string): Promise<{
+export function generateCert(encryptedCSR?: undefined): 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";