edatalia-websign 3.0.0 → 3.0.2

package/README.md

@@ -1,67 +1,245 @@
-# Web-Sign
+# WebSign 
 
-**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.
+**WebSign** is a JavaScript library developed by **Edatalia** for integrating handwritten digital signatures into PDF documents from any modern web browser. It supports native browser signing as well as advanced integration with Wacom STU and DTU signature tablets.
 
-## ✨ Características
+> **Important:** WebSign works exclusively over **HTTPS** and with **UTF-8** encoding.
 
-- Modo **Core**: incluye lo esencial para capturar firmas y captura por DTU.
-- Modo **Full**: incluye funcionalidades extra como firma manual (no DTU por el momento).
-- Detección automática de dispositivos compatibles (STU, DTU o modo display).
-- Configuración flexible y override opcional por parte del usuario.
-- Callback centralizado para controlar eventos como éxito, error, cancelación, etc.
+---
 
+## ✨ Features
 
+- Handwritten PDF signing via browser, STU, or DTU tablets
+- Signature positioning via fixed coordinates or float (text search)
+- Certified PDF signatures with OCSP and timestamp support
+- EBP templates for Wacom
+- Supports Salesforce and restricted environments
+- Multi-language support
+- Custom signature widget appearance and metadata
+- Multi-document signature
 
-## 🚀 Uso Básico
+---
 
-Para comenzar a utilizar `Web-Sign`, sigue estos pasos:
+## 📦 Installation
 
-### 1. Inserta el contenedor en tu HTML
+Install via NPM:
 
-Crea un `<div>` con el ID `web-sign`, que es donde se renderizará el componente de firma:
+```bash
+npm install edatalia-websign
+```
+
+Then, import it in your JavaScript application:
+
+```js
+import 'edatalia-websign';
+```
+> This will globally register the `WebSign` constructor in the browser context.
+
+In your HTML or SPA component, place the following container:
 
 ```html
 <div id="web-sign"></div>
 ```
-### 2. Importa y utiliza la librería
+
+---
+
+## 🚀 Basic Usage
+
+Example using a file input:
+
+WebSign comes with default parameter values, but it's recommended to set them to your desired value depending on your needs. Also you need a bearer token to be able to sign.
 ```html
-let webSign = new WebSign(file, config, callback);
+<input type="file" id="fileInput" />
+<div id="web-sign"></div>
+
+<script>
+  document.getElementById("fileInput").addEventListener("change", (e) => {
+    const file = e.target.files[0];
+
+    const config = {
+      bearerToken: "Your bearer Token",
+      signatureType: "display",
+      language: "es"
+      //...
+    };
+
+    const webSign = new WebSign(file, config, (event) => {
+      switch (event.type) {
+        case "signed":
+          console.log("Signed PDF:", event.data);
+          break;
+        default;
+      }
+    });
+  });
+</script>
 ```
-Parámetros:
+---
+WebSign constructor requires **three** parameters: 
 
-```file:``` El documento PDF a firmar. Puede ser un archivo File, un Blob o una cadena en Base64.
+    1. PDF INPUT FILE
+    2. CONFIG OBJECT
+    3. CALLBACK
 
