@signosoft/signpad-js 0.4.0 → 0.4.2

package/README.md

@@ -582,9 +582,9 @@ Add the custom element tag to your HTML and create the necessary control buttons
 
 The component is primarily configured through a single `config` property. This object controls everything from licensing and hardware behavior to UI visibility and localization.
 
-| Property | Type            | Default     | Description                                      |
-| :------- | :-------------- | :---------- | :----------------------------------------------- |
-| `config` | `SignpadConfig` | `undefined` | The main configuration object for the component. |
+| Property | Type            | Default | Description                                      |
+| :------- | :-------------- | :------ | :----------------------------------------------- |
+| `config` | `SignpadConfig` | `{}`    | The main configuration object for the component. |
 
 ### 🔑 Core Options
 
@@ -592,32 +592,22 @@ The component is primarily configured through a single `config` property. This o
 | :---------- | :------- | :------- | :---------------------------------------------------------------------------- |
 | **`lease`** | `object` | **Yes**  | Lease payload returned from the lease API call. Mandatory for initialization. |
 
-### 🔄 autoconnectOptions
-
-Controls how the component handles hardware connections and session flow.
-
-| Field                           | Type      | Default | Description                                                                                           |
-| :------------------------------ | :-------- | :------ | :---------------------------------------------------------------------------------------------------- |
-| `autoConnect`                   | `boolean` | `false` | Attempts to connect to an authorized device on startup. Defaults to mouse mode if no device is found. |
-| `autoConnectOnPlugIn`           | `boolean` | `false` | Automatically initiates connection when a compatible and authorized device is plugged into USB.       |
-| `autoRestartSigningAfterAction` | `boolean` | `false` | Automatically calls `startSigning()` after a user completes an action (OK/Cancel).                    |
-
 ### 👁️ uiVisibilityOptions
 
 Toggles the visibility of specific User Interface elements.
 
-| Field                        | Type      | Description                                                       |
-| :--------------------------- | :-------- | :---------------------------------------------------------------- |
-| `topBarVisible`              | `boolean` | Shows/hides the entire top navigation bar.                        |
-| `topBarClearButtonVisible`   | `boolean` | Shows a "Clear" button in the top-left corner.                    |
-| `topBarConnectButtonVisible` | `boolean` | Shows the connect/disconnect button area in the top-right corner. |
-| `bottomBarVisible`           | `boolean` | Shows/hides the entire bottom action bar.                         |
-| `okButtonVisible`            | `boolean` | Shows the **OK** button in the bottom bar.                        |
-| `clearButtonVisible`         | `boolean` | Shows the **Clear** button in the bottom bar.                     |
-| `cancelButtonVisible`        | `boolean` | Shows the **Cancel** button in the bottom bar.                    |
-| `canvasLineVisible`          | `boolean` | Shows the horizontal signature guide line on the canvas.          |
-| `deviceStatusTextVisible`    | `boolean` | Shows the name of the connected device (e.g., "Wacom STU-540").   |
-| `additionalTextVisible`      | `boolean` | Shows helper status messages (e.g., "Ready to sign").             |
+| Field                        | Type      | Default | Description                                                       |
+| :--------------------------- | :-------- | :------ | :---------------------------------------------------------------- |
+| `topBarVisible`              | `boolean` | `true`  | Shows/hides the entire top navigation bar.                        |
+| `topBarClearButtonVisible`   | `boolean` | `false` | Shows a "Clear" button in the top-left corner.                    |
+| `topBarConnectButtonVisible` | `boolean` | `true`  | Shows the connect/disconnect button area in the top-right corner. |
+| `bottomBarVisible`           | `boolean` | `true`  | Shows/hides the entire bottom action bar.                         |
+| `okButtonVisible`            | `boolean` | `true`  | Shows the **OK** button in the bottom bar.                        |
+| `clearButtonVisible`         | `boolean` | `true`  | Shows the **Clear** button in the bottom bar.                     |
+| `cancelButtonVisible`        | `boolean` | `true`  | Shows the **Cancel** button in the bottom bar.                    |
+| `canvasLineVisible`          | `boolean` | `true`  | Shows the horizontal signature guide line on the canvas.          |
+| `deviceStatusTextVisible`    | `boolean` | `true`  | Shows the name of the connected device (e.g., "Wacom STU-540").   |
+| `additionalTextVisible`      | `boolean` | `true`  | Shows helper status messages (e.g., "Ready to sign").             |
 
 ### 🖋️ canvasAndDrawingOptions
 
@@ -635,17 +625,17 @@ Adjusts the visual appearance of the digital ink.
 
 Handles component localization. It can load external files or use inline definitions.
 
