apacuana-sdk-core 0.4.0 → 0.6.0

package/dist/api/signatures.d.ts

@@ -1,16 +1,124 @@
-export function signDocument(): Promise<{
-    digest: string;
-}>;
-export function getDigest(signData: object): Promise<{
-    digest: string;
-    success: boolean;
-}>;
-export function addSigner(signerData: object): Promise<{
+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>;
+/**
+ * Define la estructura de un objeto Firmante.
+ */
+export type Signer = {
+    /**
+     * - Nombre completo del firmante.
+     */
+    name: string;
+    /**
+     * - Correo electrónico del firmante.
+     */
+    email: string;
+    /**
+     * - Documento de identidad del firmante.
+     */
+    document: string;
+};
+/**
+ * Define la estructura de datos para añadir un firmante.
+ */
+export type SignerData = {
+    /**
+     * - Identificador único del documento.
+     */
+    docId: string;
+    /**
+     * - Objeto con la información del firmante.
+     */
+    signer: Signer;
+};
+/**
+ * Define la estructura de la respuesta al añadir un firmante.
+ */
+export type AddSignerResponse = {
+    /**
+     * - Identificador de confirmación del firmante añadido.
+     */
     signer: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
+    success: boolean;
+};
+/**
+ * Define la estructura de datos para obtener el digest de un documento.
+ */
+export type GetDigestData = {
+    /**
+     * - Certificado del firmante en formato base64.
+     */
+    cert: string;
+    /**
+     * - Identificador único del proceso de firma.
+     */
+    signatureId: string;
+};
+/**
+ * Define la estructura de la respuesta al obtener el digest.
+ */
+export type GetDigestResponse = {
+    /**
+     * - El digest del documento que se va a firmar.
+     */
+    digest: string;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
     success: boolean;
-}>;
-export function getDocs(data: object): Promise<{
+};
+/**
+ * Define la estructura de los parámetros para obtener documentos.
+ */
+export type GetDocsParams = {
+    /**
+     * - Número de página para la paginación.
+     */
+    page: number;
+    /**
+     * - Cantidad de registros por página.
+     */
+    size: number;
+    /**
+     * - (Opcional) Estado para filtrar los documentos.
+     */
+    status?: string | undefined;
+};
+/**
+ * Define la estructura de la respuesta al obtener documentos.
+ */
+export type GetDocsResponse = {
+    /**
+     * - El número total de registros encontrados.
+     */
     totalRecords: number;
-    records: any[];
+    /**
+     * - Un arreglo con los registros de los documentos.
+     */
+    records: Array<object>;
+    /**
+     * - Indica si la operación fue exitosa.
+     */
     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";