edatalia-websign 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.txt ADDED
@@ -0,0 +1,15 @@
1
+ # Licencia Comercial de Web-Sign
2
+
3
+ © 2024 edatalia data solutions. Todos los derechos reservados.
4
+
5
+ **Web-Sign** es un software propietario. Esta licencia permite el uso de la librería exclusivamente bajo las condiciones establecidas por edatalia data solutions.
6
+
7
+ ## Condiciones de Uso
8
+ - Este software no puede ser distribuido, modificado, o utilizado sin el permiso explícito de edatalia data solutions.
9
+ - La redistribución no autorizada está prohibida.
10
+ - Para obtener derechos de uso comercial, contacta con nosotros en https://edatalia.com/contacto/.
11
+
12
+ ## Garantía y Responsabilidad
13
+ Este software se proporciona "tal cual", sin garantías de ningún tipo.edatalia data solutions no es responsable de ningún daño derivado del uso del software.
14
+
15
+ Para más información o adquirir una licencia comercial, visita https://edatalia.com/.
package/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # Web-Sign
2
+
3
+ **Web-Sign** es una librería JavaScript para la captura de firmas digitales de forma sencilla y personalizable. Permite integrarse fácilmente en cualquier entorno web y ofrece compatibilidad con dispositivos como Wacom STU o DTU.
4
+
5
+ ## ✨ Características
6
+
7
+ - Modo **Core**: incluye lo esencial para capturar firmas y captura por DTU.
8
+ - Modo **Full**: incluye funcionalidades extra como firma manual (no DTU por el momento).
9
+ - Detección automática de dispositivos compatibles (STU, DTU o modo display).
10
+ - Configuración flexible y override opcional por parte del usuario.
11
+ - Callback centralizado para controlar eventos como éxito, error, cancelación, etc.
12
+
13
+
14
+
15
+ ## 🚀 Uso Básico
16
+
17
+ Para comenzar a utilizar `Web-Sign`, sigue estos pasos:
18
+
19
+ ### 1. Inserta el contenedor en tu HTML
20
+
21
+ Crea un `<div>` con el ID `web-sign`, que es donde se renderizará el componente de firma:
22
+
23
+ ```html
24
+ <div id="web-sign"></div>
25
+ ```
26
+ ### 2. Importa y utiliza la librería
27
+ ```html
28
+ let webSign = new WebSign(file, config, callback);
29
+ ```
30
+ Parámetros:
31
+
32
+ ```file:``` El documento PDF a firmar. Puede ser un archivo File, un Blob o una cadena en Base64.
33
+
34
+ ```config``` (opcional): Objeto con configuración adicional para personalizar el comportamiento. Si no se pasa, se usará la configuración por defecto incluida en el archivo de configuración del proyecto.
35
+
36
+ ```callback:``` Función que se ejecutará con los eventos que genere la librería.
37
+
38
+ #### Ejemplo de uso:
39
+
40
+ ```html
41
+ let webSign = new WebSign(file, {}, (event) => {
42
+ console.log(event);
43
+ switch (event.type) {
44
+ case "cancel":
45
+ // El usuario canceló el proceso
46
+ break;
47
+ case "signed":
48
+ // Firma completada con éxito
49
+ break;
50
+ case "error":
51
+ console.error(event.error);
52
+ document.getElementById("fieldset-container").style.display = "none";
53
+ break;
54
+ case "no-device":
55
+ console.log("No hay dispositivo conectado. Intenta relanzar WebSign con otra configuración.");
56
+ break;
57
+ case "signature-timeout":
58
+ console.log("La firma ha expirado por tiempo.");
59
+ break;
60
+ }
61
+ });
62
+ ````
63
+
64
+
65
+
66
+
67
+
package/package.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "name": "edatalia-websign",
3
+ "version": "3.0.0",
4
+ "description": "JavaScript library for handwritten digital signatures from a web browser and/or using Wacom STU and DTU tablets.",
5
+ "main": "web-sign-core.js",
6
+ "files": [
7
+ "web-sign-core.js"
8
+ ],
9
+ "scripts": {
10
+ "test": "jest",
11
+ "build:core": "cross-env BUILD_TARGET=core rollup -c",
12
+ "build:full": "cross-env BUILD_TARGET=full rollup -c",
13
+ "build:all": "node postbuild.mjs"
14
+ },
15
+ "keywords": [],
16
+ "author": "edatalia data solutions",
17
+ "license": "Propietary",
18
+ "private": false,
19
+ "devDependencies": {
20
+ "@babel/preset-env": "^7.26.9",
21
+ "@rollup/plugin-babel": "^6.0.4",
22
+ "@rollup/plugin-commonjs": "^28.0.1",
23
+ "@rollup/plugin-json": "^6.1.0",
24
+ "@rollup/plugin-node-resolve": "^15.3.0",
25
+ "@rollup/plugin-replace": "^6.0.2",
26
+ "babel-jest": "^29.7.0",
27
+ "cross-env": "^7.0.3",
28
+ "jest-environment-jsdom": "^29.7.0",
29
+ "jest-environment-node": "^29.7.0",
30
+ "rollup": "^2.79.2",
31
+ "rollup-plugin-terser": "^7.0.2"
32
+ },
33
+ "dependencies": {
34
+ "archiver": "^7.0.1",
35
+ "jest": "^29.7.0"
36
+ }
37
+ }