apacuana-sdk-core 1.26.0 → 1.26.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apacuana-sdk-core",
-  "version": "1.26.0",
+  "version": "1.26.2",
   "description": "Core SDK para interacciones con las APIs de Apacuana.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/src/api/signatures.js

@@ -240,12 +240,10 @@ const deleteSignatureVariantOnPremise = async () => {
 
 const addMemberOnBoarding = async (memberData) => {
   const payload = helpers.validateAddMemberData(memberData);
-  // Transform documentId to docid for API compatibility
   const apiPayload = {
     docid: payload.documentId,
     kinddoc: payload.typedoc,
     doc: payload.doc,
-    signature: payload.signature,
   };
   try {
     const response = await httpRequest(
@@ -272,6 +270,64 @@ const addMemberOnPremise = async () => {
   );
 };
 
+const createDocumentOnBoarding = async (documentData) => {
+  const formData = new FormData();
+  formData.append("name", documentData.name);
+  formData.append("reference", documentData.reference);
+  try {
+    const response = await httpRequest(
+      "services/api/documents",
+      formData,
+      "POST"
+    );
+    return new ApacuanaSuccess({
+      msg: response.msg,
+      id: response.id,
+    });
+  } catch (error) {
+    if (error instanceof ApacuanaAPIError) {
+      throw error;
+    }
+    throw new ApacuanaAPIError(
+      `Failed to create document: ${error.message || "Unknown error"}`
+    );
+  }
+};
+
+const createDocumentOnPremise = async () => {
+  throw new ApacuanaAPIError(
+    "Creating documents is not supported for integration type: ONPREMISE",
+    501,
+    "NOT_IMPLEMENTED"
+  );
+};
+
+const lockDocumentOnBoarding = async (documentId) => {
+  try {
+    const response = await httpRequest(
+      `services/api/documents/lock/${documentId}`,
+      {},
+      "PUT"
+    );
+    return new ApacuanaSuccess(response);
+  } catch (error) {
+    if (error instanceof ApacuanaAPIError) {
+      throw error;
+    }
+    throw new ApacuanaAPIError(
+      `Failed to lock document: ${error.message || "Unknown error"}`
+    );
+  }
+};
+
+const lockDocumentOnPremise = async () => {
+  throw new ApacuanaAPIError(
+    "Locking documents is not supported for integration type: ONPREMISE",
+    501,
+    "NOT_IMPLEMENTED"
+  );
+};
+
 // =================================================================
 // Exported Functions
 // =================================================================
@@ -506,3 +562,81 @@ export const addMember = async (memberData) => {
     "UNSUPPORTED_INTEGRATION_TYPE"
   );
 };
+
+/**
+ * Crea un nuevo documento para ser firmado.
+ * @param {object} documentData - Datos del documento a crear.
+ * @param {string} documentData.name - Nombre del documento.
+ * @param {string} documentData.reference - Referencia del documento.
+ * @returns {Promise<object>} Una promesa que resuelve a un objeto con `{ msg, id }` del documento creado.
+ * @throws {ApacuanaAPIError} Si los datos son inválidos, la llamada a la API falla, o el tipo de integración no es soportado.
+ */
+export const createDocument = async (documentData) => {
+  if (
+    !documentData ||
+    typeof documentData !== "object" ||
+    Object.keys(documentData).length === 0
+  ) {
+    throw new ApacuanaAPIError(
+      "Document data (documentData) is required and must be a non-empty object.",
+      400,
+      "INVALID_PARAMETER"
+    );
+  }
+
+  if (!documentData.name || !documentData.reference) {
+    throw new ApacuanaAPIError(
+      "Fields 'name' and 'reference' are required.",
+      400,
+      "INVALID_PARAMETER"
+    );
+  }
+
+  const { integrationType } = getConfig();
+
+  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
+    return createDocumentOnBoarding(documentData);
+  }
+
+  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
+    return createDocumentOnPremise();
+  }
+
+  throw new ApacuanaAPIError(
+    `Unsupported integration type: ${integrationType}`,
+    400,
+    "UNSUPPORTED_INTEGRATION_TYPE"
+  );
+};
+
+/**
+ * Bloquea un documento para evitar modificaciones.
+ * @param {string} documentId - ID (UUID) del documento a bloquear.
+ * @returns {Promise<object>} Una promesa que resuelve al response de la API.
+ * @throws {ApacuanaAPIError} Si el documentId es inválido, la llamada a la API falla, o el tipo de integración no es soportado.
+ */
+export const lockDocument = async (documentId) => {
+  if (!documentId || typeof documentId !== "string") {
+    throw new ApacuanaAPIError(
+      "Field 'documentId' is required and must be a string.",
+      400,
+      "INVALID_PARAMETER"
+    );
+  }
+
+  const { integrationType } = getConfig();
+
+  if (integrationType === INTEGRATION_TYPE.ONBOARDING) {
+    return lockDocumentOnBoarding(documentId);
+  }
+
+  if (integrationType === INTEGRATION_TYPE.ONPREMISE) {
+    return lockDocumentOnPremise();
+  }
+
+  throw new ApacuanaAPIError(
+    `Unsupported integration type: ${integrationType}`,
+    400,
+    "UNSUPPORTED_INTEGRATION_TYPE"
+  );
+};

