@signosoft/signpad-js 0.2.2 → 0.3.0

package/dist/index.d.ts

@@ -14,7 +14,7 @@ declare class ButtonManager {
      * Finalizes the signature, dispatches SIGN_OK, and returns captured data.
      * @returns Captured signature payload from the driver.
      */
-    handleOk(): Promise<any>;
+    handleOk(): Promise<ISignatureConfirmationData | undefined>;
     /**
      * Cancels the signature without collecting data, dispatches SIGN_CANCEL.
      * @returns Resolves when the cancel flow completes.
@@ -105,7 +105,7 @@ declare class CanvasManager {
      * Prevents signatures from appearing blurry.
      * @private
      */
-    private configureCanvasForDPI;
+    configureCanvasForDPI(): void;
     /**
      * Applies line caps, joins, and composite operations to the rendering context.
      * @param options - The style options to apply.
@@ -120,6 +120,7 @@ declare class CanvasManager {
 declare class ConfigManager {
     private component;
     private configEventHandlers;
+    private customEventListenerCache;
     /**
      * @param component - The host SignosoftSignpad instance.
      */
@@ -129,10 +130,6 @@ declare class ConfigManager {
      * @param prevConfig - Optional previous config for diffing.
      */
     apply(prevConfig?: SignpadConfig): void;
-    /**
-     * Applies custom CSS variables from the config to the host element.
-     */
-    applyCssVariables(): void;
     /**
      * Returns resolved UI visibility options with defaults applied.
      * @returns UI visibility options.
@@ -179,14 +176,8 @@ declare class ConnectionManager {
     private sigLayer;
     /** @private Debug counter for callback registrations */
     private debugCallbackRegistrationCount;
-    /** @private Offscreen canvas used to capture driver input without direct UI interference */
-    private offscreenDrawingCanvas;
     /** @private Cached device info from the last successful connect */
     private cachedDeviceInfo;
-    /** @private Tracks SignatureLayer initialization state */
-    private sigLayerInitialized;
-    /** @private License server endpoint */
-    private licenseServerUrl;
     /** @private Timestamp of the last pen event dispatch */
     private lastPenDispatchTime;
     /** @private Buffered pen data for throttling */
@@ -267,7 +258,7 @@ declare class ConnectionManager {
      * Fetches a lease from the license server and initializes the driver.
      * @returns Resolves when the driver is initialized.
      */
-    private initializeTabletWithLicense;
+    initWithLease(lease: any): Promise<void>;
     isFallback(deviceInfo: any | null, isDeviceConnected: boolean, includeDisconnected: boolean): boolean;
     /**
      * Normalizes device info to always include deviceName.
@@ -286,7 +277,7 @@ export declare enum DeviceStatusText {
 }
 
 export declare interface IActionHandlers {
-    handleOk?: () => any | Promise<any>;
+    handleOk?: (data?: ISignatureConfirmationData) => any | Promise<any>;
     handleClear?: () => any | Promise<any>;
     handleCancel?: () => any | Promise<any>;
 }
@@ -317,7 +308,7 @@ export declare interface IEventCallbacks {
     }>) => void;
     onDisconnect?: (event: CustomEvent<void>) => void;
     onPen?: (event: CustomEvent<IPenData_2>) => void;
-    onOk?: (event: CustomEvent<any>) => void;
+    onOk?: (event: CustomEvent<ISignatureConfirmationData>) => void;
     onClear?: (event: CustomEvent<void>) => void;
     onCancel?: (event: CustomEvent<void>) => void;
     onError?: (event: CustomEvent<Error>) => void;
@@ -335,7 +326,9 @@ declare type IPenData_2 = {
     absoluteX?: number;
     absoluteY?: number;
     pressure?: number;
-    timestamp?: number;
+    ready?: boolean;
+    sequence?: number;
+    timestamp?: number | bigint;
     inContact: boolean;
     [key: string]: any;
 };
@@ -345,6 +338,49 @@ export declare interface IPenDataCallback {
     (penData: IPenData_2): void;
 }
 
+export declare interface ISignatureCanvasMeta {
+    top?: number;
+    left?: number;
+    right?: number;
+    bottom?: number;
+    width?: number;
+    height?: number;
+    cssWidth?: number;
+    cssHeight?: number;
+    dpr?: number;
+    [key: string]: any;
+}
+
+export declare type ISignatureConfirmationData = [
+points: IPenData_2[],
+imageBase64: string,
+metadata: ISignatureResultMeta
+];
+
+export declare interface ISignatureResultMeta {
+    canvas?: ISignatureCanvasMeta;
+    tablet?: ISignatureTabletMeta;
+    [key: string]: any;
+}
+
+export declare interface ISignatureTabletMeta {
+    name?: string;
+    aspectRatio?: number;
+    isCanvasStyleTablet?: boolean;
+    screenWidth?: number;
+    screenHeight?: number;
+    drawingArea?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    serialNumber?: string | Promise<string>;
+    vendorId?: number | null;
+    productId?: number | null;
+    [key: string]: any;
+}
+
 export declare interface ITranslationSet {
     [key: string]: string;
 }
@@ -352,6 +388,7 @@ export declare interface ITranslationSet {
 export declare interface IUIVisibilityOptions {
     topBarVisible?: boolean;
     topBarClearButtonVisible?: boolean;
+    topBarConnectButtonVisible?: boolean;
     bottomBarVisible?: boolean;
     okButtonVisible?: boolean;
     clearButtonVisible?: boolean;
@@ -558,6 +595,11 @@ export declare class SignosoftSignpad extends LitElement {
     localizationManager: LocalizationManager;
     configManager: ConfigManager;
     webHIDAPI: any;
+    clear: () => Promise<void>;
+    ok: () => Promise<ISignatureConfirmationData | undefined>;
+    cancel: () => Promise<void>;
+    startSigning: (drawingOptions?: IDrawingOptions) => Promise<void>;
+    stopSigning: () => Promise<void>;
     static styles: CSSResult[];
     /**
      * Lit lifecycle: Invoked after the element's DOM has been updated the first time.
@@ -601,32 +643,6 @@ export declare class SignosoftSignpad extends LitElement {
      * @returns A promise that resolves when disconnection is complete.
      */
     disconnect(): Promise<void>;
-    /**
-     * Clears the signature from both the UI canvas and the physical device screen.
-     * @returns Resolves when the clear flow completes.
-     */
-    clear(): Promise<void>;
-    /**
-     * Finalizes the signature session (OK action).
-     * @returns Captured signature payload from the driver.
-     */
-    ok(): Promise<any>;
-    /**
-     * Aborts the current signature session (Cancel action).
-     * @returns Resolves when the cancel flow completes.
-     */
-    cancel(): Promise<void>;
-    /**
-     * Programmatically starts a new signing session.
-     * @param drawingOptions - Optional settings for line thickness and color.
-     * @returns Resolves when the session is ready.
-     */
-    startSigning(drawingOptions?: IDrawingOptions): Promise<void>;
-    /**
-     * Programmatically stops the current signing session.
-     * @returns Resolves when the session stops.
-     */
-    stopSigning(): Promise<void>;
     /**
      * Resets the UI canvas and internal drawing flags.
      * @returns void
@@ -638,6 +654,12 @@ export declare class SignosoftSignpad extends LitElement {
      * @returns void
      */
     disconnectedCallback(): void;
+    /**
+     * Keeps canvas internal size in sync with responsive layout changes.
+     * @private
+     * @returns void
+     */
+    private handleWindowResize;
     /**
      * Attaches WebHID API event listeners for device connection and disconnection.
      * @private
@@ -674,6 +696,20 @@ export declare class SignosoftSignpad extends LitElement {
      * @returns void
      */
     private initializeMouseManager;
+    /**
+     * Throttles pen event dispatch to avoid excessive callback pressure.
+     * Drawing is still processed for every sample; only event emission is throttled.
+     */
+    private dispatchPenEventThrottled;
+    /**
+     * Initializes the driver once a lease is provided via config.
+     * Safe to call repeatedly; initialization is performed at most once.
+     */
+    private initializeFromConfigLeaseIfNeeded;
+    private shouldAutoConnect;
+    private autoConnectIfConfigured;
+    private scheduleAutoConnectRetry;
+    private clearAutoConnectQueue;
     /**
      * Renders the HTML template for the component.
      * Uses Lit's html template literal.
@@ -693,14 +729,13 @@ export declare type SignosoftSignpadProps = {
 };
 
 export declare interface SignpadConfig {
-    licenseKey?: string;
+    lease?: {};
     languageOptions?: ILanguageOptions;
     autoconnectOptions?: IAutoconnectOptions;
     uiVisibilityOptions?: IUIVisibilityOptions;
-    canvasAndDrawigOptions?: IDrawingOptions;
+    canvasAndDrawingOptions?: IDrawingOptions;
     actionHandlers?: IActionHandlers;
     eventCallbacks?: IEventCallbacks;
-    customCssVariables?: Record<string, string>;
 }
 
 export declare enum SignpadEventType {