-```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.
+## 📄 PDF Input Formats 
 
-```callback:``` Función que se ejecutará con los eventos que genere la librería.
+You can provide the PDF to WebSign in three formats:
 
-#### Ejemplo de uso:
+1. **HTML file input**
 
-```html
-let webSign = new WebSign(file, {}, (event) => {
-  console.log(event);
-  switch (event.type) {
-    case "cancel":
-      // El usuario canceló el proceso
-      break;
-    case "signed":
-      // Firma completada con éxito
-      break;
-    case "error":
-      console.error(event.error);
-      document.getElementById("fieldset-container").style.display = "none";
-      break;
-    case "no-device":
-      console.log("No hay dispositivo conectado. Intenta relanzar WebSign con otra configuración.");
-      break;
-    case "signature-timeout":
-      console.log("La firma ha expirado por tiempo.");
-      break;
-  }
-});
-````
+```js
+const file = input.files[0]; // can be multi-document
+```
+
+2. **Base64 string**
+
+```js
+const base64String = "JVBERi0xLjQKJ...";
+```
+
+3. **Salesforce-compatible structure**
+
+```js
+const pdfData = {
+  pdfB64: "base64_string",
+  pdfUrl: "https://url.to/your.pdf"
+};
+```
+
+---
+
+## ⚙️ Configuration Parameters
+
+All parameters below are part of the `config` object:
+
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `bearerToken` | `string` | Auth token for API communication |
+| `debug` | `boolean` | To enable or disable error messages |
+| `requestPermissions` | `boolean` | Request permissions for tablets via a button before launching the app. |
+| `mainContainerWidth` | `string` | Width of the main container (e.g. `"100%"`, `"800px"`)|
+| `mainContainerHeight` | `string` | Height of the main container (e.g. `"100%"`, `"800px"`) |
+| `signatureContainerWidth` | `string` | Width of the signature container (e.g. `"100%"`, `"800px"`)|
+| `signatureContainerHeight` | `string` | Height of the signature container (e.g. `"100%"`, `"800px"`) |
+| `signatureEnvironment` | `string` | `"SANDBOX"` or `"PRO"` |
+| `signatureServiceUrl` | `string` | Endpoint for signature |
+| `signatureType` | `string` | `"stu"`, `"display"`, `"dtu"`, or `"auto"` |
+| `signatureColorHex` | `string` | Hex color of signature stroke |
+| `autoDownload` | `boolean` | Auto-download the signed PDF |
+| `minPointsRequiredToSign` | `number` | Minimum stroke points required |
+| `signatureThickness` | `number` | Stroke thickness (1–30) |
+| `mouseEBP` | `boolean` | Enable mouse EBP |
+| `viewPDF` | `boolean` | Enable PDF preview |
+| `renderDefaultIndexPage` | `number` | PDF page to show initially |
+| `requestedEncodingBits` | `number` | EBP encoding quality (1, 16, 24) |
+| `requestPermissions` | `boolean` | Show permission button before start |
+| `language` | `string` | UI language (e.g., `"es"`, `"en"`, `"fr"`) |
+| `requestLocation` | `boolean` | Include geolocation metadata |
+| `doPerformance` | `boolean` | Enable performance tracking |
+| `dtuHtmlUrl` | `boolean` | Html path for dtu  |
+| `jsUrl` | `boolean` | Js path for dtu |
+| `loadSignedPdf` | `boolean` | Upload the signed PDF upon completion of the signature |
+| `encCertKey` | `string` | Value to define the public key for the biometric data encryption certificate. By default, the edatalia encryption certificate will be used. |
+| `signatureTimeLimit` | `number` | Time limit to be able to sign |
+| `widget` | `Object` | Specifies signature positioning in coordinates or by text search, custom text for the signature, etc. |
+| `wacom` | `Object` | Specifies parameter for the wacom devices |
+
+---
+
+```js
+widget: {
+  type: "float", // can be 'fixed' (absolute position) or 'float' (based on text search)
+  width: 160, // width of the signature area
+  height: 100, // height of the signature area
+  x: 0, // X position on the PDF page (used if type is 'fixed')
+  y: 0, // Y position on the PDF page (used if type is 'fixed')
+  page: 0, // PDF page number where the signature will appear
+  customText: [ // text displayed on the PDF after signing
+      {
+          text: "Documento firmado digitalmente",
+          fontSize: 6
+      },
+      {
+          text: "Fecha y hora: ##TIMESTAMP##",
+          fontSize: 4
+      }
+  ],
+  text: null, // if 'float', this text will be searched in the PDF to place the signature
+  fieldName: null, // optional name of the signature field
+  gapX: 0, // horizontal offset
+  gapY: 0  // vertical offset
+},
+
+```
+
+
+```js
+wacom: {
+  ebpServiceUrl: //Service URL for the ebp translation service (only required for on-premise installations),
+  enableScreenSaver: //Enables the standby screen.
+  blackAndWhiteScreenSaver: //Project path where the black and white Wacom standby screen image is located.
+  colorScreenSaver: //Project path where the color Wacom standby screen image is located.
+  enableEbp: //Enables ebp in the project (display templates on Wacom).
+  enableInitialEbp: //Enables the pre-signature screen on Wacom.
+  varInitialEbp: //Template description that appears on the Wacom screen before signing. Separated by |||.
+  blackAndWhiteInitialEbp: //Project path where the black and white Wacom initial image is located.
+  colorInitialEbp: //Project path where the initial color image for Wacom is located.
+  varEbp: //Text values displayed in the EBP template for Wacom tablets at the time of signing. Variables are separated by three "|||" pipes.
+
+},
+```
+  Example: "**varEbp**": "Titulo=Título inicial|||Subtitulo=Subtítulo inicial|||Nombre=Edatalia|||TextoPrevio=Estoy de acuerdo con el documento a firmar",
+## 📡 Events
+
+WebSign emits events via the callback function passed as the third argument:
+
+| Event | Description |
+|-------|-------------|
+| `signed` | Signature complete, PDF in `event.data` |
+| `signed-multiple` | Signature complete for multiple PDF in `event.data` |
+| `cancel` | User canceled the process |
+| `error` | An error occurred |
+| `no-device` | No Wacom device detected |
+| `signature-timeout` | Timeout waiting for user input |
+
+---
+---
+
+## 💻 DTU Integration
+
+WebSign supports **Wacom DTU tablets** via a dedicated HTML file rendered on the device screen. You must provide the following parameters:
+
+```js
+const config = {
+  signatureType: "dtu",
+  jsUrl: "/your/path/web-sign.js",
+  dtuHtmlUrl: "/your/path/dtu.html", // only needed in salesforce
+
+};
+
+```
+> DTU signing is only supported in **Google Chrome**, **Edge**, and **Opera**.
+
+## 🧾 License
+
+© 2025 Edatalia Data Solutions. All rights reserved.
+
+Web-Sign is proprietary software. Use of this library is permitted exclusively under the conditions set forth by Edatalia Data Solutions.
+
+Terms of Use
+This software may not be distributed, modified, or used without explicit permission from Edatalia Data Solutions.
+
+Unauthorized redistribution is strictly prohibited.
+
+For commercial licensing rights, please contact us at https://edatalia.com/contacto/.
 