package/src/index.js

@@ -10,10 +10,12 @@ import {
 import {
   addSigner,
   addMember,
+  createDocument,
   deleteSignatureVariant,
   getDigest,
   getDocs,
   getSignatureVariant,
+  lockDocument,
   signDocument,
   uploadSignatureVariant,
 } from "./api/signatures";
@@ -161,6 +163,15 @@ const apacuana = {
     return sendFaceLiveness(data);
   },
 
+  createDocument: (data) => {
+    checkSdk(false);
+    return createDocument(data);
+  },
+  lockDocument: (documentId) => {
+    checkSdk(false);
+    return lockDocument(documentId);
+  },
+
   close: () => close(),
   getConfig,
 };

package/tests/api/signatures.test.js

@@ -5,12 +5,14 @@ import ApacuanaSuccess from "../../src/success";
 import {
   addSigner,
   addMember,
+  createDocument,
+  deleteSignatureVariant,
   getDocs,
   getDigest,
+  getSignatureVariant,
+  lockDocument,
   signDocument,
   uploadSignatureVariant,
-  getSignatureVariant,
-  deleteSignatureVariant,
 } from "../../src/api/signatures";
 import helpers from "../../src/utils/helpers";
 import { INTEGRATION_TYPE } from "../../src/utils/constant";
@@ -622,4 +624,166 @@ describe("API - Signatures", () => {
       );
     });
   });