-| Field          | Type     | Description                                                                                                                                          |
-| :------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `lang`         | `string` | The active language code. Built-in translations are bundled for `'en'` and `'cs'`; other languages can be supplied via `langPath` or `translations`. |
-| `langPath`     | `string` | URL path to fetch translation files. Expects files in `[path]/[lang].json` format.                                                                   |
-| `translations` | `object` | An inline object containing key-value pairs (e.g., `{ "OK": "Confirm signature" }`). Overrides files.                                                |
+| Field          | Type     | Description                                                                                                                                              |
+| :------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `lang`         | `string` | The active language code. Built-in translations are bundled for `'en'`, `'cs'`, and `'pt'`; other languages can be supplied via `langPath` or `translations`. |
+| `langPath`     | `string` | URL path to fetch translation files. Expects files in `[path]/[lang].json` format.                                                                       |
+| `translations` | `object` | An inline object containing key-value pairs (e.g., `{ "OK": "Confirm signature" }`). Overrides files.                                                    |
 
 ## 🌐 Localization & Translation Keys
 
 Localization is driven from `languageOptions`, but you can also provide overrides at runtime:
 
-1. **Set the language code** in `config.languageOptions.lang`. English (`en`) is the fallback and Czech (`cs`) is shipped alongside it.
+1. **Set the language code** in `config.languageOptions.lang`. English (`en`) is the fallback, Czech (`cs`) and Portuguese (`pt`) are shipped alongside it.
 2. **Load a hosted file** by pointing `languageOptions.langPath` to the directory that contains `[lang].json`. The loader will fetch `${langPath}/${lang}.json` (or the exact file if you include the `.json` suffix).
 3. **Override only specific phrases** by passing a `translations` object—either a flat key map or a per-language map (`{ en: {...}, cs: {...} }`). Inline values take precedence over both built-in and fetched files.
 4. **Dynamic placeholders** (for example, `{device}` in `TEXT_SIGNING_WITH_DEVICE`) are replaced using the `LocalizationManager.t` helper. Keep the braces intact if you expect runtime interpolation.
@@ -723,9 +713,6 @@ Standard event listeners triggered _after_ specific actions. Useful for observin
 ```typescript
 this.config = {
   lease: leasePayloadFromApi,
-  autoconnectOptions: {
-    autoConnect: true,
-  },
   canvasAndDrawingOptions: {
     color: "#1a1a1a",
   },
@@ -751,7 +738,7 @@ The following methods are available on the component instance to control the sig
 | `connect()`      | `Promise<void>`                                    | Connects device to component                                                     |
 | `disconnect()`   | `Promise<void>`                                    | Disconnects device from component                                                |
 | `startSigning()` | `Promise<void>`                                    | Initializes a new signing session on the canvas and hardware.                    |
-| `stopSigning()`  | `Promise<any>`                                     | Low-level session stop that returns the raw driver payload.                      |
+| `stopSigning()`  | `Promise<void>`                                    | Low-level session stop that returns the raw driver payload.                      |
 | `ok()`           | `Promise<ISignatureConfirmationData \| undefined>` | Finalizes the session, cleans the device screen, and returns the signature data. |
 | `clear()`        | `Promise<void>`                                    | Wipes the signature from the UI and hardware without ending the session.         |
 | `cancel()`       | `Promise<void>`                                    | Aborts the current session and resets the component state.                       |
@@ -783,7 +770,6 @@ Safely terminates the communication channel with the signature tablet.
 #### 💡 Best Practices
 
 - **Initial Connection:** Always call `connect()` from a click handler so the user can select their device from the browser list.
-- **Auto-Reconnect:** Use `autoconnectOptions.autoConnect: true` in the config to silently reconnect to a previously authorized device on startup without a user gesture.
 - **Cleanup:** It is good practice to call `disconnect()` when the component is being destroyed or the user navigates away from the signing page to free up the USB port.
 
 #### 📜 `startSigning(options?: IDrawingOptions)`
@@ -799,8 +785,6 @@ await signpad.startSigning({
 });
 ```
 
-If you have `autoRestartSigningAfterAction` enabled in your config, the component will automatically call `startSigning()` again after an `ok` or `cancel` action is completed.
-
 #### 📜 `ok()`
 
 This is the standard way to confirm a signature. It:
@@ -836,11 +820,8 @@ This is the standard way to confirm a signature. It:
 ```
 
 ```js
-// [1] Image structure
-{
-  data: image / png;
-  (base64, Some - long - string);
-}
+// [1] imageBase64 — plain base64 PNG string
+"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
 ```
 
 ```js