+Warranty and Liability
+This software is provided "as is", without any warranties of any kind. Edatalia Data Solutions is not liable for any damages arising from the use of this software.
 
+For more information or to acquire a commercial license, visit https://edatalia.com/.
 
+---
 
+## 🏢 About
 
+Developed by [**Edatalia**](https://www.edatalia.com), digital signatures, and biometric solutions for secure document processing.

package/package.json

@@ -1,20 +1,25 @@
 {
   "name": "edatalia-websign",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "JavaScript library for handwritten digital signatures from a web browser and/or using Wacom STU and DTU tablets.",
   "main": "web-sign-core.js",
   "files": [
-    "web-sign-core.js"
+    "web-sign-core.js",
+    "favicon.ico"
   ],
   "scripts": {
     "test": "jest",
     "build:core": "cross-env BUILD_TARGET=core rollup -c",
     "build:full": "cross-env BUILD_TARGET=full rollup -c",
-    "build:all": "node postbuild.mjs"
+    "build:all": "node postbuild.mjs",
+    "publish:core-win": "npm run build:core && copy dist\\web-sign-core.js web-sign-core.js && npm publish --access public && del web-sign-core.js",
+    "publish:core-mac": "npm run build:core && cp dist/web-sign-core.js web-sign-core.js && npm publish --access public && rm -f web-sign-core.js"
+
+
   },
   "keywords": [],
   "author": "edatalia data solutions",
-  "license": "Propietary",
+  "license": "SEE LICENSE IN LICENSE.txt",
   "private": false,
   "devDependencies": {
     "@babel/preset-env": "^7.26.9",