+
+  describe("createDocument", () => {
+    it("should create a document for ONBOARDING integration", async () => {
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONBOARDING,
+      });
+      const documentData = { name: "prueba", reference: "prueba" };
+      const mockResponse = {
+        msg: "Documento creado",
+        id: "ef3344bb-d114-46b5-8356-90ec113cbbbd",
+      };
+      httpRequest.mockResolvedValue(mockResponse);
+
+      const result = await createDocument(documentData);
+
+      expect(httpRequest).toHaveBeenCalledWith(
+        "services/api/documents",
+        expect.any(FormData),
+        "POST"
+      );
+      expect(result).toBeInstanceOf(ApacuanaSuccess);
+      expect(result.data).toEqual(mockResponse);
+    });
+
+    it("should throw not implemented for ONPREMISE integration", async () => {
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONPREMISE,
+      });
+
+      await expect(
+        createDocument({ name: "x", reference: "y" })
+      ).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Creating documents is not supported for integration type: ONPREMISE",
+          501,
+          "NOT_IMPLEMENTED"
+        )
+      );
+    });
+
+    it("should throw an error for unsupported integration type", async () => {
+      getConfig.mockReturnValue({ integrationType: "UNSUPPORTED" });
+      await expect(
+        createDocument({ name: "x", reference: "y" })
+      ).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Unsupported integration type: UNSUPPORTED",
+          400,
+          "UNSUPPORTED_INTEGRATION_TYPE"
+        )
+      );
+    });
+
+    it("should throw an error if documentData is invalid", async () => {
+      await expect(createDocument(null)).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Document data (documentData) is required and must be a non-empty object.",
+          400,
+          "INVALID_PARAMETER"
+        )
+      );
+    });
+
+    it("should throw an error if name or reference is missing", async () => {
+      await expect(createDocument({ name: "x" })).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Fields 'name' and 'reference' are required.",
+          400,
+          "INVALID_PARAMETER"
+        )
+      );
+    });
+
+    it("should wrap non-ApacuanaAPIError from httpRequest as ApacuanaAPIError", async () => {
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONBOARDING,
+      });
+      httpRequest.mockRejectedValue(new Error("Network error"));
+
+      await expect(
+        createDocument({ name: "x", reference: "y" })
+      ).rejects.toThrow(
+        new ApacuanaAPIError("Failed to create document: Network error")
+      );
+    });
+  });
+
+  describe("lockDocument", () => {
+    it("should lock a document for ONBOARDING integration", async () => {
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONBOARDING,
+      });
+      const documentId = "ccb318a8-e8ff-4a17-ba20-10acbcd96785";
+      const mockResponse = { success: true, locked: true };
+      httpRequest.mockResolvedValue(mockResponse);
+
+      const result = await lockDocument(documentId);
+
+      expect(httpRequest).toHaveBeenCalledWith(
+        `services/api/documents/lock/${documentId}`,
+        {},
+        "PUT"
+      );
+      expect(result).toBeInstanceOf(ApacuanaSuccess);
+      expect(result.data).toEqual(mockResponse);
+    });
+
+    it("should throw not implemented for ONPREMISE integration", async () => {
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONPREMISE,
+      });
+
+      await expect(lockDocument("ccb318a8-e8ff-4a17-ba20-10acbcd96785")).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Locking documents is not supported for integration type: ONPREMISE",
+          501,
+          "NOT_IMPLEMENTED"
+        )
+      );
+    });
+
+    it("should throw an error for unsupported integration type", async () => {
+      getConfig.mockReturnValue({ integrationType: "UNSUPPORTED" });
+      await expect(lockDocument("ccb318a8-e8ff-4a17-ba20-10acbcd96785")).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Unsupported integration type: UNSUPPORTED",
+          400,
+          "UNSUPPORTED_INTEGRATION_TYPE"
+        )
+      );
+    });
+
+    it("should throw an error if documentId is missing or not a string", async () => {
+      await expect(lockDocument(null)).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Field 'documentId' is required and must be a string.",
+          400,
+          "INVALID_PARAMETER"
+        )
+      );
+      await expect(lockDocument(123)).rejects.toThrow(
+        new ApacuanaAPIError(
+          "Field 'documentId' is required and must be a string.",
+          400,
+          "INVALID_PARAMETER"
+        )
+      );
+    });
+
+    it("should wrap non-ApacuanaAPIError from httpRequest as ApacuanaAPIError", async () => {
+      getConfig.mockReturnValue({
+        integrationType: INTEGRATION_TYPE.ONBOARDING,
+      });
+      httpRequest.mockRejectedValue(new Error("Network error"));
+
+      await expect(
+        lockDocument("ccb318a8-e8ff-4a17-ba20-10acbcd96785")
+      ).rejects.toThrow(
+        new ApacuanaAPIError("Failed to lock document: Network error")
+      );
+    });
+  });
 });

package/tests/integration/createAndLockDocument.test.js

@@ -0,0 +1,93 @@
+/**
+ * Integration tests for createDocument → lockDocument flow
+ *
+ * Requires environment variables (copy .env.example to .env and fill in):
+ *   APACUANA_API_URL=https://api.dev.apacuana.3dlinkweb.com
+ *   APACUANA_SECRET_KEY=your-secret-key
+ *   APACUANA_API_KEY=your-api-key
+ *   APACUANA_VERIFICATION_ID=your-verification-id
+ *   APACUANA_INTEGRATION_TYPE=ONBOARDING
+ *
+ * Note: APACUANA_DOCUMENT_REFERENCE is provided by the backend team for this
+ * sandbox environment; it's a reference id the document will be linked to.
+ *
+ * Run with: NODE_ENV=test npm test -- --testPathPatterns="integration/createAndLockDocument.test.js"
+ */
+import { readFileSync } from "fs";
+import { resolve } from "path";
+
+const envPath = resolve(process.cwd(), ".env");
+
+try {
+	const envContent = readFileSync(envPath, "utf-8");
+	envContent.split("\n").forEach(line => {
+		const [key, ...valueParts] = line.split("=");
+		if (key && key.trim() && !key.startsWith("#")) {
+			process.env[key.trim()] = valueParts.join("=").replace(/"/g, "").trim();
+		}
+	});
+} catch (err) {
+	// .env file not found, continue without it
+}
+
+import apacuana from "../../src/index.js";
+
+const requiredEnvVars = [
+	"APACUANA_API_URL",
+	"APACUANA_SECRET_KEY",
+	"APACUANA_API_KEY",
+	"APACUANA_VERIFICATION_ID",
+	"APACUANA_INTEGRATION_TYPE",
+	"APACUANA_DOCUMENT_REFERENCE",
+];
+
+const missingVars = requiredEnvVars.filter(v => !process.env[v]);
+if (missingVars.length > 0) {
+	test.skip("createDocument then lockDocument integration", () => {});
+	throw new Error(
+		`\n⚠️  Missing environment variables: ${missingVars.join(", ")}\n` +
+			"Create a .env file based on .env.example.\n"
+	);
+}
+
+describe("createDocument → lockDocument - Integration", () => {
+	beforeAll(async () => {
+		await apacuana.init({
+			apiUrl: process.env.APACUANA_API_URL,
+			secretKey: process.env.APACUANA_SECRET_KEY,
+			apiKey: process.env.APACUANA_API_KEY,
+			verificationId: process.env.APACUANA_VERIFICATION_ID,
+			integrationType: process.env.APACUANA_INTEGRATION_TYPE,
+			// customerId omitted: init() would set Authorization: Bearer which the
+			// backend rejects on this endpoint with 404 "Cliente no encontrado".
+		});
+	});
+
+	afterAll(() => {
+		apacuana.close();
+	});
+
+	test("should create a document and then lock it using the returned id", async () => {
+		const timestamp = Date.now();
+		const documentData = {
+			name: `integration-test-${timestamp}`,
+			reference: process.env.APACUANA_DOCUMENT_REFERENCE,
+		};
+
+		const createResult = await apacuana.createDocument(documentData);
+
+		expect(createResult).toBeDefined();
+		expect(createResult.success).toBe(true);
+		expect(createResult.data).toBeDefined();
+		expect(createResult.data.id).toBeDefined();
+		expect(typeof createResult.data.id).toBe("string");
+
+		const documentId = createResult.data.id;
+
+		const lockResult = await apacuana.lockDocument(documentId);
+
+		expect(lockResult).toBeDefined();
+		expect(lockResult.success).toBe(true);
+		expect(lockResult.data).toBeDefined();
+	});
+});

package/coverage/lcov-report/api/index.html

@@ -1,131 +0,0 @@
-
-<!doctype html>
-<html lang="en">
-
-<head>
-    <title>Code coverage report for api</title>
-    <meta charset="utf-8" />
-    <link rel="stylesheet" href="../prettify.css" />
-    <link rel="stylesheet" href="../base.css" />
-    <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <style type='text/css'>
-        .coverage-summary .sorter {
-            background-image: url(../sort-arrow-sprite.png);
-        }
-    </style>
-</head>
-    
-<body>
-<div class='wrapper'>
-    <div class='pad1'>
-        <h1><a href="../index.html">All files</a> api</h1>
-        <div class='clearfix'>
-            
-            <div class='fl pad1y space-right2'>
-                <span class="strong">57.29% </span>
-                <span class="quiet">Statements</span>
-                <span class='fraction'>55/96</span>
-            </div>
-        
-            
-            <div class='fl pad1y space-right2'>
-                <span class="strong">50.98% </span>
-                <span class="quiet">Branches</span>
-                <span class='fraction'>26/51</span>
-            </div>
-        
-            
-            <div class='fl pad1y space-right2'>
-                <span class="strong">50% </span>
-                <span class="quiet">Functions</span>
-                <span class='fraction'>7/14</span>
-            </div>
-        
-            
-            <div class='fl pad1y space-right2'>
-                <span class="strong">57.29% </span>
-                <span class="quiet">Lines</span>
-                <span class='fraction'>55/96</span>
-            </div>
-        
-            
-        </div>
-        <p class="quiet">
-            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
-        </p>
-        <template id="filterTemplate">
-            <div class="quiet">
-                Filter:
-                <input type="search" id="fileSearch">
-            </div>
-        </template>
-    </div>
-    <div class='status-line medium'></div>
-    <div class="pad1">
-<table class="coverage-summary">
-<thead>
-<tr>
-   <th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
-   <th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
-   <th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
-   <th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
-   <th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
-   <th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
-   <th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
-   <th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
-</tr>
-</thead>
-<tbody><tr>
-	<td class="file medium" data-value="signatures.js"><a href="signatures.js.html">signatures.js</a></td>
-	<td data-value="50.6" class="pic medium">
-	<div class="chart"><div class="cover-fill" style="width: 50%"></div><div class="cover-empty" style="width: 50%"></div></div>
-	</td>
-	<td data-value="50.6" class="pct medium">50.6%</td>
-	<td data-value="83" class="abs medium">42/83</td>
-	<td data-value="38.46" class="pct low">38.46%</td>
-	<td data-value="39" class="abs low">15/39</td>
-	<td data-value="46.15" class="pct low">46.15%</td>
-	<td data-value="13" class="abs low">6/13</td>
-	<td data-value="50.6" class="pct medium">50.6%</td>
-	<td data-value="83" class="abs medium">42/83</td>
-	</tr>
-
-<tr>
-	<td class="file high" data-value="users.js"><a href="users.js.html">users.js</a></td>
-	<td data-value="100" class="pic high">
-	<div class="chart"><div class="cover-fill cover-full" style="width: 100%"></div><div class="cover-empty" style="width: 0%"></div></div>
-	</td>
-	<td data-value="100" class="pct high">100%</td>
-	<td data-value="13" class="abs high">13/13</td>
-	<td data-value="91.66" class="pct high">91.66%</td>
-	<td data-value="12" class="abs high">11/12</td>
-	<td data-value="100" class="pct high">100%</td>
-	<td data-value="1" class="abs high">1/1</td>
-	<td data-value="100" class="pct high">100%</td>
-	<td data-value="13" class="abs high">13/13</td>
-	</tr>
-
-</tbody>
-</table>
-</div>
-                <div class='push'></div><!-- for sticky footer -->
-            </div><!-- /wrapper -->
-            <div class='footer quiet pad2 space-top1 center small'>
-                Code coverage generated by
-                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-                at 2025-08-26T16:18:42.585Z
-            </div>
-        <script src="../prettify.js"></script>
-        <script>
-            window.onload = function () {
-                prettyPrint();
-            };
-        </script>
-        <script src="../sorter.js"></script>
-        <script src="../block-navigation.js"></script>
-    </body>
-</html>
-